@opens/gateways 1.15.11 → 1.15.13
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 +24 -1
- package/dist/contact-list/contracts/index.d.ts +24 -1
- package/dist/contact-list/contracts/index.js.map +1 -1
- package/dist/customer-service/contracts/index.d.mts +35 -31
- package/dist/customer-service/contracts/index.d.ts +35 -31
- package/dist/index.d.mts +18 -5
- package/dist/index.d.ts +18 -5
- package/dist/index.js +26 -7
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +26 -7
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
|
@@ -1,3 +1,26 @@
|
|
|
1
|
+
/** Request payload and query parameters for finding or creating a contact. */
|
|
2
|
+
interface FindOrCreateContactRequest {
|
|
3
|
+
contactName: string;
|
|
4
|
+
companyId: string;
|
|
5
|
+
email: string;
|
|
6
|
+
}
|
|
7
|
+
/** Contact returned by the Contact List API. */
|
|
8
|
+
interface ContactResponse {
|
|
9
|
+
id: string;
|
|
10
|
+
belongsTo: string;
|
|
11
|
+
name: string;
|
|
12
|
+
cpf: string | null;
|
|
13
|
+
isActive: boolean;
|
|
14
|
+
avatar: string | null;
|
|
15
|
+
declinedMarketing: boolean;
|
|
16
|
+
customField: Record<string, unknown>;
|
|
17
|
+
deletedAt: string | null;
|
|
18
|
+
createdAt: string;
|
|
19
|
+
updatedAt: string;
|
|
20
|
+
categoryId: string | null;
|
|
21
|
+
organizationId: string | null;
|
|
22
|
+
}
|
|
23
|
+
|
|
1
24
|
/** Query parameters for searching contact phones. */
|
|
2
25
|
interface GetContactPhonesParams {
|
|
3
26
|
limit: number;
|
|
@@ -43,4 +66,4 @@ interface ContactCategoryResponse {
|
|
|
43
66
|
name: string;
|
|
44
67
|
}
|
|
45
68
|
|
|
46
|
-
export type { ContactCategoryResponse, ContactPhoneResponse, ContactPhoneSearchResponse, GetContactPhonesParams };
|
|
69
|
+
export type { ContactCategoryResponse, ContactPhoneResponse, ContactPhoneSearchResponse, ContactResponse, FindOrCreateContactRequest, GetContactPhonesParams };
|
|
@@ -1,3 +1,26 @@
|
|
|
1
|
+
/** Request payload and query parameters for finding or creating a contact. */
|
|
2
|
+
interface FindOrCreateContactRequest {
|
|
3
|
+
contactName: string;
|
|
4
|
+
companyId: string;
|
|
5
|
+
email: string;
|
|
6
|
+
}
|
|
7
|
+
/** Contact returned by the Contact List API. */
|
|
8
|
+
interface ContactResponse {
|
|
9
|
+
id: string;
|
|
10
|
+
belongsTo: string;
|
|
11
|
+
name: string;
|
|
12
|
+
cpf: string | null;
|
|
13
|
+
isActive: boolean;
|
|
14
|
+
avatar: string | null;
|
|
15
|
+
declinedMarketing: boolean;
|
|
16
|
+
customField: Record<string, unknown>;
|
|
17
|
+
deletedAt: string | null;
|
|
18
|
+
createdAt: string;
|
|
19
|
+
updatedAt: string;
|
|
20
|
+
categoryId: string | null;
|
|
21
|
+
organizationId: string | null;
|
|
22
|
+
}
|
|
23
|
+
|
|
1
24
|
/** Query parameters for searching contact phones. */
|
|
2
25
|
interface GetContactPhonesParams {
|
|
3
26
|
limit: number;
|
|
@@ -43,4 +66,4 @@ interface ContactCategoryResponse {
|
|
|
43
66
|
name: string;
|
|
44
67
|
}
|
|
45
68
|
|
|
46
|
-
export type { ContactCategoryResponse, ContactPhoneResponse, ContactPhoneSearchResponse, GetContactPhonesParams };
|
|
69
|
+
export type { ContactCategoryResponse, ContactPhoneResponse, ContactPhoneSearchResponse, ContactResponse, FindOrCreateContactRequest, GetContactPhonesParams };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../src/contact-list/contracts/index.ts"],"sourcesContent":["export * 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';\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
|
|
@@ -97,41 +97,41 @@ interface User {
|
|
|
97
97
|
username: string;
|
|
98
98
|
email: string;
|
|
99
99
|
profile: 'p_admin' | 'p_manager' | 'p_corporative' | 'p_agent';
|
|
100
|
-
|
|
100
|
+
language: string;
|
|
101
|
+
access_token: string;
|
|
102
|
+
occupation: string;
|
|
103
|
+
endpoint: string;
|
|
104
|
+
phone_number: string | null;
|
|
105
|
+
usercode: number;
|
|
106
|
+
queues: unknown[] | null;
|
|
101
107
|
avatar: string | null;
|
|
102
108
|
type: string;
|
|
103
|
-
|
|
109
|
+
status: 'new' | 'activated' | 'disabled';
|
|
110
|
+
redefine_code: number;
|
|
111
|
+
redefine_expires: string;
|
|
112
|
+
state: string;
|
|
113
|
+
pause: Record<string, unknown> | null;
|
|
114
|
+
last_event_time: string;
|
|
115
|
+
oncall: boolean;
|
|
116
|
+
ringing: boolean;
|
|
117
|
+
callnumber: string;
|
|
118
|
+
timezone: string;
|
|
119
|
+
utc: string;
|
|
120
|
+
peer_create: string;
|
|
121
|
+
token_id: string;
|
|
122
|
+
tech_channel: string;
|
|
123
|
+
bad_password: number;
|
|
124
|
+
block_status: string;
|
|
125
|
+
two_auth_mail: boolean;
|
|
126
|
+
two_auth_otp: boolean;
|
|
127
|
+
otp_key: string | null;
|
|
128
|
+
watching: boolean;
|
|
129
|
+
trial: boolean;
|
|
130
|
+
ringing_sound: string | null;
|
|
104
131
|
createdAt: string;
|
|
105
132
|
updatedAt: string;
|
|
133
|
+
company_id: string;
|
|
106
134
|
password?: string;
|
|
107
|
-
language?: string;
|
|
108
|
-
access_token?: string;
|
|
109
|
-
occupation?: string | null;
|
|
110
|
-
endpoint?: string;
|
|
111
|
-
phone_number?: string | null;
|
|
112
|
-
usercode?: number;
|
|
113
|
-
redefine_code?: number;
|
|
114
|
-
redefine_expires?: string;
|
|
115
|
-
state?: string;
|
|
116
|
-
pause?: string | null;
|
|
117
|
-
last_event_time?: string | null;
|
|
118
|
-
oncall?: boolean;
|
|
119
|
-
ringing?: boolean;
|
|
120
|
-
callnumber?: string;
|
|
121
|
-
timezone?: string;
|
|
122
|
-
utc?: string;
|
|
123
|
-
peer_create?: string;
|
|
124
|
-
token_id?: string;
|
|
125
|
-
tech_channel?: string;
|
|
126
|
-
bad_password?: number | null;
|
|
127
|
-
block_status?: string;
|
|
128
|
-
two_auth_mail?: boolean;
|
|
129
|
-
two_auth_otp?: boolean;
|
|
130
|
-
otp_key?: string | null;
|
|
131
|
-
watching?: boolean;
|
|
132
|
-
trial?: boolean;
|
|
133
|
-
ringing_sound?: string;
|
|
134
|
-
company_id?: string;
|
|
135
135
|
}
|
|
136
136
|
interface GetAllUsersParams {
|
|
137
137
|
status?: string;
|
|
@@ -152,6 +152,10 @@ interface ManagedUser {
|
|
|
152
152
|
updatedAt: string;
|
|
153
153
|
}
|
|
154
154
|
type GetManagedUsersResponse = ManagedUser[];
|
|
155
|
+
/** Response returned by the Customer Service API when fetching a user by identifier. */
|
|
156
|
+
interface GetUserByIdResponse {
|
|
157
|
+
user: User;
|
|
158
|
+
}
|
|
155
159
|
/** Request payload for updating a company user. */
|
|
156
160
|
interface UpdateCompanyUserRequest {
|
|
157
161
|
username?: string;
|
|
@@ -382,4 +386,4 @@ interface ValidateTwoFactorOtpResponse {
|
|
|
382
386
|
validate: boolean;
|
|
383
387
|
}
|
|
384
388
|
|
|
385
|
-
export type { ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementAppearance, AnnouncementButton, AnnouncementCompany, AnnouncementListFilters, AnnouncementListResponse, AnnouncementPayload, AnnouncementTargetingRuleUrl, AnnouncementTargetingRules, AnnouncementType, AnnouncementVisualStatus, CompanyData, CompanyResponse, CreateAnnouncementRequest, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse, ManagedUser, StrongPasswordOptions, StrongPasswordOptionsResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCompanyUserAvatarResponse, UpdateCompanyUserRequest, UpdateUserPasswordRequest, UpdateUserPasswordResponse, User, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, WorkGroup, WorkGroupListResponse, WorkGroupMember, WorkGroupMembersResponse, WorkGroupResponse };
|
|
389
|
+
export type { ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementAppearance, AnnouncementButton, AnnouncementCompany, AnnouncementListFilters, AnnouncementListResponse, AnnouncementPayload, AnnouncementTargetingRuleUrl, AnnouncementTargetingRules, AnnouncementType, AnnouncementVisualStatus, CompanyData, CompanyResponse, CreateAnnouncementRequest, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse, GetUserByIdResponse, ManagedUser, StrongPasswordOptions, StrongPasswordOptionsResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCompanyUserAvatarResponse, UpdateCompanyUserRequest, UpdateUserPasswordRequest, UpdateUserPasswordResponse, User, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, WorkGroup, WorkGroupListResponse, WorkGroupMember, WorkGroupMembersResponse, WorkGroupResponse };
|
|
@@ -97,41 +97,41 @@ interface User {
|
|
|
97
97
|
username: string;
|
|
98
98
|
email: string;
|
|
99
99
|
profile: 'p_admin' | 'p_manager' | 'p_corporative' | 'p_agent';
|
|
100
|
-
|
|
100
|
+
language: string;
|
|
101
|
+
access_token: string;
|
|
102
|
+
occupation: string;
|
|
103
|
+
endpoint: string;
|
|
104
|
+
phone_number: string | null;
|
|
105
|
+
usercode: number;
|
|
106
|
+
queues: unknown[] | null;
|
|
101
107
|
avatar: string | null;
|
|
102
108
|
type: string;
|
|
103
|
-
|
|
109
|
+
status: 'new' | 'activated' | 'disabled';
|
|
110
|
+
redefine_code: number;
|
|
111
|
+
redefine_expires: string;
|
|
112
|
+
state: string;
|
|
113
|
+
pause: Record<string, unknown> | null;
|
|
114
|
+
last_event_time: string;
|
|
115
|
+
oncall: boolean;
|
|
116
|
+
ringing: boolean;
|
|
117
|
+
callnumber: string;
|
|
118
|
+
timezone: string;
|
|
119
|
+
utc: string;
|
|
120
|
+
peer_create: string;
|
|
121
|
+
token_id: string;
|
|
122
|
+
tech_channel: string;
|
|
123
|
+
bad_password: number;
|
|
124
|
+
block_status: string;
|
|
125
|
+
two_auth_mail: boolean;
|
|
126
|
+
two_auth_otp: boolean;
|
|
127
|
+
otp_key: string | null;
|
|
128
|
+
watching: boolean;
|
|
129
|
+
trial: boolean;
|
|
130
|
+
ringing_sound: string | null;
|
|
104
131
|
createdAt: string;
|
|
105
132
|
updatedAt: string;
|
|
133
|
+
company_id: string;
|
|
106
134
|
password?: string;
|
|
107
|
-
language?: string;
|
|
108
|
-
access_token?: string;
|
|
109
|
-
occupation?: string | null;
|
|
110
|
-
endpoint?: string;
|
|
111
|
-
phone_number?: string | null;
|
|
112
|
-
usercode?: number;
|
|
113
|
-
redefine_code?: number;
|
|
114
|
-
redefine_expires?: string;
|
|
115
|
-
state?: string;
|
|
116
|
-
pause?: string | null;
|
|
117
|
-
last_event_time?: string | null;
|
|
118
|
-
oncall?: boolean;
|
|
119
|
-
ringing?: boolean;
|
|
120
|
-
callnumber?: string;
|
|
121
|
-
timezone?: string;
|
|
122
|
-
utc?: string;
|
|
123
|
-
peer_create?: string;
|
|
124
|
-
token_id?: string;
|
|
125
|
-
tech_channel?: string;
|
|
126
|
-
bad_password?: number | null;
|
|
127
|
-
block_status?: string;
|
|
128
|
-
two_auth_mail?: boolean;
|
|
129
|
-
two_auth_otp?: boolean;
|
|
130
|
-
otp_key?: string | null;
|
|
131
|
-
watching?: boolean;
|
|
132
|
-
trial?: boolean;
|
|
133
|
-
ringing_sound?: string;
|
|
134
|
-
company_id?: string;
|
|
135
135
|
}
|
|
136
136
|
interface GetAllUsersParams {
|
|
137
137
|
status?: string;
|
|
@@ -152,6 +152,10 @@ interface ManagedUser {
|
|
|
152
152
|
updatedAt: string;
|
|
153
153
|
}
|
|
154
154
|
type GetManagedUsersResponse = ManagedUser[];
|
|
155
|
+
/** Response returned by the Customer Service API when fetching a user by identifier. */
|
|
156
|
+
interface GetUserByIdResponse {
|
|
157
|
+
user: User;
|
|
158
|
+
}
|
|
155
159
|
/** Request payload for updating a company user. */
|
|
156
160
|
interface UpdateCompanyUserRequest {
|
|
157
161
|
username?: string;
|
|
@@ -382,4 +386,4 @@ interface ValidateTwoFactorOtpResponse {
|
|
|
382
386
|
validate: boolean;
|
|
383
387
|
}
|
|
384
388
|
|
|
385
|
-
export type { ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementAppearance, AnnouncementButton, AnnouncementCompany, AnnouncementListFilters, AnnouncementListResponse, AnnouncementPayload, AnnouncementTargetingRuleUrl, AnnouncementTargetingRules, AnnouncementType, AnnouncementVisualStatus, CompanyData, CompanyResponse, CreateAnnouncementRequest, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse, ManagedUser, StrongPasswordOptions, StrongPasswordOptionsResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCompanyUserAvatarResponse, UpdateCompanyUserRequest, UpdateUserPasswordRequest, UpdateUserPasswordResponse, User, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, WorkGroup, WorkGroupListResponse, WorkGroupMember, WorkGroupMembersResponse, WorkGroupResponse };
|
|
389
|
+
export type { ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementAppearance, AnnouncementButton, AnnouncementCompany, AnnouncementListFilters, AnnouncementListResponse, AnnouncementPayload, AnnouncementTargetingRuleUrl, AnnouncementTargetingRules, AnnouncementType, AnnouncementVisualStatus, CompanyData, CompanyResponse, CreateAnnouncementRequest, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse, GetUserByIdResponse, ManagedUser, StrongPasswordOptions, StrongPasswordOptionsResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCompanyUserAvatarResponse, UpdateCompanyUserRequest, UpdateUserPasswordRequest, UpdateUserPasswordResponse, User, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, WorkGroup, WorkGroupListResponse, WorkGroupMember, WorkGroupMembersResponse, WorkGroupResponse };
|
package/dist/index.d.mts
CHANGED
|
@@ -1,15 +1,15 @@
|
|
|
1
1
|
import { AxiosInstance } from 'axios';
|
|
2
|
-
import { CompanyResponse, StrongPasswordOptionsResponse, User, WorkGroupListResponse, WorkGroupResponse, WorkGroupMembersResponse, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse, UpdateCompanyUserRequest, UpdateUserPasswordRequest, UpdateUserPasswordResponse, UpdateCompanyUserAvatarResponse, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, AnnouncementListFilters, AnnouncementListResponse, Announcement, CreateAnnouncementRequest, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, AnnouncementType, ActiveAnnouncementQuery, ActiveAnnouncement } from './customer-service/contracts/index.mjs';
|
|
2
|
+
import { CompanyResponse, StrongPasswordOptionsResponse, User, WorkGroupListResponse, WorkGroupResponse, WorkGroupMembersResponse, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse, GetUserByIdResponse, UpdateCompanyUserRequest, UpdateUserPasswordRequest, UpdateUserPasswordResponse, UpdateCompanyUserAvatarResponse, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, AnnouncementListFilters, AnnouncementListResponse, Announcement, CreateAnnouncementRequest, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, AnnouncementType, ActiveAnnouncementQuery, ActiveAnnouncement } from './customer-service/contracts/index.mjs';
|
|
3
3
|
export { AnnouncementAppearance, AnnouncementButton, AnnouncementCompany, AnnouncementPayload, AnnouncementTargetingRuleUrl, AnnouncementTargetingRules, AnnouncementVisualStatus, CompanyData, ManagedUser, StrongPasswordOptions, WorkGroup, WorkGroupMember } from './customer-service/contracts/index.mjs';
|
|
4
|
-
import { ProviderListResponse, GetProviderConfigurationsParams, ProviderConfigurationsResponse, GetProviderDisplayInfoParams, ProviderDisplayInfoResponse, GetConfigsByProviderParams, ConfigListByProviderResponse, Queue, GetMemberQueuesRequest, QueueMember, GetServiceGroupsParams, ServiceGroupsResponse, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, FindOrCreateQueueRuleRequest, QueueRule, GetRootRulesRequest, RootRulesResponse } from './chat-config/contracts/index.mjs';
|
|
5
|
-
export {
|
|
4
|
+
import { ProviderListResponse, Config, GetProviderConfigurationsParams, ProviderConfigurationsResponse, GetProviderDisplayInfoParams, ProviderDisplayInfoResponse, GetConfigsByProviderParams, ConfigListByProviderResponse, Queue, GetMemberQueuesRequest, QueueMember, GetServiceGroupsParams, ServiceGroupsResponse, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, FindOrCreateQueueRuleRequest, QueueRule, GetRootRulesRequest, RootRulesResponse } from './chat-config/contracts/index.mjs';
|
|
5
|
+
export { ConfigProvider, DistributionType, MetaTemplateButton, Provider, ProviderConfiguration, ProviderName, QueueListResponse, Rule, ServiceGroup, WhatsAppProviderSettings, WidgetProviderSettings } from './chat-config/contracts/index.mjs';
|
|
6
6
|
import { CampaignQueryParams, CampaignPaginatedResponse, Campaign, CreateCampaignRequest, PatchCampaignRequest, CampaignContactQueryParams, CampaignContactPaginatedResponse, CampaignContactResponse, CreateCampaignContactRequest, PatchCampaignContactRequest, CampaignContactsDashboardQueryParams, CampaignContactsDashboardData, CampaignUser, CampaignWorkGroupQueryParams, CampaignWorkGroupPaginatedResponse, CreateCampaignWorkGroupRequest, CampaignWorkGroup, CampaignCompanyQueryParams, CampaignCompanyPaginatedResponse, CampaignCompanyResponse, EnableCampaignCompanyRequest, CampaignAccessResponse } from './campaigns/contracts/index.mjs';
|
|
7
7
|
export { CampaignAccessReason, CampaignContactCampaignStatus, CampaignContactDispatchStatus, CampaignContactFilter, CampaignContactLikeQueryOperators, CampaignContactQueryOperators, CampaignContactQueryValue, CampaignContactSortDirection, CampaignContactSortParams, CampaignContactsDashboardChannelPerformance, CampaignContactsDashboardEvolutionItem, CampaignContactsDashboardExactQueryOperators, CampaignContactsDashboardFunnelItem, CampaignContactsDashboardInterval, CampaignContactsDashboardMetrics, CampaignContactsDashboardQueryValue, CampaignContactsDashboardRangeQueryOperators, CampaignContactsDashboardStatusDistribution, CampaignContactsDashboardStatusMetrics, CampaignContactsDashboardSummary, CampaignContactsDashboardTopCampaign, CampaignProvider, CampaignRetryConfig, CampaignSchedule, CampaignStatus, WhatsAppPayload, WhatsAppTemplateComponent } from './campaigns/contracts/index.mjs';
|
|
8
8
|
import { GetConfigTemplatesParams, GetConfigTemplatesResponse, FlowReadiness, FlowCatalogParams, FlowCatalogResponse, FlowDefinition } from './chat-adapter/contracts/index.mjs';
|
|
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 } from './contact-list/contracts/index.mjs';
|
|
12
|
+
import { GetContactPhonesParams, ContactPhoneSearchResponse, ContactCategoryResponse, FindOrCreateContactRequest, ContactResponse } from './contact-list/contracts/index.mjs';
|
|
13
13
|
export { ContactPhoneResponse } from './contact-list/contracts/index.mjs';
|
|
14
14
|
import { 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 { UpdateIntegrationActionRequest, UpdateIntegrationFieldRequest } from './integrations/contracts/index.mjs';
|
|
@@ -71,6 +71,12 @@ declare class CustomerServiceGateway {
|
|
|
71
71
|
getWorkGroupMembers(groupId: string, companyId?: string, profile?: string[]): Promise<WorkGroupMembersResponse>;
|
|
72
72
|
getAllUsers(params?: GetAllUsersParams): Promise<GetAllUsersResponse>;
|
|
73
73
|
getManagedUsers(managerId: string): Promise<GetManagedUsersResponse>;
|
|
74
|
+
/**
|
|
75
|
+
* Retrieves a user by its unique identifier.
|
|
76
|
+
* @param userId - The unique identifier of the user.
|
|
77
|
+
* @returns The user data wrapped in a {@link GetUserByIdResponse}.
|
|
78
|
+
*/
|
|
79
|
+
getUserById(userId: string): Promise<GetUserByIdResponse>;
|
|
74
80
|
/**
|
|
75
81
|
* Updates a company user by its unique identifier.
|
|
76
82
|
* @param userId - The unique identifier of the user.
|
|
@@ -169,6 +175,7 @@ declare class ChatConfigGateway {
|
|
|
169
175
|
* @returns The list of providers.
|
|
170
176
|
*/
|
|
171
177
|
getProviders(): Promise<ProviderListResponse>;
|
|
178
|
+
getConfigById(configId: string): Promise<Config>;
|
|
172
179
|
/**
|
|
173
180
|
* Retrieves provider configurations filtered by configuration IDs.
|
|
174
181
|
* @param params - Query parameters containing one or more configuration IDs.
|
|
@@ -415,6 +422,12 @@ declare class ContactListGateway {
|
|
|
415
422
|
* @returns An array of contact categories.
|
|
416
423
|
*/
|
|
417
424
|
getCategoryList(): Promise<ContactCategoryResponse[]>;
|
|
425
|
+
/**
|
|
426
|
+
* Finds an existing contact or creates a new one.
|
|
427
|
+
* @param payload - The contact data sent as query parameters and in the request body.
|
|
428
|
+
* @returns The existing or newly created contact.
|
|
429
|
+
*/
|
|
430
|
+
findOrCreateContact(payload: FindOrCreateContactRequest): Promise<ContactResponse>;
|
|
418
431
|
}
|
|
419
432
|
|
|
420
433
|
/**
|
|
@@ -812,4 +825,4 @@ declare const configure: (params: GatewayClientParams) => void;
|
|
|
812
825
|
*/
|
|
813
826
|
declare function gateway<T extends keyof GatewayMap>(service: T): GatewayMap[T];
|
|
814
827
|
|
|
815
|
-
export { AccessPackage, ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementListFilters, AnnouncementListResponse, AnnouncementType, AttachmentByIdResponse, AudioConvertResponse, AutomationPartner, AutomationPartnerAction, Campaign, CampaignAccessResponse, CampaignCompanyPaginatedResponse, CampaignCompanyQueryParams, CampaignCompanyResponse, CampaignContactPaginatedResponse, CampaignContactQueryParams, CampaignContactResponse, CampaignContactsDashboardData, CampaignContactsDashboardQueryParams, CampaignPaginatedResponse, CampaignQueryParams, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CancelInvitationRequest, CaseFeedByActionItem, CasePermissions, CaseTimeEntry, CommentHistoryPage, CompanyAccessPackageItem, CompanyResource, CompanyResponse, ConfigListByProviderResponse, ContactCategoryResponse, ContactHistoryResponse, ContactPhoneSearchResponse, CreateAnnouncementRequest, CreateAutomationPartnerRequest, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, CreateCompanyAccessPackagePayload, CreateIntegrationActionRequest, CreateIntegrationFieldRequest, CreateIntegrationPartnerRequest, CreateTimeEntryRequest, CreateWebhookRequest$1 as CreateWebhookRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, DeleteTimeEntryRequest, EnableCampaignCompanyRequest, FindOrCreateQueueRuleRequest, FlowCatalogParams, FlowCatalogResponse, FlowDefinition, FlowReadiness, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, GetAccessPackagesParams, GetAllUsersParams, GetAllUsersResponse, GetAttachmentByIdRequest, GetAutomationPartnerRequest, GetCaseFeedByActionsRequest, GetCommentHistoryRequest, GetCompanyAccessPackagesParams, GetCompanyResourcesParams, GetConfigTemplatesParams, GetConfigTemplatesResponse, GetConfigsByProviderParams, GetContactPhonesParams, GetInitialContextRequest, GetInitialContextResponse, GetIntegrationHooksCatalogRequest, GetIntegrationPartnersByCompanyRequest, GetManagedUsersResponse, GetMemberQueuesRequest, GetMessagesByCursorRequest, GetMessagesByCursorResponse, GetPresignedUrlRequest, GetProviderConfigurationsParams, GetProviderDisplayInfoParams, GetRoomByIdRequest, GetRootRulesRequest, GetServiceGroupsParams, GetWebhooksByCompanyRequest$1 as GetWebhooksByCompanyRequest, HookCatalogItem, IntegrationAction, IntegrationField, IntegrationPartner, InvitationResponse, ListAutomationActionsRequest, ListAutomationPartnersRequest, ListCasesRequest, ListCasesResponse, ListContactHistoryRequest, ListInvitationsRequest, ListLiveUserRoomsRequest, ListTimeEntriesPage, ListTimeEntriesRequest, LiveUserRoomResponse, MarkMessagesAsReadRequest, MarkMessagesAsReadResponse, MessageResponse, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, PaginatedResult, PatchCampaignContactRequest, PatchCampaignRequest, ProviderConfigurationsResponse, ProviderDisplayInfoResponse, ProviderListResponse, Queue, QueueMember, QueueRule, ReplyInvitationRequest, RoomMemberResponse, RoomResponse, RootRulesResponse, SERVICE_GATEWAYS, SERVICE_GATEWAYS as SERVICE_GATEWAYS_TYPE, SendAttachmentMessageResponse, SendMessageRequest, ServiceGroupsResponse, StrongPasswordOptionsResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCasePermissionsRequest, UpdateCompanyAccessPackagePayload, UpdateCompanyUserAvatarResponse, UpdateCompanyUserRequest, UpdateIntegrationActionParams, UpdateIntegrationFieldParams, UpdateMemberInRoomRequest, UpdateTimeEntryRequest, UpdateUserPasswordRequest, UpdateUserPasswordResponse, UploadPresignedUrlResponse, User, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };
|
|
828
|
+
export { AccessPackage, ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementListFilters, AnnouncementListResponse, AnnouncementType, AttachmentByIdResponse, AudioConvertResponse, AutomationPartner, AutomationPartnerAction, Campaign, CampaignAccessResponse, CampaignCompanyPaginatedResponse, CampaignCompanyQueryParams, CampaignCompanyResponse, CampaignContactPaginatedResponse, CampaignContactQueryParams, CampaignContactResponse, CampaignContactsDashboardData, CampaignContactsDashboardQueryParams, CampaignPaginatedResponse, CampaignQueryParams, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CancelInvitationRequest, CaseFeedByActionItem, CasePermissions, CaseTimeEntry, CommentHistoryPage, CompanyAccessPackageItem, CompanyResource, CompanyResponse, Config, ConfigListByProviderResponse, ContactCategoryResponse, ContactHistoryResponse, ContactPhoneSearchResponse, ContactResponse, CreateAnnouncementRequest, CreateAutomationPartnerRequest, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, CreateCompanyAccessPackagePayload, CreateIntegrationActionRequest, CreateIntegrationFieldRequest, CreateIntegrationPartnerRequest, CreateTimeEntryRequest, CreateWebhookRequest$1 as CreateWebhookRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, DeleteTimeEntryRequest, EnableCampaignCompanyRequest, FindOrCreateContactRequest, FindOrCreateQueueRuleRequest, FlowCatalogParams, FlowCatalogResponse, FlowDefinition, FlowReadiness, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, GetAccessPackagesParams, GetAllUsersParams, GetAllUsersResponse, GetAttachmentByIdRequest, GetAutomationPartnerRequest, GetCaseFeedByActionsRequest, GetCommentHistoryRequest, GetCompanyAccessPackagesParams, GetCompanyResourcesParams, GetConfigTemplatesParams, GetConfigTemplatesResponse, GetConfigsByProviderParams, GetContactPhonesParams, GetInitialContextRequest, GetInitialContextResponse, GetIntegrationHooksCatalogRequest, GetIntegrationPartnersByCompanyRequest, GetManagedUsersResponse, GetMemberQueuesRequest, GetMessagesByCursorRequest, GetMessagesByCursorResponse, GetPresignedUrlRequest, GetProviderConfigurationsParams, GetProviderDisplayInfoParams, GetRoomByIdRequest, GetRootRulesRequest, GetServiceGroupsParams, GetUserByIdResponse, GetWebhooksByCompanyRequest$1 as GetWebhooksByCompanyRequest, HookCatalogItem, IntegrationAction, IntegrationField, IntegrationPartner, InvitationResponse, ListAutomationActionsRequest, ListAutomationPartnersRequest, ListCasesRequest, ListCasesResponse, ListContactHistoryRequest, ListInvitationsRequest, ListLiveUserRoomsRequest, ListTimeEntriesPage, ListTimeEntriesRequest, LiveUserRoomResponse, MarkMessagesAsReadRequest, MarkMessagesAsReadResponse, MessageResponse, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, PaginatedResult, PatchCampaignContactRequest, PatchCampaignRequest, ProviderConfigurationsResponse, ProviderDisplayInfoResponse, ProviderListResponse, Queue, QueueMember, QueueRule, ReplyInvitationRequest, RoomMemberResponse, RoomResponse, RootRulesResponse, SERVICE_GATEWAYS, SERVICE_GATEWAYS as SERVICE_GATEWAYS_TYPE, SendAttachmentMessageResponse, SendMessageRequest, ServiceGroupsResponse, StrongPasswordOptionsResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCasePermissionsRequest, UpdateCompanyAccessPackagePayload, UpdateCompanyUserAvatarResponse, UpdateCompanyUserRequest, UpdateIntegrationActionParams, UpdateIntegrationFieldParams, UpdateMemberInRoomRequest, UpdateTimeEntryRequest, UpdateUserPasswordRequest, UpdateUserPasswordResponse, UploadPresignedUrlResponse, User, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,15 +1,15 @@
|
|
|
1
1
|
import { AxiosInstance } from 'axios';
|
|
2
|
-
import { CompanyResponse, StrongPasswordOptionsResponse, User, WorkGroupListResponse, WorkGroupResponse, WorkGroupMembersResponse, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse, UpdateCompanyUserRequest, UpdateUserPasswordRequest, UpdateUserPasswordResponse, UpdateCompanyUserAvatarResponse, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, AnnouncementListFilters, AnnouncementListResponse, Announcement, CreateAnnouncementRequest, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, AnnouncementType, ActiveAnnouncementQuery, ActiveAnnouncement } from './customer-service/contracts/index.js';
|
|
2
|
+
import { CompanyResponse, StrongPasswordOptionsResponse, User, WorkGroupListResponse, WorkGroupResponse, WorkGroupMembersResponse, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse, GetUserByIdResponse, UpdateCompanyUserRequest, UpdateUserPasswordRequest, UpdateUserPasswordResponse, UpdateCompanyUserAvatarResponse, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, AnnouncementListFilters, AnnouncementListResponse, Announcement, CreateAnnouncementRequest, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, AnnouncementType, ActiveAnnouncementQuery, ActiveAnnouncement } from './customer-service/contracts/index.js';
|
|
3
3
|
export { AnnouncementAppearance, AnnouncementButton, AnnouncementCompany, AnnouncementPayload, AnnouncementTargetingRuleUrl, AnnouncementTargetingRules, AnnouncementVisualStatus, CompanyData, ManagedUser, StrongPasswordOptions, WorkGroup, WorkGroupMember } from './customer-service/contracts/index.js';
|
|
4
|
-
import { ProviderListResponse, GetProviderConfigurationsParams, ProviderConfigurationsResponse, GetProviderDisplayInfoParams, ProviderDisplayInfoResponse, GetConfigsByProviderParams, ConfigListByProviderResponse, Queue, GetMemberQueuesRequest, QueueMember, GetServiceGroupsParams, ServiceGroupsResponse, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, FindOrCreateQueueRuleRequest, QueueRule, GetRootRulesRequest, RootRulesResponse } from './chat-config/contracts/index.js';
|
|
5
|
-
export {
|
|
4
|
+
import { ProviderListResponse, Config, GetProviderConfigurationsParams, ProviderConfigurationsResponse, GetProviderDisplayInfoParams, ProviderDisplayInfoResponse, GetConfigsByProviderParams, ConfigListByProviderResponse, Queue, GetMemberQueuesRequest, QueueMember, GetServiceGroupsParams, ServiceGroupsResponse, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, FindOrCreateQueueRuleRequest, QueueRule, GetRootRulesRequest, RootRulesResponse } from './chat-config/contracts/index.js';
|
|
5
|
+
export { ConfigProvider, DistributionType, MetaTemplateButton, Provider, ProviderConfiguration, ProviderName, QueueListResponse, Rule, ServiceGroup, WhatsAppProviderSettings, WidgetProviderSettings } from './chat-config/contracts/index.js';
|
|
6
6
|
import { CampaignQueryParams, CampaignPaginatedResponse, Campaign, CreateCampaignRequest, PatchCampaignRequest, CampaignContactQueryParams, CampaignContactPaginatedResponse, CampaignContactResponse, CreateCampaignContactRequest, PatchCampaignContactRequest, CampaignContactsDashboardQueryParams, CampaignContactsDashboardData, CampaignUser, CampaignWorkGroupQueryParams, CampaignWorkGroupPaginatedResponse, CreateCampaignWorkGroupRequest, CampaignWorkGroup, CampaignCompanyQueryParams, CampaignCompanyPaginatedResponse, CampaignCompanyResponse, EnableCampaignCompanyRequest, CampaignAccessResponse } from './campaigns/contracts/index.js';
|
|
7
7
|
export { CampaignAccessReason, CampaignContactCampaignStatus, CampaignContactDispatchStatus, CampaignContactFilter, CampaignContactLikeQueryOperators, CampaignContactQueryOperators, CampaignContactQueryValue, CampaignContactSortDirection, CampaignContactSortParams, CampaignContactsDashboardChannelPerformance, CampaignContactsDashboardEvolutionItem, CampaignContactsDashboardExactQueryOperators, CampaignContactsDashboardFunnelItem, CampaignContactsDashboardInterval, CampaignContactsDashboardMetrics, CampaignContactsDashboardQueryValue, CampaignContactsDashboardRangeQueryOperators, CampaignContactsDashboardStatusDistribution, CampaignContactsDashboardStatusMetrics, CampaignContactsDashboardSummary, CampaignContactsDashboardTopCampaign, CampaignProvider, CampaignRetryConfig, CampaignSchedule, CampaignStatus, WhatsAppPayload, WhatsAppTemplateComponent } from './campaigns/contracts/index.js';
|
|
8
8
|
import { GetConfigTemplatesParams, GetConfigTemplatesResponse, FlowReadiness, FlowCatalogParams, FlowCatalogResponse, FlowDefinition } from './chat-adapter/contracts/index.js';
|
|
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 } from './contact-list/contracts/index.js';
|
|
12
|
+
import { GetContactPhonesParams, ContactPhoneSearchResponse, ContactCategoryResponse, FindOrCreateContactRequest, ContactResponse } from './contact-list/contracts/index.js';
|
|
13
13
|
export { ContactPhoneResponse } from './contact-list/contracts/index.js';
|
|
14
14
|
import { 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 { UpdateIntegrationActionRequest, UpdateIntegrationFieldRequest } from './integrations/contracts/index.js';
|
|
@@ -71,6 +71,12 @@ declare class CustomerServiceGateway {
|
|
|
71
71
|
getWorkGroupMembers(groupId: string, companyId?: string, profile?: string[]): Promise<WorkGroupMembersResponse>;
|
|
72
72
|
getAllUsers(params?: GetAllUsersParams): Promise<GetAllUsersResponse>;
|
|
73
73
|
getManagedUsers(managerId: string): Promise<GetManagedUsersResponse>;
|
|
74
|
+
/**
|
|
75
|
+
* Retrieves a user by its unique identifier.
|
|
76
|
+
* @param userId - The unique identifier of the user.
|
|
77
|
+
* @returns The user data wrapped in a {@link GetUserByIdResponse}.
|
|
78
|
+
*/
|
|
79
|
+
getUserById(userId: string): Promise<GetUserByIdResponse>;
|
|
74
80
|
/**
|
|
75
81
|
* Updates a company user by its unique identifier.
|
|
76
82
|
* @param userId - The unique identifier of the user.
|
|
@@ -169,6 +175,7 @@ declare class ChatConfigGateway {
|
|
|
169
175
|
* @returns The list of providers.
|
|
170
176
|
*/
|
|
171
177
|
getProviders(): Promise<ProviderListResponse>;
|
|
178
|
+
getConfigById(configId: string): Promise<Config>;
|
|
172
179
|
/**
|
|
173
180
|
* Retrieves provider configurations filtered by configuration IDs.
|
|
174
181
|
* @param params - Query parameters containing one or more configuration IDs.
|
|
@@ -415,6 +422,12 @@ declare class ContactListGateway {
|
|
|
415
422
|
* @returns An array of contact categories.
|
|
416
423
|
*/
|
|
417
424
|
getCategoryList(): Promise<ContactCategoryResponse[]>;
|
|
425
|
+
/**
|
|
426
|
+
* Finds an existing contact or creates a new one.
|
|
427
|
+
* @param payload - The contact data sent as query parameters and in the request body.
|
|
428
|
+
* @returns The existing or newly created contact.
|
|
429
|
+
*/
|
|
430
|
+
findOrCreateContact(payload: FindOrCreateContactRequest): Promise<ContactResponse>;
|
|
418
431
|
}
|
|
419
432
|
|
|
420
433
|
/**
|
|
@@ -812,4 +825,4 @@ declare const configure: (params: GatewayClientParams) => void;
|
|
|
812
825
|
*/
|
|
813
826
|
declare function gateway<T extends keyof GatewayMap>(service: T): GatewayMap[T];
|
|
814
827
|
|
|
815
|
-
export { AccessPackage, ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementListFilters, AnnouncementListResponse, AnnouncementType, AttachmentByIdResponse, AudioConvertResponse, AutomationPartner, AutomationPartnerAction, Campaign, CampaignAccessResponse, CampaignCompanyPaginatedResponse, CampaignCompanyQueryParams, CampaignCompanyResponse, CampaignContactPaginatedResponse, CampaignContactQueryParams, CampaignContactResponse, CampaignContactsDashboardData, CampaignContactsDashboardQueryParams, CampaignPaginatedResponse, CampaignQueryParams, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CancelInvitationRequest, CaseFeedByActionItem, CasePermissions, CaseTimeEntry, CommentHistoryPage, CompanyAccessPackageItem, CompanyResource, CompanyResponse, ConfigListByProviderResponse, ContactCategoryResponse, ContactHistoryResponse, ContactPhoneSearchResponse, CreateAnnouncementRequest, CreateAutomationPartnerRequest, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, CreateCompanyAccessPackagePayload, CreateIntegrationActionRequest, CreateIntegrationFieldRequest, CreateIntegrationPartnerRequest, CreateTimeEntryRequest, CreateWebhookRequest$1 as CreateWebhookRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, DeleteTimeEntryRequest, EnableCampaignCompanyRequest, FindOrCreateQueueRuleRequest, FlowCatalogParams, FlowCatalogResponse, FlowDefinition, FlowReadiness, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, GetAccessPackagesParams, GetAllUsersParams, GetAllUsersResponse, GetAttachmentByIdRequest, GetAutomationPartnerRequest, GetCaseFeedByActionsRequest, GetCommentHistoryRequest, GetCompanyAccessPackagesParams, GetCompanyResourcesParams, GetConfigTemplatesParams, GetConfigTemplatesResponse, GetConfigsByProviderParams, GetContactPhonesParams, GetInitialContextRequest, GetInitialContextResponse, GetIntegrationHooksCatalogRequest, GetIntegrationPartnersByCompanyRequest, GetManagedUsersResponse, GetMemberQueuesRequest, GetMessagesByCursorRequest, GetMessagesByCursorResponse, GetPresignedUrlRequest, GetProviderConfigurationsParams, GetProviderDisplayInfoParams, GetRoomByIdRequest, GetRootRulesRequest, GetServiceGroupsParams, GetWebhooksByCompanyRequest$1 as GetWebhooksByCompanyRequest, HookCatalogItem, IntegrationAction, IntegrationField, IntegrationPartner, InvitationResponse, ListAutomationActionsRequest, ListAutomationPartnersRequest, ListCasesRequest, ListCasesResponse, ListContactHistoryRequest, ListInvitationsRequest, ListLiveUserRoomsRequest, ListTimeEntriesPage, ListTimeEntriesRequest, LiveUserRoomResponse, MarkMessagesAsReadRequest, MarkMessagesAsReadResponse, MessageResponse, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, PaginatedResult, PatchCampaignContactRequest, PatchCampaignRequest, ProviderConfigurationsResponse, ProviderDisplayInfoResponse, ProviderListResponse, Queue, QueueMember, QueueRule, ReplyInvitationRequest, RoomMemberResponse, RoomResponse, RootRulesResponse, SERVICE_GATEWAYS, SERVICE_GATEWAYS as SERVICE_GATEWAYS_TYPE, SendAttachmentMessageResponse, SendMessageRequest, ServiceGroupsResponse, StrongPasswordOptionsResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCasePermissionsRequest, UpdateCompanyAccessPackagePayload, UpdateCompanyUserAvatarResponse, UpdateCompanyUserRequest, UpdateIntegrationActionParams, UpdateIntegrationFieldParams, UpdateMemberInRoomRequest, UpdateTimeEntryRequest, UpdateUserPasswordRequest, UpdateUserPasswordResponse, UploadPresignedUrlResponse, User, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };
|
|
828
|
+
export { AccessPackage, ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementListFilters, AnnouncementListResponse, AnnouncementType, AttachmentByIdResponse, AudioConvertResponse, AutomationPartner, AutomationPartnerAction, Campaign, CampaignAccessResponse, CampaignCompanyPaginatedResponse, CampaignCompanyQueryParams, CampaignCompanyResponse, CampaignContactPaginatedResponse, CampaignContactQueryParams, CampaignContactResponse, CampaignContactsDashboardData, CampaignContactsDashboardQueryParams, CampaignPaginatedResponse, CampaignQueryParams, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CancelInvitationRequest, CaseFeedByActionItem, CasePermissions, CaseTimeEntry, CommentHistoryPage, CompanyAccessPackageItem, CompanyResource, CompanyResponse, Config, ConfigListByProviderResponse, ContactCategoryResponse, ContactHistoryResponse, ContactPhoneSearchResponse, ContactResponse, CreateAnnouncementRequest, CreateAutomationPartnerRequest, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, CreateCompanyAccessPackagePayload, CreateIntegrationActionRequest, CreateIntegrationFieldRequest, CreateIntegrationPartnerRequest, CreateTimeEntryRequest, CreateWebhookRequest$1 as CreateWebhookRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, DeleteTimeEntryRequest, EnableCampaignCompanyRequest, FindOrCreateContactRequest, FindOrCreateQueueRuleRequest, FlowCatalogParams, FlowCatalogResponse, FlowDefinition, FlowReadiness, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, GetAccessPackagesParams, GetAllUsersParams, GetAllUsersResponse, GetAttachmentByIdRequest, GetAutomationPartnerRequest, GetCaseFeedByActionsRequest, GetCommentHistoryRequest, GetCompanyAccessPackagesParams, GetCompanyResourcesParams, GetConfigTemplatesParams, GetConfigTemplatesResponse, GetConfigsByProviderParams, GetContactPhonesParams, GetInitialContextRequest, GetInitialContextResponse, GetIntegrationHooksCatalogRequest, GetIntegrationPartnersByCompanyRequest, GetManagedUsersResponse, GetMemberQueuesRequest, GetMessagesByCursorRequest, GetMessagesByCursorResponse, GetPresignedUrlRequest, GetProviderConfigurationsParams, GetProviderDisplayInfoParams, GetRoomByIdRequest, GetRootRulesRequest, GetServiceGroupsParams, GetUserByIdResponse, GetWebhooksByCompanyRequest$1 as GetWebhooksByCompanyRequest, HookCatalogItem, IntegrationAction, IntegrationField, IntegrationPartner, InvitationResponse, ListAutomationActionsRequest, ListAutomationPartnersRequest, ListCasesRequest, ListCasesResponse, ListContactHistoryRequest, ListInvitationsRequest, ListLiveUserRoomsRequest, ListTimeEntriesPage, ListTimeEntriesRequest, LiveUserRoomResponse, MarkMessagesAsReadRequest, MarkMessagesAsReadResponse, MessageResponse, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, PaginatedResult, PatchCampaignContactRequest, PatchCampaignRequest, ProviderConfigurationsResponse, ProviderDisplayInfoResponse, ProviderListResponse, Queue, QueueMember, QueueRule, ReplyInvitationRequest, RoomMemberResponse, RoomResponse, RootRulesResponse, SERVICE_GATEWAYS, SERVICE_GATEWAYS as SERVICE_GATEWAYS_TYPE, SendAttachmentMessageResponse, SendMessageRequest, ServiceGroupsResponse, StrongPasswordOptionsResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCasePermissionsRequest, UpdateCompanyAccessPackagePayload, UpdateCompanyUserAvatarResponse, UpdateCompanyUserRequest, UpdateIntegrationActionParams, UpdateIntegrationFieldParams, UpdateMemberInRoomRequest, UpdateTimeEntryRequest, UpdateUserPasswordRequest, UpdateUserPasswordResponse, UploadPresignedUrlResponse, User, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };
|
package/dist/index.js
CHANGED
|
@@ -124,6 +124,15 @@ var CustomerServiceGateway = class {
|
|
|
124
124
|
const { data } = await this.httpClient.get(`${this.baseUrl}/users/managed/${managerId}`);
|
|
125
125
|
return data;
|
|
126
126
|
}
|
|
127
|
+
/**
|
|
128
|
+
* Retrieves a user by its unique identifier.
|
|
129
|
+
* @param userId - The unique identifier of the user.
|
|
130
|
+
* @returns The user data wrapped in a {@link GetUserByIdResponse}.
|
|
131
|
+
*/
|
|
132
|
+
async getUserById(userId) {
|
|
133
|
+
const { data } = await this.httpClient.get(`${this.baseUrl}/companies/users/search/${userId}`);
|
|
134
|
+
return data;
|
|
135
|
+
}
|
|
127
136
|
/**
|
|
128
137
|
* Updates a company user by its unique identifier.
|
|
129
138
|
* @param userId - The unique identifier of the user.
|
|
@@ -293,6 +302,10 @@ var ChatConfigGateway = class {
|
|
|
293
302
|
const { data } = await this.httpClient.get(`${this.baseUrl}/providers`);
|
|
294
303
|
return data;
|
|
295
304
|
}
|
|
305
|
+
async getConfigById(configId) {
|
|
306
|
+
const { data } = await this.httpClient.get(`${this.baseUrl}/config/${configId}`);
|
|
307
|
+
return data;
|
|
308
|
+
}
|
|
296
309
|
/**
|
|
297
310
|
* Retrieves provider configurations filtered by configuration IDs.
|
|
298
311
|
* @param params - Query parameters containing one or more configuration IDs.
|
|
@@ -741,10 +754,9 @@ var ContactListGateway = class {
|
|
|
741
754
|
* @returns The paginated contact phones response.
|
|
742
755
|
*/
|
|
743
756
|
async getContactsPhones(params) {
|
|
744
|
-
const { data } = await this.httpClient.get(
|
|
745
|
-
|
|
746
|
-
|
|
747
|
-
);
|
|
757
|
+
const { data } = await this.httpClient.get(`${this.baseUrl}/contact/phone/search`, {
|
|
758
|
+
params
|
|
759
|
+
});
|
|
748
760
|
return data;
|
|
749
761
|
}
|
|
750
762
|
/**
|
|
@@ -752,9 +764,16 @@ var ContactListGateway = class {
|
|
|
752
764
|
* @returns An array of contact categories.
|
|
753
765
|
*/
|
|
754
766
|
async getCategoryList() {
|
|
755
|
-
const { data } = await this.httpClient.get(
|
|
756
|
-
|
|
757
|
-
|
|
767
|
+
const { data } = await this.httpClient.get(`${this.baseUrl}/contact/category`);
|
|
768
|
+
return data;
|
|
769
|
+
}
|
|
770
|
+
/**
|
|
771
|
+
* Finds an existing contact or creates a new one.
|
|
772
|
+
* @param payload - The contact data sent as query parameters and in the request body.
|
|
773
|
+
* @returns The existing or newly created contact.
|
|
774
|
+
*/
|
|
775
|
+
async findOrCreateContact(payload) {
|
|
776
|
+
const { data } = await this.httpClient.put(`${this.baseUrl}/contact/find-or-create`, payload);
|
|
758
777
|
return data;
|
|
759
778
|
}
|
|
760
779
|
};
|