telnyx 6.41.1 → 6.43.0

package/src/resources/text-to-speech/ws.ts

@@ -1,203 +1,4 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as WS from 'ws';
-import { TextToSpeechEmitter, TextToSpeechStreamMessage, WebSocketError, buildURL } from './internal-base';
-import * as TextToSpeechAPI from './text-to-speech';
-import { Telnyx } from '../../client';
-
-export class TextToSpeechWS extends TextToSpeechEmitter {
-  url: URL;
-  socket: WS.WebSocket;
-  private client: Telnyx;
-
-  constructor(client: Telnyx, parameters?: null | undefined, options?: WS.ClientOptions | null | undefined) {
-    super();
-    this.client = client;
-    this.url = buildURL(client, parameters);
-    this.socket = new WS.WebSocket(this.url, {
-      ...options,
-      headers: {
-        ...this.authHeaders(),
-        ...options?.headers,
-      },
-    });
-
-    this.socket.on('message', (wsEvent) => {
-      const event = (() => {
-        try {
-          return JSON.parse(wsEvent.toString()) as TextToSpeechAPI.StreamServerEvent;
-        } catch (err) {
-          this._onError(null, 'could not parse websocket event', err);
-          return null;
-        }
-      })();
-
-      if (event) {
-        this._emit('event', event);
-
-        if (event.type === 'error') {
-          this._onError(event);
-        } else {
-          // @ts-ignore TS isn't smart enough to get the relationship right here
-          this._emit(event.type, event);
-        }
-      }
-    });
-
-    this.socket.on('error', (err) => {
-      this._onError(null, err.message, err);
-    });
-  }
-
-  send(event: TextToSpeechAPI.StreamClientEvent) {
-    try {
-      this.socket.send(JSON.stringify(event));
-    } catch (err) {
-      this._onError(null, 'could not send data', err);
-    }
-  }
-
-  close(props?: { code: number; reason: string }) {
-    try {
-      this.socket.close(props?.code ?? 1000, props?.reason ?? 'OK');
-    } catch (err) {
-      this._onError(null, 'could not close the connection', err);
-    }
-  }
-
-  /**
-   * Returns an async iterator over WebSocket lifecycle and message events,
-   * providing an alternative to the event-based `.on()` API.
-   * The iterator will exit if the socket closes but breaking out of the iterator
-   * does not close the socket.
-   *
-   * @example
-   * ```ts
-   * for await (const event of connection.stream()) {
-   *   switch (event.type) {
-   *     case 'message':
-   *       console.log('received:', event.message);
-   *       break;
-   *     case 'error':
-   *       console.error(event.error);
-   *       break;
-   *     case 'close':
-   *       console.log('connection closed');
-   *       break;
-   *   }
-   * }
-   * ```
-   */
-  stream(): AsyncIterableIterator<TextToSpeechStreamMessage> {
-    return this[Symbol.asyncIterator]();
-  }
-
-  [Symbol.asyncIterator](): AsyncIterableIterator<TextToSpeechStreamMessage> {
-    // Two-queue async iterator: `queue` buffers incoming messages,
-    // `resolvers` buffers waiting next() calls. A push wakes the
-    // oldest next(); a next() drains the oldest message.
-    const queue: TextToSpeechStreamMessage[] = [];
-    const resolvers: (() => void)[] = [];
-    let done = false;
-
-    const push = (msg: TextToSpeechStreamMessage) => {
-      queue.push(msg);
-      resolvers.shift()?.();
-    };
-
-    const onEvent = (event: TextToSpeechAPI.StreamServerEvent) => {
-      if (event.type === 'error') return; // handled by onEmitterError
-      push({ type: 'message', message: event });
-    };
-
-    // Catches both API-level and socket-level errors via _onError → _emit('error')
-    const onEmitterError = (err: WebSocketError) => {
-      push({ type: 'error', error: err });
-    };
-
-    const onOpen = () => {
-      push({ type: 'open' });
-    };
-
-    const flushResolvers = () => {
-      for (let resolver = resolvers.shift(); resolver; resolver = resolvers.shift()) {
-        resolver();
-      }
-    };
-
-    const onClose = () => {
-      push({ type: 'close' });
-      done = true;
-      flushResolvers();
-      cleanup();
-    };
-
-    const cleanup = () => {
-      this.off('event', onEvent);
-      this.off('error', onEmitterError);
-      this.socket.off('open', onOpen);
-      this.socket.off('close', onClose);
-    };
-
-    this.on('event', onEvent);
-    this.on('error', onEmitterError);
-    this.socket.on('open', onOpen);
-    this.socket.on('close', onClose);
-
-    switch (this.socket.readyState) {
-      case WS.WebSocket.CONNECTING:
-        push({ type: 'connecting' });
-        break;
-      case WS.WebSocket.OPEN:
-        push({ type: 'open' });
-        break;
-      case WS.WebSocket.CLOSING:
-        push({ type: 'closing' });
-        break;
-      case WS.WebSocket.CLOSED:
-        push({ type: 'close' });
-        done = true;
-        cleanup();
-        break;
-    }
-
-    const resolve = (res: (value: IteratorResult<TextToSpeechStreamMessage>) => void) => {
-      if (queue.length > 0) {
-        res({ value: queue.shift()!, done: false });
-      } else if (done) {
-        res({ value: undefined, done: true });
-      } else {
-        return false;
-      }
-      return true;
-    };
-
-    const next = (): Promise<IteratorResult<TextToSpeechStreamMessage>> =>
-      new Promise((res) => {
-        if (resolve(res)) return;
-        resolvers.push(() => {
-          resolve(res);
-        });
-      });
-
-    return {
-      next,
-      return: (): Promise<IteratorReturnResult<undefined>> => {
-        done = true;
-        cleanup();
-        flushResolvers();
-        return Promise.resolve({ value: undefined, done: true });
-      },
-      [Symbol.asyncIterator]() {
-        return this;
-      },
-    };
-  }
-
-  private authHeaders(): Record<string, string> {
-    if (this.client.apiKey) {
-      return { Authorization: `Bearer ${this.client.apiKey}` };
-    }
-    return {};
-  }
-}
+export { TextToSpeechWS, type TextToSpeechWSClientOptions } from '../../lib/text-to-speech-ws';
+export type { TextToSpeechWSReconnectOptions } from '../../lib/text-to-speech-ws-base';

package/src/resources/verify-profiles.ts

@@ -162,14 +162,22 @@ export interface VerifyProfile {
 
   created_at?: string;
 
+  /**
+   * The maximum daily spend allowed on this verify profile, in USD.
+   */
+  daily_spend_limit?: number;
+
+  /**
+   * Whether the daily spend limit is enforced for this verify profile.
+   */
+  daily_spend_limit_enabled?: boolean;
+
   flashcall?: VerifyProfile.Flashcall;
 
   language?: string;
 
   name?: string;
 
-  rcs?: VerifyProfile.Rcs;
-
   /**
    * The possible verification profile record types.
    */
@@ -182,6 +190,8 @@ export interface VerifyProfile {
   webhook_failover_url?: string;
 
   webhook_url?: string;
+
+  whatsapp?: VerifyProfile.Whatsapp;
 }
 
 export namespace VerifyProfile {
@@ -213,7 +223,9 @@ export namespace VerifyProfile {
     /**
      * Enabled country destinations to send verification codes. The elements in the
      * list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
-     * destinations will be allowed.
+     * destinations will be allowed. **Conditionally required:** this field must be
+     * provided when your organization is configured to require explicit whitelisted
+     * destinations; otherwise it is optional.
      */
     whitelisted_destinations?: Array<string>;
 
@@ -238,7 +250,13 @@ export namespace VerifyProfile {
     [k: string]: unknown;
   }
 
-  export interface Rcs {
+  export interface SMS {
+    /**
+     * The alphanumeric sender ID to use when sending to destinations that require an
+     * alphanumeric sender ID.
+     */
+    alpha_sender?: string | null;
+
     /**
      * The name that identifies the application requesting 2fa in the verification
      * message.
@@ -263,28 +281,19 @@ export namespace VerifyProfile {
      */
     messaging_template_id?: string;
 
-    /**
-     * Enable SMS fallback when RCS delivery fails.
-     */
-    sms_fallback?: boolean;
-
     /**
      * Enabled country destinations to send verification codes. The elements in the
      * list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
-     * destinations will be allowed.
+     * destinations will be allowed. **Conditionally required:** this field must be
+     * provided when your organization is configured to require explicit whitelisted
+     * destinations; otherwise it is optional.
      */
     whitelisted_destinations?: Array<string>;
 
     [k: string]: unknown;
   }
 
-  export interface SMS {
-    /**
-     * The alphanumeric sender ID to use when sending to destinations that require an
-     * alphanumeric sender ID.
-     */
-    alpha_sender?: string | null;
-
+  export interface Whatsapp {
     /**
      * The name that identifies the application requesting 2fa in the verification
      * message.
@@ -309,10 +318,27 @@ export namespace VerifyProfile {
      */
     messaging_template_id?: string;
 
+    /**
+     * Phone number registered on the customer WABA to send OTPs from
+     */
+    sender_phone_number?: string | null;
+
+    /**
+     * Customer pre-approved authentication template name registered on Meta
+     */
+    template_id?: string | null;
+
+    /**
+     * Customer Meta WABA ID for Bring-Your-Own-WABA sending
+     */
+    waba_id?: string | null;
+
     /**
      * Enabled country destinations to send verification codes. The elements in the
      * list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
-     * destinations will be allowed.
+     * destinations will be allowed. **Conditionally required:** this field must be
+     * provided when your organization is configured to require explicit whitelisted
+     * destinations; otherwise it is optional.
      */
     whitelisted_destinations?: Array<string>;
 
@@ -342,12 +368,20 @@ export interface VerifyProfileCreateParams {
 
   call?: VerifyProfileCreateParams.Call;
 
+  /**
+   * The maximum daily spend allowed on this verify profile, in USD.
+   */
+  daily_spend_limit?: number;
+
+  /**
+   * Whether the daily spend limit is enforced for this verify profile.
+   */
+  daily_spend_limit_enabled?: boolean;
+
   flashcall?: VerifyProfileCreateParams.Flashcall;
 
   language?: string;
 
-  rcs?: VerifyProfileCreateParams.Rcs;
-
   sms?: VerifyProfileCreateParams.SMS;
 
   webhook_failover_url?: string;
@@ -386,7 +420,9 @@ export namespace VerifyProfileCreateParams {
     /**
      * Enabled country destinations to send verification codes. The elements in the
      * list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
-     * destinations will be allowed.
+     * destinations will be allowed. **Conditionally required:** this field must be
+     * provided when your organization is configured to require explicit whitelisted
+     * destinations; otherwise it is optional.
      */
     whitelisted_destinations?: Array<string>;
 
@@ -411,14 +447,22 @@ export namespace VerifyProfileCreateParams {
     /**
      * Enabled country destinations to send verification codes. The elements in the
      * list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
-     * destinations will be allowed.
+     * destinations will be allowed. **Conditionally required:** this field must be
+     * provided when your organization is configured to require explicit whitelisted
+     * destinations; otherwise it is optional.
      */
     whitelisted_destinations?: Array<string>;
 
     [k: string]: unknown;
   }
 
-  export interface Rcs {
+  export interface SMS {
+    /**
+     * The alphanumeric sender ID to use when sending to destinations that require an
+     * alphanumeric sender ID.
+     */
+    alpha_sender?: string | null;
+
     /**
      * The name that identifies the application requesting 2fa in the verification
      * message.
@@ -443,39 +487,19 @@ export namespace VerifyProfileCreateParams {
      */
     messaging_template_id?: string;
 
-    /**
-     * Enable SMS fallback when RCS delivery fails.
-     */
-    sms_fallback?: boolean;
-
     /**
      * Enabled country destinations to send verification codes. The elements in the
      * list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
-     * destinations will be allowed.
+     * destinations will be allowed. **Conditionally required:** this field must be
+     * provided when your organization is configured to require explicit whitelisted
+     * destinations; otherwise it is optional.
      */
     whitelisted_destinations?: Array<string>;
 
     [k: string]: unknown;
   }
 
-  export interface SMS {
-    /**
-     * The alphanumeric sender ID to use when sending to destinations that require an
-     * alphanumeric sender ID.
-     */
-    alpha_sender?: string | null;
-
-    /**
-     * The name that identifies the application requesting 2fa in the verification
-     * message.
-     */
-    app_name?: string;
-
-    /**
-     * The length of the verify code to generate.
-     */
-    code_length?: number;
-
+  export interface Whatsapp {
     /**
      * For every request that is initiated via this Verify profile, this sets the
      * number of seconds before a verification request code expires. Once the
@@ -485,39 +509,26 @@ export namespace VerifyProfileCreateParams {
     default_verification_timeout_secs?: number;
 
     /**
-     * The message template identifier selected from /verify_profiles/templates
-     */
-    messaging_template_id?: string;
-
-    /**
-     * Enabled country destinations to send verification codes. The elements in the
-     * list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
-     * destinations will be allowed.
+     * Phone number registered on the customer WABA to send OTPs from
      */
-    whitelisted_destinations?: Array<string>;
-
-    [k: string]: unknown;
-  }
+    sender_phone_number?: string | null;
 
-  export interface Whatsapp {
     /**
-     * The name that identifies the application requesting 2fa in the verification
-     * message.
+     * Customer pre-approved authentication template name registered on Meta
      */
-    app_name?: string;
+    template_id?: string | null;
 
     /**
-     * For every request that is initiated via this Verify profile, this sets the
-     * number of seconds before a verification request code expires. Once the
-     * verification request expires, the user cannot use the code to verify their
-     * identity.
+     * Customer Meta WABA ID for Bring-Your-Own-WABA sending
      */
-    default_verification_timeout_secs?: number;
+    waba_id?: string | null;
 
     /**
      * Enabled country destinations to send verification codes. The elements in the
      * list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
-     * destinations will be allowed.
+     * destinations will be allowed. **Conditionally required:** this field must be
+     * provided when your organization is configured to require explicit whitelisted
+     * destinations; otherwise it is optional.
      */
     whitelisted_destinations?: Array<string>;
 
@@ -528,14 +539,20 @@ export namespace VerifyProfileCreateParams {
 export interface VerifyProfileUpdateParams {
   call?: VerifyProfileUpdateParams.Call;
 
-  flashcall?: VerifyProfileUpdateParams.Flashcall;
+  /**
+   * The maximum daily spend allowed on this verify profile, in USD.
+   */
+  daily_spend_limit?: number;
+
+  /**
+   * Whether the daily spend limit is enforced for this verify profile.
+   */
+  daily_spend_limit_enabled?: boolean;
 
   language?: string;
 
   name?: string;
 
-  rcs?: VerifyProfileUpdateParams.Rcs;
-
   sms?: VerifyProfileUpdateParams.SMS;
 
   webhook_failover_url?: string;
@@ -574,39 +591,22 @@ export namespace VerifyProfileUpdateParams {
     /**
      * Enabled country destinations to send verification codes. The elements in the
      * list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
-     * destinations will be allowed.
+     * destinations will be allowed. **Conditionally required:** this field must be
+     * provided when your organization is configured to require explicit whitelisted
+     * destinations; otherwise it is optional.
      */
     whitelisted_destinations?: Array<string>;
 
     [k: string]: unknown;
   }
 
-  export interface Flashcall {
-    /**
-     * The name that identifies the application requesting 2fa in the verification
-     * message.
-     */
-    app_name?: string;
-
-    /**
-     * For every request that is initiated via this Verify profile, this sets the
-     * number of seconds before a verification request code expires. Once the
-     * verification request expires, the user cannot use the code to verify their
-     * identity.
-     */
-    default_verification_timeout_secs?: number;
-
+  export interface SMS {
     /**
-     * Enabled country destinations to send verification codes. The elements in the
-     * list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
-     * destinations will be allowed.
+     * The alphanumeric sender ID to use when sending to destinations that require an
+     * alphanumeric sender ID.
      */
-    whitelisted_destinations?: Array<string>;
-
-    [k: string]: unknown;
-  }
+    alpha_sender?: string | null;
 
-  export interface Rcs {
     /**
      * The name that identifies the application requesting 2fa in the verification
      * message.
@@ -631,39 +631,19 @@ export namespace VerifyProfileUpdateParams {
      */
     messaging_template_id?: string;
 
-    /**
-     * Enable SMS fallback when RCS delivery fails.
-     */
-    sms_fallback?: boolean;
-
     /**
      * Enabled country destinations to send verification codes. The elements in the
      * list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
-     * destinations will be allowed.
+     * destinations will be allowed. **Conditionally required:** this field must be
+     * provided when your organization is configured to require explicit whitelisted
+     * destinations; otherwise it is optional.
      */
     whitelisted_destinations?: Array<string>;
 
     [k: string]: unknown;
   }
 
-  export interface SMS {
-    /**
-     * The alphanumeric sender ID to use when sending to destinations that require an
-     * alphanumeric sender ID.
-     */
-    alpha_sender?: string | null;
-
-    /**
-     * The name that identifies the application requesting 2fa in the verification
-     * message.
-     */
-    app_name?: string;
-
-    /**
-     * The length of the verify code to generate.
-     */
-    code_length?: number;
-
+  export interface Whatsapp {
     /**
      * For every request that is initiated via this Verify profile, this sets the
      * number of seconds before a verification request code expires. Once the
@@ -673,39 +653,26 @@ export namespace VerifyProfileUpdateParams {
     default_verification_timeout_secs?: number;
 
     /**
-     * The message template identifier selected from /verify_profiles/templates
-     */
-    messaging_template_id?: string;
-
-    /**
-     * Enabled country destinations to send verification codes. The elements in the
-     * list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
-     * destinations will be allowed.
+     * Phone number registered on the customer WABA to send OTPs from
      */
-    whitelisted_destinations?: Array<string>;
-
-    [k: string]: unknown;
-  }
+    sender_phone_number?: string | null;
 
-  export interface Whatsapp {
     /**
-     * The name that identifies the application requesting 2fa in the verification
-     * message.
+     * Customer pre-approved authentication template name registered on Meta
      */
-    app_name?: string;
+    template_id?: string | null;
 
     /**
-     * For every request that is initiated via this Verify profile, this sets the
-     * number of seconds before a verification request code expires. Once the
-     * verification request expires, the user cannot use the code to verify their
-     * identity.
+     * Customer Meta WABA ID for Bring-Your-Own-WABA sending
      */
-    default_verification_timeout_secs?: number;
+    waba_id?: string | null;
 
     /**
      * Enabled country destinations to send verification codes. The elements in the
      * list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
-     * destinations will be allowed.
+     * destinations will be allowed. **Conditionally required:** this field must be
+     * provided when your organization is configured to require explicit whitelisted
+     * destinations; otherwise it is optional.
      */
     whitelisted_destinations?: Array<string>;