@seamly/web-ui 24.5.0-beta.1 → 25.0.0

package/src/javascripts/core/api/asyncapi.types.ts

@@ -4,7 +4,6 @@
  */
 
 /** OneOf type helpers */
-// eslint-disable-next-line no-unused-vars
 type Without<T, U> = { [P in Exclude<keyof T, keyof U>]?: never }
 type XOR<T, U> = T | U extends object
   ? (Without<T, U> & U) | (Without<U, T> & T)
@@ -134,7 +133,7 @@ export interface components {
       type: 'action'
       /** @description An action performed by the user */
       payload:
-        | components['schemas']['ActionBodyCustomFaqClick']
+        | components['schemas']['ActionBodyCustom']
         | components['schemas']['ActionBodyDetachService']
         | components['schemas']['ActionBodyDismiss']
         | components['schemas']['ActionBodyInteractivityUpdate']
@@ -231,7 +230,6 @@ export interface components {
           | components['schemas']['MessageBodyCard']
           | components['schemas']['MessageBodyCarousel']
           | components['schemas']['MessageBodyChoicePrompt']
-          | components['schemas']['MessageBodyCTA']
           | components['schemas']['MessageBodyCustom']
           | components['schemas']['MessageBodyImage']
           | components['schemas']['MessageBodyText']
@@ -260,7 +258,6 @@ export interface components {
           | components['schemas']['MessageBodyCard']
           | components['schemas']['MessageBodyCarousel']
           | components['schemas']['MessageBodyChoicePrompt']
-          | components['schemas']['MessageBodyCTA']
           | components['schemas']['MessageBodyCustom']
           | components['schemas']['MessageBodyImage']
           | components['schemas']['MessageBodyText']
@@ -279,7 +276,6 @@ export interface components {
           | 'card'
           | 'carousel'
           | 'choice_prompt'
-          | 'cta'
           | 'custom'
           | 'image'
           | 'splash'
@@ -455,22 +451,8 @@ export interface components {
           settings: {
             /** @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 | null
-                }
                 /** @description Settings of the upload entry */
                 upload: {
                   /**
@@ -549,16 +531,295 @@ export interface components {
       } | null
     } | null
     Entry:
+      | components['schemas']['EntryAlphanumeric']
+      | components['schemas']['EntryChoicePrompt']
+      | components['schemas']['EntryDateTime']
+      | components['schemas']['EntryIntent']
+      | components['schemas']['EntryMfa']
+      | components['schemas']['EntryNumeric']
+      | components['schemas']['EntryPhoneNumber']
+      | components['schemas']['EntryPostalCode']
       | components['schemas']['EntryText']
       | components['schemas']['EntryUpload']
-    EntryText: {
-      /** @description Settings of the text entry */
+    EntryAlphanumeric: {
+      /** @description Settings of the alphanumeric entry */
+      options: {
+        /**
+         * @description A custom label to show above the input field
+         * @example Your name:
+         */
+        label: string | null
+        /**
+         * @description Maximum number of characters the user may enter
+         * @example 100
+         */
+        limit: number | null
+        /**
+         * @description A custom placeholder to show in the input field
+         * @example Your message (max. 100 characters)
+         */
+        placeholder: string | null
+        /**
+         * @description Seamly validates the processed input using this PCRE regular expression. The processed input will be used if it matches the pattern. In any other case, the original input is kept as-is.
+         * @example /[a-f0-9]{6}/i
+         */
+        validationPattern: string
+      }
+      /**
+       * @description Entry type
+       * @example alphanumeric
+       * @enum {string}
+       */
+      type: 'alphanumeric'
+    }
+    EntryChoicePrompt: {
+      /** @description Settings of the choice prompt entry */
       options: {
         /**
-         * @description Allow the user to also manually enter text as a response to a choice prompt message. By default this is set to true.
+         * @description Whether manual input is allowed. When set to `false`, the user must pick from one of the available options.
          * @example true
          */
-        allowManualInput?: boolean
+        allowManualInput: boolean
+        /**
+         * @description A custom label to show above the input field
+         * @example Your name:
+         */
+        label: string | null
+        /**
+         * @description Maximum number of characters the user may enter
+         * @example 100
+         */
+        limit: number | null
+        /**
+         * @description A custom placeholder to show in the input field
+         * @example Your message (max. 100 characters)
+         */
+        placeholder: string | null
+        /** @description Entry for textual responses to a choice prompt. */
+        textualResponseEntry: components['schemas']['Entry'] | null
+      }
+      /**
+       * @description Entry type
+       * @example choice_prompt
+       * @enum {string}
+       */
+      type: 'choice_prompt'
+    }
+    EntryDateTime: {
+      /** @description Settings of the date time entry */
+      options: {
+        /**
+         * @description Indicates the kind of input expected and the output produced. If the input was recognised, `date` outputs will be in the form of `yyyy-mm-dd`, and `time` outputs will be in the form of `hh:mm`.
+         * @example date
+         * @enum {string}
+         */
+        format: 'date' | 'time'
+        /**
+         * @description A custom label to show above the input field
+         * @example Your name:
+         */
+        label: string | null
+        /**
+         * @description Maximum number of characters the user may enter
+         * @example 100
+         */
+        limit: number | null
+        /**
+         * @description A custom placeholder to show in the input field
+         * @example Your message (max. 100 characters)
+         */
+        placeholder: string | null
+      }
+      /**
+       * @description Entry type
+       * @example date_time
+       * @enum {string}
+       */
+      type: 'date_time'
+    }
+    EntryIntent: {
+      /** @description Settings of the intent entry */
+      options: {
+        /**
+         * @description Name of the intent to be matched
+         * @example wait
+         */
+        intentName: string
+        /**
+         * @description A custom label to show above the input field
+         * @example Your name:
+         */
+        label: string | null
+        /**
+         * @description Maximum number of characters the user may enter
+         * @example 100
+         */
+        limit: number | null
+        /**
+         * @description Model ID.
+         * @example 8f19cf20-d072-4432-a7be-70258aa40224
+         */
+        modelId: string
+        /**
+         * @description A custom placeholder to show in the input field
+         * @example Your message (max. 100 characters)
+         */
+        placeholder: string | null
+      }
+      /**
+       * @description Entry type
+       * @example intent
+       * @enum {string}
+       */
+      type: 'intent'
+    }
+    EntryMfa: {
+      /** @description Settings of the MFA entry */
+      options: {
+        /**
+         * @description The email addresses the MFA code has been sent to.
+         * @example [
+         *   "john@acme.com",
+         *   "john@acme.co.uk"
+         * ]
+         */
+        emailAddresses: string[]
+        /**
+         * @description Timestamp (in milliseconds) when the MFA code expires.
+         * @example 1750679434372
+         */
+        expiresAt: number
+        /**
+         * @description A custom label to show above the input field
+         * @example Your name:
+         */
+        label: string | null
+        /**
+         * @description Maximum number of characters the user may enter
+         * @example 100
+         */
+        limit: number | null
+        /**
+         * @description The phone numbers the MFA code has been sent to.
+         * @example [
+         *   "+31612345678"
+         * ]
+         */
+        mobilePhoneNumbers: string[]
+        /**
+         * @description A custom placeholder to show in the input field
+         * @example Your message (max. 100 characters)
+         */
+        placeholder: string | null
+      }
+      /**
+       * @description Entry type
+       * @example mfa
+       * @enum {string}
+       */
+      type: 'mfa'
+    }
+    EntryNumeric: {
+      /** @description Settings of the numeric entry */
+      options: {
+        /**
+         * @description A custom label to show above the input field
+         * @example Your name:
+         */
+        label: string | null
+        /**
+         * @description Maximum number of characters the user may enter
+         * @example 7
+         */
+        limit: number | null
+        /**
+         * @description The maximum length of the processed input.
+         * @example 7
+         */
+        maxLength: number | null
+        /**
+         * @description The minimum length of the processed input.
+         * @example 1
+         */
+        minLength: number
+        /**
+         * @description A custom placeholder to show in the input field
+         * @example Your message (max. 100 characters)
+         */
+        placeholder: string | null
+      }
+      /**
+       * @description Entry type
+       * @example numeric
+       * @enum {string}
+       */
+      type: 'numeric'
+    }
+    EntryPhoneNumber: {
+      /** @description Settings of the phone number entry */
+      options: {
+        /**
+         * @description The country code will be used if Seamly cannot determine the correct country from the input. For instance, if the `country_code` is set to `"NL"` an input of `"+4912312421421"` will still be recognised as a German phone number. However, an input of `"06123456789"` with `country_code` `"NL"` will yield the phone number `"+316123456789"`, as the country cannot be determined from the number alone.
+         * @example NL
+         */
+        countryCode: string | null
+        /**
+         * @description A custom label to show above the input field
+         * @example Your name:
+         */
+        label: string | null
+        /**
+         * @description Maximum number of characters the user may enter
+         * @example 100
+         */
+        limit: number | null
+        /**
+         * @description A custom placeholder to show in the input field
+         * @example Your message (max. 100 characters)
+         */
+        placeholder: string | null
+      }
+      /**
+       * @description Entry type
+       * @example phone_number
+       * @enum {string}
+       */
+      type: 'phone_number'
+    }
+    EntryPostalCode: {
+      /** @description Settings of the postal code entry */
+      options: {
+        /**
+         * @description The country code (ISO 3166-1 alpha-2) of the expected postal code.
+         * @example NL
+         */
+        countryCode: string | null
+        /**
+         * @description A custom label to show above the input field
+         * @example Your name:
+         */
+        label: string | null
+        /**
+         * @description Maximum number of characters the user may enter
+         * @example 100
+         */
+        limit: number | null
+        /**
+         * @description A custom placeholder to show in the input field
+         * @example Your message (max. 100 characters)
+         */
+        placeholder: string | null
+      }
+      /**
+       * @description Entry type
+       * @example postal_code
+       * @enum {string}
+       */
+      type: 'postal_code'
+    }
+    EntryText: {
+      /** @description Settings of the text entry */
+      options: {
         /**
          * @description A custom label to show above the input field
          * @example Your name:
@@ -568,9 +829,9 @@ export interface components {
          * @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
+        languageNeutral: boolean
         /**
-         * @description Maximum number of characters the use may enter
+         * @description Maximum number of characters the user may enter
          * @example 100
          */
         limit: number | null
@@ -625,7 +886,7 @@ export interface components {
          * @description A reference to the upload as stored in the conversation context. When set, the upload can later on be used in hooks.
          * @example cv
          */
-        reference: string
+        reference: string | null
       }
       /**
        * @description Entry type
@@ -634,25 +895,16 @@ export interface components {
        */
       type: 'upload'
     }
-    ActionBodyCustomFaqClick: {
+    ActionBodyCustom: {
       /**
        * @example custom
        * @enum {string}
        */
       type: 'custom'
-      transactionId: components['schemas']['TransactionId']
+      transactionId?: components['schemas']['TransactionId']
       /** @description ID of the related service data message with the suggestions */
-      originMessage: string
-      body: {
-        body: {
-          /** @description ID of the suggestion / FAQ the user clicked on */
-          faqId: number | string
-          /** @description Question of the suggestion / FAQ the user clicked on */
-          faqQuestion: string
-        }
-        /** @constant */
-        type: 'faqclick'
-      }
+      originMessage?: string
+      body: Record<string, unknown>
     }
     ActionBodyDetachService: {
       /**
@@ -956,35 +1208,6 @@ export interface components {
             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
-       */
-      buttonNewTab: 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 Textual representation of whole CTA message. Can be used in case the CTA cannot be rendered properly.
-       * @example Text shown above the CTA button
-       * Text on the CTA button : https://seamly.ai
-       */
-      text: string
-    }
     /** @description A custom message to be used and designed for specific accounts */
     MessageBodyCustom: {
       /**
@@ -1214,7 +1437,7 @@ export interface components {
       serviceSessionId: string | null
     }
     /**
-     * @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.
+     * @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 transactionId.
      * @example ddff6efa-619a-497d-854c-f6a111f19196
      */
     TransactionId: string | null