@opens/gateways 1.14.6 → 1.14.8
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/index.d.mts +26 -5
- package/dist/index.d.ts +26 -5
- package/dist/index.js +54 -15
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +54 -15
- package/dist/index.mjs.map +1 -1
- package/dist/integrations/contracts/index.d.mts +52 -1
- package/dist/integrations/contracts/index.d.ts +52 -1
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -11,7 +11,7 @@ import { GetPresignedUrlRequest, UploadPresignedUrlResponse, AudioConvertRespons
|
|
|
11
11
|
export { IUploadPresignedUrlResponse } from './assets/contracts/index.mjs';
|
|
12
12
|
import { GetContactPhonesParams, ContactPhoneSearchResponse, ContactCategoryResponse } from './contact-list/contracts/index.mjs';
|
|
13
13
|
export { ContactPhoneResponse } from './contact-list/contracts/index.mjs';
|
|
14
|
-
import { GetIntegrationPartnersByCompanyRequest, IntegrationPartner, GetWebhooksByCompanyRequest as GetWebhooksByCompanyRequest$1, GetIntegrationHooksCatalogRequest, HookCatalogItem, CreateIntegrationPartnerRequest, CreateWebhookRequest as CreateWebhookRequest$1, DeleteIntegrationPartnerParams, CreateIntegrationActionRequest, IntegrationAction, UpdateIntegrationActionParams, CreateIntegrationFieldRequest, IntegrationField, UpdateIntegrationFieldParams, DeleteIntegrationFieldParams, DeleteIntegrationActionParams } from './integrations/contracts/index.mjs';
|
|
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';
|
|
16
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.mjs';
|
|
17
17
|
export { MessageAttachment, MessageMetadata, MessageReactionResponse, MessageReplyContext, MessageStatusResponse, RoomActiveDates, RoomTagResponse } from './chat-webservice/contracts/index.mjs';
|
|
@@ -59,6 +59,10 @@ declare class CustomerServiceGateway {
|
|
|
59
59
|
getWorkGroupMembers(groupId: string, companyId?: string, profile?: string[]): Promise<WorkGroupMembersResponse>;
|
|
60
60
|
getAllUsers(params?: GetAllUsersParams): Promise<GetAllUsersResponse>;
|
|
61
61
|
getManagedUsers(managerId: string): Promise<GetManagedUsersResponse>;
|
|
62
|
+
/**
|
|
63
|
+
* Logs out the current user.
|
|
64
|
+
*/
|
|
65
|
+
logout(): Promise<void>;
|
|
62
66
|
}
|
|
63
67
|
|
|
64
68
|
/**
|
|
@@ -327,17 +331,34 @@ declare class IntegrationsGateway {
|
|
|
327
331
|
/**
|
|
328
332
|
* Retrieves all integration partners configured for a company.
|
|
329
333
|
* @param companyId - The company identifier.
|
|
330
|
-
* @returns The integration partners configured for the company.
|
|
331
334
|
*/
|
|
332
|
-
getPartnersByCompany({ companyId, name }: GetIntegrationPartnersByCompanyRequest): Promise<IntegrationPartner[]>;
|
|
335
|
+
getPartnersByCompany({ companyId, name, }: GetIntegrationPartnersByCompanyRequest): Promise<IntegrationPartner[]>;
|
|
333
336
|
/** Retrieves the webhooks scenario for a company. */
|
|
334
337
|
getWebhooksByCompany(params: GetWebhooksByCompanyRequest$1): Promise<IntegrationPartner[]>;
|
|
335
338
|
/**
|
|
336
339
|
* Retrieves the hook catalog, optionally scoped by module.
|
|
337
340
|
* @param module - The optional module identifier used by the Integrations API filter.
|
|
338
|
-
* @returns The hook catalog items, filtered by module when provided.
|
|
339
341
|
*/
|
|
340
342
|
getHooksCatalog({ module }?: GetIntegrationHooksCatalogRequest): Promise<HookCatalogItem[]>;
|
|
343
|
+
/**
|
|
344
|
+
* @param companyId - The optional company identifier.
|
|
345
|
+
*/
|
|
346
|
+
listAutomationPartners({ companyId }?: ListAutomationPartnersRequest): Promise<AutomationPartner[]>;
|
|
347
|
+
/**
|
|
348
|
+
* Lists actions for an automation partner.
|
|
349
|
+
* @param partnerId - The automation partner identifier.
|
|
350
|
+
*/
|
|
351
|
+
listAutomationActions({ partnerId }: ListAutomationActionsRequest): Promise<AutomationPartnerAction[]>;
|
|
352
|
+
/**
|
|
353
|
+
* Retrieves an automation partner by identifier.
|
|
354
|
+
* @param id - The automation partner identifier.
|
|
355
|
+
*/
|
|
356
|
+
getAutomationPartner({ id }: GetAutomationPartnerRequest): Promise<AutomationPartner>;
|
|
357
|
+
/**
|
|
358
|
+
* Creates an automation partner.
|
|
359
|
+
* @param payload - The automation partner creation payload.
|
|
360
|
+
*/
|
|
361
|
+
createAutomationPartner(payload: CreateAutomationPartnerRequest): Promise<AutomationPartner>;
|
|
341
362
|
/**
|
|
342
363
|
* Creates an integration partner.
|
|
343
364
|
* @param payload - The partner creation payload.
|
|
@@ -695,4 +716,4 @@ declare const configure: (params: GatewayClientParams) => void;
|
|
|
695
716
|
*/
|
|
696
717
|
declare function gateway<T extends keyof GatewayMap>(service: T): GatewayMap[T];
|
|
697
718
|
|
|
698
|
-
export { AccessPackage, AttachmentByIdResponse, AudioConvertResponse, 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, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, CreateCompanyAccessPackagePayload, CreateIntegrationActionRequest, CreateIntegrationFieldRequest, CreateIntegrationPartnerRequest, CreateTimeEntryRequest, CreateWebhookRequest$1 as CreateWebhookRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, DeleteTimeEntryRequest, EnableCampaignCompanyRequest, FindOrCreateQueueRuleRequest, GetAccessPackagesParams, GetAllUsersParams, GetAllUsersResponse, GetAttachmentByIdRequest, 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, 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, UpdateCasePermissionsRequest, UpdateCompanyAccessPackagePayload, UpdateIntegrationActionParams, UpdateIntegrationFieldParams, UpdateMemberInRoomRequest, UpdateTimeEntryRequest, UploadPresignedUrlResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };
|
|
719
|
+
export { AccessPackage, 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, CreateAutomationPartnerRequest, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, CreateCompanyAccessPackagePayload, CreateIntegrationActionRequest, CreateIntegrationFieldRequest, CreateIntegrationPartnerRequest, CreateTimeEntryRequest, CreateWebhookRequest$1 as CreateWebhookRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, DeleteTimeEntryRequest, EnableCampaignCompanyRequest, FindOrCreateQueueRuleRequest, 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, UpdateCasePermissionsRequest, UpdateCompanyAccessPackagePayload, UpdateIntegrationActionParams, UpdateIntegrationFieldParams, UpdateMemberInRoomRequest, UpdateTimeEntryRequest, UploadPresignedUrlResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };
|
package/dist/index.d.ts
CHANGED
|
@@ -11,7 +11,7 @@ import { GetPresignedUrlRequest, UploadPresignedUrlResponse, AudioConvertRespons
|
|
|
11
11
|
export { IUploadPresignedUrlResponse } from './assets/contracts/index.js';
|
|
12
12
|
import { GetContactPhonesParams, ContactPhoneSearchResponse, ContactCategoryResponse } from './contact-list/contracts/index.js';
|
|
13
13
|
export { ContactPhoneResponse } from './contact-list/contracts/index.js';
|
|
14
|
-
import { GetIntegrationPartnersByCompanyRequest, IntegrationPartner, GetWebhooksByCompanyRequest as GetWebhooksByCompanyRequest$1, GetIntegrationHooksCatalogRequest, HookCatalogItem, CreateIntegrationPartnerRequest, CreateWebhookRequest as CreateWebhookRequest$1, DeleteIntegrationPartnerParams, CreateIntegrationActionRequest, IntegrationAction, UpdateIntegrationActionParams, CreateIntegrationFieldRequest, IntegrationField, UpdateIntegrationFieldParams, DeleteIntegrationFieldParams, DeleteIntegrationActionParams } from './integrations/contracts/index.js';
|
|
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
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
17
|
export { MessageAttachment, MessageMetadata, MessageReactionResponse, MessageReplyContext, MessageStatusResponse, RoomActiveDates, RoomTagResponse } from './chat-webservice/contracts/index.js';
|
|
@@ -59,6 +59,10 @@ declare class CustomerServiceGateway {
|
|
|
59
59
|
getWorkGroupMembers(groupId: string, companyId?: string, profile?: string[]): Promise<WorkGroupMembersResponse>;
|
|
60
60
|
getAllUsers(params?: GetAllUsersParams): Promise<GetAllUsersResponse>;
|
|
61
61
|
getManagedUsers(managerId: string): Promise<GetManagedUsersResponse>;
|
|
62
|
+
/**
|
|
63
|
+
* Logs out the current user.
|
|
64
|
+
*/
|
|
65
|
+
logout(): Promise<void>;
|
|
62
66
|
}
|
|
63
67
|
|
|
64
68
|
/**
|
|
@@ -327,17 +331,34 @@ declare class IntegrationsGateway {
|
|
|
327
331
|
/**
|
|
328
332
|
* Retrieves all integration partners configured for a company.
|
|
329
333
|
* @param companyId - The company identifier.
|
|
330
|
-
* @returns The integration partners configured for the company.
|
|
331
334
|
*/
|
|
332
|
-
getPartnersByCompany({ companyId, name }: GetIntegrationPartnersByCompanyRequest): Promise<IntegrationPartner[]>;
|
|
335
|
+
getPartnersByCompany({ companyId, name, }: GetIntegrationPartnersByCompanyRequest): Promise<IntegrationPartner[]>;
|
|
333
336
|
/** Retrieves the webhooks scenario for a company. */
|
|
334
337
|
getWebhooksByCompany(params: GetWebhooksByCompanyRequest$1): Promise<IntegrationPartner[]>;
|
|
335
338
|
/**
|
|
336
339
|
* Retrieves the hook catalog, optionally scoped by module.
|
|
337
340
|
* @param module - The optional module identifier used by the Integrations API filter.
|
|
338
|
-
* @returns The hook catalog items, filtered by module when provided.
|
|
339
341
|
*/
|
|
340
342
|
getHooksCatalog({ module }?: GetIntegrationHooksCatalogRequest): Promise<HookCatalogItem[]>;
|
|
343
|
+
/**
|
|
344
|
+
* @param companyId - The optional company identifier.
|
|
345
|
+
*/
|
|
346
|
+
listAutomationPartners({ companyId }?: ListAutomationPartnersRequest): Promise<AutomationPartner[]>;
|
|
347
|
+
/**
|
|
348
|
+
* Lists actions for an automation partner.
|
|
349
|
+
* @param partnerId - The automation partner identifier.
|
|
350
|
+
*/
|
|
351
|
+
listAutomationActions({ partnerId }: ListAutomationActionsRequest): Promise<AutomationPartnerAction[]>;
|
|
352
|
+
/**
|
|
353
|
+
* Retrieves an automation partner by identifier.
|
|
354
|
+
* @param id - The automation partner identifier.
|
|
355
|
+
*/
|
|
356
|
+
getAutomationPartner({ id }: GetAutomationPartnerRequest): Promise<AutomationPartner>;
|
|
357
|
+
/**
|
|
358
|
+
* Creates an automation partner.
|
|
359
|
+
* @param payload - The automation partner creation payload.
|
|
360
|
+
*/
|
|
361
|
+
createAutomationPartner(payload: CreateAutomationPartnerRequest): Promise<AutomationPartner>;
|
|
341
362
|
/**
|
|
342
363
|
* Creates an integration partner.
|
|
343
364
|
* @param payload - The partner creation payload.
|
|
@@ -695,4 +716,4 @@ declare const configure: (params: GatewayClientParams) => void;
|
|
|
695
716
|
*/
|
|
696
717
|
declare function gateway<T extends keyof GatewayMap>(service: T): GatewayMap[T];
|
|
697
718
|
|
|
698
|
-
export { AccessPackage, AttachmentByIdResponse, AudioConvertResponse, 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, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, CreateCompanyAccessPackagePayload, CreateIntegrationActionRequest, CreateIntegrationFieldRequest, CreateIntegrationPartnerRequest, CreateTimeEntryRequest, CreateWebhookRequest$1 as CreateWebhookRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, DeleteTimeEntryRequest, EnableCampaignCompanyRequest, FindOrCreateQueueRuleRequest, GetAccessPackagesParams, GetAllUsersParams, GetAllUsersResponse, GetAttachmentByIdRequest, 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, 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, UpdateCasePermissionsRequest, UpdateCompanyAccessPackagePayload, UpdateIntegrationActionParams, UpdateIntegrationFieldParams, UpdateMemberInRoomRequest, UpdateTimeEntryRequest, UploadPresignedUrlResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };
|
|
719
|
+
export { AccessPackage, 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, CreateAutomationPartnerRequest, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, CreateCompanyAccessPackagePayload, CreateIntegrationActionRequest, CreateIntegrationFieldRequest, CreateIntegrationPartnerRequest, CreateTimeEntryRequest, CreateWebhookRequest$1 as CreateWebhookRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, DeleteTimeEntryRequest, EnableCampaignCompanyRequest, FindOrCreateQueueRuleRequest, 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, UpdateCasePermissionsRequest, UpdateCompanyAccessPackagePayload, UpdateIntegrationActionParams, UpdateIntegrationFieldParams, UpdateMemberInRoomRequest, UpdateTimeEntryRequest, UploadPresignedUrlResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };
|
package/dist/index.js
CHANGED
|
@@ -59,10 +59,9 @@ var CustomerServiceGateway = class {
|
|
|
59
59
|
* @returns The work groups for the given company.
|
|
60
60
|
*/
|
|
61
61
|
async getWorkGroups(companyId) {
|
|
62
|
-
const { data } = await this.httpClient.get(
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
);
|
|
62
|
+
const { data } = await this.httpClient.get(`${this.baseUrl}/companies/work-groups`, {
|
|
63
|
+
params: { company_id: companyId }
|
|
64
|
+
});
|
|
66
65
|
return data;
|
|
67
66
|
}
|
|
68
67
|
/**
|
|
@@ -97,18 +96,19 @@ var CustomerServiceGateway = class {
|
|
|
97
96
|
return data;
|
|
98
97
|
}
|
|
99
98
|
async getAllUsers(params) {
|
|
100
|
-
const { data } = await this.httpClient.get(
|
|
101
|
-
`${this.baseUrl}/companies/users`,
|
|
102
|
-
{ params }
|
|
103
|
-
);
|
|
99
|
+
const { data } = await this.httpClient.get(`${this.baseUrl}/companies/users`, { params });
|
|
104
100
|
return data;
|
|
105
101
|
}
|
|
106
102
|
async getManagedUsers(managerId) {
|
|
107
|
-
const { data } = await this.httpClient.get(
|
|
108
|
-
`${this.baseUrl}/users/managed/${managerId}`
|
|
109
|
-
);
|
|
103
|
+
const { data } = await this.httpClient.get(`${this.baseUrl}/users/managed/${managerId}`);
|
|
110
104
|
return data;
|
|
111
105
|
}
|
|
106
|
+
/**
|
|
107
|
+
* Logs out the current user.
|
|
108
|
+
*/
|
|
109
|
+
async logout() {
|
|
110
|
+
await this.httpClient.get(`${this.baseUrl}/users/logout`);
|
|
111
|
+
}
|
|
112
112
|
};
|
|
113
113
|
|
|
114
114
|
// src/chat-config/index.ts
|
|
@@ -584,9 +584,11 @@ var IntegrationsGateway = class {
|
|
|
584
584
|
/**
|
|
585
585
|
* Retrieves all integration partners configured for a company.
|
|
586
586
|
* @param companyId - The company identifier.
|
|
587
|
-
* @returns The integration partners configured for the company.
|
|
588
587
|
*/
|
|
589
|
-
async getPartnersByCompany({
|
|
588
|
+
async getPartnersByCompany({
|
|
589
|
+
companyId,
|
|
590
|
+
name
|
|
591
|
+
}) {
|
|
590
592
|
const { data } = await this.httpClient.get(`${this.baseUrl}/partner/company/${companyId}`, {
|
|
591
593
|
params: name ? { name } : void 0
|
|
592
594
|
});
|
|
@@ -602,7 +604,6 @@ var IntegrationsGateway = class {
|
|
|
602
604
|
/**
|
|
603
605
|
* Retrieves the hook catalog, optionally scoped by module.
|
|
604
606
|
* @param module - The optional module identifier used by the Integrations API filter.
|
|
605
|
-
* @returns The hook catalog items, filtered by module when provided.
|
|
606
607
|
*/
|
|
607
608
|
async getHooksCatalog({ module: module2 } = {}) {
|
|
608
609
|
const { data } = await this.httpClient.get(`${this.baseUrl}/hooks`, {
|
|
@@ -610,6 +611,41 @@ var IntegrationsGateway = class {
|
|
|
610
611
|
});
|
|
611
612
|
return data;
|
|
612
613
|
}
|
|
614
|
+
/**
|
|
615
|
+
* @param companyId - The optional company identifier.
|
|
616
|
+
*/
|
|
617
|
+
async listAutomationPartners({ companyId } = {}) {
|
|
618
|
+
const { data } = await this.httpClient.get(`${this.baseUrl}/automations/partners`, {
|
|
619
|
+
params: companyId ? { companyId } : void 0
|
|
620
|
+
});
|
|
621
|
+
return data;
|
|
622
|
+
}
|
|
623
|
+
/**
|
|
624
|
+
* Lists actions for an automation partner.
|
|
625
|
+
* @param partnerId - The automation partner identifier.
|
|
626
|
+
*/
|
|
627
|
+
async listAutomationActions({ partnerId }) {
|
|
628
|
+
const { data } = await this.httpClient.get(
|
|
629
|
+
`${this.baseUrl}/automations/partners/${partnerId}/actions`
|
|
630
|
+
);
|
|
631
|
+
return data;
|
|
632
|
+
}
|
|
633
|
+
/**
|
|
634
|
+
* Retrieves an automation partner by identifier.
|
|
635
|
+
* @param id - The automation partner identifier.
|
|
636
|
+
*/
|
|
637
|
+
async getAutomationPartner({ id }) {
|
|
638
|
+
const { data } = await this.httpClient.get(`${this.baseUrl}/automations/partners/${id}`);
|
|
639
|
+
return data;
|
|
640
|
+
}
|
|
641
|
+
/**
|
|
642
|
+
* Creates an automation partner.
|
|
643
|
+
* @param payload - The automation partner creation payload.
|
|
644
|
+
*/
|
|
645
|
+
async createAutomationPartner(payload) {
|
|
646
|
+
const { data } = await this.httpClient.post(`${this.baseUrl}/automations/partners`, payload);
|
|
647
|
+
return data;
|
|
648
|
+
}
|
|
613
649
|
/**
|
|
614
650
|
* Creates an integration partner.
|
|
615
651
|
* @param payload - The partner creation payload.
|
|
@@ -670,7 +706,10 @@ var IntegrationsGateway = class {
|
|
|
670
706
|
* @returns The updated integration field response.
|
|
671
707
|
*/
|
|
672
708
|
async updateField({ fieldId, payload }) {
|
|
673
|
-
const { data } = await this.httpClient.put(
|
|
709
|
+
const { data } = await this.httpClient.put(
|
|
710
|
+
`${this.baseUrl}/field/${fieldId}`,
|
|
711
|
+
payload
|
|
712
|
+
);
|
|
674
713
|
return data;
|
|
675
714
|
}
|
|
676
715
|
/**
|