Skip to content

Commit d82d2a5

Browse files
fern-api[bot]fern-api[bot]
authored
SDK regeneration (#488)
Co-authored-by: fern-api <115122769+fern-api[bot]@users.noreply.github.com>
1 parent fc2ac6c commit d82d2a5

File tree

40 files changed

+963
-486
lines changed

40 files changed

+963
-486
lines changed

‎README.md

Lines changed: 7 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -180,24 +180,12 @@ an issue first to discuss with us!
180180

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

183-
## Request Options
184-
185-
This client library also supports passing in [`request` options](https://github.com/axios/axios#request-config):
186-
187-
```typescript
188-
client.useRequestOpts({
189-
baseURL: "http://local.test-server.com",
190-
});
191-
```
192-
193-
Note that certain request options (such as `json`, and certain `headers` names cannot be overriden).
194-
195-
### Setting the API base url
183+
## Contributing
196184

197-
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:
185+
While we value open-source contributions to this SDK, this library is generated programmatically.
186+
Additions made directly to this library would have to be moved over to our generation code,
187+
otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
188+
a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
189+
an issue first to discuss with us!
198190

199-
```typescript
200-
client.useRequestOpts({
201-
baseURL: "https://api.eu.intercom.io",
202-
});
203-
```
191+
On the other hand, contributions to the README are always very welcome!

‎package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "intercom-client",
3-
"version": "6.2.0",
3+
"version": "6.3.0",
44
"private": false,
55
"repository": "https://github.com/intercom/intercom-node",
66
"main": "./index.js",

‎reference.md

Lines changed: 163 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -877,7 +877,7 @@ while (page.hasNextPage()) {
877877

878878
## Companies
879879

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

@@ -6833,6 +6833,168 @@ await client.visitors.mergeToContact({
68336833
</dl>
68346834
</details>
68356835

6836+
## CustomChannelEvents
6837+
6838+
<details><summary><code>client.customChannelEvents.<a href="/src/api/resources/customChannelEvents/client/Client.ts">notifyAttributeCollected</a>() -> void</code></summary>
6839+
<dl>
6840+
<dd>
6841+
6842+
#### 🔌 Usage
6843+
6844+
<dl>
6845+
<dd>
6846+
6847+
<dl>
6848+
<dd>
6849+
6850+
```typescript
6851+
await client.customChannelEvents.notifyAttributeCollected();
6852+
```
6853+
6854+
</dd>
6855+
</dl>
6856+
</dd>
6857+
</dl>
6858+
6859+
#### ⚙️ Parameters
6860+
6861+
<dl>
6862+
<dd>
6863+
6864+
<dl>
6865+
<dd>
6866+
6867+
**requestOptions:** `CustomChannelEvents.RequestOptions`
6868+
6869+
</dd>
6870+
</dl>
6871+
</dd>
6872+
</dl>
6873+
6874+
</dd>
6875+
</dl>
6876+
</details>
6877+
6878+
<details><summary><code>client.customChannelEvents.<a href="/src/api/resources/customChannelEvents/client/Client.ts">notifyNewMessage</a>() -> void</code></summary>
6879+
<dl>
6880+
<dd>
6881+
6882+
#### 🔌 Usage
6883+
6884+
<dl>
6885+
<dd>
6886+
6887+
<dl>
6888+
<dd>
6889+
6890+
```typescript
6891+
await client.customChannelEvents.notifyNewMessage();
6892+
```
6893+
6894+
</dd>
6895+
</dl>
6896+
</dd>
6897+
</dl>
6898+
6899+
#### ⚙️ Parameters
6900+
6901+
<dl>
6902+
<dd>
6903+
6904+
<dl>
6905+
<dd>
6906+
6907+
**requestOptions:** `CustomChannelEvents.RequestOptions`
6908+
6909+
</dd>
6910+
</dl>
6911+
</dd>
6912+
</dl>
6913+
6914+
</dd>
6915+
</dl>
6916+
</details>
6917+
6918+
<details><summary><code>client.customChannelEvents.<a href="/src/api/resources/customChannelEvents/client/Client.ts">notifyNewConversation</a>() -> void</code></summary>
6919+
<dl>
6920+
<dd>
6921+
6922+
#### 🔌 Usage
6923+
6924+
<dl>
6925+
<dd>
6926+
6927+
<dl>
6928+
<dd>
6929+
6930+
```typescript
6931+
await client.customChannelEvents.notifyNewConversation();
6932+
```
6933+
6934+
</dd>
6935+
</dl>
6936+
</dd>
6937+
</dl>
6938+
6939+
#### ⚙️ Parameters
6940+
6941+
<dl>
6942+
<dd>
6943+
6944+
<dl>
6945+
<dd>
6946+
6947+
**requestOptions:** `CustomChannelEvents.RequestOptions`
6948+
6949+
</dd>
6950+
</dl>
6951+
</dd>
6952+
</dl>
6953+
6954+
</dd>
6955+
</dl>
6956+
</details>
6957+
6958+
<details><summary><code>client.customChannelEvents.<a href="/src/api/resources/customChannelEvents/client/Client.ts">notifyQuickReplySelected</a>() -> void</code></summary>
6959+
<dl>
6960+
<dd>
6961+
6962+
#### 🔌 Usage
6963+
6964+
<dl>
6965+
<dd>
6966+
6967+
<dl>
6968+
<dd>
6969+
6970+
```typescript
6971+
await client.customChannelEvents.notifyQuickReplySelected();
6972+
```
6973+
6974+
</dd>
6975+
</dl>
6976+
</dd>
6977+
</dl>
6978+
6979+
#### ⚙️ Parameters
6980+
6981+
<dl>
6982+
<dd>
6983+
6984+
<dl>
6985+
<dd>
6986+
6987+
**requestOptions:** `CustomChannelEvents.RequestOptions`
6988+
6989+
</dd>
6990+
</dl>
6991+
</dd>
6992+
</dl>
6993+
6994+
</dd>
6995+
</dl>
6996+
</details>
6997+
68366998
## HelpCenters Collections
68376999

68387000
<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>

‎src/Client.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ import { Teams } from "./api/resources/teams/client/Client";
2323
import { TicketTypes } from "./api/resources/ticketTypes/client/Client";
2424
import { Tickets } from "./api/resources/tickets/client/Client";
2525
import { Visitors } from "./api/resources/visitors/client/Client";
26+
import { CustomChannelEvents } from "./api/resources/customChannelEvents/client/Client";
2627
import { News } from "./api/resources/news/client/Client";
2728

2829
export declare namespace IntercomClient {
@@ -106,6 +107,7 @@ export class IntercomClient {
106107
protected _ticketTypes: TicketTypes | undefined;
107108
protected _tickets: Tickets | undefined;
108109
protected _visitors: Visitors | undefined;
110+
protected _customChannelEvents: CustomChannelEvents | undefined;
109111
protected _news: News | undefined;
110112

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

191+
public get customChannelEvents(): CustomChannelEvents {
192+
return (this._customChannelEvents ??= new CustomChannelEvents(this._options));
193+
}
194+
189195
public get news(): News {
190196
return (this._news ??= new News(this._options));
191197
}

‎src/api/resources/admins/client/Client.ts

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -101,8 +101,8 @@ export class Admins {
101101
Authorization: await this._getAuthorizationHeader(),
102102
"X-Fern-Language": "JavaScript",
103103
"X-Fern-SDK-Name": "intercom-client",
104-
"X-Fern-SDK-Version": "6.2.0",
105-
"User-Agent": "intercom-client/6.2.0",
104+
"X-Fern-SDK-Version": "6.3.0",
105+
"User-Agent": "intercom-client/6.3.0",
106106
"Intercom-Version": requestOptions?.version ?? this._options?.version ?? "2.11",
107107
"X-Fern-Runtime": core.RUNTIME.type,
108108
"X-Fern-Runtime-Version": core.RUNTIME.version,
@@ -173,8 +173,8 @@ export class Admins {
173173
Authorization: await this._getAuthorizationHeader(),
174174
"X-Fern-Language": "JavaScript",
175175
"X-Fern-SDK-Name": "intercom-client",
176-
"X-Fern-SDK-Version": "6.2.0",
177-
"User-Agent": "intercom-client/6.2.0",
176+
"X-Fern-SDK-Version": "6.3.0",
177+
"User-Agent": "intercom-client/6.3.0",
178178
"Intercom-Version": requestOptions?.version ?? this._options?.version ?? "2.11",
179179
"X-Fern-Runtime": core.RUNTIME.type,
180180
"X-Fern-Runtime-Version": core.RUNTIME.version,
@@ -257,8 +257,8 @@ export class Admins {
257257
Authorization: await this._getAuthorizationHeader(),
258258
"X-Fern-Language": "JavaScript",
259259
"X-Fern-SDK-Name": "intercom-client",
260-
"X-Fern-SDK-Version": "6.2.0",
261-
"User-Agent": "intercom-client/6.2.0",
260+
"X-Fern-SDK-Version": "6.3.0",
261+
"User-Agent": "intercom-client/6.3.0",
262262
"Intercom-Version": requestOptions?.version ?? this._options?.version ?? "2.11",
263263
"X-Fern-Runtime": core.RUNTIME.type,
264264
"X-Fern-Runtime-Version": core.RUNTIME.version,
@@ -325,8 +325,8 @@ export class Admins {
325325
Authorization: await this._getAuthorizationHeader(),
326326
"X-Fern-Language": "JavaScript",
327327
"X-Fern-SDK-Name": "intercom-client",
328-
"X-Fern-SDK-Version": "6.2.0",
329-
"User-Agent": "intercom-client/6.2.0",
328+
"X-Fern-SDK-Version": "6.3.0",
329+
"User-Agent": "intercom-client/6.3.0",
330330
"Intercom-Version": requestOptions?.version ?? this._options?.version ?? "2.11",
331331
"X-Fern-Runtime": core.RUNTIME.type,
332332
"X-Fern-Runtime-Version": core.RUNTIME.version,
@@ -400,8 +400,8 @@ export class Admins {
400400
Authorization: await this._getAuthorizationHeader(),
401401
"X-Fern-Language": "JavaScript",
402402
"X-Fern-SDK-Name": "intercom-client",
403-
"X-Fern-SDK-Version": "6.2.0",
404-
"User-Agent": "intercom-client/6.2.0",
403+
"X-Fern-SDK-Version": "6.3.0",
404+
"User-Agent": "intercom-client/6.3.0",
405405
"Intercom-Version": requestOptions?.version ?? this._options?.version ?? "2.11",
406406
"X-Fern-Runtime": core.RUNTIME.type,
407407
"X-Fern-Runtime-Version": core.RUNTIME.version,

‎src/api/resources/aiContentSource/types/ContentSource.ts

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,25 +7,11 @@
77
*/
88
export interface ContentSource {
99
/** The type of the content source. */
10-
content_type: ContentSource.ContentType;
10+
content_type: "custom_answer";
1111
/** The internal URL linking to the content source for teammates. */
1212
url: string;
1313
/** The title of the content source. */
1414
title: string;
1515
/** The ISO 639 language code of the content source. */
1616
locale: string;
1717
}
18-
19-
export namespace ContentSource {
20-
/**
21-
* The type of the content source.
22-
*/
23-
export type ContentType = "file" | "article" | "external_content" | "content_snippet" | "workflow_connector_action";
24-
export const ContentType = {
25-
File: "file",
26-
Article: "article",
27-
ExternalContent: "external_content",
28-
ContentSnippet: "content_snippet",
29-
WorkflowConnectorAction: "workflow_connector_action",
30-
} as const;
31-
}

‎src/api/resources/articles/client/Client.ts

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -115,8 +115,8 @@ export class Articles {
115115
Authorization: await this._getAuthorizationHeader(),
116116
"X-Fern-Language": "JavaScript",
117117
"X-Fern-SDK-Name": "intercom-client",
118-
"X-Fern-SDK-Version": "6.2.0",
119-
"User-Agent": "intercom-client/6.2.0",
118+
"X-Fern-SDK-Version": "6.3.0",
119+
"User-Agent": "intercom-client/6.3.0",
120120
"Intercom-Version": requestOptions?.version ?? this._options?.version ?? "2.11",
121121
"X-Fern-Runtime": core.RUNTIME.type,
122122
"X-Fern-Runtime-Version": core.RUNTIME.version,
@@ -224,8 +224,8 @@ export class Articles {
224224
Authorization: await this._getAuthorizationHeader(),
225225
"X-Fern-Language": "JavaScript",
226226
"X-Fern-SDK-Name": "intercom-client",
227-
"X-Fern-SDK-Version": "6.2.0",
228-
"User-Agent": "intercom-client/6.2.0",
227+
"X-Fern-SDK-Version": "6.3.0",
228+
"User-Agent": "intercom-client/6.3.0",
229229
"Intercom-Version": requestOptions?.version ?? this._options?.version ?? "2.11",
230230
"X-Fern-Runtime": core.RUNTIME.type,
231231
"X-Fern-Runtime-Version": core.RUNTIME.version,
@@ -302,8 +302,8 @@ export class Articles {
302302
Authorization: await this._getAuthorizationHeader(),
303303
"X-Fern-Language": "JavaScript",
304304
"X-Fern-SDK-Name": "intercom-client",
305-
"X-Fern-SDK-Version": "6.2.0",
306-
"User-Agent": "intercom-client/6.2.0",
305+
"X-Fern-SDK-Version": "6.3.0",
306+
"User-Agent": "intercom-client/6.3.0",
307307
"Intercom-Version": requestOptions?.version ?? this._options?.version ?? "2.11",
308308
"X-Fern-Runtime": core.RUNTIME.type,
309309
"X-Fern-Runtime-Version": core.RUNTIME.version,
@@ -381,8 +381,8 @@ export class Articles {
381381
Authorization: await this._getAuthorizationHeader(),
382382
"X-Fern-Language": "JavaScript",
383383
"X-Fern-SDK-Name": "intercom-client",
384-
"X-Fern-SDK-Version": "6.2.0",
385-
"User-Agent": "intercom-client/6.2.0",
384+
"X-Fern-SDK-Version": "6.3.0",
385+
"User-Agent": "intercom-client/6.3.0",
386386
"Intercom-Version": requestOptions?.version ?? this._options?.version ?? "2.11",
387387
"X-Fern-Runtime": core.RUNTIME.type,
388388
"X-Fern-Runtime-Version": core.RUNTIME.version,
@@ -459,8 +459,8 @@ export class Articles {
459459
Authorization: await this._getAuthorizationHeader(),
460460
"X-Fern-Language": "JavaScript",
461461
"X-Fern-SDK-Name": "intercom-client",
462-
"X-Fern-SDK-Version": "6.2.0",
463-
"User-Agent": "intercom-client/6.2.0",
462+
"X-Fern-SDK-Version": "6.3.0",
463+
"User-Agent": "intercom-client/6.3.0",
464464
"Intercom-Version": requestOptions?.version ?? this._options?.version ?? "2.11",
465465
"X-Fern-Runtime": core.RUNTIME.type,
466466
"X-Fern-Runtime-Version": core.RUNTIME.version,
@@ -553,8 +553,8 @@ export class Articles {
553553
Authorization: await this._getAuthorizationHeader(),
554554
"X-Fern-Language": "JavaScript",
555555
"X-Fern-SDK-Name": "intercom-client",
556-
"X-Fern-SDK-Version": "6.2.0",
557-
"User-Agent": "intercom-client/6.2.0",
556+
"X-Fern-SDK-Version": "6.3.0",
557+
"User-Agent": "intercom-client/6.3.0",
558558
"Intercom-Version": requestOptions?.version ?? this._options?.version ?? "2.11",
559559
"X-Fern-Runtime": core.RUNTIME.type,
560560
"X-Fern-Runtime-Version": core.RUNTIME.version,

0 commit comments

Comments
 (0)