twilio 6.0.0 → 6.0.1
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/ConversationsBase.d.ts +3 -0
- package/lib/rest/ConversationsBase.js +5 -0
- package/lib/rest/InsightsBase.d.ts +3 -0
- package/lib/rest/InsightsBase.js +5 -0
- package/lib/rest/IntelligenceBase.d.ts +3 -0
- package/lib/rest/IntelligenceBase.js +5 -0
- package/lib/rest/KnowledgeBase.d.ts +3 -0
- package/lib/rest/KnowledgeBase.js +5 -0
- package/lib/rest/Memory.d.ts +4 -0
- package/lib/rest/Memory.js +8 -0
- package/lib/rest/MemoryBase.d.ts +13 -0
- package/lib/rest/MemoryBase.js +31 -0
- package/lib/rest/Twilio.d.ts +5 -0
- package/lib/rest/Twilio.js +5 -0
- package/lib/rest/VoiceBase.d.ts +3 -0
- package/lib/rest/VoiceBase.js +5 -0
- package/lib/rest/api/v2010/account/call/recording.d.ts +2 -0
- package/lib/rest/api/v2010/account/call/recording.js +4 -0
- package/lib/rest/api/v2010/account/call/transcription.d.ts +1 -1
- package/lib/rest/api/v2010/account/call/transcription.js +6 -4
- package/lib/rest/api/v2010/account/call.d.ts +2 -0
- package/lib/rest/api/v2010/account/call.js +4 -0
- package/lib/rest/api/v2010/account/conference/participant.d.ts +2 -0
- package/lib/rest/api/v2010/account/conference/participant.js +4 -0
- package/lib/rest/conversations/V2.d.ts +35 -0
- package/lib/rest/conversations/V2.js +67 -0
- package/lib/rest/conversations/v2/communication.d.ts +479 -0
- package/lib/rest/conversations/v2/communication.js +436 -0
- package/lib/rest/conversations/v2/configuration.d.ts +906 -0
- package/lib/rest/conversations/v2/configuration.js +619 -0
- package/lib/rest/conversations/v2/conversation.d.ts +936 -0
- package/lib/rest/conversations/v2/conversation.js +664 -0
- package/lib/rest/conversations/v2/operation.d.ts +167 -0
- package/lib/rest/conversations/v2/operation.js +170 -0
- package/lib/rest/conversations/v2/participant.d.ts +469 -0
- package/lib/rest/conversations/v2/participant.js +442 -0
- package/lib/rest/flexApi/v1/plugin/pluginVersions.d.ts +1 -1
- package/lib/rest/flexApi/v1/plugin/pluginVersions.js +8 -6
- package/lib/rest/insights/V3.d.ts +20 -0
- package/lib/rest/insights/V3.js +42 -0
- package/lib/rest/insights/v1/call/callSummary.d.ts +10 -10
- package/lib/rest/insights/v1/call/event.d.ts +4 -4
- package/lib/rest/insights/v1/callSummaries.d.ts +12 -9
- package/lib/rest/insights/v3/metadata.d.ts +115 -0
- package/lib/rest/insights/v3/metadata.js +118 -0
- package/lib/rest/insights/v3/query.d.ts +180 -0
- package/lib/rest/insights/v3/query.js +214 -0
- package/lib/rest/intelligence/V3.d.ts +35 -0
- package/lib/rest/intelligence/V3.js +65 -0
- package/lib/rest/intelligence/v3/configuration.d.ts +693 -0
- package/lib/rest/intelligence/v3/configuration.js +528 -0
- package/lib/rest/intelligence/v3/conversation.d.ts +478 -0
- package/lib/rest/intelligence/v3/conversation.js +342 -0
- package/lib/rest/intelligence/v3/operator.d.ts +619 -0
- package/lib/rest/intelligence/v3/operator.js +493 -0
- package/lib/rest/intelligence/v3/operatorResult.d.ts +543 -0
- package/lib/rest/intelligence/v3/operatorResult.js +478 -0
- package/lib/rest/intelligence/v3/version.d.ts +469 -0
- package/lib/rest/intelligence/v3/version.js +341 -0
- package/lib/rest/knowledge/V2.d.ts +31 -0
- package/lib/rest/knowledge/V2.js +62 -0
- package/lib/rest/knowledge/v2/chunk.d.ts +209 -0
- package/lib/rest/knowledge/v2/chunk.js +178 -0
- package/lib/rest/knowledge/v2/knowledge.d.ts +507 -0
- package/lib/rest/knowledge/v2/knowledge.js +466 -0
- package/lib/rest/knowledge/v2/knowledgeBasis.d.ts +484 -0
- package/lib/rest/knowledge/v2/knowledgeBasis.js +441 -0
- package/lib/rest/knowledge/v2/operation.d.ts +162 -0
- package/lib/rest/knowledge/v2/operation.js +175 -0
- package/lib/rest/knowledge/v2/search.d.ts +180 -0
- package/lib/rest/knowledge/v2/search.js +174 -0
- package/lib/rest/memory/V1.d.ts +76 -0
- package/lib/rest/memory/V1.js +140 -0
- package/lib/rest/memory/v1/bulk.d.ts +129 -0
- package/lib/rest/memory/v1/bulk.js +158 -0
- package/lib/rest/memory/v1/conversationSummary.d.ts +531 -0
- package/lib/rest/memory/v1/conversationSummary.js +473 -0
- package/lib/rest/memory/v1/dataMapping.d.ts +630 -0
- package/lib/rest/memory/v1/dataMapping.js +512 -0
- package/lib/rest/memory/v1/event.d.ts +153 -0
- package/lib/rest/memory/v1/event.js +159 -0
- package/lib/rest/memory/v1/identifier.d.ts +362 -0
- package/lib/rest/memory/v1/identifier.js +369 -0
- package/lib/rest/memory/v1/identityResolutionSetting.d.ts +247 -0
- package/lib/rest/memory/v1/identityResolutionSetting.js +229 -0
- package/lib/rest/memory/v1/import.d.ts +292 -0
- package/lib/rest/memory/v1/import.js +280 -0
- package/lib/rest/memory/v1/lookup.d.ts +82 -0
- package/lib/rest/memory/v1/lookup.js +118 -0
- package/lib/rest/memory/v1/observation.d.ts +521 -0
- package/lib/rest/memory/v1/observation.js +477 -0
- package/lib/rest/memory/v1/operation.d.ts +162 -0
- package/lib/rest/memory/v1/operation.js +175 -0
- package/lib/rest/memory/v1/profile.d.ts +441 -0
- package/lib/rest/memory/v1/profile.js +467 -0
- package/lib/rest/memory/v1/recall.d.ts +306 -0
- package/lib/rest/memory/v1/recall.js +234 -0
- package/lib/rest/memory/v1/revision.d.ts +246 -0
- package/lib/rest/memory/v1/revision.js +195 -0
- package/lib/rest/memory/v1/store.d.ts +503 -0
- package/lib/rest/memory/v1/store.js +482 -0
- package/lib/rest/memory/v1/trait.d.ts +233 -0
- package/lib/rest/memory/v1/trait.js +190 -0
- package/lib/rest/memory/v1/traitGroup.d.ts +758 -0
- package/lib/rest/memory/v1/traitGroup.js +555 -0
- package/lib/rest/messaging/v2/channelsSender.d.ts +8 -0
- package/lib/rest/messaging/v2/channelsSender.js +2 -0
- package/lib/rest/previewIam/versionless/organization/roleAssignment.d.ts +32 -0
- package/lib/rest/previewIam/versionless/organization/roleAssignment.js +14 -0
- package/lib/rest/studio/v2/flow.d.ts +4 -0
- package/lib/rest/studio/v2/flow.js +8 -0
- package/lib/rest/verify/v2/service/webhook.d.ts +2 -2
- package/lib/rest/verify/v2/service/webhook.js +8 -8
- package/lib/rest/voice/V3.d.ts +15 -0
- package/lib/rest/voice/V3.js +37 -0
- package/lib/rest/voice/v3/transcription.d.ts +378 -0
- package/lib/rest/voice/v3/transcription.js +264 -0
- package/lib/twiml/VoiceResponse.d.ts +8 -0
- package/package.json +1 -1
|
@@ -0,0 +1,906 @@
|
|
|
1
|
+
import { inspect, InspectOptions } from "util";
|
|
2
|
+
import TokenPage, { TokenPaginationPayload } from "../../../base/TokenPage";
|
|
3
|
+
import Response from "../../../http/response";
|
|
4
|
+
import V2 from "../V2";
|
|
5
|
+
import { ApiResponse } from "../../../base/ApiResponse";
|
|
6
|
+
/**
|
|
7
|
+
* Defines a capture rule with from and to addresses. Supports wildcard `*` for omnidirectional matching.
|
|
8
|
+
*/
|
|
9
|
+
export declare class ConversationsV2CaptureRule {
|
|
10
|
+
/**
|
|
11
|
+
* The from address. Use `*` for wildcard to match any from address.
|
|
12
|
+
*/
|
|
13
|
+
"from": string;
|
|
14
|
+
/**
|
|
15
|
+
* The to address. Use `*` for wildcard to match any to address.
|
|
16
|
+
*/
|
|
17
|
+
"to": string;
|
|
18
|
+
/**
|
|
19
|
+
* Additional matching criteria for the capture rule. For voice calls, can include `callType` (`PSTN`, `SIP`, and similar).
|
|
20
|
+
*/
|
|
21
|
+
"metadata"?: {
|
|
22
|
+
[key: string]: string;
|
|
23
|
+
};
|
|
24
|
+
constructor(payload: any);
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* Configuration settings for a specific channel type.
|
|
28
|
+
*/
|
|
29
|
+
export declare class ConversationsV2ChannelSetting {
|
|
30
|
+
"statusTimeouts"?: ConversationsV2StatusTimeouts;
|
|
31
|
+
/**
|
|
32
|
+
* Array of capture rules with from/to addresses and optional metadata. Use `*` for wildcard matching in either direction.
|
|
33
|
+
*/
|
|
34
|
+
"captureRules"?: Array<ConversationsV2CaptureRule>;
|
|
35
|
+
constructor(payload: any);
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* Configuration for Conversations V1 bridge. When set, messaging channels route through Conversations V1. Use this to integrate with existing Conversations V1 applications.
|
|
39
|
+
*/
|
|
40
|
+
export declare class ConversationsV2ConversationsV1Bridge {
|
|
41
|
+
/**
|
|
42
|
+
* The Conversations V1 Service SID (IS prefix). One configuration per V1 Service SID.
|
|
43
|
+
*/
|
|
44
|
+
"serviceId": string;
|
|
45
|
+
constructor(payload: any);
|
|
46
|
+
}
|
|
47
|
+
/**
|
|
48
|
+
* Default webhook configuration for Conversation-level events under this Configuration.
|
|
49
|
+
*/
|
|
50
|
+
export declare class ConversationsV2StatusCallbackConfig {
|
|
51
|
+
/**
|
|
52
|
+
* Destination URL for webhooks.
|
|
53
|
+
*/
|
|
54
|
+
"url": string;
|
|
55
|
+
/**
|
|
56
|
+
* HTTP method used to invoke the webhook URL.
|
|
57
|
+
*/
|
|
58
|
+
"method"?: string;
|
|
59
|
+
constructor(payload: any);
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
* Timeout settings for channel status transitions.
|
|
63
|
+
*/
|
|
64
|
+
export declare class ConversationsV2StatusTimeouts {
|
|
65
|
+
/**
|
|
66
|
+
* Inactivity timeout in minutes.
|
|
67
|
+
*/
|
|
68
|
+
"inactive"?: number;
|
|
69
|
+
/**
|
|
70
|
+
* Close timeout in minutes.
|
|
71
|
+
*/
|
|
72
|
+
"closed"?: number;
|
|
73
|
+
constructor(payload: any);
|
|
74
|
+
}
|
|
75
|
+
export declare class CreateConfigurationRequest {
|
|
76
|
+
/**
|
|
77
|
+
* A human-readable name for the configuration. Limited to 32 characters.
|
|
78
|
+
*/
|
|
79
|
+
"displayName": string;
|
|
80
|
+
/**
|
|
81
|
+
* Human-readable description for the configuration.
|
|
82
|
+
*/
|
|
83
|
+
"description": string;
|
|
84
|
+
/**
|
|
85
|
+
* The strategy Conversation Orchestrator uses to assign communications to conversations.
|
|
86
|
+
*/
|
|
87
|
+
"conversationGroupingType": string;
|
|
88
|
+
/**
|
|
89
|
+
* The memory store ID that Conversation Orchestrator uses for profile resolution.
|
|
90
|
+
*/
|
|
91
|
+
"memoryStoreId": string;
|
|
92
|
+
"channelSettings"?: {
|
|
93
|
+
[key: string]: CreateConfigurationRequestChannelSettingsValue;
|
|
94
|
+
};
|
|
95
|
+
/**
|
|
96
|
+
* A list of webhook configurations.
|
|
97
|
+
*/
|
|
98
|
+
"statusCallbacks"?: Array<CreateConfigurationRequestStatusCallbacks>;
|
|
99
|
+
/**
|
|
100
|
+
* A list of Conversational Intelligence configuration IDs.
|
|
101
|
+
*/
|
|
102
|
+
"intelligenceConfigurationIds"?: Array<string>;
|
|
103
|
+
/**
|
|
104
|
+
* Whether memory extraction is enabled for conversations under this configuration. Defaults to false.
|
|
105
|
+
*/
|
|
106
|
+
"memoryExtractionEnabled"?: boolean;
|
|
107
|
+
constructor(payload: any);
|
|
108
|
+
}
|
|
109
|
+
export declare class CreateConfigurationRequestChannelSettingsValue {
|
|
110
|
+
"statusTimeouts"?: CreateConfigurationRequestChannelSettingsValueStatusTimeouts;
|
|
111
|
+
"captureRules"?: Array<CreateConfigurationRequestChannelSettingsValueCaptureRules>;
|
|
112
|
+
constructor(payload: any);
|
|
113
|
+
}
|
|
114
|
+
export declare class CreateConfigurationRequestChannelSettingsValueCaptureRules {
|
|
115
|
+
/**
|
|
116
|
+
* The from address. Use \'*\' for wildcard.
|
|
117
|
+
*/
|
|
118
|
+
"from": string;
|
|
119
|
+
/**
|
|
120
|
+
* The to address. Use \'*\' for wildcard.
|
|
121
|
+
*/
|
|
122
|
+
"to": string;
|
|
123
|
+
"metadata"?: {
|
|
124
|
+
[key: string]: string;
|
|
125
|
+
};
|
|
126
|
+
constructor(payload: any);
|
|
127
|
+
}
|
|
128
|
+
export declare class CreateConfigurationRequestChannelSettingsValueStatusTimeouts {
|
|
129
|
+
/**
|
|
130
|
+
* The inactivity timeout in minutes. For more information, see [Conversation lifecycle](/docs/platform/conversations/concepts/lifecycle).
|
|
131
|
+
*/
|
|
132
|
+
"inactive"?: number;
|
|
133
|
+
/**
|
|
134
|
+
* The close timeout in minutes. For more information, see [Conversation lifecycle](/docs/platform/conversations/concepts/lifecycle).
|
|
135
|
+
*/
|
|
136
|
+
"closed"?: number;
|
|
137
|
+
constructor(payload: any);
|
|
138
|
+
}
|
|
139
|
+
export declare class CreateConfigurationRequestStatusCallbacks {
|
|
140
|
+
/**
|
|
141
|
+
* The destination URL for webhooks.
|
|
142
|
+
*/
|
|
143
|
+
"url": string;
|
|
144
|
+
/**
|
|
145
|
+
* The HTTP method used to invoke the webhook URL.
|
|
146
|
+
*/
|
|
147
|
+
"method"?: string;
|
|
148
|
+
constructor(payload: any);
|
|
149
|
+
}
|
|
150
|
+
export declare class UpdateConfigurationRequest {
|
|
151
|
+
/**
|
|
152
|
+
* A human-readable name for the configuration. Limited to 32 characters.
|
|
153
|
+
*/
|
|
154
|
+
"displayName"?: string;
|
|
155
|
+
/**
|
|
156
|
+
* Human-readable description for the configuration.
|
|
157
|
+
*/
|
|
158
|
+
"description": string;
|
|
159
|
+
/**
|
|
160
|
+
* The strategy Conversation Orchestrator uses to assign communications to conversations.
|
|
161
|
+
*/
|
|
162
|
+
"conversationGroupingType": string;
|
|
163
|
+
/**
|
|
164
|
+
* The Memory Store ID for profile resolution.
|
|
165
|
+
*/
|
|
166
|
+
"memoryStoreId": string;
|
|
167
|
+
"channelSettings": {
|
|
168
|
+
[key: string]: UpdateConfigurationRequestChannelSettingsValue;
|
|
169
|
+
};
|
|
170
|
+
"statusCallbacks"?: Array<UpdateConfigurationRequestStatusCallbacks>;
|
|
171
|
+
/**
|
|
172
|
+
* A list of Conversational Intelligence configuration IDs.
|
|
173
|
+
*/
|
|
174
|
+
"intelligenceConfigurationIds"?: Array<string>;
|
|
175
|
+
/**
|
|
176
|
+
* Whether memory extraction is enabled for conversations under this configuration. Defaults to false.
|
|
177
|
+
*/
|
|
178
|
+
"memoryExtractionEnabled"?: boolean;
|
|
179
|
+
constructor(payload: any);
|
|
180
|
+
}
|
|
181
|
+
export declare class UpdateConfigurationRequestChannelSettingsValue {
|
|
182
|
+
"statusTimeouts"?: UpdateConfigurationRequestChannelSettingsValueStatusTimeouts;
|
|
183
|
+
"captureRules"?: Array<UpdateConfigurationRequestChannelSettingsValueCaptureRules>;
|
|
184
|
+
constructor(payload: any);
|
|
185
|
+
}
|
|
186
|
+
export declare class UpdateConfigurationRequestChannelSettingsValueCaptureRules {
|
|
187
|
+
"from": string;
|
|
188
|
+
"to": string;
|
|
189
|
+
"metadata"?: {
|
|
190
|
+
[key: string]: string;
|
|
191
|
+
};
|
|
192
|
+
constructor(payload: any);
|
|
193
|
+
}
|
|
194
|
+
export declare class UpdateConfigurationRequestChannelSettingsValueStatusTimeouts {
|
|
195
|
+
"inactive"?: number;
|
|
196
|
+
"closed"?: number;
|
|
197
|
+
constructor(payload: any);
|
|
198
|
+
}
|
|
199
|
+
export declare class UpdateConfigurationRequestStatusCallbacks {
|
|
200
|
+
"url": string;
|
|
201
|
+
"method"?: string;
|
|
202
|
+
constructor(payload: any);
|
|
203
|
+
}
|
|
204
|
+
/**
|
|
205
|
+
* Options to pass to remove a ConfigurationInstance
|
|
206
|
+
*/
|
|
207
|
+
export interface ConfigurationContextRemoveOptions {
|
|
208
|
+
/** Client-generated UUID key to ensure idempotent behavior. Submitting the same key returns the original response without creating a duplicate operation. Keys are scoped to account + region with a 24-hour TTL. */
|
|
209
|
+
idempotencyKey?: string;
|
|
210
|
+
}
|
|
211
|
+
/**
|
|
212
|
+
* Options to pass to update a ConfigurationInstance
|
|
213
|
+
*/
|
|
214
|
+
export interface ConfigurationContextUpdateOptions {
|
|
215
|
+
/** Client-generated UUID key to ensure idempotent behavior. Submitting the same key returns the original response without creating a duplicate operation. Keys are scoped to account + region with a 24-hour TTL. */
|
|
216
|
+
idempotencyKey?: string;
|
|
217
|
+
/** The configuration to update */
|
|
218
|
+
updateConfigurationRequest?: UpdateConfigurationRequest;
|
|
219
|
+
}
|
|
220
|
+
/**
|
|
221
|
+
* Options to pass to create a ConfigurationInstance
|
|
222
|
+
*/
|
|
223
|
+
export interface ConfigurationListInstanceCreateOptions {
|
|
224
|
+
/** Client-generated UUID key to ensure idempotent behavior. Submitting the same key returns the original response without creating a duplicate operation. Keys are scoped to account + region with a 24-hour TTL. */
|
|
225
|
+
idempotencyKey?: string;
|
|
226
|
+
/** The configuration to create */
|
|
227
|
+
createConfigurationRequest?: CreateConfigurationRequest;
|
|
228
|
+
}
|
|
229
|
+
/**
|
|
230
|
+
* Options to pass to each
|
|
231
|
+
*/
|
|
232
|
+
export interface ConfigurationListInstanceEachOptions {
|
|
233
|
+
/** Maximum number of items to return in a single response */
|
|
234
|
+
pageSize?: number;
|
|
235
|
+
/** A URL-safe, base64-encoded token representing the page of results to return */
|
|
236
|
+
pageToken?: string;
|
|
237
|
+
/** Filter configurations by Memory Store ID */
|
|
238
|
+
memoryStoreId?: string;
|
|
239
|
+
/** Function to process each record. If this and a positional callback are passed, this one will be used */
|
|
240
|
+
callback?: (item: ConfigurationInstance, done: (err?: Error) => void) => void;
|
|
241
|
+
/** Function to be called upon completion of streaming */
|
|
242
|
+
done?: Function;
|
|
243
|
+
/** Upper limit for the number of records to return. each() guarantees never to return more than limit. Default is no limit */
|
|
244
|
+
limit?: number;
|
|
245
|
+
}
|
|
246
|
+
/**
|
|
247
|
+
* Options to pass to list
|
|
248
|
+
*/
|
|
249
|
+
export interface ConfigurationListInstanceOptions {
|
|
250
|
+
/** Maximum number of items to return in a single response */
|
|
251
|
+
pageSize?: number;
|
|
252
|
+
/** A URL-safe, base64-encoded token representing the page of results to return */
|
|
253
|
+
pageToken?: string;
|
|
254
|
+
/** Filter configurations by Memory Store ID */
|
|
255
|
+
memoryStoreId?: string;
|
|
256
|
+
/** Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit */
|
|
257
|
+
limit?: number;
|
|
258
|
+
}
|
|
259
|
+
/**
|
|
260
|
+
* Options to pass to page
|
|
261
|
+
*/
|
|
262
|
+
export interface ConfigurationListInstancePageOptions {
|
|
263
|
+
/** Maximum number of items to return in a single response */
|
|
264
|
+
pageSize?: number;
|
|
265
|
+
/** A URL-safe, base64-encoded token representing the page of results to return */
|
|
266
|
+
pageToken?: string;
|
|
267
|
+
/** Filter configurations by Memory Store ID */
|
|
268
|
+
memoryStoreId?: string;
|
|
269
|
+
}
|
|
270
|
+
export interface ConfigurationContext {
|
|
271
|
+
/**
|
|
272
|
+
* Remove a ConfigurationInstance
|
|
273
|
+
*
|
|
274
|
+
* @param callback - Callback to handle processed record
|
|
275
|
+
*
|
|
276
|
+
* @returns Resolves to processed ConfigurationInstance
|
|
277
|
+
*/
|
|
278
|
+
remove(callback?: (error: Error | null, item?: ConfigurationInstance) => any): Promise<ConfigurationInstance>;
|
|
279
|
+
/**
|
|
280
|
+
* Remove a ConfigurationInstance
|
|
281
|
+
*
|
|
282
|
+
* @param params - Parameter for request
|
|
283
|
+
* @param callback - Callback to handle processed record
|
|
284
|
+
*
|
|
285
|
+
* @returns Resolves to processed ConfigurationInstance
|
|
286
|
+
*/
|
|
287
|
+
remove(params: ConfigurationContextRemoveOptions, callback?: (error: Error | null, item?: ConfigurationInstance) => any): Promise<ConfigurationInstance>;
|
|
288
|
+
/**
|
|
289
|
+
* Remove a ConfigurationInstance and return HTTP info
|
|
290
|
+
*
|
|
291
|
+
* @param callback - Callback to handle processed record
|
|
292
|
+
*
|
|
293
|
+
* @returns Resolves to processed ConfigurationInstance with HTTP metadata
|
|
294
|
+
*/
|
|
295
|
+
removeWithHttpInfo(callback?: (error: Error | null, item?: ApiResponse<ConfigurationInstance>) => any): Promise<ApiResponse<ConfigurationInstance>>;
|
|
296
|
+
/**
|
|
297
|
+
* Remove a ConfigurationInstance and return HTTP info
|
|
298
|
+
*
|
|
299
|
+
* @param params - Parameter for request
|
|
300
|
+
* @param callback - Callback to handle processed record
|
|
301
|
+
*
|
|
302
|
+
* @returns Resolves to processed ConfigurationInstance with HTTP metadata
|
|
303
|
+
*/
|
|
304
|
+
removeWithHttpInfo(params: ConfigurationContextRemoveOptions, callback?: (error: Error | null, item?: ApiResponse<ConfigurationInstance>) => any): Promise<ApiResponse<ConfigurationInstance>>;
|
|
305
|
+
/**
|
|
306
|
+
* Fetch a ConfigurationInstance
|
|
307
|
+
*
|
|
308
|
+
* @param callback - Callback to handle processed record
|
|
309
|
+
*
|
|
310
|
+
* @returns Resolves to processed ConfigurationInstance
|
|
311
|
+
*/
|
|
312
|
+
fetch(callback?: (error: Error | null, item?: ConfigurationInstance) => any): Promise<ConfigurationInstance>;
|
|
313
|
+
/**
|
|
314
|
+
* Fetch a ConfigurationInstance and return HTTP info
|
|
315
|
+
*
|
|
316
|
+
* @param callback - Callback to handle processed record
|
|
317
|
+
*
|
|
318
|
+
* @returns Resolves to processed ConfigurationInstance with HTTP metadata
|
|
319
|
+
*/
|
|
320
|
+
fetchWithHttpInfo(callback?: (error: Error | null, item?: ApiResponse<ConfigurationInstance>) => any): Promise<ApiResponse<ConfigurationInstance>>;
|
|
321
|
+
/**
|
|
322
|
+
* Update a ConfigurationInstance
|
|
323
|
+
*
|
|
324
|
+
* @param callback - Callback to handle processed record
|
|
325
|
+
*
|
|
326
|
+
* @returns Resolves to processed ConfigurationInstance
|
|
327
|
+
*/
|
|
328
|
+
update(callback?: (error: Error | null, item?: ConfigurationInstance) => any): Promise<ConfigurationInstance>;
|
|
329
|
+
/**
|
|
330
|
+
* Update a ConfigurationInstance
|
|
331
|
+
*
|
|
332
|
+
* @param params - Body for request
|
|
333
|
+
* @param headers - header params for request
|
|
334
|
+
* @param callback - Callback to handle processed record
|
|
335
|
+
*
|
|
336
|
+
* @returns Resolves to processed ConfigurationInstance
|
|
337
|
+
*/
|
|
338
|
+
update(params: UpdateConfigurationRequest, headers?: any, callback?: (error: Error | null, item?: ConfigurationInstance) => any): Promise<ConfigurationInstance>;
|
|
339
|
+
/**
|
|
340
|
+
* Update a ConfigurationInstance and return HTTP info
|
|
341
|
+
*
|
|
342
|
+
* @param callback - Callback to handle processed record
|
|
343
|
+
*
|
|
344
|
+
* @returns Resolves to processed ConfigurationInstance with HTTP metadata
|
|
345
|
+
*/
|
|
346
|
+
updateWithHttpInfo(callback?: (error: Error | null, item?: ApiResponse<ConfigurationInstance>) => any): Promise<ApiResponse<ConfigurationInstance>>;
|
|
347
|
+
/**
|
|
348
|
+
* Update a ConfigurationInstance and return HTTP info
|
|
349
|
+
*
|
|
350
|
+
* @param params - Body for request
|
|
351
|
+
* @param headers - header params for request
|
|
352
|
+
* @param callback - Callback to handle processed record
|
|
353
|
+
*
|
|
354
|
+
* @returns Resolves to processed ConfigurationInstance with HTTP metadata
|
|
355
|
+
*/
|
|
356
|
+
updateWithHttpInfo(params: UpdateConfigurationRequest, headers?: any, callback?: (error: Error | null, item?: ApiResponse<ConfigurationInstance>) => any): Promise<ApiResponse<ConfigurationInstance>>;
|
|
357
|
+
/**
|
|
358
|
+
* Provide a user-friendly representation
|
|
359
|
+
*/
|
|
360
|
+
toJSON(): any;
|
|
361
|
+
[inspect.custom](_depth: any, options: InspectOptions): any;
|
|
362
|
+
}
|
|
363
|
+
export interface ConfigurationContextSolution {
|
|
364
|
+
sid: string;
|
|
365
|
+
}
|
|
366
|
+
export declare class ConfigurationContextImpl implements ConfigurationContext {
|
|
367
|
+
protected _version: V2;
|
|
368
|
+
protected _solution: ConfigurationContextSolution;
|
|
369
|
+
protected _uri: string;
|
|
370
|
+
constructor(_version: V2, sid: string);
|
|
371
|
+
remove(params?: ConfigurationContextRemoveOptions | ((error: Error | null, item?: ConfigurationInstance) => any), callback?: (error: Error | null, item?: ConfigurationInstance) => any): Promise<ConfigurationInstance>;
|
|
372
|
+
removeWithHttpInfo(params?: ConfigurationContextRemoveOptions | ((error: Error | null, item?: ApiResponse<ConfigurationInstance>) => any), callback?: (error: Error | null, item?: ApiResponse<ConfigurationInstance>) => any): Promise<ApiResponse<ConfigurationInstance>>;
|
|
373
|
+
fetch(callback?: (error: Error | null, item?: ConfigurationInstance) => any): Promise<ConfigurationInstance>;
|
|
374
|
+
fetchWithHttpInfo(callback?: (error: Error | null, item?: ApiResponse<ConfigurationInstance>) => any): Promise<ApiResponse<ConfigurationInstance>>;
|
|
375
|
+
update(params?: UpdateConfigurationRequest | ((error: Error | null, item?: ConfigurationInstance) => any), headers?: any, callback?: (error: Error | null, item?: ConfigurationInstance) => any): Promise<ConfigurationInstance>;
|
|
376
|
+
updateWithHttpInfo(params?: UpdateConfigurationRequest | ((error: Error | null, item?: ApiResponse<ConfigurationInstance>) => any), headers?: any, callback?: (error: Error | null, item?: ApiResponse<ConfigurationInstance>) => any): Promise<ApiResponse<ConfigurationInstance>>;
|
|
377
|
+
/**
|
|
378
|
+
* Provide a user-friendly representation
|
|
379
|
+
*
|
|
380
|
+
* @returns Object
|
|
381
|
+
*/
|
|
382
|
+
toJSON(): ConfigurationContextSolution;
|
|
383
|
+
[inspect.custom](_depth: any, options: InspectOptions): string;
|
|
384
|
+
}
|
|
385
|
+
/**
|
|
386
|
+
* Nested model for ConversationsV2CaptureRule
|
|
387
|
+
*/
|
|
388
|
+
export interface ConversationsV2CaptureRule {
|
|
389
|
+
from: string;
|
|
390
|
+
to: string;
|
|
391
|
+
metadata?: {
|
|
392
|
+
[key: string]: string;
|
|
393
|
+
};
|
|
394
|
+
}
|
|
395
|
+
/**
|
|
396
|
+
* Nested model for ConversationsV2ChannelSetting
|
|
397
|
+
*/
|
|
398
|
+
export interface ConversationsV2ChannelSetting {
|
|
399
|
+
statusTimeouts?: ConversationsV2StatusTimeouts;
|
|
400
|
+
captureRules?: Array<ConversationsV2CaptureRule>;
|
|
401
|
+
}
|
|
402
|
+
/**
|
|
403
|
+
* Nested model for ConversationsV2ConversationsV1Bridge
|
|
404
|
+
*/
|
|
405
|
+
export interface ConversationsV2ConversationsV1Bridge {
|
|
406
|
+
serviceId: string;
|
|
407
|
+
}
|
|
408
|
+
/**
|
|
409
|
+
* Nested model for ConversationsV2StatusCallbackConfig
|
|
410
|
+
*/
|
|
411
|
+
export interface ConversationsV2StatusCallbackConfig {
|
|
412
|
+
url: string;
|
|
413
|
+
method?: string;
|
|
414
|
+
}
|
|
415
|
+
/**
|
|
416
|
+
* Nested model for ConversationsV2StatusTimeouts
|
|
417
|
+
*/
|
|
418
|
+
export interface ConversationsV2StatusTimeouts {
|
|
419
|
+
inactive?: number;
|
|
420
|
+
closed?: number;
|
|
421
|
+
}
|
|
422
|
+
/**
|
|
423
|
+
* Nested model for CreateConfigurationRequest
|
|
424
|
+
*/
|
|
425
|
+
export interface CreateConfigurationRequest {
|
|
426
|
+
displayName: string;
|
|
427
|
+
description: string;
|
|
428
|
+
conversationGroupingType: string;
|
|
429
|
+
memoryStoreId: string;
|
|
430
|
+
channelSettings?: {
|
|
431
|
+
[key: string]: CreateConfigurationRequestChannelSettingsValue;
|
|
432
|
+
};
|
|
433
|
+
statusCallbacks?: Array<CreateConfigurationRequestStatusCallbacks>;
|
|
434
|
+
intelligenceConfigurationIds?: Array<string>;
|
|
435
|
+
memoryExtractionEnabled?: boolean;
|
|
436
|
+
}
|
|
437
|
+
/**
|
|
438
|
+
* Nested model for CreateConfigurationRequestChannelSettingsValue
|
|
439
|
+
*/
|
|
440
|
+
export interface CreateConfigurationRequestChannelSettingsValue {
|
|
441
|
+
statusTimeouts?: CreateConfigurationRequestChannelSettingsValueStatusTimeouts;
|
|
442
|
+
captureRules?: Array<CreateConfigurationRequestChannelSettingsValueCaptureRules>;
|
|
443
|
+
}
|
|
444
|
+
/**
|
|
445
|
+
* Nested model for CreateConfigurationRequestChannelSettingsValueCaptureRules
|
|
446
|
+
*/
|
|
447
|
+
export interface CreateConfigurationRequestChannelSettingsValueCaptureRules {
|
|
448
|
+
from: string;
|
|
449
|
+
to: string;
|
|
450
|
+
metadata?: {
|
|
451
|
+
[key: string]: string;
|
|
452
|
+
};
|
|
453
|
+
}
|
|
454
|
+
/**
|
|
455
|
+
* Nested model for CreateConfigurationRequestChannelSettingsValueStatusTimeouts
|
|
456
|
+
*/
|
|
457
|
+
export interface CreateConfigurationRequestChannelSettingsValueStatusTimeouts {
|
|
458
|
+
inactive?: number;
|
|
459
|
+
closed?: number;
|
|
460
|
+
}
|
|
461
|
+
/**
|
|
462
|
+
* Nested model for CreateConfigurationRequestStatusCallbacks
|
|
463
|
+
*/
|
|
464
|
+
export interface CreateConfigurationRequestStatusCallbacks {
|
|
465
|
+
url: string;
|
|
466
|
+
method?: string;
|
|
467
|
+
}
|
|
468
|
+
/**
|
|
469
|
+
* Nested model for UpdateConfigurationRequest
|
|
470
|
+
*/
|
|
471
|
+
export interface UpdateConfigurationRequest {
|
|
472
|
+
displayName?: string;
|
|
473
|
+
description: string;
|
|
474
|
+
conversationGroupingType: string;
|
|
475
|
+
memoryStoreId: string;
|
|
476
|
+
channelSettings: {
|
|
477
|
+
[key: string]: UpdateConfigurationRequestChannelSettingsValue;
|
|
478
|
+
};
|
|
479
|
+
statusCallbacks?: Array<UpdateConfigurationRequestStatusCallbacks>;
|
|
480
|
+
intelligenceConfigurationIds?: Array<string>;
|
|
481
|
+
memoryExtractionEnabled?: boolean;
|
|
482
|
+
}
|
|
483
|
+
/**
|
|
484
|
+
* Nested model for UpdateConfigurationRequestChannelSettingsValue
|
|
485
|
+
*/
|
|
486
|
+
export interface UpdateConfigurationRequestChannelSettingsValue {
|
|
487
|
+
statusTimeouts?: UpdateConfigurationRequestChannelSettingsValueStatusTimeouts;
|
|
488
|
+
captureRules?: Array<UpdateConfigurationRequestChannelSettingsValueCaptureRules>;
|
|
489
|
+
}
|
|
490
|
+
/**
|
|
491
|
+
* Nested model for UpdateConfigurationRequestChannelSettingsValueCaptureRules
|
|
492
|
+
*/
|
|
493
|
+
export interface UpdateConfigurationRequestChannelSettingsValueCaptureRules {
|
|
494
|
+
from: string;
|
|
495
|
+
to: string;
|
|
496
|
+
metadata?: {
|
|
497
|
+
[key: string]: string;
|
|
498
|
+
};
|
|
499
|
+
}
|
|
500
|
+
/**
|
|
501
|
+
* Nested model for UpdateConfigurationRequestChannelSettingsValueStatusTimeouts
|
|
502
|
+
*/
|
|
503
|
+
export interface UpdateConfigurationRequestChannelSettingsValueStatusTimeouts {
|
|
504
|
+
inactive?: number;
|
|
505
|
+
closed?: number;
|
|
506
|
+
}
|
|
507
|
+
/**
|
|
508
|
+
* Nested model for UpdateConfigurationRequestStatusCallbacks
|
|
509
|
+
*/
|
|
510
|
+
export interface UpdateConfigurationRequestStatusCallbacks {
|
|
511
|
+
url: string;
|
|
512
|
+
method?: string;
|
|
513
|
+
}
|
|
514
|
+
interface ConfigurationPayload extends TokenPaginationPayload {
|
|
515
|
+
configurations: ConfigurationResource[];
|
|
516
|
+
}
|
|
517
|
+
/**
|
|
518
|
+
* Response model for CreateConfiguration202Response operations
|
|
519
|
+
*/
|
|
520
|
+
interface CreateConfiguration202Response_ResponseResource {
|
|
521
|
+
statusUrl: string;
|
|
522
|
+
related?: {
|
|
523
|
+
[key: string]: string;
|
|
524
|
+
};
|
|
525
|
+
}
|
|
526
|
+
/**
|
|
527
|
+
* Response model for ListConfiguration200ResponseConfigurations operations
|
|
528
|
+
*/
|
|
529
|
+
interface ListConfiguration200ResponseConfigurations_ResponseResource {
|
|
530
|
+
id: string;
|
|
531
|
+
displayName: string;
|
|
532
|
+
description: string;
|
|
533
|
+
conversationGroupingType: string;
|
|
534
|
+
memoryStoreId: string;
|
|
535
|
+
channelSettings?: {
|
|
536
|
+
[key: string]: ConversationsV2ChannelSetting;
|
|
537
|
+
};
|
|
538
|
+
statusCallbacks?: Array<ConversationsV2StatusCallbackConfig>;
|
|
539
|
+
intelligenceConfigurationIds?: Array<string>;
|
|
540
|
+
memoryExtractionEnabled?: boolean;
|
|
541
|
+
conversationsV1Bridge?: ConversationsV2ConversationsV1Bridge;
|
|
542
|
+
createdAt?: Date;
|
|
543
|
+
updatedAt?: Date;
|
|
544
|
+
version?: number;
|
|
545
|
+
}
|
|
546
|
+
/**
|
|
547
|
+
* Union type for all possible response models
|
|
548
|
+
*/
|
|
549
|
+
type ConfigurationResource = CreateConfiguration202Response_ResponseResource | ListConfiguration200ResponseConfigurations_ResponseResource;
|
|
550
|
+
/**
|
|
551
|
+
* Slim response for an accepted long-running operation.
|
|
552
|
+
*/
|
|
553
|
+
export declare class ConfigurationInstance {
|
|
554
|
+
protected _version: V2;
|
|
555
|
+
protected _solution: ConfigurationContextSolution;
|
|
556
|
+
protected _context?: ConfigurationContext;
|
|
557
|
+
constructor(_version: V2, _payload: ConfigurationResource, sid?: string);
|
|
558
|
+
/**
|
|
559
|
+
* URL to poll for operation status.
|
|
560
|
+
*/
|
|
561
|
+
statusUrl?: string;
|
|
562
|
+
/**
|
|
563
|
+
* Named resource identifiers associated with this operation. Keys depend on the operation type: - config-create, config-update, config-delete: configurationId - conversation-delete: conversationId
|
|
564
|
+
*/
|
|
565
|
+
related?: {
|
|
566
|
+
[key: string]: string;
|
|
567
|
+
};
|
|
568
|
+
/**
|
|
569
|
+
* Configuration ID.
|
|
570
|
+
*/
|
|
571
|
+
id?: string;
|
|
572
|
+
/**
|
|
573
|
+
* A human-readable name for the configuration. Limited to 32 characters.
|
|
574
|
+
*/
|
|
575
|
+
displayName?: string;
|
|
576
|
+
/**
|
|
577
|
+
* Human-readable description for the Configuration. Allows spaces and special characters, typically limited to a paragraph of text. This serves as a descriptive field rather than just a name.
|
|
578
|
+
*/
|
|
579
|
+
description?: string;
|
|
580
|
+
/**
|
|
581
|
+
* Type of Conversation grouping strategy: - `GROUP_BY_PROFILE`: Groups Communications by resolved Profile from the Memory Store. A Profile is looked up or created for `CUSTOMER` Participant types. All Communications from the same Profile are in the same Conversation, regardless of address or channel. - `GROUP_BY_PARTICIPANT_ADDRESSES`: Groups Communications by Participant addresses across all channels. A customer using +18005550100 will be in the same Conversation whether they contact by SMS, WhatsApp, or RCS. - `GROUP_BY_PARTICIPANT_ADDRESSES_AND_CHANNEL_TYPE`: Groups Communications by both Participant addresses AND channel. A customer using +18005550100 by SMS will be in a different Conversation than the same customer by Voice.
|
|
582
|
+
*/
|
|
583
|
+
conversationGroupingType?: string;
|
|
584
|
+
/**
|
|
585
|
+
* Memory Store ID for Profile resolution.
|
|
586
|
+
*/
|
|
587
|
+
memoryStoreId?: string;
|
|
588
|
+
/**
|
|
589
|
+
* Channel-specific configuration settings by channel type. Keys should be valid channel types (`VOICE`, `SMS`, `RCS`, `WHATSAPP`, `CHAT`).
|
|
590
|
+
*/
|
|
591
|
+
channelSettings?: {
|
|
592
|
+
[key: string]: ConversationsV2ChannelSetting;
|
|
593
|
+
};
|
|
594
|
+
/**
|
|
595
|
+
* List of default webhook configurations applied to Conversations under this Configuration.
|
|
596
|
+
*/
|
|
597
|
+
statusCallbacks?: Array<ConversationsV2StatusCallbackConfig>;
|
|
598
|
+
/**
|
|
599
|
+
* A list of Conversational Intelligence configuration IDs.
|
|
600
|
+
*/
|
|
601
|
+
intelligenceConfigurationIds?: Array<string>;
|
|
602
|
+
/**
|
|
603
|
+
* Whether memory extraction is enabled for conversations under this configuration. Defaults to false.
|
|
604
|
+
*/
|
|
605
|
+
memoryExtractionEnabled?: boolean;
|
|
606
|
+
conversationsV1Bridge?: ConversationsV2ConversationsV1Bridge;
|
|
607
|
+
/**
|
|
608
|
+
* Timestamp when this Configuration was created.
|
|
609
|
+
*/
|
|
610
|
+
createdAt?: Date;
|
|
611
|
+
/**
|
|
612
|
+
* Timestamp when this Configuration was last updated.
|
|
613
|
+
*/
|
|
614
|
+
updatedAt?: Date;
|
|
615
|
+
/**
|
|
616
|
+
* Version number used for optimistic locking.
|
|
617
|
+
*/
|
|
618
|
+
version?: number;
|
|
619
|
+
private get _proxy();
|
|
620
|
+
/**
|
|
621
|
+
* Remove a ConfigurationInstance
|
|
622
|
+
*
|
|
623
|
+
* @param callback - Callback to handle processed record
|
|
624
|
+
*
|
|
625
|
+
* @returns Resolves to processed ConfigurationInstance
|
|
626
|
+
*/
|
|
627
|
+
remove(callback?: (error: Error | null, item?: ConfigurationInstance) => any): Promise<ConfigurationInstance>;
|
|
628
|
+
/**
|
|
629
|
+
* Remove a ConfigurationInstance
|
|
630
|
+
*
|
|
631
|
+
* @param params - Parameter for request
|
|
632
|
+
* @param callback - Callback to handle processed record
|
|
633
|
+
*
|
|
634
|
+
* @returns Resolves to processed ConfigurationInstance
|
|
635
|
+
*/
|
|
636
|
+
remove(params: ConfigurationContextRemoveOptions, callback?: (error: Error | null, item?: ConfigurationInstance) => any): Promise<ConfigurationInstance>;
|
|
637
|
+
/**
|
|
638
|
+
* Remove a ConfigurationInstance and return HTTP info
|
|
639
|
+
*
|
|
640
|
+
* @param callback - Callback to handle processed record
|
|
641
|
+
*
|
|
642
|
+
* @returns Resolves to processed ConfigurationInstance with HTTP metadata
|
|
643
|
+
*/
|
|
644
|
+
removeWithHttpInfo(callback?: (error: Error | null, item?: ApiResponse<ConfigurationInstance>) => any): Promise<ApiResponse<ConfigurationInstance>>;
|
|
645
|
+
/**
|
|
646
|
+
* Remove a ConfigurationInstance and return HTTP info
|
|
647
|
+
*
|
|
648
|
+
* @param params - Parameter for request
|
|
649
|
+
* @param callback - Callback to handle processed record
|
|
650
|
+
*
|
|
651
|
+
* @returns Resolves to processed ConfigurationInstance with HTTP metadata
|
|
652
|
+
*/
|
|
653
|
+
removeWithHttpInfo(params: ConfigurationContextRemoveOptions, callback?: (error: Error | null, item?: ApiResponse<ConfigurationInstance>) => any): Promise<ApiResponse<ConfigurationInstance>>;
|
|
654
|
+
/**
|
|
655
|
+
* Fetch a ConfigurationInstance
|
|
656
|
+
*
|
|
657
|
+
* @param callback - Callback to handle processed record
|
|
658
|
+
*
|
|
659
|
+
* @returns Resolves to processed ConfigurationInstance
|
|
660
|
+
*/
|
|
661
|
+
fetch(callback?: (error: Error | null, item?: ConfigurationInstance) => any): Promise<ConfigurationInstance>;
|
|
662
|
+
/**
|
|
663
|
+
* Fetch a ConfigurationInstance and return HTTP info
|
|
664
|
+
*
|
|
665
|
+
* @param callback - Callback to handle processed record
|
|
666
|
+
*
|
|
667
|
+
* @returns Resolves to processed ConfigurationInstance with HTTP metadata
|
|
668
|
+
*/
|
|
669
|
+
fetchWithHttpInfo(callback?: (error: Error | null, item?: ApiResponse<ConfigurationInstance>) => any): Promise<ApiResponse<ConfigurationInstance>>;
|
|
670
|
+
/**
|
|
671
|
+
* Update a ConfigurationInstance
|
|
672
|
+
*
|
|
673
|
+
* @param callback - Callback to handle processed record
|
|
674
|
+
*
|
|
675
|
+
* @returns Resolves to processed ConfigurationInstance
|
|
676
|
+
*/
|
|
677
|
+
update(callback?: (error: Error | null, item?: ConfigurationInstance) => any): Promise<ConfigurationInstance>;
|
|
678
|
+
/**
|
|
679
|
+
* Update a ConfigurationInstance
|
|
680
|
+
*
|
|
681
|
+
* @param params - Body for request
|
|
682
|
+
* @param headers - header params for request
|
|
683
|
+
* @param callback - Callback to handle processed record
|
|
684
|
+
*
|
|
685
|
+
* @returns Resolves to processed ConfigurationInstance
|
|
686
|
+
*/
|
|
687
|
+
update(params: UpdateConfigurationRequest, headers?: any, callback?: (error: Error | null, item?: ConfigurationInstance) => any): Promise<ConfigurationInstance>;
|
|
688
|
+
/**
|
|
689
|
+
* Update a ConfigurationInstance and return HTTP info
|
|
690
|
+
*
|
|
691
|
+
* @param callback - Callback to handle processed record
|
|
692
|
+
*
|
|
693
|
+
* @returns Resolves to processed ConfigurationInstance with HTTP metadata
|
|
694
|
+
*/
|
|
695
|
+
updateWithHttpInfo(callback?: (error: Error | null, item?: ApiResponse<ConfigurationInstance>) => any): Promise<ApiResponse<ConfigurationInstance>>;
|
|
696
|
+
/**
|
|
697
|
+
* Update a ConfigurationInstance and return HTTP info
|
|
698
|
+
*
|
|
699
|
+
* @param params - Body for request
|
|
700
|
+
* @param headers - header params for request
|
|
701
|
+
* @param callback - Callback to handle processed record
|
|
702
|
+
*
|
|
703
|
+
* @returns Resolves to processed ConfigurationInstance with HTTP metadata
|
|
704
|
+
*/
|
|
705
|
+
updateWithHttpInfo(params: UpdateConfigurationRequest, headers?: any, callback?: (error: Error | null, item?: ApiResponse<ConfigurationInstance>) => any): Promise<ApiResponse<ConfigurationInstance>>;
|
|
706
|
+
/**
|
|
707
|
+
* Provide a user-friendly representation
|
|
708
|
+
*
|
|
709
|
+
* @returns Object
|
|
710
|
+
*/
|
|
711
|
+
toJSON(): {
|
|
712
|
+
statusUrl: string;
|
|
713
|
+
related: {
|
|
714
|
+
[key: string]: string;
|
|
715
|
+
};
|
|
716
|
+
id: string;
|
|
717
|
+
displayName: string;
|
|
718
|
+
description: string;
|
|
719
|
+
conversationGroupingType: string;
|
|
720
|
+
memoryStoreId: string;
|
|
721
|
+
channelSettings: {
|
|
722
|
+
[key: string]: ConversationsV2ChannelSetting;
|
|
723
|
+
};
|
|
724
|
+
statusCallbacks: ConversationsV2StatusCallbackConfig[];
|
|
725
|
+
intelligenceConfigurationIds: string[];
|
|
726
|
+
memoryExtractionEnabled: boolean;
|
|
727
|
+
conversationsV1Bridge: ConversationsV2ConversationsV1Bridge;
|
|
728
|
+
createdAt: Date;
|
|
729
|
+
updatedAt: Date;
|
|
730
|
+
version: number;
|
|
731
|
+
};
|
|
732
|
+
[inspect.custom](_depth: any, options: InspectOptions): string;
|
|
733
|
+
}
|
|
734
|
+
export interface ConfigurationSolution {
|
|
735
|
+
}
|
|
736
|
+
export interface ConfigurationListInstance {
|
|
737
|
+
_version: V2;
|
|
738
|
+
_solution: ConfigurationSolution;
|
|
739
|
+
_uri: string;
|
|
740
|
+
(sid: string): ConfigurationContext;
|
|
741
|
+
get(sid: string): ConfigurationContext;
|
|
742
|
+
/**
|
|
743
|
+
* Create a ConfigurationInstance
|
|
744
|
+
*
|
|
745
|
+
* @param callback - Callback to handle processed record
|
|
746
|
+
*
|
|
747
|
+
* @returns Resolves to processed ConfigurationInstance
|
|
748
|
+
*/
|
|
749
|
+
create(callback?: (error: Error | null, item?: ConfigurationInstance) => any): Promise<ConfigurationInstance>;
|
|
750
|
+
/**
|
|
751
|
+
* Create a ConfigurationInstance
|
|
752
|
+
*
|
|
753
|
+
* @param params - Body for request
|
|
754
|
+
* @param headers - header params for request
|
|
755
|
+
* @param callback - Callback to handle processed record
|
|
756
|
+
*
|
|
757
|
+
* @returns Resolves to processed ConfigurationInstance
|
|
758
|
+
*/
|
|
759
|
+
create(params: CreateConfigurationRequest, headers?: any, callback?: (error: Error | null, item?: ConfigurationInstance) => any): Promise<ConfigurationInstance>;
|
|
760
|
+
/**
|
|
761
|
+
* Create a ConfigurationInstance and return HTTP info
|
|
762
|
+
*
|
|
763
|
+
* @param callback - Callback to handle processed record
|
|
764
|
+
*
|
|
765
|
+
* @returns Resolves to processed ConfigurationInstance with HTTP metadata
|
|
766
|
+
*/
|
|
767
|
+
createWithHttpInfo(callback?: (error: Error | null, item?: ApiResponse<ConfigurationInstance>) => any): Promise<ApiResponse<ConfigurationInstance>>;
|
|
768
|
+
/**
|
|
769
|
+
* Create a ConfigurationInstance and return HTTP info
|
|
770
|
+
*
|
|
771
|
+
* @param params - Body for request
|
|
772
|
+
* @param headers - header params for request
|
|
773
|
+
* @param callback - Callback to handle processed record
|
|
774
|
+
*
|
|
775
|
+
* @returns Resolves to processed ConfigurationInstance with HTTP metadata
|
|
776
|
+
*/
|
|
777
|
+
createWithHttpInfo(params: CreateConfigurationRequest, headers?: any, callback?: (error: Error | null, item?: ApiResponse<ConfigurationInstance>) => any): Promise<ApiResponse<ConfigurationInstance>>;
|
|
778
|
+
/**
|
|
779
|
+
* Streams ConfigurationInstance records from the API.
|
|
780
|
+
*
|
|
781
|
+
* This operation lazily loads records as efficiently as possible until the limit
|
|
782
|
+
* is reached.
|
|
783
|
+
*
|
|
784
|
+
* The results are passed into the callback function, so this operation is memory
|
|
785
|
+
* efficient.
|
|
786
|
+
*
|
|
787
|
+
* If a function is passed as the first argument, it will be used as the callback
|
|
788
|
+
* function.
|
|
789
|
+
*
|
|
790
|
+
* @param { ConfigurationListInstanceEachOptions } [params] - Options for request
|
|
791
|
+
* @param { function } [callback] - Function to process each record
|
|
792
|
+
*/
|
|
793
|
+
each(callback?: (item: ConfigurationInstance, done: (err?: Error) => void) => void): void;
|
|
794
|
+
each(params: ConfigurationListInstanceEachOptions, callback?: (item: ConfigurationInstance, done: (err?: Error) => void) => void): void;
|
|
795
|
+
/**
|
|
796
|
+
* Streams ConfigurationInstance records from the API with HTTP metadata captured per page.
|
|
797
|
+
*
|
|
798
|
+
* This operation lazily loads records as efficiently as possible until the limit
|
|
799
|
+
* is reached. HTTP metadata (status code, headers) is captured for each page request.
|
|
800
|
+
*
|
|
801
|
+
* The results are passed into the callback function, so this operation is memory
|
|
802
|
+
* efficient.
|
|
803
|
+
*
|
|
804
|
+
* If a function is passed as the first argument, it will be used as the callback
|
|
805
|
+
* function.
|
|
806
|
+
*
|
|
807
|
+
* @param { ConfigurationListInstanceEachOptions } [params] - Options for request
|
|
808
|
+
* @param { function } [callback] - Function to process each record
|
|
809
|
+
*/
|
|
810
|
+
eachWithHttpInfo(callback?: (item: ConfigurationInstance, done: (err?: Error) => void) => void): void;
|
|
811
|
+
eachWithHttpInfo(params: ConfigurationListInstanceEachOptions, callback?: (item: ConfigurationInstance, done: (err?: Error) => void) => void): void;
|
|
812
|
+
/**
|
|
813
|
+
* Retrieve a single target page of ConfigurationInstance records from the API.
|
|
814
|
+
*
|
|
815
|
+
* The request is executed immediately.
|
|
816
|
+
*
|
|
817
|
+
* @param { string } [targetUrl] - API-generated URL for the requested results page
|
|
818
|
+
* @param { function } [callback] - Callback to handle list of records
|
|
819
|
+
*/
|
|
820
|
+
getPage(targetUrl: string, callback?: (error: Error | null, items: ConfigurationPage) => any): Promise<ConfigurationPage>;
|
|
821
|
+
/**
|
|
822
|
+
* Retrieve a single target page of ConfigurationInstance records from the API with HTTP metadata.
|
|
823
|
+
*
|
|
824
|
+
* The request is executed immediately.
|
|
825
|
+
*
|
|
826
|
+
* @param { string } [targetUrl] - API-generated URL for the requested results page
|
|
827
|
+
* @param { function } [callback] - Callback to handle list of records with metadata
|
|
828
|
+
*/
|
|
829
|
+
getPageWithHttpInfo(targetUrl: string, callback?: (error: Error | null, items: ApiResponse<ConfigurationPage>) => any): Promise<ApiResponse<ConfigurationPage>>;
|
|
830
|
+
/**
|
|
831
|
+
* Lists ConfigurationInstance records from the API as a list.
|
|
832
|
+
*
|
|
833
|
+
* If a function is passed as the first argument, it will be used as the callback
|
|
834
|
+
* function.
|
|
835
|
+
*
|
|
836
|
+
* @param { ConfigurationListInstanceOptions } [params] - Options for request
|
|
837
|
+
* @param { function } [callback] - Callback to handle list of records
|
|
838
|
+
*/
|
|
839
|
+
list(callback?: (error: Error | null, items: ConfigurationInstance[]) => any): Promise<ConfigurationInstance[]>;
|
|
840
|
+
list(params: ConfigurationListInstanceOptions, callback?: (error: Error | null, items: ConfigurationInstance[]) => any): Promise<ConfigurationInstance[]>;
|
|
841
|
+
/**
|
|
842
|
+
* Lists ConfigurationInstance records from the API as a list with HTTP metadata.
|
|
843
|
+
*
|
|
844
|
+
* Returns all records along with HTTP metadata from the first page fetched.
|
|
845
|
+
*
|
|
846
|
+
* If a function is passed as the first argument, it will be used as the callback
|
|
847
|
+
* function.
|
|
848
|
+
*
|
|
849
|
+
* @param { ConfigurationListInstanceOptions } [params] - Options for request
|
|
850
|
+
* @param { function } [callback] - Callback to handle list of records with metadata
|
|
851
|
+
*/
|
|
852
|
+
listWithHttpInfo(callback?: (error: Error | null, items: ApiResponse<ConfigurationInstance[]>) => any): Promise<ApiResponse<ConfigurationInstance[]>>;
|
|
853
|
+
listWithHttpInfo(params: ConfigurationListInstanceOptions, callback?: (error: Error | null, items: ApiResponse<ConfigurationInstance[]>) => any): Promise<ApiResponse<ConfigurationInstance[]>>;
|
|
854
|
+
/**
|
|
855
|
+
* Retrieve a single page of ConfigurationInstance records from the API.
|
|
856
|
+
*
|
|
857
|
+
* The request is executed immediately.
|
|
858
|
+
*
|
|
859
|
+
* If a function is passed as the first argument, it will be used as the callback
|
|
860
|
+
* function.
|
|
861
|
+
*
|
|
862
|
+
* @param { ConfigurationListInstancePageOptions } [params] - Options for request
|
|
863
|
+
* @param { function } [callback] - Callback to handle list of records
|
|
864
|
+
*/
|
|
865
|
+
page(callback?: (error: Error | null, items: ConfigurationPage) => any): Promise<ConfigurationPage>;
|
|
866
|
+
page(params: ConfigurationListInstancePageOptions, callback?: (error: Error | null, items: ConfigurationPage) => any): Promise<ConfigurationPage>;
|
|
867
|
+
/**
|
|
868
|
+
* Retrieve a single page of ConfigurationInstance records from the API with HTTP metadata.
|
|
869
|
+
*
|
|
870
|
+
* The request is executed immediately.
|
|
871
|
+
*
|
|
872
|
+
* If a function is passed as the first argument, it will be used as the callback
|
|
873
|
+
* function.
|
|
874
|
+
*
|
|
875
|
+
* @param { ConfigurationListInstancePageOptions } [params] - Options for request
|
|
876
|
+
* @param { function } [callback] - Callback to handle list of records with metadata
|
|
877
|
+
*/
|
|
878
|
+
pageWithHttpInfo(callback?: (error: Error | null, items: ApiResponse<ConfigurationPage>) => any): Promise<ApiResponse<ConfigurationPage>>;
|
|
879
|
+
pageWithHttpInfo(params: ConfigurationListInstancePageOptions, callback?: (error: Error | null, items: ApiResponse<ConfigurationPage>) => any): Promise<ApiResponse<ConfigurationPage>>;
|
|
880
|
+
/**
|
|
881
|
+
* Provide a user-friendly representation
|
|
882
|
+
*/
|
|
883
|
+
toJSON(): any;
|
|
884
|
+
[inspect.custom](_depth: any, options: InspectOptions): any;
|
|
885
|
+
}
|
|
886
|
+
export declare function ConfigurationListInstance(version: V2): ConfigurationListInstance;
|
|
887
|
+
export declare class ConfigurationPage extends TokenPage<V2, ConfigurationPayload, ConfigurationResource, ConfigurationInstance> {
|
|
888
|
+
/**
|
|
889
|
+
* Initialize the ConfigurationPage
|
|
890
|
+
*
|
|
891
|
+
* @param version - Version of the resource
|
|
892
|
+
* @param response - Response from the API
|
|
893
|
+
* @param uri - URI of the resource
|
|
894
|
+
* @param params - Query parameters
|
|
895
|
+
* @param solution - Path solution
|
|
896
|
+
*/
|
|
897
|
+
constructor(version: V2, response: Response<string>, uri: string, params: any, solution: ConfigurationSolution);
|
|
898
|
+
/**
|
|
899
|
+
* Build an instance of ConfigurationInstance
|
|
900
|
+
*
|
|
901
|
+
* @param payload - Payload response from the API
|
|
902
|
+
*/
|
|
903
|
+
getInstance(payload: ConfigurationResource): ConfigurationInstance;
|
|
904
|
+
[inspect.custom](depth: any, options: InspectOptions): string;
|
|
905
|
+
}
|
|
906
|
+
export {};
|