@opens/gateways 1.17.1 → 1.17.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -56,11 +56,62 @@ interface FindContactByIdResponse extends Contact {
56
56
  instagramProfile: Record<string, unknown>[];
57
57
  }
58
58
 
59
+ /** Query parameters for searching WhatsApp accounts. Text filters are combined with OR within the company and portfolio scope. */
60
+ interface SearchWhatsappAccountsRequest {
61
+ companyId?: string;
62
+ businessPortfolioId?: string;
63
+ filterBsuid?: string;
64
+ filterContactName?: string;
65
+ filterContactCpf?: string;
66
+ filterPhone?: string;
67
+ filterCategoryName?: string;
68
+ filterOrganizationName?: string;
69
+ includes?: 'phone'[];
70
+ contactInclude?: ('organization' | 'category' | 'phone' | 'email')[];
71
+ limit?: number;
72
+ offset?: number;
73
+ orderBy?: 'name' | 'bsuid' | 'createdAt';
74
+ }
75
+ /** WhatsApp account returned by the Contact List API. */
76
+ interface WhatsappAccountResponse {
77
+ id: string;
78
+ companyId: string;
79
+ contactId: string;
80
+ businessPortfolioId: string;
81
+ bsuid: string;
82
+ phoneId: number | null;
83
+ phoneNumber: string | null;
84
+ createdAt: string;
85
+ updatedAt: string;
86
+ }
87
+ /** WhatsApp account with its contact details returned by search. */
88
+ interface WhatsappAccountSearchItemResponse extends WhatsappAccountResponse {
89
+ phone?: FindContactByIdPhoneResponse | null;
90
+ contact: Contact & {
91
+ organization?: {
92
+ id: number;
93
+ name: string;
94
+ } | null;
95
+ category?: {
96
+ id: number;
97
+ name: string;
98
+ } | null;
99
+ phones?: FindContactByIdPhoneResponse[];
100
+ emails?: FindContactByIdEmailResponse[];
101
+ };
102
+ }
103
+ /** Paginated WhatsApp account search response. */
104
+ interface SearchWhatsappAccountsResponse {
105
+ total: number;
106
+ accounts: WhatsappAccountSearchItemResponse[];
107
+ }
108
+
59
109
  /** Query parameters for searching contact phones. */
60
110
  interface GetContactPhonesParams {
61
111
  limit: number;
62
112
  offset: number;
63
113
  companyId: string;
114
+ businessPortfolioId?: string;
64
115
  orderBy?: string;
65
116
  filter?: string;
66
117
  associations?: string[];
@@ -89,6 +140,7 @@ interface ContactPhoneResponse {
89
140
  campaigns: {
90
141
  campaignId: string;
91
142
  }[];
143
+ whatsappAccounts?: WhatsappAccountResponse[];
92
144
  };
93
145
  }
94
146
  /** Paginated response returned by the Contact List API for phone search. */
@@ -101,4 +153,4 @@ interface ContactCategoryResponse {
101
153
  name: string;
102
154
  }
103
155
 
104
- export type { Contact, ContactCategoryResponse, ContactPhoneResponse, ContactPhoneSearchResponse, ContactResponse, FindContactByIdEmailResponse, FindContactByIdPhoneResponse, FindContactByIdResponse, FindOrCreateContactRequest, GetContactPhonesParams };
156
+ export type { Contact, ContactCategoryResponse, ContactPhoneResponse, ContactPhoneSearchResponse, ContactResponse, FindContactByIdEmailResponse, FindContactByIdPhoneResponse, FindContactByIdResponse, FindOrCreateContactRequest, GetContactPhonesParams, SearchWhatsappAccountsRequest, SearchWhatsappAccountsResponse, WhatsappAccountResponse, WhatsappAccountSearchItemResponse };
@@ -56,11 +56,62 @@ interface FindContactByIdResponse extends Contact {
56
56
  instagramProfile: Record<string, unknown>[];
57
57
  }
58
58
 
59
+ /** Query parameters for searching WhatsApp accounts. Text filters are combined with OR within the company and portfolio scope. */
60
+ interface SearchWhatsappAccountsRequest {
61
+ companyId?: string;
62
+ businessPortfolioId?: string;
63
+ filterBsuid?: string;
64
+ filterContactName?: string;
65
+ filterContactCpf?: string;
66
+ filterPhone?: string;
67
+ filterCategoryName?: string;
68
+ filterOrganizationName?: string;
69
+ includes?: 'phone'[];
70
+ contactInclude?: ('organization' | 'category' | 'phone' | 'email')[];
71
+ limit?: number;
72
+ offset?: number;
73
+ orderBy?: 'name' | 'bsuid' | 'createdAt';
74
+ }
75
+ /** WhatsApp account returned by the Contact List API. */
76
+ interface WhatsappAccountResponse {
77
+ id: string;
78
+ companyId: string;
79
+ contactId: string;
80
+ businessPortfolioId: string;
81
+ bsuid: string;
82
+ phoneId: number | null;
83
+ phoneNumber: string | null;
84
+ createdAt: string;
85
+ updatedAt: string;
86
+ }
87
+ /** WhatsApp account with its contact details returned by search. */
88
+ interface WhatsappAccountSearchItemResponse extends WhatsappAccountResponse {
89
+ phone?: FindContactByIdPhoneResponse | null;
90
+ contact: Contact & {
91
+ organization?: {
92
+ id: number;
93
+ name: string;
94
+ } | null;
95
+ category?: {
96
+ id: number;
97
+ name: string;
98
+ } | null;
99
+ phones?: FindContactByIdPhoneResponse[];
100
+ emails?: FindContactByIdEmailResponse[];
101
+ };
102
+ }
103
+ /** Paginated WhatsApp account search response. */
104
+ interface SearchWhatsappAccountsResponse {
105
+ total: number;
106
+ accounts: WhatsappAccountSearchItemResponse[];
107
+ }
108
+
59
109
  /** Query parameters for searching contact phones. */
60
110
  interface GetContactPhonesParams {
61
111
  limit: number;
62
112
  offset: number;
63
113
  companyId: string;
114
+ businessPortfolioId?: string;
64
115
  orderBy?: string;
65
116
  filter?: string;
66
117
  associations?: string[];
@@ -89,6 +140,7 @@ interface ContactPhoneResponse {
89
140
  campaigns: {
90
141
  campaignId: string;
91
142
  }[];
143
+ whatsappAccounts?: WhatsappAccountResponse[];
92
144
  };
93
145
  }
94
146
  /** Paginated response returned by the Contact List API for phone search. */
@@ -101,4 +153,4 @@ interface ContactCategoryResponse {
101
153
  name: string;
102
154
  }
103
155
 
104
- export type { Contact, ContactCategoryResponse, ContactPhoneResponse, ContactPhoneSearchResponse, ContactResponse, FindContactByIdEmailResponse, FindContactByIdPhoneResponse, FindContactByIdResponse, FindOrCreateContactRequest, GetContactPhonesParams };
156
+ export type { Contact, ContactCategoryResponse, ContactPhoneResponse, ContactPhoneSearchResponse, ContactResponse, FindContactByIdEmailResponse, FindContactByIdPhoneResponse, FindContactByIdResponse, FindOrCreateContactRequest, GetContactPhonesParams, SearchWhatsappAccountsRequest, SearchWhatsappAccountsResponse, WhatsappAccountResponse, WhatsappAccountSearchItemResponse };
@@ -1 +1 @@
1
- {"version":3,"sources":["../../../src/contact-list/contracts/index.ts"],"sourcesContent":["export * from './contact';\nexport * from './contact-phone';\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
1
+ {"version":3,"sources":["../../../src/contact-list/contracts/index.ts"],"sourcesContent":["export * from './contact';\nexport * from './contact-phone';\nexport * from './whatsapp-account';\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
package/dist/index.d.mts CHANGED
@@ -9,8 +9,8 @@ import { GetConfigTemplatesParams, GetConfigTemplatesResponse, FlowReadiness, Fl
9
9
  export { ConfigTemplatesPaging, FlowCatalogItem, MessageTemplate, MessageTemplateComponent } from './chat-adapter/contracts/index.mjs';
10
10
  import { GetPresignedUrlRequest, UploadPresignedUrlResponse, AudioConvertResponse, GetAttachmentByIdRequest, AttachmentByIdResponse } from './assets/contracts/index.mjs';
11
11
  export { IUploadPresignedUrlResponse } from './assets/contracts/index.mjs';
12
- import { GetContactPhonesParams, ContactPhoneSearchResponse, ContactCategoryResponse, FindContactByIdResponse, FindOrCreateContactRequest, ContactResponse } from './contact-list/contracts/index.mjs';
13
- export { Contact, ContactPhoneResponse, FindContactByIdEmailResponse, FindContactByIdPhoneResponse } from './contact-list/contracts/index.mjs';
12
+ import { GetContactPhonesParams, ContactPhoneSearchResponse, SearchWhatsappAccountsRequest, SearchWhatsappAccountsResponse, ContactCategoryResponse, FindContactByIdResponse, FindOrCreateContactRequest, ContactResponse } from './contact-list/contracts/index.mjs';
13
+ export { Contact, ContactPhoneResponse, FindContactByIdEmailResponse, FindContactByIdPhoneResponse, WhatsappAccountResponse, WhatsappAccountSearchItemResponse } from './contact-list/contracts/index.mjs';
14
14
  import { AppListResponse, GetAppRequest, AppDetails, ResolveAppDatasourceRequest, ResolveAppDatasourceResponse, SubmitAppRequest, GetIntegrationPartnersByCompanyRequest, IntegrationPartner, GetWebhooksByCompanyRequest as GetWebhooksByCompanyRequest$1, GetIntegrationHooksCatalogRequest, HookCatalogItem, ListAutomationPartnersRequest, AutomationPartner, ListAutomationActionsRequest, AutomationPartnerAction, GetAutomationPartnerRequest, CreateAutomationPartnerRequest, CreateIntegrationPartnerRequest, CreateWebhookRequest as CreateWebhookRequest$1, DeleteIntegrationPartnerParams, CreateIntegrationActionRequest, IntegrationAction, UpdateIntegrationActionParams, CreateIntegrationFieldRequest, IntegrationField, UpdateIntegrationFieldParams, DeleteIntegrationFieldParams, DeleteIntegrationActionParams } from './integrations/contracts/index.mjs';
15
15
  export { App, AppDatasource, AppDatasourceItem, AppField, AppForm, AppSection, UpdateIntegrationActionRequest, UpdateIntegrationFieldRequest } from './integrations/contracts/index.mjs';
16
16
  import { ListInvitationsRequest, InvitationResponse, ReplyInvitationRequest, CancelInvitationRequest, ListLiveUserRoomsRequest, LiveUserRoomResponse, GetRoomByIdRequest, RoomResponse, GetInitialContextRequest, GetInitialContextResponse, GetMessagesByCursorRequest, GetMessagesByCursorResponse, SendMessageRequest, MessageResponse, ForwardMessageRequest, SendAttachmentMessageResponse, MarkMessagesAsReadRequest, MarkMessagesAsReadResponse, UpdateMemberInRoomRequest, RoomMemberResponse, ChatWebserviceCompanyUsageRequest, ChatWebserviceCompanyUsageResponse } from './chat-webservice/contracts/index.mjs';
@@ -520,6 +520,12 @@ declare class ContactListGateway {
520
520
  * @returns The paginated contact phones response.
521
521
  */
522
522
  getContactsPhones(params: GetContactPhonesParams): Promise<ContactPhoneSearchResponse>;
523
+ /**
524
+ * Searches WhatsApp accounts with optional filtering and pagination.
525
+ * @param params - The query parameters for the search.
526
+ * @returns The paginated WhatsApp accounts response.
527
+ */
528
+ searchWhatsappAccounts(params: SearchWhatsappAccountsRequest): Promise<SearchWhatsappAccountsResponse>;
523
529
  /**
524
530
  * Retrieves all contact categories.
525
531
  * @returns An array of contact categories.
@@ -1066,4 +1072,4 @@ declare const configure: (params: GatewayClientParams) => void;
1066
1072
  */
1067
1073
  declare function gateway<T extends keyof GatewayMap>(service: T): GatewayMap[T];
1068
1074
 
1069
- export { AccessPackage, ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementListFilters, AnnouncementListResponse, AnnouncementType, AppDetails, AppListResponse, AttachmentByIdResponse, AudioConvertResponse, AutomationPartner, AutomationPartnerAction, CallEndpoint, CallReportCompanyUsageRequest, CallReportCompanyUsageResponse, Campaign, CampaignAccessResponse, CampaignCompanyPaginatedResponse, CampaignCompanyQueryParams, CampaignCompanyResponse, CampaignContactPaginatedResponse, CampaignContactQueryParams, CampaignContactResponse, CampaignContactsDashboardData, CampaignContactsDashboardQueryParams, CampaignPaginatedResponse, CampaignQueryParams, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CancelInvitationRequest, CaseFeedByActionItem, CasePermissions, CaseStatus, CaseTimeEntry, ChatWebserviceCompanyUsageRequest, ChatWebserviceCompanyUsageResponse, CloneCaseRequest, ClonedCase, CommentHistoryPage, CompanyAccessPackageItem, CompanyBooleanConfigKey, CompanyConfigKey, CompanyConfigResponse, CompanyJsonConfigKey, CompanyQueue, CompanyResource, CompanyResponse, CompanyStringConfigKey, CompanyWithConfigsResponse, Config, ConfigListByProviderResponse, ContactCategoryResponse, ContactHistoryResponse, ContactPhoneSearchResponse, ContactResponse, CreateAnnouncementRequest, CreateAutomationPartnerRequest, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, CreateCaseStatusRequest, CreateCompanyAccessPackagePayload, CreateIntegrationActionRequest, CreateIntegrationFieldRequest, CreateIntegrationPartnerRequest, CreateSurveyResponseRequest, CreateTimeEntryRequest, CreateUserPreferenceRequest, CreateWebhookRequest$1 as CreateWebhookRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, DeleteTimeEntryRequest, DeleteUserDeviceResponse, DeleteUserPreferenceParams, DeleteUserPreferenceResponse, EnableCampaignCompanyRequest, FindContactByIdResponse, FindOrCreateContactRequest, FindOrCreateQueueRuleRequest, FlowCatalogParams, FlowCatalogResponse, FlowDefinition, FlowReadiness, ForwardMessageRequest, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, GetAccessPackagesParams, GetAllUsersParams, GetAllUsersResponse, GetAppRequest, GetAttachmentByIdRequest, GetAutomationPartnerRequest, GetCaseFeedByActionsRequest, GetCommentHistoryRequest, GetCompanyAccessPackagesParams, GetCompanyResourcesParams, GetConfigTemplatesParams, GetConfigTemplatesResponse, GetConfigsByProviderParams, GetContactPhonesParams, GetInitialContextRequest, GetInitialContextResponse, GetIntegrationHooksCatalogRequest, GetIntegrationPartnersByCompanyRequest, GetManagedUsersResponse, GetMemberQueuesRequest, GetMessagesByCursorRequest, GetMessagesByCursorResponse, GetPresignedUrlRequest, GetProviderConfigurationsParams, GetProviderDisplayInfoParams, GetRoomByIdRequest, GetRootRulesRequest, GetRuleByIdRequest, GetRulesCountRequest, GetRulesRequest, GetServiceGroupsParams, GetSupportWidgetIdResponse, GetSystemNotificationsParams, GetSystemNotificationsResponse, GetUserByIdResponse, GetUserDevicesParams, GetUserDevicesResponse, GetUserPreferencesParams, GetWebhooksByCompanyRequest$1 as GetWebhooksByCompanyRequest, HookCatalogItem, IntegrationAction, IntegrationField, IntegrationPartner, InvitationResponse, ListAutomationActionsRequest, ListAutomationPartnersRequest, ListCaseStatusesRequest, ListCasesRequest, ListCasesResponse, ListContactHistoryRequest, ListInvitationsRequest, ListLiveUserRoomsRequest, ListTimeEntriesPage, ListTimeEntriesRequest, ListUsersRequest, ListUsersResponse, LiveUserRoomResponse, MarkMessagesAsReadRequest, MarkMessagesAsReadResponse, MessageResponse, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, PaginatedResult, PatchCampaignContactRequest, PatchCampaignRequest, ProviderConfigurationsResponse, ProviderDisplayInfoResponse, ProviderListResponse, Queue, QueueMember, QueueRule, RegisterUserDeviceRequest, RegisterUserDeviceResponse, ReplyInvitationRequest, ResolveAppDatasourceRequest, ResolveAppDatasourceResponse, RoomMemberResponse, RoomResponse, RootRulesResponse, RuleResponse, RulesCountResponse, RulesResponse, SERVICE_GATEWAYS, SERVICE_GATEWAYS as SERVICE_GATEWAYS_TYPE, SendAttachmentMessageResponse, SendMessageRequest, ServiceGroupsResponse, StrongPasswordOptionsResponse, SubmitAppRequest, SurveyResponse, SurveyResponseListFilters, SurveyResponseListResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCasePermissionsRequest, UpdateCaseStatusRequest, UpdateCompanyAccessPackagePayload, UpdateCompanyBooleanConfigRequest, UpdateCompanyJsonConfigRequest, UpdateCompanyRequest, UpdateCompanyStringConfigRequest, UpdateCompanyUserAvatarResponse, UpdateCompanyUserRequest, UpdateIntegrationActionParams, UpdateIntegrationFieldParams, UpdateMemberInRoomRequest, UpdateSupportWidgetIdRequest, UpdateSupportWidgetIdResponse, UpdateTimeEntryRequest, UpdateUserPasswordRequest, UpdateUserPasswordResponse, UploadPresignedUrlResponse, User, UserPreference, UserProfile, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };
1075
+ export { AccessPackage, ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementListFilters, AnnouncementListResponse, AnnouncementType, AppDetails, AppListResponse, AttachmentByIdResponse, AudioConvertResponse, AutomationPartner, AutomationPartnerAction, CallEndpoint, CallReportCompanyUsageRequest, CallReportCompanyUsageResponse, Campaign, CampaignAccessResponse, CampaignCompanyPaginatedResponse, CampaignCompanyQueryParams, CampaignCompanyResponse, CampaignContactPaginatedResponse, CampaignContactQueryParams, CampaignContactResponse, CampaignContactsDashboardData, CampaignContactsDashboardQueryParams, CampaignPaginatedResponse, CampaignQueryParams, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CancelInvitationRequest, CaseFeedByActionItem, CasePermissions, CaseStatus, CaseTimeEntry, ChatWebserviceCompanyUsageRequest, ChatWebserviceCompanyUsageResponse, CloneCaseRequest, ClonedCase, CommentHistoryPage, CompanyAccessPackageItem, CompanyBooleanConfigKey, CompanyConfigKey, CompanyConfigResponse, CompanyJsonConfigKey, CompanyQueue, CompanyResource, CompanyResponse, CompanyStringConfigKey, CompanyWithConfigsResponse, Config, ConfigListByProviderResponse, ContactCategoryResponse, ContactHistoryResponse, ContactPhoneSearchResponse, ContactResponse, CreateAnnouncementRequest, CreateAutomationPartnerRequest, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, CreateCaseStatusRequest, CreateCompanyAccessPackagePayload, CreateIntegrationActionRequest, CreateIntegrationFieldRequest, CreateIntegrationPartnerRequest, CreateSurveyResponseRequest, CreateTimeEntryRequest, CreateUserPreferenceRequest, CreateWebhookRequest$1 as CreateWebhookRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, DeleteTimeEntryRequest, DeleteUserDeviceResponse, DeleteUserPreferenceParams, DeleteUserPreferenceResponse, EnableCampaignCompanyRequest, FindContactByIdResponse, FindOrCreateContactRequest, FindOrCreateQueueRuleRequest, FlowCatalogParams, FlowCatalogResponse, FlowDefinition, FlowReadiness, ForwardMessageRequest, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, GetAccessPackagesParams, GetAllUsersParams, GetAllUsersResponse, GetAppRequest, GetAttachmentByIdRequest, GetAutomationPartnerRequest, GetCaseFeedByActionsRequest, GetCommentHistoryRequest, GetCompanyAccessPackagesParams, GetCompanyResourcesParams, GetConfigTemplatesParams, GetConfigTemplatesResponse, GetConfigsByProviderParams, GetContactPhonesParams, GetInitialContextRequest, GetInitialContextResponse, GetIntegrationHooksCatalogRequest, GetIntegrationPartnersByCompanyRequest, GetManagedUsersResponse, GetMemberQueuesRequest, GetMessagesByCursorRequest, GetMessagesByCursorResponse, GetPresignedUrlRequest, GetProviderConfigurationsParams, GetProviderDisplayInfoParams, GetRoomByIdRequest, GetRootRulesRequest, GetRuleByIdRequest, GetRulesCountRequest, GetRulesRequest, GetServiceGroupsParams, GetSupportWidgetIdResponse, GetSystemNotificationsParams, GetSystemNotificationsResponse, GetUserByIdResponse, GetUserDevicesParams, GetUserDevicesResponse, GetUserPreferencesParams, GetWebhooksByCompanyRequest$1 as GetWebhooksByCompanyRequest, HookCatalogItem, IntegrationAction, IntegrationField, IntegrationPartner, InvitationResponse, ListAutomationActionsRequest, ListAutomationPartnersRequest, ListCaseStatusesRequest, ListCasesRequest, ListCasesResponse, ListContactHistoryRequest, ListInvitationsRequest, ListLiveUserRoomsRequest, ListTimeEntriesPage, ListTimeEntriesRequest, ListUsersRequest, ListUsersResponse, LiveUserRoomResponse, MarkMessagesAsReadRequest, MarkMessagesAsReadResponse, MessageResponse, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, PaginatedResult, PatchCampaignContactRequest, PatchCampaignRequest, ProviderConfigurationsResponse, ProviderDisplayInfoResponse, ProviderListResponse, Queue, QueueMember, QueueRule, RegisterUserDeviceRequest, RegisterUserDeviceResponse, ReplyInvitationRequest, ResolveAppDatasourceRequest, ResolveAppDatasourceResponse, RoomMemberResponse, RoomResponse, RootRulesResponse, RuleResponse, RulesCountResponse, RulesResponse, SERVICE_GATEWAYS, SERVICE_GATEWAYS as SERVICE_GATEWAYS_TYPE, SearchWhatsappAccountsRequest, SearchWhatsappAccountsResponse, SendAttachmentMessageResponse, SendMessageRequest, ServiceGroupsResponse, StrongPasswordOptionsResponse, SubmitAppRequest, SurveyResponse, SurveyResponseListFilters, SurveyResponseListResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCasePermissionsRequest, UpdateCaseStatusRequest, UpdateCompanyAccessPackagePayload, UpdateCompanyBooleanConfigRequest, UpdateCompanyJsonConfigRequest, UpdateCompanyRequest, UpdateCompanyStringConfigRequest, UpdateCompanyUserAvatarResponse, UpdateCompanyUserRequest, UpdateIntegrationActionParams, UpdateIntegrationFieldParams, UpdateMemberInRoomRequest, UpdateSupportWidgetIdRequest, UpdateSupportWidgetIdResponse, UpdateTimeEntryRequest, UpdateUserPasswordRequest, UpdateUserPasswordResponse, UploadPresignedUrlResponse, User, UserPreference, UserProfile, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };
package/dist/index.d.ts CHANGED
@@ -9,8 +9,8 @@ import { GetConfigTemplatesParams, GetConfigTemplatesResponse, FlowReadiness, Fl
9
9
  export { ConfigTemplatesPaging, FlowCatalogItem, MessageTemplate, MessageTemplateComponent } from './chat-adapter/contracts/index.js';
10
10
  import { GetPresignedUrlRequest, UploadPresignedUrlResponse, AudioConvertResponse, GetAttachmentByIdRequest, AttachmentByIdResponse } from './assets/contracts/index.js';
11
11
  export { IUploadPresignedUrlResponse } from './assets/contracts/index.js';
12
- import { GetContactPhonesParams, ContactPhoneSearchResponse, ContactCategoryResponse, FindContactByIdResponse, FindOrCreateContactRequest, ContactResponse } from './contact-list/contracts/index.js';
13
- export { Contact, ContactPhoneResponse, FindContactByIdEmailResponse, FindContactByIdPhoneResponse } from './contact-list/contracts/index.js';
12
+ import { GetContactPhonesParams, ContactPhoneSearchResponse, SearchWhatsappAccountsRequest, SearchWhatsappAccountsResponse, ContactCategoryResponse, FindContactByIdResponse, FindOrCreateContactRequest, ContactResponse } from './contact-list/contracts/index.js';
13
+ export { Contact, ContactPhoneResponse, FindContactByIdEmailResponse, FindContactByIdPhoneResponse, WhatsappAccountResponse, WhatsappAccountSearchItemResponse } from './contact-list/contracts/index.js';
14
14
  import { AppListResponse, GetAppRequest, AppDetails, ResolveAppDatasourceRequest, ResolveAppDatasourceResponse, SubmitAppRequest, GetIntegrationPartnersByCompanyRequest, IntegrationPartner, GetWebhooksByCompanyRequest as GetWebhooksByCompanyRequest$1, GetIntegrationHooksCatalogRequest, HookCatalogItem, ListAutomationPartnersRequest, AutomationPartner, ListAutomationActionsRequest, AutomationPartnerAction, GetAutomationPartnerRequest, CreateAutomationPartnerRequest, CreateIntegrationPartnerRequest, CreateWebhookRequest as CreateWebhookRequest$1, DeleteIntegrationPartnerParams, CreateIntegrationActionRequest, IntegrationAction, UpdateIntegrationActionParams, CreateIntegrationFieldRequest, IntegrationField, UpdateIntegrationFieldParams, DeleteIntegrationFieldParams, DeleteIntegrationActionParams } from './integrations/contracts/index.js';
15
15
  export { App, AppDatasource, AppDatasourceItem, AppField, AppForm, AppSection, UpdateIntegrationActionRequest, UpdateIntegrationFieldRequest } from './integrations/contracts/index.js';
16
16
  import { ListInvitationsRequest, InvitationResponse, ReplyInvitationRequest, CancelInvitationRequest, ListLiveUserRoomsRequest, LiveUserRoomResponse, GetRoomByIdRequest, RoomResponse, GetInitialContextRequest, GetInitialContextResponse, GetMessagesByCursorRequest, GetMessagesByCursorResponse, SendMessageRequest, MessageResponse, ForwardMessageRequest, SendAttachmentMessageResponse, MarkMessagesAsReadRequest, MarkMessagesAsReadResponse, UpdateMemberInRoomRequest, RoomMemberResponse, ChatWebserviceCompanyUsageRequest, ChatWebserviceCompanyUsageResponse } from './chat-webservice/contracts/index.js';
@@ -520,6 +520,12 @@ declare class ContactListGateway {
520
520
  * @returns The paginated contact phones response.
521
521
  */
522
522
  getContactsPhones(params: GetContactPhonesParams): Promise<ContactPhoneSearchResponse>;
523
+ /**
524
+ * Searches WhatsApp accounts with optional filtering and pagination.
525
+ * @param params - The query parameters for the search.
526
+ * @returns The paginated WhatsApp accounts response.
527
+ */
528
+ searchWhatsappAccounts(params: SearchWhatsappAccountsRequest): Promise<SearchWhatsappAccountsResponse>;
523
529
  /**
524
530
  * Retrieves all contact categories.
525
531
  * @returns An array of contact categories.
@@ -1066,4 +1072,4 @@ declare const configure: (params: GatewayClientParams) => void;
1066
1072
  */
1067
1073
  declare function gateway<T extends keyof GatewayMap>(service: T): GatewayMap[T];
1068
1074
 
1069
- export { AccessPackage, ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementListFilters, AnnouncementListResponse, AnnouncementType, AppDetails, AppListResponse, AttachmentByIdResponse, AudioConvertResponse, AutomationPartner, AutomationPartnerAction, CallEndpoint, CallReportCompanyUsageRequest, CallReportCompanyUsageResponse, Campaign, CampaignAccessResponse, CampaignCompanyPaginatedResponse, CampaignCompanyQueryParams, CampaignCompanyResponse, CampaignContactPaginatedResponse, CampaignContactQueryParams, CampaignContactResponse, CampaignContactsDashboardData, CampaignContactsDashboardQueryParams, CampaignPaginatedResponse, CampaignQueryParams, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CancelInvitationRequest, CaseFeedByActionItem, CasePermissions, CaseStatus, CaseTimeEntry, ChatWebserviceCompanyUsageRequest, ChatWebserviceCompanyUsageResponse, CloneCaseRequest, ClonedCase, CommentHistoryPage, CompanyAccessPackageItem, CompanyBooleanConfigKey, CompanyConfigKey, CompanyConfigResponse, CompanyJsonConfigKey, CompanyQueue, CompanyResource, CompanyResponse, CompanyStringConfigKey, CompanyWithConfigsResponse, Config, ConfigListByProviderResponse, ContactCategoryResponse, ContactHistoryResponse, ContactPhoneSearchResponse, ContactResponse, CreateAnnouncementRequest, CreateAutomationPartnerRequest, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, CreateCaseStatusRequest, CreateCompanyAccessPackagePayload, CreateIntegrationActionRequest, CreateIntegrationFieldRequest, CreateIntegrationPartnerRequest, CreateSurveyResponseRequest, CreateTimeEntryRequest, CreateUserPreferenceRequest, CreateWebhookRequest$1 as CreateWebhookRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, DeleteTimeEntryRequest, DeleteUserDeviceResponse, DeleteUserPreferenceParams, DeleteUserPreferenceResponse, EnableCampaignCompanyRequest, FindContactByIdResponse, FindOrCreateContactRequest, FindOrCreateQueueRuleRequest, FlowCatalogParams, FlowCatalogResponse, FlowDefinition, FlowReadiness, ForwardMessageRequest, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, GetAccessPackagesParams, GetAllUsersParams, GetAllUsersResponse, GetAppRequest, GetAttachmentByIdRequest, GetAutomationPartnerRequest, GetCaseFeedByActionsRequest, GetCommentHistoryRequest, GetCompanyAccessPackagesParams, GetCompanyResourcesParams, GetConfigTemplatesParams, GetConfigTemplatesResponse, GetConfigsByProviderParams, GetContactPhonesParams, GetInitialContextRequest, GetInitialContextResponse, GetIntegrationHooksCatalogRequest, GetIntegrationPartnersByCompanyRequest, GetManagedUsersResponse, GetMemberQueuesRequest, GetMessagesByCursorRequest, GetMessagesByCursorResponse, GetPresignedUrlRequest, GetProviderConfigurationsParams, GetProviderDisplayInfoParams, GetRoomByIdRequest, GetRootRulesRequest, GetRuleByIdRequest, GetRulesCountRequest, GetRulesRequest, GetServiceGroupsParams, GetSupportWidgetIdResponse, GetSystemNotificationsParams, GetSystemNotificationsResponse, GetUserByIdResponse, GetUserDevicesParams, GetUserDevicesResponse, GetUserPreferencesParams, GetWebhooksByCompanyRequest$1 as GetWebhooksByCompanyRequest, HookCatalogItem, IntegrationAction, IntegrationField, IntegrationPartner, InvitationResponse, ListAutomationActionsRequest, ListAutomationPartnersRequest, ListCaseStatusesRequest, ListCasesRequest, ListCasesResponse, ListContactHistoryRequest, ListInvitationsRequest, ListLiveUserRoomsRequest, ListTimeEntriesPage, ListTimeEntriesRequest, ListUsersRequest, ListUsersResponse, LiveUserRoomResponse, MarkMessagesAsReadRequest, MarkMessagesAsReadResponse, MessageResponse, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, PaginatedResult, PatchCampaignContactRequest, PatchCampaignRequest, ProviderConfigurationsResponse, ProviderDisplayInfoResponse, ProviderListResponse, Queue, QueueMember, QueueRule, RegisterUserDeviceRequest, RegisterUserDeviceResponse, ReplyInvitationRequest, ResolveAppDatasourceRequest, ResolveAppDatasourceResponse, RoomMemberResponse, RoomResponse, RootRulesResponse, RuleResponse, RulesCountResponse, RulesResponse, SERVICE_GATEWAYS, SERVICE_GATEWAYS as SERVICE_GATEWAYS_TYPE, SendAttachmentMessageResponse, SendMessageRequest, ServiceGroupsResponse, StrongPasswordOptionsResponse, SubmitAppRequest, SurveyResponse, SurveyResponseListFilters, SurveyResponseListResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCasePermissionsRequest, UpdateCaseStatusRequest, UpdateCompanyAccessPackagePayload, UpdateCompanyBooleanConfigRequest, UpdateCompanyJsonConfigRequest, UpdateCompanyRequest, UpdateCompanyStringConfigRequest, UpdateCompanyUserAvatarResponse, UpdateCompanyUserRequest, UpdateIntegrationActionParams, UpdateIntegrationFieldParams, UpdateMemberInRoomRequest, UpdateSupportWidgetIdRequest, UpdateSupportWidgetIdResponse, UpdateTimeEntryRequest, UpdateUserPasswordRequest, UpdateUserPasswordResponse, UploadPresignedUrlResponse, User, UserPreference, UserProfile, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };
1075
+ export { AccessPackage, ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementListFilters, AnnouncementListResponse, AnnouncementType, AppDetails, AppListResponse, AttachmentByIdResponse, AudioConvertResponse, AutomationPartner, AutomationPartnerAction, CallEndpoint, CallReportCompanyUsageRequest, CallReportCompanyUsageResponse, Campaign, CampaignAccessResponse, CampaignCompanyPaginatedResponse, CampaignCompanyQueryParams, CampaignCompanyResponse, CampaignContactPaginatedResponse, CampaignContactQueryParams, CampaignContactResponse, CampaignContactsDashboardData, CampaignContactsDashboardQueryParams, CampaignPaginatedResponse, CampaignQueryParams, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CancelInvitationRequest, CaseFeedByActionItem, CasePermissions, CaseStatus, CaseTimeEntry, ChatWebserviceCompanyUsageRequest, ChatWebserviceCompanyUsageResponse, CloneCaseRequest, ClonedCase, CommentHistoryPage, CompanyAccessPackageItem, CompanyBooleanConfigKey, CompanyConfigKey, CompanyConfigResponse, CompanyJsonConfigKey, CompanyQueue, CompanyResource, CompanyResponse, CompanyStringConfigKey, CompanyWithConfigsResponse, Config, ConfigListByProviderResponse, ContactCategoryResponse, ContactHistoryResponse, ContactPhoneSearchResponse, ContactResponse, CreateAnnouncementRequest, CreateAutomationPartnerRequest, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, CreateCaseStatusRequest, CreateCompanyAccessPackagePayload, CreateIntegrationActionRequest, CreateIntegrationFieldRequest, CreateIntegrationPartnerRequest, CreateSurveyResponseRequest, CreateTimeEntryRequest, CreateUserPreferenceRequest, CreateWebhookRequest$1 as CreateWebhookRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, DeleteTimeEntryRequest, DeleteUserDeviceResponse, DeleteUserPreferenceParams, DeleteUserPreferenceResponse, EnableCampaignCompanyRequest, FindContactByIdResponse, FindOrCreateContactRequest, FindOrCreateQueueRuleRequest, FlowCatalogParams, FlowCatalogResponse, FlowDefinition, FlowReadiness, ForwardMessageRequest, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, GetAccessPackagesParams, GetAllUsersParams, GetAllUsersResponse, GetAppRequest, GetAttachmentByIdRequest, GetAutomationPartnerRequest, GetCaseFeedByActionsRequest, GetCommentHistoryRequest, GetCompanyAccessPackagesParams, GetCompanyResourcesParams, GetConfigTemplatesParams, GetConfigTemplatesResponse, GetConfigsByProviderParams, GetContactPhonesParams, GetInitialContextRequest, GetInitialContextResponse, GetIntegrationHooksCatalogRequest, GetIntegrationPartnersByCompanyRequest, GetManagedUsersResponse, GetMemberQueuesRequest, GetMessagesByCursorRequest, GetMessagesByCursorResponse, GetPresignedUrlRequest, GetProviderConfigurationsParams, GetProviderDisplayInfoParams, GetRoomByIdRequest, GetRootRulesRequest, GetRuleByIdRequest, GetRulesCountRequest, GetRulesRequest, GetServiceGroupsParams, GetSupportWidgetIdResponse, GetSystemNotificationsParams, GetSystemNotificationsResponse, GetUserByIdResponse, GetUserDevicesParams, GetUserDevicesResponse, GetUserPreferencesParams, GetWebhooksByCompanyRequest$1 as GetWebhooksByCompanyRequest, HookCatalogItem, IntegrationAction, IntegrationField, IntegrationPartner, InvitationResponse, ListAutomationActionsRequest, ListAutomationPartnersRequest, ListCaseStatusesRequest, ListCasesRequest, ListCasesResponse, ListContactHistoryRequest, ListInvitationsRequest, ListLiveUserRoomsRequest, ListTimeEntriesPage, ListTimeEntriesRequest, ListUsersRequest, ListUsersResponse, LiveUserRoomResponse, MarkMessagesAsReadRequest, MarkMessagesAsReadResponse, MessageResponse, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, PaginatedResult, PatchCampaignContactRequest, PatchCampaignRequest, ProviderConfigurationsResponse, ProviderDisplayInfoResponse, ProviderListResponse, Queue, QueueMember, QueueRule, RegisterUserDeviceRequest, RegisterUserDeviceResponse, ReplyInvitationRequest, ResolveAppDatasourceRequest, ResolveAppDatasourceResponse, RoomMemberResponse, RoomResponse, RootRulesResponse, RuleResponse, RulesCountResponse, RulesResponse, SERVICE_GATEWAYS, SERVICE_GATEWAYS as SERVICE_GATEWAYS_TYPE, SearchWhatsappAccountsRequest, SearchWhatsappAccountsResponse, SendAttachmentMessageResponse, SendMessageRequest, ServiceGroupsResponse, StrongPasswordOptionsResponse, SubmitAppRequest, SurveyResponse, SurveyResponseListFilters, SurveyResponseListResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCasePermissionsRequest, UpdateCaseStatusRequest, UpdateCompanyAccessPackagePayload, UpdateCompanyBooleanConfigRequest, UpdateCompanyJsonConfigRequest, UpdateCompanyRequest, UpdateCompanyStringConfigRequest, UpdateCompanyUserAvatarResponse, UpdateCompanyUserRequest, UpdateIntegrationActionParams, UpdateIntegrationFieldParams, UpdateMemberInRoomRequest, UpdateSupportWidgetIdRequest, UpdateSupportWidgetIdResponse, UpdateTimeEntryRequest, UpdateUserPasswordRequest, UpdateUserPasswordResponse, UploadPresignedUrlResponse, User, UserPreference, UserProfile, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };
package/dist/index.js CHANGED
@@ -926,6 +926,17 @@ var ContactListGateway = class {
926
926
  });
927
927
  return data;
928
928
  }
929
+ /**
930
+ * Searches WhatsApp accounts with optional filtering and pagination.
931
+ * @param params - The query parameters for the search.
932
+ * @returns The paginated WhatsApp accounts response.
933
+ */
934
+ async searchWhatsappAccounts(params) {
935
+ const { data } = await this.httpClient.get(`${this.baseUrl}/whatsapp-accounts/search`, {
936
+ params
937
+ });
938
+ return data;
939
+ }
929
940
  /**
930
941
  * Retrieves all contact categories.
931
942
  * @returns An array of contact categories.