Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ jobs:
run: pnpm test
env:
INTERCOM_API_KEY: ${{ secrets.INTERCOM_API_KEY }}
API_TOKEN: ${{ secrets.INTERCOM_API_KEY }}

publish:
needs: [ compile, test ]
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "intercom-client",
"version": "7.0.1",
"version": "7.0.2",
"private": false,
"repository": "github:intercom/intercom-node",
"type": "commonjs",
Expand Down
265 changes: 265 additions & 0 deletions reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -2451,6 +2451,132 @@ await client.internalArticles.searchInternalArticles({
</dl>


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

## IP Allowlist
<details><summary><code>client.ipAllowlist.<a href="/src/api/resources/ipAllowlist/client/Client.ts">getIpAllowlist</a>() -> Intercom.IpAllowlist</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Retrieve the current IP allowlist configuration for the workspace.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.ipAllowlist.getIpAllowlist();

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**requestOptions:** `IpAllowlistClient.RequestOptions`

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


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

<details><summary><code>client.ipAllowlist.<a href="/src/api/resources/ipAllowlist/client/Client.ts">updateIpAllowlist</a>({ ...params }) -> Intercom.IpAllowlist</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Update the IP allowlist configuration for the workspace.

{% admonition type="warning" name="Lockout Protection" %}
The API will reject updates that would lock out the caller's IP address. Ensure your current IP is included in the allowlist when enabling the feature.
{% /admonition %}
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.ipAllowlist.updateIpAllowlist({
enabled: true,
ip_allowlist: ["192.168.1.0/24", "10.0.0.1"]
});

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**request:** `Intercom.IpAllowlist`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `IpAllowlistClient.RequestOptions`

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


</dd>
</dl>
</details>
Expand Down Expand Up @@ -16633,6 +16759,73 @@ await client.unstable.conversations.detachContactFromConversation({
</dl>


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

<details><summary><code>client.unstable.conversations.<a href="/src/api/resources/unstable/resources/conversations/client/Client.ts">listHandlingEvents</a>({ ...params }) -> Intercom.HandlingEventList</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

List all pause/resume events for a conversation. These events track when teammates paused or resumed handling a conversation.

Requires the `read_conversations` OAuth scope.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.unstable.conversations.listHandlingEvents({
id: "123"
});

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**request:** `Intercom.unstable.ListHandlingEventsRequest`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `ConversationsClient.RequestOptions`

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


</dd>
</dl>
</details>
Expand Down Expand Up @@ -18150,6 +18343,78 @@ await client.unstable.dataExport.downloadDataExport({
</dl>


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

## Workflows
<details><summary><code>client.unstable.workflows.<a href="/src/api/resources/unstable/resources/workflows/client/Client.ts">exportWorkflow</a>({ ...params }) -> Intercom.WorkflowExport</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Export a workflow configuration by its ID. This endpoint returns the complete workflow definition including its steps, targeting rules, and attributes.

This endpoint is designed for EU Data Act compliance, allowing customers to export their workflow configurations.

{% admonition type="warning" name="Unstable API" %}
This API is currently in the Unstable version. Its behavior may change in future releases.
{% /admonition %}
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.unstable.workflows.exportWorkflow({
id: "12345"
});

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**request:** `Intercom.unstable.ExportWorkflowRequest`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `WorkflowsClient.RequestOptions`

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


</dd>
</dl>
</details>
Expand Down
4 changes: 2 additions & 2 deletions src/BaseClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,8 @@ export function normalizeClientOptions<T extends BaseClientOptions>(options: T):
{
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "intercom-client",
"X-Fern-SDK-Version": "7.0.0",
"User-Agent": "intercom-client/7.0.0",
"X-Fern-SDK-Version": "7.0.2",
"User-Agent": "intercom-client/7.0.2",
"X-Fern-Runtime": core.RUNTIME.type,
"X-Fern-Runtime-Version": core.RUNTIME.version,
"Intercom-Version": options?.version ?? "2.14",
Expand Down
6 changes: 6 additions & 0 deletions src/Client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import { EventsClient } from "./api/resources/events/client/Client.js";
import { ExportClient } from "./api/resources/export/client/Client.js";
import { HelpCentersClient } from "./api/resources/helpCenters/client/Client.js";
import { InternalArticlesClient } from "./api/resources/internalArticles/client/Client.js";
import { IpAllowlistClient } from "./api/resources/ipAllowlist/client/Client.js";
import { JobsClient } from "./api/resources/jobs/client/Client.js";
import { MessagesClient } from "./api/resources/messages/client/Client.js";
import { NewsClient } from "./api/resources/news/client/Client.js";
Expand Down Expand Up @@ -49,6 +50,7 @@ export class IntercomClient {
protected _dataExport: DataExportClient | undefined;
protected _helpCenters: HelpCentersClient | undefined;
protected _internalArticles: InternalArticlesClient | undefined;
protected _ipAllowlist: IpAllowlistClient | undefined;
protected _companies: CompaniesClient | undefined;
protected _contacts: ContactsClient | undefined;
protected _notes: NotesClient | undefined;
Expand Down Expand Up @@ -108,6 +110,10 @@ export class IntercomClient {
return (this._internalArticles ??= new InternalArticlesClient(this._options));
}

public get ipAllowlist(): IpAllowlistClient {
return (this._ipAllowlist ??= new IpAllowlistClient(this._options));
}

public get companies(): CompaniesClient {
return (this._companies ??= new CompaniesClient(this._options));
}
Expand Down
1 change: 1 addition & 0 deletions src/api/resources/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ export * as helpCenters from "./helpCenters/index.js";
export * from "./internalArticles/client/requests/index.js";
export * as internalArticles from "./internalArticles/index.js";
export * from "./internalArticles/types/index.js";
export * as ipAllowlist from "./ipAllowlist/index.js";
export * from "./jobs/client/requests/index.js";
export * as jobs from "./jobs/index.js";
export * from "./jobs/types/index.js";
Expand Down
Loading