-
Notifications
You must be signed in to change notification settings - Fork 20
/
assistant.ts
300 lines (268 loc) · 8.67 KB
/
assistant.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
/*
* This code was generated by
* ___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
* | | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
* | |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
*
* Twilio - Versionless
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
*
* NOTE: This class is auto generated by OpenAPI Generator.
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { inspect, InspectOptions } from "util";
import Page, { TwilioResponsePayload } from "../../../base/Page";
import Response from "../../../http/response";
import Understand from "../Understand";
const deserialize = require("../../../base/deserialize");
const serialize = require("../../../base/serialize");
import { isValidPathParam } from "../../../base/utility";
/**
* Options to pass to each
*/
export interface AssistantListInstanceEachOptions {
/** How many resources to return in each list page. The default is 50, and the maximum is 1000. */
pageSize?: number;
/** Function to process each record. If this and a positional callback are passed, this one will be used */
callback?: (item: AssistantInstance, done: (err?: Error) => void) => void;
/** Function to be called upon completion of streaming */
done?: Function;
/** Upper limit for the number of records to return. each() guarantees never to return more than limit. Default is no limit */
limit?: number;
}
/**
* Options to pass to list
*/
export interface AssistantListInstanceOptions {
/** How many resources to return in each list page. The default is 50, and the maximum is 1000. */
pageSize?: number;
/** Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit */
limit?: number;
}
/**
* Options to pass to page
*/
export interface AssistantListInstancePageOptions {
/** How many resources to return in each list page. The default is 50, and the maximum is 1000. */
pageSize?: number;
/** Page Number, this value is simply for client state */
pageNumber?: number;
/** PageToken provided by the API */
pageToken?: string;
}
export interface AssistantSolution {}
export interface AssistantListInstance {
_version: Understand;
_solution: AssistantSolution;
_uri: string;
/**
* Streams AssistantInstance records from the API.
*
* This operation lazily loads records as efficiently as possible until the limit
* is reached.
*
* The results are passed into the callback function, so this operation is memory
* efficient.
*
* If a function is passed as the first argument, it will be used as the callback
* function.
*
* @param { AssistantListInstanceEachOptions } [params] - Options for request
* @param { function } [callback] - Function to process each record
*/
each(
callback?: (item: AssistantInstance, done: (err?: Error) => void) => void
): void;
each(
params: AssistantListInstanceEachOptions,
callback?: (item: AssistantInstance, done: (err?: Error) => void) => void
): void;
/**
* Retrieve a single target page of AssistantInstance records from the API.
*
* The request is executed immediately.
*
* @param { string } [targetUrl] - API-generated URL for the requested results page
* @param { function } [callback] - Callback to handle list of records
*/
getPage(
targetUrl: string,
callback?: (error: Error | null, items: AssistantPage) => any
): Promise<AssistantPage>;
/**
* Lists AssistantInstance records from the API as a list.
*
* If a function is passed as the first argument, it will be used as the callback
* function.
*
* @param { AssistantListInstanceOptions } [params] - Options for request
* @param { function } [callback] - Callback to handle list of records
*/
list(
callback?: (error: Error | null, items: AssistantInstance[]) => any
): Promise<AssistantInstance[]>;
list(
params: AssistantListInstanceOptions,
callback?: (error: Error | null, items: AssistantInstance[]) => any
): Promise<AssistantInstance[]>;
/**
* Retrieve a single page of AssistantInstance records from the API.
*
* The request is executed immediately.
*
* If a function is passed as the first argument, it will be used as the callback
* function.
*
* @param { AssistantListInstancePageOptions } [params] - Options for request
* @param { function } [callback] - Callback to handle list of records
*/
page(
callback?: (error: Error | null, items: AssistantPage) => any
): Promise<AssistantPage>;
page(
params: AssistantListInstancePageOptions,
callback?: (error: Error | null, items: AssistantPage) => any
): Promise<AssistantPage>;
/**
* Provide a user-friendly representation
*/
toJSON(): any;
[inspect.custom](_depth: any, options: InspectOptions): any;
}
export function AssistantListInstance(
version: Understand
): AssistantListInstance {
const instance = {} as AssistantListInstance;
instance._version = version;
instance._solution = {};
instance._uri = `/Assistants`;
instance.page = function page(
params?:
| AssistantListInstancePageOptions
| ((error: Error | null, items: AssistantPage) => any),
callback?: (error: Error | null, items: AssistantPage) => any
): Promise<AssistantPage> {
if (params instanceof Function) {
callback = params;
params = {};
} else {
params = params || {};
}
let data: any = {};
if (params["pageSize"] !== undefined) data["PageSize"] = params["pageSize"];
if (params.pageNumber !== undefined) data["Page"] = params.pageNumber;
if (params.pageToken !== undefined) data["PageToken"] = params.pageToken;
const headers: any = {};
let operationVersion = version,
operationPromise = operationVersion.page({
uri: instance._uri,
method: "get",
params: data,
headers,
});
operationPromise = operationPromise.then(
(payload) =>
new AssistantPage(operationVersion, payload, instance._solution)
);
operationPromise = instance._version.setPromiseCallback(
operationPromise,
callback
);
return operationPromise;
};
instance.each = instance._version.each;
instance.list = instance._version.list;
instance.getPage = function getPage(
targetUrl: string,
callback?: (error: Error | null, items: AssistantPage) => any
): Promise<AssistantPage> {
const operationPromise = instance._version._domain.twilio.request({
method: "get",
uri: targetUrl,
});
let pagePromise = operationPromise.then(
(payload) =>
new AssistantPage(instance._version, payload, instance._solution)
);
pagePromise = instance._version.setPromiseCallback(pagePromise, callback);
return pagePromise;
};
instance.toJSON = function toJSON() {
return instance._solution;
};
instance[inspect.custom] = function inspectImpl(
_depth: any,
options: InspectOptions
) {
return inspect(instance.toJSON(), options);
};
return instance;
}
interface AssistantPayload extends TwilioResponsePayload {
assistants: AssistantResource[];
}
interface AssistantResource {
sid: string;
friendly_name: string;
}
export class AssistantInstance {
constructor(protected _version: Understand, payload: AssistantResource) {
this.sid = payload.sid;
this.friendlyName = payload.friendly_name;
}
/**
* A string that uniquely identifies this Fleet.
*/
sid: string;
/**
* A human readable description for this Fleet.
*/
friendlyName: string;
/**
* Provide a user-friendly representation
*
* @returns Object
*/
toJSON() {
return {
sid: this.sid,
friendlyName: this.friendlyName,
};
}
[inspect.custom](_depth: any, options: InspectOptions) {
return inspect(this.toJSON(), options);
}
}
export class AssistantPage extends Page<
Understand,
AssistantPayload,
AssistantResource,
AssistantInstance
> {
/**
* Initialize the AssistantPage
*
* @param version - Version of the resource
* @param response - Response from the API
* @param solution - Path solution
*/
constructor(
version: Understand,
response: Response<string>,
solution: AssistantSolution
) {
super(version, response, solution);
}
/**
* Build an instance of AssistantInstance
*
* @param payload - Payload response from the API
*/
getInstance(payload: AssistantResource): AssistantInstance {
return new AssistantInstance(this._version, payload);
}
[inspect.custom](depth: any, options: InspectOptions) {
return inspect(this.toJSON(), options);
}
}