twilio 6.0.0 → 6.0.2

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.
Files changed (121) hide show
  1. package/lib/rest/ConversationsBase.d.ts +3 -0
  2. package/lib/rest/ConversationsBase.js +5 -0
  3. package/lib/rest/InsightsBase.d.ts +3 -0
  4. package/lib/rest/InsightsBase.js +5 -0
  5. package/lib/rest/IntelligenceBase.d.ts +3 -0
  6. package/lib/rest/IntelligenceBase.js +5 -0
  7. package/lib/rest/KnowledgeBase.d.ts +3 -0
  8. package/lib/rest/KnowledgeBase.js +5 -0
  9. package/lib/rest/Memory.d.ts +4 -0
  10. package/lib/rest/Memory.js +8 -0
  11. package/lib/rest/MemoryBase.d.ts +13 -0
  12. package/lib/rest/MemoryBase.js +31 -0
  13. package/lib/rest/Twilio.d.ts +5 -0
  14. package/lib/rest/Twilio.js +5 -0
  15. package/lib/rest/VoiceBase.d.ts +3 -0
  16. package/lib/rest/VoiceBase.js +5 -0
  17. package/lib/rest/api/v2010/account/call/recording.d.ts +2 -0
  18. package/lib/rest/api/v2010/account/call/recording.js +4 -0
  19. package/lib/rest/api/v2010/account/call/transcription.d.ts +1 -1
  20. package/lib/rest/api/v2010/account/call/transcription.js +6 -4
  21. package/lib/rest/api/v2010/account/call.d.ts +2 -0
  22. package/lib/rest/api/v2010/account/call.js +4 -0
  23. package/lib/rest/api/v2010/account/conference/participant.d.ts +2 -0
  24. package/lib/rest/api/v2010/account/conference/participant.js +4 -0
  25. package/lib/rest/conversations/V2.d.ts +38 -0
  26. package/lib/rest/conversations/V2.js +72 -0
  27. package/lib/rest/conversations/v2/action.d.ts +241 -0
  28. package/lib/rest/conversations/v2/action.js +246 -0
  29. package/lib/rest/conversations/v2/communication.d.ts +479 -0
  30. package/lib/rest/conversations/v2/communication.js +436 -0
  31. package/lib/rest/conversations/v2/configuration.d.ts +906 -0
  32. package/lib/rest/conversations/v2/configuration.js +619 -0
  33. package/lib/rest/conversations/v2/conversation.d.ts +936 -0
  34. package/lib/rest/conversations/v2/conversation.js +664 -0
  35. package/lib/rest/conversations/v2/operation.d.ts +167 -0
  36. package/lib/rest/conversations/v2/operation.js +170 -0
  37. package/lib/rest/conversations/v2/participant.d.ts +469 -0
  38. package/lib/rest/conversations/v2/participant.js +442 -0
  39. package/lib/rest/flexApi/v1/plugin/pluginVersions.d.ts +1 -1
  40. package/lib/rest/flexApi/v1/plugin/pluginVersions.js +8 -6
  41. package/lib/rest/insights/V3.d.ts +20 -0
  42. package/lib/rest/insights/V3.js +42 -0
  43. package/lib/rest/insights/v1/call/callSummary.d.ts +10 -10
  44. package/lib/rest/insights/v1/call/event.d.ts +4 -4
  45. package/lib/rest/insights/v1/callSummaries.d.ts +12 -9
  46. package/lib/rest/insights/v3/metadata.d.ts +115 -0
  47. package/lib/rest/insights/v3/metadata.js +118 -0
  48. package/lib/rest/insights/v3/query.d.ts +180 -0
  49. package/lib/rest/insights/v3/query.js +214 -0
  50. package/lib/rest/intelligence/V3.d.ts +35 -0
  51. package/lib/rest/intelligence/V3.js +65 -0
  52. package/lib/rest/intelligence/v3/configuration.d.ts +693 -0
  53. package/lib/rest/intelligence/v3/configuration.js +528 -0
  54. package/lib/rest/intelligence/v3/conversation.d.ts +478 -0
  55. package/lib/rest/intelligence/v3/conversation.js +342 -0
  56. package/lib/rest/intelligence/v3/operator.d.ts +619 -0
  57. package/lib/rest/intelligence/v3/operator.js +493 -0
  58. package/lib/rest/intelligence/v3/operatorResult.d.ts +543 -0
  59. package/lib/rest/intelligence/v3/operatorResult.js +478 -0
  60. package/lib/rest/intelligence/v3/version.d.ts +469 -0
  61. package/lib/rest/intelligence/v3/version.js +341 -0
  62. package/lib/rest/knowledge/V2.d.ts +31 -0
  63. package/lib/rest/knowledge/V2.js +62 -0
  64. package/lib/rest/knowledge/v2/chunk.d.ts +209 -0
  65. package/lib/rest/knowledge/v2/chunk.js +178 -0
  66. package/lib/rest/knowledge/v2/knowledge.d.ts +507 -0
  67. package/lib/rest/knowledge/v2/knowledge.js +466 -0
  68. package/lib/rest/knowledge/v2/knowledgeBasis.d.ts +484 -0
  69. package/lib/rest/knowledge/v2/knowledgeBasis.js +441 -0
  70. package/lib/rest/knowledge/v2/operation.d.ts +162 -0
  71. package/lib/rest/knowledge/v2/operation.js +175 -0
  72. package/lib/rest/knowledge/v2/search.d.ts +180 -0
  73. package/lib/rest/knowledge/v2/search.js +174 -0
  74. package/lib/rest/memory/V1.d.ts +76 -0
  75. package/lib/rest/memory/V1.js +140 -0
  76. package/lib/rest/memory/v1/bulk.d.ts +129 -0
  77. package/lib/rest/memory/v1/bulk.js +158 -0
  78. package/lib/rest/memory/v1/conversationSummary.d.ts +531 -0
  79. package/lib/rest/memory/v1/conversationSummary.js +473 -0
  80. package/lib/rest/memory/v1/dataMapping.d.ts +630 -0
  81. package/lib/rest/memory/v1/dataMapping.js +512 -0
  82. package/lib/rest/memory/v1/event.d.ts +153 -0
  83. package/lib/rest/memory/v1/event.js +159 -0
  84. package/lib/rest/memory/v1/identifier.d.ts +362 -0
  85. package/lib/rest/memory/v1/identifier.js +369 -0
  86. package/lib/rest/memory/v1/identityResolutionSetting.d.ts +247 -0
  87. package/lib/rest/memory/v1/identityResolutionSetting.js +229 -0
  88. package/lib/rest/memory/v1/import.d.ts +292 -0
  89. package/lib/rest/memory/v1/import.js +280 -0
  90. package/lib/rest/memory/v1/lookup.d.ts +82 -0
  91. package/lib/rest/memory/v1/lookup.js +118 -0
  92. package/lib/rest/memory/v1/observation.d.ts +521 -0
  93. package/lib/rest/memory/v1/observation.js +477 -0
  94. package/lib/rest/memory/v1/operation.d.ts +162 -0
  95. package/lib/rest/memory/v1/operation.js +175 -0
  96. package/lib/rest/memory/v1/profile.d.ts +548 -0
  97. package/lib/rest/memory/v1/profile.js +531 -0
  98. package/lib/rest/memory/v1/recall.d.ts +306 -0
  99. package/lib/rest/memory/v1/recall.js +234 -0
  100. package/lib/rest/memory/v1/revision.d.ts +246 -0
  101. package/lib/rest/memory/v1/revision.js +195 -0
  102. package/lib/rest/memory/v1/store.d.ts +544 -0
  103. package/lib/rest/memory/v1/store.js +534 -0
  104. package/lib/rest/memory/v1/trait.d.ts +233 -0
  105. package/lib/rest/memory/v1/trait.js +190 -0
  106. package/lib/rest/memory/v1/traitGroup.d.ts +758 -0
  107. package/lib/rest/memory/v1/traitGroup.js +555 -0
  108. package/lib/rest/messaging/v2/channelsSender.d.ts +8 -0
  109. package/lib/rest/messaging/v2/channelsSender.js +2 -0
  110. package/lib/rest/previewIam/versionless/organization/roleAssignment.d.ts +32 -0
  111. package/lib/rest/previewIam/versionless/organization/roleAssignment.js +14 -0
  112. package/lib/rest/studio/v2/flow.d.ts +4 -0
  113. package/lib/rest/studio/v2/flow.js +8 -0
  114. package/lib/rest/verify/v2/service/webhook.d.ts +2 -2
  115. package/lib/rest/verify/v2/service/webhook.js +8 -8
  116. package/lib/rest/voice/V3.d.ts +15 -0
  117. package/lib/rest/voice/V3.js +37 -0
  118. package/lib/rest/voice/v3/transcription.d.ts +378 -0
  119. package/lib/rest/voice/v3/transcription.js +264 -0
  120. package/lib/twiml/VoiceResponse.d.ts +8 -0
  121. package/package.json +1 -1
@@ -0,0 +1,693 @@
1
+ import { inspect, InspectOptions } from "util";
2
+ import TokenPage, { TokenPaginationPayload } from "../../../base/TokenPage";
3
+ import Response from "../../../http/response";
4
+ import V3 from "../V3";
5
+ import { ApiResponse } from "../../../base/ApiResponse";
6
+ export declare class Action {
7
+ /**
8
+ * The type of Action to be performed after the Rule is triggered. Supported Actions are: - `WEBHOOK`: A webhook Action sends an HTTP request to a specified URL with Rule execution results.
9
+ */
10
+ "type": string;
11
+ /**
12
+ * The HTTP method to be used when performing the Action. Must be set to `POST`.
13
+ */
14
+ "method": string;
15
+ /**
16
+ * The URL endpoint where the Action will send the HTTP request containing the Rule execution results.
17
+ */
18
+ "url": string;
19
+ constructor(payload: any);
20
+ }
21
+ /**
22
+ * Controls what additional customer and enterprise context is made available to Language Operators when this Rule executes.
23
+ */
24
+ export declare class Context {
25
+ "memory"?: ContextMemory;
26
+ "knowledge"?: ContextKnowledge;
27
+ constructor(payload: any);
28
+ }
29
+ /**
30
+ * Configuration for passing Enterprise Knowledge as context to Operators in this Rule (available only for Enterprise Knowledge–enabled accounts).
31
+ */
32
+ export declare class ContextKnowledge {
33
+ /**
34
+ * Specifies the Knowledge Base(s) and corresponding Source(s) to pass to Language Operators in this Rule as context. Only applied to Language Operators that have Knowledge as a context source enabled.
35
+ */
36
+ "bases": Array<string>;
37
+ constructor(payload: any);
38
+ }
39
+ /**
40
+ * Configuration for passing Memory as context to Operators in this Rule (available only for Memory–enabled accounts).
41
+ */
42
+ export declare class ContextMemory {
43
+ /**
44
+ * When set to `true`, allows this Intelligence Configuration Rule to pass the Profile into attached Language Operators. The profile is only passed to Language Operators that have Memory as a context source enabled.
45
+ */
46
+ "enabled"?: boolean;
47
+ constructor(payload: any);
48
+ }
49
+ /**
50
+ * Request body for creating a new Intelligence Configuration.
51
+ */
52
+ export declare class CreateConfigurationRequest {
53
+ /**
54
+ * The display name of the Intelligence Configuration describing its purpose.
55
+ */
56
+ "displayName": string;
57
+ /**
58
+ * The description of the Intelligence Configuration further explaining its purpose.
59
+ */
60
+ "description"?: string;
61
+ /**
62
+ * List of Intelligence Configuration Rules that govern when and how Language Operators run. Each Rule represents a bundle of Operators, Triggers, Context, and Actions to be executed by the Intelligence Configuration on a Conversation. A maximum of five (5) Rules are allowed per Intelligence Configuration. To create an Intelligence Configuration without any Rules configured yet, pass an empty array (`\"rules\": []`). The Configuration will not execute any Language Operators until at least one Rule has been added.
63
+ */
64
+ "rules": Array<RuleCreationRequestPayload>;
65
+ constructor(payload: any);
66
+ }
67
+ export declare class Operator {
68
+ /**
69
+ * The unique identifier for the Language Operator to be executed by the Rule. Assigned by Twilio (TTID).
70
+ */
71
+ "id": string;
72
+ /**
73
+ * The specific version of the Language Operator to execute. When provided, the Rule will use this exact version of the Operator. When omitted, the latest active version of the Operator is used at execution time.
74
+ */
75
+ "version"?: number;
76
+ /**
77
+ * Key-value mapping for parameters defined as part of the Operator schema. The key and value passed by the Rule must match the name and data type of the parameter defined in the Operator, respectively. These parameters will customize the behavior of the Operator when executed by the Rule via runtime substitution into the prompt. Note: For parameters of type `knowledge_base_and_source_ids`, the value must be passed in the following format: `knowledge_base_id:knowledge_source_id`.
78
+ */
79
+ "parameters"?: Record<string, object>;
80
+ constructor(payload: any);
81
+ }
82
+ export declare class Rule {
83
+ /**
84
+ * The unique identifier for the Rule. Assigned by Twilio (TTID).
85
+ */
86
+ "id": string;
87
+ /**
88
+ * List of Operators to be executed by the Rule. Maximum of five (5) Operators allowed per Rule.
89
+ */
90
+ "operators": Array<Operator>;
91
+ /**
92
+ * List of Triggers that determine when to activate the Rule. Maximum of one (1) Trigger allowed per Rule.
93
+ */
94
+ "triggers": Array<Trigger>;
95
+ /**
96
+ * List of Actions to be performed after the Rule is triggered. Maximum of two (2) Actions allowed per Rule.
97
+ */
98
+ "actions": Array<Action>;
99
+ "context"?: Context;
100
+ constructor(payload: any);
101
+ }
102
+ export declare class RuleCreationRequestPayload {
103
+ /**
104
+ * List of Operators to be executed by the Rule. Minimum of one (1) and maximum of five (5) Operators allowed per Rule.
105
+ */
106
+ "operators": Array<Operator>;
107
+ /**
108
+ * List of Triggers that determine when to activate the Rule. Maximum of one (1) Trigger allowed per Rule.
109
+ */
110
+ "triggers"?: Array<Trigger>;
111
+ /**
112
+ * List of Actions to be performed after the Rule is triggered. Maximum of two (2) Actions allowed per Rule.
113
+ */
114
+ "actions": Array<Action>;
115
+ "context"?: Context;
116
+ constructor(payload: any);
117
+ }
118
+ export declare class RuleUpdateRequestPayload {
119
+ /**
120
+ * Optional field used when updating an existing Rule within an Intelligence Configuration. When provided, the Rule with this `id` is updated; when omitted, a new Rule is created.
121
+ */
122
+ "id"?: string;
123
+ /**
124
+ * List of Operators to be executed by the Rule. Minimum of one (1) and maximum of five (5) Operators allowed per Rule.
125
+ */
126
+ "operators": Array<Operator>;
127
+ /**
128
+ * List of Triggers that determine when to activate the Rule. Maximum of one (1) Trigger allowed per Rule.
129
+ */
130
+ "triggers"?: Array<Trigger>;
131
+ /**
132
+ * List of Actions to be performed after the Rule is triggered. Maximum of two (2) Actions allowed per Rule.
133
+ */
134
+ "actions": Array<Action>;
135
+ "context"?: Context;
136
+ constructor(payload: any);
137
+ }
138
+ export declare class Trigger {
139
+ /**
140
+ * The conversational lifecycle event that will activate execution of the Rule. Available values are: - `COMMUNICATION`: Trigger the Rule on each communication within the Conversation. - `CONVERSATION_END`: Trigger the Rule when the Conversation moves to the `closed` state - `CONVERSATION_INACTIVE`: Trigger the Rule when the Conversation moves to `inactive` state
141
+ */
142
+ "on": string;
143
+ "parameters"?: TriggerParameters;
144
+ constructor(payload: any);
145
+ }
146
+ /**
147
+ * Additional configuration to modify Trigger behavior. Only applies to certain Trigger types.
148
+ */
149
+ export declare class TriggerParameters {
150
+ /**
151
+ * When `on` is set to `COMMUNICATION`, this value controls how often the Rule should run. A value of `1` executes the Rule for every communication event. Higher values delay execution until the specified number of communications have occurred since the last execution.
152
+ */
153
+ "count"?: number;
154
+ constructor(payload: any);
155
+ }
156
+ export declare class UpdateConfigurationRequest {
157
+ /**
158
+ * The display name of the Intelligence Configuration describing its purpose.
159
+ */
160
+ "displayName": string;
161
+ /**
162
+ * The description of the Intelligence Configuration further explaining its purpose.
163
+ */
164
+ "description"?: string;
165
+ /**
166
+ * List of Intelligence Configuration Rules that govern when and how Language Operators run. Each Rule represents a bundle of Operators, Triggers, Context, and Actions to be executed by the Intelligence Configuration on a Conversation. A maximum of five (5) Rules are allowed per Intelligence Configuration.
167
+ */
168
+ "rules": Array<RuleUpdateRequestPayload>;
169
+ constructor(payload: any);
170
+ }
171
+ /**
172
+ * Options to pass to update a ConfigurationInstance
173
+ */
174
+ export interface ConfigurationContextUpdateOptions {
175
+ /** */
176
+ updateConfigurationRequest: UpdateConfigurationRequest;
177
+ }
178
+ /**
179
+ * Options to pass to create a ConfigurationInstance
180
+ */
181
+ export interface ConfigurationListInstanceCreateOptions {
182
+ /** */
183
+ createConfigurationRequest: CreateConfigurationRequest;
184
+ }
185
+ /**
186
+ * Options to pass to each
187
+ */
188
+ export interface ConfigurationListInstanceEachOptions {
189
+ /** The maximum number of resources to return */
190
+ pageSize?: number;
191
+ /** Token for pagination */
192
+ pageToken?: string;
193
+ /** Function to process each record. If this and a positional callback are passed, this one will be used */
194
+ callback?: (item: ConfigurationInstance, done: (err?: Error) => void) => void;
195
+ /** Function to be called upon completion of streaming */
196
+ done?: Function;
197
+ /** Upper limit for the number of records to return. each() guarantees never to return more than limit. Default is no limit */
198
+ limit?: number;
199
+ }
200
+ /**
201
+ * Options to pass to list
202
+ */
203
+ export interface ConfigurationListInstanceOptions {
204
+ /** The maximum number of resources to return */
205
+ pageSize?: number;
206
+ /** Token for pagination */
207
+ pageToken?: string;
208
+ /** Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit */
209
+ limit?: number;
210
+ }
211
+ /**
212
+ * Options to pass to page
213
+ */
214
+ export interface ConfigurationListInstancePageOptions {
215
+ /** The maximum number of resources to return */
216
+ pageSize?: number;
217
+ /** Token for pagination */
218
+ pageToken?: string;
219
+ }
220
+ export interface ConfigurationContext {
221
+ /**
222
+ * Remove a ConfigurationInstance
223
+ *
224
+ * @param callback - Callback to handle processed record
225
+ *
226
+ * @returns Resolves to processed boolean
227
+ */
228
+ remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
229
+ /**
230
+ * Remove a ConfigurationInstance and return HTTP info
231
+ *
232
+ * @param callback - Callback to handle processed record
233
+ *
234
+ * @returns Resolves to processed boolean with HTTP metadata
235
+ */
236
+ removeWithHttpInfo(callback?: (error: Error | null, item?: ApiResponse<boolean>) => any): Promise<ApiResponse<boolean>>;
237
+ /**
238
+ * Fetch a ConfigurationInstance
239
+ *
240
+ * @param callback - Callback to handle processed record
241
+ *
242
+ * @returns Resolves to processed ConfigurationInstance
243
+ */
244
+ fetch(callback?: (error: Error | null, item?: ConfigurationInstance) => any): Promise<ConfigurationInstance>;
245
+ /**
246
+ * Fetch a ConfigurationInstance and return HTTP info
247
+ *
248
+ * @param callback - Callback to handle processed record
249
+ *
250
+ * @returns Resolves to processed ConfigurationInstance with HTTP metadata
251
+ */
252
+ fetchWithHttpInfo(callback?: (error: Error | null, item?: ApiResponse<ConfigurationInstance>) => any): Promise<ApiResponse<ConfigurationInstance>>;
253
+ /**
254
+ * Update a ConfigurationInstance
255
+ *
256
+ * @param params - Body for request
257
+ * @param headers - header params for request
258
+ * @param callback - Callback to handle processed record
259
+ *
260
+ * @returns Resolves to processed ConfigurationInstance
261
+ */
262
+ update(params: UpdateConfigurationRequest, headers?: any, callback?: (error: Error | null, item?: ConfigurationInstance) => any): Promise<ConfigurationInstance>;
263
+ /**
264
+ * Update a ConfigurationInstance and return HTTP info
265
+ *
266
+ * @param params - Body for request
267
+ * @param headers - header params for request
268
+ * @param callback - Callback to handle processed record
269
+ *
270
+ * @returns Resolves to processed ConfigurationInstance with HTTP metadata
271
+ */
272
+ updateWithHttpInfo(params: UpdateConfigurationRequest, headers?: any, callback?: (error: Error | null, item?: ApiResponse<ConfigurationInstance>) => any): Promise<ApiResponse<ConfigurationInstance>>;
273
+ /**
274
+ * Provide a user-friendly representation
275
+ */
276
+ toJSON(): any;
277
+ [inspect.custom](_depth: any, options: InspectOptions): any;
278
+ }
279
+ export interface ConfigurationContextSolution {
280
+ id: string;
281
+ }
282
+ export declare class ConfigurationContextImpl implements ConfigurationContext {
283
+ protected _version: V3;
284
+ protected _solution: ConfigurationContextSolution;
285
+ protected _uri: string;
286
+ constructor(_version: V3, id: string);
287
+ remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
288
+ removeWithHttpInfo(callback?: (error: Error | null, item?: ApiResponse<boolean>) => any): Promise<ApiResponse<boolean>>;
289
+ fetch(callback?: (error: Error | null, item?: ConfigurationInstance) => any): Promise<ConfigurationInstance>;
290
+ fetchWithHttpInfo(callback?: (error: Error | null, item?: ApiResponse<ConfigurationInstance>) => any): Promise<ApiResponse<ConfigurationInstance>>;
291
+ update(params: UpdateConfigurationRequest, headers?: any, callback?: (error: Error | null, item?: ConfigurationInstance) => any): Promise<ConfigurationInstance>;
292
+ updateWithHttpInfo(params: UpdateConfigurationRequest, headers?: any, callback?: (error: Error | null, item?: ApiResponse<ConfigurationInstance>) => any): Promise<ApiResponse<ConfigurationInstance>>;
293
+ /**
294
+ * Provide a user-friendly representation
295
+ *
296
+ * @returns Object
297
+ */
298
+ toJSON(): ConfigurationContextSolution;
299
+ [inspect.custom](_depth: any, options: InspectOptions): string;
300
+ }
301
+ /**
302
+ * Nested model for Action
303
+ */
304
+ export interface Action {
305
+ type: string;
306
+ method: string;
307
+ url: string;
308
+ }
309
+ /**
310
+ * Nested model for Context
311
+ */
312
+ export interface Context {
313
+ memory?: ContextMemory;
314
+ knowledge?: ContextKnowledge;
315
+ }
316
+ /**
317
+ * Nested model for ContextKnowledge
318
+ */
319
+ export interface ContextKnowledge {
320
+ bases: Array<string>;
321
+ }
322
+ /**
323
+ * Nested model for ContextMemory
324
+ */
325
+ export interface ContextMemory {
326
+ enabled?: boolean;
327
+ }
328
+ /**
329
+ * Nested model for CreateConfigurationRequest
330
+ */
331
+ export interface CreateConfigurationRequest {
332
+ displayName: string;
333
+ description?: string;
334
+ rules: Array<RuleCreationRequestPayload>;
335
+ }
336
+ /**
337
+ * Nested model for Operator
338
+ */
339
+ export interface Operator {
340
+ id: string;
341
+ version?: number;
342
+ parameters?: Record<string, object>;
343
+ }
344
+ /**
345
+ * Nested model for Rule
346
+ */
347
+ export interface Rule {
348
+ id: string;
349
+ operators: Array<Operator>;
350
+ triggers: Array<Trigger>;
351
+ actions: Array<Action>;
352
+ context?: Context;
353
+ }
354
+ /**
355
+ * Nested model for RuleCreationRequestPayload
356
+ */
357
+ export interface RuleCreationRequestPayload {
358
+ operators: Array<Operator>;
359
+ triggers?: Array<Trigger>;
360
+ actions: Array<Action>;
361
+ context?: Context;
362
+ }
363
+ /**
364
+ * Nested model for RuleUpdateRequestPayload
365
+ */
366
+ export interface RuleUpdateRequestPayload {
367
+ id?: string;
368
+ operators: Array<Operator>;
369
+ triggers?: Array<Trigger>;
370
+ actions: Array<Action>;
371
+ context?: Context;
372
+ }
373
+ /**
374
+ * Nested model for Trigger
375
+ */
376
+ export interface Trigger {
377
+ on: string;
378
+ parameters?: TriggerParameters;
379
+ }
380
+ /**
381
+ * Nested model for TriggerParameters
382
+ */
383
+ export interface TriggerParameters {
384
+ count?: number;
385
+ }
386
+ /**
387
+ * Nested model for UpdateConfigurationRequest
388
+ */
389
+ export interface UpdateConfigurationRequest {
390
+ displayName: string;
391
+ description?: string;
392
+ rules: Array<RuleUpdateRequestPayload>;
393
+ }
394
+ interface ConfigurationPayload extends TokenPaginationPayload {
395
+ items: ConfigurationResource[];
396
+ }
397
+ /**
398
+ * Response model for CreateConfiguration201Response operations
399
+ */
400
+ interface CreateConfiguration201Response_ResponseResource {
401
+ accountId: string;
402
+ id: string;
403
+ displayName: string;
404
+ description?: string;
405
+ version: number;
406
+ rules: Array<Rule>;
407
+ dateCreated: Date;
408
+ dateUpdated: Date;
409
+ }
410
+ /**
411
+ * Response model for IntelligenceConfiguration operations
412
+ */
413
+ interface IntelligenceConfiguration_ResponseResource {
414
+ accountId: string;
415
+ id: string;
416
+ displayName: string;
417
+ description?: string;
418
+ version: number;
419
+ rules: Array<Rule>;
420
+ dateCreated: Date;
421
+ dateUpdated: Date;
422
+ }
423
+ /**
424
+ * Union type for all possible response models
425
+ */
426
+ type ConfigurationResource = CreateConfiguration201Response_ResponseResource | IntelligenceConfiguration_ResponseResource;
427
+ /**
428
+ * An Intelligence Configuration defines how and when Language Operators execute for a given conversation. To activate an Intelligence Configuration and trigger Operator execution, two conditions must be met: 1. The Intelligence Configuration must include at least one Rule. 2. The Intelligence Configuration must be attached to a Conversations Configuration via the Conversations API. Conversation traffic received by that Conversations Configuration determines when Rules are evaluated and executed. An Intelligence Configuration that has no Rules or is not attached to a Conversations Configuration will not execute.
429
+ */
430
+ export declare class ConfigurationInstance {
431
+ protected _version: V3;
432
+ protected _solution: ConfigurationContextSolution;
433
+ protected _context?: ConfigurationContext;
434
+ constructor(_version: V3, _payload: ConfigurationResource, id?: string);
435
+ /**
436
+ * The ID of the Account that created the Intelligence Configuration.
437
+ */
438
+ accountId?: string;
439
+ /**
440
+ * The unique identifier for the Intelligence Configuration. Assigned by Twilio (TTID).
441
+ */
442
+ id?: string;
443
+ /**
444
+ * The display name of the Intelligence Configuration describing its purpose.
445
+ */
446
+ displayName?: string;
447
+ /**
448
+ * The description of the Intelligence Configuration further explaining its purpose.
449
+ */
450
+ description?: string;
451
+ /**
452
+ * The numeric version of the Intelligence Configuration. Automatically incremented with each update on the resource, used to ensure integrity when updating the Configuration.
453
+ */
454
+ version?: number;
455
+ /**
456
+ * List of Intelligence Configuration Rules that govern when and how Language Operators run. Each Rule represents a bundle of Operators, Triggers, Context, and Actions to be executed by the Intelligence Configuration on a Conversation. A maximum of five (5) Rules are allowed per Intelligence Configuration.
457
+ */
458
+ rules?: Array<Rule>;
459
+ /**
460
+ * Timestamp of when the Intelligence Configuration was created.
461
+ */
462
+ dateCreated?: Date;
463
+ /**
464
+ * Timestamp of when the Intelligence Configuration was last updated.
465
+ */
466
+ dateUpdated?: Date;
467
+ private get _proxy();
468
+ /**
469
+ * Remove a ConfigurationInstance
470
+ *
471
+ * @param callback - Callback to handle processed record
472
+ *
473
+ * @returns Resolves to processed boolean
474
+ */
475
+ remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
476
+ /**
477
+ * Remove a ConfigurationInstance and return HTTP info
478
+ *
479
+ * @param callback - Callback to handle processed record
480
+ *
481
+ * @returns Resolves to processed boolean with HTTP metadata
482
+ */
483
+ removeWithHttpInfo(callback?: (error: Error | null, item?: ApiResponse<boolean>) => any): Promise<ApiResponse<boolean>>;
484
+ /**
485
+ * Fetch a ConfigurationInstance
486
+ *
487
+ * @param callback - Callback to handle processed record
488
+ *
489
+ * @returns Resolves to processed ConfigurationInstance
490
+ */
491
+ fetch(callback?: (error: Error | null, item?: ConfigurationInstance) => any): Promise<ConfigurationInstance>;
492
+ /**
493
+ * Fetch a ConfigurationInstance and return HTTP info
494
+ *
495
+ * @param callback - Callback to handle processed record
496
+ *
497
+ * @returns Resolves to processed ConfigurationInstance with HTTP metadata
498
+ */
499
+ fetchWithHttpInfo(callback?: (error: Error | null, item?: ApiResponse<ConfigurationInstance>) => any): Promise<ApiResponse<ConfigurationInstance>>;
500
+ /**
501
+ * Update a ConfigurationInstance
502
+ *
503
+ * @param params - Body for request
504
+ * @param headers - header params for request
505
+ * @param callback - Callback to handle processed record
506
+ *
507
+ * @returns Resolves to processed ConfigurationInstance
508
+ */
509
+ update(params: UpdateConfigurationRequest, headers?: any, callback?: (error: Error | null, item?: ConfigurationInstance) => any): Promise<ConfigurationInstance>;
510
+ /**
511
+ * Update a ConfigurationInstance and return HTTP info
512
+ *
513
+ * @param params - Body for request
514
+ * @param headers - header params for request
515
+ * @param callback - Callback to handle processed record
516
+ *
517
+ * @returns Resolves to processed ConfigurationInstance with HTTP metadata
518
+ */
519
+ updateWithHttpInfo(params: UpdateConfigurationRequest, headers?: any, callback?: (error: Error | null, item?: ApiResponse<ConfigurationInstance>) => any): Promise<ApiResponse<ConfigurationInstance>>;
520
+ /**
521
+ * Provide a user-friendly representation
522
+ *
523
+ * @returns Object
524
+ */
525
+ toJSON(): {
526
+ accountId: string;
527
+ id: string;
528
+ displayName: string;
529
+ description: string;
530
+ version: number;
531
+ rules: Rule[];
532
+ dateCreated: Date;
533
+ dateUpdated: Date;
534
+ };
535
+ [inspect.custom](_depth: any, options: InspectOptions): string;
536
+ }
537
+ export interface ConfigurationSolution {
538
+ }
539
+ export interface ConfigurationListInstance {
540
+ _version: V3;
541
+ _solution: ConfigurationSolution;
542
+ _uri: string;
543
+ (id: string): ConfigurationContext;
544
+ get(id: string): ConfigurationContext;
545
+ /**
546
+ * Create a ConfigurationInstance
547
+ *
548
+ * @param params - Body for request
549
+ * @param headers - header params for request
550
+ * @param callback - Callback to handle processed record
551
+ *
552
+ * @returns Resolves to processed ConfigurationInstance
553
+ */
554
+ create(params: CreateConfigurationRequest, headers?: any, callback?: (error: Error | null, item?: ConfigurationInstance) => any): Promise<ConfigurationInstance>;
555
+ /**
556
+ * Create a ConfigurationInstance and return HTTP info
557
+ *
558
+ * @param params - Body for request
559
+ * @param headers - header params for request
560
+ * @param callback - Callback to handle processed record
561
+ *
562
+ * @returns Resolves to processed ConfigurationInstance with HTTP metadata
563
+ */
564
+ createWithHttpInfo(params: CreateConfigurationRequest, headers?: any, callback?: (error: Error | null, item?: ApiResponse<ConfigurationInstance>) => any): Promise<ApiResponse<ConfigurationInstance>>;
565
+ /**
566
+ * Streams ConfigurationInstance records from the API.
567
+ *
568
+ * This operation lazily loads records as efficiently as possible until the limit
569
+ * is reached.
570
+ *
571
+ * The results are passed into the callback function, so this operation is memory
572
+ * efficient.
573
+ *
574
+ * If a function is passed as the first argument, it will be used as the callback
575
+ * function.
576
+ *
577
+ * @param { ConfigurationListInstanceEachOptions } [params] - Options for request
578
+ * @param { function } [callback] - Function to process each record
579
+ */
580
+ each(callback?: (item: ConfigurationInstance, done: (err?: Error) => void) => void): void;
581
+ each(params: ConfigurationListInstanceEachOptions, callback?: (item: ConfigurationInstance, done: (err?: Error) => void) => void): void;
582
+ /**
583
+ * Streams ConfigurationInstance records from the API with HTTP metadata captured per page.
584
+ *
585
+ * This operation lazily loads records as efficiently as possible until the limit
586
+ * is reached. HTTP metadata (status code, headers) is captured for each page request.
587
+ *
588
+ * The results are passed into the callback function, so this operation is memory
589
+ * efficient.
590
+ *
591
+ * If a function is passed as the first argument, it will be used as the callback
592
+ * function.
593
+ *
594
+ * @param { ConfigurationListInstanceEachOptions } [params] - Options for request
595
+ * @param { function } [callback] - Function to process each record
596
+ */
597
+ eachWithHttpInfo(callback?: (item: ConfigurationInstance, done: (err?: Error) => void) => void): void;
598
+ eachWithHttpInfo(params: ConfigurationListInstanceEachOptions, callback?: (item: ConfigurationInstance, done: (err?: Error) => void) => void): void;
599
+ /**
600
+ * Retrieve a single target page of ConfigurationInstance records from the API.
601
+ *
602
+ * The request is executed immediately.
603
+ *
604
+ * @param { string } [targetUrl] - API-generated URL for the requested results page
605
+ * @param { function } [callback] - Callback to handle list of records
606
+ */
607
+ getPage(targetUrl: string, callback?: (error: Error | null, items: ConfigurationPage) => any): Promise<ConfigurationPage>;
608
+ /**
609
+ * Retrieve a single target page of ConfigurationInstance records from the API with HTTP metadata.
610
+ *
611
+ * The request is executed immediately.
612
+ *
613
+ * @param { string } [targetUrl] - API-generated URL for the requested results page
614
+ * @param { function } [callback] - Callback to handle list of records with metadata
615
+ */
616
+ getPageWithHttpInfo(targetUrl: string, callback?: (error: Error | null, items: ApiResponse<ConfigurationPage>) => any): Promise<ApiResponse<ConfigurationPage>>;
617
+ /**
618
+ * Lists ConfigurationInstance records from the API as a list.
619
+ *
620
+ * If a function is passed as the first argument, it will be used as the callback
621
+ * function.
622
+ *
623
+ * @param { ConfigurationListInstanceOptions } [params] - Options for request
624
+ * @param { function } [callback] - Callback to handle list of records
625
+ */
626
+ list(callback?: (error: Error | null, items: ConfigurationInstance[]) => any): Promise<ConfigurationInstance[]>;
627
+ list(params: ConfigurationListInstanceOptions, callback?: (error: Error | null, items: ConfigurationInstance[]) => any): Promise<ConfigurationInstance[]>;
628
+ /**
629
+ * Lists ConfigurationInstance records from the API as a list with HTTP metadata.
630
+ *
631
+ * Returns all records along with HTTP metadata from the first page fetched.
632
+ *
633
+ * If a function is passed as the first argument, it will be used as the callback
634
+ * function.
635
+ *
636
+ * @param { ConfigurationListInstanceOptions } [params] - Options for request
637
+ * @param { function } [callback] - Callback to handle list of records with metadata
638
+ */
639
+ listWithHttpInfo(callback?: (error: Error | null, items: ApiResponse<ConfigurationInstance[]>) => any): Promise<ApiResponse<ConfigurationInstance[]>>;
640
+ listWithHttpInfo(params: ConfigurationListInstanceOptions, callback?: (error: Error | null, items: ApiResponse<ConfigurationInstance[]>) => any): Promise<ApiResponse<ConfigurationInstance[]>>;
641
+ /**
642
+ * Retrieve a single page of ConfigurationInstance records from the API.
643
+ *
644
+ * The request is executed immediately.
645
+ *
646
+ * If a function is passed as the first argument, it will be used as the callback
647
+ * function.
648
+ *
649
+ * @param { ConfigurationListInstancePageOptions } [params] - Options for request
650
+ * @param { function } [callback] - Callback to handle list of records
651
+ */
652
+ page(callback?: (error: Error | null, items: ConfigurationPage) => any): Promise<ConfigurationPage>;
653
+ page(params: ConfigurationListInstancePageOptions, callback?: (error: Error | null, items: ConfigurationPage) => any): Promise<ConfigurationPage>;
654
+ /**
655
+ * Retrieve a single page of ConfigurationInstance records from the API with HTTP metadata.
656
+ *
657
+ * The request is executed immediately.
658
+ *
659
+ * If a function is passed as the first argument, it will be used as the callback
660
+ * function.
661
+ *
662
+ * @param { ConfigurationListInstancePageOptions } [params] - Options for request
663
+ * @param { function } [callback] - Callback to handle list of records with metadata
664
+ */
665
+ pageWithHttpInfo(callback?: (error: Error | null, items: ApiResponse<ConfigurationPage>) => any): Promise<ApiResponse<ConfigurationPage>>;
666
+ pageWithHttpInfo(params: ConfigurationListInstancePageOptions, callback?: (error: Error | null, items: ApiResponse<ConfigurationPage>) => any): Promise<ApiResponse<ConfigurationPage>>;
667
+ /**
668
+ * Provide a user-friendly representation
669
+ */
670
+ toJSON(): any;
671
+ [inspect.custom](_depth: any, options: InspectOptions): any;
672
+ }
673
+ export declare function ConfigurationListInstance(version: V3): ConfigurationListInstance;
674
+ export declare class ConfigurationPage extends TokenPage<V3, ConfigurationPayload, ConfigurationResource, ConfigurationInstance> {
675
+ /**
676
+ * Initialize the ConfigurationPage
677
+ *
678
+ * @param version - Version of the resource
679
+ * @param response - Response from the API
680
+ * @param uri - URI of the resource
681
+ * @param params - Query parameters
682
+ * @param solution - Path solution
683
+ */
684
+ constructor(version: V3, response: Response<string>, uri: string, params: any, solution: ConfigurationSolution);
685
+ /**
686
+ * Build an instance of ConfigurationInstance
687
+ *
688
+ * @param payload - Payload response from the API
689
+ */
690
+ getInstance(payload: ConfigurationResource): ConfigurationInstance;
691
+ [inspect.custom](depth: any, options: InspectOptions): string;
692
+ }
693
+ export {};