telnyx 7.23.0 → 7.25.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/enterprises/dir.ts

@@ -176,7 +176,8 @@ export interface DirCreateParams {
   call_reasons: Array<string>;
 
   /**
-   * Must be `true`.
+   * Certification that the DIR information is accurate. Must be `true` for the DIR
+   * to be submitted for vetting.
    */
   certify_brand_is_accurate: true;
 
@@ -196,6 +197,16 @@ export interface DirCreateParams {
    */
   display_name: string;
 
+  /**
+   * Optional. Approved BPO (Business Process Outsourcer) accounts on your
+   * organization authorized to place branded calls for this DIR, each with the
+   * signed Letter of Authorization the Brand Owner granted it. Each authorization
+   * starts `pending` and takes effect only after an admin reviews its Letter of
+   * Authorization. Omit or send an empty list to authorize no BPO on this DIR.
+   * Maximum 10.
+   */
+  bpo_authorizations?: Array<DirAPI.BpoAuthorizationInput>;
+
   /**
    * Supporting documents. Each `document_id` may appear at most once on a DIR.
    */
@@ -211,6 +222,13 @@ export interface DirCreateParams {
    * (BPO/reseller).
    */
   reselling?: boolean;
+
+  /**
+   * Optional `https://` URL that receives webhook notifications when this DIR's
+   * compliance review completes (rejection outcomes include structured rejection
+   * reasons). Maximum 2048 characters.
+   */
+  webhook_url?: string | null;
 }
 
 export declare namespace Dir {