@opens/gateways 1.15.13 → 1.15.15
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/calls/contracts/index.d.mts +12 -0
- package/dist/calls/contracts/index.d.ts +12 -0
- package/dist/calls/contracts/index.js +19 -0
- package/dist/calls/contracts/index.js.map +1 -0
- package/dist/calls/contracts/index.mjs +1 -0
- package/dist/calls/contracts/index.mjs.map +1 -0
- package/dist/chat-webservice/contracts/index.d.mts +37 -1
- package/dist/chat-webservice/contracts/index.d.ts +37 -1
- package/dist/customer-service/contracts/index.d.mts +104 -12
- package/dist/customer-service/contracts/index.d.ts +104 -12
- package/dist/customer-service/contracts/index.js.map +1 -1
- package/dist/index.d.mts +69 -5
- package/dist/index.d.ts +69 -5
- package/dist/index.js +103 -1
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +103 -1
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { AxiosInstance } from 'axios';
|
|
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
|
-
export { AnnouncementAppearance, AnnouncementButton, AnnouncementCompany, AnnouncementPayload, AnnouncementTargetingRuleUrl, AnnouncementTargetingRules, AnnouncementVisualStatus, CompanyData, ManagedUser,
|
|
2
|
+
import { CompanyResponse, UpdateCompanyRequest, UpdateSupportWidgetIdRequest, UpdateSupportWidgetIdResponse, CompanyQueue, StrongPasswordOptionsResponse, StrongPasswordOptions, CompanyBooleanConfigKey, UpdateCompanyBooleanConfigRequest, CompanyConfigResponse, CompanyStringConfigKey, UpdateCompanyStringConfigRequest, 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
|
+
export { AnnouncementAppearance, AnnouncementButton, AnnouncementCompany, AnnouncementPayload, AnnouncementTargetingRuleUrl, AnnouncementTargetingRules, AnnouncementVisualStatus, CompanyData, ManagedUser, WorkGroup, WorkGroupMember } from './customer-service/contracts/index.js';
|
|
4
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
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';
|
|
@@ -13,10 +13,12 @@ import { GetContactPhonesParams, ContactPhoneSearchResponse, ContactCategoryResp
|
|
|
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';
|
|
16
|
-
import { ListInvitationsRequest, InvitationResponse, ReplyInvitationRequest, CancelInvitationRequest, ListLiveUserRoomsRequest, LiveUserRoomResponse, GetRoomByIdRequest, RoomResponse, GetInitialContextRequest, GetInitialContextResponse, GetMessagesByCursorRequest, GetMessagesByCursorResponse, SendMessageRequest, MessageResponse, SendAttachmentMessageResponse, MarkMessagesAsReadRequest, MarkMessagesAsReadResponse, UpdateMemberInRoomRequest, RoomMemberResponse } from './chat-webservice/contracts/index.js';
|
|
17
|
-
export { MessageAttachment, MessageMetadata, MessageReactionResponse, MessageReplyContext, MessageStatusResponse, RoomActiveDates, RoomTagResponse } from './chat-webservice/contracts/index.js';
|
|
16
|
+
import { ListInvitationsRequest, InvitationResponse, ReplyInvitationRequest, CancelInvitationRequest, ListLiveUserRoomsRequest, LiveUserRoomResponse, GetRoomByIdRequest, RoomResponse, GetInitialContextRequest, GetInitialContextResponse, GetMessagesByCursorRequest, GetMessagesByCursorResponse, SendMessageRequest, MessageResponse, ForwardMessageRequest, SendAttachmentMessageResponse, MarkMessagesAsReadRequest, MarkMessagesAsReadResponse, UpdateMemberInRoomRequest, RoomMemberResponse } from './chat-webservice/contracts/index.js';
|
|
17
|
+
export { ForwardMessageDestination, ForwardMessageForwardingMetadata, ForwardMessageMetadata, MessageAttachment, MessageMetadata, MessageReactionResponse, MessageReplyContext, MessageStatusResponse, RoomActiveDates, RoomTagResponse } from './chat-webservice/contracts/index.js';
|
|
18
18
|
import { ListContactHistoryRequest, ContactHistoryResponse } from './call-report/contracts/index.js';
|
|
19
19
|
export { ContactHistoryIndex, ContactHistorySortOrder, ContactInteractionResponse, InteractionCallStepResponse, InteractionChatStepResponse, InteractionMemberResponse, InteractionOrganizationResponse } from './call-report/contracts/index.js';
|
|
20
|
+
import { CallEndpoint } from './calls/contracts/index.js';
|
|
21
|
+
export { CallEndpointStatus } from './calls/contracts/index.js';
|
|
20
22
|
import { GetCommentHistoryRequest, CommentHistoryPage, CasePermissions, UpdateCasePermissionsRequest, GetCaseFeedByActionsRequest, CaseFeedByActionItem, ListCasesRequest, ListCasesResponse, CreateTimeEntryRequest, CaseTimeEntry, ListTimeEntriesRequest, ListTimeEntriesPage, UpdateTimeEntryRequest, DeleteTimeEntryRequest } from './cases/contracts/index.js';
|
|
21
23
|
export { CaseListItem, CasePermissionsValue, CommentHistoryChangeType, CommentHistoryCursor, CommentHistoryEntry, ListCasesCursor, TimeEntryCursor } from './cases/contracts/index.js';
|
|
22
24
|
import { GetAccessPackagesParams, PaginatedResult, AccessPackage, GetCompanyAccessPackagesParams, CompanyAccessPackageItem, CreateCompanyAccessPackagePayload, UpdateCompanyAccessPackagePayload, GetCompanyResourcesParams, CompanyResource } from './access-hub/contracts/index.js';
|
|
@@ -36,12 +38,49 @@ declare class CustomerServiceGateway {
|
|
|
36
38
|
* @returns The company data wrapped in a {@link CompanyResponse}.
|
|
37
39
|
*/
|
|
38
40
|
getCompanyById(companyId: string): Promise<CompanyResponse>;
|
|
41
|
+
/**
|
|
42
|
+
* Updates the current company settings.
|
|
43
|
+
* @param payload - The company fields to update.
|
|
44
|
+
* @returns The updated company data wrapped in a {@link CompanyResponse}.
|
|
45
|
+
*/
|
|
46
|
+
updateCompany(payload: UpdateCompanyRequest): Promise<CompanyResponse>;
|
|
47
|
+
/**
|
|
48
|
+
* Updates the support widget identifier for the current company.
|
|
49
|
+
* @param payload - The support widget identifier to set.
|
|
50
|
+
* @returns The updated company support widget data.
|
|
51
|
+
*/
|
|
52
|
+
updateSupportWidgetId(payload: UpdateSupportWidgetIdRequest): Promise<UpdateSupportWidgetIdResponse>;
|
|
53
|
+
/**
|
|
54
|
+
* Retrieves the list of queues configured for the current company.
|
|
55
|
+
* @returns The company queues.
|
|
56
|
+
*/
|
|
57
|
+
getCompanyQueues(): Promise<CompanyQueue[]>;
|
|
39
58
|
/**
|
|
40
59
|
* Retrieves the strong password options config for a company.
|
|
41
60
|
* @param companyId - The unique identifier of the company.
|
|
42
61
|
* @returns The strong password options company config.
|
|
43
62
|
*/
|
|
44
63
|
getStrongPasswordOptions(companyId: string): Promise<StrongPasswordOptionsResponse>;
|
|
64
|
+
/**
|
|
65
|
+
* Updates the strong password options config for the current company.
|
|
66
|
+
* @param payload - The strong password policy rules to apply.
|
|
67
|
+
* @returns The updated strong password options company config.
|
|
68
|
+
*/
|
|
69
|
+
updateStrongPasswordOptions(payload: StrongPasswordOptions): Promise<StrongPasswordOptionsResponse>;
|
|
70
|
+
/**
|
|
71
|
+
* Updates a boolean company config by key.
|
|
72
|
+
* @param key - The config key to update.
|
|
73
|
+
* @param payload - The boolean value to set.
|
|
74
|
+
* @returns The updated company config entry.
|
|
75
|
+
*/
|
|
76
|
+
updateCompanyBooleanConfig(key: CompanyBooleanConfigKey, payload: UpdateCompanyBooleanConfigRequest): Promise<CompanyConfigResponse>;
|
|
77
|
+
/**
|
|
78
|
+
* Updates a string company config by key.
|
|
79
|
+
* @param key - The config key to update.
|
|
80
|
+
* @param payload - The string value to set.
|
|
81
|
+
* @returns The updated company config entry.
|
|
82
|
+
*/
|
|
83
|
+
updateCompanyStringConfig(key: CompanyStringConfigKey, payload: UpdateCompanyStringConfigRequest): Promise<CompanyConfigResponse>;
|
|
45
84
|
/**
|
|
46
85
|
* Retrieves a user by login email.
|
|
47
86
|
* @param email - The user email used as login identifier.
|
|
@@ -578,6 +617,12 @@ declare class ChatWebserviceGateway {
|
|
|
578
617
|
* @returns The created message.
|
|
579
618
|
*/
|
|
580
619
|
sendMessage(payload: SendMessageRequest): Promise<MessageResponse>;
|
|
620
|
+
/**
|
|
621
|
+
* Creates a forwarded chat message.
|
|
622
|
+
* @param payload - The message content and forwarding metadata.
|
|
623
|
+
* @returns The created message.
|
|
624
|
+
*/
|
|
625
|
+
forwardMessage(payload: ForwardMessageRequest): Promise<MessageResponse>;
|
|
581
626
|
/**
|
|
582
627
|
* Sends a chat message that includes attachments.
|
|
583
628
|
* @param payload - The message content, attachments, and routing metadata.
|
|
@@ -621,6 +666,20 @@ declare class CallReportGateway {
|
|
|
621
666
|
listContactHistory(params?: ListContactHistoryRequest): Promise<ContactHistoryResponse>;
|
|
622
667
|
}
|
|
623
668
|
|
|
669
|
+
/**
|
|
670
|
+
* Gateway for interacting with the Calls API.
|
|
671
|
+
*/
|
|
672
|
+
declare class CallsGateway {
|
|
673
|
+
private readonly httpClient;
|
|
674
|
+
private readonly baseUrl;
|
|
675
|
+
constructor(httpClient: AxiosInstance, baseUrl: string);
|
|
676
|
+
/**
|
|
677
|
+
* Retrieves all call endpoints and their current status.
|
|
678
|
+
* @returns The list of call endpoints.
|
|
679
|
+
*/
|
|
680
|
+
getEndpoints(): Promise<CallEndpoint[]>;
|
|
681
|
+
}
|
|
682
|
+
|
|
624
683
|
/** Request parameters for retrieving the webhooks scenario for a company. */
|
|
625
684
|
interface GetWebhooksByCompanyRequest {
|
|
626
685
|
companyId: string;
|
|
@@ -732,6 +791,7 @@ type GatewayMap = {
|
|
|
732
791
|
integrations: IntegrationsGateway;
|
|
733
792
|
'chat-webservice': ChatWebserviceGateway;
|
|
734
793
|
'call-report': CallReportGateway;
|
|
794
|
+
calls: CallsGateway;
|
|
735
795
|
cases: CasesGateway;
|
|
736
796
|
rh: RhGateway;
|
|
737
797
|
'access-hub': AccessHubGateway;
|
|
@@ -774,6 +834,9 @@ interface GatewayClientParams {
|
|
|
774
834
|
callReport?: {
|
|
775
835
|
baseUrl: string;
|
|
776
836
|
};
|
|
837
|
+
calls?: {
|
|
838
|
+
baseUrl: string;
|
|
839
|
+
};
|
|
777
840
|
cases?: {
|
|
778
841
|
baseUrl: string;
|
|
779
842
|
};
|
|
@@ -796,6 +859,7 @@ declare const SERVICE_GATEWAYS: {
|
|
|
796
859
|
readonly INTEGRATIONS: "integrations";
|
|
797
860
|
readonly CHAT_WEBSERVICE: "chat-webservice";
|
|
798
861
|
readonly CALL_REPORT: "call-report";
|
|
862
|
+
readonly CALLS: "calls";
|
|
799
863
|
readonly CASES: "cases";
|
|
800
864
|
readonly RH: "rh";
|
|
801
865
|
readonly ACCESS_HUB: "access-hub";
|
|
@@ -825,4 +889,4 @@ declare const configure: (params: GatewayClientParams) => void;
|
|
|
825
889
|
*/
|
|
826
890
|
declare function gateway<T extends keyof GatewayMap>(service: T): GatewayMap[T];
|
|
827
891
|
|
|
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 };
|
|
892
|
+
export { AccessPackage, ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementListFilters, AnnouncementListResponse, AnnouncementType, AttachmentByIdResponse, AudioConvertResponse, AutomationPartner, AutomationPartnerAction, CallEndpoint, Campaign, CampaignAccessResponse, CampaignCompanyPaginatedResponse, CampaignCompanyQueryParams, CampaignCompanyResponse, CampaignContactPaginatedResponse, CampaignContactQueryParams, CampaignContactResponse, CampaignContactsDashboardData, CampaignContactsDashboardQueryParams, CampaignPaginatedResponse, CampaignQueryParams, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CancelInvitationRequest, CaseFeedByActionItem, CasePermissions, CaseTimeEntry, CommentHistoryPage, CompanyAccessPackageItem, CompanyBooleanConfigKey, CompanyConfigResponse, CompanyQueue, CompanyResource, CompanyResponse, CompanyStringConfigKey, 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, ForwardMessageRequest, 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, StrongPasswordOptions, StrongPasswordOptionsResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCasePermissionsRequest, UpdateCompanyAccessPackagePayload, UpdateCompanyBooleanConfigRequest, UpdateCompanyRequest, UpdateCompanyStringConfigRequest, UpdateCompanyUserAvatarResponse, UpdateCompanyUserRequest, UpdateIntegrationActionParams, UpdateIntegrationFieldParams, UpdateMemberInRoomRequest, UpdateSupportWidgetIdRequest, UpdateSupportWidgetIdResponse, UpdateTimeEntryRequest, UpdateUserPasswordRequest, UpdateUserPasswordResponse, UploadPresignedUrlResponse, User, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };
|
package/dist/index.js
CHANGED
|
@@ -53,6 +53,35 @@ var CustomerServiceGateway = class {
|
|
|
53
53
|
const { data } = await this.httpClient.get(`${this.baseUrl}/companies/search/${companyId}`);
|
|
54
54
|
return data;
|
|
55
55
|
}
|
|
56
|
+
/**
|
|
57
|
+
* Updates the current company settings.
|
|
58
|
+
* @param payload - The company fields to update.
|
|
59
|
+
* @returns The updated company data wrapped in a {@link CompanyResponse}.
|
|
60
|
+
*/
|
|
61
|
+
async updateCompany(payload) {
|
|
62
|
+
const { data } = await this.httpClient.put(`${this.baseUrl}/companies`, payload);
|
|
63
|
+
return data;
|
|
64
|
+
}
|
|
65
|
+
/**
|
|
66
|
+
* Updates the support widget identifier for the current company.
|
|
67
|
+
* @param payload - The support widget identifier to set.
|
|
68
|
+
* @returns The updated company support widget data.
|
|
69
|
+
*/
|
|
70
|
+
async updateSupportWidgetId(payload) {
|
|
71
|
+
const { data } = await this.httpClient.put(
|
|
72
|
+
`${this.baseUrl}/companies/support-widget-id`,
|
|
73
|
+
payload
|
|
74
|
+
);
|
|
75
|
+
return data;
|
|
76
|
+
}
|
|
77
|
+
/**
|
|
78
|
+
* Retrieves the list of queues configured for the current company.
|
|
79
|
+
* @returns The company queues.
|
|
80
|
+
*/
|
|
81
|
+
async getCompanyQueues() {
|
|
82
|
+
const { data } = await this.httpClient.get(`${this.baseUrl}/companies/queues`);
|
|
83
|
+
return data;
|
|
84
|
+
}
|
|
56
85
|
/**
|
|
57
86
|
* Retrieves the strong password options config for a company.
|
|
58
87
|
* @param companyId - The unique identifier of the company.
|
|
@@ -65,6 +94,44 @@ var CustomerServiceGateway = class {
|
|
|
65
94
|
);
|
|
66
95
|
return data;
|
|
67
96
|
}
|
|
97
|
+
/**
|
|
98
|
+
* Updates the strong password options config for the current company.
|
|
99
|
+
* @param payload - The strong password policy rules to apply.
|
|
100
|
+
* @returns The updated strong password options company config.
|
|
101
|
+
*/
|
|
102
|
+
async updateStrongPasswordOptions(payload) {
|
|
103
|
+
const { data } = await this.httpClient.put(
|
|
104
|
+
`${this.baseUrl}/companies/configs/strong-password-options`,
|
|
105
|
+
payload
|
|
106
|
+
);
|
|
107
|
+
return data;
|
|
108
|
+
}
|
|
109
|
+
/**
|
|
110
|
+
* Updates a boolean company config by key.
|
|
111
|
+
* @param key - The config key to update.
|
|
112
|
+
* @param payload - The boolean value to set.
|
|
113
|
+
* @returns The updated company config entry.
|
|
114
|
+
*/
|
|
115
|
+
async updateCompanyBooleanConfig(key, payload) {
|
|
116
|
+
const { data } = await this.httpClient.put(
|
|
117
|
+
`${this.baseUrl}/companies/configs/${key}`,
|
|
118
|
+
payload
|
|
119
|
+
);
|
|
120
|
+
return data;
|
|
121
|
+
}
|
|
122
|
+
/**
|
|
123
|
+
* Updates a string company config by key.
|
|
124
|
+
* @param key - The config key to update.
|
|
125
|
+
* @param payload - The string value to set.
|
|
126
|
+
* @returns The updated company config entry.
|
|
127
|
+
*/
|
|
128
|
+
async updateCompanyStringConfig(key, payload) {
|
|
129
|
+
const { data } = await this.httpClient.put(
|
|
130
|
+
`${this.baseUrl}/companies/configs/${key}`,
|
|
131
|
+
payload
|
|
132
|
+
);
|
|
133
|
+
return data;
|
|
134
|
+
}
|
|
68
135
|
/**
|
|
69
136
|
* Retrieves a user by login email.
|
|
70
137
|
* @param email - The user email used as login identifier.
|
|
@@ -1021,6 +1088,15 @@ var ChatWebserviceGateway = class {
|
|
|
1021
1088
|
const { data } = await this.httpClient.post(`${this.baseUrl}/message`, payload);
|
|
1022
1089
|
return data;
|
|
1023
1090
|
}
|
|
1091
|
+
/**
|
|
1092
|
+
* Creates a forwarded chat message.
|
|
1093
|
+
* @param payload - The message content and forwarding metadata.
|
|
1094
|
+
* @returns The created message.
|
|
1095
|
+
*/
|
|
1096
|
+
async forwardMessage(payload) {
|
|
1097
|
+
const { data } = await this.httpClient.post(`${this.baseUrl}/message/forward`, payload);
|
|
1098
|
+
return data;
|
|
1099
|
+
}
|
|
1024
1100
|
/**
|
|
1025
1101
|
* Sends a chat message that includes attachments.
|
|
1026
1102
|
* @param payload - The message content, attachments, and routing metadata.
|
|
@@ -1087,6 +1163,24 @@ var CallReportGateway = class {
|
|
|
1087
1163
|
}
|
|
1088
1164
|
};
|
|
1089
1165
|
|
|
1166
|
+
// src/calls/index.ts
|
|
1167
|
+
var CallsGateway = class {
|
|
1168
|
+
constructor(httpClient, baseUrl) {
|
|
1169
|
+
this.httpClient = httpClient;
|
|
1170
|
+
this.baseUrl = baseUrl;
|
|
1171
|
+
}
|
|
1172
|
+
httpClient;
|
|
1173
|
+
baseUrl;
|
|
1174
|
+
/**
|
|
1175
|
+
* Retrieves all call endpoints and their current status.
|
|
1176
|
+
* @returns The list of call endpoints.
|
|
1177
|
+
*/
|
|
1178
|
+
async getEndpoints() {
|
|
1179
|
+
const { data } = await this.httpClient.get(`${this.baseUrl}/endpoints`);
|
|
1180
|
+
return data;
|
|
1181
|
+
}
|
|
1182
|
+
};
|
|
1183
|
+
|
|
1090
1184
|
// src/cases/index.ts
|
|
1091
1185
|
var CasesGateway = class {
|
|
1092
1186
|
constructor(httpClient, baseUrl) {
|
|
@@ -1270,10 +1364,11 @@ var SDKGateways = class {
|
|
|
1270
1364
|
integrations;
|
|
1271
1365
|
chatWebservice;
|
|
1272
1366
|
callReport;
|
|
1367
|
+
calls;
|
|
1273
1368
|
cases;
|
|
1274
1369
|
rh;
|
|
1275
1370
|
accessHub;
|
|
1276
|
-
constructor(customerService, chatConfig, campaigns, chatAdapter, assets, contactList, integrations, chatWebservice, callReport, cases, rh, accessHub) {
|
|
1371
|
+
constructor(customerService, chatConfig, campaigns, chatAdapter, assets, contactList, integrations, chatWebservice, callReport, calls, cases, rh, accessHub) {
|
|
1277
1372
|
this.customerService = customerService;
|
|
1278
1373
|
this.chatConfig = chatConfig;
|
|
1279
1374
|
this.campaigns = campaigns;
|
|
@@ -1283,6 +1378,7 @@ var SDKGateways = class {
|
|
|
1283
1378
|
this.integrations = integrations;
|
|
1284
1379
|
this.chatWebservice = chatWebservice;
|
|
1285
1380
|
this.callReport = callReport;
|
|
1381
|
+
this.calls = calls;
|
|
1286
1382
|
this.cases = cases;
|
|
1287
1383
|
this.rh = rh;
|
|
1288
1384
|
this.accessHub = accessHub;
|
|
@@ -1303,6 +1399,7 @@ function createClient(params) {
|
|
|
1303
1399
|
const integrations = params.services.integrations ? new IntegrationsGateway(httpClient, params.services.integrations.baseUrl) : null;
|
|
1304
1400
|
const chatWebservice = params.services.chatWebservice ? new ChatWebserviceGateway(httpClient, params.services.chatWebservice.baseUrl) : null;
|
|
1305
1401
|
const callReport = params.services.callReport ? new CallReportGateway(httpClient, params.services.callReport.baseUrl) : null;
|
|
1402
|
+
const calls = params.services.calls ? new CallsGateway(httpClient, params.services.calls.baseUrl) : null;
|
|
1306
1403
|
const cases = params.services.cases ? new CasesGateway(httpClient, params.services.cases.baseUrl) : null;
|
|
1307
1404
|
const rh = params.services.rh ? new RhGateway(httpClient, params.services.rh.baseUrl) : null;
|
|
1308
1405
|
const accessHub = params.services.accessHub ? new AccessHubGateway(httpClient, params.services.accessHub.baseUrl) : null;
|
|
@@ -1316,6 +1413,7 @@ function createClient(params) {
|
|
|
1316
1413
|
integrations,
|
|
1317
1414
|
chatWebservice,
|
|
1318
1415
|
callReport,
|
|
1416
|
+
calls,
|
|
1319
1417
|
cases,
|
|
1320
1418
|
rh,
|
|
1321
1419
|
accessHub
|
|
@@ -1333,6 +1431,7 @@ var SERVICE_GATEWAYS = {
|
|
|
1333
1431
|
INTEGRATIONS: "integrations",
|
|
1334
1432
|
CHAT_WEBSERVICE: "chat-webservice",
|
|
1335
1433
|
CALL_REPORT: "call-report",
|
|
1434
|
+
CALLS: "calls",
|
|
1336
1435
|
CASES: "cases",
|
|
1337
1436
|
RH: "rh",
|
|
1338
1437
|
ACCESS_HUB: "access-hub"
|
|
@@ -1391,6 +1490,9 @@ function gateway(service) {
|
|
|
1391
1490
|
if (!sdk.client.callReport)
|
|
1392
1491
|
throw new Error(`Service 'call-report' is not configured. Provide its baseUrl in configure().`);
|
|
1393
1492
|
return sdk.client.callReport;
|
|
1493
|
+
case SERVICE_GATEWAYS.CALLS:
|
|
1494
|
+
if (!sdk.client.calls) throw new Error(`Service 'calls' is not configured. Provide its baseUrl in configure().`);
|
|
1495
|
+
return sdk.client.calls;
|
|
1394
1496
|
case SERVICE_GATEWAYS.CASES:
|
|
1395
1497
|
if (!sdk.client.cases) throw new Error(`Service 'cases' is not configured. Provide its baseUrl in configure().`);
|
|
1396
1498
|
return sdk.client.cases;
|