@epilot/sdk 2.20.34 → 2.20.36
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 +749 -126
- package/definitions/integration-toolkit-runtime.json +1 -1
- package/definitions/integration-toolkit.json +259 -13
- 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/integration-toolkit.cjs +19 -15
- package/dist/apis/integration-toolkit.d.cts +2 -2
- package/dist/apis/integration-toolkit.d.ts +2 -2
- package/dist/apis/integration-toolkit.js +13 -9
- 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-3MIK7DUI.js +7 -0
- package/dist/chat-IWMQEXCD.cjs +7 -0
- package/dist/{chat-runtime-MF35HI2U.js → chat-runtime-O46V7MCD.js} +1 -1
- package/dist/chat-runtime-QSGSW6SL.cjs +5 -0
- package/dist/{chat.d-0w0TaT-a.d.cts → chat.d-mUHenLz7.d.cts} +564 -365
- package/dist/{chat.d-0w0TaT-a.d.ts → chat.d-mUHenLz7.d.ts} +564 -365
- package/dist/chunk-2F4JXHGX.js +14 -0
- package/dist/{chunk-4DTTVPUM.cjs → chunk-4M4Z7BKK.cjs} +1 -1
- package/dist/{chunk-WE4C7GER.js → chunk-4OBXBYLK.js} +1 -1
- package/dist/chunk-QWQ6UINA.cjs +14 -0
- package/dist/{chunk-XFBOYWIP.cjs → chunk-RSP6PAXQ.cjs} +4 -4
- package/dist/{chunk-RJVNG46W.js → chunk-YH6DUNL2.js} +4 -4
- package/dist/index.cjs +12 -12
- package/dist/index.d.cts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +3 -3
- package/dist/integration-toolkit-4ADZMNTB.cjs +7 -0
- package/dist/integration-toolkit-BCRYMKLW.js +7 -0
- package/dist/{integration-toolkit-runtime-TNDJH6HK.js → integration-toolkit-runtime-ABL4FFLI.js} +1 -1
- package/dist/{integration-toolkit-runtime-57I2O6DI.cjs → integration-toolkit-runtime-SU7VKZJB.cjs} +2 -2
- package/dist/{integration-toolkit.d-CEY26qJu.d.cts → integration-toolkit.d-BQ0Fj-48.d.cts} +274 -25
- package/dist/{integration-toolkit.d-CEY26qJu.d.ts → integration-toolkit.d-BQ0Fj-48.d.ts} +274 -25
- package/dist/js-yaml-DLCVPJ7G.js +0 -0
- package/docs/chat.md +231 -77
- package/docs/integration-toolkit.md +113 -8
- package/package.json +11 -12
- package/definitions/focus-pocus-runtime.json +0 -1
- package/definitions/focus-pocus.json +0 -757
- package/dist/chat-5EOD2OPN.cjs +0 -7
- package/dist/chat-D5KXPRYY.js +0 -7
- package/dist/chat-runtime-MYMUFT3Y.cjs +0 -5
- package/dist/chunk-6ZTP7EQE.js +0 -14
- package/dist/chunk-A5THJ4SF.cjs +0 -14
- package/dist/integration-toolkit-FM53LFD7.cjs +0 -7
- package/dist/integration-toolkit-PUA7B6YT.js +0 -7
|
@@ -6,16 +6,16 @@ import { OpenAPIClient, Parameters, AxiosRequestConfig, OperationResponse, Unkno
|
|
|
6
6
|
declare namespace Components {
|
|
7
7
|
namespace Responses {
|
|
8
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";
|
|
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
10
|
}
|
|
11
11
|
}
|
|
12
12
|
namespace Schemas {
|
|
13
|
-
export interface
|
|
13
|
+
export interface CreateWebsiteChatRequest {
|
|
14
14
|
name: string;
|
|
15
15
|
agent_id: string | null; // uuid
|
|
16
|
-
|
|
16
|
+
settings: {
|
|
17
17
|
/**
|
|
18
|
-
* Exact HTTPS origins. Empty means the
|
|
18
|
+
* Exact HTTPS origins. Empty means the Website Chat cannot start sessions.
|
|
19
19
|
*/
|
|
20
20
|
allowed_origins: [
|
|
21
21
|
string?,
|
|
@@ -72,99 +72,7 @@ declare namespace Components {
|
|
|
72
72
|
organisation_name: string;
|
|
73
73
|
default_locale: "en" | "de";
|
|
74
74
|
/**
|
|
75
|
-
* Design Builder configuration for the
|
|
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.
|
|
75
|
+
* Design Builder configuration for the Website Chat only.
|
|
168
76
|
*/
|
|
169
77
|
design_id?: string | null; // uuid
|
|
170
78
|
/**
|
|
@@ -184,13 +92,13 @@ declare namespace Components {
|
|
|
184
92
|
[key: string]: any;
|
|
185
93
|
};
|
|
186
94
|
}
|
|
187
|
-
export interface
|
|
188
|
-
|
|
95
|
+
export interface ListWebsiteChatsResponse {
|
|
96
|
+
website_chats: {
|
|
189
97
|
name: string;
|
|
190
98
|
agent_id: string | null; // uuid
|
|
191
|
-
|
|
99
|
+
settings: {
|
|
192
100
|
/**
|
|
193
|
-
* Exact HTTPS origins. Empty means the
|
|
101
|
+
* Exact HTTPS origins. Empty means the Website Chat cannot start sessions.
|
|
194
102
|
*/
|
|
195
103
|
allowed_origins: [
|
|
196
104
|
string?,
|
|
@@ -247,7 +155,7 @@ declare namespace Components {
|
|
|
247
155
|
organisation_name: string;
|
|
248
156
|
default_locale: "en" | "de";
|
|
249
157
|
/**
|
|
250
|
-
* Design Builder configuration for the
|
|
158
|
+
* Design Builder configuration for the Website Chat only.
|
|
251
159
|
*/
|
|
252
160
|
design_id?: string | null; // uuid
|
|
253
161
|
/**
|
|
@@ -262,7 +170,7 @@ declare namespace Components {
|
|
|
262
170
|
/**
|
|
263
171
|
* Stable public embed identifier, independent of the assigned agent. Not a credential.
|
|
264
172
|
*/
|
|
265
|
-
|
|
173
|
+
website_chat_id: string; // uuid
|
|
266
174
|
org_id: string;
|
|
267
175
|
/**
|
|
268
176
|
* Server-owned session binding; changes on reassignment or allowed-origin changes.
|
|
@@ -271,7 +179,7 @@ declare namespace Components {
|
|
|
271
179
|
version: number;
|
|
272
180
|
created_at: string; // date-time
|
|
273
181
|
updated_at: string; // date-time
|
|
274
|
-
|
|
182
|
+
embed: {
|
|
275
183
|
script_url: string; // uri
|
|
276
184
|
chat_api_origin: string; // uri
|
|
277
185
|
demo_url: string; // uri
|
|
@@ -280,7 +188,7 @@ declare namespace Components {
|
|
|
280
188
|
next_cursor?: string;
|
|
281
189
|
}
|
|
282
190
|
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";
|
|
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";
|
|
284
192
|
}
|
|
285
193
|
/**
|
|
286
194
|
* JSON payload of one SSE data frame from sendAnonymousChatMessage.
|
|
@@ -298,12 +206,58 @@ declare namespace Components {
|
|
|
298
206
|
code: "UNAVAILABLE";
|
|
299
207
|
request_id: string; // uuid
|
|
300
208
|
};
|
|
301
|
-
export interface
|
|
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 {
|
|
302
256
|
name?: string;
|
|
303
257
|
agent_id?: string | null; // uuid
|
|
304
|
-
|
|
258
|
+
settings?: {
|
|
305
259
|
/**
|
|
306
|
-
* Exact HTTPS origins. Empty means the
|
|
260
|
+
* Exact HTTPS origins. Empty means the Website Chat cannot start sessions.
|
|
307
261
|
*/
|
|
308
262
|
allowed_origins: [
|
|
309
263
|
string?,
|
|
@@ -360,7 +314,7 @@ declare namespace Components {
|
|
|
360
314
|
organisation_name: string;
|
|
361
315
|
default_locale: "en" | "de";
|
|
362
316
|
/**
|
|
363
|
-
* Design Builder configuration for the
|
|
317
|
+
* Design Builder configuration for the Website Chat only.
|
|
364
318
|
*/
|
|
365
319
|
design_id?: string | null; // uuid
|
|
366
320
|
/**
|
|
@@ -377,9 +331,153 @@ declare namespace Components {
|
|
|
377
331
|
*/
|
|
378
332
|
version: number;
|
|
379
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
|
+
}
|
|
380
478
|
export interface WebsiteChatSettings {
|
|
381
479
|
/**
|
|
382
|
-
* Exact HTTPS origins. Empty means the
|
|
480
|
+
* Exact HTTPS origins. Empty means the Website Chat cannot start sessions.
|
|
383
481
|
*/
|
|
384
482
|
allowed_origins: [
|
|
385
483
|
string?,
|
|
@@ -436,100 +534,44 @@ declare namespace Components {
|
|
|
436
534
|
organisation_name: string;
|
|
437
535
|
default_locale: "en" | "de";
|
|
438
536
|
/**
|
|
439
|
-
* Design Builder configuration for the
|
|
537
|
+
* Design Builder configuration for the Website Chat only.
|
|
440
538
|
*/
|
|
441
539
|
design_id?: string | null; // uuid
|
|
442
540
|
/**
|
|
443
541
|
* 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
|
-
};
|
|
542
|
+
*/
|
|
543
|
+
authentication?: {
|
|
544
|
+
email_code: {
|
|
545
|
+
email_template_id?: string | null; // uuid
|
|
546
|
+
};
|
|
547
|
+
} | null;
|
|
529
548
|
}
|
|
530
549
|
}
|
|
531
550
|
}
|
|
532
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
|
+
}
|
|
533
575
|
namespace CreateAnonymousChatSession {
|
|
534
576
|
export interface RequestBody {
|
|
535
577
|
grant: string; // ^[A-Za-z0-9_-]{43}$
|
|
@@ -542,11 +584,14 @@ declare namespace Paths {
|
|
|
542
584
|
* Unix seconds
|
|
543
585
|
*/
|
|
544
586
|
expires_at: number;
|
|
545
|
-
|
|
587
|
+
website_chat: {
|
|
546
588
|
key: string;
|
|
547
589
|
organisationName: string;
|
|
548
590
|
assistantName: string;
|
|
549
591
|
defaultLocale: "en" | "de";
|
|
592
|
+
authentication?: {
|
|
593
|
+
email_code: boolean;
|
|
594
|
+
};
|
|
550
595
|
design?: {
|
|
551
596
|
id: string; // uuid
|
|
552
597
|
last_modified_at?: string;
|
|
@@ -587,17 +632,36 @@ declare namespace Paths {
|
|
|
587
632
|
};
|
|
588
633
|
}
|
|
589
634
|
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";
|
|
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";
|
|
591
655
|
}
|
|
592
656
|
}
|
|
593
657
|
}
|
|
594
|
-
namespace
|
|
658
|
+
namespace CreateWebsiteChat {
|
|
595
659
|
export interface RequestBody {
|
|
596
660
|
name: string;
|
|
597
661
|
agent_id: string | null; // uuid
|
|
598
|
-
|
|
662
|
+
settings: {
|
|
599
663
|
/**
|
|
600
|
-
* Exact HTTPS origins. Empty means the
|
|
664
|
+
* Exact HTTPS origins. Empty means the Website Chat cannot start sessions.
|
|
601
665
|
*/
|
|
602
666
|
allowed_origins: [
|
|
603
667
|
string?,
|
|
@@ -654,7 +718,7 @@ declare namespace Paths {
|
|
|
654
718
|
organisation_name: string;
|
|
655
719
|
default_locale: "en" | "de";
|
|
656
720
|
/**
|
|
657
|
-
* Design Builder configuration for the
|
|
721
|
+
* Design Builder configuration for the Website Chat only.
|
|
658
722
|
*/
|
|
659
723
|
design_id?: string | null; // uuid
|
|
660
724
|
/**
|
|
@@ -671,9 +735,9 @@ declare namespace Paths {
|
|
|
671
735
|
export interface $201 {
|
|
672
736
|
name: string;
|
|
673
737
|
agent_id: string | null; // uuid
|
|
674
|
-
|
|
738
|
+
settings: {
|
|
675
739
|
/**
|
|
676
|
-
* Exact HTTPS origins. Empty means the
|
|
740
|
+
* Exact HTTPS origins. Empty means the Website Chat cannot start sessions.
|
|
677
741
|
*/
|
|
678
742
|
allowed_origins: [
|
|
679
743
|
string?,
|
|
@@ -730,7 +794,7 @@ declare namespace Paths {
|
|
|
730
794
|
organisation_name: string;
|
|
731
795
|
default_locale: "en" | "de";
|
|
732
796
|
/**
|
|
733
|
-
* Design Builder configuration for the
|
|
797
|
+
* Design Builder configuration for the Website Chat only.
|
|
734
798
|
*/
|
|
735
799
|
design_id?: string | null; // uuid
|
|
736
800
|
/**
|
|
@@ -745,7 +809,7 @@ declare namespace Paths {
|
|
|
745
809
|
/**
|
|
746
810
|
* Stable public embed identifier, independent of the assigned agent. Not a credential.
|
|
747
811
|
*/
|
|
748
|
-
|
|
812
|
+
website_chat_id: string; // uuid
|
|
749
813
|
org_id: string;
|
|
750
814
|
/**
|
|
751
815
|
* Server-owned session binding; changes on reassignment or allowed-origin changes.
|
|
@@ -754,7 +818,7 @@ declare namespace Paths {
|
|
|
754
818
|
version: number;
|
|
755
819
|
created_at: string; // date-time
|
|
756
820
|
updated_at: string; // date-time
|
|
757
|
-
|
|
821
|
+
embed: {
|
|
758
822
|
script_url: string; // uri
|
|
759
823
|
chat_api_origin: string; // uri
|
|
760
824
|
demo_url: string; // uri
|
|
@@ -783,26 +847,7 @@ declare namespace Paths {
|
|
|
783
847
|
}
|
|
784
848
|
}
|
|
785
849
|
}
|
|
786
|
-
namespace
|
|
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 {
|
|
850
|
+
namespace DeleteWebsiteChat {
|
|
806
851
|
namespace Parameters {
|
|
807
852
|
export type Version = number;
|
|
808
853
|
}
|
|
@@ -835,14 +880,96 @@ declare namespace Paths {
|
|
|
835
880
|
}
|
|
836
881
|
}
|
|
837
882
|
}
|
|
838
|
-
namespace
|
|
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 {
|
|
839
966
|
namespace Responses {
|
|
840
967
|
export interface $200 {
|
|
841
968
|
name: string;
|
|
842
969
|
agent_id: string | null; // uuid
|
|
843
|
-
|
|
970
|
+
settings: {
|
|
844
971
|
/**
|
|
845
|
-
* Exact HTTPS origins. Empty means the
|
|
972
|
+
* Exact HTTPS origins. Empty means the Website Chat cannot start sessions.
|
|
846
973
|
*/
|
|
847
974
|
allowed_origins: [
|
|
848
975
|
string?,
|
|
@@ -899,7 +1026,7 @@ declare namespace Paths {
|
|
|
899
1026
|
organisation_name: string;
|
|
900
1027
|
default_locale: "en" | "de";
|
|
901
1028
|
/**
|
|
902
|
-
* Design Builder configuration for the
|
|
1029
|
+
* Design Builder configuration for the Website Chat only.
|
|
903
1030
|
*/
|
|
904
1031
|
design_id?: string | null; // uuid
|
|
905
1032
|
/**
|
|
@@ -914,7 +1041,7 @@ declare namespace Paths {
|
|
|
914
1041
|
/**
|
|
915
1042
|
* Stable public embed identifier, independent of the assigned agent. Not a credential.
|
|
916
1043
|
*/
|
|
917
|
-
|
|
1044
|
+
website_chat_id: string; // uuid
|
|
918
1045
|
org_id: string;
|
|
919
1046
|
/**
|
|
920
1047
|
* Server-owned session binding; changes on reassignment or allowed-origin changes.
|
|
@@ -923,7 +1050,7 @@ declare namespace Paths {
|
|
|
923
1050
|
version: number;
|
|
924
1051
|
created_at: string; // date-time
|
|
925
1052
|
updated_at: string; // date-time
|
|
926
|
-
|
|
1053
|
+
embed: {
|
|
927
1054
|
script_url: string; // uri
|
|
928
1055
|
chat_api_origin: string; // uri
|
|
929
1056
|
demo_url: string; // uri
|
|
@@ -952,63 +1079,7 @@ declare namespace Paths {
|
|
|
952
1079
|
}
|
|
953
1080
|
}
|
|
954
1081
|
}
|
|
955
|
-
namespace
|
|
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 {
|
|
1082
|
+
namespace ListWebsiteChats {
|
|
1012
1083
|
namespace Parameters {
|
|
1013
1084
|
export type Cursor = string;
|
|
1014
1085
|
}
|
|
@@ -1017,12 +1088,12 @@ declare namespace Paths {
|
|
|
1017
1088
|
}
|
|
1018
1089
|
namespace Responses {
|
|
1019
1090
|
export interface $200 {
|
|
1020
|
-
|
|
1091
|
+
website_chats: {
|
|
1021
1092
|
name: string;
|
|
1022
1093
|
agent_id: string | null; // uuid
|
|
1023
|
-
|
|
1094
|
+
settings: {
|
|
1024
1095
|
/**
|
|
1025
|
-
* Exact HTTPS origins. Empty means the
|
|
1096
|
+
* Exact HTTPS origins. Empty means the Website Chat cannot start sessions.
|
|
1026
1097
|
*/
|
|
1027
1098
|
allowed_origins: [
|
|
1028
1099
|
string?,
|
|
@@ -1079,7 +1150,7 @@ declare namespace Paths {
|
|
|
1079
1150
|
organisation_name: string;
|
|
1080
1151
|
default_locale: "en" | "de";
|
|
1081
1152
|
/**
|
|
1082
|
-
* Design Builder configuration for the
|
|
1153
|
+
* Design Builder configuration for the Website Chat only.
|
|
1083
1154
|
*/
|
|
1084
1155
|
design_id?: string | null; // uuid
|
|
1085
1156
|
/**
|
|
@@ -1094,7 +1165,7 @@ declare namespace Paths {
|
|
|
1094
1165
|
/**
|
|
1095
1166
|
* Stable public embed identifier, independent of the assigned agent. Not a credential.
|
|
1096
1167
|
*/
|
|
1097
|
-
|
|
1168
|
+
website_chat_id: string; // uuid
|
|
1098
1169
|
org_id: string;
|
|
1099
1170
|
/**
|
|
1100
1171
|
* Server-owned session binding; changes on reassignment or allowed-origin changes.
|
|
@@ -1103,7 +1174,7 @@ declare namespace Paths {
|
|
|
1103
1174
|
version: number;
|
|
1104
1175
|
created_at: string; // date-time
|
|
1105
1176
|
updated_at: string; // date-time
|
|
1106
|
-
|
|
1177
|
+
embed: {
|
|
1107
1178
|
script_url: string; // uri
|
|
1108
1179
|
chat_api_origin: string; // uri
|
|
1109
1180
|
demo_url: string; // uri
|
|
@@ -1144,17 +1215,45 @@ declare namespace Paths {
|
|
|
1144
1215
|
namespace Responses {
|
|
1145
1216
|
export type $200 = string;
|
|
1146
1217
|
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";
|
|
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";
|
|
1148
1247
|
}
|
|
1149
1248
|
}
|
|
1150
1249
|
}
|
|
1151
|
-
namespace
|
|
1250
|
+
namespace UpdateWebsiteChat {
|
|
1152
1251
|
export interface RequestBody {
|
|
1153
1252
|
name?: string;
|
|
1154
1253
|
agent_id?: string | null; // uuid
|
|
1155
|
-
|
|
1254
|
+
settings?: {
|
|
1156
1255
|
/**
|
|
1157
|
-
* Exact HTTPS origins. Empty means the
|
|
1256
|
+
* Exact HTTPS origins. Empty means the Website Chat cannot start sessions.
|
|
1158
1257
|
*/
|
|
1159
1258
|
allowed_origins: [
|
|
1160
1259
|
string?,
|
|
@@ -1211,7 +1310,7 @@ declare namespace Paths {
|
|
|
1211
1310
|
organisation_name: string;
|
|
1212
1311
|
default_locale: "en" | "de";
|
|
1213
1312
|
/**
|
|
1214
|
-
* Design Builder configuration for the
|
|
1313
|
+
* Design Builder configuration for the Website Chat only.
|
|
1215
1314
|
*/
|
|
1216
1315
|
design_id?: string | null; // uuid
|
|
1217
1316
|
/**
|
|
@@ -1232,9 +1331,9 @@ declare namespace Paths {
|
|
|
1232
1331
|
export interface $200 {
|
|
1233
1332
|
name: string;
|
|
1234
1333
|
agent_id: string | null; // uuid
|
|
1235
|
-
|
|
1334
|
+
settings: {
|
|
1236
1335
|
/**
|
|
1237
|
-
* Exact HTTPS origins. Empty means the
|
|
1336
|
+
* Exact HTTPS origins. Empty means the Website Chat cannot start sessions.
|
|
1238
1337
|
*/
|
|
1239
1338
|
allowed_origins: [
|
|
1240
1339
|
string?,
|
|
@@ -1291,7 +1390,7 @@ declare namespace Paths {
|
|
|
1291
1390
|
organisation_name: string;
|
|
1292
1391
|
default_locale: "en" | "de";
|
|
1293
1392
|
/**
|
|
1294
|
-
* Design Builder configuration for the
|
|
1393
|
+
* Design Builder configuration for the Website Chat only.
|
|
1295
1394
|
*/
|
|
1296
1395
|
design_id?: string | null; // uuid
|
|
1297
1396
|
/**
|
|
@@ -1306,7 +1405,7 @@ declare namespace Paths {
|
|
|
1306
1405
|
/**
|
|
1307
1406
|
* Stable public embed identifier, independent of the assigned agent. Not a credential.
|
|
1308
1407
|
*/
|
|
1309
|
-
|
|
1408
|
+
website_chat_id: string; // uuid
|
|
1310
1409
|
org_id: string;
|
|
1311
1410
|
/**
|
|
1312
1411
|
* Server-owned session binding; changes on reassignment or allowed-origin changes.
|
|
@@ -1315,7 +1414,7 @@ declare namespace Paths {
|
|
|
1315
1414
|
version: number;
|
|
1316
1415
|
created_at: string; // date-time
|
|
1317
1416
|
updated_at: string; // date-time
|
|
1318
|
-
|
|
1417
|
+
embed: {
|
|
1319
1418
|
script_url: string; // uri
|
|
1320
1419
|
chat_api_origin: string; // uri
|
|
1321
1420
|
demo_url: string; // uri
|
|
@@ -1344,12 +1443,39 @@ declare namespace Paths {
|
|
|
1344
1443
|
}
|
|
1345
1444
|
}
|
|
1346
1445
|
}
|
|
1347
|
-
namespace
|
|
1446
|
+
namespace V1WebsiteChats$WebsiteChatId {
|
|
1348
1447
|
namespace Parameters {
|
|
1349
|
-
export type
|
|
1448
|
+
export type WebsiteChatId = string; // uuid
|
|
1350
1449
|
}
|
|
1351
1450
|
export interface PathParameters {
|
|
1352
|
-
|
|
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
|
+
}
|
|
1353
1479
|
}
|
|
1354
1480
|
}
|
|
1355
1481
|
}
|
|
@@ -1357,55 +1483,55 @@ declare namespace Paths {
|
|
|
1357
1483
|
|
|
1358
1484
|
interface OperationMethods {
|
|
1359
1485
|
/**
|
|
1360
|
-
*
|
|
1486
|
+
* listWebsiteChats
|
|
1361
1487
|
*/
|
|
1362
|
-
'
|
|
1363
|
-
parameters?: Parameters<Paths.
|
|
1488
|
+
'listWebsiteChats'(
|
|
1489
|
+
parameters?: Parameters<Paths.ListWebsiteChats.QueryParameters> | null,
|
|
1364
1490
|
data?: any,
|
|
1365
1491
|
config?: AxiosRequestConfig
|
|
1366
|
-
): OperationResponse<Paths.
|
|
1492
|
+
): OperationResponse<Paths.ListWebsiteChats.Responses.$200>
|
|
1367
1493
|
/**
|
|
1368
|
-
*
|
|
1494
|
+
* createWebsiteChat
|
|
1369
1495
|
*/
|
|
1370
|
-
'
|
|
1496
|
+
'createWebsiteChat'(
|
|
1371
1497
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1372
|
-
data?: Paths.
|
|
1498
|
+
data?: Paths.CreateWebsiteChat.RequestBody,
|
|
1373
1499
|
config?: AxiosRequestConfig
|
|
1374
|
-
): OperationResponse<Paths.
|
|
1500
|
+
): OperationResponse<Paths.CreateWebsiteChat.Responses.$201>
|
|
1375
1501
|
/**
|
|
1376
|
-
*
|
|
1502
|
+
* getWebsiteChat
|
|
1377
1503
|
*/
|
|
1378
|
-
'
|
|
1379
|
-
parameters?: Parameters<Paths.
|
|
1504
|
+
'getWebsiteChat'(
|
|
1505
|
+
parameters?: Parameters<Paths.V1WebsiteChats$WebsiteChatId.PathParameters> | null,
|
|
1380
1506
|
data?: any,
|
|
1381
1507
|
config?: AxiosRequestConfig
|
|
1382
|
-
): OperationResponse<Paths.
|
|
1508
|
+
): OperationResponse<Paths.GetWebsiteChat.Responses.$200>
|
|
1383
1509
|
/**
|
|
1384
|
-
*
|
|
1510
|
+
* updateWebsiteChat
|
|
1385
1511
|
*/
|
|
1386
|
-
'
|
|
1387
|
-
parameters?: Parameters<Paths.
|
|
1388
|
-
data?: Paths.
|
|
1512
|
+
'updateWebsiteChat'(
|
|
1513
|
+
parameters?: Parameters<Paths.V1WebsiteChats$WebsiteChatId.PathParameters> | null,
|
|
1514
|
+
data?: Paths.UpdateWebsiteChat.RequestBody,
|
|
1389
1515
|
config?: AxiosRequestConfig
|
|
1390
|
-
): OperationResponse<Paths.
|
|
1516
|
+
): OperationResponse<Paths.UpdateWebsiteChat.Responses.$200>
|
|
1391
1517
|
/**
|
|
1392
|
-
*
|
|
1518
|
+
* deleteWebsiteChat
|
|
1393
1519
|
*/
|
|
1394
|
-
'
|
|
1395
|
-
parameters?: Parameters<Paths.
|
|
1520
|
+
'deleteWebsiteChat'(
|
|
1521
|
+
parameters?: Parameters<Paths.DeleteWebsiteChat.QueryParameters & Paths.V1WebsiteChats$WebsiteChatId.PathParameters> | null,
|
|
1396
1522
|
data?: any,
|
|
1397
1523
|
config?: AxiosRequestConfig
|
|
1398
|
-
): OperationResponse<Paths.
|
|
1524
|
+
): OperationResponse<Paths.DeleteWebsiteChat.Responses.$204>
|
|
1399
1525
|
/**
|
|
1400
|
-
*
|
|
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.
|
|
1401
1527
|
*/
|
|
1402
|
-
'
|
|
1403
|
-
parameters?: Parameters<Paths.
|
|
1528
|
+
'getPublicWebsiteChat'(
|
|
1529
|
+
parameters?: Parameters<Paths.GetPublicWebsiteChat.PathParameters> | null,
|
|
1404
1530
|
data?: any,
|
|
1405
1531
|
config?: AxiosRequestConfig
|
|
1406
|
-
): OperationResponse<Paths.
|
|
1532
|
+
): OperationResponse<Paths.GetPublicWebsiteChat.Responses.$200 | Paths.GetPublicWebsiteChat.Responses.Default>
|
|
1407
1533
|
/**
|
|
1408
|
-
* createPublicChatGrant - Called by the host website with its
|
|
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.
|
|
1409
1535
|
*/
|
|
1410
1536
|
'createPublicChatGrant'(
|
|
1411
1537
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
@@ -1433,66 +1559,98 @@ interface OperationMethods {
|
|
|
1433
1559
|
data?: Paths.SendAnonymousChatMessage.RequestBody,
|
|
1434
1560
|
config?: AxiosRequestConfig
|
|
1435
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>
|
|
1436
1594
|
}
|
|
1437
1595
|
|
|
1438
1596
|
interface PathsDictionary {
|
|
1439
|
-
['/v1/
|
|
1597
|
+
['/v1/website-chats']: {
|
|
1440
1598
|
/**
|
|
1441
|
-
*
|
|
1599
|
+
* listWebsiteChats
|
|
1442
1600
|
*/
|
|
1443
1601
|
'get'(
|
|
1444
|
-
parameters?: Parameters<Paths.
|
|
1602
|
+
parameters?: Parameters<Paths.ListWebsiteChats.QueryParameters> | null,
|
|
1445
1603
|
data?: any,
|
|
1446
1604
|
config?: AxiosRequestConfig
|
|
1447
|
-
): OperationResponse<Paths.
|
|
1605
|
+
): OperationResponse<Paths.ListWebsiteChats.Responses.$200>
|
|
1448
1606
|
/**
|
|
1449
|
-
*
|
|
1607
|
+
* createWebsiteChat
|
|
1450
1608
|
*/
|
|
1451
1609
|
'post'(
|
|
1452
1610
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1453
|
-
data?: Paths.
|
|
1611
|
+
data?: Paths.CreateWebsiteChat.RequestBody,
|
|
1454
1612
|
config?: AxiosRequestConfig
|
|
1455
|
-
): OperationResponse<Paths.
|
|
1613
|
+
): OperationResponse<Paths.CreateWebsiteChat.Responses.$201>
|
|
1456
1614
|
}
|
|
1457
|
-
['/v1/
|
|
1615
|
+
['/v1/website-chats/{website_chat_id}']: {
|
|
1458
1616
|
/**
|
|
1459
|
-
*
|
|
1617
|
+
* getWebsiteChat
|
|
1460
1618
|
*/
|
|
1461
1619
|
'get'(
|
|
1462
|
-
parameters?: Parameters<Paths.
|
|
1620
|
+
parameters?: Parameters<Paths.V1WebsiteChats$WebsiteChatId.PathParameters> | null,
|
|
1463
1621
|
data?: any,
|
|
1464
1622
|
config?: AxiosRequestConfig
|
|
1465
|
-
): OperationResponse<Paths.
|
|
1623
|
+
): OperationResponse<Paths.GetWebsiteChat.Responses.$200>
|
|
1466
1624
|
/**
|
|
1467
|
-
*
|
|
1625
|
+
* updateWebsiteChat
|
|
1468
1626
|
*/
|
|
1469
1627
|
'put'(
|
|
1470
|
-
parameters?: Parameters<Paths.
|
|
1471
|
-
data?: Paths.
|
|
1628
|
+
parameters?: Parameters<Paths.V1WebsiteChats$WebsiteChatId.PathParameters> | null,
|
|
1629
|
+
data?: Paths.UpdateWebsiteChat.RequestBody,
|
|
1472
1630
|
config?: AxiosRequestConfig
|
|
1473
|
-
): OperationResponse<Paths.
|
|
1631
|
+
): OperationResponse<Paths.UpdateWebsiteChat.Responses.$200>
|
|
1474
1632
|
/**
|
|
1475
|
-
*
|
|
1633
|
+
* deleteWebsiteChat
|
|
1476
1634
|
*/
|
|
1477
1635
|
'delete'(
|
|
1478
|
-
parameters?: Parameters<Paths.
|
|
1636
|
+
parameters?: Parameters<Paths.DeleteWebsiteChat.QueryParameters & Paths.V1WebsiteChats$WebsiteChatId.PathParameters> | null,
|
|
1479
1637
|
data?: any,
|
|
1480
1638
|
config?: AxiosRequestConfig
|
|
1481
|
-
): OperationResponse<Paths.
|
|
1639
|
+
): OperationResponse<Paths.DeleteWebsiteChat.Responses.$204>
|
|
1482
1640
|
}
|
|
1483
|
-
['/v1/
|
|
1641
|
+
['/v1/website-chats/{website_chat_id}/configuration']: {
|
|
1484
1642
|
/**
|
|
1485
|
-
*
|
|
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.
|
|
1486
1644
|
*/
|
|
1487
1645
|
'get'(
|
|
1488
|
-
parameters?: Parameters<Paths.
|
|
1646
|
+
parameters?: Parameters<Paths.GetPublicWebsiteChat.PathParameters> | null,
|
|
1489
1647
|
data?: any,
|
|
1490
1648
|
config?: AxiosRequestConfig
|
|
1491
|
-
): OperationResponse<Paths.
|
|
1649
|
+
): OperationResponse<Paths.GetPublicWebsiteChat.Responses.$200 | Paths.GetPublicWebsiteChat.Responses.Default>
|
|
1492
1650
|
}
|
|
1493
1651
|
['/v1/bootstrap']: {
|
|
1494
1652
|
/**
|
|
1495
|
-
* createPublicChatGrant - Called by the host website with its
|
|
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.
|
|
1496
1654
|
*/
|
|
1497
1655
|
'post'(
|
|
1498
1656
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
@@ -1525,20 +1683,61 @@ interface PathsDictionary {
|
|
|
1525
1683
|
config?: AxiosRequestConfig
|
|
1526
1684
|
): OperationResponse<Paths.SendAnonymousChatMessage.Responses.$200 | Paths.SendAnonymousChatMessage.Responses.Default>
|
|
1527
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
|
+
}
|
|
1528
1726
|
}
|
|
1529
1727
|
|
|
1530
1728
|
type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
1531
1729
|
|
|
1532
1730
|
|
|
1533
|
-
type
|
|
1534
|
-
type CreateChatWidgetRequest = Components.Schemas.CreateChatWidgetRequest;
|
|
1731
|
+
type CreateWebsiteChatRequest = Components.Schemas.CreateWebsiteChatRequest;
|
|
1535
1732
|
type Error = Components.Schemas.Error;
|
|
1536
|
-
type
|
|
1733
|
+
type ListWebsiteChatsResponse = Components.Schemas.ListWebsiteChatsResponse;
|
|
1537
1734
|
type PublicChatError = Components.Schemas.PublicChatError;
|
|
1538
1735
|
type PublicEvent = Components.Schemas.PublicEvent;
|
|
1539
|
-
type
|
|
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;
|
|
1540
1741
|
type WebsiteChatSettings = Components.Schemas.WebsiteChatSettings;
|
|
1541
|
-
type Widget = Components.Schemas.Widget;
|
|
1542
|
-
type WidgetDesign = Components.Schemas.WidgetDesign;
|
|
1543
1742
|
|
|
1544
|
-
export { type Client as C, type Error as E, type
|
|
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 };
|