@wildix/xbees-kite-client 1.0.14 → 1.0.17
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 +20 -0
- package/dist-cjs/KiteClient.js +4 -5
- package/dist-cjs/commands/CreateOrUpdateWidgetPreviewCommand.js +21 -0
- 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 +10 -0
- package/dist-cjs/models/models_0.js +113 -22
- package/dist-cjs/protocols/Aws_restJson1.js +380 -74
- 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 +20 -0
- package/dist-es/KiteClient.js +4 -5
- package/dist-es/commands/CreateOrUpdateWidgetPreviewCommand.js +17 -0
- 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 +10 -0
- package/dist-es/models/models_0.js +105 -15
- package/dist-es/protocols/Aws_restJson1.js +334 -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 +74 -0
- package/dist-types/KiteClient.d.ts +12 -2
- package/dist-types/commands/CancelCalendarEventCommand.d.ts +17 -0
- package/dist-types/commands/CreateOrUpdateWidgetPreviewCommand.d.ts +414 -0
- package/dist-types/commands/CreateWidgetCommand.d.ts +118 -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 +178 -0
- package/dist-types/commands/GetWhatsAppNumberConfigurationCommand.d.ts +178 -0
- package/dist-types/commands/GetWidgetCommand.d.ts +66 -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 +179 -0
- package/dist-types/commands/ListSmsNumbersCommand.d.ts +82 -0
- package/dist-types/commands/ListWhatsAppConfigurationsCommand.d.ts +179 -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 +66 -0
- package/dist-types/commands/PutSmsNumberConfigurationCommand.d.ts +270 -0
- package/dist-types/commands/PutWhatsAppNumberConfigurationCommand.d.ts +270 -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 +118 -0
- package/dist-types/commands/index.d.ts +10 -0
- package/dist-types/models/models_0.d.ts +900 -154
- package/dist-types/protocols/Aws_restJson1.d.ts +90 -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,43 +943,54 @@ 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
|
|
658
960
|
*/
|
|
659
|
-
export interface
|
|
961
|
+
export interface CreateOrUpdateWidgetPreviewInput {
|
|
660
962
|
/**
|
|
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
|
+
* Actions that will be used if the specified route and the conditions within a specific action are met.
|
|
985
|
+
* @public
|
|
986
|
+
*/
|
|
987
|
+
actions?: (RouteAction)[] | undefined;
|
|
681
988
|
/**
|
|
682
989
|
* The unique identifier of the company when a service token is used.
|
|
683
990
|
* @public
|
|
684
991
|
*/
|
|
685
|
-
companyId?: string;
|
|
992
|
+
companyId?: string | undefined;
|
|
993
|
+
temporaryWidgetId: string;
|
|
686
994
|
}
|
|
687
995
|
/**
|
|
688
996
|
* @public
|
|
@@ -692,27 +1000,74 @@ export interface Widget {
|
|
|
692
1000
|
* The appearance configuration allows you to customize colors and text settings.
|
|
693
1001
|
* @public
|
|
694
1002
|
*/
|
|
695
|
-
appearance?: WidgetAppearance;
|
|
1003
|
+
appearance?: WidgetAppearance | undefined;
|
|
696
1004
|
/**
|
|
697
1005
|
* 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.
|
|
698
1006
|
* @public
|
|
699
1007
|
*/
|
|
700
|
-
routes?: (WidgetRoute)[];
|
|
1008
|
+
routes?: (WidgetRoute)[] | undefined;
|
|
701
1009
|
/**
|
|
702
1010
|
* A list of welcome messages that will be sent to the user when they first interact with the widget.
|
|
703
1011
|
* @public
|
|
704
1012
|
*/
|
|
705
|
-
welcomeMessages?: (WidgetWelcomeMessage)[];
|
|
1013
|
+
welcomeMessages?: (WidgetWelcomeMessage)[] | undefined;
|
|
706
1014
|
name: string;
|
|
707
1015
|
/**
|
|
708
1016
|
* 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.
|
|
709
1017
|
* @public
|
|
710
1018
|
*/
|
|
711
1019
|
target: WidgetTarget;
|
|
1020
|
+
/**
|
|
1021
|
+
* Actions that will be used if the specified route and the conditions within a specific action are met.
|
|
1022
|
+
* @public
|
|
1023
|
+
*/
|
|
1024
|
+
actions?: (RouteAction)[] | undefined;
|
|
712
1025
|
id: string;
|
|
713
1026
|
company: string;
|
|
714
1027
|
createdAt: string;
|
|
715
|
-
updatedAt?: string;
|
|
1028
|
+
updatedAt?: string | undefined;
|
|
1029
|
+
}
|
|
1030
|
+
/**
|
|
1031
|
+
* @public
|
|
1032
|
+
*/
|
|
1033
|
+
export interface CreateOrUpdateWidgetPreviewOutput {
|
|
1034
|
+
widget: Widget;
|
|
1035
|
+
}
|
|
1036
|
+
/**
|
|
1037
|
+
* @public
|
|
1038
|
+
*/
|
|
1039
|
+
export interface CreateWidgetInput {
|
|
1040
|
+
/**
|
|
1041
|
+
* The appearance configuration allows you to customize colors and text settings.
|
|
1042
|
+
* @public
|
|
1043
|
+
*/
|
|
1044
|
+
appearance?: WidgetAppearance | undefined;
|
|
1045
|
+
/**
|
|
1046
|
+
* 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.
|
|
1047
|
+
* @public
|
|
1048
|
+
*/
|
|
1049
|
+
routes?: (WidgetRoute)[] | undefined;
|
|
1050
|
+
/**
|
|
1051
|
+
* A list of welcome messages that will be sent to the user when they first interact with the widget.
|
|
1052
|
+
* @public
|
|
1053
|
+
*/
|
|
1054
|
+
welcomeMessages?: (WidgetWelcomeMessage)[] | undefined;
|
|
1055
|
+
name: string;
|
|
1056
|
+
/**
|
|
1057
|
+
* 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.
|
|
1058
|
+
* @public
|
|
1059
|
+
*/
|
|
1060
|
+
target: WidgetTarget;
|
|
1061
|
+
/**
|
|
1062
|
+
* Actions that will be used if the specified route and the conditions within a specific action are met.
|
|
1063
|
+
* @public
|
|
1064
|
+
*/
|
|
1065
|
+
actions?: (RouteAction)[] | undefined;
|
|
1066
|
+
/**
|
|
1067
|
+
* The unique identifier of the company when a service token is used.
|
|
1068
|
+
* @public
|
|
1069
|
+
*/
|
|
1070
|
+
companyId?: string | undefined;
|
|
716
1071
|
}
|
|
717
1072
|
/**
|
|
718
1073
|
* @public
|
|
@@ -757,9 +1112,9 @@ export interface GetCalendarSlotsInput {
|
|
|
757
1112
|
targetId: string;
|
|
758
1113
|
from: string;
|
|
759
1114
|
till: string;
|
|
760
|
-
duration?: string;
|
|
1115
|
+
duration?: string | undefined;
|
|
761
1116
|
timeZone: string;
|
|
762
|
-
excluded?: string;
|
|
1117
|
+
excluded?: string | undefined;
|
|
763
1118
|
}
|
|
764
1119
|
/**
|
|
765
1120
|
* @public
|
|
@@ -780,7 +1135,7 @@ export interface GetConfigInput {
|
|
|
780
1135
|
* The unique identifier of the route for time-based configuration.
|
|
781
1136
|
* @public
|
|
782
1137
|
*/
|
|
783
|
-
targetRouteId?: string;
|
|
1138
|
+
targetRouteId?: string | undefined;
|
|
784
1139
|
}
|
|
785
1140
|
/**
|
|
786
1141
|
* @public
|
|
@@ -825,25 +1180,25 @@ export interface KiteConfig {
|
|
|
825
1180
|
* The unique identifier of the route for time-based configuration.
|
|
826
1181
|
* @public
|
|
827
1182
|
*/
|
|
828
|
-
targetRouteId?: string;
|
|
1183
|
+
targetRouteId?: string | undefined;
|
|
829
1184
|
targetVariant: KiteVariant;
|
|
830
|
-
targetService?: KiteTargetService;
|
|
1185
|
+
targetService?: KiteTargetService | undefined;
|
|
831
1186
|
agents: (User)[];
|
|
832
1187
|
/**
|
|
833
1188
|
* The appearance settings like color scheme or custom texts.
|
|
834
1189
|
* @public
|
|
835
1190
|
*/
|
|
836
|
-
appearance?: WidgetAppearance;
|
|
1191
|
+
appearance?: WidgetAppearance | undefined;
|
|
837
1192
|
/**
|
|
838
1193
|
* A list of welcome messages that should be visible to the user.
|
|
839
1194
|
* @public
|
|
840
1195
|
*/
|
|
841
|
-
welcomeMessages?: (WidgetWelcomeMessage)[];
|
|
1196
|
+
welcomeMessages?: (WidgetWelcomeMessage)[] | undefined;
|
|
842
1197
|
/**
|
|
843
1198
|
* A list of features that are supported.
|
|
844
1199
|
* @public
|
|
845
1200
|
*/
|
|
846
|
-
features?: (KiteFeatures)[];
|
|
1201
|
+
features?: (KiteFeatures)[] | undefined;
|
|
847
1202
|
}
|
|
848
1203
|
/**
|
|
849
1204
|
* @public
|
|
@@ -854,34 +1209,288 @@ export interface GetConfigOutput {
|
|
|
854
1209
|
/**
|
|
855
1210
|
* @public
|
|
856
1211
|
*/
|
|
857
|
-
export interface
|
|
1212
|
+
export interface GetSmsNumberConfigurationInput {
|
|
858
1213
|
/**
|
|
859
|
-
* The unique identifier of the
|
|
1214
|
+
* The unique identifier of the company when a service token is used.
|
|
860
1215
|
* @public
|
|
861
1216
|
*/
|
|
862
|
-
|
|
863
|
-
|
|
864
|
-
/**
|
|
865
|
-
* @public
|
|
866
|
-
*/
|
|
867
|
-
export interface GetWidgetOutput {
|
|
868
|
-
widget: Widget;
|
|
1217
|
+
companyId?: string | undefined;
|
|
1218
|
+
serviceNumber: string;
|
|
869
1219
|
}
|
|
870
1220
|
/**
|
|
871
1221
|
* @public
|
|
872
1222
|
*/
|
|
873
|
-
export
|
|
874
|
-
readonly name: "WidgetNotFoundException";
|
|
875
|
-
readonly $fault: "client";
|
|
1223
|
+
export interface RouteTimeFrameRule {
|
|
876
1224
|
/**
|
|
877
|
-
*
|
|
1225
|
+
* The IANA time zone name (e.g., 'America/Los_Angeles') specifying the time zone in which the rule applies.
|
|
1226
|
+
* @public
|
|
878
1227
|
*/
|
|
879
|
-
|
|
880
|
-
|
|
881
|
-
|
|
882
|
-
|
|
883
|
-
|
|
884
|
-
|
|
1228
|
+
timeZone: string;
|
|
1229
|
+
/**
|
|
1230
|
+
* The day of the week or pattern when the rule applies.
|
|
1231
|
+
* @public
|
|
1232
|
+
*/
|
|
1233
|
+
day: RouteTimeFrameDay;
|
|
1234
|
+
/**
|
|
1235
|
+
* The minute of the day when the rule matches for the specified time zone (for example, 300 corresponds to 5AM)
|
|
1236
|
+
* @public
|
|
1237
|
+
*/
|
|
1238
|
+
startMinute: number;
|
|
1239
|
+
/**
|
|
1240
|
+
* The minute of the day when the rule matches for the specified time zone (for example, 300 corresponds to 5AM)
|
|
1241
|
+
* @public
|
|
1242
|
+
*/
|
|
1243
|
+
endMinute: number;
|
|
1244
|
+
}
|
|
1245
|
+
/**
|
|
1246
|
+
* @public
|
|
1247
|
+
*/
|
|
1248
|
+
export type RouteRule = RouteRule.TimeFrameMember | RouteRule.$UnknownMember;
|
|
1249
|
+
/**
|
|
1250
|
+
* @public
|
|
1251
|
+
*/
|
|
1252
|
+
export declare namespace RouteRule {
|
|
1253
|
+
interface TimeFrameMember {
|
|
1254
|
+
timeFrame: RouteTimeFrameRule;
|
|
1255
|
+
$unknown?: never;
|
|
1256
|
+
}
|
|
1257
|
+
/**
|
|
1258
|
+
* @public
|
|
1259
|
+
*/
|
|
1260
|
+
interface $UnknownMember {
|
|
1261
|
+
timeFrame?: never;
|
|
1262
|
+
$unknown: [string, any];
|
|
1263
|
+
}
|
|
1264
|
+
interface Visitor<T> {
|
|
1265
|
+
timeFrame: (value: RouteTimeFrameRule) => T;
|
|
1266
|
+
_: (name: string, value: any) => T;
|
|
1267
|
+
}
|
|
1268
|
+
const visit: <T>(value: RouteRule, visitor: Visitor<T>) => T;
|
|
1269
|
+
}
|
|
1270
|
+
/**
|
|
1271
|
+
* @public
|
|
1272
|
+
*/
|
|
1273
|
+
export interface RouteAgentTarget {
|
|
1274
|
+
/**
|
|
1275
|
+
* An email of the user that registered on x-bees and account must be connected to the PBX.
|
|
1276
|
+
* @public
|
|
1277
|
+
*/
|
|
1278
|
+
email: string;
|
|
1279
|
+
}
|
|
1280
|
+
/**
|
|
1281
|
+
* @public
|
|
1282
|
+
*/
|
|
1283
|
+
export interface RouteBotTarget {
|
|
1284
|
+
/**
|
|
1285
|
+
* An ID of the bot.
|
|
1286
|
+
* @public
|
|
1287
|
+
*/
|
|
1288
|
+
id: string;
|
|
1289
|
+
}
|
|
1290
|
+
/**
|
|
1291
|
+
* @public
|
|
1292
|
+
*/
|
|
1293
|
+
export interface RouteServiceTarget {
|
|
1294
|
+
/**
|
|
1295
|
+
* An ID of the service. ID of the service equals the ID of the call group that available on the PBX.
|
|
1296
|
+
* @public
|
|
1297
|
+
*/
|
|
1298
|
+
id: number;
|
|
1299
|
+
/**
|
|
1300
|
+
* An URI of the service which includes ID, PBX domain and port (example - 1@example.wildixin.com:443
|
|
1301
|
+
* @public
|
|
1302
|
+
*/
|
|
1303
|
+
uri: string;
|
|
1304
|
+
}
|
|
1305
|
+
/**
|
|
1306
|
+
* @public
|
|
1307
|
+
*/
|
|
1308
|
+
export type RouteTarget = RouteTarget.AgentMember | RouteTarget.BotMember | RouteTarget.ServiceMember | RouteTarget.$UnknownMember;
|
|
1309
|
+
/**
|
|
1310
|
+
* @public
|
|
1311
|
+
*/
|
|
1312
|
+
export declare namespace RouteTarget {
|
|
1313
|
+
interface ServiceMember {
|
|
1314
|
+
service: RouteServiceTarget;
|
|
1315
|
+
agent?: never;
|
|
1316
|
+
bot?: never;
|
|
1317
|
+
$unknown?: never;
|
|
1318
|
+
}
|
|
1319
|
+
interface AgentMember {
|
|
1320
|
+
service?: never;
|
|
1321
|
+
agent: RouteAgentTarget;
|
|
1322
|
+
bot?: never;
|
|
1323
|
+
$unknown?: never;
|
|
1324
|
+
}
|
|
1325
|
+
interface BotMember {
|
|
1326
|
+
service?: never;
|
|
1327
|
+
agent?: never;
|
|
1328
|
+
bot: RouteBotTarget;
|
|
1329
|
+
$unknown?: never;
|
|
1330
|
+
}
|
|
1331
|
+
/**
|
|
1332
|
+
* @public
|
|
1333
|
+
*/
|
|
1334
|
+
interface $UnknownMember {
|
|
1335
|
+
service?: never;
|
|
1336
|
+
agent?: never;
|
|
1337
|
+
bot?: never;
|
|
1338
|
+
$unknown: [string, any];
|
|
1339
|
+
}
|
|
1340
|
+
interface Visitor<T> {
|
|
1341
|
+
service: (value: RouteServiceTarget) => T;
|
|
1342
|
+
agent: (value: RouteAgentTarget) => T;
|
|
1343
|
+
bot: (value: RouteBotTarget) => T;
|
|
1344
|
+
_: (name: string, value: any) => T;
|
|
1345
|
+
}
|
|
1346
|
+
const visit: <T>(value: RouteTarget, visitor: Visitor<T>) => T;
|
|
1347
|
+
}
|
|
1348
|
+
/**
|
|
1349
|
+
* @public
|
|
1350
|
+
*/
|
|
1351
|
+
export interface SmsConfigRoute {
|
|
1352
|
+
id: string;
|
|
1353
|
+
rules: (RouteRule)[];
|
|
1354
|
+
/**
|
|
1355
|
+
* 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.
|
|
1356
|
+
* @public
|
|
1357
|
+
*/
|
|
1358
|
+
target: RouteTarget;
|
|
1359
|
+
/**
|
|
1360
|
+
* Actions that will be used if the specified route and the conditions within a specific action are met.
|
|
1361
|
+
* @public
|
|
1362
|
+
*/
|
|
1363
|
+
actions?: (RouteAction)[] | undefined;
|
|
1364
|
+
}
|
|
1365
|
+
/**
|
|
1366
|
+
* @public
|
|
1367
|
+
*/
|
|
1368
|
+
export interface SmsConfig {
|
|
1369
|
+
/**
|
|
1370
|
+
* 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.
|
|
1371
|
+
* @public
|
|
1372
|
+
*/
|
|
1373
|
+
serviceUri: string;
|
|
1374
|
+
/**
|
|
1375
|
+
* 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.
|
|
1376
|
+
* @public
|
|
1377
|
+
*/
|
|
1378
|
+
routes?: (SmsConfigRoute)[] | undefined;
|
|
1379
|
+
/**
|
|
1380
|
+
* 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.
|
|
1381
|
+
* @public
|
|
1382
|
+
*/
|
|
1383
|
+
target: RouteTarget;
|
|
1384
|
+
/**
|
|
1385
|
+
* Actions that will be used if the specified route and the conditions within a specific action are met.
|
|
1386
|
+
* @public
|
|
1387
|
+
*/
|
|
1388
|
+
actions?: (RouteAction)[] | undefined;
|
|
1389
|
+
companyId: string;
|
|
1390
|
+
serviceNumber: string;
|
|
1391
|
+
createdAt: string;
|
|
1392
|
+
updatedAt?: string | undefined;
|
|
1393
|
+
}
|
|
1394
|
+
/**
|
|
1395
|
+
* @public
|
|
1396
|
+
*/
|
|
1397
|
+
export interface GetSmsNumberConfigurationOutput {
|
|
1398
|
+
configuration: SmsConfig;
|
|
1399
|
+
}
|
|
1400
|
+
/**
|
|
1401
|
+
* @public
|
|
1402
|
+
*/
|
|
1403
|
+
export interface GetWhatsAppNumberConfigurationInput {
|
|
1404
|
+
/**
|
|
1405
|
+
* The unique identifier of the company when a service token is used.
|
|
1406
|
+
* @public
|
|
1407
|
+
*/
|
|
1408
|
+
companyId?: string | undefined;
|
|
1409
|
+
serviceNumber: string;
|
|
1410
|
+
}
|
|
1411
|
+
/**
|
|
1412
|
+
* @public
|
|
1413
|
+
*/
|
|
1414
|
+
export interface WhatsAppConfigRoute {
|
|
1415
|
+
id: string;
|
|
1416
|
+
rules: (RouteRule)[];
|
|
1417
|
+
/**
|
|
1418
|
+
* 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.
|
|
1419
|
+
* @public
|
|
1420
|
+
*/
|
|
1421
|
+
target: RouteTarget;
|
|
1422
|
+
/**
|
|
1423
|
+
* Actions that will be used if the specified route and the conditions within a specific action are met.
|
|
1424
|
+
* @public
|
|
1425
|
+
*/
|
|
1426
|
+
actions?: (RouteAction)[] | undefined;
|
|
1427
|
+
}
|
|
1428
|
+
/**
|
|
1429
|
+
* @public
|
|
1430
|
+
*/
|
|
1431
|
+
export interface WhatsAppConfig {
|
|
1432
|
+
/**
|
|
1433
|
+
* 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.
|
|
1434
|
+
* @public
|
|
1435
|
+
*/
|
|
1436
|
+
serviceUri: string;
|
|
1437
|
+
/**
|
|
1438
|
+
* 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.
|
|
1439
|
+
* @public
|
|
1440
|
+
*/
|
|
1441
|
+
routes?: (WhatsAppConfigRoute)[] | undefined;
|
|
1442
|
+
/**
|
|
1443
|
+
* 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.
|
|
1444
|
+
* @public
|
|
1445
|
+
*/
|
|
1446
|
+
target: RouteTarget;
|
|
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
|
+
companyId: string;
|
|
1453
|
+
serviceNumber: string;
|
|
1454
|
+
createdAt: string;
|
|
1455
|
+
updatedAt?: string | undefined;
|
|
1456
|
+
}
|
|
1457
|
+
/**
|
|
1458
|
+
* @public
|
|
1459
|
+
*/
|
|
1460
|
+
export interface GetWhatsAppNumberConfigurationOutput {
|
|
1461
|
+
configuration: WhatsAppConfig;
|
|
1462
|
+
}
|
|
1463
|
+
/**
|
|
1464
|
+
* @public
|
|
1465
|
+
*/
|
|
1466
|
+
export interface GetWidgetInput {
|
|
1467
|
+
/**
|
|
1468
|
+
* The unique identifier of the widget.
|
|
1469
|
+
* @public
|
|
1470
|
+
*/
|
|
1471
|
+
widgetId: string;
|
|
1472
|
+
}
|
|
1473
|
+
/**
|
|
1474
|
+
* @public
|
|
1475
|
+
*/
|
|
1476
|
+
export interface GetWidgetOutput {
|
|
1477
|
+
widget: Widget;
|
|
1478
|
+
}
|
|
1479
|
+
/**
|
|
1480
|
+
* @public
|
|
1481
|
+
*/
|
|
1482
|
+
export declare class WidgetNotFoundException extends __BaseException {
|
|
1483
|
+
readonly name: "WidgetNotFoundException";
|
|
1484
|
+
readonly $fault: "client";
|
|
1485
|
+
/**
|
|
1486
|
+
* @internal
|
|
1487
|
+
*/
|
|
1488
|
+
constructor(opts: __ExceptionOptionType<WidgetNotFoundException, __BaseException>);
|
|
1489
|
+
}
|
|
1490
|
+
/**
|
|
1491
|
+
* @public
|
|
1492
|
+
*/
|
|
1493
|
+
export type ListAgentsFilter = ListAgentsFilter.EmailsMember | ListAgentsFilter.ExtensionsMember | ListAgentsFilter.ServiceMember | ListAgentsFilter.$UnknownMember;
|
|
885
1494
|
/**
|
|
886
1495
|
* @public
|
|
887
1496
|
*/
|
|
@@ -941,7 +1550,7 @@ export interface ListAgentsInput {
|
|
|
941
1550
|
* The unique identifier of the organization when a service token is used.
|
|
942
1551
|
* @public
|
|
943
1552
|
*/
|
|
944
|
-
companyId?: string;
|
|
1553
|
+
companyId?: string | undefined;
|
|
945
1554
|
/**
|
|
946
1555
|
* The filter to be used to query agents.
|
|
947
1556
|
* @public
|
|
@@ -962,36 +1571,94 @@ export interface ListServicesInput {
|
|
|
962
1571
|
* The unique identifier of the organization when a service token is used.
|
|
963
1572
|
* @public
|
|
964
1573
|
*/
|
|
965
|
-
companyId?: string;
|
|
1574
|
+
companyId?: string | undefined;
|
|
966
1575
|
}
|
|
967
1576
|
/**
|
|
968
1577
|
* @public
|
|
969
1578
|
*/
|
|
970
|
-
export interface
|
|
971
|
-
|
|
972
|
-
port: number;
|
|
1579
|
+
export interface ListServicesOutput {
|
|
1580
|
+
services: (Service)[];
|
|
973
1581
|
}
|
|
974
1582
|
/**
|
|
975
1583
|
* @public
|
|
976
1584
|
*/
|
|
977
|
-
export interface
|
|
1585
|
+
export interface ListSmsConfigurationsInput {
|
|
1586
|
+
/**
|
|
1587
|
+
* The unique identifier of the company when a service token is used.
|
|
1588
|
+
* @public
|
|
1589
|
+
*/
|
|
1590
|
+
companyId?: string | undefined;
|
|
978
1591
|
}
|
|
979
1592
|
/**
|
|
980
1593
|
* @public
|
|
981
1594
|
*/
|
|
982
|
-
export interface
|
|
983
|
-
|
|
984
|
-
uri: string;
|
|
985
|
-
title: string;
|
|
986
|
-
settings: ServiceSettings;
|
|
987
|
-
extensions: (string)[];
|
|
988
|
-
pbx: ServicePbx;
|
|
1595
|
+
export interface ListSmsConfigurationsOutput {
|
|
1596
|
+
configurations: (SmsConfig)[];
|
|
989
1597
|
}
|
|
990
1598
|
/**
|
|
991
1599
|
* @public
|
|
992
1600
|
*/
|
|
993
|
-
export interface
|
|
994
|
-
|
|
1601
|
+
export interface ListSmsNumbersInput {
|
|
1602
|
+
/**
|
|
1603
|
+
* The unique identifier of the company when a service token is used.
|
|
1604
|
+
* @public
|
|
1605
|
+
*/
|
|
1606
|
+
companyId?: string | undefined;
|
|
1607
|
+
}
|
|
1608
|
+
/**
|
|
1609
|
+
* @public
|
|
1610
|
+
*/
|
|
1611
|
+
export interface ListSmsNumbersOutput {
|
|
1612
|
+
numbers: (string)[];
|
|
1613
|
+
}
|
|
1614
|
+
/**
|
|
1615
|
+
* @public
|
|
1616
|
+
*/
|
|
1617
|
+
export interface ListWhatsAppConfigurationsInput {
|
|
1618
|
+
/**
|
|
1619
|
+
* The unique identifier of the company when a service token is used.
|
|
1620
|
+
* @public
|
|
1621
|
+
*/
|
|
1622
|
+
companyId?: string | undefined;
|
|
1623
|
+
}
|
|
1624
|
+
/**
|
|
1625
|
+
* @public
|
|
1626
|
+
*/
|
|
1627
|
+
export interface ListWhatsAppConfigurationsOutput {
|
|
1628
|
+
configurations: (WhatsAppConfig)[];
|
|
1629
|
+
}
|
|
1630
|
+
/**
|
|
1631
|
+
* @public
|
|
1632
|
+
*/
|
|
1633
|
+
export interface ListWhatsAppNumbersInput {
|
|
1634
|
+
/**
|
|
1635
|
+
* The unique identifier of the company when a service token is used.
|
|
1636
|
+
* @public
|
|
1637
|
+
*/
|
|
1638
|
+
companyId?: string | undefined;
|
|
1639
|
+
}
|
|
1640
|
+
/**
|
|
1641
|
+
* @public
|
|
1642
|
+
*/
|
|
1643
|
+
export interface ListWhatsAppNumbersOutput {
|
|
1644
|
+
numbers: (string)[];
|
|
1645
|
+
}
|
|
1646
|
+
/**
|
|
1647
|
+
* @public
|
|
1648
|
+
*/
|
|
1649
|
+
export interface ListWhatsAppTemplatesInput {
|
|
1650
|
+
/**
|
|
1651
|
+
* The unique identifier of the company when a service token is used.
|
|
1652
|
+
* @public
|
|
1653
|
+
*/
|
|
1654
|
+
companyId?: string | undefined;
|
|
1655
|
+
serviceNumber: string;
|
|
1656
|
+
}
|
|
1657
|
+
/**
|
|
1658
|
+
* @public
|
|
1659
|
+
*/
|
|
1660
|
+
export interface ListWhatsAppTemplatesOutput {
|
|
1661
|
+
templates: (Template)[];
|
|
995
1662
|
}
|
|
996
1663
|
/**
|
|
997
1664
|
* @public
|
|
@@ -1001,7 +1668,7 @@ export interface ListWidgetsInput {
|
|
|
1001
1668
|
* The unique identifier of the company when a service token is used.
|
|
1002
1669
|
* @public
|
|
1003
1670
|
*/
|
|
1004
|
-
companyId?: string;
|
|
1671
|
+
companyId?: string | undefined;
|
|
1005
1672
|
}
|
|
1006
1673
|
/**
|
|
1007
1674
|
* @public
|
|
@@ -1009,6 +1676,80 @@ export interface ListWidgetsInput {
|
|
|
1009
1676
|
export interface ListWidgetsOutput {
|
|
1010
1677
|
widgets: (Widget)[];
|
|
1011
1678
|
}
|
|
1679
|
+
/**
|
|
1680
|
+
* @public
|
|
1681
|
+
*/
|
|
1682
|
+
export interface PutSmsNumberConfigurationInput {
|
|
1683
|
+
/**
|
|
1684
|
+
* 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.
|
|
1685
|
+
* @public
|
|
1686
|
+
*/
|
|
1687
|
+
serviceUri: string;
|
|
1688
|
+
/**
|
|
1689
|
+
* 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.
|
|
1690
|
+
* @public
|
|
1691
|
+
*/
|
|
1692
|
+
routes?: (SmsConfigRoute)[] | undefined;
|
|
1693
|
+
/**
|
|
1694
|
+
* 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.
|
|
1695
|
+
* @public
|
|
1696
|
+
*/
|
|
1697
|
+
target: RouteTarget;
|
|
1698
|
+
/**
|
|
1699
|
+
* Actions that will be used if the specified route and the conditions within a specific action are met.
|
|
1700
|
+
* @public
|
|
1701
|
+
*/
|
|
1702
|
+
actions?: (RouteAction)[] | undefined;
|
|
1703
|
+
/**
|
|
1704
|
+
* The unique identifier of the company when a service token is used.
|
|
1705
|
+
* @public
|
|
1706
|
+
*/
|
|
1707
|
+
companyId?: string | undefined;
|
|
1708
|
+
serviceNumber: string;
|
|
1709
|
+
}
|
|
1710
|
+
/**
|
|
1711
|
+
* @public
|
|
1712
|
+
*/
|
|
1713
|
+
export interface PutSmsNumberConfigurationOutput {
|
|
1714
|
+
configuration: SmsConfig;
|
|
1715
|
+
}
|
|
1716
|
+
/**
|
|
1717
|
+
* @public
|
|
1718
|
+
*/
|
|
1719
|
+
export interface PutWhatsAppNumberConfigurationInput {
|
|
1720
|
+
/**
|
|
1721
|
+
* 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.
|
|
1722
|
+
* @public
|
|
1723
|
+
*/
|
|
1724
|
+
serviceUri: string;
|
|
1725
|
+
/**
|
|
1726
|
+
* 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.
|
|
1727
|
+
* @public
|
|
1728
|
+
*/
|
|
1729
|
+
routes?: (WhatsAppConfigRoute)[] | undefined;
|
|
1730
|
+
/**
|
|
1731
|
+
* 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.
|
|
1732
|
+
* @public
|
|
1733
|
+
*/
|
|
1734
|
+
target: RouteTarget;
|
|
1735
|
+
/**
|
|
1736
|
+
* Actions that will be used if the specified route and the conditions within a specific action are met.
|
|
1737
|
+
* @public
|
|
1738
|
+
*/
|
|
1739
|
+
actions?: (RouteAction)[] | undefined;
|
|
1740
|
+
/**
|
|
1741
|
+
* The unique identifier of the company when a service token is used.
|
|
1742
|
+
* @public
|
|
1743
|
+
*/
|
|
1744
|
+
companyId?: string | undefined;
|
|
1745
|
+
serviceNumber: string;
|
|
1746
|
+
}
|
|
1747
|
+
/**
|
|
1748
|
+
* @public
|
|
1749
|
+
*/
|
|
1750
|
+
export interface PutWhatsAppNumberConfigurationOutput {
|
|
1751
|
+
configuration: WhatsAppConfig;
|
|
1752
|
+
}
|
|
1012
1753
|
/**
|
|
1013
1754
|
* @public
|
|
1014
1755
|
*/
|
|
@@ -1020,16 +1761,16 @@ export interface RescheduleCalendarEventInput {
|
|
|
1020
1761
|
channelId: string;
|
|
1021
1762
|
eventId: string;
|
|
1022
1763
|
eventOwner: string;
|
|
1023
|
-
start?: string;
|
|
1024
|
-
duration?: string;
|
|
1025
|
-
reason?: string;
|
|
1764
|
+
start?: string | undefined;
|
|
1765
|
+
duration?: string | undefined;
|
|
1766
|
+
reason?: string | undefined;
|
|
1026
1767
|
/**
|
|
1027
1768
|
* Event title
|
|
1028
1769
|
* @public
|
|
1029
1770
|
*/
|
|
1030
|
-
summary?: string;
|
|
1031
|
-
attendees?: (string)[];
|
|
1032
|
-
changed?: (string)[];
|
|
1771
|
+
summary?: string | undefined;
|
|
1772
|
+
attendees?: (string)[] | undefined;
|
|
1773
|
+
changed?: (string)[] | undefined;
|
|
1033
1774
|
}
|
|
1034
1775
|
/**
|
|
1035
1776
|
* @public
|
|
@@ -1047,17 +1788,17 @@ export interface ScheduleCalendarEventInput {
|
|
|
1047
1788
|
* @public
|
|
1048
1789
|
*/
|
|
1049
1790
|
targetId: string;
|
|
1050
|
-
channelId?: string;
|
|
1791
|
+
channelId?: string | undefined;
|
|
1051
1792
|
start: string;
|
|
1052
1793
|
duration: string;
|
|
1053
|
-
attendees?: (string)[];
|
|
1794
|
+
attendees?: (string)[] | undefined;
|
|
1054
1795
|
/**
|
|
1055
1796
|
* Event title
|
|
1056
1797
|
* @public
|
|
1057
1798
|
*/
|
|
1058
|
-
summary?: string;
|
|
1059
|
-
language?: string;
|
|
1060
|
-
timeZone?: string;
|
|
1799
|
+
summary?: string | undefined;
|
|
1800
|
+
language?: string | undefined;
|
|
1801
|
+
timeZone?: string | undefined;
|
|
1061
1802
|
}
|
|
1062
1803
|
/**
|
|
1063
1804
|
* @public
|
|
@@ -1074,28 +1815,33 @@ export interface UpdateWidgetInput {
|
|
|
1074
1815
|
* The appearance configuration allows you to customize colors and text settings.
|
|
1075
1816
|
* @public
|
|
1076
1817
|
*/
|
|
1077
|
-
appearance?: WidgetAppearance;
|
|
1818
|
+
appearance?: WidgetAppearance | undefined;
|
|
1078
1819
|
/**
|
|
1079
1820
|
* 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.
|
|
1080
1821
|
* @public
|
|
1081
1822
|
*/
|
|
1082
|
-
routes?: (WidgetRoute)[];
|
|
1823
|
+
routes?: (WidgetRoute)[] | undefined;
|
|
1083
1824
|
/**
|
|
1084
1825
|
* A list of welcome messages that will be sent to the user when they first interact with the widget.
|
|
1085
1826
|
* @public
|
|
1086
1827
|
*/
|
|
1087
|
-
welcomeMessages?: (WidgetWelcomeMessage)[];
|
|
1828
|
+
welcomeMessages?: (WidgetWelcomeMessage)[] | undefined;
|
|
1088
1829
|
name: string;
|
|
1089
1830
|
/**
|
|
1090
1831
|
* 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.
|
|
1091
1832
|
* @public
|
|
1092
1833
|
*/
|
|
1093
1834
|
target: WidgetTarget;
|
|
1835
|
+
/**
|
|
1836
|
+
* Actions that will be used if the specified route and the conditions within a specific action are met.
|
|
1837
|
+
* @public
|
|
1838
|
+
*/
|
|
1839
|
+
actions?: (RouteAction)[] | undefined;
|
|
1094
1840
|
/**
|
|
1095
1841
|
* The unique identifier of the company when a service token is used.
|
|
1096
1842
|
* @public
|
|
1097
1843
|
*/
|
|
1098
|
-
companyId?: string;
|
|
1844
|
+
companyId?: string | undefined;
|
|
1099
1845
|
/**
|
|
1100
1846
|
* The unique identifier of the widget to be updated.
|
|
1101
1847
|
* @public
|