@opens/gateways 1.14.4 → 1.14.6
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 +104 -1
- package/dist/cases/contracts/index.d.ts +104 -1
- package/dist/cases/contracts/index.js.map +1 -1
- package/dist/index.d.mts +13 -3
- package/dist/index.d.ts +13 -3
- package/dist/index.js +36 -0
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +36 -0
- package/dist/index.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -77,4 +77,107 @@ interface CaseFeedByActionItem {
|
|
|
77
77
|
protocol: string | null;
|
|
78
78
|
}
|
|
79
79
|
|
|
80
|
-
|
|
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
|
+
|
|
137
|
+
/** A single time entry (apontamento) recorded against a case. */
|
|
138
|
+
interface CaseTimeEntry {
|
|
139
|
+
id: string;
|
|
140
|
+
caseId: number;
|
|
141
|
+
companyId: string;
|
|
142
|
+
durationMinutes: number;
|
|
143
|
+
comment: string | null;
|
|
144
|
+
recordedByUserId: string;
|
|
145
|
+
createdAt: string;
|
|
146
|
+
updatedAt: string;
|
|
147
|
+
deletedAt: string | null;
|
|
148
|
+
}
|
|
149
|
+
/** Request payload for creating a time entry on a case. */
|
|
150
|
+
interface CreateTimeEntryRequest {
|
|
151
|
+
caseId: number;
|
|
152
|
+
duration: string;
|
|
153
|
+
comment?: string;
|
|
154
|
+
}
|
|
155
|
+
/** Cursor returned by the time entries list endpoint: [createdAt, id]. */
|
|
156
|
+
type TimeEntryCursor = [string, string];
|
|
157
|
+
/** Request parameters for listing the time entries of a case. */
|
|
158
|
+
interface ListTimeEntriesRequest {
|
|
159
|
+
caseId: number;
|
|
160
|
+
limit?: number;
|
|
161
|
+
cursor?: TimeEntryCursor;
|
|
162
|
+
}
|
|
163
|
+
/** Paginated response for the time entries of a case. */
|
|
164
|
+
interface ListTimeEntriesPage {
|
|
165
|
+
data: CaseTimeEntry[];
|
|
166
|
+
totalLoggedTimeMinutes: number;
|
|
167
|
+
hasMore: boolean;
|
|
168
|
+
nextCursor: TimeEntryCursor | null;
|
|
169
|
+
}
|
|
170
|
+
/** Request payload for updating a time entry. */
|
|
171
|
+
interface UpdateTimeEntryRequest {
|
|
172
|
+
caseId: number;
|
|
173
|
+
timeEntryId: string;
|
|
174
|
+
duration?: string;
|
|
175
|
+
comment?: string | null;
|
|
176
|
+
}
|
|
177
|
+
/** Request parameters for deleting (soft-delete) a time entry. */
|
|
178
|
+
interface DeleteTimeEntryRequest {
|
|
179
|
+
caseId: number;
|
|
180
|
+
timeEntryId: string;
|
|
181
|
+
}
|
|
182
|
+
|
|
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,4 +77,107 @@ interface CaseFeedByActionItem {
|
|
|
77
77
|
protocol: string | null;
|
|
78
78
|
}
|
|
79
79
|
|
|
80
|
-
|
|
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
|
+
|
|
137
|
+
/** A single time entry (apontamento) recorded against a case. */
|
|
138
|
+
interface CaseTimeEntry {
|
|
139
|
+
id: string;
|
|
140
|
+
caseId: number;
|
|
141
|
+
companyId: string;
|
|
142
|
+
durationMinutes: number;
|
|
143
|
+
comment: string | null;
|
|
144
|
+
recordedByUserId: string;
|
|
145
|
+
createdAt: string;
|
|
146
|
+
updatedAt: string;
|
|
147
|
+
deletedAt: string | null;
|
|
148
|
+
}
|
|
149
|
+
/** Request payload for creating a time entry on a case. */
|
|
150
|
+
interface CreateTimeEntryRequest {
|
|
151
|
+
caseId: number;
|
|
152
|
+
duration: string;
|
|
153
|
+
comment?: string;
|
|
154
|
+
}
|
|
155
|
+
/** Cursor returned by the time entries list endpoint: [createdAt, id]. */
|
|
156
|
+
type TimeEntryCursor = [string, string];
|
|
157
|
+
/** Request parameters for listing the time entries of a case. */
|
|
158
|
+
interface ListTimeEntriesRequest {
|
|
159
|
+
caseId: number;
|
|
160
|
+
limit?: number;
|
|
161
|
+
cursor?: TimeEntryCursor;
|
|
162
|
+
}
|
|
163
|
+
/** Paginated response for the time entries of a case. */
|
|
164
|
+
interface ListTimeEntriesPage {
|
|
165
|
+
data: CaseTimeEntry[];
|
|
166
|
+
totalLoggedTimeMinutes: number;
|
|
167
|
+
hasMore: boolean;
|
|
168
|
+
nextCursor: TimeEntryCursor | null;
|
|
169
|
+
}
|
|
170
|
+
/** Request payload for updating a time entry. */
|
|
171
|
+
interface UpdateTimeEntryRequest {
|
|
172
|
+
caseId: number;
|
|
173
|
+
timeEntryId: string;
|
|
174
|
+
duration?: string;
|
|
175
|
+
comment?: string | null;
|
|
176
|
+
}
|
|
177
|
+
/** Request parameters for deleting (soft-delete) a time entry. */
|
|
178
|
+
interface DeleteTimeEntryRequest {
|
|
179
|
+
caseId: number;
|
|
180
|
+
timeEntryId: string;
|
|
181
|
+
}
|
|
182
|
+
|
|
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';\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
|
@@ -17,8 +17,8 @@ import { ListInvitationsRequest, InvitationResponse, ReplyInvitationRequest, Can
|
|
|
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 } from './cases/contracts/index.mjs';
|
|
21
|
-
export { CasePermissionsValue, CommentHistoryChangeType, CommentHistoryCursor, CommentHistoryEntry } 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';
|
|
@@ -523,6 +523,16 @@ declare class CasesGateway {
|
|
|
523
523
|
* @returns Array of case feed items linking each action to a case.
|
|
524
524
|
*/
|
|
525
525
|
getCaseFeedByActions(payload: GetCaseFeedByActionsRequest): Promise<CaseFeedByActionItem[]>;
|
|
526
|
+
/** 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. */
|
|
527
|
+
listCases(payload: ListCasesRequest): Promise<ListCasesResponse>;
|
|
528
|
+
/** Creates a time entry (apontamento) on a case. */
|
|
529
|
+
createTimeEntry(payload: CreateTimeEntryRequest): Promise<CaseTimeEntry>;
|
|
530
|
+
/** Retrieves one page of time entries (apontamentos) for a case. */
|
|
531
|
+
listTimeEntries(params: ListTimeEntriesRequest): Promise<ListTimeEntriesPage>;
|
|
532
|
+
/** Updates a time entry (apontamento) on a case. */
|
|
533
|
+
updateTimeEntry(payload: UpdateTimeEntryRequest): Promise<CaseTimeEntry>;
|
|
534
|
+
/** Deletes (soft-delete) a time entry (apontamento) on a case. */
|
|
535
|
+
deleteTimeEntry(params: DeleteTimeEntryRequest): Promise<CaseTimeEntry>;
|
|
526
536
|
}
|
|
527
537
|
|
|
528
538
|
/**
|
|
@@ -685,4 +695,4 @@ declare const configure: (params: GatewayClientParams) => void;
|
|
|
685
695
|
*/
|
|
686
696
|
declare function gateway<T extends keyof GatewayMap>(service: T): GatewayMap[T];
|
|
687
697
|
|
|
688
|
-
export { AccessPackage, AttachmentByIdResponse, AudioConvertResponse, Campaign, CampaignAccessResponse, CampaignCompanyPaginatedResponse, CampaignCompanyQueryParams, CampaignCompanyResponse, CampaignContactPaginatedResponse, CampaignContactQueryParams, CampaignContactResponse, CampaignContactsDashboardData, CampaignContactsDashboardQueryParams, CampaignPaginatedResponse, CampaignQueryParams, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CancelInvitationRequest, CaseFeedByActionItem, CasePermissions, CommentHistoryPage, CompanyAccessPackageItem, CompanyResource, CompanyResponse, ConfigListByProviderResponse, ContactCategoryResponse, ContactHistoryResponse, ContactPhoneSearchResponse, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, CreateCompanyAccessPackagePayload, CreateIntegrationActionRequest, CreateIntegrationFieldRequest, CreateIntegrationPartnerRequest, CreateWebhookRequest$1 as CreateWebhookRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, 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, 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, UploadPresignedUrlResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };
|
|
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 };
|
package/dist/index.d.ts
CHANGED
|
@@ -17,8 +17,8 @@ import { ListInvitationsRequest, InvitationResponse, ReplyInvitationRequest, Can
|
|
|
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 } from './cases/contracts/index.js';
|
|
21
|
-
export { CasePermissionsValue, CommentHistoryChangeType, CommentHistoryCursor, CommentHistoryEntry } 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';
|
|
@@ -523,6 +523,16 @@ declare class CasesGateway {
|
|
|
523
523
|
* @returns Array of case feed items linking each action to a case.
|
|
524
524
|
*/
|
|
525
525
|
getCaseFeedByActions(payload: GetCaseFeedByActionsRequest): Promise<CaseFeedByActionItem[]>;
|
|
526
|
+
/** 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. */
|
|
527
|
+
listCases(payload: ListCasesRequest): Promise<ListCasesResponse>;
|
|
528
|
+
/** Creates a time entry (apontamento) on a case. */
|
|
529
|
+
createTimeEntry(payload: CreateTimeEntryRequest): Promise<CaseTimeEntry>;
|
|
530
|
+
/** Retrieves one page of time entries (apontamentos) for a case. */
|
|
531
|
+
listTimeEntries(params: ListTimeEntriesRequest): Promise<ListTimeEntriesPage>;
|
|
532
|
+
/** Updates a time entry (apontamento) on a case. */
|
|
533
|
+
updateTimeEntry(payload: UpdateTimeEntryRequest): Promise<CaseTimeEntry>;
|
|
534
|
+
/** Deletes (soft-delete) a time entry (apontamento) on a case. */
|
|
535
|
+
deleteTimeEntry(params: DeleteTimeEntryRequest): Promise<CaseTimeEntry>;
|
|
526
536
|
}
|
|
527
537
|
|
|
528
538
|
/**
|
|
@@ -685,4 +695,4 @@ declare const configure: (params: GatewayClientParams) => void;
|
|
|
685
695
|
*/
|
|
686
696
|
declare function gateway<T extends keyof GatewayMap>(service: T): GatewayMap[T];
|
|
687
697
|
|
|
688
|
-
export { AccessPackage, AttachmentByIdResponse, AudioConvertResponse, Campaign, CampaignAccessResponse, CampaignCompanyPaginatedResponse, CampaignCompanyQueryParams, CampaignCompanyResponse, CampaignContactPaginatedResponse, CampaignContactQueryParams, CampaignContactResponse, CampaignContactsDashboardData, CampaignContactsDashboardQueryParams, CampaignPaginatedResponse, CampaignQueryParams, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CancelInvitationRequest, CaseFeedByActionItem, CasePermissions, CommentHistoryPage, CompanyAccessPackageItem, CompanyResource, CompanyResponse, ConfigListByProviderResponse, ContactCategoryResponse, ContactHistoryResponse, ContactPhoneSearchResponse, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, CreateCompanyAccessPackagePayload, CreateIntegrationActionRequest, CreateIntegrationFieldRequest, CreateIntegrationPartnerRequest, CreateWebhookRequest$1 as CreateWebhookRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, 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, 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, UploadPresignedUrlResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };
|
|
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 };
|
package/dist/index.js
CHANGED
|
@@ -899,6 +899,42 @@ var CasesGateway = class {
|
|
|
899
899
|
);
|
|
900
900
|
return data;
|
|
901
901
|
}
|
|
902
|
+
/** 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. */
|
|
903
|
+
async listCases(payload) {
|
|
904
|
+
const { data } = await this.httpClient.post(`${this.baseUrl}/cases/list`, payload);
|
|
905
|
+
return data;
|
|
906
|
+
}
|
|
907
|
+
/** Creates a time entry (apontamento) on a case. */
|
|
908
|
+
async createTimeEntry(payload) {
|
|
909
|
+
const { caseId, ...body } = payload;
|
|
910
|
+
const { data } = await this.httpClient.post(`${this.baseUrl}/cases/${caseId}/time-entries`, body);
|
|
911
|
+
return data;
|
|
912
|
+
}
|
|
913
|
+
/** Retrieves one page of time entries (apontamentos) for a case. */
|
|
914
|
+
async listTimeEntries(params) {
|
|
915
|
+
const { caseId, ...query } = params;
|
|
916
|
+
const { data } = await this.httpClient.get(`${this.baseUrl}/cases/${caseId}/time-entries`, {
|
|
917
|
+
params: query
|
|
918
|
+
});
|
|
919
|
+
return data;
|
|
920
|
+
}
|
|
921
|
+
/** Updates a time entry (apontamento) on a case. */
|
|
922
|
+
async updateTimeEntry(payload) {
|
|
923
|
+
const { caseId, timeEntryId, ...body } = payload;
|
|
924
|
+
const { data } = await this.httpClient.patch(
|
|
925
|
+
`${this.baseUrl}/cases/${caseId}/time-entries/${timeEntryId}`,
|
|
926
|
+
body
|
|
927
|
+
);
|
|
928
|
+
return data;
|
|
929
|
+
}
|
|
930
|
+
/** Deletes (soft-delete) a time entry (apontamento) on a case. */
|
|
931
|
+
async deleteTimeEntry(params) {
|
|
932
|
+
const { caseId, timeEntryId } = params;
|
|
933
|
+
const { data } = await this.httpClient.delete(
|
|
934
|
+
`${this.baseUrl}/cases/${caseId}/time-entries/${timeEntryId}`
|
|
935
|
+
);
|
|
936
|
+
return data;
|
|
937
|
+
}
|
|
902
938
|
};
|
|
903
939
|
|
|
904
940
|
// src/rh/index.ts
|