@epilot/sdk 2.20.48 → 2.20.49

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 (127) hide show
  1. package/definitions/chat.json +1092 -1
  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/file.cjs +6 -6
  55. package/dist/apis/file.js +1 -1
  56. package/dist/apis/iban.cjs +6 -6
  57. package/dist/apis/iban.js +1 -1
  58. package/dist/apis/identity.cjs +6 -6
  59. package/dist/apis/identity.js +1 -1
  60. package/dist/apis/integration-toolkit.cjs +6 -6
  61. package/dist/apis/integration-toolkit.js +1 -1
  62. package/dist/apis/journey.cjs +6 -6
  63. package/dist/apis/journey.js +1 -1
  64. package/dist/apis/kanban.cjs +6 -6
  65. package/dist/apis/kanban.js +1 -1
  66. package/dist/apis/message.cjs +6 -6
  67. package/dist/apis/message.js +1 -1
  68. package/dist/apis/metering.cjs +6 -6
  69. package/dist/apis/metering.js +1 -1
  70. package/dist/apis/notes.cjs +6 -6
  71. package/dist/apis/notes.js +1 -1
  72. package/dist/apis/notification.cjs +6 -6
  73. package/dist/apis/notification.js +1 -1
  74. package/dist/apis/organization.cjs +6 -6
  75. package/dist/apis/organization.js +1 -1
  76. package/dist/apis/partner-directory.cjs +6 -6
  77. package/dist/apis/partner-directory.js +1 -1
  78. package/dist/apis/permissions.cjs +6 -6
  79. package/dist/apis/permissions.js +1 -1
  80. package/dist/apis/pricing-tier.cjs +6 -6
  81. package/dist/apis/pricing-tier.js +1 -1
  82. package/dist/apis/pricing.cjs +6 -6
  83. package/dist/apis/pricing.js +1 -1
  84. package/dist/apis/purpose.cjs +6 -6
  85. package/dist/apis/purpose.js +1 -1
  86. package/dist/apis/query.cjs +6 -6
  87. package/dist/apis/query.js +1 -1
  88. package/dist/apis/sandbox.cjs +6 -6
  89. package/dist/apis/sandbox.js +1 -1
  90. package/dist/apis/sharing.cjs +6 -6
  91. package/dist/apis/sharing.js +1 -1
  92. package/dist/apis/snapshot.cjs +6 -6
  93. package/dist/apis/snapshot.js +1 -1
  94. package/dist/apis/submission.cjs +6 -6
  95. package/dist/apis/submission.js +1 -1
  96. package/dist/apis/target.cjs +6 -6
  97. package/dist/apis/target.js +1 -1
  98. package/dist/apis/targeting.cjs +6 -6
  99. package/dist/apis/targeting.js +1 -1
  100. package/dist/apis/template-variables.cjs +6 -6
  101. package/dist/apis/template-variables.js +1 -1
  102. package/dist/apis/user.cjs +6 -6
  103. package/dist/apis/user.js +1 -1
  104. package/dist/apis/validation-rules.cjs +6 -6
  105. package/dist/apis/validation-rules.js +1 -1
  106. package/dist/apis/webhooks.cjs +6 -6
  107. package/dist/apis/webhooks.js +1 -1
  108. package/dist/apis/workflow-definition.cjs +6 -6
  109. package/dist/apis/workflow-definition.js +1 -1
  110. package/dist/apis/workflow.cjs +6 -6
  111. package/dist/apis/workflow.js +1 -1
  112. package/dist/chat-J2QDZT3T.cjs +7 -0
  113. package/dist/chat-S2AFYBHH.js +7 -0
  114. package/dist/chat.d-C-X6oeNS.d.cts +10535 -0
  115. package/dist/chat.d-C-X6oeNS.d.ts +10535 -0
  116. package/dist/{chunk-UORN27QE.js → chunk-B3CLGH23.js} +1 -1
  117. package/dist/{chunk-KP2RRRO5.cjs → chunk-CFHQ2UJU.cjs} +1 -1
  118. package/dist/index.cjs +8 -8
  119. package/dist/index.d.cts +1 -1
  120. package/dist/index.d.ts +1 -1
  121. package/dist/index.js +1 -1
  122. package/docs/chat.md +158 -0
  123. package/package.json +1 -1
  124. package/dist/chat-6E3CPZZV.js +0 -7
  125. package/dist/chat-EGLWHHF5.cjs +0 -7
  126. package/dist/chat.d-BGPN5RIE.d.cts +0 -5319
  127. package/dist/chat.d-BGPN5RIE.d.ts +0 -5319
@@ -39,7 +39,7 @@ var globImport_docs = __glob({
39
39
  "./docs/billing.json": () => import("./billing-UJ6I7FPG.js"),
40
40
  "./docs/blueprint-manifest.json": () => import("./blueprint-manifest-YU2UZLHV.js"),
41
41
  "./docs/calendar.json": () => import("./calendar-2H4RGMV3.js"),
42
- "./docs/chat.json": () => import("./chat-6E3CPZZV.js"),
42
+ "./docs/chat.json": () => import("./chat-S2AFYBHH.js"),
43
43
  "./docs/configuration-hub.json": () => import("./configuration-hub-ZYOLN7ZX.js"),
44
44
  "./docs/consent.json": () => import("./consent-NNYHF2N4.js"),
45
45
  "./docs/customer-portal.json": () => import("./customer-portal-TSJKBA37.js"),
@@ -39,7 +39,7 @@ var globImport_docs = _chunkNJK5F5TFcjs.__glob.call(void 0, {
39
39
  "./docs/billing.json": () => Promise.resolve().then(() => _interopRequireWildcard(require("./billing-CKCFSK6K.cjs"))),
40
40
  "./docs/blueprint-manifest.json": () => Promise.resolve().then(() => _interopRequireWildcard(require("./blueprint-manifest-SXG3M6B4.cjs"))),
41
41
  "./docs/calendar.json": () => Promise.resolve().then(() => _interopRequireWildcard(require("./calendar-UADWQX7G.cjs"))),
42
- "./docs/chat.json": () => Promise.resolve().then(() => _interopRequireWildcard(require("./chat-EGLWHHF5.cjs"))),
42
+ "./docs/chat.json": () => Promise.resolve().then(() => _interopRequireWildcard(require("./chat-J2QDZT3T.cjs"))),
43
43
  "./docs/configuration-hub.json": () => Promise.resolve().then(() => _interopRequireWildcard(require("./configuration-hub-6TSL5AGX.cjs"))),
44
44
  "./docs/consent.json": () => Promise.resolve().then(() => _interopRequireWildcard(require("./consent-CS2ZBZX4.cjs"))),
45
45
  "./docs/customer-portal.json": () => Promise.resolve().then(() => _interopRequireWildcard(require("./customer-portal-WOO2QDPR.cjs"))),
package/dist/index.cjs CHANGED
@@ -164,7 +164,7 @@ var _chunkWOUASZJWcjs = require('./chunk-WOUASZJW.cjs');
164
164
 
165
165
 
166
166
 
167
- var _chunkKP2RRRO5cjs = require('./chunk-KP2RRRO5.cjs');
167
+ var _chunkCFHQ2UJUcjs = require('./chunk-CFHQ2UJU.cjs');
168
168
 
169
169
 
170
170
  var _chunkNJK5F5TFcjs = require('./chunk-NJK5F5TF.cjs');
@@ -231,7 +231,7 @@ var resolveClient = (params) => {
231
231
  }
232
232
  if (!entry.instance) {
233
233
  const definition = entry.loader();
234
- entry.instance = _chunkKP2RRRO5cjs.createApiClient.call(void 0, {
234
+ entry.instance = _chunkCFHQ2UJUcjs.createApiClient.call(void 0, {
235
235
  definition,
236
236
  token: state.token,
237
237
  headers: state.globalHeaders,
@@ -264,7 +264,7 @@ var resetAllClients = (registry) => {
264
264
  };
265
265
 
266
266
  // src/apis/_registry.ts
267
- var expandDef = (mod) => _chunkKP2RRRO5cjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
267
+ var expandDef = (mod) => _chunkCFHQ2UJUcjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
268
268
  var registerBuiltinApis = (registry) => {
269
269
  registerApi({
270
270
  registry,
@@ -617,9 +617,9 @@ var createSDK = () => {
617
617
  const available = [...registry.keys()].join(", ");
618
618
  throw new Error(`Unknown API: "${name}". Available: ${available}`);
619
619
  }
620
- return _chunkKP2RRRO5cjs.createApiHandle.call(void 0, {
620
+ return _chunkCFHQ2UJUcjs.createApiHandle.call(void 0, {
621
621
  resolveClient: () => resolveClient({ registry, name, state }),
622
- createClient: () => _chunkKP2RRRO5cjs.createApiClient.call(void 0, { definition: entry.loader(), apiName: name }),
622
+ createClient: () => _chunkCFHQ2UJUcjs.createApiClient.call(void 0, { definition: entry.loader(), apiName: name }),
623
623
  apiName: name
624
624
  });
625
625
  };
@@ -667,9 +667,9 @@ var createSDK = () => {
667
667
  return interceptorUse;
668
668
  }
669
669
  case "help":
670
- return (apiName) => _chunkKP2RRRO5cjs.help.call(void 0, apiName);
670
+ return (apiName) => _chunkCFHQ2UJUcjs.help.call(void 0, apiName);
671
671
  case "openapi":
672
- return (apiName) => _chunkKP2RRRO5cjs.openapi.call(void 0, apiName);
672
+ return (apiName) => _chunkCFHQ2UJUcjs.openapi.call(void 0, apiName);
673
673
  case "then":
674
674
  case "catch":
675
675
  case "finally":
@@ -699,4 +699,4 @@ var epilot = createSDK();
699
699
 
700
700
 
701
701
 
702
- exports.applyLargeResponseInterceptor = applyLargeResponseInterceptor; exports.applyRetryInterceptor = applyRetryInterceptor; exports.authorize = _chunkKP2RRRO5cjs.authorize; exports.createSDK = createSDK; exports.epilot = epilot; exports.help = _chunkKP2RRRO5cjs.help; exports.openapi = _chunkKP2RRRO5cjs.openapi;
702
+ exports.applyLargeResponseInterceptor = applyLargeResponseInterceptor; exports.applyRetryInterceptor = applyRetryInterceptor; exports.authorize = _chunkCFHQ2UJUcjs.authorize; exports.createSDK = createSDK; exports.epilot = epilot; exports.help = _chunkCFHQ2UJUcjs.help; exports.openapi = _chunkCFHQ2UJUcjs.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-BGPN5RIE.cjs';
16
+ import { C as Client$a } from './chat.d-C-X6oeNS.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-COI3Xe4x.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-BGPN5RIE.js';
16
+ import { C as Client$a } from './chat.d-C-X6oeNS.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-COI3Xe4x.js';
package/dist/index.js CHANGED
@@ -164,7 +164,7 @@ import {
164
164
  expand,
165
165
  help,
166
166
  openapi
167
- } from "./chunk-UORN27QE.js";
167
+ } from "./chunk-B3CLGH23.js";
168
168
  import {
169
169
  __require
170
170
  } from "./chunk-YPSWSI3M.js";
package/docs/chat.md CHANGED
@@ -55,6 +55,8 @@ const { data } = await chatClient.listWebsiteChats(...)
55
55
  - [`ListWebsiteChatsResponse`](#listwebsitechatsresponse)
56
56
  - [`WebsiteChat`](#websitechat)
57
57
  - [`WebsiteChatSettings`](#websitechatsettings)
58
+ - [`SelfServiceSettings`](#selfservicesettings)
59
+ - [`SelfServiceAction`](#selfserviceaction)
58
60
  - [`Error`](#error)
59
61
  - [`CreateWebsiteChatRequest`](#createwebsitechatrequest)
60
62
  - [`UpdateWebsiteChatRequest`](#updatewebsitechatrequest)
@@ -68,6 +70,7 @@ const { data } = await chatClient.listWebsiteChats(...)
68
70
  - [`PublicWebsiteChat`](#publicwebsitechat)
69
71
  - [`WebsiteChatDesign`](#websitechatdesign)
70
72
  - [`PublicEvent`](#publicevent)
73
+ - [`SelfServiceDirective`](#selfservicedirective)
71
74
  - [`PublicChatError`](#publicchaterror)
72
75
 
73
76
  ### `listWebsiteChats`
@@ -101,6 +104,19 @@ const { data } = await client.listWebsiteChats({
101
104
  "portal": {
102
105
  "portal_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
103
106
  }
107
+ },
108
+ "self_service": {
109
+ "actions": [
110
+ {
111
+ "action": "submit_meter_reading",
112
+ "enabled": true,
113
+ "fulfilment": "in_chat",
114
+ "journey_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
115
+ "url": "string",
116
+ "access": "anonymous",
117
+ "guidance": "string"
118
+ }
119
+ ]
104
120
  }
105
121
  },
106
122
  "website_chat_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
@@ -146,6 +162,19 @@ const { data } = await client.createWebsiteChat(
146
162
  portal: {
147
163
  portal_id: '3fa85f64-5717-4562-b3fc-2c963f66afa6'
148
164
  }
165
+ },
166
+ self_service: {
167
+ actions: [
168
+ {
169
+ action: 'submit_meter_reading',
170
+ enabled: true,
171
+ fulfilment: 'in_chat',
172
+ journey_id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
173
+ url: 'string',
174
+ access: 'anonymous',
175
+ guidance: 'string'
176
+ }
177
+ ]
149
178
  }
150
179
  }
151
180
  },
@@ -171,6 +200,19 @@ const { data } = await client.createWebsiteChat(
171
200
  "portal": {
172
201
  "portal_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
173
202
  }
203
+ },
204
+ "self_service": {
205
+ "actions": [
206
+ {
207
+ "action": "submit_meter_reading",
208
+ "enabled": true,
209
+ "fulfilment": "in_chat",
210
+ "journey_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
211
+ "url": "string",
212
+ "access": "anonymous",
213
+ "guidance": "string"
214
+ }
215
+ ]
174
216
  }
175
217
  },
176
218
  "website_chat_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
@@ -220,6 +262,19 @@ const { data } = await client.getWebsiteChat({
220
262
  "portal": {
221
263
  "portal_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
222
264
  }
265
+ },
266
+ "self_service": {
267
+ "actions": [
268
+ {
269
+ "action": "submit_meter_reading",
270
+ "enabled": true,
271
+ "fulfilment": "in_chat",
272
+ "journey_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
273
+ "url": "string",
274
+ "access": "anonymous",
275
+ "guidance": "string"
276
+ }
277
+ ]
223
278
  }
224
279
  },
225
280
  "website_chat_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
@@ -264,6 +319,19 @@ const { data } = await client.updateWebsiteChat(
264
319
  portal: {
265
320
  portal_id: '3fa85f64-5717-4562-b3fc-2c963f66afa6'
266
321
  }
322
+ },
323
+ self_service: {
324
+ actions: [
325
+ {
326
+ action: 'submit_meter_reading',
327
+ enabled: true,
328
+ fulfilment: 'in_chat',
329
+ journey_id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
330
+ url: 'string',
331
+ access: 'anonymous',
332
+ guidance: 'string'
333
+ }
334
+ ]
267
335
  }
268
336
  },
269
337
  version: 1
@@ -290,6 +358,19 @@ const { data } = await client.updateWebsiteChat(
290
358
  "portal": {
291
359
  "portal_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
292
360
  }
361
+ },
362
+ "self_service": {
363
+ "actions": [
364
+ {
365
+ "action": "submit_meter_reading",
366
+ "enabled": true,
367
+ "fulfilment": "in_chat",
368
+ "journey_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
369
+ "url": "string",
370
+ "access": "anonymous",
371
+ "guidance": "string"
372
+ }
373
+ ]
293
374
  }
294
375
  },
295
376
  "website_chat_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
@@ -1109,6 +1190,7 @@ type ListWebsiteChatsResponse = {
1109
1190
  default_locale: { ... }
1110
1191
  design_id?: { ... }
1111
1192
  authentication?: { ... }
1193
+ self_service?: { ... }
1112
1194
  }
1113
1195
  website_chat_id: string // uuid
1114
1196
  org_id: string
@@ -1141,6 +1223,9 @@ type WebsiteChat = {
1141
1223
  email_code?: { ... }
1142
1224
  portal?: { ... }
1143
1225
  }
1226
+ self_service?: {
1227
+ actions: { ... }
1228
+ }
1144
1229
  }
1145
1230
  website_chat_id: string // uuid
1146
1231
  org_id: string
@@ -1172,6 +1257,51 @@ type WebsiteChatSettings = {
1172
1257
  portal_id: { ... }
1173
1258
  }
1174
1259
  }
1260
+ self_service?: {
1261
+ actions: Array<{
1262
+ action: { ... }
1263
+ enabled: { ... }
1264
+ fulfilment: { ... }
1265
+ journey_id?: { ... }
1266
+ url?: { ... }
1267
+ access: { ... }
1268
+ guidance?: { ... }
1269
+ }>
1270
+ }
1271
+ }
1272
+ ```
1273
+
1274
+ ### `SelfServiceSettings`
1275
+
1276
+ Self-service actions customers can start in this Website Chat. On update, the list is replaced as a whole; null removes all actions.
1277
+
1278
+ ```ts
1279
+ type SelfServiceSettings = {
1280
+ actions: Array<{
1281
+ action: "submit_meter_reading" | "change_installment_rate" | "update_payment_method" | "change_billing_address" | "update_customer_details" | "change_tariff" | "report_move" | "terminate_contract"
1282
+ enabled: boolean
1283
+ fulfilment: "in_chat" | "journey" | "link"
1284
+ journey_id?: string // uuid
1285
+ url?: string
1286
+ access: "anonymous" | "identified" | "verified"
1287
+ guidance?: string
1288
+ }>
1289
+ }
1290
+ ```
1291
+
1292
+ ### `SelfServiceAction`
1293
+
1294
+ How 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.
1295
+
1296
+ ```ts
1297
+ type SelfServiceAction = {
1298
+ action: "submit_meter_reading" | "change_installment_rate" | "update_payment_method" | "change_billing_address" | "update_customer_details" | "change_tariff" | "report_move" | "terminate_contract"
1299
+ enabled: boolean
1300
+ fulfilment: "in_chat" | "journey" | "link"
1301
+ journey_id?: string // uuid
1302
+ url?: string
1303
+ access: "anonymous" | "identified" | "verified"
1304
+ guidance?: string
1175
1305
  }
1176
1306
  ```
1177
1307
 
@@ -1200,6 +1330,9 @@ type CreateWebsiteChatRequest = {
1200
1330
  email_code?: { ... }
1201
1331
  portal?: { ... }
1202
1332
  }
1333
+ self_service?: {
1334
+ actions: { ... }
1335
+ }
1203
1336
  }
1204
1337
  }
1205
1338
  ```
@@ -1219,6 +1352,9 @@ type UpdateWebsiteChatRequest = {
1219
1352
  email_code?: { ... }
1220
1353
  portal?: { ... }
1221
1354
  }
1355
+ self_service?: {
1356
+ actions: { ... }
1357
+ }
1222
1358
  }
1223
1359
  version: number
1224
1360
  }
@@ -1431,6 +1567,28 @@ type PublicEvent = {
1431
1567
  type: "error"
1432
1568
  code: "UNAVAILABLE"
1433
1569
  request_id: string // uuid
1570
+ } | {
1571
+ type: "action"
1572
+ action: {
1573
+ action: string
1574
+ fulfilment: "in_chat" | "journey" | "link"
1575
+ journey_id?: string // uuid
1576
+ url?: string
1577
+ access: "anonymous" | "identified" | "verified"
1578
+ }
1579
+ request_id: string // uuid
1580
+ }
1581
+ ```
1582
+
1583
+ ### `SelfServiceDirective`
1584
+
1585
+ ```ts
1586
+ type SelfServiceDirective = {
1587
+ action: string
1588
+ fulfilment: "in_chat" | "journey" | "link"
1589
+ journey_id?: string // uuid
1590
+ url?: string
1591
+ access: "anonymous" | "identified" | "verified"
1434
1592
  }
1435
1593
  ```
1436
1594
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/sdk",
3
- "version": "2.20.48",
3
+ "version": "2.20.49",
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\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- [`startChatPortalLogin`](#startchatportallogin)\n- [`verifyChatPortalLogin`](#verifychatportallogin)\n- [`cancelChatPortalLogin`](#cancelchatportallogin)\n- [`signOutChatCustomer`](#signoutchatcustomer)\n- [`getChatAction`](#getchataction)\n- [`startChatAction`](#startchataction)\n- [`submitChatAction`](#submitchataction)\n- [`confirmChatAction`](#confirmchataction)\n- [`cancelChatAction`](#cancelchataction)\n\n**Schemas**\n- [`ListWebsiteChatsResponse`](#listwebsitechatsresponse)\n- [`WebsiteChat`](#websitechat)\n- [`WebsiteChatSettings`](#websitechatsettings)\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- [`PublicWebsiteChat`](#publicwebsitechat)\n- [`WebsiteChatDesign`](#websitechatdesign)\n- [`PublicEvent`](#publicevent)\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 },\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 }\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 },\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 },\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 },\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 },\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### `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 "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 "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### `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### `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### `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 }\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 }\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}\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 }\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 }\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### `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 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```\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\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- [`startChatPortalLogin`](#startchatportallogin)\n- [`verifyChatPortalLogin`](#verifychatportallogin)\n- [`cancelChatPortalLogin`](#cancelchatportallogin)\n- [`signOutChatCustomer`](#signoutchatcustomer)\n- [`getChatAction`](#getchataction)\n- [`startChatAction`](#startchataction)\n- [`submitChatAction`](#submitchataction)\n- [`confirmChatAction`](#confirmchataction)\n- [`cancelChatAction`](#cancelchataction)\n\n**Schemas**\n- [`ListWebsiteChatsResponse`](#listwebsitechatsresponse)\n- [`WebsiteChat`](#websitechat)\n- [`WebsiteChatSettings`](#websitechatsettings)\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- [`PublicWebsiteChat`](#publicwebsitechat)\n- [`WebsiteChatDesign`](#websitechatdesign)\n- [`PublicEvent`](#publicevent)\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 },\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 }\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 },\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 },\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 },\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 },\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### `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 "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 "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### `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### `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### `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 }\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 }\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}\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 }\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 }\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### `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 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```\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;