Skip to content

🌿 Fern Regeneration -- May 22, 2025 #488

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

Merged
merged 1 commit into from
May 22, 2025
Merged

🌿 Fern Regeneration -- May 22, 2025 #488

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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 7 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,24 +180,12 @@ an issue first to discuss with us!

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

## Request Options

This client library also supports passing in [`request` options](https://github.com/axios/axios#request-config):

```typescript
client.useRequestOpts({
baseURL: "http://local.test-server.com",
});
```

Note that certain request options (such as `json`, and certain `headers` names cannot be overriden).

### Setting the API base url
## Contributing

If you are using the european instance of intercom and would like to call it directly and not be redirected through our US instance, you can set the `baseUrl` as follows:
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!

```typescript
client.useRequestOpts({
baseURL: "https://api.eu.intercom.io",
});
```
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.2.0",
"version": "6.3.0",
"private": false,
"repository": "https://github.com/intercom/intercom-node",
"main": "./index.js",
Expand Down
164 changes: 163 additions & 1 deletion reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -877,7 +877,7 @@ while (page.hasNextPage()) {

## Companies

<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">retrieve</a>({ ...params }) -> Intercom.CompanyList</code></summary>
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">retrieve</a>({ ...params }) -> Intercom.CompaniesRetrieveResponse</code></summary>
<dl>
<dd>

Expand Down Expand Up @@ -6833,6 +6833,168 @@ await client.visitors.mergeToContact({
</dl>
</details>

## CustomChannelEvents

<details><summary><code>client.customChannelEvents.<a href="/src/api/resources/customChannelEvents/client/Client.ts">notifyAttributeCollected</a>() -> void</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.customChannelEvents.notifyAttributeCollected();
```

</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**requestOptions:** `CustomChannelEvents.RequestOptions`

</dd>
</dl>
</dd>
</dl>

</dd>
</dl>
</details>

<details><summary><code>client.customChannelEvents.<a href="/src/api/resources/customChannelEvents/client/Client.ts">notifyNewMessage</a>() -> void</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.customChannelEvents.notifyNewMessage();
```

</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**requestOptions:** `CustomChannelEvents.RequestOptions`

</dd>
</dl>
</dd>
</dl>

</dd>
</dl>
</details>

<details><summary><code>client.customChannelEvents.<a href="/src/api/resources/customChannelEvents/client/Client.ts">notifyNewConversation</a>() -> void</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.customChannelEvents.notifyNewConversation();
```

</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**requestOptions:** `CustomChannelEvents.RequestOptions`

</dd>
</dl>
</dd>
</dl>

</dd>
</dl>
</details>

<details><summary><code>client.customChannelEvents.<a href="/src/api/resources/customChannelEvents/client/Client.ts">notifyQuickReplySelected</a>() -> void</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.customChannelEvents.notifyQuickReplySelected();
```

</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**requestOptions:** `CustomChannelEvents.RequestOptions`

</dd>
</dl>
</dd>
</dl>

</dd>
</dl>
</details>

## HelpCenters Collections

<details><summary><code>client.helpCenters.collections.<a href="/src/api/resources/helpCenters/resources/collections/client/Client.ts">list</a>({ ...params }) -> core.Page<Intercom.Collection></code></summary>
Expand Down
6 changes: 6 additions & 0 deletions src/Client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ import { Teams } from "./api/resources/teams/client/Client";
import { TicketTypes } from "./api/resources/ticketTypes/client/Client";
import { Tickets } from "./api/resources/tickets/client/Client";
import { Visitors } from "./api/resources/visitors/client/Client";
import { CustomChannelEvents } from "./api/resources/customChannelEvents/client/Client";
import { News } from "./api/resources/news/client/Client";

export declare namespace IntercomClient {
Expand Down Expand Up @@ -106,6 +107,7 @@ export class IntercomClient {
protected _ticketTypes: TicketTypes | undefined;
protected _tickets: Tickets | undefined;
protected _visitors: Visitors | undefined;
protected _customChannelEvents: CustomChannelEvents | undefined;
protected _news: News | undefined;

constructor(protected readonly _options: IntercomClient.Options = {}) {}
Expand Down Expand Up @@ -186,6 +188,10 @@ export class IntercomClient {
return (this._visitors ??= new Visitors(this._options));
}

public get customChannelEvents(): CustomChannelEvents {
return (this._customChannelEvents ??= new CustomChannelEvents(this._options));
}

public get news(): News {
return (this._news ??= new News(this._options));
}
Expand Down
20 changes: 10 additions & 10 deletions src/api/resources/admins/client/Client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,8 +101,8 @@ export class Admins {
Authorization: await this._getAuthorizationHeader(),
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "intercom-client",
"X-Fern-SDK-Version": "6.2.0",
"User-Agent": "intercom-client/6.2.0",
"X-Fern-SDK-Version": "6.3.0",
"User-Agent": "intercom-client/6.3.0",
"Intercom-Version": requestOptions?.version ?? this._options?.version ?? "2.11",
"X-Fern-Runtime": core.RUNTIME.type,
"X-Fern-Runtime-Version": core.RUNTIME.version,
Expand Down Expand Up @@ -173,8 +173,8 @@ export class Admins {
Authorization: await this._getAuthorizationHeader(),
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "intercom-client",
"X-Fern-SDK-Version": "6.2.0",
"User-Agent": "intercom-client/6.2.0",
"X-Fern-SDK-Version": "6.3.0",
"User-Agent": "intercom-client/6.3.0",
"Intercom-Version": requestOptions?.version ?? this._options?.version ?? "2.11",
"X-Fern-Runtime": core.RUNTIME.type,
"X-Fern-Runtime-Version": core.RUNTIME.version,
Expand Down Expand Up @@ -257,8 +257,8 @@ export class Admins {
Authorization: await this._getAuthorizationHeader(),
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "intercom-client",
"X-Fern-SDK-Version": "6.2.0",
"User-Agent": "intercom-client/6.2.0",
"X-Fern-SDK-Version": "6.3.0",
"User-Agent": "intercom-client/6.3.0",
"Intercom-Version": requestOptions?.version ?? this._options?.version ?? "2.11",
"X-Fern-Runtime": core.RUNTIME.type,
"X-Fern-Runtime-Version": core.RUNTIME.version,
Expand Down Expand Up @@ -325,8 +325,8 @@ export class Admins {
Authorization: await this._getAuthorizationHeader(),
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "intercom-client",
"X-Fern-SDK-Version": "6.2.0",
"User-Agent": "intercom-client/6.2.0",
"X-Fern-SDK-Version": "6.3.0",
"User-Agent": "intercom-client/6.3.0",
"Intercom-Version": requestOptions?.version ?? this._options?.version ?? "2.11",
"X-Fern-Runtime": core.RUNTIME.type,
"X-Fern-Runtime-Version": core.RUNTIME.version,
Expand Down Expand Up @@ -400,8 +400,8 @@ export class Admins {
Authorization: await this._getAuthorizationHeader(),
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "intercom-client",
"X-Fern-SDK-Version": "6.2.0",
"User-Agent": "intercom-client/6.2.0",
"X-Fern-SDK-Version": "6.3.0",
"User-Agent": "intercom-client/6.3.0",
"Intercom-Version": requestOptions?.version ?? this._options?.version ?? "2.11",
"X-Fern-Runtime": core.RUNTIME.type,
"X-Fern-Runtime-Version": core.RUNTIME.version,
Expand Down
16 changes: 1 addition & 15 deletions src/api/resources/aiContentSource/types/ContentSource.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,25 +7,11 @@
*/
export interface ContentSource {
/** The type of the content source. */
content_type: ContentSource.ContentType;
content_type: "custom_answer";
/** The internal URL linking to the content source for teammates. */
url: string;
/** The title of the content source. */
title: string;
/** The ISO 639 language code of the content source. */
locale: string;
}

export namespace ContentSource {
/**
* The type of the content source.
*/
export type ContentType = "file" | "article" | "external_content" | "content_snippet" | "workflow_connector_action";
export const ContentType = {
File: "file",
Article: "article",
ExternalContent: "external_content",
ContentSnippet: "content_snippet",
WorkflowConnectorAction: "workflow_connector_action",
} as const;
}
24 changes: 12 additions & 12 deletions src/api/resources/articles/client/Client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,8 +115,8 @@ export class Articles {
Authorization: await this._getAuthorizationHeader(),
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "intercom-client",
"X-Fern-SDK-Version": "6.2.0",
"User-Agent": "intercom-client/6.2.0",
"X-Fern-SDK-Version": "6.3.0",
"User-Agent": "intercom-client/6.3.0",
"Intercom-Version": requestOptions?.version ?? this._options?.version ?? "2.11",
"X-Fern-Runtime": core.RUNTIME.type,
"X-Fern-Runtime-Version": core.RUNTIME.version,
Expand Down Expand Up @@ -224,8 +224,8 @@ export class Articles {
Authorization: await this._getAuthorizationHeader(),
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "intercom-client",
"X-Fern-SDK-Version": "6.2.0",
"User-Agent": "intercom-client/6.2.0",
"X-Fern-SDK-Version": "6.3.0",
"User-Agent": "intercom-client/6.3.0",
"Intercom-Version": requestOptions?.version ?? this._options?.version ?? "2.11",
"X-Fern-Runtime": core.RUNTIME.type,
"X-Fern-Runtime-Version": core.RUNTIME.version,
Expand Down Expand Up @@ -302,8 +302,8 @@ export class Articles {
Authorization: await this._getAuthorizationHeader(),
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "intercom-client",
"X-Fern-SDK-Version": "6.2.0",
"User-Agent": "intercom-client/6.2.0",
"X-Fern-SDK-Version": "6.3.0",
"User-Agent": "intercom-client/6.3.0",
"Intercom-Version": requestOptions?.version ?? this._options?.version ?? "2.11",
"X-Fern-Runtime": core.RUNTIME.type,
"X-Fern-Runtime-Version": core.RUNTIME.version,
Expand Down Expand Up @@ -381,8 +381,8 @@ export class Articles {
Authorization: await this._getAuthorizationHeader(),
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "intercom-client",
"X-Fern-SDK-Version": "6.2.0",
"User-Agent": "intercom-client/6.2.0",
"X-Fern-SDK-Version": "6.3.0",
"User-Agent": "intercom-client/6.3.0",
"Intercom-Version": requestOptions?.version ?? this._options?.version ?? "2.11",
"X-Fern-Runtime": core.RUNTIME.type,
"X-Fern-Runtime-Version": core.RUNTIME.version,
Expand Down Expand Up @@ -459,8 +459,8 @@ export class Articles {
Authorization: await this._getAuthorizationHeader(),
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "intercom-client",
"X-Fern-SDK-Version": "6.2.0",
"User-Agent": "intercom-client/6.2.0",
"X-Fern-SDK-Version": "6.3.0",
"User-Agent": "intercom-client/6.3.0",
"Intercom-Version": requestOptions?.version ?? this._options?.version ?? "2.11",
"X-Fern-Runtime": core.RUNTIME.type,
"X-Fern-Runtime-Version": core.RUNTIME.version,
Expand Down Expand Up @@ -553,8 +553,8 @@ export class Articles {
Authorization: await this._getAuthorizationHeader(),
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "intercom-client",
"X-Fern-SDK-Version": "6.2.0",
"User-Agent": "intercom-client/6.2.0",
"X-Fern-SDK-Version": "6.3.0",
"User-Agent": "intercom-client/6.3.0",
"Intercom-Version": requestOptions?.version ?? this._options?.version ?? "2.11",
"X-Fern-Runtime": core.RUNTIME.type,
"X-Fern-Runtime-Version": core.RUNTIME.version,
Expand Down
Loading