telnyx 6.7.0 → 6.8.0

package/src/resources/text-to-speech/internal-base.ts

@@ -22,7 +22,7 @@ export class WebSocketError extends TelnyxError {
 
 type Simplify<T> = { [KeyType in keyof T]: T[KeyType] } & {};
 
-type WebsocketEvents = Simplify<
+type WebSocketEvents = Simplify<
   {
     event: (event: TextToSpeechAPI.StreamServerEvent) => void;
     error: (error: WebSocketError) => void;
@@ -33,14 +33,14 @@ type WebsocketEvents = Simplify<
   }
 >;
 
-export abstract class TextToSpeechEmitter extends EventEmitter<WebsocketEvents> {
+export abstract class TextToSpeechEmitter extends EventEmitter<WebSocketEvents> {
   /**
    * Send an event to the API.
    */
   abstract send(event: TextToSpeechAPI.StreamClientEvent): void;
 
   /**
-   * Close the websocket connection.
+   * Close the WebSocket connection.
    */
   abstract close(props?: { code: number; reason: string }): void;
 
@@ -80,7 +80,7 @@ export function buildURL(client: Telnyx, query?: object | null): URL {
   if (query) {
     url.search = stringifyQuery(query);
   }
-  url.protocol = 'wss';
+  url.protocol = url.protocol === 'http:' ? 'ws:' : 'wss:';
   return url;
 }
 

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

@@ -125,7 +125,7 @@ export interface StreamClientEvent {
  */
 export type StreamServerEvent =
   | StreamServerEvent.AudioChunkFrame
-  | StreamServerEvent.FinalFrame
+  | StreamServerEvent.FinalFrameEvent
   | StreamServerEvent.ErrorFrame;
 
 export namespace StreamServerEvent {
@@ -170,7 +170,7 @@ export namespace StreamServerEvent {
   /**
    * Server-to-client frame indicating synthesis is complete for the current text.
    */
-  export interface FinalFrame {
+  export interface FinalFrameEvent {
     /**
      * Always `null` for the final frame.
      */
@@ -238,7 +238,7 @@ export interface TextToSpeechGenerateParams {
   /**
    * Inworld provider-specific parameters.
    */
-  inworld?: unknown;
+  inworld?: { [key: string]: unknown };
 
   /**
    * Language code (e.g. `en-US`). Usage varies by provider.

package/src/resources/whatsapp/business-accounts/business-accounts.ts

@@ -0,0 +1,217 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as PhoneNumbersAPI from './phone-numbers';
+import {
+  PhoneNumberInitializeVerificationParams,
+  PhoneNumberListParams,
+  PhoneNumberListResponse,
+  PhoneNumberListResponsesDefaultFlatPagination,
+  PhoneNumbers,
+} from './phone-numbers';
+import * as SettingsAPI from './settings';
+import {
+  SettingRetrieveResponse,
+  SettingUpdateParams,
+  SettingUpdateResponse,
+  Settings,
+  WabaSettings,
+} from './settings';
+import { APIPromise } from '../../../core/api-promise';
+import {
+  DefaultFlatPagination,
+  type DefaultFlatPaginationParams,
+  PagePromise,
+} from '../../../core/pagination';
+import { buildHeaders } from '../../../internal/headers';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+/**
+ * Manage Whatsapp business accounts
+ */
+export class BusinessAccounts extends APIResource {
+  phoneNumbers: PhoneNumbersAPI.PhoneNumbers = new PhoneNumbersAPI.PhoneNumbers(this._client);
+  settings: SettingsAPI.Settings = new SettingsAPI.Settings(this._client);
+
+  /**
+   * Get a single Whatsapp Business Account
+   *
+   * @example
+   * ```ts
+   * const businessAccount =
+   *   await client.whatsapp.businessAccounts.retrieve('id');
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<BusinessAccountRetrieveResponse> {
+    return this._client.get(path`/v2/whatsapp/business_accounts/${id}`, options);
+  }
+
+  /**
+   * List Whatsapp Business Accounts
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const businessAccountListResponse of client.whatsapp.businessAccounts.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: BusinessAccountListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<BusinessAccountListResponsesDefaultFlatPagination, BusinessAccountListResponse> {
+    return this._client.getAPIList(
+      '/v2/whatsapp/business_accounts',
+      DefaultFlatPagination<BusinessAccountListResponse>,
+      { query, ...options },
+    );
+  }
+
+  /**
+   * Delete a Whatsapp Business Account
+   *
+   * @example
+   * ```ts
+   * await client.whatsapp.businessAccounts.delete('id');
+   * ```
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/v2/whatsapp/business_accounts/${id}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export type BusinessAccountListResponsesDefaultFlatPagination =
+  DefaultFlatPagination<BusinessAccountListResponse>;
+
+export interface BusinessAccountRetrieveResponse {
+  data?: BusinessAccountRetrieveResponse.Data;
+}
+
+export namespace BusinessAccountRetrieveResponse {
+  export interface Data {
+    /**
+     * Internal ID of Whatsapp business account
+     */
+    id?: string;
+
+    /**
+     * Account review status of Whatsapp business account
+     */
+    account_review_status?: string;
+
+    /**
+     * Business verification status of Whatsapp business account
+     */
+    business_verification_status?: string;
+
+    /**
+     * Country associated with Whatsapp business account
+     */
+    country?: string;
+
+    created_at?: string;
+
+    /**
+     * Name of Whatsapp business account
+     */
+    name?: string;
+
+    /**
+     * Count of phone numbers associated with Whatsapp business account
+     */
+    phone_numbers_count?: number;
+
+    record_type?: string;
+
+    /**
+     * Status of Whatsapp business account
+     */
+    status?: string;
+
+    /**
+     * WABA ID of Whatsapp business account
+     */
+    waba_id?: string;
+  }
+}
+
+export interface BusinessAccountListResponse {
+  /**
+   * Internal ID of Whatsapp business account
+   */
+  id?: string;
+
+  /**
+   * Account review status of Whatsapp business account
+   */
+  account_review_status?: string;
+
+  /**
+   * Business verification status of Whatsapp business account
+   */
+  business_verification_status?: string;
+
+  /**
+   * Country associated with Whatsapp business account
+   */
+  country?: string;
+
+  created_at?: string;
+
+  /**
+   * Name of Whatsapp business account
+   */
+  name?: string;
+
+  /**
+   * Count of phone numbers associated with Whatsapp business account
+   */
+  phone_numbers_count?: number;
+
+  record_type?: string;
+
+  /**
+   * Status of Whatsapp business account
+   */
+  status?: string;
+
+  /**
+   * WABA ID of Whatsapp business account
+   */
+  waba_id?: string;
+}
+
+export interface BusinessAccountListParams extends DefaultFlatPaginationParams {}
+
+BusinessAccounts.PhoneNumbers = PhoneNumbers;
+BusinessAccounts.Settings = Settings;
+
+export declare namespace BusinessAccounts {
+  export {
+    type BusinessAccountRetrieveResponse as BusinessAccountRetrieveResponse,
+    type BusinessAccountListResponse as BusinessAccountListResponse,
+    type BusinessAccountListResponsesDefaultFlatPagination as BusinessAccountListResponsesDefaultFlatPagination,
+    type BusinessAccountListParams as BusinessAccountListParams,
+  };
+
+  export {
+    PhoneNumbers as PhoneNumbers,
+    type PhoneNumberListResponse as PhoneNumberListResponse,
+    type PhoneNumberListResponsesDefaultFlatPagination as PhoneNumberListResponsesDefaultFlatPagination,
+    type PhoneNumberListParams as PhoneNumberListParams,
+    type PhoneNumberInitializeVerificationParams as PhoneNumberInitializeVerificationParams,
+  };
+
+  export {
+    Settings as Settings,
+    type WabaSettings as WabaSettings,
+    type SettingRetrieveResponse as SettingRetrieveResponse,
+    type SettingUpdateResponse as SettingUpdateResponse,
+    type SettingUpdateParams as SettingUpdateParams,
+  };
+}

package/src/resources/whatsapp/business-accounts/index.ts

@@ -0,0 +1,23 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  BusinessAccounts,
+  type BusinessAccountRetrieveResponse,
+  type BusinessAccountListResponse,
+  type BusinessAccountListParams,
+  type BusinessAccountListResponsesDefaultFlatPagination,
+} from './business-accounts';
+export {
+  PhoneNumbers,
+  type PhoneNumberListResponse,
+  type PhoneNumberListParams,
+  type PhoneNumberInitializeVerificationParams,
+  type PhoneNumberListResponsesDefaultFlatPagination,
+} from './phone-numbers';
+export {
+  Settings,
+  type WabaSettings,
+  type SettingRetrieveResponse,
+  type SettingUpdateResponse,
+  type SettingUpdateParams,
+} from './settings';

package/src/resources/whatsapp/business-accounts/phone-numbers.ts

@@ -0,0 +1,127 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import { APIPromise } from '../../../core/api-promise';
+import {
+  DefaultFlatPagination,
+  type DefaultFlatPaginationParams,
+  PagePromise,
+} from '../../../core/pagination';
+import { buildHeaders } from '../../../internal/headers';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+export class PhoneNumbers extends APIResource {
+  /**
+   * List phone numbers for a WABA
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const phoneNumberListResponse of client.whatsapp.businessAccounts.phoneNumbers.list(
+   *   'id',
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    id: string,
+    query: PhoneNumberListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<PhoneNumberListResponsesDefaultFlatPagination, PhoneNumberListResponse> {
+    return this._client.getAPIList(
+      path`/v2/whatsapp/business_accounts/${id}/phone_numbers`,
+      DefaultFlatPagination<PhoneNumberListResponse>,
+      { query, ...options },
+    );
+  }
+
+  /**
+   * Initialize Whatsapp phone number verification
+   *
+   * @example
+   * ```ts
+   * await client.whatsapp.businessAccounts.phoneNumbers.initializeVerification(
+   *   'id',
+   *   {
+   *     display_name: 'display_name',
+   *     phone_number: 'phone_number',
+   *   },
+   * );
+   * ```
+   */
+  initializeVerification(
+    id: string,
+    body: PhoneNumberInitializeVerificationParams,
+    options?: RequestOptions,
+  ): APIPromise<void> {
+    return this._client.post(path`/v2/whatsapp/business_accounts/${id}/phone_numbers`, {
+      body,
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export type PhoneNumberListResponsesDefaultFlatPagination = DefaultFlatPagination<PhoneNumberListResponse>;
+
+export interface PhoneNumberListResponse {
+  calling_enabled?: boolean;
+
+  created_at?: string;
+
+  display_name?: string;
+
+  enabled?: boolean;
+
+  /**
+   * Phone number in E164 format
+   */
+  phone_number?: string;
+
+  /**
+   * Whatsapp phone number ID
+   */
+  phone_number_id?: string;
+
+  /**
+   * Whatsapp quality rating
+   */
+  quality_rating?: string;
+
+  record_type?: string;
+
+  status?: string;
+
+  /**
+   * User ID
+   */
+  user_id?: string;
+
+  /**
+   * WABA ID of Whatsapp business account
+   */
+  waba_id?: string;
+}
+
+export interface PhoneNumberListParams extends DefaultFlatPaginationParams {}
+
+export interface PhoneNumberInitializeVerificationParams {
+  display_name: string;
+
+  phone_number: string;
+
+  language?: string;
+
+  verification_method?: 'sms' | 'voice';
+}
+
+export declare namespace PhoneNumbers {
+  export {
+    type PhoneNumberListResponse as PhoneNumberListResponse,
+    type PhoneNumberListResponsesDefaultFlatPagination as PhoneNumberListResponsesDefaultFlatPagination,
+    type PhoneNumberListParams as PhoneNumberListParams,
+    type PhoneNumberInitializeVerificationParams as PhoneNumberInitializeVerificationParams,
+  };
+}

package/src/resources/whatsapp/business-accounts/settings.ts

@@ -0,0 +1,116 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+/**
+ * Manage Whatsapp business accounts
+ */
+export class Settings extends APIResource {
+  /**
+   * Get WABA settings
+   *
+   * @example
+   * ```ts
+   * const setting =
+   *   await client.whatsapp.businessAccounts.settings.retrieve(
+   *     'id',
+   *   );
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<SettingRetrieveResponse> {
+    return this._client.get(path`/v2/whatsapp/business_accounts/${id}/settings`, options);
+  }
+
+  /**
+   * Update WABA settings
+   *
+   * @example
+   * ```ts
+   * const setting =
+   *   await client.whatsapp.businessAccounts.settings.update(
+   *     'id',
+   *   );
+   * ```
+   */
+  update(id: string, body: SettingUpdateParams, options?: RequestOptions): APIPromise<SettingUpdateResponse> {
+    return this._client.patch(path`/v2/whatsapp/business_accounts/${id}/settings`, { body, ...options });
+  }
+}
+
+export interface WabaSettings {
+  /**
+   * Internal ID of Whatsapp business account
+   */
+  id?: string;
+
+  name?: string;
+
+  record_type?: string;
+
+  timezone?: string;
+
+  updated_at?: string;
+
+  /**
+   * Enable/disable receiving Whatsapp events
+   */
+  webhook_enabled?: boolean;
+
+  webhook_events?: Array<string>;
+
+  /**
+   * Failover URL to receive Whatsapp events
+   */
+  webhook_failover_url?: string;
+
+  /**
+   * URL to receive Whatsapp events
+   */
+  webhook_url?: string;
+}
+
+export interface SettingRetrieveResponse {
+  data?: WabaSettings;
+}
+
+export interface SettingUpdateResponse {
+  data?: WabaSettings;
+}
+
+export interface SettingUpdateParams {
+  name?: string;
+
+  /**
+   * IANA timezone identifier
+   */
+  timezone?: string;
+
+  /**
+   * Enable/disable receiving Whatsapp events
+   */
+  webhook_enabled?: boolean;
+
+  webhook_events?: Array<string>;
+
+  /**
+   * Failover URL to send Whatsapp events
+   */
+  webhook_failover_url?: string;
+
+  /**
+   * URL to send Whatsapp events
+   */
+  webhook_url?: string;
+}
+
+export declare namespace Settings {
+  export {
+    type WabaSettings as WabaSettings,
+    type SettingRetrieveResponse as SettingRetrieveResponse,
+    type SettingUpdateResponse as SettingUpdateResponse,
+    type SettingUpdateParams as SettingUpdateParams,
+  };
+}

package/src/resources/whatsapp/business-accounts.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './business-accounts/index';

package/src/resources/whatsapp/index.ts

@@ -0,0 +1,24 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  BusinessAccounts,
+  type BusinessAccountRetrieveResponse,
+  type BusinessAccountListResponse,
+  type BusinessAccountListParams,
+  type BusinessAccountListResponsesDefaultFlatPagination,
+} from './business-accounts/index';
+export {
+  PhoneNumbers,
+  type PhoneNumberListResponse,
+  type PhoneNumberListParams,
+  type PhoneNumberResendVerificationParams,
+  type PhoneNumberVerifyParams,
+  type PhoneNumberListResponsesDefaultFlatPagination,
+} from './phone-numbers/index';
+export {
+  Templates,
+  type TemplateCreateResponse,
+  type TemplateCreateParams,
+  type TemplateListParams,
+} from './templates';
+export { Whatsapp } from './whatsapp';

package/src/resources/whatsapp/phone-numbers/calling-settings.ts

@@ -0,0 +1,86 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+/**
+ * Manage Whatsapp phone numbers
+ */
+export class CallingSettings extends APIResource {
+  /**
+   * Get calling settings for a phone number
+   *
+   * @example
+   * ```ts
+   * const callingSetting =
+   *   await client.whatsapp.phoneNumbers.callingSettings.retrieve(
+   *     'phone_number',
+   *   );
+   * ```
+   */
+  retrieve(phoneNumber: string, options?: RequestOptions): APIPromise<CallingSettingRetrieveResponse> {
+    return this._client.get(path`/v2/whatsapp/phone_numbers/${phoneNumber}/calling_settings`, options);
+  }
+
+  /**
+   * Enable or disable Whatsapp calling for a phone number
+   *
+   * @example
+   * ```ts
+   * const callingSetting =
+   *   await client.whatsapp.phoneNumbers.callingSettings.update(
+   *     'phone_number',
+   *     { enabled: true },
+   *   );
+   * ```
+   */
+  update(
+    phoneNumber: string,
+    body: CallingSettingUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<CallingSettingUpdateResponse> {
+    return this._client.patch(path`/v2/whatsapp/phone_numbers/${phoneNumber}/calling_settings`, {
+      body,
+      ...options,
+    });
+  }
+}
+
+export interface WhatsappCallingSettingsData {
+  /**
+   * True if calling is enabled on the phone
+   */
+  enabled?: boolean;
+
+  /**
+   * Phone number in E164 format
+   */
+  phone_number?: string;
+
+  record_type?: string;
+
+  updated_at?: string;
+}
+
+export interface CallingSettingRetrieveResponse {
+  data?: WhatsappCallingSettingsData;
+}
+
+export interface CallingSettingUpdateResponse {
+  data?: WhatsappCallingSettingsData;
+}
+
+export interface CallingSettingUpdateParams {
+  enabled: boolean;
+}
+
+export declare namespace CallingSettings {
+  export {
+    type WhatsappCallingSettingsData as WhatsappCallingSettingsData,
+    type CallingSettingRetrieveResponse as CallingSettingRetrieveResponse,
+    type CallingSettingUpdateResponse as CallingSettingUpdateResponse,
+    type CallingSettingUpdateParams as CallingSettingUpdateParams,
+  };
+}

package/src/resources/whatsapp/phone-numbers/index.ts

@@ -0,0 +1,24 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  CallingSettings,
+  type WhatsappCallingSettingsData,
+  type CallingSettingRetrieveResponse,
+  type CallingSettingUpdateResponse,
+  type CallingSettingUpdateParams,
+} from './calling-settings';
+export {
+  PhoneNumbers,
+  type PhoneNumberListResponse,
+  type PhoneNumberListParams,
+  type PhoneNumberResendVerificationParams,
+  type PhoneNumberVerifyParams,
+  type PhoneNumberListResponsesDefaultFlatPagination,
+} from './phone-numbers';
+export {
+  Profile,
+  type WhatsappProfileData,
+  type ProfileRetrieveResponse,
+  type ProfileUpdateResponse,
+  type ProfileUpdateParams,
+} from './profile/index';