telnyx 7.23.0 → 7.24.0

package/src/resources/email-templates.ts

@@ -139,6 +139,12 @@ export class EmailTemplates extends APIResource {
    * Renders a template using the provided Liquid variables. Missing
    * `template_variables` defaults to `{}`.
    *
+   * When the template has `strict_variables` enabled and a required variable (per
+   * `variable_schema`) is missing, returns 422 naming the variable. When the
+   * template has `autoescape` enabled, the rendered `html_body` expression output is
+   * HTML-escaped at the output boundary; `subject` and `text_body` are not
+   * autoescaped.
+   *
    * @example
    * ```ts
    * const response = await client.emailTemplates.render(
@@ -161,6 +167,13 @@ export type EmailTemplatesEmailCursorPagination = EmailCursorPagination<EmailTem
 export interface EmailTemplate {
   id: string;
 
+  /**
+   * Whether HTML autoescaping is enabled for this template. When `true`, only
+   * rendered `html_body` expression output is HTML-escaped at the output boundary;
+   * `subject` and `text_body` are never autoescaped.
+   */
+  autoescape: boolean;
+
   created_at: string;
 
   html_body: string | null;
@@ -169,20 +182,56 @@ export interface EmailTemplate {
 
   record_type: 'email_template';
 
+  /**
+   * Whether strict variable validation is enabled for this template. When `true`,
+   * sends and renders that are missing a variable marked `required: true` in
+   * `variable_schema` fail with 422 naming the variable.
+   */
+  strict_variables: boolean;
+
   subject: string | null;
 
   text_body: string | null;
 
   updated_at: string;
 
+  /**
+   * Structured variable requirements, or `null` when the template uses only the
+   * legacy `variables` array.
+   */
+  variable_schema: { [key: string]: EmailTemplate.VariableSchema } | null;
+
+  /**
+   * Legacy unstructured variable names. This path remains supported unchanged.
+   */
   variables: Array<string>;
 }
 
+export namespace EmailTemplate {
+  export interface VariableSchema {
+    /**
+     * Whether the variable must be supplied when strict variable validation is
+     * enabled.
+     */
+    required: boolean;
+
+    /**
+     * Default value for an optional variable. Rejected when `required` is `true`.
+     */
+    default?: string;
+  }
+}
+
 export interface EmailTemplateResponse {
   data: EmailTemplate;
 }
 
 export interface UpdateEmailTemplateRequest {
+  /**
+   * Per-template HTML autoescaping setting.
+   */
+  autoescape?: boolean;
+
   /**
    * Liquid template HTML body.
    */
@@ -190,6 +239,11 @@ export interface UpdateEmailTemplateRequest {
 
   name?: string;
 
+  /**
+   * Per-template strict variable-validation setting.
+   */
+  strict_variables?: boolean;
+
   /**
    * Liquid template subject.
    */
@@ -200,9 +254,30 @@ export interface UpdateEmailTemplateRequest {
    */
   text_body?: string | null;
 
+  /**
+   * Structured variable requirements. Required variables cannot define defaults;
+   * invalid combinations return 422. Set to `null` to clear the schema.
+   */
+  variable_schema?: { [key: string]: UpdateEmailTemplateRequest.VariableSchema } | null;
+
   variables?: Array<string>;
 }
 
+export namespace UpdateEmailTemplateRequest {
+  export interface VariableSchema {
+    /**
+     * Whether the variable must be supplied when strict variable validation is
+     * enabled.
+     */
+    required: boolean;
+
+    /**
+     * Default value for an optional variable. Rejected when `required` is `true`.
+     */
+    default?: string;
+  }
+}
+
 export interface EmailTemplateRenderResponse {
   /**
    * Template object with `subject`, `html_body`, and `text_body` replaced by their
@@ -229,11 +304,33 @@ export interface EmailTemplateCreateParams {
    */
   name: string;
 
+  /**
+   * Body param: Per-template HTML autoescaping setting. Defaults to `false` for
+   * backward compatibility. When `true`, the rendered `html_body` HTML-escapes each
+   * Liquid expression's output at the output boundary (after its filters run, before
+   * concatenation with literal template markup). Input values are never mutated and
+   * `subject`/`text_body` are never autoescaped. The boundary escape is idempotent:
+   * HTML entities already present in the output (e.g. from an explicit `escape`
+   * filter) are preserved, so an explicit `escape`/`escape_once` is never
+   * double-escaped, and markup introduced by any later filter in the chain is still
+   * escaped.
+   */
+  autoescape?: boolean;
+
   /**
    * Body param: Liquid template HTML body.
    */
   html_body?: string | null;
 
+  /**
+   * Body param: Per-template strict variable-validation setting. Defaults to `false`
+   * for backward compatibility. When `true`, a send or render that is missing a
+   * variable marked `required: true` in `variable_schema` fails with 422 naming the
+   * variable. Missing optional variables never fail; their schema `default` (when
+   * set) is applied to the render.
+   */
+  strict_variables?: boolean;
+
   /**
    * Body param: Liquid template subject.
    */
@@ -244,6 +341,17 @@ export interface EmailTemplateCreateParams {
    */
   text_body?: string | null;
 
+  /**
+   * Body param: Structured variable requirements. Required variables cannot define
+   * defaults; invalid combinations return 422. This is independent of the legacy
+   * `variables` array. On render with `strict_variables` enabled: `required`
+   * variables must be supplied as non-empty values — absent, `null`, empty string,
+   * empty object `{}`, and empty array `[]` all fail with 422 naming the variable,
+   * while present values such as `false` and `0` pass (they are present, not empty).
+   * Optional variables fall back to their `default` when absent.
+   */
+  variable_schema?: { [key: string]: EmailTemplateCreateParams.VariableSchema } | null;
+
   /**
    * Body param: Template variables. Auto-extracted from subject/body fields when
    * absent.
@@ -263,7 +371,27 @@ export interface EmailTemplateCreateParams {
   'Idempotency-Key'?: string;
 }
 
+export namespace EmailTemplateCreateParams {
+  export interface VariableSchema {
+    /**
+     * Whether the variable must be supplied when strict variable validation is
+     * enabled.
+     */
+    required: boolean;
+
+    /**
+     * Default value for an optional variable. Rejected when `required` is `true`.
+     */
+    default?: string;
+  }
+}
+
 export interface EmailTemplateReplaceParams {
+  /**
+   * Per-template HTML autoescaping setting.
+   */
+  autoescape?: boolean;
+
   /**
    * Liquid template HTML body.
    */
@@ -271,6 +399,11 @@ export interface EmailTemplateReplaceParams {
 
   name?: string;
 
+  /**
+   * Per-template strict variable-validation setting.
+   */
+  strict_variables?: boolean;
+
   /**
    * Liquid template subject.
    */
@@ -281,10 +414,36 @@ export interface EmailTemplateReplaceParams {
    */
   text_body?: string | null;
 
+  /**
+   * Structured variable requirements. Required variables cannot define defaults;
+   * invalid combinations return 422. Set to `null` to clear the schema.
+   */
+  variable_schema?: { [key: string]: EmailTemplateReplaceParams.VariableSchema } | null;
+
   variables?: Array<string>;
 }
 
+export namespace EmailTemplateReplaceParams {
+  export interface VariableSchema {
+    /**
+     * Whether the variable must be supplied when strict variable validation is
+     * enabled.
+     */
+    required: boolean;
+
+    /**
+     * Default value for an optional variable. Rejected when `required` is `true`.
+     */
+    default?: string;
+  }
+}
+
 export interface EmailTemplateUpdateParams {
+  /**
+   * Per-template HTML autoescaping setting.
+   */
+  autoescape?: boolean;
+
   /**
    * Liquid template HTML body.
    */
@@ -292,6 +451,11 @@ export interface EmailTemplateUpdateParams {
 
   name?: string;
 
+  /**
+   * Per-template strict variable-validation setting.
+   */
+  strict_variables?: boolean;
+
   /**
    * Liquid template subject.
    */
@@ -302,9 +466,30 @@ export interface EmailTemplateUpdateParams {
    */
   text_body?: string | null;
 
+  /**
+   * Structured variable requirements. Required variables cannot define defaults;
+   * invalid combinations return 422. Set to `null` to clear the schema.
+   */
+  variable_schema?: { [key: string]: EmailTemplateUpdateParams.VariableSchema } | null;
+
   variables?: Array<string>;
 }
 
+export namespace EmailTemplateUpdateParams {
+  export interface VariableSchema {
+    /**
+     * Whether the variable must be supplied when strict variable validation is
+     * enabled.
+     */
+    required: boolean;
+
+    /**
+     * Default value for an optional variable. Rejected when `required` is `true`.
+     */
+    default?: string;
+  }
+}
+
 export interface EmailTemplateRenderParams {
   /**
    * Variables for Liquid template rendering. Non-object values are silently treated

package/src/resources/index.ts

@@ -368,6 +368,7 @@ export {
   type EmailDomainVerification,
   type EmailDomainRetrieveDNSRecordsResponse,
   type EmailDomainRetrieveHealthResponse,
+  type EmailDomainRotateDkimResponse,
   type EmailDomainListParams,
   type EmailDomainCreateParams,
   type EmailDomainDeleteParams,
@@ -377,12 +378,12 @@ export {
 export {
   EmailEvents,
   type EmailEventType,
+  type EmailWebhookRecipient,
   type TimeRange,
   type EmailEventListResponse,
   type EmailEventRetrieveStatsResponse,
   type EmailEventListParams,
   type EmailEventRetrieveStatsParams,
-  type EmailEventListResponsesEmailCursorPagination,
 } from './email-events';
 export {
   EmailInboxes,
@@ -396,16 +397,17 @@ export {
   EmailMessages,
   type AttachmentRequest,
   type EmailAddressInput,
+  type EmailMessageDetailResponse,
   type MessageEvent,
   type SuppressedRecipient,
   type TrackingSettings,
-  type EmailMessageRetrieveResponse,
   type EmailMessageBatchResponse,
   type EmailMessageDeleteAllParams,
   type EmailMessageListParams,
   type EmailMessageCreateParams,
   type EmailMessageBatchParams,
   type EmailMessageRetrieveEventsParams,
+  type EmailMessageUpdateScheduleParams,
   type MessageEventsEmailCursorPagination,
 } from './email-messages/email-messages';
 export {
@@ -1129,12 +1131,13 @@ export {
   type PrivateWirelessGateway,
   type PrivateWirelessGatewayStatus,
   type PwgAssignedResourcesSummary,
+  type WirelessPrivateWirelessGateway,
   type PrivateWirelessGatewayCreateResponse,
   type PrivateWirelessGatewayRetrieveResponse,
   type PrivateWirelessGatewayDeleteResponse,
   type PrivateWirelessGatewayListParams,
   type PrivateWirelessGatewayCreateParams,
-  type PrivateWirelessGatewaysDefaultFlatPagination,
+  type WirelessPrivateWirelessGatewaysDefaultFlatPagination,
 } from './private-wireless-gateways';
 export {
   PronunciationDicts,

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

@@ -30,7 +30,13 @@ export class Actions extends APIResource {
   }
 
   /**
-   * Sends audio / text-to-speech into a meeting session.
+   * Sends audio / text-to-speech into a meeting session. With a Telnyx AI Assistant
+   * (or avatar) attached, the bot is a webpage-output bot: the speak audio routes
+   * through the assistant's output page rather than the bot mic and plays once the
+   * assistant is connected -- it is not refused. If that page cannot be reached,
+   * delivery fails with the 502 below, which may arrive without an error envelope,
+   * so branch on the status code before parsing a body. The assistant is designed to
+   * own the conversation, so prefer letting it speak or use `send_chat`.
    *
    * @example
    * ```ts

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,8 +139,6 @@ 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
@@ -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.
      */
@@ -520,10 +534,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 +570,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 +599,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 +628,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 +640,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;