telnyx 7.18.0 → 7.19.0

package/src/resources/ai/assistants/assistants.ts

@@ -2701,17 +2701,19 @@ export interface TranscriptionSettings {
    * supported models will automatically detect the language. For `deepgram/flux`,
    * supported values are: `auto` (Telnyx language detection controls the language
    * hint), `multi` (no language hint), and language-specific hints `en`, `es`, `fr`,
-   * `de`, `hi`, `ru`, `pt`, `ja`, `it`, and `nl`. For `soniox/stt-rt-v4`, `auto`
-   * omits the language hint and lets Soniox auto-detect; ISO 639-1 codes (e.g. `en`,
-   * `es`) bias detection toward that language. For `humain/realtime`, supported
-   * values are `ar`, `en`, `codeswitch` (Arabic/English code-switching), and `auto`
-   * (resolves server-side to code-switching). Unlike other models, `humain/realtime`
-   * does not fall back to `auto` when `language` is omitted — omitting it applies
-   * `en` instead. For `reson8/turns`, supported values are `auto` (or unset) for
-   * automatic language detection, and the language codes `nl`, `en`, `fr`, `fy`,
-   * `de`, `it`, `pl`, `pt`, `es`, and `sv` to fix the transcription language. For
-   * `cohere/ar-stt`, supported values are `ar` and `en`; unlike other models, this
-   * model does not auto-detect and defaults to `ar` when `language` is omitted.
+   * `de`, `hi`, `ru`, `pt`, `ja`, `it`, and `nl`. For `soniox/stt-rt-v4` and
+   * `soniox/stt-rt-v5`, `auto` omits the language hint and lets Soniox auto-detect;
+   * ISO 639-1 codes (e.g. `en`, `es`) bias detection toward that language;
+   * `settings.language_hints` can pin multiple languages at once instead. For
+   * `humain/realtime`, supported values are `ar`, `en`, `codeswitch` (Arabic/English
+   * code-switching), and `auto` (resolves server-side to code-switching). Unlike
+   * other models, `humain/realtime` does not fall back to `auto` when `language` is
+   * omitted — omitting it applies `en` instead. For `reson8/turns`, supported values
+   * are `auto` (or unset) for automatic language detection, and the language codes
+   * `nl`, `en`, `fr`, `fy`, `de`, `it`, `pl`, `pt`, `es`, and `sv` to fix the
+   * transcription language. For `cohere/ar-stt`, supported values are `ar` and `en`;
+   * unlike other models, this model does not auto-detect and defaults to `ar` when
+   * `language` is omitted.
    */
   language?: string;
 
@@ -2726,8 +2728,9 @@ export interface TranscriptionSettings {
    * - `assemblyai/universal-streaming` is a multilingual streaming model with
    *   configurable turn detection.
    * - `xai/grok-stt` is a multilingual Grok STT model.
-   * - `soniox/stt-rt-v4` is a multilingual streaming model with automatic language
-   *   detection and configurable endpointing.
+   * - `soniox/stt-rt-v4` and `soniox/stt-rt-v5` are multilingual streaming models
+   *   with automatic language detection, configurable endpointing, term biasing
+   *   (`context`), and `language_hints`.
    * - `nvidia/parakeet-v3` is a multilingual transcription model with automatic
    *   language detection.
    * - `humain/realtime` is a streaming model with native Arabic and Arabic/English
@@ -2744,6 +2747,7 @@ export interface TranscriptionSettings {
     | 'assemblyai/universal-streaming'
     | 'xai/grok-stt'
     | 'soniox/stt-rt-v4'
+    | 'soniox/stt-rt-v5'
     | 'nvidia/parakeet-v3'
     | 'humain/realtime'
     | 'reson8/turns'
@@ -2761,6 +2765,17 @@ export interface TranscriptionSettings {
 }
 
 export interface TranscriptionSettingsConfig {
+  /**
+   * Available only for soniox/stt-rt-v4 and soniox/stt-rt-v5. A comma-separated list
+   * of terms to boost for recognition during transcription, for staff names,
+   * building names, or other domain-specific vocabulary. This field may be templated
+   * with
+   * [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
+   * using mustache syntax (e.g. `Telnyx,{{customer_name}},VoIP`). Variables are
+   * resolved at call time before the value is sent to Soniox.
+   */
+  context?: string;
+
   /**
    * Available only for deepgram/flux. Confidence threshold for eager end of turn
    * detection. Must be lower than or equal to eot_threshold. Setting this equal to
@@ -2769,8 +2784,9 @@ export interface TranscriptionSettingsConfig {
   eager_eot_threshold?: number;
 
   /**
-   * Available only for soniox/stt-rt-v4. When true, Soniox emits end-of-utterance
-   * events at the cadence configured by `max_endpoint_delay_ms`.
+   * Available only for soniox/stt-rt-v4 and soniox/stt-rt-v5. When true, Soniox
+   * emits end-of-utterance events at the cadence configured by
+   * `max_endpoint_delay_ms`.
    */
   enable_endpoint_detection?: boolean;
 
@@ -2794,8 +2810,8 @@ export interface TranscriptionSettingsConfig {
   eot_timeout_ms?: number;
 
   /**
-   * Available only for soniox/stt-rt-v4. When true, Soniox streams interim
-   * (non-final) results in addition to finalized transcripts.
+   * Available only for soniox/stt-rt-v4 and soniox/stt-rt-v5. When true, Soniox
+   * streams interim (non-final) results in addition to finalized transcripts.
    */
   interim_results?: boolean;
 
@@ -2811,8 +2827,15 @@ export interface TranscriptionSettingsConfig {
   keyterm?: string;
 
   /**
-   * Available only for soniox/stt-rt-v4. Maximum silence (in milliseconds) before
-   * Soniox emits an end-of-utterance event. Only honored when
+   * Available only for soniox/stt-rt-v4 and soniox/stt-rt-v5. A list of ISO 639-1
+   * language codes (e.g. `["nl", "fr"]`) to pin recognition to multiple languages at
+   * once, overriding the single hint derived from `language`.
+   */
+  language_hints?: Array<string>;
+
+  /**
+   * Available only for soniox/stt-rt-v4 and soniox/stt-rt-v5. Maximum silence (in
+   * milliseconds) before Soniox emits an end-of-utterance event. Only honored when
    * `enable_endpoint_detection` is true.
    */
   max_endpoint_delay_ms?: number;

package/src/resources/credential-connections/credential-connections.ts

@@ -130,8 +130,8 @@ export type ConnectionNoiseSuppression = 'inbound' | 'outbound' | 'both' | 'disa
 
 export interface ConnectionRtcpSettings {
   /**
-   * BETA - Enable the capture and storage of RTCP messages to create QoS reports on
-   * the Telnyx Mission Control Portal.
+   * Enable the capture and storage of RTCP messages to create QoS reports on the
+   * Telnyx Mission Control Portal.
    */
   capture_enabled?: boolean;
 

package/src/resources/external-requirements/external-requirements.ts

@@ -0,0 +1,27 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as SubNumberOrdersAPI from './sub-number-orders';
+import {
+  SubNumberOrderRetrieveParams,
+  SubNumberOrderRetrieveResponse,
+  SubNumberOrderUpdateParams,
+  SubNumberOrderUpdateResponse,
+  SubNumberOrders,
+} from './sub-number-orders';
+
+export class ExternalRequirements extends APIResource {
+  subNumberOrders: SubNumberOrdersAPI.SubNumberOrders = new SubNumberOrdersAPI.SubNumberOrders(this._client);
+}
+
+ExternalRequirements.SubNumberOrders = SubNumberOrders;
+
+export declare namespace ExternalRequirements {
+  export {
+    SubNumberOrders as SubNumberOrders,
+    type SubNumberOrderRetrieveResponse as SubNumberOrderRetrieveResponse,
+    type SubNumberOrderUpdateResponse as SubNumberOrderUpdateResponse,
+    type SubNumberOrderRetrieveParams as SubNumberOrderRetrieveParams,
+    type SubNumberOrderUpdateParams as SubNumberOrderUpdateParams,
+  };
+}

package/src/resources/external-requirements/index.ts

@@ -0,0 +1,10 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { ExternalRequirements } from './external-requirements';
+export {
+  SubNumberOrders,
+  type SubNumberOrderRetrieveResponse,
+  type SubNumberOrderUpdateResponse,
+  type SubNumberOrderRetrieveParams,
+  type SubNumberOrderUpdateParams,
+} from './sub-number-orders';

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

@@ -0,0 +1,202 @@
+// 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';
+
+/**
+ * Requirement Groups
+ */
+export class SubNumberOrders extends APIResource {
+  /**
+   * Returns the input fields an action requirement needs and the current requirement
+   * action for a sub number order. Action requirements are fulfilled by an external
+   * step rather than by uploading documents. Australia mobile ID verification is
+   * currently the only action requirement. Once a verification link has been
+   * generated, it is returned in `requirement_action.value`.
+   *
+   * @example
+   * ```ts
+   * const subNumberOrder =
+   *   await client.externalRequirements.subNumberOrders.retrieve(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *     {
+   *       regulatory_requirement_id:
+   *         '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *     },
+   *   );
+   * ```
+   */
+  retrieve(
+    subNumberOrderID: string,
+    params: SubNumberOrderRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<SubNumberOrderRetrieveResponse> {
+    const { regulatory_requirement_id } = params;
+    return this._client.get(
+      path`/external_requirements/${regulatory_requirement_id}/sub_number_orders/${subNumberOrderID}`,
+      options,
+    );
+  }
+
+  /**
+   * Submits the end user's details to the external verification provider and returns
+   * the requirement action. Australia mobile ID verification is currently the only
+   * action requirement. It generates a unique Onfido verification link, returned in
+   * `requirement_action.value`, which you share with the end user. The end user's
+   * `first_name` and `last_name` must be nested inside a `requirement` object;
+   * sending them at the top level is rejected.
+   *
+   * @example
+   * ```ts
+   * const subNumberOrder =
+   *   await client.externalRequirements.subNumberOrders.update(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *     {
+   *       regulatory_requirement_id:
+   *         '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *       requirement: { first_name: 'Jane', last_name: 'Doe' },
+   *     },
+   *   );
+   * ```
+   */
+  update(
+    subNumberOrderID: string,
+    params: SubNumberOrderUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<SubNumberOrderUpdateResponse> {
+    const { regulatory_requirement_id, ...body } = params;
+    return this._client.post(
+      path`/external_requirements/${regulatory_requirement_id}/sub_number_orders/${subNumberOrderID}`,
+      { body, ...options },
+    );
+  }
+}
+
+export interface SubNumberOrderRetrieveResponse {
+  data?: SubNumberOrderRetrieveResponse.Data;
+}
+
+export namespace SubNumberOrderRetrieveResponse {
+  export interface Data {
+    /**
+     * The fields the end user must provide to fulfill this requirement.
+     */
+    fields_required?: Array<Data.FieldsRequired>;
+
+    regulatory_requirement_id?: string;
+
+    requirement_action?: Data.RequirementAction;
+  }
+
+  export namespace Data {
+    export interface FieldsRequired {
+      description?: string;
+
+      /**
+       * The field name to send inside the `requirement` object on the POST.
+       */
+      name?: string;
+
+      type?: string;
+
+      /**
+       * The value already stored for this field, or null if not yet provided.
+       */
+      value?: string | null;
+    }
+
+    export interface RequirementAction {
+      /**
+       * The type of action the end user must complete.
+       */
+      type?: string;
+
+      /**
+       * The action value. For ID verification this is the verification link URL, or null
+       * until it has been generated.
+       */
+      value?: string | null;
+    }
+  }
+}
+
+export interface SubNumberOrderUpdateResponse {
+  data?: SubNumberOrderUpdateResponse.Data;
+}
+
+export namespace SubNumberOrderUpdateResponse {
+  export interface Data {
+    regulatory_requirement_id?: string;
+
+    requirement_action?: Data.RequirementAction;
+
+    sub_order_id?: string;
+  }
+
+  export namespace Data {
+    export interface RequirementAction {
+      type?: string;
+
+      /**
+       * For Australia mobile ID verification, the unique Onfido verification link to
+       * share with the end user.
+       */
+      value?: string | null;
+    }
+  }
+}
+
+export interface SubNumberOrderRetrieveParams {
+  /**
+   * The ID of the regulatory (action) requirement. For Australia mobile ID
+   * verification this is `b7c72fb8-fa08-4529-aaf6-b9117d3f3698`.
+   */
+  regulatory_requirement_id: string;
+}
+
+export interface SubNumberOrderUpdateParams {
+  /**
+   * Path param: The ID of the regulatory (action) requirement. For Australia mobile
+   * ID verification this is `b7c72fb8-fa08-4529-aaf6-b9117d3f3698`.
+   */
+  regulatory_requirement_id: string;
+
+  /**
+   * Body param: The end user's identity details for the action requirement.
+   * Australia mobile ID verification is currently the only action requirement. It
+   * requires `first_name` and `last_name`, the same fields the corresponding GET
+   * lists in `fields_required`.
+   */
+  requirement: SubNumberOrderUpdateParams.Requirement;
+}
+
+export namespace SubNumberOrderUpdateParams {
+  /**
+   * The end user's identity details for the action requirement. Australia mobile ID
+   * verification is currently the only action requirement. It requires `first_name`
+   * and `last_name`, the same fields the corresponding GET lists in
+   * `fields_required`.
+   */
+  export interface Requirement {
+    /**
+     * The end user's first name.
+     */
+    first_name: string;
+
+    /**
+     * The end user's last name.
+     */
+    last_name: string;
+  }
+}
+
+export declare namespace SubNumberOrders {
+  export {
+    type SubNumberOrderRetrieveResponse as SubNumberOrderRetrieveResponse,
+    type SubNumberOrderUpdateResponse as SubNumberOrderUpdateResponse,
+    type SubNumberOrderRetrieveParams as SubNumberOrderRetrieveParams,
+    type SubNumberOrderUpdateParams as SubNumberOrderUpdateParams,
+  };
+}

package/src/resources/external-requirements.ts

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

package/src/resources/index.ts

@@ -459,6 +459,7 @@ export {
   type ExternalConnectionUpdateLocationParams,
   type ExternalConnectionsDefaultFlatPagination,
 } from './external-connections/external-connections';
+export { ExternalRequirements } from './external-requirements/external-requirements';
 export {
   FaxApplications,
   type FaxApplication,

package/src/resources/outbound-voice-profiles.ts

@@ -148,8 +148,8 @@ export interface OutboundVoiceProfile {
   call_recording?: OutboundCallRecording;
 
   /**
-   * (BETA) Specifies the time window and call limits for calls made using this
-   * outbound voice profile. Note that all times are UTC in 24-hour clock time.
+   * Specifies the time window and call limits for calls made using this outbound
+   * voice profile. Note that all times are UTC in 24-hour clock time.
    */
   calling_window?: OutboundVoiceProfile.CallingWindow;
 
@@ -228,25 +228,25 @@ export interface OutboundVoiceProfile {
 
 export namespace OutboundVoiceProfile {
   /**
-   * (BETA) Specifies the time window and call limits for calls made using this
-   * outbound voice profile. Note that all times are UTC in 24-hour clock time.
+   * Specifies the time window and call limits for calls made using this outbound
+   * voice profile. Note that all times are UTC in 24-hour clock time.
    */
   export interface CallingWindow {
     /**
-     * (BETA) The maximum number of calls that can be initiated to a single called
-     * party (CLD) within the calling window. A null value means no limit.
+     * The maximum number of calls that can be initiated to a single called party (CLD)
+     * within the calling window. A null value means no limit.
      */
     calls_per_cld?: number;
 
     /**
-     * (BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are no
-     * longer allowed to start.
+     * The UTC time of day (in HH:MM format, 24-hour clock) when calls are no longer
+     * allowed to start.
      */
     end_time?: string;
 
     /**
-     * (BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are
-     * allowed to start.
+     * The UTC time of day (in HH:MM format, 24-hour clock) when calls are allowed to
+     * start.
      */
     start_time?: string;
   }
@@ -361,8 +361,8 @@ export interface OutboundVoiceProfileCreateParams {
   call_recording?: OutboundCallRecording;
 
   /**
-   * (BETA) Specifies the time window and call limits for calls made using this
-   * outbound voice profile. Note that all times are UTC in 24-hour clock time.
+   * Specifies the time window and call limits for calls made using this outbound
+   * voice profile. Note that all times are UTC in 24-hour clock time.
    */
   calling_window?: OutboundVoiceProfileCreateParams.CallingWindow;
 
@@ -421,25 +421,25 @@ export interface OutboundVoiceProfileCreateParams {
 
 export namespace OutboundVoiceProfileCreateParams {
   /**
-   * (BETA) Specifies the time window and call limits for calls made using this
-   * outbound voice profile. Note that all times are UTC in 24-hour clock time.
+   * Specifies the time window and call limits for calls made using this outbound
+   * voice profile. Note that all times are UTC in 24-hour clock time.
    */
   export interface CallingWindow {
     /**
-     * (BETA) The maximum number of calls that can be initiated to a single called
-     * party (CLD) within the calling window. A null value means no limit.
+     * The maximum number of calls that can be initiated to a single called party (CLD)
+     * within the calling window. A null value means no limit.
      */
     calls_per_cld?: number;
 
     /**
-     * (BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are no
-     * longer allowed to start.
+     * The UTC time of day (in HH:MM format, 24-hour clock) when calls are no longer
+     * allowed to start.
      */
     end_time?: string;
 
     /**
-     * (BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are
-     * allowed to start.
+     * The UTC time of day (in HH:MM format, 24-hour clock) when calls are allowed to
+     * start.
      */
     start_time?: string;
   }
@@ -460,8 +460,8 @@ export interface OutboundVoiceProfileUpdateParams {
   call_recording?: OutboundCallRecording;
 
   /**
-   * (BETA) Specifies the time window and call limits for calls made using this
-   * outbound voice profile.
+   * Specifies the time window and call limits for calls made using this outbound
+   * voice profile.
    */
   calling_window?: OutboundVoiceProfileUpdateParams.CallingWindow;
 
@@ -520,25 +520,25 @@ export interface OutboundVoiceProfileUpdateParams {
 
 export namespace OutboundVoiceProfileUpdateParams {
   /**
-   * (BETA) Specifies the time window and call limits for calls made using this
-   * outbound voice profile.
+   * Specifies the time window and call limits for calls made using this outbound
+   * voice profile.
    */
   export interface CallingWindow {
     /**
-     * (BETA) The maximum number of calls that can be initiated to a single called
-     * party (CLD) within the calling window. A null value means no limit.
+     * The maximum number of calls that can be initiated to a single called party (CLD)
+     * within the calling window. A null value means no limit.
      */
     calls_per_cld?: number;
 
     /**
-     * (BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are no
-     * longer allowed to start.
+     * The UTC time of day (in HH:MM format, 24-hour clock) when calls are no longer
+     * allowed to start.
      */
     end_time?: string;
 
     /**
-     * (BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are
-     * allowed to start.
+     * The UTC time of day (in HH:MM format, 24-hour clock) when calls are allowed to
+     * start.
      */
     start_time?: string;
   }

package/src/resources/webhooks.ts

@@ -6,25 +6,19 @@ import * as NumberOrdersAPI from './number-orders';
 import * as CallsAPI from './calls/calls';
 import * as MessagesAPI from './messages/messages';
 import * as ThreadsAPI from './email-inboxes/threads/threads';
-import { Webhook } from 'standardwebhooks';
 import { EmailBracketCursorPagination } from '../core/pagination';
+import { unsafeUnwrapWebhook, unwrapWebhook } from '../lib/webhooks';
 
 export class Webhooks extends APIResource {
-  unwrap(
+  async unwrap(
     body: string,
     { headers, key }: { headers: Record<string, string>; key?: string },
-  ): UnwrapWebhookEvent {
-    if (headers !== undefined) {
-      const keyStr: string | null = key === undefined ? this._client.publicKey : key;
-      if (keyStr === null) throw new Error('Webhook key must not be null in order to unwrap');
-      const wh = new Webhook(keyStr);
-      wh.verify(body, headers);
-    }
-    return JSON.parse(body) as UnwrapWebhookEvent;
+  ): Promise<UnwrapWebhookEvent> {
+    return unwrapWebhook<UnwrapWebhookEvent>(body, { headers, key }, this._client.publicKey);
   }
 
   unsafeUnwrap(body: string): UnsafeUnwrapWebhookEvent {
-    return JSON.parse(body) as UnsafeUnwrapWebhookEvent;
+    return unsafeUnwrapWebhook<UnsafeUnwrapWebhookEvent>(body);
   }
 }
 

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '7.18.0'; // x-release-please-version
+export const VERSION = '7.19.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "7.18.0";
+export declare const VERSION = "7.19.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "7.18.0";
+export declare const VERSION = "7.19.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '7.18.0'; // x-release-please-version
+exports.VERSION = '7.19.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '7.18.0'; // x-release-please-version
+export const VERSION = '7.19.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map