@epilot/sdk 2.20.66 → 2.20.68

package/docs/message.md

@@ -54,6 +54,7 @@ const { data } = await messageClient.sendMessage(...)
 - [`markThreadAsDone`](#markthreadasdone)
 - [`markThreadAsOpen`](#markthreadasopen)
 - [`getThreadTimeline`](#getthreadtimeline)
+- [`getThreadSummary`](#getthreadsummary)
 - [`trashThread`](#trashthread)
 - [`untrashThread`](#untrashthread)
 - [`spamThread`](#spamthread)
@@ -74,6 +75,7 @@ const { data } = await messageClient.sendMessage(...)
 - [`markUnreadThread`](#markunreadthread)
 - [`markUnreadThreadV2`](#markunreadthreadv2)
 - [`assignThread`](#assignthread)
+- [`dismissThreadLinkSuggestions`](#dismissthreadlinksuggestions)
 - [`unassignThread`](#unassignthread)
 - [`assignUsers`](#assignusers)
 - [`assignUsersV2`](#assignusersv2)
@@ -108,6 +110,16 @@ const { data } = await messageClient.sendMessage(...)
 - [`AssigneeWorkloadResults`](#assigneeworkloadresults)
 - [`ReadMessagePayload`](#readmessagepayload)
 - [`ReadingScope`](#readingscope)
+- [`ThreadReplyContext`](#threadreplycontext)
+- [`ReplyContextMessage`](#replycontextmessage)
+- [`ReplyContextEntityRef`](#replycontextentityref)
+- [`ThreadSummary`](#threadsummary)
+- [`ThreadSummaryPayload`](#threadsummarypayload)
+- [`ThreadSummaryEntityRef`](#threadsummaryentityref)
+- [`ThreadSummaryContext`](#threadsummarycontext)
+- [`SimilarSentMessagesRequest`](#similarsentmessagesrequest)
+- [`SimilarSentMessagesResponse`](#similarsentmessagesresponse)
+- [`SimilarSentMessage`](#similarsentmessage)
 - [`ThreadTimeline`](#threadtimeline)
 - [`ThreadDoneEvent`](#threaddoneevent)
 - [`ThreadOpenEvent`](#threadopenevent)
@@ -121,6 +133,11 @@ const { data } = await messageClient.sendMessage(...)
 - [`ThreadMovedToInboxEvent`](#threadmovedtoinboxevent)
 - [`ThreadTrashedEvent`](#threadtrashedevent)
 - [`ThreadRestoredEvent`](#threadrestoredevent)
+- [`LinkSuggestionCandidate`](#linksuggestioncandidate)
+- [`LinkSuggestion`](#linksuggestion)
+- [`TimelineLinkSuggestion`](#timelinelinksuggestion)
+- [`MessageEntityLinkSuggestedEvent`](#messageentitylinksuggestedevent)
+- [`MessageEntityLinkSuggestionDismissedEvent`](#messageentitylinksuggestiondismissedevent)
 - [`TimelineLinkedEntity`](#timelinelinkedentity)
 - [`TimelineActor`](#timelineactor)
 - [`TimelineEventData`](#timelineeventdata)
@@ -1082,7 +1099,7 @@ const { data } = await client.getThreadTimeline({
         "user_id": "123",
         "organization_id": "456"
       },
-      "timestamp": "2024-01-01T00:00:00.000Z",
+      "timestamp": "2024-01-01T00:00:00Z",
       "message_id": "string",
       "source": "user",
       "automated": true,
@@ -1103,6 +1120,52 @@ const { data } = await client.getThreadTimeline({
 
 ---
 
+### `getThreadSummary`
+
+AI summary of a thread. Returns `202` while it is generated; poll until `jobStatus.status` is `COMPLETED` or `FAILED`.
+
+`GET /v1/message/threads/{id}/summary`
+
+```ts
+const { data } = await client.getThreadSummary({
+  id: '123e4567-e89b-12d3-a456-426614174000',
+  message_id: 'example',
+})
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "orgId": "string",
+  "jobId": "string",
+  "executionId": "string",
+  "jobStatus": {
+    "status": "INITIATED",
+    "error": "string"
+  },
+  "payload": {
+    "summary": ["string"],
+    "topics": ["string"],
+    "next_steps": ["string"],
+    "refs": [
+      {
+        "id": "string",
+        "displayText": "Raven GmbH",
+        "schema": "contact"
+      }
+    ]
+  },
+  "createdAt": "1970-01-01T00:00:00.000Z",
+  "updatedAt": "1970-01-01T00:00:00.000Z"
+}
+```
+
+</details>
+
+---
+
 ### `trashThread`
 
 Move a thread to trash
@@ -1476,6 +1539,37 @@ const { data } = await client.assignThread(
 
 ---
 
+### `dismissThreadLinkSuggestions`
+
+Dismiss pending candidates of entity-link suggestions on a thread. A suggestion is recorded on a message when an identifier in it matched entities of different customers, so nothing was linked automat
+
+`POST /v1/message/threads/{id}/link-suggestions/dismiss`
+
+```ts
+const { data } = await client.dismissThreadLinkSuggestions(
+  {
+    id: '123e4567-e89b-12d3-a456-426614174000',
+  },
+  {
+    suggestion_ids: ['string'],
+    entity_ids: ['string']
+  },
+)
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "dismissed": ["string"]
+}
+```
+
+</details>
+
+---
+
 ### `unassignThread`
 
 Unassign thread from entities
@@ -1669,7 +1763,7 @@ const { data } = await client.createDraft(
 
 ### `sendDraft`
 
-Send the existing draft to the recipients
+Send the existing draft to the recipients.
 
 `POST /v1/message/drafts:send`
 
@@ -1786,6 +1880,19 @@ const { data } = await client.getMessageV2({
 
 ```json
 {
+  "link_suggestions": [
+    {
+      "id": "string",
+      "identifier": "string",
+      "found_in": "string",
+      "status": "pending",
+      "candidates": [],
+      "accepted_entity_ids": ["string"],
+      "resolved_by": {},
+      "resolved_at": "1970-01-01T00:00:00.000Z",
+      "created_at": "1970-01-01T00:00:00.000Z"
+    }
+  ],
   "html_omitted": false,
   "html_download_url": "https://s3.eu-central-1.amazonaws.com/epilot-attachments/3f34ce73-089c-4d45-a5ee-c161234e41c3/3f34ce73-089c-4d45-a5ee-c161234e41c3.html",
   "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
@@ -1844,16 +1951,7 @@ const { data } = await client.getMessageV2({
   ],
   "file": {
     "$relation": [
-      {
-        "entity_id": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f",
-        "filename": "Produktinformationen_epilot360_Double_Opt_in.pdf",
-        "is_message_attachment": true,
-        "may_be_signature_attachment": true,
-        "cid": "fb222496-a1a5-4639-94f2-07b5e35e4068",
-        "inline": false,
-        "send_as_link": false,
-        "save_to_entity": true
-      }
+      {}
     ]
   },
   "references": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>",
@@ -2463,6 +2561,161 @@ Who is marking an item as read or unread.
 type ReadingScope = "organization" | "user"
 ```
 
+### `ThreadReplyContext`
+
+```ts
+type ThreadReplyContext = {
+  thread_id: string
+  topic?: string
+  reply_to_message_id?: string
+  messages: Array<{
+    id: string
+    created_at?: string // date-time
+    type: "RECEIVED" | "SENT"
+    role: "customer" | "agent" | "partner"
+    subject?: string
+    from?: {
+      address?: { ... }
+      name?: { ... }
+    }
+    text: string
+  }>
+  related_entities: Array<{
+    _id: string
+    _schema: string
+  }>
+}
+```
+
+### `ReplyContextMessage`
+
+```ts
+type ReplyContextMessage = {
+  id: string
+  created_at?: string // date-time
+  type: "RECEIVED" | "SENT"
+  role: "customer" | "agent" | "partner"
+  subject?: string
+  from?: {
+    address?: string
+    name?: string
+  }
+  text: string
+}
+```
+
+### `ReplyContextEntityRef`
+
+```ts
+type ReplyContextEntityRef = {
+  _id: string
+  _schema: string
+}
+```
+
+### `ThreadSummary`
+
+```ts
+type ThreadSummary = {
+  orgId: string
+  jobId: string
+  executionId?: string
+  jobStatus: {
+    status: "INITIATED" | "IN_PROGRESS" | "COMPLETED" | "FAILED"
+    error?: string
+  }
+  payload?: {
+    summary?: string[]
+    topics?: string[]
+    next_steps?: string[]
+    refs?: Array<{
+      id: { ... }
+      displayText: { ... }
+      schema: { ... }
+    }>
+  }
+  createdAt: string // date-time
+  updatedAt: string // date-time
+}
+```
+
+### `ThreadSummaryPayload`
+
+Present once the summary is generated
+
+```ts
+type ThreadSummaryPayload = {
+  summary?: string[]
+  topics?: string[]
+  next_steps?: string[]
+  refs?: Array<{
+    id: string
+    displayText: string
+    schema: string
+  }>
+}
+```
+
+### `ThreadSummaryEntityRef`
+
+```ts
+type ThreadSummaryEntityRef = {
+  id: string
+  displayText: string
+  schema: string
+}
+```
+
+### `ThreadSummaryContext`
+
+```ts
+type ThreadSummaryContext = {
+  thread_id: string
+  message_id: string
+  subject: string
+  conversation: string
+  entity_context: string
+}
+```
+
+### `SimilarSentMessagesRequest`
+
+```ts
+type SimilarSentMessagesRequest = {
+  queries: string[]
+  limit?: number
+  min_score?: number
+}
+```
+
+### `SimilarSentMessagesResponse`
+
+```ts
+type SimilarSentMessagesResponse = {
+  results: Array<{
+    message_id: string
+    thread_id?: string
+    subject?: string
+    text: string
+    created_at?: string
+    score: number
+  }>
+}
+```
+
+### `SimilarSentMessage`
+
+```ts
+type SimilarSentMessage = {
+  message_id: string
+  thread_id?: string
+  subject?: string
+  text: string
+  created_at?: string
+  score: number
+}
+```
+
 ### `ThreadTimeline`
 
 ```ts
@@ -2497,10 +2750,17 @@ type ThreadTimeline = {
       type: { ... }
       entities?: { ... }
       link_kind?: { ... }
+      from_suggestion?: { ... }
     } | {
       type: { ... }
       entities?: { ... }
       link_kind?: { ... }
+    } | {
+      type: { ... }
+      suggestions?: { ... }
+    } | {
+      type: { ... }
+      suggestions?: { ... }
     } | {
       type: { ... }
       reply_message_id?: { ... }
@@ -2600,6 +2860,7 @@ type MessageEntityLinkedEvent = {
     schema?: string
   }>
   link_kind?: "manual" | "auto"
+  from_suggestion?: boolean
 }
 ```
 
@@ -2652,6 +2913,100 @@ type ThreadRestoredEvent = {
 }
 ```
 
+### `LinkSuggestionCandidate`
+
+```ts
+type LinkSuggestionCandidate = {
+  entity_id: string
+  schema: string
+  attribute?: string
+  attribute_value?: string
+  title?: string
+  status?: "pending" | "linked" | "dismissed"
+  resolved_by?: {
+    user_id?: string
+    email?: string
+  }
+  resolved_at?: string // date-time
+}
+```
+
+### `LinkSuggestion`
+
+```ts
+type LinkSuggestion = {
+  id: string
+  identifier: string
+  found_in?: string
+  status: "pending" | "accepted" | "dismissed"
+  candidates: Array<{
+    entity_id: string
+    schema: string
+    attribute?: string
+    attribute_value?: string
+    title?: string
+    status?: "pending" | "linked" | "dismissed"
+    resolved_by?: {
+      user_id?: { ... }
+      email?: { ... }
+    }
+    resolved_at?: string // date-time
+  }>
+  accepted_entity_ids?: string[]
+  resolved_by?: {
+    user_id?: string
+    email?: string
+  }
+  resolved_at?: string // date-time
+  created_at?: string // date-time
+}
+```
+
+### `TimelineLinkSuggestion`
+
+```ts
+type TimelineLinkSuggestion = {
+  id?: string
+  identifier: string
+  candidates?: Array<{
+    entity_id: string
+    schema?: string
+  }>
+}
+```
+
+### `MessageEntityLinkSuggestedEvent`
+
+```ts
+type MessageEntityLinkSuggestedEvent = {
+  type: "MESSAGE_ENTITY_LINK_SUGGESTED"
+  suggestions?: Array<{
+    id?: string
+    identifier: string
+    candidates?: Array<{
+      entity_id: { ... }
+      schema?: { ... }
+    }>
+  }>
+}
+```
+
+### `MessageEntityLinkSuggestionDismissedEvent`
+
+```ts
+type MessageEntityLinkSuggestionDismissedEvent = {
+  type: "MESSAGE_ENTITY_LINK_SUGGESTION_DISMISSED"
+  suggestions?: Array<{
+    id?: string
+    identifier: string
+    candidates?: Array<{
+      entity_id: { ... }
+      schema?: { ... }
+    }>
+  }>
+}
+```
+
 ### `TimelineLinkedEntity`
 
 ```ts
@@ -2704,6 +3059,7 @@ type TimelineEventData = {
     schema?: string
   }>
   link_kind?: "manual" | "auto"
+  from_suggestion?: boolean
 } | {
   type: "MESSAGE_ENTITY_UNLINKED"
   entities?: Array<{
@@ -2711,6 +3067,26 @@ type TimelineEventData = {
     schema?: string
   }>
   link_kind?: "manual" | "auto"
+} | {
+  type: "MESSAGE_ENTITY_LINK_SUGGESTED"
+  suggestions?: Array<{
+    id?: string
+    identifier: string
+    candidates?: Array<{
+      entity_id: { ... }
+      schema?: { ... }
+    }>
+  }>
+} | {
+  type: "MESSAGE_ENTITY_LINK_SUGGESTION_DISMISSED"
+  suggestions?: Array<{
+    id?: string
+    identifier: string
+    candidates?: Array<{
+      entity_id: { ... }
+      schema?: { ... }
+    }>
+  }>
 } | {
   type: "MESSAGE_AUTO_REPLY_SENT"
   reply_message_id?: string
@@ -2762,6 +3138,7 @@ type TimelineEvent = {
       schema?: { ... }
     }>
     link_kind?: "manual" | "auto"
+    from_suggestion?: boolean
   } | {
     type: "MESSAGE_ENTITY_UNLINKED"
     entities?: Array<{
@@ -2769,6 +3146,20 @@ type TimelineEvent = {
       schema?: { ... }
     }>
     link_kind?: "manual" | "auto"
+  } | {
+    type: "MESSAGE_ENTITY_LINK_SUGGESTED"
+    suggestions?: Array<{
+      id?: { ... }
+      identifier: { ... }
+      candidates?: { ... }
+    }>
+  } | {
+    type: "MESSAGE_ENTITY_LINK_SUGGESTION_DISMISSED"
+    suggestions?: Array<{
+      id?: { ... }
+      identifier: { ... }
+      candidates?: { ... }
+    }>
   } | {
     type: "MESSAGE_AUTO_REPLY_SENT"
     reply_message_id?: string

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/sdk",
-  "version": "2.20.66",
+  "version": "2.20.68",
   "description": "JavaScript/TypeScript SDK for epilot APIs",
   "type": "module",
   "main": "./dist/index.cjs",

package/dist/chat-UYCCJWAM.js

@@ -1,7 +0,0 @@
-import "./chunk-YPSWSI3M.js";
-
-// src/docs/chat.json
-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';
-export {
-  chat_default as default
-};