@opens/gateways 1.16.15 → 1.16.17
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 +49 -4
- package/dist/cases/contracts/index.d.ts +49 -4
- package/dist/cases/contracts/index.js.map +1 -1
- package/dist/index.d.mts +9 -3
- package/dist/index.d.ts +9 -3
- package/dist/index.js +16 -0
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +16 -0
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
|
@@ -77,6 +77,53 @@ interface CaseFeedByActionItem {
|
|
|
77
77
|
protocol: string | null;
|
|
78
78
|
}
|
|
79
79
|
|
|
80
|
+
/** Colors offered by the UI when creating or updating a case status. */
|
|
81
|
+
type CaseStatusColor = 'blue' | 'yellow' | 'green' | 'purple' | 'red' | 'cyan' | 'orange' | 'gray';
|
|
82
|
+
/** Id of a fixed workflow stage. Stages are global, not per-company. */
|
|
83
|
+
type CaseStageId = 'OPEN' | 'IN_PROGRESS' | 'CLOSED';
|
|
84
|
+
/** A fixed workflow stage (Aberto / Em andamento / Fechado). */
|
|
85
|
+
interface CaseStage {
|
|
86
|
+
id: CaseStageId;
|
|
87
|
+
label: string;
|
|
88
|
+
}
|
|
89
|
+
/** A company-scoped case status, linked to a fixed stage. */
|
|
90
|
+
interface CaseStatus {
|
|
91
|
+
id: number;
|
|
92
|
+
name: string | null;
|
|
93
|
+
companyId: string;
|
|
94
|
+
caseStageId: CaseStageId;
|
|
95
|
+
/** Any color stored by the API; the UI palette is `CaseStatusColor`. */
|
|
96
|
+
color: string;
|
|
97
|
+
/** Hex of the color when it belongs to the color catalog (list only). */
|
|
98
|
+
colorHex?: string | null;
|
|
99
|
+
isDefault: boolean;
|
|
100
|
+
isCustomStatus: boolean;
|
|
101
|
+
isActive: boolean;
|
|
102
|
+
createdAt: string;
|
|
103
|
+
updatedAt: string;
|
|
104
|
+
deletedAt: string | null;
|
|
105
|
+
/** Present when the API includes the related stage (e.g. list). */
|
|
106
|
+
stage?: CaseStage;
|
|
107
|
+
}
|
|
108
|
+
/** Request payload for creating a case status. */
|
|
109
|
+
interface CreateCaseStatusRequest {
|
|
110
|
+
name: string;
|
|
111
|
+
caseStageId: CaseStageId;
|
|
112
|
+
color: CaseStatusColor;
|
|
113
|
+
}
|
|
114
|
+
/** Request payload for updating a case status. All fields besides `statusId` are optional. */
|
|
115
|
+
interface UpdateCaseStatusRequest {
|
|
116
|
+
statusId: number;
|
|
117
|
+
name?: string;
|
|
118
|
+
caseStageId?: CaseStageId;
|
|
119
|
+
color?: CaseStatusColor;
|
|
120
|
+
isActive?: boolean;
|
|
121
|
+
}
|
|
122
|
+
/** Request parameters for listing case statuses. */
|
|
123
|
+
interface ListCaseStatusesRequest {
|
|
124
|
+
activeOnly?: boolean;
|
|
125
|
+
}
|
|
126
|
+
|
|
80
127
|
/** A case item as returned by the cases listing endpoint. */
|
|
81
128
|
interface CaseListItem {
|
|
82
129
|
id: number;
|
|
@@ -92,9 +139,7 @@ interface CaseListItem {
|
|
|
92
139
|
dueDate: string | null;
|
|
93
140
|
createdAt: string;
|
|
94
141
|
updatedAt: string;
|
|
95
|
-
status?:
|
|
96
|
-
name: string;
|
|
97
|
-
};
|
|
142
|
+
status?: CaseStatus;
|
|
98
143
|
categories?: {
|
|
99
144
|
id: string;
|
|
100
145
|
name: string;
|
|
@@ -208,4 +253,4 @@ interface ClonedCase extends Omit<CaseListItem, 'status' | 'categories'> {
|
|
|
208
253
|
estimatedTimeMinutes: number | null;
|
|
209
254
|
}
|
|
210
255
|
|
|
211
|
-
export type { CaseFeedByActionItem, CaseListItem, CasePermissions, CasePermissionsValue, CaseTimeEntry, CloneCaseRequest, ClonedCase, CommentHistoryChangeType, CommentHistoryCursor, CommentHistoryEntry, CommentHistoryPage, CreateTimeEntryRequest, DeleteTimeEntryRequest, GetCaseFeedByActionsRequest, GetCommentHistoryRequest, ListCasesCursor, ListCasesRequest, ListCasesResponse, ListTimeEntriesPage, ListTimeEntriesRequest, TimeEntryCursor, UpdateCasePermissionsRequest, UpdateTimeEntryRequest };
|
|
256
|
+
export type { CaseFeedByActionItem, CaseListItem, CasePermissions, CasePermissionsValue, CaseStage, CaseStageId, CaseStatus, CaseStatusColor, CaseTimeEntry, CloneCaseRequest, ClonedCase, CommentHistoryChangeType, CommentHistoryCursor, CommentHistoryEntry, CommentHistoryPage, CreateCaseStatusRequest, CreateTimeEntryRequest, DeleteTimeEntryRequest, GetCaseFeedByActionsRequest, GetCommentHistoryRequest, ListCaseStatusesRequest, ListCasesCursor, ListCasesRequest, ListCasesResponse, ListTimeEntriesPage, ListTimeEntriesRequest, TimeEntryCursor, UpdateCasePermissionsRequest, UpdateCaseStatusRequest, UpdateTimeEntryRequest };
|
|
@@ -77,6 +77,53 @@ interface CaseFeedByActionItem {
|
|
|
77
77
|
protocol: string | null;
|
|
78
78
|
}
|
|
79
79
|
|
|
80
|
+
/** Colors offered by the UI when creating or updating a case status. */
|
|
81
|
+
type CaseStatusColor = 'blue' | 'yellow' | 'green' | 'purple' | 'red' | 'cyan' | 'orange' | 'gray';
|
|
82
|
+
/** Id of a fixed workflow stage. Stages are global, not per-company. */
|
|
83
|
+
type CaseStageId = 'OPEN' | 'IN_PROGRESS' | 'CLOSED';
|
|
84
|
+
/** A fixed workflow stage (Aberto / Em andamento / Fechado). */
|
|
85
|
+
interface CaseStage {
|
|
86
|
+
id: CaseStageId;
|
|
87
|
+
label: string;
|
|
88
|
+
}
|
|
89
|
+
/** A company-scoped case status, linked to a fixed stage. */
|
|
90
|
+
interface CaseStatus {
|
|
91
|
+
id: number;
|
|
92
|
+
name: string | null;
|
|
93
|
+
companyId: string;
|
|
94
|
+
caseStageId: CaseStageId;
|
|
95
|
+
/** Any color stored by the API; the UI palette is `CaseStatusColor`. */
|
|
96
|
+
color: string;
|
|
97
|
+
/** Hex of the color when it belongs to the color catalog (list only). */
|
|
98
|
+
colorHex?: string | null;
|
|
99
|
+
isDefault: boolean;
|
|
100
|
+
isCustomStatus: boolean;
|
|
101
|
+
isActive: boolean;
|
|
102
|
+
createdAt: string;
|
|
103
|
+
updatedAt: string;
|
|
104
|
+
deletedAt: string | null;
|
|
105
|
+
/** Present when the API includes the related stage (e.g. list). */
|
|
106
|
+
stage?: CaseStage;
|
|
107
|
+
}
|
|
108
|
+
/** Request payload for creating a case status. */
|
|
109
|
+
interface CreateCaseStatusRequest {
|
|
110
|
+
name: string;
|
|
111
|
+
caseStageId: CaseStageId;
|
|
112
|
+
color: CaseStatusColor;
|
|
113
|
+
}
|
|
114
|
+
/** Request payload for updating a case status. All fields besides `statusId` are optional. */
|
|
115
|
+
interface UpdateCaseStatusRequest {
|
|
116
|
+
statusId: number;
|
|
117
|
+
name?: string;
|
|
118
|
+
caseStageId?: CaseStageId;
|
|
119
|
+
color?: CaseStatusColor;
|
|
120
|
+
isActive?: boolean;
|
|
121
|
+
}
|
|
122
|
+
/** Request parameters for listing case statuses. */
|
|
123
|
+
interface ListCaseStatusesRequest {
|
|
124
|
+
activeOnly?: boolean;
|
|
125
|
+
}
|
|
126
|
+
|
|
80
127
|
/** A case item as returned by the cases listing endpoint. */
|
|
81
128
|
interface CaseListItem {
|
|
82
129
|
id: number;
|
|
@@ -92,9 +139,7 @@ interface CaseListItem {
|
|
|
92
139
|
dueDate: string | null;
|
|
93
140
|
createdAt: string;
|
|
94
141
|
updatedAt: string;
|
|
95
|
-
status?:
|
|
96
|
-
name: string;
|
|
97
|
-
};
|
|
142
|
+
status?: CaseStatus;
|
|
98
143
|
categories?: {
|
|
99
144
|
id: string;
|
|
100
145
|
name: string;
|
|
@@ -208,4 +253,4 @@ interface ClonedCase extends Omit<CaseListItem, 'status' | 'categories'> {
|
|
|
208
253
|
estimatedTimeMinutes: number | null;
|
|
209
254
|
}
|
|
210
255
|
|
|
211
|
-
export type { CaseFeedByActionItem, CaseListItem, CasePermissions, CasePermissionsValue, CaseTimeEntry, CloneCaseRequest, ClonedCase, CommentHistoryChangeType, CommentHistoryCursor, CommentHistoryEntry, CommentHistoryPage, CreateTimeEntryRequest, DeleteTimeEntryRequest, GetCaseFeedByActionsRequest, GetCommentHistoryRequest, ListCasesCursor, ListCasesRequest, ListCasesResponse, ListTimeEntriesPage, ListTimeEntriesRequest, TimeEntryCursor, UpdateCasePermissionsRequest, UpdateTimeEntryRequest };
|
|
256
|
+
export type { CaseFeedByActionItem, CaseListItem, CasePermissions, CasePermissionsValue, CaseStage, CaseStageId, CaseStatus, CaseStatusColor, CaseTimeEntry, CloneCaseRequest, ClonedCase, CommentHistoryChangeType, CommentHistoryCursor, CommentHistoryEntry, CommentHistoryPage, CreateCaseStatusRequest, CreateTimeEntryRequest, DeleteTimeEntryRequest, GetCaseFeedByActionsRequest, GetCommentHistoryRequest, ListCaseStatusesRequest, ListCasesCursor, ListCasesRequest, ListCasesResponse, ListTimeEntriesPage, ListTimeEntriesRequest, TimeEntryCursor, UpdateCasePermissionsRequest, UpdateCaseStatusRequest, 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 './list-cases';\nexport * from './time-entry';\nexport * from './clone-case';\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';\nexport * from './case-status';\nexport * from './clone-case';\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
|
package/dist/index.d.mts
CHANGED
|
@@ -19,8 +19,8 @@ import { ListContactHistoryRequest, ContactHistoryResponse, CallReportCompanyUsa
|
|
|
19
19
|
export { CallReportTelephonyUsageEntryResponse, CallReportTelephonyUsageProvidersResponse, CallReportTelephonyUsageResponse, ContactHistoryIndex, ContactHistorySortOrder, ContactInteractionResponse, InteractionCallStepResponse, InteractionChatStepResponse, InteractionMemberResponse, InteractionOrganizationResponse } from './call-report/contracts/index.mjs';
|
|
20
20
|
import { CallEndpoint } from './calls/contracts/index.mjs';
|
|
21
21
|
export { CallEndpointStatus } from './calls/contracts/index.mjs';
|
|
22
|
-
import { GetCommentHistoryRequest, CommentHistoryPage, CasePermissions, UpdateCasePermissionsRequest, GetCaseFeedByActionsRequest, CaseFeedByActionItem, ListCasesRequest, ListCasesResponse, CloneCaseRequest, ClonedCase, CreateTimeEntryRequest, CaseTimeEntry, ListTimeEntriesRequest, ListTimeEntriesPage, UpdateTimeEntryRequest, DeleteTimeEntryRequest } from './cases/contracts/index.mjs';
|
|
23
|
-
export { CaseListItem, CasePermissionsValue, CommentHistoryChangeType, CommentHistoryCursor, CommentHistoryEntry, ListCasesCursor, TimeEntryCursor } from './cases/contracts/index.mjs';
|
|
22
|
+
import { GetCommentHistoryRequest, CommentHistoryPage, CasePermissions, UpdateCasePermissionsRequest, GetCaseFeedByActionsRequest, CaseFeedByActionItem, ListCasesRequest, ListCasesResponse, CloneCaseRequest, ClonedCase, CreateTimeEntryRequest, CaseTimeEntry, ListTimeEntriesRequest, ListTimeEntriesPage, UpdateTimeEntryRequest, DeleteTimeEntryRequest, ListCaseStatusesRequest, CaseStatus, CreateCaseStatusRequest, UpdateCaseStatusRequest } from './cases/contracts/index.mjs';
|
|
23
|
+
export { CaseListItem, CasePermissionsValue, CaseStage, CaseStageId, CaseStatusColor, CommentHistoryChangeType, CommentHistoryCursor, CommentHistoryEntry, ListCasesCursor, TimeEntryCursor } from './cases/contracts/index.mjs';
|
|
24
24
|
import { GetAccessPackagesParams, PaginatedResult, AccessPackage, GetCompanyAccessPackagesParams, CompanyAccessPackageItem, CreateCompanyAccessPackagePayload, UpdateCompanyAccessPackagePayload, GetCompanyResourcesParams, CompanyResource } from './access-hub/contracts/index.mjs';
|
|
25
25
|
export { AccessGroup, AccessPackageGroup } from './access-hub/contracts/index.mjs';
|
|
26
26
|
import { GetSystemNotificationsParams, GetSystemNotificationsResponse, GetUserDevicesParams, GetUserDevicesResponse, RegisterUserDeviceRequest, RegisterUserDeviceResponse, DeleteUserDeviceResponse, GetUserPreferencesParams, UserPreference, CreateUserPreferenceRequest, DeleteUserPreferenceParams, DeleteUserPreferenceResponse } from './notifications/contracts/index.mjs';
|
|
@@ -771,6 +771,12 @@ declare class CasesGateway {
|
|
|
771
771
|
updateTimeEntry(payload: UpdateTimeEntryRequest): Promise<CaseTimeEntry>;
|
|
772
772
|
/** Deletes (soft-delete) a time entry (apontamento) on a case. */
|
|
773
773
|
deleteTimeEntry(params: DeleteTimeEntryRequest): Promise<CaseTimeEntry>;
|
|
774
|
+
/** Lists case statuses for the current company. */
|
|
775
|
+
listCaseStatuses(params?: ListCaseStatusesRequest): Promise<CaseStatus[]>;
|
|
776
|
+
/** Creates a case status linked to a fixed stage. */
|
|
777
|
+
createCaseStatus(payload: CreateCaseStatusRequest): Promise<CaseStatus>;
|
|
778
|
+
/** Updates a case status (name, color and/or stage). */
|
|
779
|
+
updateCaseStatus(payload: UpdateCaseStatusRequest): Promise<CaseStatus>;
|
|
774
780
|
}
|
|
775
781
|
|
|
776
782
|
/**
|
|
@@ -997,4 +1003,4 @@ declare const configure: (params: GatewayClientParams) => void;
|
|
|
997
1003
|
*/
|
|
998
1004
|
declare function gateway<T extends keyof GatewayMap>(service: T): GatewayMap[T];
|
|
999
1005
|
|
|
1000
|
-
export { AccessPackage, ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementListFilters, AnnouncementListResponse, AnnouncementType, AttachmentByIdResponse, AudioConvertResponse, AutomationPartner, AutomationPartnerAction, CallEndpoint, CallReportCompanyUsageRequest, CallReportCompanyUsageResponse, Campaign, CampaignAccessResponse, CampaignCompanyPaginatedResponse, CampaignCompanyQueryParams, CampaignCompanyResponse, CampaignContactPaginatedResponse, CampaignContactQueryParams, CampaignContactResponse, CampaignContactsDashboardData, CampaignContactsDashboardQueryParams, CampaignPaginatedResponse, CampaignQueryParams, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CancelInvitationRequest, CaseFeedByActionItem, CasePermissions, CaseTimeEntry, ChatWebserviceCompanyUsageRequest, ChatWebserviceCompanyUsageResponse, CloneCaseRequest, ClonedCase, CommentHistoryPage, CompanyAccessPackageItem, CompanyBooleanConfigKey, CompanyConfigKey, CompanyConfigResponse, CompanyJsonConfigKey, CompanyQueue, CompanyResource, CompanyResponse, CompanyStringConfigKey, CompanyWithConfigsResponse, Config, ConfigListByProviderResponse, ContactCategoryResponse, ContactHistoryResponse, ContactPhoneSearchResponse, ContactResponse, CreateAnnouncementRequest, CreateAutomationPartnerRequest, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, CreateCompanyAccessPackagePayload, CreateIntegrationActionRequest, CreateIntegrationFieldRequest, CreateIntegrationPartnerRequest, CreateTimeEntryRequest, CreateUserPreferenceRequest, CreateWebhookRequest$1 as CreateWebhookRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, DeleteTimeEntryRequest, DeleteUserDeviceResponse, DeleteUserPreferenceParams, DeleteUserPreferenceResponse, EnableCampaignCompanyRequest, FindContactByIdResponse, FindOrCreateContactRequest, FindOrCreateQueueRuleRequest, FlowCatalogParams, FlowCatalogResponse, FlowDefinition, FlowReadiness, ForwardMessageRequest, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, GetAccessPackagesParams, GetAllUsersParams, GetAllUsersResponse, GetAttachmentByIdRequest, GetAutomationPartnerRequest, GetCaseFeedByActionsRequest, GetCommentHistoryRequest, GetCompanyAccessPackagesParams, GetCompanyResourcesParams, GetConfigTemplatesParams, GetConfigTemplatesResponse, GetConfigsByProviderParams, GetContactPhonesParams, GetInitialContextRequest, GetInitialContextResponse, GetIntegrationHooksCatalogRequest, GetIntegrationPartnersByCompanyRequest, GetManagedUsersResponse, GetMemberQueuesRequest, GetMessagesByCursorRequest, GetMessagesByCursorResponse, GetPresignedUrlRequest, GetProviderConfigurationsParams, GetProviderDisplayInfoParams, GetRoomByIdRequest, GetRootRulesRequest, GetServiceGroupsParams, GetSupportWidgetIdResponse, GetSystemNotificationsParams, GetSystemNotificationsResponse, GetUserByIdResponse, GetUserDevicesParams, GetUserDevicesResponse, GetUserPreferencesParams, GetWebhooksByCompanyRequest$1 as GetWebhooksByCompanyRequest, HookCatalogItem, IntegrationAction, IntegrationField, IntegrationPartner, InvitationResponse, ListAutomationActionsRequest, ListAutomationPartnersRequest, ListCasesRequest, ListCasesResponse, ListContactHistoryRequest, ListInvitationsRequest, ListLiveUserRoomsRequest, ListTimeEntriesPage, ListTimeEntriesRequest, ListUsersRequest, ListUsersResponse, LiveUserRoomResponse, MarkMessagesAsReadRequest, MarkMessagesAsReadResponse, MessageResponse, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, PaginatedResult, PatchCampaignContactRequest, PatchCampaignRequest, ProviderConfigurationsResponse, ProviderDisplayInfoResponse, ProviderListResponse, Queue, QueueMember, QueueRule, RegisterUserDeviceRequest, RegisterUserDeviceResponse, ReplyInvitationRequest, RoomMemberResponse, RoomResponse, RootRulesResponse, SERVICE_GATEWAYS, SERVICE_GATEWAYS as SERVICE_GATEWAYS_TYPE, SendAttachmentMessageResponse, SendMessageRequest, ServiceGroupsResponse, StrongPasswordOptionsResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCasePermissionsRequest, UpdateCompanyAccessPackagePayload, UpdateCompanyBooleanConfigRequest, UpdateCompanyJsonConfigRequest, UpdateCompanyRequest, UpdateCompanyStringConfigRequest, UpdateCompanyUserAvatarResponse, UpdateCompanyUserRequest, UpdateIntegrationActionParams, UpdateIntegrationFieldParams, UpdateMemberInRoomRequest, UpdateSupportWidgetIdRequest, UpdateSupportWidgetIdResponse, UpdateTimeEntryRequest, UpdateUserPasswordRequest, UpdateUserPasswordResponse, UploadPresignedUrlResponse, User, UserPreference, UserProfile, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };
|
|
1006
|
+
export { AccessPackage, ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementListFilters, AnnouncementListResponse, AnnouncementType, AttachmentByIdResponse, AudioConvertResponse, AutomationPartner, AutomationPartnerAction, CallEndpoint, CallReportCompanyUsageRequest, CallReportCompanyUsageResponse, Campaign, CampaignAccessResponse, CampaignCompanyPaginatedResponse, CampaignCompanyQueryParams, CampaignCompanyResponse, CampaignContactPaginatedResponse, CampaignContactQueryParams, CampaignContactResponse, CampaignContactsDashboardData, CampaignContactsDashboardQueryParams, CampaignPaginatedResponse, CampaignQueryParams, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CancelInvitationRequest, CaseFeedByActionItem, CasePermissions, CaseStatus, CaseTimeEntry, ChatWebserviceCompanyUsageRequest, ChatWebserviceCompanyUsageResponse, CloneCaseRequest, ClonedCase, CommentHistoryPage, CompanyAccessPackageItem, CompanyBooleanConfigKey, CompanyConfigKey, CompanyConfigResponse, CompanyJsonConfigKey, CompanyQueue, CompanyResource, CompanyResponse, CompanyStringConfigKey, CompanyWithConfigsResponse, Config, ConfigListByProviderResponse, ContactCategoryResponse, ContactHistoryResponse, ContactPhoneSearchResponse, ContactResponse, CreateAnnouncementRequest, CreateAutomationPartnerRequest, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, CreateCaseStatusRequest, CreateCompanyAccessPackagePayload, CreateIntegrationActionRequest, CreateIntegrationFieldRequest, CreateIntegrationPartnerRequest, CreateTimeEntryRequest, CreateUserPreferenceRequest, CreateWebhookRequest$1 as CreateWebhookRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, DeleteTimeEntryRequest, DeleteUserDeviceResponse, DeleteUserPreferenceParams, DeleteUserPreferenceResponse, EnableCampaignCompanyRequest, FindContactByIdResponse, FindOrCreateContactRequest, FindOrCreateQueueRuleRequest, FlowCatalogParams, FlowCatalogResponse, FlowDefinition, FlowReadiness, ForwardMessageRequest, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, GetAccessPackagesParams, GetAllUsersParams, GetAllUsersResponse, GetAttachmentByIdRequest, GetAutomationPartnerRequest, GetCaseFeedByActionsRequest, GetCommentHistoryRequest, GetCompanyAccessPackagesParams, GetCompanyResourcesParams, GetConfigTemplatesParams, GetConfigTemplatesResponse, GetConfigsByProviderParams, GetContactPhonesParams, GetInitialContextRequest, GetInitialContextResponse, GetIntegrationHooksCatalogRequest, GetIntegrationPartnersByCompanyRequest, GetManagedUsersResponse, GetMemberQueuesRequest, GetMessagesByCursorRequest, GetMessagesByCursorResponse, GetPresignedUrlRequest, GetProviderConfigurationsParams, GetProviderDisplayInfoParams, GetRoomByIdRequest, GetRootRulesRequest, GetServiceGroupsParams, GetSupportWidgetIdResponse, GetSystemNotificationsParams, GetSystemNotificationsResponse, GetUserByIdResponse, GetUserDevicesParams, GetUserDevicesResponse, GetUserPreferencesParams, GetWebhooksByCompanyRequest$1 as GetWebhooksByCompanyRequest, HookCatalogItem, IntegrationAction, IntegrationField, IntegrationPartner, InvitationResponse, ListAutomationActionsRequest, ListAutomationPartnersRequest, ListCaseStatusesRequest, ListCasesRequest, ListCasesResponse, ListContactHistoryRequest, ListInvitationsRequest, ListLiveUserRoomsRequest, ListTimeEntriesPage, ListTimeEntriesRequest, ListUsersRequest, ListUsersResponse, LiveUserRoomResponse, MarkMessagesAsReadRequest, MarkMessagesAsReadResponse, MessageResponse, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, PaginatedResult, PatchCampaignContactRequest, PatchCampaignRequest, ProviderConfigurationsResponse, ProviderDisplayInfoResponse, ProviderListResponse, Queue, QueueMember, QueueRule, RegisterUserDeviceRequest, RegisterUserDeviceResponse, ReplyInvitationRequest, RoomMemberResponse, RoomResponse, RootRulesResponse, SERVICE_GATEWAYS, SERVICE_GATEWAYS as SERVICE_GATEWAYS_TYPE, SendAttachmentMessageResponse, SendMessageRequest, ServiceGroupsResponse, StrongPasswordOptionsResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCasePermissionsRequest, UpdateCaseStatusRequest, UpdateCompanyAccessPackagePayload, UpdateCompanyBooleanConfigRequest, UpdateCompanyJsonConfigRequest, UpdateCompanyRequest, UpdateCompanyStringConfigRequest, UpdateCompanyUserAvatarResponse, UpdateCompanyUserRequest, UpdateIntegrationActionParams, UpdateIntegrationFieldParams, UpdateMemberInRoomRequest, UpdateSupportWidgetIdRequest, UpdateSupportWidgetIdResponse, UpdateTimeEntryRequest, UpdateUserPasswordRequest, UpdateUserPasswordResponse, UploadPresignedUrlResponse, User, UserPreference, UserProfile, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };
|
package/dist/index.d.ts
CHANGED
|
@@ -19,8 +19,8 @@ import { ListContactHistoryRequest, ContactHistoryResponse, CallReportCompanyUsa
|
|
|
19
19
|
export { CallReportTelephonyUsageEntryResponse, CallReportTelephonyUsageProvidersResponse, CallReportTelephonyUsageResponse, ContactHistoryIndex, ContactHistorySortOrder, ContactInteractionResponse, InteractionCallStepResponse, InteractionChatStepResponse, InteractionMemberResponse, InteractionOrganizationResponse } from './call-report/contracts/index.js';
|
|
20
20
|
import { CallEndpoint } from './calls/contracts/index.js';
|
|
21
21
|
export { CallEndpointStatus } from './calls/contracts/index.js';
|
|
22
|
-
import { GetCommentHistoryRequest, CommentHistoryPage, CasePermissions, UpdateCasePermissionsRequest, GetCaseFeedByActionsRequest, CaseFeedByActionItem, ListCasesRequest, ListCasesResponse, CloneCaseRequest, ClonedCase, CreateTimeEntryRequest, CaseTimeEntry, ListTimeEntriesRequest, ListTimeEntriesPage, UpdateTimeEntryRequest, DeleteTimeEntryRequest } from './cases/contracts/index.js';
|
|
23
|
-
export { CaseListItem, CasePermissionsValue, CommentHistoryChangeType, CommentHistoryCursor, CommentHistoryEntry, ListCasesCursor, TimeEntryCursor } from './cases/contracts/index.js';
|
|
22
|
+
import { GetCommentHistoryRequest, CommentHistoryPage, CasePermissions, UpdateCasePermissionsRequest, GetCaseFeedByActionsRequest, CaseFeedByActionItem, ListCasesRequest, ListCasesResponse, CloneCaseRequest, ClonedCase, CreateTimeEntryRequest, CaseTimeEntry, ListTimeEntriesRequest, ListTimeEntriesPage, UpdateTimeEntryRequest, DeleteTimeEntryRequest, ListCaseStatusesRequest, CaseStatus, CreateCaseStatusRequest, UpdateCaseStatusRequest } from './cases/contracts/index.js';
|
|
23
|
+
export { CaseListItem, CasePermissionsValue, CaseStage, CaseStageId, CaseStatusColor, CommentHistoryChangeType, CommentHistoryCursor, CommentHistoryEntry, ListCasesCursor, TimeEntryCursor } from './cases/contracts/index.js';
|
|
24
24
|
import { GetAccessPackagesParams, PaginatedResult, AccessPackage, GetCompanyAccessPackagesParams, CompanyAccessPackageItem, CreateCompanyAccessPackagePayload, UpdateCompanyAccessPackagePayload, GetCompanyResourcesParams, CompanyResource } from './access-hub/contracts/index.js';
|
|
25
25
|
export { AccessGroup, AccessPackageGroup } from './access-hub/contracts/index.js';
|
|
26
26
|
import { GetSystemNotificationsParams, GetSystemNotificationsResponse, GetUserDevicesParams, GetUserDevicesResponse, RegisterUserDeviceRequest, RegisterUserDeviceResponse, DeleteUserDeviceResponse, GetUserPreferencesParams, UserPreference, CreateUserPreferenceRequest, DeleteUserPreferenceParams, DeleteUserPreferenceResponse } from './notifications/contracts/index.js';
|
|
@@ -771,6 +771,12 @@ declare class CasesGateway {
|
|
|
771
771
|
updateTimeEntry(payload: UpdateTimeEntryRequest): Promise<CaseTimeEntry>;
|
|
772
772
|
/** Deletes (soft-delete) a time entry (apontamento) on a case. */
|
|
773
773
|
deleteTimeEntry(params: DeleteTimeEntryRequest): Promise<CaseTimeEntry>;
|
|
774
|
+
/** Lists case statuses for the current company. */
|
|
775
|
+
listCaseStatuses(params?: ListCaseStatusesRequest): Promise<CaseStatus[]>;
|
|
776
|
+
/** Creates a case status linked to a fixed stage. */
|
|
777
|
+
createCaseStatus(payload: CreateCaseStatusRequest): Promise<CaseStatus>;
|
|
778
|
+
/** Updates a case status (name, color and/or stage). */
|
|
779
|
+
updateCaseStatus(payload: UpdateCaseStatusRequest): Promise<CaseStatus>;
|
|
774
780
|
}
|
|
775
781
|
|
|
776
782
|
/**
|
|
@@ -997,4 +1003,4 @@ declare const configure: (params: GatewayClientParams) => void;
|
|
|
997
1003
|
*/
|
|
998
1004
|
declare function gateway<T extends keyof GatewayMap>(service: T): GatewayMap[T];
|
|
999
1005
|
|
|
1000
|
-
export { AccessPackage, ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementListFilters, AnnouncementListResponse, AnnouncementType, AttachmentByIdResponse, AudioConvertResponse, AutomationPartner, AutomationPartnerAction, CallEndpoint, CallReportCompanyUsageRequest, CallReportCompanyUsageResponse, Campaign, CampaignAccessResponse, CampaignCompanyPaginatedResponse, CampaignCompanyQueryParams, CampaignCompanyResponse, CampaignContactPaginatedResponse, CampaignContactQueryParams, CampaignContactResponse, CampaignContactsDashboardData, CampaignContactsDashboardQueryParams, CampaignPaginatedResponse, CampaignQueryParams, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CancelInvitationRequest, CaseFeedByActionItem, CasePermissions, CaseTimeEntry, ChatWebserviceCompanyUsageRequest, ChatWebserviceCompanyUsageResponse, CloneCaseRequest, ClonedCase, CommentHistoryPage, CompanyAccessPackageItem, CompanyBooleanConfigKey, CompanyConfigKey, CompanyConfigResponse, CompanyJsonConfigKey, CompanyQueue, CompanyResource, CompanyResponse, CompanyStringConfigKey, CompanyWithConfigsResponse, Config, ConfigListByProviderResponse, ContactCategoryResponse, ContactHistoryResponse, ContactPhoneSearchResponse, ContactResponse, CreateAnnouncementRequest, CreateAutomationPartnerRequest, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, CreateCompanyAccessPackagePayload, CreateIntegrationActionRequest, CreateIntegrationFieldRequest, CreateIntegrationPartnerRequest, CreateTimeEntryRequest, CreateUserPreferenceRequest, CreateWebhookRequest$1 as CreateWebhookRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, DeleteTimeEntryRequest, DeleteUserDeviceResponse, DeleteUserPreferenceParams, DeleteUserPreferenceResponse, EnableCampaignCompanyRequest, FindContactByIdResponse, FindOrCreateContactRequest, FindOrCreateQueueRuleRequest, FlowCatalogParams, FlowCatalogResponse, FlowDefinition, FlowReadiness, ForwardMessageRequest, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, GetAccessPackagesParams, GetAllUsersParams, GetAllUsersResponse, GetAttachmentByIdRequest, GetAutomationPartnerRequest, GetCaseFeedByActionsRequest, GetCommentHistoryRequest, GetCompanyAccessPackagesParams, GetCompanyResourcesParams, GetConfigTemplatesParams, GetConfigTemplatesResponse, GetConfigsByProviderParams, GetContactPhonesParams, GetInitialContextRequest, GetInitialContextResponse, GetIntegrationHooksCatalogRequest, GetIntegrationPartnersByCompanyRequest, GetManagedUsersResponse, GetMemberQueuesRequest, GetMessagesByCursorRequest, GetMessagesByCursorResponse, GetPresignedUrlRequest, GetProviderConfigurationsParams, GetProviderDisplayInfoParams, GetRoomByIdRequest, GetRootRulesRequest, GetServiceGroupsParams, GetSupportWidgetIdResponse, GetSystemNotificationsParams, GetSystemNotificationsResponse, GetUserByIdResponse, GetUserDevicesParams, GetUserDevicesResponse, GetUserPreferencesParams, GetWebhooksByCompanyRequest$1 as GetWebhooksByCompanyRequest, HookCatalogItem, IntegrationAction, IntegrationField, IntegrationPartner, InvitationResponse, ListAutomationActionsRequest, ListAutomationPartnersRequest, ListCasesRequest, ListCasesResponse, ListContactHistoryRequest, ListInvitationsRequest, ListLiveUserRoomsRequest, ListTimeEntriesPage, ListTimeEntriesRequest, ListUsersRequest, ListUsersResponse, LiveUserRoomResponse, MarkMessagesAsReadRequest, MarkMessagesAsReadResponse, MessageResponse, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, PaginatedResult, PatchCampaignContactRequest, PatchCampaignRequest, ProviderConfigurationsResponse, ProviderDisplayInfoResponse, ProviderListResponse, Queue, QueueMember, QueueRule, RegisterUserDeviceRequest, RegisterUserDeviceResponse, ReplyInvitationRequest, RoomMemberResponse, RoomResponse, RootRulesResponse, SERVICE_GATEWAYS, SERVICE_GATEWAYS as SERVICE_GATEWAYS_TYPE, SendAttachmentMessageResponse, SendMessageRequest, ServiceGroupsResponse, StrongPasswordOptionsResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCasePermissionsRequest, UpdateCompanyAccessPackagePayload, UpdateCompanyBooleanConfigRequest, UpdateCompanyJsonConfigRequest, UpdateCompanyRequest, UpdateCompanyStringConfigRequest, UpdateCompanyUserAvatarResponse, UpdateCompanyUserRequest, UpdateIntegrationActionParams, UpdateIntegrationFieldParams, UpdateMemberInRoomRequest, UpdateSupportWidgetIdRequest, UpdateSupportWidgetIdResponse, UpdateTimeEntryRequest, UpdateUserPasswordRequest, UpdateUserPasswordResponse, UploadPresignedUrlResponse, User, UserPreference, UserProfile, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };
|
|
1006
|
+
export { AccessPackage, ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementListFilters, AnnouncementListResponse, AnnouncementType, AttachmentByIdResponse, AudioConvertResponse, AutomationPartner, AutomationPartnerAction, CallEndpoint, CallReportCompanyUsageRequest, CallReportCompanyUsageResponse, Campaign, CampaignAccessResponse, CampaignCompanyPaginatedResponse, CampaignCompanyQueryParams, CampaignCompanyResponse, CampaignContactPaginatedResponse, CampaignContactQueryParams, CampaignContactResponse, CampaignContactsDashboardData, CampaignContactsDashboardQueryParams, CampaignPaginatedResponse, CampaignQueryParams, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CancelInvitationRequest, CaseFeedByActionItem, CasePermissions, CaseStatus, CaseTimeEntry, ChatWebserviceCompanyUsageRequest, ChatWebserviceCompanyUsageResponse, CloneCaseRequest, ClonedCase, CommentHistoryPage, CompanyAccessPackageItem, CompanyBooleanConfigKey, CompanyConfigKey, CompanyConfigResponse, CompanyJsonConfigKey, CompanyQueue, CompanyResource, CompanyResponse, CompanyStringConfigKey, CompanyWithConfigsResponse, Config, ConfigListByProviderResponse, ContactCategoryResponse, ContactHistoryResponse, ContactPhoneSearchResponse, ContactResponse, CreateAnnouncementRequest, CreateAutomationPartnerRequest, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, CreateCaseStatusRequest, CreateCompanyAccessPackagePayload, CreateIntegrationActionRequest, CreateIntegrationFieldRequest, CreateIntegrationPartnerRequest, CreateTimeEntryRequest, CreateUserPreferenceRequest, CreateWebhookRequest$1 as CreateWebhookRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, DeleteTimeEntryRequest, DeleteUserDeviceResponse, DeleteUserPreferenceParams, DeleteUserPreferenceResponse, EnableCampaignCompanyRequest, FindContactByIdResponse, FindOrCreateContactRequest, FindOrCreateQueueRuleRequest, FlowCatalogParams, FlowCatalogResponse, FlowDefinition, FlowReadiness, ForwardMessageRequest, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, GetAccessPackagesParams, GetAllUsersParams, GetAllUsersResponse, GetAttachmentByIdRequest, GetAutomationPartnerRequest, GetCaseFeedByActionsRequest, GetCommentHistoryRequest, GetCompanyAccessPackagesParams, GetCompanyResourcesParams, GetConfigTemplatesParams, GetConfigTemplatesResponse, GetConfigsByProviderParams, GetContactPhonesParams, GetInitialContextRequest, GetInitialContextResponse, GetIntegrationHooksCatalogRequest, GetIntegrationPartnersByCompanyRequest, GetManagedUsersResponse, GetMemberQueuesRequest, GetMessagesByCursorRequest, GetMessagesByCursorResponse, GetPresignedUrlRequest, GetProviderConfigurationsParams, GetProviderDisplayInfoParams, GetRoomByIdRequest, GetRootRulesRequest, GetServiceGroupsParams, GetSupportWidgetIdResponse, GetSystemNotificationsParams, GetSystemNotificationsResponse, GetUserByIdResponse, GetUserDevicesParams, GetUserDevicesResponse, GetUserPreferencesParams, GetWebhooksByCompanyRequest$1 as GetWebhooksByCompanyRequest, HookCatalogItem, IntegrationAction, IntegrationField, IntegrationPartner, InvitationResponse, ListAutomationActionsRequest, ListAutomationPartnersRequest, ListCaseStatusesRequest, ListCasesRequest, ListCasesResponse, ListContactHistoryRequest, ListInvitationsRequest, ListLiveUserRoomsRequest, ListTimeEntriesPage, ListTimeEntriesRequest, ListUsersRequest, ListUsersResponse, LiveUserRoomResponse, MarkMessagesAsReadRequest, MarkMessagesAsReadResponse, MessageResponse, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, PaginatedResult, PatchCampaignContactRequest, PatchCampaignRequest, ProviderConfigurationsResponse, ProviderDisplayInfoResponse, ProviderListResponse, Queue, QueueMember, QueueRule, RegisterUserDeviceRequest, RegisterUserDeviceResponse, ReplyInvitationRequest, RoomMemberResponse, RoomResponse, RootRulesResponse, SERVICE_GATEWAYS, SERVICE_GATEWAYS as SERVICE_GATEWAYS_TYPE, SendAttachmentMessageResponse, SendMessageRequest, ServiceGroupsResponse, StrongPasswordOptionsResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCasePermissionsRequest, UpdateCaseStatusRequest, UpdateCompanyAccessPackagePayload, UpdateCompanyBooleanConfigRequest, UpdateCompanyJsonConfigRequest, UpdateCompanyRequest, UpdateCompanyStringConfigRequest, UpdateCompanyUserAvatarResponse, UpdateCompanyUserRequest, UpdateIntegrationActionParams, UpdateIntegrationFieldParams, UpdateMemberInRoomRequest, UpdateSupportWidgetIdRequest, UpdateSupportWidgetIdResponse, UpdateTimeEntryRequest, UpdateUserPasswordRequest, UpdateUserPasswordResponse, UploadPresignedUrlResponse, User, UserPreference, UserProfile, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };
|
package/dist/index.js
CHANGED
|
@@ -1351,6 +1351,22 @@ var CasesGateway = class {
|
|
|
1351
1351
|
);
|
|
1352
1352
|
return data;
|
|
1353
1353
|
}
|
|
1354
|
+
/** Lists case statuses for the current company. */
|
|
1355
|
+
async listCaseStatuses(params) {
|
|
1356
|
+
const { data } = await this.httpClient.get(`${this.baseUrl}/case-statuses`, { params });
|
|
1357
|
+
return data;
|
|
1358
|
+
}
|
|
1359
|
+
/** Creates a case status linked to a fixed stage. */
|
|
1360
|
+
async createCaseStatus(payload) {
|
|
1361
|
+
const { data } = await this.httpClient.post(`${this.baseUrl}/case-statuses`, payload);
|
|
1362
|
+
return data;
|
|
1363
|
+
}
|
|
1364
|
+
/** Updates a case status (name, color and/or stage). */
|
|
1365
|
+
async updateCaseStatus(payload) {
|
|
1366
|
+
const { statusId, ...body } = payload;
|
|
1367
|
+
const { data } = await this.httpClient.patch(`${this.baseUrl}/case-statuses/${statusId}`, body);
|
|
1368
|
+
return data;
|
|
1369
|
+
}
|
|
1354
1370
|
};
|
|
1355
1371
|
|
|
1356
1372
|
// src/rh/index.ts
|