@seamly/web-ui 20.7.0 → 20.8.0-alpha.1

package/src/javascripts/schema.ts

@@ -0,0 +1,1455 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+
+export interface paths {
+  '/client/{apiKey}/configs': {
+    /** Get account settings and conversation defaults */
+    post: operations['getAccountConfig']
+  }
+  '/client/{apiKey}/translations/{version}/{locale}.json': {
+    get: operations['getAccountTranslations']
+  }
+  '/client/{apiKey}/conversations': {
+    /** Create a new conversation. The full URL should be obtained from the HAL links as returned by the configs endpoint. */
+    post: operations['createConversation']
+  }
+  '/client/{apiKey}/conversations/{conversationId}': {
+    /** Get conversation to be resumed. The full URL should be obtained from the HAL links as returned by the POST conversations endpoint. */
+    get: operations['getConversation']
+  }
+  '/client/{apiKey}/conversations/{conversationId}/history': {
+    /** Get message history of a conversation. The full URL should be obtained from the HAL links as returned by the POST conversations endpoint. Pass the conversation's access token (as obtained by the initial POST to create the conversation) as a Bearer token. */
+    get: operations['getConversationHistory']
+  }
+  '/client/{apiKey}/conversations/{conversationId}/uploads': {
+    /** Upload a file of a conversation. The full URL should be obtained from the HAL links as returned by the POST conversations endpoint. Pass the conversation's access token (as obtained by the initial POST to create the conversation) as a Bearer token. */
+    post: operations['createConversationUpload']
+  }
+}
+
+export interface components {
+  schemas: {
+    ConversationResponse: {
+      /** @description Information about the conversation. */
+      conversation?: {
+        /** @description Token required to fetch the history and to establish a websocket connection. */
+        accessToken?: string
+        /**
+         * @description Phoenix websocket channel topic
+         * @example conversations:e096b036-ac9c-4e8b-b42c-9e0bcd74a5fd
+         */
+        channelTopic?: string
+        translation?: components['schemas']['Translation']
+        /**
+         * @description The amount of unread messages.
+         * @example 2
+         */
+        unreadMessageCount?: number
+        /**
+         * @description Whether or not the user has already interacted with / responded to the conversation.
+         * @example true
+         */
+        userResponded?: boolean
+      }
+      _links?: {
+        conversation?: {
+          /**
+           * @description The endpoint retrieve the conversation later on to resume it
+           * @example /client/f38c06f4-283b-4011-8672-4923cbdc8f26/conversations/4eb31272-ed89-4d0d-92c1-bc258bd7ac9c?srv_id=3010109
+           */
+          href?: string
+        }
+        history?: {
+          /**
+           * @description The endpoint retrieve the conversation's history
+           * @example /client/f38c06f4-283b-4011-8672-4923cbdc8f26/conversations/4eb31272-ed89-4d0d-92c1-bc258bd7ac9c/history?srv_id=3010109
+           */
+          href?: string
+        }
+        self?: {
+          /**
+           * @description The endpoint retrieve the conversation later on to resume it
+           * @example /client/f38c06f4-283b-4011-8672-4923cbdc8f26/conversations/4eb31272-ed89-4d0d-92c1-bc258bd7ac9c?srv_id=3010109
+           */
+          href?: string
+        }
+        socket?: {
+          /**
+           * @description The endpoint of the conversation websocket
+           * @example /client/f38c06f4-283b-4011-8672-4923cbdc8f26/socket/websocket?srv_id=3010109
+           */
+          href?: string
+        }
+        uploads?: {
+          /**
+           * @description The endpoint to send uploaded files to
+           * @example /client/f38c06f4-283b-4011-8672-4923cbdc8f26/conversations/4eb31272-ed89-4d0d-92c1-bc258bd7ac9c/uploads?srv_id=3010109
+           */
+          href?: string
+        }
+      }
+    }
+    ConversationHistoryResponse: {
+      /** @description History information of a conversation. */
+      history?: {
+        /**
+         * @description Internal identifier of the current service session. Can be used to determine which messages from the history are from the current service, and, for example, might have the choose-again functionality available.
+         * @example c18c86f3-a31f-4a61-a4f3-f805b5b71883
+         */
+        activeServiceSessionId?: string
+        /** @description Settings of the current service. */
+        activeServiceSettings?: {
+          /** @description Settings related to the input field */
+          entry?: {
+            /**
+             * @description The default type of input field.
+             * @example text
+             * @enum {string}
+             */
+            default?: 'text' | 'postal_code' | 'upload'
+            /** @description Specific options of the various entry types */
+            options?: {
+              /** @description Settings of the text entry */
+              text?: {
+                /**
+                 * @description Maximum number of characters the use may enter
+                 * @example 100
+                 */
+                limit?: number
+              }
+              /** @description Settings of the upload entry */
+              upload?: {
+                /**
+                 * @description List of allowed mime types of any uploaded file
+                 * @example [
+                 *   "application/msword",
+                 *   "application/pdf",
+                 *   "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
+                 *   "image/*",
+                 *   "text/*"
+                 * ]
+                 */
+                allowedMimeTypes?: string[]
+                /**
+                 * @description Whether file uploads are possible. When true the client might for instance show a file upload button.
+                 * @example true
+                 */
+                enabled?: boolean
+                /**
+                 * @description Maximum filesize in bytes
+                 * @example 10485760
+                 */
+                maxSize?: number
+              }
+            }
+          }
+          /** @description Exists for backward compatibility. Please ignore. */
+          uploads?: { [key: string]: unknown }
+        }
+        /**
+         * @description A list of all messages in the history of the conversation
+         * @example [
+         *   [
+         *     "message",
+         *     {}
+         *   ],
+         *   [
+         *     "message",
+         *     {}
+         *   ],
+         *   [
+         *     "participant",
+         *     {}
+         *   ]
+         * ]
+         */
+        messages?: (Partial<'info' | 'message' | 'participant'> &
+          Partial<components['schemas']['MessageInfo']> &
+          Partial<components['schemas']['MessageMessage']> &
+          Partial<components['schemas']['MessageParticipant']>)[][]
+        /** @description All participants that ever participated in the conversation. Only seamly-client-participant is specced, but all others will have their own entry by their own id. */
+        participants?: {
+          'seamly-client-participant'?: components['schemas']['Participant']
+        }
+        /** @description Additional information related to the conversation, such as FAQs (suggestions) */
+        serviceData?: {
+          suggestion?: components['schemas']['ServiceDataMessage']
+        }
+        translation?: components['schemas']['Translation']
+        /** @description Information about user interface elements */
+        ui?: {
+          /**
+           * @description Whether or not the client should show a prompt asking the user to continue the conversation.
+           * @example false
+           */
+          resumeConversationPrompt?: boolean
+        }
+      }
+      _links?: {
+        conversation?: {
+          /**
+           * @description The endpoint retrieve the conversation later on to resume it
+           * @example /client/f38c06f4-283b-4011-8672-4923cbdc8f26/conversations/4eb31272-ed89-4d0d-92c1-bc258bd7ac9c?srv_id=3010109
+           */
+          href?: string
+        }
+        history?: {
+          /**
+           * @description The endpoint retrieve the conversation's history
+           * @example /client/f38c06f4-283b-4011-8672-4923cbdc8f26/conversations/4eb31272-ed89-4d0d-92c1-bc258bd7ac9c/history?srv_id=3010109
+           */
+          href?: string
+        }
+        self?: {
+          /**
+           * @description The endpoint retrieve the conversation later on to resume it
+           * @example /client/f38c06f4-283b-4011-8672-4923cbdc8f26/conversations/4eb31272-ed89-4d0d-92c1-bc258bd7ac9c?srv_id=3010109
+           */
+          href?: string
+        }
+        socket?: {
+          /**
+           * @description The endpoint of the conversation websocket
+           * @example /client/f38c06f4-283b-4011-8672-4923cbdc8f26/socket/websocket?srv_id=3010109
+           */
+          href?: string
+        }
+        uploads?: {
+          /**
+           * @description The endpoint to send uploaded files to
+           * @example /client/f38c06f4-283b-4011-8672-4923cbdc8f26/conversations/4eb31272-ed89-4d0d-92c1-bc258bd7ac9c/uploads?srv_id=3010109
+           */
+          href?: string
+        }
+      }
+    }
+    EntryText: {
+      /** @description Settings of the text entry */
+      options?: {
+        /**
+         * @description Whether or not the expected input is language neutral. A postal code or a last name for example are independent of language.
+         * @example false
+         */
+        languageNeutral?: boolean
+        /**
+         * @description Maximum number of characters the use may enter
+         * @example 100
+         */
+        limit?: number | null
+      }
+      /**
+       * @description Entry type
+       * @example text
+       */
+      type?: string
+    }
+    EntryPostalCode: {
+      /** @description Settings of the postal code entry */
+      options?: {
+        /**
+         * @description Country code (ISO 3166-1 alpha-2) of the expected postal code. Can be used for input hints and validation.
+         * @example nl
+         */
+        countryCode?: string | null
+      }
+      /**
+       * @description Entry type
+       * @example postal_code
+       */
+      type?: string
+    }
+    EntryUpload: {
+      /** @description Settings of the upload entry */
+      options?: {
+        /**
+         * @description List of allowed mime types of any uploaded file
+         * @example [
+         *   "application/msword",
+         *   "application/pdf",
+         *   "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
+         *   "image/*",
+         *   "text/*"
+         * ]
+         */
+        allowedMimeTypes?: string[]
+        /**
+         * @description Whether file uploads are possible. When true the client might for instance show a file upload button.
+         * @example true
+         */
+        enabled?: boolean
+        /**
+         * @description Maximum filesize in bytes
+         * @example 10485760
+         */
+        maxSize?: number
+      }
+      /**
+       * @description Entry type
+       * @example upload
+       */
+      type?: string
+    }
+    MessageInfo: {
+      body?:
+        | components['schemas']['InfoBodyDividerNewTopic']
+        | components['schemas']['InfoBodyDividerNewTranslation']
+        | components['schemas']['InfoBodyText']
+        | components['schemas']['InfoBodyTranslation']
+      fromClient?: components['schemas']['FromClient']
+      fromHistory?: components['schemas']['FromHistory']
+      id?: components['schemas']['MessageId']
+      messageStatus?: components['schemas']['MessageStatus']
+      occurredAt?: components['schemas']['OccurredAt']
+      /**
+       * @description Reference to the participant of the message
+       * @example 07371d91-c95a-43b7-853b-fa870e3f789c
+       */
+      participant?: string
+      service?: components['schemas']['Service']
+      transactionId?: components['schemas']['TransactionId']
+      /** @description In case a translations was active when this message originated, this object will contain the translated message in the translationLocale locale. */
+      translatedBody?: {
+        data?:
+          | components['schemas']['InfoBodyDividerNewTopic']
+          | components['schemas']['InfoBodyDividerNewTranslation']
+          | components['schemas']['InfoBodyText']
+          | components['schemas']['InfoBodyTranslation']
+        direction?: components['schemas']['Direction']
+        locale?: components['schemas']['Locale']
+      } | null
+      /**
+       * @description Type of the message body
+       * @example text
+       * @enum {string}
+       */
+      type?: 'divider' | 'text' | 'translation'
+    }
+    MessageMessage: {
+      /** @description The body of the message. The type of the body is indicated by the "type" property. See below. */
+      body?:
+        | components['schemas']['MessageBodyCard']
+        | components['schemas']['MessageBodyCarousel']
+        | components['schemas']['MessageBodyChoicePrompt']
+        | components['schemas']['MessageBodyCTA']
+        | components['schemas']['MessageBodyCustom']
+        | components['schemas']['MessageBodyImage']
+        | components['schemas']['MessageBodySplash']
+        | components['schemas']['MessageBodyText']
+        | components['schemas']['MessageBodyUpload']
+        | components['schemas']['MessageBodyVideo']
+      /** @description The requested form of entry from the user */
+      entry?:
+        | (Partial<components['schemas']['EntryText']> &
+            Partial<components['schemas']['EntryPostalCode']> &
+            Partial<components['schemas']['EntryUpload']>)
+        | null
+      fromClient?: components['schemas']['FromClient']
+      fromHistory?: components['schemas']['FromHistory']
+      id?: components['schemas']['MessageId']
+      messageStatus?: components['schemas']['MessageStatus']
+      occurredAt?: components['schemas']['OccurredAt']
+      /**
+       * @description Reference to the participant of the message
+       * @example 07371d91-c95a-43b7-853b-fa870e3f789c
+       */
+      participant?: string
+      service?: components['schemas']['Service']
+      transactionId?: components['schemas']['TransactionId']
+      /**
+       * @description Whether or not this message is the last one in the transaction.
+       * @example true
+       */
+      transactionLast?: boolean
+      /** @description In case a translations was active when this message originated, this object will contain the translated message in the translationLocale locale. */
+      translatedBody?: {
+        data?:
+          | components['schemas']['MessageBodyCard']
+          | components['schemas']['MessageBodyCarousel']
+          | components['schemas']['MessageBodyChoicePrompt']
+          | components['schemas']['MessageBodyCTA']
+          | components['schemas']['MessageBodyCustom']
+          | components['schemas']['MessageBodyImage']
+          | components['schemas']['MessageBodySplash']
+          | components['schemas']['MessageBodyText']
+          | components['schemas']['MessageBodyUpload']
+          | components['schemas']['MessageBodyVideo']
+        direction?: components['schemas']['Direction']
+        locale?: components['schemas']['Locale']
+      } | null
+      /**
+       * @description Type of the message body
+       * @example text
+       * @enum {string}
+       */
+      type?:
+        | 'card'
+        | 'carousel'
+        | 'choice_prompt'
+        | 'cta'
+        | 'custom'
+        | 'image'
+        | 'splash'
+        | 'text'
+        | 'upload'
+        | 'video'
+    }
+    ServiceDataMessage: {
+      /** @description The body of the message. The type of the body is indicated by the "type" property. See below. */
+      body?: components['schemas']['ServiceDataBodySuggestion']
+      fromClient?: components['schemas']['FromClient']
+      id?: components['schemas']['MessageId']
+      occurredAt?: components['schemas']['OccurredAt']
+      /**
+       * @description Whether this service data message is a message in the history at a specific point in time (false) or whether this message should be persisted (kept visible for instance in the client) until an update is received (true).
+       * @example true
+       */
+      persist?: boolean
+      /**
+       * @description Name of the attached service
+       * @example bot
+       */
+      service?: string
+      transactionId?: components['schemas']['TransactionId']
+      /** @description In case a translations was active when this message originated, this object will contain the translated message in the translationLocale locale. */
+      translatedBody?: {
+        data?: components['schemas']['ServiceDataBodySuggestion']
+        direction?: components['schemas']['Direction']
+        locale?: components['schemas']['Locale']
+      } | null
+      /**
+       * @description Type of the message body
+       * @example text
+       * @enum {string}
+       */
+      type?: 'suggestion'
+    }
+    MessageParticipant: {
+      fromClient?: components['schemas']['FromClient']
+      fromHistory?: components['schemas']['FromHistory']
+      id?: components['schemas']['MessageId']
+      messageStatus?: components['schemas']['MessageStatus']
+      occurredAt?: components['schemas']['OccurredAt']
+      participant?: components['schemas']['Participant']
+      transactionId?: components['schemas']['TransactionId']
+    }
+    /** @description A divider when a new topic has started */
+    InfoBodyDividerNewTopic: {
+      /**
+       * @description The type of divider
+       * @example new_topic
+       * @enum {string}
+       */
+      subtype?: 'new_topic'
+    }
+    /** @description A divider when translations was started or stopped */
+    InfoBodyDividerNewTranslation: {
+      /**
+       * @description The type of divider
+       * @example new_translation
+       * @enum {string}
+       */
+      subtype?: 'new_translation'
+      /**
+       * @description Whether translations was turn on (true) or turned off (false)
+       * @example true
+       */
+      translationEnabled?: boolean
+      /**
+       * @description The locale the user wants to speak.
+       * @example nl-informal
+       */
+      translationLocale?: string | null
+      /**
+       * @description The native language name of the translation locale
+       * @example Deutsch
+       */
+      language?: string
+      /**
+       * @description Title of the divider
+       * @example Übersetzen in Deutsch
+       */
+      title?: string
+      /**
+       * @description Optional text for the divider
+       * @example Automatische Übersetzung nach Deutsch gestartet. Bitte beachten Sie, dass automatische Übersetzungen Fehler enthalten können. Die Übersetzungen werden von DeepL bereitgestellt.
+       */
+      text?: string | null
+      /**
+       * @description Optional button text to re-start translations after the user has stopped translating.
+       * @example Neu beginnen
+       */
+      restartButtonText?: string | null
+    }
+    /** @description An info text message */
+    InfoBodyText: {
+      /**
+       * @description Text of the info message
+       * @example The agent has left the building
+       */
+      text?: string
+    }
+    /** @description A message indicating the client to display a message from the translations file. Those kind of messages are deprecated and are being replaced with info text messages. */
+    InfoBodyTranslation: {
+      /**
+       * @description The key of the translation to lookup in the translation file.
+       * @example [
+       *   "info",
+       *   "sendTranscript",
+       *   "accepted"
+       * ]
+       */
+      key?: string[]
+      /** @description Arbitrary variables to be used when rendering the ICU translation. */
+      variables?: { [key: string]: unknown }
+    }
+    /** @description A text message */
+    MessageBodyCard: {
+      action?:
+        | {
+            /** @description When the user clicks on this card this value will be submitted as if the user has typed it himself. */
+            ask?: string
+            /**
+             * @example ask
+             * @enum {string}
+             */
+            type?: 'ask'
+          }
+        | {
+            /**
+             * @description To URL to navigate to when the user clicks on the card.
+             * @example https://www.google.com
+             */
+            link?: string
+            /**
+             * @description Whether or not the link should be opened in a new window/tab.
+             * @example true
+             */
+            newTab?: boolean
+            /**
+             * @example navigate
+             * @enum {string}
+             */
+            type?: 'navigate'
+          }
+        | {
+            /**
+             * @description The new topic to start when the user clicks on the card.
+             * @example login
+             */
+            topic?: string
+            /**
+             * @description Text displayed if, for whatever reason, starting the new topic fails.
+             * @example Sorry, I can help you right now
+             */
+            fallbackMessage?: string
+            /**
+             * @example topic
+             * @enum {string}
+             */
+            type?: 'topic'
+          }
+      /**
+       * @description Text to display on the button of the card
+       * @example Order now!
+       */
+      buttonText?: string
+      /**
+       * @description Some more information to display on the card
+       * @example Pizza Margherita is a typical Neapolitan pizza.
+       */
+      description?: string | null
+      /**
+       * @description Image to display on the card
+       * @example https://via.placeholder.com/150/003A5D/FFFFFF?text=Margherita
+       */
+      image?: string
+      /**
+       * @description Title to display on the card
+       * @example Pizza Margherita
+       */
+      title?: string | null
+    }
+    /** @description A carousel message */
+    MessageBodyCarousel: {
+      cards?: components['schemas']['MessageBodyCard'][]
+    }
+    /** @description A choice prompt message */
+    MessageBodyChoicePrompt: {
+      /** @description Choices to show to the user */
+      choices?: {
+        /**
+         * @description Optional category this choice belongs to. Allows the client to apply custom styling for example.
+         * @example invoice
+         */
+        category?: string | null
+        /**
+         * @description Choice identifier. Required value to submit once the user selects this choice.
+         * @example 17b6b250-7299-41dd-8d23-09749197d792
+         */
+        id?: string
+        /**
+         * @description The text of the choice
+         * @example My invoice
+         */
+        text?: string
+      }[]
+      /**
+       * @description Whether or not the user is able to select a different choice later on.
+       * @example true
+       */
+      chooseAgain?: boolean
+      prompt?: Partial<{
+        /**
+         * @description The prompt text
+         * @example What can I help you with?
+         */
+        text?: string
+        /**
+         * @example text
+         * @enum {string}
+         */
+        type?: 'text'
+      }> &
+        Partial<{
+          /**
+           * @description The prompt image
+           * @example https://via.placeholder.com/150/003A5D/FFFFFF?text=How can I help you?
+           */
+          url?: string
+          /** @description Image description */
+          description?: string | null
+          /**
+           * @description Whether the image should be zoomable for the user
+           * @example true
+           */
+          isZoomable?: boolean
+          /**
+           * @example image
+           * @enum {string}
+           */
+          type?: 'image'
+        }>
+    }
+    /** @description A Call To Action (CTA) message */
+    MessageBodyCTA: {
+      /**
+       * @description URL of the CTA
+       * @example https://seamly.ai
+       */
+      buttonLink?: string
+      /**
+       * @description Whether or not the link should be opened in a new window/tab
+       * @example true
+       */
+      newTab?: boolean
+      /**
+       * @description Text on the CTA button
+       * @example Buy now!
+       */
+      buttonText?: string
+      /**
+       * @description Text shown above the CTA button
+       * @example Would you like to order a pizza? Click on the button below!
+       */
+      description?: string
+    }
+    /** @description A custom message to be used and designed for specific accounts */
+    MessageBodyCustom: {
+      /**
+       * @description String indicating the what type of custom message this is. Can be any string.
+       * @example alarm
+       */
+      type?: string
+      /**
+       * @description Text representation of this message. This should be used when the client does not know how to render this specific type of custom message.
+       * @example Attention! This is an emergency!
+       */
+      text?: string
+      /**
+       * @description Arbitrary data of the custom message
+       * @example {
+       *   "type": "emergency"
+       * }
+       */
+      data?: { [key: string]: unknown }
+    }
+    /** @description An image message */
+    MessageBodyImage: {
+      /**
+       * @description The prompt image
+       * @example https://via.placeholder.com/150/003A5D/FFFFFF?text=How can I help you?
+       */
+      url?: string
+      /** @description Image description */
+      description?: string | null
+      /**
+       * @description Whether the image should be zoomable for the user
+       * @example true
+       */
+      isZoomable?: boolean
+    }
+    /** @description A text message that can be displayed highlighted for example */
+    MessageBodySplash: {
+      /**
+       * @description Text of the message
+       * @example Hi, how may I help?
+       */
+      text?: string
+    }
+    /** @description A text message */
+    MessageBodyText: {
+      /**
+       * @description Text of the message
+       * @example Hi, how may I help?
+       */
+      text?: string
+    }
+    /** @description An upload message */
+    MessageBodyUpload: {
+      /**
+       * @description Content type of the upload
+       * @example image/jpeg
+       */
+      contentType?: string
+      /**
+       * @description Timestamp until when the file is available for download (in microseconds).
+       * @example 1661165549122131
+       */
+      deleteAt?: number
+      /**
+       * @description Filename of the upload
+       * @example dog.jpg
+       */
+      filename?: string
+      /**
+       * @description Filesize of the upload in bytes
+       * @example 7131
+       */
+      filesize?: number
+      /**
+       * @description Internal identifier of the upload
+       * @example 9557ec25-ba9b-402f-a8cf-2ecf73477d50
+       */
+      id?: string
+    }
+    /** @description A video message */
+    MessageBodyVideo: {
+      /**
+       * @description The url to the video
+       * @example https://www.youtube.com/embed/dQw4w9WgXcQ
+       */
+      url?: string
+      /**
+       * @description Source of the video
+       * @example YouTube
+       */
+      source?: string | null
+      /**
+       * @description Optional description to show alongside the video
+       * @example Rick Astley - Never Gonna Give You Up (Official Music Video)
+       */
+      description?: string | null
+    }
+    /** @description A suggestion service data message */
+    ServiceDataBodySuggestion: {
+      /** @description Any categories the suggestion belongs to. May be used to style the suggestion for example. */
+      categories?: (number | string)[]
+      id?: number | string
+      /**
+       * @description The suggestion / question
+       * @example What are your opening hours?
+       */
+      question?: string
+    }[]
+    /** @description Information about the current translation state */
+    Translation: {
+      /**
+       * @description Whether translation is turned on
+       * @example true
+       */
+      enabled?: boolean
+      /**
+       * @description When enabled equals true, this property will contain the translation locale.
+       * @example nl-informal
+       */
+      locale?: string
+    }
+    /**
+     * @description Either "to_translation_locale" when the text was translated from the locale to the translationLocale, or "from_translation_locale" when it was translated from the translationLocale to the locale.
+     * @example to_translation_locale
+     * @enum {string}
+     */
+    Direction: 'to_translation_locale' | 'from_translation_locale'
+    /**
+     * @description A string representation of a locale
+     * @example nl-informal
+     */
+    Locale: string
+    /**
+     * @description Whether this message is sent by the user (true) or is received from a bot or agent (false).
+     * @example false
+     */
+    FromClient: boolean
+    /**
+     * @description Whether this message was sent in the history request.
+     * @example false
+     */
+    FromHistory: boolean
+    /**
+     * @description Unique identifier of the message
+     * @example 851c9e59-caf0-4f7f-9c69-39eac5617c36
+     */
+    MessageId: string
+    /**
+     * @description Status of the message: "received" or "read".
+     * @example received
+     */
+    MessageStatus: string
+    /**
+     * @description Timestamp of the message in microseconds
+     * @example 1660281438713581
+     */
+    OccurredAt: number
+    /** @description Information about the participant */
+    Participant: {
+      /**
+       * @description The icon of the participant
+       * @example data:image/svg+xml;base64,.....
+       */
+      avatar?: string
+      /**
+       * @description Reference to the participant of the message
+       * @example 07371d91-c95a-43b7-853b-fa870e3f789c
+       */
+      id?: string
+      /**
+       * @description Introduction message of the participant
+       * @example Your digital assistant
+       */
+      introduction?: string | null
+      /**
+       * @description The name of the participant
+       * @example ACME bot
+       */
+      name?: string
+      service?: components['schemas']['Service']
+      /** @description In case a translations was active when this message originated, this object will contain the translated introduction in the translationLocale locale. */
+      translatedIntroduction?: {
+        /**
+         * @description The translated introduction
+         * @example Jouw digitale assistent
+         */
+        data?: string
+        direction?: components['schemas']['Direction']
+        locale?: components['schemas']['Locale']
+      } | null
+      /** @description Arbitrary variables of this participant. */
+      variables?: { [key: string]: unknown }
+    }
+    /** @description Information the attached service exposes to the client */
+    Service: {
+      /**
+       * @description May include any information
+       * @example {
+       *   "additions": {
+       *     "displayChoices": "horizontal"
+       *   }
+       * }
+       */
+      meta?: { [key: string]: unknown }
+      /**
+       * @description Name of the attached service
+       * @example livechat
+       */
+      name?: string
+      /**
+       * @description Internal identifier of the current service session. Can be used to determine which messages from the history are from the current service, and, for example, might have the choose-again functionality available.
+       * @example c18c86f3-a31f-4a61-a4f3-f805b5b71883
+       */
+      serviceSessionId?: string
+    }
+    /**
+     * @description Identifier of the transaction this message belongs to. Aids to group and link messages together. When a bot service for instance emits multiple messages at once they'll all have the same transctionId.
+     * @example ddff6efa-619a-497d-854c-f6a111f19196
+     */
+    TransactionId: string
+  }
+}
+
+export interface operations {
+  /** Get account settings and conversation defaults */
+  getAccountConfig: {
+    parameters: {
+      path: {
+        /** Seamly account API key */
+        apiKey: string
+      }
+      query: {
+        /** Seamly API Version to use */
+        v: number
+      }
+    }
+    responses: {
+      /** Success response */
+      201: {
+        content: {
+          'application/json': {
+            config?: {
+              agentParticipant?: {
+                /**
+                 * @description The default avatar of the agent participant. This can be used until an actual participant is received over the websocket.
+                 * @example data:image/svg+xml;base64,.....
+                 */
+                avatar?: string
+                /**
+                 * @description The default name of the agent participant. This can be used until an actual participant is received over the websocket.
+                 * @example ACME Assistant
+                 */
+                name?: string
+              }
+              /**
+               * @description The default locale as configured in the Seamly account.
+               * @example nl-informal
+               */
+              defaultLocale?: string
+              features?: {
+                sendTranscript?: {
+                  /**
+                   * @description Whether the Send Transcript feature is available to allow users to receive a transcript of their conversation history by mail.
+                   * @example true
+                   */
+                  enabled?: boolean
+                  /**
+                   * @description The period (in milliseconds) for which messages will be included in the transcript. This value is available so you can for example add a button like "Send transcript of the last 24 hours".
+                   * @example 86400000
+                   */
+                  period?: number
+                }
+                translation?: {
+                  /** @description Whether the Translation feature is available to allow users to chat in a different language. */
+                  enabled?: boolean
+                  /** @description The list of languages the user is allowed to type in. */
+                  languages?: {
+                    /**
+                     * @description The locale of the language
+                     * @example de-informal
+                     */
+                    locale?: string
+                    /**
+                     * @description The name of the language in the language itself
+                     * @example Deutsch
+                     */
+                    nativeName?: string
+                  }[]
+                }
+                typingPeekahead?: {
+                  /** @description Whether the Typing Peekahead feature is available and the client should send typed in text to Seamly, while the user is typing. */
+                  enabled?: boolean
+                }
+                uploads?: {
+                  /**
+                   * @description Whether the Uploads feature is available to allow users to upload files. This feature might later on be switch on or off again depending on the attached service. A livechat service for example might actually accept files, whereas a bot service will not.
+                   * @example false
+                   */
+                  enabled?: boolean
+                }
+              }
+              /** @description A list of messages to show to the user (before the conversation is started) to trigger the user to open up the chat. */
+              preChat?: {
+                body?: {
+                  /**
+                   * @description Text of the pre chat message
+                   * @example Hi, how can I help?
+                   */
+                  text?: string
+                }
+                /**
+                 * @description Whether this message is sent by the user (true) or is received from a bot or agent (false). For pre chat messages this value will always be false.
+                 * @example false
+                 */
+                fromClient?: boolean
+                /** @description In case a translationLocale was passed this object will contain the translated message in the translationLocale locale. */
+                translatedBody?: {
+                  /**
+                   * @description Text of the pre chat message
+                   * @example Hoi, hoe kan ik je helpen?
+                   */
+                  text?: string
+                }
+                /**
+                 * @description The type of the message. Will always be "splash" for pre chat messages.
+                 * @example splash
+                 */
+                type?: string
+              }[]
+              /**
+               * @description The icon that can be used as a (hovering / sticky) button on the website to trigger users to open the chat.
+               * @example data:image/svg+xml;base64,.....
+               */
+              startChatIcon?: string
+              /** @description Visual information about how to render the user participant. */
+              userParticipant?: {
+                /**
+                 * @description Avatar of the user
+                 * @example data:image/svg+xml;base64,.....
+                 */
+                avatar?: string
+              }
+            }
+            _links?: {
+              conversations?: {
+                /**
+                 * @description The endpoint to create a new conversation
+                 * @example /client/f38c06f4-283b-4011-8672-4923cbdc8f26/conversations?srv_id=3010109
+                 */
+                href?: string
+              }
+              self?: {
+                /**
+                 * @description The endpoint of the current request
+                 * @example /client/f38c06f4-283b-4011-8672-4923cbdc8f26/configs?v=2
+                 */
+                href?: string
+              }
+              socket?: {
+                /**
+                 * @description The endpoint of the conversation websocket
+                 * @example /client/f38c06f4-283b-4011-8672-4923cbdc8f26/socket/websocket?srv_id=3010109
+                 */
+                href?: string
+              }
+              translations?: {
+                /**
+                 * @description The endpoint to fetch the translation labels to use in the interface of your client. You must replace {version} by the version of the translation set (currently: 1), and you must replace {locale} by the required locale (ie: 'nl-informal').
+                 * @example /client/f38c06f4-283b-4011-8672-4923cbdc8f26/translations/{version}/{locale}
+                 */
+                href?: string
+                /**
+                 * @description Indicating whether the URI provided in the href property has keywords that must be replaced.
+                 * @example true
+                 */
+                templated?: boolean
+              }
+            }
+          }
+        }
+      }
+      /** Error when parsing the request failed */
+      400: {
+        content: {
+          'application/json': {
+            /**
+             * @description The error message
+             * @example server_error
+             */
+            error?: string
+          }
+        }
+      }
+      /** Error when no valid api key was passed */
+      404: {
+        content: {
+          'application/json': {
+            /**
+             * @description The error message
+             * @example not_found
+             */
+            error?: string
+          }
+        }
+      }
+    }
+    /** Payload */
+    requestBody: {
+      content: {
+        'application/json': {
+          context: {
+            /**
+             * @description The name of the channel to use, as configured in your Seamly account.
+             * @example web
+             */
+            channelName: string
+            /** @description Environment information about the user. The passed data can be used (in your Seamly account configuration) to customize the returned configuration. The sent information is not stored nor used in a potentially upcoming conversation. */
+            environment?: {
+              /**
+               * @description The name of the client application.
+               * @example @seamly/web-ui
+               */
+              clientName?: string
+              /**
+               * @description The variant of the client application, to distinguish between different use cases of the client. For example 'inline' versus 'popup'.
+               * @example inline
+               */
+              clientVariant?: string
+              /**
+               * @description The version of the client application.
+               * @example 20.3.0
+               */
+              clientVersion?: string
+              /**
+               * @description The URL the user currently is on.
+               * @example https://seamly.ai/en/contact-us/
+               */
+              currentUrl?: string
+              /**
+               * @description The screen resolution of the user.
+               * @example 2560x1440
+               */
+              screenResolution?: string
+              /**
+               * @description The timezone of the user.
+               * @example Europe/Amsterdam
+               */
+              timezone?: string
+              /**
+               * @description The user agent of the user.
+               * @example Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/104.0.0.0 Safari/537.36
+               */
+              userAgent?: string
+            }
+            /**
+             * @description The locale of the conversation. Any locales to be used must be specifically enabled in your Seamly Account. And of course your connected services must also support this locale.
+             * @example nl-informal
+             */
+            locale: string
+            /**
+             * @description Optional translation locale; the locale the user immediately starts translating to.
+             * @example null
+             */
+            translationLocale?: string
+            /** @description Arbitrary variables used to customize the returned configuration. The sent variables are not stored and are not used in a potentially upcoming conversation. */
+            variables?: { [key: string]: unknown }
+          }
+        }
+      }
+    }
+  }
+  getAccountTranslations: {
+    parameters: {
+      path: {
+        /** Seamly account API key */
+        apiKey: string
+        /** Translation file version */
+        version: number
+        /** Locale to get translations for */
+        locale: string
+      }
+    }
+    responses: {
+      /** Success response */
+      200: {
+        content: {
+          'application/json': {
+            /**
+             * @description Key value pairs of labels and ICU texts.
+             * @example {
+             *   "account.preChatText": "Hallo! Kan ik je ergens mee helpen?",
+             *   "carousel.controls.next": "Volgende",
+             *   "carousel.controls.previous": "Vorige"
+             * }
+             */
+            translations?: { [key: string]: unknown }
+          }
+        }
+      }
+      /** Error when parsing the request failed, for example due to an invalid locale. */
+      400: {
+        content: {
+          'plain/text': string
+        }
+      }
+      /** Error when no valid api key was passed, or when the requested locale is not available for the account. */
+      404: {
+        content: {
+          'application/json': {
+            /**
+             * @description The error message
+             * @example not_found
+             */
+            error?: string
+          }
+        }
+      }
+    }
+  }
+  /** Create a new conversation. The full URL should be obtained from the HAL links as returned by the configs endpoint. */
+  createConversation: {
+    parameters: {
+      path: {
+        /** Seamly account API key */
+        apiKey: string
+      }
+      query: {
+        /** Required reference to a Seamly server. Must be obtained from the HAL links as returned by the configs endpoint. */
+        srv_id: string
+        /** Seamly API Version to use */
+        v: number
+      }
+    }
+    responses: {
+      /** Success response */
+      201: {
+        content: {
+          'application/json': components['schemas']['ConversationResponse']
+        }
+      }
+      /** Error when parsing the request failed */
+      400: {
+        content: {
+          'plain/text': string
+        }
+      }
+      /** Error when creating the conversation failed */
+      404: {
+        content: {
+          'application/json': {
+            /**
+             * @description The error message
+             * @example not_found
+             */
+            error?: string
+          }
+        }
+      }
+    }
+    /** Payload */
+    requestBody: {
+      content: {
+        'application/json': {
+          /**
+           * @description Optional external id to identify the conversation
+           * @example hjlbh5e5vek0p7gd8d9g9st28d6kowrk
+           */
+          externalId?: string | null
+        } | null
+      }
+    }
+  }
+  /** Get conversation to be resumed. The full URL should be obtained from the HAL links as returned by the POST conversations endpoint. */
+  getConversation: {
+    parameters: {
+      path: {
+        /** Seamly account API key */
+        apiKey: string
+        /** Id of the conversation */
+        conversationId: string
+      }
+      query: {
+        /** Required reference to a Seamly server. Must be obtained from the HAL links as returned by the configs endpoint. */
+        srv_id: string
+        /** Seamly API Version to use */
+        v: number
+      }
+    }
+    responses: {
+      /** Success response */
+      200: {
+        content: {
+          'application/json': components['schemas']['ConversationResponse']
+        }
+      }
+      /** Invalid access token provided */
+      401: {
+        content: {
+          'application/json': {
+            /**
+             * @description The error message
+             * @example unauthorized
+             */
+            error?: string
+          }
+        }
+      }
+      /** Error when no valid api key was passed or when the conversation does not exist (anymore) */
+      404: {
+        content: {
+          'application/json': {
+            /**
+             * @description The error message
+             * @example not_found
+             */
+            error?: string
+          }
+        }
+      }
+      /** Something went wrong internally */
+      500: {
+        content: {
+          'application/json': {
+            /**
+             * @description The error message
+             * @example timeout
+             */
+            error?: string
+          }
+        }
+      }
+    }
+  }
+  /** Get message history of a conversation. The full URL should be obtained from the HAL links as returned by the POST conversations endpoint. Pass the conversation's access token (as obtained by the initial POST to create the conversation) as a Bearer token. */
+  getConversationHistory: {
+    parameters: {
+      path: {
+        /** Seamly account API key */
+        apiKey: string
+        /** Id of the conversation */
+        conversationId: string
+      }
+      query: {
+        /** Required reference to a Seamly server. Must be obtained from the HAL links as returned by the configs endpoint. */
+        srv_id: string
+        /** Seamly API Version to use */
+        v: number
+      }
+    }
+    responses: {
+      /** Success response */
+      200: {
+        content: {
+          'application/json': components['schemas']['ConversationHistoryResponse']
+        }
+      }
+      /** Invalid access token provided */
+      401: {
+        content: {
+          'application/json': {
+            /**
+             * @description The error message
+             * @example unauthorized
+             */
+            error?: string
+          }
+        }
+      }
+      /** Error when no valid api key was passed or when the conversation does not exist (anymore) */
+      404: {
+        content: {
+          'application/json': {
+            /**
+             * @description The error message
+             * @example not_found
+             */
+            error?: string
+          }
+        }
+      }
+      /** Something went wrong internally */
+      500: {
+        content: {
+          'application/json': {
+            /**
+             * @description The error message
+             * @example timeout
+             */
+            error?: string
+          }
+        }
+      }
+    }
+  }
+  /** Upload a file of a conversation. The full URL should be obtained from the HAL links as returned by the POST conversations endpoint. Pass the conversation's access token (as obtained by the initial POST to create the conversation) as a Bearer token. */
+  createConversationUpload: {
+    parameters: {
+      path: {
+        /** Seamly account API key */
+        apiKey: string
+        /** Id of the conversation */
+        conversationId: string
+      }
+      query: {
+        /** Required reference to a Seamly server. Must be obtained from the HAL links as returned by the configs endpoint. */
+        srv_id: string
+      }
+    }
+    responses: {
+      /** Success response. Will contain a message with type "upload". */
+      201: {
+        content: {
+          'application/json': components['schemas']['MessageMessage']
+        }
+      }
+      /** Failed to process the upload */
+      400: {
+        content: {
+          'application/json': {
+            /**
+             * @description The error message
+             * @example file_uploads_are_disabled
+             */
+            error?: string
+          }
+        }
+      }
+      /** Invalid access token provided */
+      401: {
+        content: {
+          'application/json': {
+            /**
+             * @description The error message
+             * @example unauthorized
+             */
+            error?: string
+          }
+        }
+      }
+      /** Error when no valid api key was passed or when the conversation does not exist (anymore) */
+      404: {
+        content: {
+          'application/json': {
+            /**
+             * @description The error message
+             * @example not_found
+             */
+            error?: string
+          }
+        }
+      }
+      /** Uploaded file is too large */
+      413: {
+        content: {
+          'application/json': {
+            /**
+             * @description The error message
+             * @example request_entity_too_large
+             */
+            error?: string
+          }
+        }
+      }
+      /** Uploaded file has an unsupprted mime type */
+      415: {
+        content: {
+          'application/json': {
+            /**
+             * @description The error message
+             * @example file_has_invalid_mime_type
+             */
+            error?: string
+          }
+        }
+      }
+      /** Something went wrong internally */
+      500: {
+        content: {
+          'application/json': {
+            /**
+             * @description The error message
+             * @example timeout
+             */
+            error?: string
+          }
+        }
+      }
+    }
+    requestBody: {
+      content: {
+        'multipart/form-data': {
+          /** Format: binary */
+          upload?: string
+        }
+      }
+    }
+  }
+}