Skip to content

🌿 Fern Regeneration -- September 11, 2025 #500

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

🌿 Fern Regeneration -- September 11, 2025 #500

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
32 changes: 9 additions & 23 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fintercom%2Fintercom-node)
[![npm shield](https://img.shields.io/npm/v/intercom-client)](https://www.npmjs.com/package/intercom-client)

The Intercom TypeScript library provides convenient access to the Intercom API from TypeScript.
The Intercom TypeScript library provides convenient access to the Intercom APIs from TypeScript.

## Project Updates

Expand All @@ -27,12 +27,8 @@ Instantiate and use the client with the following:
import { IntercomClient } from "intercom-client";

const client = new IntercomClient({ token: "YOUR_TOKEN" });
await client.articles.create({
title: "Thanks for everything",
description: "Description of the Article",
body: "Body of the Article",
author_id: 1295,
state: "published",
await client.aiContent.createContentImportSource({
url: "https://www.example.com",
});
```

Expand All @@ -58,7 +54,7 @@ will be thrown.
import { IntercomError } from "intercom-client";

try {
await client.articles.create(...);
await client.aiContent.createContentImportSource(...);
} catch (err) {
if (err instanceof IntercomError) {
console.log(err.statusCode);
Expand Down Expand Up @@ -96,7 +92,7 @@ while (page.hasNextPage()) {
If you would like to send additional headers as part of the request, use the `headers` request option.

```typescript
const response = await client.articles.create(..., {
const response = await client.aiContent.createContentImportSource(..., {
headers: {
'X-Custom-Header': 'custom value'
}
Expand All @@ -118,7 +114,7 @@ A request is deemed retryable when any of the following HTTP status codes is ret
Use the `maxRetries` request option to configure this behavior.

```typescript
const response = await client.articles.create(..., {
const response = await client.aiContent.createContentImportSource(..., {
maxRetries: 0 // override maxRetries at the request level
});
```
Expand All @@ -128,7 +124,7 @@ const response = await client.articles.create(..., {
The SDK defaults to a 60 second timeout. Use the `timeoutInSeconds` option to configure this behavior.

```typescript
const response = await client.articles.create(..., {
const response = await client.aiContent.createContentImportSource(..., {
timeoutInSeconds: 30 // override timeout to 30s
});
```
Expand All @@ -139,7 +135,7 @@ The SDK allows users to abort requests at any point by passing in an abort signa

```typescript
const controller = new AbortController();
const response = await client.articles.create(..., {
const response = await client.aiContent.createContentImportSource(..., {
abortSignal: controller.signal
});
controller.abort(); // aborts the request
Expand All @@ -151,7 +147,7 @@ The SDK provides access to raw response data, including headers, through the `.w
The `.withRawResponse()` method returns a promise that results to an object with a `data` and a `rawResponse` property.

```typescript
const { data, rawResponse } = await client.articles.create(...).withRawResponse();
const { data, rawResponse } = await client.aiContent.createContentImportSource(...).withRawResponse();

console.log(data);
console.log(rawResponse.headers['X-My-Header']);
Expand Down Expand Up @@ -192,13 +188,3 @@ a proof of concept, but know that we will not be able to merge it as-is. We sugg
an issue first to discuss with us!

On the other hand, contributions to the README are always very welcome!

## Contributing

While we value open-source contributions to this SDK, this library is generated programmatically.
Additions made directly to this library would have to be moved over to our generation code,
otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
an issue first to discuss with us!

On the other hand, contributions to the README are always very welcome!
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "intercom-client",
"version": "6.4.0",
"version": "7.0.0",
"private": false,
"repository": "https://github.com/intercom/intercom-node",
"main": "./index.js",
Expand Down
Loading
Loading