@opens/gateways 1.17.1 → 1.17.2
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.
- package/dist/contact-list/contracts/index.d.mts +47 -1
- package/dist/contact-list/contracts/index.d.ts +47 -1
- package/dist/contact-list/contracts/index.js.map +1 -1
- package/dist/index.d.mts +9 -3
- package/dist/index.d.ts +9 -3
- package/dist/index.js +11 -0
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +11 -0
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
|
@@ -56,11 +56,56 @@ interface FindContactByIdResponse extends Contact {
|
|
|
56
56
|
instagramProfile: Record<string, unknown>[];
|
|
57
57
|
}
|
|
58
58
|
|
|
59
|
+
/** Query parameters for searching WhatsApp accounts. */
|
|
60
|
+
interface SearchWhatsappAccountsRequest {
|
|
61
|
+
companyId?: string;
|
|
62
|
+
businessPortfolioId?: string;
|
|
63
|
+
filter?: string;
|
|
64
|
+
bsuid?: string;
|
|
65
|
+
name?: string;
|
|
66
|
+
limit?: number;
|
|
67
|
+
offset?: number;
|
|
68
|
+
orderBy?: 'name' | 'bsuid' | 'createdAt';
|
|
69
|
+
}
|
|
70
|
+
/** WhatsApp account returned by the Contact List API. */
|
|
71
|
+
interface WhatsappAccountResponse {
|
|
72
|
+
id: string;
|
|
73
|
+
companyId: string;
|
|
74
|
+
contactId: string;
|
|
75
|
+
businessPortfolioId: string;
|
|
76
|
+
bsuid: string;
|
|
77
|
+
phoneId: number | null;
|
|
78
|
+
phoneNumber: string | null;
|
|
79
|
+
createdAt: string;
|
|
80
|
+
updatedAt: string;
|
|
81
|
+
}
|
|
82
|
+
/** WhatsApp account with its contact details returned by search. */
|
|
83
|
+
interface WhatsappAccountSearchItemResponse extends WhatsappAccountResponse {
|
|
84
|
+
contact: Contact & {
|
|
85
|
+
organization: {
|
|
86
|
+
id: string;
|
|
87
|
+
name: string;
|
|
88
|
+
} | null;
|
|
89
|
+
category: {
|
|
90
|
+
id: string;
|
|
91
|
+
name: string;
|
|
92
|
+
} | null;
|
|
93
|
+
phones: FindContactByIdPhoneResponse[];
|
|
94
|
+
};
|
|
95
|
+
}
|
|
96
|
+
/** Paginated WhatsApp account search response. */
|
|
97
|
+
interface SearchWhatsappAccountsResponse {
|
|
98
|
+
total: number;
|
|
99
|
+
totalItems: number;
|
|
100
|
+
accounts: WhatsappAccountSearchItemResponse[];
|
|
101
|
+
}
|
|
102
|
+
|
|
59
103
|
/** Query parameters for searching contact phones. */
|
|
60
104
|
interface GetContactPhonesParams {
|
|
61
105
|
limit: number;
|
|
62
106
|
offset: number;
|
|
63
107
|
companyId: string;
|
|
108
|
+
businessPortfolioId?: string;
|
|
64
109
|
orderBy?: string;
|
|
65
110
|
filter?: string;
|
|
66
111
|
associations?: string[];
|
|
@@ -89,6 +134,7 @@ interface ContactPhoneResponse {
|
|
|
89
134
|
campaigns: {
|
|
90
135
|
campaignId: string;
|
|
91
136
|
}[];
|
|
137
|
+
whatsappAccounts?: WhatsappAccountResponse[];
|
|
92
138
|
};
|
|
93
139
|
}
|
|
94
140
|
/** Paginated response returned by the Contact List API for phone search. */
|
|
@@ -101,4 +147,4 @@ interface ContactCategoryResponse {
|
|
|
101
147
|
name: string;
|
|
102
148
|
}
|
|
103
149
|
|
|
104
|
-
export type { Contact, ContactCategoryResponse, ContactPhoneResponse, ContactPhoneSearchResponse, ContactResponse, FindContactByIdEmailResponse, FindContactByIdPhoneResponse, FindContactByIdResponse, FindOrCreateContactRequest, GetContactPhonesParams };
|
|
150
|
+
export type { Contact, ContactCategoryResponse, ContactPhoneResponse, ContactPhoneSearchResponse, ContactResponse, FindContactByIdEmailResponse, FindContactByIdPhoneResponse, FindContactByIdResponse, FindOrCreateContactRequest, GetContactPhonesParams, SearchWhatsappAccountsRequest, SearchWhatsappAccountsResponse, WhatsappAccountResponse, WhatsappAccountSearchItemResponse };
|
|
@@ -56,11 +56,56 @@ interface FindContactByIdResponse extends Contact {
|
|
|
56
56
|
instagramProfile: Record<string, unknown>[];
|
|
57
57
|
}
|
|
58
58
|
|
|
59
|
+
/** Query parameters for searching WhatsApp accounts. */
|
|
60
|
+
interface SearchWhatsappAccountsRequest {
|
|
61
|
+
companyId?: string;
|
|
62
|
+
businessPortfolioId?: string;
|
|
63
|
+
filter?: string;
|
|
64
|
+
bsuid?: string;
|
|
65
|
+
name?: string;
|
|
66
|
+
limit?: number;
|
|
67
|
+
offset?: number;
|
|
68
|
+
orderBy?: 'name' | 'bsuid' | 'createdAt';
|
|
69
|
+
}
|
|
70
|
+
/** WhatsApp account returned by the Contact List API. */
|
|
71
|
+
interface WhatsappAccountResponse {
|
|
72
|
+
id: string;
|
|
73
|
+
companyId: string;
|
|
74
|
+
contactId: string;
|
|
75
|
+
businessPortfolioId: string;
|
|
76
|
+
bsuid: string;
|
|
77
|
+
phoneId: number | null;
|
|
78
|
+
phoneNumber: string | null;
|
|
79
|
+
createdAt: string;
|
|
80
|
+
updatedAt: string;
|
|
81
|
+
}
|
|
82
|
+
/** WhatsApp account with its contact details returned by search. */
|
|
83
|
+
interface WhatsappAccountSearchItemResponse extends WhatsappAccountResponse {
|
|
84
|
+
contact: Contact & {
|
|
85
|
+
organization: {
|
|
86
|
+
id: string;
|
|
87
|
+
name: string;
|
|
88
|
+
} | null;
|
|
89
|
+
category: {
|
|
90
|
+
id: string;
|
|
91
|
+
name: string;
|
|
92
|
+
} | null;
|
|
93
|
+
phones: FindContactByIdPhoneResponse[];
|
|
94
|
+
};
|
|
95
|
+
}
|
|
96
|
+
/** Paginated WhatsApp account search response. */
|
|
97
|
+
interface SearchWhatsappAccountsResponse {
|
|
98
|
+
total: number;
|
|
99
|
+
totalItems: number;
|
|
100
|
+
accounts: WhatsappAccountSearchItemResponse[];
|
|
101
|
+
}
|
|
102
|
+
|
|
59
103
|
/** Query parameters for searching contact phones. */
|
|
60
104
|
interface GetContactPhonesParams {
|
|
61
105
|
limit: number;
|
|
62
106
|
offset: number;
|
|
63
107
|
companyId: string;
|
|
108
|
+
businessPortfolioId?: string;
|
|
64
109
|
orderBy?: string;
|
|
65
110
|
filter?: string;
|
|
66
111
|
associations?: string[];
|
|
@@ -89,6 +134,7 @@ interface ContactPhoneResponse {
|
|
|
89
134
|
campaigns: {
|
|
90
135
|
campaignId: string;
|
|
91
136
|
}[];
|
|
137
|
+
whatsappAccounts?: WhatsappAccountResponse[];
|
|
92
138
|
};
|
|
93
139
|
}
|
|
94
140
|
/** Paginated response returned by the Contact List API for phone search. */
|
|
@@ -101,4 +147,4 @@ interface ContactCategoryResponse {
|
|
|
101
147
|
name: string;
|
|
102
148
|
}
|
|
103
149
|
|
|
104
|
-
export type { Contact, ContactCategoryResponse, ContactPhoneResponse, ContactPhoneSearchResponse, ContactResponse, FindContactByIdEmailResponse, FindContactByIdPhoneResponse, FindContactByIdResponse, FindOrCreateContactRequest, GetContactPhonesParams };
|
|
150
|
+
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.
|