@epilot/sdk 2.20.21 → 2.20.23
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/README.md +1 -0
- package/definitions/automation-runtime.json +1 -1
- package/definitions/automation.json +207 -2
- package/definitions/chat-runtime.json +1 -0
- package/definitions/chat.json +2909 -0
- package/dist/README-7F36AG5O.js +7 -0
- package/dist/README-I7JMAFA4.cjs +7 -0
- package/dist/{_index-D5TTZP5F.cjs → _index-655GNTWT.cjs} +4 -1
- package/dist/{_index-UY46ZN47.js → _index-6FK4PV6Y.js} +3 -0
- package/dist/apis/access-token.cjs +6 -6
- package/dist/apis/access-token.js +1 -1
- package/dist/apis/address-suggestions.cjs +6 -6
- package/dist/apis/address-suggestions.js +1 -1
- package/dist/apis/address.cjs +6 -6
- package/dist/apis/address.js +1 -1
- package/dist/apis/ai-agents.cjs +6 -6
- package/dist/apis/ai-agents.js +1 -1
- package/dist/apis/app.cjs +6 -6
- package/dist/apis/app.js +1 -1
- package/dist/apis/audit-logs.cjs +6 -6
- package/dist/apis/audit-logs.js +1 -1
- package/dist/apis/automation.cjs +8 -8
- package/dist/apis/automation.d.cts +2 -2
- package/dist/apis/automation.d.ts +2 -2
- package/dist/apis/automation.js +2 -2
- package/dist/apis/billing.cjs +6 -6
- package/dist/apis/billing.js +1 -1
- package/dist/apis/blueprint-manifest.cjs +6 -6
- package/dist/apis/blueprint-manifest.js +1 -1
- package/dist/apis/calendar.cjs +6 -6
- package/dist/apis/calendar.js +1 -1
- package/dist/apis/chat.cjs +38 -0
- package/dist/apis/chat.d.cts +18 -0
- package/dist/apis/chat.d.ts +18 -0
- package/dist/apis/chat.js +38 -0
- package/dist/apis/configuration-hub.cjs +6 -6
- package/dist/apis/configuration-hub.js +1 -1
- package/dist/apis/consent.cjs +6 -6
- package/dist/apis/consent.js +1 -1
- package/dist/apis/customer-portal.cjs +6 -6
- package/dist/apis/customer-portal.js +1 -1
- package/dist/apis/dashboard.cjs +6 -6
- package/dist/apis/dashboard.js +1 -1
- package/dist/apis/data-governance.cjs +6 -6
- package/dist/apis/data-governance.js +1 -1
- package/dist/apis/deduplication.cjs +6 -6
- package/dist/apis/deduplication.js +1 -1
- package/dist/apis/design.cjs +6 -6
- package/dist/apis/design.js +1 -1
- package/dist/apis/document.cjs +6 -6
- package/dist/apis/document.js +1 -1
- package/dist/apis/email-settings.cjs +6 -6
- package/dist/apis/email-settings.js +1 -1
- package/dist/apis/email-template.cjs +6 -6
- package/dist/apis/email-template.js +1 -1
- package/dist/apis/entity-mapping.cjs +6 -6
- package/dist/apis/entity-mapping.js +1 -1
- package/dist/apis/entity.cjs +6 -6
- package/dist/apis/entity.js +1 -1
- package/dist/apis/environments.cjs +6 -6
- package/dist/apis/environments.js +1 -1
- package/dist/apis/event-catalog.cjs +6 -6
- package/dist/apis/event-catalog.js +1 -1
- package/dist/apis/file.cjs +6 -6
- package/dist/apis/file.js +1 -1
- package/dist/apis/iban.cjs +6 -6
- package/dist/apis/iban.js +1 -1
- package/dist/apis/integration-toolkit.cjs +6 -6
- package/dist/apis/integration-toolkit.js +1 -1
- package/dist/apis/journey.cjs +6 -6
- package/dist/apis/journey.js +1 -1
- package/dist/apis/kanban.cjs +6 -6
- package/dist/apis/kanban.js +1 -1
- package/dist/apis/message.cjs +6 -6
- package/dist/apis/message.js +1 -1
- package/dist/apis/metering.cjs +6 -6
- package/dist/apis/metering.js +1 -1
- package/dist/apis/notes.cjs +6 -6
- package/dist/apis/notes.js +1 -1
- package/dist/apis/notification.cjs +6 -6
- package/dist/apis/notification.js +1 -1
- package/dist/apis/organization.cjs +6 -6
- package/dist/apis/organization.js +1 -1
- package/dist/apis/partner-directory.cjs +6 -6
- package/dist/apis/partner-directory.js +1 -1
- package/dist/apis/permissions.cjs +6 -6
- package/dist/apis/permissions.js +1 -1
- package/dist/apis/pricing-tier.cjs +6 -6
- package/dist/apis/pricing-tier.js +1 -1
- package/dist/apis/pricing.cjs +6 -6
- package/dist/apis/pricing.js +1 -1
- package/dist/apis/purpose.cjs +6 -6
- package/dist/apis/purpose.js +1 -1
- package/dist/apis/query.cjs +6 -6
- package/dist/apis/query.js +1 -1
- package/dist/apis/sandbox.cjs +6 -6
- package/dist/apis/sandbox.js +1 -1
- package/dist/apis/sharing.cjs +6 -6
- package/dist/apis/sharing.js +1 -1
- package/dist/apis/snapshot.cjs +6 -6
- package/dist/apis/snapshot.js +1 -1
- package/dist/apis/submission.cjs +6 -6
- package/dist/apis/submission.js +1 -1
- package/dist/apis/target.cjs +6 -6
- package/dist/apis/target.js +1 -1
- package/dist/apis/targeting.cjs +6 -6
- package/dist/apis/targeting.js +1 -1
- package/dist/apis/template-variables.cjs +6 -6
- package/dist/apis/template-variables.js +1 -1
- package/dist/apis/user.cjs +6 -6
- package/dist/apis/user.js +1 -1
- package/dist/apis/validation-rules.cjs +6 -6
- package/dist/apis/validation-rules.js +1 -1
- package/dist/apis/webhooks.cjs +6 -6
- package/dist/apis/webhooks.js +1 -1
- package/dist/apis/workflow-definition.cjs +6 -6
- package/dist/apis/workflow-definition.js +1 -1
- package/dist/apis/workflow.cjs +6 -6
- package/dist/apis/workflow.js +1 -1
- package/dist/automation-CDMOEYVP.cjs +7 -0
- package/dist/automation-XFMSH7Y3.js +7 -0
- package/dist/{automation-runtime-RM5EOZH2.cjs → automation-runtime-KLCXZKEC.cjs} +2 -2
- package/dist/{automation-runtime-ORW5BVCD.js → automation-runtime-Y52HM57N.js} +1 -1
- package/dist/{automation.d-Bp45eKlU.d.cts → automation.d-2biAmiMc.d.cts} +214 -6
- package/dist/{automation.d-Bp45eKlU.d.ts → automation.d-2biAmiMc.d.ts} +214 -6
- package/dist/chat-5EOD2OPN.cjs +7 -0
- package/dist/chat-D5KXPRYY.js +7 -0
- package/dist/chat-runtime-MF35HI2U.js +5 -0
- package/dist/chat-runtime-MYMUFT3Y.cjs +5 -0
- package/dist/chat.d-CQ5eRtNU.d.cts +1544 -0
- package/dist/chat.d-CQ5eRtNU.d.ts +1544 -0
- package/dist/chunk-6ZTP7EQE.js +14 -0
- package/dist/chunk-A5THJ4SF.cjs +14 -0
- package/dist/{chunk-6LUOXPO4.js → chunk-KZXOYL5D.js} +6 -4
- package/dist/chunk-QW3ROE6H.js +14 -0
- package/dist/chunk-WOUASZJW.cjs +14 -0
- package/dist/{chunk-CKLXVVGF.cjs → chunk-YCTBOY3T.cjs} +6 -4
- package/dist/index.cjs +27 -19
- package/dist/index.d.cts +85 -83
- package/dist/index.d.ts +85 -83
- package/dist/index.js +22 -14
- package/docs/automation.md +99 -17
- package/docs/chat.md +695 -0
- package/package.json +10 -1
- package/dist/README-NBWAQWQS.js +0 -7
- package/dist/README-XCIDDEAE.cjs +0 -7
- package/dist/automation-FTFGFHT7.cjs +0 -7
- package/dist/automation-HJGT6QK5.js +0 -7
- package/dist/chunk-ADSWGLIV.cjs +0 -14
- package/dist/chunk-LCE7N4ZL.js +0 -14
|
@@ -0,0 +1,1544 @@
|
|
|
1
|
+
import { OpenAPIClient, Parameters, AxiosRequestConfig, OperationResponse, UnknownParamsObject } from 'openapi-client-axios';
|
|
2
|
+
|
|
3
|
+
/* Auto-copied from chat-client */
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
declare namespace Components {
|
|
7
|
+
namespace Responses {
|
|
8
|
+
export interface Error {
|
|
9
|
+
code: "INVALID_REQUEST" | "ORIGIN_DENIED" | "NOT_FOUND" | "INVALID_GRANT" | "SESSION_EXPIRED" | "RATE_LIMITED" | "SESSION_LIMIT" | "USAGE_LIMIT" | "REQUEST_CONFLICT" | "IN_PROGRESS" | "UNAVAILABLE" | "TEMPORARILY_UNAVAILABLE";
|
|
10
|
+
}
|
|
11
|
+
}
|
|
12
|
+
namespace Schemas {
|
|
13
|
+
export interface ChatWidget {
|
|
14
|
+
name: string;
|
|
15
|
+
agent_id: string | null; // uuid
|
|
16
|
+
website_chat: {
|
|
17
|
+
/**
|
|
18
|
+
* Exact HTTPS origins. Empty means the widget cannot start sessions.
|
|
19
|
+
*/
|
|
20
|
+
allowed_origins: [
|
|
21
|
+
string?,
|
|
22
|
+
string?,
|
|
23
|
+
string?,
|
|
24
|
+
string?,
|
|
25
|
+
string?,
|
|
26
|
+
string?,
|
|
27
|
+
string?,
|
|
28
|
+
string?,
|
|
29
|
+
string?,
|
|
30
|
+
string?,
|
|
31
|
+
string?,
|
|
32
|
+
string?,
|
|
33
|
+
string?,
|
|
34
|
+
string?,
|
|
35
|
+
string?,
|
|
36
|
+
string?,
|
|
37
|
+
string?,
|
|
38
|
+
string?,
|
|
39
|
+
string?,
|
|
40
|
+
string?,
|
|
41
|
+
string?,
|
|
42
|
+
string?,
|
|
43
|
+
string?,
|
|
44
|
+
string?,
|
|
45
|
+
string?,
|
|
46
|
+
string?,
|
|
47
|
+
string?,
|
|
48
|
+
string?,
|
|
49
|
+
string?,
|
|
50
|
+
string?,
|
|
51
|
+
string?,
|
|
52
|
+
string?,
|
|
53
|
+
string?,
|
|
54
|
+
string?,
|
|
55
|
+
string?,
|
|
56
|
+
string?,
|
|
57
|
+
string?,
|
|
58
|
+
string?,
|
|
59
|
+
string?,
|
|
60
|
+
string?,
|
|
61
|
+
string?,
|
|
62
|
+
string?,
|
|
63
|
+
string?,
|
|
64
|
+
string?,
|
|
65
|
+
string?,
|
|
66
|
+
string?,
|
|
67
|
+
string?,
|
|
68
|
+
string?,
|
|
69
|
+
string?,
|
|
70
|
+
string?
|
|
71
|
+
];
|
|
72
|
+
organisation_name: string;
|
|
73
|
+
default_locale: "en" | "de";
|
|
74
|
+
/**
|
|
75
|
+
* Design Builder configuration for the widget only.
|
|
76
|
+
*/
|
|
77
|
+
design_id?: string | null; // uuid
|
|
78
|
+
/**
|
|
79
|
+
* Email Builder template selection. Does not enable verification by itself.
|
|
80
|
+
*/
|
|
81
|
+
authentication?: {
|
|
82
|
+
email_code: {
|
|
83
|
+
email_template_id?: string | null; // uuid
|
|
84
|
+
};
|
|
85
|
+
} | null;
|
|
86
|
+
};
|
|
87
|
+
/**
|
|
88
|
+
* Stable public embed identifier, independent of the assigned agent. Not a credential.
|
|
89
|
+
*/
|
|
90
|
+
widget_id: string; // uuid
|
|
91
|
+
org_id: string;
|
|
92
|
+
/**
|
|
93
|
+
* Server-owned session binding; changes on reassignment or allowed-origin changes.
|
|
94
|
+
*/
|
|
95
|
+
binding_id: string; // uuid
|
|
96
|
+
version: number;
|
|
97
|
+
created_at: string; // date-time
|
|
98
|
+
updated_at: string; // date-time
|
|
99
|
+
website_chat_embed: {
|
|
100
|
+
script_url: string; // uri
|
|
101
|
+
chat_api_origin: string; // uri
|
|
102
|
+
demo_url: string; // uri
|
|
103
|
+
};
|
|
104
|
+
}
|
|
105
|
+
export interface CreateChatWidgetRequest {
|
|
106
|
+
name: string;
|
|
107
|
+
agent_id: string | null; // uuid
|
|
108
|
+
website_chat: {
|
|
109
|
+
/**
|
|
110
|
+
* Exact HTTPS origins. Empty means the widget cannot start sessions.
|
|
111
|
+
*/
|
|
112
|
+
allowed_origins: [
|
|
113
|
+
string?,
|
|
114
|
+
string?,
|
|
115
|
+
string?,
|
|
116
|
+
string?,
|
|
117
|
+
string?,
|
|
118
|
+
string?,
|
|
119
|
+
string?,
|
|
120
|
+
string?,
|
|
121
|
+
string?,
|
|
122
|
+
string?,
|
|
123
|
+
string?,
|
|
124
|
+
string?,
|
|
125
|
+
string?,
|
|
126
|
+
string?,
|
|
127
|
+
string?,
|
|
128
|
+
string?,
|
|
129
|
+
string?,
|
|
130
|
+
string?,
|
|
131
|
+
string?,
|
|
132
|
+
string?,
|
|
133
|
+
string?,
|
|
134
|
+
string?,
|
|
135
|
+
string?,
|
|
136
|
+
string?,
|
|
137
|
+
string?,
|
|
138
|
+
string?,
|
|
139
|
+
string?,
|
|
140
|
+
string?,
|
|
141
|
+
string?,
|
|
142
|
+
string?,
|
|
143
|
+
string?,
|
|
144
|
+
string?,
|
|
145
|
+
string?,
|
|
146
|
+
string?,
|
|
147
|
+
string?,
|
|
148
|
+
string?,
|
|
149
|
+
string?,
|
|
150
|
+
string?,
|
|
151
|
+
string?,
|
|
152
|
+
string?,
|
|
153
|
+
string?,
|
|
154
|
+
string?,
|
|
155
|
+
string?,
|
|
156
|
+
string?,
|
|
157
|
+
string?,
|
|
158
|
+
string?,
|
|
159
|
+
string?,
|
|
160
|
+
string?,
|
|
161
|
+
string?,
|
|
162
|
+
string?
|
|
163
|
+
];
|
|
164
|
+
organisation_name: string;
|
|
165
|
+
default_locale: "en" | "de";
|
|
166
|
+
/**
|
|
167
|
+
* Design Builder configuration for the widget only.
|
|
168
|
+
*/
|
|
169
|
+
design_id?: string | null; // uuid
|
|
170
|
+
/**
|
|
171
|
+
* Email Builder template selection. Does not enable verification by itself.
|
|
172
|
+
*/
|
|
173
|
+
authentication?: {
|
|
174
|
+
email_code: {
|
|
175
|
+
email_template_id?: string | null; // uuid
|
|
176
|
+
};
|
|
177
|
+
} | null;
|
|
178
|
+
};
|
|
179
|
+
}
|
|
180
|
+
export interface Error {
|
|
181
|
+
error?: string;
|
|
182
|
+
message?: string;
|
|
183
|
+
details?: {
|
|
184
|
+
[key: string]: any;
|
|
185
|
+
};
|
|
186
|
+
}
|
|
187
|
+
export interface ListChatWidgetsResponse {
|
|
188
|
+
widgets: {
|
|
189
|
+
name: string;
|
|
190
|
+
agent_id: string | null; // uuid
|
|
191
|
+
website_chat: {
|
|
192
|
+
/**
|
|
193
|
+
* Exact HTTPS origins. Empty means the widget cannot start sessions.
|
|
194
|
+
*/
|
|
195
|
+
allowed_origins: [
|
|
196
|
+
string?,
|
|
197
|
+
string?,
|
|
198
|
+
string?,
|
|
199
|
+
string?,
|
|
200
|
+
string?,
|
|
201
|
+
string?,
|
|
202
|
+
string?,
|
|
203
|
+
string?,
|
|
204
|
+
string?,
|
|
205
|
+
string?,
|
|
206
|
+
string?,
|
|
207
|
+
string?,
|
|
208
|
+
string?,
|
|
209
|
+
string?,
|
|
210
|
+
string?,
|
|
211
|
+
string?,
|
|
212
|
+
string?,
|
|
213
|
+
string?,
|
|
214
|
+
string?,
|
|
215
|
+
string?,
|
|
216
|
+
string?,
|
|
217
|
+
string?,
|
|
218
|
+
string?,
|
|
219
|
+
string?,
|
|
220
|
+
string?,
|
|
221
|
+
string?,
|
|
222
|
+
string?,
|
|
223
|
+
string?,
|
|
224
|
+
string?,
|
|
225
|
+
string?,
|
|
226
|
+
string?,
|
|
227
|
+
string?,
|
|
228
|
+
string?,
|
|
229
|
+
string?,
|
|
230
|
+
string?,
|
|
231
|
+
string?,
|
|
232
|
+
string?,
|
|
233
|
+
string?,
|
|
234
|
+
string?,
|
|
235
|
+
string?,
|
|
236
|
+
string?,
|
|
237
|
+
string?,
|
|
238
|
+
string?,
|
|
239
|
+
string?,
|
|
240
|
+
string?,
|
|
241
|
+
string?,
|
|
242
|
+
string?,
|
|
243
|
+
string?,
|
|
244
|
+
string?,
|
|
245
|
+
string?
|
|
246
|
+
];
|
|
247
|
+
organisation_name: string;
|
|
248
|
+
default_locale: "en" | "de";
|
|
249
|
+
/**
|
|
250
|
+
* Design Builder configuration for the widget only.
|
|
251
|
+
*/
|
|
252
|
+
design_id?: string | null; // uuid
|
|
253
|
+
/**
|
|
254
|
+
* Email Builder template selection. Does not enable verification by itself.
|
|
255
|
+
*/
|
|
256
|
+
authentication?: {
|
|
257
|
+
email_code: {
|
|
258
|
+
email_template_id?: string | null; // uuid
|
|
259
|
+
};
|
|
260
|
+
} | null;
|
|
261
|
+
};
|
|
262
|
+
/**
|
|
263
|
+
* Stable public embed identifier, independent of the assigned agent. Not a credential.
|
|
264
|
+
*/
|
|
265
|
+
widget_id: string; // uuid
|
|
266
|
+
org_id: string;
|
|
267
|
+
/**
|
|
268
|
+
* Server-owned session binding; changes on reassignment or allowed-origin changes.
|
|
269
|
+
*/
|
|
270
|
+
binding_id: string; // uuid
|
|
271
|
+
version: number;
|
|
272
|
+
created_at: string; // date-time
|
|
273
|
+
updated_at: string; // date-time
|
|
274
|
+
website_chat_embed: {
|
|
275
|
+
script_url: string; // uri
|
|
276
|
+
chat_api_origin: string; // uri
|
|
277
|
+
demo_url: string; // uri
|
|
278
|
+
};
|
|
279
|
+
}[];
|
|
280
|
+
next_cursor?: string;
|
|
281
|
+
}
|
|
282
|
+
export interface PublicChatError {
|
|
283
|
+
code: "INVALID_REQUEST" | "ORIGIN_DENIED" | "NOT_FOUND" | "INVALID_GRANT" | "SESSION_EXPIRED" | "RATE_LIMITED" | "SESSION_LIMIT" | "USAGE_LIMIT" | "REQUEST_CONFLICT" | "IN_PROGRESS" | "UNAVAILABLE" | "TEMPORARILY_UNAVAILABLE";
|
|
284
|
+
}
|
|
285
|
+
/**
|
|
286
|
+
* JSON payload of one SSE data frame from sendAnonymousChatMessage.
|
|
287
|
+
*/
|
|
288
|
+
export type PublicEvent = /* JSON payload of one SSE data frame from sendAnonymousChatMessage. */ {
|
|
289
|
+
type: "delta";
|
|
290
|
+
text: string;
|
|
291
|
+
request_id: string; // uuid
|
|
292
|
+
} | {
|
|
293
|
+
type: "complete";
|
|
294
|
+
text: string;
|
|
295
|
+
request_id: string; // uuid
|
|
296
|
+
} | {
|
|
297
|
+
type: "error";
|
|
298
|
+
code: "UNAVAILABLE";
|
|
299
|
+
request_id: string; // uuid
|
|
300
|
+
};
|
|
301
|
+
export interface UpdateChatWidgetRequest {
|
|
302
|
+
name?: string;
|
|
303
|
+
agent_id?: string | null; // uuid
|
|
304
|
+
website_chat?: {
|
|
305
|
+
/**
|
|
306
|
+
* Exact HTTPS origins. Empty means the widget cannot start sessions.
|
|
307
|
+
*/
|
|
308
|
+
allowed_origins: [
|
|
309
|
+
string?,
|
|
310
|
+
string?,
|
|
311
|
+
string?,
|
|
312
|
+
string?,
|
|
313
|
+
string?,
|
|
314
|
+
string?,
|
|
315
|
+
string?,
|
|
316
|
+
string?,
|
|
317
|
+
string?,
|
|
318
|
+
string?,
|
|
319
|
+
string?,
|
|
320
|
+
string?,
|
|
321
|
+
string?,
|
|
322
|
+
string?,
|
|
323
|
+
string?,
|
|
324
|
+
string?,
|
|
325
|
+
string?,
|
|
326
|
+
string?,
|
|
327
|
+
string?,
|
|
328
|
+
string?,
|
|
329
|
+
string?,
|
|
330
|
+
string?,
|
|
331
|
+
string?,
|
|
332
|
+
string?,
|
|
333
|
+
string?,
|
|
334
|
+
string?,
|
|
335
|
+
string?,
|
|
336
|
+
string?,
|
|
337
|
+
string?,
|
|
338
|
+
string?,
|
|
339
|
+
string?,
|
|
340
|
+
string?,
|
|
341
|
+
string?,
|
|
342
|
+
string?,
|
|
343
|
+
string?,
|
|
344
|
+
string?,
|
|
345
|
+
string?,
|
|
346
|
+
string?,
|
|
347
|
+
string?,
|
|
348
|
+
string?,
|
|
349
|
+
string?,
|
|
350
|
+
string?,
|
|
351
|
+
string?,
|
|
352
|
+
string?,
|
|
353
|
+
string?,
|
|
354
|
+
string?,
|
|
355
|
+
string?,
|
|
356
|
+
string?,
|
|
357
|
+
string?,
|
|
358
|
+
string?
|
|
359
|
+
];
|
|
360
|
+
organisation_name: string;
|
|
361
|
+
default_locale: "en" | "de";
|
|
362
|
+
/**
|
|
363
|
+
* Design Builder configuration for the widget only.
|
|
364
|
+
*/
|
|
365
|
+
design_id?: string | null; // uuid
|
|
366
|
+
/**
|
|
367
|
+
* Email Builder template selection. Does not enable verification by itself.
|
|
368
|
+
*/
|
|
369
|
+
authentication?: {
|
|
370
|
+
email_code: {
|
|
371
|
+
email_template_id?: string | null; // uuid
|
|
372
|
+
};
|
|
373
|
+
} | null;
|
|
374
|
+
};
|
|
375
|
+
/**
|
|
376
|
+
* Version read by the editor; stale writes return 409.
|
|
377
|
+
*/
|
|
378
|
+
version: number;
|
|
379
|
+
}
|
|
380
|
+
export interface WebsiteChatSettings {
|
|
381
|
+
/**
|
|
382
|
+
* Exact HTTPS origins. Empty means the widget cannot start sessions.
|
|
383
|
+
*/
|
|
384
|
+
allowed_origins: [
|
|
385
|
+
string?,
|
|
386
|
+
string?,
|
|
387
|
+
string?,
|
|
388
|
+
string?,
|
|
389
|
+
string?,
|
|
390
|
+
string?,
|
|
391
|
+
string?,
|
|
392
|
+
string?,
|
|
393
|
+
string?,
|
|
394
|
+
string?,
|
|
395
|
+
string?,
|
|
396
|
+
string?,
|
|
397
|
+
string?,
|
|
398
|
+
string?,
|
|
399
|
+
string?,
|
|
400
|
+
string?,
|
|
401
|
+
string?,
|
|
402
|
+
string?,
|
|
403
|
+
string?,
|
|
404
|
+
string?,
|
|
405
|
+
string?,
|
|
406
|
+
string?,
|
|
407
|
+
string?,
|
|
408
|
+
string?,
|
|
409
|
+
string?,
|
|
410
|
+
string?,
|
|
411
|
+
string?,
|
|
412
|
+
string?,
|
|
413
|
+
string?,
|
|
414
|
+
string?,
|
|
415
|
+
string?,
|
|
416
|
+
string?,
|
|
417
|
+
string?,
|
|
418
|
+
string?,
|
|
419
|
+
string?,
|
|
420
|
+
string?,
|
|
421
|
+
string?,
|
|
422
|
+
string?,
|
|
423
|
+
string?,
|
|
424
|
+
string?,
|
|
425
|
+
string?,
|
|
426
|
+
string?,
|
|
427
|
+
string?,
|
|
428
|
+
string?,
|
|
429
|
+
string?,
|
|
430
|
+
string?,
|
|
431
|
+
string?,
|
|
432
|
+
string?,
|
|
433
|
+
string?,
|
|
434
|
+
string?
|
|
435
|
+
];
|
|
436
|
+
organisation_name: string;
|
|
437
|
+
default_locale: "en" | "de";
|
|
438
|
+
/**
|
|
439
|
+
* Design Builder configuration for the widget only.
|
|
440
|
+
*/
|
|
441
|
+
design_id?: string | null; // uuid
|
|
442
|
+
/**
|
|
443
|
+
* Email Builder template selection. Does not enable verification by itself.
|
|
444
|
+
*/
|
|
445
|
+
authentication?: {
|
|
446
|
+
email_code: {
|
|
447
|
+
email_template_id?: string | null; // uuid
|
|
448
|
+
};
|
|
449
|
+
} | null;
|
|
450
|
+
}
|
|
451
|
+
export interface Widget {
|
|
452
|
+
key: string;
|
|
453
|
+
organisationName: string;
|
|
454
|
+
assistantName: string;
|
|
455
|
+
defaultLocale: "en" | "de";
|
|
456
|
+
design?: {
|
|
457
|
+
id: string; // uuid
|
|
458
|
+
last_modified_at?: string;
|
|
459
|
+
style?: {
|
|
460
|
+
palette?: {
|
|
461
|
+
primary?: string;
|
|
462
|
+
background?: string;
|
|
463
|
+
};
|
|
464
|
+
typography?: {
|
|
465
|
+
font?: {
|
|
466
|
+
font_family?: string;
|
|
467
|
+
};
|
|
468
|
+
};
|
|
469
|
+
shape?: {
|
|
470
|
+
border_radius?: number;
|
|
471
|
+
};
|
|
472
|
+
};
|
|
473
|
+
spark_theme?: {
|
|
474
|
+
accentColor?: string;
|
|
475
|
+
backgroundColor?: string;
|
|
476
|
+
fontBody?: string;
|
|
477
|
+
fontHeading?: string;
|
|
478
|
+
radius?: string;
|
|
479
|
+
scaling?: string;
|
|
480
|
+
spacing?: string;
|
|
481
|
+
appearance?: string;
|
|
482
|
+
neutralColor?: string;
|
|
483
|
+
styleVariant?: string;
|
|
484
|
+
labelPosition?: string;
|
|
485
|
+
inputStyle?: string;
|
|
486
|
+
inputColor?: string;
|
|
487
|
+
cardVariant?: string;
|
|
488
|
+
cardColor?: string;
|
|
489
|
+
highContrast?: boolean;
|
|
490
|
+
};
|
|
491
|
+
};
|
|
492
|
+
locales: ("en" | "de")[];
|
|
493
|
+
}
|
|
494
|
+
export interface WidgetDesign {
|
|
495
|
+
id: string; // uuid
|
|
496
|
+
last_modified_at?: string;
|
|
497
|
+
style?: {
|
|
498
|
+
palette?: {
|
|
499
|
+
primary?: string;
|
|
500
|
+
background?: string;
|
|
501
|
+
};
|
|
502
|
+
typography?: {
|
|
503
|
+
font?: {
|
|
504
|
+
font_family?: string;
|
|
505
|
+
};
|
|
506
|
+
};
|
|
507
|
+
shape?: {
|
|
508
|
+
border_radius?: number;
|
|
509
|
+
};
|
|
510
|
+
};
|
|
511
|
+
spark_theme?: {
|
|
512
|
+
accentColor?: string;
|
|
513
|
+
backgroundColor?: string;
|
|
514
|
+
fontBody?: string;
|
|
515
|
+
fontHeading?: string;
|
|
516
|
+
radius?: string;
|
|
517
|
+
scaling?: string;
|
|
518
|
+
spacing?: string;
|
|
519
|
+
appearance?: string;
|
|
520
|
+
neutralColor?: string;
|
|
521
|
+
styleVariant?: string;
|
|
522
|
+
labelPosition?: string;
|
|
523
|
+
inputStyle?: string;
|
|
524
|
+
inputColor?: string;
|
|
525
|
+
cardVariant?: string;
|
|
526
|
+
cardColor?: string;
|
|
527
|
+
highContrast?: boolean;
|
|
528
|
+
};
|
|
529
|
+
}
|
|
530
|
+
}
|
|
531
|
+
}
|
|
532
|
+
declare namespace Paths {
|
|
533
|
+
namespace CreateAnonymousChatSession {
|
|
534
|
+
export interface RequestBody {
|
|
535
|
+
grant: string; // ^[A-Za-z0-9_-]{43}$
|
|
536
|
+
}
|
|
537
|
+
namespace Responses {
|
|
538
|
+
export interface $201 {
|
|
539
|
+
token: string;
|
|
540
|
+
conversation_id: string; // uuid
|
|
541
|
+
/**
|
|
542
|
+
* Unix seconds
|
|
543
|
+
*/
|
|
544
|
+
expires_at: number;
|
|
545
|
+
widget: {
|
|
546
|
+
key: string;
|
|
547
|
+
organisationName: string;
|
|
548
|
+
assistantName: string;
|
|
549
|
+
defaultLocale: "en" | "de";
|
|
550
|
+
design?: {
|
|
551
|
+
id: string; // uuid
|
|
552
|
+
last_modified_at?: string;
|
|
553
|
+
style?: {
|
|
554
|
+
palette?: {
|
|
555
|
+
primary?: string;
|
|
556
|
+
background?: string;
|
|
557
|
+
};
|
|
558
|
+
typography?: {
|
|
559
|
+
font?: {
|
|
560
|
+
font_family?: string;
|
|
561
|
+
};
|
|
562
|
+
};
|
|
563
|
+
shape?: {
|
|
564
|
+
border_radius?: number;
|
|
565
|
+
};
|
|
566
|
+
};
|
|
567
|
+
spark_theme?: {
|
|
568
|
+
accentColor?: string;
|
|
569
|
+
backgroundColor?: string;
|
|
570
|
+
fontBody?: string;
|
|
571
|
+
fontHeading?: string;
|
|
572
|
+
radius?: string;
|
|
573
|
+
scaling?: string;
|
|
574
|
+
spacing?: string;
|
|
575
|
+
appearance?: string;
|
|
576
|
+
neutralColor?: string;
|
|
577
|
+
styleVariant?: string;
|
|
578
|
+
labelPosition?: string;
|
|
579
|
+
inputStyle?: string;
|
|
580
|
+
inputColor?: string;
|
|
581
|
+
cardVariant?: string;
|
|
582
|
+
cardColor?: string;
|
|
583
|
+
highContrast?: boolean;
|
|
584
|
+
};
|
|
585
|
+
};
|
|
586
|
+
locales: ("en" | "de")[];
|
|
587
|
+
};
|
|
588
|
+
}
|
|
589
|
+
export interface Default {
|
|
590
|
+
code: "INVALID_REQUEST" | "ORIGIN_DENIED" | "NOT_FOUND" | "INVALID_GRANT" | "SESSION_EXPIRED" | "RATE_LIMITED" | "SESSION_LIMIT" | "USAGE_LIMIT" | "REQUEST_CONFLICT" | "IN_PROGRESS" | "UNAVAILABLE" | "TEMPORARILY_UNAVAILABLE";
|
|
591
|
+
}
|
|
592
|
+
}
|
|
593
|
+
}
|
|
594
|
+
namespace CreateChatWidget {
|
|
595
|
+
export interface RequestBody {
|
|
596
|
+
name: string;
|
|
597
|
+
agent_id: string | null; // uuid
|
|
598
|
+
website_chat: {
|
|
599
|
+
/**
|
|
600
|
+
* Exact HTTPS origins. Empty means the widget cannot start sessions.
|
|
601
|
+
*/
|
|
602
|
+
allowed_origins: [
|
|
603
|
+
string?,
|
|
604
|
+
string?,
|
|
605
|
+
string?,
|
|
606
|
+
string?,
|
|
607
|
+
string?,
|
|
608
|
+
string?,
|
|
609
|
+
string?,
|
|
610
|
+
string?,
|
|
611
|
+
string?,
|
|
612
|
+
string?,
|
|
613
|
+
string?,
|
|
614
|
+
string?,
|
|
615
|
+
string?,
|
|
616
|
+
string?,
|
|
617
|
+
string?,
|
|
618
|
+
string?,
|
|
619
|
+
string?,
|
|
620
|
+
string?,
|
|
621
|
+
string?,
|
|
622
|
+
string?,
|
|
623
|
+
string?,
|
|
624
|
+
string?,
|
|
625
|
+
string?,
|
|
626
|
+
string?,
|
|
627
|
+
string?,
|
|
628
|
+
string?,
|
|
629
|
+
string?,
|
|
630
|
+
string?,
|
|
631
|
+
string?,
|
|
632
|
+
string?,
|
|
633
|
+
string?,
|
|
634
|
+
string?,
|
|
635
|
+
string?,
|
|
636
|
+
string?,
|
|
637
|
+
string?,
|
|
638
|
+
string?,
|
|
639
|
+
string?,
|
|
640
|
+
string?,
|
|
641
|
+
string?,
|
|
642
|
+
string?,
|
|
643
|
+
string?,
|
|
644
|
+
string?,
|
|
645
|
+
string?,
|
|
646
|
+
string?,
|
|
647
|
+
string?,
|
|
648
|
+
string?,
|
|
649
|
+
string?,
|
|
650
|
+
string?,
|
|
651
|
+
string?,
|
|
652
|
+
string?
|
|
653
|
+
];
|
|
654
|
+
organisation_name: string;
|
|
655
|
+
default_locale: "en" | "de";
|
|
656
|
+
/**
|
|
657
|
+
* Design Builder configuration for the widget only.
|
|
658
|
+
*/
|
|
659
|
+
design_id?: string | null; // uuid
|
|
660
|
+
/**
|
|
661
|
+
* Email Builder template selection. Does not enable verification by itself.
|
|
662
|
+
*/
|
|
663
|
+
authentication?: {
|
|
664
|
+
email_code: {
|
|
665
|
+
email_template_id?: string | null; // uuid
|
|
666
|
+
};
|
|
667
|
+
} | null;
|
|
668
|
+
};
|
|
669
|
+
}
|
|
670
|
+
namespace Responses {
|
|
671
|
+
export interface $201 {
|
|
672
|
+
name: string;
|
|
673
|
+
agent_id: string | null; // uuid
|
|
674
|
+
website_chat: {
|
|
675
|
+
/**
|
|
676
|
+
* Exact HTTPS origins. Empty means the widget cannot start sessions.
|
|
677
|
+
*/
|
|
678
|
+
allowed_origins: [
|
|
679
|
+
string?,
|
|
680
|
+
string?,
|
|
681
|
+
string?,
|
|
682
|
+
string?,
|
|
683
|
+
string?,
|
|
684
|
+
string?,
|
|
685
|
+
string?,
|
|
686
|
+
string?,
|
|
687
|
+
string?,
|
|
688
|
+
string?,
|
|
689
|
+
string?,
|
|
690
|
+
string?,
|
|
691
|
+
string?,
|
|
692
|
+
string?,
|
|
693
|
+
string?,
|
|
694
|
+
string?,
|
|
695
|
+
string?,
|
|
696
|
+
string?,
|
|
697
|
+
string?,
|
|
698
|
+
string?,
|
|
699
|
+
string?,
|
|
700
|
+
string?,
|
|
701
|
+
string?,
|
|
702
|
+
string?,
|
|
703
|
+
string?,
|
|
704
|
+
string?,
|
|
705
|
+
string?,
|
|
706
|
+
string?,
|
|
707
|
+
string?,
|
|
708
|
+
string?,
|
|
709
|
+
string?,
|
|
710
|
+
string?,
|
|
711
|
+
string?,
|
|
712
|
+
string?,
|
|
713
|
+
string?,
|
|
714
|
+
string?,
|
|
715
|
+
string?,
|
|
716
|
+
string?,
|
|
717
|
+
string?,
|
|
718
|
+
string?,
|
|
719
|
+
string?,
|
|
720
|
+
string?,
|
|
721
|
+
string?,
|
|
722
|
+
string?,
|
|
723
|
+
string?,
|
|
724
|
+
string?,
|
|
725
|
+
string?,
|
|
726
|
+
string?,
|
|
727
|
+
string?,
|
|
728
|
+
string?
|
|
729
|
+
];
|
|
730
|
+
organisation_name: string;
|
|
731
|
+
default_locale: "en" | "de";
|
|
732
|
+
/**
|
|
733
|
+
* Design Builder configuration for the widget only.
|
|
734
|
+
*/
|
|
735
|
+
design_id?: string | null; // uuid
|
|
736
|
+
/**
|
|
737
|
+
* Email Builder template selection. Does not enable verification by itself.
|
|
738
|
+
*/
|
|
739
|
+
authentication?: {
|
|
740
|
+
email_code: {
|
|
741
|
+
email_template_id?: string | null; // uuid
|
|
742
|
+
};
|
|
743
|
+
} | null;
|
|
744
|
+
};
|
|
745
|
+
/**
|
|
746
|
+
* Stable public embed identifier, independent of the assigned agent. Not a credential.
|
|
747
|
+
*/
|
|
748
|
+
widget_id: string; // uuid
|
|
749
|
+
org_id: string;
|
|
750
|
+
/**
|
|
751
|
+
* Server-owned session binding; changes on reassignment or allowed-origin changes.
|
|
752
|
+
*/
|
|
753
|
+
binding_id: string; // uuid
|
|
754
|
+
version: number;
|
|
755
|
+
created_at: string; // date-time
|
|
756
|
+
updated_at: string; // date-time
|
|
757
|
+
website_chat_embed: {
|
|
758
|
+
script_url: string; // uri
|
|
759
|
+
chat_api_origin: string; // uri
|
|
760
|
+
demo_url: string; // uri
|
|
761
|
+
};
|
|
762
|
+
}
|
|
763
|
+
export interface $400 {
|
|
764
|
+
error?: string;
|
|
765
|
+
message?: string;
|
|
766
|
+
details?: {
|
|
767
|
+
[key: string]: any;
|
|
768
|
+
};
|
|
769
|
+
}
|
|
770
|
+
export interface $404 {
|
|
771
|
+
error?: string;
|
|
772
|
+
message?: string;
|
|
773
|
+
details?: {
|
|
774
|
+
[key: string]: any;
|
|
775
|
+
};
|
|
776
|
+
}
|
|
777
|
+
export interface $409 {
|
|
778
|
+
error?: string;
|
|
779
|
+
message?: string;
|
|
780
|
+
details?: {
|
|
781
|
+
[key: string]: any;
|
|
782
|
+
};
|
|
783
|
+
}
|
|
784
|
+
}
|
|
785
|
+
}
|
|
786
|
+
namespace CreatePublicChatGrant {
|
|
787
|
+
export interface RequestBody {
|
|
788
|
+
widget_key: string; // ^[a-zA-Z0-9_-]{1,100}$
|
|
789
|
+
}
|
|
790
|
+
namespace Responses {
|
|
791
|
+
export interface $201 {
|
|
792
|
+
grant: string;
|
|
793
|
+
/**
|
|
794
|
+
* example:
|
|
795
|
+
* 60
|
|
796
|
+
*/
|
|
797
|
+
expires_in: number;
|
|
798
|
+
widget_origin: string; // uri
|
|
799
|
+
}
|
|
800
|
+
export interface Default {
|
|
801
|
+
code: "INVALID_REQUEST" | "ORIGIN_DENIED" | "NOT_FOUND" | "INVALID_GRANT" | "SESSION_EXPIRED" | "RATE_LIMITED" | "SESSION_LIMIT" | "USAGE_LIMIT" | "REQUEST_CONFLICT" | "IN_PROGRESS" | "UNAVAILABLE" | "TEMPORARILY_UNAVAILABLE";
|
|
802
|
+
}
|
|
803
|
+
}
|
|
804
|
+
}
|
|
805
|
+
namespace DeleteChatWidget {
|
|
806
|
+
namespace Parameters {
|
|
807
|
+
export type Version = number;
|
|
808
|
+
}
|
|
809
|
+
export interface QueryParameters {
|
|
810
|
+
version: Parameters.Version;
|
|
811
|
+
}
|
|
812
|
+
namespace Responses {
|
|
813
|
+
export interface $204 {
|
|
814
|
+
}
|
|
815
|
+
export interface $400 {
|
|
816
|
+
error?: string;
|
|
817
|
+
message?: string;
|
|
818
|
+
details?: {
|
|
819
|
+
[key: string]: any;
|
|
820
|
+
};
|
|
821
|
+
}
|
|
822
|
+
export interface $404 {
|
|
823
|
+
error?: string;
|
|
824
|
+
message?: string;
|
|
825
|
+
details?: {
|
|
826
|
+
[key: string]: any;
|
|
827
|
+
};
|
|
828
|
+
}
|
|
829
|
+
export interface $409 {
|
|
830
|
+
error?: string;
|
|
831
|
+
message?: string;
|
|
832
|
+
details?: {
|
|
833
|
+
[key: string]: any;
|
|
834
|
+
};
|
|
835
|
+
}
|
|
836
|
+
}
|
|
837
|
+
}
|
|
838
|
+
namespace GetChatWidget {
|
|
839
|
+
namespace Responses {
|
|
840
|
+
export interface $200 {
|
|
841
|
+
name: string;
|
|
842
|
+
agent_id: string | null; // uuid
|
|
843
|
+
website_chat: {
|
|
844
|
+
/**
|
|
845
|
+
* Exact HTTPS origins. Empty means the widget cannot start sessions.
|
|
846
|
+
*/
|
|
847
|
+
allowed_origins: [
|
|
848
|
+
string?,
|
|
849
|
+
string?,
|
|
850
|
+
string?,
|
|
851
|
+
string?,
|
|
852
|
+
string?,
|
|
853
|
+
string?,
|
|
854
|
+
string?,
|
|
855
|
+
string?,
|
|
856
|
+
string?,
|
|
857
|
+
string?,
|
|
858
|
+
string?,
|
|
859
|
+
string?,
|
|
860
|
+
string?,
|
|
861
|
+
string?,
|
|
862
|
+
string?,
|
|
863
|
+
string?,
|
|
864
|
+
string?,
|
|
865
|
+
string?,
|
|
866
|
+
string?,
|
|
867
|
+
string?,
|
|
868
|
+
string?,
|
|
869
|
+
string?,
|
|
870
|
+
string?,
|
|
871
|
+
string?,
|
|
872
|
+
string?,
|
|
873
|
+
string?,
|
|
874
|
+
string?,
|
|
875
|
+
string?,
|
|
876
|
+
string?,
|
|
877
|
+
string?,
|
|
878
|
+
string?,
|
|
879
|
+
string?,
|
|
880
|
+
string?,
|
|
881
|
+
string?,
|
|
882
|
+
string?,
|
|
883
|
+
string?,
|
|
884
|
+
string?,
|
|
885
|
+
string?,
|
|
886
|
+
string?,
|
|
887
|
+
string?,
|
|
888
|
+
string?,
|
|
889
|
+
string?,
|
|
890
|
+
string?,
|
|
891
|
+
string?,
|
|
892
|
+
string?,
|
|
893
|
+
string?,
|
|
894
|
+
string?,
|
|
895
|
+
string?,
|
|
896
|
+
string?,
|
|
897
|
+
string?
|
|
898
|
+
];
|
|
899
|
+
organisation_name: string;
|
|
900
|
+
default_locale: "en" | "de";
|
|
901
|
+
/**
|
|
902
|
+
* Design Builder configuration for the widget only.
|
|
903
|
+
*/
|
|
904
|
+
design_id?: string | null; // uuid
|
|
905
|
+
/**
|
|
906
|
+
* Email Builder template selection. Does not enable verification by itself.
|
|
907
|
+
*/
|
|
908
|
+
authentication?: {
|
|
909
|
+
email_code: {
|
|
910
|
+
email_template_id?: string | null; // uuid
|
|
911
|
+
};
|
|
912
|
+
} | null;
|
|
913
|
+
};
|
|
914
|
+
/**
|
|
915
|
+
* Stable public embed identifier, independent of the assigned agent. Not a credential.
|
|
916
|
+
*/
|
|
917
|
+
widget_id: string; // uuid
|
|
918
|
+
org_id: string;
|
|
919
|
+
/**
|
|
920
|
+
* Server-owned session binding; changes on reassignment or allowed-origin changes.
|
|
921
|
+
*/
|
|
922
|
+
binding_id: string; // uuid
|
|
923
|
+
version: number;
|
|
924
|
+
created_at: string; // date-time
|
|
925
|
+
updated_at: string; // date-time
|
|
926
|
+
website_chat_embed: {
|
|
927
|
+
script_url: string; // uri
|
|
928
|
+
chat_api_origin: string; // uri
|
|
929
|
+
demo_url: string; // uri
|
|
930
|
+
};
|
|
931
|
+
}
|
|
932
|
+
export interface $400 {
|
|
933
|
+
error?: string;
|
|
934
|
+
message?: string;
|
|
935
|
+
details?: {
|
|
936
|
+
[key: string]: any;
|
|
937
|
+
};
|
|
938
|
+
}
|
|
939
|
+
export interface $404 {
|
|
940
|
+
error?: string;
|
|
941
|
+
message?: string;
|
|
942
|
+
details?: {
|
|
943
|
+
[key: string]: any;
|
|
944
|
+
};
|
|
945
|
+
}
|
|
946
|
+
export interface $409 {
|
|
947
|
+
error?: string;
|
|
948
|
+
message?: string;
|
|
949
|
+
details?: {
|
|
950
|
+
[key: string]: any;
|
|
951
|
+
};
|
|
952
|
+
}
|
|
953
|
+
}
|
|
954
|
+
}
|
|
955
|
+
namespace GetPublicChatWidget {
|
|
956
|
+
namespace Parameters {
|
|
957
|
+
export type WidgetId = string; // ^[a-zA-Z0-9_-]{1,100}$
|
|
958
|
+
}
|
|
959
|
+
export interface PathParameters {
|
|
960
|
+
widget_id: Parameters.WidgetId /* ^[a-zA-Z0-9_-]{1,100}$ */;
|
|
961
|
+
}
|
|
962
|
+
namespace Responses {
|
|
963
|
+
export interface $200 {
|
|
964
|
+
key: string;
|
|
965
|
+
organisationName: string;
|
|
966
|
+
assistantName: string;
|
|
967
|
+
defaultLocale: "en" | "de";
|
|
968
|
+
design?: {
|
|
969
|
+
id: string; // uuid
|
|
970
|
+
last_modified_at?: string;
|
|
971
|
+
style?: {
|
|
972
|
+
palette?: {
|
|
973
|
+
primary?: string;
|
|
974
|
+
background?: string;
|
|
975
|
+
};
|
|
976
|
+
typography?: {
|
|
977
|
+
font?: {
|
|
978
|
+
font_family?: string;
|
|
979
|
+
};
|
|
980
|
+
};
|
|
981
|
+
shape?: {
|
|
982
|
+
border_radius?: number;
|
|
983
|
+
};
|
|
984
|
+
};
|
|
985
|
+
spark_theme?: {
|
|
986
|
+
accentColor?: string;
|
|
987
|
+
backgroundColor?: string;
|
|
988
|
+
fontBody?: string;
|
|
989
|
+
fontHeading?: string;
|
|
990
|
+
radius?: string;
|
|
991
|
+
scaling?: string;
|
|
992
|
+
spacing?: string;
|
|
993
|
+
appearance?: string;
|
|
994
|
+
neutralColor?: string;
|
|
995
|
+
styleVariant?: string;
|
|
996
|
+
labelPosition?: string;
|
|
997
|
+
inputStyle?: string;
|
|
998
|
+
inputColor?: string;
|
|
999
|
+
cardVariant?: string;
|
|
1000
|
+
cardColor?: string;
|
|
1001
|
+
highContrast?: boolean;
|
|
1002
|
+
};
|
|
1003
|
+
};
|
|
1004
|
+
locales: ("en" | "de")[];
|
|
1005
|
+
}
|
|
1006
|
+
export interface Default {
|
|
1007
|
+
code: "INVALID_REQUEST" | "ORIGIN_DENIED" | "NOT_FOUND" | "INVALID_GRANT" | "SESSION_EXPIRED" | "RATE_LIMITED" | "SESSION_LIMIT" | "USAGE_LIMIT" | "REQUEST_CONFLICT" | "IN_PROGRESS" | "UNAVAILABLE" | "TEMPORARILY_UNAVAILABLE";
|
|
1008
|
+
}
|
|
1009
|
+
}
|
|
1010
|
+
}
|
|
1011
|
+
namespace ListChatWidgets {
|
|
1012
|
+
namespace Parameters {
|
|
1013
|
+
export type Cursor = string;
|
|
1014
|
+
}
|
|
1015
|
+
export interface QueryParameters {
|
|
1016
|
+
cursor?: Parameters.Cursor;
|
|
1017
|
+
}
|
|
1018
|
+
namespace Responses {
|
|
1019
|
+
export interface $200 {
|
|
1020
|
+
widgets: {
|
|
1021
|
+
name: string;
|
|
1022
|
+
agent_id: string | null; // uuid
|
|
1023
|
+
website_chat: {
|
|
1024
|
+
/**
|
|
1025
|
+
* Exact HTTPS origins. Empty means the widget cannot start sessions.
|
|
1026
|
+
*/
|
|
1027
|
+
allowed_origins: [
|
|
1028
|
+
string?,
|
|
1029
|
+
string?,
|
|
1030
|
+
string?,
|
|
1031
|
+
string?,
|
|
1032
|
+
string?,
|
|
1033
|
+
string?,
|
|
1034
|
+
string?,
|
|
1035
|
+
string?,
|
|
1036
|
+
string?,
|
|
1037
|
+
string?,
|
|
1038
|
+
string?,
|
|
1039
|
+
string?,
|
|
1040
|
+
string?,
|
|
1041
|
+
string?,
|
|
1042
|
+
string?,
|
|
1043
|
+
string?,
|
|
1044
|
+
string?,
|
|
1045
|
+
string?,
|
|
1046
|
+
string?,
|
|
1047
|
+
string?,
|
|
1048
|
+
string?,
|
|
1049
|
+
string?,
|
|
1050
|
+
string?,
|
|
1051
|
+
string?,
|
|
1052
|
+
string?,
|
|
1053
|
+
string?,
|
|
1054
|
+
string?,
|
|
1055
|
+
string?,
|
|
1056
|
+
string?,
|
|
1057
|
+
string?,
|
|
1058
|
+
string?,
|
|
1059
|
+
string?,
|
|
1060
|
+
string?,
|
|
1061
|
+
string?,
|
|
1062
|
+
string?,
|
|
1063
|
+
string?,
|
|
1064
|
+
string?,
|
|
1065
|
+
string?,
|
|
1066
|
+
string?,
|
|
1067
|
+
string?,
|
|
1068
|
+
string?,
|
|
1069
|
+
string?,
|
|
1070
|
+
string?,
|
|
1071
|
+
string?,
|
|
1072
|
+
string?,
|
|
1073
|
+
string?,
|
|
1074
|
+
string?,
|
|
1075
|
+
string?,
|
|
1076
|
+
string?,
|
|
1077
|
+
string?
|
|
1078
|
+
];
|
|
1079
|
+
organisation_name: string;
|
|
1080
|
+
default_locale: "en" | "de";
|
|
1081
|
+
/**
|
|
1082
|
+
* Design Builder configuration for the widget only.
|
|
1083
|
+
*/
|
|
1084
|
+
design_id?: string | null; // uuid
|
|
1085
|
+
/**
|
|
1086
|
+
* Email Builder template selection. Does not enable verification by itself.
|
|
1087
|
+
*/
|
|
1088
|
+
authentication?: {
|
|
1089
|
+
email_code: {
|
|
1090
|
+
email_template_id?: string | null; // uuid
|
|
1091
|
+
};
|
|
1092
|
+
} | null;
|
|
1093
|
+
};
|
|
1094
|
+
/**
|
|
1095
|
+
* Stable public embed identifier, independent of the assigned agent. Not a credential.
|
|
1096
|
+
*/
|
|
1097
|
+
widget_id: string; // uuid
|
|
1098
|
+
org_id: string;
|
|
1099
|
+
/**
|
|
1100
|
+
* Server-owned session binding; changes on reassignment or allowed-origin changes.
|
|
1101
|
+
*/
|
|
1102
|
+
binding_id: string; // uuid
|
|
1103
|
+
version: number;
|
|
1104
|
+
created_at: string; // date-time
|
|
1105
|
+
updated_at: string; // date-time
|
|
1106
|
+
website_chat_embed: {
|
|
1107
|
+
script_url: string; // uri
|
|
1108
|
+
chat_api_origin: string; // uri
|
|
1109
|
+
demo_url: string; // uri
|
|
1110
|
+
};
|
|
1111
|
+
}[];
|
|
1112
|
+
next_cursor?: string;
|
|
1113
|
+
}
|
|
1114
|
+
export interface $400 {
|
|
1115
|
+
error?: string;
|
|
1116
|
+
message?: string;
|
|
1117
|
+
details?: {
|
|
1118
|
+
[key: string]: any;
|
|
1119
|
+
};
|
|
1120
|
+
}
|
|
1121
|
+
export interface $404 {
|
|
1122
|
+
error?: string;
|
|
1123
|
+
message?: string;
|
|
1124
|
+
details?: {
|
|
1125
|
+
[key: string]: any;
|
|
1126
|
+
};
|
|
1127
|
+
}
|
|
1128
|
+
export interface $409 {
|
|
1129
|
+
error?: string;
|
|
1130
|
+
message?: string;
|
|
1131
|
+
details?: {
|
|
1132
|
+
[key: string]: any;
|
|
1133
|
+
};
|
|
1134
|
+
}
|
|
1135
|
+
}
|
|
1136
|
+
}
|
|
1137
|
+
namespace SendAnonymousChatMessage {
|
|
1138
|
+
export interface RequestBody {
|
|
1139
|
+
request_id: string; // uuid ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
|
|
1140
|
+
message: string; // \S
|
|
1141
|
+
locale: "en" | "de";
|
|
1142
|
+
simple_language: boolean;
|
|
1143
|
+
}
|
|
1144
|
+
namespace Responses {
|
|
1145
|
+
export type $200 = string;
|
|
1146
|
+
export interface Default {
|
|
1147
|
+
code: "INVALID_REQUEST" | "ORIGIN_DENIED" | "NOT_FOUND" | "INVALID_GRANT" | "SESSION_EXPIRED" | "RATE_LIMITED" | "SESSION_LIMIT" | "USAGE_LIMIT" | "REQUEST_CONFLICT" | "IN_PROGRESS" | "UNAVAILABLE" | "TEMPORARILY_UNAVAILABLE";
|
|
1148
|
+
}
|
|
1149
|
+
}
|
|
1150
|
+
}
|
|
1151
|
+
namespace UpdateChatWidget {
|
|
1152
|
+
export interface RequestBody {
|
|
1153
|
+
name?: string;
|
|
1154
|
+
agent_id?: string | null; // uuid
|
|
1155
|
+
website_chat?: {
|
|
1156
|
+
/**
|
|
1157
|
+
* Exact HTTPS origins. Empty means the widget cannot start sessions.
|
|
1158
|
+
*/
|
|
1159
|
+
allowed_origins: [
|
|
1160
|
+
string?,
|
|
1161
|
+
string?,
|
|
1162
|
+
string?,
|
|
1163
|
+
string?,
|
|
1164
|
+
string?,
|
|
1165
|
+
string?,
|
|
1166
|
+
string?,
|
|
1167
|
+
string?,
|
|
1168
|
+
string?,
|
|
1169
|
+
string?,
|
|
1170
|
+
string?,
|
|
1171
|
+
string?,
|
|
1172
|
+
string?,
|
|
1173
|
+
string?,
|
|
1174
|
+
string?,
|
|
1175
|
+
string?,
|
|
1176
|
+
string?,
|
|
1177
|
+
string?,
|
|
1178
|
+
string?,
|
|
1179
|
+
string?,
|
|
1180
|
+
string?,
|
|
1181
|
+
string?,
|
|
1182
|
+
string?,
|
|
1183
|
+
string?,
|
|
1184
|
+
string?,
|
|
1185
|
+
string?,
|
|
1186
|
+
string?,
|
|
1187
|
+
string?,
|
|
1188
|
+
string?,
|
|
1189
|
+
string?,
|
|
1190
|
+
string?,
|
|
1191
|
+
string?,
|
|
1192
|
+
string?,
|
|
1193
|
+
string?,
|
|
1194
|
+
string?,
|
|
1195
|
+
string?,
|
|
1196
|
+
string?,
|
|
1197
|
+
string?,
|
|
1198
|
+
string?,
|
|
1199
|
+
string?,
|
|
1200
|
+
string?,
|
|
1201
|
+
string?,
|
|
1202
|
+
string?,
|
|
1203
|
+
string?,
|
|
1204
|
+
string?,
|
|
1205
|
+
string?,
|
|
1206
|
+
string?,
|
|
1207
|
+
string?,
|
|
1208
|
+
string?,
|
|
1209
|
+
string?
|
|
1210
|
+
];
|
|
1211
|
+
organisation_name: string;
|
|
1212
|
+
default_locale: "en" | "de";
|
|
1213
|
+
/**
|
|
1214
|
+
* Design Builder configuration for the widget only.
|
|
1215
|
+
*/
|
|
1216
|
+
design_id?: string | null; // uuid
|
|
1217
|
+
/**
|
|
1218
|
+
* Email Builder template selection. Does not enable verification by itself.
|
|
1219
|
+
*/
|
|
1220
|
+
authentication?: {
|
|
1221
|
+
email_code: {
|
|
1222
|
+
email_template_id?: string | null; // uuid
|
|
1223
|
+
};
|
|
1224
|
+
} | null;
|
|
1225
|
+
};
|
|
1226
|
+
/**
|
|
1227
|
+
* Version read by the editor; stale writes return 409.
|
|
1228
|
+
*/
|
|
1229
|
+
version: number;
|
|
1230
|
+
}
|
|
1231
|
+
namespace Responses {
|
|
1232
|
+
export interface $200 {
|
|
1233
|
+
name: string;
|
|
1234
|
+
agent_id: string | null; // uuid
|
|
1235
|
+
website_chat: {
|
|
1236
|
+
/**
|
|
1237
|
+
* Exact HTTPS origins. Empty means the widget cannot start sessions.
|
|
1238
|
+
*/
|
|
1239
|
+
allowed_origins: [
|
|
1240
|
+
string?,
|
|
1241
|
+
string?,
|
|
1242
|
+
string?,
|
|
1243
|
+
string?,
|
|
1244
|
+
string?,
|
|
1245
|
+
string?,
|
|
1246
|
+
string?,
|
|
1247
|
+
string?,
|
|
1248
|
+
string?,
|
|
1249
|
+
string?,
|
|
1250
|
+
string?,
|
|
1251
|
+
string?,
|
|
1252
|
+
string?,
|
|
1253
|
+
string?,
|
|
1254
|
+
string?,
|
|
1255
|
+
string?,
|
|
1256
|
+
string?,
|
|
1257
|
+
string?,
|
|
1258
|
+
string?,
|
|
1259
|
+
string?,
|
|
1260
|
+
string?,
|
|
1261
|
+
string?,
|
|
1262
|
+
string?,
|
|
1263
|
+
string?,
|
|
1264
|
+
string?,
|
|
1265
|
+
string?,
|
|
1266
|
+
string?,
|
|
1267
|
+
string?,
|
|
1268
|
+
string?,
|
|
1269
|
+
string?,
|
|
1270
|
+
string?,
|
|
1271
|
+
string?,
|
|
1272
|
+
string?,
|
|
1273
|
+
string?,
|
|
1274
|
+
string?,
|
|
1275
|
+
string?,
|
|
1276
|
+
string?,
|
|
1277
|
+
string?,
|
|
1278
|
+
string?,
|
|
1279
|
+
string?,
|
|
1280
|
+
string?,
|
|
1281
|
+
string?,
|
|
1282
|
+
string?,
|
|
1283
|
+
string?,
|
|
1284
|
+
string?,
|
|
1285
|
+
string?,
|
|
1286
|
+
string?,
|
|
1287
|
+
string?,
|
|
1288
|
+
string?,
|
|
1289
|
+
string?
|
|
1290
|
+
];
|
|
1291
|
+
organisation_name: string;
|
|
1292
|
+
default_locale: "en" | "de";
|
|
1293
|
+
/**
|
|
1294
|
+
* Design Builder configuration for the widget only.
|
|
1295
|
+
*/
|
|
1296
|
+
design_id?: string | null; // uuid
|
|
1297
|
+
/**
|
|
1298
|
+
* Email Builder template selection. Does not enable verification by itself.
|
|
1299
|
+
*/
|
|
1300
|
+
authentication?: {
|
|
1301
|
+
email_code: {
|
|
1302
|
+
email_template_id?: string | null; // uuid
|
|
1303
|
+
};
|
|
1304
|
+
} | null;
|
|
1305
|
+
};
|
|
1306
|
+
/**
|
|
1307
|
+
* Stable public embed identifier, independent of the assigned agent. Not a credential.
|
|
1308
|
+
*/
|
|
1309
|
+
widget_id: string; // uuid
|
|
1310
|
+
org_id: string;
|
|
1311
|
+
/**
|
|
1312
|
+
* Server-owned session binding; changes on reassignment or allowed-origin changes.
|
|
1313
|
+
*/
|
|
1314
|
+
binding_id: string; // uuid
|
|
1315
|
+
version: number;
|
|
1316
|
+
created_at: string; // date-time
|
|
1317
|
+
updated_at: string; // date-time
|
|
1318
|
+
website_chat_embed: {
|
|
1319
|
+
script_url: string; // uri
|
|
1320
|
+
chat_api_origin: string; // uri
|
|
1321
|
+
demo_url: string; // uri
|
|
1322
|
+
};
|
|
1323
|
+
}
|
|
1324
|
+
export interface $400 {
|
|
1325
|
+
error?: string;
|
|
1326
|
+
message?: string;
|
|
1327
|
+
details?: {
|
|
1328
|
+
[key: string]: any;
|
|
1329
|
+
};
|
|
1330
|
+
}
|
|
1331
|
+
export interface $404 {
|
|
1332
|
+
error?: string;
|
|
1333
|
+
message?: string;
|
|
1334
|
+
details?: {
|
|
1335
|
+
[key: string]: any;
|
|
1336
|
+
};
|
|
1337
|
+
}
|
|
1338
|
+
export interface $409 {
|
|
1339
|
+
error?: string;
|
|
1340
|
+
message?: string;
|
|
1341
|
+
details?: {
|
|
1342
|
+
[key: string]: any;
|
|
1343
|
+
};
|
|
1344
|
+
}
|
|
1345
|
+
}
|
|
1346
|
+
}
|
|
1347
|
+
namespace V1Widgets$WidgetId {
|
|
1348
|
+
namespace Parameters {
|
|
1349
|
+
export type WidgetId = string; // uuid
|
|
1350
|
+
}
|
|
1351
|
+
export interface PathParameters {
|
|
1352
|
+
widget_id: Parameters.WidgetId /* uuid */;
|
|
1353
|
+
}
|
|
1354
|
+
}
|
|
1355
|
+
}
|
|
1356
|
+
|
|
1357
|
+
|
|
1358
|
+
interface OperationMethods {
|
|
1359
|
+
/**
|
|
1360
|
+
* listChatWidgets
|
|
1361
|
+
*/
|
|
1362
|
+
'listChatWidgets'(
|
|
1363
|
+
parameters?: Parameters<Paths.ListChatWidgets.QueryParameters> | null,
|
|
1364
|
+
data?: any,
|
|
1365
|
+
config?: AxiosRequestConfig
|
|
1366
|
+
): OperationResponse<Paths.ListChatWidgets.Responses.$200>
|
|
1367
|
+
/**
|
|
1368
|
+
* createChatWidget
|
|
1369
|
+
*/
|
|
1370
|
+
'createChatWidget'(
|
|
1371
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1372
|
+
data?: Paths.CreateChatWidget.RequestBody,
|
|
1373
|
+
config?: AxiosRequestConfig
|
|
1374
|
+
): OperationResponse<Paths.CreateChatWidget.Responses.$201>
|
|
1375
|
+
/**
|
|
1376
|
+
* getChatWidget
|
|
1377
|
+
*/
|
|
1378
|
+
'getChatWidget'(
|
|
1379
|
+
parameters?: Parameters<Paths.V1Widgets$WidgetId.PathParameters> | null,
|
|
1380
|
+
data?: any,
|
|
1381
|
+
config?: AxiosRequestConfig
|
|
1382
|
+
): OperationResponse<Paths.GetChatWidget.Responses.$200>
|
|
1383
|
+
/**
|
|
1384
|
+
* updateChatWidget
|
|
1385
|
+
*/
|
|
1386
|
+
'updateChatWidget'(
|
|
1387
|
+
parameters?: Parameters<Paths.V1Widgets$WidgetId.PathParameters> | null,
|
|
1388
|
+
data?: Paths.UpdateChatWidget.RequestBody,
|
|
1389
|
+
config?: AxiosRequestConfig
|
|
1390
|
+
): OperationResponse<Paths.UpdateChatWidget.Responses.$200>
|
|
1391
|
+
/**
|
|
1392
|
+
* deleteChatWidget
|
|
1393
|
+
*/
|
|
1394
|
+
'deleteChatWidget'(
|
|
1395
|
+
parameters?: Parameters<Paths.DeleteChatWidget.QueryParameters & Paths.V1Widgets$WidgetId.PathParameters> | null,
|
|
1396
|
+
data?: any,
|
|
1397
|
+
config?: AxiosRequestConfig
|
|
1398
|
+
): OperationResponse<Paths.DeleteChatWidget.Responses.$204>
|
|
1399
|
+
/**
|
|
1400
|
+
* getPublicChatWidget - Resolve visitor-facing configuration for an independent widget and its current agent assignment. The widget ID is not an organisation ID or a destination such as website or portal.
|
|
1401
|
+
*/
|
|
1402
|
+
'getPublicChatWidget'(
|
|
1403
|
+
parameters?: Parameters<Paths.GetPublicChatWidget.PathParameters> | null,
|
|
1404
|
+
data?: any,
|
|
1405
|
+
config?: AxiosRequestConfig
|
|
1406
|
+
): OperationResponse<Paths.GetPublicChatWidget.Responses.$200 | Paths.GetPublicChatWidget.Responses.Default>
|
|
1407
|
+
/**
|
|
1408
|
+
* createPublicChatGrant - Called by the host website with its widget_key. Checks the saved website origin allowlist and issues a single-use grant for the iframe to exchange at POST /v1/sessions within 60 seconds. This deadline does not limit the resulting session.
|
|
1409
|
+
*/
|
|
1410
|
+
'createPublicChatGrant'(
|
|
1411
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1412
|
+
data?: Paths.CreatePublicChatGrant.RequestBody,
|
|
1413
|
+
config?: AxiosRequestConfig
|
|
1414
|
+
): OperationResponse<Paths.CreatePublicChatGrant.Responses.$201 | Paths.CreatePublicChatGrant.Responses.Default>
|
|
1415
|
+
/**
|
|
1416
|
+
* createAnonymousChatSession - Exchanges an unexpired grant once for an independent 30-minute session. Expired or previously used grants return 401 INVALID_GRANT; the host must bootstrap again.
|
|
1417
|
+
*/
|
|
1418
|
+
'createAnonymousChatSession'(
|
|
1419
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1420
|
+
data?: Paths.CreateAnonymousChatSession.RequestBody,
|
|
1421
|
+
config?: AxiosRequestConfig
|
|
1422
|
+
): OperationResponse<Paths.CreateAnonymousChatSession.Responses.$201 | Paths.CreateAnonymousChatSession.Responses.Default>
|
|
1423
|
+
/**
|
|
1424
|
+
* sendAnonymousChatMessage - Creates a turn or replays its persisted result. Reuse request_id and the exact
|
|
1425
|
+
* payload for a retry. History, org, agent, tools and account identity cannot be supplied.
|
|
1426
|
+
* TEMPORARILY_UNAVAILABLE means the request outcome could not be checked; retry the same request ID and payload.
|
|
1427
|
+
* A running request returns 409 IN_PROGRESS; a changed payload returns 409 REQUEST_CONFLICT.
|
|
1428
|
+
* A failed admitted request never starts another model execution when retried.
|
|
1429
|
+
*
|
|
1430
|
+
*/
|
|
1431
|
+
'sendAnonymousChatMessage'(
|
|
1432
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1433
|
+
data?: Paths.SendAnonymousChatMessage.RequestBody,
|
|
1434
|
+
config?: AxiosRequestConfig
|
|
1435
|
+
): OperationResponse<Paths.SendAnonymousChatMessage.Responses.$200 | Paths.SendAnonymousChatMessage.Responses.Default>
|
|
1436
|
+
}
|
|
1437
|
+
|
|
1438
|
+
interface PathsDictionary {
|
|
1439
|
+
['/v1/widgets']: {
|
|
1440
|
+
/**
|
|
1441
|
+
* listChatWidgets
|
|
1442
|
+
*/
|
|
1443
|
+
'get'(
|
|
1444
|
+
parameters?: Parameters<Paths.ListChatWidgets.QueryParameters> | null,
|
|
1445
|
+
data?: any,
|
|
1446
|
+
config?: AxiosRequestConfig
|
|
1447
|
+
): OperationResponse<Paths.ListChatWidgets.Responses.$200>
|
|
1448
|
+
/**
|
|
1449
|
+
* createChatWidget
|
|
1450
|
+
*/
|
|
1451
|
+
'post'(
|
|
1452
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1453
|
+
data?: Paths.CreateChatWidget.RequestBody,
|
|
1454
|
+
config?: AxiosRequestConfig
|
|
1455
|
+
): OperationResponse<Paths.CreateChatWidget.Responses.$201>
|
|
1456
|
+
}
|
|
1457
|
+
['/v1/widgets/{widget_id}']: {
|
|
1458
|
+
/**
|
|
1459
|
+
* getChatWidget
|
|
1460
|
+
*/
|
|
1461
|
+
'get'(
|
|
1462
|
+
parameters?: Parameters<Paths.V1Widgets$WidgetId.PathParameters> | null,
|
|
1463
|
+
data?: any,
|
|
1464
|
+
config?: AxiosRequestConfig
|
|
1465
|
+
): OperationResponse<Paths.GetChatWidget.Responses.$200>
|
|
1466
|
+
/**
|
|
1467
|
+
* updateChatWidget
|
|
1468
|
+
*/
|
|
1469
|
+
'put'(
|
|
1470
|
+
parameters?: Parameters<Paths.V1Widgets$WidgetId.PathParameters> | null,
|
|
1471
|
+
data?: Paths.UpdateChatWidget.RequestBody,
|
|
1472
|
+
config?: AxiosRequestConfig
|
|
1473
|
+
): OperationResponse<Paths.UpdateChatWidget.Responses.$200>
|
|
1474
|
+
/**
|
|
1475
|
+
* deleteChatWidget
|
|
1476
|
+
*/
|
|
1477
|
+
'delete'(
|
|
1478
|
+
parameters?: Parameters<Paths.DeleteChatWidget.QueryParameters & Paths.V1Widgets$WidgetId.PathParameters> | null,
|
|
1479
|
+
data?: any,
|
|
1480
|
+
config?: AxiosRequestConfig
|
|
1481
|
+
): OperationResponse<Paths.DeleteChatWidget.Responses.$204>
|
|
1482
|
+
}
|
|
1483
|
+
['/v1/widgets/{widget_id}/configuration']: {
|
|
1484
|
+
/**
|
|
1485
|
+
* getPublicChatWidget - Resolve visitor-facing configuration for an independent widget and its current agent assignment. The widget ID is not an organisation ID or a destination such as website or portal.
|
|
1486
|
+
*/
|
|
1487
|
+
'get'(
|
|
1488
|
+
parameters?: Parameters<Paths.GetPublicChatWidget.PathParameters> | null,
|
|
1489
|
+
data?: any,
|
|
1490
|
+
config?: AxiosRequestConfig
|
|
1491
|
+
): OperationResponse<Paths.GetPublicChatWidget.Responses.$200 | Paths.GetPublicChatWidget.Responses.Default>
|
|
1492
|
+
}
|
|
1493
|
+
['/v1/bootstrap']: {
|
|
1494
|
+
/**
|
|
1495
|
+
* createPublicChatGrant - Called by the host website with its widget_key. Checks the saved website origin allowlist and issues a single-use grant for the iframe to exchange at POST /v1/sessions within 60 seconds. This deadline does not limit the resulting session.
|
|
1496
|
+
*/
|
|
1497
|
+
'post'(
|
|
1498
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1499
|
+
data?: Paths.CreatePublicChatGrant.RequestBody,
|
|
1500
|
+
config?: AxiosRequestConfig
|
|
1501
|
+
): OperationResponse<Paths.CreatePublicChatGrant.Responses.$201 | Paths.CreatePublicChatGrant.Responses.Default>
|
|
1502
|
+
}
|
|
1503
|
+
['/v1/sessions']: {
|
|
1504
|
+
/**
|
|
1505
|
+
* createAnonymousChatSession - Exchanges an unexpired grant once for an independent 30-minute session. Expired or previously used grants return 401 INVALID_GRANT; the host must bootstrap again.
|
|
1506
|
+
*/
|
|
1507
|
+
'post'(
|
|
1508
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1509
|
+
data?: Paths.CreateAnonymousChatSession.RequestBody,
|
|
1510
|
+
config?: AxiosRequestConfig
|
|
1511
|
+
): OperationResponse<Paths.CreateAnonymousChatSession.Responses.$201 | Paths.CreateAnonymousChatSession.Responses.Default>
|
|
1512
|
+
}
|
|
1513
|
+
['/v1/messages']: {
|
|
1514
|
+
/**
|
|
1515
|
+
* sendAnonymousChatMessage - Creates a turn or replays its persisted result. Reuse request_id and the exact
|
|
1516
|
+
* payload for a retry. History, org, agent, tools and account identity cannot be supplied.
|
|
1517
|
+
* TEMPORARILY_UNAVAILABLE means the request outcome could not be checked; retry the same request ID and payload.
|
|
1518
|
+
* A running request returns 409 IN_PROGRESS; a changed payload returns 409 REQUEST_CONFLICT.
|
|
1519
|
+
* A failed admitted request never starts another model execution when retried.
|
|
1520
|
+
*
|
|
1521
|
+
*/
|
|
1522
|
+
'post'(
|
|
1523
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1524
|
+
data?: Paths.SendAnonymousChatMessage.RequestBody,
|
|
1525
|
+
config?: AxiosRequestConfig
|
|
1526
|
+
): OperationResponse<Paths.SendAnonymousChatMessage.Responses.$200 | Paths.SendAnonymousChatMessage.Responses.Default>
|
|
1527
|
+
}
|
|
1528
|
+
}
|
|
1529
|
+
|
|
1530
|
+
type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
1531
|
+
|
|
1532
|
+
|
|
1533
|
+
type ChatWidget = Components.Schemas.ChatWidget;
|
|
1534
|
+
type CreateChatWidgetRequest = Components.Schemas.CreateChatWidgetRequest;
|
|
1535
|
+
type Error = Components.Schemas.Error;
|
|
1536
|
+
type ListChatWidgetsResponse = Components.Schemas.ListChatWidgetsResponse;
|
|
1537
|
+
type PublicChatError = Components.Schemas.PublicChatError;
|
|
1538
|
+
type PublicEvent = Components.Schemas.PublicEvent;
|
|
1539
|
+
type UpdateChatWidgetRequest = Components.Schemas.UpdateChatWidgetRequest;
|
|
1540
|
+
type WebsiteChatSettings = Components.Schemas.WebsiteChatSettings;
|
|
1541
|
+
type Widget = Components.Schemas.Widget;
|
|
1542
|
+
type WidgetDesign = Components.Schemas.WidgetDesign;
|
|
1543
|
+
|
|
1544
|
+
export { type Client as C, type Error as E, type ListChatWidgetsResponse as L, type OperationMethods as O, Paths as P, type UpdateChatWidgetRequest as U, type WebsiteChatSettings as W, Components as a, type PathsDictionary as b, type ChatWidget as c, type CreateChatWidgetRequest as d, type PublicChatError as e, type PublicEvent as f, type Widget as g, type WidgetDesign as h };
|