Skip to content

Commit eadf458

Browse files
stainless-app[bot]stainless-bot
stainless-app[bot]
authored and
stainless-bot
committed
feat(api): update via SDK Studio (#423)
1 parent c9ffc43 commit eadf458

File tree

6 files changed

+82
-83
lines changed

6 files changed

+82
-83
lines changed

‎api.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,11 @@ Methods:
7979

8080
# HelpCenter
8181

82+
Types:
83+
84+
- <code><a href="./src/resources/help-center/help-center.ts">HelpCenter</a></code>
85+
- <code><a href="./src/resources/help-center/help-center.ts">HelpCenterList</a></code>
86+
8287
## Collections
8388

8489
Types:
@@ -97,11 +102,6 @@ Methods:
97102

98103
## HelpCenters
99104

100-
Types:
101-
102-
- <code><a href="./src/resources/help-center/help-centers.ts">HelpCenter</a></code>
103-
- <code><a href="./src/resources/help-center/help-centers.ts">HelpCenterList</a></code>
104-
105105
Methods:
106106

107107
- <code title="get /help_center/help_centers/{id}">client.helpCenter.helpCenters.<a href="./src/resources/help-center/help-centers.ts">retrieve</a>(id, { ...params }) -> HelpCenter</code>

‎src/index.ts‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ export class Intercom extends Core.APIClient {
149149
me: API.Me = new API.Me(this);
150150
admins: API.Admins = new API.Admins(this);
151151
articles: API.Articles = new API.Articles(this);
152-
helpCenter: API.HelpCenter = new API.HelpCenter(this);
152+
helpCenter: API.HelpCenterResource = new API.HelpCenterResource(this);
153153
companies: API.Companies = new API.Companies(this);
154154
contacts: API.Contacts = new API.Contacts(this);
155155
conversations: API.Conversations = new API.Conversations(this);
@@ -257,7 +257,9 @@ export namespace Intercom {
257257
export import ArticleRemoveParams = API.ArticleRemoveParams;
258258
export import ArticleSearchParams = API.ArticleSearchParams;
259259

260+
export import HelpCenterResource = API.HelpCenterResource;
260261
export import HelpCenter = API.HelpCenter;
262+
export import HelpCenterList = API.HelpCenterList;
261263

262264
export import Companies = API.Companies;
263265
export import CompanyList = API.CompanyList;

‎src/resources/help-center/help-center.ts‎

Lines changed: 61 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,74 @@
11
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
22

33
import { APIResource } from '../../resource';
4+
import * as HelpCenterAPI from './help-center';
45
import * as CollectionsAPI from './collections';
56
import * as HelpCentersAPI from './help-centers';
67

7-
export class HelpCenter extends APIResource {
8+
export class HelpCenterResource extends APIResource {
89
collections: CollectionsAPI.Collections = new CollectionsAPI.Collections(this._client);
910
helpCenters: HelpCentersAPI.HelpCenters = new HelpCentersAPI.HelpCenters(this._client);
1011
}
1112

12-
export namespace HelpCenter {
13+
/**
14+
* Help Centers contain collections
15+
*/
16+
export interface HelpCenter {
17+
/**
18+
* The unique identifier for the Help Center which is given by Intercom.
19+
*/
20+
id?: string;
21+
22+
/**
23+
* The time when the Help Center was created.
24+
*/
25+
created_at?: number;
26+
27+
/**
28+
* The display name of the Help Center only seen by teammates.
29+
*/
30+
display_name?: string;
31+
32+
/**
33+
* The identifier of the Help Center. This is used in the URL of the Help Center.
34+
*/
35+
identifier?: string;
36+
37+
/**
38+
* The time when the Help Center was last updated.
39+
*/
40+
updated_at?: number;
41+
42+
/**
43+
* Whether the Help Center is turned on or not. This is controlled in your Help
44+
* Center settings.
45+
*/
46+
website_turned_on?: boolean;
47+
48+
/**
49+
* The id of the workspace which the Help Center belongs to.
50+
*/
51+
workspace_id?: string;
52+
}
53+
54+
/**
55+
* A list of Help Centers belonging to the App
56+
*/
57+
export interface HelpCenterList {
58+
/**
59+
* An array of Help Center objects
60+
*/
61+
data?: Array<HelpCenter>;
62+
63+
/**
64+
* The type of the object - `list`.
65+
*/
66+
type?: 'list';
67+
}
68+
69+
export namespace HelpCenterResource {
70+
export import HelpCenter = HelpCenterAPI.HelpCenter;
71+
export import HelpCenterList = HelpCenterAPI.HelpCenterList;
1372
export import Collections = CollectionsAPI.Collections;
1473
export import Collection = CollectionsAPI.Collection;
1574
export import CollectionList = CollectionsAPI.CollectionList;
@@ -20,8 +79,6 @@ export namespace HelpCenter {
2079
export import CollectionListParams = CollectionsAPI.CollectionListParams;
2180
export import CollectionDeleteParams = CollectionsAPI.CollectionDeleteParams;
2281
export import HelpCenters = HelpCentersAPI.HelpCenters;
23-
export import HelpCenter = HelpCentersAPI.HelpCenter;
24-
export import HelpCenterList = HelpCentersAPI.HelpCenterList;
2582
export import HelpCenterRetrieveParams = HelpCentersAPI.HelpCenterRetrieveParams;
2683
export import HelpCenterListParams = HelpCentersAPI.HelpCenterListParams;
2784
}

‎src/resources/help-center/help-centers.ts‎

Lines changed: 10 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ import { APIResource } from '../../resource';
44
import { isRequestOptions } from '../../core';
55
import * as Core from '../../core';
66
import * as HelpCentersAPI from './help-centers';
7+
import * as HelpCenterAPI from './help-center';
78

89
export class HelpCenters extends APIResource {
910
/**
@@ -14,13 +15,13 @@ export class HelpCenters extends APIResource {
1415
id: number,
1516
params?: HelpCenterRetrieveParams,
1617
options?: Core.RequestOptions,
17-
): Core.APIPromise<HelpCenter>;
18-
retrieve(id: number, options?: Core.RequestOptions): Core.APIPromise<HelpCenter>;
18+
): Core.APIPromise<HelpCenterAPI.HelpCenter>;
19+
retrieve(id: number, options?: Core.RequestOptions): Core.APIPromise<HelpCenterAPI.HelpCenter>;
1920
retrieve(
2021
id: number,
2122
params: HelpCenterRetrieveParams | Core.RequestOptions = {},
2223
options?: Core.RequestOptions,
23-
): Core.APIPromise<HelpCenter> {
24+
): Core.APIPromise<HelpCenterAPI.HelpCenter> {
2425
if (isRequestOptions(params)) {
2526
return this.retrieve(id, {}, params);
2627
}
@@ -40,12 +41,15 @@ export class HelpCenters extends APIResource {
4041
* You can list all Help Centers by making a GET request to
4142
* `https://api.intercom.io/help_center/help_centers`.
4243
*/
43-
list(params?: HelpCenterListParams, options?: Core.RequestOptions): Core.APIPromise<HelpCenterList>;
44-
list(options?: Core.RequestOptions): Core.APIPromise<HelpCenterList>;
44+
list(
45+
params?: HelpCenterListParams,
46+
options?: Core.RequestOptions,
47+
): Core.APIPromise<HelpCenterAPI.HelpCenterList>;
48+
list(options?: Core.RequestOptions): Core.APIPromise<HelpCenterAPI.HelpCenterList>;
4549
list(
4650
params: HelpCenterListParams | Core.RequestOptions = {},
4751
options?: Core.RequestOptions,
48-
): Core.APIPromise<HelpCenterList> {
52+
): Core.APIPromise<HelpCenterAPI.HelpCenterList> {
4953
if (isRequestOptions(params)) {
5054
return this.list({}, params);
5155
}
@@ -62,62 +66,6 @@ export class HelpCenters extends APIResource {
6266
}
6367
}
6468

65-
/**
66-
* Help Centers contain collections
67-
*/
68-
export interface HelpCenter {
69-
/**
70-
* The unique identifier for the Help Center which is given by Intercom.
71-
*/
72-
id?: string;
73-
74-
/**
75-
* The time when the Help Center was created.
76-
*/
77-
created_at?: number;
78-
79-
/**
80-
* The display name of the Help Center only seen by teammates.
81-
*/
82-
display_name?: string;
83-
84-
/**
85-
* The identifier of the Help Center. This is used in the URL of the Help Center.
86-
*/
87-
identifier?: string;
88-
89-
/**
90-
* The time when the Help Center was last updated.
91-
*/
92-
updated_at?: number;
93-
94-
/**
95-
* Whether the Help Center is turned on or not. This is controlled in your Help
96-
* Center settings.
97-
*/
98-
website_turned_on?: boolean;
99-
100-
/**
101-
* The id of the workspace which the Help Center belongs to.
102-
*/
103-
workspace_id?: string;
104-
}
105-
106-
/**
107-
* A list of Help Centers belonging to the App
108-
*/
109-
export interface HelpCenterList {
110-
/**
111-
* An array of Help Center objects
112-
*/
113-
data?: Array<HelpCenter>;
114-
115-
/**
116-
* The type of the object - `list`.
117-
*/
118-
type?: 'list';
119-
}
120-
12169
export interface HelpCenterRetrieveParams {
12270
/**
12371
* Intercom API version.By default, it's equal to the version set in the app
@@ -171,8 +119,6 @@ export interface HelpCenterListParams {
171119
}
172120

173121
export namespace HelpCenters {
174-
export import HelpCenter = HelpCentersAPI.HelpCenter;
175-
export import HelpCenterList = HelpCentersAPI.HelpCenterList;
176122
export import HelpCenterRetrieveParams = HelpCentersAPI.HelpCenterRetrieveParams;
177123
export import HelpCenterListParams = HelpCentersAPI.HelpCenterListParams;
178124
}

‎src/resources/help-center/index.ts‎

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,5 @@ export {
1111
CollectionDeleteParams,
1212
Collections,
1313
} from './collections';
14-
export { HelpCenter } from './help-center';
15-
export {
16-
HelpCenter,
17-
HelpCenterList,
18-
HelpCenterRetrieveParams,
19-
HelpCenterListParams,
20-
HelpCenters,
21-
} from './help-centers';
14+
export { HelpCenter, HelpCenterList, HelpCenterResource } from './help-center';
15+
export { HelpCenterRetrieveParams, HelpCenterListParams, HelpCenters } from './help-centers';

‎src/resources/index.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ export {
7676
export { DataExport, DataExportContentDataParams, DataExports } from './data-exports';
7777
export { Download } from './download/download';
7878
export { ExportCancelParams, Export } from './export/export';
79-
export { HelpCenter } from './help-center/help-center';
79+
export { HelpCenter, HelpCenterList, HelpCenterResource } from './help-center/help-center';
8080
export { MessageCreateParams, Messages } from './messages';
8181
export { News } from './news/news';
8282
export { NoteRetrieveParams, Notes } from './notes';

0 commit comments

Comments
 (0)