telnyx 7.23.0 → 7.25.0

package/src/resources/meeting-sessions/artifacts.ts

@@ -25,11 +25,17 @@ export class Artifacts extends APIResource {
   }
 
   /**
-   * Requests asynchronous generation of one `summary` or `action_items` artifact.
-   * Each type requires its own request. Generation requires transcript content and
-   * configured inference and currently reads at most the first 10,000 segments, so
-   * exceptionally long transcripts may produce incomplete artifacts or fail model
-   * limits.
+   * Requests asynchronous generation of one artifact: `summary`, `action_items`,
+   * `decisions`, `topics`, `open_questions`, or `custom`. Each request produces one
+   * artifact. `custom` is answered from a `prompt` you supply, which is required for
+   * `custom` and rejected on the five named types. Generation requires transcript
+   * content and configured inference and currently reads at most the first 10,000
+   * segments, so exceptionally long transcripts may produce incomplete artifacts or
+   * fail model limits. **Not idempotent, and every call is billed**: each request is
+   * a separate inference run, so a retry or a duplicate POST produces a second
+   * artifact and a second charge. Guard the call rather than relying on the service
+   * to collapse it. The automatic `summarize_on_end` attempt is billed on the same
+   * basis.
    *
    * @example
    * ```ts
@@ -81,11 +87,17 @@ export interface MeetingSessionArtifact {
 
   model_provenance: MeetingSessionArtifact.ModelProvenance | null;
 
+  /**
+   * The prompt that produced this artifact, or null for a named type. Non-null only
+   * when `type` is `custom`; the five named types always return `null`.
+   */
+  prompt: string | null;
+
   session_id: string;
 
   status: 'pending' | 'completed' | 'failed';
 
-  type: 'summary' | 'action_items';
+  type: 'summary' | 'action_items' | 'decisions' | 'topics' | 'open_questions' | 'custom';
 
   updated_at: string;
 }
@@ -110,11 +122,30 @@ export interface ArtifactListResponse {
   data: Array<MeetingSessionArtifact>;
 }
 
-export interface ArtifactCreateParams {
-  /**
-   * Type of artifact to generate from the session.
-   */
-  type: 'summary' | 'action_items';
+export type ArtifactCreateParams = ArtifactCreateParams.NamedArtifact | ArtifactCreateParams.CustomArtifact;
+
+export declare namespace ArtifactCreateParams {
+  export interface NamedArtifact {
+    /**
+     * What to generate from the transcript. `custom` is answered from a `prompt` you
+     * supply; the five named types need none.
+     */
+    type: 'summary' | 'action_items' | 'decisions' | 'topics' | 'open_questions';
+  }
+
+  export interface CustomArtifact {
+    /**
+     * An open-ended request answered from the transcript. Required when `type` is
+     * `custom`, and rejected with 400 on any named type. Trimmed before storage and
+     * echoed back in artifact responses and the `artifact.completed` webhook.
+     */
+    prompt: string;
+
+    /**
+     * Answered from the `prompt` below rather than a fixed question.
+     */
+    type: 'custom';
+  }
 }
 
 export interface ArtifactRetrieveParams {

package/src/resources/meeting-sessions/meeting-sessions.ts

@@ -139,14 +139,12 @@ export class MeetingSessions extends APIResource {
   }
 
   /**
-   * **Not yet available in production** — this route is not currently routed on
-   * api.telnyx.com and returns a generic 404; it is documented ahead of rollout.
-   * Irreversibly requests deletion of provider-hosted aggregate recording media
-   * under the provider contract. The operation retains the Telnyx-local Meeting
-   * session, transcript segments, events, artifacts, and usage records. It is
-   * separate from `DELETE /meeting_sessions/{id}`, which stops or cancels
-   * participation without deleting the persisted session. A missing/foreign session
-   * returns 404; provider deletion failures return 502.
+   * Irreversibly requests deletion of the aggregate recording media for the session.
+   * The operation retains the Telnyx-local Meeting session, transcript segments,
+   * events, artifacts, and usage records. It is separate from
+   * `DELETE /meeting_sessions/{id}`, which stops or cancels participation without
+   * deleting the persisted session. A missing/foreign session returns 404; provider
+   * deletion failures return 502.
    *
    * @example
    * ```ts
@@ -353,9 +351,20 @@ export namespace MeetingSession {
     id: string;
 
     /**
-     * Audio gating strategy for the assistant call leg.
+     * Audio gating strategy in force for the assistant call leg.
      */
-    audio_gate: 'none' | 'half_duplex';
+    audio_gate: 'half_duplex' | 'full_duplex';
+
+    /**
+     * The dynamic variables in force for this session, or null when none were
+     * supplied.
+     */
+    dynamic_variables: { [key: string]: string } | null;
+
+    /**
+     * Whether the bot leaves when the Assistant's conversation ends or fails.
+     */
+    leave_on_end: boolean;
   }
 
   /**
@@ -381,6 +390,11 @@ export namespace MeetingSession {
      */
     barge_in: boolean;
 
+    /**
+     * The message posted to chat on join, or null when unset.
+     */
+    chat_on_enter: string | null;
+
     /**
      * Text spoken on meeting entry, or null if not set.
      */
@@ -424,7 +438,7 @@ export namespace MeetingSessionDeleteRecordingMediaResponse {
      */
     meeting_session_id: string;
 
-    provider: 'recall';
+    provider: 'telnyx';
 
     scope: 'provider_recording_media';
   }
@@ -453,8 +467,7 @@ export interface MeetingSessionRetrieveRecordingsResponse {
 export namespace MeetingSessionRetrieveRecordingsResponse {
   export interface Data {
     /**
-     * Expiry timestamp when supplied by the provider, or null. The current adapter
-     * returns null.
+     * Expiry timestamp when available, or null. Currently returns null.
      */
     expires_at: string | null;
 
@@ -520,10 +533,10 @@ export interface MeetingSessionCreateParams {
   meeting_url: string;
 
   /**
-   * Request options for attaching a voice assistant to the session. Routing fields
-   * (`call_control_connection_id`, `from`, and `loopback_sip_uri`) are used only to
-   * establish the assistant call leg and are omitted from response objects.
-   * `audio_gate` is returned with `id` in the assistant response object.
+   * Attach a Telnyx AI Assistant to the session. Supply the Assistant's ID; the
+   * Meeting service connects it to the meeting directly. The Call Control
+   * connection, caller ID and loopback SIP URI previously required here have been
+   * removed and are now rejected as unknown fields.
    */
   assistant?: MeetingSessionCreateParams.Assistant;
 
@@ -556,6 +569,15 @@ export interface MeetingSessionCreateParams {
     | MeetingSessionCreateParams.MeetingSessionCameraImageBase64Source
     | MeetingSessionCreateParams.MeetingSessionCameraImageURLSource;
 
+  /**
+   * A message the bot posts to the meeting's chat as soon as it becomes active —
+   * typically a recording disclosure. Delivered at most once. Independent of
+   * `speak_on_enter`: both may be set, and the chat message posts first because it
+   * does not wait for text-to-speech or avatar startup. Rejected with 422
+   * `unsupported_capability` on platforms without meeting chat.
+   */
+  chat_on_enter?: string;
+
   /**
    * Client-supplied idempotency key to safely retry creation requests without
    * duplicating sessions. Lookup is scoped to the authenticated account and compares
@@ -576,7 +598,10 @@ export interface MeetingSessionCreateParams {
   metadata?: { [key: string]: unknown };
 
   /**
-   * Text the bot speaks when it enters the meeting.
+   * Text the bot speaks when it enters the meeting. **Not spoken when an `assistant`
+   * is attached**: the value is accepted and echoed back on the session, but the
+   * assistant owns the voice and the line is never delivered, with no event
+   * reporting the omission. Use `chat_on_enter` to announce an assistant-backed bot.
    */
   speak_on_enter?: string;
 
@@ -602,10 +627,10 @@ export interface MeetingSessionCreateParams {
 
 export namespace MeetingSessionCreateParams {
   /**
-   * Request options for attaching a voice assistant to the session. Routing fields
-   * (`call_control_connection_id`, `from`, and `loopback_sip_uri`) are used only to
-   * establish the assistant call leg and are omitted from response objects.
-   * `audio_gate` is returned with `id` in the assistant response object.
+   * Attach a Telnyx AI Assistant to the session. Supply the Assistant's ID; the
+   * Meeting service connects it to the meeting directly. The Call Control
+   * connection, caller ID and loopback SIP URI previously required here have been
+   * removed and are now rejected as unknown fields.
    */
   export interface Assistant {
     /**
@@ -614,24 +639,37 @@ export namespace MeetingSessionCreateParams {
     id: string;
 
     /**
-     * Call control connection used to bridge the assistant into the meeting audio.
-     */
-    call_control_connection_id: string;
-
-    /**
-     * E.164 calling number used as the originating party for the assistant call leg.
+     * Audio gating strategy for the assistant call leg. `half_duplex` (default) sends
+     * the assistant a single mixed meeting stream and mutes it while the assistant
+     * speaks, so the assistant cannot hear itself and cannot be interrupted.
+     * `full_duplex` sends a separate stream per participant, which allows barge-in and
+     * removes self-hearing, and COSTS SIGNIFICANTLY MORE: per-participant streams
+     * multiply the per-minute cost by the number of participants.
      */
-    from: string;
+    audio_gate?: 'half_duplex' | 'full_duplex';
 
     /**
-     * SIP URI to which the assistant media loopback is established.
+     * Per-conversation values for the
+     * [dynamic variables](/docs/inference/ai-assistants/dynamic-variables) used in the
+     * Assistant's instructions, greeting, or tools. Delivered before the Assistant's
+     * first utterance, so they resolve for the opening line as well as the rest of the
+     * conversation. At most 63 entries; keys 1-128 characters; values must be strings.
+     * The map is budgeted in aggregate at 1,047,552 bytes (1023 KiB) rather than
+     * capped per value. `streaming_audio`, `ai_assistant_streaming_audio` and
+     * `meeting_session_id` are reserved and rejected with `400 invalid_request` --
+     * they toggle provider infrastructure or are set by the service rather than fill a
+     * prompt template.
      */
-    loopback_sip_uri: string;
+    dynamic_variables?: { [key: string]: string };
 
     /**
-     * Audio gating strategy for the assistant call leg.
+     * Leave the meeting when the Assistant's conversation reaches a terminal state --
+     * `ended` **or** `failed`. Off by default, which leaves the bot in the meeting
+     * after the Assistant stops. Fires once: a second terminal transition does not
+     * leave twice, and a leave the provider refuses is logged without changing how the
+     * session settles.
      */
-    audio_gate?: 'none' | 'half_duplex';
+    leave_on_end?: boolean;
   }
 
   /**

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

@@ -353,12 +353,23 @@ export interface NumbersPhoneNumberDetailed {
   inbound_call_screening?: 'disabled' | 'reject_calls' | 'flag_calls';
 
   /**
-   * Identifies the messaging profile associated with the phone number.
+   * Identifies the messaging campaign associated with the phone number's messaging
+   * profile. If the messaging profile details could not be retrieved, this value is
+   * the string `UNAVAILABLE`.
+   */
+  messaging_campaign_id?: string | null;
+
+  /**
+   * Identifies the messaging profile associated with the phone number. If the
+   * messaging profile details could not be retrieved, this value is the string
+   * `UNAVAILABLE`.
    */
   messaging_profile_id?: string | null;
 
   /**
-   * The name of the messaging profile associated with the phone number.
+   * The name of the messaging profile associated with the phone number. If the
+   * messaging profile details could not be retrieved, this value is the string
+   * `UNAVAILABLE`.
    */
   messaging_profile_name?: string | null;
 

package/src/resources/porting-orders/phone-number-blocks.ts

@@ -130,7 +130,15 @@ export interface PortingPhoneNumberBlock {
   /**
    * Specifies the phone number type for this porting phone number block.
    */
-  phone_number_type?: 'landline' | 'local' | 'mobile' | 'national' | 'shared_cost' | 'toll_free';
+  phone_number_type?:
+    | 'landline'
+    | 'local'
+    | 'mobile'
+    | 'multipurpose'
+    | 'national'
+    | 'other'
+    | 'shared_cost'
+    | 'toll_free';
 
   /**
    * Identifies the type of the resource.

package/src/resources/porting-orders/porting-orders.ts

@@ -417,7 +417,15 @@ export interface PortingOrder {
   /**
    * The type of the phone number
    */
-  phone_number_type?: 'landline' | 'local' | 'mobile' | 'national' | 'shared_cost' | 'toll_free';
+  phone_number_type?:
+    | 'landline'
+    | 'local'
+    | 'mobile'
+    | 'multipurpose'
+    | 'national'
+    | 'other'
+    | 'shared_cost'
+    | 'toll_free';
 
   /**
    * List of phone numbers associated with this porting order

package/src/resources/porting-phone-numbers.ts

@@ -56,7 +56,15 @@ export interface PortingPhoneNumber {
   /**
    * The type of the phone number
    */
-  phone_number_type?: 'landline' | 'local' | 'mobile' | 'national' | 'shared_cost' | 'toll_free';
+  phone_number_type?:
+    | 'landline'
+    | 'local'
+    | 'mobile'
+    | 'multipurpose'
+    | 'national'
+    | 'other'
+    | 'shared_cost'
+    | 'toll_free';
 
   /**
    * Specifies whether Telnyx is able to confirm portability this number in the

package/src/resources/private-wireless-gateways.ts

@@ -16,7 +16,7 @@ export class PrivateWirelessGateways extends APIResource {
    * @example
    * ```ts
    * // Automatically fetches more pages as needed.
-   * for await (const privateWirelessGateway of client.privateWirelessGateways.list()) {
+   * for await (const wirelessPrivateWirelessGateway of client.privateWirelessGateways.list()) {
    *   // ...
    * }
    * ```
@@ -24,10 +24,10 @@ export class PrivateWirelessGateways extends APIResource {
   list(
     query: PrivateWirelessGatewayListParams | null | undefined = {},
     options?: RequestOptions,
-  ): PagePromise<PrivateWirelessGatewaysDefaultFlatPagination, PrivateWirelessGateway> {
+  ): PagePromise<WirelessPrivateWirelessGatewaysDefaultFlatPagination, WirelessPrivateWirelessGateway> {
     return this._client.getAPIList(
       '/private_wireless_gateways',
-      DefaultFlatPagination<PrivateWirelessGateway>,
+      DefaultFlatPagination<WirelessPrivateWirelessGateway>,
       { query, ...options },
     );
   }
@@ -84,7 +84,8 @@ export class PrivateWirelessGateways extends APIResource {
   }
 }
 
-export type PrivateWirelessGatewaysDefaultFlatPagination = DefaultFlatPagination<PrivateWirelessGateway>;
+export type WirelessPrivateWirelessGatewaysDefaultFlatPagination =
+  DefaultFlatPagination<WirelessPrivateWirelessGateway>;
 
 export interface PrivateWirelessGateway {
   /**
@@ -180,16 +181,73 @@ export interface PwgAssignedResourcesSummary {
   record_type?: string;
 }
 
+export interface WirelessPrivateWirelessGateway {
+  /**
+   * Identifies the resource.
+   */
+  id?: string;
+
+  /**
+   * The address mode of the private wireless gateway. With static, each SIM card
+   * gets a fixed IP address from the gateway's IP range that is preserved across
+   * sessions. With dynamic, IP addresses are assigned by the network at attach time
+   * and may change between sessions.
+   */
+  address_mode?: 'static' | 'dynamic';
+
+  /**
+   * A list of the resources that have been assigned to the Private Wireless Gateway.
+   */
+  assigned_resources?: Array<PwgAssignedResourcesSummary>;
+
+  /**
+   * ISO 8601 formatted date-time indicating when the resource was created.
+   */
+  created_at?: string;
+
+  /**
+   * IP block used to assign IPs to the SIM cards in the Private Wireless Gateway.
+   */
+  ip_range?: string;
+
+  /**
+   * The private wireless gateway name.
+   */
+  name?: string;
+
+  /**
+   * The identification of the related network resource.
+   */
+  network_id?: string;
+
+  record_type?: string;
+
+  /**
+   * The name of the region where the Private Wireless Gateway is deployed.
+   */
+  region_code?: string;
+
+  /**
+   * The current status or failure details of the Private Wireless Gateway.
+   */
+  status?: PrivateWirelessGatewayStatus;
+
+  /**
+   * ISO 8601 formatted date-time indicating when the resource was updated.
+   */
+  updated_at?: string;
+}
+
 export interface PrivateWirelessGatewayCreateResponse {
-  data?: PrivateWirelessGateway;
+  data?: WirelessPrivateWirelessGateway;
 }
 
 export interface PrivateWirelessGatewayRetrieveResponse {
-  data?: PrivateWirelessGateway;
+  data?: WirelessPrivateWirelessGateway;
 }
 
 export interface PrivateWirelessGatewayDeleteResponse {
-  data?: PrivateWirelessGateway;
+  data?: WirelessPrivateWirelessGateway;
 }
 
 export interface PrivateWirelessGatewayListParams extends DefaultFlatPaginationParams {
@@ -230,6 +288,15 @@ export interface PrivateWirelessGatewayCreateParams {
    */
   network_id: string;
 
+  /**
+   * Determines how IP addresses are assigned to SIM cards using this gateway. With
+   * static, each SIM card gets a fixed IP address from the gateway's IP range that
+   * is preserved across sessions. With dynamic, an IP address is assigned by the
+   * network at attach time and may change between sessions. If omitted, the gateway
+   * is created with the default address mode, dynamic.
+   */
+  address_mode?: 'static' | 'dynamic';
+
   /**
    * The code of the region where the private wireless gateway will be assigned. A
    * list of available regions can be found at the regions endpoint
@@ -242,10 +309,11 @@ export declare namespace PrivateWirelessGateways {
     type PrivateWirelessGateway as PrivateWirelessGateway,
     type PrivateWirelessGatewayStatus as PrivateWirelessGatewayStatus,
     type PwgAssignedResourcesSummary as PwgAssignedResourcesSummary,
+    type WirelessPrivateWirelessGateway as WirelessPrivateWirelessGateway,
     type PrivateWirelessGatewayCreateResponse as PrivateWirelessGatewayCreateResponse,
     type PrivateWirelessGatewayRetrieveResponse as PrivateWirelessGatewayRetrieveResponse,
     type PrivateWirelessGatewayDeleteResponse as PrivateWirelessGatewayDeleteResponse,
-    type PrivateWirelessGatewaysDefaultFlatPagination as PrivateWirelessGatewaysDefaultFlatPagination,
+    type WirelessPrivateWirelessGatewaysDefaultFlatPagination as WirelessPrivateWirelessGatewaysDefaultFlatPagination,
     type PrivateWirelessGatewayListParams as PrivateWirelessGatewayListParams,
     type PrivateWirelessGatewayCreateParams as PrivateWirelessGatewayCreateParams,
   };

package/src/resources/requirements.ts

@@ -97,7 +97,7 @@ export interface DocReqsRequirement {
    * Indicates the phone_number_type this requirement applies to. Leave blank if this
    * requirement applies to all number_types.
    */
-  phone_number_type?: 'local' | 'national' | 'toll_free';
+  phone_number_type?: 'local' | 'mobile' | 'multipurpose' | 'national' | 'shared_cost' | 'toll_free';
 
   /**
    * Identifies the type of the resource.
@@ -173,7 +173,7 @@ export namespace RequirementListParams {
     /**
      * Filters results to those applying to a specific phone_number_type
      */
-    phone_number_type?: 'local' | 'national' | 'toll_free';
+    phone_number_type?: 'local' | 'mobile' | 'multipurpose' | 'national' | 'shared_cost' | 'toll_free';
   }
 }