/
tollFree.ts
756 lines (710 loc) · 27.8 KB
/
tollFree.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
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
/*
* This code was generated by
* ___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
* | | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
* | |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
*
* Twilio - Api
* 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 Page, { TwilioResponsePayload } from "../../../../../base/Page";
import Response from "../../../../../http/response";
import V2010 from "../../../V2010";
const deserialize = require("../../../../../base/deserialize");
const serialize = require("../../../../../base/serialize");
import { isValidPathParam } from "../../../../../base/utility";
import { PhoneNumberCapabilities } from "../../../../../../src/interfaces";
type IncomingPhoneNumberTollFreeAddressRequirement =
| "none"
| "any"
| "local"
| "foreign";
type IncomingPhoneNumberTollFreeEmergencyAddressStatus =
| "registered"
| "unregistered"
| "pending-registration"
| "registration-failure"
| "pending-unregistration"
| "unregistration-failure";
type IncomingPhoneNumberTollFreeEmergencyStatus = "Active" | "Inactive";
type IncomingPhoneNumberTollFreeVoiceReceiveMode = "voice" | "fax";
/**
* Options to pass to create a TollFreeInstance
*/
export interface TollFreeListInstanceCreateOptions {
/** The phone number to purchase specified in [E.164](https://www.twilio.com/docs/glossary/what-e164) format. E.164 phone numbers consist of a + followed by the country code and subscriber number without punctuation characters. For example, +14155551234. */
phoneNumber: string;
/** The API version to use for incoming calls made to the new phone number. The default is `2010-04-01`. */
apiVersion?: string;
/** A descriptive string that you created to describe the new phone number. It can be up to 64 characters long. By default, this is a formatted version of the phone number. */
friendlyName?: string;
/** The SID of the application that should handle SMS messages sent to the new phone number. If an `sms_application_sid` is present, we ignore all `sms_*_url` values and use those of the application. */
smsApplicationSid?: string;
/** The HTTP method that we should use to call `sms_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`. */
smsFallbackMethod?: string;
/** The URL that we should call when an error occurs while requesting or executing the TwiML defined by `sms_url`. */
smsFallbackUrl?: string;
/** The HTTP method that we should use to call `sms_url`. Can be: `GET` or `POST` and defaults to `POST`. */
smsMethod?: string;
/** The URL we should call when the new phone number receives an incoming SMS message. */
smsUrl?: string;
/** The URL we should call using the `status_callback_method` to send status information to your application. */
statusCallback?: string;
/** The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST` and defaults to `POST`. */
statusCallbackMethod?: string;
/** The SID of the application we should use to handle calls to the new phone number. If a `voice_application_sid` is present, we ignore all of the voice urls and use those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa. */
voiceApplicationSid?: string;
/** Whether to lookup the caller\\\'s name from the CNAM database and post it to your app. Can be: `true` or `false` and defaults to `false`. */
voiceCallerIdLookup?: boolean;
/** The HTTP method that we should use to call `voice_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`. */
voiceFallbackMethod?: string;
/** The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`. */
voiceFallbackUrl?: string;
/** The HTTP method that we should use to call `voice_url`. Can be: `GET` or `POST` and defaults to `POST`. */
voiceMethod?: string;
/** The URL that we should call to answer a call to the new phone number. The `voice_url` will not be called if a `voice_application_sid` or a `trunk_sid` is set. */
voiceUrl?: string;
/** The SID of the Identity resource that we should associate with the new phone number. Some regions require an Identity to meet local regulations. */
identitySid?: string;
/** The SID of the Address resource we should associate with the new phone number. Some regions require addresses to meet local regulations. */
addressSid?: string;
/** */
emergencyStatus?: IncomingPhoneNumberTollFreeEmergencyStatus;
/** The SID of the emergency address configuration to use for emergency calling from the new phone number. */
emergencyAddressSid?: string;
/** The SID of the Trunk we should use to handle calls to the new phone number. If a `trunk_sid` is present, we ignore all of the voice urls and voice applications and use only those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa. */
trunkSid?: string;
/** */
voiceReceiveMode?: IncomingPhoneNumberTollFreeVoiceReceiveMode;
/** The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations. */
bundleSid?: string;
}
/**
* Options to pass to each
*/
export interface TollFreeListInstanceEachOptions {
/** Whether to include phone numbers new to the Twilio platform. Can be: `true` or `false` and the default is `true`. */
beta?: boolean;
/** A string that identifies the resources to read. */
friendlyName?: string;
/** The phone numbers of the IncomingPhoneNumber resources to read. You can specify partial numbers and use \'*\' as a wildcard for any digit. */
phoneNumber?: string;
/** Whether to include phone numbers based on their origin. Can be: `twilio` or `hosted`. By default, phone numbers of all origin are included. */
origin?: string;
/** 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: TollFreeInstance, 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 TollFreeListInstanceOptions {
/** Whether to include phone numbers new to the Twilio platform. Can be: `true` or `false` and the default is `true`. */
beta?: boolean;
/** A string that identifies the resources to read. */
friendlyName?: string;
/** The phone numbers of the IncomingPhoneNumber resources to read. You can specify partial numbers and use \'*\' as a wildcard for any digit. */
phoneNumber?: string;
/** Whether to include phone numbers based on their origin. Can be: `twilio` or `hosted`. By default, phone numbers of all origin are included. */
origin?: string;
/** 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 TollFreeListInstancePageOptions {
/** Whether to include phone numbers new to the Twilio platform. Can be: `true` or `false` and the default is `true`. */
beta?: boolean;
/** A string that identifies the resources to read. */
friendlyName?: string;
/** The phone numbers of the IncomingPhoneNumber resources to read. You can specify partial numbers and use \'*\' as a wildcard for any digit. */
phoneNumber?: string;
/** Whether to include phone numbers based on their origin. Can be: `twilio` or `hosted`. By default, phone numbers of all origin are included. */
origin?: string;
/** 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 TollFreeSolution {
accountSid: string;
}
export interface TollFreeListInstance {
_version: V2010;
_solution: TollFreeSolution;
_uri: string;
/**
* Create a TollFreeInstance
*
* @param params - Parameter for request
* @param callback - Callback to handle processed record
*
* @returns Resolves to processed TollFreeInstance
*/
create(
params: TollFreeListInstanceCreateOptions,
callback?: (error: Error | null, item?: TollFreeInstance) => any
): Promise<TollFreeInstance>;
/**
* Streams TollFreeInstance 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 { TollFreeListInstanceEachOptions } [params] - Options for request
* @param { function } [callback] - Function to process each record
*/
each(
callback?: (item: TollFreeInstance, done: (err?: Error) => void) => void
): void;
each(
params: TollFreeListInstanceEachOptions,
callback?: (item: TollFreeInstance, done: (err?: Error) => void) => void
): void;
/**
* Retrieve a single target page of TollFreeInstance 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: TollFreePage) => any
): Promise<TollFreePage>;
/**
* Lists TollFreeInstance 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 { TollFreeListInstanceOptions } [params] - Options for request
* @param { function } [callback] - Callback to handle list of records
*/
list(
callback?: (error: Error | null, items: TollFreeInstance[]) => any
): Promise<TollFreeInstance[]>;
list(
params: TollFreeListInstanceOptions,
callback?: (error: Error | null, items: TollFreeInstance[]) => any
): Promise<TollFreeInstance[]>;
/**
* Retrieve a single page of TollFreeInstance 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 { TollFreeListInstancePageOptions } [params] - Options for request
* @param { function } [callback] - Callback to handle list of records
*/
page(
callback?: (error: Error | null, items: TollFreePage) => any
): Promise<TollFreePage>;
page(
params: TollFreeListInstancePageOptions,
callback?: (error: Error | null, items: TollFreePage) => any
): Promise<TollFreePage>;
/**
* Provide a user-friendly representation
*/
toJSON(): any;
[inspect.custom](_depth: any, options: InspectOptions): any;
}
export function TollFreeListInstance(
version: V2010,
accountSid: string
): TollFreeListInstance {
if (!isValidPathParam(accountSid)) {
throw new Error("Parameter 'accountSid' is not valid.");
}
const instance = {} as TollFreeListInstance;
instance._version = version;
instance._solution = { accountSid };
instance._uri = `/Accounts/${accountSid}/IncomingPhoneNumbers/TollFree.json`;
instance.create = function create(
params: TollFreeListInstanceCreateOptions,
callback?: (error: Error | null, items: TollFreeInstance) => any
): Promise<TollFreeInstance> {
if (params === null || params === undefined) {
throw new Error('Required parameter "params" missing.');
}
if (params["phoneNumber"] === null || params["phoneNumber"] === undefined) {
throw new Error("Required parameter \"params['phoneNumber']\" missing.");
}
let data: any = {};
data["PhoneNumber"] = params["phoneNumber"];
if (params["apiVersion"] !== undefined)
data["ApiVersion"] = params["apiVersion"];
if (params["friendlyName"] !== undefined)
data["FriendlyName"] = params["friendlyName"];
if (params["smsApplicationSid"] !== undefined)
data["SmsApplicationSid"] = params["smsApplicationSid"];
if (params["smsFallbackMethod"] !== undefined)
data["SmsFallbackMethod"] = params["smsFallbackMethod"];
if (params["smsFallbackUrl"] !== undefined)
data["SmsFallbackUrl"] = params["smsFallbackUrl"];
if (params["smsMethod"] !== undefined)
data["SmsMethod"] = params["smsMethod"];
if (params["smsUrl"] !== undefined) data["SmsUrl"] = params["smsUrl"];
if (params["statusCallback"] !== undefined)
data["StatusCallback"] = params["statusCallback"];
if (params["statusCallbackMethod"] !== undefined)
data["StatusCallbackMethod"] = params["statusCallbackMethod"];
if (params["voiceApplicationSid"] !== undefined)
data["VoiceApplicationSid"] = params["voiceApplicationSid"];
if (params["voiceCallerIdLookup"] !== undefined)
data["VoiceCallerIdLookup"] = serialize.bool(
params["voiceCallerIdLookup"]
);
if (params["voiceFallbackMethod"] !== undefined)
data["VoiceFallbackMethod"] = params["voiceFallbackMethod"];
if (params["voiceFallbackUrl"] !== undefined)
data["VoiceFallbackUrl"] = params["voiceFallbackUrl"];
if (params["voiceMethod"] !== undefined)
data["VoiceMethod"] = params["voiceMethod"];
if (params["voiceUrl"] !== undefined) data["VoiceUrl"] = params["voiceUrl"];
if (params["identitySid"] !== undefined)
data["IdentitySid"] = params["identitySid"];
if (params["addressSid"] !== undefined)
data["AddressSid"] = params["addressSid"];
if (params["emergencyStatus"] !== undefined)
data["EmergencyStatus"] = params["emergencyStatus"];
if (params["emergencyAddressSid"] !== undefined)
data["EmergencyAddressSid"] = params["emergencyAddressSid"];
if (params["trunkSid"] !== undefined) data["TrunkSid"] = params["trunkSid"];
if (params["voiceReceiveMode"] !== undefined)
data["VoiceReceiveMode"] = params["voiceReceiveMode"];
if (params["bundleSid"] !== undefined)
data["BundleSid"] = params["bundleSid"];
const headers: any = {};
headers["Content-Type"] = "application/x-www-form-urlencoded";
let operationVersion = version,
operationPromise = operationVersion.create({
uri: instance._uri,
method: "post",
data,
headers,
});
operationPromise = operationPromise.then(
(payload) =>
new TollFreeInstance(
operationVersion,
payload,
instance._solution.accountSid
)
);
operationPromise = instance._version.setPromiseCallback(
operationPromise,
callback
);
return operationPromise;
};
instance.page = function page(
params?:
| TollFreeListInstancePageOptions
| ((error: Error | null, items: TollFreePage) => any),
callback?: (error: Error | null, items: TollFreePage) => any
): Promise<TollFreePage> {
if (params instanceof Function) {
callback = params;
params = {};
} else {
params = params || {};
}
let data: any = {};
if (params["beta"] !== undefined)
data["Beta"] = serialize.bool(params["beta"]);
if (params["friendlyName"] !== undefined)
data["FriendlyName"] = params["friendlyName"];
if (params["phoneNumber"] !== undefined)
data["PhoneNumber"] = params["phoneNumber"];
if (params["origin"] !== undefined) data["Origin"] = params["origin"];
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 TollFreePage(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: TollFreePage) => any
): Promise<TollFreePage> {
const operationPromise = instance._version._domain.twilio.request({
method: "get",
uri: targetUrl,
});
let pagePromise = operationPromise.then(
(payload) =>
new TollFreePage(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;
}
export type TollFreeSmsFallbackMethod =
| "HEAD"
| "GET"
| "POST"
| "PATCH"
| "PUT"
| "DELETE";
export type TollFreeSmsMethod =
| "HEAD"
| "GET"
| "POST"
| "PATCH"
| "PUT"
| "DELETE";
export type TollFreeStatusCallbackMethod =
| "HEAD"
| "GET"
| "POST"
| "PATCH"
| "PUT"
| "DELETE";
export type TollFreeVoiceFallbackMethod =
| "HEAD"
| "GET"
| "POST"
| "PATCH"
| "PUT"
| "DELETE";
export type TollFreeVoiceMethod =
| "HEAD"
| "GET"
| "POST"
| "PATCH"
| "PUT"
| "DELETE";
interface TollFreePayload extends TwilioResponsePayload {
incoming_phone_numbers: TollFreeResource[];
}
interface TollFreeResource {
account_sid: string;
address_sid: string;
address_requirements: IncomingPhoneNumberTollFreeAddressRequirement;
api_version: string;
beta: boolean;
capabilities: PhoneNumberCapabilities;
date_created: Date;
date_updated: Date;
friendly_name: string;
identity_sid: string;
phone_number: string;
origin: string;
sid: string;
sms_application_sid: string;
sms_fallback_method: TollFreeSmsFallbackMethod;
sms_fallback_url: string;
sms_method: TollFreeSmsMethod;
sms_url: string;
status_callback: string;
status_callback_method: TollFreeStatusCallbackMethod;
trunk_sid: string;
uri: string;
voice_receive_mode: IncomingPhoneNumberTollFreeVoiceReceiveMode;
voice_application_sid: string;
voice_caller_id_lookup: boolean;
voice_fallback_method: TollFreeVoiceFallbackMethod;
voice_fallback_url: string;
voice_method: TollFreeVoiceMethod;
voice_url: string;
emergency_status: IncomingPhoneNumberTollFreeEmergencyStatus;
emergency_address_sid: string;
emergency_address_status: IncomingPhoneNumberTollFreeEmergencyAddressStatus;
bundle_sid: string;
status: string;
}
export class TollFreeInstance {
constructor(
protected _version: V2010,
payload: TollFreeResource,
accountSid: string
) {
this.accountSid = payload.account_sid;
this.addressSid = payload.address_sid;
this.addressRequirements = payload.address_requirements;
this.apiVersion = payload.api_version;
this.beta = payload.beta;
this.capabilities = payload.capabilities;
this.dateCreated = deserialize.rfc2822DateTime(payload.date_created);
this.dateUpdated = deserialize.rfc2822DateTime(payload.date_updated);
this.friendlyName = payload.friendly_name;
this.identitySid = payload.identity_sid;
this.phoneNumber = payload.phone_number;
this.origin = payload.origin;
this.sid = payload.sid;
this.smsApplicationSid = payload.sms_application_sid;
this.smsFallbackMethod = payload.sms_fallback_method;
this.smsFallbackUrl = payload.sms_fallback_url;
this.smsMethod = payload.sms_method;
this.smsUrl = payload.sms_url;
this.statusCallback = payload.status_callback;
this.statusCallbackMethod = payload.status_callback_method;
this.trunkSid = payload.trunk_sid;
this.uri = payload.uri;
this.voiceReceiveMode = payload.voice_receive_mode;
this.voiceApplicationSid = payload.voice_application_sid;
this.voiceCallerIdLookup = payload.voice_caller_id_lookup;
this.voiceFallbackMethod = payload.voice_fallback_method;
this.voiceFallbackUrl = payload.voice_fallback_url;
this.voiceMethod = payload.voice_method;
this.voiceUrl = payload.voice_url;
this.emergencyStatus = payload.emergency_status;
this.emergencyAddressSid = payload.emergency_address_sid;
this.emergencyAddressStatus = payload.emergency_address_status;
this.bundleSid = payload.bundle_sid;
this.status = payload.status;
}
/**
* The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the resource.
*/
accountSid: string;
/**
* The SID of the Address resource associated with the phone number.
*/
addressSid: string;
addressRequirements: IncomingPhoneNumberTollFreeAddressRequirement;
/**
* The API version used to start a new TwiML session.
*/
apiVersion: string;
/**
* Whether the phone number is new to the Twilio platform. Can be: `true` or `false`.
*/
beta: boolean;
capabilities: PhoneNumberCapabilities;
/**
* The date and time in GMT that the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
*/
dateCreated: Date;
/**
* The date and time in GMT that the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
*/
dateUpdated: Date;
/**
* The string that you assigned to describe the resource.
*/
friendlyName: string;
/**
* The SID of the Identity resource that we associate with the phone number. Some regions require an Identity to meet local regulations.
*/
identitySid: string;
/**
* The phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number.
*/
phoneNumber: string;
/**
* The phone number\'s origin. `twilio` identifies Twilio-owned phone numbers and `hosted` identifies hosted phone numbers.
*/
origin: string;
/**
* The unique string that that we created to identify the resource.
*/
sid: string;
/**
* The SID of the application that handles SMS messages sent to the phone number. If an `sms_application_sid` is present, we ignore all `sms_*_url` values and use those of the application.
*/
smsApplicationSid: string;
/**
* The HTTP method we use to call `sms_fallback_url`. Can be: `GET` or `POST`.
*/
smsFallbackMethod: TollFreeSmsFallbackMethod;
/**
* The URL that we call when an error occurs while retrieving or executing the TwiML from `sms_url`.
*/
smsFallbackUrl: string;
/**
* The HTTP method we use to call `sms_url`. Can be: `GET` or `POST`.
*/
smsMethod: TollFreeSmsMethod;
/**
* The URL we call when the phone number receives an incoming SMS message.
*/
smsUrl: string;
/**
* The URL we call using the `status_callback_method` to send status information to your application.
*/
statusCallback: string;
/**
* The HTTP method we use to call `status_callback`. Can be: `GET` or `POST`.
*/
statusCallbackMethod: TollFreeStatusCallbackMethod;
/**
* The SID of the Trunk that handles calls to the phone number. If a `trunk_sid` is present, we ignore all of the voice urls and voice applications and use those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa.
*/
trunkSid: string;
/**
* The URI of the resource, relative to `https://api.twilio.com`.
*/
uri: string;
voiceReceiveMode: IncomingPhoneNumberTollFreeVoiceReceiveMode;
/**
* The SID of the application that handles calls to the phone number. If a `voice_application_sid` is present, we ignore all of the voice urls and use those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa.
*/
voiceApplicationSid: string;
/**
* Whether we look up the caller\'s caller-ID name from the CNAM database ($0.01 per look up). Can be: `true` or `false`.
*/
voiceCallerIdLookup: boolean;
/**
* The HTTP method we use to call `voice_fallback_url`. Can be: `GET` or `POST`.
*/
voiceFallbackMethod: TollFreeVoiceFallbackMethod;
/**
* The URL that we call when an error occurs retrieving or executing the TwiML requested by `url`.
*/
voiceFallbackUrl: string;
/**
* The HTTP method we use to call `voice_url`. Can be: `GET` or `POST`.
*/
voiceMethod: TollFreeVoiceMethod;
/**
* The URL we call when the phone number receives a call. The `voice_url` will not be used if a `voice_application_sid` or a `trunk_sid` is set.
*/
voiceUrl: string;
emergencyStatus: IncomingPhoneNumberTollFreeEmergencyStatus;
/**
* The SID of the emergency address configuration that we use for emergency calling from this phone number.
*/
emergencyAddressSid: string;
emergencyAddressStatus: IncomingPhoneNumberTollFreeEmergencyAddressStatus;
/**
* The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations.
*/
bundleSid: string;
status: string;
/**
* Provide a user-friendly representation
*
* @returns Object
*/
toJSON() {
return {
accountSid: this.accountSid,
addressSid: this.addressSid,
addressRequirements: this.addressRequirements,
apiVersion: this.apiVersion,
beta: this.beta,
capabilities: this.capabilities,
dateCreated: this.dateCreated,
dateUpdated: this.dateUpdated,
friendlyName: this.friendlyName,
identitySid: this.identitySid,
phoneNumber: this.phoneNumber,
origin: this.origin,
sid: this.sid,
smsApplicationSid: this.smsApplicationSid,
smsFallbackMethod: this.smsFallbackMethod,
smsFallbackUrl: this.smsFallbackUrl,
smsMethod: this.smsMethod,
smsUrl: this.smsUrl,
statusCallback: this.statusCallback,
statusCallbackMethod: this.statusCallbackMethod,
trunkSid: this.trunkSid,
uri: this.uri,
voiceReceiveMode: this.voiceReceiveMode,
voiceApplicationSid: this.voiceApplicationSid,
voiceCallerIdLookup: this.voiceCallerIdLookup,
voiceFallbackMethod: this.voiceFallbackMethod,
voiceFallbackUrl: this.voiceFallbackUrl,
voiceMethod: this.voiceMethod,
voiceUrl: this.voiceUrl,
emergencyStatus: this.emergencyStatus,
emergencyAddressSid: this.emergencyAddressSid,
emergencyAddressStatus: this.emergencyAddressStatus,
bundleSid: this.bundleSid,
status: this.status,
};
}
[inspect.custom](_depth: any, options: InspectOptions) {
return inspect(this.toJSON(), options);
}
}
export class TollFreePage extends Page<
V2010,
TollFreePayload,
TollFreeResource,
TollFreeInstance
> {
/**
* Initialize the TollFreePage
*
* @param version - Version of the resource
* @param response - Response from the API
* @param solution - Path solution
*/
constructor(
version: V2010,
response: Response<string>,
solution: TollFreeSolution
) {
super(version, response, solution);
}
/**
* Build an instance of TollFreeInstance
*
* @param payload - Payload response from the API
*/
getInstance(payload: TollFreeResource): TollFreeInstance {
return new TollFreeInstance(
this._version,
payload,
this._solution.accountSid
);
}
[inspect.custom](depth: any, options: InspectOptions) {
return inspect(this.toJSON(), options);
}
}