telnyx 7.12.0 → 7.13.0

package/resources/email-messages/recipients.js

@@ -0,0 +1,48 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Recipients = void 0;
+const resource_1 = require("../../core/resource.js");
+const path_1 = require("../../internal/utils/path.js");
+/**
+ * Send and manage email messages. Legacy `/v2/emails` routes are aliases for these endpoints.
+ */
+class Recipients extends resource_1.APIResource {
+    /**
+     * Lists per-recipient delivery states for a single message with cursor pagination.
+     * Each recipient has an independent status, billable flag, and lifecycle
+     * timestamps. BCC recipient addresses are redacted (returned as null) to protect
+     * BCC privacy. Default page size is 25, maximum is 100.
+     *
+     * @example
+     * ```ts
+     * const recipients =
+     *   await client.emailMessages.recipients.list(
+     *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   );
+     * ```
+     */
+    list(emailID, query = {}, options) {
+        return this._client.get((0, path_1.path) `/email_messages/${emailID}/recipients`, { query, ...options });
+    }
+    /**
+     * Returns the current delivery state of a single recipient, including status,
+     * billable flag, SMTP detail, and lifecycle timestamps. BCC recipient addresses
+     * are redacted (returned as null).
+     *
+     * @example
+     * ```ts
+     * const recipient =
+     *   await client.emailMessages.recipients.retrieve(
+     *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *     { email_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
+     *   );
+     * ```
+     */
+    retrieve(recipientID, params, options) {
+        const { email_id } = params;
+        return this._client.get((0, path_1.path) `/email_messages/${email_id}/recipients/${recipientID}`, options);
+    }
+}
+exports.Recipients = Recipients;
+//# sourceMappingURL=recipients.js.map

package/resources/email-messages/recipients.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"recipients.js","sourceRoot":"","sources":["../../src/resources/email-messages/recipients.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAGlD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,UAAW,SAAQ,sBAAW;IACzC;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,OAAe,EACf,QAAgD,EAAE,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,mBAAmB,OAAO,aAAa,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,QAAQ,CACN,WAAmB,EACnB,MAA+B,EAC/B,OAAwB;QAExB,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;QAC5B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,mBAAmB,QAAQ,eAAe,WAAW,EAAE,EAAE,OAAO,CAAC,CAAC;IAChG,CAAC;CACF;AA7CD,gCA6CC"}

package/resources/email-messages/recipients.mjs

@@ -0,0 +1,44 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+import { path } from "../../internal/utils/path.mjs";
+/**
+ * Send and manage email messages. Legacy `/v2/emails` routes are aliases for these endpoints.
+ */
+export class Recipients extends APIResource {
+    /**
+     * Lists per-recipient delivery states for a single message with cursor pagination.
+     * Each recipient has an independent status, billable flag, and lifecycle
+     * timestamps. BCC recipient addresses are redacted (returned as null) to protect
+     * BCC privacy. Default page size is 25, maximum is 100.
+     *
+     * @example
+     * ```ts
+     * const recipients =
+     *   await client.emailMessages.recipients.list(
+     *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   );
+     * ```
+     */
+    list(emailID, query = {}, options) {
+        return this._client.get(path `/email_messages/${emailID}/recipients`, { query, ...options });
+    }
+    /**
+     * Returns the current delivery state of a single recipient, including status,
+     * billable flag, SMTP detail, and lifecycle timestamps. BCC recipient addresses
+     * are redacted (returned as null).
+     *
+     * @example
+     * ```ts
+     * const recipient =
+     *   await client.emailMessages.recipients.retrieve(
+     *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *     { email_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
+     *   );
+     * ```
+     */
+    retrieve(recipientID, params, options) {
+        const { email_id } = params;
+        return this._client.get(path `/email_messages/${email_id}/recipients/${recipientID}`, options);
+    }
+}
+//# sourceMappingURL=recipients.mjs.map

package/resources/email-messages/recipients.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"recipients.mjs","sourceRoot":"","sources":["../../src/resources/email-messages/recipients.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAGlD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,OAAe,EACf,QAAgD,EAAE,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,mBAAmB,OAAO,aAAa,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,QAAQ,CACN,WAAmB,EACnB,MAA+B,EAC/B,OAAwB;QAExB,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;QAC5B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,mBAAmB,QAAQ,eAAe,WAAW,EAAE,EAAE,OAAO,CAAC,CAAC;IAChG,CAAC;CACF"}

package/resources/email-messages.d.mts

@@ -0,0 +1,2 @@
+export * from "./email-messages/index.mjs";
+//# sourceMappingURL=email-messages.d.mts.map

package/resources/email-messages.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"email-messages.d.mts","sourceRoot":"","sources":["../src/resources/email-messages.ts"],"names":[],"mappings":"AAEA,2CAAuC"}

package/resources/email-messages.d.ts

@@ -0,0 +1,2 @@
+export * from "./email-messages/index.js";
+//# sourceMappingURL=email-messages.d.ts.map

package/resources/email-messages.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"email-messages.d.ts","sourceRoot":"","sources":["../src/resources/email-messages.ts"],"names":[],"mappings":"AAEA,0CAAuC"}

package/resources/email-messages.js

@@ -0,0 +1,6 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("../internal/tslib.js");
+tslib_1.__exportStar(require("./email-messages/index.js"), exports);
+//# sourceMappingURL=email-messages.js.map

package/resources/email-messages.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"email-messages.js","sourceRoot":"","sources":["../src/resources/email-messages.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,oEAAuC"}

package/resources/email-messages.mjs

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export * from "./email-messages/index.mjs";
+//# sourceMappingURL=email-messages.mjs.map

package/resources/email-messages.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"email-messages.mjs","sourceRoot":"","sources":["../src/resources/email-messages.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,2CAAuC"}

package/resources/email-templates.d.mts

@@ -0,0 +1,236 @@
+import { APIResource } from "../core/resource.mjs";
+import * as EmailTemplatesAPI from "./email-templates.mjs";
+import * as ThreadsAPI from "./email-inboxes/threads/threads.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+/**
+ * Create, list, retrieve, update, delete, and render Liquid email templates.
+ */
+export declare class EmailTemplates extends APIResource {
+    /**
+     * Lists templates sorted newest first by `created_at desc, id desc`.
+     *
+     * @example
+     * ```ts
+     * const emailTemplates = await client.emailTemplates.list();
+     * ```
+     */
+    list(query?: EmailTemplateListParams | null | undefined, options?: RequestOptions): APIPromise<EmailTemplateListResponse>;
+    /**
+     * Creates a Liquid email template. Variables are auto-extracted when omitted.
+     *
+     * @example
+     * ```ts
+     * const emailTemplateResponse =
+     *   await client.emailTemplates.create({
+     *     name: 'Welcome Email',
+     *     html_body: '<h1>Hello {{ first_name }}</h1>',
+     *     subject: 'Welcome, {{ first_name }}!',
+     *     text_body: 'Hello {{ first_name }}',
+     *   });
+     * ```
+     */
+    create(params: EmailTemplateCreateParams, options?: RequestOptions): APIPromise<EmailTemplateResponse>;
+    /**
+     * Delete an email template
+     *
+     * @example
+     * ```ts
+     * await client.emailTemplates.delete(
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     * );
+     * ```
+     */
+    delete(id: string, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Get an email template
+     *
+     * @example
+     * ```ts
+     * const emailTemplateResponse =
+     *   await client.emailTemplates.retrieve(
+     *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   );
+     * ```
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<EmailTemplateResponse>;
+    /**
+     * Replaces template fields. Behaves identically to PATCH; provided for
+     * compatibility with Phoenix resource routes.
+     *
+     * @example
+     * ```ts
+     * const emailTemplateResponse =
+     *   await client.emailTemplates.replace(
+     *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   );
+     * ```
+     */
+    replace(id: string, body: EmailTemplateReplaceParams, options?: RequestOptions): APIPromise<EmailTemplateResponse>;
+    /**
+     * Updates one or more template fields.
+     *
+     * @example
+     * ```ts
+     * const emailTemplateResponse =
+     *   await client.emailTemplates.update(
+     *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   );
+     * ```
+     */
+    update(id: string, body: EmailTemplateUpdateParams, options?: RequestOptions): APIPromise<EmailTemplateResponse>;
+    /**
+     * Renders a template using the provided Liquid variables. Missing
+     * `template_variables` defaults to `{}`.
+     *
+     * @example
+     * ```ts
+     * const response = await client.emailTemplates.render(
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   { template_variables: { first_name: 'Ada' } },
+     * );
+     * ```
+     */
+    render(id: string, body?: EmailTemplateRenderParams | null | undefined, options?: RequestOptions): APIPromise<EmailTemplateRenderResponse>;
+}
+export interface EmailTemplate {
+    id: string;
+    created_at: string;
+    html_body: string | null;
+    name: string;
+    record_type: 'email_template';
+    subject: string | null;
+    text_body: string | null;
+    updated_at: string;
+    variables: Array<string>;
+}
+export interface EmailTemplateResponse {
+    data: EmailTemplate;
+}
+export interface UpdateEmailTemplateRequest {
+    /**
+     * Liquid template HTML body.
+     */
+    html_body?: string | null;
+    name?: string;
+    /**
+     * Liquid template subject.
+     */
+    subject?: string | null;
+    /**
+     * Liquid template text body.
+     */
+    text_body?: string | null;
+    variables?: Array<string>;
+}
+export interface EmailTemplateListResponse {
+    data: Array<EmailTemplate>;
+    meta: ThreadsAPI.EmailPaginationMeta;
+}
+export interface EmailTemplateRenderResponse {
+    /**
+     * Template object with `subject`, `html_body`, and `text_body` replaced by their
+     * Liquid-rendered values. All other template fields (id, name, variables, etc.)
+     * remain unchanged.
+     */
+    data: EmailTemplateRenderResponse.Data;
+}
+export declare namespace EmailTemplateRenderResponse {
+    /**
+     * Template object with `subject`, `html_body`, and `text_body` replaced by their
+     * Liquid-rendered values. All other template fields (id, name, variables, etc.)
+     * remain unchanged.
+     */
+    interface Data extends EmailTemplatesAPI.EmailTemplate {
+    }
+}
+export interface EmailTemplateListParams {
+    /**
+     * Opaque URL-safe Base64 cursor returned by a previous list response.
+     */
+    page_cursor?: string;
+    /**
+     * Number of results to return. Defaults to 25; maximum is 100. Invalid values are
+     * clamped to the valid range.
+     */
+    page_size?: number;
+}
+export interface EmailTemplateCreateParams {
+    /**
+     * Body param: Letters, numbers, spaces, hyphens, and underscores only.
+     */
+    name: string;
+    /**
+     * Body param: Liquid template HTML body.
+     */
+    html_body?: string | null;
+    /**
+     * Body param: Liquid template subject.
+     */
+    subject?: string | null;
+    /**
+     * Body param: Liquid template text body.
+     */
+    text_body?: string | null;
+    /**
+     * Body param: Template variables. Auto-extracted from subject/body fields when
+     * absent.
+     */
+    variables?: Array<string>;
+    /**
+     * Header param: Optional opaque, unquoted key for safely retrying the same logical
+     * request. Keys must contain 1 to 255 letters, numbers, hyphens, or underscores.
+     * Generate a unique UUID v4 for each operation and reuse it only when retrying
+     * that operation with the same request. Invalid headers—including duplicate,
+     * empty, malformed, or overlong values—return 400 with error code 10015. A request
+     * already in progress with the same key returns 409; reusing the key with a
+     * different request returns 422. Only successful responses are replayed, for up to
+     * 24 hours. Do not include sensitive data in the key.
+     */
+    'Idempotency-Key'?: string;
+}
+export interface EmailTemplateReplaceParams {
+    /**
+     * Liquid template HTML body.
+     */
+    html_body?: string | null;
+    name?: string;
+    /**
+     * Liquid template subject.
+     */
+    subject?: string | null;
+    /**
+     * Liquid template text body.
+     */
+    text_body?: string | null;
+    variables?: Array<string>;
+}
+export interface EmailTemplateUpdateParams {
+    /**
+     * Liquid template HTML body.
+     */
+    html_body?: string | null;
+    name?: string;
+    /**
+     * Liquid template subject.
+     */
+    subject?: string | null;
+    /**
+     * Liquid template text body.
+     */
+    text_body?: string | null;
+    variables?: Array<string>;
+}
+export interface EmailTemplateRenderParams {
+    /**
+     * Variables for Liquid template rendering. Non-object values are silently treated
+     * as an empty object.
+     */
+    template_variables?: {
+        [key: string]: unknown;
+    };
+}
+export declare namespace EmailTemplates {
+    export { type EmailTemplate as EmailTemplate, type EmailTemplateResponse as EmailTemplateResponse, type UpdateEmailTemplateRequest as UpdateEmailTemplateRequest, type EmailTemplateListResponse as EmailTemplateListResponse, type EmailTemplateRenderResponse as EmailTemplateRenderResponse, type EmailTemplateListParams as EmailTemplateListParams, type EmailTemplateCreateParams as EmailTemplateCreateParams, type EmailTemplateReplaceParams as EmailTemplateReplaceParams, type EmailTemplateUpdateParams as EmailTemplateUpdateParams, type EmailTemplateRenderParams as EmailTemplateRenderParams, };
+}
+//# sourceMappingURL=email-templates.d.mts.map

package/resources/email-templates.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"email-templates.d.mts","sourceRoot":"","sources":["../src/resources/email-templates.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,KAAK,iBAAiB,8BAA0B;AACvD,OAAO,KAAK,UAAU,4CAAwC;AAC9D,OAAO,EAAE,UAAU,EAAE,gCAA4B;AAEjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D;;GAEG;AACH,qBAAa,cAAe,SAAQ,WAAW;IAC7C;;;;;;;OAOG;IACH,IAAI,CACF,KAAK,GAAE,uBAAuB,GAAG,IAAI,GAAG,SAAc,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAIxC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,MAAM,EAAE,yBAAyB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAYtG;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAO9D;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAIjF;;;;;;;;;;;OAWG;IACH,OAAO,CACL,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,0BAA0B,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;IAIpC;;;;;;;;;;OAUG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,yBAAyB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;IAIpC;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,yBAAyB,GAAG,IAAI,GAAG,SAAc,EACvD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;CAG3C;AAED,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IAEX,UAAU,EAAE,MAAM,CAAC;IAEnB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,IAAI,EAAE,MAAM,CAAC;IAEb,WAAW,EAAE,gBAAgB,CAAC;IAE9B,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,UAAU,EAAE,MAAM,CAAC;IAEnB,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC1B;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,aAAa,CAAC;CACrB;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC3B;AAED,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IAE3B,IAAI,EAAE,UAAU,CAAC,mBAAmB,CAAC;CACtC;AAED,MAAM,WAAW,2BAA2B;IAC1C;;;;OAIG;IACH,IAAI,EAAE,2BAA2B,CAAC,IAAI,CAAC;CACxC;AAED,yBAAiB,2BAA2B,CAAC;IAC3C;;;;OAIG;IACH,UAAiB,IAAK,SAAQ,iBAAiB,CAAC,aAAa;KAAG;CACjE;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE1B;;;;;;;;;OASG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC3B;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC3B;AAED,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,kBAAkB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACjD;AAED,MAAM,CAAC,OAAO,WAAW,cAAc,CAAC;IACtC,OAAO,EACL,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}

package/resources/email-templates.d.ts

@@ -0,0 +1,236 @@
+import { APIResource } from "../core/resource.js";
+import * as EmailTemplatesAPI from "./email-templates.js";
+import * as ThreadsAPI from "./email-inboxes/threads/threads.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+/**
+ * Create, list, retrieve, update, delete, and render Liquid email templates.
+ */
+export declare class EmailTemplates extends APIResource {
+    /**
+     * Lists templates sorted newest first by `created_at desc, id desc`.
+     *
+     * @example
+     * ```ts
+     * const emailTemplates = await client.emailTemplates.list();
+     * ```
+     */
+    list(query?: EmailTemplateListParams | null | undefined, options?: RequestOptions): APIPromise<EmailTemplateListResponse>;
+    /**
+     * Creates a Liquid email template. Variables are auto-extracted when omitted.
+     *
+     * @example
+     * ```ts
+     * const emailTemplateResponse =
+     *   await client.emailTemplates.create({
+     *     name: 'Welcome Email',
+     *     html_body: '<h1>Hello {{ first_name }}</h1>',
+     *     subject: 'Welcome, {{ first_name }}!',
+     *     text_body: 'Hello {{ first_name }}',
+     *   });
+     * ```
+     */
+    create(params: EmailTemplateCreateParams, options?: RequestOptions): APIPromise<EmailTemplateResponse>;
+    /**
+     * Delete an email template
+     *
+     * @example
+     * ```ts
+     * await client.emailTemplates.delete(
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     * );
+     * ```
+     */
+    delete(id: string, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Get an email template
+     *
+     * @example
+     * ```ts
+     * const emailTemplateResponse =
+     *   await client.emailTemplates.retrieve(
+     *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   );
+     * ```
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<EmailTemplateResponse>;
+    /**
+     * Replaces template fields. Behaves identically to PATCH; provided for
+     * compatibility with Phoenix resource routes.
+     *
+     * @example
+     * ```ts
+     * const emailTemplateResponse =
+     *   await client.emailTemplates.replace(
+     *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   );
+     * ```
+     */
+    replace(id: string, body: EmailTemplateReplaceParams, options?: RequestOptions): APIPromise<EmailTemplateResponse>;
+    /**
+     * Updates one or more template fields.
+     *
+     * @example
+     * ```ts
+     * const emailTemplateResponse =
+     *   await client.emailTemplates.update(
+     *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   );
+     * ```
+     */
+    update(id: string, body: EmailTemplateUpdateParams, options?: RequestOptions): APIPromise<EmailTemplateResponse>;
+    /**
+     * Renders a template using the provided Liquid variables. Missing
+     * `template_variables` defaults to `{}`.
+     *
+     * @example
+     * ```ts
+     * const response = await client.emailTemplates.render(
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   { template_variables: { first_name: 'Ada' } },
+     * );
+     * ```
+     */
+    render(id: string, body?: EmailTemplateRenderParams | null | undefined, options?: RequestOptions): APIPromise<EmailTemplateRenderResponse>;
+}
+export interface EmailTemplate {
+    id: string;
+    created_at: string;
+    html_body: string | null;
+    name: string;
+    record_type: 'email_template';
+    subject: string | null;
+    text_body: string | null;
+    updated_at: string;
+    variables: Array<string>;
+}
+export interface EmailTemplateResponse {
+    data: EmailTemplate;
+}
+export interface UpdateEmailTemplateRequest {
+    /**
+     * Liquid template HTML body.
+     */
+    html_body?: string | null;
+    name?: string;
+    /**
+     * Liquid template subject.
+     */
+    subject?: string | null;
+    /**
+     * Liquid template text body.
+     */
+    text_body?: string | null;
+    variables?: Array<string>;
+}
+export interface EmailTemplateListResponse {
+    data: Array<EmailTemplate>;
+    meta: ThreadsAPI.EmailPaginationMeta;
+}
+export interface EmailTemplateRenderResponse {
+    /**
+     * Template object with `subject`, `html_body`, and `text_body` replaced by their
+     * Liquid-rendered values. All other template fields (id, name, variables, etc.)
+     * remain unchanged.
+     */
+    data: EmailTemplateRenderResponse.Data;
+}
+export declare namespace EmailTemplateRenderResponse {
+    /**
+     * Template object with `subject`, `html_body`, and `text_body` replaced by their
+     * Liquid-rendered values. All other template fields (id, name, variables, etc.)
+     * remain unchanged.
+     */
+    interface Data extends EmailTemplatesAPI.EmailTemplate {
+    }
+}
+export interface EmailTemplateListParams {
+    /**
+     * Opaque URL-safe Base64 cursor returned by a previous list response.
+     */
+    page_cursor?: string;
+    /**
+     * Number of results to return. Defaults to 25; maximum is 100. Invalid values are
+     * clamped to the valid range.
+     */
+    page_size?: number;
+}
+export interface EmailTemplateCreateParams {
+    /**
+     * Body param: Letters, numbers, spaces, hyphens, and underscores only.
+     */
+    name: string;
+    /**
+     * Body param: Liquid template HTML body.
+     */
+    html_body?: string | null;
+    /**
+     * Body param: Liquid template subject.
+     */
+    subject?: string | null;
+    /**
+     * Body param: Liquid template text body.
+     */
+    text_body?: string | null;
+    /**
+     * Body param: Template variables. Auto-extracted from subject/body fields when
+     * absent.
+     */
+    variables?: Array<string>;
+    /**
+     * Header param: Optional opaque, unquoted key for safely retrying the same logical
+     * request. Keys must contain 1 to 255 letters, numbers, hyphens, or underscores.
+     * Generate a unique UUID v4 for each operation and reuse it only when retrying
+     * that operation with the same request. Invalid headers—including duplicate,
+     * empty, malformed, or overlong values—return 400 with error code 10015. A request
+     * already in progress with the same key returns 409; reusing the key with a
+     * different request returns 422. Only successful responses are replayed, for up to
+     * 24 hours. Do not include sensitive data in the key.
+     */
+    'Idempotency-Key'?: string;
+}
+export interface EmailTemplateReplaceParams {
+    /**
+     * Liquid template HTML body.
+     */
+    html_body?: string | null;
+    name?: string;
+    /**
+     * Liquid template subject.
+     */
+    subject?: string | null;
+    /**
+     * Liquid template text body.
+     */
+    text_body?: string | null;
+    variables?: Array<string>;
+}
+export interface EmailTemplateUpdateParams {
+    /**
+     * Liquid template HTML body.
+     */
+    html_body?: string | null;
+    name?: string;
+    /**
+     * Liquid template subject.
+     */
+    subject?: string | null;
+    /**
+     * Liquid template text body.
+     */
+    text_body?: string | null;
+    variables?: Array<string>;
+}
+export interface EmailTemplateRenderParams {
+    /**
+     * Variables for Liquid template rendering. Non-object values are silently treated
+     * as an empty object.
+     */
+    template_variables?: {
+        [key: string]: unknown;
+    };
+}
+export declare namespace EmailTemplates {
+    export { type EmailTemplate as EmailTemplate, type EmailTemplateResponse as EmailTemplateResponse, type UpdateEmailTemplateRequest as UpdateEmailTemplateRequest, type EmailTemplateListResponse as EmailTemplateListResponse, type EmailTemplateRenderResponse as EmailTemplateRenderResponse, type EmailTemplateListParams as EmailTemplateListParams, type EmailTemplateCreateParams as EmailTemplateCreateParams, type EmailTemplateReplaceParams as EmailTemplateReplaceParams, type EmailTemplateUpdateParams as EmailTemplateUpdateParams, type EmailTemplateRenderParams as EmailTemplateRenderParams, };
+}
+//# sourceMappingURL=email-templates.d.ts.map

package/resources/email-templates.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"email-templates.d.ts","sourceRoot":"","sources":["../src/resources/email-templates.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,KAAK,iBAAiB,6BAA0B;AACvD,OAAO,KAAK,UAAU,2CAAwC;AAC9D,OAAO,EAAE,UAAU,EAAE,+BAA4B;AAEjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D;;GAEG;AACH,qBAAa,cAAe,SAAQ,WAAW;IAC7C;;;;;;;OAOG;IACH,IAAI,CACF,KAAK,GAAE,uBAAuB,GAAG,IAAI,GAAG,SAAc,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAIxC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,MAAM,EAAE,yBAAyB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAYtG;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAO9D;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAIjF;;;;;;;;;;;OAWG;IACH,OAAO,CACL,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,0BAA0B,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;IAIpC;;;;;;;;;;OAUG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,yBAAyB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;IAIpC;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,yBAAyB,GAAG,IAAI,GAAG,SAAc,EACvD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;CAG3C;AAED,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IAEX,UAAU,EAAE,MAAM,CAAC;IAEnB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,IAAI,EAAE,MAAM,CAAC;IAEb,WAAW,EAAE,gBAAgB,CAAC;IAE9B,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,UAAU,EAAE,MAAM,CAAC;IAEnB,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC1B;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,aAAa,CAAC;CACrB;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC3B;AAED,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IAE3B,IAAI,EAAE,UAAU,CAAC,mBAAmB,CAAC;CACtC;AAED,MAAM,WAAW,2BAA2B;IAC1C;;;;OAIG;IACH,IAAI,EAAE,2BAA2B,CAAC,IAAI,CAAC;CACxC;AAED,yBAAiB,2BAA2B,CAAC;IAC3C;;;;OAIG;IACH,UAAiB,IAAK,SAAQ,iBAAiB,CAAC,aAAa;KAAG;CACjE;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE1B;;;;;;;;;OASG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC3B;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC3B;AAED,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,kBAAkB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACjD;AAED,MAAM,CAAC,OAAO,WAAW,cAAc,CAAC;IACtC,OAAO,EACL,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}