twilio 3.77.0 → 3.77.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/rest/Lookups.d.ts +2 -0
- package/lib/rest/Lookups.js +11 -0
- package/lib/rest/Twilio.d.ts +1 -3
- package/lib/rest/Twilio.js +3 -17
- package/lib/rest/api/v2010/account/call/payment.d.ts +1 -1
- package/lib/rest/api/v2010/account/call/payment.js +1 -1
- package/lib/rest/api/v2010/account/recording.d.ts +2 -0
- package/lib/rest/api/v2010/account/recording.js +2 -0
- package/lib/rest/flexApi/v1/interaction/interactionChannel/interactionChannelInvite.d.ts +5 -5
- package/lib/rest/flexApi/v1/interaction/interactionChannel/interactionChannelInvite.js +10 -9
- package/lib/rest/flexApi/v1/interaction/interactionChannel.d.ts +8 -8
- package/lib/rest/flexApi/v1/interaction/interactionChannel.js +12 -13
- package/lib/rest/flexApi/v1/interaction.js +2 -1
- package/lib/rest/lookups/V2.d.ts +25 -0
- package/lib/rest/lookups/V2.js +47 -0
- package/lib/rest/lookups/v2/phoneNumber.d.ts +182 -0
- package/lib/rest/lookups/v2/phoneNumber.js +362 -0
- package/lib/rest/media/v1/mediaRecording.d.ts +2 -2
- package/lib/rest/media/v1/mediaRecording.js +2 -2
- package/lib/rest/verify/v2/service/verification.d.ts +3 -1
- package/lib/rest/verify/v2/service/verification.js +3 -0
- package/lib/rest/verify/v2/service/verificationCheck.d.ts +1 -1
- package/lib/twiml/VoiceResponse.d.ts +79 -4
- package/lib/twiml/VoiceResponse.js +110 -3
- package/package.json +1 -1
- package/lib/rest/Fax.d.ts +0 -26
- package/lib/rest/Fax.js +0 -54
- package/lib/rest/fax/V1.d.ts +0 -25
- package/lib/rest/fax/V1.js +0 -46
- package/lib/rest/fax/v1/fax/faxMedia.d.ts +0 -310
- package/lib/rest/fax/v1/fax/faxMedia.js +0 -633
- package/lib/rest/fax/v1/fax.d.ts +0 -367
- package/lib/rest/fax/v1/fax.js +0 -700
|
@@ -329,7 +329,7 @@ VoiceResponse.prototype.reject = function reject(attributes) {
|
|
|
329
329
|
* @param {object} attributes - TwiML attributes
|
|
330
330
|
* @param {say.voice} [attributes.voice] - Voice to use
|
|
331
331
|
* @param {number} [attributes.loop] - Times to loop message
|
|
332
|
-
* @param {say.language} [attributes.language] - Message
|
|
332
|
+
* @param {say.language} [attributes.language] - Message language
|
|
333
333
|
* @param {string} message - Message to say
|
|
334
334
|
*
|
|
335
335
|
* @returns Say
|
|
@@ -792,7 +792,7 @@ Prompt.prototype.constructor = Prompt;
|
|
|
792
792
|
* @param {object} attributes - TwiML attributes
|
|
793
793
|
* @param {say.voice} [attributes.voice] - Voice to use
|
|
794
794
|
* @param {number} [attributes.loop] - Times to loop message
|
|
795
|
-
* @param {say.language} [attributes.language] - Message
|
|
795
|
+
* @param {say.language} [attributes.language] - Message language
|
|
796
796
|
* @param {string} message - Message to say
|
|
797
797
|
*
|
|
798
798
|
* @returns Say
|
|
@@ -3773,7 +3773,7 @@ Gather.prototype.constructor = Gather;
|
|
|
3773
3773
|
* @param {object} attributes - TwiML attributes
|
|
3774
3774
|
* @param {say.voice} [attributes.voice] - Voice to use
|
|
3775
3775
|
* @param {number} [attributes.loop] - Times to loop message
|
|
3776
|
-
* @param {say.language} [attributes.language] - Message
|
|
3776
|
+
* @param {say.language} [attributes.language] - Message language
|
|
3777
3777
|
* @param {string} message - Message to say
|
|
3778
3778
|
*
|
|
3779
3779
|
* @returns Say
|
|
@@ -4302,6 +4302,8 @@ Connect.prototype.stream = function stream(attributes) {
|
|
|
4302
4302
|
* Whether sentiment analysis needs to be enabled or not
|
|
4303
4303
|
* @param {string} [attributes.statusCallback] -
|
|
4304
4304
|
* URL to post status callbacks from Twilio
|
|
4305
|
+
* @param {string} [attributes.statusCallbackMethod] -
|
|
4306
|
+
* HTTP method to use when requesting the status callback URL
|
|
4305
4307
|
*
|
|
4306
4308
|
* @returns VirtualAgent
|
|
4307
4309
|
*/
|
|
@@ -4310,6 +4312,57 @@ Connect.prototype.virtualAgent = function virtualAgent(attributes) {
|
|
|
4310
4312
|
return new VirtualAgent(this.connect.ele('VirtualAgent', attributes));
|
|
4311
4313
|
};
|
|
4312
4314
|
|
|
4315
|
+
/* jshint ignore:start */
|
|
4316
|
+
/**
|
|
4317
|
+
* <Conversation> TwiML Noun
|
|
4318
|
+
*
|
|
4319
|
+
* @function conversation
|
|
4320
|
+
* @memberof Connect#
|
|
4321
|
+
*
|
|
4322
|
+
* @param {object} [attributes] - TwiML attributes
|
|
4323
|
+
* @param {string} [attributes.serviceInstanceSid] - Service instance Sid
|
|
4324
|
+
* @param {boolean} [attributes.inboundAutocreation] - Inbound autocreation
|
|
4325
|
+
* @param {number} [attributes.routingAssignmentTimeout] -
|
|
4326
|
+
* Routing assignment timeout
|
|
4327
|
+
* @param {number} [attributes.inboundTimeout] - Inbound timeout
|
|
4328
|
+
* @param {conversation.record} [attributes.record] - Record
|
|
4329
|
+
* @param {conversation.trim} [attributes.trim] - Trim
|
|
4330
|
+
* @param {string} [attributes.recordingStatusCallback] -
|
|
4331
|
+
* Recording status callback URL
|
|
4332
|
+
* @param {string} [attributes.recordingStatusCallbackMethod] -
|
|
4333
|
+
* Recording status callback URL method
|
|
4334
|
+
* @param {conversation.recording_event} [attributes.recordingStatusCallbackEvent] -
|
|
4335
|
+
* Recording status callback events
|
|
4336
|
+
* @param {string} [attributes.statusCallback] - Status callback URL
|
|
4337
|
+
* @param {string} [attributes.statusCallbackMethod] - Status callback URL method
|
|
4338
|
+
* @param {conversation.event} [attributes.statusCallbackEvent] -
|
|
4339
|
+
* Events to call status callback URL
|
|
4340
|
+
*
|
|
4341
|
+
* @returns Conversation
|
|
4342
|
+
*/
|
|
4343
|
+
/* jshint ignore:end */
|
|
4344
|
+
Connect.prototype.conversation = function conversation(attributes) {
|
|
4345
|
+
return new Conversation(this.connect.ele('Conversation', attributes));
|
|
4346
|
+
};
|
|
4347
|
+
|
|
4348
|
+
|
|
4349
|
+
/* jshint ignore:start */
|
|
4350
|
+
/**
|
|
4351
|
+
* <Conversation> TwiML Noun
|
|
4352
|
+
*
|
|
4353
|
+
* @constructor Conversation
|
|
4354
|
+
*
|
|
4355
|
+
* @param {object} conversation - <Conversation> TwiML Noun
|
|
4356
|
+
*/
|
|
4357
|
+
/* jshint ignore:end */
|
|
4358
|
+
function Conversation(conversation) {
|
|
4359
|
+
this.conversation = conversation;
|
|
4360
|
+
this._propertyName = 'conversation';
|
|
4361
|
+
}
|
|
4362
|
+
|
|
4363
|
+
Conversation.prototype = Object.create(TwiML.prototype);
|
|
4364
|
+
Conversation.prototype.constructor = Conversation;
|
|
4365
|
+
|
|
4313
4366
|
|
|
4314
4367
|
/* jshint ignore:start */
|
|
4315
4368
|
/**
|
|
@@ -4328,6 +4381,60 @@ function VirtualAgent(virtualAgent) {
|
|
|
4328
4381
|
VirtualAgent.prototype = Object.create(TwiML.prototype);
|
|
4329
4382
|
VirtualAgent.prototype.constructor = VirtualAgent;
|
|
4330
4383
|
|
|
4384
|
+
/* jshint ignore:start */
|
|
4385
|
+
/**
|
|
4386
|
+
* <Config> TwiML Noun
|
|
4387
|
+
*
|
|
4388
|
+
* @function config
|
|
4389
|
+
* @memberof VirtualAgent#
|
|
4390
|
+
*
|
|
4391
|
+
* @param {object} [attributes] - TwiML attributes
|
|
4392
|
+
* @param {string} [attributes.name] - The name of the custom config
|
|
4393
|
+
* @param {string} [attributes.value] - The value of the custom config
|
|
4394
|
+
*
|
|
4395
|
+
* @returns Config
|
|
4396
|
+
*/
|
|
4397
|
+
/* jshint ignore:end */
|
|
4398
|
+
VirtualAgent.prototype.config = function config(attributes) {
|
|
4399
|
+
return new Config(this.virtual_agent.ele('Config', attributes));
|
|
4400
|
+
};
|
|
4401
|
+
|
|
4402
|
+
/* jshint ignore:start */
|
|
4403
|
+
/**
|
|
4404
|
+
* <Parameter> TwiML Noun
|
|
4405
|
+
*
|
|
4406
|
+
* @function parameter
|
|
4407
|
+
* @memberof VirtualAgent#
|
|
4408
|
+
*
|
|
4409
|
+
* @param {object} [attributes] - TwiML attributes
|
|
4410
|
+
* @param {string} [attributes.name] - The name of the custom parameter
|
|
4411
|
+
* @param {string} [attributes.value] - The value of the custom parameter
|
|
4412
|
+
*
|
|
4413
|
+
* @returns Parameter
|
|
4414
|
+
*/
|
|
4415
|
+
/* jshint ignore:end */
|
|
4416
|
+
VirtualAgent.prototype.parameter = function parameter(attributes) {
|
|
4417
|
+
return new Parameter(this.virtual_agent.ele('Parameter', attributes));
|
|
4418
|
+
};
|
|
4419
|
+
|
|
4420
|
+
|
|
4421
|
+
/* jshint ignore:start */
|
|
4422
|
+
/**
|
|
4423
|
+
* <Config> TwiML Noun
|
|
4424
|
+
*
|
|
4425
|
+
* @constructor Config
|
|
4426
|
+
*
|
|
4427
|
+
* @param {object} config - <Config> TwiML Noun
|
|
4428
|
+
*/
|
|
4429
|
+
/* jshint ignore:end */
|
|
4430
|
+
function Config(config) {
|
|
4431
|
+
this.config = config;
|
|
4432
|
+
this._propertyName = 'config';
|
|
4433
|
+
}
|
|
4434
|
+
|
|
4435
|
+
Config.prototype = Object.create(TwiML.prototype);
|
|
4436
|
+
Config.prototype.constructor = Config;
|
|
4437
|
+
|
|
4331
4438
|
|
|
4332
4439
|
/* jshint ignore:start */
|
|
4333
4440
|
/**
|
package/package.json
CHANGED
package/lib/rest/Fax.d.ts
DELETED
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This code was generated by
|
|
3
|
-
* \ / _ _ _| _ _
|
|
4
|
-
* | (_)\/(_)(_|\/| |(/_ v1.0.0
|
|
5
|
-
* / /
|
|
6
|
-
*/
|
|
7
|
-
|
|
8
|
-
import Domain = require('../base/Domain');
|
|
9
|
-
import Twilio = require('./Twilio');
|
|
10
|
-
import V1 = require('./fax/V1');
|
|
11
|
-
import { FaxListInstance } from './fax/v1/fax';
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
declare class Fax extends Domain {
|
|
15
|
-
/**
|
|
16
|
-
* Initialize fax domain
|
|
17
|
-
*
|
|
18
|
-
* @param twilio - The twilio client
|
|
19
|
-
*/
|
|
20
|
-
constructor(twilio: Twilio);
|
|
21
|
-
|
|
22
|
-
readonly faxes: FaxListInstance;
|
|
23
|
-
readonly v1: V1;
|
|
24
|
-
}
|
|
25
|
-
|
|
26
|
-
export = Fax;
|
package/lib/rest/Fax.js
DELETED
|
@@ -1,54 +0,0 @@
|
|
|
1
|
-
'use strict';
|
|
2
|
-
|
|
3
|
-
/* jshint ignore:start */
|
|
4
|
-
/**
|
|
5
|
-
* This code was generated by
|
|
6
|
-
* \ / _ _ _| _ _
|
|
7
|
-
* | (_)\/(_)(_|\/| |(/_ v1.0.0
|
|
8
|
-
* / /
|
|
9
|
-
*/
|
|
10
|
-
/* jshint ignore:end */
|
|
11
|
-
|
|
12
|
-
var _ = require('lodash'); /* jshint ignore:line */
|
|
13
|
-
var Domain = require('../base/Domain'); /* jshint ignore:line */
|
|
14
|
-
var V1 = require('./fax/V1'); /* jshint ignore:line */
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
/* jshint ignore:start */
|
|
18
|
-
/**
|
|
19
|
-
* Initialize fax domain
|
|
20
|
-
*
|
|
21
|
-
* @constructor Twilio.Fax
|
|
22
|
-
*
|
|
23
|
-
* @property {Twilio.Fax.V1} v1 - v1 version
|
|
24
|
-
* @property {Twilio.Fax.V1.FaxList} faxes - faxes resource
|
|
25
|
-
*
|
|
26
|
-
* @param {Twilio} twilio - The twilio client
|
|
27
|
-
*/
|
|
28
|
-
/* jshint ignore:end */
|
|
29
|
-
function Fax(twilio) {
|
|
30
|
-
Domain.prototype.constructor.call(this, twilio, 'https://fax.twilio.com');
|
|
31
|
-
|
|
32
|
-
// Versions
|
|
33
|
-
this._v1 = undefined;
|
|
34
|
-
}
|
|
35
|
-
|
|
36
|
-
_.extend(Fax.prototype, Domain.prototype);
|
|
37
|
-
Fax.prototype.constructor = Fax;
|
|
38
|
-
|
|
39
|
-
Object.defineProperty(Fax.prototype,
|
|
40
|
-
'v1', {
|
|
41
|
-
get: function() {
|
|
42
|
-
this._v1 = this._v1 || new V1(this);
|
|
43
|
-
return this._v1;
|
|
44
|
-
}
|
|
45
|
-
});
|
|
46
|
-
|
|
47
|
-
Object.defineProperty(Fax.prototype,
|
|
48
|
-
'faxes', {
|
|
49
|
-
get: function() {
|
|
50
|
-
return this.v1.faxes;
|
|
51
|
-
}
|
|
52
|
-
});
|
|
53
|
-
|
|
54
|
-
module.exports = Fax;
|
package/lib/rest/fax/V1.d.ts
DELETED
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This code was generated by
|
|
3
|
-
* \ / _ _ _| _ _
|
|
4
|
-
* | (_)\/(_)(_|\/| |(/_ v1.0.0
|
|
5
|
-
* / /
|
|
6
|
-
*/
|
|
7
|
-
|
|
8
|
-
import Fax = require('../Fax');
|
|
9
|
-
import Version = require('../../base/Version');
|
|
10
|
-
import { FaxList } from './v1/fax';
|
|
11
|
-
import { FaxListInstance } from './v1/fax';
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
declare class V1 extends Version {
|
|
15
|
-
/**
|
|
16
|
-
* Initialize the V1 version of Fax
|
|
17
|
-
*
|
|
18
|
-
* @param domain - The twilio domain
|
|
19
|
-
*/
|
|
20
|
-
constructor(domain: Fax);
|
|
21
|
-
|
|
22
|
-
readonly faxes: FaxListInstance;
|
|
23
|
-
}
|
|
24
|
-
|
|
25
|
-
export = V1;
|
package/lib/rest/fax/V1.js
DELETED
|
@@ -1,46 +0,0 @@
|
|
|
1
|
-
'use strict';
|
|
2
|
-
|
|
3
|
-
/* jshint ignore:start */
|
|
4
|
-
/**
|
|
5
|
-
* This code was generated by
|
|
6
|
-
* \ / _ _ _| _ _
|
|
7
|
-
* | (_)\/(_)(_|\/| |(/_ v1.0.0
|
|
8
|
-
* / /
|
|
9
|
-
*/
|
|
10
|
-
/* jshint ignore:end */
|
|
11
|
-
|
|
12
|
-
var _ = require('lodash'); /* jshint ignore:line */
|
|
13
|
-
var FaxList = require('./v1/fax').FaxList;
|
|
14
|
-
var Version = require('../../base/Version'); /* jshint ignore:line */
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
/* jshint ignore:start */
|
|
18
|
-
/**
|
|
19
|
-
* Initialize the V1 version of Fax
|
|
20
|
-
*
|
|
21
|
-
* @constructor Twilio.Fax.V1
|
|
22
|
-
*
|
|
23
|
-
* @property {Twilio.Fax.V1.FaxList} faxes - faxes resource
|
|
24
|
-
*
|
|
25
|
-
* @param {Twilio.Fax} domain - The twilio domain
|
|
26
|
-
*/
|
|
27
|
-
/* jshint ignore:end */
|
|
28
|
-
function V1(domain) {
|
|
29
|
-
Version.prototype.constructor.call(this, domain, 'v1');
|
|
30
|
-
|
|
31
|
-
// Resources
|
|
32
|
-
this._faxes = undefined;
|
|
33
|
-
}
|
|
34
|
-
|
|
35
|
-
_.extend(V1.prototype, Version.prototype);
|
|
36
|
-
V1.prototype.constructor = V1;
|
|
37
|
-
|
|
38
|
-
Object.defineProperty(V1.prototype,
|
|
39
|
-
'faxes', {
|
|
40
|
-
get: function() {
|
|
41
|
-
this._faxes = this._faxes || new FaxList(this);
|
|
42
|
-
return this._faxes;
|
|
43
|
-
}
|
|
44
|
-
});
|
|
45
|
-
|
|
46
|
-
module.exports = V1;
|
|
@@ -1,310 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This code was generated by
|
|
3
|
-
* \ / _ _ _| _ _
|
|
4
|
-
* | (_)\/(_)(_|\/| |(/_ v1.0.0
|
|
5
|
-
* / /
|
|
6
|
-
*/
|
|
7
|
-
|
|
8
|
-
import Page = require('../../../../base/Page');
|
|
9
|
-
import Response = require('../../../../http/response');
|
|
10
|
-
import V1 = require('../../V1');
|
|
11
|
-
import { SerializableClass } from '../../../../interfaces';
|
|
12
|
-
|
|
13
|
-
/**
|
|
14
|
-
* Initialize the FaxMediaList
|
|
15
|
-
*
|
|
16
|
-
* PLEASE NOTE that this class contains beta products that are subject to change.
|
|
17
|
-
* Use them with caution.
|
|
18
|
-
*
|
|
19
|
-
* @param version - Version of the resource
|
|
20
|
-
* @param faxSid - The SID of the fax the FaxMedia resource is associated with
|
|
21
|
-
*/
|
|
22
|
-
declare function FaxMediaList(version: V1, faxSid: string): FaxMediaListInstance;
|
|
23
|
-
|
|
24
|
-
interface FaxMediaListInstance {
|
|
25
|
-
/**
|
|
26
|
-
* @param sid - sid of instance
|
|
27
|
-
*/
|
|
28
|
-
(sid: string): FaxMediaContext;
|
|
29
|
-
/**
|
|
30
|
-
* Streams FaxMediaInstance records from the API.
|
|
31
|
-
*
|
|
32
|
-
* This operation lazily loads records as efficiently as possible until the limit
|
|
33
|
-
* is reached.
|
|
34
|
-
*
|
|
35
|
-
* The results are passed into the callback function, so this operation is memory
|
|
36
|
-
* efficient.
|
|
37
|
-
*
|
|
38
|
-
* If a function is passed as the first argument, it will be used as the callback
|
|
39
|
-
* function.
|
|
40
|
-
*
|
|
41
|
-
* @param callback - Function to process each record
|
|
42
|
-
*/
|
|
43
|
-
each(callback?: (item: FaxMediaInstance, done: (err?: Error) => void) => void): void;
|
|
44
|
-
/**
|
|
45
|
-
* Streams FaxMediaInstance records from the API.
|
|
46
|
-
*
|
|
47
|
-
* This operation lazily loads records as efficiently as possible until the limit
|
|
48
|
-
* is reached.
|
|
49
|
-
*
|
|
50
|
-
* The results are passed into the callback function, so this operation is memory
|
|
51
|
-
* efficient.
|
|
52
|
-
*
|
|
53
|
-
* If a function is passed as the first argument, it will be used as the callback
|
|
54
|
-
* function.
|
|
55
|
-
*
|
|
56
|
-
* @param opts - Options for request
|
|
57
|
-
* @param callback - Function to process each record
|
|
58
|
-
*/
|
|
59
|
-
each(opts?: FaxMediaListInstanceEachOptions, callback?: (item: FaxMediaInstance, done: (err?: Error) => void) => void): void;
|
|
60
|
-
/**
|
|
61
|
-
* Constructs a fax_media
|
|
62
|
-
*
|
|
63
|
-
* @param sid - The unique string that identifies the resource to fetch
|
|
64
|
-
*/
|
|
65
|
-
get(sid: string): FaxMediaContext;
|
|
66
|
-
/**
|
|
67
|
-
* Retrieve a single target page of FaxMediaInstance records from the API.
|
|
68
|
-
*
|
|
69
|
-
* The request is executed immediately.
|
|
70
|
-
*
|
|
71
|
-
* If a function is passed as the first argument, it will be used as the callback
|
|
72
|
-
* function.
|
|
73
|
-
*
|
|
74
|
-
* @param callback - Callback to handle list of records
|
|
75
|
-
*/
|
|
76
|
-
getPage(callback?: (error: Error | null, items: FaxMediaPage) => any): Promise<FaxMediaPage>;
|
|
77
|
-
/**
|
|
78
|
-
* Retrieve a single target page of FaxMediaInstance records from the API.
|
|
79
|
-
*
|
|
80
|
-
* The request is executed immediately.
|
|
81
|
-
*
|
|
82
|
-
* If a function is passed as the first argument, it will be used as the callback
|
|
83
|
-
* function.
|
|
84
|
-
*
|
|
85
|
-
* @param targetUrl - API-generated URL for the requested results page
|
|
86
|
-
* @param callback - Callback to handle list of records
|
|
87
|
-
*/
|
|
88
|
-
getPage(targetUrl?: string, callback?: (error: Error | null, items: FaxMediaPage) => any): Promise<FaxMediaPage>;
|
|
89
|
-
/**
|
|
90
|
-
* Lists FaxMediaInstance records from the API as a list.
|
|
91
|
-
*
|
|
92
|
-
* If a function is passed as the first argument, it will be used as the callback
|
|
93
|
-
* function.
|
|
94
|
-
*
|
|
95
|
-
* @param callback - Callback to handle list of records
|
|
96
|
-
*/
|
|
97
|
-
list(callback?: (error: Error | null, items: FaxMediaInstance[]) => any): Promise<FaxMediaInstance[]>;
|
|
98
|
-
/**
|
|
99
|
-
* Lists FaxMediaInstance records from the API as a list.
|
|
100
|
-
*
|
|
101
|
-
* If a function is passed as the first argument, it will be used as the callback
|
|
102
|
-
* function.
|
|
103
|
-
*
|
|
104
|
-
* @param opts - Options for request
|
|
105
|
-
* @param callback - Callback to handle list of records
|
|
106
|
-
*/
|
|
107
|
-
list(opts?: FaxMediaListInstanceOptions, callback?: (error: Error | null, items: FaxMediaInstance[]) => any): Promise<FaxMediaInstance[]>;
|
|
108
|
-
/**
|
|
109
|
-
* Retrieve a single page of FaxMediaInstance records from the API.
|
|
110
|
-
*
|
|
111
|
-
* The request is executed immediately.
|
|
112
|
-
*
|
|
113
|
-
* If a function is passed as the first argument, it will be used as the callback
|
|
114
|
-
* function.
|
|
115
|
-
*
|
|
116
|
-
* @param callback - Callback to handle list of records
|
|
117
|
-
*/
|
|
118
|
-
page(callback?: (error: Error | null, items: FaxMediaPage) => any): Promise<FaxMediaPage>;
|
|
119
|
-
/**
|
|
120
|
-
* Retrieve a single page of FaxMediaInstance records from the API.
|
|
121
|
-
*
|
|
122
|
-
* The request is executed immediately.
|
|
123
|
-
*
|
|
124
|
-
* If a function is passed as the first argument, it will be used as the callback
|
|
125
|
-
* function.
|
|
126
|
-
*
|
|
127
|
-
* @param opts - Options for request
|
|
128
|
-
* @param callback - Callback to handle list of records
|
|
129
|
-
*/
|
|
130
|
-
page(opts?: FaxMediaListInstancePageOptions, callback?: (error: Error | null, items: FaxMediaPage) => any): Promise<FaxMediaPage>;
|
|
131
|
-
/**
|
|
132
|
-
* Provide a user-friendly representation
|
|
133
|
-
*/
|
|
134
|
-
toJSON(): any;
|
|
135
|
-
}
|
|
136
|
-
|
|
137
|
-
/**
|
|
138
|
-
* Options to pass to each
|
|
139
|
-
*
|
|
140
|
-
* @property callback -
|
|
141
|
-
* Function to process each record. If this and a positional
|
|
142
|
-
* callback are passed, this one will be used
|
|
143
|
-
* @property done - Function to be called upon completion of streaming
|
|
144
|
-
* @property limit -
|
|
145
|
-
* Upper limit for the number of records to return.
|
|
146
|
-
* each() guarantees never to return more than limit.
|
|
147
|
-
* Default is no limit
|
|
148
|
-
* @property pageSize -
|
|
149
|
-
* Number of records to fetch per request,
|
|
150
|
-
* when not set will use the default value of 50 records.
|
|
151
|
-
* If no pageSize is defined but a limit is defined,
|
|
152
|
-
* each() will attempt to read the limit with the most efficient
|
|
153
|
-
* page size, i.e. min(limit, 1000)
|
|
154
|
-
*/
|
|
155
|
-
interface FaxMediaListInstanceEachOptions {
|
|
156
|
-
callback?: (item: FaxMediaInstance, done: (err?: Error) => void) => void;
|
|
157
|
-
done?: Function;
|
|
158
|
-
limit?: number;
|
|
159
|
-
pageSize?: number;
|
|
160
|
-
}
|
|
161
|
-
|
|
162
|
-
/**
|
|
163
|
-
* Options to pass to list
|
|
164
|
-
*
|
|
165
|
-
* @property limit -
|
|
166
|
-
* Upper limit for the number of records to return.
|
|
167
|
-
* list() guarantees never to return more than limit.
|
|
168
|
-
* Default is no limit
|
|
169
|
-
* @property pageSize -
|
|
170
|
-
* Number of records to fetch per request,
|
|
171
|
-
* when not set will use the default value of 50 records.
|
|
172
|
-
* If no page_size is defined but a limit is defined,
|
|
173
|
-
* list() will attempt to read the limit with the most
|
|
174
|
-
* efficient page size, i.e. min(limit, 1000)
|
|
175
|
-
*/
|
|
176
|
-
interface FaxMediaListInstanceOptions {
|
|
177
|
-
limit?: number;
|
|
178
|
-
pageSize?: number;
|
|
179
|
-
}
|
|
180
|
-
|
|
181
|
-
/**
|
|
182
|
-
* Options to pass to page
|
|
183
|
-
*
|
|
184
|
-
* @property pageNumber - Page Number, this value is simply for client state
|
|
185
|
-
* @property pageSize - Number of records to return, defaults to 50
|
|
186
|
-
* @property pageToken - PageToken provided by the API
|
|
187
|
-
*/
|
|
188
|
-
interface FaxMediaListInstancePageOptions {
|
|
189
|
-
pageNumber?: number;
|
|
190
|
-
pageSize?: number;
|
|
191
|
-
pageToken?: string;
|
|
192
|
-
}
|
|
193
|
-
|
|
194
|
-
interface FaxMediaPayload extends FaxMediaResource, Page.TwilioResponsePayload {
|
|
195
|
-
}
|
|
196
|
-
|
|
197
|
-
interface FaxMediaResource {
|
|
198
|
-
account_sid: string;
|
|
199
|
-
content_type: string;
|
|
200
|
-
date_created: Date;
|
|
201
|
-
date_updated: Date;
|
|
202
|
-
fax_sid: string;
|
|
203
|
-
sid: string;
|
|
204
|
-
url: string;
|
|
205
|
-
}
|
|
206
|
-
|
|
207
|
-
interface FaxMediaSolution {
|
|
208
|
-
faxSid?: string;
|
|
209
|
-
}
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
declare class FaxMediaContext {
|
|
213
|
-
/**
|
|
214
|
-
* Initialize the FaxMediaContext
|
|
215
|
-
*
|
|
216
|
-
* PLEASE NOTE that this class contains beta products that are subject to change.
|
|
217
|
-
* Use them with caution.
|
|
218
|
-
*
|
|
219
|
-
* @param version - Version of the resource
|
|
220
|
-
* @param faxSid - The SID of the fax with the FaxMedia resource to fetch
|
|
221
|
-
* @param sid - The unique string that identifies the resource to fetch
|
|
222
|
-
*/
|
|
223
|
-
constructor(version: V1, faxSid: string, sid: string);
|
|
224
|
-
|
|
225
|
-
/**
|
|
226
|
-
* fetch a FaxMediaInstance
|
|
227
|
-
*
|
|
228
|
-
* @param callback - Callback to handle processed record
|
|
229
|
-
*/
|
|
230
|
-
fetch(callback?: (error: Error | null, items: FaxMediaInstance) => any): Promise<FaxMediaInstance>;
|
|
231
|
-
/**
|
|
232
|
-
* remove a FaxMediaInstance
|
|
233
|
-
*
|
|
234
|
-
* @param callback - Callback to handle processed record
|
|
235
|
-
*/
|
|
236
|
-
remove(callback?: (error: Error | null, items: FaxMediaInstance) => any): Promise<boolean>;
|
|
237
|
-
/**
|
|
238
|
-
* Provide a user-friendly representation
|
|
239
|
-
*/
|
|
240
|
-
toJSON(): any;
|
|
241
|
-
}
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
declare class FaxMediaInstance extends SerializableClass {
|
|
245
|
-
/**
|
|
246
|
-
* Initialize the FaxMediaContext
|
|
247
|
-
*
|
|
248
|
-
* PLEASE NOTE that this class contains beta products that are subject to change.
|
|
249
|
-
* Use them with caution.
|
|
250
|
-
*
|
|
251
|
-
* @param version - Version of the resource
|
|
252
|
-
* @param payload - The instance payload
|
|
253
|
-
* @param faxSid - The SID of the fax the FaxMedia resource is associated with
|
|
254
|
-
* @param sid - The unique string that identifies the resource to fetch
|
|
255
|
-
*/
|
|
256
|
-
constructor(version: V1, payload: FaxMediaPayload, faxSid: string, sid: string);
|
|
257
|
-
|
|
258
|
-
private _proxy: FaxMediaContext;
|
|
259
|
-
accountSid: string;
|
|
260
|
-
contentType: string;
|
|
261
|
-
dateCreated: Date;
|
|
262
|
-
dateUpdated: Date;
|
|
263
|
-
faxSid: string;
|
|
264
|
-
/**
|
|
265
|
-
* fetch a FaxMediaInstance
|
|
266
|
-
*
|
|
267
|
-
* @param callback - Callback to handle processed record
|
|
268
|
-
*/
|
|
269
|
-
fetch(callback?: (error: Error | null, items: FaxMediaInstance) => any): Promise<FaxMediaInstance>;
|
|
270
|
-
/**
|
|
271
|
-
* remove a FaxMediaInstance
|
|
272
|
-
*
|
|
273
|
-
* @param callback - Callback to handle processed record
|
|
274
|
-
*/
|
|
275
|
-
remove(callback?: (error: Error | null, items: FaxMediaInstance) => any): Promise<boolean>;
|
|
276
|
-
sid: string;
|
|
277
|
-
/**
|
|
278
|
-
* Provide a user-friendly representation
|
|
279
|
-
*/
|
|
280
|
-
toJSON(): any;
|
|
281
|
-
url: string;
|
|
282
|
-
}
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
declare class FaxMediaPage extends Page<V1, FaxMediaPayload, FaxMediaResource, FaxMediaInstance> {
|
|
286
|
-
/**
|
|
287
|
-
* Initialize the FaxMediaPage
|
|
288
|
-
*
|
|
289
|
-
* PLEASE NOTE that this class contains beta products that are subject to change.
|
|
290
|
-
* Use them with caution.
|
|
291
|
-
*
|
|
292
|
-
* @param version - Version of the resource
|
|
293
|
-
* @param response - Response from the API
|
|
294
|
-
* @param solution - Path solution
|
|
295
|
-
*/
|
|
296
|
-
constructor(version: V1, response: Response<string>, solution: FaxMediaSolution);
|
|
297
|
-
|
|
298
|
-
/**
|
|
299
|
-
* Build an instance of FaxMediaInstance
|
|
300
|
-
*
|
|
301
|
-
* @param payload - Payload response from the API
|
|
302
|
-
*/
|
|
303
|
-
getInstance(payload: FaxMediaPayload): FaxMediaInstance;
|
|
304
|
-
/**
|
|
305
|
-
* Provide a user-friendly representation
|
|
306
|
-
*/
|
|
307
|
-
toJSON(): any;
|
|
308
|
-
}
|
|
309
|
-
|
|
310
|
-
export { FaxMediaContext, FaxMediaInstance, FaxMediaList, FaxMediaListInstance, FaxMediaListInstanceEachOptions, FaxMediaListInstanceOptions, FaxMediaListInstancePageOptions, FaxMediaPage, FaxMediaPayload, FaxMediaResource, FaxMediaSolution }
|