forked from twilio/twilio-node
/
address.js
875 lines (789 loc) · 26.9 KB
/
address.js
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
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
'use strict';
/* jshint ignore:start */
/**
* This code was generated by
* \ / _ _ _| _ _
* | (_)\/(_)(_|\/| |(/_ v1.0.0
* / /
*/
/* jshint ignore:end */
var Q = require('q'); /* jshint ignore:line */
var _ = require('lodash'); /* jshint ignore:line */
var util = require('util'); /* jshint ignore:line */
var DependentPhoneNumberList = require(
'./address/dependentPhoneNumber').DependentPhoneNumberList;
var Page = require('../../../../base/Page'); /* jshint ignore:line */
var deserialize = require(
'../../../../base/deserialize'); /* jshint ignore:line */
var serialize = require('../../../../base/serialize'); /* jshint ignore:line */
var values = require('../../../../base/values'); /* jshint ignore:line */
var AddressList;
var AddressPage;
var AddressInstance;
var AddressContext;
/* jshint ignore:start */
/**
* Initialize the AddressList
*
* @constructor Twilio.Api.V2010.AccountContext.AddressList
*
* @param {Twilio.Api.V2010} version - Version of the resource
* @param {string} accountSid -
* The SID of the Account that is responsible for the resource
*/
/* jshint ignore:end */
AddressList = function AddressList(version, accountSid) {
/* jshint ignore:start */
/**
* @function addresses
* @memberof Twilio.Api.V2010.AccountContext#
*
* @param {string} sid - sid of instance
*
* @returns {Twilio.Api.V2010.AccountContext.AddressContext}
*/
/* jshint ignore:end */
function AddressListInstance(sid) {
return AddressListInstance.get(sid);
}
AddressListInstance._version = version;
// Path Solution
AddressListInstance._solution = {accountSid: accountSid};
AddressListInstance._uri = `/Accounts/${accountSid}/Addresses.json`;
/* jshint ignore:start */
/**
* create a AddressInstance
*
* @function create
* @memberof Twilio.Api.V2010.AccountContext.AddressList#
*
* @param {object} opts - Options for request
* @param {string} opts.customerName - The name to associate with the new address
* @param {string} opts.street - The number and street address of the new address
* @param {string} opts.city - The city of the new address
* @param {string} opts.region - The state or region of the new address
* @param {string} opts.postalCode - The postal code of the new address
* @param {string} opts.isoCountry - The ISO country code of the new address
* @param {string} [opts.friendlyName] - A string to describe the new resource
* @param {boolean} [opts.emergencyEnabled] -
* Whether to enable emergency calling on the new address
* @param {boolean} [opts.autoCorrectAddress] -
* Whether we should automatically correct the address
* @param {function} [callback] - Callback to handle processed record
*
* @returns {Promise} Resolves to processed AddressInstance
*/
/* jshint ignore:end */
AddressListInstance.create = function create(opts, callback) {
if (_.isUndefined(opts)) {
throw new Error('Required parameter "opts" missing.');
}
if (_.isUndefined(opts['customerName'])) {
throw new Error('Required parameter "opts[\'customerName\']" missing.');
}
if (_.isUndefined(opts['street'])) {
throw new Error('Required parameter "opts[\'street\']" missing.');
}
if (_.isUndefined(opts['city'])) {
throw new Error('Required parameter "opts[\'city\']" missing.');
}
if (_.isUndefined(opts['region'])) {
throw new Error('Required parameter "opts[\'region\']" missing.');
}
if (_.isUndefined(opts['postalCode'])) {
throw new Error('Required parameter "opts[\'postalCode\']" missing.');
}
if (_.isUndefined(opts['isoCountry'])) {
throw new Error('Required parameter "opts[\'isoCountry\']" missing.');
}
var deferred = Q.defer();
var data = values.of({
'CustomerName': _.get(opts, 'customerName'),
'Street': _.get(opts, 'street'),
'City': _.get(opts, 'city'),
'Region': _.get(opts, 'region'),
'PostalCode': _.get(opts, 'postalCode'),
'IsoCountry': _.get(opts, 'isoCountry'),
'FriendlyName': _.get(opts, 'friendlyName'),
'EmergencyEnabled': serialize.bool(_.get(opts, 'emergencyEnabled')),
'AutoCorrectAddress': serialize.bool(_.get(opts, 'autoCorrectAddress'))
});
var promise = this._version.create({uri: this._uri, method: 'POST', data: data});
promise = promise.then(function(payload) {
deferred.resolve(new AddressInstance(
this._version,
payload,
this._solution.accountSid,
this._solution.sid
));
}.bind(this));
promise.catch(function(error) {
deferred.reject(error);
});
if (_.isFunction(callback)) {
deferred.promise.nodeify(callback);
}
return deferred.promise;
};
/* jshint ignore:start */
/**
* Streams AddressInstance 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.
*
* @function each
* @memberof Twilio.Api.V2010.AccountContext.AddressList#
*
* @param {object} [opts] - Options for request
* @param {string} [opts.customerName] -
* The `customer_name` of the Address resources to read
* @param {string} [opts.friendlyName] -
* The string that identifies the Address resources to read
* @param {string} [opts.isoCountry] -
* The ISO country code of the Address resources to read
* @param {number} [opts.limit] -
* Upper limit for the number of records to return.
* each() guarantees never to return more than limit.
* Default is no limit
* @param {number} [opts.pageSize] -
* Number of records to fetch per request,
* when not set will use the default value of 50 records.
* If no pageSize is defined but a limit is defined,
* each() will attempt to read the limit with the most efficient
* page size, i.e. min(limit, 1000)
* @param {Function} [opts.callback] -
* Function to process each record. If this and a positional
* callback are passed, this one will be used
* @param {Function} [opts.done] -
* Function to be called upon completion of streaming
* @param {Function} [callback] - Function to process each record
*/
/* jshint ignore:end */
AddressListInstance.each = function each(opts, callback) {
if (_.isFunction(opts)) {
callback = opts;
opts = {};
}
opts = opts || {};
if (opts.callback) {
callback = opts.callback;
}
if (_.isUndefined(callback)) {
throw new Error('Callback function must be provided');
}
var done = false;
var currentPage = 1;
var currentResource = 0;
var limits = this._version.readLimits({
limit: opts.limit,
pageSize: opts.pageSize
});
function onComplete(error) {
done = true;
if (_.isFunction(opts.done)) {
opts.done(error);
}
}
function fetchNextPage(fn) {
var promise = fn();
if (_.isUndefined(promise)) {
onComplete();
return;
}
promise.then(function(page) {
_.each(page.instances, function(instance) {
if (done || (!_.isUndefined(opts.limit) && currentResource >= opts.limit)) {
done = true;
return false;
}
currentResource++;
callback(instance, onComplete);
});
if (!done) {
currentPage++;
fetchNextPage(_.bind(page.nextPage, page));
} else {
onComplete();
}
});
promise.catch(onComplete);
}
fetchNextPage(_.bind(this.page, this, _.merge(opts, limits)));
};
/* jshint ignore:start */
/**
* Lists AddressInstance records from the API as a list.
*
* If a function is passed as the first argument, it will be used as the callback
* function.
*
* @function list
* @memberof Twilio.Api.V2010.AccountContext.AddressList#
*
* @param {object} [opts] - Options for request
* @param {string} [opts.customerName] -
* The `customer_name` of the Address resources to read
* @param {string} [opts.friendlyName] -
* The string that identifies the Address resources to read
* @param {string} [opts.isoCountry] -
* The ISO country code of the Address resources to read
* @param {number} [opts.limit] -
* Upper limit for the number of records to return.
* list() guarantees never to return more than limit.
* Default is no limit
* @param {number} [opts.pageSize] -
* Number of records to fetch per request,
* when not set will use the default value of 50 records.
* If no page_size is defined but a limit is defined,
* list() will attempt to read the limit with the most
* efficient page size, i.e. min(limit, 1000)
* @param {function} [callback] - Callback to handle list of records
*
* @returns {Promise} Resolves to a list of records
*/
/* jshint ignore:end */
AddressListInstance.list = function list(opts, callback) {
if (_.isFunction(opts)) {
callback = opts;
opts = {};
}
opts = opts || {};
var deferred = Q.defer();
var allResources = [];
opts.callback = function(resource, done) {
allResources.push(resource);
if (!_.isUndefined(opts.limit) && allResources.length === opts.limit) {
done();
}
};
opts.done = function(error) {
if (_.isUndefined(error)) {
deferred.resolve(allResources);
} else {
deferred.reject(error);
}
};
if (_.isFunction(callback)) {
deferred.promise.nodeify(callback);
}
this.each(opts);
return deferred.promise;
};
/* jshint ignore:start */
/**
* Retrieve a single page of AddressInstance 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.
*
* @function page
* @memberof Twilio.Api.V2010.AccountContext.AddressList#
*
* @param {object} [opts] - Options for request
* @param {string} [opts.customerName] -
* The `customer_name` of the Address resources to read
* @param {string} [opts.friendlyName] -
* The string that identifies the Address resources to read
* @param {string} [opts.isoCountry] -
* The ISO country code of the Address resources to read
* @param {string} [opts.pageToken] - PageToken provided by the API
* @param {number} [opts.pageNumber] -
* Page Number, this value is simply for client state
* @param {number} [opts.pageSize] - Number of records to return, defaults to 50
* @param {function} [callback] - Callback to handle list of records
*
* @returns {Promise} Resolves to a list of records
*/
/* jshint ignore:end */
AddressListInstance.page = function page(opts, callback) {
if (_.isFunction(opts)) {
callback = opts;
opts = {};
}
opts = opts || {};
var deferred = Q.defer();
var data = values.of({
'CustomerName': _.get(opts, 'customerName'),
'FriendlyName': _.get(opts, 'friendlyName'),
'IsoCountry': _.get(opts, 'isoCountry'),
'PageToken': opts.pageToken,
'Page': opts.pageNumber,
'PageSize': opts.pageSize
});
var promise = this._version.page({uri: this._uri, method: 'GET', params: data});
promise = promise.then(function(payload) {
deferred.resolve(new AddressPage(this._version, payload, this._solution));
}.bind(this));
promise.catch(function(error) {
deferred.reject(error);
});
if (_.isFunction(callback)) {
deferred.promise.nodeify(callback);
}
return deferred.promise;
};
/* jshint ignore:start */
/**
* Retrieve a single target page of AddressInstance 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.
*
* @function getPage
* @memberof Twilio.Api.V2010.AccountContext.AddressList#
*
* @param {string} [targetUrl] - API-generated URL for the requested results page
* @param {function} [callback] - Callback to handle list of records
*
* @returns {Promise} Resolves to a list of records
*/
/* jshint ignore:end */
AddressListInstance.getPage = function getPage(targetUrl, callback) {
var deferred = Q.defer();
var promise = this._version._domain.twilio.request({method: 'GET', uri: targetUrl});
promise = promise.then(function(payload) {
deferred.resolve(new AddressPage(this._version, payload, this._solution));
}.bind(this));
promise.catch(function(error) {
deferred.reject(error);
});
if (_.isFunction(callback)) {
deferred.promise.nodeify(callback);
}
return deferred.promise;
};
/* jshint ignore:start */
/**
* Constructs a address
*
* @function get
* @memberof Twilio.Api.V2010.AccountContext.AddressList#
*
* @param {string} sid - The unique string that identifies the resource
*
* @returns {Twilio.Api.V2010.AccountContext.AddressContext}
*/
/* jshint ignore:end */
AddressListInstance.get = function get(sid) {
return new AddressContext(this._version, this._solution.accountSid, sid);
};
/* jshint ignore:start */
/**
* Provide a user-friendly representation
*
* @function toJSON
* @memberof Twilio.Api.V2010.AccountContext.AddressList#
*
* @returns Object
*/
/* jshint ignore:end */
AddressListInstance.toJSON = function toJSON() {
return this._solution;
};
AddressListInstance[util.inspect.custom] = function inspect(depth, options) {
return util.inspect(this.toJSON(), options);
};
return AddressListInstance;
};
/* jshint ignore:start */
/**
* Initialize the AddressPage
*
* @constructor Twilio.Api.V2010.AccountContext.AddressPage
*
* @param {V2010} version - Version of the resource
* @param {Response<string>} response - Response from the API
* @param {AddressSolution} solution - Path solution
*
* @returns AddressPage
*/
/* jshint ignore:end */
AddressPage = function AddressPage(version, response, solution) {
// Path Solution
this._solution = solution;
Page.prototype.constructor.call(this, version, response, this._solution);
};
_.extend(AddressPage.prototype, Page.prototype);
AddressPage.prototype.constructor = AddressPage;
/* jshint ignore:start */
/**
* Build an instance of AddressInstance
*
* @function getInstance
* @memberof Twilio.Api.V2010.AccountContext.AddressPage#
*
* @param {AddressPayload} payload - Payload response from the API
*
* @returns AddressInstance
*/
/* jshint ignore:end */
AddressPage.prototype.getInstance = function getInstance(payload) {
return new AddressInstance(this._version, payload, this._solution.accountSid);
};
/* jshint ignore:start */
/**
* Provide a user-friendly representation
*
* @function toJSON
* @memberof Twilio.Api.V2010.AccountContext.AddressPage#
*
* @returns Object
*/
/* jshint ignore:end */
AddressPage.prototype.toJSON = function toJSON() {
let clone = {};
_.forOwn(this, function(value, key) {
if (!_.startsWith(key, '_') && ! _.isFunction(value)) {
clone[key] = value;
}
});
return clone;
};
AddressPage.prototype[util.inspect.custom] = function inspect(depth, options) {
return util.inspect(this.toJSON(), options);
};
/* jshint ignore:start */
/**
* Initialize the AddressContext
*
* @constructor Twilio.Api.V2010.AccountContext.AddressInstance
*
* @property {string} accountSid -
* The SID of the Account that is responsible for the resource
* @property {string} city - The city in which the address is located
* @property {string} customerName - The name associated with the address
* @property {Date} dateCreated -
* The RFC 2822 date and time in GMT that the resource was created
* @property {Date} dateUpdated -
* The RFC 2822 date and time in GMT that the resource was last updated
* @property {string} friendlyName -
* The string that you assigned to describe the resource
* @property {string} isoCountry - The ISO country code of the address
* @property {string} postalCode - The postal code of the address
* @property {string} region - The state or region of the address
* @property {string} sid - The unique string that identifies the resource
* @property {string} street - The number and street address of the address
* @property {string} uri -
* The URI of the resource, relative to `https://api.twilio.com`
* @property {boolean} emergencyEnabled -
* Whether emergency calling has been enabled on this number
* @property {boolean} validated -
* Whether the address has been validated to comply with local regulation
* @property {boolean} verified -
* Whether the address has been verified to comply with regulation
*
* @param {V2010} version - Version of the resource
* @param {AddressPayload} payload - The instance payload
* @param {sid} accountSid -
* The SID of the Account that is responsible for the resource
* @param {sid} sid - The unique string that identifies the resource
*/
/* jshint ignore:end */
AddressInstance = function AddressInstance(version, payload, accountSid, sid) {
this._version = version;
// Marshaled Properties
this.accountSid = payload.account_sid; // jshint ignore:line
this.city = payload.city; // jshint ignore:line
this.customerName = payload.customer_name; // jshint ignore:line
this.dateCreated = deserialize.rfc2822DateTime(payload.date_created); // jshint ignore:line
this.dateUpdated = deserialize.rfc2822DateTime(payload.date_updated); // jshint ignore:line
this.friendlyName = payload.friendly_name; // jshint ignore:line
this.isoCountry = payload.iso_country; // jshint ignore:line
this.postalCode = payload.postal_code; // jshint ignore:line
this.region = payload.region; // jshint ignore:line
this.sid = payload.sid; // jshint ignore:line
this.street = payload.street; // jshint ignore:line
this.uri = payload.uri; // jshint ignore:line
this.emergencyEnabled = payload.emergency_enabled; // jshint ignore:line
this.validated = payload.validated; // jshint ignore:line
this.verified = payload.verified; // jshint ignore:line
// Context
this._context = undefined;
this._solution = {accountSid: accountSid, sid: sid || this.sid, };
};
Object.defineProperty(AddressInstance.prototype,
'_proxy', {
get: function() {
if (!this._context) {
this._context = new AddressContext(this._version, this._solution.accountSid, this._solution.sid);
}
return this._context;
}
});
/* jshint ignore:start */
/**
* remove a AddressInstance
*
* @function remove
* @memberof Twilio.Api.V2010.AccountContext.AddressInstance#
*
* @param {function} [callback] - Callback to handle processed record
*
* @returns {Promise} Resolves to processed AddressInstance
*/
/* jshint ignore:end */
AddressInstance.prototype.remove = function remove(callback) {
return this._proxy.remove(callback);
};
/* jshint ignore:start */
/**
* fetch a AddressInstance
*
* @function fetch
* @memberof Twilio.Api.V2010.AccountContext.AddressInstance#
*
* @param {function} [callback] - Callback to handle processed record
*
* @returns {Promise} Resolves to processed AddressInstance
*/
/* jshint ignore:end */
AddressInstance.prototype.fetch = function fetch(callback) {
return this._proxy.fetch(callback);
};
/* jshint ignore:start */
/**
* update a AddressInstance
*
* @function update
* @memberof Twilio.Api.V2010.AccountContext.AddressInstance#
*
* @param {object} [opts] - Options for request
* @param {string} [opts.friendlyName] - A string to describe the resource
* @param {string} [opts.customerName] - The name to associate with the address
* @param {string} [opts.street] - The number and street address of the address
* @param {string} [opts.city] - The city of the address
* @param {string} [opts.region] - The state or region of the address
* @param {string} [opts.postalCode] - The postal code of the address
* @param {boolean} [opts.emergencyEnabled] -
* Whether to enable emergency calling on the address
* @param {boolean} [opts.autoCorrectAddress] -
* Whether we should automatically correct the address
* @param {function} [callback] - Callback to handle processed record
*
* @returns {Promise} Resolves to processed AddressInstance
*/
/* jshint ignore:end */
AddressInstance.prototype.update = function update(opts, callback) {
return this._proxy.update(opts, callback);
};
/* jshint ignore:start */
/**
* Access the dependentPhoneNumbers
*
* @function dependentPhoneNumbers
* @memberof Twilio.Api.V2010.AccountContext.AddressInstance#
*
* @returns {Twilio.Api.V2010.AccountContext.AddressContext.DependentPhoneNumberList}
*/
/* jshint ignore:end */
AddressInstance.prototype.dependentPhoneNumbers = function
dependentPhoneNumbers() {
return this._proxy.dependentPhoneNumbers;
};
/* jshint ignore:start */
/**
* Provide a user-friendly representation
*
* @function toJSON
* @memberof Twilio.Api.V2010.AccountContext.AddressInstance#
*
* @returns Object
*/
/* jshint ignore:end */
AddressInstance.prototype.toJSON = function toJSON() {
let clone = {};
_.forOwn(this, function(value, key) {
if (!_.startsWith(key, '_') && ! _.isFunction(value)) {
clone[key] = value;
}
});
return clone;
};
AddressInstance.prototype[util.inspect.custom] = function inspect(depth,
options) {
return util.inspect(this.toJSON(), options);
};
/* jshint ignore:start */
/**
* Initialize the AddressContext
*
* @constructor Twilio.Api.V2010.AccountContext.AddressContext
*
* @property {Twilio.Api.V2010.AccountContext.AddressContext.DependentPhoneNumberList} dependentPhoneNumbers -
* dependentPhoneNumbers resource
*
* @param {V2010} version - Version of the resource
* @param {sid} accountSid -
* The SID of the Account that is responsible for this address
* @param {sid} sid - The unique string that identifies the resource
*/
/* jshint ignore:end */
AddressContext = function AddressContext(version, accountSid, sid) {
this._version = version;
// Path Solution
this._solution = {accountSid: accountSid, sid: sid, };
this._uri = `/Accounts/${accountSid}/Addresses/${sid}.json`;
// Dependents
this._dependentPhoneNumbers = undefined;
};
/* jshint ignore:start */
/**
* remove a AddressInstance
*
* @function remove
* @memberof Twilio.Api.V2010.AccountContext.AddressContext#
*
* @param {function} [callback] - Callback to handle processed record
*
* @returns {Promise} Resolves to processed AddressInstance
*/
/* jshint ignore:end */
AddressContext.prototype.remove = function remove(callback) {
var deferred = Q.defer();
var promise = this._version.remove({uri: this._uri, method: 'DELETE'});
promise = promise.then(function(payload) {
deferred.resolve(payload);
}.bind(this));
promise.catch(function(error) {
deferred.reject(error);
});
if (_.isFunction(callback)) {
deferred.promise.nodeify(callback);
}
return deferred.promise;
};
/* jshint ignore:start */
/**
* fetch a AddressInstance
*
* @function fetch
* @memberof Twilio.Api.V2010.AccountContext.AddressContext#
*
* @param {function} [callback] - Callback to handle processed record
*
* @returns {Promise} Resolves to processed AddressInstance
*/
/* jshint ignore:end */
AddressContext.prototype.fetch = function fetch(callback) {
var deferred = Q.defer();
var promise = this._version.fetch({uri: this._uri, method: 'GET'});
promise = promise.then(function(payload) {
deferred.resolve(new AddressInstance(
this._version,
payload,
this._solution.accountSid,
this._solution.sid
));
}.bind(this));
promise.catch(function(error) {
deferred.reject(error);
});
if (_.isFunction(callback)) {
deferred.promise.nodeify(callback);
}
return deferred.promise;
};
/* jshint ignore:start */
/**
* update a AddressInstance
*
* @function update
* @memberof Twilio.Api.V2010.AccountContext.AddressContext#
*
* @param {object} [opts] - Options for request
* @param {string} [opts.friendlyName] - A string to describe the resource
* @param {string} [opts.customerName] - The name to associate with the address
* @param {string} [opts.street] - The number and street address of the address
* @param {string} [opts.city] - The city of the address
* @param {string} [opts.region] - The state or region of the address
* @param {string} [opts.postalCode] - The postal code of the address
* @param {boolean} [opts.emergencyEnabled] -
* Whether to enable emergency calling on the address
* @param {boolean} [opts.autoCorrectAddress] -
* Whether we should automatically correct the address
* @param {function} [callback] - Callback to handle processed record
*
* @returns {Promise} Resolves to processed AddressInstance
*/
/* jshint ignore:end */
AddressContext.prototype.update = function update(opts, callback) {
if (_.isFunction(opts)) {
callback = opts;
opts = {};
}
opts = opts || {};
var deferred = Q.defer();
var data = values.of({
'FriendlyName': _.get(opts, 'friendlyName'),
'CustomerName': _.get(opts, 'customerName'),
'Street': _.get(opts, 'street'),
'City': _.get(opts, 'city'),
'Region': _.get(opts, 'region'),
'PostalCode': _.get(opts, 'postalCode'),
'EmergencyEnabled': serialize.bool(_.get(opts, 'emergencyEnabled')),
'AutoCorrectAddress': serialize.bool(_.get(opts, 'autoCorrectAddress'))
});
var promise = this._version.update({uri: this._uri, method: 'POST', data: data});
promise = promise.then(function(payload) {
deferred.resolve(new AddressInstance(
this._version,
payload,
this._solution.accountSid,
this._solution.sid
));
}.bind(this));
promise.catch(function(error) {
deferred.reject(error);
});
if (_.isFunction(callback)) {
deferred.promise.nodeify(callback);
}
return deferred.promise;
};
Object.defineProperty(AddressContext.prototype,
'dependentPhoneNumbers', {
get: function() {
if (!this._dependentPhoneNumbers) {
this._dependentPhoneNumbers = new DependentPhoneNumberList(
this._version,
this._solution.accountSid,
this._solution.sid
);
}
return this._dependentPhoneNumbers;
}
});
/* jshint ignore:start */
/**
* Provide a user-friendly representation
*
* @function toJSON
* @memberof Twilio.Api.V2010.AccountContext.AddressContext#
*
* @returns Object
*/
/* jshint ignore:end */
AddressContext.prototype.toJSON = function toJSON() {
return this._solution;
};
AddressContext.prototype[util.inspect.custom] = function inspect(depth, options)
{
return util.inspect(this.toJSON(), options);
};
module.exports = {
AddressList: AddressList,
AddressPage: AddressPage,
AddressInstance: AddressInstance,
AddressContext: AddressContext
};