@opens/gateways 1.5.1 → 1.7.0

package/dist/assets/contracts/index.d.mts

@@ -0,0 +1,33 @@
+/** Request payload for obtaining a presigned upload URL. */
+interface GetPresignedUrlRequest {
+    /** The name of the file to upload. */
+    fileName: string;
+    /** The destination key for the file in the bucket. */
+    key: string;
+    /** The unique identifier of the company. */
+    companyId: string;
+}
+/** Response returned when generating a presigned URL. */
+interface UploadPresignedUrlResponse {
+    /** The destination key for the file. */
+    key: string;
+    /** The destination bucket. */
+    bucket: string;
+    /** The presigned URL to upload the file to. */
+    presignedUrl: string;
+}
+/** Alias for UploadPresignedUrlResponse to support legacy imports. */
+type IUploadPresignedUrlResponse = UploadPresignedUrlResponse;
+/** Response returned by the Assets API when converting an audio file to M4A. */
+interface AudioConvertResponse {
+    /** The MIME type of the converted audio (e.g. 'audio/mp4'). */
+    mimetype: string;
+    /** The file extension of the converted audio (e.g. 'm4a'). */
+    extension: string;
+    /** The base64-encoded audio data. */
+    data: string;
+    /** The filename of the converted audio. */
+    filename: string;
+}
+
+export type { AudioConvertResponse, GetPresignedUrlRequest, IUploadPresignedUrlResponse, UploadPresignedUrlResponse };

package/dist/assets/contracts/index.d.ts

@@ -0,0 +1,33 @@
+/** Request payload for obtaining a presigned upload URL. */
+interface GetPresignedUrlRequest {
+    /** The name of the file to upload. */
+    fileName: string;
+    /** The destination key for the file in the bucket. */
+    key: string;
+    /** The unique identifier of the company. */
+    companyId: string;
+}
+/** Response returned when generating a presigned URL. */
+interface UploadPresignedUrlResponse {
+    /** The destination key for the file. */
+    key: string;
+    /** The destination bucket. */
+    bucket: string;
+    /** The presigned URL to upload the file to. */
+    presignedUrl: string;
+}
+/** Alias for UploadPresignedUrlResponse to support legacy imports. */
+type IUploadPresignedUrlResponse = UploadPresignedUrlResponse;
+/** Response returned by the Assets API when converting an audio file to M4A. */
+interface AudioConvertResponse {
+    /** The MIME type of the converted audio (e.g. 'audio/mp4'). */
+    mimetype: string;
+    /** The file extension of the converted audio (e.g. 'm4a'). */
+    extension: string;
+    /** The base64-encoded audio data. */
+    data: string;
+    /** The filename of the converted audio. */
+    filename: string;
+}
+
+export type { AudioConvertResponse, GetPresignedUrlRequest, IUploadPresignedUrlResponse, UploadPresignedUrlResponse };

package/dist/assets/contracts/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/assets/contracts/index.ts
+var contracts_exports = {};
+module.exports = __toCommonJS(contracts_exports);
+//# sourceMappingURL=index.js.map

package/dist/assets/contracts/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/assets/contracts/index.ts"],"sourcesContent":["export * from './assets';\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/assets/contracts/index.mjs

@@ -0,0 +1 @@
+//# sourceMappingURL=index.mjs.map

package/dist/assets/contracts/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/campaigns/contracts/index.d.mts

@@ -0,0 +1,248 @@
+/** Campaign status literals. */
+type CampaignStatus = 'ongoing' | 'finished' | 'paused' | 'scheduled';
+/** Campaign provider literals. */
+type CampaignProvider = 'whatsapp';
+/** WhatsApp template component structure. */
+interface WhatsAppTemplateComponent {
+    type: string;
+    parameters: {
+        type: string;
+        text?: string;
+    }[];
+}
+/** WhatsApp payload used when dispatching campaign messages. */
+interface WhatsAppPayload {
+    template: {
+        name: string;
+        components: WhatsAppTemplateComponent[];
+        language: string;
+        status: string;
+        category: string;
+        id: string;
+    };
+    templateOptions: {
+        buttonsVariablesValues?: (string | null)[] | null;
+        bodyVariablesValues?: string[];
+        headerVariablesValues?: string[];
+        headerFileInfos?: {
+            filename: string;
+            fileUrl: string;
+            parsedFilename: string;
+        };
+    };
+}
+/** Contact filter applied when adding contacts to a campaign. */
+interface CampaignContactFilter {
+    excludeDeclinedMarketing?: boolean;
+}
+/** Schedule configuration for a campaign. */
+interface CampaignSchedule {
+    startAt?: string;
+    repeat?: {
+        delay?: number;
+        count?: number;
+        until?: string;
+    };
+}
+/** Campaign entity returned by the Campaigns API. */
+interface Campaign {
+    id: string;
+    sid: number;
+    companyId: string;
+    createdBy: string;
+    assignedTo: string;
+    name?: string;
+    provider: CampaignProvider;
+    providerId: number;
+    providerConfigId: string;
+    associatedRuleId?: string;
+    payload: WhatsAppPayload;
+    conversionRuleIds: string[];
+    status: CampaignStatus;
+    expiresAt?: string;
+    createdAt: string;
+    updatedAt: string;
+    failedCampaignAttempts: number;
+    queuedCampaignAttempts: number;
+    deliveredCampaignAttempts: number;
+    convertedCampaignAttempts: number;
+    categoryId?: number;
+    contactFilter?: CampaignContactFilter;
+    schedule?: CampaignSchedule;
+}
+/** Paginated response returned by the Campaigns API for list endpoints. */
+interface CampaignPaginatedResponse {
+    total: number;
+    limit: number;
+    skip: number;
+    data: Campaign[];
+}
+/** Request payload for creating a campaign. */
+interface CreateCampaignRequest {
+    name: string;
+    payload: WhatsAppPayload;
+    provider: CampaignProvider;
+    companyId: string;
+    createdBy: string;
+    providerId: number;
+    providerConfigId: string;
+    schedule: CampaignSchedule;
+    associatedRuleId?: string;
+    assignedTo?: string;
+    expiresAt?: string;
+}
+/** Request payload for updating a campaign. */
+interface PatchCampaignRequest {
+    name?: string;
+    expiresAt?: string;
+    status?: CampaignStatus;
+    categoryId?: number;
+    contactFilter?: CampaignContactFilter;
+}
+/** Query parameters for listing campaigns. */
+interface CampaignQueryParams {
+    companyId?: string;
+    status?: CampaignStatus;
+    createdBy?: string;
+    assignedTo?: string;
+    name?: string;
+    $limit?: number;
+    $skip?: number;
+}
+/** User entity returned by the Campaigns API. */
+interface CampaignUser {
+    id: string;
+    name: string;
+    status: 'new' | 'activated' | 'disabled';
+}
+
+/** Dispatch status literals for a campaign contact. */
+type CampaignContactDispatchStatus = 'scheduled' | 'queued' | 'delivered' | 'converted' | 'failed';
+/** Campaign status literals accepted by campaign contact queries. */
+type CampaignContactCampaignStatus = 'ongoing' | 'finished';
+/** Primitive values accepted by REST query filters. */
+type CampaignContactQueryValue = string | number | boolean;
+/** Sort direction accepted by REST query parameters. */
+type CampaignContactSortDirection = 1 | -1;
+/** Query operators accepted by REST query filters. */
+type CampaignContactQueryOperators<T extends CampaignContactQueryValue> = {
+    $eq?: T;
+    $ne?: T;
+    $in?: T[];
+    $nin?: T[];
+    $lt?: T;
+    $lte?: T;
+    $gt?: T;
+    $gte?: T;
+};
+/** Case-insensitive LIKE operator accepted by contact name and endpoint filters. */
+type CampaignContactLikeQueryOperators = {
+    $ilike?: string;
+};
+/** Campaign contact entity returned by the Campaign Contacts API. */
+interface CampaignContactResponse {
+    id: string;
+    contactId: string;
+    campaignId: string;
+    createdAt: string;
+    updatedAt: string;
+    contactEndpointId?: string;
+    dispatchStatusMessage: string;
+    contactName?: string;
+    contactEndpoint?: string;
+    metadata?: unknown;
+    communicationChannelId: string;
+    dispatchStatus: CampaignContactDispatchStatus;
+    isMessageRead?: boolean;
+}
+/** Paginated response returned by the Campaign Contacts API for list endpoints. */
+type CampaignContactPaginatedResponse = {
+    total: number;
+    limit: number;
+    skip: number;
+    data: CampaignContactResponse[];
+};
+/** Request payload for creating a campaign contact. */
+type CreateCampaignContactRequest = {
+    contactId: string;
+    campaignId: string;
+    contactEndpointId?: string;
+    contactName?: string;
+    contactEndpoint?: string;
+    metadata?: unknown;
+};
+/** Request payload for partially updating a campaign contact. */
+type PatchCampaignContactRequest = {
+    id?: string;
+    contactId?: string;
+    campaignId?: string;
+    createdAt?: string;
+    updatedAt?: string;
+    contactEndpointId?: string;
+    dispatchStatusMessage?: string;
+    contactName?: string;
+    contactEndpoint?: string;
+    metadata?: unknown;
+    communicationChannelId?: string;
+    dispatchStatus?: CampaignContactDispatchStatus;
+    isMessageRead?: boolean;
+};
+/** Sort fields accepted when listing campaign contacts. */
+type CampaignContactSortParams = {
+    contactId?: CampaignContactSortDirection;
+    createdAt?: CampaignContactSortDirection;
+    updatedAt?: CampaignContactSortDirection;
+    campaignId?: CampaignContactSortDirection;
+    dispatchStatus?: CampaignContactSortDirection;
+    contactName?: CampaignContactSortDirection;
+    contactEndpoint?: CampaignContactSortDirection;
+    contactEndpointId?: CampaignContactSortDirection;
+    communicationChannelId?: CampaignContactSortDirection;
+};
+/** Query parameters for listing campaign contacts. */
+type CampaignContactQueryParams = {
+    contactId?: string | CampaignContactQueryOperators<string>;
+    createdAt?: string | CampaignContactQueryOperators<string>;
+    updatedAt?: string | CampaignContactQueryOperators<string>;
+    campaignId?: string | CampaignContactQueryOperators<string>;
+    dispatchStatus?: CampaignContactDispatchStatus | CampaignContactQueryOperators<CampaignContactDispatchStatus>;
+    contactName?: string | CampaignContactQueryOperators<string> | CampaignContactLikeQueryOperators;
+    contactEndpoint?: string | CampaignContactQueryOperators<string> | CampaignContactLikeQueryOperators;
+    contactEndpointId?: string | CampaignContactQueryOperators<string>;
+    communicationChannelId?: string | CampaignContactQueryOperators<string>;
+    'campaign.status'?: CampaignContactCampaignStatus | CampaignContactQueryOperators<CampaignContactCampaignStatus>;
+    $limit?: number;
+    $skip?: number;
+    $sort?: CampaignContactSortParams;
+    $select?: (keyof CampaignContactResponse)[];
+};
+
+/** Work group entity returned by the Campaigns API. */
+interface CampaignWorkGroup {
+    id: string;
+    name: string;
+    companyId: string;
+}
+/** Paginated response returned when listing work groups. */
+interface CampaignWorkGroupPaginatedResponse {
+    total: number;
+    limit: number;
+    skip: number;
+    data: CampaignWorkGroup[];
+}
+/** Query parameters for listing work groups. */
+interface CampaignWorkGroupQueryParams {
+    id?: string;
+    name?: string;
+    companyId?: string;
+    $limit?: number;
+    $skip?: number;
+}
+/** Request payload for creating a work group. */
+interface CreateCampaignWorkGroupRequest {
+    id: string;
+    name: string;
+    companyId: string;
+}
+
+export type { Campaign, CampaignContactCampaignStatus, CampaignContactDispatchStatus, CampaignContactFilter, CampaignContactLikeQueryOperators, CampaignContactPaginatedResponse, CampaignContactQueryOperators, CampaignContactQueryParams, CampaignContactQueryValue, CampaignContactResponse, CampaignContactSortDirection, CampaignContactSortParams, CampaignPaginatedResponse, CampaignProvider, CampaignQueryParams, CampaignSchedule, CampaignStatus, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, PatchCampaignContactRequest, PatchCampaignRequest, WhatsAppPayload, WhatsAppTemplateComponent };

package/dist/campaigns/contracts/index.d.ts

@@ -0,0 +1,248 @@
+/** Campaign status literals. */
+type CampaignStatus = 'ongoing' | 'finished' | 'paused' | 'scheduled';
+/** Campaign provider literals. */
+type CampaignProvider = 'whatsapp';
+/** WhatsApp template component structure. */
+interface WhatsAppTemplateComponent {
+    type: string;
+    parameters: {
+        type: string;
+        text?: string;
+    }[];
+}
+/** WhatsApp payload used when dispatching campaign messages. */
+interface WhatsAppPayload {
+    template: {
+        name: string;
+        components: WhatsAppTemplateComponent[];
+        language: string;
+        status: string;
+        category: string;
+        id: string;
+    };
+    templateOptions: {
+        buttonsVariablesValues?: (string | null)[] | null;
+        bodyVariablesValues?: string[];
+        headerVariablesValues?: string[];
+        headerFileInfos?: {
+            filename: string;
+            fileUrl: string;
+            parsedFilename: string;
+        };
+    };
+}
+/** Contact filter applied when adding contacts to a campaign. */
+interface CampaignContactFilter {
+    excludeDeclinedMarketing?: boolean;
+}
+/** Schedule configuration for a campaign. */
+interface CampaignSchedule {
+    startAt?: string;
+    repeat?: {
+        delay?: number;
+        count?: number;
+        until?: string;
+    };
+}
+/** Campaign entity returned by the Campaigns API. */
+interface Campaign {
+    id: string;
+    sid: number;
+    companyId: string;
+    createdBy: string;
+    assignedTo: string;
+    name?: string;
+    provider: CampaignProvider;
+    providerId: number;
+    providerConfigId: string;
+    associatedRuleId?: string;
+    payload: WhatsAppPayload;
+    conversionRuleIds: string[];
+    status: CampaignStatus;
+    expiresAt?: string;
+    createdAt: string;
+    updatedAt: string;
+    failedCampaignAttempts: number;
+    queuedCampaignAttempts: number;
+    deliveredCampaignAttempts: number;
+    convertedCampaignAttempts: number;
+    categoryId?: number;
+    contactFilter?: CampaignContactFilter;
+    schedule?: CampaignSchedule;
+}
+/** Paginated response returned by the Campaigns API for list endpoints. */
+interface CampaignPaginatedResponse {
+    total: number;
+    limit: number;
+    skip: number;
+    data: Campaign[];
+}
+/** Request payload for creating a campaign. */
+interface CreateCampaignRequest {
+    name: string;
+    payload: WhatsAppPayload;
+    provider: CampaignProvider;
+    companyId: string;
+    createdBy: string;
+    providerId: number;
+    providerConfigId: string;
+    schedule: CampaignSchedule;
+    associatedRuleId?: string;
+    assignedTo?: string;
+    expiresAt?: string;
+}
+/** Request payload for updating a campaign. */
+interface PatchCampaignRequest {
+    name?: string;
+    expiresAt?: string;
+    status?: CampaignStatus;
+    categoryId?: number;
+    contactFilter?: CampaignContactFilter;
+}
+/** Query parameters for listing campaigns. */
+interface CampaignQueryParams {
+    companyId?: string;
+    status?: CampaignStatus;
+    createdBy?: string;
+    assignedTo?: string;
+    name?: string;
+    $limit?: number;
+    $skip?: number;
+}
+/** User entity returned by the Campaigns API. */
+interface CampaignUser {
+    id: string;
+    name: string;
+    status: 'new' | 'activated' | 'disabled';
+}
+
+/** Dispatch status literals for a campaign contact. */
+type CampaignContactDispatchStatus = 'scheduled' | 'queued' | 'delivered' | 'converted' | 'failed';
+/** Campaign status literals accepted by campaign contact queries. */
+type CampaignContactCampaignStatus = 'ongoing' | 'finished';
+/** Primitive values accepted by REST query filters. */
+type CampaignContactQueryValue = string | number | boolean;
+/** Sort direction accepted by REST query parameters. */
+type CampaignContactSortDirection = 1 | -1;
+/** Query operators accepted by REST query filters. */
+type CampaignContactQueryOperators<T extends CampaignContactQueryValue> = {
+    $eq?: T;
+    $ne?: T;
+    $in?: T[];
+    $nin?: T[];
+    $lt?: T;
+    $lte?: T;
+    $gt?: T;
+    $gte?: T;
+};
+/** Case-insensitive LIKE operator accepted by contact name and endpoint filters. */
+type CampaignContactLikeQueryOperators = {
+    $ilike?: string;
+};
+/** Campaign contact entity returned by the Campaign Contacts API. */
+interface CampaignContactResponse {
+    id: string;
+    contactId: string;
+    campaignId: string;
+    createdAt: string;
+    updatedAt: string;
+    contactEndpointId?: string;
+    dispatchStatusMessage: string;
+    contactName?: string;
+    contactEndpoint?: string;
+    metadata?: unknown;
+    communicationChannelId: string;
+    dispatchStatus: CampaignContactDispatchStatus;
+    isMessageRead?: boolean;
+}
+/** Paginated response returned by the Campaign Contacts API for list endpoints. */
+type CampaignContactPaginatedResponse = {
+    total: number;
+    limit: number;
+    skip: number;
+    data: CampaignContactResponse[];
+};
+/** Request payload for creating a campaign contact. */
+type CreateCampaignContactRequest = {
+    contactId: string;
+    campaignId: string;
+    contactEndpointId?: string;
+    contactName?: string;
+    contactEndpoint?: string;
+    metadata?: unknown;
+};
+/** Request payload for partially updating a campaign contact. */
+type PatchCampaignContactRequest = {
+    id?: string;
+    contactId?: string;
+    campaignId?: string;
+    createdAt?: string;
+    updatedAt?: string;
+    contactEndpointId?: string;
+    dispatchStatusMessage?: string;
+    contactName?: string;
+    contactEndpoint?: string;
+    metadata?: unknown;
+    communicationChannelId?: string;
+    dispatchStatus?: CampaignContactDispatchStatus;
+    isMessageRead?: boolean;
+};
+/** Sort fields accepted when listing campaign contacts. */
+type CampaignContactSortParams = {
+    contactId?: CampaignContactSortDirection;
+    createdAt?: CampaignContactSortDirection;
+    updatedAt?: CampaignContactSortDirection;
+    campaignId?: CampaignContactSortDirection;
+    dispatchStatus?: CampaignContactSortDirection;
+    contactName?: CampaignContactSortDirection;
+    contactEndpoint?: CampaignContactSortDirection;
+    contactEndpointId?: CampaignContactSortDirection;
+    communicationChannelId?: CampaignContactSortDirection;
+};
+/** Query parameters for listing campaign contacts. */
+type CampaignContactQueryParams = {
+    contactId?: string | CampaignContactQueryOperators<string>;
+    createdAt?: string | CampaignContactQueryOperators<string>;
+    updatedAt?: string | CampaignContactQueryOperators<string>;
+    campaignId?: string | CampaignContactQueryOperators<string>;
+    dispatchStatus?: CampaignContactDispatchStatus | CampaignContactQueryOperators<CampaignContactDispatchStatus>;
+    contactName?: string | CampaignContactQueryOperators<string> | CampaignContactLikeQueryOperators;
+    contactEndpoint?: string | CampaignContactQueryOperators<string> | CampaignContactLikeQueryOperators;
+    contactEndpointId?: string | CampaignContactQueryOperators<string>;
+    communicationChannelId?: string | CampaignContactQueryOperators<string>;
+    'campaign.status'?: CampaignContactCampaignStatus | CampaignContactQueryOperators<CampaignContactCampaignStatus>;
+    $limit?: number;
+    $skip?: number;
+    $sort?: CampaignContactSortParams;
+    $select?: (keyof CampaignContactResponse)[];
+};
+
+/** Work group entity returned by the Campaigns API. */
+interface CampaignWorkGroup {
+    id: string;
+    name: string;
+    companyId: string;
+}
+/** Paginated response returned when listing work groups. */
+interface CampaignWorkGroupPaginatedResponse {
+    total: number;
+    limit: number;
+    skip: number;
+    data: CampaignWorkGroup[];
+}
+/** Query parameters for listing work groups. */
+interface CampaignWorkGroupQueryParams {
+    id?: string;
+    name?: string;
+    companyId?: string;
+    $limit?: number;
+    $skip?: number;
+}
+/** Request payload for creating a work group. */
+interface CreateCampaignWorkGroupRequest {
+    id: string;
+    name: string;
+    companyId: string;
+}
+
+export type { Campaign, CampaignContactCampaignStatus, CampaignContactDispatchStatus, CampaignContactFilter, CampaignContactLikeQueryOperators, CampaignContactPaginatedResponse, CampaignContactQueryOperators, CampaignContactQueryParams, CampaignContactQueryValue, CampaignContactResponse, CampaignContactSortDirection, CampaignContactSortParams, CampaignPaginatedResponse, CampaignProvider, CampaignQueryParams, CampaignSchedule, CampaignStatus, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, PatchCampaignContactRequest, PatchCampaignRequest, WhatsAppPayload, WhatsAppTemplateComponent };

package/dist/campaigns/contracts/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/campaigns/contracts/index.ts
+var contracts_exports = {};
+module.exports = __toCommonJS(contracts_exports);
+//# sourceMappingURL=index.js.map

package/dist/campaigns/contracts/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/campaigns/contracts/index.ts"],"sourcesContent":["export * from './campaign';\nexport * from './campaign-contacts';\nexport * from './work-group';\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/campaigns/contracts/index.mjs

@@ -0,0 +1 @@
+//# sourceMappingURL=index.mjs.map

package/dist/campaigns/contracts/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/chat-adapter/contracts/index.d.mts

@@ -0,0 +1,67 @@
+/** Parameters for retrieving configuration templates. */
+interface GetConfigTemplatesParams {
+    /** Optional template name filter. */
+    templateName?: string;
+    /** Optional maximum number of templates to return. */
+    limit?: number;
+    /** Optional status filter (e.g. 'APPROVED', 'REJECTED', 'PENDING'). */
+    status?: string;
+    /** Optional category filter (e.g. 'UTILITY', 'MARKETING', 'AUTHENTICATION'). */
+    category?: string;
+    /** Optional pagination cursor token/URL. */
+    next?: string;
+    /** Optional pagination cursor 'after' parameter. */
+    after?: string;
+}
+/** Component of a message template. */
+interface MessageTemplateComponent {
+    /** Type of the component (e.g. 'HEADER', 'BODY', 'FOOTER', 'BUTTONS'). */
+    type: string;
+    /** Format of the component (e.g. 'TEXT', 'IMAGE', 'DOCUMENT', 'VIDEO'). */
+    format?: string;
+    /** Text content of the component. */
+    text?: string;
+    /** List of buttons in the component if type is 'BUTTONS'. */
+    buttons?: Array<{
+        type: string;
+        text: string;
+        url?: string;
+        phoneNumber?: string;
+    }>;
+}
+/** Details of a message template. */
+interface MessageTemplate {
+    /** Name of the message template. */
+    name: string;
+    /** Status of the template (e.g. 'APPROVED', 'REJECTED', 'PENDING'). */
+    status: string;
+    /** Category of the template (e.g. 'UTILITY', 'MARKETING', 'AUTHENTICATION'). */
+    category: string;
+    /** Language locale of the template (e.g. 'pt_BR', 'en_US'). */
+    language: string;
+    /** Components that build up the template content. */
+    components: MessageTemplateComponent[];
+    /** Unique identifier of the template. */
+    id: string;
+}
+/** Pagination information for the template query response. */
+interface ConfigTemplatesPaging {
+    /** Cursors used to paginate results. */
+    cursors?: {
+        /** Cursor pointing to the start of the current range. */
+        before?: string;
+        /** Cursor pointing to the end of the current range. */
+        after?: string;
+    };
+    /** URL for the next page of results. */
+    next?: string;
+}
+/** Response containing the list of message templates configured. */
+interface GetConfigTemplatesResponse {
+    /** List of message templates. */
+    data: MessageTemplate[];
+    /** Pagination information. */
+    paging?: ConfigTemplatesPaging;
+}
+
+export type { ConfigTemplatesPaging, GetConfigTemplatesParams, GetConfigTemplatesResponse, MessageTemplate, MessageTemplateComponent };