@wildix/xbees-kite-client 1.0.15 → 1.0.18
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/dist-cjs/Kite.js +18 -0
- package/dist-cjs/KiteClient.js +4 -5
- package/dist-cjs/commands/GetSmsNumberConfigurationCommand.js +21 -0
- package/dist-cjs/commands/GetWhatsAppNumberConfigurationCommand.js +21 -0
- package/dist-cjs/commands/ListSmsConfigurationsCommand.js +21 -0
- package/dist-cjs/commands/ListSmsNumbersCommand.js +21 -0
- package/dist-cjs/commands/ListWhatsAppConfigurationsCommand.js +21 -0
- package/dist-cjs/commands/ListWhatsAppNumbersCommand.js +21 -0
- package/dist-cjs/commands/ListWhatsAppTemplatesCommand.js +21 -0
- package/dist-cjs/commands/PutSmsNumberConfigurationCommand.js +21 -0
- package/dist-cjs/commands/PutWhatsAppNumberConfigurationCommand.js +21 -0
- package/dist-cjs/commands/index.js +9 -0
- package/dist-cjs/models/models_0.js +113 -22
- package/dist-cjs/protocols/Aws_restJson1.js +347 -76
- package/dist-cjs/runtimeConfig.browser.js +1 -1
- package/dist-cjs/runtimeConfig.js +4 -3
- package/dist-cjs/runtimeExtensions.js +2 -10
- package/dist-es/Kite.js +18 -0
- package/dist-es/KiteClient.js +4 -5
- package/dist-es/commands/GetSmsNumberConfigurationCommand.js +17 -0
- package/dist-es/commands/GetWhatsAppNumberConfigurationCommand.js +17 -0
- package/dist-es/commands/ListSmsConfigurationsCommand.js +17 -0
- package/dist-es/commands/ListSmsNumbersCommand.js +17 -0
- package/dist-es/commands/ListWhatsAppConfigurationsCommand.js +17 -0
- package/dist-es/commands/ListWhatsAppNumbersCommand.js +17 -0
- package/dist-es/commands/ListWhatsAppTemplatesCommand.js +17 -0
- package/dist-es/commands/PutSmsNumberConfigurationCommand.js +17 -0
- package/dist-es/commands/PutWhatsAppNumberConfigurationCommand.js +17 -0
- package/dist-es/commands/index.js +9 -0
- package/dist-es/models/models_0.js +105 -15
- package/dist-es/protocols/Aws_restJson1.js +301 -48
- package/dist-es/runtimeConfig.browser.js +2 -2
- package/dist-es/runtimeConfig.js +5 -4
- package/dist-es/runtimeExtensions.js +2 -10
- package/dist-types/Kite.d.ts +67 -0
- package/dist-types/KiteClient.d.ts +11 -2
- package/dist-types/commands/CancelCalendarEventCommand.d.ts +17 -0
- package/dist-types/commands/CreateOrUpdateWidgetPreviewCommand.d.ts +120 -0
- package/dist-types/commands/CreateWidgetCommand.d.ts +120 -0
- package/dist-types/commands/DeleteWidgetCommand.d.ts +14 -0
- package/dist-types/commands/GetCalendarSlotsCommand.d.ts +14 -0
- package/dist-types/commands/GetConfigCommand.d.ts +14 -0
- package/dist-types/commands/GetSmsNumberConfigurationCommand.d.ts +179 -0
- package/dist-types/commands/GetWhatsAppNumberConfigurationCommand.d.ts +179 -0
- package/dist-types/commands/GetWidgetCommand.d.ts +67 -0
- package/dist-types/commands/ListAgentsCommand.d.ts +14 -0
- package/dist-types/commands/ListServicesCommand.d.ts +14 -0
- package/dist-types/commands/ListSmsConfigurationsCommand.d.ts +180 -0
- package/dist-types/commands/ListSmsNumbersCommand.d.ts +82 -0
- package/dist-types/commands/ListWhatsAppConfigurationsCommand.d.ts +180 -0
- package/dist-types/commands/ListWhatsAppNumbersCommand.d.ts +82 -0
- package/dist-types/commands/ListWhatsAppTemplatesCommand.d.ts +118 -0
- package/dist-types/commands/ListWidgetsCommand.d.ts +67 -0
- package/dist-types/commands/PutSmsNumberConfigurationCommand.d.ts +272 -0
- package/dist-types/commands/PutWhatsAppNumberConfigurationCommand.d.ts +272 -0
- package/dist-types/commands/RescheduleCalendarEventCommand.d.ts +17 -0
- package/dist-types/commands/ScheduleCalendarEventCommand.d.ts +17 -0
- package/dist-types/commands/UpdateWidgetCommand.d.ts +120 -0
- package/dist-types/commands/index.d.ts +9 -0
- package/dist-types/models/models_0.d.ts +908 -165
- package/dist-types/protocols/Aws_restJson1.d.ts +81 -0
- package/dist-types/runtimeConfig.browser.d.ts +2 -1
- package/dist-types/runtimeConfig.d.ts +2 -1
- package/dist-types/runtimeConfig.native.d.ts +2 -1
- package/package.json +37 -33
|
@@ -1,5 +1,16 @@
|
|
|
1
1
|
import { KiteServiceException as __BaseException } from "./KiteServiceException";
|
|
2
2
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export declare class NotFoundException extends __BaseException {
|
|
7
|
+
readonly name: "NotFoundException";
|
|
8
|
+
readonly $fault: "client";
|
|
9
|
+
/**
|
|
10
|
+
* @internal
|
|
11
|
+
*/
|
|
12
|
+
constructor(opts: __ExceptionOptionType<NotFoundException, __BaseException>);
|
|
13
|
+
}
|
|
3
14
|
/**
|
|
4
15
|
* @public
|
|
5
16
|
*/
|
|
@@ -32,47 +43,176 @@ export declare class RateLimitExceededException extends __BaseException {
|
|
|
32
43
|
* Displays the applicable rate limits for the current request.
|
|
33
44
|
* @public
|
|
34
45
|
*/
|
|
35
|
-
rateLimit?: string;
|
|
46
|
+
rateLimit?: string | undefined;
|
|
36
47
|
/**
|
|
37
48
|
* Indicates how many requests a user can still make within the current time window.
|
|
38
49
|
* @public
|
|
39
50
|
*/
|
|
40
|
-
rateLimitRemaining?: number;
|
|
51
|
+
rateLimitRemaining?: number | undefined;
|
|
41
52
|
/**
|
|
42
53
|
* Shows the time in seconds until the rate limit resets.
|
|
43
54
|
* @public
|
|
44
55
|
*/
|
|
45
|
-
rateLimitReset?: number;
|
|
56
|
+
rateLimitReset?: number | undefined;
|
|
46
57
|
/**
|
|
47
58
|
* Displays how many seconds the user agent should wait before making a follow-up request.
|
|
48
59
|
* @public
|
|
49
60
|
*/
|
|
50
|
-
retryAfter?: number;
|
|
61
|
+
retryAfter?: number | undefined;
|
|
51
62
|
/**
|
|
52
63
|
* @internal
|
|
53
64
|
*/
|
|
54
65
|
constructor(opts: __ExceptionOptionType<RateLimitExceededException, __BaseException>);
|
|
55
66
|
}
|
|
67
|
+
/**
|
|
68
|
+
* @public
|
|
69
|
+
*/
|
|
70
|
+
export interface BodyTextNamedParam {
|
|
71
|
+
paramName: string;
|
|
72
|
+
example: string;
|
|
73
|
+
}
|
|
74
|
+
/**
|
|
75
|
+
* @public
|
|
76
|
+
* @enum
|
|
77
|
+
*/
|
|
78
|
+
export declare const ButtonType: {
|
|
79
|
+
readonly APP: "APP";
|
|
80
|
+
readonly CATALOG: "CATALOG";
|
|
81
|
+
readonly FLOW: "FLOW";
|
|
82
|
+
readonly MPM: "MPM";
|
|
83
|
+
readonly OTP: "OTP";
|
|
84
|
+
readonly PHONE_NUMBER: "PHONE_NUMBER";
|
|
85
|
+
readonly QUICK_REPLY: "QUICK_REPLY";
|
|
86
|
+
readonly URL: "URL";
|
|
87
|
+
readonly VOICE_CALL: "VOICE_CALL";
|
|
88
|
+
};
|
|
89
|
+
/**
|
|
90
|
+
* @public
|
|
91
|
+
*/
|
|
92
|
+
export type ButtonType = typeof ButtonType[keyof typeof ButtonType];
|
|
93
|
+
/**
|
|
94
|
+
* @public
|
|
95
|
+
*/
|
|
96
|
+
export interface Button {
|
|
97
|
+
type: ButtonType;
|
|
98
|
+
text: string;
|
|
99
|
+
flowId?: number | undefined;
|
|
100
|
+
flowAction?: string | undefined;
|
|
101
|
+
navigateScreen?: string | undefined;
|
|
102
|
+
}
|
|
103
|
+
/**
|
|
104
|
+
* @public
|
|
105
|
+
* @enum
|
|
106
|
+
*/
|
|
107
|
+
export declare const TemplateCategory: {
|
|
108
|
+
readonly AUTHENTICATION: "AUTHENTICATION";
|
|
109
|
+
readonly MARKETING: "MARKETING";
|
|
110
|
+
readonly UTILITY: "UTILITY";
|
|
111
|
+
};
|
|
112
|
+
/**
|
|
113
|
+
* @public
|
|
114
|
+
*/
|
|
115
|
+
export type TemplateCategory = typeof TemplateCategory[keyof typeof TemplateCategory];
|
|
116
|
+
/**
|
|
117
|
+
* @public
|
|
118
|
+
*/
|
|
119
|
+
export interface ComponentExample {
|
|
120
|
+
headerHandle?: (string)[] | undefined;
|
|
121
|
+
bodyTextNamedParams?: (BodyTextNamedParam)[] | undefined;
|
|
122
|
+
}
|
|
123
|
+
/**
|
|
124
|
+
* @public
|
|
125
|
+
* @enum
|
|
126
|
+
*/
|
|
127
|
+
export declare const ComponentFormat: {
|
|
128
|
+
readonly IMAGE: "IMAGE";
|
|
129
|
+
readonly TEXT: "TEXT";
|
|
130
|
+
};
|
|
131
|
+
/**
|
|
132
|
+
* @public
|
|
133
|
+
*/
|
|
134
|
+
export type ComponentFormat = typeof ComponentFormat[keyof typeof ComponentFormat];
|
|
135
|
+
/**
|
|
136
|
+
* @public
|
|
137
|
+
* @enum
|
|
138
|
+
*/
|
|
139
|
+
export declare const ComponentType: {
|
|
140
|
+
readonly BODY: "BODY";
|
|
141
|
+
readonly BUTTONS: "BUTTONS";
|
|
142
|
+
readonly FOOTER: "FOOTER";
|
|
143
|
+
readonly HEADER: "HEADER";
|
|
144
|
+
};
|
|
145
|
+
/**
|
|
146
|
+
* @public
|
|
147
|
+
*/
|
|
148
|
+
export type ComponentType = typeof ComponentType[keyof typeof ComponentType];
|
|
149
|
+
/**
|
|
150
|
+
* @public
|
|
151
|
+
*/
|
|
152
|
+
export interface Component {
|
|
153
|
+
type: ComponentType;
|
|
154
|
+
format: ComponentFormat;
|
|
155
|
+
text?: string | undefined;
|
|
156
|
+
example?: ComponentExample | undefined;
|
|
157
|
+
buttons?: (Button)[] | undefined;
|
|
158
|
+
}
|
|
159
|
+
/**
|
|
160
|
+
* @public
|
|
161
|
+
* @enum
|
|
162
|
+
*/
|
|
163
|
+
export declare const ParameterFormat: {
|
|
164
|
+
readonly NAMED: "NAMED";
|
|
165
|
+
};
|
|
166
|
+
/**
|
|
167
|
+
* @public
|
|
168
|
+
*/
|
|
169
|
+
export type ParameterFormat = typeof ParameterFormat[keyof typeof ParameterFormat];
|
|
170
|
+
/**
|
|
171
|
+
* @public
|
|
172
|
+
* @enum
|
|
173
|
+
*/
|
|
174
|
+
export declare const TemplateStatus: {
|
|
175
|
+
readonly APPROVED: "APPROVED";
|
|
176
|
+
readonly PAUSED: "PAUSED";
|
|
177
|
+
readonly REJECTED: "REJECTED";
|
|
178
|
+
};
|
|
179
|
+
/**
|
|
180
|
+
* @public
|
|
181
|
+
*/
|
|
182
|
+
export type TemplateStatus = typeof TemplateStatus[keyof typeof TemplateStatus];
|
|
183
|
+
/**
|
|
184
|
+
* @public
|
|
185
|
+
*/
|
|
186
|
+
export interface Template {
|
|
187
|
+
name: string;
|
|
188
|
+
parameterFormat: ParameterFormat;
|
|
189
|
+
components: (Component)[];
|
|
190
|
+
language: string;
|
|
191
|
+
status: TemplateStatus;
|
|
192
|
+
category: TemplateCategory;
|
|
193
|
+
subCategory?: string | undefined;
|
|
194
|
+
id: string;
|
|
195
|
+
}
|
|
56
196
|
/**
|
|
57
197
|
* @public
|
|
58
198
|
*/
|
|
59
199
|
export interface User {
|
|
60
200
|
id: string;
|
|
61
|
-
name?: string;
|
|
62
|
-
email?: string;
|
|
63
|
-
phone?: string;
|
|
64
|
-
picture?: string;
|
|
65
|
-
locale?: string;
|
|
66
|
-
timeZone?: string;
|
|
67
|
-
company?: string;
|
|
68
|
-
bot?: boolean;
|
|
69
|
-
pbxDomain?: string;
|
|
70
|
-
pbxPort?: string;
|
|
71
|
-
pbxExtension?: string;
|
|
72
|
-
pbxSerial?: string;
|
|
73
|
-
pbxUserId?: string;
|
|
74
|
-
createdAt?: string;
|
|
75
|
-
updatedAt?: string;
|
|
201
|
+
name?: string | undefined;
|
|
202
|
+
email?: string | undefined;
|
|
203
|
+
phone?: string | undefined;
|
|
204
|
+
picture?: string | undefined;
|
|
205
|
+
locale?: string | undefined;
|
|
206
|
+
timeZone?: string | undefined;
|
|
207
|
+
company?: string | undefined;
|
|
208
|
+
bot?: boolean | undefined;
|
|
209
|
+
pbxDomain?: string | undefined;
|
|
210
|
+
pbxPort?: string | undefined;
|
|
211
|
+
pbxExtension?: string | undefined;
|
|
212
|
+
pbxSerial?: string | undefined;
|
|
213
|
+
pbxUserId?: string | undefined;
|
|
214
|
+
createdAt?: string | undefined;
|
|
215
|
+
updatedAt?: string | undefined;
|
|
76
216
|
}
|
|
77
217
|
/**
|
|
78
218
|
* @public
|
|
@@ -90,29 +230,29 @@ export type ChannelType = typeof ChannelType[keyof typeof ChannelType];
|
|
|
90
230
|
* @public
|
|
91
231
|
*/
|
|
92
232
|
export interface CalendarSlot {
|
|
93
|
-
startTime?: string;
|
|
233
|
+
startTime?: string | undefined;
|
|
94
234
|
}
|
|
95
235
|
/**
|
|
96
236
|
* @public
|
|
97
237
|
*/
|
|
98
238
|
export interface CalendarDaySlots {
|
|
99
|
-
date?: string;
|
|
100
|
-
slots?: (CalendarSlot)[];
|
|
239
|
+
date?: string | undefined;
|
|
240
|
+
slots?: (CalendarSlot)[] | undefined;
|
|
101
241
|
}
|
|
102
242
|
/**
|
|
103
243
|
* @public
|
|
104
244
|
*/
|
|
105
245
|
export interface CalendarAvailabilitySettings {
|
|
106
|
-
duration?: (string)[];
|
|
246
|
+
duration?: (string)[] | undefined;
|
|
107
247
|
}
|
|
108
248
|
/**
|
|
109
249
|
* @public
|
|
110
250
|
*/
|
|
111
251
|
export interface CalendarAvailability {
|
|
112
|
-
days?: (CalendarDaySlots)[];
|
|
113
|
-
duration?: string;
|
|
114
|
-
timeZone?: string;
|
|
115
|
-
settings?: CalendarAvailabilitySettings;
|
|
252
|
+
days?: (CalendarDaySlots)[] | undefined;
|
|
253
|
+
duration?: string | undefined;
|
|
254
|
+
timeZone?: string | undefined;
|
|
255
|
+
settings?: CalendarAvailabilitySettings | undefined;
|
|
116
256
|
}
|
|
117
257
|
/**
|
|
118
258
|
* @public
|
|
@@ -134,7 +274,7 @@ export interface ButtonLinkHandler {
|
|
|
134
274
|
* @public
|
|
135
275
|
*/
|
|
136
276
|
export interface ButtonReplyHandler {
|
|
137
|
-
text?: string;
|
|
277
|
+
text?: string | undefined;
|
|
138
278
|
}
|
|
139
279
|
/**
|
|
140
280
|
* @public
|
|
@@ -197,8 +337,8 @@ export type ButtonVariant = typeof ButtonVariant[keyof typeof ButtonVariant];
|
|
|
197
337
|
export interface ButtonElement {
|
|
198
338
|
text: string;
|
|
199
339
|
handler: ButtonHandler;
|
|
200
|
-
variant?: ButtonVariant;
|
|
201
|
-
disabled?: boolean;
|
|
340
|
+
variant?: ButtonVariant | undefined;
|
|
341
|
+
disabled?: boolean | undefined;
|
|
202
342
|
}
|
|
203
343
|
/**
|
|
204
344
|
* @public
|
|
@@ -236,6 +376,29 @@ export declare class ChannelNotFoundException extends __BaseException {
|
|
|
236
376
|
*/
|
|
237
377
|
constructor(opts: __ExceptionOptionType<ChannelNotFoundException, __BaseException>);
|
|
238
378
|
}
|
|
379
|
+
/**
|
|
380
|
+
* @public
|
|
381
|
+
*/
|
|
382
|
+
export interface ServicePbx {
|
|
383
|
+
domain: string;
|
|
384
|
+
port: number;
|
|
385
|
+
}
|
|
386
|
+
/**
|
|
387
|
+
* @public
|
|
388
|
+
*/
|
|
389
|
+
export interface ServiceSettings {
|
|
390
|
+
}
|
|
391
|
+
/**
|
|
392
|
+
* @public
|
|
393
|
+
*/
|
|
394
|
+
export interface Service {
|
|
395
|
+
id: number;
|
|
396
|
+
uri: string;
|
|
397
|
+
title: string;
|
|
398
|
+
settings: ServiceSettings;
|
|
399
|
+
extensions: (string)[];
|
|
400
|
+
pbx: ServicePbx;
|
|
401
|
+
}
|
|
239
402
|
/**
|
|
240
403
|
* @public
|
|
241
404
|
* @enum
|
|
@@ -267,19 +430,29 @@ export type ChannelContextEventAttendeeStatus = typeof ChannelContextEventAttend
|
|
|
267
430
|
*/
|
|
268
431
|
export interface ChannelContextEventAttendee {
|
|
269
432
|
email: string;
|
|
270
|
-
name?: string;
|
|
433
|
+
name?: string | undefined;
|
|
271
434
|
status: ChannelContextEventAttendeeStatus;
|
|
272
435
|
}
|
|
273
436
|
/**
|
|
274
437
|
* @public
|
|
275
438
|
*/
|
|
276
439
|
export interface ChannelContextEvent {
|
|
277
|
-
id?: string;
|
|
278
|
-
owner?: string;
|
|
279
|
-
start?: string;
|
|
280
|
-
end?: string;
|
|
281
|
-
summary?: string;
|
|
282
|
-
attendees?: (ChannelContextEventAttendee)[];
|
|
440
|
+
id?: string | undefined;
|
|
441
|
+
owner?: string | undefined;
|
|
442
|
+
start?: string | undefined;
|
|
443
|
+
end?: string | undefined;
|
|
444
|
+
summary?: string | undefined;
|
|
445
|
+
attendees?: (ChannelContextEventAttendee)[] | undefined;
|
|
446
|
+
}
|
|
447
|
+
/**
|
|
448
|
+
* @public
|
|
449
|
+
*/
|
|
450
|
+
export interface ChannelContextPushToTalk {
|
|
451
|
+
/**
|
|
452
|
+
* A unique identifier of x-hoppers broadcast conference. If present x-hoppers application will use broadcast and push-to-talk functionality for the channel.
|
|
453
|
+
* @public
|
|
454
|
+
*/
|
|
455
|
+
broadcastId?: string | undefined;
|
|
283
456
|
}
|
|
284
457
|
/**
|
|
285
458
|
* @public
|
|
@@ -296,9 +469,10 @@ export type ChannelContextSource = typeof ChannelContextSource[keyof typeof Chan
|
|
|
296
469
|
* @public
|
|
297
470
|
*/
|
|
298
471
|
export interface ChannelContext {
|
|
299
|
-
source?: ChannelContextSource;
|
|
300
|
-
target?: string;
|
|
301
|
-
events?: (ChannelContextEvent)[];
|
|
472
|
+
source?: ChannelContextSource | undefined;
|
|
473
|
+
target?: string | undefined;
|
|
474
|
+
events?: (ChannelContextEvent)[] | undefined;
|
|
475
|
+
ptt?: ChannelContextPushToTalk | undefined;
|
|
302
476
|
}
|
|
303
477
|
/**
|
|
304
478
|
* @public
|
|
@@ -315,44 +489,44 @@ export type ChannelWhatsAppStatus = typeof ChannelWhatsAppStatus[keyof typeof Ch
|
|
|
315
489
|
* @public
|
|
316
490
|
*/
|
|
317
491
|
export interface Channel {
|
|
318
|
-
subject?: string;
|
|
319
|
-
description?: string;
|
|
492
|
+
subject?: string | undefined;
|
|
493
|
+
description?: string | undefined;
|
|
320
494
|
/**
|
|
321
495
|
* Picture URL
|
|
322
496
|
* @public
|
|
323
497
|
*/
|
|
324
|
-
picture?: string;
|
|
498
|
+
picture?: string | undefined;
|
|
325
499
|
/**
|
|
326
500
|
* Picture dominant color represented by a hex value.
|
|
327
501
|
* @public
|
|
328
502
|
*/
|
|
329
|
-
pictureColor?: string;
|
|
330
|
-
access?: ChannelAccess;
|
|
331
|
-
company?: string;
|
|
332
|
-
context?: ChannelContext;
|
|
333
|
-
kite?: boolean;
|
|
334
|
-
kiteTarget?: string;
|
|
335
|
-
kiteVariant?: string;
|
|
336
|
-
kiteAssign?: string;
|
|
337
|
-
kiteServiceName?: string;
|
|
338
|
-
kiteDefaultSubject?: string;
|
|
339
|
-
service?: string;
|
|
340
|
-
serviceTitle?: string;
|
|
341
|
-
serviceRecipient?: string;
|
|
342
|
-
assignee?: User;
|
|
343
|
-
telephony?: boolean;
|
|
344
|
-
sms?: boolean;
|
|
345
|
-
mms?: boolean;
|
|
346
|
-
whatsapp?: boolean;
|
|
347
|
-
whatsappStatus?: ChannelWhatsAppStatus;
|
|
348
|
-
broadcast?: boolean;
|
|
349
|
-
external?: boolean;
|
|
503
|
+
pictureColor?: string | undefined;
|
|
504
|
+
access?: ChannelAccess | undefined;
|
|
505
|
+
company?: string | undefined;
|
|
506
|
+
context?: ChannelContext | undefined;
|
|
507
|
+
kite?: boolean | undefined;
|
|
508
|
+
kiteTarget?: string | undefined;
|
|
509
|
+
kiteVariant?: string | undefined;
|
|
510
|
+
kiteAssign?: string | undefined;
|
|
511
|
+
kiteServiceName?: string | undefined;
|
|
512
|
+
kiteDefaultSubject?: string | undefined;
|
|
513
|
+
service?: string | undefined;
|
|
514
|
+
serviceTitle?: string | undefined;
|
|
515
|
+
serviceRecipient?: string | undefined;
|
|
516
|
+
assignee?: User | undefined;
|
|
517
|
+
telephony?: boolean | undefined;
|
|
518
|
+
sms?: boolean | undefined;
|
|
519
|
+
mms?: boolean | undefined;
|
|
520
|
+
whatsapp?: boolean | undefined;
|
|
521
|
+
whatsappStatus?: ChannelWhatsAppStatus | undefined;
|
|
522
|
+
broadcast?: boolean | undefined;
|
|
523
|
+
external?: boolean | undefined;
|
|
350
524
|
channelId: string;
|
|
351
525
|
channelType: ChannelType;
|
|
352
526
|
memberCount: number;
|
|
353
527
|
createdAt: string;
|
|
354
528
|
createdBy: string;
|
|
355
|
-
updatedAt?: string;
|
|
529
|
+
updatedAt?: string | undefined;
|
|
356
530
|
}
|
|
357
531
|
/**
|
|
358
532
|
* @public
|
|
@@ -394,12 +568,12 @@ export declare class TargetNotFoundException extends __BaseException {
|
|
|
394
568
|
* @public
|
|
395
569
|
*/
|
|
396
570
|
export interface CalendarEvent {
|
|
397
|
-
id?: string;
|
|
398
|
-
owner?: string;
|
|
399
|
-
start?: string;
|
|
400
|
-
end?: string;
|
|
401
|
-
summary?: string;
|
|
402
|
-
attendees?: (string)[];
|
|
571
|
+
id?: string | undefined;
|
|
572
|
+
owner?: string | undefined;
|
|
573
|
+
start?: string | undefined;
|
|
574
|
+
end?: string | undefined;
|
|
575
|
+
summary?: string | undefined;
|
|
576
|
+
attendees?: (string)[] | undefined;
|
|
403
577
|
}
|
|
404
578
|
/**
|
|
405
579
|
* @public
|
|
@@ -412,7 +586,7 @@ export interface CancelCalendarEventInput {
|
|
|
412
586
|
channelId: string;
|
|
413
587
|
eventId: string;
|
|
414
588
|
eventOwner: string;
|
|
415
|
-
reason?: string;
|
|
589
|
+
reason?: string | undefined;
|
|
416
590
|
}
|
|
417
591
|
/**
|
|
418
592
|
* @public
|
|
@@ -421,6 +595,129 @@ export interface CancelCalendarEventOutput {
|
|
|
421
595
|
channel: Channel;
|
|
422
596
|
event: CalendarEvent;
|
|
423
597
|
}
|
|
598
|
+
/**
|
|
599
|
+
* @public
|
|
600
|
+
*/
|
|
601
|
+
export interface RouteReadTimeoutCondition {
|
|
602
|
+
/**
|
|
603
|
+
* Timeout in seconds during which the message should not be read by the agent to meet the condition.
|
|
604
|
+
* @public
|
|
605
|
+
*/
|
|
606
|
+
timeout: number;
|
|
607
|
+
}
|
|
608
|
+
/**
|
|
609
|
+
* @public
|
|
610
|
+
*/
|
|
611
|
+
export interface RouteReplyTimeoutCondition {
|
|
612
|
+
/**
|
|
613
|
+
* The timeout in seconds during which the agent should not reply to the message in order to meet the condition.
|
|
614
|
+
* @public
|
|
615
|
+
*/
|
|
616
|
+
timeout: number;
|
|
617
|
+
}
|
|
618
|
+
/**
|
|
619
|
+
* @public
|
|
620
|
+
*/
|
|
621
|
+
export type RouteActionCondition = RouteActionCondition.ReadTimeoutMember | RouteActionCondition.ReplyTimeoutMember | RouteActionCondition.$UnknownMember;
|
|
622
|
+
/**
|
|
623
|
+
* @public
|
|
624
|
+
*/
|
|
625
|
+
export declare namespace RouteActionCondition {
|
|
626
|
+
interface ReplyTimeoutMember {
|
|
627
|
+
replyTimeout: RouteReplyTimeoutCondition;
|
|
628
|
+
readTimeout?: never;
|
|
629
|
+
$unknown?: never;
|
|
630
|
+
}
|
|
631
|
+
interface ReadTimeoutMember {
|
|
632
|
+
replyTimeout?: never;
|
|
633
|
+
readTimeout: RouteReadTimeoutCondition;
|
|
634
|
+
$unknown?: never;
|
|
635
|
+
}
|
|
636
|
+
/**
|
|
637
|
+
* @public
|
|
638
|
+
*/
|
|
639
|
+
interface $UnknownMember {
|
|
640
|
+
replyTimeout?: never;
|
|
641
|
+
readTimeout?: never;
|
|
642
|
+
$unknown: [string, any];
|
|
643
|
+
}
|
|
644
|
+
interface Visitor<T> {
|
|
645
|
+
replyTimeout: (value: RouteReplyTimeoutCondition) => T;
|
|
646
|
+
readTimeout: (value: RouteReadTimeoutCondition) => T;
|
|
647
|
+
_: (name: string, value: any) => T;
|
|
648
|
+
}
|
|
649
|
+
const visit: <T>(value: RouteActionCondition, visitor: Visitor<T>) => T;
|
|
650
|
+
}
|
|
651
|
+
/**
|
|
652
|
+
* @public
|
|
653
|
+
*/
|
|
654
|
+
export interface RouteAddMembersTask {
|
|
655
|
+
emails: (string)[];
|
|
656
|
+
}
|
|
657
|
+
/**
|
|
658
|
+
* @public
|
|
659
|
+
*/
|
|
660
|
+
export interface RouteSendMessageTask {
|
|
661
|
+
/**
|
|
662
|
+
* Identifier of the chatbot from whom the message will be sent.
|
|
663
|
+
* @public
|
|
664
|
+
*/
|
|
665
|
+
botId: string;
|
|
666
|
+
/**
|
|
667
|
+
* Static message that should be sent to the user.
|
|
668
|
+
* @public
|
|
669
|
+
*/
|
|
670
|
+
text: string;
|
|
671
|
+
}
|
|
672
|
+
/**
|
|
673
|
+
* @public
|
|
674
|
+
*/
|
|
675
|
+
export type RouteActionTask = RouteActionTask.AddMembersMember | RouteActionTask.SendMessageMember | RouteActionTask.$UnknownMember;
|
|
676
|
+
/**
|
|
677
|
+
* @public
|
|
678
|
+
*/
|
|
679
|
+
export declare namespace RouteActionTask {
|
|
680
|
+
interface SendMessageMember {
|
|
681
|
+
sendMessage: RouteSendMessageTask;
|
|
682
|
+
addMembers?: never;
|
|
683
|
+
$unknown?: never;
|
|
684
|
+
}
|
|
685
|
+
interface AddMembersMember {
|
|
686
|
+
sendMessage?: never;
|
|
687
|
+
addMembers: RouteAddMembersTask;
|
|
688
|
+
$unknown?: never;
|
|
689
|
+
}
|
|
690
|
+
/**
|
|
691
|
+
* @public
|
|
692
|
+
*/
|
|
693
|
+
interface $UnknownMember {
|
|
694
|
+
sendMessage?: never;
|
|
695
|
+
addMembers?: never;
|
|
696
|
+
$unknown: [string, any];
|
|
697
|
+
}
|
|
698
|
+
interface Visitor<T> {
|
|
699
|
+
sendMessage: (value: RouteSendMessageTask) => T;
|
|
700
|
+
addMembers: (value: RouteAddMembersTask) => T;
|
|
701
|
+
_: (name: string, value: any) => T;
|
|
702
|
+
}
|
|
703
|
+
const visit: <T>(value: RouteActionTask, visitor: Visitor<T>) => T;
|
|
704
|
+
}
|
|
705
|
+
/**
|
|
706
|
+
* @public
|
|
707
|
+
*/
|
|
708
|
+
export interface RouteAction {
|
|
709
|
+
id: string;
|
|
710
|
+
/**
|
|
711
|
+
* List of conditions that must match before making an action.
|
|
712
|
+
* @public
|
|
713
|
+
*/
|
|
714
|
+
conditions?: (RouteActionCondition)[] | undefined;
|
|
715
|
+
/**
|
|
716
|
+
* Task that must be performed once all conditions are met.
|
|
717
|
+
* @public
|
|
718
|
+
*/
|
|
719
|
+
task: RouteActionTask;
|
|
720
|
+
}
|
|
424
721
|
/**
|
|
425
722
|
* @public
|
|
426
723
|
*/
|
|
@@ -429,12 +726,12 @@ export interface WidgetPalleteSettings {
|
|
|
429
726
|
* The background color can be specified in hex format (#CCC or #FAFAFA), rgb format (rgb(22, 123, 200)), or rgba format (rgba(22, 123, 200, 1)).
|
|
430
727
|
* @public
|
|
431
728
|
*/
|
|
432
|
-
backgroundColor?: string;
|
|
729
|
+
backgroundColor?: string | undefined;
|
|
433
730
|
/**
|
|
434
731
|
* The accent color can be specified in hex format (#CCC or #FAFAFA), rgb format (rgb(22, 123, 200)), or rgba format (rgba(22, 123, 200, 1)).
|
|
435
732
|
* @public
|
|
436
733
|
*/
|
|
437
|
-
accentColor?: string;
|
|
734
|
+
accentColor?: string | undefined;
|
|
438
735
|
}
|
|
439
736
|
/**
|
|
440
737
|
* @public
|
|
@@ -444,22 +741,22 @@ export interface WidgetTextSettings {
|
|
|
444
741
|
* Text that will be visible to the user inside Send button (default: Start new conversation)
|
|
445
742
|
* @public
|
|
446
743
|
*/
|
|
447
|
-
button?: string;
|
|
744
|
+
button?: string | undefined;
|
|
448
745
|
/**
|
|
449
746
|
* Text that will be visible to the user below avatar (default: Support agent)
|
|
450
747
|
* @public
|
|
451
748
|
*/
|
|
452
|
-
title?: string;
|
|
749
|
+
title?: string | undefined;
|
|
453
750
|
/**
|
|
454
751
|
* Text that will be visible to the user in the header title (default: Hello)
|
|
455
752
|
* @public
|
|
456
753
|
*/
|
|
457
|
-
topTitle?: string;
|
|
754
|
+
topTitle?: string | undefined;
|
|
458
755
|
/**
|
|
459
756
|
* Text that will be visible to the user in the header subtitle (default: How can we help you?)
|
|
460
757
|
* @public
|
|
461
758
|
*/
|
|
462
|
-
topSubtitle?: string;
|
|
759
|
+
topSubtitle?: string | undefined;
|
|
463
760
|
}
|
|
464
761
|
/**
|
|
465
762
|
* @public
|
|
@@ -469,18 +766,18 @@ export interface WidgetAppearance {
|
|
|
469
766
|
* Configuration of the widget's color scheme settings.
|
|
470
767
|
* @public
|
|
471
768
|
*/
|
|
472
|
-
pallete?: WidgetPalleteSettings;
|
|
769
|
+
pallete?: WidgetPalleteSettings | undefined;
|
|
473
770
|
/**
|
|
474
771
|
* Configuration of the widget's text elements.
|
|
475
772
|
* @public
|
|
476
773
|
*/
|
|
477
|
-
text?: WidgetTextSettings;
|
|
774
|
+
text?: WidgetTextSettings | undefined;
|
|
478
775
|
}
|
|
479
776
|
/**
|
|
480
777
|
* @public
|
|
481
778
|
* @enum
|
|
482
779
|
*/
|
|
483
|
-
export declare const
|
|
780
|
+
export declare const RouteTimeFrameDay: {
|
|
484
781
|
readonly EVERY_DAY: "EVERY_DAY";
|
|
485
782
|
readonly FRIDAY: "FRIDAY";
|
|
486
783
|
readonly MONDAY: "MONDAY";
|
|
@@ -495,7 +792,7 @@ export declare const WidgetRouteTimeFrameDay: {
|
|
|
495
792
|
/**
|
|
496
793
|
* @public
|
|
497
794
|
*/
|
|
498
|
-
export type
|
|
795
|
+
export type RouteTimeFrameDay = typeof RouteTimeFrameDay[keyof typeof RouteTimeFrameDay];
|
|
499
796
|
/**
|
|
500
797
|
* @public
|
|
501
798
|
*/
|
|
@@ -509,7 +806,7 @@ export interface WidgetRouteTimeFrameRule {
|
|
|
509
806
|
* The day of the week or pattern when the rule applies.
|
|
510
807
|
* @public
|
|
511
808
|
*/
|
|
512
|
-
day:
|
|
809
|
+
day: RouteTimeFrameDay;
|
|
513
810
|
/**
|
|
514
811
|
* The minute of the day when the rule matches for the specified time zone (for example, 300 corresponds to 5AM)
|
|
515
812
|
* @public
|
|
@@ -628,13 +925,13 @@ export declare namespace WidgetTarget {
|
|
|
628
925
|
* @public
|
|
629
926
|
*/
|
|
630
927
|
export interface WidgetWelcomeMessage {
|
|
631
|
-
text?: string;
|
|
632
|
-
elements?: (Element)[];
|
|
928
|
+
text?: string | undefined;
|
|
929
|
+
elements?: (Element)[] | undefined;
|
|
633
930
|
/**
|
|
634
931
|
* The time in milliseconds until the message will be visible to the end user.
|
|
635
932
|
* @public
|
|
636
933
|
*/
|
|
637
|
-
delay?: number;
|
|
934
|
+
delay?: number | undefined;
|
|
638
935
|
}
|
|
639
936
|
/**
|
|
640
937
|
* @public
|
|
@@ -646,12 +943,17 @@ export interface WidgetRoute {
|
|
|
646
943
|
* A list of welcome messages that will be sent to the user when they first interact with the widget.
|
|
647
944
|
* @public
|
|
648
945
|
*/
|
|
649
|
-
welcomeMessages?: (WidgetWelcomeMessage)[];
|
|
946
|
+
welcomeMessages?: (WidgetWelcomeMessage)[] | undefined;
|
|
650
947
|
/**
|
|
651
948
|
* The target will be used if the specified route matches the specified rules. If no rules are matched, the default target of the widget will be used.
|
|
652
949
|
* @public
|
|
653
950
|
*/
|
|
654
951
|
target: WidgetTarget;
|
|
952
|
+
/**
|
|
953
|
+
* Actions that will be used if the specified route and the conditions within a specific action are met.
|
|
954
|
+
* @public
|
|
955
|
+
*/
|
|
956
|
+
actions?: (RouteAction)[] | undefined;
|
|
655
957
|
}
|
|
656
958
|
/**
|
|
657
959
|
* @public
|
|
@@ -661,28 +963,38 @@ export interface CreateOrUpdateWidgetPreviewInput {
|
|
|
661
963
|
* The appearance configuration allows you to customize colors and text settings.
|
|
662
964
|
* @public
|
|
663
965
|
*/
|
|
664
|
-
appearance?: WidgetAppearance;
|
|
966
|
+
appearance?: WidgetAppearance | undefined;
|
|
665
967
|
/**
|
|
666
968
|
* A list of routes that define different routing rules for the widget. Each route specifies a set of rules and a target to direct the interaction.
|
|
667
969
|
* @public
|
|
668
970
|
*/
|
|
669
|
-
routes?: (WidgetRoute)[];
|
|
971
|
+
routes?: (WidgetRoute)[] | undefined;
|
|
670
972
|
/**
|
|
671
973
|
* A list of welcome messages that will be sent to the user when they first interact with the widget.
|
|
672
974
|
* @public
|
|
673
975
|
*/
|
|
674
|
-
welcomeMessages?: (WidgetWelcomeMessage)[];
|
|
976
|
+
welcomeMessages?: (WidgetWelcomeMessage)[] | undefined;
|
|
675
977
|
name: string;
|
|
676
978
|
/**
|
|
677
979
|
* The primary target for the widget. This target is used if no route rules are matched. The target can be a service, an agent, or a bot, and it specifies where the widget directs its interactions.
|
|
678
980
|
* @public
|
|
679
981
|
*/
|
|
680
982
|
target: WidgetTarget;
|
|
983
|
+
/**
|
|
984
|
+
* Determines whether the conversation should be assigned to the specified target and rules even if initially conversation have different target. If set to true, assignment will occur regardless of previously defined target. Defaults to false.
|
|
985
|
+
* @public
|
|
986
|
+
*/
|
|
987
|
+
reassign?: boolean | undefined;
|
|
988
|
+
/**
|
|
989
|
+
* Actions that will be used if the specified route and the conditions within a specific action are met.
|
|
990
|
+
* @public
|
|
991
|
+
*/
|
|
992
|
+
actions?: (RouteAction)[] | undefined;
|
|
681
993
|
/**
|
|
682
994
|
* The unique identifier of the company when a service token is used.
|
|
683
995
|
* @public
|
|
684
996
|
*/
|
|
685
|
-
companyId?: string;
|
|
997
|
+
companyId?: string | undefined;
|
|
686
998
|
temporaryWidgetId: string;
|
|
687
999
|
}
|
|
688
1000
|
/**
|
|
@@ -693,27 +1005,37 @@ export interface Widget {
|
|
|
693
1005
|
* The appearance configuration allows you to customize colors and text settings.
|
|
694
1006
|
* @public
|
|
695
1007
|
*/
|
|
696
|
-
appearance?: WidgetAppearance;
|
|
1008
|
+
appearance?: WidgetAppearance | undefined;
|
|
697
1009
|
/**
|
|
698
1010
|
* A list of routes that define different routing rules for the widget. Each route specifies a set of rules and a target to direct the interaction.
|
|
699
1011
|
* @public
|
|
700
1012
|
*/
|
|
701
|
-
routes?: (WidgetRoute)[];
|
|
1013
|
+
routes?: (WidgetRoute)[] | undefined;
|
|
702
1014
|
/**
|
|
703
1015
|
* A list of welcome messages that will be sent to the user when they first interact with the widget.
|
|
704
1016
|
* @public
|
|
705
1017
|
*/
|
|
706
|
-
welcomeMessages?: (WidgetWelcomeMessage)[];
|
|
1018
|
+
welcomeMessages?: (WidgetWelcomeMessage)[] | undefined;
|
|
707
1019
|
name: string;
|
|
708
1020
|
/**
|
|
709
1021
|
* The primary target for the widget. This target is used if no route rules are matched. The target can be a service, an agent, or a bot, and it specifies where the widget directs its interactions.
|
|
710
1022
|
* @public
|
|
711
1023
|
*/
|
|
712
1024
|
target: WidgetTarget;
|
|
1025
|
+
/**
|
|
1026
|
+
* Determines whether the conversation should be assigned to the specified target and rules even if initially conversation have different target. If set to true, assignment will occur regardless of previously defined target. Defaults to false.
|
|
1027
|
+
* @public
|
|
1028
|
+
*/
|
|
1029
|
+
reassign?: boolean | undefined;
|
|
1030
|
+
/**
|
|
1031
|
+
* Actions that will be used if the specified route and the conditions within a specific action are met.
|
|
1032
|
+
* @public
|
|
1033
|
+
*/
|
|
1034
|
+
actions?: (RouteAction)[] | undefined;
|
|
713
1035
|
id: string;
|
|
714
1036
|
company: string;
|
|
715
1037
|
createdAt: string;
|
|
716
|
-
updatedAt?: string;
|
|
1038
|
+
updatedAt?: string | undefined;
|
|
717
1039
|
}
|
|
718
1040
|
/**
|
|
719
1041
|
* @public
|
|
@@ -729,28 +1051,38 @@ export interface CreateWidgetInput {
|
|
|
729
1051
|
* The appearance configuration allows you to customize colors and text settings.
|
|
730
1052
|
* @public
|
|
731
1053
|
*/
|
|
732
|
-
appearance?: WidgetAppearance;
|
|
1054
|
+
appearance?: WidgetAppearance | undefined;
|
|
733
1055
|
/**
|
|
734
1056
|
* A list of routes that define different routing rules for the widget. Each route specifies a set of rules and a target to direct the interaction.
|
|
735
1057
|
* @public
|
|
736
1058
|
*/
|
|
737
|
-
routes?: (WidgetRoute)[];
|
|
1059
|
+
routes?: (WidgetRoute)[] | undefined;
|
|
738
1060
|
/**
|
|
739
1061
|
* A list of welcome messages that will be sent to the user when they first interact with the widget.
|
|
740
1062
|
* @public
|
|
741
1063
|
*/
|
|
742
|
-
welcomeMessages?: (WidgetWelcomeMessage)[];
|
|
1064
|
+
welcomeMessages?: (WidgetWelcomeMessage)[] | undefined;
|
|
743
1065
|
name: string;
|
|
744
1066
|
/**
|
|
745
1067
|
* The primary target for the widget. This target is used if no route rules are matched. The target can be a service, an agent, or a bot, and it specifies where the widget directs its interactions.
|
|
746
1068
|
* @public
|
|
747
1069
|
*/
|
|
748
1070
|
target: WidgetTarget;
|
|
1071
|
+
/**
|
|
1072
|
+
* Determines whether the conversation should be assigned to the specified target and rules even if initially conversation have different target. If set to true, assignment will occur regardless of previously defined target. Defaults to false.
|
|
1073
|
+
* @public
|
|
1074
|
+
*/
|
|
1075
|
+
reassign?: boolean | undefined;
|
|
1076
|
+
/**
|
|
1077
|
+
* Actions that will be used if the specified route and the conditions within a specific action are met.
|
|
1078
|
+
* @public
|
|
1079
|
+
*/
|
|
1080
|
+
actions?: (RouteAction)[] | undefined;
|
|
749
1081
|
/**
|
|
750
1082
|
* The unique identifier of the company when a service token is used.
|
|
751
1083
|
* @public
|
|
752
1084
|
*/
|
|
753
|
-
companyId?: string;
|
|
1085
|
+
companyId?: string | undefined;
|
|
754
1086
|
}
|
|
755
1087
|
/**
|
|
756
1088
|
* @public
|
|
@@ -795,9 +1127,9 @@ export interface GetCalendarSlotsInput {
|
|
|
795
1127
|
targetId: string;
|
|
796
1128
|
from: string;
|
|
797
1129
|
till: string;
|
|
798
|
-
duration?: string;
|
|
1130
|
+
duration?: string | undefined;
|
|
799
1131
|
timeZone: string;
|
|
800
|
-
excluded?: string;
|
|
1132
|
+
excluded?: string | undefined;
|
|
801
1133
|
}
|
|
802
1134
|
/**
|
|
803
1135
|
* @public
|
|
@@ -818,7 +1150,7 @@ export interface GetConfigInput {
|
|
|
818
1150
|
* The unique identifier of the route for time-based configuration.
|
|
819
1151
|
* @public
|
|
820
1152
|
*/
|
|
821
|
-
targetRouteId?: string;
|
|
1153
|
+
targetRouteId?: string | undefined;
|
|
822
1154
|
}
|
|
823
1155
|
/**
|
|
824
1156
|
* @public
|
|
@@ -863,25 +1195,25 @@ export interface KiteConfig {
|
|
|
863
1195
|
* The unique identifier of the route for time-based configuration.
|
|
864
1196
|
* @public
|
|
865
1197
|
*/
|
|
866
|
-
targetRouteId?: string;
|
|
1198
|
+
targetRouteId?: string | undefined;
|
|
867
1199
|
targetVariant: KiteVariant;
|
|
868
|
-
targetService?: KiteTargetService;
|
|
1200
|
+
targetService?: KiteTargetService | undefined;
|
|
869
1201
|
agents: (User)[];
|
|
870
1202
|
/**
|
|
871
1203
|
* The appearance settings like color scheme or custom texts.
|
|
872
1204
|
* @public
|
|
873
1205
|
*/
|
|
874
|
-
appearance?: WidgetAppearance;
|
|
1206
|
+
appearance?: WidgetAppearance | undefined;
|
|
875
1207
|
/**
|
|
876
1208
|
* A list of welcome messages that should be visible to the user.
|
|
877
1209
|
* @public
|
|
878
1210
|
*/
|
|
879
|
-
welcomeMessages?: (WidgetWelcomeMessage)[];
|
|
1211
|
+
welcomeMessages?: (WidgetWelcomeMessage)[] | undefined;
|
|
880
1212
|
/**
|
|
881
1213
|
* A list of features that are supported.
|
|
882
1214
|
* @public
|
|
883
1215
|
*/
|
|
884
|
-
features?: (KiteFeatures)[];
|
|
1216
|
+
features?: (KiteFeatures)[] | undefined;
|
|
885
1217
|
}
|
|
886
1218
|
/**
|
|
887
1219
|
* @public
|
|
@@ -892,54 +1224,318 @@ export interface GetConfigOutput {
|
|
|
892
1224
|
/**
|
|
893
1225
|
* @public
|
|
894
1226
|
*/
|
|
895
|
-
export interface
|
|
1227
|
+
export interface GetSmsNumberConfigurationInput {
|
|
896
1228
|
/**
|
|
897
|
-
* The unique identifier of the
|
|
1229
|
+
* The unique identifier of the company when a service token is used.
|
|
898
1230
|
* @public
|
|
899
1231
|
*/
|
|
900
|
-
|
|
901
|
-
|
|
902
|
-
/**
|
|
903
|
-
* @public
|
|
904
|
-
*/
|
|
905
|
-
export interface GetWidgetOutput {
|
|
906
|
-
widget: Widget;
|
|
1232
|
+
companyId?: string | undefined;
|
|
1233
|
+
serviceNumber: string;
|
|
907
1234
|
}
|
|
908
1235
|
/**
|
|
909
1236
|
* @public
|
|
910
1237
|
*/
|
|
911
|
-
export
|
|
912
|
-
readonly name: "WidgetNotFoundException";
|
|
913
|
-
readonly $fault: "client";
|
|
1238
|
+
export interface RouteTimeFrameRule {
|
|
914
1239
|
/**
|
|
915
|
-
*
|
|
1240
|
+
* The IANA time zone name (e.g., 'America/Los_Angeles') specifying the time zone in which the rule applies.
|
|
1241
|
+
* @public
|
|
916
1242
|
*/
|
|
917
|
-
|
|
1243
|
+
timeZone: string;
|
|
1244
|
+
/**
|
|
1245
|
+
* The day of the week or pattern when the rule applies.
|
|
1246
|
+
* @public
|
|
1247
|
+
*/
|
|
1248
|
+
day: RouteTimeFrameDay;
|
|
1249
|
+
/**
|
|
1250
|
+
* The minute of the day when the rule matches for the specified time zone (for example, 300 corresponds to 5AM)
|
|
1251
|
+
* @public
|
|
1252
|
+
*/
|
|
1253
|
+
startMinute: number;
|
|
1254
|
+
/**
|
|
1255
|
+
* The minute of the day when the rule matches for the specified time zone (for example, 300 corresponds to 5AM)
|
|
1256
|
+
* @public
|
|
1257
|
+
*/
|
|
1258
|
+
endMinute: number;
|
|
918
1259
|
}
|
|
919
1260
|
/**
|
|
920
1261
|
* @public
|
|
921
1262
|
*/
|
|
922
|
-
export type
|
|
1263
|
+
export type RouteRule = RouteRule.TimeFrameMember | RouteRule.$UnknownMember;
|
|
923
1264
|
/**
|
|
924
1265
|
* @public
|
|
925
1266
|
*/
|
|
926
|
-
export declare namespace
|
|
927
|
-
|
|
928
|
-
|
|
929
|
-
* @public
|
|
930
|
-
*/
|
|
931
|
-
interface ServiceMember {
|
|
932
|
-
service: string;
|
|
933
|
-
extensions?: never;
|
|
934
|
-
emails?: never;
|
|
1267
|
+
export declare namespace RouteRule {
|
|
1268
|
+
interface TimeFrameMember {
|
|
1269
|
+
timeFrame: RouteTimeFrameRule;
|
|
935
1270
|
$unknown?: never;
|
|
936
1271
|
}
|
|
937
1272
|
/**
|
|
938
|
-
* A list of extensions that could be used inside Kite based conversation.
|
|
939
1273
|
* @public
|
|
940
1274
|
*/
|
|
941
|
-
interface
|
|
942
|
-
|
|
1275
|
+
interface $UnknownMember {
|
|
1276
|
+
timeFrame?: never;
|
|
1277
|
+
$unknown: [string, any];
|
|
1278
|
+
}
|
|
1279
|
+
interface Visitor<T> {
|
|
1280
|
+
timeFrame: (value: RouteTimeFrameRule) => T;
|
|
1281
|
+
_: (name: string, value: any) => T;
|
|
1282
|
+
}
|
|
1283
|
+
const visit: <T>(value: RouteRule, visitor: Visitor<T>) => T;
|
|
1284
|
+
}
|
|
1285
|
+
/**
|
|
1286
|
+
* @public
|
|
1287
|
+
*/
|
|
1288
|
+
export interface RouteAgentTarget {
|
|
1289
|
+
/**
|
|
1290
|
+
* An email of the user that registered on x-bees and account must be connected to the PBX.
|
|
1291
|
+
* @public
|
|
1292
|
+
*/
|
|
1293
|
+
email: string;
|
|
1294
|
+
}
|
|
1295
|
+
/**
|
|
1296
|
+
* @public
|
|
1297
|
+
*/
|
|
1298
|
+
export interface RouteBotTarget {
|
|
1299
|
+
/**
|
|
1300
|
+
* An ID of the bot.
|
|
1301
|
+
* @public
|
|
1302
|
+
*/
|
|
1303
|
+
id: string;
|
|
1304
|
+
}
|
|
1305
|
+
/**
|
|
1306
|
+
* @public
|
|
1307
|
+
*/
|
|
1308
|
+
export interface RouteServiceTarget {
|
|
1309
|
+
/**
|
|
1310
|
+
* An ID of the service. ID of the service equals the ID of the call group that available on the PBX.
|
|
1311
|
+
* @public
|
|
1312
|
+
*/
|
|
1313
|
+
id: number;
|
|
1314
|
+
/**
|
|
1315
|
+
* An URI of the service which includes ID, PBX domain and port (example - 1@example.wildixin.com:443
|
|
1316
|
+
* @public
|
|
1317
|
+
*/
|
|
1318
|
+
uri: string;
|
|
1319
|
+
}
|
|
1320
|
+
/**
|
|
1321
|
+
* @public
|
|
1322
|
+
*/
|
|
1323
|
+
export type RouteTarget = RouteTarget.AgentMember | RouteTarget.BotMember | RouteTarget.ServiceMember | RouteTarget.$UnknownMember;
|
|
1324
|
+
/**
|
|
1325
|
+
* @public
|
|
1326
|
+
*/
|
|
1327
|
+
export declare namespace RouteTarget {
|
|
1328
|
+
interface ServiceMember {
|
|
1329
|
+
service: RouteServiceTarget;
|
|
1330
|
+
agent?: never;
|
|
1331
|
+
bot?: never;
|
|
1332
|
+
$unknown?: never;
|
|
1333
|
+
}
|
|
1334
|
+
interface AgentMember {
|
|
1335
|
+
service?: never;
|
|
1336
|
+
agent: RouteAgentTarget;
|
|
1337
|
+
bot?: never;
|
|
1338
|
+
$unknown?: never;
|
|
1339
|
+
}
|
|
1340
|
+
interface BotMember {
|
|
1341
|
+
service?: never;
|
|
1342
|
+
agent?: never;
|
|
1343
|
+
bot: RouteBotTarget;
|
|
1344
|
+
$unknown?: never;
|
|
1345
|
+
}
|
|
1346
|
+
/**
|
|
1347
|
+
* @public
|
|
1348
|
+
*/
|
|
1349
|
+
interface $UnknownMember {
|
|
1350
|
+
service?: never;
|
|
1351
|
+
agent?: never;
|
|
1352
|
+
bot?: never;
|
|
1353
|
+
$unknown: [string, any];
|
|
1354
|
+
}
|
|
1355
|
+
interface Visitor<T> {
|
|
1356
|
+
service: (value: RouteServiceTarget) => T;
|
|
1357
|
+
agent: (value: RouteAgentTarget) => T;
|
|
1358
|
+
bot: (value: RouteBotTarget) => T;
|
|
1359
|
+
_: (name: string, value: any) => T;
|
|
1360
|
+
}
|
|
1361
|
+
const visit: <T>(value: RouteTarget, visitor: Visitor<T>) => T;
|
|
1362
|
+
}
|
|
1363
|
+
/**
|
|
1364
|
+
* @public
|
|
1365
|
+
*/
|
|
1366
|
+
export interface SmsConfigRoute {
|
|
1367
|
+
id: string;
|
|
1368
|
+
rules: (RouteRule)[];
|
|
1369
|
+
/**
|
|
1370
|
+
* The target will be used if the specified route matches the specified rules. If no rules are matched, the default target of the widget will be used.
|
|
1371
|
+
* @public
|
|
1372
|
+
*/
|
|
1373
|
+
target: RouteTarget;
|
|
1374
|
+
/**
|
|
1375
|
+
* Actions that will be used if the specified route and the conditions within a specific action are met.
|
|
1376
|
+
* @public
|
|
1377
|
+
*/
|
|
1378
|
+
actions?: (RouteAction)[] | undefined;
|
|
1379
|
+
}
|
|
1380
|
+
/**
|
|
1381
|
+
* @public
|
|
1382
|
+
*/
|
|
1383
|
+
export interface SmsConfig {
|
|
1384
|
+
/**
|
|
1385
|
+
* An URI of the service which includes ID, PBX domain and port (example - 1@example.wildixin.com:443). The speicifed service is used during conversation creation which means that conversation can be linked to the same service as for phone calls.
|
|
1386
|
+
* @public
|
|
1387
|
+
*/
|
|
1388
|
+
serviceUri: string;
|
|
1389
|
+
/**
|
|
1390
|
+
* A list of routes that define different routing rules for the widget. Each route specifies a set of rules and a target to direct the interaction.
|
|
1391
|
+
* @public
|
|
1392
|
+
*/
|
|
1393
|
+
routes?: (SmsConfigRoute)[] | undefined;
|
|
1394
|
+
/**
|
|
1395
|
+
* The primary target for the widget. This target is used if no route rules are matched. The target can be a service, an agent, or a bot, and it specifies where the widget directs its interactions.
|
|
1396
|
+
* @public
|
|
1397
|
+
*/
|
|
1398
|
+
target: RouteTarget;
|
|
1399
|
+
/**
|
|
1400
|
+
* Determines whether the conversation should be assigned to the specified target and rules even if initially conversation have different target. If set to true, assignment will occur regardless of previously defined target. Defaults to false.
|
|
1401
|
+
* @public
|
|
1402
|
+
*/
|
|
1403
|
+
reassign?: boolean | undefined;
|
|
1404
|
+
/**
|
|
1405
|
+
* Actions that will be used if the specified route and the conditions within a specific action are met.
|
|
1406
|
+
* @public
|
|
1407
|
+
*/
|
|
1408
|
+
actions?: (RouteAction)[] | undefined;
|
|
1409
|
+
companyId: string;
|
|
1410
|
+
serviceNumber: string;
|
|
1411
|
+
createdAt: string;
|
|
1412
|
+
updatedAt?: string | undefined;
|
|
1413
|
+
}
|
|
1414
|
+
/**
|
|
1415
|
+
* @public
|
|
1416
|
+
*/
|
|
1417
|
+
export interface GetSmsNumberConfigurationOutput {
|
|
1418
|
+
configuration: SmsConfig;
|
|
1419
|
+
}
|
|
1420
|
+
/**
|
|
1421
|
+
* @public
|
|
1422
|
+
*/
|
|
1423
|
+
export interface GetWhatsAppNumberConfigurationInput {
|
|
1424
|
+
/**
|
|
1425
|
+
* The unique identifier of the company when a service token is used.
|
|
1426
|
+
* @public
|
|
1427
|
+
*/
|
|
1428
|
+
companyId?: string | undefined;
|
|
1429
|
+
serviceNumber: string;
|
|
1430
|
+
}
|
|
1431
|
+
/**
|
|
1432
|
+
* @public
|
|
1433
|
+
*/
|
|
1434
|
+
export interface WhatsAppConfigRoute {
|
|
1435
|
+
id: string;
|
|
1436
|
+
rules: (RouteRule)[];
|
|
1437
|
+
/**
|
|
1438
|
+
* The target will be used if the specified route matches the specified rules. If no rules are matched, the default target of the widget will be used.
|
|
1439
|
+
* @public
|
|
1440
|
+
*/
|
|
1441
|
+
target: RouteTarget;
|
|
1442
|
+
/**
|
|
1443
|
+
* Determines whether the conversation should be assigned to the specified target and rules even if initially conversation have different target. If set to true, assignment will occur regardless of previously defined target. Defaults to false.
|
|
1444
|
+
* @public
|
|
1445
|
+
*/
|
|
1446
|
+
reassign?: boolean | undefined;
|
|
1447
|
+
/**
|
|
1448
|
+
* Actions that will be used if the specified route and the conditions within a specific action are met.
|
|
1449
|
+
* @public
|
|
1450
|
+
*/
|
|
1451
|
+
actions?: (RouteAction)[] | undefined;
|
|
1452
|
+
}
|
|
1453
|
+
/**
|
|
1454
|
+
* @public
|
|
1455
|
+
*/
|
|
1456
|
+
export interface WhatsAppConfig {
|
|
1457
|
+
/**
|
|
1458
|
+
* An URI of the service which includes ID, PBX domain and port (example - 1@example.wildixin.com:443). The speicifed service is used during conversation creation which means that conversation can be linked to the same service as for phone calls.
|
|
1459
|
+
* @public
|
|
1460
|
+
*/
|
|
1461
|
+
serviceUri: string;
|
|
1462
|
+
/**
|
|
1463
|
+
* A list of routes that define different routing rules for the widget. Each route specifies a set of rules and a target to direct the interaction.
|
|
1464
|
+
* @public
|
|
1465
|
+
*/
|
|
1466
|
+
routes?: (WhatsAppConfigRoute)[] | undefined;
|
|
1467
|
+
/**
|
|
1468
|
+
* The primary target for the widget. This target is used if no route rules are matched. The target can be a service, an agent, or a bot, and it specifies where the widget directs its interactions.
|
|
1469
|
+
* @public
|
|
1470
|
+
*/
|
|
1471
|
+
target: RouteTarget;
|
|
1472
|
+
/**
|
|
1473
|
+
* Actions that will be used if the specified route and the conditions within a specific action are met.
|
|
1474
|
+
* @public
|
|
1475
|
+
*/
|
|
1476
|
+
actions?: (RouteAction)[] | undefined;
|
|
1477
|
+
companyId: string;
|
|
1478
|
+
serviceNumber: string;
|
|
1479
|
+
createdAt: string;
|
|
1480
|
+
updatedAt?: string | undefined;
|
|
1481
|
+
}
|
|
1482
|
+
/**
|
|
1483
|
+
* @public
|
|
1484
|
+
*/
|
|
1485
|
+
export interface GetWhatsAppNumberConfigurationOutput {
|
|
1486
|
+
configuration: WhatsAppConfig;
|
|
1487
|
+
}
|
|
1488
|
+
/**
|
|
1489
|
+
* @public
|
|
1490
|
+
*/
|
|
1491
|
+
export interface GetWidgetInput {
|
|
1492
|
+
/**
|
|
1493
|
+
* The unique identifier of the widget.
|
|
1494
|
+
* @public
|
|
1495
|
+
*/
|
|
1496
|
+
widgetId: string;
|
|
1497
|
+
}
|
|
1498
|
+
/**
|
|
1499
|
+
* @public
|
|
1500
|
+
*/
|
|
1501
|
+
export interface GetWidgetOutput {
|
|
1502
|
+
widget: Widget;
|
|
1503
|
+
}
|
|
1504
|
+
/**
|
|
1505
|
+
* @public
|
|
1506
|
+
*/
|
|
1507
|
+
export declare class WidgetNotFoundException extends __BaseException {
|
|
1508
|
+
readonly name: "WidgetNotFoundException";
|
|
1509
|
+
readonly $fault: "client";
|
|
1510
|
+
/**
|
|
1511
|
+
* @internal
|
|
1512
|
+
*/
|
|
1513
|
+
constructor(opts: __ExceptionOptionType<WidgetNotFoundException, __BaseException>);
|
|
1514
|
+
}
|
|
1515
|
+
/**
|
|
1516
|
+
* @public
|
|
1517
|
+
*/
|
|
1518
|
+
export type ListAgentsFilter = ListAgentsFilter.EmailsMember | ListAgentsFilter.ExtensionsMember | ListAgentsFilter.ServiceMember | ListAgentsFilter.$UnknownMember;
|
|
1519
|
+
/**
|
|
1520
|
+
* @public
|
|
1521
|
+
*/
|
|
1522
|
+
export declare namespace ListAgentsFilter {
|
|
1523
|
+
/**
|
|
1524
|
+
* The unique identifier of the service which represent URI (example - 2@example.wildixin.com:443).
|
|
1525
|
+
* @public
|
|
1526
|
+
*/
|
|
1527
|
+
interface ServiceMember {
|
|
1528
|
+
service: string;
|
|
1529
|
+
extensions?: never;
|
|
1530
|
+
emails?: never;
|
|
1531
|
+
$unknown?: never;
|
|
1532
|
+
}
|
|
1533
|
+
/**
|
|
1534
|
+
* A list of extensions that could be used inside Kite based conversation.
|
|
1535
|
+
* @public
|
|
1536
|
+
*/
|
|
1537
|
+
interface ExtensionsMember {
|
|
1538
|
+
service?: never;
|
|
943
1539
|
extensions: (string)[];
|
|
944
1540
|
emails?: never;
|
|
945
1541
|
$unknown?: never;
|
|
@@ -979,7 +1575,7 @@ export interface ListAgentsInput {
|
|
|
979
1575
|
* The unique identifier of the organization when a service token is used.
|
|
980
1576
|
* @public
|
|
981
1577
|
*/
|
|
982
|
-
companyId?: string;
|
|
1578
|
+
companyId?: string | undefined;
|
|
983
1579
|
/**
|
|
984
1580
|
* The filter to be used to query agents.
|
|
985
1581
|
* @public
|
|
@@ -1000,36 +1596,94 @@ export interface ListServicesInput {
|
|
|
1000
1596
|
* The unique identifier of the organization when a service token is used.
|
|
1001
1597
|
* @public
|
|
1002
1598
|
*/
|
|
1003
|
-
companyId?: string;
|
|
1599
|
+
companyId?: string | undefined;
|
|
1004
1600
|
}
|
|
1005
1601
|
/**
|
|
1006
1602
|
* @public
|
|
1007
1603
|
*/
|
|
1008
|
-
export interface
|
|
1009
|
-
|
|
1010
|
-
port: number;
|
|
1604
|
+
export interface ListServicesOutput {
|
|
1605
|
+
services: (Service)[];
|
|
1011
1606
|
}
|
|
1012
1607
|
/**
|
|
1013
1608
|
* @public
|
|
1014
1609
|
*/
|
|
1015
|
-
export interface
|
|
1610
|
+
export interface ListSmsConfigurationsInput {
|
|
1611
|
+
/**
|
|
1612
|
+
* The unique identifier of the company when a service token is used.
|
|
1613
|
+
* @public
|
|
1614
|
+
*/
|
|
1615
|
+
companyId?: string | undefined;
|
|
1016
1616
|
}
|
|
1017
1617
|
/**
|
|
1018
1618
|
* @public
|
|
1019
1619
|
*/
|
|
1020
|
-
export interface
|
|
1021
|
-
|
|
1022
|
-
uri: string;
|
|
1023
|
-
title: string;
|
|
1024
|
-
settings: ServiceSettings;
|
|
1025
|
-
extensions: (string)[];
|
|
1026
|
-
pbx: ServicePbx;
|
|
1620
|
+
export interface ListSmsConfigurationsOutput {
|
|
1621
|
+
configurations: (SmsConfig)[];
|
|
1027
1622
|
}
|
|
1028
1623
|
/**
|
|
1029
1624
|
* @public
|
|
1030
1625
|
*/
|
|
1031
|
-
export interface
|
|
1032
|
-
|
|
1626
|
+
export interface ListSmsNumbersInput {
|
|
1627
|
+
/**
|
|
1628
|
+
* The unique identifier of the company when a service token is used.
|
|
1629
|
+
* @public
|
|
1630
|
+
*/
|
|
1631
|
+
companyId?: string | undefined;
|
|
1632
|
+
}
|
|
1633
|
+
/**
|
|
1634
|
+
* @public
|
|
1635
|
+
*/
|
|
1636
|
+
export interface ListSmsNumbersOutput {
|
|
1637
|
+
numbers: (string)[];
|
|
1638
|
+
}
|
|
1639
|
+
/**
|
|
1640
|
+
* @public
|
|
1641
|
+
*/
|
|
1642
|
+
export interface ListWhatsAppConfigurationsInput {
|
|
1643
|
+
/**
|
|
1644
|
+
* The unique identifier of the company when a service token is used.
|
|
1645
|
+
* @public
|
|
1646
|
+
*/
|
|
1647
|
+
companyId?: string | undefined;
|
|
1648
|
+
}
|
|
1649
|
+
/**
|
|
1650
|
+
* @public
|
|
1651
|
+
*/
|
|
1652
|
+
export interface ListWhatsAppConfigurationsOutput {
|
|
1653
|
+
configurations: (WhatsAppConfig)[];
|
|
1654
|
+
}
|
|
1655
|
+
/**
|
|
1656
|
+
* @public
|
|
1657
|
+
*/
|
|
1658
|
+
export interface ListWhatsAppNumbersInput {
|
|
1659
|
+
/**
|
|
1660
|
+
* The unique identifier of the company when a service token is used.
|
|
1661
|
+
* @public
|
|
1662
|
+
*/
|
|
1663
|
+
companyId?: string | undefined;
|
|
1664
|
+
}
|
|
1665
|
+
/**
|
|
1666
|
+
* @public
|
|
1667
|
+
*/
|
|
1668
|
+
export interface ListWhatsAppNumbersOutput {
|
|
1669
|
+
numbers: (string)[];
|
|
1670
|
+
}
|
|
1671
|
+
/**
|
|
1672
|
+
* @public
|
|
1673
|
+
*/
|
|
1674
|
+
export interface ListWhatsAppTemplatesInput {
|
|
1675
|
+
/**
|
|
1676
|
+
* The unique identifier of the company when a service token is used.
|
|
1677
|
+
* @public
|
|
1678
|
+
*/
|
|
1679
|
+
companyId?: string | undefined;
|
|
1680
|
+
serviceNumber: string;
|
|
1681
|
+
}
|
|
1682
|
+
/**
|
|
1683
|
+
* @public
|
|
1684
|
+
*/
|
|
1685
|
+
export interface ListWhatsAppTemplatesOutput {
|
|
1686
|
+
templates: (Template)[];
|
|
1033
1687
|
}
|
|
1034
1688
|
/**
|
|
1035
1689
|
* @public
|
|
@@ -1039,7 +1693,7 @@ export interface ListWidgetsInput {
|
|
|
1039
1693
|
* The unique identifier of the company when a service token is used.
|
|
1040
1694
|
* @public
|
|
1041
1695
|
*/
|
|
1042
|
-
companyId?: string;
|
|
1696
|
+
companyId?: string | undefined;
|
|
1043
1697
|
}
|
|
1044
1698
|
/**
|
|
1045
1699
|
* @public
|
|
@@ -1047,6 +1701,85 @@ export interface ListWidgetsInput {
|
|
|
1047
1701
|
export interface ListWidgetsOutput {
|
|
1048
1702
|
widgets: (Widget)[];
|
|
1049
1703
|
}
|
|
1704
|
+
/**
|
|
1705
|
+
* @public
|
|
1706
|
+
*/
|
|
1707
|
+
export interface PutSmsNumberConfigurationInput {
|
|
1708
|
+
/**
|
|
1709
|
+
* An URI of the service which includes ID, PBX domain and port (example - 1@example.wildixin.com:443). The speicifed service is used during conversation creation which means that conversation can be linked to the same service as for phone calls.
|
|
1710
|
+
* @public
|
|
1711
|
+
*/
|
|
1712
|
+
serviceUri: string;
|
|
1713
|
+
/**
|
|
1714
|
+
* A list of routes that define different routing rules for the widget. Each route specifies a set of rules and a target to direct the interaction.
|
|
1715
|
+
* @public
|
|
1716
|
+
*/
|
|
1717
|
+
routes?: (SmsConfigRoute)[] | undefined;
|
|
1718
|
+
/**
|
|
1719
|
+
* The primary target for the widget. This target is used if no route rules are matched. The target can be a service, an agent, or a bot, and it specifies where the widget directs its interactions.
|
|
1720
|
+
* @public
|
|
1721
|
+
*/
|
|
1722
|
+
target: RouteTarget;
|
|
1723
|
+
/**
|
|
1724
|
+
* Determines whether the conversation should be assigned to the specified target and rules even if initially conversation have different target. If set to true, assignment will occur regardless of previously defined target. Defaults to false.
|
|
1725
|
+
* @public
|
|
1726
|
+
*/
|
|
1727
|
+
reassign?: boolean | undefined;
|
|
1728
|
+
/**
|
|
1729
|
+
* Actions that will be used if the specified route and the conditions within a specific action are met.
|
|
1730
|
+
* @public
|
|
1731
|
+
*/
|
|
1732
|
+
actions?: (RouteAction)[] | undefined;
|
|
1733
|
+
/**
|
|
1734
|
+
* The unique identifier of the company when a service token is used.
|
|
1735
|
+
* @public
|
|
1736
|
+
*/
|
|
1737
|
+
companyId?: string | undefined;
|
|
1738
|
+
serviceNumber: string;
|
|
1739
|
+
}
|
|
1740
|
+
/**
|
|
1741
|
+
* @public
|
|
1742
|
+
*/
|
|
1743
|
+
export interface PutSmsNumberConfigurationOutput {
|
|
1744
|
+
configuration: SmsConfig;
|
|
1745
|
+
}
|
|
1746
|
+
/**
|
|
1747
|
+
* @public
|
|
1748
|
+
*/
|
|
1749
|
+
export interface PutWhatsAppNumberConfigurationInput {
|
|
1750
|
+
/**
|
|
1751
|
+
* An URI of the service which includes ID, PBX domain and port (example - 1@example.wildixin.com:443). The speicifed service is used during conversation creation which means that conversation can be linked to the same service as for phone calls.
|
|
1752
|
+
* @public
|
|
1753
|
+
*/
|
|
1754
|
+
serviceUri: string;
|
|
1755
|
+
/**
|
|
1756
|
+
* A list of routes that define different routing rules for the widget. Each route specifies a set of rules and a target to direct the interaction.
|
|
1757
|
+
* @public
|
|
1758
|
+
*/
|
|
1759
|
+
routes?: (WhatsAppConfigRoute)[] | undefined;
|
|
1760
|
+
/**
|
|
1761
|
+
* The primary target for the widget. This target is used if no route rules are matched. The target can be a service, an agent, or a bot, and it specifies where the widget directs its interactions.
|
|
1762
|
+
* @public
|
|
1763
|
+
*/
|
|
1764
|
+
target: RouteTarget;
|
|
1765
|
+
/**
|
|
1766
|
+
* Actions that will be used if the specified route and the conditions within a specific action are met.
|
|
1767
|
+
* @public
|
|
1768
|
+
*/
|
|
1769
|
+
actions?: (RouteAction)[] | undefined;
|
|
1770
|
+
/**
|
|
1771
|
+
* The unique identifier of the company when a service token is used.
|
|
1772
|
+
* @public
|
|
1773
|
+
*/
|
|
1774
|
+
companyId?: string | undefined;
|
|
1775
|
+
serviceNumber: string;
|
|
1776
|
+
}
|
|
1777
|
+
/**
|
|
1778
|
+
* @public
|
|
1779
|
+
*/
|
|
1780
|
+
export interface PutWhatsAppNumberConfigurationOutput {
|
|
1781
|
+
configuration: WhatsAppConfig;
|
|
1782
|
+
}
|
|
1050
1783
|
/**
|
|
1051
1784
|
* @public
|
|
1052
1785
|
*/
|
|
@@ -1058,16 +1791,16 @@ export interface RescheduleCalendarEventInput {
|
|
|
1058
1791
|
channelId: string;
|
|
1059
1792
|
eventId: string;
|
|
1060
1793
|
eventOwner: string;
|
|
1061
|
-
start?: string;
|
|
1062
|
-
duration?: string;
|
|
1063
|
-
reason?: string;
|
|
1794
|
+
start?: string | undefined;
|
|
1795
|
+
duration?: string | undefined;
|
|
1796
|
+
reason?: string | undefined;
|
|
1064
1797
|
/**
|
|
1065
1798
|
* Event title
|
|
1066
1799
|
* @public
|
|
1067
1800
|
*/
|
|
1068
|
-
summary?: string;
|
|
1069
|
-
attendees?: (string)[];
|
|
1070
|
-
changed?: (string)[];
|
|
1801
|
+
summary?: string | undefined;
|
|
1802
|
+
attendees?: (string)[] | undefined;
|
|
1803
|
+
changed?: (string)[] | undefined;
|
|
1071
1804
|
}
|
|
1072
1805
|
/**
|
|
1073
1806
|
* @public
|
|
@@ -1085,17 +1818,17 @@ export interface ScheduleCalendarEventInput {
|
|
|
1085
1818
|
* @public
|
|
1086
1819
|
*/
|
|
1087
1820
|
targetId: string;
|
|
1088
|
-
channelId?: string;
|
|
1821
|
+
channelId?: string | undefined;
|
|
1089
1822
|
start: string;
|
|
1090
1823
|
duration: string;
|
|
1091
|
-
attendees?: (string)[];
|
|
1824
|
+
attendees?: (string)[] | undefined;
|
|
1092
1825
|
/**
|
|
1093
1826
|
* Event title
|
|
1094
1827
|
* @public
|
|
1095
1828
|
*/
|
|
1096
|
-
summary?: string;
|
|
1097
|
-
language?: string;
|
|
1098
|
-
timeZone?: string;
|
|
1829
|
+
summary?: string | undefined;
|
|
1830
|
+
language?: string | undefined;
|
|
1831
|
+
timeZone?: string | undefined;
|
|
1099
1832
|
}
|
|
1100
1833
|
/**
|
|
1101
1834
|
* @public
|
|
@@ -1112,28 +1845,38 @@ export interface UpdateWidgetInput {
|
|
|
1112
1845
|
* The appearance configuration allows you to customize colors and text settings.
|
|
1113
1846
|
* @public
|
|
1114
1847
|
*/
|
|
1115
|
-
appearance?: WidgetAppearance;
|
|
1848
|
+
appearance?: WidgetAppearance | undefined;
|
|
1116
1849
|
/**
|
|
1117
1850
|
* A list of routes that define different routing rules for the widget. Each route specifies a set of rules and a target to direct the interaction.
|
|
1118
1851
|
* @public
|
|
1119
1852
|
*/
|
|
1120
|
-
routes?: (WidgetRoute)[];
|
|
1853
|
+
routes?: (WidgetRoute)[] | undefined;
|
|
1121
1854
|
/**
|
|
1122
1855
|
* A list of welcome messages that will be sent to the user when they first interact with the widget.
|
|
1123
1856
|
* @public
|
|
1124
1857
|
*/
|
|
1125
|
-
welcomeMessages?: (WidgetWelcomeMessage)[];
|
|
1858
|
+
welcomeMessages?: (WidgetWelcomeMessage)[] | undefined;
|
|
1126
1859
|
name: string;
|
|
1127
1860
|
/**
|
|
1128
1861
|
* The primary target for the widget. This target is used if no route rules are matched. The target can be a service, an agent, or a bot, and it specifies where the widget directs its interactions.
|
|
1129
1862
|
* @public
|
|
1130
1863
|
*/
|
|
1131
1864
|
target: WidgetTarget;
|
|
1865
|
+
/**
|
|
1866
|
+
* Determines whether the conversation should be assigned to the specified target and rules even if initially conversation have different target. If set to true, assignment will occur regardless of previously defined target. Defaults to false.
|
|
1867
|
+
* @public
|
|
1868
|
+
*/
|
|
1869
|
+
reassign?: boolean | undefined;
|
|
1870
|
+
/**
|
|
1871
|
+
* Actions that will be used if the specified route and the conditions within a specific action are met.
|
|
1872
|
+
* @public
|
|
1873
|
+
*/
|
|
1874
|
+
actions?: (RouteAction)[] | undefined;
|
|
1132
1875
|
/**
|
|
1133
1876
|
* The unique identifier of the company when a service token is used.
|
|
1134
1877
|
* @public
|
|
1135
1878
|
*/
|
|
1136
|
-
companyId?: string;
|
|
1879
|
+
companyId?: string | undefined;
|
|
1137
1880
|
/**
|
|
1138
1881
|
* The unique identifier of the widget to be updated.
|
|
1139
1882
|
* @public
|