@opens/gateways 1.6.0 → 1.8.0

package/dist/index.d.mts

@@ -1,98 +1,16 @@
 import { AxiosInstance } from 'axios';
-
-/** Shared company data fields returned by the Customer Service API. */
-interface CompanyData {
-    id: string;
-    name: string;
-    hostname: string;
-    crm_code: string;
-    token: string;
-    status: string;
-    timezone: string;
-    utc: string;
-    check_bad_password: boolean;
-    limit_bad_password: number;
-    watching: boolean;
-    trial: boolean;
-    support_widget_id: string;
-    createdAt: string;
-    updatedAt: string;
-}
-/** Response returned by the Customer Service API when fetching a company. */
-interface CompanyResponse {
-    company: CompanyData;
-}
-
-/** A work group entity nested within {@link WorkGroupListResponse} and {@link WorkGroupResponse}. */
-interface WorkGroup {
-    id: string;
-    name: string;
-    description: string | null;
-    type: 'default' | 'user';
-    company_id: string;
-    createdAt: string;
-    updatedAt: string;
-}
-/** Response returned by the Customer Service API when fetching the work groups list. */
-interface WorkGroupListResponse extends CompanyData {
-    workgroups: WorkGroup[];
-}
-/** A user membership entity nested within {@link WorkGroupResponse}. */
-interface WorkGroupMember {
-    id: string;
-    username: string;
-    email: string;
-    profile: 'p_admin' | 'p_manager' | 'p_corporative' | 'p_agent';
-    status: 'new' | 'activated' | 'disabled';
-    avatar: string | null;
-    createdAt: string;
-    updatedAt: string;
-}
-/** Response returned by the Customer Service API when fetching a single work group. */
-interface WorkGroupResponse {
-    id: string;
-    name: string;
-    description: string | null;
-    type: 'default' | 'user';
-    company_id: string;
-    createdAt: string;
-    updatedAt: string;
-    workgroups_users: WorkGroupMember[];
-}
-/** Response returned by the Customer Service API when fetching members of a work group. */
-type WorkGroupMembersResponse = WorkGroupMember[];
-
-interface User {
-    id: string;
-    username: string;
-    email: string;
-    profile: 'p_admin' | 'p_manager' | 'p_corporative' | 'p_agent';
-    status: 'new' | 'activated' | 'disabled';
-    avatar: string | null;
-    type: string;
-    companyId: string;
-    createdAt: string;
-    updatedAt: string;
-}
-interface GetAllUsersParams {
-    status?: string;
-    includeWorkGroups?: boolean;
-    withoutOpensUsers?: boolean;
-}
-interface GetAllUsersResponse {
-    users: User[];
-}
-interface ManagedUser {
-    id: string;
-    username: string;
-    email: string;
-    profile: string;
-    status: string;
-    companyId: string;
-    createdAt: string;
-    updatedAt: string;
-}
-type GetManagedUsersResponse = ManagedUser[];
+import { CompanyResponse, WorkGroupListResponse, WorkGroupResponse, WorkGroupMembersResponse, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse } from './customer-service/contracts/index.mjs';
+export { CompanyData, ManagedUser, User, WorkGroup, WorkGroupMember } from './customer-service/contracts/index.mjs';
+import { ProviderListResponse, GetConfigsByProviderParams, ConfigListByProviderResponse, Queue, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, FindOrCreateQueueRuleRequest, QueueRule } from './chat-config/contracts/index.mjs';
+export { Config, ConfigProvider, DistributionType, MetaTemplateButton, Provider, QueueListResponse, QueueMember } from './chat-config/contracts/index.mjs';
+import { CampaignQueryParams, CampaignPaginatedResponse, Campaign, CreateCampaignRequest, PatchCampaignRequest, CampaignContactQueryParams, CampaignContactPaginatedResponse, CampaignContactResponse, CreateCampaignContactRequest, PatchCampaignContactRequest, CampaignUser, CampaignWorkGroupQueryParams, CampaignWorkGroupPaginatedResponse, CreateCampaignWorkGroupRequest, CampaignWorkGroup } from './campaigns/contracts/index.mjs';
+export { CampaignContactCampaignStatus, CampaignContactDispatchStatus, CampaignContactFilter, CampaignContactLikeQueryOperators, CampaignContactQueryOperators, CampaignContactQueryValue, CampaignContactSortDirection, CampaignContactSortParams, CampaignProvider, CampaignSchedule, CampaignStatus, WhatsAppPayload, WhatsAppTemplateComponent } from './campaigns/contracts/index.mjs';
+import { GetConfigTemplatesParams, GetConfigTemplatesResponse } from './chat-adapter/contracts/index.mjs';
+export { ConfigTemplatesPaging, MessageTemplate, MessageTemplateComponent } from './chat-adapter/contracts/index.mjs';
+import { GetPresignedUrlRequest, UploadPresignedUrlResponse, AudioConvertResponse } from './assets/contracts/index.mjs';
+export { IUploadPresignedUrlResponse } from './assets/contracts/index.mjs';
+import { GetContactPhonesParams, ContactPhoneSearchResponse, ContactCategoryResponse } from './contact-list/contracts/index.mjs';
+export { ContactPhoneResponse } from './contact-list/contracts/index.mjs';
 
 /**
  * Gateway for interacting with the Customer Service API.
@@ -132,206 +50,6 @@ declare class CustomerServiceGateway {
     getManagedUsers(managerId: string): Promise<GetManagedUsersResponse>;
 }
 
-/** A provider entity returned by the Chat Config API. */
-interface Provider {
-    id: string;
-    name: string;
-    configurationsSchema: Record<string, unknown> | null;
-    defaultSession: number;
-    type: string;
-    createdAt: string;
-    updatedAt: string;
-}
-/** Response returned by the Chat Config API when listing providers. */
-type ProviderListResponse = Provider[];
-
-/** A provider entity nested within a configuration response. */
-interface ConfigProvider {
-    id: string;
-    name: string;
-    type: string;
-    defaultSession: number;
-    configurationsSchema: Record<string, unknown> | null;
-    createdAt: string;
-    updatedAt: string;
-}
-/** A configuration entity returned by the Chat Config API. */
-interface Config {
-    id: string;
-    isAssistanceEnabled: boolean;
-    rewind: number | null;
-    companyId: string;
-    active: boolean;
-    configurations: Record<string, unknown>;
-    priority: number | null;
-    inbound: boolean;
-    outbound: boolean;
-    deletedAt: string | null;
-    providers: ConfigProvider;
-}
-/** Response returned by the Chat Config API when listing configurations by provider. */
-interface ConfigListByProviderResponse {
-    configurations: Config[];
-}
-/** Query parameters for filtering configurations by provider. */
-interface GetConfigsByProviderParams {
-    isAssistanceEnabled?: boolean;
-    rewind?: number;
-    active?: boolean;
-    priority?: number;
-    inbound?: boolean;
-    outbound?: boolean;
-    providerType?: string;
-    providerName?: string;
-}
-
-interface QueueMember {
-    id: string;
-    memberId: string;
-    priority: number;
-    permission: string;
-    lastAttendance: string;
-    lastInvite: string;
-    paused: boolean;
-    activeChat: number;
-    online: boolean;
-    companyId: string;
-    avatar: string;
-    username: string;
-    createdAt: string;
-    updatedAt: string;
-    queueId: string;
-}
-type DistributionType = {
-    id: string;
-    alias: string;
-    description: string;
-    createdAt: string;
-    updatedAt: string;
-};
-interface Queue {
-    id: string;
-    distributionTypeId: string;
-    companyId: string;
-    name: string;
-    strategy: 'leastrecent' | 'roundrobin' | 'random';
-    defaultQueue: boolean;
-    unlimitedService: boolean;
-    serviceLimit: number;
-    timeLimit: number;
-    skipOncallUsers: boolean;
-    csat: boolean;
-    csatAnswer: string;
-    csatTTL: number;
-    outsideBusinessHourMessage: string;
-    createCallbackOnExpired: boolean;
-    createCallbackOnOutsideBusinessHours: boolean;
-    archived: boolean;
-    isPrivate: boolean;
-    createdAt: string;
-    updatedAt: string;
-    members: QueueMember[];
-    distributionType: DistributionType;
-}
-/** Response returned when listing queues. */
-interface QueueListResponse {
-    queues: Queue[];
-}
-
-/** Representation of a button in a Meta template. */
-interface MetaTemplateButton {
-    /** Unique identifier of the button. */
-    id: string;
-    /** Type of the button (e.g. 'URL', 'PHONE_NUMBER', 'QUICK_REPLY'). */
-    type: string;
-    /** Text displayed on the button. */
-    text: string;
-    /** Value of the button (e.g. URL or phone number). */
-    value?: string | null;
-    /** Dynamic variable of the button. */
-    variable?: string | null;
-    /** ID of the template configuration to which the button belongs. */
-    templateConfigId: string;
-    /** Creation date of the record. */
-    createdAt?: string;
-    /** Update date of the record. */
-    updatedAt?: string;
-}
-/** Detailed configuration of a Meta template. */
-interface MetaTemplateConfigResponse {
-    /** Unique identifier of the template configuration. */
-    id: string;
-    /** Name of the template in Meta. */
-    name: string;
-    /** Identifier of the template in Meta. */
-    templateId: string;
-    /** Company identifier in Meta. */
-    companyId: string;
-    /** Format of the template (e.g. TEXT, IMAGE, VIDEO). */
-    format?: string | null;
-    /** Content of the template header. */
-    headerContent?: string | null;
-    /** Defines if the header has dynamic content (parameters). */
-    isDynamicHeader: boolean;
-    /** Type of the header (e.g. TEXT, IMAGE, DOCUMENT, VIDEO). */
-    headerType?: string | null;
-    /** Content of the template body. */
-    bodyContent?: string | null;
-    /** Type of the body (e.g. TEXT). */
-    bodyType?: string | null;
-    /** Content of the template footer. */
-    footerContent?: string | null;
-    /** Type of the footer (e.g. TEXT). */
-    footerType?: string | null;
-    /** ID of the configuration associated with the template. */
-    configId?: string | null;
-    /** ID of the provider associated with the template. */
-    providerId?: string | null;
-    /** Creation date of the record. */
-    createdAt?: string;
-    /** Update date of the record. */
-    updatedAt?: string;
-    /** List of buttons in the template. */
-    buttons?: MetaTemplateButton[];
-}
-/** Response containing the list of template configurations associated with a configuration. */
-interface MetaTemplateConfigsResponse {
-    /** List of Meta template configurations. */
-    templatesConfig: MetaTemplateConfigResponse[];
-}
-
-/** Request payload for finding or creating a queue rule. */
-interface FindOrCreateQueueRuleRequest {
-    companyId: string;
-    queueId: string;
-    configId: string;
-}
-/** Response returned when finding or creating a queue rule. */
-interface QueueRule {
-    id: string;
-    companyId: string;
-    name: string;
-    action: string;
-    message?: string;
-    automaticMessage?: Record<string, unknown>;
-    callOnQueue?: Record<string, unknown>;
-    uraDescription: string;
-    interactiveMessageId: string | null;
-    configId?: string;
-    queueId?: string;
-    redirectQueue: Record<string, unknown> | null;
-    redirectRuleId?: string;
-    questionnaire?: Record<string, unknown>;
-    webhook?: Record<string, unknown>;
-    isRoot: boolean;
-    redirectDefault: boolean;
-    redirectTimeout?: number;
-    delay?: number;
-    createdAt: string;
-    updatedAt: string;
-    flow?: Record<string, unknown>[];
-}
-
 /**
  * Gateway for interacting with the Chat Config API.
  */
@@ -378,225 +96,6 @@ declare class ChatConfigGateway {
     findOrCreateQueueRule(payload: FindOrCreateQueueRuleRequest): Promise<QueueRule>;
 }
 
-/** 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)[];
-};
-
 /**
  * Gateway for interacting with the Campaigns API.
  */
@@ -653,6 +152,12 @@ declare class CampaignsGateway {
      * @returns The created campaign contact.
      */
     createCampaignContact(payload: CreateCampaignContactRequest): Promise<CampaignContactResponse>;
+    /**
+     * Adds multiple contacts to a campaign in a single request.
+     * @param payload - The list of campaign contacts to create.
+     * @returns The created campaign contacts.
+     */
+    addContactsToCampaign(payload: CreateCampaignContactRequest[]): Promise<CampaignContactResponse[]>;
     /**
      * Partially updates an existing campaign contact.
      * @param id - The unique identifier of the campaign contact.
@@ -667,72 +172,9 @@ declare class CampaignsGateway {
      */
     removeCampaignContact(id: string): Promise<CampaignContactResponse>;
     getUsers(): Promise<CampaignUser[]>;
-}
-
-/** 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;
+    listWorkGroups(query?: CampaignWorkGroupQueryParams): Promise<CampaignWorkGroupPaginatedResponse>;
+    createWorkGroup(payload: CreateCampaignWorkGroupRequest): Promise<CampaignWorkGroup>;
+    deleteWorkGroup(id: string): Promise<CampaignWorkGroup>;
 }
 
 /**
@@ -751,38 +193,6 @@ declare class ChatAdapterGateway {
     getConfigTemplates(configId: string, params?: GetConfigTemplatesParams): Promise<GetConfigTemplatesResponse>;
 }
 
-/** 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;
-}
-
 /**
  * Gateway for interacting with the Assets API.
  */
@@ -805,6 +215,26 @@ declare class AssetsGateway {
     convertAudioToM4A(formData: any): Promise<AudioConvertResponse>;
 }
 
+/**
+ * Gateway for interacting with the Contact List API.
+ */
+declare class ContactListGateway {
+    private readonly httpClient;
+    private readonly baseUrl;
+    constructor(httpClient: AxiosInstance, baseUrl: string);
+    /**
+     * Searches for contact phones with optional filtering and pagination.
+     * @param params - The query parameters for the search.
+     * @returns The paginated contact phones response.
+     */
+    getContactsPhones(params: GetContactPhonesParams): Promise<ContactPhoneSearchResponse>;
+    /**
+     * Retrieves all contact categories.
+     * @returns An array of contact categories.
+     */
+    getCategoryList(): Promise<ContactCategoryResponse[]>;
+}
+
 /**
  * Maps service identifiers to their corresponding gateway types.
  * Used by the `gateway()` function to infer the correct return type
@@ -819,6 +249,7 @@ type GatewayMap = {
     'campaigns': CampaignsGateway;
     'chat-adapter': ChatAdapterGateway;
     'assets': AssetsGateway;
+    'contact-list': ContactListGateway;
 };
 /**
  * Parameters required to configure the SDK client.
@@ -846,6 +277,9 @@ interface GatewayClientParams {
         assets?: {
             baseUrl: string;
         };
+        contactList?: {
+            baseUrl: string;
+        };
     };
 }
 
@@ -872,4 +306,4 @@ declare const configure: (params: GatewayClientParams) => void;
  */
 declare function gateway<T extends keyof GatewayMap>(service: T): GatewayMap[T];
 
-export { type AudioConvertResponse, type Campaign, type CampaignContactCampaignStatus, type CampaignContactDispatchStatus, type CampaignContactFilter, type CampaignContactLikeQueryOperators, type CampaignContactPaginatedResponse, type CampaignContactQueryOperators, type CampaignContactQueryParams, type CampaignContactQueryValue, type CampaignContactResponse, type CampaignContactSortDirection, type CampaignContactSortParams, type CampaignPaginatedResponse, type CampaignProvider, type CampaignQueryParams, type CampaignSchedule, type CampaignStatus, type CampaignUser, type CompanyData, type CompanyResponse, type Config, type ConfigListByProviderResponse, type ConfigProvider, type ConfigTemplatesPaging, type CreateCampaignContactRequest, type CreateCampaignRequest, type DistributionType, type FindOrCreateQueueRuleRequest, type GetAllUsersParams, type GetAllUsersResponse, type GetConfigTemplatesParams, type GetConfigTemplatesResponse, type GetConfigsByProviderParams, type GetManagedUsersResponse, type GetPresignedUrlRequest, type IUploadPresignedUrlResponse, type ManagedUser, type MessageTemplate, type MessageTemplateComponent, type MetaTemplateButton, type MetaTemplateConfigResponse, type MetaTemplateConfigsResponse, type PatchCampaignContactRequest, type PatchCampaignRequest, type Provider, type ProviderListResponse, type Queue, type QueueListResponse, type QueueMember, type QueueRule, type UploadPresignedUrlResponse, type User, type WhatsAppPayload, type WhatsAppTemplateComponent, type WorkGroup, type WorkGroupListResponse, type WorkGroupMember, type WorkGroupMembersResponse, type WorkGroupResponse, configure, gateway };
+export { AudioConvertResponse, Campaign, CampaignContactPaginatedResponse, CampaignContactQueryParams, CampaignContactResponse, CampaignPaginatedResponse, CampaignQueryParams, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CompanyResponse, ConfigListByProviderResponse, ContactCategoryResponse, ContactPhoneSearchResponse, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, FindOrCreateQueueRuleRequest, GetAllUsersParams, GetAllUsersResponse, GetConfigTemplatesParams, GetConfigTemplatesResponse, GetConfigsByProviderParams, GetContactPhonesParams, GetManagedUsersResponse, GetPresignedUrlRequest, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, PatchCampaignContactRequest, PatchCampaignRequest, ProviderListResponse, Queue, QueueRule, UploadPresignedUrlResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };