@opens/gateways 1.14.5 → 1.14.7
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/cases/contracts/index.d.mts +58 -1
- package/dist/cases/contracts/index.d.ts +58 -1
- package/dist/cases/contracts/index.js.map +1 -1
- package/dist/index.d.mts +26 -7
- package/dist/index.d.ts +26 -7
- package/dist/index.js +48 -4
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +48 -4
- 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 +2 -2
|
@@ -77,6 +77,63 @@ interface CaseFeedByActionItem {
|
|
|
77
77
|
protocol: string | null;
|
|
78
78
|
}
|
|
79
79
|
|
|
80
|
+
/** A case item as returned by the cases listing endpoint. */
|
|
81
|
+
interface CaseListItem {
|
|
82
|
+
id: number;
|
|
83
|
+
sid: number;
|
|
84
|
+
protocol: string;
|
|
85
|
+
title: string;
|
|
86
|
+
description: string;
|
|
87
|
+
customerId: string;
|
|
88
|
+
assignedTo: string | null;
|
|
89
|
+
createdBy: string;
|
|
90
|
+
companyId: string;
|
|
91
|
+
caseStatusId: number;
|
|
92
|
+
dueDate: string | null;
|
|
93
|
+
createdAt: string;
|
|
94
|
+
updatedAt: string;
|
|
95
|
+
status?: {
|
|
96
|
+
name: string;
|
|
97
|
+
};
|
|
98
|
+
categories?: {
|
|
99
|
+
id: string;
|
|
100
|
+
name: string;
|
|
101
|
+
}[];
|
|
102
|
+
}
|
|
103
|
+
/** Cursor returned by the cases listing endpoint. */
|
|
104
|
+
type ListCasesCursor = unknown[];
|
|
105
|
+
/** Request payload for listing cases, including the work group filter (multi-select). */
|
|
106
|
+
interface ListCasesRequest {
|
|
107
|
+
customerId?: string;
|
|
108
|
+
caseStatusId?: (string | number)[];
|
|
109
|
+
statusName?: string;
|
|
110
|
+
createdBy?: string;
|
|
111
|
+
assignedTo?: string;
|
|
112
|
+
/** Work group ids to filter by (union of members across all selected groups). */
|
|
113
|
+
workGroupId?: string[];
|
|
114
|
+
title?: string;
|
|
115
|
+
startDate?: string;
|
|
116
|
+
endDate?: string;
|
|
117
|
+
limit?: number;
|
|
118
|
+
priorityIds?: string[];
|
|
119
|
+
protocol?: string;
|
|
120
|
+
categoryIds?: string[];
|
|
121
|
+
etaStatus?: 'unscheduled' | 'overdue' | 'upcoming';
|
|
122
|
+
dueDateGt?: string;
|
|
123
|
+
dueDateLt?: string;
|
|
124
|
+
sortBy?: 'createdAt' | 'dueDate' | 'title' | 'protocol';
|
|
125
|
+
sortOrder?: 'asc' | 'desc';
|
|
126
|
+
cursor?: ListCasesCursor;
|
|
127
|
+
associations?: ('status' | 'priority' | 'categories')[];
|
|
128
|
+
}
|
|
129
|
+
/** Paginated response for the cases listing endpoint. */
|
|
130
|
+
interface ListCasesResponse {
|
|
131
|
+
data: CaseListItem[];
|
|
132
|
+
totalRemaining: number;
|
|
133
|
+
nextCursor: ListCasesCursor | null;
|
|
134
|
+
hasMore: boolean;
|
|
135
|
+
}
|
|
136
|
+
|
|
80
137
|
/** A single time entry (apontamento) recorded against a case. */
|
|
81
138
|
interface CaseTimeEntry {
|
|
82
139
|
id: string;
|
|
@@ -123,4 +180,4 @@ interface DeleteTimeEntryRequest {
|
|
|
123
180
|
timeEntryId: string;
|
|
124
181
|
}
|
|
125
182
|
|
|
126
|
-
export type { CaseFeedByActionItem, CasePermissions, CasePermissionsValue, CaseTimeEntry, CommentHistoryChangeType, CommentHistoryCursor, CommentHistoryEntry, CommentHistoryPage, CreateTimeEntryRequest, DeleteTimeEntryRequest, GetCaseFeedByActionsRequest, GetCommentHistoryRequest, ListTimeEntriesPage, ListTimeEntriesRequest, TimeEntryCursor, UpdateCasePermissionsRequest, UpdateTimeEntryRequest };
|
|
183
|
+
export type { CaseFeedByActionItem, CaseListItem, CasePermissions, CasePermissionsValue, CaseTimeEntry, CommentHistoryChangeType, CommentHistoryCursor, CommentHistoryEntry, CommentHistoryPage, CreateTimeEntryRequest, DeleteTimeEntryRequest, GetCaseFeedByActionsRequest, GetCommentHistoryRequest, ListCasesCursor, ListCasesRequest, ListCasesResponse, ListTimeEntriesPage, ListTimeEntriesRequest, TimeEntryCursor, UpdateCasePermissionsRequest, UpdateTimeEntryRequest };
|
|
@@ -77,6 +77,63 @@ interface CaseFeedByActionItem {
|
|
|
77
77
|
protocol: string | null;
|
|
78
78
|
}
|
|
79
79
|
|
|
80
|
+
/** A case item as returned by the cases listing endpoint. */
|
|
81
|
+
interface CaseListItem {
|
|
82
|
+
id: number;
|
|
83
|
+
sid: number;
|
|
84
|
+
protocol: string;
|
|
85
|
+
title: string;
|
|
86
|
+
description: string;
|
|
87
|
+
customerId: string;
|
|
88
|
+
assignedTo: string | null;
|
|
89
|
+
createdBy: string;
|
|
90
|
+
companyId: string;
|
|
91
|
+
caseStatusId: number;
|
|
92
|
+
dueDate: string | null;
|
|
93
|
+
createdAt: string;
|
|
94
|
+
updatedAt: string;
|
|
95
|
+
status?: {
|
|
96
|
+
name: string;
|
|
97
|
+
};
|
|
98
|
+
categories?: {
|
|
99
|
+
id: string;
|
|
100
|
+
name: string;
|
|
101
|
+
}[];
|
|
102
|
+
}
|
|
103
|
+
/** Cursor returned by the cases listing endpoint. */
|
|
104
|
+
type ListCasesCursor = unknown[];
|
|
105
|
+
/** Request payload for listing cases, including the work group filter (multi-select). */
|
|
106
|
+
interface ListCasesRequest {
|
|
107
|
+
customerId?: string;
|
|
108
|
+
caseStatusId?: (string | number)[];
|
|
109
|
+
statusName?: string;
|
|
110
|
+
createdBy?: string;
|
|
111
|
+
assignedTo?: string;
|
|
112
|
+
/** Work group ids to filter by (union of members across all selected groups). */
|
|
113
|
+
workGroupId?: string[];
|
|
114
|
+
title?: string;
|
|
115
|
+
startDate?: string;
|
|
116
|
+
endDate?: string;
|
|
117
|
+
limit?: number;
|
|
118
|
+
priorityIds?: string[];
|
|
119
|
+
protocol?: string;
|
|
120
|
+
categoryIds?: string[];
|
|
121
|
+
etaStatus?: 'unscheduled' | 'overdue' | 'upcoming';
|
|
122
|
+
dueDateGt?: string;
|
|
123
|
+
dueDateLt?: string;
|
|
124
|
+
sortBy?: 'createdAt' | 'dueDate' | 'title' | 'protocol';
|
|
125
|
+
sortOrder?: 'asc' | 'desc';
|
|
126
|
+
cursor?: ListCasesCursor;
|
|
127
|
+
associations?: ('status' | 'priority' | 'categories')[];
|
|
128
|
+
}
|
|
129
|
+
/** Paginated response for the cases listing endpoint. */
|
|
130
|
+
interface ListCasesResponse {
|
|
131
|
+
data: CaseListItem[];
|
|
132
|
+
totalRemaining: number;
|
|
133
|
+
nextCursor: ListCasesCursor | null;
|
|
134
|
+
hasMore: boolean;
|
|
135
|
+
}
|
|
136
|
+
|
|
80
137
|
/** A single time entry (apontamento) recorded against a case. */
|
|
81
138
|
interface CaseTimeEntry {
|
|
82
139
|
id: string;
|
|
@@ -123,4 +180,4 @@ interface DeleteTimeEntryRequest {
|
|
|
123
180
|
timeEntryId: string;
|
|
124
181
|
}
|
|
125
182
|
|
|
126
|
-
export type { CaseFeedByActionItem, CasePermissions, CasePermissionsValue, CaseTimeEntry, CommentHistoryChangeType, CommentHistoryCursor, CommentHistoryEntry, CommentHistoryPage, CreateTimeEntryRequest, DeleteTimeEntryRequest, GetCaseFeedByActionsRequest, GetCommentHistoryRequest, ListTimeEntriesPage, ListTimeEntriesRequest, TimeEntryCursor, UpdateCasePermissionsRequest, UpdateTimeEntryRequest };
|
|
183
|
+
export type { CaseFeedByActionItem, CaseListItem, CasePermissions, CasePermissionsValue, CaseTimeEntry, CommentHistoryChangeType, CommentHistoryCursor, CommentHistoryEntry, CommentHistoryPage, CreateTimeEntryRequest, DeleteTimeEntryRequest, GetCaseFeedByActionsRequest, GetCommentHistoryRequest, ListCasesCursor, ListCasesRequest, ListCasesResponse, ListTimeEntriesPage, ListTimeEntriesRequest, TimeEntryCursor, UpdateCasePermissionsRequest, UpdateTimeEntryRequest };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../src/cases/contracts/index.ts"],"sourcesContent":["export * from './comment-history';\nexport * from './case-permissions';\nexport * from './case-feed-by-actions';\nexport * from './time-entry';\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
|
|
1
|
+
{"version":3,"sources":["../../../src/cases/contracts/index.ts"],"sourcesContent":["export * from './comment-history';\nexport * from './case-permissions';\nexport * from './case-feed-by-actions';\nexport * from './list-cases';\nexport * from './time-entry';\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
|
package/dist/index.d.mts
CHANGED
|
@@ -11,14 +11,14 @@ 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';
|
|
18
18
|
import { ListContactHistoryRequest, ContactHistoryResponse } from './call-report/contracts/index.mjs';
|
|
19
19
|
export { ContactHistoryIndex, ContactHistorySortOrder, ContactInteractionResponse, InteractionCallStepResponse, InteractionChatStepResponse, InteractionMemberResponse, InteractionOrganizationResponse } from './call-report/contracts/index.mjs';
|
|
20
|
-
import { GetCommentHistoryRequest, CommentHistoryPage, CasePermissions, UpdateCasePermissionsRequest, GetCaseFeedByActionsRequest, CaseFeedByActionItem, CreateTimeEntryRequest, CaseTimeEntry, ListTimeEntriesRequest, ListTimeEntriesPage, UpdateTimeEntryRequest, DeleteTimeEntryRequest } from './cases/contracts/index.mjs';
|
|
21
|
-
export { CasePermissionsValue, CommentHistoryChangeType, CommentHistoryCursor, CommentHistoryEntry, TimeEntryCursor } from './cases/contracts/index.mjs';
|
|
20
|
+
import { GetCommentHistoryRequest, CommentHistoryPage, CasePermissions, UpdateCasePermissionsRequest, GetCaseFeedByActionsRequest, CaseFeedByActionItem, ListCasesRequest, ListCasesResponse, CreateTimeEntryRequest, CaseTimeEntry, ListTimeEntriesRequest, ListTimeEntriesPage, UpdateTimeEntryRequest, DeleteTimeEntryRequest } from './cases/contracts/index.mjs';
|
|
21
|
+
export { CaseListItem, CasePermissionsValue, CommentHistoryChangeType, CommentHistoryCursor, CommentHistoryEntry, ListCasesCursor, TimeEntryCursor } from './cases/contracts/index.mjs';
|
|
22
22
|
import { GetAccessPackagesParams, PaginatedResult, AccessPackage, GetCompanyAccessPackagesParams, CompanyAccessPackageItem, CreateCompanyAccessPackagePayload, UpdateCompanyAccessPackagePayload, GetCompanyResourcesParams, CompanyResource } from './access-hub/contracts/index.mjs';
|
|
23
23
|
export { AccessGroup, AccessPackageGroup } from './access-hub/contracts/index.mjs';
|
|
24
24
|
export { Event } from './rh/contracts/index.mjs';
|
|
@@ -327,17 +327,34 @@ declare class IntegrationsGateway {
|
|
|
327
327
|
/**
|
|
328
328
|
* Retrieves all integration partners configured for a company.
|
|
329
329
|
* @param companyId - The company identifier.
|
|
330
|
-
* @returns The integration partners configured for the company.
|
|
331
330
|
*/
|
|
332
|
-
getPartnersByCompany({ companyId, name }: GetIntegrationPartnersByCompanyRequest): Promise<IntegrationPartner[]>;
|
|
331
|
+
getPartnersByCompany({ companyId, name, }: GetIntegrationPartnersByCompanyRequest): Promise<IntegrationPartner[]>;
|
|
333
332
|
/** Retrieves the webhooks scenario for a company. */
|
|
334
333
|
getWebhooksByCompany(params: GetWebhooksByCompanyRequest$1): Promise<IntegrationPartner[]>;
|
|
335
334
|
/**
|
|
336
335
|
* Retrieves the hook catalog, optionally scoped by module.
|
|
337
336
|
* @param module - The optional module identifier used by the Integrations API filter.
|
|
338
|
-
* @returns The hook catalog items, filtered by module when provided.
|
|
339
337
|
*/
|
|
340
338
|
getHooksCatalog({ module }?: GetIntegrationHooksCatalogRequest): Promise<HookCatalogItem[]>;
|
|
339
|
+
/**
|
|
340
|
+
* @param companyId - The optional company identifier.
|
|
341
|
+
*/
|
|
342
|
+
listAutomationPartners({ companyId }?: ListAutomationPartnersRequest): Promise<AutomationPartner[]>;
|
|
343
|
+
/**
|
|
344
|
+
* Lists actions for an automation partner.
|
|
345
|
+
* @param partnerId - The automation partner identifier.
|
|
346
|
+
*/
|
|
347
|
+
listAutomationActions({ partnerId }: ListAutomationActionsRequest): Promise<AutomationPartnerAction[]>;
|
|
348
|
+
/**
|
|
349
|
+
* Retrieves an automation partner by identifier.
|
|
350
|
+
* @param id - The automation partner identifier.
|
|
351
|
+
*/
|
|
352
|
+
getAutomationPartner({ id }: GetAutomationPartnerRequest): Promise<AutomationPartner>;
|
|
353
|
+
/**
|
|
354
|
+
* Creates an automation partner.
|
|
355
|
+
* @param payload - The automation partner creation payload.
|
|
356
|
+
*/
|
|
357
|
+
createAutomationPartner(payload: CreateAutomationPartnerRequest): Promise<AutomationPartner>;
|
|
341
358
|
/**
|
|
342
359
|
* Creates an integration partner.
|
|
343
360
|
* @param payload - The partner creation payload.
|
|
@@ -523,6 +540,8 @@ declare class CasesGateway {
|
|
|
523
540
|
* @returns Array of case feed items linking each action to a case.
|
|
524
541
|
*/
|
|
525
542
|
getCaseFeedByActions(payload: GetCaseFeedByActionsRequest): Promise<CaseFeedByActionItem[]>;
|
|
543
|
+
/** Lists cases with the given filters. `workGroupId` accepts multiple ids (union of members across groups) and is sent in the body to avoid GET URL length limits. */
|
|
544
|
+
listCases(payload: ListCasesRequest): Promise<ListCasesResponse>;
|
|
526
545
|
/** Creates a time entry (apontamento) on a case. */
|
|
527
546
|
createTimeEntry(payload: CreateTimeEntryRequest): Promise<CaseTimeEntry>;
|
|
528
547
|
/** Retrieves one page of time entries (apontamentos) for a case. */
|
|
@@ -693,4 +712,4 @@ declare const configure: (params: GatewayClientParams) => void;
|
|
|
693
712
|
*/
|
|
694
713
|
declare function gateway<T extends keyof GatewayMap>(service: T): GatewayMap[T];
|
|
695
714
|
|
|
696
|
-
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, 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 };
|
|
715
|
+
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,14 +11,14 @@ 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';
|
|
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 { GetCommentHistoryRequest, CommentHistoryPage, CasePermissions, UpdateCasePermissionsRequest, GetCaseFeedByActionsRequest, CaseFeedByActionItem, CreateTimeEntryRequest, CaseTimeEntry, ListTimeEntriesRequest, ListTimeEntriesPage, UpdateTimeEntryRequest, DeleteTimeEntryRequest } from './cases/contracts/index.js';
|
|
21
|
-
export { CasePermissionsValue, CommentHistoryChangeType, CommentHistoryCursor, CommentHistoryEntry, TimeEntryCursor } from './cases/contracts/index.js';
|
|
20
|
+
import { GetCommentHistoryRequest, CommentHistoryPage, CasePermissions, UpdateCasePermissionsRequest, GetCaseFeedByActionsRequest, CaseFeedByActionItem, ListCasesRequest, ListCasesResponse, CreateTimeEntryRequest, CaseTimeEntry, ListTimeEntriesRequest, ListTimeEntriesPage, UpdateTimeEntryRequest, DeleteTimeEntryRequest } from './cases/contracts/index.js';
|
|
21
|
+
export { CaseListItem, CasePermissionsValue, CommentHistoryChangeType, CommentHistoryCursor, CommentHistoryEntry, ListCasesCursor, TimeEntryCursor } from './cases/contracts/index.js';
|
|
22
22
|
import { GetAccessPackagesParams, PaginatedResult, AccessPackage, GetCompanyAccessPackagesParams, CompanyAccessPackageItem, CreateCompanyAccessPackagePayload, UpdateCompanyAccessPackagePayload, GetCompanyResourcesParams, CompanyResource } from './access-hub/contracts/index.js';
|
|
23
23
|
export { AccessGroup, AccessPackageGroup } from './access-hub/contracts/index.js';
|
|
24
24
|
export { Event } from './rh/contracts/index.js';
|
|
@@ -327,17 +327,34 @@ declare class IntegrationsGateway {
|
|
|
327
327
|
/**
|
|
328
328
|
* Retrieves all integration partners configured for a company.
|
|
329
329
|
* @param companyId - The company identifier.
|
|
330
|
-
* @returns The integration partners configured for the company.
|
|
331
330
|
*/
|
|
332
|
-
getPartnersByCompany({ companyId, name }: GetIntegrationPartnersByCompanyRequest): Promise<IntegrationPartner[]>;
|
|
331
|
+
getPartnersByCompany({ companyId, name, }: GetIntegrationPartnersByCompanyRequest): Promise<IntegrationPartner[]>;
|
|
333
332
|
/** Retrieves the webhooks scenario for a company. */
|
|
334
333
|
getWebhooksByCompany(params: GetWebhooksByCompanyRequest$1): Promise<IntegrationPartner[]>;
|
|
335
334
|
/**
|
|
336
335
|
* Retrieves the hook catalog, optionally scoped by module.
|
|
337
336
|
* @param module - The optional module identifier used by the Integrations API filter.
|
|
338
|
-
* @returns The hook catalog items, filtered by module when provided.
|
|
339
337
|
*/
|
|
340
338
|
getHooksCatalog({ module }?: GetIntegrationHooksCatalogRequest): Promise<HookCatalogItem[]>;
|
|
339
|
+
/**
|
|
340
|
+
* @param companyId - The optional company identifier.
|
|
341
|
+
*/
|
|
342
|
+
listAutomationPartners({ companyId }?: ListAutomationPartnersRequest): Promise<AutomationPartner[]>;
|
|
343
|
+
/**
|
|
344
|
+
* Lists actions for an automation partner.
|
|
345
|
+
* @param partnerId - The automation partner identifier.
|
|
346
|
+
*/
|
|
347
|
+
listAutomationActions({ partnerId }: ListAutomationActionsRequest): Promise<AutomationPartnerAction[]>;
|
|
348
|
+
/**
|
|
349
|
+
* Retrieves an automation partner by identifier.
|
|
350
|
+
* @param id - The automation partner identifier.
|
|
351
|
+
*/
|
|
352
|
+
getAutomationPartner({ id }: GetAutomationPartnerRequest): Promise<AutomationPartner>;
|
|
353
|
+
/**
|
|
354
|
+
* Creates an automation partner.
|
|
355
|
+
* @param payload - The automation partner creation payload.
|
|
356
|
+
*/
|
|
357
|
+
createAutomationPartner(payload: CreateAutomationPartnerRequest): Promise<AutomationPartner>;
|
|
341
358
|
/**
|
|
342
359
|
* Creates an integration partner.
|
|
343
360
|
* @param payload - The partner creation payload.
|
|
@@ -523,6 +540,8 @@ declare class CasesGateway {
|
|
|
523
540
|
* @returns Array of case feed items linking each action to a case.
|
|
524
541
|
*/
|
|
525
542
|
getCaseFeedByActions(payload: GetCaseFeedByActionsRequest): Promise<CaseFeedByActionItem[]>;
|
|
543
|
+
/** Lists cases with the given filters. `workGroupId` accepts multiple ids (union of members across groups) and is sent in the body to avoid GET URL length limits. */
|
|
544
|
+
listCases(payload: ListCasesRequest): Promise<ListCasesResponse>;
|
|
526
545
|
/** Creates a time entry (apontamento) on a case. */
|
|
527
546
|
createTimeEntry(payload: CreateTimeEntryRequest): Promise<CaseTimeEntry>;
|
|
528
547
|
/** Retrieves one page of time entries (apontamentos) for a case. */
|
|
@@ -693,4 +712,4 @@ declare const configure: (params: GatewayClientParams) => void;
|
|
|
693
712
|
*/
|
|
694
713
|
declare function gateway<T extends keyof GatewayMap>(service: T): GatewayMap[T];
|
|
695
714
|
|
|
696
|
-
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, 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 };
|
|
715
|
+
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
|
@@ -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
|
/**
|
|
@@ -899,6 +938,11 @@ var CasesGateway = class {
|
|
|
899
938
|
);
|
|
900
939
|
return data;
|
|
901
940
|
}
|
|
941
|
+
/** Lists cases with the given filters. `workGroupId` accepts multiple ids (union of members across groups) and is sent in the body to avoid GET URL length limits. */
|
|
942
|
+
async listCases(payload) {
|
|
943
|
+
const { data } = await this.httpClient.post(`${this.baseUrl}/cases/list`, payload);
|
|
944
|
+
return data;
|
|
945
|
+
}
|
|
902
946
|
/** Creates a time entry (apontamento) on a case. */
|
|
903
947
|
async createTimeEntry(payload) {
|
|
904
948
|
const { caseId, ...body } = payload;
|