twilio 3.81.0 → 3.82.0
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/Messaging.d.ts +2 -0
- package/lib/rest/Messaging.js +9 -0
- package/lib/rest/Verify.d.ts +2 -0
- package/lib/rest/Verify.js +8 -0
- package/lib/rest/flexApi/v1/configuration.d.ts +4 -0
- package/lib/rest/flexApi/v1/configuration.js +6 -0
- package/lib/rest/flexApi/v1/interaction/interactionChannel/interactionChannelParticipant.d.ts +1 -1
- package/lib/rest/flexApi/v1/interaction/interactionChannel.d.ts +1 -1
- package/lib/rest/flexApi/v1/interaction.d.ts +1 -3
- package/lib/rest/messaging/V1.d.ts +3 -0
- package/lib/rest/messaging/V1.js +13 -0
- package/lib/rest/messaging/v1/tollfreeVerification.d.ts +418 -0
- package/lib/rest/messaging/v1/tollfreeVerification.js +802 -0
- package/lib/rest/verify/V2.d.ts +3 -0
- package/lib/rest/verify/V2.js +11 -0
- package/lib/rest/verify/v2/safelist.d.ts +161 -0
- package/lib/rest/verify/v2/safelist.js +408 -0
- package/lib/rest/video/v1/room/roomParticipant/roomParticipantAnonymize.d.ts +143 -0
- package/lib/rest/video/v1/room/roomParticipant/roomParticipantAnonymize.js +337 -0
- package/lib/rest/video/v1/room/roomParticipant.d.ts +7 -0
- package/lib/rest/video/v1/room/roomParticipant.js +29 -0
- package/lib/twiml/VoiceResponse.d.ts +1 -1
- package/lib/webhooks/webhooks.js +1 -0
- package/package.json +1 -1
package/lib/rest/Messaging.d.ts
CHANGED
|
@@ -12,6 +12,7 @@ import { BrandRegistrationListInstance } from './messaging/v1/brandRegistration'
|
|
|
12
12
|
import { DeactivationsListInstance } from './messaging/v1/deactivation';
|
|
13
13
|
import { ExternalCampaignListInstance } from './messaging/v1/externalCampaign';
|
|
14
14
|
import { ServiceListInstance } from './messaging/v1/service';
|
|
15
|
+
import { TollfreeVerificationListInstance } from './messaging/v1/tollfreeVerification';
|
|
15
16
|
import { UsecaseListInstance } from './messaging/v1/usecase';
|
|
16
17
|
|
|
17
18
|
|
|
@@ -27,6 +28,7 @@ declare class Messaging extends Domain {
|
|
|
27
28
|
readonly deactivations: DeactivationsListInstance;
|
|
28
29
|
readonly externalCampaign: ExternalCampaignListInstance;
|
|
29
30
|
readonly services: ServiceListInstance;
|
|
31
|
+
readonly tollfreeVerifications: TollfreeVerificationListInstance;
|
|
30
32
|
readonly usecases: UsecaseListInstance;
|
|
31
33
|
readonly v1: V1;
|
|
32
34
|
}
|
package/lib/rest/Messaging.js
CHANGED
|
@@ -28,6 +28,8 @@ var V1 = require('./messaging/V1'); /* jshint ignore:line */
|
|
|
28
28
|
* @property {Twilio.Messaging.V1.ExternalCampaignList} externalCampaign -
|
|
29
29
|
* externalCampaign resource
|
|
30
30
|
* @property {Twilio.Messaging.V1.ServiceList} services - services resource
|
|
31
|
+
* @property {Twilio.Messaging.V1.TollfreeVerificationList} tollfreeVerifications -
|
|
32
|
+
* tollfreeVerifications resource
|
|
31
33
|
* @property {Twilio.Messaging.V1.UsecaseList} usecases - usecases resource
|
|
32
34
|
*
|
|
33
35
|
* @param {Twilio} twilio - The twilio client
|
|
@@ -79,6 +81,13 @@ Object.defineProperty(Messaging.prototype,
|
|
|
79
81
|
}
|
|
80
82
|
});
|
|
81
83
|
|
|
84
|
+
Object.defineProperty(Messaging.prototype,
|
|
85
|
+
'tollfreeVerifications', {
|
|
86
|
+
get: function() {
|
|
87
|
+
return this.v1.tollfreeVerifications;
|
|
88
|
+
}
|
|
89
|
+
});
|
|
90
|
+
|
|
82
91
|
Object.defineProperty(Messaging.prototype,
|
|
83
92
|
'usecases', {
|
|
84
93
|
get: function() {
|
package/lib/rest/Verify.d.ts
CHANGED
|
@@ -9,6 +9,7 @@ import Domain = require('../base/Domain');
|
|
|
9
9
|
import Twilio = require('./Twilio');
|
|
10
10
|
import V2 = require('./verify/V2');
|
|
11
11
|
import { FormListInstance } from './verify/v2/form';
|
|
12
|
+
import { SafelistListInstance } from './verify/v2/safelist';
|
|
12
13
|
import { ServiceListInstance } from './verify/v2/service';
|
|
13
14
|
import { TemplateListInstance } from './verify/v2/template';
|
|
14
15
|
import { VerificationAttemptListInstance } from './verify/v2/verificationAttempt';
|
|
@@ -24,6 +25,7 @@ declare class Verify extends Domain {
|
|
|
24
25
|
constructor(twilio: Twilio);
|
|
25
26
|
|
|
26
27
|
readonly forms: FormListInstance;
|
|
28
|
+
readonly safelist: SafelistListInstance;
|
|
27
29
|
readonly services: ServiceListInstance;
|
|
28
30
|
readonly templates: TemplateListInstance;
|
|
29
31
|
readonly v2: V2;
|
package/lib/rest/Verify.js
CHANGED
|
@@ -22,6 +22,7 @@ var V2 = require('./verify/V2'); /* jshint ignore:line */
|
|
|
22
22
|
*
|
|
23
23
|
* @property {Twilio.Verify.V2} v2 - v2 version
|
|
24
24
|
* @property {Twilio.Verify.V2.FormList} forms - forms resource
|
|
25
|
+
* @property {Twilio.Verify.V2.SafelistList} safelist - safelist resource
|
|
25
26
|
* @property {Twilio.Verify.V2.ServiceList} services - services resource
|
|
26
27
|
* @property {Twilio.Verify.V2.VerificationAttemptList} verificationAttempts -
|
|
27
28
|
* verificationAttempts resource
|
|
@@ -57,6 +58,13 @@ Object.defineProperty(Verify.prototype,
|
|
|
57
58
|
}
|
|
58
59
|
});
|
|
59
60
|
|
|
61
|
+
Object.defineProperty(Verify.prototype,
|
|
62
|
+
'safelist', {
|
|
63
|
+
get: function() {
|
|
64
|
+
return this.v2.safelist;
|
|
65
|
+
}
|
|
66
|
+
});
|
|
67
|
+
|
|
60
68
|
Object.defineProperty(Verify.prototype,
|
|
61
69
|
'services', {
|
|
62
70
|
get: function() {
|
|
@@ -60,9 +60,11 @@ interface ConfigurationResource {
|
|
|
60
60
|
crm_type: string;
|
|
61
61
|
date_created: Date;
|
|
62
62
|
date_updated: Date;
|
|
63
|
+
debugger_integration: object;
|
|
63
64
|
flex_insights_drilldown: boolean;
|
|
64
65
|
flex_insights_hr: object;
|
|
65
66
|
flex_service_instance_sid: string;
|
|
67
|
+
flex_ui_status_report: object;
|
|
66
68
|
flex_url: string;
|
|
67
69
|
integrations: object[];
|
|
68
70
|
markdown: object;
|
|
@@ -165,6 +167,7 @@ declare class ConfigurationInstance extends SerializableClass {
|
|
|
165
167
|
crmType: string;
|
|
166
168
|
dateCreated: Date;
|
|
167
169
|
dateUpdated: Date;
|
|
170
|
+
debuggerIntegration: any;
|
|
168
171
|
/**
|
|
169
172
|
* fetch a ConfigurationInstance
|
|
170
173
|
*
|
|
@@ -181,6 +184,7 @@ declare class ConfigurationInstance extends SerializableClass {
|
|
|
181
184
|
flexInsightsDrilldown: boolean;
|
|
182
185
|
flexInsightsHr: any;
|
|
183
186
|
flexServiceInstanceSid: string;
|
|
187
|
+
flexUiStatusReport: any;
|
|
184
188
|
flexUrl: string;
|
|
185
189
|
integrations: object[];
|
|
186
190
|
markdown: any;
|
|
@@ -216,6 +216,10 @@ ConfigurationPage.prototype[util.inspect.custom] = function inspect(depth,
|
|
|
216
216
|
* @property {string} flexUrl - URL to redirect to in case drilldown is enabled.
|
|
217
217
|
* @property {object} channelConfigs -
|
|
218
218
|
* Flex Conversations channels' attachments configurations
|
|
219
|
+
* @property {object} debuggerIntegration -
|
|
220
|
+
* Configurable parameters for Debugger Integration
|
|
221
|
+
* @property {object} flexUiStatusReport -
|
|
222
|
+
* Configurable parameters for Flex UI Status report
|
|
219
223
|
*
|
|
220
224
|
* @param {V1} version - Version of the resource
|
|
221
225
|
* @param {ConfigurationPayload} payload - The instance payload
|
|
@@ -268,6 +272,8 @@ ConfigurationInstance = function ConfigurationInstance(version, payload) {
|
|
|
268
272
|
this.flexInsightsDrilldown = payload.flex_insights_drilldown; // jshint ignore:line
|
|
269
273
|
this.flexUrl = payload.flex_url; // jshint ignore:line
|
|
270
274
|
this.channelConfigs = payload.channel_configs; // jshint ignore:line
|
|
275
|
+
this.debuggerIntegration = payload.debugger_integration; // jshint ignore:line
|
|
276
|
+
this.flexUiStatusReport = payload.flex_ui_status_report; // jshint ignore:line
|
|
271
277
|
|
|
272
278
|
// Context
|
|
273
279
|
this._context = undefined;
|
package/lib/rest/flexApi/v1/interaction/interactionChannel/interactionChannelParticipant.d.ts
CHANGED
|
@@ -10,7 +10,7 @@ import Response = require('../../../../../http/response');
|
|
|
10
10
|
import V1 = require('../../../V1');
|
|
11
11
|
import { SerializableClass } from '../../../../../interfaces';
|
|
12
12
|
|
|
13
|
-
type InteractionChannelParticipantStatus = '
|
|
13
|
+
type InteractionChannelParticipantStatus = 'closed'|'wrapup';
|
|
14
14
|
|
|
15
15
|
type InteractionChannelParticipantType = 'supervisor'|'customer'|'external'|'agent'|'unknown';
|
|
16
16
|
|
|
@@ -16,7 +16,7 @@ import { SerializableClass } from '../../../../interfaces';
|
|
|
16
16
|
|
|
17
17
|
type InteractionChannelChannelStatus = 'setup'|'active'|'failed'|'closed';
|
|
18
18
|
|
|
19
|
-
type InteractionChannelStatus = '
|
|
19
|
+
type InteractionChannelStatus = 'closed'|'wrapup';
|
|
20
20
|
|
|
21
21
|
type InteractionChannelType = 'voice'|'sms'|'email'|'web'|'whatsapp'|'chat'|'messenger'|'gbm';
|
|
22
22
|
|
|
@@ -12,8 +12,6 @@ import { InteractionChannelList } from './interaction/interactionChannel';
|
|
|
12
12
|
import { InteractionChannelListInstance } from './interaction/interactionChannel';
|
|
13
13
|
import { SerializableClass } from '../../../interfaces';
|
|
14
14
|
|
|
15
|
-
type InteractionStatus = 'close'|'closed'|'wrapup';
|
|
16
|
-
|
|
17
15
|
/**
|
|
18
16
|
* Initialize the InteractionList
|
|
19
17
|
*
|
|
@@ -149,4 +147,4 @@ declare class InteractionPage extends Page<V1, InteractionPayload, InteractionRe
|
|
|
149
147
|
toJSON(): any;
|
|
150
148
|
}
|
|
151
149
|
|
|
152
|
-
export { InteractionContext, InteractionInstance, InteractionList, InteractionListInstance, InteractionListInstanceCreateOptions, InteractionPage, InteractionPayload, InteractionResource, InteractionSolution
|
|
150
|
+
export { InteractionContext, InteractionInstance, InteractionList, InteractionListInstance, InteractionListInstanceCreateOptions, InteractionPage, InteractionPayload, InteractionResource, InteractionSolution }
|
|
@@ -15,6 +15,8 @@ import { ExternalCampaignList } from './v1/externalCampaign';
|
|
|
15
15
|
import { ExternalCampaignListInstance } from './v1/externalCampaign';
|
|
16
16
|
import { ServiceList } from './v1/service';
|
|
17
17
|
import { ServiceListInstance } from './v1/service';
|
|
18
|
+
import { TollfreeVerificationList } from './v1/tollfreeVerification';
|
|
19
|
+
import { TollfreeVerificationListInstance } from './v1/tollfreeVerification';
|
|
18
20
|
import { UsecaseList } from './v1/usecase';
|
|
19
21
|
import { UsecaseListInstance } from './v1/usecase';
|
|
20
22
|
|
|
@@ -31,6 +33,7 @@ declare class V1 extends Version {
|
|
|
31
33
|
readonly deactivations: DeactivationsListInstance;
|
|
32
34
|
readonly externalCampaign: ExternalCampaignListInstance;
|
|
33
35
|
readonly services: ServiceListInstance;
|
|
36
|
+
readonly tollfreeVerifications: TollfreeVerificationListInstance;
|
|
34
37
|
readonly usecases: UsecaseListInstance;
|
|
35
38
|
}
|
|
36
39
|
|
package/lib/rest/messaging/V1.js
CHANGED
|
@@ -16,6 +16,8 @@ var DeactivationsList = require('./v1/deactivation').DeactivationsList;
|
|
|
16
16
|
var ExternalCampaignList = require(
|
|
17
17
|
'./v1/externalCampaign').ExternalCampaignList;
|
|
18
18
|
var ServiceList = require('./v1/service').ServiceList;
|
|
19
|
+
var TollfreeVerificationList = require(
|
|
20
|
+
'./v1/tollfreeVerification').TollfreeVerificationList;
|
|
19
21
|
var UsecaseList = require('./v1/usecase').UsecaseList;
|
|
20
22
|
var Version = require('../../base/Version'); /* jshint ignore:line */
|
|
21
23
|
|
|
@@ -33,6 +35,8 @@ var Version = require('../../base/Version'); /* jshint ignore:line */
|
|
|
33
35
|
* @property {Twilio.Messaging.V1.ExternalCampaignList} externalCampaign -
|
|
34
36
|
* externalCampaign resource
|
|
35
37
|
* @property {Twilio.Messaging.V1.ServiceList} services - services resource
|
|
38
|
+
* @property {Twilio.Messaging.V1.TollfreeVerificationList} tollfreeVerifications -
|
|
39
|
+
* tollfreeVerifications resource
|
|
36
40
|
* @property {Twilio.Messaging.V1.UsecaseList} usecases - usecases resource
|
|
37
41
|
*
|
|
38
42
|
* @param {Twilio.Messaging} domain - The twilio domain
|
|
@@ -46,6 +50,7 @@ function V1(domain) {
|
|
|
46
50
|
this._deactivations = undefined;
|
|
47
51
|
this._externalCampaign = undefined;
|
|
48
52
|
this._services = undefined;
|
|
53
|
+
this._tollfreeVerifications = undefined;
|
|
49
54
|
this._usecases = undefined;
|
|
50
55
|
}
|
|
51
56
|
|
|
@@ -84,6 +89,14 @@ Object.defineProperty(V1.prototype,
|
|
|
84
89
|
}
|
|
85
90
|
});
|
|
86
91
|
|
|
92
|
+
Object.defineProperty(V1.prototype,
|
|
93
|
+
'tollfreeVerifications', {
|
|
94
|
+
get: function() {
|
|
95
|
+
this._tollfreeVerifications = this._tollfreeVerifications || new TollfreeVerificationList(this);
|
|
96
|
+
return this._tollfreeVerifications;
|
|
97
|
+
}
|
|
98
|
+
});
|
|
99
|
+
|
|
87
100
|
Object.defineProperty(V1.prototype,
|
|
88
101
|
'usecases', {
|
|
89
102
|
get: function() {
|
|
@@ -0,0 +1,418 @@
|
|
|
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
|
+
type TollfreeVerificationOptInType = 'VERBAL'|'WEB_FORM'|'PAPER_FORM'|'VIA_TEXT'|'MOBILE_QR_CODE';
|
|
14
|
+
|
|
15
|
+
type TollfreeVerificationStatus = 'PENDING_REVIEW'|'IN_REVIEW'|'TWILIO_APPROVED'|'TWILIO_REJECTED';
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
* Initialize the TollfreeVerificationList
|
|
19
|
+
*
|
|
20
|
+
* PLEASE NOTE that this class contains beta products that are subject to change.
|
|
21
|
+
* Use them with caution.
|
|
22
|
+
*
|
|
23
|
+
* @param version - Version of the resource
|
|
24
|
+
*/
|
|
25
|
+
declare function TollfreeVerificationList(version: V1): TollfreeVerificationListInstance;
|
|
26
|
+
|
|
27
|
+
interface TollfreeVerificationListInstance {
|
|
28
|
+
/**
|
|
29
|
+
* @param sid - sid of instance
|
|
30
|
+
*/
|
|
31
|
+
(sid: string): TollfreeVerificationContext;
|
|
32
|
+
/**
|
|
33
|
+
* create a TollfreeVerificationInstance
|
|
34
|
+
*
|
|
35
|
+
* @param opts - Options for request
|
|
36
|
+
* @param callback - Callback to handle processed record
|
|
37
|
+
*/
|
|
38
|
+
create(opts: TollfreeVerificationListInstanceCreateOptions, callback?: (error: Error | null, item: TollfreeVerificationInstance) => any): Promise<TollfreeVerificationInstance>;
|
|
39
|
+
/**
|
|
40
|
+
* Streams TollfreeVerificationInstance records from the API.
|
|
41
|
+
*
|
|
42
|
+
* This operation lazily loads records as efficiently as possible until the limit
|
|
43
|
+
* is reached.
|
|
44
|
+
*
|
|
45
|
+
* The results are passed into the callback function, so this operation is memory
|
|
46
|
+
* efficient.
|
|
47
|
+
*
|
|
48
|
+
* If a function is passed as the first argument, it will be used as the callback
|
|
49
|
+
* function.
|
|
50
|
+
*
|
|
51
|
+
* @param callback - Function to process each record
|
|
52
|
+
*/
|
|
53
|
+
each(callback?: (item: TollfreeVerificationInstance, done: (err?: Error) => void) => void): void;
|
|
54
|
+
/**
|
|
55
|
+
* Streams TollfreeVerificationInstance records from the API.
|
|
56
|
+
*
|
|
57
|
+
* This operation lazily loads records as efficiently as possible until the limit
|
|
58
|
+
* is reached.
|
|
59
|
+
*
|
|
60
|
+
* The results are passed into the callback function, so this operation is memory
|
|
61
|
+
* efficient.
|
|
62
|
+
*
|
|
63
|
+
* If a function is passed as the first argument, it will be used as the callback
|
|
64
|
+
* function.
|
|
65
|
+
*
|
|
66
|
+
* @param opts - Options for request
|
|
67
|
+
* @param callback - Function to process each record
|
|
68
|
+
*/
|
|
69
|
+
each(opts?: TollfreeVerificationListInstanceEachOptions, callback?: (item: TollfreeVerificationInstance, done: (err?: Error) => void) => void): void;
|
|
70
|
+
/**
|
|
71
|
+
* Constructs a tollfree_verification
|
|
72
|
+
*
|
|
73
|
+
* @param sid - Tollfree Verification Sid
|
|
74
|
+
*/
|
|
75
|
+
get(sid: string): TollfreeVerificationContext;
|
|
76
|
+
/**
|
|
77
|
+
* Retrieve a single target page of TollfreeVerificationInstance records from the
|
|
78
|
+
* 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 callback - Callback to handle list of records
|
|
86
|
+
*/
|
|
87
|
+
getPage(callback?: (error: Error | null, items: TollfreeVerificationPage) => any): Promise<TollfreeVerificationPage>;
|
|
88
|
+
/**
|
|
89
|
+
* Retrieve a single target page of TollfreeVerificationInstance records from the
|
|
90
|
+
* API.
|
|
91
|
+
*
|
|
92
|
+
* The request is executed immediately.
|
|
93
|
+
*
|
|
94
|
+
* If a function is passed as the first argument, it will be used as the callback
|
|
95
|
+
* function.
|
|
96
|
+
*
|
|
97
|
+
* @param targetUrl - API-generated URL for the requested results page
|
|
98
|
+
* @param callback - Callback to handle list of records
|
|
99
|
+
*/
|
|
100
|
+
getPage(targetUrl?: string, callback?: (error: Error | null, items: TollfreeVerificationPage) => any): Promise<TollfreeVerificationPage>;
|
|
101
|
+
/**
|
|
102
|
+
* Lists TollfreeVerificationInstance records from the API as a list.
|
|
103
|
+
*
|
|
104
|
+
* If a function is passed as the first argument, it will be used as the callback
|
|
105
|
+
* function.
|
|
106
|
+
*
|
|
107
|
+
* @param callback - Callback to handle list of records
|
|
108
|
+
*/
|
|
109
|
+
list(callback?: (error: Error | null, items: TollfreeVerificationInstance[]) => any): Promise<TollfreeVerificationInstance[]>;
|
|
110
|
+
/**
|
|
111
|
+
* Lists TollfreeVerificationInstance records from the API as a list.
|
|
112
|
+
*
|
|
113
|
+
* If a function is passed as the first argument, it will be used as the callback
|
|
114
|
+
* function.
|
|
115
|
+
*
|
|
116
|
+
* @param opts - Options for request
|
|
117
|
+
* @param callback - Callback to handle list of records
|
|
118
|
+
*/
|
|
119
|
+
list(opts?: TollfreeVerificationListInstanceOptions, callback?: (error: Error | null, items: TollfreeVerificationInstance[]) => any): Promise<TollfreeVerificationInstance[]>;
|
|
120
|
+
/**
|
|
121
|
+
* Retrieve a single page of TollfreeVerificationInstance records from the API.
|
|
122
|
+
*
|
|
123
|
+
* The request is executed immediately.
|
|
124
|
+
*
|
|
125
|
+
* If a function is passed as the first argument, it will be used as the callback
|
|
126
|
+
* function.
|
|
127
|
+
*
|
|
128
|
+
* @param callback - Callback to handle list of records
|
|
129
|
+
*/
|
|
130
|
+
page(callback?: (error: Error | null, items: TollfreeVerificationPage) => any): Promise<TollfreeVerificationPage>;
|
|
131
|
+
/**
|
|
132
|
+
* Retrieve a single page of TollfreeVerificationInstance records from the API.
|
|
133
|
+
*
|
|
134
|
+
* The request is executed immediately.
|
|
135
|
+
*
|
|
136
|
+
* If a function is passed as the first argument, it will be used as the callback
|
|
137
|
+
* function.
|
|
138
|
+
*
|
|
139
|
+
* @param opts - Options for request
|
|
140
|
+
* @param callback - Callback to handle list of records
|
|
141
|
+
*/
|
|
142
|
+
page(opts?: TollfreeVerificationListInstancePageOptions, callback?: (error: Error | null, items: TollfreeVerificationPage) => any): Promise<TollfreeVerificationPage>;
|
|
143
|
+
/**
|
|
144
|
+
* Provide a user-friendly representation
|
|
145
|
+
*/
|
|
146
|
+
toJSON(): any;
|
|
147
|
+
}
|
|
148
|
+
|
|
149
|
+
/**
|
|
150
|
+
* Options to pass to create
|
|
151
|
+
*
|
|
152
|
+
* @property additionalInformation - Additional information to be provided for verification
|
|
153
|
+
* @property businessCity - The city of the business or organization using the Tollfree number
|
|
154
|
+
* @property businessContactEmail - The email address of the contact for the business or organization using the Tollfree number
|
|
155
|
+
* @property businessContactFirstName - The first name of the contact for the business or organization using the Tollfree number
|
|
156
|
+
* @property businessContactLastName - The last name of the contact for the business or organization using the Tollfree number
|
|
157
|
+
* @property businessContactPhone - The phone number of the contact for the business or organization using the Tollfree number
|
|
158
|
+
* @property businessCountry - The country of the business or organization using the Tollfree number
|
|
159
|
+
* @property businessName - The name of the business or organization using the Tollfree number
|
|
160
|
+
* @property businessPostalCode - The postal code of the business or organization using the Tollfree number
|
|
161
|
+
* @property businessStateProvinceRegion - The state/province/region of the business or organization using the Tollfree number
|
|
162
|
+
* @property businessStreetAddress - The address of the business or organization using the Tollfree number
|
|
163
|
+
* @property businessStreetAddress2 - The address of the business or organization using the Tollfree number
|
|
164
|
+
* @property businessWebsite - The website of the business or organization using the Tollfree number
|
|
165
|
+
* @property customerProfileSid - Customer's Profile Bundle BundleSid
|
|
166
|
+
* @property messageVolume - Estimate monthly volume of messages from the Tollfree Number
|
|
167
|
+
* @property notificationEmail - The email address to receive the notification about the verification result.
|
|
168
|
+
* @property optInImageUrls - Link to an image that shows the opt-in workflow. Multiple images allowed and must be a publicly hosted URL
|
|
169
|
+
* @property optInType - Describe how a user opts-in to text messages
|
|
170
|
+
* @property productionMessageSample - An example of message content, i.e. a sample message
|
|
171
|
+
* @property tollfreePhoneNumberSid - The SID of the Phone Number associated with the Tollfree Verification
|
|
172
|
+
* @property useCaseCategories - The category of the use case for the Tollfree Number. List as many are applicable.
|
|
173
|
+
* @property useCaseSummary - Further explaination on how messaging is used by the business or organization
|
|
174
|
+
*/
|
|
175
|
+
interface TollfreeVerificationListInstanceCreateOptions {
|
|
176
|
+
additionalInformation?: string;
|
|
177
|
+
businessCity?: string;
|
|
178
|
+
businessContactEmail?: string;
|
|
179
|
+
businessContactFirstName?: string;
|
|
180
|
+
businessContactLastName?: string;
|
|
181
|
+
businessContactPhone?: string;
|
|
182
|
+
businessCountry?: string;
|
|
183
|
+
businessName: string;
|
|
184
|
+
businessPostalCode?: string;
|
|
185
|
+
businessStateProvinceRegion?: string;
|
|
186
|
+
businessStreetAddress?: string;
|
|
187
|
+
businessStreetAddress2?: string;
|
|
188
|
+
businessWebsite: string;
|
|
189
|
+
customerProfileSid?: string;
|
|
190
|
+
messageVolume: string;
|
|
191
|
+
notificationEmail: string;
|
|
192
|
+
optInImageUrls: string | string[];
|
|
193
|
+
optInType: TollfreeVerificationOptInType;
|
|
194
|
+
productionMessageSample: string;
|
|
195
|
+
tollfreePhoneNumberSid: string;
|
|
196
|
+
useCaseCategories: string | string[];
|
|
197
|
+
useCaseSummary: string;
|
|
198
|
+
}
|
|
199
|
+
|
|
200
|
+
/**
|
|
201
|
+
* Options to pass to each
|
|
202
|
+
*
|
|
203
|
+
* @property callback -
|
|
204
|
+
* Function to process each record. If this and a positional
|
|
205
|
+
* callback are passed, this one will be used
|
|
206
|
+
* @property done - Function to be called upon completion of streaming
|
|
207
|
+
* @property limit -
|
|
208
|
+
* Upper limit for the number of records to return.
|
|
209
|
+
* each() guarantees never to return more than limit.
|
|
210
|
+
* Default is no limit
|
|
211
|
+
* @property pageSize -
|
|
212
|
+
* Number of records to fetch per request,
|
|
213
|
+
* when not set will use the default value of 50 records.
|
|
214
|
+
* If no pageSize is defined but a limit is defined,
|
|
215
|
+
* each() will attempt to read the limit with the most efficient
|
|
216
|
+
* page size, i.e. min(limit, 1000)
|
|
217
|
+
* @property status - The compliance status of the Tollfree Verification record.
|
|
218
|
+
* @property tollfreePhoneNumberSid - The SID of the Phone Number associated with the Tollfree Verification
|
|
219
|
+
*/
|
|
220
|
+
interface TollfreeVerificationListInstanceEachOptions {
|
|
221
|
+
callback?: (item: TollfreeVerificationInstance, done: (err?: Error) => void) => void;
|
|
222
|
+
done?: Function;
|
|
223
|
+
limit?: number;
|
|
224
|
+
pageSize?: number;
|
|
225
|
+
status?: TollfreeVerificationStatus;
|
|
226
|
+
tollfreePhoneNumberSid?: string;
|
|
227
|
+
}
|
|
228
|
+
|
|
229
|
+
/**
|
|
230
|
+
* Options to pass to list
|
|
231
|
+
*
|
|
232
|
+
* @property limit -
|
|
233
|
+
* Upper limit for the number of records to return.
|
|
234
|
+
* list() guarantees never to return more than limit.
|
|
235
|
+
* Default is no limit
|
|
236
|
+
* @property pageSize -
|
|
237
|
+
* Number of records to fetch per request,
|
|
238
|
+
* when not set will use the default value of 50 records.
|
|
239
|
+
* If no page_size is defined but a limit is defined,
|
|
240
|
+
* list() will attempt to read the limit with the most
|
|
241
|
+
* efficient page size, i.e. min(limit, 1000)
|
|
242
|
+
* @property status - The compliance status of the Tollfree Verification record.
|
|
243
|
+
* @property tollfreePhoneNumberSid - The SID of the Phone Number associated with the Tollfree Verification
|
|
244
|
+
*/
|
|
245
|
+
interface TollfreeVerificationListInstanceOptions {
|
|
246
|
+
limit?: number;
|
|
247
|
+
pageSize?: number;
|
|
248
|
+
status?: TollfreeVerificationStatus;
|
|
249
|
+
tollfreePhoneNumberSid?: string;
|
|
250
|
+
}
|
|
251
|
+
|
|
252
|
+
/**
|
|
253
|
+
* Options to pass to page
|
|
254
|
+
*
|
|
255
|
+
* @property pageNumber - Page Number, this value is simply for client state
|
|
256
|
+
* @property pageSize - Number of records to return, defaults to 50
|
|
257
|
+
* @property pageToken - PageToken provided by the API
|
|
258
|
+
* @property status - The compliance status of the Tollfree Verification record.
|
|
259
|
+
* @property tollfreePhoneNumberSid - The SID of the Phone Number associated with the Tollfree Verification
|
|
260
|
+
*/
|
|
261
|
+
interface TollfreeVerificationListInstancePageOptions {
|
|
262
|
+
pageNumber?: number;
|
|
263
|
+
pageSize?: number;
|
|
264
|
+
pageToken?: string;
|
|
265
|
+
status?: TollfreeVerificationStatus;
|
|
266
|
+
tollfreePhoneNumberSid?: string;
|
|
267
|
+
}
|
|
268
|
+
|
|
269
|
+
interface TollfreeVerificationPayload extends TollfreeVerificationResource, Page.TwilioResponsePayload {
|
|
270
|
+
}
|
|
271
|
+
|
|
272
|
+
interface TollfreeVerificationResource {
|
|
273
|
+
account_sid: string;
|
|
274
|
+
additional_information: string;
|
|
275
|
+
business_city: string;
|
|
276
|
+
business_contact_email: string;
|
|
277
|
+
business_contact_first_name: string;
|
|
278
|
+
business_contact_last_name: string;
|
|
279
|
+
business_contact_phone: string;
|
|
280
|
+
business_country: string;
|
|
281
|
+
business_name: string;
|
|
282
|
+
business_postal_code: string;
|
|
283
|
+
business_state_province_region: string;
|
|
284
|
+
business_street_address: string;
|
|
285
|
+
business_street_address2: string;
|
|
286
|
+
business_website: string;
|
|
287
|
+
customer_profile_sid: string;
|
|
288
|
+
date_created: Date;
|
|
289
|
+
date_updated: Date;
|
|
290
|
+
message_volume: string;
|
|
291
|
+
notification_email: string;
|
|
292
|
+
opt_in_image_urls: string[];
|
|
293
|
+
opt_in_type: TollfreeVerificationOptInType;
|
|
294
|
+
production_message_sample: string;
|
|
295
|
+
regulated_item_sid: string;
|
|
296
|
+
resource_links: object;
|
|
297
|
+
sid: string;
|
|
298
|
+
status: TollfreeVerificationStatus;
|
|
299
|
+
tollfree_phone_number_sid: string;
|
|
300
|
+
trust_product_sid: string;
|
|
301
|
+
url: string;
|
|
302
|
+
use_case_categories: string[];
|
|
303
|
+
use_case_summary: string;
|
|
304
|
+
}
|
|
305
|
+
|
|
306
|
+
interface TollfreeVerificationSolution {
|
|
307
|
+
}
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
declare class TollfreeVerificationContext {
|
|
311
|
+
/**
|
|
312
|
+
* Initialize the TollfreeVerificationContext
|
|
313
|
+
*
|
|
314
|
+
* PLEASE NOTE that this class contains beta products that are subject to change.
|
|
315
|
+
* Use them with caution.
|
|
316
|
+
*
|
|
317
|
+
* @param version - Version of the resource
|
|
318
|
+
* @param sid - Tollfree Verification Sid
|
|
319
|
+
*/
|
|
320
|
+
constructor(version: V1, sid: string);
|
|
321
|
+
|
|
322
|
+
/**
|
|
323
|
+
* fetch a TollfreeVerificationInstance
|
|
324
|
+
*
|
|
325
|
+
* @param callback - Callback to handle processed record
|
|
326
|
+
*/
|
|
327
|
+
fetch(callback?: (error: Error | null, items: TollfreeVerificationInstance) => any): Promise<TollfreeVerificationInstance>;
|
|
328
|
+
/**
|
|
329
|
+
* Provide a user-friendly representation
|
|
330
|
+
*/
|
|
331
|
+
toJSON(): any;
|
|
332
|
+
}
|
|
333
|
+
|
|
334
|
+
|
|
335
|
+
declare class TollfreeVerificationInstance extends SerializableClass {
|
|
336
|
+
/**
|
|
337
|
+
* Initialize the TollfreeVerificationContext
|
|
338
|
+
*
|
|
339
|
+
* PLEASE NOTE that this class contains beta products that are subject to change.
|
|
340
|
+
* Use them with caution.
|
|
341
|
+
*
|
|
342
|
+
* @param version - Version of the resource
|
|
343
|
+
* @param payload - The instance payload
|
|
344
|
+
* @param sid - Tollfree Verification Sid
|
|
345
|
+
*/
|
|
346
|
+
constructor(version: V1, payload: TollfreeVerificationPayload, sid: string);
|
|
347
|
+
|
|
348
|
+
private _proxy: TollfreeVerificationContext;
|
|
349
|
+
accountSid: string;
|
|
350
|
+
additionalInformation: string;
|
|
351
|
+
businessCity: string;
|
|
352
|
+
businessContactEmail: string;
|
|
353
|
+
businessContactFirstName: string;
|
|
354
|
+
businessContactLastName: string;
|
|
355
|
+
businessContactPhone: string;
|
|
356
|
+
businessCountry: string;
|
|
357
|
+
businessName: string;
|
|
358
|
+
businessPostalCode: string;
|
|
359
|
+
businessStateProvinceRegion: string;
|
|
360
|
+
businessStreetAddress: string;
|
|
361
|
+
businessStreetAddress2: string;
|
|
362
|
+
businessWebsite: string;
|
|
363
|
+
customerProfileSid: string;
|
|
364
|
+
dateCreated: Date;
|
|
365
|
+
dateUpdated: Date;
|
|
366
|
+
/**
|
|
367
|
+
* fetch a TollfreeVerificationInstance
|
|
368
|
+
*
|
|
369
|
+
* @param callback - Callback to handle processed record
|
|
370
|
+
*/
|
|
371
|
+
fetch(callback?: (error: Error | null, items: TollfreeVerificationInstance) => any): Promise<TollfreeVerificationInstance>;
|
|
372
|
+
messageVolume: string;
|
|
373
|
+
notificationEmail: string;
|
|
374
|
+
optInImageUrls: string[];
|
|
375
|
+
optInType: TollfreeVerificationOptInType;
|
|
376
|
+
productionMessageSample: string;
|
|
377
|
+
regulatedItemSid: string;
|
|
378
|
+
resourceLinks: any;
|
|
379
|
+
sid: string;
|
|
380
|
+
status: TollfreeVerificationStatus;
|
|
381
|
+
/**
|
|
382
|
+
* Provide a user-friendly representation
|
|
383
|
+
*/
|
|
384
|
+
toJSON(): any;
|
|
385
|
+
tollfreePhoneNumberSid: string;
|
|
386
|
+
trustProductSid: string;
|
|
387
|
+
url: string;
|
|
388
|
+
useCaseCategories: string[];
|
|
389
|
+
useCaseSummary: string;
|
|
390
|
+
}
|
|
391
|
+
|
|
392
|
+
|
|
393
|
+
declare class TollfreeVerificationPage extends Page<V1, TollfreeVerificationPayload, TollfreeVerificationResource, TollfreeVerificationInstance> {
|
|
394
|
+
/**
|
|
395
|
+
* Initialize the TollfreeVerificationPage
|
|
396
|
+
*
|
|
397
|
+
* PLEASE NOTE that this class contains beta products that are subject to change.
|
|
398
|
+
* Use them with caution.
|
|
399
|
+
*
|
|
400
|
+
* @param version - Version of the resource
|
|
401
|
+
* @param response - Response from the API
|
|
402
|
+
* @param solution - Path solution
|
|
403
|
+
*/
|
|
404
|
+
constructor(version: V1, response: Response<string>, solution: TollfreeVerificationSolution);
|
|
405
|
+
|
|
406
|
+
/**
|
|
407
|
+
* Build an instance of TollfreeVerificationInstance
|
|
408
|
+
*
|
|
409
|
+
* @param payload - Payload response from the API
|
|
410
|
+
*/
|
|
411
|
+
getInstance(payload: TollfreeVerificationPayload): TollfreeVerificationInstance;
|
|
412
|
+
/**
|
|
413
|
+
* Provide a user-friendly representation
|
|
414
|
+
*/
|
|
415
|
+
toJSON(): any;
|
|
416
|
+
}
|
|
417
|
+
|
|
418
|
+
export { TollfreeVerificationContext, TollfreeVerificationInstance, TollfreeVerificationList, TollfreeVerificationListInstance, TollfreeVerificationListInstanceCreateOptions, TollfreeVerificationListInstanceEachOptions, TollfreeVerificationListInstanceOptions, TollfreeVerificationListInstancePageOptions, TollfreeVerificationOptInType, TollfreeVerificationPage, TollfreeVerificationPayload, TollfreeVerificationResource, TollfreeVerificationSolution, TollfreeVerificationStatus }
|