twilio 3.23.0 → 3.25.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/CHANGES.md +55 -0
- package/lib/rest/Api.d.ts +2 -0
- package/lib/rest/Api.js +9 -0
- package/lib/rest/Authy.js +5 -5
- package/lib/rest/Preview.d.ts +0 -2
- package/lib/rest/Preview.js +12 -23
- package/lib/rest/Twilio.d.ts +1 -0
- package/lib/rest/Twilio.js +9 -0
- package/lib/rest/Video.js +8 -8
- package/lib/rest/api/V2010.d.ts +3 -0
- package/lib/rest/api/V2010.js +9 -0
- package/lib/rest/api/v2010/account/balance.d.ts +87 -0
- package/lib/rest/api/v2010/account/balance.js +162 -0
- package/lib/rest/api/v2010/account/message.d.ts +2 -0
- package/lib/rest/api/v2010/account/message.js +4 -1
- package/lib/rest/api/v2010/account/sip/ipAccessControlList.d.ts +3 -3
- package/lib/rest/api/v2010/account/sip/ipAccessControlList.js +3 -3
- package/lib/rest/api/v2010/account/usage/record/allTime.d.ts +1 -1
- package/lib/rest/api/v2010/account/usage/record/daily.d.ts +1 -1
- package/lib/rest/api/v2010/account/usage/record/lastMonth.d.ts +1 -1
- package/lib/rest/api/v2010/account/usage/record/monthly.d.ts +1 -1
- package/lib/rest/api/v2010/account/usage/record/thisMonth.d.ts +1 -1
- package/lib/rest/api/v2010/account/usage/record/today.d.ts +1 -1
- package/lib/rest/api/v2010/account/usage/record/yearly.d.ts +1 -1
- package/lib/rest/api/v2010/account/usage/record/yesterday.d.ts +1 -1
- package/lib/rest/api/v2010/account/usage/record.d.ts +1 -1
- package/lib/rest/api/v2010/account/usage/trigger.d.ts +1 -1
- package/lib/rest/api/v2010/account.d.ts +8 -0
- package/lib/rest/api/v2010/account.js +25 -0
- package/lib/rest/authy/V1.d.ts +1 -1
- package/lib/rest/authy/V1.js +8 -8
- package/lib/rest/authy/v1/form.d.ts +13 -13
- package/lib/rest/authy/v1/form.js +17 -17
- package/lib/rest/authy/v1/service/entity/factor/challenge.d.ts +12 -13
- package/lib/rest/authy/v1/service/entity/factor/challenge.js +4 -6
- package/lib/rest/authy/v1/service/entity/factor.d.ts +9 -9
- package/lib/rest/authy/v1/service/entity/factor.js +7 -9
- package/lib/rest/autopilot/v1/assistant/fieldType/fieldValue.d.ts +5 -5
- package/lib/rest/autopilot/v1/assistant/fieldType/fieldValue.js +9 -5
- package/lib/rest/autopilot/v1/assistant/fieldType.d.ts +5 -5
- package/lib/rest/autopilot/v1/assistant/fieldType.js +8 -5
- package/lib/rest/autopilot/v1/assistant/modelBuild.d.ts +5 -5
- package/lib/rest/autopilot/v1/assistant/modelBuild.js +8 -5
- package/lib/rest/autopilot/v1/assistant/query.d.ts +17 -17
- package/lib/rest/autopilot/v1/assistant/query.js +24 -18
- package/lib/rest/autopilot/v1/assistant/task/field.d.ts +11 -11
- package/lib/rest/autopilot/v1/assistant/task/field.js +15 -11
- package/lib/rest/autopilot/v1/assistant/task/sample.d.ts +18 -18
- package/lib/rest/autopilot/v1/assistant/task/sample.js +23 -21
- package/lib/rest/autopilot/v1/assistant/task/taskActions.d.ts +2 -2
- package/lib/rest/autopilot/v1/assistant/task/taskActions.js +4 -3
- package/lib/rest/autopilot/v1/assistant/task/taskStatistics.d.ts +6 -6
- package/lib/rest/autopilot/v1/assistant/task/taskStatistics.js +7 -6
- package/lib/rest/autopilot/v1/assistant/task.d.ts +10 -10
- package/lib/rest/autopilot/v1/assistant/task.js +21 -12
- package/lib/rest/autopilot/v1/assistant.d.ts +15 -15
- package/lib/rest/autopilot/v1/assistant.js +25 -20
- package/lib/rest/chat/v2/service/channel/member.d.ts +7 -0
- package/lib/rest/chat/v2/service/channel/member.js +13 -2
- package/lib/rest/ipMessaging/v2/service/channel/member.d.ts +7 -0
- package/lib/rest/ipMessaging/v2/service/channel/member.js +13 -2
- package/lib/rest/preview/Marketplace.d.ts +1 -1
- package/lib/rest/preview/Marketplace.js +9 -9
- package/lib/rest/proxy/v1/service.d.ts +7 -0
- package/lib/rest/proxy/v1/service.js +13 -2
- package/lib/rest/sync/v1/service/syncList/syncListItem.d.ts +10 -2
- package/lib/rest/sync/v1/service/syncList/syncListItem.js +24 -5
- package/lib/rest/sync/v1/service/syncList.d.ts +6 -2
- package/lib/rest/sync/v1/service/syncList.js +12 -5
- package/lib/rest/sync/v1/service/syncMap/syncMapItem.d.ts +10 -2
- package/lib/rest/sync/v1/service/syncMap/syncMapItem.js +24 -6
- package/lib/rest/sync/v1/service/syncMap.d.ts +6 -2
- package/lib/rest/sync/v1/service/syncMap.js +12 -5
- package/lib/rest/verify/v1/service/verification.d.ts +4 -0
- package/lib/rest/verify/v1/service/verification.js +5 -1
- package/lib/rest/video/V1.d.ts +1 -1
- package/lib/rest/video/V1.js +10 -10
- package/lib/twiml/VoiceResponse.d.ts +124 -0
- package/lib/twiml/VoiceResponse.js +960 -0
- package/package.json +1 -1
- package/lib/rest/preview/Authy.d.ts +0 -27
- package/lib/rest/preview/Authy.js +0 -44
- package/lib/rest/preview/authy/service/entity.d.ts +0 -250
- package/lib/rest/preview/authy/service/entity.js +0 -514
- package/lib/rest/preview/authy/service.d.ts +0 -275
- package/lib/rest/preview/authy/service.js +0 -578
|
@@ -59,7 +59,7 @@ interface ModelBuildListInstance {
|
|
|
59
59
|
/**
|
|
60
60
|
* Constructs a model_build
|
|
61
61
|
*
|
|
62
|
-
* @param sid -
|
|
62
|
+
* @param sid - A 34-character string that uniquely identifies this resource.
|
|
63
63
|
*/
|
|
64
64
|
get(sid: string): ModelBuildContext;
|
|
65
65
|
/**
|
|
@@ -187,8 +187,8 @@ declare class ModelBuildContext {
|
|
|
187
187
|
* Initialize the ModelBuildContextPLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
|
|
188
188
|
*
|
|
189
189
|
* @param version - Version of the resource
|
|
190
|
-
* @param assistantSid - The
|
|
191
|
-
* @param sid -
|
|
190
|
+
* @param assistantSid - The unique ID of the parent Assistant.
|
|
191
|
+
* @param sid - A 34-character string that uniquely identifies this resource.
|
|
192
192
|
*/
|
|
193
193
|
constructor(version: V1, assistantSid: string, sid: string);
|
|
194
194
|
|
|
@@ -222,7 +222,7 @@ declare class ModelBuildInstance extends SerializableClass {
|
|
|
222
222
|
* @property dateCreated - The date that this resource was created
|
|
223
223
|
* @property dateUpdated - The date that this resource was last updated
|
|
224
224
|
* @property assistantSid - The unique ID of the parent Assistant.
|
|
225
|
-
* @property sid - A 34
|
|
225
|
+
* @property sid - A 34-character string that uniquely identifies this resource.
|
|
226
226
|
* @property status - A string that described the model build status. The values can be: `enqueued`, `building`, `completed`, `failed`
|
|
227
227
|
* @property uniqueName - A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.
|
|
228
228
|
* @property url - The url
|
|
@@ -232,7 +232,7 @@ declare class ModelBuildInstance extends SerializableClass {
|
|
|
232
232
|
* @param version - Version of the resource
|
|
233
233
|
* @param payload - The instance payload
|
|
234
234
|
* @param assistantSid - The unique ID of the parent Assistant.
|
|
235
|
-
* @param sid -
|
|
235
|
+
* @param sid - A 34-character string that uniquely identifies this resource.
|
|
236
236
|
*/
|
|
237
237
|
constructor(version: V1, payload: ModelBuildPayload, assistantSid: string, sid: string);
|
|
238
238
|
|
|
@@ -325,7 +325,8 @@ ModelBuildList = function ModelBuildList(version, assistantSid) {
|
|
|
325
325
|
/**
|
|
326
326
|
* Constructs a model_build
|
|
327
327
|
*
|
|
328
|
-
* @param {string} sid -
|
|
328
|
+
* @param {string} sid -
|
|
329
|
+
* A 34-character string that uniquely identifies this resource.
|
|
329
330
|
*
|
|
330
331
|
* @returns {Twilio.Autopilot.V1.AssistantContext.ModelBuildContext}
|
|
331
332
|
*/
|
|
@@ -383,7 +384,7 @@ ModelBuildPage.prototype.getInstance = function getInstance(payload) {
|
|
|
383
384
|
* @property {Date} dateUpdated - The date that this resource was last updated
|
|
384
385
|
* @property {string} assistantSid - The unique ID of the parent Assistant.
|
|
385
386
|
* @property {string} sid -
|
|
386
|
-
* A 34
|
|
387
|
+
* A 34-character string that uniquely identifies this resource.
|
|
387
388
|
* @property {model_build.status} status -
|
|
388
389
|
* A string that described the model build status. The values can be: `enqueued`, `building`, `completed`, `failed`
|
|
389
390
|
* @property {string} uniqueName -
|
|
@@ -396,7 +397,8 @@ ModelBuildPage.prototype.getInstance = function getInstance(payload) {
|
|
|
396
397
|
* @param {V1} version - Version of the resource
|
|
397
398
|
* @param {ModelBuildPayload} payload - The instance payload
|
|
398
399
|
* @param {sid} assistantSid - The unique ID of the parent Assistant.
|
|
399
|
-
* @param {sid_like} sid -
|
|
400
|
+
* @param {sid_like} sid -
|
|
401
|
+
* A 34-character string that uniquely identifies this resource.
|
|
400
402
|
*/
|
|
401
403
|
/* jshint ignore:end */
|
|
402
404
|
ModelBuildInstance = function ModelBuildInstance(version, payload, assistantSid,
|
|
@@ -501,8 +503,9 @@ ModelBuildInstance.prototype.toJSON = function toJSON() {
|
|
|
501
503
|
* Initialize the ModelBuildContextPLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
|
|
502
504
|
*
|
|
503
505
|
* @param {V1} version - Version of the resource
|
|
504
|
-
* @param {sid_like} assistantSid - The
|
|
505
|
-
* @param {sid_like} sid -
|
|
506
|
+
* @param {sid_like} assistantSid - The unique ID of the parent Assistant.
|
|
507
|
+
* @param {sid_like} sid -
|
|
508
|
+
* A 34-character string that uniquely identifies this resource.
|
|
506
509
|
*/
|
|
507
510
|
/* jshint ignore:end */
|
|
508
511
|
ModelBuildContext = function ModelBuildContext(version, assistantSid, sid) {
|
|
@@ -22,7 +22,7 @@ declare function QueryList(version: V1, assistantSid: string): QueryListInstance
|
|
|
22
22
|
/**
|
|
23
23
|
* Options to pass to update
|
|
24
24
|
*
|
|
25
|
-
* @property sampleSid -
|
|
25
|
+
* @property sampleSid - An optional reference to the Sample created from this query.
|
|
26
26
|
* @property status - A string that described the query status. The values can be: `pending_review`, `reviewed`, `discarded`
|
|
27
27
|
*/
|
|
28
28
|
interface QueryInstanceUpdateOptions {
|
|
@@ -59,7 +59,7 @@ interface QueryListInstance {
|
|
|
59
59
|
/**
|
|
60
60
|
* Constructs a query
|
|
61
61
|
*
|
|
62
|
-
* @param sid -
|
|
62
|
+
* @param sid - A 34-character string that uniquely identifies this resource.
|
|
63
63
|
*/
|
|
64
64
|
get(sid: string): QueryContext;
|
|
65
65
|
/**
|
|
@@ -96,8 +96,8 @@ interface QueryListInstance {
|
|
|
96
96
|
/**
|
|
97
97
|
* Options to pass to create
|
|
98
98
|
*
|
|
99
|
-
* @property language - An ISO language-country string that specifies the language used for this query. For example: en-US
|
|
100
|
-
* @property modelBuild - The
|
|
99
|
+
* @property language - An [ISO language-country string](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) that specifies the language used for this query. For example: `en-US`.
|
|
100
|
+
* @property modelBuild - The Sid or unique name of the [Model Build](https://www.twilio.com/docs/autopilot/api/model-build) to be queried.
|
|
101
101
|
* @property query - A user-provided string that uniquely identifies this resource as an alternative to the sid. It can be up to 2048 characters long.
|
|
102
102
|
* @property tasks - Constraints the query to a set of tasks. Useful when you need to constrain the paths the user can take. Tasks should be comma separated task-unique-name-1, task-unique-name-2
|
|
103
103
|
*/
|
|
@@ -115,12 +115,12 @@ interface QueryListInstanceCreateOptions {
|
|
|
115
115
|
* Function to process each record. If this and a positional
|
|
116
116
|
* callback are passed, this one will be used
|
|
117
117
|
* @property done - Function to be called upon completion of streaming
|
|
118
|
-
* @property language - An ISO language-country string that specifies the language used for this query. For example: en-US
|
|
118
|
+
* @property language - An [ISO language-country string](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) that specifies the language used for this query. For example: `en-US`.
|
|
119
119
|
* @property limit -
|
|
120
120
|
* Upper limit for the number of records to return.
|
|
121
121
|
* each() guarantees never to return more than limit.
|
|
122
122
|
* Default is no limit
|
|
123
|
-
* @property modelBuild - The
|
|
123
|
+
* @property modelBuild - The Sid or unique name of the [Model Build](https://www.twilio.com/docs/autopilot/api/model-build) to be queried.
|
|
124
124
|
* @property pageSize -
|
|
125
125
|
* Number of records to fetch per request,
|
|
126
126
|
* when not set will use the default value of 50 records.
|
|
@@ -142,12 +142,12 @@ interface QueryListInstanceEachOptions {
|
|
|
142
142
|
/**
|
|
143
143
|
* Options to pass to list
|
|
144
144
|
*
|
|
145
|
-
* @property language - An ISO language-country string that specifies the language used for this query. For example: en-US
|
|
145
|
+
* @property language - An [ISO language-country string](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) that specifies the language used for this query. For example: `en-US`.
|
|
146
146
|
* @property limit -
|
|
147
147
|
* Upper limit for the number of records to return.
|
|
148
148
|
* list() guarantees never to return more than limit.
|
|
149
149
|
* Default is no limit
|
|
150
|
-
* @property modelBuild - The
|
|
150
|
+
* @property modelBuild - The Sid or unique name of the [Model Build](https://www.twilio.com/docs/autopilot/api/model-build) to be queried.
|
|
151
151
|
* @property pageSize -
|
|
152
152
|
* Number of records to fetch per request,
|
|
153
153
|
* when not set will use the default value of 50 records.
|
|
@@ -167,8 +167,8 @@ interface QueryListInstanceOptions {
|
|
|
167
167
|
/**
|
|
168
168
|
* Options to pass to page
|
|
169
169
|
*
|
|
170
|
-
* @property language - An ISO language-country string that specifies the language used for this query. For example: en-US
|
|
171
|
-
* @property modelBuild - The
|
|
170
|
+
* @property language - An [ISO language-country string](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) that specifies the language used for this query. For example: `en-US`.
|
|
171
|
+
* @property modelBuild - The Sid or unique name of the [Model Build](https://www.twilio.com/docs/autopilot/api/model-build) to be queried.
|
|
172
172
|
* @property pageNumber - Page Number, this value is simply for client state
|
|
173
173
|
* @property pageSize - Number of records to return, defaults to 50
|
|
174
174
|
* @property pageToken - PageToken provided by the API
|
|
@@ -212,8 +212,8 @@ declare class QueryContext {
|
|
|
212
212
|
* Initialize the QueryContextPLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
|
|
213
213
|
*
|
|
214
214
|
* @param version - Version of the resource
|
|
215
|
-
* @param assistantSid - The
|
|
216
|
-
* @param sid -
|
|
215
|
+
* @param assistantSid - The unique ID of the Assistant.
|
|
216
|
+
* @param sid - A 34-character string that uniquely identifies this resource.
|
|
217
217
|
*/
|
|
218
218
|
constructor(version: V1, assistantSid: string, sid: string);
|
|
219
219
|
|
|
@@ -246,13 +246,13 @@ declare class QueryInstance extends SerializableClass {
|
|
|
246
246
|
* @property accountSid - The unique ID of the Account that created this Query.
|
|
247
247
|
* @property dateCreated - The date that this resource was created
|
|
248
248
|
* @property dateUpdated - The date that this resource was last updated
|
|
249
|
-
* @property results - The natural language analysis results which include the Task recognized, the confidence score and a list of identified Fields.
|
|
250
|
-
* @property language - An ISO language-country string that specifies the language used for this query. For example: en-US
|
|
251
|
-
* @property modelBuildSid - The unique ID of the Model Build queried.
|
|
249
|
+
* @property results - The natural language analysis results which include the [Task](https://www.twilio.com/docs/autopilot/api/task) recognized, the confidence score, and a list of identified [Fields](https://www.twilio.com/docs/autopilot/api/task-field).
|
|
250
|
+
* @property language - An [ISO language-country string](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) that specifies the language used for this query. For example: `en-US`
|
|
251
|
+
* @property modelBuildSid - The unique ID of the [Model Build](https://www.twilio.com/docs/autopilot/api/model-build) queried.
|
|
252
252
|
* @property query - The end-user's natural language input.
|
|
253
253
|
* @property sampleSid - An optional reference to the Sample created from this query.
|
|
254
254
|
* @property assistantSid - The unique ID of the parent Assistant.
|
|
255
|
-
* @property sid - A 34
|
|
255
|
+
* @property sid - A 34-character string that uniquely identifies this resource.
|
|
256
256
|
* @property status - A string that describes the query status. The values can be: `pending_review`, `reviewed`, `discarded`
|
|
257
257
|
* @property url - The url
|
|
258
258
|
* @property sourceChannel - The communication channel where this end-user input came from
|
|
@@ -260,7 +260,7 @@ declare class QueryInstance extends SerializableClass {
|
|
|
260
260
|
* @param version - Version of the resource
|
|
261
261
|
* @param payload - The instance payload
|
|
262
262
|
* @param assistantSid - The unique ID of the parent Assistant.
|
|
263
|
-
* @param sid -
|
|
263
|
+
* @param sid - A 34-character string that uniquely identifies this resource.
|
|
264
264
|
*/
|
|
265
265
|
constructor(version: V1, payload: QueryPayload, assistantSid: string, sid: string);
|
|
266
266
|
|
|
@@ -61,9 +61,9 @@ QueryList = function QueryList(version, assistantSid) {
|
|
|
61
61
|
*
|
|
62
62
|
* @param {object} [opts] - Options for request
|
|
63
63
|
* @param {string} [opts.language] -
|
|
64
|
-
* An ISO language-country string that specifies the language used for this query. For example: en-US
|
|
64
|
+
* An [ISO language-country string](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) that specifies the language used for this query. For example: `en-US`.
|
|
65
65
|
* @param {string} [opts.modelBuild] -
|
|
66
|
-
* The
|
|
66
|
+
* The Sid or unique name of the [Model Build](https://www.twilio.com/docs/autopilot/api/model-build) to be queried.
|
|
67
67
|
* @param {string} [opts.status] -
|
|
68
68
|
* A string that described the query status. The values can be: `pending_review`, `reviewed`, `discarded`
|
|
69
69
|
* @param {number} [opts.limit] -
|
|
@@ -152,9 +152,9 @@ QueryList = function QueryList(version, assistantSid) {
|
|
|
152
152
|
*
|
|
153
153
|
* @param {object} [opts] - Options for request
|
|
154
154
|
* @param {string} [opts.language] -
|
|
155
|
-
* An ISO language-country string that specifies the language used for this query. For example: en-US
|
|
155
|
+
* An [ISO language-country string](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) that specifies the language used for this query. For example: `en-US`.
|
|
156
156
|
* @param {string} [opts.modelBuild] -
|
|
157
|
-
* The
|
|
157
|
+
* The Sid or unique name of the [Model Build](https://www.twilio.com/docs/autopilot/api/model-build) to be queried.
|
|
158
158
|
* @param {string} [opts.status] -
|
|
159
159
|
* A string that described the query status. The values can be: `pending_review`, `reviewed`, `discarded`
|
|
160
160
|
* @param {number} [opts.limit] -
|
|
@@ -213,9 +213,9 @@ QueryList = function QueryList(version, assistantSid) {
|
|
|
213
213
|
*
|
|
214
214
|
* @param {object} [opts] - Options for request
|
|
215
215
|
* @param {string} [opts.language] -
|
|
216
|
-
* An ISO language-country string that specifies the language used for this query. For example: en-US
|
|
216
|
+
* An [ISO language-country string](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) that specifies the language used for this query. For example: `en-US`.
|
|
217
217
|
* @param {string} [opts.modelBuild] -
|
|
218
|
-
* The
|
|
218
|
+
* The Sid or unique name of the [Model Build](https://www.twilio.com/docs/autopilot/api/model-build) to be queried.
|
|
219
219
|
* @param {string} [opts.status] -
|
|
220
220
|
* A string that described the query status. The values can be: `pending_review`, `reviewed`, `discarded`
|
|
221
221
|
* @param {string} [opts.pageToken] - PageToken provided by the API
|
|
@@ -300,13 +300,13 @@ QueryList = function QueryList(version, assistantSid) {
|
|
|
300
300
|
*
|
|
301
301
|
* @param {object} opts - Options for request
|
|
302
302
|
* @param {string} opts.language -
|
|
303
|
-
* An ISO language-country string that specifies the language used for this query. For example: en-US
|
|
303
|
+
* An [ISO language-country string](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) that specifies the language used for this query. For example: `en-US`.
|
|
304
304
|
* @param {string} opts.query -
|
|
305
305
|
* A user-provided string that uniquely identifies this resource as an alternative to the sid. It can be up to 2048 characters long.
|
|
306
306
|
* @param {string} [opts.tasks] -
|
|
307
307
|
* Constraints the query to a set of tasks. Useful when you need to constrain the paths the user can take. Tasks should be comma separated task-unique-name-1, task-unique-name-2
|
|
308
308
|
* @param {string} [opts.modelBuild] -
|
|
309
|
-
* The
|
|
309
|
+
* The Sid or unique name of the [Model Build](https://www.twilio.com/docs/autopilot/api/model-build) to be queried.
|
|
310
310
|
* @param {function} [callback] - Callback to handle processed record
|
|
311
311
|
*
|
|
312
312
|
* @returns {Promise} Resolves to processed QueryInstance
|
|
@@ -357,7 +357,8 @@ QueryList = function QueryList(version, assistantSid) {
|
|
|
357
357
|
/**
|
|
358
358
|
* Constructs a query
|
|
359
359
|
*
|
|
360
|
-
* @param {string} sid -
|
|
360
|
+
* @param {string} sid -
|
|
361
|
+
* A 34-character string that uniquely identifies this resource.
|
|
361
362
|
*
|
|
362
363
|
* @returns {Twilio.Autopilot.V1.AssistantContext.QueryContext}
|
|
363
364
|
*/
|
|
@@ -414,16 +415,17 @@ QueryPage.prototype.getInstance = function getInstance(payload) {
|
|
|
414
415
|
* @property {Date} dateCreated - The date that this resource was created
|
|
415
416
|
* @property {Date} dateUpdated - The date that this resource was last updated
|
|
416
417
|
* @property {string} results -
|
|
417
|
-
* The natural language analysis results which include the Task recognized, the confidence score and a list of identified Fields.
|
|
418
|
+
* The natural language analysis results which include the [Task](https://www.twilio.com/docs/autopilot/api/task) recognized, the confidence score, and a list of identified [Fields](https://www.twilio.com/docs/autopilot/api/task-field).
|
|
418
419
|
* @property {string} language -
|
|
419
|
-
* An ISO language-country string that specifies the language used for this query. For example: en-US
|
|
420
|
-
* @property {string} modelBuildSid -
|
|
420
|
+
* An [ISO language-country string](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) that specifies the language used for this query. For example: `en-US`
|
|
421
|
+
* @property {string} modelBuildSid -
|
|
422
|
+
* The unique ID of the [Model Build](https://www.twilio.com/docs/autopilot/api/model-build) queried.
|
|
421
423
|
* @property {string} query - The end-user's natural language input.
|
|
422
424
|
* @property {string} sampleSid -
|
|
423
425
|
* An optional reference to the Sample created from this query.
|
|
424
426
|
* @property {string} assistantSid - The unique ID of the parent Assistant.
|
|
425
427
|
* @property {string} sid -
|
|
426
|
-
* A 34
|
|
428
|
+
* A 34-character string that uniquely identifies this resource.
|
|
427
429
|
* @property {string} status -
|
|
428
430
|
* A string that describes the query status. The values can be: `pending_review`, `reviewed`, `discarded`
|
|
429
431
|
* @property {string} url - The url
|
|
@@ -433,7 +435,8 @@ QueryPage.prototype.getInstance = function getInstance(payload) {
|
|
|
433
435
|
* @param {V1} version - Version of the resource
|
|
434
436
|
* @param {QueryPayload} payload - The instance payload
|
|
435
437
|
* @param {sid} assistantSid - The unique ID of the parent Assistant.
|
|
436
|
-
* @param {sid_like} sid -
|
|
438
|
+
* @param {sid_like} sid -
|
|
439
|
+
* A 34-character string that uniquely identifies this resource.
|
|
437
440
|
*/
|
|
438
441
|
/* jshint ignore:end */
|
|
439
442
|
QueryInstance = function QueryInstance(version, payload, assistantSid, sid) {
|
|
@@ -488,7 +491,8 @@ QueryInstance.prototype.fetch = function fetch(callback) {
|
|
|
488
491
|
* update a QueryInstance
|
|
489
492
|
*
|
|
490
493
|
* @param {object} [opts] - Options for request
|
|
491
|
-
* @param {string} [opts.sampleSid] -
|
|
494
|
+
* @param {string} [opts.sampleSid] -
|
|
495
|
+
* An optional reference to the Sample created from this query.
|
|
492
496
|
* @param {string} [opts.status] -
|
|
493
497
|
* A string that described the query status. The values can be: `pending_review`, `reviewed`, `discarded`
|
|
494
498
|
* @param {function} [callback] - Callback to handle processed record
|
|
@@ -537,8 +541,9 @@ QueryInstance.prototype.toJSON = function toJSON() {
|
|
|
537
541
|
* Initialize the QueryContextPLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
|
|
538
542
|
*
|
|
539
543
|
* @param {V1} version - Version of the resource
|
|
540
|
-
* @param {sid_like} assistantSid - The
|
|
541
|
-
* @param {sid_like} sid -
|
|
544
|
+
* @param {sid_like} assistantSid - The unique ID of the Assistant.
|
|
545
|
+
* @param {sid_like} sid -
|
|
546
|
+
* A 34-character string that uniquely identifies this resource.
|
|
542
547
|
*/
|
|
543
548
|
/* jshint ignore:end */
|
|
544
549
|
QueryContext = function QueryContext(version, assistantSid, sid) {
|
|
@@ -589,7 +594,8 @@ QueryContext.prototype.fetch = function fetch(callback) {
|
|
|
589
594
|
* update a QueryInstance
|
|
590
595
|
*
|
|
591
596
|
* @param {object} [opts] - Options for request
|
|
592
|
-
* @param {string} [opts.sampleSid] -
|
|
597
|
+
* @param {string} [opts.sampleSid] -
|
|
598
|
+
* An optional reference to the Sample created from this query.
|
|
593
599
|
* @param {string} [opts.status] -
|
|
594
600
|
* A string that described the query status. The values can be: `pending_review`, `reviewed`, `discarded`
|
|
595
601
|
* @param {function} [callback] - Callback to handle processed record
|
|
@@ -15,7 +15,7 @@ import { SerializableClass } from '../../../../../interfaces';
|
|
|
15
15
|
* PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
|
|
16
16
|
*
|
|
17
17
|
* @param version - Version of the resource
|
|
18
|
-
* @param assistantSid - The unique ID of the
|
|
18
|
+
* @param assistantSid - The unique ID of the Assistant.
|
|
19
19
|
* @param taskSid - The unique ID of the Task associated with this Field.
|
|
20
20
|
*/
|
|
21
21
|
declare function FieldList(version: V1, assistantSid: string, taskSid: string): FieldListInstance;
|
|
@@ -49,7 +49,7 @@ interface FieldListInstance {
|
|
|
49
49
|
/**
|
|
50
50
|
* Constructs a field
|
|
51
51
|
*
|
|
52
|
-
* @param sid -
|
|
52
|
+
* @param sid - A 34-character string that uniquely identifies this resource.
|
|
53
53
|
*/
|
|
54
54
|
get(sid: string): FieldContext;
|
|
55
55
|
/**
|
|
@@ -86,7 +86,7 @@ interface FieldListInstance {
|
|
|
86
86
|
/**
|
|
87
87
|
* Options to pass to create
|
|
88
88
|
*
|
|
89
|
-
* @property fieldType - The
|
|
89
|
+
* @property fieldType - The Field Type of this field. It can be either a Built-in Field Type or the unique_name or sid of a custom Field Type.
|
|
90
90
|
* @property uniqueName - A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.
|
|
91
91
|
*/
|
|
92
92
|
interface FieldListInstanceCreateOptions {
|
|
@@ -177,9 +177,9 @@ declare class FieldContext {
|
|
|
177
177
|
* Initialize the FieldContextPLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
|
|
178
178
|
*
|
|
179
179
|
* @param version - Version of the resource
|
|
180
|
-
* @param assistantSid - The
|
|
181
|
-
* @param taskSid - The
|
|
182
|
-
* @param sid -
|
|
180
|
+
* @param assistantSid - The unique ID of the Assistant.
|
|
181
|
+
* @param taskSid - The unique ID of the Task associated with this Field.
|
|
182
|
+
* @param sid - A 34-character string that uniquely identifies this resource.
|
|
183
183
|
*/
|
|
184
184
|
constructor(version: V1, assistantSid: string, taskSid: string, sid: string);
|
|
185
185
|
|
|
@@ -205,18 +205,18 @@ declare class FieldInstance extends SerializableClass {
|
|
|
205
205
|
* @property accountSid - The unique ID of the Account that created this Field.
|
|
206
206
|
* @property dateCreated - The date that this resource was created
|
|
207
207
|
* @property dateUpdated - The date that this resource was last updated
|
|
208
|
-
* @property fieldType - The Field Type of this field. It can be
|
|
208
|
+
* @property fieldType - The Field Type of this field. It can be either a Built-in Field Type or the unique_name or sid of a custom Field Type.
|
|
209
209
|
* @property taskSid - The unique ID of the Task associated with this Field.
|
|
210
|
-
* @property assistantSid - The unique ID of the
|
|
211
|
-
* @property sid - A 34
|
|
210
|
+
* @property assistantSid - The unique ID of the Assistant.
|
|
211
|
+
* @property sid - A 34-character string that uniquely identifies this resource.
|
|
212
212
|
* @property uniqueName - A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.
|
|
213
213
|
* @property url - The url
|
|
214
214
|
*
|
|
215
215
|
* @param version - Version of the resource
|
|
216
216
|
* @param payload - The instance payload
|
|
217
|
-
* @param assistantSid - The unique ID of the
|
|
217
|
+
* @param assistantSid - The unique ID of the Assistant.
|
|
218
218
|
* @param taskSid - The unique ID of the Task associated with this Field.
|
|
219
|
-
* @param sid -
|
|
219
|
+
* @param sid - A 34-character string that uniquely identifies this resource.
|
|
220
220
|
*/
|
|
221
221
|
constructor(version: V1, payload: FieldPayload, assistantSid: string, taskSid: string, sid: string);
|
|
222
222
|
|
|
@@ -27,7 +27,7 @@ var FieldContext;
|
|
|
27
27
|
* PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
|
|
28
28
|
*
|
|
29
29
|
* @param {Twilio.Autopilot.V1} version - Version of the resource
|
|
30
|
-
* @param {string} assistantSid - The unique ID of the
|
|
30
|
+
* @param {string} assistantSid - The unique ID of the Assistant.
|
|
31
31
|
* @param {string} taskSid - The unique ID of the Task associated with this Field.
|
|
32
32
|
*/
|
|
33
33
|
/* jshint ignore:end */
|
|
@@ -280,7 +280,7 @@ FieldList = function FieldList(version, assistantSid, taskSid) {
|
|
|
280
280
|
*
|
|
281
281
|
* @param {object} opts - Options for request
|
|
282
282
|
* @param {string} opts.fieldType -
|
|
283
|
-
* The
|
|
283
|
+
* The Field Type of this field. It can be either a Built-in Field Type or the unique_name or sid of a custom Field Type.
|
|
284
284
|
* @param {string} opts.uniqueName -
|
|
285
285
|
* A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.
|
|
286
286
|
* @param {function} [callback] - Callback to handle processed record
|
|
@@ -332,7 +332,8 @@ FieldList = function FieldList(version, assistantSid, taskSid) {
|
|
|
332
332
|
/**
|
|
333
333
|
* Constructs a field
|
|
334
334
|
*
|
|
335
|
-
* @param {string} sid -
|
|
335
|
+
* @param {string} sid -
|
|
336
|
+
* A 34-character string that uniquely identifies this resource.
|
|
336
337
|
*
|
|
337
338
|
* @returns {Twilio.Autopilot.V1.AssistantContext.TaskContext.FieldContext}
|
|
338
339
|
*/
|
|
@@ -394,21 +395,22 @@ FieldPage.prototype.getInstance = function getInstance(payload) {
|
|
|
394
395
|
* @property {Date} dateCreated - The date that this resource was created
|
|
395
396
|
* @property {Date} dateUpdated - The date that this resource was last updated
|
|
396
397
|
* @property {string} fieldType -
|
|
397
|
-
* The Field Type of this field. It can be
|
|
398
|
+
* The Field Type of this field. It can be either a Built-in Field Type or the unique_name or sid of a custom Field Type.
|
|
398
399
|
* @property {string} taskSid -
|
|
399
400
|
* The unique ID of the Task associated with this Field.
|
|
400
|
-
* @property {string} assistantSid - The unique ID of the
|
|
401
|
+
* @property {string} assistantSid - The unique ID of the Assistant.
|
|
401
402
|
* @property {string} sid -
|
|
402
|
-
* A 34
|
|
403
|
+
* A 34-character string that uniquely identifies this resource.
|
|
403
404
|
* @property {string} uniqueName -
|
|
404
405
|
* A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.
|
|
405
406
|
* @property {string} url - The url
|
|
406
407
|
*
|
|
407
408
|
* @param {V1} version - Version of the resource
|
|
408
409
|
* @param {FieldPayload} payload - The instance payload
|
|
409
|
-
* @param {sid} assistantSid - The unique ID of the
|
|
410
|
+
* @param {sid} assistantSid - The unique ID of the Assistant.
|
|
410
411
|
* @param {sid} taskSid - The unique ID of the Task associated with this Field.
|
|
411
|
-
* @param {sid_like} sid -
|
|
412
|
+
* @param {sid_like} sid -
|
|
413
|
+
* A 34-character string that uniquely identifies this resource.
|
|
412
414
|
*/
|
|
413
415
|
/* jshint ignore:end */
|
|
414
416
|
FieldInstance = function FieldInstance(version, payload, assistantSid, taskSid,
|
|
@@ -497,9 +499,11 @@ FieldInstance.prototype.toJSON = function toJSON() {
|
|
|
497
499
|
* Initialize the FieldContextPLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
|
|
498
500
|
*
|
|
499
501
|
* @param {V1} version - Version of the resource
|
|
500
|
-
* @param {sid_like} assistantSid - The
|
|
501
|
-
* @param {sid_like} taskSid -
|
|
502
|
-
*
|
|
502
|
+
* @param {sid_like} assistantSid - The unique ID of the Assistant.
|
|
503
|
+
* @param {sid_like} taskSid -
|
|
504
|
+
* The unique ID of the Task associated with this Field.
|
|
505
|
+
* @param {sid_like} sid -
|
|
506
|
+
* A 34-character string that uniquely identifies this resource.
|
|
503
507
|
*/
|
|
504
508
|
/* jshint ignore:end */
|
|
505
509
|
FieldContext = function FieldContext(version, assistantSid, taskSid, sid) {
|
|
@@ -23,9 +23,9 @@ declare function SampleList(version: V1, assistantSid: string, taskSid: string):
|
|
|
23
23
|
/**
|
|
24
24
|
* Options to pass to update
|
|
25
25
|
*
|
|
26
|
-
* @property language - An ISO language-country string that specifies the language used for this sample. For example: en-US
|
|
27
|
-
* @property sourceChannel - The communication channel from which the sample was captured. It can be: voice, sms, chat, alexa, google-assistant, or slack. If not included the value will be null
|
|
28
|
-
* @property taggedText - The text example of how end-users may express this task. The sample may contain Field tag blocks.
|
|
26
|
+
* @property language - An [ISO language-country string](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) that specifies the language used for this sample. For example: `en-US`.
|
|
27
|
+
* @property sourceChannel - The communication channel from which the sample was captured. It can be: voice, sms, chat, alexa, google-assistant, or slack. If not included, the value will be `null`
|
|
28
|
+
* @property taggedText - The text example of how end-users may express this task. The sample may contain [Field tag blocks](https://www.twilio.com/docs/autopilot/api/task-sample#field-tagging).
|
|
29
29
|
*/
|
|
30
30
|
interface SampleInstanceUpdateOptions {
|
|
31
31
|
language?: string;
|
|
@@ -62,7 +62,7 @@ interface SampleListInstance {
|
|
|
62
62
|
/**
|
|
63
63
|
* Constructs a sample
|
|
64
64
|
*
|
|
65
|
-
* @param sid -
|
|
65
|
+
* @param sid - A 34-character string that uniquely identifies this resource.
|
|
66
66
|
*/
|
|
67
67
|
get(sid: string): SampleContext;
|
|
68
68
|
/**
|
|
@@ -99,9 +99,9 @@ interface SampleListInstance {
|
|
|
99
99
|
/**
|
|
100
100
|
* Options to pass to create
|
|
101
101
|
*
|
|
102
|
-
* @property language - An ISO language-country string that specifies the language used for this sample. For example: en-US
|
|
103
|
-
* @property sourceChannel - The communication channel from which the sample was captured. It can be: voice, sms, chat, alexa, google-assistant, or slack. If not included the value will be null
|
|
104
|
-
* @property taggedText - The text example of how end-users may express this task. The sample may contain Field tag blocks.
|
|
102
|
+
* @property language - An [ISO language-country string](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) that specifies the language used for this sample. For example: `en-US`.
|
|
103
|
+
* @property sourceChannel - The communication channel from which the sample was captured. It can be: voice, sms, chat, alexa, google-assistant, or slack. If not included, the value will be `null`
|
|
104
|
+
* @property taggedText - The text example of how end-users may express this task. The sample may contain [Field tag blocks](https://www.twilio.com/docs/autopilot/api/task-sample#field-tagging).
|
|
105
105
|
*/
|
|
106
106
|
interface SampleListInstanceCreateOptions {
|
|
107
107
|
language: string;
|
|
@@ -116,7 +116,7 @@ interface SampleListInstanceCreateOptions {
|
|
|
116
116
|
* Function to process each record. If this and a positional
|
|
117
117
|
* callback are passed, this one will be used
|
|
118
118
|
* @property done - Function to be called upon completion of streaming
|
|
119
|
-
* @property language - An ISO language-country string that specifies the language used for this sample. For example: en-US
|
|
119
|
+
* @property language - An [ISO language-country string](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) that specifies the language used for this sample. For example: `en-US`.
|
|
120
120
|
* @property limit -
|
|
121
121
|
* Upper limit for the number of records to return.
|
|
122
122
|
* each() guarantees never to return more than limit.
|
|
@@ -139,7 +139,7 @@ interface SampleListInstanceEachOptions {
|
|
|
139
139
|
/**
|
|
140
140
|
* Options to pass to list
|
|
141
141
|
*
|
|
142
|
-
* @property language - An ISO language-country string that specifies the language used for this sample. For example: en-US
|
|
142
|
+
* @property language - An [ISO language-country string](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) that specifies the language used for this sample. For example: `en-US`.
|
|
143
143
|
* @property limit -
|
|
144
144
|
* Upper limit for the number of records to return.
|
|
145
145
|
* list() guarantees never to return more than limit.
|
|
@@ -160,7 +160,7 @@ interface SampleListInstanceOptions {
|
|
|
160
160
|
/**
|
|
161
161
|
* Options to pass to page
|
|
162
162
|
*
|
|
163
|
-
* @property language - An ISO language-country string that specifies the language used for this sample. For example: en-US
|
|
163
|
+
* @property language - An [ISO language-country string](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) that specifies the language used for this sample. For example: `en-US`.
|
|
164
164
|
* @property pageNumber - Page Number, this value is simply for client state
|
|
165
165
|
* @property pageSize - Number of records to return, defaults to 50
|
|
166
166
|
* @property pageToken - PageToken provided by the API
|
|
@@ -199,9 +199,9 @@ declare class SampleContext {
|
|
|
199
199
|
* Initialize the SampleContextPLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
|
|
200
200
|
*
|
|
201
201
|
* @param version - Version of the resource
|
|
202
|
-
* @param assistantSid - The
|
|
203
|
-
* @param taskSid - The
|
|
204
|
-
* @param sid -
|
|
202
|
+
* @param assistantSid - The unique ID of the Assistant.
|
|
203
|
+
* @param taskSid - The unique ID of the Task associated with this Sample.
|
|
204
|
+
* @param sid - A 34-character string that uniquely identifies this resource.
|
|
205
205
|
*/
|
|
206
206
|
constructor(version: V1, assistantSid: string, taskSid: string, sid: string);
|
|
207
207
|
|
|
@@ -235,18 +235,18 @@ declare class SampleInstance extends SerializableClass {
|
|
|
235
235
|
* @property dateCreated - The date that this resource was created
|
|
236
236
|
* @property dateUpdated - The date that this resource was last updated
|
|
237
237
|
* @property taskSid - The unique ID of the Task associated with this Sample.
|
|
238
|
-
* @property language - An ISO language-country string that specifies the language used for this sample. For example: en-US
|
|
238
|
+
* @property language - An [ISO language-country string](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) that specifies the language used for this sample. For example: `en-US`.
|
|
239
239
|
* @property assistantSid - The unique ID of the Assistant.
|
|
240
|
-
* @property sid - A 34
|
|
241
|
-
* @property taggedText - The text example of how end-users may express this task. The sample may contain Field tag blocks.
|
|
240
|
+
* @property sid - A 34-character string that uniquely identifies this resource.
|
|
241
|
+
* @property taggedText - The text example of how end-users may express this task. The sample may contain [Field tag blocks](https://www.twilio.com/docs/autopilot/api/task-sample#field-tagging).
|
|
242
242
|
* @property url - The url
|
|
243
|
-
* @property sourceChannel - The communication channel from which the sample was captured. It can be: voice, sms, chat, alexa, google-assistant, or slack. If not included the value will be null
|
|
243
|
+
* @property sourceChannel - The communication channel from which the sample was captured. It can be: voice, sms, chat, alexa, google-assistant, or slack. If not included, the value will be `null`
|
|
244
244
|
*
|
|
245
245
|
* @param version - Version of the resource
|
|
246
246
|
* @param payload - The instance payload
|
|
247
247
|
* @param assistantSid - The unique ID of the Assistant.
|
|
248
248
|
* @param taskSid - The unique ID of the Task associated with this Sample.
|
|
249
|
-
* @param sid -
|
|
249
|
+
* @param sid - A 34-character string that uniquely identifies this resource.
|
|
250
250
|
*/
|
|
251
251
|
constructor(version: V1, payload: SamplePayload, assistantSid: string, taskSid: string, sid: string);
|
|
252
252
|
|