/
channel.ts
369 lines (328 loc) · 10.1 KB
/
channel.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
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
/*
* This code was generated by
* ___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
* | | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
* | |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
*
* Twilio - Chat
* This is the public Twilio REST API.
*
* 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 V3 from "../V3";
const deserialize = require("../../../base/deserialize");
const serialize = require("../../../base/serialize");
import { isValidPathParam } from "../../../base/utility";
type ChannelChannelType = "public" | "private";
type ChannelWebhookEnabledType = "true" | "false";
/**
* Options to pass to update a ChannelInstance
*/
export interface ChannelContextUpdateOptions {
/** The X-Twilio-Webhook-Enabled HTTP request header */
xTwilioWebhookEnabled?: ChannelWebhookEnabledType;
/** */
type?: ChannelChannelType;
/** The unique ID of the [Messaging Service](https://www.twilio.com/docs/sms/services/api) this channel belongs to. */
messagingServiceSid?: string;
}
export interface ChannelContext {
/**
* Update a ChannelInstance
*
* @param callback - Callback to handle processed record
*
* @returns Resolves to processed ChannelInstance
*/
update(
callback?: (error: Error | null, item?: ChannelInstance) => any
): Promise<ChannelInstance>;
/**
* Update a ChannelInstance
*
* @param params - Parameter for request
* @param callback - Callback to handle processed record
*
* @returns Resolves to processed ChannelInstance
*/
update(
params: ChannelContextUpdateOptions,
callback?: (error: Error | null, item?: ChannelInstance) => any
): Promise<ChannelInstance>;
/**
* Provide a user-friendly representation
*/
toJSON(): any;
[inspect.custom](_depth: any, options: InspectOptions): any;
}
export interface ChannelContextSolution {
serviceSid: string;
sid: string;
}
export class ChannelContextImpl implements ChannelContext {
protected _solution: ChannelContextSolution;
protected _uri: string;
constructor(protected _version: V3, serviceSid: string, sid: string) {
if (!isValidPathParam(serviceSid)) {
throw new Error("Parameter 'serviceSid' is not valid.");
}
if (!isValidPathParam(sid)) {
throw new Error("Parameter 'sid' is not valid.");
}
this._solution = { serviceSid, sid };
this._uri = `/Services/${serviceSid}/Channels/${sid}`;
}
update(
params?:
| ChannelContextUpdateOptions
| ((error: Error | null, item?: ChannelInstance) => any),
callback?: (error: Error | null, item?: ChannelInstance) => any
): Promise<ChannelInstance> {
if (params instanceof Function) {
callback = params;
params = {};
} else {
params = params || {};
}
let data: any = {};
if (params["type"] !== undefined) data["Type"] = params["type"];
if (params["messagingServiceSid"] !== undefined)
data["MessagingServiceSid"] = params["messagingServiceSid"];
const headers: any = {};
headers["Content-Type"] = "application/x-www-form-urlencoded";
if (params["xTwilioWebhookEnabled"] !== undefined)
headers["X-Twilio-Webhook-Enabled"] = params["xTwilioWebhookEnabled"];
const instance = this;
let operationVersion = instance._version,
operationPromise = operationVersion.update({
uri: instance._uri,
method: "post",
data,
headers,
});
operationPromise = operationPromise.then(
(payload) =>
new ChannelInstance(
operationVersion,
payload,
instance._solution.serviceSid,
instance._solution.sid
)
);
operationPromise = instance._version.setPromiseCallback(
operationPromise,
callback
);
return operationPromise;
}
/**
* Provide a user-friendly representation
*
* @returns Object
*/
toJSON() {
return this._solution;
}
[inspect.custom](_depth: any, options: InspectOptions) {
return inspect(this.toJSON(), options);
}
}
interface ChannelPayload extends ChannelResource {}
interface ChannelResource {
sid: string;
account_sid: string;
service_sid: string;
friendly_name: string;
unique_name: string;
attributes: string;
type: ChannelChannelType;
date_created: Date;
date_updated: Date;
created_by: string;
members_count: number;
messages_count: number;
messaging_service_sid: string;
url: string;
}
export class ChannelInstance {
protected _solution: ChannelContextSolution;
protected _context?: ChannelContext;
constructor(
protected _version: V3,
payload: ChannelResource,
serviceSid?: string,
sid?: string
) {
this.sid = payload.sid;
this.accountSid = payload.account_sid;
this.serviceSid = payload.service_sid;
this.friendlyName = payload.friendly_name;
this.uniqueName = payload.unique_name;
this.attributes = payload.attributes;
this.type = payload.type;
this.dateCreated = deserialize.iso8601DateTime(payload.date_created);
this.dateUpdated = deserialize.iso8601DateTime(payload.date_updated);
this.createdBy = payload.created_by;
this.membersCount = deserialize.integer(payload.members_count);
this.messagesCount = deserialize.integer(payload.messages_count);
this.messagingServiceSid = payload.messaging_service_sid;
this.url = payload.url;
this._solution = {
serviceSid: serviceSid || this.serviceSid,
sid: sid || this.sid,
};
}
/**
* The unique string that we created to identify the Channel resource.
*/
sid: string;
/**
* The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Channel resource.
*/
accountSid: string;
/**
* The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Channel resource is associated with.
*/
serviceSid: string;
/**
* The string that you assigned to describe the resource.
*/
friendlyName: string;
/**
* An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource\'s `sid` in the URL.
*/
uniqueName: string;
/**
* The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned.
*/
attributes: string;
type: ChannelChannelType;
/**
* The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
*/
dateCreated: Date;
/**
* The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
*/
dateUpdated: Date;
/**
* The `identity` of the User that created the channel. If the Channel was created by using the API, the value is `system`.
*/
createdBy: string;
/**
* The number of Members in the Channel.
*/
membersCount: number;
/**
* The number of Messages that have been passed in the Channel.
*/
messagesCount: number;
/**
* The unique ID of the [Messaging Service](https://www.twilio.com/docs/sms/services/api) this channel belongs to.
*/
messagingServiceSid: string;
/**
* The absolute URL of the Channel resource.
*/
url: string;
private get _proxy(): ChannelContext {
this._context =
this._context ||
new ChannelContextImpl(
this._version,
this._solution.serviceSid,
this._solution.sid
);
return this._context;
}
/**
* Update a ChannelInstance
*
* @param callback - Callback to handle processed record
*
* @returns Resolves to processed ChannelInstance
*/
update(
callback?: (error: Error | null, item?: ChannelInstance) => any
): Promise<ChannelInstance>;
/**
* Update a ChannelInstance
*
* @param params - Parameter for request
* @param callback - Callback to handle processed record
*
* @returns Resolves to processed ChannelInstance
*/
update(
params: ChannelContextUpdateOptions,
callback?: (error: Error | null, item?: ChannelInstance) => any
): Promise<ChannelInstance>;
update(
params?: any,
callback?: (error: Error | null, item?: ChannelInstance) => any
): Promise<ChannelInstance> {
return this._proxy.update(params, callback);
}
/**
* Provide a user-friendly representation
*
* @returns Object
*/
toJSON() {
return {
sid: this.sid,
accountSid: this.accountSid,
serviceSid: this.serviceSid,
friendlyName: this.friendlyName,
uniqueName: this.uniqueName,
attributes: this.attributes,
type: this.type,
dateCreated: this.dateCreated,
dateUpdated: this.dateUpdated,
createdBy: this.createdBy,
membersCount: this.membersCount,
messagesCount: this.messagesCount,
messagingServiceSid: this.messagingServiceSid,
url: this.url,
};
}
[inspect.custom](_depth: any, options: InspectOptions) {
return inspect(this.toJSON(), options);
}
}
export interface ChannelSolution {}
export interface ChannelListInstance {
_version: V3;
_solution: ChannelSolution;
_uri: string;
(serviceSid: string, sid: string): ChannelContext;
get(serviceSid: string, sid: string): ChannelContext;
/**
* Provide a user-friendly representation
*/
toJSON(): any;
[inspect.custom](_depth: any, options: InspectOptions): any;
}
export function ChannelListInstance(version: V3): ChannelListInstance {
const instance = ((serviceSid, sid) =>
instance.get(serviceSid, sid)) as ChannelListInstance;
instance.get = function get(serviceSid, sid): ChannelContext {
return new ChannelContextImpl(version, serviceSid, sid);
};
instance._version = version;
instance._solution = {};
instance._uri = ``;
instance.toJSON = function toJSON() {
return instance._solution;
};
instance[inspect.custom] = function inspectImpl(
_depth: any,
options: InspectOptions
) {
return inspect(instance.toJSON(), options);
};
return instance;
}