@epilot/sdk 2.20.66 → 2.20.67

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.
Files changed (129) hide show
  1. package/definitions/chat.json +257 -193
  2. package/dist/apis/access-token.cjs +6 -6
  3. package/dist/apis/access-token.js +1 -1
  4. package/dist/apis/address-suggestions.cjs +6 -6
  5. package/dist/apis/address-suggestions.js +1 -1
  6. package/dist/apis/address.cjs +6 -6
  7. package/dist/apis/address.js +1 -1
  8. package/dist/apis/ai-agents.cjs +6 -6
  9. package/dist/apis/ai-agents.js +1 -1
  10. package/dist/apis/app.cjs +6 -6
  11. package/dist/apis/app.js +1 -1
  12. package/dist/apis/audit-logs.cjs +6 -6
  13. package/dist/apis/audit-logs.js +1 -1
  14. package/dist/apis/automation.cjs +6 -6
  15. package/dist/apis/automation.js +1 -1
  16. package/dist/apis/billing.cjs +6 -6
  17. package/dist/apis/billing.js +1 -1
  18. package/dist/apis/blueprint-manifest.cjs +6 -6
  19. package/dist/apis/blueprint-manifest.js +1 -1
  20. package/dist/apis/calendar.cjs +6 -6
  21. package/dist/apis/calendar.js +1 -1
  22. package/dist/apis/chat.cjs +6 -6
  23. package/dist/apis/chat.d.cts +2 -2
  24. package/dist/apis/chat.d.ts +2 -2
  25. package/dist/apis/chat.js +1 -1
  26. package/dist/apis/configuration-hub.cjs +6 -6
  27. package/dist/apis/configuration-hub.js +1 -1
  28. package/dist/apis/consent.cjs +6 -6
  29. package/dist/apis/consent.js +1 -1
  30. package/dist/apis/customer-portal.cjs +6 -6
  31. package/dist/apis/customer-portal.js +1 -1
  32. package/dist/apis/dashboard.cjs +6 -6
  33. package/dist/apis/dashboard.js +1 -1
  34. package/dist/apis/data-governance.cjs +6 -6
  35. package/dist/apis/data-governance.js +1 -1
  36. package/dist/apis/deduplication.cjs +6 -6
  37. package/dist/apis/deduplication.js +1 -1
  38. package/dist/apis/design.cjs +6 -6
  39. package/dist/apis/design.js +1 -1
  40. package/dist/apis/document.cjs +6 -6
  41. package/dist/apis/document.js +1 -1
  42. package/dist/apis/email-settings.cjs +6 -6
  43. package/dist/apis/email-settings.js +1 -1
  44. package/dist/apis/email-template.cjs +6 -6
  45. package/dist/apis/email-template.js +1 -1
  46. package/dist/apis/entity-mapping.cjs +6 -6
  47. package/dist/apis/entity-mapping.js +1 -1
  48. package/dist/apis/entity.cjs +6 -6
  49. package/dist/apis/entity.js +1 -1
  50. package/dist/apis/environments.cjs +6 -6
  51. package/dist/apis/environments.js +1 -1
  52. package/dist/apis/event-catalog.cjs +6 -6
  53. package/dist/apis/event-catalog.js +1 -1
  54. package/dist/apis/external-values.cjs +6 -6
  55. package/dist/apis/external-values.js +1 -1
  56. package/dist/apis/file.cjs +6 -6
  57. package/dist/apis/file.js +1 -1
  58. package/dist/apis/iban.cjs +6 -6
  59. package/dist/apis/iban.js +1 -1
  60. package/dist/apis/identity.cjs +6 -6
  61. package/dist/apis/identity.js +1 -1
  62. package/dist/apis/integration-toolkit.cjs +6 -6
  63. package/dist/apis/integration-toolkit.js +1 -1
  64. package/dist/apis/journey.cjs +6 -6
  65. package/dist/apis/journey.js +1 -1
  66. package/dist/apis/kanban.cjs +6 -6
  67. package/dist/apis/kanban.js +1 -1
  68. package/dist/apis/message.cjs +6 -6
  69. package/dist/apis/message.js +1 -1
  70. package/dist/apis/metering.cjs +6 -6
  71. package/dist/apis/metering.js +1 -1
  72. package/dist/apis/notes.cjs +6 -6
  73. package/dist/apis/notes.js +1 -1
  74. package/dist/apis/notification.cjs +6 -6
  75. package/dist/apis/notification.js +1 -1
  76. package/dist/apis/organization.cjs +6 -6
  77. package/dist/apis/organization.js +1 -1
  78. package/dist/apis/partner-directory.cjs +6 -6
  79. package/dist/apis/partner-directory.js +1 -1
  80. package/dist/apis/permissions.cjs +6 -6
  81. package/dist/apis/permissions.js +1 -1
  82. package/dist/apis/phone-integration.cjs +6 -6
  83. package/dist/apis/phone-integration.js +1 -1
  84. package/dist/apis/pricing-tier.cjs +6 -6
  85. package/dist/apis/pricing-tier.js +1 -1
  86. package/dist/apis/pricing.cjs +6 -6
  87. package/dist/apis/pricing.js +1 -1
  88. package/dist/apis/purpose.cjs +6 -6
  89. package/dist/apis/purpose.js +1 -1
  90. package/dist/apis/query.cjs +6 -6
  91. package/dist/apis/query.js +1 -1
  92. package/dist/apis/sandbox.cjs +6 -6
  93. package/dist/apis/sandbox.js +1 -1
  94. package/dist/apis/sharing.cjs +6 -6
  95. package/dist/apis/sharing.js +1 -1
  96. package/dist/apis/snapshot.cjs +6 -6
  97. package/dist/apis/snapshot.js +1 -1
  98. package/dist/apis/submission.cjs +6 -6
  99. package/dist/apis/submission.js +1 -1
  100. package/dist/apis/target.cjs +6 -6
  101. package/dist/apis/target.js +1 -1
  102. package/dist/apis/targeting.cjs +6 -6
  103. package/dist/apis/targeting.js +1 -1
  104. package/dist/apis/template-variables.cjs +6 -6
  105. package/dist/apis/template-variables.js +1 -1
  106. package/dist/apis/user.cjs +6 -6
  107. package/dist/apis/user.js +1 -1
  108. package/dist/apis/validation-rules.cjs +6 -6
  109. package/dist/apis/validation-rules.js +1 -1
  110. package/dist/apis/webhooks.cjs +6 -6
  111. package/dist/apis/webhooks.js +1 -1
  112. package/dist/apis/workflow-definition.cjs +6 -6
  113. package/dist/apis/workflow-definition.js +1 -1
  114. package/dist/apis/workflow.cjs +6 -6
  115. package/dist/apis/workflow.js +1 -1
  116. package/dist/chat-QZJ5P6HQ.cjs +7 -0
  117. package/dist/chat-T6GUSV2K.js +7 -0
  118. package/dist/{chat.d-BUkItuYX.d.cts → chat.d-B6dICX6Y.d.cts} +177 -71
  119. package/dist/{chat.d-BUkItuYX.d.ts → chat.d-B6dICX6Y.d.ts} +177 -71
  120. package/dist/{chunk-3UL4JWCK.cjs → chunk-JJDDKFBB.cjs} +1 -1
  121. package/dist/{chunk-SGTQJYAX.js → chunk-OOBSXWVB.js} +1 -1
  122. package/dist/index.cjs +8 -8
  123. package/dist/index.d.cts +1 -1
  124. package/dist/index.d.ts +1 -1
  125. package/dist/index.js +1 -1
  126. package/docs/chat.md +64 -37
  127. package/package.json +1 -1
  128. package/dist/chat-UYCCJWAM.js +0 -7
  129. package/dist/chat-YYRMNUXU.cjs +0 -7
package/dist/index.cjs CHANGED
@@ -170,7 +170,7 @@ var _chunkWOUASZJWcjs = require('./chunk-WOUASZJW.cjs');
170
170
 
171
171
 
172
172
 
173
- var _chunk3UL4JWCKcjs = require('./chunk-3UL4JWCK.cjs');
173
+ var _chunkJJDDKFBBcjs = require('./chunk-JJDDKFBB.cjs');
174
174
 
175
175
 
176
176
  var _chunkNJK5F5TFcjs = require('./chunk-NJK5F5TF.cjs');
@@ -244,7 +244,7 @@ var resolveClient = (params) => {
244
244
  }
245
245
  if (!entry.instance) {
246
246
  const definition = entry.loader();
247
- entry.instance = _chunk3UL4JWCKcjs.createApiClient.call(void 0, {
247
+ entry.instance = _chunkJJDDKFBBcjs.createApiClient.call(void 0, {
248
248
  definition,
249
249
  token: state.token,
250
250
  headers: state.globalHeaders,
@@ -277,7 +277,7 @@ var resetAllClients = (registry) => {
277
277
  };
278
278
 
279
279
  // src/apis/_registry.ts
280
- var expandDef = (mod) => _chunk3UL4JWCKcjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
280
+ var expandDef = (mod) => _chunkJJDDKFBBcjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
281
281
  var registerBuiltinApis = (registry) => {
282
282
  registerApi({
283
283
  registry,
@@ -640,9 +640,9 @@ var createSDK = () => {
640
640
  const available = [...registry.keys()].join(", ");
641
641
  throw new Error(`Unknown API: "${name}". Available: ${available}`);
642
642
  }
643
- return _chunk3UL4JWCKcjs.createApiHandle.call(void 0, {
643
+ return _chunkJJDDKFBBcjs.createApiHandle.call(void 0, {
644
644
  resolveClient: () => resolveClient({ registry, name, state }),
645
- createClient: () => _chunk3UL4JWCKcjs.createApiClient.call(void 0, { definition: entry.loader(), apiName: name }),
645
+ createClient: () => _chunkJJDDKFBBcjs.createApiClient.call(void 0, { definition: entry.loader(), apiName: name }),
646
646
  apiName: name
647
647
  });
648
648
  };
@@ -690,9 +690,9 @@ var createSDK = () => {
690
690
  return interceptorUse;
691
691
  }
692
692
  case "help":
693
- return (apiName) => _chunk3UL4JWCKcjs.help.call(void 0, apiName);
693
+ return (apiName) => _chunkJJDDKFBBcjs.help.call(void 0, apiName);
694
694
  case "openapi":
695
- return (apiName) => _chunk3UL4JWCKcjs.openapi.call(void 0, apiName);
695
+ return (apiName) => _chunkJJDDKFBBcjs.openapi.call(void 0, apiName);
696
696
  case "then":
697
697
  case "catch":
698
698
  case "finally":
@@ -722,4 +722,4 @@ var epilot = createSDK();
722
722
 
723
723
 
724
724
 
725
- exports.applyLargeResponseInterceptor = applyLargeResponseInterceptor; exports.applyRetryInterceptor = applyRetryInterceptor; exports.authorize = _chunk3UL4JWCKcjs.authorize; exports.createSDK = createSDK; exports.epilot = epilot; exports.help = _chunk3UL4JWCKcjs.help; exports.openapi = _chunk3UL4JWCKcjs.openapi;
725
+ exports.applyLargeResponseInterceptor = applyLargeResponseInterceptor; exports.applyRetryInterceptor = applyRetryInterceptor; exports.authorize = _chunkJJDDKFBBcjs.authorize; exports.createSDK = createSDK; exports.epilot = epilot; exports.help = _chunkJJDDKFBBcjs.help; exports.openapi = _chunkJJDDKFBBcjs.openapi;
package/dist/index.d.cts CHANGED
@@ -13,7 +13,7 @@ import { C as Client$6 } from './automation.d-B8g3nYp-.cjs';
13
13
  import { C as Client$7 } from './billing.d-DA3sViEF.cjs';
14
14
  import { C as Client$8 } from './blueprint-manifest.d-B8YKYzSJ.cjs';
15
15
  import { C as Client$9 } from './calendar.d-mk-ltGpk.cjs';
16
- import { C as Client$a } from './chat.d-BUkItuYX.cjs';
16
+ import { C as Client$a } from './chat.d-B6dICX6Y.cjs';
17
17
  import { C as Client$b } from './configuration-hub.d-DhPrjJkE.cjs';
18
18
  import { C as Client$c } from './consent.d-C2PROHhX.cjs';
19
19
  import { C as Client$d } from './customer-portal.d-CTIzvirI.cjs';
package/dist/index.d.ts CHANGED
@@ -13,7 +13,7 @@ import { C as Client$6 } from './automation.d-B8g3nYp-.js';
13
13
  import { C as Client$7 } from './billing.d-DA3sViEF.js';
14
14
  import { C as Client$8 } from './blueprint-manifest.d-B8YKYzSJ.js';
15
15
  import { C as Client$9 } from './calendar.d-mk-ltGpk.js';
16
- import { C as Client$a } from './chat.d-BUkItuYX.js';
16
+ import { C as Client$a } from './chat.d-B6dICX6Y.js';
17
17
  import { C as Client$b } from './configuration-hub.d-DhPrjJkE.js';
18
18
  import { C as Client$c } from './consent.d-C2PROHhX.js';
19
19
  import { C as Client$d } from './customer-portal.d-CTIzvirI.js';
package/dist/index.js CHANGED
@@ -170,7 +170,7 @@ import {
170
170
  expand,
171
171
  help,
172
172
  openapi
173
- } from "./chunk-SGTQJYAX.js";
173
+ } from "./chunk-OOBSXWVB.js";
174
174
  import {
175
175
  __require
176
176
  } from "./chunk-YPSWSI3M.js";
package/docs/chat.md CHANGED
@@ -70,6 +70,7 @@ const { data } = await chatClient.listWebsiteChats(...)
70
70
  - [`VerificationState`](#verificationstate)
71
71
  - [`PortalLoginState`](#portalloginstate)
72
72
  - [`LoginMethod`](#loginmethod)
73
+ - [`AccessMethod`](#accessmethod)
73
74
  - [`AccessTier`](#accesstier)
74
75
  - [`CustomerAccess`](#customeraccess)
75
76
  - [`StarterQuestions`](#starterquestions)
@@ -96,11 +97,9 @@ const { data } = await client.listWebsiteChats({
96
97
  {
97
98
  "website_chats": [
98
99
  {
99
- "name": "string",
100
100
  "agent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
101
101
  "settings": {
102
102
  "allowed_origins": ["string"],
103
- "organisation_name": "string",
104
103
  "default_locale": "en",
105
104
  "design_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
106
105
  "authentication": {
@@ -154,11 +153,9 @@ const { data } = await client.listWebsiteChats({
154
153
  const { data } = await client.createWebsiteChat(
155
154
  null,
156
155
  {
157
- name: 'string',
158
156
  agent_id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
159
157
  settings: {
160
158
  allowed_origins: ['string'],
161
- organisation_name: 'string',
162
159
  default_locale: 'en',
163
160
  design_id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
164
161
  authentication: {
@@ -192,11 +189,9 @@ const { data } = await client.createWebsiteChat(
192
189
 
193
190
  ```json
194
191
  {
195
- "name": "string",
196
192
  "agent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
197
193
  "settings": {
198
194
  "allowed_origins": ["string"],
199
- "organisation_name": "string",
200
195
  "default_locale": "en",
201
196
  "design_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
202
197
  "authentication": {
@@ -254,11 +249,9 @@ const { data } = await client.getWebsiteChat({
254
249
 
255
250
  ```json
256
251
  {
257
- "name": "string",
258
252
  "agent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
259
253
  "settings": {
260
254
  "allowed_origins": ["string"],
261
- "organisation_name": "string",
262
255
  "default_locale": "en",
263
256
  "design_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
264
257
  "authentication": {
@@ -311,11 +304,9 @@ const { data } = await client.updateWebsiteChat(
311
304
  website_chat_id: 'example',
312
305
  },
313
306
  {
314
- name: 'string',
315
307
  agent_id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
316
308
  settings: {
317
309
  allowed_origins: ['string'],
318
- organisation_name: 'string',
319
310
  default_locale: 'en',
320
311
  design_id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
321
312
  authentication: {
@@ -350,11 +341,9 @@ const { data } = await client.updateWebsiteChat(
350
341
 
351
342
  ```json
352
343
  {
353
- "name": "string",
354
344
  "agent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
355
345
  "settings": {
356
346
  "allowed_origins": ["string"],
357
- "organisation_name": "string",
358
347
  "default_locale": "en",
359
348
  "design_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
360
349
  "authentication": {
@@ -420,7 +409,8 @@ const { data } = await client.createWebsiteChatPreviewGrant(
420
409
  website_chat_id: 'example',
421
410
  },
422
411
  {
423
- design_id: '3fa85f64-5717-4562-b3fc-2c963f66afa6'
412
+ design_id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
413
+ demo_customer: false
424
414
  },
425
415
  )
426
416
  ```
@@ -435,8 +425,14 @@ const { data } = await client.createWebsiteChatPreviewGrant(
435
425
  "frame_origin": "https://example.com/path",
436
426
  "website_chat": {
437
427
  "key": "string",
438
- "organisationName": "string",
439
- "assistantName": "string",
428
+ "assistant_name": {
429
+ "de": "string",
430
+ "en": "string"
431
+ },
432
+ "greeting": {
433
+ "de": "string",
434
+ "en": "string"
435
+ },
440
436
  "defaultLocale": "en",
441
437
  "login_methods": ["email_code"],
442
438
  "starters": {
@@ -508,8 +504,14 @@ const { data } = await client.getPublicWebsiteChat({
508
504
  ```json
509
505
  {
510
506
  "key": "string",
511
- "organisationName": "string",
512
- "assistantName": "string",
507
+ "assistant_name": {
508
+ "de": "string",
509
+ "en": "string"
510
+ },
511
+ "greeting": {
512
+ "de": "string",
513
+ "en": "string"
514
+ },
513
515
  "defaultLocale": "en",
514
516
  "login_methods": ["email_code"],
515
517
  "starters": {
@@ -615,8 +617,14 @@ const { data } = await client.createAnonymousChatSession(
615
617
  "expires_at": 0,
616
618
  "website_chat": {
617
619
  "key": "string",
618
- "organisationName": "string",
619
- "assistantName": "string",
620
+ "assistant_name": {
621
+ "de": "string",
622
+ "en": "string"
623
+ },
624
+ "greeting": {
625
+ "de": "string",
626
+ "en": "string"
627
+ },
620
628
  "defaultLocale": "en",
621
629
  "login_methods": ["email_code"],
622
630
  "starters": {
@@ -665,7 +673,11 @@ const { data } = await client.createAnonymousChatSession(
665
673
  },
666
674
  "locales": ["en"]
667
675
  },
668
- "preview": true
676
+ "preview": true,
677
+ "access": {
678
+ "tier": "anonymous",
679
+ "method": "email_code"
680
+ }
669
681
  }
670
682
  ```
671
683
 
@@ -1317,11 +1329,9 @@ const { data } = await client.cancelChatAction(
1317
1329
  ```ts
1318
1330
  type ListWebsiteChatsResponse = {
1319
1331
  website_chats: Array<{
1320
- name: string
1321
1332
  agent_id: string // uuid
1322
1333
  settings: {
1323
1334
  allowed_origins: { ... }
1324
- organisation_name: { ... }
1325
1335
  default_locale: { ... }
1326
1336
  design_id?: { ... }
1327
1337
  authentication?: { ... }
@@ -1347,11 +1357,9 @@ type ListWebsiteChatsResponse = {
1347
1357
 
1348
1358
  ```ts
1349
1359
  type WebsiteChat = {
1350
- name: string
1351
1360
  agent_id: string // uuid
1352
1361
  settings: {
1353
1362
  allowed_origins: string[]
1354
- organisation_name: string
1355
1363
  default_locale: "en" | "de"
1356
1364
  design_id?: string // uuid
1357
1365
  authentication?: {
@@ -1381,7 +1389,6 @@ type WebsiteChat = {
1381
1389
  ```ts
1382
1390
  type WebsiteChatSettings = {
1383
1391
  allowed_origins: string[]
1384
- organisation_name: string
1385
1392
  default_locale: "en" | "de"
1386
1393
  design_id?: string // uuid
1387
1394
  authentication?: {
@@ -1445,6 +1452,7 @@ type SelfServiceAction = {
1445
1452
  ```ts
1446
1453
  type WebsiteChatPreviewGrantRequest = {
1447
1454
  design_id?: string // uuid
1455
+ demo_customer?: boolean
1448
1456
  }
1449
1457
  ```
1450
1458
 
@@ -1457,8 +1465,14 @@ type WebsiteChatPreviewGrant = {
1457
1465
  frame_origin: string // uri
1458
1466
  website_chat: {
1459
1467
  key: string
1460
- organisationName: string
1461
- assistantName: string
1468
+ assistant_name?: {
1469
+ de?: { ... }
1470
+ en?: { ... }
1471
+ }
1472
+ greeting?: {
1473
+ de?: { ... }
1474
+ en?: { ... }
1475
+ }
1462
1476
  defaultLocale: "en" | "de"
1463
1477
  login_methods: "email_code" | "portal_login"[]
1464
1478
  starters?: {
@@ -1494,11 +1508,9 @@ type Error = {
1494
1508
 
1495
1509
  ```ts
1496
1510
  type CreateWebsiteChatRequest = {
1497
- name: string
1498
1511
  agent_id: string // uuid
1499
1512
  settings: {
1500
1513
  allowed_origins: string[]
1501
- organisation_name: string
1502
1514
  default_locale: "en" | "de"
1503
1515
  design_id?: string // uuid
1504
1516
  authentication?: {
@@ -1516,11 +1528,9 @@ type CreateWebsiteChatRequest = {
1516
1528
 
1517
1529
  ```ts
1518
1530
  type UpdateWebsiteChatRequest = {
1519
- name?: string
1520
1531
  agent_id?: string // uuid
1521
1532
  settings?: {
1522
1533
  allowed_origins: string[]
1523
- organisation_name: string
1524
1534
  default_locale: "en" | "de"
1525
1535
  design_id?: string // uuid
1526
1536
  authentication?: {
@@ -1591,7 +1601,7 @@ type VerificationState = {
1591
1601
  contact_resolution?: "matched" | "ambiguous" | "not_found"
1592
1602
  access: {
1593
1603
  tier: "anonymous" | "identified" | "verified"
1594
- method?: "email_code" | "portal_login"
1604
+ method?: "email_code" | "portal_login" | "demo"
1595
1605
  }
1596
1606
  }
1597
1607
  ```
@@ -1610,7 +1620,7 @@ type PortalLoginState = {
1610
1620
  contact_resolution?: "matched" | "not_found"
1611
1621
  access: {
1612
1622
  tier: "anonymous" | "identified" | "verified"
1613
- method?: "email_code" | "portal_login"
1623
+ method?: "email_code" | "portal_login" | "demo"
1614
1624
  }
1615
1625
  }
1616
1626
  ```
@@ -1623,10 +1633,21 @@ How a customer can log in or verify themselves in the chat.
1623
1633
  type LoginMethod = "email_code" | "portal_login"
1624
1634
  ```
1625
1635
 
1636
+ ### `AccessMethod`
1637
+
1638
+ How the current customer identity was established. demo is the fictional, verified
1639
+ customer of an Agent Builder preview; it is never a login method.
1640
+
1641
+
1642
+ ```ts
1643
+ type AccessMethod = "email_code" | "portal_login" | "demo"
1644
+ ```
1645
+
1626
1646
  ### `AccessTier`
1627
1647
 
1628
1648
  anonymous: no customer identity. identified: the Contact is known but ownership
1629
- is not proven. verified: ownership is proven (an email code or a portal login).
1649
+ is not proven. verified: ownership is proven (an email code or a portal login), or the
1650
+ demo customer of an Agent Builder preview.
1630
1651
 
1631
1652
 
1632
1653
  ```ts
@@ -1638,7 +1659,7 @@ type AccessTier = "anonymous" | "identified" | "verified"
1638
1659
  ```ts
1639
1660
  type CustomerAccess = {
1640
1661
  tier: "anonymous" | "identified" | "verified"
1641
- method?: "email_code" | "portal_login"
1662
+ method?: "email_code" | "portal_login" | "demo"
1642
1663
  }
1643
1664
  ```
1644
1665
 
@@ -1655,8 +1676,14 @@ type StarterQuestions = string[]
1655
1676
  ```ts
1656
1677
  type PublicWebsiteChat = {
1657
1678
  key: string
1658
- organisationName: string
1659
- assistantName: string
1679
+ assistant_name?: {
1680
+ de?: string
1681
+ en?: string
1682
+ }
1683
+ greeting?: {
1684
+ de?: string
1685
+ en?: string
1686
+ }
1660
1687
  defaultLocale: "en" | "de"
1661
1688
  login_methods: "email_code" | "portal_login"[]
1662
1689
  starters?: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/sdk",
3
- "version": "2.20.66",
3
+ "version": "2.20.67",
4
4
  "description": "JavaScript/TypeScript SDK for epilot APIs",
5
5
  "type": "module",
6
6
  "main": "./dist/index.cjs",
@@ -1,7 +0,0 @@
1
- import "./chunk-YPSWSI3M.js";
2
-
3
- // src/docs/chat.json
4
- var chat_default = '# epilot Chat API\n\n- **Base URL:** `https://chat.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/chat](https://docs.epilot.io/api/chat)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.chat.listWebsiteChats(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/chat\'\n\nconst chatClient = getClient()\nauthorize(chatClient, () => \'<token>\')\nconst { data } = await chatClient.listWebsiteChats(...)\n```\n\n## Operations\n\n**Website Chats**\n- [`listWebsiteChats`](#listwebsitechats)\n- [`createWebsiteChat`](#createwebsitechat)\n- [`getWebsiteChat`](#getwebsitechat)\n- [`updateWebsiteChat`](#updatewebsitechat)\n- [`deleteWebsiteChat`](#deletewebsitechat)\n- [`createWebsiteChatPreviewGrant`](#createwebsitechatpreviewgrant)\n\n**Other**\n- [`getPublicWebsiteChat`](#getpublicwebsitechat)\n- [`createPublicChatGrant`](#createpublicchatgrant)\n- [`createAnonymousChatSession`](#createanonymouschatsession)\n- [`sendAnonymousChatMessage`](#sendanonymouschatmessage)\n- [`getChatVerification`](#getchatverification)\n- [`startChatEmailVerification`](#startchatemailverification)\n- [`verifyChatEmailCode`](#verifychatemailcode)\n- [`cancelChatVerification`](#cancelchatverification)\n- [`getChatPortalLogin`](#getchatportallogin)\n- [`getChatPortalJourneyToken`](#getchatportaljourneytoken)\n- [`startChatPortalLogin`](#startchatportallogin)\n- [`verifyChatPortalLogin`](#verifychatportallogin)\n- [`cancelChatPortalLogin`](#cancelchatportallogin)\n- [`signOutChatCustomer`](#signoutchatcustomer)\n- [`getChatAction`](#getchataction)\n- [`startChatAction`](#startchataction)\n- [`reportChatActionEvent`](#reportchatactionevent)\n- [`submitChatAction`](#submitchataction)\n- [`confirmChatAction`](#confirmchataction)\n- [`cancelChatAction`](#cancelchataction)\n\n**Schemas**\n- [`ListWebsiteChatsResponse`](#listwebsitechatsresponse)\n- [`WebsiteChat`](#websitechat)\n- [`WebsiteChatSettings`](#websitechatsettings)\n- [`SelfServiceSettings`](#selfservicesettings)\n- [`SelfServiceAction`](#selfserviceaction)\n- [`WebsiteChatPreviewGrantRequest`](#websitechatpreviewgrantrequest)\n- [`WebsiteChatPreviewGrant`](#websitechatpreviewgrant)\n- [`Error`](#error)\n- [`CreateWebsiteChatRequest`](#createwebsitechatrequest)\n- [`UpdateWebsiteChatRequest`](#updatewebsitechatrequest)\n- [`ActionRevision`](#actionrevision)\n- [`ActionState`](#actionstate)\n- [`VerificationState`](#verificationstate)\n- [`PortalLoginState`](#portalloginstate)\n- [`LoginMethod`](#loginmethod)\n- [`AccessTier`](#accesstier)\n- [`CustomerAccess`](#customeraccess)\n- [`StarterQuestions`](#starterquestions)\n- [`PublicWebsiteChat`](#publicwebsitechat)\n- [`WebsiteChatDesign`](#websitechatdesign)\n- [`PublicEvent`](#publicevent)\n- [`SelfServiceDirective`](#selfservicedirective)\n- [`PublicChatError`](#publicchaterror)\n\n### `listWebsiteChats`\n\n`GET /v1/website-chats`\n\n```ts\nconst { data } = await client.listWebsiteChats({\n cursor: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "website_chats": [\n {\n "name": "string",\n "agent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "settings": {\n "allowed_origins": ["string"],\n "organisation_name": "string",\n "default_locale": "en",\n "design_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "authentication": {\n "email_code": {\n "email_template_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"\n },\n "portal": {\n "portal_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"\n }\n },\n "self_service": {\n "actions": [\n {\n "action": "submit_meter_reading",\n "enabled": true,\n "fulfilment": "in_chat",\n "journey_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "url": "string",\n "access": "anonymous",\n "guidance": "string"\n }\n ]\n }\n },\n "website_chat_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "org_id": "string",\n "binding_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "version": 1,\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "embed": {\n "script_url": "https://example.com/path",\n "chat_api_origin": "https://example.com/path",\n "demo_url": "https://example.com/path"\n }\n }\n ],\n "next_cursor": "string"\n}\n```\n\n</details>\n\n---\n\n### `createWebsiteChat`\n\n`POST /v1/website-chats`\n\n```ts\nconst { data } = await client.createWebsiteChat(\n null,\n {\n name: \'string\',\n agent_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n settings: {\n allowed_origins: [\'string\'],\n organisation_name: \'string\',\n default_locale: \'en\',\n design_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n authentication: {\n email_code: {\n email_template_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\'\n },\n portal: {\n portal_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\'\n }\n },\n self_service: {\n actions: [\n {\n action: \'submit_meter_reading\',\n enabled: true,\n fulfilment: \'in_chat\',\n journey_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n url: \'string\',\n access: \'anonymous\',\n guidance: \'string\'\n }\n ]\n }\n }\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "name": "string",\n "agent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "settings": {\n "allowed_origins": ["string"],\n "organisation_name": "string",\n "default_locale": "en",\n "design_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "authentication": {\n "email_code": {\n "email_template_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"\n },\n "portal": {\n "portal_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"\n }\n },\n "self_service": {\n "actions": [\n {\n "action": "submit_meter_reading",\n "enabled": true,\n "fulfilment": "in_chat",\n "journey_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "url": "string",\n "access": "anonymous",\n "guidance": "string"\n }\n ]\n }\n },\n "website_chat_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "org_id": "string",\n "binding_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "version": 1,\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "embed": {\n "script_url": "https://example.com/path",\n "chat_api_origin": "https://example.com/path",\n "demo_url": "https://example.com/path"\n }\n}\n```\n\n</details>\n\n---\n\n### `getWebsiteChat`\n\n`GET /v1/website-chats/{website_chat_id}`\n\n```ts\nconst { data } = await client.getWebsiteChat({\n website_chat_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "name": "string",\n "agent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "settings": {\n "allowed_origins": ["string"],\n "organisation_name": "string",\n "default_locale": "en",\n "design_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "authentication": {\n "email_code": {\n "email_template_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"\n },\n "portal": {\n "portal_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"\n }\n },\n "self_service": {\n "actions": [\n {\n "action": "submit_meter_reading",\n "enabled": true,\n "fulfilment": "in_chat",\n "journey_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "url": "string",\n "access": "anonymous",\n "guidance": "string"\n }\n ]\n }\n },\n "website_chat_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "org_id": "string",\n "binding_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "version": 1,\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "embed": {\n "script_url": "https://example.com/path",\n "chat_api_origin": "https://example.com/path",\n "demo_url": "https://example.com/path"\n }\n}\n```\n\n</details>\n\n---\n\n### `updateWebsiteChat`\n\n`PUT /v1/website-chats/{website_chat_id}`\n\n```ts\nconst { data } = await client.updateWebsiteChat(\n {\n website_chat_id: \'example\',\n },\n {\n name: \'string\',\n agent_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n settings: {\n allowed_origins: [\'string\'],\n organisation_name: \'string\',\n default_locale: \'en\',\n design_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n authentication: {\n email_code: {\n email_template_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\'\n },\n portal: {\n portal_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\'\n }\n },\n self_service: {\n actions: [\n {\n action: \'submit_meter_reading\',\n enabled: true,\n fulfilment: \'in_chat\',\n journey_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n url: \'string\',\n access: \'anonymous\',\n guidance: \'string\'\n }\n ]\n }\n },\n version: 1\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "name": "string",\n "agent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "settings": {\n "allowed_origins": ["string"],\n "organisation_name": "string",\n "default_locale": "en",\n "design_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "authentication": {\n "email_code": {\n "email_template_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"\n },\n "portal": {\n "portal_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"\n }\n },\n "self_service": {\n "actions": [\n {\n "action": "submit_meter_reading",\n "enabled": true,\n "fulfilment": "in_chat",\n "journey_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "url": "string",\n "access": "anonymous",\n "guidance": "string"\n }\n ]\n }\n },\n "website_chat_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "org_id": "string",\n "binding_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "version": 1,\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "embed": {\n "script_url": "https://example.com/path",\n "chat_api_origin": "https://example.com/path",\n "demo_url": "https://example.com/path"\n }\n}\n```\n\n</details>\n\n---\n\n### `deleteWebsiteChat`\n\n`DELETE /v1/website-chats/{website_chat_id}`\n\n```ts\nconst { data } = await client.deleteWebsiteChat({\n website_chat_id: \'example\',\n version: 1,\n})\n```\n\n---\n\n### `createWebsiteChatPreviewGrant`\n\n`POST /v1/website-chats/{website_chat_id}/preview-grant`\n\n```ts\nconst { data } = await client.createWebsiteChatPreviewGrant(\n {\n website_chat_id: \'example\',\n },\n {\n design_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "grant": "string",\n "expires_in": 0,\n "frame_origin": "https://example.com/path",\n "website_chat": {\n "key": "string",\n "organisationName": "string",\n "assistantName": "string",\n "defaultLocale": "en",\n "login_methods": ["email_code"],\n "starters": {\n "de": ["string"],\n "en": ["string"]\n },\n "actions": {\n "meter_reading": true,\n "meter_reading_journey_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"\n },\n "design": {\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "last_modified_at": "string",\n "style": {\n "palette": {\n "primary": "string",\n "background": "string"\n },\n "typography": {\n "font": {\n "font_family": "string"\n }\n },\n "shape": {\n "border_radius": 0\n }\n },\n "spark_theme": {\n "accentColor": "string",\n "backgroundColor": "string",\n "fontBody": "string",\n "fontHeading": "string",\n "radius": "string",\n "scaling": "string",\n "spacing": "string",\n "appearance": "string",\n "neutralColor": "string",\n "styleVariant": "string",\n "labelPosition": "string",\n "inputStyle": "string",\n "inputColor": "string",\n "cardVariant": "string",\n "cardColor": "string",\n "highContrast": true\n }\n },\n "locales": ["en"]\n }\n}\n```\n\n</details>\n\n---\n\n### `getPublicWebsiteChat`\n\n`GET /v1/website-chats/{website_chat_id}/configuration`\n\n```ts\nconst { data } = await client.getPublicWebsiteChat({\n website_chat_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "key": "string",\n "organisationName": "string",\n "assistantName": "string",\n "defaultLocale": "en",\n "login_methods": ["email_code"],\n "starters": {\n "de": ["string"],\n "en": ["string"]\n },\n "actions": {\n "meter_reading": true,\n "meter_reading_journey_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"\n },\n "design": {\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "last_modified_at": "string",\n "style": {\n "palette": {\n "primary": "string",\n "background": "string"\n },\n "typography": {\n "font": {\n "font_family": "string"\n }\n },\n "shape": {\n "border_radius": 0\n }\n },\n "spark_theme": {\n "accentColor": "string",\n "backgroundColor": "string",\n "fontBody": "string",\n "fontHeading": "string",\n "radius": "string",\n "scaling": "string",\n "spacing": "string",\n "appearance": "string",\n "neutralColor": "string",\n "styleVariant": "string",\n "labelPosition": "string",\n "inputStyle": "string",\n "inputColor": "string",\n "cardVariant": "string",\n "cardColor": "string",\n "highContrast": true\n }\n },\n "locales": ["en"]\n}\n```\n\n</details>\n\n---\n\n### `createPublicChatGrant`\n\n`POST /v1/bootstrap`\n\n```ts\nconst { data } = await client.createPublicChatGrant(\n null,\n {\n website_chat_id: \'string\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "grant": "string",\n "expires_in": 60,\n "frame_origin": "https://example.com/path"\n}\n```\n\n</details>\n\n---\n\n### `createAnonymousChatSession`\n\n`POST /v1/sessions`\n\n```ts\nconst { data } = await client.createAnonymousChatSession(\n null,\n {\n grant: \'string\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "token": "string",\n "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "expires_at": 0,\n "website_chat": {\n "key": "string",\n "organisationName": "string",\n "assistantName": "string",\n "defaultLocale": "en",\n "login_methods": ["email_code"],\n "starters": {\n "de": ["string"],\n "en": ["string"]\n },\n "actions": {\n "meter_reading": true,\n "meter_reading_journey_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"\n },\n "design": {\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "last_modified_at": "string",\n "style": {\n "palette": {\n "primary": "string",\n "background": "string"\n },\n "typography": {\n "font": {\n "font_family": "string"\n }\n },\n "shape": {\n "border_radius": 0\n }\n },\n "spark_theme": {\n "accentColor": "string",\n "backgroundColor": "string",\n "fontBody": "string",\n "fontHeading": "string",\n "radius": "string",\n "scaling": "string",\n "spacing": "string",\n "appearance": "string",\n "neutralColor": "string",\n "styleVariant": "string",\n "labelPosition": "string",\n "inputStyle": "string",\n "inputColor": "string",\n "cardVariant": "string",\n "cardColor": "string",\n "highContrast": true\n }\n },\n "locales": ["en"]\n },\n "preview": true\n}\n```\n\n</details>\n\n---\n\n### `sendAnonymousChatMessage`\n\n`POST /v1/messages`\n\n```ts\nconst { data } = await client.sendAnonymousChatMessage(\n null,\n {\n request_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n message: \'string\',\n locale: \'en\',\n simple_language: true\n },\n)\n```\n\n---\n\n### `getChatVerification`\n\n`GET /v1/verification`\n\n```ts\nconst { data } = await client.getChatVerification()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "available": true,\n "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "status": "anonymous",\n "challenge_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "code_expires_at": 0,\n "resend_after": 0,\n "email": "user@example.com",\n "contact_resolution": "matched",\n "access": {\n "tier": "anonymous",\n "method": "email_code"\n }\n}\n```\n\n</details>\n\n---\n\n### `startChatEmailVerification`\n\n`POST /v1/verification/email`\n\n```ts\nconst { data } = await client.startChatEmailVerification(\n null,\n {\n request_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n email: \'user@example.com\',\n locale: \'en\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "available": true,\n "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "status": "anonymous",\n "challenge_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "code_expires_at": 0,\n "resend_after": 0,\n "email": "user@example.com",\n "contact_resolution": "matched",\n "access": {\n "tier": "anonymous",\n "method": "email_code"\n }\n}\n```\n\n</details>\n\n---\n\n### `verifyChatEmailCode`\n\n`POST /v1/verification/code`\n\n```ts\nconst { data } = await client.verifyChatEmailCode(\n null,\n {\n challenge_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n code: \'string\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "available": true,\n "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "status": "anonymous",\n "challenge_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "code_expires_at": 0,\n "resend_after": 0,\n "email": "user@example.com",\n "contact_resolution": "matched",\n "access": {\n "tier": "anonymous",\n "method": "email_code"\n }\n}\n```\n\n</details>\n\n---\n\n### `cancelChatVerification`\n\n`POST /v1/verification/cancel`\n\n```ts\nconst { data } = await client.cancelChatVerification()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "available": true,\n "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "status": "anonymous",\n "challenge_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "code_expires_at": 0,\n "resend_after": 0,\n "email": "user@example.com",\n "contact_resolution": "matched",\n "access": {\n "tier": "anonymous",\n "method": "email_code"\n }\n}\n```\n\n</details>\n\n---\n\n### `getChatPortalLogin`\n\n`GET /v1/login/portal`\n\n```ts\nconst { data } = await client.getChatPortalLogin()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "available": true,\n "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "status": "anonymous",\n "challenge_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "code_expires_at": 0,\n "attempts_left": 0,\n "email": "user@example.com",\n "contact_resolution": "matched",\n "access": {\n "tier": "anonymous",\n "method": "email_code"\n }\n}\n```\n\n</details>\n\n---\n\n### `getChatPortalJourneyToken`\n\n`GET /v1/login/portal/journey-token`\n\n```ts\nconst { data } = await client.getChatPortalJourneyToken()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id_token": "string",\n "expires_at": 0\n}\n```\n\n</details>\n\n---\n\n### `startChatPortalLogin`\n\n`POST /v1/login/portal/start`\n\n```ts\nconst { data } = await client.startChatPortalLogin(\n null,\n {\n request_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n email: \'user@example.com\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "available": true,\n "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "status": "anonymous",\n "challenge_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "code_expires_at": 0,\n "attempts_left": 0,\n "email": "user@example.com",\n "contact_resolution": "matched",\n "access": {\n "tier": "anonymous",\n "method": "email_code"\n }\n}\n```\n\n</details>\n\n---\n\n### `verifyChatPortalLogin`\n\n`POST /v1/login/portal/verify`\n\n```ts\nconst { data } = await client.verifyChatPortalLogin(\n null,\n {\n challenge_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n code: \'string\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "available": true,\n "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "status": "anonymous",\n "challenge_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "code_expires_at": 0,\n "attempts_left": 0,\n "email": "user@example.com",\n "contact_resolution": "matched",\n "access": {\n "tier": "anonymous",\n "method": "email_code"\n }\n}\n```\n\n</details>\n\n---\n\n### `cancelChatPortalLogin`\n\n`POST /v1/login/portal/cancel`\n\n```ts\nconst { data } = await client.cancelChatPortalLogin()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "available": true,\n "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "status": "anonymous",\n "challenge_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "code_expires_at": 0,\n "attempts_left": 0,\n "email": "user@example.com",\n "contact_resolution": "matched",\n "access": {\n "tier": "anonymous",\n "method": "email_code"\n }\n}\n```\n\n</details>\n\n---\n\n### `signOutChatCustomer`\n\n`POST /v1/login/sign-out`\n\n```ts\nconst { data } = await client.signOutChatCustomer()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "access": {\n "tier": "anonymous",\n "method": "email_code"\n }\n}\n```\n\n</details>\n\n---\n\n### `getChatAction`\n\n`GET /v1/actions`\n\n```ts\nconst { data } = await client.getChatAction()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "status": "none",\n "action_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "revision": 0,\n "options": [\n {\n "meter_id": "string",\n "counter_id": "string",\n "meter_number": "string",\n "label": "string",\n "unit": "string",\n "min_value": 0,\n "max_value": 0\n }\n ],\n "values": {\n "meter_id": "string",\n "counter_id": "string",\n "value": 0\n },\n "field_error": "VALUE_INVALID",\n "receipt": {\n "reference": "string",\n "meter_number": "string",\n "value": 0,\n "unit": "string",\n "submitted_at": "string"\n },\n "reason": "NO_METERS"\n}\n```\n\n</details>\n\n---\n\n### `startChatAction`\n\n`POST /v1/actions`\n\n```ts\nconst { data } = await client.startChatAction(\n null,\n {\n request_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n action_type: \'submit_meter_reading\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "status": "none",\n "action_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "revision": 0,\n "options": [\n {\n "meter_id": "string",\n "counter_id": "string",\n "meter_number": "string",\n "label": "string",\n "unit": "string",\n "min_value": 0,\n "max_value": 0\n }\n ],\n "values": {\n "meter_id": "string",\n "counter_id": "string",\n "value": 0\n },\n "field_error": "VALUE_INVALID",\n "receipt": {\n "reference": "string",\n "meter_number": "string",\n "value": 0,\n "unit": "string",\n "submitted_at": "string"\n },\n "reason": "NO_METERS"\n}\n```\n\n</details>\n\n---\n\n### `reportChatActionEvent`\n\n`POST /v1/actions/events`\n\n```ts\nconst { data } = await client.reportChatActionEvent(\n null,\n {\n action: \'string\',\n event: \'journey_submitted\'\n },\n)\n```\n\n---\n\n### `submitChatAction`\n\n`POST /v1/actions/{action_id}/submit`\n\n```ts\nconst { data } = await client.submitChatAction(\n {\n action_id: \'example\',\n },\n {\n expected_revision: 1,\n meter_id: \'string\',\n counter_id: \'string\',\n value: 0\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "status": "none",\n "action_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "revision": 0,\n "options": [\n {\n "meter_id": "string",\n "counter_id": "string",\n "meter_number": "string",\n "label": "string",\n "unit": "string",\n "min_value": 0,\n "max_value": 0\n }\n ],\n "values": {\n "meter_id": "string",\n "counter_id": "string",\n "value": 0\n },\n "field_error": "VALUE_INVALID",\n "receipt": {\n "reference": "string",\n "meter_number": "string",\n "value": 0,\n "unit": "string",\n "submitted_at": "string"\n },\n "reason": "NO_METERS"\n}\n```\n\n</details>\n\n---\n\n### `confirmChatAction`\n\n`POST /v1/actions/{action_id}/confirm`\n\n```ts\nconst { data } = await client.confirmChatAction(\n {\n action_id: \'example\',\n },\n {\n expected_revision: 1\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "status": "none",\n "action_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "revision": 0,\n "options": [\n {\n "meter_id": "string",\n "counter_id": "string",\n "meter_number": "string",\n "label": "string",\n "unit": "string",\n "min_value": 0,\n "max_value": 0\n }\n ],\n "values": {\n "meter_id": "string",\n "counter_id": "string",\n "value": 0\n },\n "field_error": "VALUE_INVALID",\n "receipt": {\n "reference": "string",\n "meter_number": "string",\n "value": 0,\n "unit": "string",\n "submitted_at": "string"\n },\n "reason": "NO_METERS"\n}\n```\n\n</details>\n\n---\n\n### `cancelChatAction`\n\n`POST /v1/actions/{action_id}/cancel`\n\n```ts\nconst { data } = await client.cancelChatAction(\n {\n action_id: \'example\',\n },\n {\n expected_revision: 1\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "status": "none",\n "action_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "revision": 0,\n "options": [\n {\n "meter_id": "string",\n "counter_id": "string",\n "meter_number": "string",\n "label": "string",\n "unit": "string",\n "min_value": 0,\n "max_value": 0\n }\n ],\n "values": {\n "meter_id": "string",\n "counter_id": "string",\n "value": 0\n },\n "field_error": "VALUE_INVALID",\n "receipt": {\n "reference": "string",\n "meter_number": "string",\n "value": 0,\n "unit": "string",\n "submitted_at": "string"\n },\n "reason": "NO_METERS"\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `ListWebsiteChatsResponse`\n\n```ts\ntype ListWebsiteChatsResponse = {\n website_chats: Array<{\n name: string\n agent_id: string // uuid\n settings: {\n allowed_origins: { ... }\n organisation_name: { ... }\n default_locale: { ... }\n design_id?: { ... }\n authentication?: { ... }\n self_service?: { ... }\n }\n website_chat_id: string // uuid\n org_id: string\n binding_id: string // uuid\n version: number\n created_at: string // date-time\n updated_at: string // date-time\n embed: {\n script_url: { ... }\n chat_api_origin: { ... }\n demo_url: { ... }\n }\n }>\n next_cursor?: string\n}\n```\n\n### `WebsiteChat`\n\n```ts\ntype WebsiteChat = {\n name: string\n agent_id: string // uuid\n settings: {\n allowed_origins: string[]\n organisation_name: string\n default_locale: "en" | "de"\n design_id?: string // uuid\n authentication?: {\n email_code?: { ... }\n portal?: { ... }\n }\n self_service?: {\n actions: { ... }\n }\n }\n website_chat_id: string // uuid\n org_id: string\n binding_id: string // uuid\n version: number\n created_at: string // date-time\n updated_at: string // date-time\n embed: {\n script_url: string // uri\n chat_api_origin: string // uri\n demo_url: string // uri\n }\n}\n```\n\n### `WebsiteChatSettings`\n\n```ts\ntype WebsiteChatSettings = {\n allowed_origins: string[]\n organisation_name: string\n default_locale: "en" | "de"\n design_id?: string // uuid\n authentication?: {\n email_code?: {\n email_template_id?: { ... }\n }\n portal?: {\n portal_id: { ... }\n }\n }\n self_service?: {\n actions: Array<{\n action: { ... }\n enabled: { ... }\n fulfilment: { ... }\n journey_id?: { ... }\n url?: { ... }\n access: { ... }\n guidance?: { ... }\n }>\n }\n}\n```\n\n### `SelfServiceSettings`\n\nSelf-service actions customers can start in this Website Chat. On update, the list is replaced as a whole; null removes all actions.\n\n```ts\ntype SelfServiceSettings = {\n actions: Array<{\n action: "submit_meter_reading" | "change_installment_rate" | "update_payment_method" | "change_billing_address" | "update_customer_details" | "change_tariff" | "report_move" | "terminate_contract"\n enabled: boolean\n fulfilment: "in_chat" | "journey" | "link"\n journey_id?: string // uuid\n url?: string\n access: "anonymous" | "identified" | "verified"\n guidance?: string\n }>\n}\n```\n\n### `SelfServiceAction`\n\nHow a self-service action is done and who can start it. A journey needs journey_id, a link needs url. in_chat is only available for submit_meter_reading and requires a verified customer.\n\n```ts\ntype SelfServiceAction = {\n action: "submit_meter_reading" | "change_installment_rate" | "update_payment_method" | "change_billing_address" | "update_customer_details" | "change_tariff" | "report_move" | "terminate_contract"\n enabled: boolean\n fulfilment: "in_chat" | "journey" | "link"\n journey_id?: string // uuid\n url?: string\n access: "anonymous" | "identified" | "verified"\n guidance?: string\n}\n```\n\n### `WebsiteChatPreviewGrantRequest`\n\n```ts\ntype WebsiteChatPreviewGrantRequest = {\n design_id?: string // uuid\n}\n```\n\n### `WebsiteChatPreviewGrant`\n\n```ts\ntype WebsiteChatPreviewGrant = {\n grant: string\n expires_in: number\n frame_origin: string // uri\n website_chat: {\n key: string\n organisationName: string\n assistantName: string\n defaultLocale: "en" | "de"\n login_methods: "email_code" | "portal_login"[]\n starters?: {\n de?: { ... }\n en?: { ... }\n }\n actions?: {\n meter_reading?: { ... }\n meter_reading_journey_id?: { ... }\n }\n design?: {\n id: { ... }\n last_modified_at?: { ... }\n style?: { ... }\n spark_theme?: { ... }\n }\n locales: "en" | "de"[]\n }\n}\n```\n\n### `Error`\n\n```ts\ntype Error = {\n error?: string\n message?: string\n details?: object\n}\n```\n\n### `CreateWebsiteChatRequest`\n\n```ts\ntype CreateWebsiteChatRequest = {\n name: string\n agent_id: string // uuid\n settings: {\n allowed_origins: string[]\n organisation_name: string\n default_locale: "en" | "de"\n design_id?: string // uuid\n authentication?: {\n email_code?: { ... }\n portal?: { ... }\n }\n self_service?: {\n actions: { ... }\n }\n }\n}\n```\n\n### `UpdateWebsiteChatRequest`\n\n```ts\ntype UpdateWebsiteChatRequest = {\n name?: string\n agent_id?: string // uuid\n settings?: {\n allowed_origins: string[]\n organisation_name: string\n default_locale: "en" | "de"\n design_id?: string // uuid\n authentication?: {\n email_code?: { ... }\n portal?: { ... }\n }\n self_service?: {\n actions: { ... }\n }\n }\n version: number\n}\n```\n\n### `ActionRevision`\n\n```ts\ntype ActionRevision = {\n expected_revision: number\n}\n```\n\n### `ActionState`\n\n```ts\ntype ActionState = {\n conversation_id: string // uuid\n status: "none" | "needs_input" | "needs_confirmation" | "executing" | "completed" | "pending" | "rejected" | "handoff"\n action_id?: string // uuid\n revision?: number\n options?: Array<{\n meter_id: string\n counter_id: string\n meter_number: string\n label: string\n unit: string\n min_value?: number\n max_value?: number\n }>\n values?: {\n meter_id: string\n counter_id: string\n value: number\n }\n field_error?: "VALUE_INVALID" | "VALUE_OUT_OF_RANGE" | "TARGET_UNAVAILABLE"\n receipt?: {\n reference: string\n meter_number: string\n value: number\n unit: string\n submitted_at: string\n }\n reason?: "NO_METERS" | "SUBMISSION_REJECTED" | "SUBMISSION_UNCERTAIN"\n}\n```\n\n### `VerificationState`\n\n```ts\ntype VerificationState = {\n available: boolean\n conversation_id: string // uuid\n status: "anonymous" | "sending" | "pending" | "verified"\n challenge_id?: string // uuid\n code_expires_at?: number\n resend_after?: number\n email?: string // email\n contact_resolution?: "matched" | "ambiguous" | "not_found"\n access: {\n tier: "anonymous" | "identified" | "verified"\n method?: "email_code" | "portal_login"\n }\n}\n```\n\n### `PortalLoginState`\n\n```ts\ntype PortalLoginState = {\n available: boolean\n conversation_id: string // uuid\n status: "anonymous" | "pending" | "verified"\n challenge_id?: string // uuid\n code_expires_at?: number\n attempts_left?: number\n email?: string // email\n contact_resolution?: "matched" | "not_found"\n access: {\n tier: "anonymous" | "identified" | "verified"\n method?: "email_code" | "portal_login"\n }\n}\n```\n\n### `LoginMethod`\n\nHow a customer can log in or verify themselves in the chat.\n\n```ts\ntype LoginMethod = "email_code" | "portal_login"\n```\n\n### `AccessTier`\n\nanonymous: no customer identity. identified: the Contact is known but ownership\nis not proven. verified: ownership is proven (an email code or a portal login).\n\n\n```ts\ntype AccessTier = "anonymous" | "identified" | "verified"\n```\n\n### `CustomerAccess`\n\n```ts\ntype CustomerAccess = {\n tier: "anonymous" | "identified" | "verified"\n method?: "email_code" | "portal_login"\n}\n```\n\n### `StarterQuestions`\n\nAt most six. (No maxItems, which generated clients turn into fixed-length tuples.)\n\n```ts\ntype StarterQuestions = string[]\n```\n\n### `PublicWebsiteChat`\n\n```ts\ntype PublicWebsiteChat = {\n key: string\n organisationName: string\n assistantName: string\n defaultLocale: "en" | "de"\n login_methods: "email_code" | "portal_login"[]\n starters?: {\n de?: string[]\n en?: string[]\n }\n actions?: {\n meter_reading?: boolean\n meter_reading_journey_id?: string // uuid\n }\n design?: {\n id: string // uuid\n last_modified_at?: string\n style?: {\n palette?: { ... }\n typography?: { ... }\n shape?: { ... }\n }\n spark_theme?: {\n accentColor?: { ... }\n backgroundColor?: { ... }\n fontBody?: { ... }\n fontHeading?: { ... }\n radius?: { ... }\n scaling?: { ... }\n spacing?: { ... }\n appearance?: { ... }\n neutralColor?: { ... }\n styleVariant?: { ... }\n labelPosition?: { ... }\n inputStyle?: { ... }\n inputColor?: { ... }\n cardVariant?: { ... }\n cardColor?: { ... }\n highContrast?: { ... }\n }\n }\n locales: "en" | "de"[]\n}\n```\n\n### `WebsiteChatDesign`\n\n```ts\ntype WebsiteChatDesign = {\n id: string // uuid\n last_modified_at?: string\n style?: {\n palette?: {\n primary?: { ... }\n background?: { ... }\n }\n typography?: {\n font?: { ... }\n }\n shape?: {\n border_radius?: { ... }\n }\n }\n spark_theme?: {\n accentColor?: string\n backgroundColor?: string\n fontBody?: string\n fontHeading?: string\n radius?: string\n scaling?: string\n spacing?: string\n appearance?: string\n neutralColor?: string\n styleVariant?: string\n labelPosition?: string\n inputStyle?: string\n inputColor?: string\n cardVariant?: string\n cardColor?: string\n highContrast?: boolean\n }\n}\n```\n\n### `PublicEvent`\n\nJSON payload of one SSE data frame from sendAnonymousChatMessage.\n\n```ts\ntype PublicEvent = {\n type: "delta"\n text: string\n request_id: string // uuid\n} | {\n type: "complete"\n text: string\n request_id: string // uuid\n} | {\n type: "error"\n code: "UNAVAILABLE"\n request_id: string // uuid\n} | {\n type: "action"\n action: {\n action: string\n fulfilment: "in_chat" | "journey" | "link"\n journey_id?: string // uuid\n url?: string\n access: "anonymous" | "identified" | "verified"\n }\n request_id: string // uuid\n}\n```\n\n### `SelfServiceDirective`\n\n```ts\ntype SelfServiceDirective = {\n action: string\n fulfilment: "in_chat" | "journey" | "link"\n journey_id?: string // uuid\n url?: string\n access: "anonymous" | "identified" | "verified"\n}\n```\n\n### `PublicChatError`\n\n```ts\ntype PublicChatError = {\n 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" | "IDENTITY_REQUIRED" | "ACTION_UNAVAILABLE" | "ACTION_CONFLICT" | "ACTION_TARGET_DENIED" | "INVALID_LOGIN_CODE" | "LOGIN_EXPIRED" | "LOGIN_DISABLED" | "LOGIN_UNAVAILABLE" | "LOGIN_CONFLICT" | "LOGIN_REJECTED"\n attempts_left?: number\n}\n```\n';
5
- export {
6
- chat_default as default
7
- };
@@ -1,7 +0,0 @@
1
- "use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
2
-
3
- // src/docs/chat.json
4
- var chat_default = '# epilot Chat API\n\n- **Base URL:** `https://chat.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/chat](https://docs.epilot.io/api/chat)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.chat.listWebsiteChats(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/chat\'\n\nconst chatClient = getClient()\nauthorize(chatClient, () => \'<token>\')\nconst { data } = await chatClient.listWebsiteChats(...)\n```\n\n## Operations\n\n**Website Chats**\n- [`listWebsiteChats`](#listwebsitechats)\n- [`createWebsiteChat`](#createwebsitechat)\n- [`getWebsiteChat`](#getwebsitechat)\n- [`updateWebsiteChat`](#updatewebsitechat)\n- [`deleteWebsiteChat`](#deletewebsitechat)\n- [`createWebsiteChatPreviewGrant`](#createwebsitechatpreviewgrant)\n\n**Other**\n- [`getPublicWebsiteChat`](#getpublicwebsitechat)\n- [`createPublicChatGrant`](#createpublicchatgrant)\n- [`createAnonymousChatSession`](#createanonymouschatsession)\n- [`sendAnonymousChatMessage`](#sendanonymouschatmessage)\n- [`getChatVerification`](#getchatverification)\n- [`startChatEmailVerification`](#startchatemailverification)\n- [`verifyChatEmailCode`](#verifychatemailcode)\n- [`cancelChatVerification`](#cancelchatverification)\n- [`getChatPortalLogin`](#getchatportallogin)\n- [`getChatPortalJourneyToken`](#getchatportaljourneytoken)\n- [`startChatPortalLogin`](#startchatportallogin)\n- [`verifyChatPortalLogin`](#verifychatportallogin)\n- [`cancelChatPortalLogin`](#cancelchatportallogin)\n- [`signOutChatCustomer`](#signoutchatcustomer)\n- [`getChatAction`](#getchataction)\n- [`startChatAction`](#startchataction)\n- [`reportChatActionEvent`](#reportchatactionevent)\n- [`submitChatAction`](#submitchataction)\n- [`confirmChatAction`](#confirmchataction)\n- [`cancelChatAction`](#cancelchataction)\n\n**Schemas**\n- [`ListWebsiteChatsResponse`](#listwebsitechatsresponse)\n- [`WebsiteChat`](#websitechat)\n- [`WebsiteChatSettings`](#websitechatsettings)\n- [`SelfServiceSettings`](#selfservicesettings)\n- [`SelfServiceAction`](#selfserviceaction)\n- [`WebsiteChatPreviewGrantRequest`](#websitechatpreviewgrantrequest)\n- [`WebsiteChatPreviewGrant`](#websitechatpreviewgrant)\n- [`Error`](#error)\n- [`CreateWebsiteChatRequest`](#createwebsitechatrequest)\n- [`UpdateWebsiteChatRequest`](#updatewebsitechatrequest)\n- [`ActionRevision`](#actionrevision)\n- [`ActionState`](#actionstate)\n- [`VerificationState`](#verificationstate)\n- [`PortalLoginState`](#portalloginstate)\n- [`LoginMethod`](#loginmethod)\n- [`AccessTier`](#accesstier)\n- [`CustomerAccess`](#customeraccess)\n- [`StarterQuestions`](#starterquestions)\n- [`PublicWebsiteChat`](#publicwebsitechat)\n- [`WebsiteChatDesign`](#websitechatdesign)\n- [`PublicEvent`](#publicevent)\n- [`SelfServiceDirective`](#selfservicedirective)\n- [`PublicChatError`](#publicchaterror)\n\n### `listWebsiteChats`\n\n`GET /v1/website-chats`\n\n```ts\nconst { data } = await client.listWebsiteChats({\n cursor: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "website_chats": [\n {\n "name": "string",\n "agent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "settings": {\n "allowed_origins": ["string"],\n "organisation_name": "string",\n "default_locale": "en",\n "design_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "authentication": {\n "email_code": {\n "email_template_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"\n },\n "portal": {\n "portal_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"\n }\n },\n "self_service": {\n "actions": [\n {\n "action": "submit_meter_reading",\n "enabled": true,\n "fulfilment": "in_chat",\n "journey_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "url": "string",\n "access": "anonymous",\n "guidance": "string"\n }\n ]\n }\n },\n "website_chat_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "org_id": "string",\n "binding_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "version": 1,\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "embed": {\n "script_url": "https://example.com/path",\n "chat_api_origin": "https://example.com/path",\n "demo_url": "https://example.com/path"\n }\n }\n ],\n "next_cursor": "string"\n}\n```\n\n</details>\n\n---\n\n### `createWebsiteChat`\n\n`POST /v1/website-chats`\n\n```ts\nconst { data } = await client.createWebsiteChat(\n null,\n {\n name: \'string\',\n agent_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n settings: {\n allowed_origins: [\'string\'],\n organisation_name: \'string\',\n default_locale: \'en\',\n design_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n authentication: {\n email_code: {\n email_template_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\'\n },\n portal: {\n portal_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\'\n }\n },\n self_service: {\n actions: [\n {\n action: \'submit_meter_reading\',\n enabled: true,\n fulfilment: \'in_chat\',\n journey_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n url: \'string\',\n access: \'anonymous\',\n guidance: \'string\'\n }\n ]\n }\n }\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "name": "string",\n "agent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "settings": {\n "allowed_origins": ["string"],\n "organisation_name": "string",\n "default_locale": "en",\n "design_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "authentication": {\n "email_code": {\n "email_template_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"\n },\n "portal": {\n "portal_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"\n }\n },\n "self_service": {\n "actions": [\n {\n "action": "submit_meter_reading",\n "enabled": true,\n "fulfilment": "in_chat",\n "journey_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "url": "string",\n "access": "anonymous",\n "guidance": "string"\n }\n ]\n }\n },\n "website_chat_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "org_id": "string",\n "binding_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "version": 1,\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "embed": {\n "script_url": "https://example.com/path",\n "chat_api_origin": "https://example.com/path",\n "demo_url": "https://example.com/path"\n }\n}\n```\n\n</details>\n\n---\n\n### `getWebsiteChat`\n\n`GET /v1/website-chats/{website_chat_id}`\n\n```ts\nconst { data } = await client.getWebsiteChat({\n website_chat_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "name": "string",\n "agent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "settings": {\n "allowed_origins": ["string"],\n "organisation_name": "string",\n "default_locale": "en",\n "design_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "authentication": {\n "email_code": {\n "email_template_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"\n },\n "portal": {\n "portal_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"\n }\n },\n "self_service": {\n "actions": [\n {\n "action": "submit_meter_reading",\n "enabled": true,\n "fulfilment": "in_chat",\n "journey_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "url": "string",\n "access": "anonymous",\n "guidance": "string"\n }\n ]\n }\n },\n "website_chat_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "org_id": "string",\n "binding_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "version": 1,\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "embed": {\n "script_url": "https://example.com/path",\n "chat_api_origin": "https://example.com/path",\n "demo_url": "https://example.com/path"\n }\n}\n```\n\n</details>\n\n---\n\n### `updateWebsiteChat`\n\n`PUT /v1/website-chats/{website_chat_id}`\n\n```ts\nconst { data } = await client.updateWebsiteChat(\n {\n website_chat_id: \'example\',\n },\n {\n name: \'string\',\n agent_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n settings: {\n allowed_origins: [\'string\'],\n organisation_name: \'string\',\n default_locale: \'en\',\n design_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n authentication: {\n email_code: {\n email_template_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\'\n },\n portal: {\n portal_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\'\n }\n },\n self_service: {\n actions: [\n {\n action: \'submit_meter_reading\',\n enabled: true,\n fulfilment: \'in_chat\',\n journey_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n url: \'string\',\n access: \'anonymous\',\n guidance: \'string\'\n }\n ]\n }\n },\n version: 1\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "name": "string",\n "agent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "settings": {\n "allowed_origins": ["string"],\n "organisation_name": "string",\n "default_locale": "en",\n "design_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "authentication": {\n "email_code": {\n "email_template_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"\n },\n "portal": {\n "portal_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"\n }\n },\n "self_service": {\n "actions": [\n {\n "action": "submit_meter_reading",\n "enabled": true,\n "fulfilment": "in_chat",\n "journey_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "url": "string",\n "access": "anonymous",\n "guidance": "string"\n }\n ]\n }\n },\n "website_chat_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "org_id": "string",\n "binding_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "version": 1,\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "embed": {\n "script_url": "https://example.com/path",\n "chat_api_origin": "https://example.com/path",\n "demo_url": "https://example.com/path"\n }\n}\n```\n\n</details>\n\n---\n\n### `deleteWebsiteChat`\n\n`DELETE /v1/website-chats/{website_chat_id}`\n\n```ts\nconst { data } = await client.deleteWebsiteChat({\n website_chat_id: \'example\',\n version: 1,\n})\n```\n\n---\n\n### `createWebsiteChatPreviewGrant`\n\n`POST /v1/website-chats/{website_chat_id}/preview-grant`\n\n```ts\nconst { data } = await client.createWebsiteChatPreviewGrant(\n {\n website_chat_id: \'example\',\n },\n {\n design_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "grant": "string",\n "expires_in": 0,\n "frame_origin": "https://example.com/path",\n "website_chat": {\n "key": "string",\n "organisationName": "string",\n "assistantName": "string",\n "defaultLocale": "en",\n "login_methods": ["email_code"],\n "starters": {\n "de": ["string"],\n "en": ["string"]\n },\n "actions": {\n "meter_reading": true,\n "meter_reading_journey_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"\n },\n "design": {\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "last_modified_at": "string",\n "style": {\n "palette": {\n "primary": "string",\n "background": "string"\n },\n "typography": {\n "font": {\n "font_family": "string"\n }\n },\n "shape": {\n "border_radius": 0\n }\n },\n "spark_theme": {\n "accentColor": "string",\n "backgroundColor": "string",\n "fontBody": "string",\n "fontHeading": "string",\n "radius": "string",\n "scaling": "string",\n "spacing": "string",\n "appearance": "string",\n "neutralColor": "string",\n "styleVariant": "string",\n "labelPosition": "string",\n "inputStyle": "string",\n "inputColor": "string",\n "cardVariant": "string",\n "cardColor": "string",\n "highContrast": true\n }\n },\n "locales": ["en"]\n }\n}\n```\n\n</details>\n\n---\n\n### `getPublicWebsiteChat`\n\n`GET /v1/website-chats/{website_chat_id}/configuration`\n\n```ts\nconst { data } = await client.getPublicWebsiteChat({\n website_chat_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "key": "string",\n "organisationName": "string",\n "assistantName": "string",\n "defaultLocale": "en",\n "login_methods": ["email_code"],\n "starters": {\n "de": ["string"],\n "en": ["string"]\n },\n "actions": {\n "meter_reading": true,\n "meter_reading_journey_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"\n },\n "design": {\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "last_modified_at": "string",\n "style": {\n "palette": {\n "primary": "string",\n "background": "string"\n },\n "typography": {\n "font": {\n "font_family": "string"\n }\n },\n "shape": {\n "border_radius": 0\n }\n },\n "spark_theme": {\n "accentColor": "string",\n "backgroundColor": "string",\n "fontBody": "string",\n "fontHeading": "string",\n "radius": "string",\n "scaling": "string",\n "spacing": "string",\n "appearance": "string",\n "neutralColor": "string",\n "styleVariant": "string",\n "labelPosition": "string",\n "inputStyle": "string",\n "inputColor": "string",\n "cardVariant": "string",\n "cardColor": "string",\n "highContrast": true\n }\n },\n "locales": ["en"]\n}\n```\n\n</details>\n\n---\n\n### `createPublicChatGrant`\n\n`POST /v1/bootstrap`\n\n```ts\nconst { data } = await client.createPublicChatGrant(\n null,\n {\n website_chat_id: \'string\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "grant": "string",\n "expires_in": 60,\n "frame_origin": "https://example.com/path"\n}\n```\n\n</details>\n\n---\n\n### `createAnonymousChatSession`\n\n`POST /v1/sessions`\n\n```ts\nconst { data } = await client.createAnonymousChatSession(\n null,\n {\n grant: \'string\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "token": "string",\n "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "expires_at": 0,\n "website_chat": {\n "key": "string",\n "organisationName": "string",\n "assistantName": "string",\n "defaultLocale": "en",\n "login_methods": ["email_code"],\n "starters": {\n "de": ["string"],\n "en": ["string"]\n },\n "actions": {\n "meter_reading": true,\n "meter_reading_journey_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"\n },\n "design": {\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "last_modified_at": "string",\n "style": {\n "palette": {\n "primary": "string",\n "background": "string"\n },\n "typography": {\n "font": {\n "font_family": "string"\n }\n },\n "shape": {\n "border_radius": 0\n }\n },\n "spark_theme": {\n "accentColor": "string",\n "backgroundColor": "string",\n "fontBody": "string",\n "fontHeading": "string",\n "radius": "string",\n "scaling": "string",\n "spacing": "string",\n "appearance": "string",\n "neutralColor": "string",\n "styleVariant": "string",\n "labelPosition": "string",\n "inputStyle": "string",\n "inputColor": "string",\n "cardVariant": "string",\n "cardColor": "string",\n "highContrast": true\n }\n },\n "locales": ["en"]\n },\n "preview": true\n}\n```\n\n</details>\n\n---\n\n### `sendAnonymousChatMessage`\n\n`POST /v1/messages`\n\n```ts\nconst { data } = await client.sendAnonymousChatMessage(\n null,\n {\n request_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n message: \'string\',\n locale: \'en\',\n simple_language: true\n },\n)\n```\n\n---\n\n### `getChatVerification`\n\n`GET /v1/verification`\n\n```ts\nconst { data } = await client.getChatVerification()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "available": true,\n "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "status": "anonymous",\n "challenge_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "code_expires_at": 0,\n "resend_after": 0,\n "email": "user@example.com",\n "contact_resolution": "matched",\n "access": {\n "tier": "anonymous",\n "method": "email_code"\n }\n}\n```\n\n</details>\n\n---\n\n### `startChatEmailVerification`\n\n`POST /v1/verification/email`\n\n```ts\nconst { data } = await client.startChatEmailVerification(\n null,\n {\n request_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n email: \'user@example.com\',\n locale: \'en\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "available": true,\n "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "status": "anonymous",\n "challenge_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "code_expires_at": 0,\n "resend_after": 0,\n "email": "user@example.com",\n "contact_resolution": "matched",\n "access": {\n "tier": "anonymous",\n "method": "email_code"\n }\n}\n```\n\n</details>\n\n---\n\n### `verifyChatEmailCode`\n\n`POST /v1/verification/code`\n\n```ts\nconst { data } = await client.verifyChatEmailCode(\n null,\n {\n challenge_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n code: \'string\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "available": true,\n "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "status": "anonymous",\n "challenge_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "code_expires_at": 0,\n "resend_after": 0,\n "email": "user@example.com",\n "contact_resolution": "matched",\n "access": {\n "tier": "anonymous",\n "method": "email_code"\n }\n}\n```\n\n</details>\n\n---\n\n### `cancelChatVerification`\n\n`POST /v1/verification/cancel`\n\n```ts\nconst { data } = await client.cancelChatVerification()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "available": true,\n "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "status": "anonymous",\n "challenge_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "code_expires_at": 0,\n "resend_after": 0,\n "email": "user@example.com",\n "contact_resolution": "matched",\n "access": {\n "tier": "anonymous",\n "method": "email_code"\n }\n}\n```\n\n</details>\n\n---\n\n### `getChatPortalLogin`\n\n`GET /v1/login/portal`\n\n```ts\nconst { data } = await client.getChatPortalLogin()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "available": true,\n "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "status": "anonymous",\n "challenge_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "code_expires_at": 0,\n "attempts_left": 0,\n "email": "user@example.com",\n "contact_resolution": "matched",\n "access": {\n "tier": "anonymous",\n "method": "email_code"\n }\n}\n```\n\n</details>\n\n---\n\n### `getChatPortalJourneyToken`\n\n`GET /v1/login/portal/journey-token`\n\n```ts\nconst { data } = await client.getChatPortalJourneyToken()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id_token": "string",\n "expires_at": 0\n}\n```\n\n</details>\n\n---\n\n### `startChatPortalLogin`\n\n`POST /v1/login/portal/start`\n\n```ts\nconst { data } = await client.startChatPortalLogin(\n null,\n {\n request_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n email: \'user@example.com\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "available": true,\n "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "status": "anonymous",\n "challenge_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "code_expires_at": 0,\n "attempts_left": 0,\n "email": "user@example.com",\n "contact_resolution": "matched",\n "access": {\n "tier": "anonymous",\n "method": "email_code"\n }\n}\n```\n\n</details>\n\n---\n\n### `verifyChatPortalLogin`\n\n`POST /v1/login/portal/verify`\n\n```ts\nconst { data } = await client.verifyChatPortalLogin(\n null,\n {\n challenge_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n code: \'string\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "available": true,\n "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "status": "anonymous",\n "challenge_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "code_expires_at": 0,\n "attempts_left": 0,\n "email": "user@example.com",\n "contact_resolution": "matched",\n "access": {\n "tier": "anonymous",\n "method": "email_code"\n }\n}\n```\n\n</details>\n\n---\n\n### `cancelChatPortalLogin`\n\n`POST /v1/login/portal/cancel`\n\n```ts\nconst { data } = await client.cancelChatPortalLogin()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "available": true,\n "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "status": "anonymous",\n "challenge_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "code_expires_at": 0,\n "attempts_left": 0,\n "email": "user@example.com",\n "contact_resolution": "matched",\n "access": {\n "tier": "anonymous",\n "method": "email_code"\n }\n}\n```\n\n</details>\n\n---\n\n### `signOutChatCustomer`\n\n`POST /v1/login/sign-out`\n\n```ts\nconst { data } = await client.signOutChatCustomer()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "access": {\n "tier": "anonymous",\n "method": "email_code"\n }\n}\n```\n\n</details>\n\n---\n\n### `getChatAction`\n\n`GET /v1/actions`\n\n```ts\nconst { data } = await client.getChatAction()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "status": "none",\n "action_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "revision": 0,\n "options": [\n {\n "meter_id": "string",\n "counter_id": "string",\n "meter_number": "string",\n "label": "string",\n "unit": "string",\n "min_value": 0,\n "max_value": 0\n }\n ],\n "values": {\n "meter_id": "string",\n "counter_id": "string",\n "value": 0\n },\n "field_error": "VALUE_INVALID",\n "receipt": {\n "reference": "string",\n "meter_number": "string",\n "value": 0,\n "unit": "string",\n "submitted_at": "string"\n },\n "reason": "NO_METERS"\n}\n```\n\n</details>\n\n---\n\n### `startChatAction`\n\n`POST /v1/actions`\n\n```ts\nconst { data } = await client.startChatAction(\n null,\n {\n request_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n action_type: \'submit_meter_reading\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "status": "none",\n "action_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "revision": 0,\n "options": [\n {\n "meter_id": "string",\n "counter_id": "string",\n "meter_number": "string",\n "label": "string",\n "unit": "string",\n "min_value": 0,\n "max_value": 0\n }\n ],\n "values": {\n "meter_id": "string",\n "counter_id": "string",\n "value": 0\n },\n "field_error": "VALUE_INVALID",\n "receipt": {\n "reference": "string",\n "meter_number": "string",\n "value": 0,\n "unit": "string",\n "submitted_at": "string"\n },\n "reason": "NO_METERS"\n}\n```\n\n</details>\n\n---\n\n### `reportChatActionEvent`\n\n`POST /v1/actions/events`\n\n```ts\nconst { data } = await client.reportChatActionEvent(\n null,\n {\n action: \'string\',\n event: \'journey_submitted\'\n },\n)\n```\n\n---\n\n### `submitChatAction`\n\n`POST /v1/actions/{action_id}/submit`\n\n```ts\nconst { data } = await client.submitChatAction(\n {\n action_id: \'example\',\n },\n {\n expected_revision: 1,\n meter_id: \'string\',\n counter_id: \'string\',\n value: 0\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "status": "none",\n "action_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "revision": 0,\n "options": [\n {\n "meter_id": "string",\n "counter_id": "string",\n "meter_number": "string",\n "label": "string",\n "unit": "string",\n "min_value": 0,\n "max_value": 0\n }\n ],\n "values": {\n "meter_id": "string",\n "counter_id": "string",\n "value": 0\n },\n "field_error": "VALUE_INVALID",\n "receipt": {\n "reference": "string",\n "meter_number": "string",\n "value": 0,\n "unit": "string",\n "submitted_at": "string"\n },\n "reason": "NO_METERS"\n}\n```\n\n</details>\n\n---\n\n### `confirmChatAction`\n\n`POST /v1/actions/{action_id}/confirm`\n\n```ts\nconst { data } = await client.confirmChatAction(\n {\n action_id: \'example\',\n },\n {\n expected_revision: 1\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "status": "none",\n "action_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "revision": 0,\n "options": [\n {\n "meter_id": "string",\n "counter_id": "string",\n "meter_number": "string",\n "label": "string",\n "unit": "string",\n "min_value": 0,\n "max_value": 0\n }\n ],\n "values": {\n "meter_id": "string",\n "counter_id": "string",\n "value": 0\n },\n "field_error": "VALUE_INVALID",\n "receipt": {\n "reference": "string",\n "meter_number": "string",\n "value": 0,\n "unit": "string",\n "submitted_at": "string"\n },\n "reason": "NO_METERS"\n}\n```\n\n</details>\n\n---\n\n### `cancelChatAction`\n\n`POST /v1/actions/{action_id}/cancel`\n\n```ts\nconst { data } = await client.cancelChatAction(\n {\n action_id: \'example\',\n },\n {\n expected_revision: 1\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "status": "none",\n "action_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "revision": 0,\n "options": [\n {\n "meter_id": "string",\n "counter_id": "string",\n "meter_number": "string",\n "label": "string",\n "unit": "string",\n "min_value": 0,\n "max_value": 0\n }\n ],\n "values": {\n "meter_id": "string",\n "counter_id": "string",\n "value": 0\n },\n "field_error": "VALUE_INVALID",\n "receipt": {\n "reference": "string",\n "meter_number": "string",\n "value": 0,\n "unit": "string",\n "submitted_at": "string"\n },\n "reason": "NO_METERS"\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `ListWebsiteChatsResponse`\n\n```ts\ntype ListWebsiteChatsResponse = {\n website_chats: Array<{\n name: string\n agent_id: string // uuid\n settings: {\n allowed_origins: { ... }\n organisation_name: { ... }\n default_locale: { ... }\n design_id?: { ... }\n authentication?: { ... }\n self_service?: { ... }\n }\n website_chat_id: string // uuid\n org_id: string\n binding_id: string // uuid\n version: number\n created_at: string // date-time\n updated_at: string // date-time\n embed: {\n script_url: { ... }\n chat_api_origin: { ... }\n demo_url: { ... }\n }\n }>\n next_cursor?: string\n}\n```\n\n### `WebsiteChat`\n\n```ts\ntype WebsiteChat = {\n name: string\n agent_id: string // uuid\n settings: {\n allowed_origins: string[]\n organisation_name: string\n default_locale: "en" | "de"\n design_id?: string // uuid\n authentication?: {\n email_code?: { ... }\n portal?: { ... }\n }\n self_service?: {\n actions: { ... }\n }\n }\n website_chat_id: string // uuid\n org_id: string\n binding_id: string // uuid\n version: number\n created_at: string // date-time\n updated_at: string // date-time\n embed: {\n script_url: string // uri\n chat_api_origin: string // uri\n demo_url: string // uri\n }\n}\n```\n\n### `WebsiteChatSettings`\n\n```ts\ntype WebsiteChatSettings = {\n allowed_origins: string[]\n organisation_name: string\n default_locale: "en" | "de"\n design_id?: string // uuid\n authentication?: {\n email_code?: {\n email_template_id?: { ... }\n }\n portal?: {\n portal_id: { ... }\n }\n }\n self_service?: {\n actions: Array<{\n action: { ... }\n enabled: { ... }\n fulfilment: { ... }\n journey_id?: { ... }\n url?: { ... }\n access: { ... }\n guidance?: { ... }\n }>\n }\n}\n```\n\n### `SelfServiceSettings`\n\nSelf-service actions customers can start in this Website Chat. On update, the list is replaced as a whole; null removes all actions.\n\n```ts\ntype SelfServiceSettings = {\n actions: Array<{\n action: "submit_meter_reading" | "change_installment_rate" | "update_payment_method" | "change_billing_address" | "update_customer_details" | "change_tariff" | "report_move" | "terminate_contract"\n enabled: boolean\n fulfilment: "in_chat" | "journey" | "link"\n journey_id?: string // uuid\n url?: string\n access: "anonymous" | "identified" | "verified"\n guidance?: string\n }>\n}\n```\n\n### `SelfServiceAction`\n\nHow a self-service action is done and who can start it. A journey needs journey_id, a link needs url. in_chat is only available for submit_meter_reading and requires a verified customer.\n\n```ts\ntype SelfServiceAction = {\n action: "submit_meter_reading" | "change_installment_rate" | "update_payment_method" | "change_billing_address" | "update_customer_details" | "change_tariff" | "report_move" | "terminate_contract"\n enabled: boolean\n fulfilment: "in_chat" | "journey" | "link"\n journey_id?: string // uuid\n url?: string\n access: "anonymous" | "identified" | "verified"\n guidance?: string\n}\n```\n\n### `WebsiteChatPreviewGrantRequest`\n\n```ts\ntype WebsiteChatPreviewGrantRequest = {\n design_id?: string // uuid\n}\n```\n\n### `WebsiteChatPreviewGrant`\n\n```ts\ntype WebsiteChatPreviewGrant = {\n grant: string\n expires_in: number\n frame_origin: string // uri\n website_chat: {\n key: string\n organisationName: string\n assistantName: string\n defaultLocale: "en" | "de"\n login_methods: "email_code" | "portal_login"[]\n starters?: {\n de?: { ... }\n en?: { ... }\n }\n actions?: {\n meter_reading?: { ... }\n meter_reading_journey_id?: { ... }\n }\n design?: {\n id: { ... }\n last_modified_at?: { ... }\n style?: { ... }\n spark_theme?: { ... }\n }\n locales: "en" | "de"[]\n }\n}\n```\n\n### `Error`\n\n```ts\ntype Error = {\n error?: string\n message?: string\n details?: object\n}\n```\n\n### `CreateWebsiteChatRequest`\n\n```ts\ntype CreateWebsiteChatRequest = {\n name: string\n agent_id: string // uuid\n settings: {\n allowed_origins: string[]\n organisation_name: string\n default_locale: "en" | "de"\n design_id?: string // uuid\n authentication?: {\n email_code?: { ... }\n portal?: { ... }\n }\n self_service?: {\n actions: { ... }\n }\n }\n}\n```\n\n### `UpdateWebsiteChatRequest`\n\n```ts\ntype UpdateWebsiteChatRequest = {\n name?: string\n agent_id?: string // uuid\n settings?: {\n allowed_origins: string[]\n organisation_name: string\n default_locale: "en" | "de"\n design_id?: string // uuid\n authentication?: {\n email_code?: { ... }\n portal?: { ... }\n }\n self_service?: {\n actions: { ... }\n }\n }\n version: number\n}\n```\n\n### `ActionRevision`\n\n```ts\ntype ActionRevision = {\n expected_revision: number\n}\n```\n\n### `ActionState`\n\n```ts\ntype ActionState = {\n conversation_id: string // uuid\n status: "none" | "needs_input" | "needs_confirmation" | "executing" | "completed" | "pending" | "rejected" | "handoff"\n action_id?: string // uuid\n revision?: number\n options?: Array<{\n meter_id: string\n counter_id: string\n meter_number: string\n label: string\n unit: string\n min_value?: number\n max_value?: number\n }>\n values?: {\n meter_id: string\n counter_id: string\n value: number\n }\n field_error?: "VALUE_INVALID" | "VALUE_OUT_OF_RANGE" | "TARGET_UNAVAILABLE"\n receipt?: {\n reference: string\n meter_number: string\n value: number\n unit: string\n submitted_at: string\n }\n reason?: "NO_METERS" | "SUBMISSION_REJECTED" | "SUBMISSION_UNCERTAIN"\n}\n```\n\n### `VerificationState`\n\n```ts\ntype VerificationState = {\n available: boolean\n conversation_id: string // uuid\n status: "anonymous" | "sending" | "pending" | "verified"\n challenge_id?: string // uuid\n code_expires_at?: number\n resend_after?: number\n email?: string // email\n contact_resolution?: "matched" | "ambiguous" | "not_found"\n access: {\n tier: "anonymous" | "identified" | "verified"\n method?: "email_code" | "portal_login"\n }\n}\n```\n\n### `PortalLoginState`\n\n```ts\ntype PortalLoginState = {\n available: boolean\n conversation_id: string // uuid\n status: "anonymous" | "pending" | "verified"\n challenge_id?: string // uuid\n code_expires_at?: number\n attempts_left?: number\n email?: string // email\n contact_resolution?: "matched" | "not_found"\n access: {\n tier: "anonymous" | "identified" | "verified"\n method?: "email_code" | "portal_login"\n }\n}\n```\n\n### `LoginMethod`\n\nHow a customer can log in or verify themselves in the chat.\n\n```ts\ntype LoginMethod = "email_code" | "portal_login"\n```\n\n### `AccessTier`\n\nanonymous: no customer identity. identified: the Contact is known but ownership\nis not proven. verified: ownership is proven (an email code or a portal login).\n\n\n```ts\ntype AccessTier = "anonymous" | "identified" | "verified"\n```\n\n### `CustomerAccess`\n\n```ts\ntype CustomerAccess = {\n tier: "anonymous" | "identified" | "verified"\n method?: "email_code" | "portal_login"\n}\n```\n\n### `StarterQuestions`\n\nAt most six. (No maxItems, which generated clients turn into fixed-length tuples.)\n\n```ts\ntype StarterQuestions = string[]\n```\n\n### `PublicWebsiteChat`\n\n```ts\ntype PublicWebsiteChat = {\n key: string\n organisationName: string\n assistantName: string\n defaultLocale: "en" | "de"\n login_methods: "email_code" | "portal_login"[]\n starters?: {\n de?: string[]\n en?: string[]\n }\n actions?: {\n meter_reading?: boolean\n meter_reading_journey_id?: string // uuid\n }\n design?: {\n id: string // uuid\n last_modified_at?: string\n style?: {\n palette?: { ... }\n typography?: { ... }\n shape?: { ... }\n }\n spark_theme?: {\n accentColor?: { ... }\n backgroundColor?: { ... }\n fontBody?: { ... }\n fontHeading?: { ... }\n radius?: { ... }\n scaling?: { ... }\n spacing?: { ... }\n appearance?: { ... }\n neutralColor?: { ... }\n styleVariant?: { ... }\n labelPosition?: { ... }\n inputStyle?: { ... }\n inputColor?: { ... }\n cardVariant?: { ... }\n cardColor?: { ... }\n highContrast?: { ... }\n }\n }\n locales: "en" | "de"[]\n}\n```\n\n### `WebsiteChatDesign`\n\n```ts\ntype WebsiteChatDesign = {\n id: string // uuid\n last_modified_at?: string\n style?: {\n palette?: {\n primary?: { ... }\n background?: { ... }\n }\n typography?: {\n font?: { ... }\n }\n shape?: {\n border_radius?: { ... }\n }\n }\n spark_theme?: {\n accentColor?: string\n backgroundColor?: string\n fontBody?: string\n fontHeading?: string\n radius?: string\n scaling?: string\n spacing?: string\n appearance?: string\n neutralColor?: string\n styleVariant?: string\n labelPosition?: string\n inputStyle?: string\n inputColor?: string\n cardVariant?: string\n cardColor?: string\n highContrast?: boolean\n }\n}\n```\n\n### `PublicEvent`\n\nJSON payload of one SSE data frame from sendAnonymousChatMessage.\n\n```ts\ntype PublicEvent = {\n type: "delta"\n text: string\n request_id: string // uuid\n} | {\n type: "complete"\n text: string\n request_id: string // uuid\n} | {\n type: "error"\n code: "UNAVAILABLE"\n request_id: string // uuid\n} | {\n type: "action"\n action: {\n action: string\n fulfilment: "in_chat" | "journey" | "link"\n journey_id?: string // uuid\n url?: string\n access: "anonymous" | "identified" | "verified"\n }\n request_id: string // uuid\n}\n```\n\n### `SelfServiceDirective`\n\n```ts\ntype SelfServiceDirective = {\n action: string\n fulfilment: "in_chat" | "journey" | "link"\n journey_id?: string // uuid\n url?: string\n access: "anonymous" | "identified" | "verified"\n}\n```\n\n### `PublicChatError`\n\n```ts\ntype PublicChatError = {\n 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" | "IDENTITY_REQUIRED" | "ACTION_UNAVAILABLE" | "ACTION_CONFLICT" | "ACTION_TARGET_DENIED" | "INVALID_LOGIN_CODE" | "LOGIN_EXPIRED" | "LOGIN_DISABLED" | "LOGIN_UNAVAILABLE" | "LOGIN_CONFLICT" | "LOGIN_REJECTED"\n attempts_left?: number\n}\n```\n';
5
-
6
-
7
- exports.default = chat_default;