retell-sdk 5.14.1 → 5.16.0

package/src/resources/call.ts

@@ -127,6 +127,21 @@ export class Call extends APIResource {
   ): APIPromise<PhoneCallResponse> {
     return this._client.post('/v2/register-phone-call', { body, ...options });
   }
+
+  /**
+   * Stop an ongoing call.
+   *
+   * @example
+   * ```ts
+   * await client.call.stop('call_a4441234567890777c4a4a123e6');
+   * ```
+   */
+  stop(callID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.post(path`/v2/stop-call/${callID}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
 }
 
 export type CallResponse = WebCallResponse | PhoneCallResponse;
@@ -2796,10 +2811,13 @@ export namespace CallCreatePhoneCallParams {
       ivr_option?: Agent.IvrOption | null;
 
       /**
-       * Specifies what language (and dialect) the speech recognition will operate in.
-       * For instance, selecting `en-GB` optimizes speech recognition for British
-       * English. If unset, will use default value `en-US`. Select `multi` for
-       * multilingual support.
+       * Specifies what language(s) the agent will operate in. Accepts either a single
+       * scalar locale (e.g. `en-US`), the legacy scalar value `multi` for multilingual
+       * support, or an array of concrete locale codes for explicit multi-locale
+       * selection (e.g. `["en-US","es-ES"]`). The array form must contain concrete
+       * locale codes only — the `multi` value is valid only as the scalar legacy form
+       * and must not appear inside an array. Single-element arrays are normalized to the
+       * equivalent scalar on output. If unset, defaults to `en-US`.
        */
       language?:
         | 'en-US'
@@ -2865,7 +2883,72 @@ export namespace CallCreatePhoneCallParams {
         | 'ur-IN'
         | 'yue-CN'
         | 'uk-UA'
-        | 'multi';
+        | 'multi'
+        | Array<
+            | 'en-US'
+            | 'en-IN'
+            | 'en-GB'
+            | 'en-AU'
+            | 'en-NZ'
+            | 'de-DE'
+            | 'es-ES'
+            | 'es-419'
+            | 'hi-IN'
+            | 'fr-FR'
+            | 'fr-CA'
+            | 'ja-JP'
+            | 'pt-PT'
+            | 'pt-BR'
+            | 'zh-CN'
+            | 'ru-RU'
+            | 'it-IT'
+            | 'ko-KR'
+            | 'nl-NL'
+            | 'nl-BE'
+            | 'pl-PL'
+            | 'tr-TR'
+            | 'vi-VN'
+            | 'ro-RO'
+            | 'bg-BG'
+            | 'ca-ES'
+            | 'th-TH'
+            | 'da-DK'
+            | 'fi-FI'
+            | 'el-GR'
+            | 'hu-HU'
+            | 'id-ID'
+            | 'no-NO'
+            | 'sk-SK'
+            | 'sv-SE'
+            | 'lt-LT'
+            | 'lv-LV'
+            | 'cs-CZ'
+            | 'ms-MY'
+            | 'af-ZA'
+            | 'ar-SA'
+            | 'az-AZ'
+            | 'bs-BA'
+            | 'cy-GB'
+            | 'fa-IR'
+            | 'fil-PH'
+            | 'gl-ES'
+            | 'he-IL'
+            | 'hr-HR'
+            | 'hy-AM'
+            | 'is-IS'
+            | 'kk-KZ'
+            | 'kn-IN'
+            | 'mk-MK'
+            | 'mr-IN'
+            | 'ne-NP'
+            | 'sl-SI'
+            | 'sr-RS'
+            | 'sw-KE'
+            | 'ta-IN'
+            | 'ur-IN'
+            | 'yue-CN'
+            | 'uk-UA'
+          >;
 
       /**
        * Maximum allowed length for the call, will force end the call if reached. The
@@ -4044,10 +4127,13 @@ export namespace CallCreateWebCallParams {
       ivr_option?: Agent.IvrOption | null;
 
       /**
-       * Specifies what language (and dialect) the speech recognition will operate in.
-       * For instance, selecting `en-GB` optimizes speech recognition for British
-       * English. If unset, will use default value `en-US`. Select `multi` for
-       * multilingual support.
+       * Specifies what language(s) the agent will operate in. Accepts either a single
+       * scalar locale (e.g. `en-US`), the legacy scalar value `multi` for multilingual
+       * support, or an array of concrete locale codes for explicit multi-locale
+       * selection (e.g. `["en-US","es-ES"]`). The array form must contain concrete
+       * locale codes only — the `multi` value is valid only as the scalar legacy form
+       * and must not appear inside an array. Single-element arrays are normalized to the
+       * equivalent scalar on output. If unset, defaults to `en-US`.
        */
       language?:
         | 'en-US'
@@ -4113,7 +4199,72 @@ export namespace CallCreateWebCallParams {
         | 'ur-IN'
         | 'yue-CN'
         | 'uk-UA'
-        | 'multi';
+        | 'multi'
+        | Array<
+            | 'en-US'
+            | 'en-IN'
+            | 'en-GB'
+            | 'en-AU'
+            | 'en-NZ'
+            | 'de-DE'
+            | 'es-ES'
+            | 'es-419'
+            | 'hi-IN'
+            | 'fr-FR'
+            | 'fr-CA'
+            | 'ja-JP'
+            | 'pt-PT'
+            | 'pt-BR'
+            | 'zh-CN'
+            | 'ru-RU'
+            | 'it-IT'
+            | 'ko-KR'
+            | 'nl-NL'
+            | 'nl-BE'
+            | 'pl-PL'
+            | 'tr-TR'
+            | 'vi-VN'
+            | 'ro-RO'
+            | 'bg-BG'
+            | 'ca-ES'
+            | 'th-TH'
+            | 'da-DK'
+            | 'fi-FI'
+            | 'el-GR'
+            | 'hu-HU'
+            | 'id-ID'
+            | 'no-NO'
+            | 'sk-SK'
+            | 'sv-SE'
+            | 'lt-LT'
+            | 'lv-LV'
+            | 'cs-CZ'
+            | 'ms-MY'
+            | 'af-ZA'
+            | 'ar-SA'
+            | 'az-AZ'
+            | 'bs-BA'
+            | 'cy-GB'
+            | 'fa-IR'
+            | 'fil-PH'
+            | 'gl-ES'
+            | 'he-IL'
+            | 'hr-HR'
+            | 'hy-AM'
+            | 'is-IS'
+            | 'kk-KZ'
+            | 'kn-IN'
+            | 'mk-MK'
+            | 'mr-IN'
+            | 'ne-NP'
+            | 'sl-SI'
+            | 'sr-RS'
+            | 'sw-KE'
+            | 'ta-IN'
+            | 'ur-IN'
+            | 'yue-CN'
+            | 'uk-UA'
+          >;
 
       /**
        * Maximum allowed length for the call, will force end the call if reached. The
@@ -5292,10 +5443,13 @@ export namespace CallRegisterPhoneCallParams {
       ivr_option?: Agent.IvrOption | null;
 
       /**
-       * Specifies what language (and dialect) the speech recognition will operate in.
-       * For instance, selecting `en-GB` optimizes speech recognition for British
-       * English. If unset, will use default value `en-US`. Select `multi` for
-       * multilingual support.
+       * Specifies what language(s) the agent will operate in. Accepts either a single
+       * scalar locale (e.g. `en-US`), the legacy scalar value `multi` for multilingual
+       * support, or an array of concrete locale codes for explicit multi-locale
+       * selection (e.g. `["en-US","es-ES"]`). The array form must contain concrete
+       * locale codes only — the `multi` value is valid only as the scalar legacy form
+       * and must not appear inside an array. Single-element arrays are normalized to the
+       * equivalent scalar on output. If unset, defaults to `en-US`.
        */
       language?:
         | 'en-US'
@@ -5361,7 +5515,72 @@ export namespace CallRegisterPhoneCallParams {
         | 'ur-IN'
         | 'yue-CN'
         | 'uk-UA'
-        | 'multi';
+        | 'multi'
+        | Array<
+            | 'en-US'
+            | 'en-IN'
+            | 'en-GB'
+            | 'en-AU'
+            | 'en-NZ'
+            | 'de-DE'
+            | 'es-ES'
+            | 'es-419'
+            | 'hi-IN'
+            | 'fr-FR'
+            | 'fr-CA'
+            | 'ja-JP'
+            | 'pt-PT'
+            | 'pt-BR'
+            | 'zh-CN'
+            | 'ru-RU'
+            | 'it-IT'
+            | 'ko-KR'
+            | 'nl-NL'
+            | 'nl-BE'
+            | 'pl-PL'
+            | 'tr-TR'
+            | 'vi-VN'
+            | 'ro-RO'
+            | 'bg-BG'
+            | 'ca-ES'
+            | 'th-TH'
+            | 'da-DK'
+            | 'fi-FI'
+            | 'el-GR'
+            | 'hu-HU'
+            | 'id-ID'
+            | 'no-NO'
+            | 'sk-SK'
+            | 'sv-SE'
+            | 'lt-LT'
+            | 'lv-LV'
+            | 'cs-CZ'
+            | 'ms-MY'
+            | 'af-ZA'
+            | 'ar-SA'
+            | 'az-AZ'
+            | 'bs-BA'
+            | 'cy-GB'
+            | 'fa-IR'
+            | 'fil-PH'
+            | 'gl-ES'
+            | 'he-IL'
+            | 'hr-HR'
+            | 'hy-AM'
+            | 'is-IS'
+            | 'kk-KZ'
+            | 'kn-IN'
+            | 'mk-MK'
+            | 'mr-IN'
+            | 'ne-NP'
+            | 'sl-SI'
+            | 'sr-RS'
+            | 'sw-KE'
+            | 'ta-IN'
+            | 'ur-IN'
+            | 'yue-CN'
+            | 'uk-UA'
+          >;
 
       /**
        * Maximum allowed length for the call, will force end the call if reached. The

package/src/resources/chat-agent.ts

@@ -223,10 +223,13 @@ export interface ChatAgentResponse {
   is_published?: boolean;
 
   /**
-   * Specifies what language (and dialect) the chat will operate in. For instance,
-   * selecting `en-GB` optimizes for British English. If unset, will use default
-   * value `en-US`. Select `multi` for multilingual support, currently this supports
-   * Spanish and English.
+   * Specifies what language(s) the agent will operate in. Accepts either a single
+   * scalar locale (e.g. `en-US`), the legacy scalar value `multi` for multilingual
+   * support, or an array of concrete locale codes for explicit multi-locale
+   * selection (e.g. `["en-US","es-ES"]`). The array form must contain concrete
+   * locale codes only — the `multi` value is valid only as the scalar legacy form
+   * and must not appear inside an array. Single-element arrays are normalized to the
+   * equivalent scalar on output. If unset, defaults to `en-US`.
    */
   language?:
     | 'en-US'
@@ -251,11 +254,11 @@ export interface ChatAgentResponse {
     | 'nl-BE'
     | 'pl-PL'
     | 'tr-TR'
-    | 'th-TH'
     | 'vi-VN'
     | 'ro-RO'
     | 'bg-BG'
     | 'ca-ES'
+    | 'th-TH'
     | 'da-DK'
     | 'fi-FI'
     | 'el-GR'
@@ -267,7 +270,97 @@ export interface ChatAgentResponse {
     | 'lt-LT'
     | 'lv-LV'
     | 'cs-CZ'
-    | 'multi';
+    | 'ms-MY'
+    | 'af-ZA'
+    | 'ar-SA'
+    | 'az-AZ'
+    | 'bs-BA'
+    | 'cy-GB'
+    | 'fa-IR'
+    | 'fil-PH'
+    | 'gl-ES'
+    | 'he-IL'
+    | 'hr-HR'
+    | 'hy-AM'
+    | 'is-IS'
+    | 'kk-KZ'
+    | 'kn-IN'
+    | 'mk-MK'
+    | 'mr-IN'
+    | 'ne-NP'
+    | 'sl-SI'
+    | 'sr-RS'
+    | 'sw-KE'
+    | 'ta-IN'
+    | 'ur-IN'
+    | 'yue-CN'
+    | 'uk-UA'
+    | 'multi'
+    | Array<
+        | 'en-US'
+        | 'en-IN'
+        | 'en-GB'
+        | 'en-AU'
+        | 'en-NZ'
+        | 'de-DE'
+        | 'es-ES'
+        | 'es-419'
+        | 'hi-IN'
+        | 'fr-FR'
+        | 'fr-CA'
+        | 'ja-JP'
+        | 'pt-PT'
+        | 'pt-BR'
+        | 'zh-CN'
+        | 'ru-RU'
+        | 'it-IT'
+        | 'ko-KR'
+        | 'nl-NL'
+        | 'nl-BE'
+        | 'pl-PL'
+        | 'tr-TR'
+        | 'vi-VN'
+        | 'ro-RO'
+        | 'bg-BG'
+        | 'ca-ES'
+        | 'th-TH'
+        | 'da-DK'
+        | 'fi-FI'
+        | 'el-GR'
+        | 'hu-HU'
+        | 'id-ID'
+        | 'no-NO'
+        | 'sk-SK'
+        | 'sv-SE'
+        | 'lt-LT'
+        | 'lv-LV'
+        | 'cs-CZ'
+        | 'ms-MY'
+        | 'af-ZA'
+        | 'ar-SA'
+        | 'az-AZ'
+        | 'bs-BA'
+        | 'cy-GB'
+        | 'fa-IR'
+        | 'fil-PH'
+        | 'gl-ES'
+        | 'he-IL'
+        | 'hr-HR'
+        | 'hy-AM'
+        | 'is-IS'
+        | 'kk-KZ'
+        | 'kn-IN'
+        | 'mk-MK'
+        | 'mr-IN'
+        | 'ne-NP'
+        | 'sl-SI'
+        | 'sr-RS'
+        | 'sw-KE'
+        | 'ta-IN'
+        | 'ur-IN'
+        | 'yue-CN'
+        | 'uk-UA'
+      >;
 
   /**
    * Whether this agent opts in to signed url for public log. If not set, default
@@ -736,10 +829,13 @@ export interface ChatAgentCreateParams {
   is_public?: boolean | null;
 
   /**
-   * Specifies what language (and dialect) the chat will operate in. For instance,
-   * selecting `en-GB` optimizes for British English. If unset, will use default
-   * value `en-US`. Select `multi` for multilingual support, currently this supports
-   * Spanish and English.
+   * Specifies what language(s) the agent will operate in. Accepts either a single
+   * scalar locale (e.g. `en-US`), the legacy scalar value `multi` for multilingual
+   * support, or an array of concrete locale codes for explicit multi-locale
+   * selection (e.g. `["en-US","es-ES"]`). The array form must contain concrete
+   * locale codes only — the `multi` value is valid only as the scalar legacy form
+   * and must not appear inside an array. Single-element arrays are normalized to the
+   * equivalent scalar on output. If unset, defaults to `en-US`.
    */
   language?:
     | 'en-US'
@@ -764,11 +860,11 @@ export interface ChatAgentCreateParams {
     | 'nl-BE'
     | 'pl-PL'
     | 'tr-TR'
-    | 'th-TH'
     | 'vi-VN'
     | 'ro-RO'
     | 'bg-BG'
     | 'ca-ES'
+    | 'th-TH'
     | 'da-DK'
     | 'fi-FI'
     | 'el-GR'
@@ -780,7 +876,97 @@ export interface ChatAgentCreateParams {
     | 'lt-LT'
     | 'lv-LV'
     | 'cs-CZ'
-    | 'multi';
+    | 'ms-MY'
+    | 'af-ZA'
+    | 'ar-SA'
+    | 'az-AZ'
+    | 'bs-BA'
+    | 'cy-GB'
+    | 'fa-IR'
+    | 'fil-PH'
+    | 'gl-ES'
+    | 'he-IL'
+    | 'hr-HR'
+    | 'hy-AM'
+    | 'is-IS'
+    | 'kk-KZ'
+    | 'kn-IN'
+    | 'mk-MK'
+    | 'mr-IN'
+    | 'ne-NP'
+    | 'sl-SI'
+    | 'sr-RS'
+    | 'sw-KE'
+    | 'ta-IN'
+    | 'ur-IN'
+    | 'yue-CN'
+    | 'uk-UA'
+    | 'multi'
+    | Array<
+        | 'en-US'
+        | 'en-IN'
+        | 'en-GB'
+        | 'en-AU'
+        | 'en-NZ'
+        | 'de-DE'
+        | 'es-ES'
+        | 'es-419'
+        | 'hi-IN'
+        | 'fr-FR'
+        | 'fr-CA'
+        | 'ja-JP'
+        | 'pt-PT'
+        | 'pt-BR'
+        | 'zh-CN'
+        | 'ru-RU'
+        | 'it-IT'
+        | 'ko-KR'
+        | 'nl-NL'
+        | 'nl-BE'
+        | 'pl-PL'
+        | 'tr-TR'
+        | 'vi-VN'
+        | 'ro-RO'
+        | 'bg-BG'
+        | 'ca-ES'
+        | 'th-TH'
+        | 'da-DK'
+        | 'fi-FI'
+        | 'el-GR'
+        | 'hu-HU'
+        | 'id-ID'
+        | 'no-NO'
+        | 'sk-SK'
+        | 'sv-SE'
+        | 'lt-LT'
+        | 'lv-LV'
+        | 'cs-CZ'
+        | 'ms-MY'
+        | 'af-ZA'
+        | 'ar-SA'
+        | 'az-AZ'
+        | 'bs-BA'
+        | 'cy-GB'
+        | 'fa-IR'
+        | 'fil-PH'
+        | 'gl-ES'
+        | 'he-IL'
+        | 'hr-HR'
+        | 'hy-AM'
+        | 'is-IS'
+        | 'kk-KZ'
+        | 'kn-IN'
+        | 'mk-MK'
+        | 'mr-IN'
+        | 'ne-NP'
+        | 'sl-SI'
+        | 'sr-RS'
+        | 'sw-KE'
+        | 'ta-IN'
+        | 'ur-IN'
+        | 'yue-CN'
+        | 'uk-UA'
+      >;
 
   /**
    * Whether this agent opts in to signed url for public log. If not set, default
@@ -1246,10 +1432,13 @@ export interface ChatAgentUpdateParams {
   is_public?: boolean | null;
 
   /**
-   * Body param: Specifies what language (and dialect) the chat will operate in. For
-   * instance, selecting `en-GB` optimizes for British English. If unset, will use
-   * default value `en-US`. Select `multi` for multilingual support, currently this
-   * supports Spanish and English.
+   * Body param: Specifies what language(s) the agent will operate in. Accepts either
+   * a single scalar locale (e.g. `en-US`), the legacy scalar value `multi` for
+   * multilingual support, or an array of concrete locale codes for explicit
+   * multi-locale selection (e.g. `["en-US","es-ES"]`). The array form must contain
+   * concrete locale codes only — the `multi` value is valid only as the scalar
+   * legacy form and must not appear inside an array. Single-element arrays are
+   * normalized to the equivalent scalar on output. If unset, defaults to `en-US`.
    */
   language?:
     | 'en-US'
@@ -1274,11 +1463,11 @@ export interface ChatAgentUpdateParams {
     | 'nl-BE'
     | 'pl-PL'
     | 'tr-TR'
-    | 'th-TH'
     | 'vi-VN'
     | 'ro-RO'
     | 'bg-BG'
     | 'ca-ES'
+    | 'th-TH'
     | 'da-DK'
     | 'fi-FI'
     | 'el-GR'
@@ -1290,7 +1479,97 @@ export interface ChatAgentUpdateParams {
     | 'lt-LT'
     | 'lv-LV'
     | 'cs-CZ'
-    | 'multi';
+    | 'ms-MY'
+    | 'af-ZA'
+    | 'ar-SA'
+    | 'az-AZ'
+    | 'bs-BA'
+    | 'cy-GB'
+    | 'fa-IR'
+    | 'fil-PH'
+    | 'gl-ES'
+    | 'he-IL'
+    | 'hr-HR'
+    | 'hy-AM'
+    | 'is-IS'
+    | 'kk-KZ'
+    | 'kn-IN'
+    | 'mk-MK'
+    | 'mr-IN'
+    | 'ne-NP'
+    | 'sl-SI'
+    | 'sr-RS'
+    | 'sw-KE'
+    | 'ta-IN'
+    | 'ur-IN'
+    | 'yue-CN'
+    | 'uk-UA'
+    | 'multi'
+    | Array<
+        | 'en-US'
+        | 'en-IN'
+        | 'en-GB'
+        | 'en-AU'
+        | 'en-NZ'
+        | 'de-DE'
+        | 'es-ES'
+        | 'es-419'
+        | 'hi-IN'
+        | 'fr-FR'
+        | 'fr-CA'
+        | 'ja-JP'
+        | 'pt-PT'
+        | 'pt-BR'
+        | 'zh-CN'
+        | 'ru-RU'
+        | 'it-IT'
+        | 'ko-KR'
+        | 'nl-NL'
+        | 'nl-BE'
+        | 'pl-PL'
+        | 'tr-TR'
+        | 'vi-VN'
+        | 'ro-RO'
+        | 'bg-BG'
+        | 'ca-ES'
+        | 'th-TH'
+        | 'da-DK'
+        | 'fi-FI'
+        | 'el-GR'
+        | 'hu-HU'
+        | 'id-ID'
+        | 'no-NO'
+        | 'sk-SK'
+        | 'sv-SE'
+        | 'lt-LT'
+        | 'lv-LV'
+        | 'cs-CZ'
+        | 'ms-MY'
+        | 'af-ZA'
+        | 'ar-SA'
+        | 'az-AZ'
+        | 'bs-BA'
+        | 'cy-GB'
+        | 'fa-IR'
+        | 'fil-PH'
+        | 'gl-ES'
+        | 'he-IL'
+        | 'hr-HR'
+        | 'hy-AM'
+        | 'is-IS'
+        | 'kk-KZ'
+        | 'kn-IN'
+        | 'mk-MK'
+        | 'mr-IN'
+        | 'ne-NP'
+        | 'sl-SI'
+        | 'sr-RS'
+        | 'sw-KE'
+        | 'ta-IN'
+        | 'ur-IN'
+        | 'yue-CN'
+        | 'uk-UA'
+      >;
 
   /**
    * Body param: Whether this agent opts in to signed url for public log. If not set,