@epilot/sdk 2.20.63 → 2.20.65
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/definitions/chat-runtime.json +1 -1
- package/definitions/chat.json +921 -0
- package/dist/apis/access-token.cjs +6 -6
- package/dist/apis/access-token.js +1 -1
- package/dist/apis/address-suggestions.cjs +6 -6
- package/dist/apis/address-suggestions.js +1 -1
- package/dist/apis/address.cjs +6 -6
- package/dist/apis/address.js +1 -1
- package/dist/apis/ai-agents.cjs +6 -6
- package/dist/apis/ai-agents.js +1 -1
- package/dist/apis/app.cjs +6 -6
- package/dist/apis/app.js +1 -1
- package/dist/apis/audit-logs.cjs +6 -6
- package/dist/apis/audit-logs.js +1 -1
- package/dist/apis/automation.cjs +6 -6
- package/dist/apis/automation.js +1 -1
- package/dist/apis/billing.cjs +6 -6
- package/dist/apis/billing.js +1 -1
- package/dist/apis/blueprint-manifest.cjs +6 -6
- package/dist/apis/blueprint-manifest.js +1 -1
- package/dist/apis/calendar.cjs +6 -6
- package/dist/apis/calendar.js +1 -1
- package/dist/apis/chat.cjs +8 -8
- package/dist/apis/chat.d.cts +2 -2
- package/dist/apis/chat.d.ts +2 -2
- package/dist/apis/chat.js +2 -2
- package/dist/apis/configuration-hub.cjs +6 -6
- package/dist/apis/configuration-hub.js +1 -1
- package/dist/apis/consent.cjs +6 -6
- package/dist/apis/consent.js +1 -1
- package/dist/apis/customer-portal.cjs +6 -6
- package/dist/apis/customer-portal.js +1 -1
- package/dist/apis/dashboard.cjs +6 -6
- package/dist/apis/dashboard.js +1 -1
- package/dist/apis/data-governance.cjs +6 -6
- package/dist/apis/data-governance.js +1 -1
- package/dist/apis/deduplication.cjs +6 -6
- package/dist/apis/deduplication.js +1 -1
- package/dist/apis/design.cjs +6 -6
- package/dist/apis/design.js +1 -1
- package/dist/apis/document.cjs +6 -6
- package/dist/apis/document.js +1 -1
- package/dist/apis/email-settings.cjs +6 -6
- package/dist/apis/email-settings.js +1 -1
- package/dist/apis/email-template.cjs +6 -6
- package/dist/apis/email-template.js +1 -1
- package/dist/apis/entity-mapping.cjs +6 -6
- package/dist/apis/entity-mapping.js +1 -1
- package/dist/apis/entity.cjs +7 -7
- package/dist/apis/entity.d.cts +5 -6
- package/dist/apis/entity.d.ts +5 -6
- package/dist/apis/entity.js +2 -2
- package/dist/apis/environments.cjs +6 -6
- package/dist/apis/environments.js +1 -1
- package/dist/apis/event-catalog.cjs +6 -6
- package/dist/apis/event-catalog.js +1 -1
- package/dist/apis/external-values.cjs +6 -6
- package/dist/apis/external-values.js +1 -1
- package/dist/apis/file.cjs +6 -6
- package/dist/apis/file.js +1 -1
- package/dist/apis/iban.cjs +6 -6
- package/dist/apis/iban.js +1 -1
- package/dist/apis/identity.cjs +6 -6
- package/dist/apis/identity.js +1 -1
- package/dist/apis/integration-toolkit.cjs +6 -6
- package/dist/apis/integration-toolkit.js +1 -1
- package/dist/apis/journey.cjs +6 -6
- package/dist/apis/journey.js +1 -1
- package/dist/apis/kanban.cjs +6 -6
- package/dist/apis/kanban.js +1 -1
- package/dist/apis/message.cjs +6 -6
- package/dist/apis/message.js +1 -1
- package/dist/apis/metering.cjs +6 -6
- package/dist/apis/metering.js +1 -1
- package/dist/apis/notes.cjs +6 -6
- package/dist/apis/notes.js +1 -1
- package/dist/apis/notification.cjs +6 -6
- package/dist/apis/notification.js +1 -1
- package/dist/apis/organization.cjs +6 -6
- package/dist/apis/organization.js +1 -1
- package/dist/apis/partner-directory.cjs +6 -6
- package/dist/apis/partner-directory.js +1 -1
- package/dist/apis/permissions.cjs +6 -6
- package/dist/apis/permissions.js +1 -1
- package/dist/apis/phone-integration.cjs +6 -6
- package/dist/apis/phone-integration.js +1 -1
- package/dist/apis/pricing-tier.cjs +6 -6
- package/dist/apis/pricing-tier.js +1 -1
- package/dist/apis/pricing.cjs +6 -6
- package/dist/apis/pricing.js +1 -1
- package/dist/apis/purpose.cjs +6 -6
- package/dist/apis/purpose.js +1 -1
- package/dist/apis/query.cjs +6 -6
- package/dist/apis/query.js +1 -1
- package/dist/apis/sandbox.cjs +6 -6
- package/dist/apis/sandbox.js +1 -1
- package/dist/apis/sharing.cjs +6 -6
- package/dist/apis/sharing.js +1 -1
- package/dist/apis/snapshot.cjs +6 -6
- package/dist/apis/snapshot.js +1 -1
- package/dist/apis/submission.cjs +6 -6
- package/dist/apis/submission.js +1 -1
- package/dist/apis/target.cjs +6 -6
- package/dist/apis/target.js +1 -1
- package/dist/apis/targeting.cjs +6 -6
- package/dist/apis/targeting.js +1 -1
- package/dist/apis/template-variables.cjs +6 -6
- package/dist/apis/template-variables.js +1 -1
- package/dist/apis/user.cjs +6 -6
- package/dist/apis/user.js +1 -1
- package/dist/apis/validation-rules.cjs +6 -6
- package/dist/apis/validation-rules.js +1 -1
- package/dist/apis/webhooks.cjs +6 -6
- package/dist/apis/webhooks.js +1 -1
- package/dist/apis/workflow-definition.cjs +6 -6
- package/dist/apis/workflow-definition.js +1 -1
- package/dist/apis/workflow.cjs +6 -6
- package/dist/apis/workflow.js +1 -1
- package/dist/chat-UYCCJWAM.js +7 -0
- package/dist/chat-YYRMNUXU.cjs +7 -0
- package/dist/{chat-runtime-GCKIJKUM.js → chat-runtime-KQQWSK4D.js} +1 -1
- package/dist/chat-runtime-TKJQUO4U.cjs +5 -0
- package/dist/{chat.d-C-X6oeNS.d.cts → chat.d-BUkItuYX.d.cts} +363 -1
- package/dist/{chat.d-C-X6oeNS.d.ts → chat.d-BUkItuYX.d.ts} +363 -1
- package/dist/chunk-IVBCWTJ7.cjs +14 -0
- package/dist/chunk-LWF6XJNO.js +14 -0
- package/dist/{chunk-FUF6LZXH.cjs → chunk-NRSVV47V.cjs} +2 -2
- package/dist/{chunk-SYTRHMOU.js → chunk-NZKYUZK2.js} +2 -2
- package/dist/index.cjs +10 -10
- package/dist/index.d.cts +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +2 -2
- package/docs/chat.md +188 -1
- package/package.json +1 -1
- package/dist/chat-J2QDZT3T.cjs +0 -7
- package/dist/chat-S2AFYBHH.js +0 -7
- package/dist/chat-runtime-X5ASDO46.cjs +0 -5
- package/dist/chunk-2QQYR5S5.cjs +0 -14
- package/dist/chunk-DIUWLA6A.js +0 -14
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
|
|
2
|
+
|
|
3
|
+
// src/docs/chat.json
|
|
4
|
+
var chat_default = '# epilot Chat API\n\n- **Base URL:** `https://chat.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/chat](https://docs.epilot.io/api/chat)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.chat.listWebsiteChats(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/chat\'\n\nconst chatClient = getClient()\nauthorize(chatClient, () => \'<token>\')\nconst { data } = await chatClient.listWebsiteChats(...)\n```\n\n## Operations\n\n**Website Chats**\n- [`listWebsiteChats`](#listwebsitechats)\n- [`createWebsiteChat`](#createwebsitechat)\n- [`getWebsiteChat`](#getwebsitechat)\n- [`updateWebsiteChat`](#updatewebsitechat)\n- [`deleteWebsiteChat`](#deletewebsitechat)\n- [`createWebsiteChatPreviewGrant`](#createwebsitechatpreviewgrant)\n\n**Other**\n- [`getPublicWebsiteChat`](#getpublicwebsitechat)\n- [`createPublicChatGrant`](#createpublicchatgrant)\n- [`createAnonymousChatSession`](#createanonymouschatsession)\n- [`sendAnonymousChatMessage`](#sendanonymouschatmessage)\n- [`getChatVerification`](#getchatverification)\n- [`startChatEmailVerification`](#startchatemailverification)\n- [`verifyChatEmailCode`](#verifychatemailcode)\n- [`cancelChatVerification`](#cancelchatverification)\n- [`getChatPortalLogin`](#getchatportallogin)\n- [`getChatPortalJourneyToken`](#getchatportaljourneytoken)\n- [`startChatPortalLogin`](#startchatportallogin)\n- [`verifyChatPortalLogin`](#verifychatportallogin)\n- [`cancelChatPortalLogin`](#cancelchatportallogin)\n- [`signOutChatCustomer`](#signoutchatcustomer)\n- [`getChatAction`](#getchataction)\n- [`startChatAction`](#startchataction)\n- [`reportChatActionEvent`](#reportchatactionevent)\n- [`submitChatAction`](#submitchataction)\n- [`confirmChatAction`](#confirmchataction)\n- [`cancelChatAction`](#cancelchataction)\n\n**Schemas**\n- [`ListWebsiteChatsResponse`](#listwebsitechatsresponse)\n- [`WebsiteChat`](#websitechat)\n- [`WebsiteChatSettings`](#websitechatsettings)\n- [`SelfServiceSettings`](#selfservicesettings)\n- [`SelfServiceAction`](#selfserviceaction)\n- [`WebsiteChatPreviewGrantRequest`](#websitechatpreviewgrantrequest)\n- [`WebsiteChatPreviewGrant`](#websitechatpreviewgrant)\n- [`Error`](#error)\n- [`CreateWebsiteChatRequest`](#createwebsitechatrequest)\n- [`UpdateWebsiteChatRequest`](#updatewebsitechatrequest)\n- [`ActionRevision`](#actionrevision)\n- [`ActionState`](#actionstate)\n- [`VerificationState`](#verificationstate)\n- [`PortalLoginState`](#portalloginstate)\n- [`LoginMethod`](#loginmethod)\n- [`AccessTier`](#accesstier)\n- [`CustomerAccess`](#customeraccess)\n- [`StarterQuestions`](#starterquestions)\n- [`PublicWebsiteChat`](#publicwebsitechat)\n- [`WebsiteChatDesign`](#websitechatdesign)\n- [`PublicEvent`](#publicevent)\n- [`SelfServiceDirective`](#selfservicedirective)\n- [`PublicChatError`](#publicchaterror)\n\n### `listWebsiteChats`\n\n`GET /v1/website-chats`\n\n```ts\nconst { data } = await client.listWebsiteChats({\n cursor: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "website_chats": [\n {\n "name": "string",\n "agent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "settings": {\n "allowed_origins": ["string"],\n "organisation_name": "string",\n "default_locale": "en",\n "design_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "authentication": {\n "email_code": {\n "email_template_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"\n },\n "portal": {\n "portal_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"\n }\n },\n "self_service": {\n "actions": [\n {\n "action": "submit_meter_reading",\n "enabled": true,\n "fulfilment": "in_chat",\n "journey_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "url": "string",\n "access": "anonymous",\n "guidance": "string"\n }\n ]\n }\n },\n "website_chat_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "org_id": "string",\n "binding_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "version": 1,\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "embed": {\n "script_url": "https://example.com/path",\n "chat_api_origin": "https://example.com/path",\n "demo_url": "https://example.com/path"\n }\n }\n ],\n "next_cursor": "string"\n}\n```\n\n</details>\n\n---\n\n### `createWebsiteChat`\n\n`POST /v1/website-chats`\n\n```ts\nconst { data } = await client.createWebsiteChat(\n null,\n {\n name: \'string\',\n agent_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n settings: {\n allowed_origins: [\'string\'],\n organisation_name: \'string\',\n default_locale: \'en\',\n design_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n authentication: {\n email_code: {\n email_template_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\'\n },\n portal: {\n portal_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\'\n }\n },\n self_service: {\n actions: [\n {\n action: \'submit_meter_reading\',\n enabled: true,\n fulfilment: \'in_chat\',\n journey_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n url: \'string\',\n access: \'anonymous\',\n guidance: \'string\'\n }\n ]\n }\n }\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "name": "string",\n "agent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "settings": {\n "allowed_origins": ["string"],\n "organisation_name": "string",\n "default_locale": "en",\n "design_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "authentication": {\n "email_code": {\n "email_template_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"\n },\n "portal": {\n "portal_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"\n }\n },\n "self_service": {\n "actions": [\n {\n "action": "submit_meter_reading",\n "enabled": true,\n "fulfilment": "in_chat",\n "journey_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "url": "string",\n "access": "anonymous",\n "guidance": "string"\n }\n ]\n }\n },\n "website_chat_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "org_id": "string",\n "binding_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "version": 1,\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "embed": {\n "script_url": "https://example.com/path",\n "chat_api_origin": "https://example.com/path",\n "demo_url": "https://example.com/path"\n }\n}\n```\n\n</details>\n\n---\n\n### `getWebsiteChat`\n\n`GET /v1/website-chats/{website_chat_id}`\n\n```ts\nconst { data } = await client.getWebsiteChat({\n website_chat_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "name": "string",\n "agent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "settings": {\n "allowed_origins": ["string"],\n "organisation_name": "string",\n "default_locale": "en",\n "design_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "authentication": {\n "email_code": {\n "email_template_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"\n },\n "portal": {\n "portal_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"\n }\n },\n "self_service": {\n "actions": [\n {\n "action": "submit_meter_reading",\n "enabled": true,\n "fulfilment": "in_chat",\n "journey_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "url": "string",\n "access": "anonymous",\n "guidance": "string"\n }\n ]\n }\n },\n "website_chat_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "org_id": "string",\n "binding_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "version": 1,\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "embed": {\n "script_url": "https://example.com/path",\n "chat_api_origin": "https://example.com/path",\n "demo_url": "https://example.com/path"\n }\n}\n```\n\n</details>\n\n---\n\n### `updateWebsiteChat`\n\n`PUT /v1/website-chats/{website_chat_id}`\n\n```ts\nconst { data } = await client.updateWebsiteChat(\n {\n website_chat_id: \'example\',\n },\n {\n name: \'string\',\n agent_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n settings: {\n allowed_origins: [\'string\'],\n organisation_name: \'string\',\n default_locale: \'en\',\n design_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n authentication: {\n email_code: {\n email_template_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\'\n },\n portal: {\n portal_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\'\n }\n },\n self_service: {\n actions: [\n {\n action: \'submit_meter_reading\',\n enabled: true,\n fulfilment: \'in_chat\',\n journey_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n url: \'string\',\n access: \'anonymous\',\n guidance: \'string\'\n }\n ]\n }\n },\n version: 1\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "name": "string",\n "agent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "settings": {\n "allowed_origins": ["string"],\n "organisation_name": "string",\n "default_locale": "en",\n "design_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "authentication": {\n "email_code": {\n "email_template_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"\n },\n "portal": {\n "portal_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"\n }\n },\n "self_service": {\n "actions": [\n {\n "action": "submit_meter_reading",\n "enabled": true,\n "fulfilment": "in_chat",\n "journey_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "url": "string",\n "access": "anonymous",\n "guidance": "string"\n }\n ]\n }\n },\n "website_chat_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "org_id": "string",\n "binding_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "version": 1,\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "embed": {\n "script_url": "https://example.com/path",\n "chat_api_origin": "https://example.com/path",\n "demo_url": "https://example.com/path"\n }\n}\n```\n\n</details>\n\n---\n\n### `deleteWebsiteChat`\n\n`DELETE /v1/website-chats/{website_chat_id}`\n\n```ts\nconst { data } = await client.deleteWebsiteChat({\n website_chat_id: \'example\',\n version: 1,\n})\n```\n\n---\n\n### `createWebsiteChatPreviewGrant`\n\n`POST /v1/website-chats/{website_chat_id}/preview-grant`\n\n```ts\nconst { data } = await client.createWebsiteChatPreviewGrant(\n {\n website_chat_id: \'example\',\n },\n {\n design_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "grant": "string",\n "expires_in": 0,\n "frame_origin": "https://example.com/path",\n "website_chat": {\n "key": "string",\n "organisationName": "string",\n "assistantName": "string",\n "defaultLocale": "en",\n "login_methods": ["email_code"],\n "starters": {\n "de": ["string"],\n "en": ["string"]\n },\n "actions": {\n "meter_reading": true,\n "meter_reading_journey_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"\n },\n "design": {\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "last_modified_at": "string",\n "style": {\n "palette": {\n "primary": "string",\n "background": "string"\n },\n "typography": {\n "font": {\n "font_family": "string"\n }\n },\n "shape": {\n "border_radius": 0\n }\n },\n "spark_theme": {\n "accentColor": "string",\n "backgroundColor": "string",\n "fontBody": "string",\n "fontHeading": "string",\n "radius": "string",\n "scaling": "string",\n "spacing": "string",\n "appearance": "string",\n "neutralColor": "string",\n "styleVariant": "string",\n "labelPosition": "string",\n "inputStyle": "string",\n "inputColor": "string",\n "cardVariant": "string",\n "cardColor": "string",\n "highContrast": true\n }\n },\n "locales": ["en"]\n }\n}\n```\n\n</details>\n\n---\n\n### `getPublicWebsiteChat`\n\n`GET /v1/website-chats/{website_chat_id}/configuration`\n\n```ts\nconst { data } = await client.getPublicWebsiteChat({\n website_chat_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "key": "string",\n "organisationName": "string",\n "assistantName": "string",\n "defaultLocale": "en",\n "login_methods": ["email_code"],\n "starters": {\n "de": ["string"],\n "en": ["string"]\n },\n "actions": {\n "meter_reading": true,\n "meter_reading_journey_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"\n },\n "design": {\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "last_modified_at": "string",\n "style": {\n "palette": {\n "primary": "string",\n "background": "string"\n },\n "typography": {\n "font": {\n "font_family": "string"\n }\n },\n "shape": {\n "border_radius": 0\n }\n },\n "spark_theme": {\n "accentColor": "string",\n "backgroundColor": "string",\n "fontBody": "string",\n "fontHeading": "string",\n "radius": "string",\n "scaling": "string",\n "spacing": "string",\n "appearance": "string",\n "neutralColor": "string",\n "styleVariant": "string",\n "labelPosition": "string",\n "inputStyle": "string",\n "inputColor": "string",\n "cardVariant": "string",\n "cardColor": "string",\n "highContrast": true\n }\n },\n "locales": ["en"]\n}\n```\n\n</details>\n\n---\n\n### `createPublicChatGrant`\n\n`POST /v1/bootstrap`\n\n```ts\nconst { data } = await client.createPublicChatGrant(\n null,\n {\n website_chat_id: \'string\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "grant": "string",\n "expires_in": 60,\n "frame_origin": "https://example.com/path"\n}\n```\n\n</details>\n\n---\n\n### `createAnonymousChatSession`\n\n`POST /v1/sessions`\n\n```ts\nconst { data } = await client.createAnonymousChatSession(\n null,\n {\n grant: \'string\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "token": "string",\n "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "expires_at": 0,\n "website_chat": {\n "key": "string",\n "organisationName": "string",\n "assistantName": "string",\n "defaultLocale": "en",\n "login_methods": ["email_code"],\n "starters": {\n "de": ["string"],\n "en": ["string"]\n },\n "actions": {\n "meter_reading": true,\n "meter_reading_journey_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"\n },\n "design": {\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "last_modified_at": "string",\n "style": {\n "palette": {\n "primary": "string",\n "background": "string"\n },\n "typography": {\n "font": {\n "font_family": "string"\n }\n },\n "shape": {\n "border_radius": 0\n }\n },\n "spark_theme": {\n "accentColor": "string",\n "backgroundColor": "string",\n "fontBody": "string",\n "fontHeading": "string",\n "radius": "string",\n "scaling": "string",\n "spacing": "string",\n "appearance": "string",\n "neutralColor": "string",\n "styleVariant": "string",\n "labelPosition": "string",\n "inputStyle": "string",\n "inputColor": "string",\n "cardVariant": "string",\n "cardColor": "string",\n "highContrast": true\n }\n },\n "locales": ["en"]\n },\n "preview": true\n}\n```\n\n</details>\n\n---\n\n### `sendAnonymousChatMessage`\n\n`POST /v1/messages`\n\n```ts\nconst { data } = await client.sendAnonymousChatMessage(\n null,\n {\n request_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n message: \'string\',\n locale: \'en\',\n simple_language: true\n },\n)\n```\n\n---\n\n### `getChatVerification`\n\n`GET /v1/verification`\n\n```ts\nconst { data } = await client.getChatVerification()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "available": true,\n "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "status": "anonymous",\n "challenge_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "code_expires_at": 0,\n "resend_after": 0,\n "email": "user@example.com",\n "contact_resolution": "matched",\n "access": {\n "tier": "anonymous",\n "method": "email_code"\n }\n}\n```\n\n</details>\n\n---\n\n### `startChatEmailVerification`\n\n`POST /v1/verification/email`\n\n```ts\nconst { data } = await client.startChatEmailVerification(\n null,\n {\n request_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n email: \'user@example.com\',\n locale: \'en\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "available": true,\n "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "status": "anonymous",\n "challenge_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "code_expires_at": 0,\n "resend_after": 0,\n "email": "user@example.com",\n "contact_resolution": "matched",\n "access": {\n "tier": "anonymous",\n "method": "email_code"\n }\n}\n```\n\n</details>\n\n---\n\n### `verifyChatEmailCode`\n\n`POST /v1/verification/code`\n\n```ts\nconst { data } = await client.verifyChatEmailCode(\n null,\n {\n challenge_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n code: \'string\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "available": true,\n "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "status": "anonymous",\n "challenge_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "code_expires_at": 0,\n "resend_after": 0,\n "email": "user@example.com",\n "contact_resolution": "matched",\n "access": {\n "tier": "anonymous",\n "method": "email_code"\n }\n}\n```\n\n</details>\n\n---\n\n### `cancelChatVerification`\n\n`POST /v1/verification/cancel`\n\n```ts\nconst { data } = await client.cancelChatVerification()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "available": true,\n "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "status": "anonymous",\n "challenge_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "code_expires_at": 0,\n "resend_after": 0,\n "email": "user@example.com",\n "contact_resolution": "matched",\n "access": {\n "tier": "anonymous",\n "method": "email_code"\n }\n}\n```\n\n</details>\n\n---\n\n### `getChatPortalLogin`\n\n`GET /v1/login/portal`\n\n```ts\nconst { data } = await client.getChatPortalLogin()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "available": true,\n "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "status": "anonymous",\n "challenge_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "code_expires_at": 0,\n "attempts_left": 0,\n "email": "user@example.com",\n "contact_resolution": "matched",\n "access": {\n "tier": "anonymous",\n "method": "email_code"\n }\n}\n```\n\n</details>\n\n---\n\n### `getChatPortalJourneyToken`\n\n`GET /v1/login/portal/journey-token`\n\n```ts\nconst { data } = await client.getChatPortalJourneyToken()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id_token": "string",\n "expires_at": 0\n}\n```\n\n</details>\n\n---\n\n### `startChatPortalLogin`\n\n`POST /v1/login/portal/start`\n\n```ts\nconst { data } = await client.startChatPortalLogin(\n null,\n {\n request_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n email: \'user@example.com\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "available": true,\n "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "status": "anonymous",\n "challenge_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "code_expires_at": 0,\n "attempts_left": 0,\n "email": "user@example.com",\n "contact_resolution": "matched",\n "access": {\n "tier": "anonymous",\n "method": "email_code"\n }\n}\n```\n\n</details>\n\n---\n\n### `verifyChatPortalLogin`\n\n`POST /v1/login/portal/verify`\n\n```ts\nconst { data } = await client.verifyChatPortalLogin(\n null,\n {\n challenge_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n code: \'string\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "available": true,\n "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "status": "anonymous",\n "challenge_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "code_expires_at": 0,\n "attempts_left": 0,\n "email": "user@example.com",\n "contact_resolution": "matched",\n "access": {\n "tier": "anonymous",\n "method": "email_code"\n }\n}\n```\n\n</details>\n\n---\n\n### `cancelChatPortalLogin`\n\n`POST /v1/login/portal/cancel`\n\n```ts\nconst { data } = await client.cancelChatPortalLogin()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "available": true,\n "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "status": "anonymous",\n "challenge_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "code_expires_at": 0,\n "attempts_left": 0,\n "email": "user@example.com",\n "contact_resolution": "matched",\n "access": {\n "tier": "anonymous",\n "method": "email_code"\n }\n}\n```\n\n</details>\n\n---\n\n### `signOutChatCustomer`\n\n`POST /v1/login/sign-out`\n\n```ts\nconst { data } = await client.signOutChatCustomer()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "access": {\n "tier": "anonymous",\n "method": "email_code"\n }\n}\n```\n\n</details>\n\n---\n\n### `getChatAction`\n\n`GET /v1/actions`\n\n```ts\nconst { data } = await client.getChatAction()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "status": "none",\n "action_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "revision": 0,\n "options": [\n {\n "meter_id": "string",\n "counter_id": "string",\n "meter_number": "string",\n "label": "string",\n "unit": "string",\n "min_value": 0,\n "max_value": 0\n }\n ],\n "values": {\n "meter_id": "string",\n "counter_id": "string",\n "value": 0\n },\n "field_error": "VALUE_INVALID",\n "receipt": {\n "reference": "string",\n "meter_number": "string",\n "value": 0,\n "unit": "string",\n "submitted_at": "string"\n },\n "reason": "NO_METERS"\n}\n```\n\n</details>\n\n---\n\n### `startChatAction`\n\n`POST /v1/actions`\n\n```ts\nconst { data } = await client.startChatAction(\n null,\n {\n request_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n action_type: \'submit_meter_reading\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "status": "none",\n "action_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "revision": 0,\n "options": [\n {\n "meter_id": "string",\n "counter_id": "string",\n "meter_number": "string",\n "label": "string",\n "unit": "string",\n "min_value": 0,\n "max_value": 0\n }\n ],\n "values": {\n "meter_id": "string",\n "counter_id": "string",\n "value": 0\n },\n "field_error": "VALUE_INVALID",\n "receipt": {\n "reference": "string",\n "meter_number": "string",\n "value": 0,\n "unit": "string",\n "submitted_at": "string"\n },\n "reason": "NO_METERS"\n}\n```\n\n</details>\n\n---\n\n### `reportChatActionEvent`\n\n`POST /v1/actions/events`\n\n```ts\nconst { data } = await client.reportChatActionEvent(\n null,\n {\n action: \'string\',\n event: \'journey_submitted\'\n },\n)\n```\n\n---\n\n### `submitChatAction`\n\n`POST /v1/actions/{action_id}/submit`\n\n```ts\nconst { data } = await client.submitChatAction(\n {\n action_id: \'example\',\n },\n {\n expected_revision: 1,\n meter_id: \'string\',\n counter_id: \'string\',\n value: 0\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "status": "none",\n "action_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "revision": 0,\n "options": [\n {\n "meter_id": "string",\n "counter_id": "string",\n "meter_number": "string",\n "label": "string",\n "unit": "string",\n "min_value": 0,\n "max_value": 0\n }\n ],\n "values": {\n "meter_id": "string",\n "counter_id": "string",\n "value": 0\n },\n "field_error": "VALUE_INVALID",\n "receipt": {\n "reference": "string",\n "meter_number": "string",\n "value": 0,\n "unit": "string",\n "submitted_at": "string"\n },\n "reason": "NO_METERS"\n}\n```\n\n</details>\n\n---\n\n### `confirmChatAction`\n\n`POST /v1/actions/{action_id}/confirm`\n\n```ts\nconst { data } = await client.confirmChatAction(\n {\n action_id: \'example\',\n },\n {\n expected_revision: 1\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "status": "none",\n "action_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "revision": 0,\n "options": [\n {\n "meter_id": "string",\n "counter_id": "string",\n "meter_number": "string",\n "label": "string",\n "unit": "string",\n "min_value": 0,\n "max_value": 0\n }\n ],\n "values": {\n "meter_id": "string",\n "counter_id": "string",\n "value": 0\n },\n "field_error": "VALUE_INVALID",\n "receipt": {\n "reference": "string",\n "meter_number": "string",\n "value": 0,\n "unit": "string",\n "submitted_at": "string"\n },\n "reason": "NO_METERS"\n}\n```\n\n</details>\n\n---\n\n### `cancelChatAction`\n\n`POST /v1/actions/{action_id}/cancel`\n\n```ts\nconst { data } = await client.cancelChatAction(\n {\n action_id: \'example\',\n },\n {\n expected_revision: 1\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "status": "none",\n "action_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "revision": 0,\n "options": [\n {\n "meter_id": "string",\n "counter_id": "string",\n "meter_number": "string",\n "label": "string",\n "unit": "string",\n "min_value": 0,\n "max_value": 0\n }\n ],\n "values": {\n "meter_id": "string",\n "counter_id": "string",\n "value": 0\n },\n "field_error": "VALUE_INVALID",\n "receipt": {\n "reference": "string",\n "meter_number": "string",\n "value": 0,\n "unit": "string",\n "submitted_at": "string"\n },\n "reason": "NO_METERS"\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `ListWebsiteChatsResponse`\n\n```ts\ntype ListWebsiteChatsResponse = {\n website_chats: Array<{\n name: string\n agent_id: string // uuid\n settings: {\n allowed_origins: { ... }\n organisation_name: { ... }\n default_locale: { ... }\n design_id?: { ... }\n authentication?: { ... }\n self_service?: { ... }\n }\n website_chat_id: string // uuid\n org_id: string\n binding_id: string // uuid\n version: number\n created_at: string // date-time\n updated_at: string // date-time\n embed: {\n script_url: { ... }\n chat_api_origin: { ... }\n demo_url: { ... }\n }\n }>\n next_cursor?: string\n}\n```\n\n### `WebsiteChat`\n\n```ts\ntype WebsiteChat = {\n name: string\n agent_id: string // uuid\n settings: {\n allowed_origins: string[]\n organisation_name: string\n default_locale: "en" | "de"\n design_id?: string // uuid\n authentication?: {\n email_code?: { ... }\n portal?: { ... }\n }\n self_service?: {\n actions: { ... }\n }\n }\n website_chat_id: string // uuid\n org_id: string\n binding_id: string // uuid\n version: number\n created_at: string // date-time\n updated_at: string // date-time\n embed: {\n script_url: string // uri\n chat_api_origin: string // uri\n demo_url: string // uri\n }\n}\n```\n\n### `WebsiteChatSettings`\n\n```ts\ntype WebsiteChatSettings = {\n allowed_origins: string[]\n organisation_name: string\n default_locale: "en" | "de"\n design_id?: string // uuid\n authentication?: {\n email_code?: {\n email_template_id?: { ... }\n }\n portal?: {\n portal_id: { ... }\n }\n }\n self_service?: {\n actions: Array<{\n action: { ... }\n enabled: { ... }\n fulfilment: { ... }\n journey_id?: { ... }\n url?: { ... }\n access: { ... }\n guidance?: { ... }\n }>\n }\n}\n```\n\n### `SelfServiceSettings`\n\nSelf-service actions customers can start in this Website Chat. On update, the list is replaced as a whole; null removes all actions.\n\n```ts\ntype SelfServiceSettings = {\n actions: Array<{\n action: "submit_meter_reading" | "change_installment_rate" | "update_payment_method" | "change_billing_address" | "update_customer_details" | "change_tariff" | "report_move" | "terminate_contract"\n enabled: boolean\n fulfilment: "in_chat" | "journey" | "link"\n journey_id?: string // uuid\n url?: string\n access: "anonymous" | "identified" | "verified"\n guidance?: string\n }>\n}\n```\n\n### `SelfServiceAction`\n\nHow a self-service action is done and who can start it. A journey needs journey_id, a link needs url. in_chat is only available for submit_meter_reading and requires a verified customer.\n\n```ts\ntype SelfServiceAction = {\n action: "submit_meter_reading" | "change_installment_rate" | "update_payment_method" | "change_billing_address" | "update_customer_details" | "change_tariff" | "report_move" | "terminate_contract"\n enabled: boolean\n fulfilment: "in_chat" | "journey" | "link"\n journey_id?: string // uuid\n url?: string\n access: "anonymous" | "identified" | "verified"\n guidance?: string\n}\n```\n\n### `WebsiteChatPreviewGrantRequest`\n\n```ts\ntype WebsiteChatPreviewGrantRequest = {\n design_id?: string // uuid\n}\n```\n\n### `WebsiteChatPreviewGrant`\n\n```ts\ntype WebsiteChatPreviewGrant = {\n grant: string\n expires_in: number\n frame_origin: string // uri\n website_chat: {\n key: string\n organisationName: string\n assistantName: string\n defaultLocale: "en" | "de"\n login_methods: "email_code" | "portal_login"[]\n starters?: {\n de?: { ... }\n en?: { ... }\n }\n actions?: {\n meter_reading?: { ... }\n meter_reading_journey_id?: { ... }\n }\n design?: {\n id: { ... }\n last_modified_at?: { ... }\n style?: { ... }\n spark_theme?: { ... }\n }\n locales: "en" | "de"[]\n }\n}\n```\n\n### `Error`\n\n```ts\ntype Error = {\n error?: string\n message?: string\n details?: object\n}\n```\n\n### `CreateWebsiteChatRequest`\n\n```ts\ntype CreateWebsiteChatRequest = {\n name: string\n agent_id: string // uuid\n settings: {\n allowed_origins: string[]\n organisation_name: string\n default_locale: "en" | "de"\n design_id?: string // uuid\n authentication?: {\n email_code?: { ... }\n portal?: { ... }\n }\n self_service?: {\n actions: { ... }\n }\n }\n}\n```\n\n### `UpdateWebsiteChatRequest`\n\n```ts\ntype UpdateWebsiteChatRequest = {\n name?: string\n agent_id?: string // uuid\n settings?: {\n allowed_origins: string[]\n organisation_name: string\n default_locale: "en" | "de"\n design_id?: string // uuid\n authentication?: {\n email_code?: { ... }\n portal?: { ... }\n }\n self_service?: {\n actions: { ... }\n }\n }\n version: number\n}\n```\n\n### `ActionRevision`\n\n```ts\ntype ActionRevision = {\n expected_revision: number\n}\n```\n\n### `ActionState`\n\n```ts\ntype ActionState = {\n conversation_id: string // uuid\n status: "none" | "needs_input" | "needs_confirmation" | "executing" | "completed" | "pending" | "rejected" | "handoff"\n action_id?: string // uuid\n revision?: number\n options?: Array<{\n meter_id: string\n counter_id: string\n meter_number: string\n label: string\n unit: string\n min_value?: number\n max_value?: number\n }>\n values?: {\n meter_id: string\n counter_id: string\n value: number\n }\n field_error?: "VALUE_INVALID" | "VALUE_OUT_OF_RANGE" | "TARGET_UNAVAILABLE"\n receipt?: {\n reference: string\n meter_number: string\n value: number\n unit: string\n submitted_at: string\n }\n reason?: "NO_METERS" | "SUBMISSION_REJECTED" | "SUBMISSION_UNCERTAIN"\n}\n```\n\n### `VerificationState`\n\n```ts\ntype VerificationState = {\n available: boolean\n conversation_id: string // uuid\n status: "anonymous" | "sending" | "pending" | "verified"\n challenge_id?: string // uuid\n code_expires_at?: number\n resend_after?: number\n email?: string // email\n contact_resolution?: "matched" | "ambiguous" | "not_found"\n access: {\n tier: "anonymous" | "identified" | "verified"\n method?: "email_code" | "portal_login"\n }\n}\n```\n\n### `PortalLoginState`\n\n```ts\ntype PortalLoginState = {\n available: boolean\n conversation_id: string // uuid\n status: "anonymous" | "pending" | "verified"\n challenge_id?: string // uuid\n code_expires_at?: number\n attempts_left?: number\n email?: string // email\n contact_resolution?: "matched" | "not_found"\n access: {\n tier: "anonymous" | "identified" | "verified"\n method?: "email_code" | "portal_login"\n }\n}\n```\n\n### `LoginMethod`\n\nHow a customer can log in or verify themselves in the chat.\n\n```ts\ntype LoginMethod = "email_code" | "portal_login"\n```\n\n### `AccessTier`\n\nanonymous: no customer identity. identified: the Contact is known but ownership\nis not proven. verified: ownership is proven (an email code or a portal login).\n\n\n```ts\ntype AccessTier = "anonymous" | "identified" | "verified"\n```\n\n### `CustomerAccess`\n\n```ts\ntype CustomerAccess = {\n tier: "anonymous" | "identified" | "verified"\n method?: "email_code" | "portal_login"\n}\n```\n\n### `StarterQuestions`\n\nAt most six. (No maxItems, which generated clients turn into fixed-length tuples.)\n\n```ts\ntype StarterQuestions = string[]\n```\n\n### `PublicWebsiteChat`\n\n```ts\ntype PublicWebsiteChat = {\n key: string\n organisationName: string\n assistantName: string\n defaultLocale: "en" | "de"\n login_methods: "email_code" | "portal_login"[]\n starters?: {\n de?: string[]\n en?: string[]\n }\n actions?: {\n meter_reading?: boolean\n meter_reading_journey_id?: string // uuid\n }\n design?: {\n id: string // uuid\n last_modified_at?: string\n style?: {\n palette?: { ... }\n typography?: { ... }\n shape?: { ... }\n }\n spark_theme?: {\n accentColor?: { ... }\n backgroundColor?: { ... }\n fontBody?: { ... }\n fontHeading?: { ... }\n radius?: { ... }\n scaling?: { ... }\n spacing?: { ... }\n appearance?: { ... }\n neutralColor?: { ... }\n styleVariant?: { ... }\n labelPosition?: { ... }\n inputStyle?: { ... }\n inputColor?: { ... }\n cardVariant?: { ... }\n cardColor?: { ... }\n highContrast?: { ... }\n }\n }\n locales: "en" | "de"[]\n}\n```\n\n### `WebsiteChatDesign`\n\n```ts\ntype WebsiteChatDesign = {\n id: string // uuid\n last_modified_at?: string\n style?: {\n palette?: {\n primary?: { ... }\n background?: { ... }\n }\n typography?: {\n font?: { ... }\n }\n shape?: {\n border_radius?: { ... }\n }\n }\n spark_theme?: {\n accentColor?: string\n backgroundColor?: string\n fontBody?: string\n fontHeading?: string\n radius?: string\n scaling?: string\n spacing?: string\n appearance?: string\n neutralColor?: string\n styleVariant?: string\n labelPosition?: string\n inputStyle?: string\n inputColor?: string\n cardVariant?: string\n cardColor?: string\n highContrast?: boolean\n }\n}\n```\n\n### `PublicEvent`\n\nJSON payload of one SSE data frame from sendAnonymousChatMessage.\n\n```ts\ntype PublicEvent = {\n type: "delta"\n text: string\n request_id: string // uuid\n} | {\n type: "complete"\n text: string\n request_id: string // uuid\n} | {\n type: "error"\n code: "UNAVAILABLE"\n request_id: string // uuid\n} | {\n type: "action"\n action: {\n action: string\n fulfilment: "in_chat" | "journey" | "link"\n journey_id?: string // uuid\n url?: string\n access: "anonymous" | "identified" | "verified"\n }\n request_id: string // uuid\n}\n```\n\n### `SelfServiceDirective`\n\n```ts\ntype SelfServiceDirective = {\n action: string\n fulfilment: "in_chat" | "journey" | "link"\n journey_id?: string // uuid\n url?: string\n access: "anonymous" | "identified" | "verified"\n}\n```\n\n### `PublicChatError`\n\n```ts\ntype PublicChatError = {\n code: "INVALID_VERIFICATION_CODE" | "VERIFICATION_EXPIRED" | "VERIFICATION_CONFLICT" | "VERIFICATION_DISABLED" | "VERIFICATION_UNAVAILABLE" | "IDENTITY_CHANGED" | "INVALID_REQUEST" | "ORIGIN_DENIED" | "NOT_FOUND" | "INVALID_GRANT" | "SESSION_EXPIRED" | "RATE_LIMITED" | "SESSION_LIMIT" | "USAGE_LIMIT" | "REQUEST_CONFLICT" | "IN_PROGRESS" | "UNAVAILABLE" | "TEMPORARILY_UNAVAILABLE" | "IDENTITY_REQUIRED" | "ACTION_UNAVAILABLE" | "ACTION_CONFLICT" | "ACTION_TARGET_DENIED" | "INVALID_LOGIN_CODE" | "LOGIN_EXPIRED" | "LOGIN_DISABLED" | "LOGIN_UNAVAILABLE" | "LOGIN_CONFLICT" | "LOGIN_REJECTED"\n attempts_left?: number\n}\n```\n';
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
exports.default = chat_default;
|
|
@@ -1645,6 +1645,19 @@ declare namespace Components {
|
|
|
1645
1645
|
* Login methods currently available to the customer.
|
|
1646
1646
|
*/
|
|
1647
1647
|
login_methods: ("email_code" | "portal_login")[];
|
|
1648
|
+
/**
|
|
1649
|
+
* Starter questions of the assigned Agent Builder website agent, by locale. Absent when the agent has none; clients then show their own defaults.
|
|
1650
|
+
*/
|
|
1651
|
+
starters?: {
|
|
1652
|
+
/**
|
|
1653
|
+
* At most six. (No maxItems, which generated clients turn into fixed-length tuples.)
|
|
1654
|
+
*/
|
|
1655
|
+
de?: string[];
|
|
1656
|
+
/**
|
|
1657
|
+
* At most six. (No maxItems, which generated clients turn into fixed-length tuples.)
|
|
1658
|
+
*/
|
|
1659
|
+
en?: string[];
|
|
1660
|
+
};
|
|
1648
1661
|
/**
|
|
1649
1662
|
* Prototype Guided Actions offered by this Website Chat.
|
|
1650
1663
|
*/
|
|
@@ -1688,6 +1701,9 @@ declare namespace Components {
|
|
|
1688
1701
|
highContrast?: boolean;
|
|
1689
1702
|
};
|
|
1690
1703
|
};
|
|
1704
|
+
/**
|
|
1705
|
+
* Languages the chat offers, default first: the assigned Agent Builder website agent's languages, or both for a legacy agent. Hide the language choice when there is one.
|
|
1706
|
+
*/
|
|
1691
1707
|
locales: ("en" | "de")[];
|
|
1692
1708
|
}
|
|
1693
1709
|
/**
|
|
@@ -2157,6 +2173,10 @@ declare namespace Components {
|
|
|
2157
2173
|
}?
|
|
2158
2174
|
];
|
|
2159
2175
|
} | null;
|
|
2176
|
+
/**
|
|
2177
|
+
* At most six. (No maxItems, which generated clients turn into fixed-length tuples.)
|
|
2178
|
+
*/
|
|
2179
|
+
export type StarterQuestions = string[];
|
|
2160
2180
|
export interface UpdateWebsiteChatRequest {
|
|
2161
2181
|
name?: string;
|
|
2162
2182
|
agent_id?: string | null; // uuid
|
|
@@ -3270,6 +3290,93 @@ declare namespace Components {
|
|
|
3270
3290
|
highContrast?: boolean;
|
|
3271
3291
|
};
|
|
3272
3292
|
}
|
|
3293
|
+
export interface WebsiteChatPreviewGrant {
|
|
3294
|
+
/**
|
|
3295
|
+
* Single-use grant for POST /v1/sessions.
|
|
3296
|
+
*/
|
|
3297
|
+
grant: string;
|
|
3298
|
+
/**
|
|
3299
|
+
* Seconds until the grant expires.
|
|
3300
|
+
*/
|
|
3301
|
+
expires_in: number;
|
|
3302
|
+
frame_origin: string; // uri
|
|
3303
|
+
website_chat: {
|
|
3304
|
+
key: string;
|
|
3305
|
+
organisationName: string;
|
|
3306
|
+
assistantName: string;
|
|
3307
|
+
defaultLocale: "en" | "de";
|
|
3308
|
+
/**
|
|
3309
|
+
* Login methods currently available to the customer.
|
|
3310
|
+
*/
|
|
3311
|
+
login_methods: ("email_code" | "portal_login")[];
|
|
3312
|
+
/**
|
|
3313
|
+
* Starter questions of the assigned Agent Builder website agent, by locale. Absent when the agent has none; clients then show their own defaults.
|
|
3314
|
+
*/
|
|
3315
|
+
starters?: {
|
|
3316
|
+
/**
|
|
3317
|
+
* At most six. (No maxItems, which generated clients turn into fixed-length tuples.)
|
|
3318
|
+
*/
|
|
3319
|
+
de?: string[];
|
|
3320
|
+
/**
|
|
3321
|
+
* At most six. (No maxItems, which generated clients turn into fixed-length tuples.)
|
|
3322
|
+
*/
|
|
3323
|
+
en?: string[];
|
|
3324
|
+
};
|
|
3325
|
+
/**
|
|
3326
|
+
* Prototype Guided Actions offered by this Website Chat.
|
|
3327
|
+
*/
|
|
3328
|
+
actions?: {
|
|
3329
|
+
meter_reading?: boolean;
|
|
3330
|
+
meter_reading_journey_id?: string; // uuid
|
|
3331
|
+
};
|
|
3332
|
+
design?: {
|
|
3333
|
+
id: string; // uuid
|
|
3334
|
+
last_modified_at?: string;
|
|
3335
|
+
style?: {
|
|
3336
|
+
palette?: {
|
|
3337
|
+
primary?: string;
|
|
3338
|
+
background?: string;
|
|
3339
|
+
};
|
|
3340
|
+
typography?: {
|
|
3341
|
+
font?: {
|
|
3342
|
+
font_family?: string;
|
|
3343
|
+
};
|
|
3344
|
+
};
|
|
3345
|
+
shape?: {
|
|
3346
|
+
border_radius?: number;
|
|
3347
|
+
};
|
|
3348
|
+
};
|
|
3349
|
+
spark_theme?: {
|
|
3350
|
+
accentColor?: string;
|
|
3351
|
+
backgroundColor?: string;
|
|
3352
|
+
fontBody?: string;
|
|
3353
|
+
fontHeading?: string;
|
|
3354
|
+
radius?: string;
|
|
3355
|
+
scaling?: string;
|
|
3356
|
+
spacing?: string;
|
|
3357
|
+
appearance?: string;
|
|
3358
|
+
neutralColor?: string;
|
|
3359
|
+
styleVariant?: string;
|
|
3360
|
+
labelPosition?: string;
|
|
3361
|
+
inputStyle?: string;
|
|
3362
|
+
inputColor?: string;
|
|
3363
|
+
cardVariant?: string;
|
|
3364
|
+
cardColor?: string;
|
|
3365
|
+
highContrast?: boolean;
|
|
3366
|
+
};
|
|
3367
|
+
};
|
|
3368
|
+
/**
|
|
3369
|
+
* Languages the chat offers, default first: the assigned Agent Builder website agent's languages, or both for a legacy agent. Hide the language choice when there is one.
|
|
3370
|
+
*/
|
|
3371
|
+
locales: ("en" | "de")[];
|
|
3372
|
+
};
|
|
3373
|
+
}
|
|
3374
|
+
export interface WebsiteChatPreviewGrantRequest {
|
|
3375
|
+
/**
|
|
3376
|
+
* Unsaved design to preview. Omit to keep the saved design; null previews the default design.
|
|
3377
|
+
*/
|
|
3378
|
+
design_id?: string | null; // uuid
|
|
3379
|
+
}
|
|
3273
3380
|
export interface WebsiteChatSettings {
|
|
3274
3381
|
/**
|
|
3275
3382
|
* Exact HTTPS origins. Empty means the Website Chat cannot start sessions.
|
|
@@ -4863,6 +4970,19 @@ declare namespace Paths {
|
|
|
4863
4970
|
* Login methods currently available to the customer.
|
|
4864
4971
|
*/
|
|
4865
4972
|
login_methods: ("email_code" | "portal_login")[];
|
|
4973
|
+
/**
|
|
4974
|
+
* Starter questions of the assigned Agent Builder website agent, by locale. Absent when the agent has none; clients then show their own defaults.
|
|
4975
|
+
*/
|
|
4976
|
+
starters?: {
|
|
4977
|
+
/**
|
|
4978
|
+
* At most six. (No maxItems, which generated clients turn into fixed-length tuples.)
|
|
4979
|
+
*/
|
|
4980
|
+
de?: string[];
|
|
4981
|
+
/**
|
|
4982
|
+
* At most six. (No maxItems, which generated clients turn into fixed-length tuples.)
|
|
4983
|
+
*/
|
|
4984
|
+
en?: string[];
|
|
4985
|
+
};
|
|
4866
4986
|
/**
|
|
4867
4987
|
* Prototype Guided Actions offered by this Website Chat.
|
|
4868
4988
|
*/
|
|
@@ -4906,8 +5026,15 @@ declare namespace Paths {
|
|
|
4906
5026
|
highContrast?: boolean;
|
|
4907
5027
|
};
|
|
4908
5028
|
};
|
|
5029
|
+
/**
|
|
5030
|
+
* Languages the chat offers, default first: the assigned Agent Builder website agent's languages, or both for a legacy agent. Hide the language choice when there is one.
|
|
5031
|
+
*/
|
|
4909
5032
|
locales: ("en" | "de")[];
|
|
4910
5033
|
};
|
|
5034
|
+
/**
|
|
5035
|
+
* Agent Builder preview session; the frame only runs it inside the 360 portal.
|
|
5036
|
+
*/
|
|
5037
|
+
preview?: boolean;
|
|
4911
5038
|
}
|
|
4912
5039
|
export interface Default {
|
|
4913
5040
|
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";
|
|
@@ -6011,6 +6138,125 @@ declare namespace Paths {
|
|
|
6011
6138
|
}
|
|
6012
6139
|
}
|
|
6013
6140
|
}
|
|
6141
|
+
namespace CreateWebsiteChatPreviewGrant {
|
|
6142
|
+
export interface RequestBody {
|
|
6143
|
+
/**
|
|
6144
|
+
* Unsaved design to preview. Omit to keep the saved design; null previews the default design.
|
|
6145
|
+
*/
|
|
6146
|
+
design_id?: string | null; // uuid
|
|
6147
|
+
}
|
|
6148
|
+
namespace Responses {
|
|
6149
|
+
export interface $201 {
|
|
6150
|
+
/**
|
|
6151
|
+
* Single-use grant for POST /v1/sessions.
|
|
6152
|
+
*/
|
|
6153
|
+
grant: string;
|
|
6154
|
+
/**
|
|
6155
|
+
* Seconds until the grant expires.
|
|
6156
|
+
*/
|
|
6157
|
+
expires_in: number;
|
|
6158
|
+
frame_origin: string; // uri
|
|
6159
|
+
website_chat: {
|
|
6160
|
+
key: string;
|
|
6161
|
+
organisationName: string;
|
|
6162
|
+
assistantName: string;
|
|
6163
|
+
defaultLocale: "en" | "de";
|
|
6164
|
+
/**
|
|
6165
|
+
* Login methods currently available to the customer.
|
|
6166
|
+
*/
|
|
6167
|
+
login_methods: ("email_code" | "portal_login")[];
|
|
6168
|
+
/**
|
|
6169
|
+
* Starter questions of the assigned Agent Builder website agent, by locale. Absent when the agent has none; clients then show their own defaults.
|
|
6170
|
+
*/
|
|
6171
|
+
starters?: {
|
|
6172
|
+
/**
|
|
6173
|
+
* At most six. (No maxItems, which generated clients turn into fixed-length tuples.)
|
|
6174
|
+
*/
|
|
6175
|
+
de?: string[];
|
|
6176
|
+
/**
|
|
6177
|
+
* At most six. (No maxItems, which generated clients turn into fixed-length tuples.)
|
|
6178
|
+
*/
|
|
6179
|
+
en?: string[];
|
|
6180
|
+
};
|
|
6181
|
+
/**
|
|
6182
|
+
* Prototype Guided Actions offered by this Website Chat.
|
|
6183
|
+
*/
|
|
6184
|
+
actions?: {
|
|
6185
|
+
meter_reading?: boolean;
|
|
6186
|
+
meter_reading_journey_id?: string; // uuid
|
|
6187
|
+
};
|
|
6188
|
+
design?: {
|
|
6189
|
+
id: string; // uuid
|
|
6190
|
+
last_modified_at?: string;
|
|
6191
|
+
style?: {
|
|
6192
|
+
palette?: {
|
|
6193
|
+
primary?: string;
|
|
6194
|
+
background?: string;
|
|
6195
|
+
};
|
|
6196
|
+
typography?: {
|
|
6197
|
+
font?: {
|
|
6198
|
+
font_family?: string;
|
|
6199
|
+
};
|
|
6200
|
+
};
|
|
6201
|
+
shape?: {
|
|
6202
|
+
border_radius?: number;
|
|
6203
|
+
};
|
|
6204
|
+
};
|
|
6205
|
+
spark_theme?: {
|
|
6206
|
+
accentColor?: string;
|
|
6207
|
+
backgroundColor?: string;
|
|
6208
|
+
fontBody?: string;
|
|
6209
|
+
fontHeading?: string;
|
|
6210
|
+
radius?: string;
|
|
6211
|
+
scaling?: string;
|
|
6212
|
+
spacing?: string;
|
|
6213
|
+
appearance?: string;
|
|
6214
|
+
neutralColor?: string;
|
|
6215
|
+
styleVariant?: string;
|
|
6216
|
+
labelPosition?: string;
|
|
6217
|
+
inputStyle?: string;
|
|
6218
|
+
inputColor?: string;
|
|
6219
|
+
cardVariant?: string;
|
|
6220
|
+
cardColor?: string;
|
|
6221
|
+
highContrast?: boolean;
|
|
6222
|
+
};
|
|
6223
|
+
};
|
|
6224
|
+
/**
|
|
6225
|
+
* Languages the chat offers, default first: the assigned Agent Builder website agent's languages, or both for a legacy agent. Hide the language choice when there is one.
|
|
6226
|
+
*/
|
|
6227
|
+
locales: ("en" | "de")[];
|
|
6228
|
+
};
|
|
6229
|
+
}
|
|
6230
|
+
export interface $400 {
|
|
6231
|
+
error?: string;
|
|
6232
|
+
message?: string;
|
|
6233
|
+
details?: {
|
|
6234
|
+
[key: string]: any;
|
|
6235
|
+
};
|
|
6236
|
+
}
|
|
6237
|
+
export interface $403 {
|
|
6238
|
+
error?: string;
|
|
6239
|
+
message?: string;
|
|
6240
|
+
details?: {
|
|
6241
|
+
[key: string]: any;
|
|
6242
|
+
};
|
|
6243
|
+
}
|
|
6244
|
+
export interface $404 {
|
|
6245
|
+
error?: string;
|
|
6246
|
+
message?: string;
|
|
6247
|
+
details?: {
|
|
6248
|
+
[key: string]: any;
|
|
6249
|
+
};
|
|
6250
|
+
}
|
|
6251
|
+
export interface $429 {
|
|
6252
|
+
error?: string;
|
|
6253
|
+
message?: string;
|
|
6254
|
+
details?: {
|
|
6255
|
+
[key: string]: any;
|
|
6256
|
+
};
|
|
6257
|
+
}
|
|
6258
|
+
}
|
|
6259
|
+
}
|
|
6014
6260
|
namespace DeleteWebsiteChat {
|
|
6015
6261
|
namespace Parameters {
|
|
6016
6262
|
export type Version = number;
|
|
@@ -6527,6 +6773,24 @@ declare namespace Paths {
|
|
|
6527
6773
|
}
|
|
6528
6774
|
}
|
|
6529
6775
|
}
|
|
6776
|
+
namespace GetChatPortalJourneyToken {
|
|
6777
|
+
namespace Responses {
|
|
6778
|
+
export interface $200 {
|
|
6779
|
+
id_token: string;
|
|
6780
|
+
/**
|
|
6781
|
+
* Unix seconds
|
|
6782
|
+
*/
|
|
6783
|
+
expires_at: number;
|
|
6784
|
+
}
|
|
6785
|
+
export interface Default {
|
|
6786
|
+
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";
|
|
6787
|
+
/**
|
|
6788
|
+
* Remaining code attempts; only with INVALID_LOGIN_CODE.
|
|
6789
|
+
*/
|
|
6790
|
+
attempts_left?: number;
|
|
6791
|
+
}
|
|
6792
|
+
}
|
|
6793
|
+
}
|
|
6530
6794
|
namespace GetChatPortalLogin {
|
|
6531
6795
|
namespace Responses {
|
|
6532
6796
|
export interface $200 {
|
|
@@ -6619,6 +6883,19 @@ declare namespace Paths {
|
|
|
6619
6883
|
* Login methods currently available to the customer.
|
|
6620
6884
|
*/
|
|
6621
6885
|
login_methods: ("email_code" | "portal_login")[];
|
|
6886
|
+
/**
|
|
6887
|
+
* Starter questions of the assigned Agent Builder website agent, by locale. Absent when the agent has none; clients then show their own defaults.
|
|
6888
|
+
*/
|
|
6889
|
+
starters?: {
|
|
6890
|
+
/**
|
|
6891
|
+
* At most six. (No maxItems, which generated clients turn into fixed-length tuples.)
|
|
6892
|
+
*/
|
|
6893
|
+
de?: string[];
|
|
6894
|
+
/**
|
|
6895
|
+
* At most six. (No maxItems, which generated clients turn into fixed-length tuples.)
|
|
6896
|
+
*/
|
|
6897
|
+
en?: string[];
|
|
6898
|
+
};
|
|
6622
6899
|
/**
|
|
6623
6900
|
* Prototype Guided Actions offered by this Website Chat.
|
|
6624
6901
|
*/
|
|
@@ -6662,6 +6939,9 @@ declare namespace Paths {
|
|
|
6662
6939
|
highContrast?: boolean;
|
|
6663
6940
|
};
|
|
6664
6941
|
};
|
|
6942
|
+
/**
|
|
6943
|
+
* Languages the chat offers, default first: the assigned Agent Builder website agent's languages, or both for a legacy agent. Hide the language choice when there is one.
|
|
6944
|
+
*/
|
|
6665
6945
|
locales: ("en" | "de")[];
|
|
6666
6946
|
}
|
|
6667
6947
|
export interface Default {
|
|
@@ -7794,6 +8074,23 @@ declare namespace Paths {
|
|
|
7794
8074
|
}
|
|
7795
8075
|
}
|
|
7796
8076
|
}
|
|
8077
|
+
namespace ReportChatActionEvent {
|
|
8078
|
+
export interface RequestBody {
|
|
8079
|
+
action: string; // ^[a-z][a-z_]{0,59}$
|
|
8080
|
+
event: "journey_submitted" | "journey_closed";
|
|
8081
|
+
}
|
|
8082
|
+
namespace Responses {
|
|
8083
|
+
export interface $204 {
|
|
8084
|
+
}
|
|
8085
|
+
export interface Default {
|
|
8086
|
+
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";
|
|
8087
|
+
/**
|
|
8088
|
+
* Remaining code attempts; only with INVALID_LOGIN_CODE.
|
|
8089
|
+
*/
|
|
8090
|
+
attempts_left?: number;
|
|
8091
|
+
}
|
|
8092
|
+
}
|
|
8093
|
+
}
|
|
7797
8094
|
namespace SendAnonymousChatMessage {
|
|
7798
8095
|
export interface RequestBody {
|
|
7799
8096
|
request_id: string; // uuid ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
|
|
@@ -9986,6 +10283,14 @@ declare namespace Paths {
|
|
|
9986
10283
|
website_chat_id: Parameters.WebsiteChatId /* uuid */;
|
|
9987
10284
|
}
|
|
9988
10285
|
}
|
|
10286
|
+
namespace V1WebsiteChats$WebsiteChatIdPreviewGrant {
|
|
10287
|
+
namespace Parameters {
|
|
10288
|
+
export type WebsiteChatId = string; // uuid
|
|
10289
|
+
}
|
|
10290
|
+
export interface PathParameters {
|
|
10291
|
+
website_chat_id: Parameters.WebsiteChatId /* uuid */;
|
|
10292
|
+
}
|
|
10293
|
+
}
|
|
9989
10294
|
namespace VerifyChatEmailCode {
|
|
9990
10295
|
export interface RequestBody {
|
|
9991
10296
|
challenge_id: string; // uuid
|
|
@@ -10113,6 +10418,14 @@ interface OperationMethods {
|
|
|
10113
10418
|
data?: any,
|
|
10114
10419
|
config?: AxiosRequestConfig
|
|
10115
10420
|
): OperationResponse<Paths.DeleteWebsiteChat.Responses.$204>
|
|
10421
|
+
/**
|
|
10422
|
+
* createWebsiteChatPreviewGrant - Issues a single-use grant for an Agent Builder preview of this Website Chat. Only callable from the 360 portal; the preview runs without allowed websites (also before any are added), is exempt from Website Chat analytics and ends after 15 minutes. The grant is exchanged at POST /v1/sessions within 60 seconds.
|
|
10423
|
+
*/
|
|
10424
|
+
'createWebsiteChatPreviewGrant'(
|
|
10425
|
+
parameters?: Parameters<Paths.V1WebsiteChats$WebsiteChatIdPreviewGrant.PathParameters> | null,
|
|
10426
|
+
data?: Paths.CreateWebsiteChatPreviewGrant.RequestBody,
|
|
10427
|
+
config?: AxiosRequestConfig
|
|
10428
|
+
): OperationResponse<Paths.CreateWebsiteChatPreviewGrant.Responses.$201>
|
|
10116
10429
|
/**
|
|
10117
10430
|
* getPublicWebsiteChat - Resolve visitor-facing configuration for an independent Website Chat and its current agent assignment. The Website Chat ID is not an organisation ID or a destination such as website or portal.
|
|
10118
10431
|
*/
|
|
@@ -10190,6 +10503,14 @@ interface OperationMethods {
|
|
|
10190
10503
|
data?: any,
|
|
10191
10504
|
config?: AxiosRequestConfig
|
|
10192
10505
|
): OperationResponse<Paths.GetChatPortalLogin.Responses.$200 | Paths.GetChatPortalLogin.Responses.Default>
|
|
10506
|
+
/**
|
|
10507
|
+
* getChatPortalJourneyToken - Prototype. The portal ID token of this session's portal login, for an embedded Journey running in the Journey app's parent-auth mode, so the customer does not log in twice. Only for a valid portal login; the frame keeps it in memory and posts it only to the Journey origin.
|
|
10508
|
+
*/
|
|
10509
|
+
'getChatPortalJourneyToken'(
|
|
10510
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
10511
|
+
data?: any,
|
|
10512
|
+
config?: AxiosRequestConfig
|
|
10513
|
+
): OperationResponse<Paths.GetChatPortalJourneyToken.Responses.$200 | Paths.GetChatPortalJourneyToken.Responses.Default>
|
|
10193
10514
|
/**
|
|
10194
10515
|
* startChatPortalLogin - Send a one-time code for the customer portal account with this email, using the portal
|
|
10195
10516
|
* configured on this session's Website Chat. The response is pending whether or not an
|
|
@@ -10245,6 +10566,14 @@ interface OperationMethods {
|
|
|
10245
10566
|
data?: Paths.StartChatAction.RequestBody,
|
|
10246
10567
|
config?: AxiosRequestConfig
|
|
10247
10568
|
): OperationResponse<Paths.StartChatAction.Responses.$200 | Paths.StartChatAction.Responses.Default>
|
|
10569
|
+
/**
|
|
10570
|
+
* reportChatActionEvent - Report what an embedded journey did, so the assistant can refer to it. Accepted only for a journey action this Website Chat offers. Browser input: the assistant is told it is not confirmed.
|
|
10571
|
+
*/
|
|
10572
|
+
'reportChatActionEvent'(
|
|
10573
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
10574
|
+
data?: Paths.ReportChatActionEvent.RequestBody,
|
|
10575
|
+
config?: AxiosRequestConfig
|
|
10576
|
+
): OperationResponse<Paths.ReportChatActionEvent.Responses.$204 | Paths.ReportChatActionEvent.Responses.Default>
|
|
10248
10577
|
/**
|
|
10249
10578
|
* submitChatAction - Prototype. Submit values for review. Targets must be one of the server-offered options; values are validated before confirmation.
|
|
10250
10579
|
*/
|
|
@@ -10316,6 +10645,16 @@ interface PathsDictionary {
|
|
|
10316
10645
|
config?: AxiosRequestConfig
|
|
10317
10646
|
): OperationResponse<Paths.DeleteWebsiteChat.Responses.$204>
|
|
10318
10647
|
}
|
|
10648
|
+
['/v1/website-chats/{website_chat_id}/preview-grant']: {
|
|
10649
|
+
/**
|
|
10650
|
+
* createWebsiteChatPreviewGrant - Issues a single-use grant for an Agent Builder preview of this Website Chat. Only callable from the 360 portal; the preview runs without allowed websites (also before any are added), is exempt from Website Chat analytics and ends after 15 minutes. The grant is exchanged at POST /v1/sessions within 60 seconds.
|
|
10651
|
+
*/
|
|
10652
|
+
'post'(
|
|
10653
|
+
parameters?: Parameters<Paths.V1WebsiteChats$WebsiteChatIdPreviewGrant.PathParameters> | null,
|
|
10654
|
+
data?: Paths.CreateWebsiteChatPreviewGrant.RequestBody,
|
|
10655
|
+
config?: AxiosRequestConfig
|
|
10656
|
+
): OperationResponse<Paths.CreateWebsiteChatPreviewGrant.Responses.$201>
|
|
10657
|
+
}
|
|
10319
10658
|
['/v1/website-chats/{website_chat_id}/configuration']: {
|
|
10320
10659
|
/**
|
|
10321
10660
|
* getPublicWebsiteChat - Resolve visitor-facing configuration for an independent Website Chat and its current agent assignment. The Website Chat ID is not an organisation ID or a destination such as website or portal.
|
|
@@ -10411,6 +10750,16 @@ interface PathsDictionary {
|
|
|
10411
10750
|
config?: AxiosRequestConfig
|
|
10412
10751
|
): OperationResponse<Paths.GetChatPortalLogin.Responses.$200 | Paths.GetChatPortalLogin.Responses.Default>
|
|
10413
10752
|
}
|
|
10753
|
+
['/v1/login/portal/journey-token']: {
|
|
10754
|
+
/**
|
|
10755
|
+
* getChatPortalJourneyToken - Prototype. The portal ID token of this session's portal login, for an embedded Journey running in the Journey app's parent-auth mode, so the customer does not log in twice. Only for a valid portal login; the frame keeps it in memory and posts it only to the Journey origin.
|
|
10756
|
+
*/
|
|
10757
|
+
'get'(
|
|
10758
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
10759
|
+
data?: any,
|
|
10760
|
+
config?: AxiosRequestConfig
|
|
10761
|
+
): OperationResponse<Paths.GetChatPortalJourneyToken.Responses.$200 | Paths.GetChatPortalJourneyToken.Responses.Default>
|
|
10762
|
+
}
|
|
10414
10763
|
['/v1/login/portal/start']: {
|
|
10415
10764
|
/**
|
|
10416
10765
|
* startChatPortalLogin - Send a one-time code for the customer portal account with this email, using the portal
|
|
@@ -10476,6 +10825,16 @@ interface PathsDictionary {
|
|
|
10476
10825
|
config?: AxiosRequestConfig
|
|
10477
10826
|
): OperationResponse<Paths.StartChatAction.Responses.$200 | Paths.StartChatAction.Responses.Default>
|
|
10478
10827
|
}
|
|
10828
|
+
['/v1/actions/events']: {
|
|
10829
|
+
/**
|
|
10830
|
+
* reportChatActionEvent - Report what an embedded journey did, so the assistant can refer to it. Accepted only for a journey action this Website Chat offers. Browser input: the assistant is told it is not confirmed.
|
|
10831
|
+
*/
|
|
10832
|
+
'post'(
|
|
10833
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
10834
|
+
data?: Paths.ReportChatActionEvent.RequestBody,
|
|
10835
|
+
config?: AxiosRequestConfig
|
|
10836
|
+
): OperationResponse<Paths.ReportChatActionEvent.Responses.$204 | Paths.ReportChatActionEvent.Responses.Default>
|
|
10837
|
+
}
|
|
10479
10838
|
['/v1/actions/{action_id}/submit']: {
|
|
10480
10839
|
/**
|
|
10481
10840
|
* submitChatAction - Prototype. Submit values for review. Targets must be one of the server-offered options; values are validated before confirmation.
|
|
@@ -10526,10 +10885,13 @@ type PublicWebsiteChat = Components.Schemas.PublicWebsiteChat;
|
|
|
10526
10885
|
type SelfServiceAction = Components.Schemas.SelfServiceAction;
|
|
10527
10886
|
type SelfServiceDirective = Components.Schemas.SelfServiceDirective;
|
|
10528
10887
|
type SelfServiceSettings = Components.Schemas.SelfServiceSettings;
|
|
10888
|
+
type StarterQuestions = Components.Schemas.StarterQuestions;
|
|
10529
10889
|
type UpdateWebsiteChatRequest = Components.Schemas.UpdateWebsiteChatRequest;
|
|
10530
10890
|
type VerificationState = Components.Schemas.VerificationState;
|
|
10531
10891
|
type WebsiteChat = Components.Schemas.WebsiteChat;
|
|
10532
10892
|
type WebsiteChatDesign = Components.Schemas.WebsiteChatDesign;
|
|
10893
|
+
type WebsiteChatPreviewGrant = Components.Schemas.WebsiteChatPreviewGrant;
|
|
10894
|
+
type WebsiteChatPreviewGrantRequest = Components.Schemas.WebsiteChatPreviewGrantRequest;
|
|
10533
10895
|
type WebsiteChatSettings = Components.Schemas.WebsiteChatSettings;
|
|
10534
10896
|
|
|
10535
|
-
export { type AccessTier as A, type Client as C, type Error as E, type ListWebsiteChatsResponse as L, type OperationMethods as O, Paths as P, type SelfServiceAction as S, type UpdateWebsiteChatRequest as U, type VerificationState as V, type WebsiteChat as W, Components as a, type PathsDictionary as b, type ActionRevision as c, type ActionState as d, type CreateWebsiteChatRequest as e, type CustomerAccess as f, type LoginMethod as g, type PortalLoginState as h, type PublicChatError as i, type PublicEvent as j, type PublicWebsiteChat as k, type SelfServiceDirective as l, type SelfServiceSettings as m, type
|
|
10897
|
+
export { type AccessTier as A, type Client as C, type Error as E, type ListWebsiteChatsResponse as L, type OperationMethods as O, Paths as P, type SelfServiceAction as S, type UpdateWebsiteChatRequest as U, type VerificationState as V, type WebsiteChat as W, Components as a, type PathsDictionary as b, type ActionRevision as c, type ActionState as d, type CreateWebsiteChatRequest as e, type CustomerAccess as f, type LoginMethod as g, type PortalLoginState as h, type PublicChatError as i, type PublicEvent as j, type PublicWebsiteChat as k, type SelfServiceDirective as l, type SelfServiceSettings as m, type StarterQuestions as n, type WebsiteChatDesign as o, type WebsiteChatPreviewGrant as p, type WebsiteChatPreviewGrantRequest as q, type WebsiteChatSettings as r };
|