@sentdm/sentdm 0.7.2 → 0.15.0

package/resources/templates.d.ts

@@ -1,61 +1,63 @@
 import { APIResource } from "../core/resource.js";
 import * as TemplatesAPI from "./templates.js";
+import * as WebhooksAPI from "./webhooks.js";
 import { APIPromise } from "../core/api-promise.js";
 import { RequestOptions } from "../internal/request-options.js";
+/**
+ * Manage message templates with variable substitution
+ */
 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.
+     * Creates a new message template with header, body, footer, and buttons. The
+     * template can be submitted for review immediately or saved as draft for later
+     * submission.
      *
      * @example
      * ```ts
-     * const templateResponseV2 = await client.templates.create({
-     *   definition: { body: {} },
-     * });
+     * const apiResponseTemplate = await client.templates.create();
+     * ```
+     */
+    create(params: TemplateCreateParams, options?: RequestOptions): APIPromise<APIResponseTemplate>;
+    /**
+     * Retrieves a specific template by its ID. Returns template details including
+     * name, category, language, status, and definition.
+     *
+     * @example
+     * ```ts
+     * const apiResponseTemplate = await client.templates.retrieve(
+     *   '7ba7b820-9dad-11d1-80b4-00c04fd430c8',
+     * );
      * ```
      */
-    create(body: TemplateCreateParams, options?: RequestOptions): APIPromise<TemplateResponseV2>;
+    retrieve(id: string, params?: TemplateRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<APIResponseTemplate>;
     /**
-     * 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.
+     * Updates an existing template's name, category, language, definition, or submits
+     * it for review.
      *
      * @example
      * ```ts
-     * const templateResponseV2 = await client.templates.retrieve(
+     * const apiResponseTemplate = await client.templates.update(
      *   '7ba7b820-9dad-11d1-80b4-00c04fd430c8',
      * );
      * ```
      */
-    retrieve(id: string, options?: RequestOptions): APIPromise<TemplateResponseV2>;
+    update(id: string, params: TemplateUpdateParams, options?: RequestOptions): APIPromise<APIResponseTemplate>;
     /**
-     * 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.
+     * Retrieves a paginated list of message templates for the authenticated customer.
+     * Supports filtering by status, category, and search term.
      *
      * @example
      * ```ts
      * const templates = await client.templates.list({
      *   page: 0,
-     *   pageSize: 0,
+     *   page_size: 0,
      * });
      * ```
      */
-    list(query: TemplateListParams, options?: RequestOptions): APIPromise<TemplateListResponse>;
+    list(params: 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.
+     * Deletes a template by ID. Optionally, you can also delete the template from
+     * WhatsApp/Meta by setting delete_from_meta=true.
      *
      * @example
      * ```ts
@@ -64,201 +66,208 @@ export declare class Templates extends APIResource {
      * );
      * ```
      */
-    delete(id: string, options?: RequestOptions): APIPromise<void>;
+    delete(id: string, params: TemplateDeleteParams, options?: RequestOptions): APIPromise<void>;
 }
-export interface TemplateBodyContent {
-    template?: string;
-    type?: string | null;
-    variables?: Array<TemplateVariable> | null;
+/**
+ * Standard API response envelope for all v3 endpoints
+ */
+export interface APIResponseTemplate {
+    /**
+     * Template response for v3 API
+     */
+    data?: Template | null;
+    /**
+     * Error information
+     */
+    error?: WebhooksAPI.ErrorDetail | null;
+    /**
+     * Request and response metadata
+     */
+    meta?: WebhooksAPI.APIMeta;
+    /**
+     * Indicates whether the request was successful
+     */
+    success?: boolean;
 }
 /**
- * Complete definition of a message template including header, body, footer, and
- * buttons
+ * Configuration for AUTHENTICATION category templates
  */
-export interface TemplateDefinition {
+export interface SentDmServicesCommonContractsPocOsAuthenticationConfig {
     /**
-     * Required template body with content for different channels (multi-channel,
-     * SMS-specific, or WhatsApp-specific)
+     * Whether to add the security recommendation text: "For your security, do not
+     * share this code."
      */
-    body: TemplateDefinition.Body;
+    addSecurityRecommendation?: boolean;
     /**
-     * Configuration specific to AUTHENTICATION category templates (optional)
+     * Code expiration time in minutes (1-90). If set, adds footer: "This code expires
+     * in X minutes."
      */
-    authenticationConfig?: TemplateDefinition.AuthenticationConfig | null;
+    codeExpirationMinutes?: number | null;
+}
+/**
+ * Body section of a message template with channel-specific content
+ */
+export interface SentDmServicesCommonContractsPocOsTemplateBody {
     /**
-     * Optional list of interactive buttons (e.g., quick replies, URLs, phone numbers)
+     * Content that will be used for all channels (SMS and WhatsApp) unless
+     * channel-specific content is provided
      */
-    buttons?: Array<TemplateDefinition.Button> | null;
+    multiChannel?: TemplateBodyContent | null;
     /**
-     * The version of the template definition format
+     * SMS-specific content that overrides multi-channel content for SMS messages
      */
-    definitionVersion?: string | null;
+    sms?: TemplateBodyContent | null;
     /**
-     * Optional template footer with optional variables
+     * WhatsApp-specific content that overrides multi-channel content for WhatsApp
+     * messages
      */
-    footer?: TemplateDefinition.Footer | null;
+    whatsapp?: TemplateBodyContent | null;
+}
+/**
+ * Interactive button in a message template
+ */
+export interface SentDmServicesCommonContractsPocOsTemplateButton {
+    /**
+     * The unique identifier of the button (1-based index)
+     */
+    id?: number;
     /**
-     * Optional template header with optional variables
+     * Properties specific to the button type
      */
-    header?: TemplateDefinition.Header | null;
+    props?: SentDmServicesCommonContractsPocOsTemplateButtonProps;
+    /**
+     * The type of button (e.g., QUICK_REPLY, URL, PHONE_NUMBER, VOICE_CALL, COPY_CODE)
+     */
+    type?: string;
+}
+export interface SentDmServicesCommonContractsPocOsTemplateButtonProps {
+    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;
 }
-export declare namespace TemplateDefinition {
+/**
+ * Footer section of a message template
+ */
+export interface SentDmServicesCommonContractsPocOsTemplateFooter {
     /**
-     * Required template body with content for different channels (multi-channel,
-     * SMS-specific, or WhatsApp-specific)
+     * The footer template text with optional variable placeholders
      */
-    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;
-    }
+    template?: string;
     /**
-     * Configuration specific to AUTHENTICATION category templates (optional)
+     * The type of footer (typically "text")
      */
-    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;
-    }
+    type?: string | null;
     /**
-     * Interactive button in a message template
+     * List of variables used in the footer 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;
-        }
-    }
+    variables?: Array<TemplateVariable> | null;
+}
+/**
+ * Header section of a message template
+ */
+export interface SentDmServicesCommonContractsPocOsTemplateHeader {
     /**
-     * Optional template footer with optional variables
+     * The header template text with optional variable placeholders (e.g., "Welcome to
+     * {{0:variable}}")
      */
-    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;
-    }
+    template?: string;
     /**
-     * Optional template header with optional variables
+     * The type of header (e.g., "text", "image", "video", "document")
      */
-    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;
-    }
+    type?: string | null;
+    /**
+     * List of variables used in the header template
+     */
+    variables?: Array<TemplateVariable> | null;
 }
 /**
- * Represents a message template with comprehensive metadata including definition
- * structure
+ * Template response for v3 API
  */
-export interface TemplateResponseV2 {
+export interface Template {
     /**
-     * The unique identifier of the template
+     * Unique template identifier
      */
     id?: string;
     /**
-     * The template category (e.g., MARKETING, UTILITY, AUTHENTICATION)
+     * Template category: MARKETING, UTILITY, AUTHENTICATION
      */
     category?: string;
     /**
-     * The date and time when the template was created
+     * Supported channels: sms, whatsapp
      */
-    createdAt?: string;
+    channels?: Array<string> | null;
     /**
-     * The complete template definition including header, body, footer, and buttons
+     * When the template was created
      */
-    definition?: TemplateDefinition;
+    created_at?: string;
     /**
-     * The display name of the template (auto-generated if not provided)
+     * Whether the template is published and active
      */
-    displayName?: string;
+    is_published?: boolean;
     /**
-     * Indicates whether the template is published and available for use
+     * Template language code (e.g., en_US)
      */
-    isPublished?: boolean;
+    language?: string;
     /**
-     * The template language code (e.g., en_US, es_ES)
+     * Template display name
      */
-    language?: string;
+    name?: string;
     /**
-     * The approval status of the template (e.g., APPROVED, PENDING, REJECTED, DRAFT)
+     * Template status: APPROVED, PENDING, REJECTED
      */
     status?: string;
     /**
-     * The date and time when the template was last updated
+     * When the template was last updated
      */
-    updatedAt?: string | null;
+    updated_at?: string | null;
     /**
-     * The WhatsApp Business API template ID from Meta
+     * Template variables for personalization
      */
-    whatsappTemplateId?: string;
+    variables?: Array<string> | null;
+}
+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 {
     /**
-     * The WhatsApp template name as registered with Meta
+     * Body section of a message template with channel-specific content
      */
-    whatsappTemplateName?: string;
+    body: SentDmServicesCommonContractsPocOsTemplateBody;
+    /**
+     * Configuration for AUTHENTICATION category templates
+     */
+    authenticationConfig?: SentDmServicesCommonContractsPocOsAuthenticationConfig | null;
+    /**
+     * Optional list of interactive buttons (e.g., quick replies, URLs, phone numbers)
+     */
+    buttons?: Array<SentDmServicesCommonContractsPocOsTemplateButton> | null;
+    /**
+     * The version of the template definition format
+     */
+    definitionVersion?: string | null;
+    /**
+     * Footer section of a message template
+     */
+    footer?: SentDmServicesCommonContractsPocOsTemplateFooter | null;
+    /**
+     * Header section of a message template
+     */
+    header?: SentDmServicesCommonContractsPocOsTemplateHeader | null;
 }
 export interface TemplateVariable {
     id?: number;
@@ -270,64 +279,191 @@ export declare namespace TemplateVariable {
     interface Props {
         alt?: string | null;
         mediaType?: string | null;
+        regex?: string | null;
         sample?: string | null;
         shortUrl?: string | null;
         url?: string | null;
         variableType?: string | null;
     }
 }
+/**
+ * Standard API response envelope for all v3 endpoints
+ */
 export interface TemplateListResponse {
-    items?: Array<TemplateResponseV2>;
-    page?: number;
-    pageSize?: number;
-    totalCount?: number;
-    totalPages?: number;
+    /**
+     * Paginated list of templates
+     */
+    data?: TemplateListResponse.Data | null;
+    /**
+     * Error information
+     */
+    error?: WebhooksAPI.ErrorDetail | null;
+    /**
+     * Request and response metadata
+     */
+    meta?: WebhooksAPI.APIMeta;
+    /**
+     * Indicates whether the request was successful
+     */
+    success?: boolean;
+}
+export declare namespace TemplateListResponse {
+    /**
+     * Paginated list of templates
+     */
+    interface Data {
+        /**
+         * Pagination metadata for list responses
+         */
+        pagination?: WebhooksAPI.PaginationMeta;
+        /**
+         * List of templates
+         */
+        templates?: Array<TemplatesAPI.Template>;
+    }
 }
 export interface TemplateCreateParams {
     /**
-     * Template definition containing header, body, footer, and buttons
+     * Body param: Template category: MARKETING, UTILITY, AUTHENTICATION (optional,
+     * auto-detected if not provided)
+     */
+    category?: string | null;
+    /**
+     * Body param: Source of template creation (default: from-api)
      */
-    definition: TemplateDefinition;
+    creation_source?: string | null;
+    /**
+     * Body param: Complete definition of a message template including header, body,
+     * footer, and buttons
+     */
+    definition?: TemplateDefinition;
+    /**
+     * Body param: Template language code (e.g., en_US) (optional, auto-detected if not
+     * provided)
+     */
+    language?: string | null;
     /**
-     * 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.
+     * Body param: Sandbox flag - when true, the operation is simulated without side
+     * effects Useful for testing integrations without actual execution
+     */
+    sandbox?: boolean;
+    /**
+     * Body param: Whether to submit the template for review after creation (default:
+     * false)
+     */
+    submit_for_review?: boolean;
+    /**
+     * Header param: Unique key to ensure idempotent request processing. Must be 1-255
+     * alphanumeric characters, hyphens, or underscores. Responses are cached for 24
+     * hours per key per customer.
+     */
+    'Idempotency-Key'?: string;
+    /**
+     * Header param: Profile UUID to scope the request to a child profile. Only
+     * organization API keys can use this header. The profile must belong to the
+     * calling organization.
+     */
+    'x-profile-id'?: string;
+}
+export interface TemplateRetrieveParams {
+    /**
+     * Profile UUID to scope the request to a child profile. Only organization API keys
+     * can use this header. The profile must belong to the calling organization.
+     */
+    'x-profile-id'?: string;
+}
+export interface TemplateUpdateParams {
+    /**
+     * Body param: Template category: MARKETING, UTILITY, AUTHENTICATION
      */
     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.
+     * Body param: Complete definition of a message template including header, body,
+     * footer, and buttons
+     */
+    definition?: TemplateDefinition | null;
+    /**
+     * Body param: Template language code (e.g., en_US)
      */
     language?: string | null;
     /**
-     * When false, the template will be saved as draft. When true, the template will be
-     * submitted for review.
+     * Body param: Template display name
+     */
+    name?: string | null;
+    /**
+     * Body param: Sandbox flag - when true, the operation is simulated without side
+     * effects Useful for testing integrations without actual execution
+     */
+    sandbox?: boolean;
+    /**
+     * Body param: Whether to submit the template for review after updating (default:
+     * false)
+     */
+    submit_for_review?: boolean;
+    /**
+     * Header param: Unique key to ensure idempotent request processing. Must be 1-255
+     * alphanumeric characters, hyphens, or underscores. Responses are cached for 24
+     * hours per key per customer.
+     */
+    'Idempotency-Key'?: string;
+    /**
+     * Header param: Profile UUID to scope the request to a child profile. Only
+     * organization API keys can use this header. The profile must belong to the
+     * calling organization.
      */
-    submitForReview?: boolean;
+    'x-profile-id'?: string;
 }
 export interface TemplateListParams {
     /**
-     * The page number (zero-indexed). Default is 0.
+     * Query param: Page number (1-indexed)
      */
     page: number;
     /**
-     * The number of items per page (1-1000). Default is 100.
+     * Query param: Number of items per page
      */
-    pageSize: number;
+    page_size: number;
     /**
-     * Optional filter by template category (e.g., MARKETING, UTILITY, AUTHENTICATION)
+     * Query param: Optional category filter: MARKETING, UTILITY, AUTHENTICATION
      */
     category?: string | null;
     /**
-     * Optional search term to filter templates by name or content
+     * Query param: Optional filter by welcome playground flag
+     */
+    is_welcome_playground?: boolean | null;
+    /**
+     * Query param: Optional search term for filtering templates
      */
     search?: string | null;
     /**
-     * Optional filter by template status (e.g., APPROVED, PENDING, REJECTED, DRAFT)
+     * Query param: Optional status filter: APPROVED, PENDING, REJECTED
      */
     status?: string | null;
+    /**
+     * Header param: Profile UUID to scope the request to a child profile. Only
+     * organization API keys can use this header. The profile must belong to the
+     * calling organization.
+     */
+    'x-profile-id'?: string;
+}
+export interface TemplateDeleteParams {
+    /**
+     * Body param: Whether to also delete the template from WhatsApp/Meta (optional,
+     * defaults to false)
+     */
+    delete_from_meta?: boolean | null;
+    /**
+     * Body param: Sandbox flag - when true, the operation is simulated without side
+     * effects Useful for testing integrations without actual execution
+     */
+    sandbox?: boolean;
+    /**
+     * Header param: Profile UUID to scope the request to a child profile. Only
+     * organization API keys can use this header. The profile must belong to the
+     * calling organization.
+     */
+    'x-profile-id'?: string;
 }
 export declare namespace Templates {
-    export { type TemplateBodyContent as TemplateBodyContent, type TemplateDefinition as TemplateDefinition, type TemplateResponseV2 as TemplateResponseV2, type TemplateVariable as TemplateVariable, type TemplateListResponse as TemplateListResponse, type TemplateCreateParams as TemplateCreateParams, type TemplateListParams as TemplateListParams, };
+    export { type APIResponseTemplate as APIResponseTemplate, type SentDmServicesCommonContractsPocOsAuthenticationConfig as SentDmServicesCommonContractsPocOsAuthenticationConfig, type SentDmServicesCommonContractsPocOsTemplateBody as SentDmServicesCommonContractsPocOsTemplateBody, type SentDmServicesCommonContractsPocOsTemplateButton as SentDmServicesCommonContractsPocOsTemplateButton, type SentDmServicesCommonContractsPocOsTemplateButtonProps as SentDmServicesCommonContractsPocOsTemplateButtonProps, type SentDmServicesCommonContractsPocOsTemplateFooter as SentDmServicesCommonContractsPocOsTemplateFooter, type SentDmServicesCommonContractsPocOsTemplateHeader as SentDmServicesCommonContractsPocOsTemplateHeader, type Template as Template, type TemplateBodyContent as TemplateBodyContent, type TemplateDefinition as TemplateDefinition, type TemplateVariable as TemplateVariable, type TemplateListResponse as TemplateListResponse, type TemplateCreateParams as TemplateCreateParams, type TemplateRetrieveParams as TemplateRetrieveParams, type TemplateUpdateParams as TemplateUpdateParams, type TemplateListParams as TemplateListParams, type TemplateDeleteParams as TemplateDeleteParams, };
 }
 //# sourceMappingURL=templates.d.ts.map