/
notification.ts
416 lines (372 loc) · 13.2 KB
/
notification.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
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
/*
* This code was generated by
* ___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
* | | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
* | |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
*
* Twilio - Conversations
* 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 V1 from "../../../V1";
const deserialize = require("../../../../../base/deserialize");
const serialize = require("../../../../../base/serialize");
import { isValidPathParam } from "../../../../../base/utility";
/**
* Options to pass to update a NotificationInstance
*/
export interface NotificationContextUpdateOptions {
/** Weather the notification logging is enabled. */
logEnabled?: boolean;
/** Whether to send a notification when a new message is added to a conversation. The default is `false`. */
"newMessage.enabled"?: boolean;
/** The template to use to create the notification text displayed when a new message is added to a conversation and `new_message.enabled` is `true`. */
"newMessage.template"?: string;
/** The name of the sound to play when a new message is added to a conversation and `new_message.enabled` is `true`. */
"newMessage.sound"?: string;
/** Whether the new message badge is enabled. The default is `false`. */
"newMessage.badgeCountEnabled"?: boolean;
/** Whether to send a notification when a participant is added to a conversation. The default is `false`. */
"addedToConversation.enabled"?: boolean;
/** The template to use to create the notification text displayed when a participant is added to a conversation and `added_to_conversation.enabled` is `true`. */
"addedToConversation.template"?: string;
/** The name of the sound to play when a participant is added to a conversation and `added_to_conversation.enabled` is `true`. */
"addedToConversation.sound"?: string;
/** Whether to send a notification to a user when they are removed from a conversation. The default is `false`. */
"removedFromConversation.enabled"?: boolean;
/** The template to use to create the notification text displayed to a user when they are removed from a conversation and `removed_from_conversation.enabled` is `true`. */
"removedFromConversation.template"?: string;
/** The name of the sound to play to a user when they are removed from a conversation and `removed_from_conversation.enabled` is `true`. */
"removedFromConversation.sound"?: string;
/** Whether to send a notification when a new message with media/file attachments is added to a conversation. The default is `false`. */
"newMessage.withMedia.enabled"?: boolean;
/** The template to use to create the notification text displayed when a new message with media/file attachments is added to a conversation and `new_message.attachments.enabled` is `true`. */
"newMessage.withMedia.template"?: string;
}
export interface NotificationContext {
/**
* Fetch a NotificationInstance
*
* @param callback - Callback to handle processed record
*
* @returns Resolves to processed NotificationInstance
*/
fetch(
callback?: (error: Error | null, item?: NotificationInstance) => any
): Promise<NotificationInstance>;
/**
* Update a NotificationInstance
*
* @param callback - Callback to handle processed record
*
* @returns Resolves to processed NotificationInstance
*/
update(
callback?: (error: Error | null, item?: NotificationInstance) => any
): Promise<NotificationInstance>;
/**
* Update a NotificationInstance
*
* @param params - Parameter for request
* @param callback - Callback to handle processed record
*
* @returns Resolves to processed NotificationInstance
*/
update(
params: NotificationContextUpdateOptions,
callback?: (error: Error | null, item?: NotificationInstance) => any
): Promise<NotificationInstance>;
/**
* Provide a user-friendly representation
*/
toJSON(): any;
[inspect.custom](_depth: any, options: InspectOptions): any;
}
export interface NotificationContextSolution {
chatServiceSid: string;
}
export class NotificationContextImpl implements NotificationContext {
protected _solution: NotificationContextSolution;
protected _uri: string;
constructor(protected _version: V1, chatServiceSid: string) {
if (!isValidPathParam(chatServiceSid)) {
throw new Error("Parameter 'chatServiceSid' is not valid.");
}
this._solution = { chatServiceSid };
this._uri = `/Services/${chatServiceSid}/Configuration/Notifications`;
}
fetch(
callback?: (error: Error | null, item?: NotificationInstance) => any
): Promise<NotificationInstance> {
const instance = this;
let operationVersion = instance._version,
operationPromise = operationVersion.fetch({
uri: instance._uri,
method: "get",
});
operationPromise = operationPromise.then(
(payload) =>
new NotificationInstance(
operationVersion,
payload,
instance._solution.chatServiceSid
)
);
operationPromise = instance._version.setPromiseCallback(
operationPromise,
callback
);
return operationPromise;
}
update(
params?:
| NotificationContextUpdateOptions
| ((error: Error | null, item?: NotificationInstance) => any),
callback?: (error: Error | null, item?: NotificationInstance) => any
): Promise<NotificationInstance> {
if (params instanceof Function) {
callback = params;
params = {};
} else {
params = params || {};
}
let data: any = {};
if (params["logEnabled"] !== undefined)
data["LogEnabled"] = serialize.bool(params["logEnabled"]);
if (params["newMessage.enabled"] !== undefined)
data["NewMessage.Enabled"] = serialize.bool(params["newMessage.enabled"]);
if (params["newMessage.template"] !== undefined)
data["NewMessage.Template"] = params["newMessage.template"];
if (params["newMessage.sound"] !== undefined)
data["NewMessage.Sound"] = params["newMessage.sound"];
if (params["newMessage.badgeCountEnabled"] !== undefined)
data["NewMessage.BadgeCountEnabled"] = serialize.bool(
params["newMessage.badgeCountEnabled"]
);
if (params["addedToConversation.enabled"] !== undefined)
data["AddedToConversation.Enabled"] = serialize.bool(
params["addedToConversation.enabled"]
);
if (params["addedToConversation.template"] !== undefined)
data["AddedToConversation.Template"] =
params["addedToConversation.template"];
if (params["addedToConversation.sound"] !== undefined)
data["AddedToConversation.Sound"] = params["addedToConversation.sound"];
if (params["removedFromConversation.enabled"] !== undefined)
data["RemovedFromConversation.Enabled"] = serialize.bool(
params["removedFromConversation.enabled"]
);
if (params["removedFromConversation.template"] !== undefined)
data["RemovedFromConversation.Template"] =
params["removedFromConversation.template"];
if (params["removedFromConversation.sound"] !== undefined)
data["RemovedFromConversation.Sound"] =
params["removedFromConversation.sound"];
if (params["newMessage.withMedia.enabled"] !== undefined)
data["NewMessage.WithMedia.Enabled"] = serialize.bool(
params["newMessage.withMedia.enabled"]
);
if (params["newMessage.withMedia.template"] !== undefined)
data["NewMessage.WithMedia.Template"] =
params["newMessage.withMedia.template"];
const headers: any = {};
headers["Content-Type"] = "application/x-www-form-urlencoded";
const instance = this;
let operationVersion = instance._version,
operationPromise = operationVersion.update({
uri: instance._uri,
method: "post",
data,
headers,
});
operationPromise = operationPromise.then(
(payload) =>
new NotificationInstance(
operationVersion,
payload,
instance._solution.chatServiceSid
)
);
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 NotificationPayload extends NotificationResource {}
interface NotificationResource {
account_sid: string;
chat_service_sid: string;
new_message: any;
added_to_conversation: any;
removed_from_conversation: any;
log_enabled: boolean;
url: string;
}
export class NotificationInstance {
protected _solution: NotificationContextSolution;
protected _context?: NotificationContext;
constructor(
protected _version: V1,
payload: NotificationResource,
chatServiceSid: string
) {
this.accountSid = payload.account_sid;
this.chatServiceSid = payload.chat_service_sid;
this.newMessage = payload.new_message;
this.addedToConversation = payload.added_to_conversation;
this.removedFromConversation = payload.removed_from_conversation;
this.logEnabled = payload.log_enabled;
this.url = payload.url;
this._solution = { chatServiceSid };
}
/**
* The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this configuration.
*/
accountSid: string;
/**
* The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Configuration applies to.
*/
chatServiceSid: string;
/**
* The Push Notification configuration for New Messages.
*/
newMessage: any;
/**
* The Push Notification configuration for being added to a Conversation.
*/
addedToConversation: any;
/**
* The Push Notification configuration for being removed from a Conversation.
*/
removedFromConversation: any;
/**
* Weather the notification logging is enabled.
*/
logEnabled: boolean;
/**
* An absolute API resource URL for this configuration.
*/
url: string;
private get _proxy(): NotificationContext {
this._context =
this._context ||
new NotificationContextImpl(this._version, this._solution.chatServiceSid);
return this._context;
}
/**
* Fetch a NotificationInstance
*
* @param callback - Callback to handle processed record
*
* @returns Resolves to processed NotificationInstance
*/
fetch(
callback?: (error: Error | null, item?: NotificationInstance) => any
): Promise<NotificationInstance> {
return this._proxy.fetch(callback);
}
/**
* Update a NotificationInstance
*
* @param callback - Callback to handle processed record
*
* @returns Resolves to processed NotificationInstance
*/
update(
callback?: (error: Error | null, item?: NotificationInstance) => any
): Promise<NotificationInstance>;
/**
* Update a NotificationInstance
*
* @param params - Parameter for request
* @param callback - Callback to handle processed record
*
* @returns Resolves to processed NotificationInstance
*/
update(
params: NotificationContextUpdateOptions,
callback?: (error: Error | null, item?: NotificationInstance) => any
): Promise<NotificationInstance>;
update(
params?: any,
callback?: (error: Error | null, item?: NotificationInstance) => any
): Promise<NotificationInstance> {
return this._proxy.update(params, callback);
}
/**
* Provide a user-friendly representation
*
* @returns Object
*/
toJSON() {
return {
accountSid: this.accountSid,
chatServiceSid: this.chatServiceSid,
newMessage: this.newMessage,
addedToConversation: this.addedToConversation,
removedFromConversation: this.removedFromConversation,
logEnabled: this.logEnabled,
url: this.url,
};
}
[inspect.custom](_depth: any, options: InspectOptions) {
return inspect(this.toJSON(), options);
}
}
export interface NotificationSolution {
chatServiceSid: string;
}
export interface NotificationListInstance {
_version: V1;
_solution: NotificationSolution;
_uri: string;
(): NotificationContext;
get(): NotificationContext;
/**
* Provide a user-friendly representation
*/
toJSON(): any;
[inspect.custom](_depth: any, options: InspectOptions): any;
}
export function NotificationListInstance(
version: V1,
chatServiceSid: string
): NotificationListInstance {
if (!isValidPathParam(chatServiceSid)) {
throw new Error("Parameter 'chatServiceSid' is not valid.");
}
const instance = (() => instance.get()) as NotificationListInstance;
instance.get = function get(): NotificationContext {
return new NotificationContextImpl(version, chatServiceSid);
};
instance._version = version;
instance._solution = { chatServiceSid };
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;
}