@gtmi/ramp-api-client 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +59 -0
- package/dist/es/index.d.mts +3615 -0
- package/dist/es/index.mjs +2173 -0
- package/package.json +46 -0
- package/src/client.test.ts +50 -0
- package/src/client.ts +15 -0
- package/src/client.types.ts +11 -0
- package/src/generated/client/client.gen.ts +277 -0
- package/src/generated/client/index.ts +27 -0
- package/src/generated/client/types.gen.ts +214 -0
- package/src/generated/client/utils.gen.ts +316 -0
- package/src/generated/client.gen.ts +18 -0
- package/src/generated/core/auth.gen.ts +48 -0
- package/src/generated/core/bodySerializer.gen.ts +82 -0
- package/src/generated/core/params.gen.ts +178 -0
- package/src/generated/core/pathSerializer.gen.ts +171 -0
- package/src/generated/core/queryKeySerializer.gen.ts +117 -0
- package/src/generated/core/serverSentEvents.gen.ts +242 -0
- package/src/generated/core/types.gen.ts +110 -0
- package/src/generated/core/utils.gen.ts +140 -0
- package/src/generated/index.ts +268 -0
- package/src/generated/sdk.gen.ts +1590 -0
- package/src/generated/types.gen.ts +2089 -0
- package/src/generated/zod.gen.ts +358 -0
- package/src/index.ts +7 -0
|
@@ -0,0 +1,2089 @@
|
|
|
1
|
+
// This file is auto-generated by @hey-api/openapi-ts
|
|
2
|
+
|
|
3
|
+
export type ClientOptions = {
|
|
4
|
+
baseUrl: `${string}://${string}` | (string & {});
|
|
5
|
+
};
|
|
6
|
+
|
|
7
|
+
export type AutogenRequest = {
|
|
8
|
+
email?: string;
|
|
9
|
+
company?: string;
|
|
10
|
+
information?: string;
|
|
11
|
+
language?: string;
|
|
12
|
+
voice?: string;
|
|
13
|
+
speechModel?: string;
|
|
14
|
+
transcriptionProvider?: string;
|
|
15
|
+
ttsProvider?: string;
|
|
16
|
+
logoSmall?: string;
|
|
17
|
+
logoFull?: string;
|
|
18
|
+
websiteUrl?: string;
|
|
19
|
+
};
|
|
20
|
+
|
|
21
|
+
export type SupportedRegion = {
|
|
22
|
+
isoCountry?: string;
|
|
23
|
+
numberType?: string;
|
|
24
|
+
bundleSid?: string;
|
|
25
|
+
label?: string;
|
|
26
|
+
flag?: string;
|
|
27
|
+
capabilities?: string;
|
|
28
|
+
};
|
|
29
|
+
|
|
30
|
+
export type ShortenUrlInput = {
|
|
31
|
+
[key: string]: unknown;
|
|
32
|
+
};
|
|
33
|
+
|
|
34
|
+
export type GetHealthData = {
|
|
35
|
+
body?: never;
|
|
36
|
+
path?: never;
|
|
37
|
+
query?: never;
|
|
38
|
+
url: '/health';
|
|
39
|
+
};
|
|
40
|
+
|
|
41
|
+
export type GetHealthErrors = {
|
|
42
|
+
/**
|
|
43
|
+
* Internal server error
|
|
44
|
+
*/
|
|
45
|
+
500: unknown;
|
|
46
|
+
};
|
|
47
|
+
|
|
48
|
+
export type GetHealthResponses = {
|
|
49
|
+
/**
|
|
50
|
+
* Success
|
|
51
|
+
*/
|
|
52
|
+
200: unknown;
|
|
53
|
+
};
|
|
54
|
+
|
|
55
|
+
export type PostConversationsTokenData = {
|
|
56
|
+
body: {
|
|
57
|
+
[key: string]: unknown;
|
|
58
|
+
};
|
|
59
|
+
path?: never;
|
|
60
|
+
query?: never;
|
|
61
|
+
url: '/conversations/token';
|
|
62
|
+
};
|
|
63
|
+
|
|
64
|
+
export type PostConversationsTokenErrors = {
|
|
65
|
+
/**
|
|
66
|
+
* Internal server error
|
|
67
|
+
*/
|
|
68
|
+
500: unknown;
|
|
69
|
+
};
|
|
70
|
+
|
|
71
|
+
export type PostConversationsTokenResponses = {
|
|
72
|
+
/**
|
|
73
|
+
* Success
|
|
74
|
+
*/
|
|
75
|
+
200: unknown;
|
|
76
|
+
};
|
|
77
|
+
|
|
78
|
+
export type GetSyncTokenData = {
|
|
79
|
+
body?: never;
|
|
80
|
+
path?: never;
|
|
81
|
+
query?: {
|
|
82
|
+
identity?: string;
|
|
83
|
+
};
|
|
84
|
+
url: '/sync/token';
|
|
85
|
+
};
|
|
86
|
+
|
|
87
|
+
export type GetSyncTokenErrors = {
|
|
88
|
+
/**
|
|
89
|
+
* Unauthorized — requires Bearer token
|
|
90
|
+
*/
|
|
91
|
+
401: unknown;
|
|
92
|
+
/**
|
|
93
|
+
* Internal server error
|
|
94
|
+
*/
|
|
95
|
+
500: unknown;
|
|
96
|
+
};
|
|
97
|
+
|
|
98
|
+
export type GetSyncTokenResponses = {
|
|
99
|
+
/**
|
|
100
|
+
* Success
|
|
101
|
+
*/
|
|
102
|
+
200: unknown;
|
|
103
|
+
};
|
|
104
|
+
|
|
105
|
+
export type GetVoiceTokenData = {
|
|
106
|
+
body?: never;
|
|
107
|
+
path?: never;
|
|
108
|
+
query?: {
|
|
109
|
+
identity?: string;
|
|
110
|
+
};
|
|
111
|
+
url: '/voice/token';
|
|
112
|
+
};
|
|
113
|
+
|
|
114
|
+
export type GetVoiceTokenErrors = {
|
|
115
|
+
/**
|
|
116
|
+
* Internal server error
|
|
117
|
+
*/
|
|
118
|
+
500: unknown;
|
|
119
|
+
};
|
|
120
|
+
|
|
121
|
+
export type GetVoiceTokenResponses = {
|
|
122
|
+
/**
|
|
123
|
+
* Success
|
|
124
|
+
*/
|
|
125
|
+
200: unknown;
|
|
126
|
+
};
|
|
127
|
+
|
|
128
|
+
export type PostUiConfigData = {
|
|
129
|
+
body: {
|
|
130
|
+
[key: string]: unknown;
|
|
131
|
+
};
|
|
132
|
+
path?: never;
|
|
133
|
+
query?: never;
|
|
134
|
+
url: '/ui-config';
|
|
135
|
+
};
|
|
136
|
+
|
|
137
|
+
export type PostUiConfigErrors = {
|
|
138
|
+
/**
|
|
139
|
+
* Internal server error
|
|
140
|
+
*/
|
|
141
|
+
500: unknown;
|
|
142
|
+
};
|
|
143
|
+
|
|
144
|
+
export type PostUiConfigResponses = {
|
|
145
|
+
/**
|
|
146
|
+
* Success
|
|
147
|
+
*/
|
|
148
|
+
200: unknown;
|
|
149
|
+
};
|
|
150
|
+
|
|
151
|
+
export type PostCreateExternalFlexConnectionData = {
|
|
152
|
+
body: {
|
|
153
|
+
/**
|
|
154
|
+
* Source/external Twilio account SID. Required.
|
|
155
|
+
*/
|
|
156
|
+
seAccountSid: string;
|
|
157
|
+
/**
|
|
158
|
+
* Source/external Twilio API key SID. Required.
|
|
159
|
+
*/
|
|
160
|
+
seApiKeySid: string;
|
|
161
|
+
/**
|
|
162
|
+
* Source/external Twilio API key secret. Required.
|
|
163
|
+
*/
|
|
164
|
+
seApiKeySecret: string;
|
|
165
|
+
};
|
|
166
|
+
path?: never;
|
|
167
|
+
query?: never;
|
|
168
|
+
url: '/create-external-flex-connection';
|
|
169
|
+
};
|
|
170
|
+
|
|
171
|
+
export type PostCreateExternalFlexConnectionErrors = {
|
|
172
|
+
/**
|
|
173
|
+
* Unauthorized — requires Bearer token
|
|
174
|
+
*/
|
|
175
|
+
401: unknown;
|
|
176
|
+
/**
|
|
177
|
+
* Internal server error
|
|
178
|
+
*/
|
|
179
|
+
500: unknown;
|
|
180
|
+
};
|
|
181
|
+
|
|
182
|
+
export type PostCreateExternalFlexConnectionResponses = {
|
|
183
|
+
/**
|
|
184
|
+
* Success
|
|
185
|
+
*/
|
|
186
|
+
200: unknown;
|
|
187
|
+
};
|
|
188
|
+
|
|
189
|
+
export type PostInstallFlexPluginData = {
|
|
190
|
+
body: {
|
|
191
|
+
/**
|
|
192
|
+
* Source/external Twilio account SID. Required.
|
|
193
|
+
*/
|
|
194
|
+
seAccountSid: string;
|
|
195
|
+
/**
|
|
196
|
+
* Source/external Twilio API key SID. Required.
|
|
197
|
+
*/
|
|
198
|
+
seApiKeySid: string;
|
|
199
|
+
/**
|
|
200
|
+
* Source/external Twilio API key secret. Required.
|
|
201
|
+
*/
|
|
202
|
+
seApiKeySecret: string;
|
|
203
|
+
/**
|
|
204
|
+
* Name of the plugin to install (must be in registry). Required.
|
|
205
|
+
*/
|
|
206
|
+
pluginName: string;
|
|
207
|
+
};
|
|
208
|
+
path?: never;
|
|
209
|
+
query?: never;
|
|
210
|
+
url: '/install-flex-plugin';
|
|
211
|
+
};
|
|
212
|
+
|
|
213
|
+
export type PostInstallFlexPluginErrors = {
|
|
214
|
+
/**
|
|
215
|
+
* Unauthorized — requires Bearer token
|
|
216
|
+
*/
|
|
217
|
+
401: unknown;
|
|
218
|
+
/**
|
|
219
|
+
* Internal server error
|
|
220
|
+
*/
|
|
221
|
+
500: unknown;
|
|
222
|
+
};
|
|
223
|
+
|
|
224
|
+
export type PostInstallFlexPluginResponses = {
|
|
225
|
+
/**
|
|
226
|
+
* Success
|
|
227
|
+
*/
|
|
228
|
+
200: unknown;
|
|
229
|
+
};
|
|
230
|
+
|
|
231
|
+
export type PostLiveAgentWebchatConnectData = {
|
|
232
|
+
body: {
|
|
233
|
+
[key: string]: unknown;
|
|
234
|
+
};
|
|
235
|
+
path?: never;
|
|
236
|
+
query?: never;
|
|
237
|
+
url: '/live-agent-webchat-connect';
|
|
238
|
+
};
|
|
239
|
+
|
|
240
|
+
export type PostLiveAgentWebchatConnectErrors = {
|
|
241
|
+
/**
|
|
242
|
+
* Internal server error
|
|
243
|
+
*/
|
|
244
|
+
500: unknown;
|
|
245
|
+
};
|
|
246
|
+
|
|
247
|
+
export type PostLiveAgentWebchatConnectResponses = {
|
|
248
|
+
/**
|
|
249
|
+
* Success
|
|
250
|
+
*/
|
|
251
|
+
200: unknown;
|
|
252
|
+
};
|
|
253
|
+
|
|
254
|
+
export type PostLiveAgentWebchatSendData = {
|
|
255
|
+
body: {
|
|
256
|
+
/**
|
|
257
|
+
* Twilio Conversation SID (CH...). Required.
|
|
258
|
+
*/
|
|
259
|
+
conversationSid: string;
|
|
260
|
+
/**
|
|
261
|
+
* Identity to use as message author. Required.
|
|
262
|
+
*/
|
|
263
|
+
identity: string;
|
|
264
|
+
/**
|
|
265
|
+
* Message content to send. Required.
|
|
266
|
+
*/
|
|
267
|
+
message: string;
|
|
268
|
+
};
|
|
269
|
+
path?: never;
|
|
270
|
+
query?: never;
|
|
271
|
+
url: '/live-agent-webchat-send';
|
|
272
|
+
};
|
|
273
|
+
|
|
274
|
+
export type PostLiveAgentWebchatSendErrors = {
|
|
275
|
+
/**
|
|
276
|
+
* Unauthorized — requires Bearer token
|
|
277
|
+
*/
|
|
278
|
+
401: unknown;
|
|
279
|
+
/**
|
|
280
|
+
* Internal server error
|
|
281
|
+
*/
|
|
282
|
+
500: unknown;
|
|
283
|
+
};
|
|
284
|
+
|
|
285
|
+
export type PostLiveAgentWebchatSendResponses = {
|
|
286
|
+
/**
|
|
287
|
+
* Success
|
|
288
|
+
*/
|
|
289
|
+
200: unknown;
|
|
290
|
+
};
|
|
291
|
+
|
|
292
|
+
export type PostLiveAgentWebchatEndData = {
|
|
293
|
+
body: {
|
|
294
|
+
[key: string]: unknown;
|
|
295
|
+
};
|
|
296
|
+
path?: never;
|
|
297
|
+
query?: never;
|
|
298
|
+
url: '/live-agent-webchat-end';
|
|
299
|
+
};
|
|
300
|
+
|
|
301
|
+
export type PostLiveAgentWebchatEndErrors = {
|
|
302
|
+
/**
|
|
303
|
+
* Internal server error
|
|
304
|
+
*/
|
|
305
|
+
500: unknown;
|
|
306
|
+
};
|
|
307
|
+
|
|
308
|
+
export type PostLiveAgentWebchatEndResponses = {
|
|
309
|
+
/**
|
|
310
|
+
* Success
|
|
311
|
+
*/
|
|
312
|
+
200: unknown;
|
|
313
|
+
};
|
|
314
|
+
|
|
315
|
+
export type DeleteLeadGenData = {
|
|
316
|
+
body?: never;
|
|
317
|
+
path?: never;
|
|
318
|
+
query?: never;
|
|
319
|
+
url: '/lead-gen';
|
|
320
|
+
};
|
|
321
|
+
|
|
322
|
+
export type DeleteLeadGenErrors = {
|
|
323
|
+
/**
|
|
324
|
+
* Unauthorized — requires Bearer token
|
|
325
|
+
*/
|
|
326
|
+
401: unknown;
|
|
327
|
+
/**
|
|
328
|
+
* Internal server error
|
|
329
|
+
*/
|
|
330
|
+
500: unknown;
|
|
331
|
+
};
|
|
332
|
+
|
|
333
|
+
export type DeleteLeadGenResponses = {
|
|
334
|
+
/**
|
|
335
|
+
* Success
|
|
336
|
+
*/
|
|
337
|
+
200: unknown;
|
|
338
|
+
};
|
|
339
|
+
|
|
340
|
+
export type PatchLeadGenData = {
|
|
341
|
+
body: {
|
|
342
|
+
[key: string]: unknown;
|
|
343
|
+
};
|
|
344
|
+
path?: never;
|
|
345
|
+
query?: never;
|
|
346
|
+
url: '/lead-gen';
|
|
347
|
+
};
|
|
348
|
+
|
|
349
|
+
export type PatchLeadGenErrors = {
|
|
350
|
+
/**
|
|
351
|
+
* Unauthorized — requires Bearer token
|
|
352
|
+
*/
|
|
353
|
+
401: unknown;
|
|
354
|
+
/**
|
|
355
|
+
* Internal server error
|
|
356
|
+
*/
|
|
357
|
+
500: unknown;
|
|
358
|
+
};
|
|
359
|
+
|
|
360
|
+
export type PatchLeadGenResponses = {
|
|
361
|
+
/**
|
|
362
|
+
* Success
|
|
363
|
+
*/
|
|
364
|
+
200: unknown;
|
|
365
|
+
};
|
|
366
|
+
|
|
367
|
+
export type PostLeadGenData = {
|
|
368
|
+
body: {
|
|
369
|
+
/**
|
|
370
|
+
* The Algolia object ID of the template to associate with the lead gen.
|
|
371
|
+
*/
|
|
372
|
+
objectID: string;
|
|
373
|
+
/**
|
|
374
|
+
* The email address of the user creating the lead gen.
|
|
375
|
+
*/
|
|
376
|
+
userEmail: string;
|
|
377
|
+
};
|
|
378
|
+
path?: never;
|
|
379
|
+
query?: never;
|
|
380
|
+
url: '/lead-gen';
|
|
381
|
+
};
|
|
382
|
+
|
|
383
|
+
export type PostLeadGenErrors = {
|
|
384
|
+
/**
|
|
385
|
+
* Unauthorized — requires Bearer token
|
|
386
|
+
*/
|
|
387
|
+
401: unknown;
|
|
388
|
+
/**
|
|
389
|
+
* Internal server error
|
|
390
|
+
*/
|
|
391
|
+
500: unknown;
|
|
392
|
+
};
|
|
393
|
+
|
|
394
|
+
export type PostLeadGenResponses = {
|
|
395
|
+
/**
|
|
396
|
+
* Success
|
|
397
|
+
*/
|
|
398
|
+
200: unknown;
|
|
399
|
+
};
|
|
400
|
+
|
|
401
|
+
export type PostLeadGenMonitorData = {
|
|
402
|
+
body?: never;
|
|
403
|
+
path?: never;
|
|
404
|
+
query?: never;
|
|
405
|
+
url: '/lead-gen-monitor';
|
|
406
|
+
};
|
|
407
|
+
|
|
408
|
+
export type PostLeadGenMonitorErrors = {
|
|
409
|
+
/**
|
|
410
|
+
* Unauthorized — requires Bearer token
|
|
411
|
+
*/
|
|
412
|
+
401: unknown;
|
|
413
|
+
/**
|
|
414
|
+
* Internal server error
|
|
415
|
+
*/
|
|
416
|
+
500: unknown;
|
|
417
|
+
};
|
|
418
|
+
|
|
419
|
+
export type PostLeadGenMonitorResponses = {
|
|
420
|
+
/**
|
|
421
|
+
* Success
|
|
422
|
+
*/
|
|
423
|
+
200: unknown;
|
|
424
|
+
};
|
|
425
|
+
|
|
426
|
+
export type PostConversationsCommunicationsByConversationIdData = {
|
|
427
|
+
body: {
|
|
428
|
+
/**
|
|
429
|
+
* Author of the communication (required)
|
|
430
|
+
*/
|
|
431
|
+
author: string;
|
|
432
|
+
/**
|
|
433
|
+
* Content of the communication (required)
|
|
434
|
+
*/
|
|
435
|
+
content: string;
|
|
436
|
+
/**
|
|
437
|
+
* Recipients of the communication (required, non-empty)
|
|
438
|
+
*/
|
|
439
|
+
recipients: string;
|
|
440
|
+
};
|
|
441
|
+
path: {
|
|
442
|
+
conversationId: string;
|
|
443
|
+
};
|
|
444
|
+
query?: never;
|
|
445
|
+
url: '/conversations-communications/{conversationId}';
|
|
446
|
+
};
|
|
447
|
+
|
|
448
|
+
export type PostConversationsCommunicationsByConversationIdErrors = {
|
|
449
|
+
/**
|
|
450
|
+
* Unauthorized — requires Bearer token
|
|
451
|
+
*/
|
|
452
|
+
401: unknown;
|
|
453
|
+
/**
|
|
454
|
+
* Internal server error
|
|
455
|
+
*/
|
|
456
|
+
500: unknown;
|
|
457
|
+
};
|
|
458
|
+
|
|
459
|
+
export type PostConversationsCommunicationsByConversationIdResponses = {
|
|
460
|
+
/**
|
|
461
|
+
* Success
|
|
462
|
+
*/
|
|
463
|
+
200: unknown;
|
|
464
|
+
};
|
|
465
|
+
|
|
466
|
+
export type GetConversationsFetchData = {
|
|
467
|
+
body?: never;
|
|
468
|
+
path?: never;
|
|
469
|
+
query?: {
|
|
470
|
+
conversationId?: string;
|
|
471
|
+
status?: string;
|
|
472
|
+
};
|
|
473
|
+
url: '/conversations-fetch';
|
|
474
|
+
};
|
|
475
|
+
|
|
476
|
+
export type GetConversationsFetchErrors = {
|
|
477
|
+
/**
|
|
478
|
+
* Unauthorized — requires Bearer token
|
|
479
|
+
*/
|
|
480
|
+
401: unknown;
|
|
481
|
+
/**
|
|
482
|
+
* Internal server error
|
|
483
|
+
*/
|
|
484
|
+
500: unknown;
|
|
485
|
+
};
|
|
486
|
+
|
|
487
|
+
export type GetConversationsFetchResponses = {
|
|
488
|
+
/**
|
|
489
|
+
* Success
|
|
490
|
+
*/
|
|
491
|
+
200: unknown;
|
|
492
|
+
};
|
|
493
|
+
|
|
494
|
+
export type PostConversationsData = {
|
|
495
|
+
body: {
|
|
496
|
+
/**
|
|
497
|
+
* The Twilio configuration ID (required)
|
|
498
|
+
*/
|
|
499
|
+
configurationId: string;
|
|
500
|
+
};
|
|
501
|
+
path?: never;
|
|
502
|
+
query?: never;
|
|
503
|
+
url: '/conversations';
|
|
504
|
+
};
|
|
505
|
+
|
|
506
|
+
export type PostConversationsErrors = {
|
|
507
|
+
/**
|
|
508
|
+
* Unauthorized — requires Bearer token
|
|
509
|
+
*/
|
|
510
|
+
401: unknown;
|
|
511
|
+
/**
|
|
512
|
+
* Internal server error
|
|
513
|
+
*/
|
|
514
|
+
500: unknown;
|
|
515
|
+
};
|
|
516
|
+
|
|
517
|
+
export type PostConversationsResponses = {
|
|
518
|
+
/**
|
|
519
|
+
* Success
|
|
520
|
+
*/
|
|
521
|
+
200: unknown;
|
|
522
|
+
};
|
|
523
|
+
|
|
524
|
+
export type PutConversationsData = {
|
|
525
|
+
body: {
|
|
526
|
+
/**
|
|
527
|
+
* The Twilio conversation SID (required)
|
|
528
|
+
*/
|
|
529
|
+
conversationsId: string;
|
|
530
|
+
/**
|
|
531
|
+
* The new status for the conversation (required)
|
|
532
|
+
*/
|
|
533
|
+
status: string;
|
|
534
|
+
};
|
|
535
|
+
path?: never;
|
|
536
|
+
query?: never;
|
|
537
|
+
url: '/conversations';
|
|
538
|
+
};
|
|
539
|
+
|
|
540
|
+
export type PutConversationsErrors = {
|
|
541
|
+
/**
|
|
542
|
+
* Unauthorized — requires Bearer token
|
|
543
|
+
*/
|
|
544
|
+
401: unknown;
|
|
545
|
+
/**
|
|
546
|
+
* Internal server error
|
|
547
|
+
*/
|
|
548
|
+
500: unknown;
|
|
549
|
+
};
|
|
550
|
+
|
|
551
|
+
export type PutConversationsResponses = {
|
|
552
|
+
/**
|
|
553
|
+
* Success
|
|
554
|
+
*/
|
|
555
|
+
200: unknown;
|
|
556
|
+
};
|
|
557
|
+
|
|
558
|
+
export type GetParticipantsData = {
|
|
559
|
+
body?: never;
|
|
560
|
+
path?: never;
|
|
561
|
+
query?: {
|
|
562
|
+
conversationId?: string;
|
|
563
|
+
participantId?: string;
|
|
564
|
+
};
|
|
565
|
+
url: '/participants';
|
|
566
|
+
};
|
|
567
|
+
|
|
568
|
+
export type GetParticipantsErrors = {
|
|
569
|
+
/**
|
|
570
|
+
* Unauthorized — requires Bearer token
|
|
571
|
+
*/
|
|
572
|
+
401: unknown;
|
|
573
|
+
/**
|
|
574
|
+
* Internal server error
|
|
575
|
+
*/
|
|
576
|
+
500: unknown;
|
|
577
|
+
};
|
|
578
|
+
|
|
579
|
+
export type GetParticipantsResponses = {
|
|
580
|
+
/**
|
|
581
|
+
* Success
|
|
582
|
+
*/
|
|
583
|
+
200: unknown;
|
|
584
|
+
};
|
|
585
|
+
|
|
586
|
+
export type PostParticipantsData = {
|
|
587
|
+
body: {
|
|
588
|
+
/**
|
|
589
|
+
* The Twilio conversation SID (required)
|
|
590
|
+
*/
|
|
591
|
+
conversationId: string;
|
|
592
|
+
/**
|
|
593
|
+
* Type of participant (required)
|
|
594
|
+
*/
|
|
595
|
+
participantType: string;
|
|
596
|
+
/**
|
|
597
|
+
* Communication addresses for this participant (required)
|
|
598
|
+
*/
|
|
599
|
+
addresses: string;
|
|
600
|
+
};
|
|
601
|
+
path?: never;
|
|
602
|
+
query?: never;
|
|
603
|
+
url: '/participants';
|
|
604
|
+
};
|
|
605
|
+
|
|
606
|
+
export type PostParticipantsErrors = {
|
|
607
|
+
/**
|
|
608
|
+
* Unauthorized — requires Bearer token
|
|
609
|
+
*/
|
|
610
|
+
401: unknown;
|
|
611
|
+
/**
|
|
612
|
+
* Internal server error
|
|
613
|
+
*/
|
|
614
|
+
500: unknown;
|
|
615
|
+
};
|
|
616
|
+
|
|
617
|
+
export type PostParticipantsResponses = {
|
|
618
|
+
/**
|
|
619
|
+
* Success
|
|
620
|
+
*/
|
|
621
|
+
200: unknown;
|
|
622
|
+
};
|
|
623
|
+
|
|
624
|
+
export type PutParticipantsData = {
|
|
625
|
+
body: {
|
|
626
|
+
/**
|
|
627
|
+
* The conversation ID (required)
|
|
628
|
+
*/
|
|
629
|
+
conversationId: string;
|
|
630
|
+
/**
|
|
631
|
+
* The participant ID to update (required)
|
|
632
|
+
*/
|
|
633
|
+
participantId: string;
|
|
634
|
+
};
|
|
635
|
+
path?: never;
|
|
636
|
+
query?: never;
|
|
637
|
+
url: '/participants';
|
|
638
|
+
};
|
|
639
|
+
|
|
640
|
+
export type PutParticipantsErrors = {
|
|
641
|
+
/**
|
|
642
|
+
* Unauthorized — requires Bearer token
|
|
643
|
+
*/
|
|
644
|
+
401: unknown;
|
|
645
|
+
/**
|
|
646
|
+
* Internal server error
|
|
647
|
+
*/
|
|
648
|
+
500: unknown;
|
|
649
|
+
};
|
|
650
|
+
|
|
651
|
+
export type PutParticipantsResponses = {
|
|
652
|
+
/**
|
|
653
|
+
* Success
|
|
654
|
+
*/
|
|
655
|
+
200: unknown;
|
|
656
|
+
};
|
|
657
|
+
|
|
658
|
+
export type DeleteConversationalIntelligenceOperatorData = {
|
|
659
|
+
body: {
|
|
660
|
+
/**
|
|
661
|
+
* The operator ID to delete (required)
|
|
662
|
+
*/
|
|
663
|
+
intelligenceOperatorId: string;
|
|
664
|
+
};
|
|
665
|
+
path?: never;
|
|
666
|
+
query?: never;
|
|
667
|
+
url: '/conversational-intelligence-operator';
|
|
668
|
+
};
|
|
669
|
+
|
|
670
|
+
export type DeleteConversationalIntelligenceOperatorErrors = {
|
|
671
|
+
/**
|
|
672
|
+
* Unauthorized — requires Bearer token
|
|
673
|
+
*/
|
|
674
|
+
401: unknown;
|
|
675
|
+
/**
|
|
676
|
+
* Internal server error
|
|
677
|
+
*/
|
|
678
|
+
500: unknown;
|
|
679
|
+
};
|
|
680
|
+
|
|
681
|
+
export type DeleteConversationalIntelligenceOperatorResponses = {
|
|
682
|
+
/**
|
|
683
|
+
* Success
|
|
684
|
+
*/
|
|
685
|
+
200: unknown;
|
|
686
|
+
};
|
|
687
|
+
|
|
688
|
+
export type GetConversationalIntelligenceOperatorData = {
|
|
689
|
+
body?: never;
|
|
690
|
+
path?: never;
|
|
691
|
+
query?: {
|
|
692
|
+
intelligenceOperatorId?: string;
|
|
693
|
+
pageToken?: string;
|
|
694
|
+
};
|
|
695
|
+
url: '/conversational-intelligence-operator';
|
|
696
|
+
};
|
|
697
|
+
|
|
698
|
+
export type GetConversationalIntelligenceOperatorErrors = {
|
|
699
|
+
/**
|
|
700
|
+
* Unauthorized — requires Bearer token
|
|
701
|
+
*/
|
|
702
|
+
401: unknown;
|
|
703
|
+
/**
|
|
704
|
+
* Internal server error
|
|
705
|
+
*/
|
|
706
|
+
500: unknown;
|
|
707
|
+
};
|
|
708
|
+
|
|
709
|
+
export type GetConversationalIntelligenceOperatorResponses = {
|
|
710
|
+
/**
|
|
711
|
+
* Success
|
|
712
|
+
*/
|
|
713
|
+
200: unknown;
|
|
714
|
+
};
|
|
715
|
+
|
|
716
|
+
export type PostConversationalIntelligenceOperatorData = {
|
|
717
|
+
body: {
|
|
718
|
+
/**
|
|
719
|
+
* The author of the operator (required)
|
|
720
|
+
*/
|
|
721
|
+
author: string;
|
|
722
|
+
/**
|
|
723
|
+
* Human-readable name for the operator (required)
|
|
724
|
+
*/
|
|
725
|
+
displayName: string;
|
|
726
|
+
/**
|
|
727
|
+
* Description of what the operator does (required)
|
|
728
|
+
*/
|
|
729
|
+
description: string;
|
|
730
|
+
/**
|
|
731
|
+
* The AI prompt used to analyze conversations (required)
|
|
732
|
+
*/
|
|
733
|
+
prompt: string;
|
|
734
|
+
/**
|
|
735
|
+
* JSON schema type for the output value, e.g., 'string', 'boolean', 'number' (required)
|
|
736
|
+
*/
|
|
737
|
+
valueType: string;
|
|
738
|
+
/**
|
|
739
|
+
* UI rendering hint for displaying results (required)
|
|
740
|
+
*/
|
|
741
|
+
uiType: string;
|
|
742
|
+
};
|
|
743
|
+
path?: never;
|
|
744
|
+
query?: never;
|
|
745
|
+
url: '/conversational-intelligence-operator';
|
|
746
|
+
};
|
|
747
|
+
|
|
748
|
+
export type PostConversationalIntelligenceOperatorErrors = {
|
|
749
|
+
/**
|
|
750
|
+
* Unauthorized — requires Bearer token
|
|
751
|
+
*/
|
|
752
|
+
401: unknown;
|
|
753
|
+
/**
|
|
754
|
+
* Internal server error
|
|
755
|
+
*/
|
|
756
|
+
500: unknown;
|
|
757
|
+
};
|
|
758
|
+
|
|
759
|
+
export type PostConversationalIntelligenceOperatorResponses = {
|
|
760
|
+
/**
|
|
761
|
+
* Success
|
|
762
|
+
*/
|
|
763
|
+
200: unknown;
|
|
764
|
+
};
|
|
765
|
+
|
|
766
|
+
export type PutConversationalIntelligenceOperatorData = {
|
|
767
|
+
body: {
|
|
768
|
+
/**
|
|
769
|
+
* Human-readable name for the operator (required)
|
|
770
|
+
*/
|
|
771
|
+
displayName: string;
|
|
772
|
+
/**
|
|
773
|
+
* Description of what the operator does (required)
|
|
774
|
+
*/
|
|
775
|
+
description: string;
|
|
776
|
+
/**
|
|
777
|
+
* The AI prompt used to analyze conversations (required)
|
|
778
|
+
*/
|
|
779
|
+
prompt: string;
|
|
780
|
+
/**
|
|
781
|
+
* JSON schema type for the output value, e.g., 'string', 'boolean', 'number' (required)
|
|
782
|
+
*/
|
|
783
|
+
valueType: string;
|
|
784
|
+
/**
|
|
785
|
+
* UI rendering hint for displaying results (required)
|
|
786
|
+
*/
|
|
787
|
+
uiType: string;
|
|
788
|
+
/**
|
|
789
|
+
* The ID of the operator to retrieve (required)
|
|
790
|
+
*/
|
|
791
|
+
intelligenceOperatorId: string;
|
|
792
|
+
};
|
|
793
|
+
path?: never;
|
|
794
|
+
query?: never;
|
|
795
|
+
url: '/conversational-intelligence-operator';
|
|
796
|
+
};
|
|
797
|
+
|
|
798
|
+
export type PutConversationalIntelligenceOperatorErrors = {
|
|
799
|
+
/**
|
|
800
|
+
* Unauthorized — requires Bearer token
|
|
801
|
+
*/
|
|
802
|
+
401: unknown;
|
|
803
|
+
/**
|
|
804
|
+
* Internal server error
|
|
805
|
+
*/
|
|
806
|
+
500: unknown;
|
|
807
|
+
};
|
|
808
|
+
|
|
809
|
+
export type PutConversationalIntelligenceOperatorResponses = {
|
|
810
|
+
/**
|
|
811
|
+
* Success
|
|
812
|
+
*/
|
|
813
|
+
200: unknown;
|
|
814
|
+
};
|
|
815
|
+
|
|
816
|
+
export type GetIntelligenceConfigurationData = {
|
|
817
|
+
body?: never;
|
|
818
|
+
path?: never;
|
|
819
|
+
query?: {
|
|
820
|
+
intelligenceConfigurationId?: string;
|
|
821
|
+
pageToken?: string;
|
|
822
|
+
};
|
|
823
|
+
url: '/intelligence-configuration';
|
|
824
|
+
};
|
|
825
|
+
|
|
826
|
+
export type GetIntelligenceConfigurationErrors = {
|
|
827
|
+
/**
|
|
828
|
+
* Unauthorized — requires Bearer token
|
|
829
|
+
*/
|
|
830
|
+
401: unknown;
|
|
831
|
+
/**
|
|
832
|
+
* Internal server error
|
|
833
|
+
*/
|
|
834
|
+
500: unknown;
|
|
835
|
+
};
|
|
836
|
+
|
|
837
|
+
export type GetIntelligenceConfigurationResponses = {
|
|
838
|
+
/**
|
|
839
|
+
* Success
|
|
840
|
+
*/
|
|
841
|
+
200: unknown;
|
|
842
|
+
};
|
|
843
|
+
|
|
844
|
+
export type PostIntelligenceConfigurationData = {
|
|
845
|
+
body: {
|
|
846
|
+
[key: string]: unknown;
|
|
847
|
+
};
|
|
848
|
+
path?: never;
|
|
849
|
+
query?: never;
|
|
850
|
+
url: '/intelligence-configuration';
|
|
851
|
+
};
|
|
852
|
+
|
|
853
|
+
export type PostIntelligenceConfigurationErrors = {
|
|
854
|
+
/**
|
|
855
|
+
* Unauthorized — requires Bearer token
|
|
856
|
+
*/
|
|
857
|
+
401: unknown;
|
|
858
|
+
/**
|
|
859
|
+
* Internal server error
|
|
860
|
+
*/
|
|
861
|
+
500: unknown;
|
|
862
|
+
};
|
|
863
|
+
|
|
864
|
+
export type PostIntelligenceConfigurationResponses = {
|
|
865
|
+
/**
|
|
866
|
+
* Success
|
|
867
|
+
*/
|
|
868
|
+
200: unknown;
|
|
869
|
+
};
|
|
870
|
+
|
|
871
|
+
export type PutIntelligenceConfigurationData = {
|
|
872
|
+
body: {
|
|
873
|
+
/**
|
|
874
|
+
* The configuration ID to update (required)
|
|
875
|
+
*/
|
|
876
|
+
intelligenceConfigurationId: string;
|
|
877
|
+
};
|
|
878
|
+
path?: never;
|
|
879
|
+
query?: never;
|
|
880
|
+
url: '/intelligence-configuration';
|
|
881
|
+
};
|
|
882
|
+
|
|
883
|
+
export type PutIntelligenceConfigurationErrors = {
|
|
884
|
+
/**
|
|
885
|
+
* Unauthorized — requires Bearer token
|
|
886
|
+
*/
|
|
887
|
+
401: unknown;
|
|
888
|
+
/**
|
|
889
|
+
* Internal server error
|
|
890
|
+
*/
|
|
891
|
+
500: unknown;
|
|
892
|
+
};
|
|
893
|
+
|
|
894
|
+
export type PutIntelligenceConfigurationResponses = {
|
|
895
|
+
/**
|
|
896
|
+
* Success
|
|
897
|
+
*/
|
|
898
|
+
200: unknown;
|
|
899
|
+
};
|
|
900
|
+
|
|
901
|
+
export type DeleteConversationMemoryProfilesData = {
|
|
902
|
+
body?: never;
|
|
903
|
+
path?: never;
|
|
904
|
+
query?: {
|
|
905
|
+
storeId?: string;
|
|
906
|
+
profileId?: string;
|
|
907
|
+
};
|
|
908
|
+
url: '/conversation-memory-profiles';
|
|
909
|
+
};
|
|
910
|
+
|
|
911
|
+
export type DeleteConversationMemoryProfilesErrors = {
|
|
912
|
+
/**
|
|
913
|
+
* Unauthorized — requires Bearer token
|
|
914
|
+
*/
|
|
915
|
+
401: unknown;
|
|
916
|
+
/**
|
|
917
|
+
* Internal server error
|
|
918
|
+
*/
|
|
919
|
+
500: unknown;
|
|
920
|
+
};
|
|
921
|
+
|
|
922
|
+
export type DeleteConversationMemoryProfilesResponses = {
|
|
923
|
+
/**
|
|
924
|
+
* Success
|
|
925
|
+
*/
|
|
926
|
+
200: unknown;
|
|
927
|
+
};
|
|
928
|
+
|
|
929
|
+
export type GetConversationMemoryProfilesData = {
|
|
930
|
+
body?: never;
|
|
931
|
+
path?: never;
|
|
932
|
+
query?: {
|
|
933
|
+
storeId?: string;
|
|
934
|
+
profileId?: string;
|
|
935
|
+
traitGroups?: string;
|
|
936
|
+
pageSize?: string;
|
|
937
|
+
pageToken?: string;
|
|
938
|
+
orderBy?: string;
|
|
939
|
+
};
|
|
940
|
+
url: '/conversation-memory-profiles';
|
|
941
|
+
};
|
|
942
|
+
|
|
943
|
+
export type GetConversationMemoryProfilesErrors = {
|
|
944
|
+
/**
|
|
945
|
+
* Unauthorized — requires Bearer token
|
|
946
|
+
*/
|
|
947
|
+
401: unknown;
|
|
948
|
+
/**
|
|
949
|
+
* Internal server error
|
|
950
|
+
*/
|
|
951
|
+
500: unknown;
|
|
952
|
+
};
|
|
953
|
+
|
|
954
|
+
export type GetConversationMemoryProfilesResponses = {
|
|
955
|
+
/**
|
|
956
|
+
* Success
|
|
957
|
+
*/
|
|
958
|
+
200: unknown;
|
|
959
|
+
};
|
|
960
|
+
|
|
961
|
+
export type PatchConversationMemoryProfilesData = {
|
|
962
|
+
body: {
|
|
963
|
+
/**
|
|
964
|
+
* The Memory Store ID (required)
|
|
965
|
+
*/
|
|
966
|
+
storeId: string;
|
|
967
|
+
/**
|
|
968
|
+
* The Profile ID (required)
|
|
969
|
+
*/
|
|
970
|
+
profileId: string;
|
|
971
|
+
/**
|
|
972
|
+
* Trait groups with key-value pairs to merge (required)
|
|
973
|
+
*/
|
|
974
|
+
traits: string;
|
|
975
|
+
};
|
|
976
|
+
path?: never;
|
|
977
|
+
query?: never;
|
|
978
|
+
url: '/conversation-memory-profiles';
|
|
979
|
+
};
|
|
980
|
+
|
|
981
|
+
export type PatchConversationMemoryProfilesErrors = {
|
|
982
|
+
/**
|
|
983
|
+
* Unauthorized — requires Bearer token
|
|
984
|
+
*/
|
|
985
|
+
401: unknown;
|
|
986
|
+
/**
|
|
987
|
+
* Internal server error
|
|
988
|
+
*/
|
|
989
|
+
500: unknown;
|
|
990
|
+
};
|
|
991
|
+
|
|
992
|
+
export type PatchConversationMemoryProfilesResponses = {
|
|
993
|
+
/**
|
|
994
|
+
* Success
|
|
995
|
+
*/
|
|
996
|
+
200: unknown;
|
|
997
|
+
};
|
|
998
|
+
|
|
999
|
+
export type PostConversationMemoryProfilesData = {
|
|
1000
|
+
body: {
|
|
1001
|
+
/**
|
|
1002
|
+
* The Memory Store ID (required)
|
|
1003
|
+
*/
|
|
1004
|
+
storeId: string;
|
|
1005
|
+
/**
|
|
1006
|
+
* Trait groups with key-value pairs (required)
|
|
1007
|
+
*/
|
|
1008
|
+
traits: string;
|
|
1009
|
+
};
|
|
1010
|
+
path?: never;
|
|
1011
|
+
query?: never;
|
|
1012
|
+
url: '/conversation-memory-profiles';
|
|
1013
|
+
};
|
|
1014
|
+
|
|
1015
|
+
export type PostConversationMemoryProfilesErrors = {
|
|
1016
|
+
/**
|
|
1017
|
+
* Unauthorized — requires Bearer token
|
|
1018
|
+
*/
|
|
1019
|
+
401: unknown;
|
|
1020
|
+
/**
|
|
1021
|
+
* Internal server error
|
|
1022
|
+
*/
|
|
1023
|
+
500: unknown;
|
|
1024
|
+
};
|
|
1025
|
+
|
|
1026
|
+
export type PostConversationMemoryProfilesResponses = {
|
|
1027
|
+
/**
|
|
1028
|
+
* Success
|
|
1029
|
+
*/
|
|
1030
|
+
200: unknown;
|
|
1031
|
+
};
|
|
1032
|
+
|
|
1033
|
+
export type PostConversationMemoryProfilesLookupData = {
|
|
1034
|
+
body: {
|
|
1035
|
+
/**
|
|
1036
|
+
* The Memory Store ID (required)
|
|
1037
|
+
*/
|
|
1038
|
+
storeId: string;
|
|
1039
|
+
/**
|
|
1040
|
+
* Identifier type (e.g., phone, email) (required)
|
|
1041
|
+
*/
|
|
1042
|
+
idType: string;
|
|
1043
|
+
/**
|
|
1044
|
+
* Raw identifier value to search for (required)
|
|
1045
|
+
*/
|
|
1046
|
+
value: string;
|
|
1047
|
+
};
|
|
1048
|
+
path?: never;
|
|
1049
|
+
query?: never;
|
|
1050
|
+
url: '/conversation-memory-profiles-lookup';
|
|
1051
|
+
};
|
|
1052
|
+
|
|
1053
|
+
export type PostConversationMemoryProfilesLookupErrors = {
|
|
1054
|
+
/**
|
|
1055
|
+
* Unauthorized — requires Bearer token
|
|
1056
|
+
*/
|
|
1057
|
+
401: unknown;
|
|
1058
|
+
/**
|
|
1059
|
+
* Internal server error
|
|
1060
|
+
*/
|
|
1061
|
+
500: unknown;
|
|
1062
|
+
};
|
|
1063
|
+
|
|
1064
|
+
export type PostConversationMemoryProfilesLookupResponses = {
|
|
1065
|
+
/**
|
|
1066
|
+
* Success
|
|
1067
|
+
*/
|
|
1068
|
+
200: unknown;
|
|
1069
|
+
};
|
|
1070
|
+
|
|
1071
|
+
export type PostConversationMemoryRecallData = {
|
|
1072
|
+
body: {
|
|
1073
|
+
/**
|
|
1074
|
+
* The Memory Store ID (required)
|
|
1075
|
+
*/
|
|
1076
|
+
storeId: string;
|
|
1077
|
+
/**
|
|
1078
|
+
* The Profile ID (required)
|
|
1079
|
+
*/
|
|
1080
|
+
profileId: string;
|
|
1081
|
+
};
|
|
1082
|
+
path?: never;
|
|
1083
|
+
query?: never;
|
|
1084
|
+
url: '/conversation-memory-recall';
|
|
1085
|
+
};
|
|
1086
|
+
|
|
1087
|
+
export type PostConversationMemoryRecallErrors = {
|
|
1088
|
+
/**
|
|
1089
|
+
* Unauthorized — requires Bearer token
|
|
1090
|
+
*/
|
|
1091
|
+
401: unknown;
|
|
1092
|
+
/**
|
|
1093
|
+
* Internal server error
|
|
1094
|
+
*/
|
|
1095
|
+
500: unknown;
|
|
1096
|
+
};
|
|
1097
|
+
|
|
1098
|
+
export type PostConversationMemoryRecallResponses = {
|
|
1099
|
+
/**
|
|
1100
|
+
* Success
|
|
1101
|
+
*/
|
|
1102
|
+
200: unknown;
|
|
1103
|
+
};
|
|
1104
|
+
|
|
1105
|
+
export type DeleteConversationMemoryIdentifiersData = {
|
|
1106
|
+
body?: never;
|
|
1107
|
+
path?: never;
|
|
1108
|
+
query?: {
|
|
1109
|
+
storeId?: string;
|
|
1110
|
+
profileId?: string;
|
|
1111
|
+
idType?: string;
|
|
1112
|
+
removeAll?: string;
|
|
1113
|
+
};
|
|
1114
|
+
url: '/conversation-memory-identifiers';
|
|
1115
|
+
};
|
|
1116
|
+
|
|
1117
|
+
export type DeleteConversationMemoryIdentifiersErrors = {
|
|
1118
|
+
/**
|
|
1119
|
+
* Unauthorized — requires Bearer token
|
|
1120
|
+
*/
|
|
1121
|
+
401: unknown;
|
|
1122
|
+
/**
|
|
1123
|
+
* Internal server error
|
|
1124
|
+
*/
|
|
1125
|
+
500: unknown;
|
|
1126
|
+
};
|
|
1127
|
+
|
|
1128
|
+
export type DeleteConversationMemoryIdentifiersResponses = {
|
|
1129
|
+
/**
|
|
1130
|
+
* Success
|
|
1131
|
+
*/
|
|
1132
|
+
200: unknown;
|
|
1133
|
+
};
|
|
1134
|
+
|
|
1135
|
+
export type GetConversationMemoryIdentifiersData = {
|
|
1136
|
+
body?: never;
|
|
1137
|
+
path?: never;
|
|
1138
|
+
query?: {
|
|
1139
|
+
storeId?: string;
|
|
1140
|
+
profileId?: string;
|
|
1141
|
+
idType?: string;
|
|
1142
|
+
};
|
|
1143
|
+
url: '/conversation-memory-identifiers';
|
|
1144
|
+
};
|
|
1145
|
+
|
|
1146
|
+
export type GetConversationMemoryIdentifiersErrors = {
|
|
1147
|
+
/**
|
|
1148
|
+
* Unauthorized — requires Bearer token
|
|
1149
|
+
*/
|
|
1150
|
+
401: unknown;
|
|
1151
|
+
/**
|
|
1152
|
+
* Internal server error
|
|
1153
|
+
*/
|
|
1154
|
+
500: unknown;
|
|
1155
|
+
};
|
|
1156
|
+
|
|
1157
|
+
export type GetConversationMemoryIdentifiersResponses = {
|
|
1158
|
+
/**
|
|
1159
|
+
* Success
|
|
1160
|
+
*/
|
|
1161
|
+
200: unknown;
|
|
1162
|
+
};
|
|
1163
|
+
|
|
1164
|
+
export type PatchConversationMemoryIdentifiersData = {
|
|
1165
|
+
body: {
|
|
1166
|
+
/**
|
|
1167
|
+
* The Memory Store ID (required)
|
|
1168
|
+
*/
|
|
1169
|
+
storeId: string;
|
|
1170
|
+
/**
|
|
1171
|
+
* The Profile ID (required)
|
|
1172
|
+
*/
|
|
1173
|
+
profileId: string;
|
|
1174
|
+
/**
|
|
1175
|
+
* Identifier type to update (required)
|
|
1176
|
+
*/
|
|
1177
|
+
idType: string;
|
|
1178
|
+
/**
|
|
1179
|
+
* Existing stored value to replace (required)
|
|
1180
|
+
*/
|
|
1181
|
+
oldValue: string;
|
|
1182
|
+
/**
|
|
1183
|
+
* New value to store (required)
|
|
1184
|
+
*/
|
|
1185
|
+
newValue: string;
|
|
1186
|
+
};
|
|
1187
|
+
path?: never;
|
|
1188
|
+
query?: never;
|
|
1189
|
+
url: '/conversation-memory-identifiers';
|
|
1190
|
+
};
|
|
1191
|
+
|
|
1192
|
+
export type PatchConversationMemoryIdentifiersErrors = {
|
|
1193
|
+
/**
|
|
1194
|
+
* Unauthorized — requires Bearer token
|
|
1195
|
+
*/
|
|
1196
|
+
401: unknown;
|
|
1197
|
+
/**
|
|
1198
|
+
* Internal server error
|
|
1199
|
+
*/
|
|
1200
|
+
500: unknown;
|
|
1201
|
+
};
|
|
1202
|
+
|
|
1203
|
+
export type PatchConversationMemoryIdentifiersResponses = {
|
|
1204
|
+
/**
|
|
1205
|
+
* Success
|
|
1206
|
+
*/
|
|
1207
|
+
200: unknown;
|
|
1208
|
+
};
|
|
1209
|
+
|
|
1210
|
+
export type PostConversationMemoryIdentifiersData = {
|
|
1211
|
+
body: {
|
|
1212
|
+
/**
|
|
1213
|
+
* The Memory Store ID (required)
|
|
1214
|
+
*/
|
|
1215
|
+
storeId: string;
|
|
1216
|
+
/**
|
|
1217
|
+
* The Profile ID (required)
|
|
1218
|
+
*/
|
|
1219
|
+
profileId: string;
|
|
1220
|
+
/**
|
|
1221
|
+
* Identifier type (e.g., phone, email) (required)
|
|
1222
|
+
*/
|
|
1223
|
+
idType: string;
|
|
1224
|
+
/**
|
|
1225
|
+
* Raw identifier value (required)
|
|
1226
|
+
*/
|
|
1227
|
+
value: string;
|
|
1228
|
+
};
|
|
1229
|
+
path?: never;
|
|
1230
|
+
query?: never;
|
|
1231
|
+
url: '/conversation-memory-identifiers';
|
|
1232
|
+
};
|
|
1233
|
+
|
|
1234
|
+
export type PostConversationMemoryIdentifiersErrors = {
|
|
1235
|
+
/**
|
|
1236
|
+
* Unauthorized — requires Bearer token
|
|
1237
|
+
*/
|
|
1238
|
+
401: unknown;
|
|
1239
|
+
/**
|
|
1240
|
+
* Internal server error
|
|
1241
|
+
*/
|
|
1242
|
+
500: unknown;
|
|
1243
|
+
};
|
|
1244
|
+
|
|
1245
|
+
export type PostConversationMemoryIdentifiersResponses = {
|
|
1246
|
+
/**
|
|
1247
|
+
* Success
|
|
1248
|
+
*/
|
|
1249
|
+
200: unknown;
|
|
1250
|
+
};
|
|
1251
|
+
|
|
1252
|
+
export type DeleteConversationMemoryTraitGroupsData = {
|
|
1253
|
+
body?: never;
|
|
1254
|
+
path?: never;
|
|
1255
|
+
query?: {
|
|
1256
|
+
storeId?: string;
|
|
1257
|
+
traitGroupName?: string;
|
|
1258
|
+
};
|
|
1259
|
+
url: '/conversation-memory-trait-groups';
|
|
1260
|
+
};
|
|
1261
|
+
|
|
1262
|
+
export type DeleteConversationMemoryTraitGroupsErrors = {
|
|
1263
|
+
/**
|
|
1264
|
+
* Unauthorized — requires Bearer token
|
|
1265
|
+
*/
|
|
1266
|
+
401: unknown;
|
|
1267
|
+
/**
|
|
1268
|
+
* Internal server error
|
|
1269
|
+
*/
|
|
1270
|
+
500: unknown;
|
|
1271
|
+
};
|
|
1272
|
+
|
|
1273
|
+
export type DeleteConversationMemoryTraitGroupsResponses = {
|
|
1274
|
+
/**
|
|
1275
|
+
* Success
|
|
1276
|
+
*/
|
|
1277
|
+
200: unknown;
|
|
1278
|
+
};
|
|
1279
|
+
|
|
1280
|
+
export type GetConversationMemoryTraitGroupsData = {
|
|
1281
|
+
body?: never;
|
|
1282
|
+
path?: never;
|
|
1283
|
+
query?: {
|
|
1284
|
+
storeId?: string;
|
|
1285
|
+
traitGroupName?: string;
|
|
1286
|
+
includeTraits?: string;
|
|
1287
|
+
pageSize?: string;
|
|
1288
|
+
pageToken?: string;
|
|
1289
|
+
orderBy?: string;
|
|
1290
|
+
};
|
|
1291
|
+
url: '/conversation-memory-trait-groups';
|
|
1292
|
+
};
|
|
1293
|
+
|
|
1294
|
+
export type GetConversationMemoryTraitGroupsErrors = {
|
|
1295
|
+
/**
|
|
1296
|
+
* Unauthorized — requires Bearer token
|
|
1297
|
+
*/
|
|
1298
|
+
401: unknown;
|
|
1299
|
+
/**
|
|
1300
|
+
* Internal server error
|
|
1301
|
+
*/
|
|
1302
|
+
500: unknown;
|
|
1303
|
+
};
|
|
1304
|
+
|
|
1305
|
+
export type GetConversationMemoryTraitGroupsResponses = {
|
|
1306
|
+
/**
|
|
1307
|
+
* Success
|
|
1308
|
+
*/
|
|
1309
|
+
200: unknown;
|
|
1310
|
+
};
|
|
1311
|
+
|
|
1312
|
+
export type PatchConversationMemoryTraitGroupsData = {
|
|
1313
|
+
body: {
|
|
1314
|
+
/**
|
|
1315
|
+
* The Memory Store ID (required)
|
|
1316
|
+
*/
|
|
1317
|
+
storeId: string;
|
|
1318
|
+
/**
|
|
1319
|
+
* The Trait Group name to update (required)
|
|
1320
|
+
*/
|
|
1321
|
+
traitGroupName: string;
|
|
1322
|
+
};
|
|
1323
|
+
path?: never;
|
|
1324
|
+
query?: never;
|
|
1325
|
+
url: '/conversation-memory-trait-groups';
|
|
1326
|
+
};
|
|
1327
|
+
|
|
1328
|
+
export type PatchConversationMemoryTraitGroupsErrors = {
|
|
1329
|
+
/**
|
|
1330
|
+
* Unauthorized — requires Bearer token
|
|
1331
|
+
*/
|
|
1332
|
+
401: unknown;
|
|
1333
|
+
/**
|
|
1334
|
+
* Internal server error
|
|
1335
|
+
*/
|
|
1336
|
+
500: unknown;
|
|
1337
|
+
};
|
|
1338
|
+
|
|
1339
|
+
export type PatchConversationMemoryTraitGroupsResponses = {
|
|
1340
|
+
/**
|
|
1341
|
+
* Success
|
|
1342
|
+
*/
|
|
1343
|
+
200: unknown;
|
|
1344
|
+
};
|
|
1345
|
+
|
|
1346
|
+
export type PostConversationMemoryTraitGroupsData = {
|
|
1347
|
+
body: {
|
|
1348
|
+
/**
|
|
1349
|
+
* The Memory Store ID (required)
|
|
1350
|
+
*/
|
|
1351
|
+
storeId: string;
|
|
1352
|
+
/**
|
|
1353
|
+
* Unique name of the Trait Group (required, 1-64 chars)
|
|
1354
|
+
*/
|
|
1355
|
+
displayName: string;
|
|
1356
|
+
};
|
|
1357
|
+
path?: never;
|
|
1358
|
+
query?: never;
|
|
1359
|
+
url: '/conversation-memory-trait-groups';
|
|
1360
|
+
};
|
|
1361
|
+
|
|
1362
|
+
export type PostConversationMemoryTraitGroupsErrors = {
|
|
1363
|
+
/**
|
|
1364
|
+
* Unauthorized — requires Bearer token
|
|
1365
|
+
*/
|
|
1366
|
+
401: unknown;
|
|
1367
|
+
/**
|
|
1368
|
+
* Internal server error
|
|
1369
|
+
*/
|
|
1370
|
+
500: unknown;
|
|
1371
|
+
};
|
|
1372
|
+
|
|
1373
|
+
export type PostConversationMemoryTraitGroupsResponses = {
|
|
1374
|
+
/**
|
|
1375
|
+
* Success
|
|
1376
|
+
*/
|
|
1377
|
+
200: unknown;
|
|
1378
|
+
};
|
|
1379
|
+
|
|
1380
|
+
export type GetConversationMemoryTraitsData = {
|
|
1381
|
+
body?: never;
|
|
1382
|
+
path?: never;
|
|
1383
|
+
query?: {
|
|
1384
|
+
storeId?: string;
|
|
1385
|
+
profileId?: string;
|
|
1386
|
+
pageSize?: string;
|
|
1387
|
+
pageToken?: string;
|
|
1388
|
+
orderBy?: string;
|
|
1389
|
+
traitGroups?: string;
|
|
1390
|
+
};
|
|
1391
|
+
url: '/conversation-memory-traits';
|
|
1392
|
+
};
|
|
1393
|
+
|
|
1394
|
+
export type GetConversationMemoryTraitsErrors = {
|
|
1395
|
+
/**
|
|
1396
|
+
* Unauthorized — requires Bearer token
|
|
1397
|
+
*/
|
|
1398
|
+
401: unknown;
|
|
1399
|
+
/**
|
|
1400
|
+
* Internal server error
|
|
1401
|
+
*/
|
|
1402
|
+
500: unknown;
|
|
1403
|
+
};
|
|
1404
|
+
|
|
1405
|
+
export type GetConversationMemoryTraitsResponses = {
|
|
1406
|
+
/**
|
|
1407
|
+
* Success
|
|
1408
|
+
*/
|
|
1409
|
+
200: unknown;
|
|
1410
|
+
};
|
|
1411
|
+
|
|
1412
|
+
export type DeleteConversationMemoryObservationsData = {
|
|
1413
|
+
body?: never;
|
|
1414
|
+
path?: never;
|
|
1415
|
+
query?: {
|
|
1416
|
+
storeId?: string;
|
|
1417
|
+
profileId?: string;
|
|
1418
|
+
observationId?: string;
|
|
1419
|
+
};
|
|
1420
|
+
url: '/conversation-memory-observations';
|
|
1421
|
+
};
|
|
1422
|
+
|
|
1423
|
+
export type DeleteConversationMemoryObservationsErrors = {
|
|
1424
|
+
/**
|
|
1425
|
+
* Unauthorized — requires Bearer token
|
|
1426
|
+
*/
|
|
1427
|
+
401: unknown;
|
|
1428
|
+
/**
|
|
1429
|
+
* Internal server error
|
|
1430
|
+
*/
|
|
1431
|
+
500: unknown;
|
|
1432
|
+
};
|
|
1433
|
+
|
|
1434
|
+
export type DeleteConversationMemoryObservationsResponses = {
|
|
1435
|
+
/**
|
|
1436
|
+
* Success
|
|
1437
|
+
*/
|
|
1438
|
+
200: unknown;
|
|
1439
|
+
};
|
|
1440
|
+
|
|
1441
|
+
export type GetConversationMemoryObservationsData = {
|
|
1442
|
+
body?: never;
|
|
1443
|
+
path?: never;
|
|
1444
|
+
query?: {
|
|
1445
|
+
storeId?: string;
|
|
1446
|
+
profileId?: string;
|
|
1447
|
+
observationId?: string;
|
|
1448
|
+
pageSize?: string;
|
|
1449
|
+
pageToken?: string;
|
|
1450
|
+
orderBy?: string;
|
|
1451
|
+
source?: string;
|
|
1452
|
+
createdAfter?: string;
|
|
1453
|
+
createdBefore?: string;
|
|
1454
|
+
};
|
|
1455
|
+
url: '/conversation-memory-observations';
|
|
1456
|
+
};
|
|
1457
|
+
|
|
1458
|
+
export type GetConversationMemoryObservationsErrors = {
|
|
1459
|
+
/**
|
|
1460
|
+
* Unauthorized — requires Bearer token
|
|
1461
|
+
*/
|
|
1462
|
+
401: unknown;
|
|
1463
|
+
/**
|
|
1464
|
+
* Internal server error
|
|
1465
|
+
*/
|
|
1466
|
+
500: unknown;
|
|
1467
|
+
};
|
|
1468
|
+
|
|
1469
|
+
export type GetConversationMemoryObservationsResponses = {
|
|
1470
|
+
/**
|
|
1471
|
+
* Success
|
|
1472
|
+
*/
|
|
1473
|
+
200: unknown;
|
|
1474
|
+
};
|
|
1475
|
+
|
|
1476
|
+
export type PatchConversationMemoryObservationsData = {
|
|
1477
|
+
body: {
|
|
1478
|
+
/**
|
|
1479
|
+
* The Memory Store ID (required)
|
|
1480
|
+
*/
|
|
1481
|
+
storeId: string;
|
|
1482
|
+
/**
|
|
1483
|
+
* The Profile ID (required)
|
|
1484
|
+
*/
|
|
1485
|
+
profileId: string;
|
|
1486
|
+
/**
|
|
1487
|
+
* The Observation ID to update (required)
|
|
1488
|
+
*/
|
|
1489
|
+
observationId: string;
|
|
1490
|
+
/**
|
|
1491
|
+
* Updated observation content (required)
|
|
1492
|
+
*/
|
|
1493
|
+
content: string;
|
|
1494
|
+
/**
|
|
1495
|
+
* Updated source system (required)
|
|
1496
|
+
*/
|
|
1497
|
+
source: string;
|
|
1498
|
+
/**
|
|
1499
|
+
* Updated occurrence timestamp (required)
|
|
1500
|
+
*/
|
|
1501
|
+
occurredAt: string;
|
|
1502
|
+
};
|
|
1503
|
+
path?: never;
|
|
1504
|
+
query?: never;
|
|
1505
|
+
url: '/conversation-memory-observations';
|
|
1506
|
+
};
|
|
1507
|
+
|
|
1508
|
+
export type PatchConversationMemoryObservationsErrors = {
|
|
1509
|
+
/**
|
|
1510
|
+
* Unauthorized — requires Bearer token
|
|
1511
|
+
*/
|
|
1512
|
+
401: unknown;
|
|
1513
|
+
/**
|
|
1514
|
+
* Internal server error
|
|
1515
|
+
*/
|
|
1516
|
+
500: unknown;
|
|
1517
|
+
};
|
|
1518
|
+
|
|
1519
|
+
export type PatchConversationMemoryObservationsResponses = {
|
|
1520
|
+
/**
|
|
1521
|
+
* Success
|
|
1522
|
+
*/
|
|
1523
|
+
200: unknown;
|
|
1524
|
+
};
|
|
1525
|
+
|
|
1526
|
+
export type PostConversationMemoryObservationsData = {
|
|
1527
|
+
body: {
|
|
1528
|
+
/**
|
|
1529
|
+
* The Memory Store ID (required)
|
|
1530
|
+
*/
|
|
1531
|
+
storeId: string;
|
|
1532
|
+
/**
|
|
1533
|
+
* The Profile ID (required)
|
|
1534
|
+
*/
|
|
1535
|
+
profileId: string;
|
|
1536
|
+
observations: string;
|
|
1537
|
+
};
|
|
1538
|
+
path?: never;
|
|
1539
|
+
query?: never;
|
|
1540
|
+
url: '/conversation-memory-observations';
|
|
1541
|
+
};
|
|
1542
|
+
|
|
1543
|
+
export type PostConversationMemoryObservationsErrors = {
|
|
1544
|
+
/**
|
|
1545
|
+
* Unauthorized — requires Bearer token
|
|
1546
|
+
*/
|
|
1547
|
+
401: unknown;
|
|
1548
|
+
/**
|
|
1549
|
+
* Internal server error
|
|
1550
|
+
*/
|
|
1551
|
+
500: unknown;
|
|
1552
|
+
};
|
|
1553
|
+
|
|
1554
|
+
export type PostConversationMemoryObservationsResponses = {
|
|
1555
|
+
/**
|
|
1556
|
+
* Success
|
|
1557
|
+
*/
|
|
1558
|
+
200: unknown;
|
|
1559
|
+
};
|
|
1560
|
+
|
|
1561
|
+
export type DeleteConversationMemoryConversationSummariesData = {
|
|
1562
|
+
body?: never;
|
|
1563
|
+
path?: never;
|
|
1564
|
+
query?: {
|
|
1565
|
+
storeId?: string;
|
|
1566
|
+
profileId?: string;
|
|
1567
|
+
summaryId?: string;
|
|
1568
|
+
};
|
|
1569
|
+
url: '/conversation-memory-conversation-summaries';
|
|
1570
|
+
};
|
|
1571
|
+
|
|
1572
|
+
export type DeleteConversationMemoryConversationSummariesErrors = {
|
|
1573
|
+
/**
|
|
1574
|
+
* Unauthorized — requires Bearer token
|
|
1575
|
+
*/
|
|
1576
|
+
401: unknown;
|
|
1577
|
+
/**
|
|
1578
|
+
* Internal server error
|
|
1579
|
+
*/
|
|
1580
|
+
500: unknown;
|
|
1581
|
+
};
|
|
1582
|
+
|
|
1583
|
+
export type DeleteConversationMemoryConversationSummariesResponses = {
|
|
1584
|
+
/**
|
|
1585
|
+
* Success
|
|
1586
|
+
*/
|
|
1587
|
+
200: unknown;
|
|
1588
|
+
};
|
|
1589
|
+
|
|
1590
|
+
export type GetConversationMemoryConversationSummariesData = {
|
|
1591
|
+
body?: never;
|
|
1592
|
+
path?: never;
|
|
1593
|
+
query?: {
|
|
1594
|
+
storeId?: string;
|
|
1595
|
+
profileId?: string;
|
|
1596
|
+
summaryId?: string;
|
|
1597
|
+
pageSize?: string;
|
|
1598
|
+
pageToken?: string;
|
|
1599
|
+
};
|
|
1600
|
+
url: '/conversation-memory-conversation-summaries';
|
|
1601
|
+
};
|
|
1602
|
+
|
|
1603
|
+
export type GetConversationMemoryConversationSummariesErrors = {
|
|
1604
|
+
/**
|
|
1605
|
+
* Unauthorized — requires Bearer token
|
|
1606
|
+
*/
|
|
1607
|
+
401: unknown;
|
|
1608
|
+
/**
|
|
1609
|
+
* Internal server error
|
|
1610
|
+
*/
|
|
1611
|
+
500: unknown;
|
|
1612
|
+
};
|
|
1613
|
+
|
|
1614
|
+
export type GetConversationMemoryConversationSummariesResponses = {
|
|
1615
|
+
/**
|
|
1616
|
+
* Success
|
|
1617
|
+
*/
|
|
1618
|
+
200: unknown;
|
|
1619
|
+
};
|
|
1620
|
+
|
|
1621
|
+
export type PatchConversationMemoryConversationSummariesData = {
|
|
1622
|
+
body: {
|
|
1623
|
+
/**
|
|
1624
|
+
* The Memory Store ID (required)
|
|
1625
|
+
*/
|
|
1626
|
+
storeId: string;
|
|
1627
|
+
/**
|
|
1628
|
+
* The Profile ID (required)
|
|
1629
|
+
*/
|
|
1630
|
+
profileId: string;
|
|
1631
|
+
/**
|
|
1632
|
+
* The Summary ID to update (required)
|
|
1633
|
+
*/
|
|
1634
|
+
summaryId: string;
|
|
1635
|
+
};
|
|
1636
|
+
path?: never;
|
|
1637
|
+
query?: never;
|
|
1638
|
+
url: '/conversation-memory-conversation-summaries';
|
|
1639
|
+
};
|
|
1640
|
+
|
|
1641
|
+
export type PatchConversationMemoryConversationSummariesErrors = {
|
|
1642
|
+
/**
|
|
1643
|
+
* Unauthorized — requires Bearer token
|
|
1644
|
+
*/
|
|
1645
|
+
401: unknown;
|
|
1646
|
+
/**
|
|
1647
|
+
* Internal server error
|
|
1648
|
+
*/
|
|
1649
|
+
500: unknown;
|
|
1650
|
+
};
|
|
1651
|
+
|
|
1652
|
+
export type PatchConversationMemoryConversationSummariesResponses = {
|
|
1653
|
+
/**
|
|
1654
|
+
* Success
|
|
1655
|
+
*/
|
|
1656
|
+
200: unknown;
|
|
1657
|
+
};
|
|
1658
|
+
|
|
1659
|
+
export type PostConversationMemoryConversationSummariesData = {
|
|
1660
|
+
body: {
|
|
1661
|
+
/**
|
|
1662
|
+
* The Memory Store ID (required)
|
|
1663
|
+
*/
|
|
1664
|
+
storeId: string;
|
|
1665
|
+
/**
|
|
1666
|
+
* The Profile ID (required)
|
|
1667
|
+
*/
|
|
1668
|
+
profileId: string;
|
|
1669
|
+
summaries: string;
|
|
1670
|
+
};
|
|
1671
|
+
path?: never;
|
|
1672
|
+
query?: never;
|
|
1673
|
+
url: '/conversation-memory-conversation-summaries';
|
|
1674
|
+
};
|
|
1675
|
+
|
|
1676
|
+
export type PostConversationMemoryConversationSummariesErrors = {
|
|
1677
|
+
/**
|
|
1678
|
+
* Unauthorized — requires Bearer token
|
|
1679
|
+
*/
|
|
1680
|
+
401: unknown;
|
|
1681
|
+
/**
|
|
1682
|
+
* Internal server error
|
|
1683
|
+
*/
|
|
1684
|
+
500: unknown;
|
|
1685
|
+
};
|
|
1686
|
+
|
|
1687
|
+
export type PostConversationMemoryConversationSummariesResponses = {
|
|
1688
|
+
/**
|
|
1689
|
+
* Success
|
|
1690
|
+
*/
|
|
1691
|
+
200: unknown;
|
|
1692
|
+
};
|
|
1693
|
+
|
|
1694
|
+
export type DeleteConversationMemoryResetData = {
|
|
1695
|
+
body?: never;
|
|
1696
|
+
path?: never;
|
|
1697
|
+
query?: never;
|
|
1698
|
+
url: '/conversation-memory-reset';
|
|
1699
|
+
};
|
|
1700
|
+
|
|
1701
|
+
export type DeleteConversationMemoryResetErrors = {
|
|
1702
|
+
/**
|
|
1703
|
+
* Unauthorized — requires Bearer token
|
|
1704
|
+
*/
|
|
1705
|
+
401: unknown;
|
|
1706
|
+
/**
|
|
1707
|
+
* Internal server error
|
|
1708
|
+
*/
|
|
1709
|
+
500: unknown;
|
|
1710
|
+
};
|
|
1711
|
+
|
|
1712
|
+
export type DeleteConversationMemoryResetResponses = {
|
|
1713
|
+
/**
|
|
1714
|
+
* Success
|
|
1715
|
+
*/
|
|
1716
|
+
200: unknown;
|
|
1717
|
+
};
|
|
1718
|
+
|
|
1719
|
+
export type PostAssignDemoData = {
|
|
1720
|
+
body: {
|
|
1721
|
+
/**
|
|
1722
|
+
* The phone number to assign (E.164 format)
|
|
1723
|
+
*/
|
|
1724
|
+
phoneNumber: string;
|
|
1725
|
+
/**
|
|
1726
|
+
* The Algolia objectID of the target template
|
|
1727
|
+
*/
|
|
1728
|
+
targetObjectID: string;
|
|
1729
|
+
};
|
|
1730
|
+
path?: never;
|
|
1731
|
+
query?: never;
|
|
1732
|
+
url: '/assign-demo';
|
|
1733
|
+
};
|
|
1734
|
+
|
|
1735
|
+
export type PostAssignDemoErrors = {
|
|
1736
|
+
/**
|
|
1737
|
+
* Unauthorized — requires Bearer token
|
|
1738
|
+
*/
|
|
1739
|
+
401: unknown;
|
|
1740
|
+
/**
|
|
1741
|
+
* Internal server error
|
|
1742
|
+
*/
|
|
1743
|
+
500: unknown;
|
|
1744
|
+
};
|
|
1745
|
+
|
|
1746
|
+
export type PostAssignDemoResponses = {
|
|
1747
|
+
/**
|
|
1748
|
+
* Success
|
|
1749
|
+
*/
|
|
1750
|
+
200: unknown;
|
|
1751
|
+
};
|
|
1752
|
+
|
|
1753
|
+
export type GetLookupDemoData = {
|
|
1754
|
+
body?: never;
|
|
1755
|
+
path?: never;
|
|
1756
|
+
query?: {
|
|
1757
|
+
phoneNumber?: string;
|
|
1758
|
+
};
|
|
1759
|
+
url: '/lookup-demo';
|
|
1760
|
+
};
|
|
1761
|
+
|
|
1762
|
+
export type GetLookupDemoErrors = {
|
|
1763
|
+
/**
|
|
1764
|
+
* Unauthorized — requires Bearer token
|
|
1765
|
+
*/
|
|
1766
|
+
401: unknown;
|
|
1767
|
+
/**
|
|
1768
|
+
* Internal server error
|
|
1769
|
+
*/
|
|
1770
|
+
500: unknown;
|
|
1771
|
+
};
|
|
1772
|
+
|
|
1773
|
+
export type GetLookupDemoResponses = {
|
|
1774
|
+
/**
|
|
1775
|
+
* Success
|
|
1776
|
+
*/
|
|
1777
|
+
200: unknown;
|
|
1778
|
+
};
|
|
1779
|
+
|
|
1780
|
+
export type PostTemplateAutogenData = {
|
|
1781
|
+
body: {
|
|
1782
|
+
/**
|
|
1783
|
+
* List of autogen requests (one per company)
|
|
1784
|
+
*/
|
|
1785
|
+
requests: Array<AutogenRequest>;
|
|
1786
|
+
/**
|
|
1787
|
+
* Tags to apply to all generated templates
|
|
1788
|
+
*/
|
|
1789
|
+
tags: Array<string>;
|
|
1790
|
+
/**
|
|
1791
|
+
* If true, saves templates to Algolia and Snowflake
|
|
1792
|
+
*/
|
|
1793
|
+
createTemplates: boolean;
|
|
1794
|
+
/**
|
|
1795
|
+
* If true, assigns a Twilio phone number to each template
|
|
1796
|
+
*/
|
|
1797
|
+
bindPhoneNumber: boolean;
|
|
1798
|
+
/**
|
|
1799
|
+
* Country code for phone number assignment (default: US)
|
|
1800
|
+
*/
|
|
1801
|
+
countryCode: string;
|
|
1802
|
+
/**
|
|
1803
|
+
* Tool keys to enable on saved templates
|
|
1804
|
+
*/
|
|
1805
|
+
tools: Array<string>;
|
|
1806
|
+
};
|
|
1807
|
+
path?: never;
|
|
1808
|
+
query?: never;
|
|
1809
|
+
url: '/template-autogen';
|
|
1810
|
+
};
|
|
1811
|
+
|
|
1812
|
+
export type PostTemplateAutogenErrors = {
|
|
1813
|
+
/**
|
|
1814
|
+
* Unauthorized — requires Bearer token
|
|
1815
|
+
*/
|
|
1816
|
+
401: unknown;
|
|
1817
|
+
/**
|
|
1818
|
+
* Internal server error
|
|
1819
|
+
*/
|
|
1820
|
+
500: unknown;
|
|
1821
|
+
};
|
|
1822
|
+
|
|
1823
|
+
export type PostTemplateAutogenResponses = {
|
|
1824
|
+
/**
|
|
1825
|
+
* Success
|
|
1826
|
+
*/
|
|
1827
|
+
200: unknown;
|
|
1828
|
+
};
|
|
1829
|
+
|
|
1830
|
+
export type DeleteTemplateData = {
|
|
1831
|
+
body?: never;
|
|
1832
|
+
path?: never;
|
|
1833
|
+
query?: {
|
|
1834
|
+
campaign?: string;
|
|
1835
|
+
};
|
|
1836
|
+
url: '/template';
|
|
1837
|
+
};
|
|
1838
|
+
|
|
1839
|
+
export type DeleteTemplateErrors = {
|
|
1840
|
+
/**
|
|
1841
|
+
* Unauthorized — requires Bearer token
|
|
1842
|
+
*/
|
|
1843
|
+
401: unknown;
|
|
1844
|
+
/**
|
|
1845
|
+
* Internal server error
|
|
1846
|
+
*/
|
|
1847
|
+
500: unknown;
|
|
1848
|
+
};
|
|
1849
|
+
|
|
1850
|
+
export type DeleteTemplateResponses = {
|
|
1851
|
+
/**
|
|
1852
|
+
* Success
|
|
1853
|
+
*/
|
|
1854
|
+
200: unknown;
|
|
1855
|
+
};
|
|
1856
|
+
|
|
1857
|
+
export type PostTemplateData = {
|
|
1858
|
+
body: {
|
|
1859
|
+
[key: string]: unknown;
|
|
1860
|
+
};
|
|
1861
|
+
path?: never;
|
|
1862
|
+
query?: never;
|
|
1863
|
+
url: '/template';
|
|
1864
|
+
};
|
|
1865
|
+
|
|
1866
|
+
export type PostTemplateErrors = {
|
|
1867
|
+
/**
|
|
1868
|
+
* Unauthorized — requires Bearer token
|
|
1869
|
+
*/
|
|
1870
|
+
401: unknown;
|
|
1871
|
+
/**
|
|
1872
|
+
* Internal server error
|
|
1873
|
+
*/
|
|
1874
|
+
500: unknown;
|
|
1875
|
+
};
|
|
1876
|
+
|
|
1877
|
+
export type PostTemplateResponses = {
|
|
1878
|
+
/**
|
|
1879
|
+
* Success
|
|
1880
|
+
*/
|
|
1881
|
+
200: unknown;
|
|
1882
|
+
};
|
|
1883
|
+
|
|
1884
|
+
export type GetCampaignData = {
|
|
1885
|
+
body?: never;
|
|
1886
|
+
path?: never;
|
|
1887
|
+
query?: {
|
|
1888
|
+
limit?: string;
|
|
1889
|
+
offset?: string;
|
|
1890
|
+
page?: string;
|
|
1891
|
+
tag?: string;
|
|
1892
|
+
objectId?: string;
|
|
1893
|
+
company?: string;
|
|
1894
|
+
includeCalledBy?: string;
|
|
1895
|
+
};
|
|
1896
|
+
url: '/campaign';
|
|
1897
|
+
};
|
|
1898
|
+
|
|
1899
|
+
export type GetCampaignErrors = {
|
|
1900
|
+
/**
|
|
1901
|
+
* Unauthorized — requires Bearer token
|
|
1902
|
+
*/
|
|
1903
|
+
401: unknown;
|
|
1904
|
+
/**
|
|
1905
|
+
* Internal server error
|
|
1906
|
+
*/
|
|
1907
|
+
500: unknown;
|
|
1908
|
+
};
|
|
1909
|
+
|
|
1910
|
+
export type GetCampaignResponses = {
|
|
1911
|
+
/**
|
|
1912
|
+
* Success
|
|
1913
|
+
*/
|
|
1914
|
+
200: unknown;
|
|
1915
|
+
};
|
|
1916
|
+
|
|
1917
|
+
export type GetSupportedRegionsData = {
|
|
1918
|
+
body?: never;
|
|
1919
|
+
path?: never;
|
|
1920
|
+
query?: never;
|
|
1921
|
+
url: '/supported-regions';
|
|
1922
|
+
};
|
|
1923
|
+
|
|
1924
|
+
export type GetSupportedRegionsErrors = {
|
|
1925
|
+
/**
|
|
1926
|
+
* Unauthorized — requires Bearer token
|
|
1927
|
+
*/
|
|
1928
|
+
401: unknown;
|
|
1929
|
+
/**
|
|
1930
|
+
* Internal server error
|
|
1931
|
+
*/
|
|
1932
|
+
500: unknown;
|
|
1933
|
+
};
|
|
1934
|
+
|
|
1935
|
+
export type GetSupportedRegionsResponses = {
|
|
1936
|
+
/**
|
|
1937
|
+
* Success
|
|
1938
|
+
*/
|
|
1939
|
+
200: {
|
|
1940
|
+
/**
|
|
1941
|
+
* Regions a phone number can be purchased in
|
|
1942
|
+
*/
|
|
1943
|
+
regions: Array<SupportedRegion>;
|
|
1944
|
+
};
|
|
1945
|
+
};
|
|
1946
|
+
|
|
1947
|
+
export type GetSupportedRegionsResponse =
|
|
1948
|
+
GetSupportedRegionsResponses[keyof GetSupportedRegionsResponses];
|
|
1949
|
+
|
|
1950
|
+
export type GetLinkShortenerData = {
|
|
1951
|
+
body?: never;
|
|
1952
|
+
path?: never;
|
|
1953
|
+
query?: never;
|
|
1954
|
+
url: '/link-shortener';
|
|
1955
|
+
};
|
|
1956
|
+
|
|
1957
|
+
export type GetLinkShortenerErrors = {
|
|
1958
|
+
/**
|
|
1959
|
+
* Unauthorized — requires Bearer token
|
|
1960
|
+
*/
|
|
1961
|
+
401: unknown;
|
|
1962
|
+
/**
|
|
1963
|
+
* Internal server error
|
|
1964
|
+
*/
|
|
1965
|
+
500: unknown;
|
|
1966
|
+
};
|
|
1967
|
+
|
|
1968
|
+
export type GetLinkShortenerResponses = {
|
|
1969
|
+
/**
|
|
1970
|
+
* Success
|
|
1971
|
+
*/
|
|
1972
|
+
200: unknown;
|
|
1973
|
+
};
|
|
1974
|
+
|
|
1975
|
+
export type PatchLinkShortenerData = {
|
|
1976
|
+
body: {
|
|
1977
|
+
/**
|
|
1978
|
+
* Algolia object ID of the template to update
|
|
1979
|
+
*/
|
|
1980
|
+
objectID: string;
|
|
1981
|
+
/**
|
|
1982
|
+
* The generated short link URL to store
|
|
1983
|
+
*/
|
|
1984
|
+
shortLink: string;
|
|
1985
|
+
};
|
|
1986
|
+
path?: never;
|
|
1987
|
+
query?: never;
|
|
1988
|
+
url: '/link-shortener';
|
|
1989
|
+
};
|
|
1990
|
+
|
|
1991
|
+
export type PatchLinkShortenerErrors = {
|
|
1992
|
+
/**
|
|
1993
|
+
* Unauthorized — requires Bearer token
|
|
1994
|
+
*/
|
|
1995
|
+
401: unknown;
|
|
1996
|
+
/**
|
|
1997
|
+
* Internal server error
|
|
1998
|
+
*/
|
|
1999
|
+
500: unknown;
|
|
2000
|
+
};
|
|
2001
|
+
|
|
2002
|
+
export type PatchLinkShortenerResponses = {
|
|
2003
|
+
/**
|
|
2004
|
+
* Success
|
|
2005
|
+
*/
|
|
2006
|
+
200: unknown;
|
|
2007
|
+
};
|
|
2008
|
+
|
|
2009
|
+
export type PostLinkShortenerData = {
|
|
2010
|
+
body: {
|
|
2011
|
+
/**
|
|
2012
|
+
* Non-empty array of URLs to shorten.
|
|
2013
|
+
*/
|
|
2014
|
+
urls: Array<ShortenUrlInput>;
|
|
2015
|
+
};
|
|
2016
|
+
path?: never;
|
|
2017
|
+
query?: never;
|
|
2018
|
+
url: '/link-shortener';
|
|
2019
|
+
};
|
|
2020
|
+
|
|
2021
|
+
export type PostLinkShortenerErrors = {
|
|
2022
|
+
/**
|
|
2023
|
+
* Unauthorized — requires Bearer token
|
|
2024
|
+
*/
|
|
2025
|
+
401: unknown;
|
|
2026
|
+
/**
|
|
2027
|
+
* Internal server error
|
|
2028
|
+
*/
|
|
2029
|
+
500: unknown;
|
|
2030
|
+
};
|
|
2031
|
+
|
|
2032
|
+
export type PostLinkShortenerResponses = {
|
|
2033
|
+
/**
|
|
2034
|
+
* Success
|
|
2035
|
+
*/
|
|
2036
|
+
200: unknown;
|
|
2037
|
+
};
|
|
2038
|
+
|
|
2039
|
+
export type DeleteLinkShortenerByCodeData = {
|
|
2040
|
+
body?: never;
|
|
2041
|
+
path: {
|
|
2042
|
+
code: string;
|
|
2043
|
+
};
|
|
2044
|
+
query?: never;
|
|
2045
|
+
url: '/link-shortener/{code}';
|
|
2046
|
+
};
|
|
2047
|
+
|
|
2048
|
+
export type DeleteLinkShortenerByCodeErrors = {
|
|
2049
|
+
/**
|
|
2050
|
+
* Unauthorized — requires Bearer token
|
|
2051
|
+
*/
|
|
2052
|
+
401: unknown;
|
|
2053
|
+
/**
|
|
2054
|
+
* Internal server error
|
|
2055
|
+
*/
|
|
2056
|
+
500: unknown;
|
|
2057
|
+
};
|
|
2058
|
+
|
|
2059
|
+
export type DeleteLinkShortenerByCodeResponses = {
|
|
2060
|
+
/**
|
|
2061
|
+
* Success
|
|
2062
|
+
*/
|
|
2063
|
+
200: unknown;
|
|
2064
|
+
};
|
|
2065
|
+
|
|
2066
|
+
export type GetDocsOpenapiJsonData = {
|
|
2067
|
+
body?: never;
|
|
2068
|
+
path?: never;
|
|
2069
|
+
query?: never;
|
|
2070
|
+
url: '/docs/openapi.json';
|
|
2071
|
+
};
|
|
2072
|
+
|
|
2073
|
+
export type GetDocsOpenapiJsonErrors = {
|
|
2074
|
+
/**
|
|
2075
|
+
* Unauthorized — requires Bearer token
|
|
2076
|
+
*/
|
|
2077
|
+
401: unknown;
|
|
2078
|
+
/**
|
|
2079
|
+
* Internal server error
|
|
2080
|
+
*/
|
|
2081
|
+
500: unknown;
|
|
2082
|
+
};
|
|
2083
|
+
|
|
2084
|
+
export type GetDocsOpenapiJsonResponses = {
|
|
2085
|
+
/**
|
|
2086
|
+
* Success
|
|
2087
|
+
*/
|
|
2088
|
+
200: unknown;
|
|
2089
|
+
};
|