telnyx 7.16.0 → 7.18.0

package/src/resources/sub-number-orders.ts

@@ -49,7 +49,7 @@ export class SubNumberOrders extends APIResource {
   }
 
   /**
-   * Get an existing sub number order.
+   * Returns the details of an existing sub number order, with support for filtering.
    *
    * @example
    * ```ts
@@ -68,7 +68,8 @@ export class SubNumberOrders extends APIResource {
   }
 
   /**
-   * Updates a sub number order.
+   * Updates the requirements of an existing sub number order and returns the updated
+   * order.
    *
    * @example
    * ```ts
@@ -100,6 +101,112 @@ export class SubNumberOrders extends APIResource {
   }
 }
 
+export interface NumbersSubNumberOrder {
+  id?: string;
+
+  country_code?: string;
+
+  /**
+   * An ISO 8901 datetime string denoting when the number order was created.
+   */
+  created_at?: string;
+
+  /**
+   * A customer reference string for customer look ups.
+   */
+  customer_reference?: string;
+
+  /**
+   * True if the sub number order is a block sub number order
+   */
+  is_block_sub_number_order?: boolean;
+
+  order_request_id?: string;
+
+  phone_number_type?: 'local' | 'toll_free' | 'mobile' | 'national' | 'shared_cost' | 'landline';
+
+  /**
+   * The first 50 phone numbers in the sub number order, including their per-number
+   * regulatory requirement statuses. Only present when
+   * filter[include_phone_numbers]=true is used.
+   */
+  phone_numbers?: Array<NumbersSubNumberOrder.PhoneNumber>;
+
+  /**
+   * The count of phone numbers in the number order.
+   */
+  phone_numbers_count?: number;
+
+  record_type?: string;
+
+  regulatory_requirements?: Array<SubNumberOrderRegulatoryRequirement>;
+
+  /**
+   * True if all requirements are met for every phone number, false otherwise.
+   */
+  requirements_met?: boolean;
+
+  /**
+   * The status of the order.
+   */
+  status?: 'pending' | 'success' | 'failure';
+
+  /**
+   * An ISO 8901 datetime string for when the number order was updated.
+   */
+  updated_at?: string;
+
+  user_id?: string;
+}
+
+export namespace NumbersSubNumberOrder {
+  export interface PhoneNumber {
+    id?: string;
+
+    bundle_id?: string | null;
+
+    country_code?: string;
+
+    phone_number?: string;
+
+    phone_number_type?: string;
+
+    record_type?: string;
+
+    regulatory_requirements?: Array<PhoneNumber.RegulatoryRequirement>;
+
+    requirements_met?: boolean;
+
+    requirements_status?: string;
+
+    status?: string;
+  }
+
+  export namespace PhoneNumber {
+    export interface RegulatoryRequirement {
+      field_type?: 'textual' | 'datetime' | 'address' | 'document';
+
+      /**
+       * The value of the requirement, this could be an id to a resource or a string
+       * value.
+       */
+      field_value?: string;
+
+      record_type?: string;
+
+      /**
+       * Unique id for a requirement.
+       */
+      requirement_id?: string;
+
+      /**
+       * The status of the regulatory requirement for this phone number.
+       */
+      status?: 'approved' | 'declined' | 'awaiting-value' | 'pending-approval';
+    }
+  }
+}
+
 export interface SubNumberOrder {
   id?: string;
 
@@ -163,21 +270,21 @@ export interface SubNumberOrderRegulatoryRequirement {
 }
 
 export interface SubNumberOrderRetrieveResponse {
-  data?: SubNumberOrder;
+  data?: NumbersSubNumberOrder;
 }
 
 export interface SubNumberOrderUpdateResponse {
-  data?: SubNumberOrder;
+  data?: NumbersSubNumberOrder;
 }
 
 export interface SubNumberOrderListResponse {
-  data?: Array<SubNumberOrder>;
+  data?: Array<NumbersSubNumberOrder>;
 
   meta?: AuthenticationProvidersAPI.PaginationMeta;
 }
 
 export interface SubNumberOrderCancelResponse {
-  data?: SubNumberOrder;
+  data?: NumbersSubNumberOrder;
 }
 
 export interface SubNumberOrderUpdateRequirementGroupResponse {
@@ -264,7 +371,7 @@ export interface SubNumberOrderListParams {
   /**
    * Consolidated filter parameter (deepObject style). Originally: filter[status],
    * filter[order_request_id], filter[country_code], filter[phone_number_type],
-   * filter[phone_numbers_count]
+   * filter[phone_numbers_count], filter[include_phone_numbers]
    */
   filter?: SubNumberOrderListParams.Filter;
 }
@@ -273,7 +380,7 @@ export namespace SubNumberOrderListParams {
   /**
    * Consolidated filter parameter (deepObject style). Originally: filter[status],
    * filter[order_request_id], filter[country_code], filter[phone_number_type],
-   * filter[phone_numbers_count]
+   * filter[phone_numbers_count], filter[include_phone_numbers]
    */
   export interface Filter {
     /**
@@ -281,6 +388,12 @@ export namespace SubNumberOrderListParams {
      */
     country_code?: string;
 
+    /**
+     * Include the first 50 phone number objects in the results, including their
+     * per-number regulatory requirement statuses
+     */
+    include_phone_numbers?: boolean;
+
     /**
      * ID of the number order the sub number order belongs to
      */
@@ -337,6 +450,7 @@ export interface SubNumberOrderUpdateParams {
 
 export declare namespace SubNumberOrders {
   export {
+    type NumbersSubNumberOrder as NumbersSubNumberOrder,
     type SubNumberOrder as SubNumberOrder,
     type SubNumberOrderRegulatoryRequirement as SubNumberOrderRegulatoryRequirement,
     type SubNumberOrderRetrieveResponse as SubNumberOrderRetrieveResponse,

package/src/resources/telephony-credentials.ts

@@ -9,7 +9,8 @@ import { path } from '../internal/utils/path';
 
 export class TelephonyCredentials extends APIResource {
   /**
-   * List all On-demand Credentials.
+   * Returns a paginated list of the on-demand telephony credentials on your account,
+   * with support for filtering.
    *
    * @example
    * ```ts
@@ -30,7 +31,8 @@ export class TelephonyCredentials extends APIResource {
   }
 
   /**
-   * Create a credential.
+   * Creates a new on-demand telephony credential for the specified connection. The
+   * credential can then be used to generate access tokens for SIP or WebRTC clients.
    *
    * @example
    * ```ts
@@ -48,7 +50,8 @@ export class TelephonyCredentials extends APIResource {
   }
 
   /**
-   * Delete an existing credential.
+   * Permanently deletes the specified telephony credential, revoking any access it
+   * provided.
    *
    * @example
    * ```ts
@@ -74,7 +77,7 @@ export class TelephonyCredentials extends APIResource {
   }
 
   /**
-   * Update an existing credential.
+   * Updates the specified telephony credential and returns the updated credential.
    *
    * @example
    * ```ts

package/src/resources/texml/accounts/calls/calls.ts

@@ -59,7 +59,7 @@ export class Calls extends APIResource {
    * ```ts
    * const response = await client.texml.accounts.calls.calls(
    *   'account_sid',
-   *   { Url: 'https://www.example.com/instructions.xml' },
+   *   { body: { Url: 'https://www.example.com/texml.xml' } },
    * );
    * ```
    */
@@ -68,11 +68,8 @@ export class Calls extends APIResource {
     params: CallCallsParams,
     options?: RequestOptions,
   ): APIPromise<CallCallsResponse> {
-    const { timeout_seconds, ...body } = params;
-    return this._client.post(path`/texml/Accounts/${accountSid}/Calls`, {
-      body: { Timeout: timeout_seconds, ...body },
-      ...options,
-    });
+    const { body } = params;
+    return this._client.post(path`/texml/Accounts/${accountSid}/Calls`, { body: body, ...options });
   }
 
   /**
@@ -493,12 +490,11 @@ export interface CallRetrieveCallsParams {
   To?: string;
 }
 
-export type CallCallsParams =
-  | CallCallsParams.WithURL
-  | CallCallsParams.WithTeXml
-  | CallCallsParams.ApplicationDefault;
+export interface CallCallsParams {
+  body: CallCallsParams.WithURL | CallCallsParams.WithTeXml | CallCallsParams.ApplicationDefault;
+}
 
-export declare namespace CallCallsParams {
+export namespace CallCallsParams {
   export interface WithURL {
     /**
      * The URL from which Telnyx will retrieve the TeXML call instructions.
@@ -594,6 +590,14 @@ export declare namespace CallCallsParams {
      */
     MachineDetection?: 'Enable' | 'Disable' | 'DetectMessageEnd';
 
+    /**
+     * Selects which detectors must validate a beep. `both` requires the amplitude and
+     * frequency detectors to agree. `freq_only` uses the frequency detector alone, for
+     * beeps whose volume is too unsteady for the default profile. Only used when
+     * MachineDetection is enabled.
+     */
+    MachineDetectionBeepProfile?: 'both' | 'freq_only';
+
     /**
      * Silence duration threshold after a call screening prompt before ending prompt
      * detection, in milliseconds. Used when `DetectionMode` is `PremiumCallScreening`.
@@ -739,7 +743,7 @@ export declare namespace CallCallsParams {
      * call is canceled. The minimum value is 5 and the maximum value is 120. Default
      * is 30 seconds.
      */
-    timeout_seconds?: number;
+    Timeout?: number;
 
     /**
      * The phone number of the called party. Phone numbers are formatted with a `+` and
@@ -870,6 +874,14 @@ export declare namespace CallCallsParams {
      */
     MachineDetection?: 'Enable' | 'Disable' | 'DetectMessageEnd';
 
+    /**
+     * Selects which detectors must validate a beep. `both` requires the amplitude and
+     * frequency detectors to agree. `freq_only` uses the frequency detector alone, for
+     * beeps whose volume is too unsteady for the default profile. Only used when
+     * MachineDetection is enabled.
+     */
+    MachineDetectionBeepProfile?: 'both' | 'freq_only';
+
     /**
      * Silence duration threshold after a call screening prompt before ending prompt
      * detection, in milliseconds. Used when `DetectionMode` is `PremiumCallScreening`.
@@ -1013,7 +1025,7 @@ export declare namespace CallCallsParams {
      * call is canceled. The minimum value is 5 and the maximum value is 120. Default
      * is 30 seconds.
      */
-    timeout_seconds?: number;
+    Timeout?: number;
 
     /**
      * The phone number of the called party. Phone numbers are formatted with a `+` and
@@ -1140,6 +1152,14 @@ export declare namespace CallCallsParams {
      */
     MachineDetection?: 'Enable' | 'Disable' | 'DetectMessageEnd';
 
+    /**
+     * Selects which detectors must validate a beep. `both` requires the amplitude and
+     * frequency detectors to agree. `freq_only` uses the frequency detector alone, for
+     * beeps whose volume is too unsteady for the default profile. Only used when
+     * MachineDetection is enabled.
+     */
+    MachineDetectionBeepProfile?: 'both' | 'freq_only';
+
     /**
      * Silence duration threshold after a call screening prompt before ending prompt
      * detection, in milliseconds. Used when `DetectionMode` is `PremiumCallScreening`.
@@ -1285,7 +1305,7 @@ export declare namespace CallCallsParams {
      * call is canceled. The minimum value is 5 and the maximum value is 120. Default
      * is 30 seconds.
      */
-    timeout_seconds?: number;
+    Timeout?: number;
 
     /**
      * The phone number of the called party. Phone numbers are formatted with a `+` and

package/src/resources/texml/accounts/conferences/conferences.ts

@@ -26,7 +26,8 @@ export class Conferences extends APIResource {
   participants: ParticipantsAPI.Participants = new ParticipantsAPI.Participants(this._client);
 
   /**
-   * Lists conference resources.
+   * Returns a paginated list of conference resources for the account, with support
+   * for filtering by friendly name, status, and creation or update dates.
    *
    * @example
    * ```ts
@@ -45,7 +46,7 @@ export class Conferences extends APIResource {
   }
 
   /**
-   * Returns a conference resource.
+   * Returns a single conference resource for the account by its ConferenceSid.
    *
    * @example
    * ```ts
@@ -66,7 +67,8 @@ export class Conferences extends APIResource {
   }
 
   /**
-   * Updates a conference resource.
+   * Updates the specified conference resource, for example to modify its status, and
+   * returns the updated conference.
    *
    * @example
    * ```ts
@@ -91,7 +93,7 @@ export class Conferences extends APIResource {
   }
 
   /**
-   * Lists conference recordings
+   * Returns the list of recordings made for the specified conference.
    *
    * @example
    * ```ts

package/src/resources/texml/accounts/conferences/participants.ts

@@ -11,7 +11,7 @@ import { path } from '../../../../internal/utils/path';
  */
 export class Participants extends APIResource {
   /**
-   * Lists conference participants
+   * Returns the list of participants currently in the specified conference.
    *
    * @example
    * ```ts
@@ -35,7 +35,8 @@ export class Participants extends APIResource {
   }
 
   /**
-   * Dials a new conference participant
+   * Dials a new participant into the specified conference and returns the created
+   * participant resource.
    *
    * @example
    * ```ts
@@ -60,7 +61,8 @@ export class Participants extends APIResource {
   }
 
   /**
-   * Deletes a conference participant
+   * Removes the specified participant from the conference, ending their leg of the
+   * call.
    *
    * @example
    * ```ts
@@ -86,7 +88,8 @@ export class Participants extends APIResource {
   }
 
   /**
-   * Gets conference participant resource
+   * Returns a single conference participant resource by call SID or participant
+   * label.
    *
    * @example
    * ```ts
@@ -113,7 +116,8 @@ export class Participants extends APIResource {
   }
 
   /**
-   * Updates a conference participant
+   * Updates the specified conference participant, for example muting or holding
+   * them, and returns the updated participant.
    *
    * @example
    * ```ts
@@ -480,6 +484,14 @@ export interface ParticipantParticipantsParams {
    */
   MachineDetection?: 'Enable' | 'DetectMessageEnd';
 
+  /**
+   * Body param: Selects which detectors must validate a beep. `both` requires the
+   * amplitude and frequency detectors to agree. `freq_only` uses the frequency
+   * detector alone, for beeps whose volume is too unsteady for the default profile.
+   * Only used when MachineDetection is enabled.
+   */
+  MachineDetectionBeepProfile?: 'both' | 'freq_only';
+
   /**
    * Body param: If initial silence duration is greater than this value, consider it
    * a machine. Ignored when `premium` detection is used.

package/src/resources/texml/accounts/queues.ts

@@ -16,7 +16,8 @@ import { path } from '../../../internal/utils/path';
  */
 export class Queues extends APIResource {
   /**
-   * Creates a new queue resource.
+   * Creates a new queue resource for the account with the provided settings and
+   * returns it.
    *
    * @example
    * ```ts
@@ -33,7 +34,7 @@ export class Queues extends APIResource {
   }
 
   /**
-   * Delete a queue resource.
+   * Permanently deletes the specified queue resource from the account.
    *
    * @example
    * ```ts
@@ -51,7 +52,7 @@ export class Queues extends APIResource {
   }
 
   /**
-   * Returns a queue resource.
+   * Returns a single queue resource for the account by its QueueSid.
    *
    * @example
    * ```ts
@@ -71,7 +72,7 @@ export class Queues extends APIResource {
   }
 
   /**
-   * Updates a queue resource.
+   * Updates the specified queue resource's settings and returns the updated queue.
    *
    * @example
    * ```ts
@@ -91,7 +92,8 @@ export class Queues extends APIResource {
   }
 
   /**
-   * Lists queue resources.
+   * Returns a paginated list of queue resources for the account, with support for
+   * filtering by creation or update dates.
    *
    * @example
    * ```ts

package/src/resources/texml/texml.ts

@@ -203,6 +203,14 @@ export interface TexmlInitiateAICallParams {
    */
   MachineDetection?: 'Enable' | 'Disable' | 'DetectMessageEnd';
 
+  /**
+   * Selects which detectors must validate a beep. `both` requires the amplitude and
+   * frequency detectors to agree. `freq_only` uses the frequency detector alone, for
+   * beeps whose volume is too unsteady for the default profile. Only used when
+   * MachineDetection is enabled.
+   */
+  MachineDetectionBeepProfile?: 'both' | 'freq_only';
+
   /**
    * Silence duration threshold after a call screening prompt before ending prompt
    * detection, in milliseconds. Used when `DetectionMode` is `PremiumCallScreening`.

package/src/resources/texml-applications.ts

@@ -33,7 +33,8 @@ export class TexmlApplications extends APIResource {
   }
 
   /**
-   * Creates a TeXML Application.
+   * Creates a TeXML application, which defines the voice URLs and settings used to
+   * serve TeXML instructions for calls, and returns the created application.
    *
    * @example
    * ```ts
@@ -52,7 +53,7 @@ export class TexmlApplications extends APIResource {
   }
 
   /**
-   * Deletes a TeXML Application.
+   * Permanently deletes the specified TeXML application from your account.
    *
    * @example
    * ```ts

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

@@ -2,10 +2,10 @@
 
 export {
   TextToSpeech,
-  type TextToSpeechGenerateSpeechResponse,
-  type TextToSpeechListVoicesResponse,
   type StreamClientEvent,
   type StreamServerEvent,
+  type TextToSpeechGenerateSpeechResponse,
+  type TextToSpeechListVoicesResponse,
   type TextToSpeechListVoicesParams,
   type TextToSpeechGenerateSpeechParams,
   type TextToSpeechRetrieveSpeechParams,