@epilot/sdk 2.20.44 → 2.20.46
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/definitions/chat-runtime.json +1 -1
- package/definitions/chat.json +2859 -150
- package/definitions/integration-toolkit.json +18 -7
- 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 +6 -6
- package/dist/apis/automation.js +1 -1
- 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 +8 -8
- package/dist/apis/chat.d.cts +2 -2
- package/dist/apis/chat.d.ts +2 -2
- package/dist/apis/chat.js +2 -2
- 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/identity.cjs +6 -6
- package/dist/apis/identity.js +1 -1
- package/dist/apis/integration-toolkit.cjs +6 -6
- package/dist/apis/integration-toolkit.d.cts +2 -2
- package/dist/apis/integration-toolkit.d.ts +2 -2
- 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/chat-6E3CPZZV.js +7 -0
- package/dist/chat-EGLWHHF5.cjs +7 -0
- package/dist/{chat-runtime-O46V7MCD.js → chat-runtime-GCKIJKUM.js} +1 -1
- package/dist/chat-runtime-X5ASDO46.cjs +5 -0
- package/dist/chat.d-BGPN5RIE.d.cts +5319 -0
- package/dist/chat.d-BGPN5RIE.d.ts +5319 -0
- package/dist/{chunk-QWQ6UINA.cjs → chunk-2QQYR5S5.cjs} +1 -1
- package/dist/{chunk-IYEK3653.cjs → chunk-5NZXNIBE.cjs} +3 -3
- package/dist/{chunk-2F4JXHGX.js → chunk-DIUWLA6A.js} +1 -1
- package/dist/{chunk-LHBJF2FW.js → chunk-KHQACGLY.js} +3 -3
- package/dist/index.cjs +10 -10
- package/dist/index.d.cts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +2 -2
- package/dist/integration-toolkit-GGXTCIBG.cjs +7 -0
- package/dist/integration-toolkit-XPSFIGHA.js +7 -0
- package/dist/{integration-toolkit.d-D4CzSBOS.d.cts → integration-toolkit.d-93TYFohH.d.cts} +16 -6
- package/dist/{integration-toolkit.d-D4CzSBOS.d.ts → integration-toolkit.d-93TYFohH.d.ts} +16 -6
- package/docs/chat.md +610 -15
- package/docs/integration-toolkit.md +15 -10
- package/package.json +1 -1
- package/dist/chat-3MIK7DUI.js +0 -7
- package/dist/chat-IWMQEXCD.cjs +0 -7
- package/dist/chat-runtime-QSGSW6SL.cjs +0 -5
- package/dist/chat.d-mUHenLz7.d.cts +0 -1743
- package/dist/chat.d-mUHenLz7.d.ts +0 -1743
- package/dist/integration-toolkit-EIVEAO4Z.cjs +0 -7
- package/dist/integration-toolkit-NIA5DND5.js +0 -7
|
@@ -1,1743 +0,0 @@
|
|
|
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_VERIFICATION_CODE" | "VERIFICATION_EXPIRED" | "VERIFICATION_CONFLICT" | "VERIFICATION_DISABLED" | "VERIFICATION_UNAVAILABLE" | "IDENTITY_CHANGED" | "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 CreateWebsiteChatRequest {
|
|
14
|
-
name: string;
|
|
15
|
-
agent_id: string | null; // uuid
|
|
16
|
-
settings: {
|
|
17
|
-
/**
|
|
18
|
-
* Exact HTTPS origins. Empty means the Website Chat 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 Website Chat 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
|
-
export interface Error {
|
|
89
|
-
error?: string;
|
|
90
|
-
message?: string;
|
|
91
|
-
details?: {
|
|
92
|
-
[key: string]: any;
|
|
93
|
-
};
|
|
94
|
-
}
|
|
95
|
-
export interface ListWebsiteChatsResponse {
|
|
96
|
-
website_chats: {
|
|
97
|
-
name: string;
|
|
98
|
-
agent_id: string | null; // uuid
|
|
99
|
-
settings: {
|
|
100
|
-
/**
|
|
101
|
-
* Exact HTTPS origins. Empty means the Website Chat cannot start sessions.
|
|
102
|
-
*/
|
|
103
|
-
allowed_origins: [
|
|
104
|
-
string?,
|
|
105
|
-
string?,
|
|
106
|
-
string?,
|
|
107
|
-
string?,
|
|
108
|
-
string?,
|
|
109
|
-
string?,
|
|
110
|
-
string?,
|
|
111
|
-
string?,
|
|
112
|
-
string?,
|
|
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
|
-
];
|
|
155
|
-
organisation_name: string;
|
|
156
|
-
default_locale: "en" | "de";
|
|
157
|
-
/**
|
|
158
|
-
* Design Builder configuration for the Website Chat only.
|
|
159
|
-
*/
|
|
160
|
-
design_id?: string | null; // uuid
|
|
161
|
-
/**
|
|
162
|
-
* Email Builder template selection. Does not enable verification by itself.
|
|
163
|
-
*/
|
|
164
|
-
authentication?: {
|
|
165
|
-
email_code: {
|
|
166
|
-
email_template_id?: string | null; // uuid
|
|
167
|
-
};
|
|
168
|
-
} | null;
|
|
169
|
-
};
|
|
170
|
-
/**
|
|
171
|
-
* Stable public embed identifier, independent of the assigned agent. Not a credential.
|
|
172
|
-
*/
|
|
173
|
-
website_chat_id: string; // uuid
|
|
174
|
-
org_id: string;
|
|
175
|
-
/**
|
|
176
|
-
* Server-owned session binding; changes on reassignment or allowed-origin changes.
|
|
177
|
-
*/
|
|
178
|
-
binding_id: string; // uuid
|
|
179
|
-
version: number;
|
|
180
|
-
created_at: string; // date-time
|
|
181
|
-
updated_at: string; // date-time
|
|
182
|
-
embed: {
|
|
183
|
-
script_url: string; // uri
|
|
184
|
-
chat_api_origin: string; // uri
|
|
185
|
-
demo_url: string; // uri
|
|
186
|
-
};
|
|
187
|
-
}[];
|
|
188
|
-
next_cursor?: string;
|
|
189
|
-
}
|
|
190
|
-
export interface PublicChatError {
|
|
191
|
-
code: "INVALID_VERIFICATION_CODE" | "VERIFICATION_EXPIRED" | "VERIFICATION_CONFLICT" | "VERIFICATION_DISABLED" | "VERIFICATION_UNAVAILABLE" | "IDENTITY_CHANGED" | "INVALID_REQUEST" | "ORIGIN_DENIED" | "NOT_FOUND" | "INVALID_GRANT" | "SESSION_EXPIRED" | "RATE_LIMITED" | "SESSION_LIMIT" | "USAGE_LIMIT" | "REQUEST_CONFLICT" | "IN_PROGRESS" | "UNAVAILABLE" | "TEMPORARILY_UNAVAILABLE";
|
|
192
|
-
}
|
|
193
|
-
/**
|
|
194
|
-
* JSON payload of one SSE data frame from sendAnonymousChatMessage.
|
|
195
|
-
*/
|
|
196
|
-
export type PublicEvent = /* JSON payload of one SSE data frame from sendAnonymousChatMessage. */ {
|
|
197
|
-
type: "delta";
|
|
198
|
-
text: string;
|
|
199
|
-
request_id: string; // uuid
|
|
200
|
-
} | {
|
|
201
|
-
type: "complete";
|
|
202
|
-
text: string;
|
|
203
|
-
request_id: string; // uuid
|
|
204
|
-
} | {
|
|
205
|
-
type: "error";
|
|
206
|
-
code: "UNAVAILABLE";
|
|
207
|
-
request_id: string; // uuid
|
|
208
|
-
};
|
|
209
|
-
export interface PublicWebsiteChat {
|
|
210
|
-
key: string;
|
|
211
|
-
organisationName: string;
|
|
212
|
-
assistantName: string;
|
|
213
|
-
defaultLocale: "en" | "de";
|
|
214
|
-
authentication?: {
|
|
215
|
-
email_code: boolean;
|
|
216
|
-
};
|
|
217
|
-
design?: {
|
|
218
|
-
id: string; // uuid
|
|
219
|
-
last_modified_at?: string;
|
|
220
|
-
style?: {
|
|
221
|
-
palette?: {
|
|
222
|
-
primary?: string;
|
|
223
|
-
background?: string;
|
|
224
|
-
};
|
|
225
|
-
typography?: {
|
|
226
|
-
font?: {
|
|
227
|
-
font_family?: string;
|
|
228
|
-
};
|
|
229
|
-
};
|
|
230
|
-
shape?: {
|
|
231
|
-
border_radius?: number;
|
|
232
|
-
};
|
|
233
|
-
};
|
|
234
|
-
spark_theme?: {
|
|
235
|
-
accentColor?: string;
|
|
236
|
-
backgroundColor?: string;
|
|
237
|
-
fontBody?: string;
|
|
238
|
-
fontHeading?: string;
|
|
239
|
-
radius?: string;
|
|
240
|
-
scaling?: string;
|
|
241
|
-
spacing?: string;
|
|
242
|
-
appearance?: string;
|
|
243
|
-
neutralColor?: string;
|
|
244
|
-
styleVariant?: string;
|
|
245
|
-
labelPosition?: string;
|
|
246
|
-
inputStyle?: string;
|
|
247
|
-
inputColor?: string;
|
|
248
|
-
cardVariant?: string;
|
|
249
|
-
cardColor?: string;
|
|
250
|
-
highContrast?: boolean;
|
|
251
|
-
};
|
|
252
|
-
};
|
|
253
|
-
locales: ("en" | "de")[];
|
|
254
|
-
}
|
|
255
|
-
export interface UpdateWebsiteChatRequest {
|
|
256
|
-
name?: string;
|
|
257
|
-
agent_id?: string | null; // uuid
|
|
258
|
-
settings?: {
|
|
259
|
-
/**
|
|
260
|
-
* Exact HTTPS origins. Empty means the Website Chat cannot start sessions.
|
|
261
|
-
*/
|
|
262
|
-
allowed_origins: [
|
|
263
|
-
string?,
|
|
264
|
-
string?,
|
|
265
|
-
string?,
|
|
266
|
-
string?,
|
|
267
|
-
string?,
|
|
268
|
-
string?,
|
|
269
|
-
string?,
|
|
270
|
-
string?,
|
|
271
|
-
string?,
|
|
272
|
-
string?,
|
|
273
|
-
string?,
|
|
274
|
-
string?,
|
|
275
|
-
string?,
|
|
276
|
-
string?,
|
|
277
|
-
string?,
|
|
278
|
-
string?,
|
|
279
|
-
string?,
|
|
280
|
-
string?,
|
|
281
|
-
string?,
|
|
282
|
-
string?,
|
|
283
|
-
string?,
|
|
284
|
-
string?,
|
|
285
|
-
string?,
|
|
286
|
-
string?,
|
|
287
|
-
string?,
|
|
288
|
-
string?,
|
|
289
|
-
string?,
|
|
290
|
-
string?,
|
|
291
|
-
string?,
|
|
292
|
-
string?,
|
|
293
|
-
string?,
|
|
294
|
-
string?,
|
|
295
|
-
string?,
|
|
296
|
-
string?,
|
|
297
|
-
string?,
|
|
298
|
-
string?,
|
|
299
|
-
string?,
|
|
300
|
-
string?,
|
|
301
|
-
string?,
|
|
302
|
-
string?,
|
|
303
|
-
string?,
|
|
304
|
-
string?,
|
|
305
|
-
string?,
|
|
306
|
-
string?,
|
|
307
|
-
string?,
|
|
308
|
-
string?,
|
|
309
|
-
string?,
|
|
310
|
-
string?,
|
|
311
|
-
string?,
|
|
312
|
-
string?
|
|
313
|
-
];
|
|
314
|
-
organisation_name: string;
|
|
315
|
-
default_locale: "en" | "de";
|
|
316
|
-
/**
|
|
317
|
-
* Design Builder configuration for the Website Chat only.
|
|
318
|
-
*/
|
|
319
|
-
design_id?: string | null; // uuid
|
|
320
|
-
/**
|
|
321
|
-
* Email Builder template selection. Does not enable verification by itself.
|
|
322
|
-
*/
|
|
323
|
-
authentication?: {
|
|
324
|
-
email_code: {
|
|
325
|
-
email_template_id?: string | null; // uuid
|
|
326
|
-
};
|
|
327
|
-
} | null;
|
|
328
|
-
};
|
|
329
|
-
/**
|
|
330
|
-
* Version read by the editor; stale writes return 409.
|
|
331
|
-
*/
|
|
332
|
-
version: number;
|
|
333
|
-
}
|
|
334
|
-
export interface VerificationState {
|
|
335
|
-
available: boolean;
|
|
336
|
-
conversation_id: string; // uuid
|
|
337
|
-
status: "anonymous" | "sending" | "pending" | "verified";
|
|
338
|
-
challenge_id?: string; // uuid
|
|
339
|
-
/**
|
|
340
|
-
* Unix seconds
|
|
341
|
-
*/
|
|
342
|
-
code_expires_at?: number;
|
|
343
|
-
/**
|
|
344
|
-
* Unix seconds
|
|
345
|
-
*/
|
|
346
|
-
resend_after?: number;
|
|
347
|
-
email?: string; // email
|
|
348
|
-
contact_resolution?: "matched" | "ambiguous" | "not_found";
|
|
349
|
-
}
|
|
350
|
-
export interface WebsiteChat {
|
|
351
|
-
name: string;
|
|
352
|
-
agent_id: string | null; // uuid
|
|
353
|
-
settings: {
|
|
354
|
-
/**
|
|
355
|
-
* Exact HTTPS origins. Empty means the Website Chat cannot start sessions.
|
|
356
|
-
*/
|
|
357
|
-
allowed_origins: [
|
|
358
|
-
string?,
|
|
359
|
-
string?,
|
|
360
|
-
string?,
|
|
361
|
-
string?,
|
|
362
|
-
string?,
|
|
363
|
-
string?,
|
|
364
|
-
string?,
|
|
365
|
-
string?,
|
|
366
|
-
string?,
|
|
367
|
-
string?,
|
|
368
|
-
string?,
|
|
369
|
-
string?,
|
|
370
|
-
string?,
|
|
371
|
-
string?,
|
|
372
|
-
string?,
|
|
373
|
-
string?,
|
|
374
|
-
string?,
|
|
375
|
-
string?,
|
|
376
|
-
string?,
|
|
377
|
-
string?,
|
|
378
|
-
string?,
|
|
379
|
-
string?,
|
|
380
|
-
string?,
|
|
381
|
-
string?,
|
|
382
|
-
string?,
|
|
383
|
-
string?,
|
|
384
|
-
string?,
|
|
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
|
-
];
|
|
409
|
-
organisation_name: string;
|
|
410
|
-
default_locale: "en" | "de";
|
|
411
|
-
/**
|
|
412
|
-
* Design Builder configuration for the Website Chat only.
|
|
413
|
-
*/
|
|
414
|
-
design_id?: string | null; // uuid
|
|
415
|
-
/**
|
|
416
|
-
* Email Builder template selection. Does not enable verification by itself.
|
|
417
|
-
*/
|
|
418
|
-
authentication?: {
|
|
419
|
-
email_code: {
|
|
420
|
-
email_template_id?: string | null; // uuid
|
|
421
|
-
};
|
|
422
|
-
} | null;
|
|
423
|
-
};
|
|
424
|
-
/**
|
|
425
|
-
* Stable public embed identifier, independent of the assigned agent. Not a credential.
|
|
426
|
-
*/
|
|
427
|
-
website_chat_id: string; // uuid
|
|
428
|
-
org_id: string;
|
|
429
|
-
/**
|
|
430
|
-
* Server-owned session binding; changes on reassignment or allowed-origin changes.
|
|
431
|
-
*/
|
|
432
|
-
binding_id: string; // uuid
|
|
433
|
-
version: number;
|
|
434
|
-
created_at: string; // date-time
|
|
435
|
-
updated_at: string; // date-time
|
|
436
|
-
embed: {
|
|
437
|
-
script_url: string; // uri
|
|
438
|
-
chat_api_origin: string; // uri
|
|
439
|
-
demo_url: string; // uri
|
|
440
|
-
};
|
|
441
|
-
}
|
|
442
|
-
export interface WebsiteChatDesign {
|
|
443
|
-
id: string; // uuid
|
|
444
|
-
last_modified_at?: string;
|
|
445
|
-
style?: {
|
|
446
|
-
palette?: {
|
|
447
|
-
primary?: string;
|
|
448
|
-
background?: string;
|
|
449
|
-
};
|
|
450
|
-
typography?: {
|
|
451
|
-
font?: {
|
|
452
|
-
font_family?: string;
|
|
453
|
-
};
|
|
454
|
-
};
|
|
455
|
-
shape?: {
|
|
456
|
-
border_radius?: number;
|
|
457
|
-
};
|
|
458
|
-
};
|
|
459
|
-
spark_theme?: {
|
|
460
|
-
accentColor?: string;
|
|
461
|
-
backgroundColor?: string;
|
|
462
|
-
fontBody?: string;
|
|
463
|
-
fontHeading?: string;
|
|
464
|
-
radius?: string;
|
|
465
|
-
scaling?: string;
|
|
466
|
-
spacing?: string;
|
|
467
|
-
appearance?: string;
|
|
468
|
-
neutralColor?: string;
|
|
469
|
-
styleVariant?: string;
|
|
470
|
-
labelPosition?: string;
|
|
471
|
-
inputStyle?: string;
|
|
472
|
-
inputColor?: string;
|
|
473
|
-
cardVariant?: string;
|
|
474
|
-
cardColor?: string;
|
|
475
|
-
highContrast?: boolean;
|
|
476
|
-
};
|
|
477
|
-
}
|
|
478
|
-
export interface WebsiteChatSettings {
|
|
479
|
-
/**
|
|
480
|
-
* Exact HTTPS origins. Empty means the Website Chat cannot start sessions.
|
|
481
|
-
*/
|
|
482
|
-
allowed_origins: [
|
|
483
|
-
string?,
|
|
484
|
-
string?,
|
|
485
|
-
string?,
|
|
486
|
-
string?,
|
|
487
|
-
string?,
|
|
488
|
-
string?,
|
|
489
|
-
string?,
|
|
490
|
-
string?,
|
|
491
|
-
string?,
|
|
492
|
-
string?,
|
|
493
|
-
string?,
|
|
494
|
-
string?,
|
|
495
|
-
string?,
|
|
496
|
-
string?,
|
|
497
|
-
string?,
|
|
498
|
-
string?,
|
|
499
|
-
string?,
|
|
500
|
-
string?,
|
|
501
|
-
string?,
|
|
502
|
-
string?,
|
|
503
|
-
string?,
|
|
504
|
-
string?,
|
|
505
|
-
string?,
|
|
506
|
-
string?,
|
|
507
|
-
string?,
|
|
508
|
-
string?,
|
|
509
|
-
string?,
|
|
510
|
-
string?,
|
|
511
|
-
string?,
|
|
512
|
-
string?,
|
|
513
|
-
string?,
|
|
514
|
-
string?,
|
|
515
|
-
string?,
|
|
516
|
-
string?,
|
|
517
|
-
string?,
|
|
518
|
-
string?,
|
|
519
|
-
string?,
|
|
520
|
-
string?,
|
|
521
|
-
string?,
|
|
522
|
-
string?,
|
|
523
|
-
string?,
|
|
524
|
-
string?,
|
|
525
|
-
string?,
|
|
526
|
-
string?,
|
|
527
|
-
string?,
|
|
528
|
-
string?,
|
|
529
|
-
string?,
|
|
530
|
-
string?,
|
|
531
|
-
string?,
|
|
532
|
-
string?
|
|
533
|
-
];
|
|
534
|
-
organisation_name: string;
|
|
535
|
-
default_locale: "en" | "de";
|
|
536
|
-
/**
|
|
537
|
-
* Design Builder configuration for the Website Chat only.
|
|
538
|
-
*/
|
|
539
|
-
design_id?: string | null; // uuid
|
|
540
|
-
/**
|
|
541
|
-
* Email Builder template selection. Does not enable verification by itself.
|
|
542
|
-
*/
|
|
543
|
-
authentication?: {
|
|
544
|
-
email_code: {
|
|
545
|
-
email_template_id?: string | null; // uuid
|
|
546
|
-
};
|
|
547
|
-
} | null;
|
|
548
|
-
}
|
|
549
|
-
}
|
|
550
|
-
}
|
|
551
|
-
declare namespace Paths {
|
|
552
|
-
namespace CancelChatVerification {
|
|
553
|
-
namespace Responses {
|
|
554
|
-
export interface $200 {
|
|
555
|
-
available: boolean;
|
|
556
|
-
conversation_id: string; // uuid
|
|
557
|
-
status: "anonymous" | "sending" | "pending" | "verified";
|
|
558
|
-
challenge_id?: string; // uuid
|
|
559
|
-
/**
|
|
560
|
-
* Unix seconds
|
|
561
|
-
*/
|
|
562
|
-
code_expires_at?: number;
|
|
563
|
-
/**
|
|
564
|
-
* Unix seconds
|
|
565
|
-
*/
|
|
566
|
-
resend_after?: number;
|
|
567
|
-
email?: string; // email
|
|
568
|
-
contact_resolution?: "matched" | "ambiguous" | "not_found";
|
|
569
|
-
}
|
|
570
|
-
export interface Default {
|
|
571
|
-
code: "INVALID_VERIFICATION_CODE" | "VERIFICATION_EXPIRED" | "VERIFICATION_CONFLICT" | "VERIFICATION_DISABLED" | "VERIFICATION_UNAVAILABLE" | "IDENTITY_CHANGED" | "INVALID_REQUEST" | "ORIGIN_DENIED" | "NOT_FOUND" | "INVALID_GRANT" | "SESSION_EXPIRED" | "RATE_LIMITED" | "SESSION_LIMIT" | "USAGE_LIMIT" | "REQUEST_CONFLICT" | "IN_PROGRESS" | "UNAVAILABLE" | "TEMPORARILY_UNAVAILABLE";
|
|
572
|
-
}
|
|
573
|
-
}
|
|
574
|
-
}
|
|
575
|
-
namespace CreateAnonymousChatSession {
|
|
576
|
-
export interface RequestBody {
|
|
577
|
-
grant: string; // ^[A-Za-z0-9_-]{43}$
|
|
578
|
-
}
|
|
579
|
-
namespace Responses {
|
|
580
|
-
export interface $201 {
|
|
581
|
-
token: string;
|
|
582
|
-
conversation_id: string; // uuid
|
|
583
|
-
/**
|
|
584
|
-
* Unix seconds
|
|
585
|
-
*/
|
|
586
|
-
expires_at: number;
|
|
587
|
-
website_chat: {
|
|
588
|
-
key: string;
|
|
589
|
-
organisationName: string;
|
|
590
|
-
assistantName: string;
|
|
591
|
-
defaultLocale: "en" | "de";
|
|
592
|
-
authentication?: {
|
|
593
|
-
email_code: boolean;
|
|
594
|
-
};
|
|
595
|
-
design?: {
|
|
596
|
-
id: string; // uuid
|
|
597
|
-
last_modified_at?: string;
|
|
598
|
-
style?: {
|
|
599
|
-
palette?: {
|
|
600
|
-
primary?: string;
|
|
601
|
-
background?: string;
|
|
602
|
-
};
|
|
603
|
-
typography?: {
|
|
604
|
-
font?: {
|
|
605
|
-
font_family?: string;
|
|
606
|
-
};
|
|
607
|
-
};
|
|
608
|
-
shape?: {
|
|
609
|
-
border_radius?: number;
|
|
610
|
-
};
|
|
611
|
-
};
|
|
612
|
-
spark_theme?: {
|
|
613
|
-
accentColor?: string;
|
|
614
|
-
backgroundColor?: string;
|
|
615
|
-
fontBody?: string;
|
|
616
|
-
fontHeading?: string;
|
|
617
|
-
radius?: string;
|
|
618
|
-
scaling?: string;
|
|
619
|
-
spacing?: string;
|
|
620
|
-
appearance?: string;
|
|
621
|
-
neutralColor?: string;
|
|
622
|
-
styleVariant?: string;
|
|
623
|
-
labelPosition?: string;
|
|
624
|
-
inputStyle?: string;
|
|
625
|
-
inputColor?: string;
|
|
626
|
-
cardVariant?: string;
|
|
627
|
-
cardColor?: string;
|
|
628
|
-
highContrast?: boolean;
|
|
629
|
-
};
|
|
630
|
-
};
|
|
631
|
-
locales: ("en" | "de")[];
|
|
632
|
-
};
|
|
633
|
-
}
|
|
634
|
-
export interface Default {
|
|
635
|
-
code: "INVALID_VERIFICATION_CODE" | "VERIFICATION_EXPIRED" | "VERIFICATION_CONFLICT" | "VERIFICATION_DISABLED" | "VERIFICATION_UNAVAILABLE" | "IDENTITY_CHANGED" | "INVALID_REQUEST" | "ORIGIN_DENIED" | "NOT_FOUND" | "INVALID_GRANT" | "SESSION_EXPIRED" | "RATE_LIMITED" | "SESSION_LIMIT" | "USAGE_LIMIT" | "REQUEST_CONFLICT" | "IN_PROGRESS" | "UNAVAILABLE" | "TEMPORARILY_UNAVAILABLE";
|
|
636
|
-
}
|
|
637
|
-
}
|
|
638
|
-
}
|
|
639
|
-
namespace CreatePublicChatGrant {
|
|
640
|
-
export interface RequestBody {
|
|
641
|
-
website_chat_id: string; // ^[a-zA-Z0-9_-]{1,100}$
|
|
642
|
-
}
|
|
643
|
-
namespace Responses {
|
|
644
|
-
export interface $201 {
|
|
645
|
-
grant: string;
|
|
646
|
-
/**
|
|
647
|
-
* example:
|
|
648
|
-
* 60
|
|
649
|
-
*/
|
|
650
|
-
expires_in: number;
|
|
651
|
-
frame_origin: string; // uri
|
|
652
|
-
}
|
|
653
|
-
export interface Default {
|
|
654
|
-
code: "INVALID_VERIFICATION_CODE" | "VERIFICATION_EXPIRED" | "VERIFICATION_CONFLICT" | "VERIFICATION_DISABLED" | "VERIFICATION_UNAVAILABLE" | "IDENTITY_CHANGED" | "INVALID_REQUEST" | "ORIGIN_DENIED" | "NOT_FOUND" | "INVALID_GRANT" | "SESSION_EXPIRED" | "RATE_LIMITED" | "SESSION_LIMIT" | "USAGE_LIMIT" | "REQUEST_CONFLICT" | "IN_PROGRESS" | "UNAVAILABLE" | "TEMPORARILY_UNAVAILABLE";
|
|
655
|
-
}
|
|
656
|
-
}
|
|
657
|
-
}
|
|
658
|
-
namespace CreateWebsiteChat {
|
|
659
|
-
export interface RequestBody {
|
|
660
|
-
name: string;
|
|
661
|
-
agent_id: string | null; // uuid
|
|
662
|
-
settings: {
|
|
663
|
-
/**
|
|
664
|
-
* Exact HTTPS origins. Empty means the Website Chat cannot start sessions.
|
|
665
|
-
*/
|
|
666
|
-
allowed_origins: [
|
|
667
|
-
string?,
|
|
668
|
-
string?,
|
|
669
|
-
string?,
|
|
670
|
-
string?,
|
|
671
|
-
string?,
|
|
672
|
-
string?,
|
|
673
|
-
string?,
|
|
674
|
-
string?,
|
|
675
|
-
string?,
|
|
676
|
-
string?,
|
|
677
|
-
string?,
|
|
678
|
-
string?,
|
|
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
|
-
];
|
|
718
|
-
organisation_name: string;
|
|
719
|
-
default_locale: "en" | "de";
|
|
720
|
-
/**
|
|
721
|
-
* Design Builder configuration for the Website Chat only.
|
|
722
|
-
*/
|
|
723
|
-
design_id?: string | null; // uuid
|
|
724
|
-
/**
|
|
725
|
-
* Email Builder template selection. Does not enable verification by itself.
|
|
726
|
-
*/
|
|
727
|
-
authentication?: {
|
|
728
|
-
email_code: {
|
|
729
|
-
email_template_id?: string | null; // uuid
|
|
730
|
-
};
|
|
731
|
-
} | null;
|
|
732
|
-
};
|
|
733
|
-
}
|
|
734
|
-
namespace Responses {
|
|
735
|
-
export interface $201 {
|
|
736
|
-
name: string;
|
|
737
|
-
agent_id: string | null; // uuid
|
|
738
|
-
settings: {
|
|
739
|
-
/**
|
|
740
|
-
* Exact HTTPS origins. Empty means the Website Chat cannot start sessions.
|
|
741
|
-
*/
|
|
742
|
-
allowed_origins: [
|
|
743
|
-
string?,
|
|
744
|
-
string?,
|
|
745
|
-
string?,
|
|
746
|
-
string?,
|
|
747
|
-
string?,
|
|
748
|
-
string?,
|
|
749
|
-
string?,
|
|
750
|
-
string?,
|
|
751
|
-
string?,
|
|
752
|
-
string?,
|
|
753
|
-
string?,
|
|
754
|
-
string?,
|
|
755
|
-
string?,
|
|
756
|
-
string?,
|
|
757
|
-
string?,
|
|
758
|
-
string?,
|
|
759
|
-
string?,
|
|
760
|
-
string?,
|
|
761
|
-
string?,
|
|
762
|
-
string?,
|
|
763
|
-
string?,
|
|
764
|
-
string?,
|
|
765
|
-
string?,
|
|
766
|
-
string?,
|
|
767
|
-
string?,
|
|
768
|
-
string?,
|
|
769
|
-
string?,
|
|
770
|
-
string?,
|
|
771
|
-
string?,
|
|
772
|
-
string?,
|
|
773
|
-
string?,
|
|
774
|
-
string?,
|
|
775
|
-
string?,
|
|
776
|
-
string?,
|
|
777
|
-
string?,
|
|
778
|
-
string?,
|
|
779
|
-
string?,
|
|
780
|
-
string?,
|
|
781
|
-
string?,
|
|
782
|
-
string?,
|
|
783
|
-
string?,
|
|
784
|
-
string?,
|
|
785
|
-
string?,
|
|
786
|
-
string?,
|
|
787
|
-
string?,
|
|
788
|
-
string?,
|
|
789
|
-
string?,
|
|
790
|
-
string?,
|
|
791
|
-
string?,
|
|
792
|
-
string?
|
|
793
|
-
];
|
|
794
|
-
organisation_name: string;
|
|
795
|
-
default_locale: "en" | "de";
|
|
796
|
-
/**
|
|
797
|
-
* Design Builder configuration for the Website Chat only.
|
|
798
|
-
*/
|
|
799
|
-
design_id?: string | null; // uuid
|
|
800
|
-
/**
|
|
801
|
-
* Email Builder template selection. Does not enable verification by itself.
|
|
802
|
-
*/
|
|
803
|
-
authentication?: {
|
|
804
|
-
email_code: {
|
|
805
|
-
email_template_id?: string | null; // uuid
|
|
806
|
-
};
|
|
807
|
-
} | null;
|
|
808
|
-
};
|
|
809
|
-
/**
|
|
810
|
-
* Stable public embed identifier, independent of the assigned agent. Not a credential.
|
|
811
|
-
*/
|
|
812
|
-
website_chat_id: string; // uuid
|
|
813
|
-
org_id: string;
|
|
814
|
-
/**
|
|
815
|
-
* Server-owned session binding; changes on reassignment or allowed-origin changes.
|
|
816
|
-
*/
|
|
817
|
-
binding_id: string; // uuid
|
|
818
|
-
version: number;
|
|
819
|
-
created_at: string; // date-time
|
|
820
|
-
updated_at: string; // date-time
|
|
821
|
-
embed: {
|
|
822
|
-
script_url: string; // uri
|
|
823
|
-
chat_api_origin: string; // uri
|
|
824
|
-
demo_url: string; // uri
|
|
825
|
-
};
|
|
826
|
-
}
|
|
827
|
-
export interface $400 {
|
|
828
|
-
error?: string;
|
|
829
|
-
message?: string;
|
|
830
|
-
details?: {
|
|
831
|
-
[key: string]: any;
|
|
832
|
-
};
|
|
833
|
-
}
|
|
834
|
-
export interface $404 {
|
|
835
|
-
error?: string;
|
|
836
|
-
message?: string;
|
|
837
|
-
details?: {
|
|
838
|
-
[key: string]: any;
|
|
839
|
-
};
|
|
840
|
-
}
|
|
841
|
-
export interface $409 {
|
|
842
|
-
error?: string;
|
|
843
|
-
message?: string;
|
|
844
|
-
details?: {
|
|
845
|
-
[key: string]: any;
|
|
846
|
-
};
|
|
847
|
-
}
|
|
848
|
-
}
|
|
849
|
-
}
|
|
850
|
-
namespace DeleteWebsiteChat {
|
|
851
|
-
namespace Parameters {
|
|
852
|
-
export type Version = number;
|
|
853
|
-
}
|
|
854
|
-
export interface QueryParameters {
|
|
855
|
-
version: Parameters.Version;
|
|
856
|
-
}
|
|
857
|
-
namespace Responses {
|
|
858
|
-
export interface $204 {
|
|
859
|
-
}
|
|
860
|
-
export interface $400 {
|
|
861
|
-
error?: string;
|
|
862
|
-
message?: string;
|
|
863
|
-
details?: {
|
|
864
|
-
[key: string]: any;
|
|
865
|
-
};
|
|
866
|
-
}
|
|
867
|
-
export interface $404 {
|
|
868
|
-
error?: string;
|
|
869
|
-
message?: string;
|
|
870
|
-
details?: {
|
|
871
|
-
[key: string]: any;
|
|
872
|
-
};
|
|
873
|
-
}
|
|
874
|
-
export interface $409 {
|
|
875
|
-
error?: string;
|
|
876
|
-
message?: string;
|
|
877
|
-
details?: {
|
|
878
|
-
[key: string]: any;
|
|
879
|
-
};
|
|
880
|
-
}
|
|
881
|
-
}
|
|
882
|
-
}
|
|
883
|
-
namespace GetChatVerification {
|
|
884
|
-
namespace Responses {
|
|
885
|
-
export interface $200 {
|
|
886
|
-
available: boolean;
|
|
887
|
-
conversation_id: string; // uuid
|
|
888
|
-
status: "anonymous" | "sending" | "pending" | "verified";
|
|
889
|
-
challenge_id?: string; // uuid
|
|
890
|
-
/**
|
|
891
|
-
* Unix seconds
|
|
892
|
-
*/
|
|
893
|
-
code_expires_at?: number;
|
|
894
|
-
/**
|
|
895
|
-
* Unix seconds
|
|
896
|
-
*/
|
|
897
|
-
resend_after?: number;
|
|
898
|
-
email?: string; // email
|
|
899
|
-
contact_resolution?: "matched" | "ambiguous" | "not_found";
|
|
900
|
-
}
|
|
901
|
-
export interface Default {
|
|
902
|
-
code: "INVALID_VERIFICATION_CODE" | "VERIFICATION_EXPIRED" | "VERIFICATION_CONFLICT" | "VERIFICATION_DISABLED" | "VERIFICATION_UNAVAILABLE" | "IDENTITY_CHANGED" | "INVALID_REQUEST" | "ORIGIN_DENIED" | "NOT_FOUND" | "INVALID_GRANT" | "SESSION_EXPIRED" | "RATE_LIMITED" | "SESSION_LIMIT" | "USAGE_LIMIT" | "REQUEST_CONFLICT" | "IN_PROGRESS" | "UNAVAILABLE" | "TEMPORARILY_UNAVAILABLE";
|
|
903
|
-
}
|
|
904
|
-
}
|
|
905
|
-
}
|
|
906
|
-
namespace GetPublicWebsiteChat {
|
|
907
|
-
namespace Parameters {
|
|
908
|
-
export type WebsiteChatId = string; // ^[a-zA-Z0-9_-]{1,100}$
|
|
909
|
-
}
|
|
910
|
-
export interface PathParameters {
|
|
911
|
-
website_chat_id: Parameters.WebsiteChatId /* ^[a-zA-Z0-9_-]{1,100}$ */;
|
|
912
|
-
}
|
|
913
|
-
namespace Responses {
|
|
914
|
-
export interface $200 {
|
|
915
|
-
key: string;
|
|
916
|
-
organisationName: string;
|
|
917
|
-
assistantName: string;
|
|
918
|
-
defaultLocale: "en" | "de";
|
|
919
|
-
authentication?: {
|
|
920
|
-
email_code: boolean;
|
|
921
|
-
};
|
|
922
|
-
design?: {
|
|
923
|
-
id: string; // uuid
|
|
924
|
-
last_modified_at?: string;
|
|
925
|
-
style?: {
|
|
926
|
-
palette?: {
|
|
927
|
-
primary?: string;
|
|
928
|
-
background?: string;
|
|
929
|
-
};
|
|
930
|
-
typography?: {
|
|
931
|
-
font?: {
|
|
932
|
-
font_family?: string;
|
|
933
|
-
};
|
|
934
|
-
};
|
|
935
|
-
shape?: {
|
|
936
|
-
border_radius?: number;
|
|
937
|
-
};
|
|
938
|
-
};
|
|
939
|
-
spark_theme?: {
|
|
940
|
-
accentColor?: string;
|
|
941
|
-
backgroundColor?: string;
|
|
942
|
-
fontBody?: string;
|
|
943
|
-
fontHeading?: string;
|
|
944
|
-
radius?: string;
|
|
945
|
-
scaling?: string;
|
|
946
|
-
spacing?: string;
|
|
947
|
-
appearance?: string;
|
|
948
|
-
neutralColor?: string;
|
|
949
|
-
styleVariant?: string;
|
|
950
|
-
labelPosition?: string;
|
|
951
|
-
inputStyle?: string;
|
|
952
|
-
inputColor?: string;
|
|
953
|
-
cardVariant?: string;
|
|
954
|
-
cardColor?: string;
|
|
955
|
-
highContrast?: boolean;
|
|
956
|
-
};
|
|
957
|
-
};
|
|
958
|
-
locales: ("en" | "de")[];
|
|
959
|
-
}
|
|
960
|
-
export interface Default {
|
|
961
|
-
code: "INVALID_VERIFICATION_CODE" | "VERIFICATION_EXPIRED" | "VERIFICATION_CONFLICT" | "VERIFICATION_DISABLED" | "VERIFICATION_UNAVAILABLE" | "IDENTITY_CHANGED" | "INVALID_REQUEST" | "ORIGIN_DENIED" | "NOT_FOUND" | "INVALID_GRANT" | "SESSION_EXPIRED" | "RATE_LIMITED" | "SESSION_LIMIT" | "USAGE_LIMIT" | "REQUEST_CONFLICT" | "IN_PROGRESS" | "UNAVAILABLE" | "TEMPORARILY_UNAVAILABLE";
|
|
962
|
-
}
|
|
963
|
-
}
|
|
964
|
-
}
|
|
965
|
-
namespace GetWebsiteChat {
|
|
966
|
-
namespace Responses {
|
|
967
|
-
export interface $200 {
|
|
968
|
-
name: string;
|
|
969
|
-
agent_id: string | null; // uuid
|
|
970
|
-
settings: {
|
|
971
|
-
/**
|
|
972
|
-
* Exact HTTPS origins. Empty means the Website Chat cannot start sessions.
|
|
973
|
-
*/
|
|
974
|
-
allowed_origins: [
|
|
975
|
-
string?,
|
|
976
|
-
string?,
|
|
977
|
-
string?,
|
|
978
|
-
string?,
|
|
979
|
-
string?,
|
|
980
|
-
string?,
|
|
981
|
-
string?,
|
|
982
|
-
string?,
|
|
983
|
-
string?,
|
|
984
|
-
string?,
|
|
985
|
-
string?,
|
|
986
|
-
string?,
|
|
987
|
-
string?,
|
|
988
|
-
string?,
|
|
989
|
-
string?,
|
|
990
|
-
string?,
|
|
991
|
-
string?,
|
|
992
|
-
string?,
|
|
993
|
-
string?,
|
|
994
|
-
string?,
|
|
995
|
-
string?,
|
|
996
|
-
string?,
|
|
997
|
-
string?,
|
|
998
|
-
string?,
|
|
999
|
-
string?,
|
|
1000
|
-
string?,
|
|
1001
|
-
string?,
|
|
1002
|
-
string?,
|
|
1003
|
-
string?,
|
|
1004
|
-
string?,
|
|
1005
|
-
string?,
|
|
1006
|
-
string?,
|
|
1007
|
-
string?,
|
|
1008
|
-
string?,
|
|
1009
|
-
string?,
|
|
1010
|
-
string?,
|
|
1011
|
-
string?,
|
|
1012
|
-
string?,
|
|
1013
|
-
string?,
|
|
1014
|
-
string?,
|
|
1015
|
-
string?,
|
|
1016
|
-
string?,
|
|
1017
|
-
string?,
|
|
1018
|
-
string?,
|
|
1019
|
-
string?,
|
|
1020
|
-
string?,
|
|
1021
|
-
string?,
|
|
1022
|
-
string?,
|
|
1023
|
-
string?,
|
|
1024
|
-
string?
|
|
1025
|
-
];
|
|
1026
|
-
organisation_name: string;
|
|
1027
|
-
default_locale: "en" | "de";
|
|
1028
|
-
/**
|
|
1029
|
-
* Design Builder configuration for the Website Chat only.
|
|
1030
|
-
*/
|
|
1031
|
-
design_id?: string | null; // uuid
|
|
1032
|
-
/**
|
|
1033
|
-
* Email Builder template selection. Does not enable verification by itself.
|
|
1034
|
-
*/
|
|
1035
|
-
authentication?: {
|
|
1036
|
-
email_code: {
|
|
1037
|
-
email_template_id?: string | null; // uuid
|
|
1038
|
-
};
|
|
1039
|
-
} | null;
|
|
1040
|
-
};
|
|
1041
|
-
/**
|
|
1042
|
-
* Stable public embed identifier, independent of the assigned agent. Not a credential.
|
|
1043
|
-
*/
|
|
1044
|
-
website_chat_id: string; // uuid
|
|
1045
|
-
org_id: string;
|
|
1046
|
-
/**
|
|
1047
|
-
* Server-owned session binding; changes on reassignment or allowed-origin changes.
|
|
1048
|
-
*/
|
|
1049
|
-
binding_id: string; // uuid
|
|
1050
|
-
version: number;
|
|
1051
|
-
created_at: string; // date-time
|
|
1052
|
-
updated_at: string; // date-time
|
|
1053
|
-
embed: {
|
|
1054
|
-
script_url: string; // uri
|
|
1055
|
-
chat_api_origin: string; // uri
|
|
1056
|
-
demo_url: string; // uri
|
|
1057
|
-
};
|
|
1058
|
-
}
|
|
1059
|
-
export interface $400 {
|
|
1060
|
-
error?: string;
|
|
1061
|
-
message?: string;
|
|
1062
|
-
details?: {
|
|
1063
|
-
[key: string]: any;
|
|
1064
|
-
};
|
|
1065
|
-
}
|
|
1066
|
-
export interface $404 {
|
|
1067
|
-
error?: string;
|
|
1068
|
-
message?: string;
|
|
1069
|
-
details?: {
|
|
1070
|
-
[key: string]: any;
|
|
1071
|
-
};
|
|
1072
|
-
}
|
|
1073
|
-
export interface $409 {
|
|
1074
|
-
error?: string;
|
|
1075
|
-
message?: string;
|
|
1076
|
-
details?: {
|
|
1077
|
-
[key: string]: any;
|
|
1078
|
-
};
|
|
1079
|
-
}
|
|
1080
|
-
}
|
|
1081
|
-
}
|
|
1082
|
-
namespace ListWebsiteChats {
|
|
1083
|
-
namespace Parameters {
|
|
1084
|
-
export type Cursor = string;
|
|
1085
|
-
}
|
|
1086
|
-
export interface QueryParameters {
|
|
1087
|
-
cursor?: Parameters.Cursor;
|
|
1088
|
-
}
|
|
1089
|
-
namespace Responses {
|
|
1090
|
-
export interface $200 {
|
|
1091
|
-
website_chats: {
|
|
1092
|
-
name: string;
|
|
1093
|
-
agent_id: string | null; // uuid
|
|
1094
|
-
settings: {
|
|
1095
|
-
/**
|
|
1096
|
-
* Exact HTTPS origins. Empty means the Website Chat cannot start sessions.
|
|
1097
|
-
*/
|
|
1098
|
-
allowed_origins: [
|
|
1099
|
-
string?,
|
|
1100
|
-
string?,
|
|
1101
|
-
string?,
|
|
1102
|
-
string?,
|
|
1103
|
-
string?,
|
|
1104
|
-
string?,
|
|
1105
|
-
string?,
|
|
1106
|
-
string?,
|
|
1107
|
-
string?,
|
|
1108
|
-
string?,
|
|
1109
|
-
string?,
|
|
1110
|
-
string?,
|
|
1111
|
-
string?,
|
|
1112
|
-
string?,
|
|
1113
|
-
string?,
|
|
1114
|
-
string?,
|
|
1115
|
-
string?,
|
|
1116
|
-
string?,
|
|
1117
|
-
string?,
|
|
1118
|
-
string?,
|
|
1119
|
-
string?,
|
|
1120
|
-
string?,
|
|
1121
|
-
string?,
|
|
1122
|
-
string?,
|
|
1123
|
-
string?,
|
|
1124
|
-
string?,
|
|
1125
|
-
string?,
|
|
1126
|
-
string?,
|
|
1127
|
-
string?,
|
|
1128
|
-
string?,
|
|
1129
|
-
string?,
|
|
1130
|
-
string?,
|
|
1131
|
-
string?,
|
|
1132
|
-
string?,
|
|
1133
|
-
string?,
|
|
1134
|
-
string?,
|
|
1135
|
-
string?,
|
|
1136
|
-
string?,
|
|
1137
|
-
string?,
|
|
1138
|
-
string?,
|
|
1139
|
-
string?,
|
|
1140
|
-
string?,
|
|
1141
|
-
string?,
|
|
1142
|
-
string?,
|
|
1143
|
-
string?,
|
|
1144
|
-
string?,
|
|
1145
|
-
string?,
|
|
1146
|
-
string?,
|
|
1147
|
-
string?,
|
|
1148
|
-
string?
|
|
1149
|
-
];
|
|
1150
|
-
organisation_name: string;
|
|
1151
|
-
default_locale: "en" | "de";
|
|
1152
|
-
/**
|
|
1153
|
-
* Design Builder configuration for the Website Chat only.
|
|
1154
|
-
*/
|
|
1155
|
-
design_id?: string | null; // uuid
|
|
1156
|
-
/**
|
|
1157
|
-
* Email Builder template selection. Does not enable verification by itself.
|
|
1158
|
-
*/
|
|
1159
|
-
authentication?: {
|
|
1160
|
-
email_code: {
|
|
1161
|
-
email_template_id?: string | null; // uuid
|
|
1162
|
-
};
|
|
1163
|
-
} | null;
|
|
1164
|
-
};
|
|
1165
|
-
/**
|
|
1166
|
-
* Stable public embed identifier, independent of the assigned agent. Not a credential.
|
|
1167
|
-
*/
|
|
1168
|
-
website_chat_id: string; // uuid
|
|
1169
|
-
org_id: string;
|
|
1170
|
-
/**
|
|
1171
|
-
* Server-owned session binding; changes on reassignment or allowed-origin changes.
|
|
1172
|
-
*/
|
|
1173
|
-
binding_id: string; // uuid
|
|
1174
|
-
version: number;
|
|
1175
|
-
created_at: string; // date-time
|
|
1176
|
-
updated_at: string; // date-time
|
|
1177
|
-
embed: {
|
|
1178
|
-
script_url: string; // uri
|
|
1179
|
-
chat_api_origin: string; // uri
|
|
1180
|
-
demo_url: string; // uri
|
|
1181
|
-
};
|
|
1182
|
-
}[];
|
|
1183
|
-
next_cursor?: string;
|
|
1184
|
-
}
|
|
1185
|
-
export interface $400 {
|
|
1186
|
-
error?: string;
|
|
1187
|
-
message?: string;
|
|
1188
|
-
details?: {
|
|
1189
|
-
[key: string]: any;
|
|
1190
|
-
};
|
|
1191
|
-
}
|
|
1192
|
-
export interface $404 {
|
|
1193
|
-
error?: string;
|
|
1194
|
-
message?: string;
|
|
1195
|
-
details?: {
|
|
1196
|
-
[key: string]: any;
|
|
1197
|
-
};
|
|
1198
|
-
}
|
|
1199
|
-
export interface $409 {
|
|
1200
|
-
error?: string;
|
|
1201
|
-
message?: string;
|
|
1202
|
-
details?: {
|
|
1203
|
-
[key: string]: any;
|
|
1204
|
-
};
|
|
1205
|
-
}
|
|
1206
|
-
}
|
|
1207
|
-
}
|
|
1208
|
-
namespace SendAnonymousChatMessage {
|
|
1209
|
-
export interface RequestBody {
|
|
1210
|
-
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}$
|
|
1211
|
-
message: string; // \S
|
|
1212
|
-
locale: "en" | "de";
|
|
1213
|
-
simple_language: boolean;
|
|
1214
|
-
}
|
|
1215
|
-
namespace Responses {
|
|
1216
|
-
export type $200 = string;
|
|
1217
|
-
export interface Default {
|
|
1218
|
-
code: "INVALID_VERIFICATION_CODE" | "VERIFICATION_EXPIRED" | "VERIFICATION_CONFLICT" | "VERIFICATION_DISABLED" | "VERIFICATION_UNAVAILABLE" | "IDENTITY_CHANGED" | "INVALID_REQUEST" | "ORIGIN_DENIED" | "NOT_FOUND" | "INVALID_GRANT" | "SESSION_EXPIRED" | "RATE_LIMITED" | "SESSION_LIMIT" | "USAGE_LIMIT" | "REQUEST_CONFLICT" | "IN_PROGRESS" | "UNAVAILABLE" | "TEMPORARILY_UNAVAILABLE";
|
|
1219
|
-
}
|
|
1220
|
-
}
|
|
1221
|
-
}
|
|
1222
|
-
namespace StartChatEmailVerification {
|
|
1223
|
-
export interface RequestBody {
|
|
1224
|
-
request_id: string; // uuid
|
|
1225
|
-
email: string; // email
|
|
1226
|
-
locale: "en" | "de";
|
|
1227
|
-
}
|
|
1228
|
-
namespace Responses {
|
|
1229
|
-
export interface $200 {
|
|
1230
|
-
available: boolean;
|
|
1231
|
-
conversation_id: string; // uuid
|
|
1232
|
-
status: "anonymous" | "sending" | "pending" | "verified";
|
|
1233
|
-
challenge_id?: string; // uuid
|
|
1234
|
-
/**
|
|
1235
|
-
* Unix seconds
|
|
1236
|
-
*/
|
|
1237
|
-
code_expires_at?: number;
|
|
1238
|
-
/**
|
|
1239
|
-
* Unix seconds
|
|
1240
|
-
*/
|
|
1241
|
-
resend_after?: number;
|
|
1242
|
-
email?: string; // email
|
|
1243
|
-
contact_resolution?: "matched" | "ambiguous" | "not_found";
|
|
1244
|
-
}
|
|
1245
|
-
export interface Default {
|
|
1246
|
-
code: "INVALID_VERIFICATION_CODE" | "VERIFICATION_EXPIRED" | "VERIFICATION_CONFLICT" | "VERIFICATION_DISABLED" | "VERIFICATION_UNAVAILABLE" | "IDENTITY_CHANGED" | "INVALID_REQUEST" | "ORIGIN_DENIED" | "NOT_FOUND" | "INVALID_GRANT" | "SESSION_EXPIRED" | "RATE_LIMITED" | "SESSION_LIMIT" | "USAGE_LIMIT" | "REQUEST_CONFLICT" | "IN_PROGRESS" | "UNAVAILABLE" | "TEMPORARILY_UNAVAILABLE";
|
|
1247
|
-
}
|
|
1248
|
-
}
|
|
1249
|
-
}
|
|
1250
|
-
namespace UpdateWebsiteChat {
|
|
1251
|
-
export interface RequestBody {
|
|
1252
|
-
name?: string;
|
|
1253
|
-
agent_id?: string | null; // uuid
|
|
1254
|
-
settings?: {
|
|
1255
|
-
/**
|
|
1256
|
-
* Exact HTTPS origins. Empty means the Website Chat cannot start sessions.
|
|
1257
|
-
*/
|
|
1258
|
-
allowed_origins: [
|
|
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
|
-
string?,
|
|
1291
|
-
string?,
|
|
1292
|
-
string?,
|
|
1293
|
-
string?,
|
|
1294
|
-
string?,
|
|
1295
|
-
string?,
|
|
1296
|
-
string?,
|
|
1297
|
-
string?,
|
|
1298
|
-
string?,
|
|
1299
|
-
string?,
|
|
1300
|
-
string?,
|
|
1301
|
-
string?,
|
|
1302
|
-
string?,
|
|
1303
|
-
string?,
|
|
1304
|
-
string?,
|
|
1305
|
-
string?,
|
|
1306
|
-
string?,
|
|
1307
|
-
string?,
|
|
1308
|
-
string?
|
|
1309
|
-
];
|
|
1310
|
-
organisation_name: string;
|
|
1311
|
-
default_locale: "en" | "de";
|
|
1312
|
-
/**
|
|
1313
|
-
* Design Builder configuration for the Website Chat only.
|
|
1314
|
-
*/
|
|
1315
|
-
design_id?: string | null; // uuid
|
|
1316
|
-
/**
|
|
1317
|
-
* Email Builder template selection. Does not enable verification by itself.
|
|
1318
|
-
*/
|
|
1319
|
-
authentication?: {
|
|
1320
|
-
email_code: {
|
|
1321
|
-
email_template_id?: string | null; // uuid
|
|
1322
|
-
};
|
|
1323
|
-
} | null;
|
|
1324
|
-
};
|
|
1325
|
-
/**
|
|
1326
|
-
* Version read by the editor; stale writes return 409.
|
|
1327
|
-
*/
|
|
1328
|
-
version: number;
|
|
1329
|
-
}
|
|
1330
|
-
namespace Responses {
|
|
1331
|
-
export interface $200 {
|
|
1332
|
-
name: string;
|
|
1333
|
-
agent_id: string | null; // uuid
|
|
1334
|
-
settings: {
|
|
1335
|
-
/**
|
|
1336
|
-
* Exact HTTPS origins. Empty means the Website Chat cannot start sessions.
|
|
1337
|
-
*/
|
|
1338
|
-
allowed_origins: [
|
|
1339
|
-
string?,
|
|
1340
|
-
string?,
|
|
1341
|
-
string?,
|
|
1342
|
-
string?,
|
|
1343
|
-
string?,
|
|
1344
|
-
string?,
|
|
1345
|
-
string?,
|
|
1346
|
-
string?,
|
|
1347
|
-
string?,
|
|
1348
|
-
string?,
|
|
1349
|
-
string?,
|
|
1350
|
-
string?,
|
|
1351
|
-
string?,
|
|
1352
|
-
string?,
|
|
1353
|
-
string?,
|
|
1354
|
-
string?,
|
|
1355
|
-
string?,
|
|
1356
|
-
string?,
|
|
1357
|
-
string?,
|
|
1358
|
-
string?,
|
|
1359
|
-
string?,
|
|
1360
|
-
string?,
|
|
1361
|
-
string?,
|
|
1362
|
-
string?,
|
|
1363
|
-
string?,
|
|
1364
|
-
string?,
|
|
1365
|
-
string?,
|
|
1366
|
-
string?,
|
|
1367
|
-
string?,
|
|
1368
|
-
string?,
|
|
1369
|
-
string?,
|
|
1370
|
-
string?,
|
|
1371
|
-
string?,
|
|
1372
|
-
string?,
|
|
1373
|
-
string?,
|
|
1374
|
-
string?,
|
|
1375
|
-
string?,
|
|
1376
|
-
string?,
|
|
1377
|
-
string?,
|
|
1378
|
-
string?,
|
|
1379
|
-
string?,
|
|
1380
|
-
string?,
|
|
1381
|
-
string?,
|
|
1382
|
-
string?,
|
|
1383
|
-
string?,
|
|
1384
|
-
string?,
|
|
1385
|
-
string?,
|
|
1386
|
-
string?,
|
|
1387
|
-
string?,
|
|
1388
|
-
string?
|
|
1389
|
-
];
|
|
1390
|
-
organisation_name: string;
|
|
1391
|
-
default_locale: "en" | "de";
|
|
1392
|
-
/**
|
|
1393
|
-
* Design Builder configuration for the Website Chat only.
|
|
1394
|
-
*/
|
|
1395
|
-
design_id?: string | null; // uuid
|
|
1396
|
-
/**
|
|
1397
|
-
* Email Builder template selection. Does not enable verification by itself.
|
|
1398
|
-
*/
|
|
1399
|
-
authentication?: {
|
|
1400
|
-
email_code: {
|
|
1401
|
-
email_template_id?: string | null; // uuid
|
|
1402
|
-
};
|
|
1403
|
-
} | null;
|
|
1404
|
-
};
|
|
1405
|
-
/**
|
|
1406
|
-
* Stable public embed identifier, independent of the assigned agent. Not a credential.
|
|
1407
|
-
*/
|
|
1408
|
-
website_chat_id: string; // uuid
|
|
1409
|
-
org_id: string;
|
|
1410
|
-
/**
|
|
1411
|
-
* Server-owned session binding; changes on reassignment or allowed-origin changes.
|
|
1412
|
-
*/
|
|
1413
|
-
binding_id: string; // uuid
|
|
1414
|
-
version: number;
|
|
1415
|
-
created_at: string; // date-time
|
|
1416
|
-
updated_at: string; // date-time
|
|
1417
|
-
embed: {
|
|
1418
|
-
script_url: string; // uri
|
|
1419
|
-
chat_api_origin: string; // uri
|
|
1420
|
-
demo_url: string; // uri
|
|
1421
|
-
};
|
|
1422
|
-
}
|
|
1423
|
-
export interface $400 {
|
|
1424
|
-
error?: string;
|
|
1425
|
-
message?: string;
|
|
1426
|
-
details?: {
|
|
1427
|
-
[key: string]: any;
|
|
1428
|
-
};
|
|
1429
|
-
}
|
|
1430
|
-
export interface $404 {
|
|
1431
|
-
error?: string;
|
|
1432
|
-
message?: string;
|
|
1433
|
-
details?: {
|
|
1434
|
-
[key: string]: any;
|
|
1435
|
-
};
|
|
1436
|
-
}
|
|
1437
|
-
export interface $409 {
|
|
1438
|
-
error?: string;
|
|
1439
|
-
message?: string;
|
|
1440
|
-
details?: {
|
|
1441
|
-
[key: string]: any;
|
|
1442
|
-
};
|
|
1443
|
-
}
|
|
1444
|
-
}
|
|
1445
|
-
}
|
|
1446
|
-
namespace V1WebsiteChats$WebsiteChatId {
|
|
1447
|
-
namespace Parameters {
|
|
1448
|
-
export type WebsiteChatId = string; // uuid
|
|
1449
|
-
}
|
|
1450
|
-
export interface PathParameters {
|
|
1451
|
-
website_chat_id: Parameters.WebsiteChatId /* uuid */;
|
|
1452
|
-
}
|
|
1453
|
-
}
|
|
1454
|
-
namespace VerifyChatEmailCode {
|
|
1455
|
-
export interface RequestBody {
|
|
1456
|
-
challenge_id: string; // uuid
|
|
1457
|
-
code: string; // ^\d{6}$
|
|
1458
|
-
}
|
|
1459
|
-
namespace Responses {
|
|
1460
|
-
export interface $200 {
|
|
1461
|
-
available: boolean;
|
|
1462
|
-
conversation_id: string; // uuid
|
|
1463
|
-
status: "anonymous" | "sending" | "pending" | "verified";
|
|
1464
|
-
challenge_id?: string; // uuid
|
|
1465
|
-
/**
|
|
1466
|
-
* Unix seconds
|
|
1467
|
-
*/
|
|
1468
|
-
code_expires_at?: number;
|
|
1469
|
-
/**
|
|
1470
|
-
* Unix seconds
|
|
1471
|
-
*/
|
|
1472
|
-
resend_after?: number;
|
|
1473
|
-
email?: string; // email
|
|
1474
|
-
contact_resolution?: "matched" | "ambiguous" | "not_found";
|
|
1475
|
-
}
|
|
1476
|
-
export interface Default {
|
|
1477
|
-
code: "INVALID_VERIFICATION_CODE" | "VERIFICATION_EXPIRED" | "VERIFICATION_CONFLICT" | "VERIFICATION_DISABLED" | "VERIFICATION_UNAVAILABLE" | "IDENTITY_CHANGED" | "INVALID_REQUEST" | "ORIGIN_DENIED" | "NOT_FOUND" | "INVALID_GRANT" | "SESSION_EXPIRED" | "RATE_LIMITED" | "SESSION_LIMIT" | "USAGE_LIMIT" | "REQUEST_CONFLICT" | "IN_PROGRESS" | "UNAVAILABLE" | "TEMPORARILY_UNAVAILABLE";
|
|
1478
|
-
}
|
|
1479
|
-
}
|
|
1480
|
-
}
|
|
1481
|
-
}
|
|
1482
|
-
|
|
1483
|
-
|
|
1484
|
-
interface OperationMethods {
|
|
1485
|
-
/**
|
|
1486
|
-
* listWebsiteChats
|
|
1487
|
-
*/
|
|
1488
|
-
'listWebsiteChats'(
|
|
1489
|
-
parameters?: Parameters<Paths.ListWebsiteChats.QueryParameters> | null,
|
|
1490
|
-
data?: any,
|
|
1491
|
-
config?: AxiosRequestConfig
|
|
1492
|
-
): OperationResponse<Paths.ListWebsiteChats.Responses.$200>
|
|
1493
|
-
/**
|
|
1494
|
-
* createWebsiteChat
|
|
1495
|
-
*/
|
|
1496
|
-
'createWebsiteChat'(
|
|
1497
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1498
|
-
data?: Paths.CreateWebsiteChat.RequestBody,
|
|
1499
|
-
config?: AxiosRequestConfig
|
|
1500
|
-
): OperationResponse<Paths.CreateWebsiteChat.Responses.$201>
|
|
1501
|
-
/**
|
|
1502
|
-
* getWebsiteChat
|
|
1503
|
-
*/
|
|
1504
|
-
'getWebsiteChat'(
|
|
1505
|
-
parameters?: Parameters<Paths.V1WebsiteChats$WebsiteChatId.PathParameters> | null,
|
|
1506
|
-
data?: any,
|
|
1507
|
-
config?: AxiosRequestConfig
|
|
1508
|
-
): OperationResponse<Paths.GetWebsiteChat.Responses.$200>
|
|
1509
|
-
/**
|
|
1510
|
-
* updateWebsiteChat
|
|
1511
|
-
*/
|
|
1512
|
-
'updateWebsiteChat'(
|
|
1513
|
-
parameters?: Parameters<Paths.V1WebsiteChats$WebsiteChatId.PathParameters> | null,
|
|
1514
|
-
data?: Paths.UpdateWebsiteChat.RequestBody,
|
|
1515
|
-
config?: AxiosRequestConfig
|
|
1516
|
-
): OperationResponse<Paths.UpdateWebsiteChat.Responses.$200>
|
|
1517
|
-
/**
|
|
1518
|
-
* deleteWebsiteChat
|
|
1519
|
-
*/
|
|
1520
|
-
'deleteWebsiteChat'(
|
|
1521
|
-
parameters?: Parameters<Paths.DeleteWebsiteChat.QueryParameters & Paths.V1WebsiteChats$WebsiteChatId.PathParameters> | null,
|
|
1522
|
-
data?: any,
|
|
1523
|
-
config?: AxiosRequestConfig
|
|
1524
|
-
): OperationResponse<Paths.DeleteWebsiteChat.Responses.$204>
|
|
1525
|
-
/**
|
|
1526
|
-
* getPublicWebsiteChat - Resolve visitor-facing configuration for an independent Website Chat and its current agent assignment. The Website Chat ID is not an organisation ID or a destination such as website or portal.
|
|
1527
|
-
*/
|
|
1528
|
-
'getPublicWebsiteChat'(
|
|
1529
|
-
parameters?: Parameters<Paths.GetPublicWebsiteChat.PathParameters> | null,
|
|
1530
|
-
data?: any,
|
|
1531
|
-
config?: AxiosRequestConfig
|
|
1532
|
-
): OperationResponse<Paths.GetPublicWebsiteChat.Responses.$200 | Paths.GetPublicWebsiteChat.Responses.Default>
|
|
1533
|
-
/**
|
|
1534
|
-
* createPublicChatGrant - Called by the host website with its website_chat_id. 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.
|
|
1535
|
-
*/
|
|
1536
|
-
'createPublicChatGrant'(
|
|
1537
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1538
|
-
data?: Paths.CreatePublicChatGrant.RequestBody,
|
|
1539
|
-
config?: AxiosRequestConfig
|
|
1540
|
-
): OperationResponse<Paths.CreatePublicChatGrant.Responses.$201 | Paths.CreatePublicChatGrant.Responses.Default>
|
|
1541
|
-
/**
|
|
1542
|
-
* 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.
|
|
1543
|
-
*/
|
|
1544
|
-
'createAnonymousChatSession'(
|
|
1545
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1546
|
-
data?: Paths.CreateAnonymousChatSession.RequestBody,
|
|
1547
|
-
config?: AxiosRequestConfig
|
|
1548
|
-
): OperationResponse<Paths.CreateAnonymousChatSession.Responses.$201 | Paths.CreateAnonymousChatSession.Responses.Default>
|
|
1549
|
-
/**
|
|
1550
|
-
* sendAnonymousChatMessage - Creates a turn or replays its persisted result. Reuse request_id and the exact
|
|
1551
|
-
* payload for a retry. History, org, agent, tools and account identity cannot be supplied.
|
|
1552
|
-
* TEMPORARILY_UNAVAILABLE means the request outcome could not be checked; retry the same request ID and payload.
|
|
1553
|
-
* A running request returns 409 IN_PROGRESS; a changed payload returns 409 REQUEST_CONFLICT.
|
|
1554
|
-
* A failed admitted request never starts another model execution when retried.
|
|
1555
|
-
*
|
|
1556
|
-
*/
|
|
1557
|
-
'sendAnonymousChatMessage'(
|
|
1558
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1559
|
-
data?: Paths.SendAnonymousChatMessage.RequestBody,
|
|
1560
|
-
config?: AxiosRequestConfig
|
|
1561
|
-
): OperationResponse<Paths.SendAnonymousChatMessage.Responses.$200 | Paths.SendAnonymousChatMessage.Responses.Default>
|
|
1562
|
-
/**
|
|
1563
|
-
* getChatVerification - Read this session's verification state. No contact IDs or candidate records are exposed.
|
|
1564
|
-
*/
|
|
1565
|
-
'getChatVerification'(
|
|
1566
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1567
|
-
data?: any,
|
|
1568
|
-
config?: AxiosRequestConfig
|
|
1569
|
-
): OperationResponse<Paths.GetChatVerification.Responses.$200 | Paths.GetChatVerification.Responses.Default>
|
|
1570
|
-
/**
|
|
1571
|
-
* startChatEmailVerification - Start or resend an email challenge using the template saved on this session's Website Chat. Repeating the same request_id and payload does not send another email. Codes must never be sent as chat messages.
|
|
1572
|
-
*/
|
|
1573
|
-
'startChatEmailVerification'(
|
|
1574
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1575
|
-
data?: Paths.StartChatEmailVerification.RequestBody,
|
|
1576
|
-
config?: AxiosRequestConfig
|
|
1577
|
-
): OperationResponse<Paths.StartChatEmailVerification.Responses.$200 | Paths.StartChatEmailVerification.Responses.Default>
|
|
1578
|
-
/**
|
|
1579
|
-
* verifyChatEmailCode - Verify a code for this session's current challenge. Success binds email proof and contact resolution to this session and starts a new conversation. It grants no account-tool permission.
|
|
1580
|
-
*/
|
|
1581
|
-
'verifyChatEmailCode'(
|
|
1582
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1583
|
-
data?: Paths.VerifyChatEmailCode.RequestBody,
|
|
1584
|
-
config?: AxiosRequestConfig
|
|
1585
|
-
): OperationResponse<Paths.VerifyChatEmailCode.Responses.$200 | Paths.VerifyChatEmailCode.Responses.Default>
|
|
1586
|
-
/**
|
|
1587
|
-
* cancelChatVerification - Cancel a pending challenge or clear verified identity. Clearing verified identity starts a new anonymous conversation. In-flight verification cannot restore the cleared identity.
|
|
1588
|
-
*/
|
|
1589
|
-
'cancelChatVerification'(
|
|
1590
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1591
|
-
data?: any,
|
|
1592
|
-
config?: AxiosRequestConfig
|
|
1593
|
-
): OperationResponse<Paths.CancelChatVerification.Responses.$200 | Paths.CancelChatVerification.Responses.Default>
|
|
1594
|
-
}
|
|
1595
|
-
|
|
1596
|
-
interface PathsDictionary {
|
|
1597
|
-
['/v1/website-chats']: {
|
|
1598
|
-
/**
|
|
1599
|
-
* listWebsiteChats
|
|
1600
|
-
*/
|
|
1601
|
-
'get'(
|
|
1602
|
-
parameters?: Parameters<Paths.ListWebsiteChats.QueryParameters> | null,
|
|
1603
|
-
data?: any,
|
|
1604
|
-
config?: AxiosRequestConfig
|
|
1605
|
-
): OperationResponse<Paths.ListWebsiteChats.Responses.$200>
|
|
1606
|
-
/**
|
|
1607
|
-
* createWebsiteChat
|
|
1608
|
-
*/
|
|
1609
|
-
'post'(
|
|
1610
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1611
|
-
data?: Paths.CreateWebsiteChat.RequestBody,
|
|
1612
|
-
config?: AxiosRequestConfig
|
|
1613
|
-
): OperationResponse<Paths.CreateWebsiteChat.Responses.$201>
|
|
1614
|
-
}
|
|
1615
|
-
['/v1/website-chats/{website_chat_id}']: {
|
|
1616
|
-
/**
|
|
1617
|
-
* getWebsiteChat
|
|
1618
|
-
*/
|
|
1619
|
-
'get'(
|
|
1620
|
-
parameters?: Parameters<Paths.V1WebsiteChats$WebsiteChatId.PathParameters> | null,
|
|
1621
|
-
data?: any,
|
|
1622
|
-
config?: AxiosRequestConfig
|
|
1623
|
-
): OperationResponse<Paths.GetWebsiteChat.Responses.$200>
|
|
1624
|
-
/**
|
|
1625
|
-
* updateWebsiteChat
|
|
1626
|
-
*/
|
|
1627
|
-
'put'(
|
|
1628
|
-
parameters?: Parameters<Paths.V1WebsiteChats$WebsiteChatId.PathParameters> | null,
|
|
1629
|
-
data?: Paths.UpdateWebsiteChat.RequestBody,
|
|
1630
|
-
config?: AxiosRequestConfig
|
|
1631
|
-
): OperationResponse<Paths.UpdateWebsiteChat.Responses.$200>
|
|
1632
|
-
/**
|
|
1633
|
-
* deleteWebsiteChat
|
|
1634
|
-
*/
|
|
1635
|
-
'delete'(
|
|
1636
|
-
parameters?: Parameters<Paths.DeleteWebsiteChat.QueryParameters & Paths.V1WebsiteChats$WebsiteChatId.PathParameters> | null,
|
|
1637
|
-
data?: any,
|
|
1638
|
-
config?: AxiosRequestConfig
|
|
1639
|
-
): OperationResponse<Paths.DeleteWebsiteChat.Responses.$204>
|
|
1640
|
-
}
|
|
1641
|
-
['/v1/website-chats/{website_chat_id}/configuration']: {
|
|
1642
|
-
/**
|
|
1643
|
-
* getPublicWebsiteChat - Resolve visitor-facing configuration for an independent Website Chat and its current agent assignment. The Website Chat ID is not an organisation ID or a destination such as website or portal.
|
|
1644
|
-
*/
|
|
1645
|
-
'get'(
|
|
1646
|
-
parameters?: Parameters<Paths.GetPublicWebsiteChat.PathParameters> | null,
|
|
1647
|
-
data?: any,
|
|
1648
|
-
config?: AxiosRequestConfig
|
|
1649
|
-
): OperationResponse<Paths.GetPublicWebsiteChat.Responses.$200 | Paths.GetPublicWebsiteChat.Responses.Default>
|
|
1650
|
-
}
|
|
1651
|
-
['/v1/bootstrap']: {
|
|
1652
|
-
/**
|
|
1653
|
-
* createPublicChatGrant - Called by the host website with its website_chat_id. 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.
|
|
1654
|
-
*/
|
|
1655
|
-
'post'(
|
|
1656
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1657
|
-
data?: Paths.CreatePublicChatGrant.RequestBody,
|
|
1658
|
-
config?: AxiosRequestConfig
|
|
1659
|
-
): OperationResponse<Paths.CreatePublicChatGrant.Responses.$201 | Paths.CreatePublicChatGrant.Responses.Default>
|
|
1660
|
-
}
|
|
1661
|
-
['/v1/sessions']: {
|
|
1662
|
-
/**
|
|
1663
|
-
* 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.
|
|
1664
|
-
*/
|
|
1665
|
-
'post'(
|
|
1666
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1667
|
-
data?: Paths.CreateAnonymousChatSession.RequestBody,
|
|
1668
|
-
config?: AxiosRequestConfig
|
|
1669
|
-
): OperationResponse<Paths.CreateAnonymousChatSession.Responses.$201 | Paths.CreateAnonymousChatSession.Responses.Default>
|
|
1670
|
-
}
|
|
1671
|
-
['/v1/messages']: {
|
|
1672
|
-
/**
|
|
1673
|
-
* sendAnonymousChatMessage - Creates a turn or replays its persisted result. Reuse request_id and the exact
|
|
1674
|
-
* payload for a retry. History, org, agent, tools and account identity cannot be supplied.
|
|
1675
|
-
* TEMPORARILY_UNAVAILABLE means the request outcome could not be checked; retry the same request ID and payload.
|
|
1676
|
-
* A running request returns 409 IN_PROGRESS; a changed payload returns 409 REQUEST_CONFLICT.
|
|
1677
|
-
* A failed admitted request never starts another model execution when retried.
|
|
1678
|
-
*
|
|
1679
|
-
*/
|
|
1680
|
-
'post'(
|
|
1681
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1682
|
-
data?: Paths.SendAnonymousChatMessage.RequestBody,
|
|
1683
|
-
config?: AxiosRequestConfig
|
|
1684
|
-
): OperationResponse<Paths.SendAnonymousChatMessage.Responses.$200 | Paths.SendAnonymousChatMessage.Responses.Default>
|
|
1685
|
-
}
|
|
1686
|
-
['/v1/verification']: {
|
|
1687
|
-
/**
|
|
1688
|
-
* getChatVerification - Read this session's verification state. No contact IDs or candidate records are exposed.
|
|
1689
|
-
*/
|
|
1690
|
-
'get'(
|
|
1691
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1692
|
-
data?: any,
|
|
1693
|
-
config?: AxiosRequestConfig
|
|
1694
|
-
): OperationResponse<Paths.GetChatVerification.Responses.$200 | Paths.GetChatVerification.Responses.Default>
|
|
1695
|
-
}
|
|
1696
|
-
['/v1/verification/email']: {
|
|
1697
|
-
/**
|
|
1698
|
-
* startChatEmailVerification - Start or resend an email challenge using the template saved on this session's Website Chat. Repeating the same request_id and payload does not send another email. Codes must never be sent as chat messages.
|
|
1699
|
-
*/
|
|
1700
|
-
'post'(
|
|
1701
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1702
|
-
data?: Paths.StartChatEmailVerification.RequestBody,
|
|
1703
|
-
config?: AxiosRequestConfig
|
|
1704
|
-
): OperationResponse<Paths.StartChatEmailVerification.Responses.$200 | Paths.StartChatEmailVerification.Responses.Default>
|
|
1705
|
-
}
|
|
1706
|
-
['/v1/verification/code']: {
|
|
1707
|
-
/**
|
|
1708
|
-
* verifyChatEmailCode - Verify a code for this session's current challenge. Success binds email proof and contact resolution to this session and starts a new conversation. It grants no account-tool permission.
|
|
1709
|
-
*/
|
|
1710
|
-
'post'(
|
|
1711
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1712
|
-
data?: Paths.VerifyChatEmailCode.RequestBody,
|
|
1713
|
-
config?: AxiosRequestConfig
|
|
1714
|
-
): OperationResponse<Paths.VerifyChatEmailCode.Responses.$200 | Paths.VerifyChatEmailCode.Responses.Default>
|
|
1715
|
-
}
|
|
1716
|
-
['/v1/verification/cancel']: {
|
|
1717
|
-
/**
|
|
1718
|
-
* cancelChatVerification - Cancel a pending challenge or clear verified identity. Clearing verified identity starts a new anonymous conversation. In-flight verification cannot restore the cleared identity.
|
|
1719
|
-
*/
|
|
1720
|
-
'post'(
|
|
1721
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1722
|
-
data?: any,
|
|
1723
|
-
config?: AxiosRequestConfig
|
|
1724
|
-
): OperationResponse<Paths.CancelChatVerification.Responses.$200 | Paths.CancelChatVerification.Responses.Default>
|
|
1725
|
-
}
|
|
1726
|
-
}
|
|
1727
|
-
|
|
1728
|
-
type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
1729
|
-
|
|
1730
|
-
|
|
1731
|
-
type CreateWebsiteChatRequest = Components.Schemas.CreateWebsiteChatRequest;
|
|
1732
|
-
type Error = Components.Schemas.Error;
|
|
1733
|
-
type ListWebsiteChatsResponse = Components.Schemas.ListWebsiteChatsResponse;
|
|
1734
|
-
type PublicChatError = Components.Schemas.PublicChatError;
|
|
1735
|
-
type PublicEvent = Components.Schemas.PublicEvent;
|
|
1736
|
-
type PublicWebsiteChat = Components.Schemas.PublicWebsiteChat;
|
|
1737
|
-
type UpdateWebsiteChatRequest = Components.Schemas.UpdateWebsiteChatRequest;
|
|
1738
|
-
type VerificationState = Components.Schemas.VerificationState;
|
|
1739
|
-
type WebsiteChat = Components.Schemas.WebsiteChat;
|
|
1740
|
-
type WebsiteChatDesign = Components.Schemas.WebsiteChatDesign;
|
|
1741
|
-
type WebsiteChatSettings = Components.Schemas.WebsiteChatSettings;
|
|
1742
|
-
|
|
1743
|
-
export { type Client as C, type Error as E, type ListWebsiteChatsResponse as L, type OperationMethods as O, Paths as P, type UpdateWebsiteChatRequest as U, type VerificationState as V, type WebsiteChat as W, Components as a, type PathsDictionary as b, type CreateWebsiteChatRequest as c, type PublicChatError as d, type PublicEvent as e, type PublicWebsiteChat as f, type WebsiteChatDesign as g, type WebsiteChatSettings as h };
|