@sentdm/sentdm 0.3.5

package/resources/templates.d.mts

@@ -0,0 +1,333 @@
+import { APIResource } from "../core/resource.mjs";
+import * as TemplatesAPI from "./templates.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare class Templates extends APIResource {
+    /**
+     * Creates a new message template for the authenticated customer with comprehensive
+     * template definitions including headers, body, footer, and interactive buttons.
+     * Supports automatic metadata generation using AI (display name, language,
+     * category). Optionally submits the template for WhatsApp review. The customer ID
+     * is extracted from the authentication token.
+     *
+     * @example
+     * ```ts
+     * const templateResponse = await client.templates.create({
+     *   definition: { body: {} },
+     * });
+     * ```
+     */
+    create(body: TemplateCreateParams, options?: RequestOptions): APIPromise<TemplateResponse>;
+    /**
+     * Retrieves a specific message template by its unique identifier for the
+     * authenticated customer with comprehensive template definitions including
+     * headers, body, footer, and interactive buttons. The customer ID is extracted
+     * from the authentication token.
+     *
+     * @example
+     * ```ts
+     * const templateResponse = await client.templates.retrieve(
+     *   '7ba7b820-9dad-11d1-80b4-00c04fd430c8',
+     * );
+     * ```
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<TemplateResponse>;
+    /**
+     * Retrieves all message templates available for the authenticated customer with
+     * comprehensive template definitions including headers, body, footer, and
+     * interactive buttons. Supports advanced filtering by search term, status, and
+     * category, plus pagination. The customer ID is extracted from the authentication
+     * token.
+     *
+     * @example
+     * ```ts
+     * const templates = await client.templates.list({
+     *   page: 0,
+     *   pageSize: 0,
+     * });
+     * ```
+     */
+    list(query: TemplateListParams, options?: RequestOptions): APIPromise<TemplateListResponse>;
+    /**
+     * Deletes a specific message template by its unique identifier for the
+     * authenticated customer with smart deletion strategy. Deletion behavior: - If
+     * template has NO messages: Permanently deleted from database (hard delete). - If
+     * template has messages: Marked as deleted but preserved for message history (soft
+     * delete with snapshot). The template must exist and belong to the authenticated
+     * customer to be deleted successfully. The customer ID is extracted from the
+     * authentication token.
+     *
+     * @example
+     * ```ts
+     * await client.templates.delete(
+     *   '7ba7b820-9dad-11d1-80b4-00c04fd430c8',
+     * );
+     * ```
+     */
+    delete(id: string, options?: RequestOptions): APIPromise<void>;
+}
+export interface TemplateBodyContent {
+    template?: string;
+    type?: string | null;
+    variables?: Array<TemplateVariable> | null;
+}
+/**
+ * Complete definition of a message template including header, body, footer, and
+ * buttons
+ */
+export interface TemplateDefinition {
+    /**
+     * Required template body with content for different channels (multi-channel,
+     * SMS-specific, or WhatsApp-specific)
+     */
+    body: TemplateDefinition.Body;
+    /**
+     * Configuration specific to AUTHENTICATION category templates (optional)
+     */
+    authenticationConfig?: TemplateDefinition.AuthenticationConfig | null;
+    /**
+     * Optional list of interactive buttons (e.g., quick replies, URLs, phone numbers)
+     */
+    buttons?: Array<TemplateDefinition.Button> | null;
+    /**
+     * The version of the template definition format
+     */
+    definitionVersion?: string | null;
+    /**
+     * Optional template footer with optional variables
+     */
+    footer?: TemplateDefinition.Footer | null;
+    /**
+     * Optional template header with optional variables
+     */
+    header?: TemplateDefinition.Header | null;
+}
+export declare namespace TemplateDefinition {
+    /**
+     * Required template body with content for different channels (multi-channel,
+     * SMS-specific, or WhatsApp-specific)
+     */
+    interface Body {
+        /**
+         * Content that will be used for all channels (SMS and WhatsApp) unless
+         * channel-specific content is provided
+         */
+        multiChannel?: TemplatesAPI.TemplateBodyContent | null;
+        /**
+         * SMS-specific content that overrides multi-channel content for SMS messages
+         */
+        sms?: TemplatesAPI.TemplateBodyContent | null;
+        /**
+         * WhatsApp-specific content that overrides multi-channel content for WhatsApp
+         * messages
+         */
+        whatsapp?: TemplatesAPI.TemplateBodyContent | null;
+    }
+    /**
+     * Configuration specific to AUTHENTICATION category templates (optional)
+     */
+    interface AuthenticationConfig {
+        /**
+         * Whether to add the security recommendation text: "For your security, do not
+         * share this code."
+         */
+        addSecurityRecommendation?: boolean;
+        /**
+         * Code expiration time in minutes (1-90). If set, adds footer: "This code expires
+         * in X minutes."
+         */
+        codeExpirationMinutes?: number | null;
+    }
+    /**
+     * Interactive button in a message template
+     */
+    interface Button {
+        /**
+         * The unique identifier of the button (1-based index)
+         */
+        id?: number;
+        /**
+         * Properties specific to the button type
+         */
+        props?: Button.Props;
+        /**
+         * The type of button (e.g., QUICK_REPLY, URL, PHONE_NUMBER, VOICE_CALL, COPY_CODE)
+         */
+        type?: string;
+    }
+    namespace Button {
+        /**
+         * Properties specific to the button type
+         */
+        interface Props {
+            activeFor?: number | null;
+            autofillText?: string | null;
+            countryCode?: string | null;
+            offerCode?: string | null;
+            otpType?: string | null;
+            packageName?: string | null;
+            phoneNumber?: string | null;
+            quickReplyType?: string | null;
+            signatureHash?: string | null;
+            text?: string | null;
+            url?: string | null;
+            urlType?: string | null;
+        }
+    }
+    /**
+     * Optional template footer with optional variables
+     */
+    interface Footer {
+        /**
+         * The footer template text with optional variable placeholders
+         */
+        template?: string;
+        /**
+         * The type of footer (typically "text")
+         */
+        type?: string | null;
+        /**
+         * List of variables used in the footer template
+         */
+        variables?: Array<TemplatesAPI.TemplateVariable> | null;
+    }
+    /**
+     * Optional template header with optional variables
+     */
+    interface Header {
+        /**
+         * The header template text with optional variable placeholders (e.g., "Welcome to
+         * {{0:variable}}")
+         */
+        template?: string;
+        /**
+         * The type of header (e.g., "text", "image", "video", "document")
+         */
+        type?: string | null;
+        /**
+         * List of variables used in the header template
+         */
+        variables?: Array<TemplatesAPI.TemplateVariable> | null;
+    }
+}
+/**
+ * Represents a message template with comprehensive metadata including definition
+ * structure
+ */
+export interface TemplateResponse {
+    /**
+     * The unique identifier of the template
+     */
+    id?: string;
+    /**
+     * The template category (e.g., MARKETING, UTILITY, AUTHENTICATION)
+     */
+    category?: string;
+    /**
+     * The date and time when the template was created
+     */
+    createdAt?: string;
+    /**
+     * The complete template definition including header, body, footer, and buttons
+     */
+    definition?: TemplateDefinition;
+    /**
+     * The display name of the template (auto-generated if not provided)
+     */
+    displayName?: string;
+    /**
+     * Indicates whether the template is published and available for use
+     */
+    isPublished?: boolean;
+    /**
+     * The template language code (e.g., en_US, es_ES)
+     */
+    language?: string;
+    /**
+     * The approval status of the template (e.g., APPROVED, PENDING, REJECTED, DRAFT)
+     */
+    status?: string;
+    /**
+     * The date and time when the template was last updated
+     */
+    updatedAt?: string | null;
+    /**
+     * The WhatsApp Business API template ID from Meta
+     */
+    whatsappTemplateId?: string;
+    /**
+     * The WhatsApp template name as registered with Meta
+     */
+    whatsappTemplateName?: string;
+}
+export interface TemplateVariable {
+    id?: number;
+    name?: string;
+    props?: TemplateVariable.Props;
+    type?: string;
+}
+export declare namespace TemplateVariable {
+    interface Props {
+        alt?: string | null;
+        mediaType?: string | null;
+        sample?: string | null;
+        shortUrl?: string | null;
+        url?: string | null;
+        variableType?: string | null;
+    }
+}
+export interface TemplateListResponse {
+    items?: Array<TemplateResponse>;
+    page?: number;
+    pageSize?: number;
+    totalCount?: number;
+    totalPages?: number;
+}
+export interface TemplateCreateParams {
+    /**
+     * Template definition containing header, body, footer, and buttons
+     */
+    definition: TemplateDefinition;
+    /**
+     * The template category (e.g., MARKETING, UTILITY, AUTHENTICATION). Can only be
+     * set when creating a new template. If not provided, will be auto-generated using
+     * AI.
+     */
+    category?: string | null;
+    /**
+     * The template language code (e.g., en_US, es_ES). Can only be set when creating a
+     * new template. If not provided, will be auto-detected using AI.
+     */
+    language?: string | null;
+    /**
+     * When false, the template will be saved as draft. When true, the template will be
+     * submitted for review.
+     */
+    submitForReview?: boolean;
+}
+export interface TemplateListParams {
+    /**
+     * The page number (zero-indexed). Default is 0.
+     */
+    page: number;
+    /**
+     * The number of items per page (1-1000). Default is 100.
+     */
+    pageSize: number;
+    /**
+     * Optional filter by template category (e.g., MARKETING, UTILITY, AUTHENTICATION)
+     */
+    category?: string | null;
+    /**
+     * Optional search term to filter templates by name or content
+     */
+    search?: string | null;
+    /**
+     * Optional filter by template status (e.g., APPROVED, PENDING, REJECTED, DRAFT)
+     */
+    status?: string | null;
+}
+export declare namespace Templates {
+    export { type TemplateBodyContent as TemplateBodyContent, type TemplateDefinition as TemplateDefinition, type TemplateResponse as TemplateResponse, type TemplateVariable as TemplateVariable, type TemplateListResponse as TemplateListResponse, type TemplateCreateParams as TemplateCreateParams, type TemplateListParams as TemplateListParams, };
+}
+//# sourceMappingURL=templates.d.mts.map

package/resources/templates.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"templates.d.mts","sourceRoot":"","sources":["../src/resources/templates.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,YAAY;OACjB,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,gBAAgB,CAAC;IAI1F;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,gBAAgB,CAAC;IAI5E;;;;;;;;;;;;;;OAcG;IACH,IAAI,CAAC,KAAK,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;IAI3F;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAM/D;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB,SAAS,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC;CAC5C;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,IAAI,EAAE,kBAAkB,CAAC,IAAI,CAAC;IAE9B;;OAEG;IACH,oBAAoB,CAAC,EAAE,kBAAkB,CAAC,oBAAoB,GAAG,IAAI,CAAC;IAEtE;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAElD;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,MAAM,CAAC,EAAE,kBAAkB,CAAC,MAAM,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,MAAM,CAAC,EAAE,kBAAkB,CAAC,MAAM,GAAG,IAAI,CAAC;CAC3C;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;;OAGG;IACH,UAAiB,IAAI;QACnB;;;WAGG;QACH,YAAY,CAAC,EAAE,YAAY,CAAC,mBAAmB,GAAG,IAAI,CAAC;QAEvD;;WAEG;QACH,GAAG,CAAC,EAAE,YAAY,CAAC,mBAAmB,GAAG,IAAI,CAAC;QAE9C;;;WAGG;QACH,QAAQ,CAAC,EAAE,YAAY,CAAC,mBAAmB,GAAG,IAAI,CAAC;KACpD;IAED;;OAEG;IACH,UAAiB,oBAAoB;QACnC;;;WAGG;QACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;QAEpC;;;WAGG;QACH,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACvC;IAED;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC;QAErB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,MAAM,CAAC;QACtB;;WAEG;QACH,UAAiB,KAAK;YACpB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE1B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE7B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE1B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAExB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE/B,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE9B,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAErB,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEpB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACzB;KACF;IAED;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,SAAS,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC;KACzD;IAED;;OAEG;IACH,UAAiB,MAAM;QACrB;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,SAAS,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC;KACzD;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,CAAC,EAAE,kBAAkB,CAAC;IAEhC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,MAAM,WAAW,gBAAgB;IAC/B,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,KAAK,CAAC,EAAE,gBAAgB,CAAC,KAAK,CAAC;IAE/B,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,yBAAiB,gBAAgB,CAAC;IAChC,UAAiB,KAAK;QACpB,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC9B;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC,KAAK,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;IAEhC,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,UAAU,EAAE,kBAAkB,CAAC;IAE/B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}

package/resources/templates.d.ts

@@ -0,0 +1,333 @@
+import { APIResource } from "../core/resource.js";
+import * as TemplatesAPI from "./templates.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare class Templates extends APIResource {
+    /**
+     * Creates a new message template for the authenticated customer with comprehensive
+     * template definitions including headers, body, footer, and interactive buttons.
+     * Supports automatic metadata generation using AI (display name, language,
+     * category). Optionally submits the template for WhatsApp review. The customer ID
+     * is extracted from the authentication token.
+     *
+     * @example
+     * ```ts
+     * const templateResponse = await client.templates.create({
+     *   definition: { body: {} },
+     * });
+     * ```
+     */
+    create(body: TemplateCreateParams, options?: RequestOptions): APIPromise<TemplateResponse>;
+    /**
+     * Retrieves a specific message template by its unique identifier for the
+     * authenticated customer with comprehensive template definitions including
+     * headers, body, footer, and interactive buttons. The customer ID is extracted
+     * from the authentication token.
+     *
+     * @example
+     * ```ts
+     * const templateResponse = await client.templates.retrieve(
+     *   '7ba7b820-9dad-11d1-80b4-00c04fd430c8',
+     * );
+     * ```
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<TemplateResponse>;
+    /**
+     * Retrieves all message templates available for the authenticated customer with
+     * comprehensive template definitions including headers, body, footer, and
+     * interactive buttons. Supports advanced filtering by search term, status, and
+     * category, plus pagination. The customer ID is extracted from the authentication
+     * token.
+     *
+     * @example
+     * ```ts
+     * const templates = await client.templates.list({
+     *   page: 0,
+     *   pageSize: 0,
+     * });
+     * ```
+     */
+    list(query: TemplateListParams, options?: RequestOptions): APIPromise<TemplateListResponse>;
+    /**
+     * Deletes a specific message template by its unique identifier for the
+     * authenticated customer with smart deletion strategy. Deletion behavior: - If
+     * template has NO messages: Permanently deleted from database (hard delete). - If
+     * template has messages: Marked as deleted but preserved for message history (soft
+     * delete with snapshot). The template must exist and belong to the authenticated
+     * customer to be deleted successfully. The customer ID is extracted from the
+     * authentication token.
+     *
+     * @example
+     * ```ts
+     * await client.templates.delete(
+     *   '7ba7b820-9dad-11d1-80b4-00c04fd430c8',
+     * );
+     * ```
+     */
+    delete(id: string, options?: RequestOptions): APIPromise<void>;
+}
+export interface TemplateBodyContent {
+    template?: string;
+    type?: string | null;
+    variables?: Array<TemplateVariable> | null;
+}
+/**
+ * Complete definition of a message template including header, body, footer, and
+ * buttons
+ */
+export interface TemplateDefinition {
+    /**
+     * Required template body with content for different channels (multi-channel,
+     * SMS-specific, or WhatsApp-specific)
+     */
+    body: TemplateDefinition.Body;
+    /**
+     * Configuration specific to AUTHENTICATION category templates (optional)
+     */
+    authenticationConfig?: TemplateDefinition.AuthenticationConfig | null;
+    /**
+     * Optional list of interactive buttons (e.g., quick replies, URLs, phone numbers)
+     */
+    buttons?: Array<TemplateDefinition.Button> | null;
+    /**
+     * The version of the template definition format
+     */
+    definitionVersion?: string | null;
+    /**
+     * Optional template footer with optional variables
+     */
+    footer?: TemplateDefinition.Footer | null;
+    /**
+     * Optional template header with optional variables
+     */
+    header?: TemplateDefinition.Header | null;
+}
+export declare namespace TemplateDefinition {
+    /**
+     * Required template body with content for different channels (multi-channel,
+     * SMS-specific, or WhatsApp-specific)
+     */
+    interface Body {
+        /**
+         * Content that will be used for all channels (SMS and WhatsApp) unless
+         * channel-specific content is provided
+         */
+        multiChannel?: TemplatesAPI.TemplateBodyContent | null;
+        /**
+         * SMS-specific content that overrides multi-channel content for SMS messages
+         */
+        sms?: TemplatesAPI.TemplateBodyContent | null;
+        /**
+         * WhatsApp-specific content that overrides multi-channel content for WhatsApp
+         * messages
+         */
+        whatsapp?: TemplatesAPI.TemplateBodyContent | null;
+    }
+    /**
+     * Configuration specific to AUTHENTICATION category templates (optional)
+     */
+    interface AuthenticationConfig {
+        /**
+         * Whether to add the security recommendation text: "For your security, do not
+         * share this code."
+         */
+        addSecurityRecommendation?: boolean;
+        /**
+         * Code expiration time in minutes (1-90). If set, adds footer: "This code expires
+         * in X minutes."
+         */
+        codeExpirationMinutes?: number | null;
+    }
+    /**
+     * Interactive button in a message template
+     */
+    interface Button {
+        /**
+         * The unique identifier of the button (1-based index)
+         */
+        id?: number;
+        /**
+         * Properties specific to the button type
+         */
+        props?: Button.Props;
+        /**
+         * The type of button (e.g., QUICK_REPLY, URL, PHONE_NUMBER, VOICE_CALL, COPY_CODE)
+         */
+        type?: string;
+    }
+    namespace Button {
+        /**
+         * Properties specific to the button type
+         */
+        interface Props {
+            activeFor?: number | null;
+            autofillText?: string | null;
+            countryCode?: string | null;
+            offerCode?: string | null;
+            otpType?: string | null;
+            packageName?: string | null;
+            phoneNumber?: string | null;
+            quickReplyType?: string | null;
+            signatureHash?: string | null;
+            text?: string | null;
+            url?: string | null;
+            urlType?: string | null;
+        }
+    }
+    /**
+     * Optional template footer with optional variables
+     */
+    interface Footer {
+        /**
+         * The footer template text with optional variable placeholders
+         */
+        template?: string;
+        /**
+         * The type of footer (typically "text")
+         */
+        type?: string | null;
+        /**
+         * List of variables used in the footer template
+         */
+        variables?: Array<TemplatesAPI.TemplateVariable> | null;
+    }
+    /**
+     * Optional template header with optional variables
+     */
+    interface Header {
+        /**
+         * The header template text with optional variable placeholders (e.g., "Welcome to
+         * {{0:variable}}")
+         */
+        template?: string;
+        /**
+         * The type of header (e.g., "text", "image", "video", "document")
+         */
+        type?: string | null;
+        /**
+         * List of variables used in the header template
+         */
+        variables?: Array<TemplatesAPI.TemplateVariable> | null;
+    }
+}
+/**
+ * Represents a message template with comprehensive metadata including definition
+ * structure
+ */
+export interface TemplateResponse {
+    /**
+     * The unique identifier of the template
+     */
+    id?: string;
+    /**
+     * The template category (e.g., MARKETING, UTILITY, AUTHENTICATION)
+     */
+    category?: string;
+    /**
+     * The date and time when the template was created
+     */
+    createdAt?: string;
+    /**
+     * The complete template definition including header, body, footer, and buttons
+     */
+    definition?: TemplateDefinition;
+    /**
+     * The display name of the template (auto-generated if not provided)
+     */
+    displayName?: string;
+    /**
+     * Indicates whether the template is published and available for use
+     */
+    isPublished?: boolean;
+    /**
+     * The template language code (e.g., en_US, es_ES)
+     */
+    language?: string;
+    /**
+     * The approval status of the template (e.g., APPROVED, PENDING, REJECTED, DRAFT)
+     */
+    status?: string;
+    /**
+     * The date and time when the template was last updated
+     */
+    updatedAt?: string | null;
+    /**
+     * The WhatsApp Business API template ID from Meta
+     */
+    whatsappTemplateId?: string;
+    /**
+     * The WhatsApp template name as registered with Meta
+     */
+    whatsappTemplateName?: string;
+}
+export interface TemplateVariable {
+    id?: number;
+    name?: string;
+    props?: TemplateVariable.Props;
+    type?: string;
+}
+export declare namespace TemplateVariable {
+    interface Props {
+        alt?: string | null;
+        mediaType?: string | null;
+        sample?: string | null;
+        shortUrl?: string | null;
+        url?: string | null;
+        variableType?: string | null;
+    }
+}
+export interface TemplateListResponse {
+    items?: Array<TemplateResponse>;
+    page?: number;
+    pageSize?: number;
+    totalCount?: number;
+    totalPages?: number;
+}
+export interface TemplateCreateParams {
+    /**
+     * Template definition containing header, body, footer, and buttons
+     */
+    definition: TemplateDefinition;
+    /**
+     * The template category (e.g., MARKETING, UTILITY, AUTHENTICATION). Can only be
+     * set when creating a new template. If not provided, will be auto-generated using
+     * AI.
+     */
+    category?: string | null;
+    /**
+     * The template language code (e.g., en_US, es_ES). Can only be set when creating a
+     * new template. If not provided, will be auto-detected using AI.
+     */
+    language?: string | null;
+    /**
+     * When false, the template will be saved as draft. When true, the template will be
+     * submitted for review.
+     */
+    submitForReview?: boolean;
+}
+export interface TemplateListParams {
+    /**
+     * The page number (zero-indexed). Default is 0.
+     */
+    page: number;
+    /**
+     * The number of items per page (1-1000). Default is 100.
+     */
+    pageSize: number;
+    /**
+     * Optional filter by template category (e.g., MARKETING, UTILITY, AUTHENTICATION)
+     */
+    category?: string | null;
+    /**
+     * Optional search term to filter templates by name or content
+     */
+    search?: string | null;
+    /**
+     * Optional filter by template status (e.g., APPROVED, PENDING, REJECTED, DRAFT)
+     */
+    status?: string | null;
+}
+export declare namespace Templates {
+    export { type TemplateBodyContent as TemplateBodyContent, type TemplateDefinition as TemplateDefinition, type TemplateResponse as TemplateResponse, type TemplateVariable as TemplateVariable, type TemplateListResponse as TemplateListResponse, type TemplateCreateParams as TemplateCreateParams, type TemplateListParams as TemplateListParams, };
+}
+//# sourceMappingURL=templates.d.ts.map

package/resources/templates.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"templates.d.ts","sourceRoot":"","sources":["../src/resources/templates.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,YAAY;OACjB,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,gBAAgB,CAAC;IAI1F;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,gBAAgB,CAAC;IAI5E;;;;;;;;;;;;;;OAcG;IACH,IAAI,CAAC,KAAK,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;IAI3F;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAM/D;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB,SAAS,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC;CAC5C;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,IAAI,EAAE,kBAAkB,CAAC,IAAI,CAAC;IAE9B;;OAEG;IACH,oBAAoB,CAAC,EAAE,kBAAkB,CAAC,oBAAoB,GAAG,IAAI,CAAC;IAEtE;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAElD;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,MAAM,CAAC,EAAE,kBAAkB,CAAC,MAAM,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,MAAM,CAAC,EAAE,kBAAkB,CAAC,MAAM,GAAG,IAAI,CAAC;CAC3C;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;;OAGG;IACH,UAAiB,IAAI;QACnB;;;WAGG;QACH,YAAY,CAAC,EAAE,YAAY,CAAC,mBAAmB,GAAG,IAAI,CAAC;QAEvD;;WAEG;QACH,GAAG,CAAC,EAAE,YAAY,CAAC,mBAAmB,GAAG,IAAI,CAAC;QAE9C;;;WAGG;QACH,QAAQ,CAAC,EAAE,YAAY,CAAC,mBAAmB,GAAG,IAAI,CAAC;KACpD;IAED;;OAEG;IACH,UAAiB,oBAAoB;QACnC;;;WAGG;QACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;QAEpC;;;WAGG;QACH,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACvC;IAED;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC;QAErB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,MAAM,CAAC;QACtB;;WAEG;QACH,UAAiB,KAAK;YACpB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE1B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE7B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE1B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAExB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE/B,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE9B,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAErB,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEpB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACzB;KACF;IAED;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,SAAS,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC;KACzD;IAED;;OAEG;IACH,UAAiB,MAAM;QACrB;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,SAAS,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC;KACzD;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,CAAC,EAAE,kBAAkB,CAAC;IAEhC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,MAAM,WAAW,gBAAgB;IAC/B,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,KAAK,CAAC,EAAE,gBAAgB,CAAC,KAAK,CAAC;IAE/B,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,yBAAiB,gBAAgB,CAAC;IAChC,UAAiB,KAAK;QACpB,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC9B;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC,KAAK,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;IAEhC,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,UAAU,EAAE,kBAAkB,CAAC;IAE/B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}