telnyx 7.22.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

@@ -100,6 +100,18 @@ export {
   type BillingGroupUpdateParams,
   type BillingGroupsDefaultFlatPagination,
 } from './billing-groups';
+export {
+  BotChallenge,
+  type BotChallengeCreateResponse,
+  type BotChallengeCreateParams,
+} from './bot-challenge';
+export { BotSessions, type BotSessionListResponse, type BotSessionListParams } from './bot-sessions';
+export {
+  BotSignup,
+  type SuccessResponse,
+  type BotSignupCreateParams,
+  type BotSignupResendMagicLinkParams,
+} from './bot-signup';
 export {
   BulkSimCardActions,
   type BulkSimCardActionDetailed,
@@ -208,6 +220,7 @@ export {
   type Connection,
   type ConnectionRetrieveResponse,
   type ConnectionListActiveCallsResponse,
+  type ConnectionRetrieveCountResponse,
   type ConnectionListParams,
   type ConnectionListActiveCallsParams,
   type ConnectionsDefaultFlatPagination,
@@ -355,6 +368,7 @@ export {
   type EmailDomainVerification,
   type EmailDomainRetrieveDNSRecordsResponse,
   type EmailDomainRetrieveHealthResponse,
+  type EmailDomainRotateDkimResponse,
   type EmailDomainListParams,
   type EmailDomainCreateParams,
   type EmailDomainDeleteParams,
@@ -364,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,
@@ -383,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 {
@@ -648,6 +663,11 @@ export {
 } from './ledger-billing-group-reports';
 export { Legacy } from './legacy/legacy';
 export { List, type ListRetrieveAllResponse, type ListRetrieveByZoneResponse } from './list';
+export {
+  MachinePayments,
+  type MachinePaymentAccountCreditResponse,
+  type MachinePaymentAccountCreditParams,
+} from './machine-payments';
 export {
   ManagedAccounts,
   type ManagedAccount,
@@ -859,6 +879,10 @@ export {
   type NetworksDefaultFlatPagination,
   type NetworkListInterfacesResponsesDefaultFlatPagination,
 } from './networks/networks';
+export {
+  NoiseSuppressionEngines,
+  type NoiseSuppressionEngineListResponse,
+} from './noise-suppression-engines';
 export {
   NotificationChannels,
   type NotificationChannel,
@@ -1107,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,
@@ -1621,6 +1646,7 @@ export {
   type FaxSendingStarted,
   type InboundMessage,
   type InboundSipHeader,
+  type MessagingInboundMessage,
   type NumberOrderStatusUpdate,
   type OutboundMessage,
   type ReplacedLinkClick,

package/src/resources/machine-payments.ts

@@ -0,0 +1,169 @@
+// 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';
+
+/**
+ * Machine payment (MPP) account-credit operations. Fund your Telnyx account programmatically from a machine or agent using the Machine Payment Protocol, an HTTP-402 flow settled via Stripe or Tempo.
+ */
+export class MachinePayments extends APIResource {
+  /**
+   * Creates an account credit using the Machine Payment Protocol (MPP), an HTTP-402
+   * payment flow for machines and agents.
+   *
+   * The flow has two steps. First, send an authenticated request with the
+   * `amount_usd` to credit; the response is `402 Payment Required` with one or more
+   * payment challenges (for example separate Tempo and Stripe challenges) in the
+   * `WWW-Authenticate` header. Second, retry the request with an
+   * `Authorization: Payment ...` credential constructed from the challenge; on
+   * success the response includes the credited transaction and a `Payment-Receipt`
+   * header.
+   *
+   * The credited account is never chosen by the request body: the initial request
+   * credits the account of the authenticated user, and a paid retry credits the
+   * account bound to the verified payment credential. The amount must be within the
+   * configured bounds (by default between 5.00 and 500.00 USD).
+   *
+   * Successful paid retries are idempotent — when Rails reaches its
+   * duplicate-transaction lookup for an already-recorded payment, it returns the
+   * existing transaction with `created: false` instead of crediting the account
+   * again. This deduplication applies to successful fulfillment: re-sending the same
+   * Stripe credential may instead be rejected by the upstream provider as an
+   * idempotent replay and return `402 Payment Required` rather than the existing
+   * transaction.
+   *
+   * > **Warning: the payment credential is bound to a specific Telnyx account ID.**
+   * > A payment is captured before the bound account is validated. If the credential
+   * > names an account that is missing, suspended, blocked, cancelled, dormant, or
+   * > ineligible for the tier, the payment is captured but **no account is
+   * > credited**. If the credential names a different but eligible account, that
+   * > account is credited — the service does not compare it against the payer's
+   * > account. There is **no automatic refund**: if the captured payment does not
+   * > credit the intended account, contact Telnyx support for remediation.
+   *
+   * @example
+   * ```ts
+   * const response = await client.machinePayments.accountCredit(
+   *   { amount_usd: '10.00' },
+   * );
+   * ```
+   */
+  accountCredit(
+    body: MachinePaymentAccountCreditParams,
+    options?: RequestOptions,
+  ): APIPromise<MachinePaymentAccountCreditResponse> {
+    return this._client.post('/machine-payments/account-credit', { body, ...options });
+  }
+}
+
+export interface MachinePaymentAccountCreditResponse {
+  /**
+   * An account-credit transaction settled through the Machine Payment Protocol.
+   */
+  data?: MachinePaymentAccountCreditResponse.Data;
+}
+
+export namespace MachinePaymentAccountCreditResponse {
+  /**
+   * An account-credit transaction settled through the Machine Payment Protocol.
+   */
+  export interface Data {
+    /**
+     * Unique identifier of the account-credit transaction.
+     */
+    id: string;
+
+    /**
+     * Identifier of the credited Telnyx account. Derived from the authenticated user
+     * on the initial request and from the verified payment credential on a paid retry
+     * — never from the request body.
+     */
+    account_id: string;
+
+    /**
+     * Credited amount as a decimal string with two fractional digits.
+     */
+    amount: string;
+
+    /**
+     * ISO 4217 currency code of the credited amount (currently always USD).
+     */
+    currency: string;
+
+    /**
+     * Payment source identifier distinguishing machine payments from other
+     * account-credit sources.
+     */
+    payment_source: 'machine_payment';
+
+    /**
+     * Record type identifier.
+     */
+    record_type: 'machine_payment_account_credit';
+
+    /**
+     * True when this response created a new account credit, false when an existing
+     * transaction was returned for a duplicate paid retry.
+     */
+    created?: boolean;
+
+    /**
+     * ISO 8601 timestamp when the transaction was created.
+     */
+    created_at?: string;
+
+    /**
+     * Machine Payment Protocol resource identifier the payment credential was bound
+     * to.
+     */
+    mpp_resource?: string | null;
+
+    /**
+     * Stripe PaymentIntent identifier for Stripe settlements. Absent for Tempo
+     * settlements.
+     */
+    payment_intent_id?: string | null;
+
+    /**
+     * Payment method used by the provider: `stripe_spt` for Stripe Shared Payment
+     * Token payments, `tempo_usdc` for Tempo USDC payments.
+     */
+    payment_method?: 'stripe_spt' | 'tempo_usdc' | null;
+
+    /**
+     * Upstream payment provider that settled the payment.
+     */
+    provider?: 'stripe' | 'tempo' | null;
+
+    /**
+     * Provider receipt reference: the Stripe PaymentIntent identifier for Stripe
+     * settlements, or the on-chain transaction hash for Tempo settlements.
+     */
+    receipt_reference?: string | null;
+
+    /**
+     * Status of the transaction. Successful machine payment credits are recorded as
+     * `settled`.
+     */
+    status?: 'new' | 'processing' | 'settled' | 'expired' | 'invalid' | null;
+  }
+}
+
+export interface MachinePaymentAccountCreditParams {
+  /**
+   * Amount to credit in USD, as a decimal string with up to two fractional digits
+   * (by default between 5.00 and 500.00). The request body is required on the
+   * initial challenge request and remains required on a paid retry, where you
+   * re-send the identical body plus the payment credential — the credential, not the
+   * body, selects the payment, and the retried body is not re-validated.
+   */
+  amount_usd: string;
+}
+
+export declare namespace MachinePayments {
+  export {
+    type MachinePaymentAccountCreditResponse as MachinePaymentAccountCreditResponse,
+    type MachinePaymentAccountCreditParams as MachinePaymentAccountCreditParams,
+  };
+}

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 {