@gtmi/ramp-api-client 0.0.1 → 0.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/es/index.d.mts +2386 -205
- package/dist/es/index.mjs +447 -8
- package/package.json +1 -1
- package/src/generated/index.ts +134 -0
- package/src/generated/sdk.gen.ts +3 -3
- package/src/generated/types.gen.ts +1362 -143
- package/src/generated/zod.gen.ts +487 -4
|
@@ -4,6 +4,60 @@ export type ClientOptions = {
|
|
|
4
4
|
baseUrl: `${string}://${string}` | (string & {});
|
|
5
5
|
};
|
|
6
6
|
|
|
7
|
+
export type ErrorResponse = {
|
|
8
|
+
error?: string;
|
|
9
|
+
details?: string;
|
|
10
|
+
};
|
|
11
|
+
|
|
12
|
+
export type Conversation = {
|
|
13
|
+
accountId?: string;
|
|
14
|
+
configuration?: string;
|
|
15
|
+
configurationId?: string;
|
|
16
|
+
createdAt?: string;
|
|
17
|
+
id?: string;
|
|
18
|
+
name?: string;
|
|
19
|
+
status?: string;
|
|
20
|
+
updatedAt?: string;
|
|
21
|
+
};
|
|
22
|
+
|
|
23
|
+
export type Participant = {
|
|
24
|
+
id?: string;
|
|
25
|
+
conversationId?: string;
|
|
26
|
+
accountId?: string;
|
|
27
|
+
name?: string;
|
|
28
|
+
type?: string;
|
|
29
|
+
addresses?: string;
|
|
30
|
+
createdAt?: string;
|
|
31
|
+
updatedAt?: string;
|
|
32
|
+
profileId?: string;
|
|
33
|
+
};
|
|
34
|
+
|
|
35
|
+
export type Operator = {
|
|
36
|
+
id?: string;
|
|
37
|
+
displayName?: string;
|
|
38
|
+
description?: string;
|
|
39
|
+
version?: string;
|
|
40
|
+
availability?: string;
|
|
41
|
+
author?: string;
|
|
42
|
+
prompt?: string;
|
|
43
|
+
outputFormat?: string;
|
|
44
|
+
outputSchema?: string;
|
|
45
|
+
trainingExamples?: string;
|
|
46
|
+
context?: string;
|
|
47
|
+
parameters?: string;
|
|
48
|
+
};
|
|
49
|
+
|
|
50
|
+
export type IntelligenceConfiguration = {
|
|
51
|
+
accountId?: string;
|
|
52
|
+
dateCreated?: string;
|
|
53
|
+
dateUpdated?: string;
|
|
54
|
+
description?: string;
|
|
55
|
+
displayName?: string;
|
|
56
|
+
id?: string;
|
|
57
|
+
rules?: string;
|
|
58
|
+
version?: string;
|
|
59
|
+
};
|
|
60
|
+
|
|
7
61
|
export type AutogenRequest = {
|
|
8
62
|
email?: string;
|
|
9
63
|
company?: string;
|
|
@@ -18,6 +72,41 @@ export type AutogenRequest = {
|
|
|
18
72
|
websiteUrl?: string;
|
|
19
73
|
};
|
|
20
74
|
|
|
75
|
+
export type TemplateData = {
|
|
76
|
+
objectID?: string;
|
|
77
|
+
title?: string;
|
|
78
|
+
img?: string;
|
|
79
|
+
associatedNumbers?: string;
|
|
80
|
+
author?: string;
|
|
81
|
+
createdAt?: string;
|
|
82
|
+
createdAtUnix?: string;
|
|
83
|
+
lastUpdatedAtUnix?: string;
|
|
84
|
+
lastUpdated?: string;
|
|
85
|
+
lastUpdatedBy?: string;
|
|
86
|
+
prompt?: string;
|
|
87
|
+
data?: string;
|
|
88
|
+
content?: string;
|
|
89
|
+
};
|
|
90
|
+
|
|
91
|
+
export type CalledByData = {
|
|
92
|
+
phoneNumber?: string;
|
|
93
|
+
timestamp?: number;
|
|
94
|
+
direction?: string;
|
|
95
|
+
objectId?: string;
|
|
96
|
+
};
|
|
97
|
+
|
|
98
|
+
export type Campaign = {
|
|
99
|
+
email?: string;
|
|
100
|
+
companyName?: string;
|
|
101
|
+
objectID?: string;
|
|
102
|
+
encryptedObjectId?: string;
|
|
103
|
+
agentNumber?: string;
|
|
104
|
+
tag?: string;
|
|
105
|
+
createdAt?: string;
|
|
106
|
+
numCalls?: string;
|
|
107
|
+
shortLink?: string;
|
|
108
|
+
};
|
|
109
|
+
|
|
21
110
|
export type SupportedRegion = {
|
|
22
111
|
isoCountry?: string;
|
|
23
112
|
numberType?: string;
|
|
@@ -49,9 +138,16 @@ export type GetHealthResponses = {
|
|
|
49
138
|
/**
|
|
50
139
|
* Success
|
|
51
140
|
*/
|
|
52
|
-
200:
|
|
141
|
+
200: {
|
|
142
|
+
/**
|
|
143
|
+
* "ok"
|
|
144
|
+
*/
|
|
145
|
+
status: string;
|
|
146
|
+
};
|
|
53
147
|
};
|
|
54
148
|
|
|
149
|
+
export type GetHealthResponse = GetHealthResponses[keyof GetHealthResponses];
|
|
150
|
+
|
|
55
151
|
export type PostConversationsTokenData = {
|
|
56
152
|
body: {
|
|
57
153
|
[key: string]: unknown;
|
|
@@ -63,18 +159,41 @@ export type PostConversationsTokenData = {
|
|
|
63
159
|
|
|
64
160
|
export type PostConversationsTokenErrors = {
|
|
65
161
|
/**
|
|
66
|
-
*
|
|
162
|
+
* identity is required, or service could not be resolved
|
|
67
163
|
*/
|
|
68
|
-
|
|
164
|
+
400: ErrorResponse;
|
|
165
|
+
/**
|
|
166
|
+
* Server misconfiguration
|
|
167
|
+
*/
|
|
168
|
+
500: ErrorResponse;
|
|
169
|
+
/**
|
|
170
|
+
* Service temporarily unavailable
|
|
171
|
+
*/
|
|
172
|
+
503: ErrorResponse;
|
|
69
173
|
};
|
|
70
174
|
|
|
175
|
+
export type PostConversationsTokenError =
|
|
176
|
+
PostConversationsTokenErrors[keyof PostConversationsTokenErrors];
|
|
177
|
+
|
|
71
178
|
export type PostConversationsTokenResponses = {
|
|
72
179
|
/**
|
|
73
180
|
* Success
|
|
74
181
|
*/
|
|
75
|
-
200:
|
|
182
|
+
200: {
|
|
183
|
+
/**
|
|
184
|
+
* The resolved identity used in the token
|
|
185
|
+
*/
|
|
186
|
+
identity: string;
|
|
187
|
+
/**
|
|
188
|
+
* Twilio access token JWT
|
|
189
|
+
*/
|
|
190
|
+
token: string;
|
|
191
|
+
};
|
|
76
192
|
};
|
|
77
193
|
|
|
194
|
+
export type PostConversationsTokenResponse =
|
|
195
|
+
PostConversationsTokenResponses[keyof PostConversationsTokenResponses];
|
|
196
|
+
|
|
78
197
|
export type GetSyncTokenData = {
|
|
79
198
|
body?: never;
|
|
80
199
|
path?: never;
|
|
@@ -90,18 +209,35 @@ export type GetSyncTokenErrors = {
|
|
|
90
209
|
*/
|
|
91
210
|
401: unknown;
|
|
92
211
|
/**
|
|
93
|
-
*
|
|
212
|
+
* Server misconfiguration
|
|
94
213
|
*/
|
|
95
|
-
500:
|
|
214
|
+
500: ErrorResponse;
|
|
215
|
+
/**
|
|
216
|
+
* Service temporarily unavailable
|
|
217
|
+
*/
|
|
218
|
+
503: ErrorResponse;
|
|
96
219
|
};
|
|
97
220
|
|
|
221
|
+
export type GetSyncTokenError = GetSyncTokenErrors[keyof GetSyncTokenErrors];
|
|
222
|
+
|
|
98
223
|
export type GetSyncTokenResponses = {
|
|
99
224
|
/**
|
|
100
225
|
* Success
|
|
101
226
|
*/
|
|
102
|
-
200:
|
|
227
|
+
200: {
|
|
228
|
+
/**
|
|
229
|
+
* The resolved identity used in the token
|
|
230
|
+
*/
|
|
231
|
+
identity: string;
|
|
232
|
+
/**
|
|
233
|
+
* Twilio access token JWT
|
|
234
|
+
*/
|
|
235
|
+
token: string;
|
|
236
|
+
};
|
|
103
237
|
};
|
|
104
238
|
|
|
239
|
+
export type GetSyncTokenResponse = GetSyncTokenResponses[keyof GetSyncTokenResponses];
|
|
240
|
+
|
|
105
241
|
export type GetVoiceTokenData = {
|
|
106
242
|
body?: never;
|
|
107
243
|
path?: never;
|
|
@@ -113,18 +249,35 @@ export type GetVoiceTokenData = {
|
|
|
113
249
|
|
|
114
250
|
export type GetVoiceTokenErrors = {
|
|
115
251
|
/**
|
|
116
|
-
*
|
|
252
|
+
* Server misconfiguration
|
|
117
253
|
*/
|
|
118
|
-
500:
|
|
254
|
+
500: ErrorResponse;
|
|
255
|
+
/**
|
|
256
|
+
* Service temporarily unavailable
|
|
257
|
+
*/
|
|
258
|
+
503: ErrorResponse;
|
|
119
259
|
};
|
|
120
260
|
|
|
261
|
+
export type GetVoiceTokenError = GetVoiceTokenErrors[keyof GetVoiceTokenErrors];
|
|
262
|
+
|
|
121
263
|
export type GetVoiceTokenResponses = {
|
|
122
264
|
/**
|
|
123
265
|
* Success
|
|
124
266
|
*/
|
|
125
|
-
200:
|
|
267
|
+
200: {
|
|
268
|
+
/**
|
|
269
|
+
* The resolved identity used in the token
|
|
270
|
+
*/
|
|
271
|
+
identity: string;
|
|
272
|
+
/**
|
|
273
|
+
* Twilio access token JWT
|
|
274
|
+
*/
|
|
275
|
+
token: string;
|
|
276
|
+
};
|
|
126
277
|
};
|
|
127
278
|
|
|
279
|
+
export type GetVoiceTokenResponse = GetVoiceTokenResponses[keyof GetVoiceTokenResponses];
|
|
280
|
+
|
|
128
281
|
export type PostUiConfigData = {
|
|
129
282
|
body: {
|
|
130
283
|
[key: string]: unknown;
|
|
@@ -135,19 +288,72 @@ export type PostUiConfigData = {
|
|
|
135
288
|
};
|
|
136
289
|
|
|
137
290
|
export type PostUiConfigErrors = {
|
|
291
|
+
/**
|
|
292
|
+
* Bad Request
|
|
293
|
+
*/
|
|
294
|
+
400: {
|
|
295
|
+
/**
|
|
296
|
+
* Error code ("provide_customerNumber_or_objectID" or "missing_customerNumber_or_objectID")
|
|
297
|
+
*/
|
|
298
|
+
error: string;
|
|
299
|
+
};
|
|
138
300
|
/**
|
|
139
301
|
* Internal server error
|
|
140
302
|
*/
|
|
141
|
-
500:
|
|
303
|
+
500: {
|
|
304
|
+
/**
|
|
305
|
+
* Error code ("ui_config_error")
|
|
306
|
+
*/
|
|
307
|
+
error: string;
|
|
308
|
+
};
|
|
142
309
|
};
|
|
143
310
|
|
|
311
|
+
export type PostUiConfigError = PostUiConfigErrors[keyof PostUiConfigErrors];
|
|
312
|
+
|
|
144
313
|
export type PostUiConfigResponses = {
|
|
145
314
|
/**
|
|
146
315
|
* Success
|
|
147
316
|
*/
|
|
148
|
-
200:
|
|
317
|
+
200: {
|
|
318
|
+
/**
|
|
319
|
+
* Webchat UI configuration for the resolved template
|
|
320
|
+
*/
|
|
321
|
+
ui: {
|
|
322
|
+
[key: string]: unknown;
|
|
323
|
+
};
|
|
324
|
+
/**
|
|
325
|
+
* Webchat link map configuration
|
|
326
|
+
*/
|
|
327
|
+
linkMap: {
|
|
328
|
+
[key: string]: unknown;
|
|
329
|
+
};
|
|
330
|
+
/**
|
|
331
|
+
* Whether the chat link should be hidden
|
|
332
|
+
*/
|
|
333
|
+
hideChatLink: boolean;
|
|
334
|
+
/**
|
|
335
|
+
* Title of the resolved template
|
|
336
|
+
*/
|
|
337
|
+
templateTitle: string;
|
|
338
|
+
/**
|
|
339
|
+
* Dialog display configuration
|
|
340
|
+
*/
|
|
341
|
+
dialogConfig: {
|
|
342
|
+
[key: string]: unknown;
|
|
343
|
+
};
|
|
344
|
+
/**
|
|
345
|
+
* Algolia objectID of the resolved template
|
|
346
|
+
*/
|
|
347
|
+
templateObjectId: string;
|
|
348
|
+
/**
|
|
349
|
+
* Resolved customer number, present when looked up by objectID
|
|
350
|
+
*/
|
|
351
|
+
resolvedCustomerNumber: string;
|
|
352
|
+
};
|
|
149
353
|
};
|
|
150
354
|
|
|
355
|
+
export type PostUiConfigResponse = PostUiConfigResponses[keyof PostUiConfigResponses];
|
|
356
|
+
|
|
151
357
|
export type PostCreateExternalFlexConnectionData = {
|
|
152
358
|
body: {
|
|
153
359
|
/**
|
|
@@ -169,6 +375,21 @@ export type PostCreateExternalFlexConnectionData = {
|
|
|
169
375
|
};
|
|
170
376
|
|
|
171
377
|
export type PostCreateExternalFlexConnectionErrors = {
|
|
378
|
+
/**
|
|
379
|
+
* Bad Request
|
|
380
|
+
*/
|
|
381
|
+
400: {
|
|
382
|
+
/**
|
|
383
|
+
* Error code ("missing_required_params")
|
|
384
|
+
*/
|
|
385
|
+
error: string;
|
|
386
|
+
/**
|
|
387
|
+
* Details about which parameters are missing
|
|
388
|
+
*/
|
|
389
|
+
details: {
|
|
390
|
+
[key: string]: unknown;
|
|
391
|
+
};
|
|
392
|
+
};
|
|
172
393
|
/**
|
|
173
394
|
* Unauthorized — requires Bearer token
|
|
174
395
|
*/
|
|
@@ -176,16 +397,33 @@ export type PostCreateExternalFlexConnectionErrors = {
|
|
|
176
397
|
/**
|
|
177
398
|
* Internal server error
|
|
178
399
|
*/
|
|
179
|
-
500:
|
|
400
|
+
500: {
|
|
401
|
+
/**
|
|
402
|
+
* Error code ("setup_failed")
|
|
403
|
+
*/
|
|
404
|
+
error: string;
|
|
405
|
+
/**
|
|
406
|
+
* Detailed error information
|
|
407
|
+
*/
|
|
408
|
+
details: string;
|
|
409
|
+
};
|
|
180
410
|
};
|
|
181
411
|
|
|
412
|
+
export type PostCreateExternalFlexConnectionError =
|
|
413
|
+
PostCreateExternalFlexConnectionErrors[keyof PostCreateExternalFlexConnectionErrors];
|
|
414
|
+
|
|
182
415
|
export type PostCreateExternalFlexConnectionResponses = {
|
|
183
416
|
/**
|
|
184
|
-
*
|
|
417
|
+
* Studio Flow, TwiML App, and RAMP integration configuration
|
|
185
418
|
*/
|
|
186
|
-
200:
|
|
419
|
+
200: {
|
|
420
|
+
[key: string]: unknown;
|
|
421
|
+
};
|
|
187
422
|
};
|
|
188
423
|
|
|
424
|
+
export type PostCreateExternalFlexConnectionResponse =
|
|
425
|
+
PostCreateExternalFlexConnectionResponses[keyof PostCreateExternalFlexConnectionResponses];
|
|
426
|
+
|
|
189
427
|
export type PostInstallFlexPluginData = {
|
|
190
428
|
body: {
|
|
191
429
|
/**
|
|
@@ -211,6 +449,21 @@ export type PostInstallFlexPluginData = {
|
|
|
211
449
|
};
|
|
212
450
|
|
|
213
451
|
export type PostInstallFlexPluginErrors = {
|
|
452
|
+
/**
|
|
453
|
+
* Bad Request
|
|
454
|
+
*/
|
|
455
|
+
400: {
|
|
456
|
+
/**
|
|
457
|
+
* Error code ("missing_required_params", "unsupported_node", or "unknown_plugin")
|
|
458
|
+
*/
|
|
459
|
+
error: string;
|
|
460
|
+
/**
|
|
461
|
+
* Error details
|
|
462
|
+
*/
|
|
463
|
+
details: {
|
|
464
|
+
[key: string]: unknown;
|
|
465
|
+
};
|
|
466
|
+
};
|
|
214
467
|
/**
|
|
215
468
|
* Unauthorized — requires Bearer token
|
|
216
469
|
*/
|
|
@@ -218,16 +471,52 @@ export type PostInstallFlexPluginErrors = {
|
|
|
218
471
|
/**
|
|
219
472
|
* Internal server error
|
|
220
473
|
*/
|
|
221
|
-
500:
|
|
474
|
+
500: {
|
|
475
|
+
/**
|
|
476
|
+
* Error code ("clone_failed" or "install_failed")
|
|
477
|
+
*/
|
|
478
|
+
error: string;
|
|
479
|
+
/**
|
|
480
|
+
* Detailed error information
|
|
481
|
+
*/
|
|
482
|
+
details: string;
|
|
483
|
+
};
|
|
222
484
|
};
|
|
223
485
|
|
|
486
|
+
export type PostInstallFlexPluginError =
|
|
487
|
+
PostInstallFlexPluginErrors[keyof PostInstallFlexPluginErrors];
|
|
488
|
+
|
|
224
489
|
export type PostInstallFlexPluginResponses = {
|
|
225
490
|
/**
|
|
226
491
|
* Success
|
|
227
492
|
*/
|
|
228
|
-
200:
|
|
493
|
+
200: {
|
|
494
|
+
/**
|
|
495
|
+
* Always true on success
|
|
496
|
+
*/
|
|
497
|
+
success: boolean;
|
|
498
|
+
/**
|
|
499
|
+
* Plugin information (name)
|
|
500
|
+
*/
|
|
501
|
+
plugin: {
|
|
502
|
+
[key: string]: unknown;
|
|
503
|
+
};
|
|
504
|
+
/**
|
|
505
|
+
* Deployed version SID, if determinable
|
|
506
|
+
*/
|
|
507
|
+
deployedVersion: string;
|
|
508
|
+
/**
|
|
509
|
+
* Release information, if determinable
|
|
510
|
+
*/
|
|
511
|
+
release: {
|
|
512
|
+
[key: string]: unknown;
|
|
513
|
+
};
|
|
514
|
+
};
|
|
229
515
|
};
|
|
230
516
|
|
|
517
|
+
export type PostInstallFlexPluginResponse =
|
|
518
|
+
PostInstallFlexPluginResponses[keyof PostInstallFlexPluginResponses];
|
|
519
|
+
|
|
231
520
|
export type PostLiveAgentWebchatConnectData = {
|
|
232
521
|
body: {
|
|
233
522
|
[key: string]: unknown;
|
|
@@ -238,19 +527,74 @@ export type PostLiveAgentWebchatConnectData = {
|
|
|
238
527
|
};
|
|
239
528
|
|
|
240
529
|
export type PostLiveAgentWebchatConnectErrors = {
|
|
530
|
+
/**
|
|
531
|
+
* Bad Request
|
|
532
|
+
*/
|
|
533
|
+
400: {
|
|
534
|
+
/**
|
|
535
|
+
* Error code ("service_not_found")
|
|
536
|
+
*/
|
|
537
|
+
error: string;
|
|
538
|
+
/**
|
|
539
|
+
* Details about the resolution failure
|
|
540
|
+
*/
|
|
541
|
+
details: string;
|
|
542
|
+
};
|
|
241
543
|
/**
|
|
242
544
|
* Internal server error
|
|
243
545
|
*/
|
|
244
|
-
500:
|
|
546
|
+
500: {
|
|
547
|
+
/**
|
|
548
|
+
* Missing Twilio credentials, missing workflow, or failed to create interaction
|
|
549
|
+
*/
|
|
550
|
+
error: string;
|
|
551
|
+
/**
|
|
552
|
+
* Detailed error information
|
|
553
|
+
*/
|
|
554
|
+
details: {
|
|
555
|
+
[key: string]: unknown;
|
|
556
|
+
};
|
|
557
|
+
};
|
|
245
558
|
};
|
|
246
559
|
|
|
560
|
+
export type PostLiveAgentWebchatConnectError =
|
|
561
|
+
PostLiveAgentWebchatConnectErrors[keyof PostLiveAgentWebchatConnectErrors];
|
|
562
|
+
|
|
247
563
|
export type PostLiveAgentWebchatConnectResponses = {
|
|
248
564
|
/**
|
|
249
565
|
* Success
|
|
250
566
|
*/
|
|
251
567
|
200: unknown;
|
|
568
|
+
/**
|
|
569
|
+
* Created
|
|
570
|
+
*/
|
|
571
|
+
201: {
|
|
572
|
+
/**
|
|
573
|
+
* Twilio Conversation SID (CH...)
|
|
574
|
+
*/
|
|
575
|
+
conversationSid: string;
|
|
576
|
+
/**
|
|
577
|
+
* Flex Interaction SID (IN...)
|
|
578
|
+
*/
|
|
579
|
+
interactionSid: string;
|
|
580
|
+
/**
|
|
581
|
+
* Interaction Channel SID (UO...)
|
|
582
|
+
*/
|
|
583
|
+
interactionChannelSid: string;
|
|
584
|
+
/**
|
|
585
|
+
* The customer identity used in the conversation
|
|
586
|
+
*/
|
|
587
|
+
identity: string;
|
|
588
|
+
/**
|
|
589
|
+
* Conversations service SID used
|
|
590
|
+
*/
|
|
591
|
+
serviceSid: string;
|
|
592
|
+
};
|
|
252
593
|
};
|
|
253
594
|
|
|
595
|
+
export type PostLiveAgentWebchatConnectResponse =
|
|
596
|
+
PostLiveAgentWebchatConnectResponses[keyof PostLiveAgentWebchatConnectResponses];
|
|
597
|
+
|
|
254
598
|
export type PostLiveAgentWebchatSendData = {
|
|
255
599
|
body: {
|
|
256
600
|
/**
|
|
@@ -272,23 +616,70 @@ export type PostLiveAgentWebchatSendData = {
|
|
|
272
616
|
};
|
|
273
617
|
|
|
274
618
|
export type PostLiveAgentWebchatSendErrors = {
|
|
619
|
+
/**
|
|
620
|
+
* conversationSid, identity, and message are required, or invalid conversationSid
|
|
621
|
+
*/
|
|
622
|
+
400: ErrorResponse;
|
|
275
623
|
/**
|
|
276
624
|
* Unauthorized — requires Bearer token
|
|
277
625
|
*/
|
|
278
626
|
401: unknown;
|
|
627
|
+
/**
|
|
628
|
+
* Conflict
|
|
629
|
+
*/
|
|
630
|
+
409: {
|
|
631
|
+
/**
|
|
632
|
+
* Conversation is closed
|
|
633
|
+
*/
|
|
634
|
+
error: string;
|
|
635
|
+
/**
|
|
636
|
+
* conversationSid and state
|
|
637
|
+
*/
|
|
638
|
+
details: {
|
|
639
|
+
[key: string]: unknown;
|
|
640
|
+
};
|
|
641
|
+
};
|
|
279
642
|
/**
|
|
280
643
|
* Internal server error
|
|
281
644
|
*/
|
|
282
|
-
500:
|
|
645
|
+
500: {
|
|
646
|
+
/**
|
|
647
|
+
* Missing Twilio credentials, or failed to send message
|
|
648
|
+
*/
|
|
649
|
+
error: string;
|
|
650
|
+
/**
|
|
651
|
+
* Detailed error information
|
|
652
|
+
*/
|
|
653
|
+
details: {
|
|
654
|
+
[key: string]: unknown;
|
|
655
|
+
};
|
|
656
|
+
};
|
|
283
657
|
};
|
|
284
658
|
|
|
659
|
+
export type PostLiveAgentWebchatSendError =
|
|
660
|
+
PostLiveAgentWebchatSendErrors[keyof PostLiveAgentWebchatSendErrors];
|
|
661
|
+
|
|
285
662
|
export type PostLiveAgentWebchatSendResponses = {
|
|
286
663
|
/**
|
|
287
664
|
* Success
|
|
288
665
|
*/
|
|
289
666
|
200: unknown;
|
|
667
|
+
/**
|
|
668
|
+
* Created
|
|
669
|
+
*/
|
|
670
|
+
201: {
|
|
671
|
+
/**
|
|
672
|
+
* The created message object from Twilio
|
|
673
|
+
*/
|
|
674
|
+
message: {
|
|
675
|
+
[key: string]: unknown;
|
|
676
|
+
};
|
|
677
|
+
};
|
|
290
678
|
};
|
|
291
679
|
|
|
680
|
+
export type PostLiveAgentWebchatSendResponse =
|
|
681
|
+
PostLiveAgentWebchatSendResponses[keyof PostLiveAgentWebchatSendResponses];
|
|
682
|
+
|
|
292
683
|
export type PostLiveAgentWebchatEndData = {
|
|
293
684
|
body: {
|
|
294
685
|
[key: string]: unknown;
|
|
@@ -302,16 +693,32 @@ export type PostLiveAgentWebchatEndErrors = {
|
|
|
302
693
|
/**
|
|
303
694
|
* Internal server error
|
|
304
695
|
*/
|
|
305
|
-
500:
|
|
696
|
+
500: {
|
|
697
|
+
/**
|
|
698
|
+
* Missing Twilio credentials, or failed to end live agent webchat
|
|
699
|
+
*/
|
|
700
|
+
error: string;
|
|
701
|
+
};
|
|
306
702
|
};
|
|
307
703
|
|
|
704
|
+
export type PostLiveAgentWebchatEndError =
|
|
705
|
+
PostLiveAgentWebchatEndErrors[keyof PostLiveAgentWebchatEndErrors];
|
|
706
|
+
|
|
308
707
|
export type PostLiveAgentWebchatEndResponses = {
|
|
309
708
|
/**
|
|
310
709
|
* Success
|
|
311
710
|
*/
|
|
312
|
-
200:
|
|
711
|
+
200: {
|
|
712
|
+
/**
|
|
713
|
+
* Always true on success
|
|
714
|
+
*/
|
|
715
|
+
success: boolean;
|
|
716
|
+
};
|
|
313
717
|
};
|
|
314
718
|
|
|
719
|
+
export type PostLiveAgentWebchatEndResponse =
|
|
720
|
+
PostLiveAgentWebchatEndResponses[keyof PostLiveAgentWebchatEndResponses];
|
|
721
|
+
|
|
315
722
|
export type DeleteLeadGenData = {
|
|
316
723
|
body?: never;
|
|
317
724
|
path?: never;
|
|
@@ -320,23 +727,36 @@ export type DeleteLeadGenData = {
|
|
|
320
727
|
};
|
|
321
728
|
|
|
322
729
|
export type DeleteLeadGenErrors = {
|
|
730
|
+
/**
|
|
731
|
+
* Object ID and/or agent number are required, or agent number not found
|
|
732
|
+
*/
|
|
733
|
+
400: ErrorResponse;
|
|
323
734
|
/**
|
|
324
735
|
* Unauthorized — requires Bearer token
|
|
325
736
|
*/
|
|
326
737
|
401: unknown;
|
|
327
738
|
/**
|
|
328
|
-
*
|
|
739
|
+
* Failed to delete lead gen
|
|
329
740
|
*/
|
|
330
|
-
500:
|
|
741
|
+
500: ErrorResponse;
|
|
331
742
|
};
|
|
332
743
|
|
|
744
|
+
export type DeleteLeadGenError = DeleteLeadGenErrors[keyof DeleteLeadGenErrors];
|
|
745
|
+
|
|
333
746
|
export type DeleteLeadGenResponses = {
|
|
334
747
|
/**
|
|
335
748
|
* Success
|
|
336
749
|
*/
|
|
337
|
-
200:
|
|
750
|
+
200: {
|
|
751
|
+
/**
|
|
752
|
+
* Success message
|
|
753
|
+
*/
|
|
754
|
+
message: string;
|
|
755
|
+
};
|
|
338
756
|
};
|
|
339
757
|
|
|
758
|
+
export type DeleteLeadGenResponse = DeleteLeadGenResponses[keyof DeleteLeadGenResponses];
|
|
759
|
+
|
|
340
760
|
export type PatchLeadGenData = {
|
|
341
761
|
body: {
|
|
342
762
|
[key: string]: unknown;
|
|
@@ -347,23 +767,48 @@ export type PatchLeadGenData = {
|
|
|
347
767
|
};
|
|
348
768
|
|
|
349
769
|
export type PatchLeadGenErrors = {
|
|
770
|
+
/**
|
|
771
|
+
* Either agentNumber or objectID is required
|
|
772
|
+
*/
|
|
773
|
+
400: ErrorResponse;
|
|
350
774
|
/**
|
|
351
775
|
* Unauthorized — requires Bearer token
|
|
352
776
|
*/
|
|
353
777
|
401: unknown;
|
|
354
778
|
/**
|
|
355
|
-
*
|
|
779
|
+
* Template not found
|
|
356
780
|
*/
|
|
357
|
-
|
|
781
|
+
404: ErrorResponse;
|
|
782
|
+
/**
|
|
783
|
+
* Internal server error (raw error payload)
|
|
784
|
+
*/
|
|
785
|
+
500: {
|
|
786
|
+
[key: string]: unknown;
|
|
787
|
+
};
|
|
358
788
|
};
|
|
359
789
|
|
|
790
|
+
export type PatchLeadGenError = PatchLeadGenErrors[keyof PatchLeadGenErrors];
|
|
791
|
+
|
|
360
792
|
export type PatchLeadGenResponses = {
|
|
361
793
|
/**
|
|
362
794
|
* Success
|
|
363
795
|
*/
|
|
364
|
-
200:
|
|
796
|
+
200: {
|
|
797
|
+
/**
|
|
798
|
+
* Success message
|
|
799
|
+
*/
|
|
800
|
+
message: string;
|
|
801
|
+
/**
|
|
802
|
+
* Updated expiration information (objectID, agentNumber, daysOut, newExpirationDate, newExpirationDateISO)
|
|
803
|
+
*/
|
|
804
|
+
data: {
|
|
805
|
+
[key: string]: unknown;
|
|
806
|
+
};
|
|
807
|
+
};
|
|
365
808
|
};
|
|
366
809
|
|
|
810
|
+
export type PatchLeadGenResponse = PatchLeadGenResponses[keyof PatchLeadGenResponses];
|
|
811
|
+
|
|
367
812
|
export type PostLeadGenData = {
|
|
368
813
|
body: {
|
|
369
814
|
/**
|
|
@@ -381,6 +826,15 @@ export type PostLeadGenData = {
|
|
|
381
826
|
};
|
|
382
827
|
|
|
383
828
|
export type PostLeadGenErrors = {
|
|
829
|
+
/**
|
|
830
|
+
* Bad Request
|
|
831
|
+
*/
|
|
832
|
+
400: {
|
|
833
|
+
/**
|
|
834
|
+
* Error message ("Object ID is required" or "User email is required")
|
|
835
|
+
*/
|
|
836
|
+
error: string;
|
|
837
|
+
};
|
|
384
838
|
/**
|
|
385
839
|
* Unauthorized — requires Bearer token
|
|
386
840
|
*/
|
|
@@ -388,16 +842,30 @@ export type PostLeadGenErrors = {
|
|
|
388
842
|
/**
|
|
389
843
|
* Internal server error
|
|
390
844
|
*/
|
|
391
|
-
500:
|
|
845
|
+
500: {
|
|
846
|
+
/**
|
|
847
|
+
* Error message (e.g., "No toll-free numbers available" or "Failed to generate lead gen")
|
|
848
|
+
*/
|
|
849
|
+
error: string;
|
|
850
|
+
};
|
|
392
851
|
};
|
|
393
852
|
|
|
853
|
+
export type PostLeadGenError = PostLeadGenErrors[keyof PostLeadGenErrors];
|
|
854
|
+
|
|
394
855
|
export type PostLeadGenResponses = {
|
|
395
856
|
/**
|
|
396
857
|
* Success
|
|
397
858
|
*/
|
|
398
|
-
200:
|
|
859
|
+
200: {
|
|
860
|
+
/**
|
|
861
|
+
* The purchased phone number in E.164 format
|
|
862
|
+
*/
|
|
863
|
+
agentNumber: string;
|
|
864
|
+
};
|
|
399
865
|
};
|
|
400
866
|
|
|
867
|
+
export type PostLeadGenResponse = PostLeadGenResponses[keyof PostLeadGenResponses];
|
|
868
|
+
|
|
401
869
|
export type PostLeadGenMonitorData = {
|
|
402
870
|
body?: never;
|
|
403
871
|
path?: never;
|
|
@@ -411,28 +879,50 @@ export type PostLeadGenMonitorErrors = {
|
|
|
411
879
|
*/
|
|
412
880
|
401: unknown;
|
|
413
881
|
/**
|
|
414
|
-
* Internal server error
|
|
882
|
+
* Internal server error (raw error payload)
|
|
415
883
|
*/
|
|
416
|
-
500:
|
|
884
|
+
500: {
|
|
885
|
+
[key: string]: unknown;
|
|
886
|
+
};
|
|
417
887
|
};
|
|
418
888
|
|
|
889
|
+
export type PostLeadGenMonitorError = PostLeadGenMonitorErrors[keyof PostLeadGenMonitorErrors];
|
|
890
|
+
|
|
419
891
|
export type PostLeadGenMonitorResponses = {
|
|
420
892
|
/**
|
|
421
893
|
* Success
|
|
422
894
|
*/
|
|
423
|
-
200:
|
|
895
|
+
200: {
|
|
896
|
+
/**
|
|
897
|
+
* Success message
|
|
898
|
+
*/
|
|
899
|
+
message: string;
|
|
900
|
+
/**
|
|
901
|
+
* Summary of deleted/extended templates (or empty array when none expired)
|
|
902
|
+
*/
|
|
903
|
+
data: {
|
|
904
|
+
[key: string]: unknown;
|
|
905
|
+
};
|
|
906
|
+
};
|
|
424
907
|
};
|
|
425
908
|
|
|
909
|
+
export type PostLeadGenMonitorResponse =
|
|
910
|
+
PostLeadGenMonitorResponses[keyof PostLeadGenMonitorResponses];
|
|
911
|
+
|
|
426
912
|
export type PostConversationsCommunicationsByConversationIdData = {
|
|
427
913
|
body: {
|
|
428
914
|
/**
|
|
429
915
|
* Author of the communication (required)
|
|
430
916
|
*/
|
|
431
|
-
author:
|
|
917
|
+
author: {
|
|
918
|
+
[key: string]: unknown;
|
|
919
|
+
};
|
|
432
920
|
/**
|
|
433
921
|
* Content of the communication (required)
|
|
434
922
|
*/
|
|
435
|
-
content:
|
|
923
|
+
content: {
|
|
924
|
+
[key: string]: unknown;
|
|
925
|
+
};
|
|
436
926
|
/**
|
|
437
927
|
* Recipients of the communication (required, non-empty)
|
|
438
928
|
*/
|
|
@@ -446,6 +936,10 @@ export type PostConversationsCommunicationsByConversationIdData = {
|
|
|
446
936
|
};
|
|
447
937
|
|
|
448
938
|
export type PostConversationsCommunicationsByConversationIdErrors = {
|
|
939
|
+
/**
|
|
940
|
+
* Invalid request parameters
|
|
941
|
+
*/
|
|
942
|
+
400: ErrorResponse;
|
|
449
943
|
/**
|
|
450
944
|
* Unauthorized — requires Bearer token
|
|
451
945
|
*/
|
|
@@ -453,16 +947,28 @@ export type PostConversationsCommunicationsByConversationIdErrors = {
|
|
|
453
947
|
/**
|
|
454
948
|
* Internal server error
|
|
455
949
|
*/
|
|
456
|
-
500:
|
|
950
|
+
500: ErrorResponse;
|
|
457
951
|
};
|
|
458
952
|
|
|
953
|
+
export type PostConversationsCommunicationsByConversationIdError =
|
|
954
|
+
PostConversationsCommunicationsByConversationIdErrors[keyof PostConversationsCommunicationsByConversationIdErrors];
|
|
955
|
+
|
|
459
956
|
export type PostConversationsCommunicationsByConversationIdResponses = {
|
|
460
957
|
/**
|
|
461
958
|
* Success
|
|
462
959
|
*/
|
|
463
960
|
200: unknown;
|
|
961
|
+
/**
|
|
962
|
+
* The created Communication object from Twilio
|
|
963
|
+
*/
|
|
964
|
+
201: {
|
|
965
|
+
[key: string]: unknown;
|
|
966
|
+
};
|
|
464
967
|
};
|
|
465
968
|
|
|
969
|
+
export type PostConversationsCommunicationsByConversationIdResponse =
|
|
970
|
+
PostConversationsCommunicationsByConversationIdResponses[keyof PostConversationsCommunicationsByConversationIdResponses];
|
|
971
|
+
|
|
466
972
|
export type GetConversationsFetchData = {
|
|
467
973
|
body?: never;
|
|
468
974
|
path?: never;
|
|
@@ -481,16 +987,24 @@ export type GetConversationsFetchErrors = {
|
|
|
481
987
|
/**
|
|
482
988
|
* Internal server error
|
|
483
989
|
*/
|
|
484
|
-
500:
|
|
990
|
+
500: ErrorResponse;
|
|
485
991
|
};
|
|
486
992
|
|
|
993
|
+
export type GetConversationsFetchError =
|
|
994
|
+
GetConversationsFetchErrors[keyof GetConversationsFetchErrors];
|
|
995
|
+
|
|
487
996
|
export type GetConversationsFetchResponses = {
|
|
488
997
|
/**
|
|
489
|
-
*
|
|
998
|
+
* A single Conversation (when conversationId is provided) or a paginated conversations list
|
|
490
999
|
*/
|
|
491
|
-
200:
|
|
1000
|
+
200: {
|
|
1001
|
+
[key: string]: unknown;
|
|
1002
|
+
};
|
|
492
1003
|
};
|
|
493
1004
|
|
|
1005
|
+
export type GetConversationsFetchResponse =
|
|
1006
|
+
GetConversationsFetchResponses[keyof GetConversationsFetchResponses];
|
|
1007
|
+
|
|
494
1008
|
export type PostConversationsData = {
|
|
495
1009
|
body: {
|
|
496
1010
|
/**
|
|
@@ -504,6 +1018,10 @@ export type PostConversationsData = {
|
|
|
504
1018
|
};
|
|
505
1019
|
|
|
506
1020
|
export type PostConversationsErrors = {
|
|
1021
|
+
/**
|
|
1022
|
+
* Invalid request parameters
|
|
1023
|
+
*/
|
|
1024
|
+
400: ErrorResponse;
|
|
507
1025
|
/**
|
|
508
1026
|
* Unauthorized — requires Bearer token
|
|
509
1027
|
*/
|
|
@@ -511,16 +1029,21 @@ export type PostConversationsErrors = {
|
|
|
511
1029
|
/**
|
|
512
1030
|
* Internal server error
|
|
513
1031
|
*/
|
|
514
|
-
500:
|
|
1032
|
+
500: ErrorResponse;
|
|
515
1033
|
};
|
|
516
1034
|
|
|
1035
|
+
export type PostConversationsError = PostConversationsErrors[keyof PostConversationsErrors];
|
|
1036
|
+
|
|
517
1037
|
export type PostConversationsResponses = {
|
|
518
1038
|
/**
|
|
519
|
-
*
|
|
1039
|
+
* The created conversation
|
|
520
1040
|
*/
|
|
521
|
-
200:
|
|
1041
|
+
200: Conversation;
|
|
522
1042
|
};
|
|
523
1043
|
|
|
1044
|
+
export type PostConversationsResponse =
|
|
1045
|
+
PostConversationsResponses[keyof PostConversationsResponses];
|
|
1046
|
+
|
|
524
1047
|
export type PutConversationsData = {
|
|
525
1048
|
body: {
|
|
526
1049
|
/**
|
|
@@ -538,6 +1061,10 @@ export type PutConversationsData = {
|
|
|
538
1061
|
};
|
|
539
1062
|
|
|
540
1063
|
export type PutConversationsErrors = {
|
|
1064
|
+
/**
|
|
1065
|
+
* Invalid request parameters or invalid status value
|
|
1066
|
+
*/
|
|
1067
|
+
400: ErrorResponse;
|
|
541
1068
|
/**
|
|
542
1069
|
* Unauthorized — requires Bearer token
|
|
543
1070
|
*/
|
|
@@ -545,16 +1072,20 @@ export type PutConversationsErrors = {
|
|
|
545
1072
|
/**
|
|
546
1073
|
* Internal server error
|
|
547
1074
|
*/
|
|
548
|
-
500:
|
|
1075
|
+
500: ErrorResponse;
|
|
549
1076
|
};
|
|
550
1077
|
|
|
1078
|
+
export type PutConversationsError = PutConversationsErrors[keyof PutConversationsErrors];
|
|
1079
|
+
|
|
551
1080
|
export type PutConversationsResponses = {
|
|
552
1081
|
/**
|
|
553
|
-
*
|
|
1082
|
+
* The updated conversation object
|
|
554
1083
|
*/
|
|
555
|
-
200:
|
|
1084
|
+
200: Conversation;
|
|
556
1085
|
};
|
|
557
1086
|
|
|
1087
|
+
export type PutConversationsResponse = PutConversationsResponses[keyof PutConversationsResponses];
|
|
1088
|
+
|
|
558
1089
|
export type GetParticipantsData = {
|
|
559
1090
|
body?: never;
|
|
560
1091
|
path?: never;
|
|
@@ -566,6 +1097,10 @@ export type GetParticipantsData = {
|
|
|
566
1097
|
};
|
|
567
1098
|
|
|
568
1099
|
export type GetParticipantsErrors = {
|
|
1100
|
+
/**
|
|
1101
|
+
* Invalid request parameters
|
|
1102
|
+
*/
|
|
1103
|
+
400: ErrorResponse;
|
|
569
1104
|
/**
|
|
570
1105
|
* Unauthorized — requires Bearer token
|
|
571
1106
|
*/
|
|
@@ -573,16 +1108,25 @@ export type GetParticipantsErrors = {
|
|
|
573
1108
|
/**
|
|
574
1109
|
* Internal server error
|
|
575
1110
|
*/
|
|
576
|
-
500:
|
|
1111
|
+
500: ErrorResponse;
|
|
577
1112
|
};
|
|
578
1113
|
|
|
1114
|
+
export type GetParticipantsError = GetParticipantsErrors[keyof GetParticipantsErrors];
|
|
1115
|
+
|
|
579
1116
|
export type GetParticipantsResponses = {
|
|
580
1117
|
/**
|
|
581
1118
|
* Success
|
|
582
1119
|
*/
|
|
583
|
-
200:
|
|
1120
|
+
200: {
|
|
1121
|
+
/**
|
|
1122
|
+
* Participants in the conversation
|
|
1123
|
+
*/
|
|
1124
|
+
participants: Array<Participant>;
|
|
1125
|
+
};
|
|
584
1126
|
};
|
|
585
1127
|
|
|
1128
|
+
export type GetParticipantsResponse = GetParticipantsResponses[keyof GetParticipantsResponses];
|
|
1129
|
+
|
|
586
1130
|
export type PostParticipantsData = {
|
|
587
1131
|
body: {
|
|
588
1132
|
/**
|
|
@@ -604,6 +1148,10 @@ export type PostParticipantsData = {
|
|
|
604
1148
|
};
|
|
605
1149
|
|
|
606
1150
|
export type PostParticipantsErrors = {
|
|
1151
|
+
/**
|
|
1152
|
+
* Invalid request parameters or invalid participant type
|
|
1153
|
+
*/
|
|
1154
|
+
400: ErrorResponse;
|
|
607
1155
|
/**
|
|
608
1156
|
* Unauthorized — requires Bearer token
|
|
609
1157
|
*/
|
|
@@ -611,16 +1159,22 @@ export type PostParticipantsErrors = {
|
|
|
611
1159
|
/**
|
|
612
1160
|
* Internal server error
|
|
613
1161
|
*/
|
|
614
|
-
500:
|
|
1162
|
+
500: ErrorResponse;
|
|
615
1163
|
};
|
|
616
1164
|
|
|
1165
|
+
export type PostParticipantsError = PostParticipantsErrors[keyof PostParticipantsErrors];
|
|
1166
|
+
|
|
617
1167
|
export type PostParticipantsResponses = {
|
|
618
1168
|
/**
|
|
619
|
-
*
|
|
1169
|
+
* The created participant object from Twilio
|
|
620
1170
|
*/
|
|
621
|
-
200:
|
|
1171
|
+
200: {
|
|
1172
|
+
[key: string]: unknown;
|
|
1173
|
+
};
|
|
622
1174
|
};
|
|
623
1175
|
|
|
1176
|
+
export type PostParticipantsResponse = PostParticipantsResponses[keyof PostParticipantsResponses];
|
|
1177
|
+
|
|
624
1178
|
export type PutParticipantsData = {
|
|
625
1179
|
body: {
|
|
626
1180
|
/**
|
|
@@ -638,6 +1192,10 @@ export type PutParticipantsData = {
|
|
|
638
1192
|
};
|
|
639
1193
|
|
|
640
1194
|
export type PutParticipantsErrors = {
|
|
1195
|
+
/**
|
|
1196
|
+
* Invalid request parameters
|
|
1197
|
+
*/
|
|
1198
|
+
400: ErrorResponse;
|
|
641
1199
|
/**
|
|
642
1200
|
* Unauthorized — requires Bearer token
|
|
643
1201
|
*/
|
|
@@ -645,16 +1203,22 @@ export type PutParticipantsErrors = {
|
|
|
645
1203
|
/**
|
|
646
1204
|
* Internal server error
|
|
647
1205
|
*/
|
|
648
|
-
500:
|
|
1206
|
+
500: ErrorResponse;
|
|
649
1207
|
};
|
|
650
1208
|
|
|
1209
|
+
export type PutParticipantsError = PutParticipantsErrors[keyof PutParticipantsErrors];
|
|
1210
|
+
|
|
651
1211
|
export type PutParticipantsResponses = {
|
|
652
1212
|
/**
|
|
653
|
-
*
|
|
1213
|
+
* The updated participant object from Twilio
|
|
654
1214
|
*/
|
|
655
|
-
200:
|
|
1215
|
+
200: {
|
|
1216
|
+
[key: string]: unknown;
|
|
1217
|
+
};
|
|
656
1218
|
};
|
|
657
1219
|
|
|
1220
|
+
export type PutParticipantsResponse = PutParticipantsResponses[keyof PutParticipantsResponses];
|
|
1221
|
+
|
|
658
1222
|
export type DeleteConversationalIntelligenceOperatorData = {
|
|
659
1223
|
body: {
|
|
660
1224
|
/**
|
|
@@ -668,23 +1232,38 @@ export type DeleteConversationalIntelligenceOperatorData = {
|
|
|
668
1232
|
};
|
|
669
1233
|
|
|
670
1234
|
export type DeleteConversationalIntelligenceOperatorErrors = {
|
|
1235
|
+
/**
|
|
1236
|
+
* Missing request parameters
|
|
1237
|
+
*/
|
|
1238
|
+
400: ErrorResponse;
|
|
671
1239
|
/**
|
|
672
1240
|
* Unauthorized — requires Bearer token
|
|
673
1241
|
*/
|
|
674
1242
|
401: unknown;
|
|
675
1243
|
/**
|
|
676
|
-
*
|
|
1244
|
+
* Operator api error, or internal server error
|
|
677
1245
|
*/
|
|
678
|
-
500:
|
|
1246
|
+
500: ErrorResponse;
|
|
679
1247
|
};
|
|
680
1248
|
|
|
1249
|
+
export type DeleteConversationalIntelligenceOperatorError =
|
|
1250
|
+
DeleteConversationalIntelligenceOperatorErrors[keyof DeleteConversationalIntelligenceOperatorErrors];
|
|
1251
|
+
|
|
681
1252
|
export type DeleteConversationalIntelligenceOperatorResponses = {
|
|
682
1253
|
/**
|
|
683
1254
|
* Success
|
|
684
1255
|
*/
|
|
685
|
-
200:
|
|
1256
|
+
200: {
|
|
1257
|
+
/**
|
|
1258
|
+
* Always true on successful deletion
|
|
1259
|
+
*/
|
|
1260
|
+
success: boolean;
|
|
1261
|
+
};
|
|
686
1262
|
};
|
|
687
1263
|
|
|
1264
|
+
export type DeleteConversationalIntelligenceOperatorResponse =
|
|
1265
|
+
DeleteConversationalIntelligenceOperatorResponses[keyof DeleteConversationalIntelligenceOperatorResponses];
|
|
1266
|
+
|
|
688
1267
|
export type GetConversationalIntelligenceOperatorData = {
|
|
689
1268
|
body?: never;
|
|
690
1269
|
path?: never;
|
|
@@ -696,6 +1275,10 @@ export type GetConversationalIntelligenceOperatorData = {
|
|
|
696
1275
|
};
|
|
697
1276
|
|
|
698
1277
|
export type GetConversationalIntelligenceOperatorErrors = {
|
|
1278
|
+
/**
|
|
1279
|
+
* pageToken should not be provided together with intelligenceOperatorId
|
|
1280
|
+
*/
|
|
1281
|
+
400: ErrorResponse;
|
|
699
1282
|
/**
|
|
700
1283
|
* Unauthorized — requires Bearer token
|
|
701
1284
|
*/
|
|
@@ -703,16 +1286,24 @@ export type GetConversationalIntelligenceOperatorErrors = {
|
|
|
703
1286
|
/**
|
|
704
1287
|
* Internal server error
|
|
705
1288
|
*/
|
|
706
|
-
500:
|
|
1289
|
+
500: ErrorResponse;
|
|
707
1290
|
};
|
|
708
1291
|
|
|
1292
|
+
export type GetConversationalIntelligenceOperatorError =
|
|
1293
|
+
GetConversationalIntelligenceOperatorErrors[keyof GetConversationalIntelligenceOperatorErrors];
|
|
1294
|
+
|
|
709
1295
|
export type GetConversationalIntelligenceOperatorResponses = {
|
|
710
1296
|
/**
|
|
711
|
-
*
|
|
1297
|
+
* A single Operator (when intelligenceOperatorId is provided) or an OperatorList (paginated)
|
|
712
1298
|
*/
|
|
713
|
-
200:
|
|
1299
|
+
200: {
|
|
1300
|
+
[key: string]: unknown;
|
|
1301
|
+
};
|
|
714
1302
|
};
|
|
715
1303
|
|
|
1304
|
+
export type GetConversationalIntelligenceOperatorResponse =
|
|
1305
|
+
GetConversationalIntelligenceOperatorResponses[keyof GetConversationalIntelligenceOperatorResponses];
|
|
1306
|
+
|
|
716
1307
|
export type PostConversationalIntelligenceOperatorData = {
|
|
717
1308
|
body: {
|
|
718
1309
|
/**
|
|
@@ -746,6 +1337,10 @@ export type PostConversationalIntelligenceOperatorData = {
|
|
|
746
1337
|
};
|
|
747
1338
|
|
|
748
1339
|
export type PostConversationalIntelligenceOperatorErrors = {
|
|
1340
|
+
/**
|
|
1341
|
+
* Missing or invalid request parameters
|
|
1342
|
+
*/
|
|
1343
|
+
400: ErrorResponse;
|
|
749
1344
|
/**
|
|
750
1345
|
* Unauthorized — requires Bearer token
|
|
751
1346
|
*/
|
|
@@ -753,16 +1348,22 @@ export type PostConversationalIntelligenceOperatorErrors = {
|
|
|
753
1348
|
/**
|
|
754
1349
|
* Internal server error
|
|
755
1350
|
*/
|
|
756
|
-
500:
|
|
1351
|
+
500: ErrorResponse;
|
|
757
1352
|
};
|
|
758
1353
|
|
|
1354
|
+
export type PostConversationalIntelligenceOperatorError =
|
|
1355
|
+
PostConversationalIntelligenceOperatorErrors[keyof PostConversationalIntelligenceOperatorErrors];
|
|
1356
|
+
|
|
759
1357
|
export type PostConversationalIntelligenceOperatorResponses = {
|
|
760
1358
|
/**
|
|
761
|
-
*
|
|
1359
|
+
* The created operator object
|
|
762
1360
|
*/
|
|
763
|
-
200:
|
|
1361
|
+
200: Operator;
|
|
764
1362
|
};
|
|
765
1363
|
|
|
1364
|
+
export type PostConversationalIntelligenceOperatorResponse =
|
|
1365
|
+
PostConversationalIntelligenceOperatorResponses[keyof PostConversationalIntelligenceOperatorResponses];
|
|
1366
|
+
|
|
766
1367
|
export type PutConversationalIntelligenceOperatorData = {
|
|
767
1368
|
body: {
|
|
768
1369
|
/**
|
|
@@ -796,6 +1397,10 @@ export type PutConversationalIntelligenceOperatorData = {
|
|
|
796
1397
|
};
|
|
797
1398
|
|
|
798
1399
|
export type PutConversationalIntelligenceOperatorErrors = {
|
|
1400
|
+
/**
|
|
1401
|
+
* Missing or invalid request parameters
|
|
1402
|
+
*/
|
|
1403
|
+
400: ErrorResponse;
|
|
799
1404
|
/**
|
|
800
1405
|
* Unauthorized — requires Bearer token
|
|
801
1406
|
*/
|
|
@@ -803,16 +1408,22 @@ export type PutConversationalIntelligenceOperatorErrors = {
|
|
|
803
1408
|
/**
|
|
804
1409
|
* Internal server error
|
|
805
1410
|
*/
|
|
806
|
-
500:
|
|
1411
|
+
500: ErrorResponse;
|
|
807
1412
|
};
|
|
808
1413
|
|
|
1414
|
+
export type PutConversationalIntelligenceOperatorError =
|
|
1415
|
+
PutConversationalIntelligenceOperatorErrors[keyof PutConversationalIntelligenceOperatorErrors];
|
|
1416
|
+
|
|
809
1417
|
export type PutConversationalIntelligenceOperatorResponses = {
|
|
810
1418
|
/**
|
|
811
|
-
*
|
|
1419
|
+
* The updated operator object
|
|
812
1420
|
*/
|
|
813
|
-
200:
|
|
1421
|
+
200: Operator;
|
|
814
1422
|
};
|
|
815
1423
|
|
|
1424
|
+
export type PutConversationalIntelligenceOperatorResponse =
|
|
1425
|
+
PutConversationalIntelligenceOperatorResponses[keyof PutConversationalIntelligenceOperatorResponses];
|
|
1426
|
+
|
|
816
1427
|
export type GetIntelligenceConfigurationData = {
|
|
817
1428
|
body?: never;
|
|
818
1429
|
path?: never;
|
|
@@ -824,6 +1435,10 @@ export type GetIntelligenceConfigurationData = {
|
|
|
824
1435
|
};
|
|
825
1436
|
|
|
826
1437
|
export type GetIntelligenceConfigurationErrors = {
|
|
1438
|
+
/**
|
|
1439
|
+
* pageToken should not be provided together with intelligenceConfigurationId
|
|
1440
|
+
*/
|
|
1441
|
+
400: ErrorResponse;
|
|
827
1442
|
/**
|
|
828
1443
|
* Unauthorized — requires Bearer token
|
|
829
1444
|
*/
|
|
@@ -831,16 +1446,24 @@ export type GetIntelligenceConfigurationErrors = {
|
|
|
831
1446
|
/**
|
|
832
1447
|
* Internal server error
|
|
833
1448
|
*/
|
|
834
|
-
500:
|
|
1449
|
+
500: ErrorResponse;
|
|
835
1450
|
};
|
|
836
1451
|
|
|
1452
|
+
export type GetIntelligenceConfigurationError =
|
|
1453
|
+
GetIntelligenceConfigurationErrors[keyof GetIntelligenceConfigurationErrors];
|
|
1454
|
+
|
|
837
1455
|
export type GetIntelligenceConfigurationResponses = {
|
|
838
1456
|
/**
|
|
839
|
-
*
|
|
1457
|
+
* A single IntelligenceConfiguration (when intelligenceConfigurationId is provided) or an IntelligenceConfigurationList (paginated)
|
|
840
1458
|
*/
|
|
841
|
-
200:
|
|
1459
|
+
200: {
|
|
1460
|
+
[key: string]: unknown;
|
|
1461
|
+
};
|
|
842
1462
|
};
|
|
843
1463
|
|
|
1464
|
+
export type GetIntelligenceConfigurationResponse =
|
|
1465
|
+
GetIntelligenceConfigurationResponses[keyof GetIntelligenceConfigurationResponses];
|
|
1466
|
+
|
|
844
1467
|
export type PostIntelligenceConfigurationData = {
|
|
845
1468
|
body: {
|
|
846
1469
|
[key: string]: unknown;
|
|
@@ -851,6 +1474,10 @@ export type PostIntelligenceConfigurationData = {
|
|
|
851
1474
|
};
|
|
852
1475
|
|
|
853
1476
|
export type PostIntelligenceConfigurationErrors = {
|
|
1477
|
+
/**
|
|
1478
|
+
* Missing request parameters
|
|
1479
|
+
*/
|
|
1480
|
+
400: ErrorResponse;
|
|
854
1481
|
/**
|
|
855
1482
|
* Unauthorized — requires Bearer token
|
|
856
1483
|
*/
|
|
@@ -858,16 +1485,22 @@ export type PostIntelligenceConfigurationErrors = {
|
|
|
858
1485
|
/**
|
|
859
1486
|
* Internal server error
|
|
860
1487
|
*/
|
|
861
|
-
500:
|
|
1488
|
+
500: ErrorResponse;
|
|
862
1489
|
};
|
|
863
1490
|
|
|
1491
|
+
export type PostIntelligenceConfigurationError =
|
|
1492
|
+
PostIntelligenceConfigurationErrors[keyof PostIntelligenceConfigurationErrors];
|
|
1493
|
+
|
|
864
1494
|
export type PostIntelligenceConfigurationResponses = {
|
|
865
1495
|
/**
|
|
866
|
-
*
|
|
1496
|
+
* The created configuration
|
|
867
1497
|
*/
|
|
868
|
-
200:
|
|
1498
|
+
200: IntelligenceConfiguration;
|
|
869
1499
|
};
|
|
870
1500
|
|
|
1501
|
+
export type PostIntelligenceConfigurationResponse =
|
|
1502
|
+
PostIntelligenceConfigurationResponses[keyof PostIntelligenceConfigurationResponses];
|
|
1503
|
+
|
|
871
1504
|
export type PutIntelligenceConfigurationData = {
|
|
872
1505
|
body: {
|
|
873
1506
|
/**
|
|
@@ -881,6 +1514,10 @@ export type PutIntelligenceConfigurationData = {
|
|
|
881
1514
|
};
|
|
882
1515
|
|
|
883
1516
|
export type PutIntelligenceConfigurationErrors = {
|
|
1517
|
+
/**
|
|
1518
|
+
* Missing or invalid request parameters
|
|
1519
|
+
*/
|
|
1520
|
+
400: ErrorResponse;
|
|
884
1521
|
/**
|
|
885
1522
|
* Unauthorized — requires Bearer token
|
|
886
1523
|
*/
|
|
@@ -888,16 +1525,22 @@ export type PutIntelligenceConfigurationErrors = {
|
|
|
888
1525
|
/**
|
|
889
1526
|
* Internal server error
|
|
890
1527
|
*/
|
|
891
|
-
500:
|
|
1528
|
+
500: ErrorResponse;
|
|
892
1529
|
};
|
|
893
1530
|
|
|
1531
|
+
export type PutIntelligenceConfigurationError =
|
|
1532
|
+
PutIntelligenceConfigurationErrors[keyof PutIntelligenceConfigurationErrors];
|
|
1533
|
+
|
|
894
1534
|
export type PutIntelligenceConfigurationResponses = {
|
|
895
1535
|
/**
|
|
896
|
-
*
|
|
1536
|
+
* The updated configuration
|
|
897
1537
|
*/
|
|
898
|
-
200:
|
|
1538
|
+
200: IntelligenceConfiguration;
|
|
899
1539
|
};
|
|
900
1540
|
|
|
1541
|
+
export type PutIntelligenceConfigurationResponse =
|
|
1542
|
+
PutIntelligenceConfigurationResponses[keyof PutIntelligenceConfigurationResponses];
|
|
1543
|
+
|
|
901
1544
|
export type DeleteConversationMemoryProfilesData = {
|
|
902
1545
|
body?: never;
|
|
903
1546
|
path?: never;
|
|
@@ -909,6 +1552,10 @@ export type DeleteConversationMemoryProfilesData = {
|
|
|
909
1552
|
};
|
|
910
1553
|
|
|
911
1554
|
export type DeleteConversationMemoryProfilesErrors = {
|
|
1555
|
+
/**
|
|
1556
|
+
* Invalid request parameters
|
|
1557
|
+
*/
|
|
1558
|
+
400: ErrorResponse;
|
|
912
1559
|
/**
|
|
913
1560
|
* Unauthorized — requires Bearer token
|
|
914
1561
|
*/
|
|
@@ -916,16 +1563,28 @@ export type DeleteConversationMemoryProfilesErrors = {
|
|
|
916
1563
|
/**
|
|
917
1564
|
* Internal server error
|
|
918
1565
|
*/
|
|
919
|
-
500:
|
|
1566
|
+
500: ErrorResponse;
|
|
920
1567
|
};
|
|
921
1568
|
|
|
1569
|
+
export type DeleteConversationMemoryProfilesError =
|
|
1570
|
+
DeleteConversationMemoryProfilesErrors[keyof DeleteConversationMemoryProfilesErrors];
|
|
1571
|
+
|
|
922
1572
|
export type DeleteConversationMemoryProfilesResponses = {
|
|
923
1573
|
/**
|
|
924
1574
|
* Success
|
|
925
1575
|
*/
|
|
926
1576
|
200: unknown;
|
|
1577
|
+
/**
|
|
1578
|
+
* Upstream confirmation payload from the Conversation Memory API
|
|
1579
|
+
*/
|
|
1580
|
+
202: {
|
|
1581
|
+
[key: string]: unknown;
|
|
1582
|
+
};
|
|
927
1583
|
};
|
|
928
1584
|
|
|
1585
|
+
export type DeleteConversationMemoryProfilesResponse =
|
|
1586
|
+
DeleteConversationMemoryProfilesResponses[keyof DeleteConversationMemoryProfilesResponses];
|
|
1587
|
+
|
|
929
1588
|
export type GetConversationMemoryProfilesData = {
|
|
930
1589
|
body?: never;
|
|
931
1590
|
path?: never;
|
|
@@ -941,6 +1600,10 @@ export type GetConversationMemoryProfilesData = {
|
|
|
941
1600
|
};
|
|
942
1601
|
|
|
943
1602
|
export type GetConversationMemoryProfilesErrors = {
|
|
1603
|
+
/**
|
|
1604
|
+
* Invalid request parameters
|
|
1605
|
+
*/
|
|
1606
|
+
400: ErrorResponse;
|
|
944
1607
|
/**
|
|
945
1608
|
* Unauthorized — requires Bearer token
|
|
946
1609
|
*/
|
|
@@ -948,16 +1611,24 @@ export type GetConversationMemoryProfilesErrors = {
|
|
|
948
1611
|
/**
|
|
949
1612
|
* Internal server error
|
|
950
1613
|
*/
|
|
951
|
-
500:
|
|
1614
|
+
500: ErrorResponse;
|
|
952
1615
|
};
|
|
953
1616
|
|
|
1617
|
+
export type GetConversationMemoryProfilesError =
|
|
1618
|
+
GetConversationMemoryProfilesErrors[keyof GetConversationMemoryProfilesErrors];
|
|
1619
|
+
|
|
954
1620
|
export type GetConversationMemoryProfilesResponses = {
|
|
955
1621
|
/**
|
|
956
|
-
*
|
|
1622
|
+
* Upstream profile data (single profile or paginated list) from the Conversation Memory API
|
|
957
1623
|
*/
|
|
958
|
-
200:
|
|
1624
|
+
200: {
|
|
1625
|
+
[key: string]: unknown;
|
|
1626
|
+
};
|
|
959
1627
|
};
|
|
960
1628
|
|
|
1629
|
+
export type GetConversationMemoryProfilesResponse =
|
|
1630
|
+
GetConversationMemoryProfilesResponses[keyof GetConversationMemoryProfilesResponses];
|
|
1631
|
+
|
|
961
1632
|
export type PatchConversationMemoryProfilesData = {
|
|
962
1633
|
body: {
|
|
963
1634
|
/**
|
|
@@ -971,7 +1642,9 @@ export type PatchConversationMemoryProfilesData = {
|
|
|
971
1642
|
/**
|
|
972
1643
|
* Trait groups with key-value pairs to merge (required)
|
|
973
1644
|
*/
|
|
974
|
-
traits:
|
|
1645
|
+
traits: {
|
|
1646
|
+
[key: string]: unknown;
|
|
1647
|
+
};
|
|
975
1648
|
};
|
|
976
1649
|
path?: never;
|
|
977
1650
|
query?: never;
|
|
@@ -979,6 +1652,10 @@ export type PatchConversationMemoryProfilesData = {
|
|
|
979
1652
|
};
|
|
980
1653
|
|
|
981
1654
|
export type PatchConversationMemoryProfilesErrors = {
|
|
1655
|
+
/**
|
|
1656
|
+
* Invalid request parameters
|
|
1657
|
+
*/
|
|
1658
|
+
400: ErrorResponse;
|
|
982
1659
|
/**
|
|
983
1660
|
* Unauthorized — requires Bearer token
|
|
984
1661
|
*/
|
|
@@ -986,16 +1663,28 @@ export type PatchConversationMemoryProfilesErrors = {
|
|
|
986
1663
|
/**
|
|
987
1664
|
* Internal server error
|
|
988
1665
|
*/
|
|
989
|
-
500:
|
|
1666
|
+
500: ErrorResponse;
|
|
990
1667
|
};
|
|
991
1668
|
|
|
1669
|
+
export type PatchConversationMemoryProfilesError =
|
|
1670
|
+
PatchConversationMemoryProfilesErrors[keyof PatchConversationMemoryProfilesErrors];
|
|
1671
|
+
|
|
992
1672
|
export type PatchConversationMemoryProfilesResponses = {
|
|
993
1673
|
/**
|
|
994
1674
|
* Success
|
|
995
1675
|
*/
|
|
996
1676
|
200: unknown;
|
|
1677
|
+
/**
|
|
1678
|
+
* Upstream confirmation payload from the Conversation Memory API
|
|
1679
|
+
*/
|
|
1680
|
+
202: {
|
|
1681
|
+
[key: string]: unknown;
|
|
1682
|
+
};
|
|
997
1683
|
};
|
|
998
1684
|
|
|
1685
|
+
export type PatchConversationMemoryProfilesResponse =
|
|
1686
|
+
PatchConversationMemoryProfilesResponses[keyof PatchConversationMemoryProfilesResponses];
|
|
1687
|
+
|
|
999
1688
|
export type PostConversationMemoryProfilesData = {
|
|
1000
1689
|
body: {
|
|
1001
1690
|
/**
|
|
@@ -1005,7 +1694,9 @@ export type PostConversationMemoryProfilesData = {
|
|
|
1005
1694
|
/**
|
|
1006
1695
|
* Trait groups with key-value pairs (required)
|
|
1007
1696
|
*/
|
|
1008
|
-
traits:
|
|
1697
|
+
traits: {
|
|
1698
|
+
[key: string]: unknown;
|
|
1699
|
+
};
|
|
1009
1700
|
};
|
|
1010
1701
|
path?: never;
|
|
1011
1702
|
query?: never;
|
|
@@ -1013,6 +1704,10 @@ export type PostConversationMemoryProfilesData = {
|
|
|
1013
1704
|
};
|
|
1014
1705
|
|
|
1015
1706
|
export type PostConversationMemoryProfilesErrors = {
|
|
1707
|
+
/**
|
|
1708
|
+
* Invalid request parameters
|
|
1709
|
+
*/
|
|
1710
|
+
400: ErrorResponse;
|
|
1016
1711
|
/**
|
|
1017
1712
|
* Unauthorized — requires Bearer token
|
|
1018
1713
|
*/
|
|
@@ -1020,16 +1715,28 @@ export type PostConversationMemoryProfilesErrors = {
|
|
|
1020
1715
|
/**
|
|
1021
1716
|
* Internal server error
|
|
1022
1717
|
*/
|
|
1023
|
-
500:
|
|
1718
|
+
500: ErrorResponse;
|
|
1024
1719
|
};
|
|
1025
1720
|
|
|
1721
|
+
export type PostConversationMemoryProfilesError =
|
|
1722
|
+
PostConversationMemoryProfilesErrors[keyof PostConversationMemoryProfilesErrors];
|
|
1723
|
+
|
|
1026
1724
|
export type PostConversationMemoryProfilesResponses = {
|
|
1027
1725
|
/**
|
|
1028
1726
|
* Success
|
|
1029
1727
|
*/
|
|
1030
1728
|
200: unknown;
|
|
1729
|
+
/**
|
|
1730
|
+
* Upstream confirmation payload from the Conversation Memory API
|
|
1731
|
+
*/
|
|
1732
|
+
202: {
|
|
1733
|
+
[key: string]: unknown;
|
|
1734
|
+
};
|
|
1031
1735
|
};
|
|
1032
1736
|
|
|
1737
|
+
export type PostConversationMemoryProfilesResponse =
|
|
1738
|
+
PostConversationMemoryProfilesResponses[keyof PostConversationMemoryProfilesResponses];
|
|
1739
|
+
|
|
1033
1740
|
export type PostConversationMemoryProfilesLookupData = {
|
|
1034
1741
|
body: {
|
|
1035
1742
|
/**
|
|
@@ -1051,6 +1758,10 @@ export type PostConversationMemoryProfilesLookupData = {
|
|
|
1051
1758
|
};
|
|
1052
1759
|
|
|
1053
1760
|
export type PostConversationMemoryProfilesLookupErrors = {
|
|
1761
|
+
/**
|
|
1762
|
+
* Invalid request parameters
|
|
1763
|
+
*/
|
|
1764
|
+
400: ErrorResponse;
|
|
1054
1765
|
/**
|
|
1055
1766
|
* Unauthorized — requires Bearer token
|
|
1056
1767
|
*/
|
|
@@ -1058,16 +1769,24 @@ export type PostConversationMemoryProfilesLookupErrors = {
|
|
|
1058
1769
|
/**
|
|
1059
1770
|
* Internal server error
|
|
1060
1771
|
*/
|
|
1061
|
-
500:
|
|
1772
|
+
500: ErrorResponse;
|
|
1062
1773
|
};
|
|
1063
1774
|
|
|
1775
|
+
export type PostConversationMemoryProfilesLookupError =
|
|
1776
|
+
PostConversationMemoryProfilesLookupErrors[keyof PostConversationMemoryProfilesLookupErrors];
|
|
1777
|
+
|
|
1064
1778
|
export type PostConversationMemoryProfilesLookupResponses = {
|
|
1065
1779
|
/**
|
|
1066
|
-
*
|
|
1780
|
+
* Upstream matching profiles payload from the Conversation Memory API
|
|
1067
1781
|
*/
|
|
1068
|
-
200:
|
|
1782
|
+
200: {
|
|
1783
|
+
[key: string]: unknown;
|
|
1784
|
+
};
|
|
1069
1785
|
};
|
|
1070
1786
|
|
|
1787
|
+
export type PostConversationMemoryProfilesLookupResponse =
|
|
1788
|
+
PostConversationMemoryProfilesLookupResponses[keyof PostConversationMemoryProfilesLookupResponses];
|
|
1789
|
+
|
|
1071
1790
|
export type PostConversationMemoryRecallData = {
|
|
1072
1791
|
body: {
|
|
1073
1792
|
/**
|
|
@@ -1085,6 +1804,10 @@ export type PostConversationMemoryRecallData = {
|
|
|
1085
1804
|
};
|
|
1086
1805
|
|
|
1087
1806
|
export type PostConversationMemoryRecallErrors = {
|
|
1807
|
+
/**
|
|
1808
|
+
* Invalid request parameters
|
|
1809
|
+
*/
|
|
1810
|
+
400: ErrorResponse;
|
|
1088
1811
|
/**
|
|
1089
1812
|
* Unauthorized — requires Bearer token
|
|
1090
1813
|
*/
|
|
@@ -1092,16 +1815,24 @@ export type PostConversationMemoryRecallErrors = {
|
|
|
1092
1815
|
/**
|
|
1093
1816
|
* Internal server error
|
|
1094
1817
|
*/
|
|
1095
|
-
500:
|
|
1818
|
+
500: ErrorResponse;
|
|
1096
1819
|
};
|
|
1097
1820
|
|
|
1821
|
+
export type PostConversationMemoryRecallError =
|
|
1822
|
+
PostConversationMemoryRecallErrors[keyof PostConversationMemoryRecallErrors];
|
|
1823
|
+
|
|
1098
1824
|
export type PostConversationMemoryRecallResponses = {
|
|
1099
1825
|
/**
|
|
1100
|
-
*
|
|
1826
|
+
* Upstream memory retrieval results from the Conversation Memory API
|
|
1101
1827
|
*/
|
|
1102
|
-
200:
|
|
1828
|
+
200: {
|
|
1829
|
+
[key: string]: unknown;
|
|
1830
|
+
};
|
|
1103
1831
|
};
|
|
1104
1832
|
|
|
1833
|
+
export type PostConversationMemoryRecallResponse =
|
|
1834
|
+
PostConversationMemoryRecallResponses[keyof PostConversationMemoryRecallResponses];
|
|
1835
|
+
|
|
1105
1836
|
export type DeleteConversationMemoryIdentifiersData = {
|
|
1106
1837
|
body?: never;
|
|
1107
1838
|
path?: never;
|
|
@@ -1115,6 +1846,10 @@ export type DeleteConversationMemoryIdentifiersData = {
|
|
|
1115
1846
|
};
|
|
1116
1847
|
|
|
1117
1848
|
export type DeleteConversationMemoryIdentifiersErrors = {
|
|
1849
|
+
/**
|
|
1850
|
+
* Invalid request parameters
|
|
1851
|
+
*/
|
|
1852
|
+
400: ErrorResponse;
|
|
1118
1853
|
/**
|
|
1119
1854
|
* Unauthorized — requires Bearer token
|
|
1120
1855
|
*/
|
|
@@ -1122,16 +1857,28 @@ export type DeleteConversationMemoryIdentifiersErrors = {
|
|
|
1122
1857
|
/**
|
|
1123
1858
|
* Internal server error
|
|
1124
1859
|
*/
|
|
1125
|
-
500:
|
|
1860
|
+
500: ErrorResponse;
|
|
1126
1861
|
};
|
|
1127
1862
|
|
|
1863
|
+
export type DeleteConversationMemoryIdentifiersError =
|
|
1864
|
+
DeleteConversationMemoryIdentifiersErrors[keyof DeleteConversationMemoryIdentifiersErrors];
|
|
1865
|
+
|
|
1128
1866
|
export type DeleteConversationMemoryIdentifiersResponses = {
|
|
1129
1867
|
/**
|
|
1130
1868
|
* Success
|
|
1131
1869
|
*/
|
|
1132
1870
|
200: unknown;
|
|
1871
|
+
/**
|
|
1872
|
+
* Upstream confirmation payload from the Conversation Memory API
|
|
1873
|
+
*/
|
|
1874
|
+
202: {
|
|
1875
|
+
[key: string]: unknown;
|
|
1876
|
+
};
|
|
1133
1877
|
};
|
|
1134
1878
|
|
|
1879
|
+
export type DeleteConversationMemoryIdentifiersResponse =
|
|
1880
|
+
DeleteConversationMemoryIdentifiersResponses[keyof DeleteConversationMemoryIdentifiersResponses];
|
|
1881
|
+
|
|
1135
1882
|
export type GetConversationMemoryIdentifiersData = {
|
|
1136
1883
|
body?: never;
|
|
1137
1884
|
path?: never;
|
|
@@ -1144,6 +1891,10 @@ export type GetConversationMemoryIdentifiersData = {
|
|
|
1144
1891
|
};
|
|
1145
1892
|
|
|
1146
1893
|
export type GetConversationMemoryIdentifiersErrors = {
|
|
1894
|
+
/**
|
|
1895
|
+
* Invalid request parameters
|
|
1896
|
+
*/
|
|
1897
|
+
400: ErrorResponse;
|
|
1147
1898
|
/**
|
|
1148
1899
|
* Unauthorized — requires Bearer token
|
|
1149
1900
|
*/
|
|
@@ -1151,16 +1902,24 @@ export type GetConversationMemoryIdentifiersErrors = {
|
|
|
1151
1902
|
/**
|
|
1152
1903
|
* Internal server error
|
|
1153
1904
|
*/
|
|
1154
|
-
500:
|
|
1905
|
+
500: ErrorResponse;
|
|
1155
1906
|
};
|
|
1156
1907
|
|
|
1908
|
+
export type GetConversationMemoryIdentifiersError =
|
|
1909
|
+
GetConversationMemoryIdentifiersErrors[keyof GetConversationMemoryIdentifiersErrors];
|
|
1910
|
+
|
|
1157
1911
|
export type GetConversationMemoryIdentifiersResponses = {
|
|
1158
1912
|
/**
|
|
1159
|
-
*
|
|
1913
|
+
* Upstream identifier data from the Conversation Memory API
|
|
1160
1914
|
*/
|
|
1161
|
-
200:
|
|
1915
|
+
200: {
|
|
1916
|
+
[key: string]: unknown;
|
|
1917
|
+
};
|
|
1162
1918
|
};
|
|
1163
1919
|
|
|
1920
|
+
export type GetConversationMemoryIdentifiersResponse =
|
|
1921
|
+
GetConversationMemoryIdentifiersResponses[keyof GetConversationMemoryIdentifiersResponses];
|
|
1922
|
+
|
|
1164
1923
|
export type PatchConversationMemoryIdentifiersData = {
|
|
1165
1924
|
body: {
|
|
1166
1925
|
/**
|
|
@@ -1190,6 +1949,10 @@ export type PatchConversationMemoryIdentifiersData = {
|
|
|
1190
1949
|
};
|
|
1191
1950
|
|
|
1192
1951
|
export type PatchConversationMemoryIdentifiersErrors = {
|
|
1952
|
+
/**
|
|
1953
|
+
* Invalid request parameters
|
|
1954
|
+
*/
|
|
1955
|
+
400: ErrorResponse;
|
|
1193
1956
|
/**
|
|
1194
1957
|
* Unauthorized — requires Bearer token
|
|
1195
1958
|
*/
|
|
@@ -1197,16 +1960,28 @@ export type PatchConversationMemoryIdentifiersErrors = {
|
|
|
1197
1960
|
/**
|
|
1198
1961
|
* Internal server error
|
|
1199
1962
|
*/
|
|
1200
|
-
500:
|
|
1963
|
+
500: ErrorResponse;
|
|
1201
1964
|
};
|
|
1202
1965
|
|
|
1966
|
+
export type PatchConversationMemoryIdentifiersError =
|
|
1967
|
+
PatchConversationMemoryIdentifiersErrors[keyof PatchConversationMemoryIdentifiersErrors];
|
|
1968
|
+
|
|
1203
1969
|
export type PatchConversationMemoryIdentifiersResponses = {
|
|
1204
1970
|
/**
|
|
1205
1971
|
* Success
|
|
1206
1972
|
*/
|
|
1207
1973
|
200: unknown;
|
|
1974
|
+
/**
|
|
1975
|
+
* Upstream confirmation payload from the Conversation Memory API
|
|
1976
|
+
*/
|
|
1977
|
+
202: {
|
|
1978
|
+
[key: string]: unknown;
|
|
1979
|
+
};
|
|
1208
1980
|
};
|
|
1209
1981
|
|
|
1982
|
+
export type PatchConversationMemoryIdentifiersResponse =
|
|
1983
|
+
PatchConversationMemoryIdentifiersResponses[keyof PatchConversationMemoryIdentifiersResponses];
|
|
1984
|
+
|
|
1210
1985
|
export type PostConversationMemoryIdentifiersData = {
|
|
1211
1986
|
body: {
|
|
1212
1987
|
/**
|
|
@@ -1232,6 +2007,10 @@ export type PostConversationMemoryIdentifiersData = {
|
|
|
1232
2007
|
};
|
|
1233
2008
|
|
|
1234
2009
|
export type PostConversationMemoryIdentifiersErrors = {
|
|
2010
|
+
/**
|
|
2011
|
+
* Invalid request parameters
|
|
2012
|
+
*/
|
|
2013
|
+
400: ErrorResponse;
|
|
1235
2014
|
/**
|
|
1236
2015
|
* Unauthorized — requires Bearer token
|
|
1237
2016
|
*/
|
|
@@ -1239,16 +2018,28 @@ export type PostConversationMemoryIdentifiersErrors = {
|
|
|
1239
2018
|
/**
|
|
1240
2019
|
* Internal server error
|
|
1241
2020
|
*/
|
|
1242
|
-
500:
|
|
2021
|
+
500: ErrorResponse;
|
|
1243
2022
|
};
|
|
1244
2023
|
|
|
2024
|
+
export type PostConversationMemoryIdentifiersError =
|
|
2025
|
+
PostConversationMemoryIdentifiersErrors[keyof PostConversationMemoryIdentifiersErrors];
|
|
2026
|
+
|
|
1245
2027
|
export type PostConversationMemoryIdentifiersResponses = {
|
|
1246
2028
|
/**
|
|
1247
2029
|
* Success
|
|
1248
2030
|
*/
|
|
1249
2031
|
200: unknown;
|
|
2032
|
+
/**
|
|
2033
|
+
* Upstream confirmation payload from the Conversation Memory API
|
|
2034
|
+
*/
|
|
2035
|
+
202: {
|
|
2036
|
+
[key: string]: unknown;
|
|
2037
|
+
};
|
|
1250
2038
|
};
|
|
1251
2039
|
|
|
2040
|
+
export type PostConversationMemoryIdentifiersResponse =
|
|
2041
|
+
PostConversationMemoryIdentifiersResponses[keyof PostConversationMemoryIdentifiersResponses];
|
|
2042
|
+
|
|
1252
2043
|
export type DeleteConversationMemoryTraitGroupsData = {
|
|
1253
2044
|
body?: never;
|
|
1254
2045
|
path?: never;
|
|
@@ -1260,6 +2051,10 @@ export type DeleteConversationMemoryTraitGroupsData = {
|
|
|
1260
2051
|
};
|
|
1261
2052
|
|
|
1262
2053
|
export type DeleteConversationMemoryTraitGroupsErrors = {
|
|
2054
|
+
/**
|
|
2055
|
+
* Invalid request parameters
|
|
2056
|
+
*/
|
|
2057
|
+
400: ErrorResponse;
|
|
1263
2058
|
/**
|
|
1264
2059
|
* Unauthorized — requires Bearer token
|
|
1265
2060
|
*/
|
|
@@ -1267,16 +2062,28 @@ export type DeleteConversationMemoryTraitGroupsErrors = {
|
|
|
1267
2062
|
/**
|
|
1268
2063
|
* Internal server error
|
|
1269
2064
|
*/
|
|
1270
|
-
500:
|
|
2065
|
+
500: ErrorResponse;
|
|
1271
2066
|
};
|
|
1272
2067
|
|
|
2068
|
+
export type DeleteConversationMemoryTraitGroupsError =
|
|
2069
|
+
DeleteConversationMemoryTraitGroupsErrors[keyof DeleteConversationMemoryTraitGroupsErrors];
|
|
2070
|
+
|
|
1273
2071
|
export type DeleteConversationMemoryTraitGroupsResponses = {
|
|
1274
2072
|
/**
|
|
1275
2073
|
* Success
|
|
1276
2074
|
*/
|
|
1277
2075
|
200: unknown;
|
|
2076
|
+
/**
|
|
2077
|
+
* Upstream confirmation payload from the Conversation Memory API
|
|
2078
|
+
*/
|
|
2079
|
+
202: {
|
|
2080
|
+
[key: string]: unknown;
|
|
2081
|
+
};
|
|
1278
2082
|
};
|
|
1279
2083
|
|
|
2084
|
+
export type DeleteConversationMemoryTraitGroupsResponse =
|
|
2085
|
+
DeleteConversationMemoryTraitGroupsResponses[keyof DeleteConversationMemoryTraitGroupsResponses];
|
|
2086
|
+
|
|
1280
2087
|
export type GetConversationMemoryTraitGroupsData = {
|
|
1281
2088
|
body?: never;
|
|
1282
2089
|
path?: never;
|
|
@@ -1292,6 +2099,10 @@ export type GetConversationMemoryTraitGroupsData = {
|
|
|
1292
2099
|
};
|
|
1293
2100
|
|
|
1294
2101
|
export type GetConversationMemoryTraitGroupsErrors = {
|
|
2102
|
+
/**
|
|
2103
|
+
* Invalid request parameters
|
|
2104
|
+
*/
|
|
2105
|
+
400: ErrorResponse;
|
|
1295
2106
|
/**
|
|
1296
2107
|
* Unauthorized — requires Bearer token
|
|
1297
2108
|
*/
|
|
@@ -1299,16 +2110,24 @@ export type GetConversationMemoryTraitGroupsErrors = {
|
|
|
1299
2110
|
/**
|
|
1300
2111
|
* Internal server error
|
|
1301
2112
|
*/
|
|
1302
|
-
500:
|
|
2113
|
+
500: ErrorResponse;
|
|
1303
2114
|
};
|
|
1304
2115
|
|
|
2116
|
+
export type GetConversationMemoryTraitGroupsError =
|
|
2117
|
+
GetConversationMemoryTraitGroupsErrors[keyof GetConversationMemoryTraitGroupsErrors];
|
|
2118
|
+
|
|
1305
2119
|
export type GetConversationMemoryTraitGroupsResponses = {
|
|
1306
2120
|
/**
|
|
1307
|
-
*
|
|
2121
|
+
* Upstream Trait Group data (single group or paginated list) from the Conversation Memory API
|
|
1308
2122
|
*/
|
|
1309
|
-
200:
|
|
2123
|
+
200: {
|
|
2124
|
+
[key: string]: unknown;
|
|
2125
|
+
};
|
|
1310
2126
|
};
|
|
1311
2127
|
|
|
2128
|
+
export type GetConversationMemoryTraitGroupsResponse =
|
|
2129
|
+
GetConversationMemoryTraitGroupsResponses[keyof GetConversationMemoryTraitGroupsResponses];
|
|
2130
|
+
|
|
1312
2131
|
export type PatchConversationMemoryTraitGroupsData = {
|
|
1313
2132
|
body: {
|
|
1314
2133
|
/**
|
|
@@ -1326,6 +2145,10 @@ export type PatchConversationMemoryTraitGroupsData = {
|
|
|
1326
2145
|
};
|
|
1327
2146
|
|
|
1328
2147
|
export type PatchConversationMemoryTraitGroupsErrors = {
|
|
2148
|
+
/**
|
|
2149
|
+
* Invalid request parameters
|
|
2150
|
+
*/
|
|
2151
|
+
400: ErrorResponse;
|
|
1329
2152
|
/**
|
|
1330
2153
|
* Unauthorized — requires Bearer token
|
|
1331
2154
|
*/
|
|
@@ -1333,16 +2156,28 @@ export type PatchConversationMemoryTraitGroupsErrors = {
|
|
|
1333
2156
|
/**
|
|
1334
2157
|
* Internal server error
|
|
1335
2158
|
*/
|
|
1336
|
-
500:
|
|
2159
|
+
500: ErrorResponse;
|
|
1337
2160
|
};
|
|
1338
2161
|
|
|
2162
|
+
export type PatchConversationMemoryTraitGroupsError =
|
|
2163
|
+
PatchConversationMemoryTraitGroupsErrors[keyof PatchConversationMemoryTraitGroupsErrors];
|
|
2164
|
+
|
|
1339
2165
|
export type PatchConversationMemoryTraitGroupsResponses = {
|
|
1340
2166
|
/**
|
|
1341
2167
|
* Success
|
|
1342
2168
|
*/
|
|
1343
2169
|
200: unknown;
|
|
2170
|
+
/**
|
|
2171
|
+
* Upstream updated Trait Group from the Conversation Memory API
|
|
2172
|
+
*/
|
|
2173
|
+
202: {
|
|
2174
|
+
[key: string]: unknown;
|
|
2175
|
+
};
|
|
1344
2176
|
};
|
|
1345
2177
|
|
|
2178
|
+
export type PatchConversationMemoryTraitGroupsResponse =
|
|
2179
|
+
PatchConversationMemoryTraitGroupsResponses[keyof PatchConversationMemoryTraitGroupsResponses];
|
|
2180
|
+
|
|
1346
2181
|
export type PostConversationMemoryTraitGroupsData = {
|
|
1347
2182
|
body: {
|
|
1348
2183
|
/**
|
|
@@ -1360,6 +2195,10 @@ export type PostConversationMemoryTraitGroupsData = {
|
|
|
1360
2195
|
};
|
|
1361
2196
|
|
|
1362
2197
|
export type PostConversationMemoryTraitGroupsErrors = {
|
|
2198
|
+
/**
|
|
2199
|
+
* Invalid request parameters
|
|
2200
|
+
*/
|
|
2201
|
+
400: ErrorResponse;
|
|
1363
2202
|
/**
|
|
1364
2203
|
* Unauthorized — requires Bearer token
|
|
1365
2204
|
*/
|
|
@@ -1367,16 +2206,28 @@ export type PostConversationMemoryTraitGroupsErrors = {
|
|
|
1367
2206
|
/**
|
|
1368
2207
|
* Internal server error
|
|
1369
2208
|
*/
|
|
1370
|
-
500:
|
|
2209
|
+
500: ErrorResponse;
|
|
1371
2210
|
};
|
|
1372
2211
|
|
|
2212
|
+
export type PostConversationMemoryTraitGroupsError =
|
|
2213
|
+
PostConversationMemoryTraitGroupsErrors[keyof PostConversationMemoryTraitGroupsErrors];
|
|
2214
|
+
|
|
1373
2215
|
export type PostConversationMemoryTraitGroupsResponses = {
|
|
1374
2216
|
/**
|
|
1375
2217
|
* Success
|
|
1376
2218
|
*/
|
|
1377
2219
|
200: unknown;
|
|
2220
|
+
/**
|
|
2221
|
+
* Upstream created Trait Group from the Conversation Memory API
|
|
2222
|
+
*/
|
|
2223
|
+
202: {
|
|
2224
|
+
[key: string]: unknown;
|
|
2225
|
+
};
|
|
1378
2226
|
};
|
|
1379
2227
|
|
|
2228
|
+
export type PostConversationMemoryTraitGroupsResponse =
|
|
2229
|
+
PostConversationMemoryTraitGroupsResponses[keyof PostConversationMemoryTraitGroupsResponses];
|
|
2230
|
+
|
|
1380
2231
|
export type GetConversationMemoryTraitsData = {
|
|
1381
2232
|
body?: never;
|
|
1382
2233
|
path?: never;
|
|
@@ -1392,6 +2243,10 @@ export type GetConversationMemoryTraitsData = {
|
|
|
1392
2243
|
};
|
|
1393
2244
|
|
|
1394
2245
|
export type GetConversationMemoryTraitsErrors = {
|
|
2246
|
+
/**
|
|
2247
|
+
* Invalid request parameters
|
|
2248
|
+
*/
|
|
2249
|
+
400: ErrorResponse;
|
|
1395
2250
|
/**
|
|
1396
2251
|
* Unauthorized — requires Bearer token
|
|
1397
2252
|
*/
|
|
@@ -1399,16 +2254,24 @@ export type GetConversationMemoryTraitsErrors = {
|
|
|
1399
2254
|
/**
|
|
1400
2255
|
* Internal server error
|
|
1401
2256
|
*/
|
|
1402
|
-
500:
|
|
2257
|
+
500: ErrorResponse;
|
|
1403
2258
|
};
|
|
1404
2259
|
|
|
2260
|
+
export type GetConversationMemoryTraitsError =
|
|
2261
|
+
GetConversationMemoryTraitsErrors[keyof GetConversationMemoryTraitsErrors];
|
|
2262
|
+
|
|
1405
2263
|
export type GetConversationMemoryTraitsResponses = {
|
|
1406
2264
|
/**
|
|
1407
|
-
*
|
|
2265
|
+
* Upstream paginated traits list from the Conversation Memory API
|
|
1408
2266
|
*/
|
|
1409
|
-
200:
|
|
2267
|
+
200: {
|
|
2268
|
+
[key: string]: unknown;
|
|
2269
|
+
};
|
|
1410
2270
|
};
|
|
1411
2271
|
|
|
2272
|
+
export type GetConversationMemoryTraitsResponse =
|
|
2273
|
+
GetConversationMemoryTraitsResponses[keyof GetConversationMemoryTraitsResponses];
|
|
2274
|
+
|
|
1412
2275
|
export type DeleteConversationMemoryObservationsData = {
|
|
1413
2276
|
body?: never;
|
|
1414
2277
|
path?: never;
|
|
@@ -1421,6 +2284,10 @@ export type DeleteConversationMemoryObservationsData = {
|
|
|
1421
2284
|
};
|
|
1422
2285
|
|
|
1423
2286
|
export type DeleteConversationMemoryObservationsErrors = {
|
|
2287
|
+
/**
|
|
2288
|
+
* Invalid request parameters
|
|
2289
|
+
*/
|
|
2290
|
+
400: ErrorResponse;
|
|
1424
2291
|
/**
|
|
1425
2292
|
* Unauthorized — requires Bearer token
|
|
1426
2293
|
*/
|
|
@@ -1428,16 +2295,28 @@ export type DeleteConversationMemoryObservationsErrors = {
|
|
|
1428
2295
|
/**
|
|
1429
2296
|
* Internal server error
|
|
1430
2297
|
*/
|
|
1431
|
-
500:
|
|
2298
|
+
500: ErrorResponse;
|
|
1432
2299
|
};
|
|
1433
2300
|
|
|
2301
|
+
export type DeleteConversationMemoryObservationsError =
|
|
2302
|
+
DeleteConversationMemoryObservationsErrors[keyof DeleteConversationMemoryObservationsErrors];
|
|
2303
|
+
|
|
1434
2304
|
export type DeleteConversationMemoryObservationsResponses = {
|
|
1435
2305
|
/**
|
|
1436
2306
|
* Success
|
|
1437
2307
|
*/
|
|
1438
2308
|
200: unknown;
|
|
2309
|
+
/**
|
|
2310
|
+
* Upstream confirmation payload from the Conversation Memory API
|
|
2311
|
+
*/
|
|
2312
|
+
202: {
|
|
2313
|
+
[key: string]: unknown;
|
|
2314
|
+
};
|
|
1439
2315
|
};
|
|
1440
2316
|
|
|
2317
|
+
export type DeleteConversationMemoryObservationsResponse =
|
|
2318
|
+
DeleteConversationMemoryObservationsResponses[keyof DeleteConversationMemoryObservationsResponses];
|
|
2319
|
+
|
|
1441
2320
|
export type GetConversationMemoryObservationsData = {
|
|
1442
2321
|
body?: never;
|
|
1443
2322
|
path?: never;
|
|
@@ -1456,6 +2335,10 @@ export type GetConversationMemoryObservationsData = {
|
|
|
1456
2335
|
};
|
|
1457
2336
|
|
|
1458
2337
|
export type GetConversationMemoryObservationsErrors = {
|
|
2338
|
+
/**
|
|
2339
|
+
* Invalid request parameters
|
|
2340
|
+
*/
|
|
2341
|
+
400: ErrorResponse;
|
|
1459
2342
|
/**
|
|
1460
2343
|
* Unauthorized — requires Bearer token
|
|
1461
2344
|
*/
|
|
@@ -1463,16 +2346,24 @@ export type GetConversationMemoryObservationsErrors = {
|
|
|
1463
2346
|
/**
|
|
1464
2347
|
* Internal server error
|
|
1465
2348
|
*/
|
|
1466
|
-
500:
|
|
2349
|
+
500: ErrorResponse;
|
|
1467
2350
|
};
|
|
1468
2351
|
|
|
2352
|
+
export type GetConversationMemoryObservationsError =
|
|
2353
|
+
GetConversationMemoryObservationsErrors[keyof GetConversationMemoryObservationsErrors];
|
|
2354
|
+
|
|
1469
2355
|
export type GetConversationMemoryObservationsResponses = {
|
|
1470
2356
|
/**
|
|
1471
|
-
*
|
|
2357
|
+
* Upstream observation data (single observation or paginated list) from the Conversation Memory API
|
|
1472
2358
|
*/
|
|
1473
|
-
200:
|
|
2359
|
+
200: {
|
|
2360
|
+
[key: string]: unknown;
|
|
2361
|
+
};
|
|
1474
2362
|
};
|
|
1475
2363
|
|
|
2364
|
+
export type GetConversationMemoryObservationsResponse =
|
|
2365
|
+
GetConversationMemoryObservationsResponses[keyof GetConversationMemoryObservationsResponses];
|
|
2366
|
+
|
|
1476
2367
|
export type PatchConversationMemoryObservationsData = {
|
|
1477
2368
|
body: {
|
|
1478
2369
|
/**
|
|
@@ -1506,6 +2397,10 @@ export type PatchConversationMemoryObservationsData = {
|
|
|
1506
2397
|
};
|
|
1507
2398
|
|
|
1508
2399
|
export type PatchConversationMemoryObservationsErrors = {
|
|
2400
|
+
/**
|
|
2401
|
+
* Invalid request parameters
|
|
2402
|
+
*/
|
|
2403
|
+
400: ErrorResponse;
|
|
1509
2404
|
/**
|
|
1510
2405
|
* Unauthorized — requires Bearer token
|
|
1511
2406
|
*/
|
|
@@ -1513,16 +2408,28 @@ export type PatchConversationMemoryObservationsErrors = {
|
|
|
1513
2408
|
/**
|
|
1514
2409
|
* Internal server error
|
|
1515
2410
|
*/
|
|
1516
|
-
500:
|
|
2411
|
+
500: ErrorResponse;
|
|
1517
2412
|
};
|
|
1518
2413
|
|
|
2414
|
+
export type PatchConversationMemoryObservationsError =
|
|
2415
|
+
PatchConversationMemoryObservationsErrors[keyof PatchConversationMemoryObservationsErrors];
|
|
2416
|
+
|
|
1519
2417
|
export type PatchConversationMemoryObservationsResponses = {
|
|
1520
2418
|
/**
|
|
1521
2419
|
* Success
|
|
1522
2420
|
*/
|
|
1523
2421
|
200: unknown;
|
|
2422
|
+
/**
|
|
2423
|
+
* Upstream confirmation payload from the Conversation Memory API
|
|
2424
|
+
*/
|
|
2425
|
+
202: {
|
|
2426
|
+
[key: string]: unknown;
|
|
2427
|
+
};
|
|
1524
2428
|
};
|
|
1525
2429
|
|
|
2430
|
+
export type PatchConversationMemoryObservationsResponse =
|
|
2431
|
+
PatchConversationMemoryObservationsResponses[keyof PatchConversationMemoryObservationsResponses];
|
|
2432
|
+
|
|
1526
2433
|
export type PostConversationMemoryObservationsData = {
|
|
1527
2434
|
body: {
|
|
1528
2435
|
/**
|
|
@@ -1541,6 +2448,10 @@ export type PostConversationMemoryObservationsData = {
|
|
|
1541
2448
|
};
|
|
1542
2449
|
|
|
1543
2450
|
export type PostConversationMemoryObservationsErrors = {
|
|
2451
|
+
/**
|
|
2452
|
+
* Invalid request parameters
|
|
2453
|
+
*/
|
|
2454
|
+
400: ErrorResponse;
|
|
1544
2455
|
/**
|
|
1545
2456
|
* Unauthorized — requires Bearer token
|
|
1546
2457
|
*/
|
|
@@ -1548,16 +2459,28 @@ export type PostConversationMemoryObservationsErrors = {
|
|
|
1548
2459
|
/**
|
|
1549
2460
|
* Internal server error
|
|
1550
2461
|
*/
|
|
1551
|
-
500:
|
|
2462
|
+
500: ErrorResponse;
|
|
1552
2463
|
};
|
|
1553
2464
|
|
|
2465
|
+
export type PostConversationMemoryObservationsError =
|
|
2466
|
+
PostConversationMemoryObservationsErrors[keyof PostConversationMemoryObservationsErrors];
|
|
2467
|
+
|
|
1554
2468
|
export type PostConversationMemoryObservationsResponses = {
|
|
1555
2469
|
/**
|
|
1556
2470
|
* Success
|
|
1557
2471
|
*/
|
|
1558
2472
|
200: unknown;
|
|
2473
|
+
/**
|
|
2474
|
+
* Upstream confirmation payload from the Conversation Memory API
|
|
2475
|
+
*/
|
|
2476
|
+
202: {
|
|
2477
|
+
[key: string]: unknown;
|
|
2478
|
+
};
|
|
1559
2479
|
};
|
|
1560
2480
|
|
|
2481
|
+
export type PostConversationMemoryObservationsResponse =
|
|
2482
|
+
PostConversationMemoryObservationsResponses[keyof PostConversationMemoryObservationsResponses];
|
|
2483
|
+
|
|
1561
2484
|
export type DeleteConversationMemoryConversationSummariesData = {
|
|
1562
2485
|
body?: never;
|
|
1563
2486
|
path?: never;
|
|
@@ -1570,6 +2493,10 @@ export type DeleteConversationMemoryConversationSummariesData = {
|
|
|
1570
2493
|
};
|
|
1571
2494
|
|
|
1572
2495
|
export type DeleteConversationMemoryConversationSummariesErrors = {
|
|
2496
|
+
/**
|
|
2497
|
+
* Invalid request parameters
|
|
2498
|
+
*/
|
|
2499
|
+
400: ErrorResponse;
|
|
1573
2500
|
/**
|
|
1574
2501
|
* Unauthorized — requires Bearer token
|
|
1575
2502
|
*/
|
|
@@ -1577,16 +2504,28 @@ export type DeleteConversationMemoryConversationSummariesErrors = {
|
|
|
1577
2504
|
/**
|
|
1578
2505
|
* Internal server error
|
|
1579
2506
|
*/
|
|
1580
|
-
500:
|
|
2507
|
+
500: ErrorResponse;
|
|
1581
2508
|
};
|
|
1582
2509
|
|
|
2510
|
+
export type DeleteConversationMemoryConversationSummariesError =
|
|
2511
|
+
DeleteConversationMemoryConversationSummariesErrors[keyof DeleteConversationMemoryConversationSummariesErrors];
|
|
2512
|
+
|
|
1583
2513
|
export type DeleteConversationMemoryConversationSummariesResponses = {
|
|
1584
2514
|
/**
|
|
1585
2515
|
* Success
|
|
1586
2516
|
*/
|
|
1587
2517
|
200: unknown;
|
|
2518
|
+
/**
|
|
2519
|
+
* Upstream confirmation payload from the Conversation Memory API
|
|
2520
|
+
*/
|
|
2521
|
+
202: {
|
|
2522
|
+
[key: string]: unknown;
|
|
2523
|
+
};
|
|
1588
2524
|
};
|
|
1589
2525
|
|
|
2526
|
+
export type DeleteConversationMemoryConversationSummariesResponse =
|
|
2527
|
+
DeleteConversationMemoryConversationSummariesResponses[keyof DeleteConversationMemoryConversationSummariesResponses];
|
|
2528
|
+
|
|
1590
2529
|
export type GetConversationMemoryConversationSummariesData = {
|
|
1591
2530
|
body?: never;
|
|
1592
2531
|
path?: never;
|
|
@@ -1601,6 +2540,10 @@ export type GetConversationMemoryConversationSummariesData = {
|
|
|
1601
2540
|
};
|
|
1602
2541
|
|
|
1603
2542
|
export type GetConversationMemoryConversationSummariesErrors = {
|
|
2543
|
+
/**
|
|
2544
|
+
* Invalid request parameters
|
|
2545
|
+
*/
|
|
2546
|
+
400: ErrorResponse;
|
|
1604
2547
|
/**
|
|
1605
2548
|
* Unauthorized — requires Bearer token
|
|
1606
2549
|
*/
|
|
@@ -1608,16 +2551,24 @@ export type GetConversationMemoryConversationSummariesErrors = {
|
|
|
1608
2551
|
/**
|
|
1609
2552
|
* Internal server error
|
|
1610
2553
|
*/
|
|
1611
|
-
500:
|
|
2554
|
+
500: ErrorResponse;
|
|
1612
2555
|
};
|
|
1613
2556
|
|
|
2557
|
+
export type GetConversationMemoryConversationSummariesError =
|
|
2558
|
+
GetConversationMemoryConversationSummariesErrors[keyof GetConversationMemoryConversationSummariesErrors];
|
|
2559
|
+
|
|
1614
2560
|
export type GetConversationMemoryConversationSummariesResponses = {
|
|
1615
2561
|
/**
|
|
1616
|
-
*
|
|
2562
|
+
* Upstream summary data (single summary or paginated list) from the Conversation Memory API
|
|
1617
2563
|
*/
|
|
1618
|
-
200:
|
|
2564
|
+
200: {
|
|
2565
|
+
[key: string]: unknown;
|
|
2566
|
+
};
|
|
1619
2567
|
};
|
|
1620
2568
|
|
|
2569
|
+
export type GetConversationMemoryConversationSummariesResponse =
|
|
2570
|
+
GetConversationMemoryConversationSummariesResponses[keyof GetConversationMemoryConversationSummariesResponses];
|
|
2571
|
+
|
|
1621
2572
|
export type PatchConversationMemoryConversationSummariesData = {
|
|
1622
2573
|
body: {
|
|
1623
2574
|
/**
|
|
@@ -1639,6 +2590,10 @@ export type PatchConversationMemoryConversationSummariesData = {
|
|
|
1639
2590
|
};
|
|
1640
2591
|
|
|
1641
2592
|
export type PatchConversationMemoryConversationSummariesErrors = {
|
|
2593
|
+
/**
|
|
2594
|
+
* Invalid request parameters, or no field to update was provided
|
|
2595
|
+
*/
|
|
2596
|
+
400: ErrorResponse;
|
|
1642
2597
|
/**
|
|
1643
2598
|
* Unauthorized — requires Bearer token
|
|
1644
2599
|
*/
|
|
@@ -1646,16 +2601,28 @@ export type PatchConversationMemoryConversationSummariesErrors = {
|
|
|
1646
2601
|
/**
|
|
1647
2602
|
* Internal server error
|
|
1648
2603
|
*/
|
|
1649
|
-
500:
|
|
2604
|
+
500: ErrorResponse;
|
|
1650
2605
|
};
|
|
1651
2606
|
|
|
2607
|
+
export type PatchConversationMemoryConversationSummariesError =
|
|
2608
|
+
PatchConversationMemoryConversationSummariesErrors[keyof PatchConversationMemoryConversationSummariesErrors];
|
|
2609
|
+
|
|
1652
2610
|
export type PatchConversationMemoryConversationSummariesResponses = {
|
|
1653
2611
|
/**
|
|
1654
2612
|
* Success
|
|
1655
2613
|
*/
|
|
1656
2614
|
200: unknown;
|
|
2615
|
+
/**
|
|
2616
|
+
* Upstream confirmation payload from the Conversation Memory API
|
|
2617
|
+
*/
|
|
2618
|
+
202: {
|
|
2619
|
+
[key: string]: unknown;
|
|
2620
|
+
};
|
|
1657
2621
|
};
|
|
1658
2622
|
|
|
2623
|
+
export type PatchConversationMemoryConversationSummariesResponse =
|
|
2624
|
+
PatchConversationMemoryConversationSummariesResponses[keyof PatchConversationMemoryConversationSummariesResponses];
|
|
2625
|
+
|
|
1659
2626
|
export type PostConversationMemoryConversationSummariesData = {
|
|
1660
2627
|
body: {
|
|
1661
2628
|
/**
|
|
@@ -1674,6 +2641,10 @@ export type PostConversationMemoryConversationSummariesData = {
|
|
|
1674
2641
|
};
|
|
1675
2642
|
|
|
1676
2643
|
export type PostConversationMemoryConversationSummariesErrors = {
|
|
2644
|
+
/**
|
|
2645
|
+
* Invalid request parameters
|
|
2646
|
+
*/
|
|
2647
|
+
400: ErrorResponse;
|
|
1677
2648
|
/**
|
|
1678
2649
|
* Unauthorized — requires Bearer token
|
|
1679
2650
|
*/
|
|
@@ -1681,16 +2652,28 @@ export type PostConversationMemoryConversationSummariesErrors = {
|
|
|
1681
2652
|
/**
|
|
1682
2653
|
* Internal server error
|
|
1683
2654
|
*/
|
|
1684
|
-
500:
|
|
2655
|
+
500: ErrorResponse;
|
|
1685
2656
|
};
|
|
1686
2657
|
|
|
2658
|
+
export type PostConversationMemoryConversationSummariesError =
|
|
2659
|
+
PostConversationMemoryConversationSummariesErrors[keyof PostConversationMemoryConversationSummariesErrors];
|
|
2660
|
+
|
|
1687
2661
|
export type PostConversationMemoryConversationSummariesResponses = {
|
|
1688
2662
|
/**
|
|
1689
2663
|
* Success
|
|
1690
2664
|
*/
|
|
1691
2665
|
200: unknown;
|
|
2666
|
+
/**
|
|
2667
|
+
* Upstream confirmation payload from the Conversation Memory API
|
|
2668
|
+
*/
|
|
2669
|
+
202: {
|
|
2670
|
+
[key: string]: unknown;
|
|
2671
|
+
};
|
|
1692
2672
|
};
|
|
1693
2673
|
|
|
2674
|
+
export type PostConversationMemoryConversationSummariesResponse =
|
|
2675
|
+
PostConversationMemoryConversationSummariesResponses[keyof PostConversationMemoryConversationSummariesResponses];
|
|
2676
|
+
|
|
1694
2677
|
export type DeleteConversationMemoryResetData = {
|
|
1695
2678
|
body?: never;
|
|
1696
2679
|
path?: never;
|
|
@@ -1699,6 +2682,10 @@ export type DeleteConversationMemoryResetData = {
|
|
|
1699
2682
|
};
|
|
1700
2683
|
|
|
1701
2684
|
export type DeleteConversationMemoryResetErrors = {
|
|
2685
|
+
/**
|
|
2686
|
+
* storeId and profileId are required
|
|
2687
|
+
*/
|
|
2688
|
+
400: ErrorResponse;
|
|
1702
2689
|
/**
|
|
1703
2690
|
* Unauthorized — requires Bearer token
|
|
1704
2691
|
*/
|
|
@@ -1706,16 +2693,31 @@ export type DeleteConversationMemoryResetErrors = {
|
|
|
1706
2693
|
/**
|
|
1707
2694
|
* Internal server error
|
|
1708
2695
|
*/
|
|
1709
|
-
500:
|
|
2696
|
+
500: ErrorResponse;
|
|
1710
2697
|
};
|
|
1711
2698
|
|
|
2699
|
+
export type DeleteConversationMemoryResetError =
|
|
2700
|
+
DeleteConversationMemoryResetErrors[keyof DeleteConversationMemoryResetErrors];
|
|
2701
|
+
|
|
1712
2702
|
export type DeleteConversationMemoryResetResponses = {
|
|
1713
2703
|
/**
|
|
1714
2704
|
* Success
|
|
1715
2705
|
*/
|
|
1716
|
-
200:
|
|
2706
|
+
200: {
|
|
2707
|
+
/**
|
|
2708
|
+
* Count of observations deleted
|
|
2709
|
+
*/
|
|
2710
|
+
deletedObservations: number;
|
|
2711
|
+
/**
|
|
2712
|
+
* Count of conversation summaries deleted
|
|
2713
|
+
*/
|
|
2714
|
+
deletedSummaries: number;
|
|
2715
|
+
};
|
|
1717
2716
|
};
|
|
1718
2717
|
|
|
2718
|
+
export type DeleteConversationMemoryResetResponse =
|
|
2719
|
+
DeleteConversationMemoryResetResponses[keyof DeleteConversationMemoryResetResponses];
|
|
2720
|
+
|
|
1719
2721
|
export type PostAssignDemoData = {
|
|
1720
2722
|
body: {
|
|
1721
2723
|
/**
|
|
@@ -1733,23 +2735,56 @@ export type PostAssignDemoData = {
|
|
|
1733
2735
|
};
|
|
1734
2736
|
|
|
1735
2737
|
export type PostAssignDemoErrors = {
|
|
2738
|
+
/**
|
|
2739
|
+
* phoneNumber and targetObjectID are required
|
|
2740
|
+
*/
|
|
2741
|
+
400: ErrorResponse;
|
|
1736
2742
|
/**
|
|
1737
2743
|
* Unauthorized — requires Bearer token
|
|
1738
2744
|
*/
|
|
1739
2745
|
401: unknown;
|
|
1740
2746
|
/**
|
|
1741
|
-
*
|
|
2747
|
+
* Target template not found
|
|
1742
2748
|
*/
|
|
1743
|
-
|
|
2749
|
+
404: ErrorResponse;
|
|
2750
|
+
/**
|
|
2751
|
+
* Failed to assign demo
|
|
2752
|
+
*/
|
|
2753
|
+
500: ErrorResponse;
|
|
1744
2754
|
};
|
|
1745
2755
|
|
|
2756
|
+
export type PostAssignDemoError = PostAssignDemoErrors[keyof PostAssignDemoErrors];
|
|
2757
|
+
|
|
1746
2758
|
export type PostAssignDemoResponses = {
|
|
1747
2759
|
/**
|
|
1748
2760
|
* Success
|
|
1749
2761
|
*/
|
|
1750
|
-
200:
|
|
2762
|
+
200: {
|
|
2763
|
+
/**
|
|
2764
|
+
* Whether the number was newly added to the target template
|
|
2765
|
+
*/
|
|
2766
|
+
addedToTarget: boolean;
|
|
2767
|
+
/**
|
|
2768
|
+
* Confirmation message
|
|
2769
|
+
*/
|
|
2770
|
+
message: string;
|
|
2771
|
+
/**
|
|
2772
|
+
* The normalized phone number that was assigned
|
|
2773
|
+
*/
|
|
2774
|
+
phoneNumber: string;
|
|
2775
|
+
/**
|
|
2776
|
+
* objectIDs the number was removed from
|
|
2777
|
+
*/
|
|
2778
|
+
removedFrom: Array<string>;
|
|
2779
|
+
/**
|
|
2780
|
+
* The Algolia objectID of the target template
|
|
2781
|
+
*/
|
|
2782
|
+
targetObjectID: string;
|
|
2783
|
+
};
|
|
1751
2784
|
};
|
|
1752
2785
|
|
|
2786
|
+
export type PostAssignDemoResponse = PostAssignDemoResponses[keyof PostAssignDemoResponses];
|
|
2787
|
+
|
|
1753
2788
|
export type GetLookupDemoData = {
|
|
1754
2789
|
body?: never;
|
|
1755
2790
|
path?: never;
|
|
@@ -1760,23 +2795,42 @@ export type GetLookupDemoData = {
|
|
|
1760
2795
|
};
|
|
1761
2796
|
|
|
1762
2797
|
export type GetLookupDemoErrors = {
|
|
2798
|
+
/**
|
|
2799
|
+
* phoneNumber query parameter is required
|
|
2800
|
+
*/
|
|
2801
|
+
400: ErrorResponse;
|
|
1763
2802
|
/**
|
|
1764
2803
|
* Unauthorized — requires Bearer token
|
|
1765
2804
|
*/
|
|
1766
2805
|
401: unknown;
|
|
1767
2806
|
/**
|
|
1768
|
-
*
|
|
2807
|
+
* Failed to look up demo
|
|
1769
2808
|
*/
|
|
1770
|
-
500:
|
|
2809
|
+
500: ErrorResponse;
|
|
1771
2810
|
};
|
|
1772
2811
|
|
|
2812
|
+
export type GetLookupDemoError = GetLookupDemoErrors[keyof GetLookupDemoErrors];
|
|
2813
|
+
|
|
1773
2814
|
export type GetLookupDemoResponses = {
|
|
1774
2815
|
/**
|
|
1775
2816
|
* Success
|
|
1776
2817
|
*/
|
|
1777
|
-
200:
|
|
2818
|
+
200: {
|
|
2819
|
+
/**
|
|
2820
|
+
* The normalized phone number that was looked up
|
|
2821
|
+
*/
|
|
2822
|
+
phoneNumber: string;
|
|
2823
|
+
/**
|
|
2824
|
+
* Matching templates, each `{ objectID, title, author }`
|
|
2825
|
+
*/
|
|
2826
|
+
templates: Array<{
|
|
2827
|
+
[key: string]: unknown;
|
|
2828
|
+
}>;
|
|
2829
|
+
};
|
|
1778
2830
|
};
|
|
1779
2831
|
|
|
2832
|
+
export type GetLookupDemoResponse = GetLookupDemoResponses[keyof GetLookupDemoResponses];
|
|
2833
|
+
|
|
1780
2834
|
export type PostTemplateAutogenData = {
|
|
1781
2835
|
body: {
|
|
1782
2836
|
/**
|
|
@@ -1810,23 +2864,41 @@ export type PostTemplateAutogenData = {
|
|
|
1810
2864
|
};
|
|
1811
2865
|
|
|
1812
2866
|
export type PostTemplateAutogenErrors = {
|
|
2867
|
+
/**
|
|
2868
|
+
* No valid requests, or email/company must be defined
|
|
2869
|
+
*/
|
|
2870
|
+
400: ErrorResponse;
|
|
1813
2871
|
/**
|
|
1814
2872
|
* Unauthorized — requires Bearer token
|
|
1815
2873
|
*/
|
|
1816
2874
|
401: unknown;
|
|
1817
2875
|
/**
|
|
1818
|
-
*
|
|
2876
|
+
* All template generations failed
|
|
1819
2877
|
*/
|
|
1820
|
-
500:
|
|
2878
|
+
500: ErrorResponse;
|
|
2879
|
+
/**
|
|
2880
|
+
* Service temporarily unavailable
|
|
2881
|
+
*/
|
|
2882
|
+
503: ErrorResponse;
|
|
1821
2883
|
};
|
|
1822
2884
|
|
|
2885
|
+
export type PostTemplateAutogenError = PostTemplateAutogenErrors[keyof PostTemplateAutogenErrors];
|
|
2886
|
+
|
|
1823
2887
|
export type PostTemplateAutogenResponses = {
|
|
1824
2888
|
/**
|
|
1825
2889
|
* Success
|
|
1826
2890
|
*/
|
|
1827
|
-
200:
|
|
2891
|
+
200: {
|
|
2892
|
+
/**
|
|
2893
|
+
* The generated (and optionally saved) templates
|
|
2894
|
+
*/
|
|
2895
|
+
templates: Array<TemplateData>;
|
|
2896
|
+
};
|
|
1828
2897
|
};
|
|
1829
2898
|
|
|
2899
|
+
export type PostTemplateAutogenResponse =
|
|
2900
|
+
PostTemplateAutogenResponses[keyof PostTemplateAutogenResponses];
|
|
2901
|
+
|
|
1830
2902
|
export type DeleteTemplateData = {
|
|
1831
2903
|
body?: never;
|
|
1832
2904
|
path?: never;
|
|
@@ -1837,6 +2909,10 @@ export type DeleteTemplateData = {
|
|
|
1837
2909
|
};
|
|
1838
2910
|
|
|
1839
2911
|
export type DeleteTemplateErrors = {
|
|
2912
|
+
/**
|
|
2913
|
+
* Missing ids query parameter
|
|
2914
|
+
*/
|
|
2915
|
+
400: ErrorResponse;
|
|
1840
2916
|
/**
|
|
1841
2917
|
* Unauthorized — requires Bearer token
|
|
1842
2918
|
*/
|
|
@@ -1845,15 +2921,28 @@ export type DeleteTemplateErrors = {
|
|
|
1845
2921
|
* Internal server error
|
|
1846
2922
|
*/
|
|
1847
2923
|
500: unknown;
|
|
2924
|
+
/**
|
|
2925
|
+
* Service temporarily unavailable
|
|
2926
|
+
*/
|
|
2927
|
+
503: ErrorResponse;
|
|
1848
2928
|
};
|
|
1849
2929
|
|
|
2930
|
+
export type DeleteTemplateError = DeleteTemplateErrors[keyof DeleteTemplateErrors];
|
|
2931
|
+
|
|
1850
2932
|
export type DeleteTemplateResponses = {
|
|
1851
2933
|
/**
|
|
1852
2934
|
* Success
|
|
1853
2935
|
*/
|
|
1854
|
-
200:
|
|
2936
|
+
200: {
|
|
2937
|
+
/**
|
|
2938
|
+
* IDs of the deleted templates/campaigns
|
|
2939
|
+
*/
|
|
2940
|
+
deleted: Array<string>;
|
|
2941
|
+
};
|
|
1855
2942
|
};
|
|
1856
2943
|
|
|
2944
|
+
export type DeleteTemplateResponse = DeleteTemplateResponses[keyof DeleteTemplateResponses];
|
|
2945
|
+
|
|
1857
2946
|
export type PostTemplateData = {
|
|
1858
2947
|
body: {
|
|
1859
2948
|
[key: string]: unknown;
|
|
@@ -1872,15 +2961,28 @@ export type PostTemplateErrors = {
|
|
|
1872
2961
|
* Internal server error
|
|
1873
2962
|
*/
|
|
1874
2963
|
500: unknown;
|
|
2964
|
+
/**
|
|
2965
|
+
* Service temporarily unavailable
|
|
2966
|
+
*/
|
|
2967
|
+
503: ErrorResponse;
|
|
1875
2968
|
};
|
|
1876
2969
|
|
|
2970
|
+
export type PostTemplateError = PostTemplateErrors[keyof PostTemplateErrors];
|
|
2971
|
+
|
|
1877
2972
|
export type PostTemplateResponses = {
|
|
1878
2973
|
/**
|
|
1879
2974
|
* Success
|
|
1880
2975
|
*/
|
|
1881
|
-
200:
|
|
2976
|
+
200: {
|
|
2977
|
+
/**
|
|
2978
|
+
* Success message
|
|
2979
|
+
*/
|
|
2980
|
+
message: string;
|
|
2981
|
+
};
|
|
1882
2982
|
};
|
|
1883
2983
|
|
|
2984
|
+
export type PostTemplateResponse = PostTemplateResponses[keyof PostTemplateResponses];
|
|
2985
|
+
|
|
1884
2986
|
export type GetCampaignData = {
|
|
1885
2987
|
body?: never;
|
|
1886
2988
|
path?: never;
|
|
@@ -1902,18 +3004,35 @@ export type GetCampaignErrors = {
|
|
|
1902
3004
|
*/
|
|
1903
3005
|
401: unknown;
|
|
1904
3006
|
/**
|
|
1905
|
-
*
|
|
3007
|
+
* Failed to fetch campaigns
|
|
1906
3008
|
*/
|
|
1907
|
-
500:
|
|
3009
|
+
500: ErrorResponse;
|
|
1908
3010
|
};
|
|
1909
3011
|
|
|
3012
|
+
export type GetCampaignError = GetCampaignErrors[keyof GetCampaignErrors];
|
|
3013
|
+
|
|
1910
3014
|
export type GetCampaignResponses = {
|
|
1911
3015
|
/**
|
|
1912
3016
|
* Success
|
|
1913
3017
|
*/
|
|
1914
|
-
200:
|
|
3018
|
+
200: {
|
|
3019
|
+
/**
|
|
3020
|
+
* Call history data, present when includeCalledBy is set
|
|
3021
|
+
*/
|
|
3022
|
+
calledByData: Array<CalledByData>;
|
|
3023
|
+
/**
|
|
3024
|
+
* Matching campaign templates
|
|
3025
|
+
*/
|
|
3026
|
+
campaigns: Array<Campaign>;
|
|
3027
|
+
/**
|
|
3028
|
+
* Total number of matching campaigns
|
|
3029
|
+
*/
|
|
3030
|
+
total: number;
|
|
3031
|
+
};
|
|
1915
3032
|
};
|
|
1916
3033
|
|
|
3034
|
+
export type GetCampaignResponse = GetCampaignResponses[keyof GetCampaignResponses];
|
|
3035
|
+
|
|
1917
3036
|
export type GetSupportedRegionsData = {
|
|
1918
3037
|
body?: never;
|
|
1919
3038
|
path?: never;
|
|
@@ -1930,8 +3049,14 @@ export type GetSupportedRegionsErrors = {
|
|
|
1930
3049
|
* Internal server error
|
|
1931
3050
|
*/
|
|
1932
3051
|
500: unknown;
|
|
3052
|
+
/**
|
|
3053
|
+
* Service temporarily unavailable
|
|
3054
|
+
*/
|
|
3055
|
+
503: ErrorResponse;
|
|
1933
3056
|
};
|
|
1934
3057
|
|
|
3058
|
+
export type GetSupportedRegionsError = GetSupportedRegionsErrors[keyof GetSupportedRegionsErrors];
|
|
3059
|
+
|
|
1935
3060
|
export type GetSupportedRegionsResponses = {
|
|
1936
3061
|
/**
|
|
1937
3062
|
* Success
|
|
@@ -1960,18 +3085,29 @@ export type GetLinkShortenerErrors = {
|
|
|
1960
3085
|
*/
|
|
1961
3086
|
401: unknown;
|
|
1962
3087
|
/**
|
|
1963
|
-
*
|
|
3088
|
+
* Failed to fetch links
|
|
1964
3089
|
*/
|
|
1965
|
-
500:
|
|
3090
|
+
500: ErrorResponse;
|
|
1966
3091
|
};
|
|
1967
3092
|
|
|
3093
|
+
export type GetLinkShortenerError = GetLinkShortenerErrors[keyof GetLinkShortenerErrors];
|
|
3094
|
+
|
|
1968
3095
|
export type GetLinkShortenerResponses = {
|
|
1969
3096
|
/**
|
|
1970
3097
|
* Success
|
|
1971
3098
|
*/
|
|
1972
|
-
200:
|
|
3099
|
+
200: {
|
|
3100
|
+
/**
|
|
3101
|
+
* Array of all short links, each `{ code, shortUrl, url, createdAt }`
|
|
3102
|
+
*/
|
|
3103
|
+
links: Array<{
|
|
3104
|
+
[key: string]: unknown;
|
|
3105
|
+
}>;
|
|
3106
|
+
};
|
|
1973
3107
|
};
|
|
1974
3108
|
|
|
3109
|
+
export type GetLinkShortenerResponse = GetLinkShortenerResponses[keyof GetLinkShortenerResponses];
|
|
3110
|
+
|
|
1975
3111
|
export type PatchLinkShortenerData = {
|
|
1976
3112
|
body: {
|
|
1977
3113
|
/**
|
|
@@ -1989,23 +3125,37 @@ export type PatchLinkShortenerData = {
|
|
|
1989
3125
|
};
|
|
1990
3126
|
|
|
1991
3127
|
export type PatchLinkShortenerErrors = {
|
|
3128
|
+
/**
|
|
3129
|
+
* objectID and shortLink are required
|
|
3130
|
+
*/
|
|
3131
|
+
400: ErrorResponse;
|
|
1992
3132
|
/**
|
|
1993
3133
|
* Unauthorized — requires Bearer token
|
|
1994
3134
|
*/
|
|
1995
3135
|
401: unknown;
|
|
1996
3136
|
/**
|
|
1997
|
-
*
|
|
3137
|
+
* Failed to persist short link
|
|
1998
3138
|
*/
|
|
1999
|
-
500:
|
|
3139
|
+
500: ErrorResponse;
|
|
2000
3140
|
};
|
|
2001
3141
|
|
|
3142
|
+
export type PatchLinkShortenerError = PatchLinkShortenerErrors[keyof PatchLinkShortenerErrors];
|
|
3143
|
+
|
|
2002
3144
|
export type PatchLinkShortenerResponses = {
|
|
2003
3145
|
/**
|
|
2004
3146
|
* Success
|
|
2005
3147
|
*/
|
|
2006
|
-
200:
|
|
3148
|
+
200: {
|
|
3149
|
+
/**
|
|
3150
|
+
* Always true
|
|
3151
|
+
*/
|
|
3152
|
+
ok: boolean;
|
|
3153
|
+
};
|
|
2007
3154
|
};
|
|
2008
3155
|
|
|
3156
|
+
export type PatchLinkShortenerResponse =
|
|
3157
|
+
PatchLinkShortenerResponses[keyof PatchLinkShortenerResponses];
|
|
3158
|
+
|
|
2009
3159
|
export type PostLinkShortenerData = {
|
|
2010
3160
|
body: {
|
|
2011
3161
|
/**
|
|
@@ -2019,23 +3169,58 @@ export type PostLinkShortenerData = {
|
|
|
2019
3169
|
};
|
|
2020
3170
|
|
|
2021
3171
|
export type PostLinkShortenerErrors = {
|
|
3172
|
+
/**
|
|
3173
|
+
* urls must be a non-empty array
|
|
3174
|
+
*/
|
|
3175
|
+
400: ErrorResponse;
|
|
2022
3176
|
/**
|
|
2023
3177
|
* Unauthorized — requires Bearer token
|
|
2024
3178
|
*/
|
|
2025
3179
|
401: unknown;
|
|
2026
3180
|
/**
|
|
2027
|
-
*
|
|
3181
|
+
* Conflict
|
|
2028
3182
|
*/
|
|
2029
|
-
|
|
3183
|
+
409: {
|
|
3184
|
+
/**
|
|
3185
|
+
* "Alias already taken"
|
|
3186
|
+
*/
|
|
3187
|
+
error: string;
|
|
3188
|
+
/**
|
|
3189
|
+
* Array of results (same shape as 201)
|
|
3190
|
+
*/
|
|
3191
|
+
results: Array<{
|
|
3192
|
+
[key: string]: unknown;
|
|
3193
|
+
}>;
|
|
3194
|
+
};
|
|
3195
|
+
/**
|
|
3196
|
+
* Failed to shorten URLs
|
|
3197
|
+
*/
|
|
3198
|
+
500: ErrorResponse;
|
|
2030
3199
|
};
|
|
2031
3200
|
|
|
3201
|
+
export type PostLinkShortenerError = PostLinkShortenerErrors[keyof PostLinkShortenerErrors];
|
|
3202
|
+
|
|
2032
3203
|
export type PostLinkShortenerResponses = {
|
|
2033
3204
|
/**
|
|
2034
3205
|
* Success
|
|
2035
3206
|
*/
|
|
2036
3207
|
200: unknown;
|
|
3208
|
+
/**
|
|
3209
|
+
* Created
|
|
3210
|
+
*/
|
|
3211
|
+
201: {
|
|
3212
|
+
/**
|
|
3213
|
+
* Array of results in the same order as the input (`{ code, shortUrl, url }`, or `error` on per-item failure)
|
|
3214
|
+
*/
|
|
3215
|
+
results: Array<{
|
|
3216
|
+
[key: string]: unknown;
|
|
3217
|
+
}>;
|
|
3218
|
+
};
|
|
2037
3219
|
};
|
|
2038
3220
|
|
|
3221
|
+
export type PostLinkShortenerResponse =
|
|
3222
|
+
PostLinkShortenerResponses[keyof PostLinkShortenerResponses];
|
|
3223
|
+
|
|
2039
3224
|
export type DeleteLinkShortenerByCodeData = {
|
|
2040
3225
|
body?: never;
|
|
2041
3226
|
path: {
|
|
@@ -2046,23 +3231,46 @@ export type DeleteLinkShortenerByCodeData = {
|
|
|
2046
3231
|
};
|
|
2047
3232
|
|
|
2048
3233
|
export type DeleteLinkShortenerByCodeErrors = {
|
|
3234
|
+
/**
|
|
3235
|
+
* code is required
|
|
3236
|
+
*/
|
|
3237
|
+
400: ErrorResponse;
|
|
2049
3238
|
/**
|
|
2050
3239
|
* Unauthorized — requires Bearer token
|
|
2051
3240
|
*/
|
|
2052
3241
|
401: unknown;
|
|
2053
3242
|
/**
|
|
2054
|
-
*
|
|
3243
|
+
* Link not found
|
|
2055
3244
|
*/
|
|
2056
|
-
|
|
3245
|
+
404: ErrorResponse;
|
|
3246
|
+
/**
|
|
3247
|
+
* Failed to delete link
|
|
3248
|
+
*/
|
|
3249
|
+
500: ErrorResponse;
|
|
2057
3250
|
};
|
|
2058
3251
|
|
|
3252
|
+
export type DeleteLinkShortenerByCodeError =
|
|
3253
|
+
DeleteLinkShortenerByCodeErrors[keyof DeleteLinkShortenerByCodeErrors];
|
|
3254
|
+
|
|
2059
3255
|
export type DeleteLinkShortenerByCodeResponses = {
|
|
2060
3256
|
/**
|
|
2061
3257
|
* Success
|
|
2062
3258
|
*/
|
|
2063
|
-
200:
|
|
3259
|
+
200: {
|
|
3260
|
+
/**
|
|
3261
|
+
* The deleted code
|
|
3262
|
+
*/
|
|
3263
|
+
code: string;
|
|
3264
|
+
/**
|
|
3265
|
+
* Always true
|
|
3266
|
+
*/
|
|
3267
|
+
ok: boolean;
|
|
3268
|
+
};
|
|
2064
3269
|
};
|
|
2065
3270
|
|
|
3271
|
+
export type DeleteLinkShortenerByCodeResponse =
|
|
3272
|
+
DeleteLinkShortenerByCodeResponses[keyof DeleteLinkShortenerByCodeResponses];
|
|
3273
|
+
|
|
2066
3274
|
export type GetDocsOpenapiJsonData = {
|
|
2067
3275
|
body?: never;
|
|
2068
3276
|
path?: never;
|
|
@@ -2075,15 +3283,26 @@ export type GetDocsOpenapiJsonErrors = {
|
|
|
2075
3283
|
* Unauthorized — requires Bearer token
|
|
2076
3284
|
*/
|
|
2077
3285
|
401: unknown;
|
|
3286
|
+
/**
|
|
3287
|
+
* OpenAPI spec not found
|
|
3288
|
+
*/
|
|
3289
|
+
404: ErrorResponse;
|
|
2078
3290
|
/**
|
|
2079
3291
|
* Internal server error
|
|
2080
3292
|
*/
|
|
2081
3293
|
500: unknown;
|
|
2082
3294
|
};
|
|
2083
3295
|
|
|
3296
|
+
export type GetDocsOpenapiJsonError = GetDocsOpenapiJsonErrors[keyof GetDocsOpenapiJsonErrors];
|
|
3297
|
+
|
|
2084
3298
|
export type GetDocsOpenapiJsonResponses = {
|
|
2085
3299
|
/**
|
|
2086
|
-
*
|
|
3300
|
+
* The raw OpenAPI 3.1 spec JSON document
|
|
2087
3301
|
*/
|
|
2088
|
-
200:
|
|
3302
|
+
200: {
|
|
3303
|
+
[key: string]: unknown;
|
|
3304
|
+
};
|
|
2089
3305
|
};
|
|
3306
|
+
|
|
3307
|
+
export type GetDocsOpenapiJsonResponse =
|
|
3308
|
+
GetDocsOpenapiJsonResponses[keyof GetDocsOpenapiJsonResponses];
|