@opens/gateways 1.16.6 → 1.16.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/customer-service/contracts/index.d.mts +44 -42
- package/dist/customer-service/contracts/index.d.ts +44 -42
- package/dist/index.d.mts +64 -3
- package/dist/index.d.ts +64 -3
- package/dist/index.js +94 -3
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +94 -3
- package/dist/index.mjs.map +1 -1
- package/dist/notifications/contracts/index.d.mts +160 -0
- package/dist/notifications/contracts/index.d.ts +160 -0
- package/dist/notifications/contracts/index.js +19 -0
- package/dist/notifications/contracts/index.js.map +1 -0
- package/dist/notifications/contracts/index.mjs +1 -0
- package/dist/notifications/contracts/index.mjs.map +1 -0
- package/package.json +1 -1
|
@@ -160,45 +160,8 @@ interface CompanyQueue {
|
|
|
160
160
|
announce_audio_enabled: string;
|
|
161
161
|
}
|
|
162
162
|
|
|
163
|
-
/**
|
|
164
|
-
|
|
165
|
-
id: string;
|
|
166
|
-
name: string;
|
|
167
|
-
description: string | null;
|
|
168
|
-
type: 'default' | 'user';
|
|
169
|
-
company_id: string;
|
|
170
|
-
createdAt: string;
|
|
171
|
-
updatedAt: string;
|
|
172
|
-
}
|
|
173
|
-
/** Response returned by the Customer Service API when fetching the work groups list. */
|
|
174
|
-
interface WorkGroupListResponse extends CompanyData {
|
|
175
|
-
workgroups: WorkGroup[];
|
|
176
|
-
}
|
|
177
|
-
/** A user membership entity nested within {@link WorkGroupResponse}. */
|
|
178
|
-
interface WorkGroupMember {
|
|
179
|
-
id: string;
|
|
180
|
-
username: string;
|
|
181
|
-
email: string;
|
|
182
|
-
profile: 'p_admin' | 'p_manager' | 'p_corporative' | 'p_agent';
|
|
183
|
-
status: 'new' | 'activated' | 'disabled';
|
|
184
|
-
avatar: string | null;
|
|
185
|
-
createdAt: string;
|
|
186
|
-
updatedAt: string;
|
|
187
|
-
}
|
|
188
|
-
/** Response returned by the Customer Service API when fetching a single work group. */
|
|
189
|
-
interface WorkGroupResponse {
|
|
190
|
-
id: string;
|
|
191
|
-
name: string;
|
|
192
|
-
description: string | null;
|
|
193
|
-
type: 'default' | 'user';
|
|
194
|
-
company_id: string;
|
|
195
|
-
createdAt: string;
|
|
196
|
-
updatedAt: string;
|
|
197
|
-
workgroups_users: WorkGroupMember[];
|
|
198
|
-
}
|
|
199
|
-
/** Response returned by the Customer Service API when fetching members of a work group. */
|
|
200
|
-
type WorkGroupMembersResponse = WorkGroupMember[];
|
|
201
|
-
|
|
163
|
+
/** Allowed user profile values in the Customer Service API. */
|
|
164
|
+
type UserProfile = 'p_admin' | 'p_manager' | 'p_corporative' | 'p_agent';
|
|
202
165
|
/** User bond returned by the Customer Service API. */
|
|
203
166
|
interface UserBond {
|
|
204
167
|
id: string;
|
|
@@ -218,7 +181,7 @@ interface User {
|
|
|
218
181
|
id: string;
|
|
219
182
|
username: string;
|
|
220
183
|
email: string;
|
|
221
|
-
profile:
|
|
184
|
+
profile: UserProfile;
|
|
222
185
|
language: string;
|
|
223
186
|
access_token?: string;
|
|
224
187
|
occupation: string;
|
|
@@ -311,7 +274,7 @@ interface UpdateCompanyUserAvatarResponse {
|
|
|
311
274
|
/** Allowed user status values for listing filters. */
|
|
312
275
|
type ListUsersStatus = 'new' | 'activated' | 'disabled';
|
|
313
276
|
/** Allowed user profile values for listing filters. */
|
|
314
|
-
type ListUsersProfile =
|
|
277
|
+
type ListUsersProfile = UserProfile;
|
|
315
278
|
/** Allowed user type values for listing filters. */
|
|
316
279
|
type ListUsersType = 'user' | 'opens';
|
|
317
280
|
/**
|
|
@@ -365,6 +328,45 @@ interface ListUsersResponse {
|
|
|
365
328
|
hasMore: boolean;
|
|
366
329
|
}
|
|
367
330
|
|
|
331
|
+
/** A work group entity nested within {@link WorkGroupListResponse} and {@link WorkGroupResponse}. */
|
|
332
|
+
interface WorkGroup {
|
|
333
|
+
id: string;
|
|
334
|
+
name: string;
|
|
335
|
+
description: string | null;
|
|
336
|
+
type: 'default' | 'user';
|
|
337
|
+
company_id: string;
|
|
338
|
+
createdAt: string;
|
|
339
|
+
updatedAt: string;
|
|
340
|
+
}
|
|
341
|
+
/** Response returned by the Customer Service API when fetching the work groups list. */
|
|
342
|
+
interface WorkGroupListResponse extends CompanyData {
|
|
343
|
+
workgroups: WorkGroup[];
|
|
344
|
+
}
|
|
345
|
+
/** A user membership entity nested within {@link WorkGroupResponse}. */
|
|
346
|
+
interface WorkGroupMember {
|
|
347
|
+
id: string;
|
|
348
|
+
username: string;
|
|
349
|
+
email: string;
|
|
350
|
+
profile: UserProfile;
|
|
351
|
+
status: 'new' | 'activated' | 'disabled';
|
|
352
|
+
avatar: string | null;
|
|
353
|
+
createdAt: string;
|
|
354
|
+
updatedAt: string;
|
|
355
|
+
}
|
|
356
|
+
/** Response returned by the Customer Service API when fetching a single work group. */
|
|
357
|
+
interface WorkGroupResponse {
|
|
358
|
+
id: string;
|
|
359
|
+
name: string;
|
|
360
|
+
description: string | null;
|
|
361
|
+
type: 'default' | 'user';
|
|
362
|
+
company_id: string;
|
|
363
|
+
createdAt: string;
|
|
364
|
+
updatedAt: string;
|
|
365
|
+
workgroups_users: WorkGroupMember[];
|
|
366
|
+
}
|
|
367
|
+
/** Response returned by the Customer Service API when fetching members of a work group. */
|
|
368
|
+
type WorkGroupMembersResponse = WorkGroupMember[];
|
|
369
|
+
|
|
368
370
|
/** Visual status literals for an announcement payload. */
|
|
369
371
|
type AnnouncementVisualStatus = 'success' | 'alert' | 'warning' | 'custom';
|
|
370
372
|
/** Button displayed inside an announcement payload. */
|
|
@@ -568,4 +570,4 @@ interface ValidateTwoFactorOtpResponse {
|
|
|
568
570
|
validate: boolean;
|
|
569
571
|
}
|
|
570
572
|
|
|
571
|
-
export type { ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementAppearance, AnnouncementButton, AnnouncementCompany, AnnouncementListFilters, AnnouncementListResponse, AnnouncementPayload, AnnouncementTargetingRuleUrl, AnnouncementTargetingRules, AnnouncementType, AnnouncementVisualStatus, CompanyBooleanConfigKey, CompanyConfigKey, CompanyConfigResponse, CompanyData, CompanyJsonConfigKey, CompanyQueue, CompanyResponse, CompanyStringConfigKey, CompanyWithConfigsResponse, CreateAnnouncementRequest, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse, GetSupportWidgetIdResponse, GetUserByIdResponse, ListUsersInclude, ListUsersProfile, ListUsersRequest, ListUsersResponse, ListUsersStatus, ListUsersType, ManagedUser, StrongPasswordOptions, StrongPasswordOptionsResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCompanyBooleanConfigRequest, UpdateCompanyJsonConfigRequest, UpdateCompanyRequest, UpdateCompanyStringConfigRequest, UpdateCompanyUserAvatarResponse, UpdateCompanyUserRequest, UpdateSupportWidgetIdRequest, UpdateSupportWidgetIdResponse, UpdateUserPasswordRequest, UpdateUserPasswordResponse, User, UserBond, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, WorkGroup, WorkGroupListResponse, WorkGroupMember, WorkGroupMembersResponse, WorkGroupResponse };
|
|
573
|
+
export type { ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementAppearance, AnnouncementButton, AnnouncementCompany, AnnouncementListFilters, AnnouncementListResponse, AnnouncementPayload, AnnouncementTargetingRuleUrl, AnnouncementTargetingRules, AnnouncementType, AnnouncementVisualStatus, CompanyBooleanConfigKey, CompanyConfigKey, CompanyConfigResponse, CompanyData, CompanyJsonConfigKey, CompanyQueue, CompanyResponse, CompanyStringConfigKey, CompanyWithConfigsResponse, CreateAnnouncementRequest, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse, GetSupportWidgetIdResponse, GetUserByIdResponse, ListUsersInclude, ListUsersProfile, ListUsersRequest, ListUsersResponse, ListUsersStatus, ListUsersType, ManagedUser, StrongPasswordOptions, StrongPasswordOptionsResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCompanyBooleanConfigRequest, UpdateCompanyJsonConfigRequest, UpdateCompanyRequest, UpdateCompanyStringConfigRequest, UpdateCompanyUserAvatarResponse, UpdateCompanyUserRequest, UpdateSupportWidgetIdRequest, UpdateSupportWidgetIdResponse, UpdateUserPasswordRequest, UpdateUserPasswordResponse, User, UserBond, UserProfile, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, WorkGroup, WorkGroupListResponse, WorkGroupMember, WorkGroupMembersResponse, WorkGroupResponse };
|
|
@@ -160,45 +160,8 @@ interface CompanyQueue {
|
|
|
160
160
|
announce_audio_enabled: string;
|
|
161
161
|
}
|
|
162
162
|
|
|
163
|
-
/**
|
|
164
|
-
|
|
165
|
-
id: string;
|
|
166
|
-
name: string;
|
|
167
|
-
description: string | null;
|
|
168
|
-
type: 'default' | 'user';
|
|
169
|
-
company_id: string;
|
|
170
|
-
createdAt: string;
|
|
171
|
-
updatedAt: string;
|
|
172
|
-
}
|
|
173
|
-
/** Response returned by the Customer Service API when fetching the work groups list. */
|
|
174
|
-
interface WorkGroupListResponse extends CompanyData {
|
|
175
|
-
workgroups: WorkGroup[];
|
|
176
|
-
}
|
|
177
|
-
/** A user membership entity nested within {@link WorkGroupResponse}. */
|
|
178
|
-
interface WorkGroupMember {
|
|
179
|
-
id: string;
|
|
180
|
-
username: string;
|
|
181
|
-
email: string;
|
|
182
|
-
profile: 'p_admin' | 'p_manager' | 'p_corporative' | 'p_agent';
|
|
183
|
-
status: 'new' | 'activated' | 'disabled';
|
|
184
|
-
avatar: string | null;
|
|
185
|
-
createdAt: string;
|
|
186
|
-
updatedAt: string;
|
|
187
|
-
}
|
|
188
|
-
/** Response returned by the Customer Service API when fetching a single work group. */
|
|
189
|
-
interface WorkGroupResponse {
|
|
190
|
-
id: string;
|
|
191
|
-
name: string;
|
|
192
|
-
description: string | null;
|
|
193
|
-
type: 'default' | 'user';
|
|
194
|
-
company_id: string;
|
|
195
|
-
createdAt: string;
|
|
196
|
-
updatedAt: string;
|
|
197
|
-
workgroups_users: WorkGroupMember[];
|
|
198
|
-
}
|
|
199
|
-
/** Response returned by the Customer Service API when fetching members of a work group. */
|
|
200
|
-
type WorkGroupMembersResponse = WorkGroupMember[];
|
|
201
|
-
|
|
163
|
+
/** Allowed user profile values in the Customer Service API. */
|
|
164
|
+
type UserProfile = 'p_admin' | 'p_manager' | 'p_corporative' | 'p_agent';
|
|
202
165
|
/** User bond returned by the Customer Service API. */
|
|
203
166
|
interface UserBond {
|
|
204
167
|
id: string;
|
|
@@ -218,7 +181,7 @@ interface User {
|
|
|
218
181
|
id: string;
|
|
219
182
|
username: string;
|
|
220
183
|
email: string;
|
|
221
|
-
profile:
|
|
184
|
+
profile: UserProfile;
|
|
222
185
|
language: string;
|
|
223
186
|
access_token?: string;
|
|
224
187
|
occupation: string;
|
|
@@ -311,7 +274,7 @@ interface UpdateCompanyUserAvatarResponse {
|
|
|
311
274
|
/** Allowed user status values for listing filters. */
|
|
312
275
|
type ListUsersStatus = 'new' | 'activated' | 'disabled';
|
|
313
276
|
/** Allowed user profile values for listing filters. */
|
|
314
|
-
type ListUsersProfile =
|
|
277
|
+
type ListUsersProfile = UserProfile;
|
|
315
278
|
/** Allowed user type values for listing filters. */
|
|
316
279
|
type ListUsersType = 'user' | 'opens';
|
|
317
280
|
/**
|
|
@@ -365,6 +328,45 @@ interface ListUsersResponse {
|
|
|
365
328
|
hasMore: boolean;
|
|
366
329
|
}
|
|
367
330
|
|
|
331
|
+
/** A work group entity nested within {@link WorkGroupListResponse} and {@link WorkGroupResponse}. */
|
|
332
|
+
interface WorkGroup {
|
|
333
|
+
id: string;
|
|
334
|
+
name: string;
|
|
335
|
+
description: string | null;
|
|
336
|
+
type: 'default' | 'user';
|
|
337
|
+
company_id: string;
|
|
338
|
+
createdAt: string;
|
|
339
|
+
updatedAt: string;
|
|
340
|
+
}
|
|
341
|
+
/** Response returned by the Customer Service API when fetching the work groups list. */
|
|
342
|
+
interface WorkGroupListResponse extends CompanyData {
|
|
343
|
+
workgroups: WorkGroup[];
|
|
344
|
+
}
|
|
345
|
+
/** A user membership entity nested within {@link WorkGroupResponse}. */
|
|
346
|
+
interface WorkGroupMember {
|
|
347
|
+
id: string;
|
|
348
|
+
username: string;
|
|
349
|
+
email: string;
|
|
350
|
+
profile: UserProfile;
|
|
351
|
+
status: 'new' | 'activated' | 'disabled';
|
|
352
|
+
avatar: string | null;
|
|
353
|
+
createdAt: string;
|
|
354
|
+
updatedAt: string;
|
|
355
|
+
}
|
|
356
|
+
/** Response returned by the Customer Service API when fetching a single work group. */
|
|
357
|
+
interface WorkGroupResponse {
|
|
358
|
+
id: string;
|
|
359
|
+
name: string;
|
|
360
|
+
description: string | null;
|
|
361
|
+
type: 'default' | 'user';
|
|
362
|
+
company_id: string;
|
|
363
|
+
createdAt: string;
|
|
364
|
+
updatedAt: string;
|
|
365
|
+
workgroups_users: WorkGroupMember[];
|
|
366
|
+
}
|
|
367
|
+
/** Response returned by the Customer Service API when fetching members of a work group. */
|
|
368
|
+
type WorkGroupMembersResponse = WorkGroupMember[];
|
|
369
|
+
|
|
368
370
|
/** Visual status literals for an announcement payload. */
|
|
369
371
|
type AnnouncementVisualStatus = 'success' | 'alert' | 'warning' | 'custom';
|
|
370
372
|
/** Button displayed inside an announcement payload. */
|
|
@@ -568,4 +570,4 @@ interface ValidateTwoFactorOtpResponse {
|
|
|
568
570
|
validate: boolean;
|
|
569
571
|
}
|
|
570
572
|
|
|
571
|
-
export type { ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementAppearance, AnnouncementButton, AnnouncementCompany, AnnouncementListFilters, AnnouncementListResponse, AnnouncementPayload, AnnouncementTargetingRuleUrl, AnnouncementTargetingRules, AnnouncementType, AnnouncementVisualStatus, CompanyBooleanConfigKey, CompanyConfigKey, CompanyConfigResponse, CompanyData, CompanyJsonConfigKey, CompanyQueue, CompanyResponse, CompanyStringConfigKey, CompanyWithConfigsResponse, CreateAnnouncementRequest, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse, GetSupportWidgetIdResponse, GetUserByIdResponse, ListUsersInclude, ListUsersProfile, ListUsersRequest, ListUsersResponse, ListUsersStatus, ListUsersType, ManagedUser, StrongPasswordOptions, StrongPasswordOptionsResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCompanyBooleanConfigRequest, UpdateCompanyJsonConfigRequest, UpdateCompanyRequest, UpdateCompanyStringConfigRequest, UpdateCompanyUserAvatarResponse, UpdateCompanyUserRequest, UpdateSupportWidgetIdRequest, UpdateSupportWidgetIdResponse, UpdateUserPasswordRequest, UpdateUserPasswordResponse, User, UserBond, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, WorkGroup, WorkGroupListResponse, WorkGroupMember, WorkGroupMembersResponse, WorkGroupResponse };
|
|
573
|
+
export type { ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementAppearance, AnnouncementButton, AnnouncementCompany, AnnouncementListFilters, AnnouncementListResponse, AnnouncementPayload, AnnouncementTargetingRuleUrl, AnnouncementTargetingRules, AnnouncementType, AnnouncementVisualStatus, CompanyBooleanConfigKey, CompanyConfigKey, CompanyConfigResponse, CompanyData, CompanyJsonConfigKey, CompanyQueue, CompanyResponse, CompanyStringConfigKey, CompanyWithConfigsResponse, CreateAnnouncementRequest, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse, GetSupportWidgetIdResponse, GetUserByIdResponse, ListUsersInclude, ListUsersProfile, ListUsersRequest, ListUsersResponse, ListUsersStatus, ListUsersType, ManagedUser, StrongPasswordOptions, StrongPasswordOptionsResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCompanyBooleanConfigRequest, UpdateCompanyJsonConfigRequest, UpdateCompanyRequest, UpdateCompanyStringConfigRequest, UpdateCompanyUserAvatarResponse, UpdateCompanyUserRequest, UpdateSupportWidgetIdRequest, UpdateSupportWidgetIdResponse, UpdateUserPasswordRequest, UpdateUserPasswordResponse, User, UserBond, UserProfile, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, WorkGroup, WorkGroupListResponse, WorkGroupMember, WorkGroupMembersResponse, WorkGroupResponse };
|
package/dist/index.d.mts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { AxiosInstance } from 'axios';
|
|
2
|
-
import { CompanyResponse, UpdateCompanyRequest, GetSupportWidgetIdResponse, UpdateSupportWidgetIdRequest, UpdateSupportWidgetIdResponse, CompanyQueue, CompanyWithConfigsResponse, StrongPasswordOptionsResponse, CompanyConfigKey, CompanyConfigResponse, CompanyJsonConfigKey, UpdateCompanyJsonConfigRequest, CompanyBooleanConfigKey, UpdateCompanyBooleanConfigRequest, CompanyStringConfigKey, UpdateCompanyStringConfigRequest, User, ListUsersRequest, ListUsersResponse, WorkGroupListResponse, WorkGroupResponse, WorkGroupMembersResponse, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse, GetUserByIdResponse, UpdateCompanyUserRequest, UpdateUserPasswordRequest, UpdateUserPasswordResponse, UpdateCompanyUserAvatarResponse, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, AnnouncementListFilters, AnnouncementListResponse, Announcement, CreateAnnouncementRequest, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, AnnouncementType, ActiveAnnouncementQuery, ActiveAnnouncement } from './customer-service/contracts/index.mjs';
|
|
2
|
+
import { CompanyResponse, UpdateCompanyRequest, GetSupportWidgetIdResponse, UpdateSupportWidgetIdRequest, UpdateSupportWidgetIdResponse, CompanyQueue, CompanyWithConfigsResponse, StrongPasswordOptionsResponse, CompanyConfigKey, CompanyConfigResponse, CompanyJsonConfigKey, UpdateCompanyJsonConfigRequest, CompanyBooleanConfigKey, UpdateCompanyBooleanConfigRequest, CompanyStringConfigKey, UpdateCompanyStringConfigRequest, User, ListUsersRequest, ListUsersResponse, WorkGroupListResponse, WorkGroupResponse, UserProfile, WorkGroupMembersResponse, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse, GetUserByIdResponse, UpdateCompanyUserRequest, UpdateUserPasswordRequest, UpdateUserPasswordResponse, UpdateCompanyUserAvatarResponse, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, AnnouncementListFilters, AnnouncementListResponse, Announcement, CreateAnnouncementRequest, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, AnnouncementType, ActiveAnnouncementQuery, ActiveAnnouncement } from './customer-service/contracts/index.mjs';
|
|
3
3
|
export { AnnouncementAppearance, AnnouncementButton, AnnouncementCompany, AnnouncementPayload, AnnouncementTargetingRuleUrl, AnnouncementTargetingRules, AnnouncementVisualStatus, CompanyData, ListUsersInclude, ListUsersProfile, ListUsersStatus, ListUsersType, ManagedUser, StrongPasswordOptions, UserBond, WorkGroup, WorkGroupMember } from './customer-service/contracts/index.mjs';
|
|
4
4
|
import { ProviderListResponse, Config, GetProviderConfigurationsParams, ProviderConfigurationsResponse, GetProviderDisplayInfoParams, ProviderDisplayInfoResponse, GetConfigsByProviderParams, ConfigListByProviderResponse, Queue, GetMemberQueuesRequest, QueueMember, GetServiceGroupsParams, ServiceGroupsResponse, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, FindOrCreateQueueRuleRequest, QueueRule, GetRootRulesRequest, RootRulesResponse } from './chat-config/contracts/index.mjs';
|
|
5
5
|
export { ConfigProvider, DistributionType, MetaTemplateButton, Provider, ProviderConfiguration, ProviderName, QueueListResponse, Rule, ServiceGroup, WhatsAppProviderSettings, WidgetProviderSettings } from './chat-config/contracts/index.mjs';
|
|
@@ -23,6 +23,8 @@ import { GetCommentHistoryRequest, CommentHistoryPage, CasePermissions, UpdateCa
|
|
|
23
23
|
export { CaseListItem, CasePermissionsValue, 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
|
+
import { GetSystemNotificationsParams, GetSystemNotificationsResponse, GetUserDevicesParams, GetUserDevicesResponse, RegisterUserDeviceRequest, RegisterUserDeviceResponse, DeleteUserDeviceResponse, GetUserPreferencesParams, UserPreference, CreateUserPreferenceRequest, DeleteUserPreferenceParams, DeleteUserPreferenceResponse } from './notifications/contracts/index.mjs';
|
|
27
|
+
export { DeviceType, SystemNotification, SystemNotificationType, UserDevice, UserPreferenceDevice, UserPreferenceSystemNotification } from './notifications/contracts/index.mjs';
|
|
26
28
|
export { Event } from './rh/contracts/index.mjs';
|
|
27
29
|
|
|
28
30
|
/**
|
|
@@ -132,7 +134,7 @@ declare class CustomerServiceGateway {
|
|
|
132
134
|
* @param profile - Filter members by profile (optional).
|
|
133
135
|
* @returns The members of the work group.
|
|
134
136
|
*/
|
|
135
|
-
getWorkGroupMembers(groupId: string, companyId?: string, profile?:
|
|
137
|
+
getWorkGroupMembers(groupId: string, companyId?: string, profile?: UserProfile[]): Promise<WorkGroupMembersResponse>;
|
|
136
138
|
getAllUsers(params?: GetAllUsersParams): Promise<GetAllUsersResponse>;
|
|
137
139
|
getManagedUsers(managerId: string): Promise<GetManagedUsersResponse>;
|
|
138
140
|
/**
|
|
@@ -814,6 +816,60 @@ declare class AccessHubGateway {
|
|
|
814
816
|
getCompanyResources(params: GetCompanyResourcesParams): Promise<CompanyResource[]>;
|
|
815
817
|
}
|
|
816
818
|
|
|
819
|
+
/**
|
|
820
|
+
* Gateway for interacting with the Notifications API.
|
|
821
|
+
*/
|
|
822
|
+
declare class NotificationsGateway {
|
|
823
|
+
private readonly httpClient;
|
|
824
|
+
private readonly baseUrl;
|
|
825
|
+
constructor(httpClient: AxiosInstance, baseUrl: string);
|
|
826
|
+
/**
|
|
827
|
+
* Returns the catalog of available system notifications with their types and metadata.
|
|
828
|
+
* @param params - Optional filters by type slug or type ID.
|
|
829
|
+
* @returns A list of system notifications and the total count.
|
|
830
|
+
*/
|
|
831
|
+
getSystemNotifications(params?: GetSystemNotificationsParams): Promise<GetSystemNotificationsResponse>;
|
|
832
|
+
/**
|
|
833
|
+
* Lists push notification devices registered for the authenticated user.
|
|
834
|
+
* @param params - Optional filters, pagination and service-token context.
|
|
835
|
+
* @returns A list of user devices and the total count.
|
|
836
|
+
*/
|
|
837
|
+
getUserDevices(params?: GetUserDevicesParams): Promise<GetUserDevicesResponse>;
|
|
838
|
+
/**
|
|
839
|
+
* Registers or updates a push notification token for a user device.
|
|
840
|
+
* Idempotent via findOrCreate on deviceToken.
|
|
841
|
+
* @param payload - Device token and either deviceSlug or deviceId.
|
|
842
|
+
* @returns The registered device summary.
|
|
843
|
+
*/
|
|
844
|
+
registerUserDevice(payload: RegisterUserDeviceRequest): Promise<RegisterUserDeviceResponse>;
|
|
845
|
+
/**
|
|
846
|
+
* Deletes a registered user device and its notification token.
|
|
847
|
+
* @param id - UUID of the user device record.
|
|
848
|
+
* @returns Confirmation of deletion.
|
|
849
|
+
*/
|
|
850
|
+
deleteUserDevice(id: string): Promise<DeleteUserDeviceResponse>;
|
|
851
|
+
/**
|
|
852
|
+
* Lists active notification preferences for the user, optionally filtered by device.
|
|
853
|
+
* @param params - Optional filters and service-token context.
|
|
854
|
+
* @returns A list of user preferences.
|
|
855
|
+
*/
|
|
856
|
+
getUserPreferences(params?: GetUserPreferencesParams): Promise<UserPreference[]>;
|
|
857
|
+
/**
|
|
858
|
+
* Creates or activates a notification preference for a user device.
|
|
859
|
+
* Idempotent via findOrCreate on the user/device/notification combination.
|
|
860
|
+
* @param payload - Device ID and either systemNotificationSlug or systemNotificationId.
|
|
861
|
+
* @returns The created or existing preference.
|
|
862
|
+
*/
|
|
863
|
+
createUserPreference(payload: CreateUserPreferenceRequest): Promise<UserPreference>;
|
|
864
|
+
/**
|
|
865
|
+
* Deletes a notification preference by its ID.
|
|
866
|
+
* @param id - UUID of the preference in `user_notification_preferences`.
|
|
867
|
+
* @param params - Optional companyId/userId for Service Token context.
|
|
868
|
+
* @returns Confirmation of deletion.
|
|
869
|
+
*/
|
|
870
|
+
deleteUserPreference(id: string, params?: DeleteUserPreferenceParams): Promise<DeleteUserPreferenceResponse>;
|
|
871
|
+
}
|
|
872
|
+
|
|
817
873
|
/**
|
|
818
874
|
* Maps service identifiers to their corresponding gateway types.
|
|
819
875
|
* Used by the `gateway()` function to infer the correct return type
|
|
@@ -836,6 +892,7 @@ type GatewayMap = {
|
|
|
836
892
|
cases: CasesGateway;
|
|
837
893
|
rh: RhGateway;
|
|
838
894
|
'access-hub': AccessHubGateway;
|
|
895
|
+
notifications: NotificationsGateway;
|
|
839
896
|
};
|
|
840
897
|
/**
|
|
841
898
|
* Parameters required to configure the SDK client.
|
|
@@ -887,6 +944,9 @@ interface GatewayClientParams {
|
|
|
887
944
|
accessHub?: {
|
|
888
945
|
baseUrl: string;
|
|
889
946
|
};
|
|
947
|
+
notifications?: {
|
|
948
|
+
baseUrl: string;
|
|
949
|
+
};
|
|
890
950
|
};
|
|
891
951
|
}
|
|
892
952
|
|
|
@@ -904,6 +964,7 @@ declare const SERVICE_GATEWAYS: {
|
|
|
904
964
|
readonly CASES: "cases";
|
|
905
965
|
readonly RH: "rh";
|
|
906
966
|
readonly ACCESS_HUB: "access-hub";
|
|
967
|
+
readonly NOTIFICATIONS: "notifications";
|
|
907
968
|
};
|
|
908
969
|
type SERVICE_GATEWAYS = (typeof SERVICE_GATEWAYS)[keyof typeof SERVICE_GATEWAYS];
|
|
909
970
|
|
|
@@ -930,4 +991,4 @@ declare const configure: (params: GatewayClientParams) => void;
|
|
|
930
991
|
*/
|
|
931
992
|
declare function gateway<T extends keyof GatewayMap>(service: T): GatewayMap[T];
|
|
932
993
|
|
|
933
|
-
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, CreateWebhookRequest$1 as CreateWebhookRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, DeleteTimeEntryRequest, EnableCampaignCompanyRequest, FindOrCreateContactRequest, FindOrCreateQueueRuleRequest, FlowCatalogParams, FlowCatalogResponse, FlowDefinition, FlowReadiness, ForwardMessageRequest, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, GetAccessPackagesParams, GetAllUsersParams, GetAllUsersResponse, GetAttachmentByIdRequest, GetAutomationPartnerRequest, GetCaseFeedByActionsRequest, GetCommentHistoryRequest, GetCompanyAccessPackagesParams, GetCompanyResourcesParams, GetConfigTemplatesParams, GetConfigTemplatesResponse, GetConfigsByProviderParams, GetContactPhonesParams, GetInitialContextRequest, GetInitialContextResponse, GetIntegrationHooksCatalogRequest, GetIntegrationPartnersByCompanyRequest, GetManagedUsersResponse, GetMemberQueuesRequest, GetMessagesByCursorRequest, GetMessagesByCursorResponse, GetPresignedUrlRequest, GetProviderConfigurationsParams, GetProviderDisplayInfoParams, GetRoomByIdRequest, GetRootRulesRequest, GetServiceGroupsParams, GetSupportWidgetIdResponse, GetUserByIdResponse, 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, 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, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };
|
|
994
|
+
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, 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 };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { AxiosInstance } from 'axios';
|
|
2
|
-
import { CompanyResponse, UpdateCompanyRequest, GetSupportWidgetIdResponse, UpdateSupportWidgetIdRequest, UpdateSupportWidgetIdResponse, CompanyQueue, CompanyWithConfigsResponse, StrongPasswordOptionsResponse, CompanyConfigKey, CompanyConfigResponse, CompanyJsonConfigKey, UpdateCompanyJsonConfigRequest, CompanyBooleanConfigKey, UpdateCompanyBooleanConfigRequest, CompanyStringConfigKey, UpdateCompanyStringConfigRequest, User, ListUsersRequest, ListUsersResponse, WorkGroupListResponse, WorkGroupResponse, WorkGroupMembersResponse, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse, GetUserByIdResponse, UpdateCompanyUserRequest, UpdateUserPasswordRequest, UpdateUserPasswordResponse, UpdateCompanyUserAvatarResponse, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, AnnouncementListFilters, AnnouncementListResponse, Announcement, CreateAnnouncementRequest, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, AnnouncementType, ActiveAnnouncementQuery, ActiveAnnouncement } from './customer-service/contracts/index.js';
|
|
2
|
+
import { CompanyResponse, UpdateCompanyRequest, GetSupportWidgetIdResponse, UpdateSupportWidgetIdRequest, UpdateSupportWidgetIdResponse, CompanyQueue, CompanyWithConfigsResponse, StrongPasswordOptionsResponse, CompanyConfigKey, CompanyConfigResponse, CompanyJsonConfigKey, UpdateCompanyJsonConfigRequest, CompanyBooleanConfigKey, UpdateCompanyBooleanConfigRequest, CompanyStringConfigKey, UpdateCompanyStringConfigRequest, User, ListUsersRequest, ListUsersResponse, WorkGroupListResponse, WorkGroupResponse, UserProfile, WorkGroupMembersResponse, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse, GetUserByIdResponse, UpdateCompanyUserRequest, UpdateUserPasswordRequest, UpdateUserPasswordResponse, UpdateCompanyUserAvatarResponse, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, AnnouncementListFilters, AnnouncementListResponse, Announcement, CreateAnnouncementRequest, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, AnnouncementType, ActiveAnnouncementQuery, ActiveAnnouncement } from './customer-service/contracts/index.js';
|
|
3
3
|
export { AnnouncementAppearance, AnnouncementButton, AnnouncementCompany, AnnouncementPayload, AnnouncementTargetingRuleUrl, AnnouncementTargetingRules, AnnouncementVisualStatus, CompanyData, ListUsersInclude, ListUsersProfile, ListUsersStatus, ListUsersType, ManagedUser, StrongPasswordOptions, UserBond, WorkGroup, WorkGroupMember } from './customer-service/contracts/index.js';
|
|
4
4
|
import { ProviderListResponse, Config, GetProviderConfigurationsParams, ProviderConfigurationsResponse, GetProviderDisplayInfoParams, ProviderDisplayInfoResponse, GetConfigsByProviderParams, ConfigListByProviderResponse, Queue, GetMemberQueuesRequest, QueueMember, GetServiceGroupsParams, ServiceGroupsResponse, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, FindOrCreateQueueRuleRequest, QueueRule, GetRootRulesRequest, RootRulesResponse } from './chat-config/contracts/index.js';
|
|
5
5
|
export { ConfigProvider, DistributionType, MetaTemplateButton, Provider, ProviderConfiguration, ProviderName, QueueListResponse, Rule, ServiceGroup, WhatsAppProviderSettings, WidgetProviderSettings } from './chat-config/contracts/index.js';
|
|
@@ -23,6 +23,8 @@ import { GetCommentHistoryRequest, CommentHistoryPage, CasePermissions, UpdateCa
|
|
|
23
23
|
export { CaseListItem, CasePermissionsValue, 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
|
+
import { GetSystemNotificationsParams, GetSystemNotificationsResponse, GetUserDevicesParams, GetUserDevicesResponse, RegisterUserDeviceRequest, RegisterUserDeviceResponse, DeleteUserDeviceResponse, GetUserPreferencesParams, UserPreference, CreateUserPreferenceRequest, DeleteUserPreferenceParams, DeleteUserPreferenceResponse } from './notifications/contracts/index.js';
|
|
27
|
+
export { DeviceType, SystemNotification, SystemNotificationType, UserDevice, UserPreferenceDevice, UserPreferenceSystemNotification } from './notifications/contracts/index.js';
|
|
26
28
|
export { Event } from './rh/contracts/index.js';
|
|
27
29
|
|
|
28
30
|
/**
|
|
@@ -132,7 +134,7 @@ declare class CustomerServiceGateway {
|
|
|
132
134
|
* @param profile - Filter members by profile (optional).
|
|
133
135
|
* @returns The members of the work group.
|
|
134
136
|
*/
|
|
135
|
-
getWorkGroupMembers(groupId: string, companyId?: string, profile?:
|
|
137
|
+
getWorkGroupMembers(groupId: string, companyId?: string, profile?: UserProfile[]): Promise<WorkGroupMembersResponse>;
|
|
136
138
|
getAllUsers(params?: GetAllUsersParams): Promise<GetAllUsersResponse>;
|
|
137
139
|
getManagedUsers(managerId: string): Promise<GetManagedUsersResponse>;
|
|
138
140
|
/**
|
|
@@ -814,6 +816,60 @@ declare class AccessHubGateway {
|
|
|
814
816
|
getCompanyResources(params: GetCompanyResourcesParams): Promise<CompanyResource[]>;
|
|
815
817
|
}
|
|
816
818
|
|
|
819
|
+
/**
|
|
820
|
+
* Gateway for interacting with the Notifications API.
|
|
821
|
+
*/
|
|
822
|
+
declare class NotificationsGateway {
|
|
823
|
+
private readonly httpClient;
|
|
824
|
+
private readonly baseUrl;
|
|
825
|
+
constructor(httpClient: AxiosInstance, baseUrl: string);
|
|
826
|
+
/**
|
|
827
|
+
* Returns the catalog of available system notifications with their types and metadata.
|
|
828
|
+
* @param params - Optional filters by type slug or type ID.
|
|
829
|
+
* @returns A list of system notifications and the total count.
|
|
830
|
+
*/
|
|
831
|
+
getSystemNotifications(params?: GetSystemNotificationsParams): Promise<GetSystemNotificationsResponse>;
|
|
832
|
+
/**
|
|
833
|
+
* Lists push notification devices registered for the authenticated user.
|
|
834
|
+
* @param params - Optional filters, pagination and service-token context.
|
|
835
|
+
* @returns A list of user devices and the total count.
|
|
836
|
+
*/
|
|
837
|
+
getUserDevices(params?: GetUserDevicesParams): Promise<GetUserDevicesResponse>;
|
|
838
|
+
/**
|
|
839
|
+
* Registers or updates a push notification token for a user device.
|
|
840
|
+
* Idempotent via findOrCreate on deviceToken.
|
|
841
|
+
* @param payload - Device token and either deviceSlug or deviceId.
|
|
842
|
+
* @returns The registered device summary.
|
|
843
|
+
*/
|
|
844
|
+
registerUserDevice(payload: RegisterUserDeviceRequest): Promise<RegisterUserDeviceResponse>;
|
|
845
|
+
/**
|
|
846
|
+
* Deletes a registered user device and its notification token.
|
|
847
|
+
* @param id - UUID of the user device record.
|
|
848
|
+
* @returns Confirmation of deletion.
|
|
849
|
+
*/
|
|
850
|
+
deleteUserDevice(id: string): Promise<DeleteUserDeviceResponse>;
|
|
851
|
+
/**
|
|
852
|
+
* Lists active notification preferences for the user, optionally filtered by device.
|
|
853
|
+
* @param params - Optional filters and service-token context.
|
|
854
|
+
* @returns A list of user preferences.
|
|
855
|
+
*/
|
|
856
|
+
getUserPreferences(params?: GetUserPreferencesParams): Promise<UserPreference[]>;
|
|
857
|
+
/**
|
|
858
|
+
* Creates or activates a notification preference for a user device.
|
|
859
|
+
* Idempotent via findOrCreate on the user/device/notification combination.
|
|
860
|
+
* @param payload - Device ID and either systemNotificationSlug or systemNotificationId.
|
|
861
|
+
* @returns The created or existing preference.
|
|
862
|
+
*/
|
|
863
|
+
createUserPreference(payload: CreateUserPreferenceRequest): Promise<UserPreference>;
|
|
864
|
+
/**
|
|
865
|
+
* Deletes a notification preference by its ID.
|
|
866
|
+
* @param id - UUID of the preference in `user_notification_preferences`.
|
|
867
|
+
* @param params - Optional companyId/userId for Service Token context.
|
|
868
|
+
* @returns Confirmation of deletion.
|
|
869
|
+
*/
|
|
870
|
+
deleteUserPreference(id: string, params?: DeleteUserPreferenceParams): Promise<DeleteUserPreferenceResponse>;
|
|
871
|
+
}
|
|
872
|
+
|
|
817
873
|
/**
|
|
818
874
|
* Maps service identifiers to their corresponding gateway types.
|
|
819
875
|
* Used by the `gateway()` function to infer the correct return type
|
|
@@ -836,6 +892,7 @@ type GatewayMap = {
|
|
|
836
892
|
cases: CasesGateway;
|
|
837
893
|
rh: RhGateway;
|
|
838
894
|
'access-hub': AccessHubGateway;
|
|
895
|
+
notifications: NotificationsGateway;
|
|
839
896
|
};
|
|
840
897
|
/**
|
|
841
898
|
* Parameters required to configure the SDK client.
|
|
@@ -887,6 +944,9 @@ interface GatewayClientParams {
|
|
|
887
944
|
accessHub?: {
|
|
888
945
|
baseUrl: string;
|
|
889
946
|
};
|
|
947
|
+
notifications?: {
|
|
948
|
+
baseUrl: string;
|
|
949
|
+
};
|
|
890
950
|
};
|
|
891
951
|
}
|
|
892
952
|
|
|
@@ -904,6 +964,7 @@ declare const SERVICE_GATEWAYS: {
|
|
|
904
964
|
readonly CASES: "cases";
|
|
905
965
|
readonly RH: "rh";
|
|
906
966
|
readonly ACCESS_HUB: "access-hub";
|
|
967
|
+
readonly NOTIFICATIONS: "notifications";
|
|
907
968
|
};
|
|
908
969
|
type SERVICE_GATEWAYS = (typeof SERVICE_GATEWAYS)[keyof typeof SERVICE_GATEWAYS];
|
|
909
970
|
|
|
@@ -930,4 +991,4 @@ declare const configure: (params: GatewayClientParams) => void;
|
|
|
930
991
|
*/
|
|
931
992
|
declare function gateway<T extends keyof GatewayMap>(service: T): GatewayMap[T];
|
|
932
993
|
|
|
933
|
-
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, CreateWebhookRequest$1 as CreateWebhookRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, DeleteTimeEntryRequest, EnableCampaignCompanyRequest, FindOrCreateContactRequest, FindOrCreateQueueRuleRequest, FlowCatalogParams, FlowCatalogResponse, FlowDefinition, FlowReadiness, ForwardMessageRequest, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, GetAccessPackagesParams, GetAllUsersParams, GetAllUsersResponse, GetAttachmentByIdRequest, GetAutomationPartnerRequest, GetCaseFeedByActionsRequest, GetCommentHistoryRequest, GetCompanyAccessPackagesParams, GetCompanyResourcesParams, GetConfigTemplatesParams, GetConfigTemplatesResponse, GetConfigsByProviderParams, GetContactPhonesParams, GetInitialContextRequest, GetInitialContextResponse, GetIntegrationHooksCatalogRequest, GetIntegrationPartnersByCompanyRequest, GetManagedUsersResponse, GetMemberQueuesRequest, GetMessagesByCursorRequest, GetMessagesByCursorResponse, GetPresignedUrlRequest, GetProviderConfigurationsParams, GetProviderDisplayInfoParams, GetRoomByIdRequest, GetRootRulesRequest, GetServiceGroupsParams, GetSupportWidgetIdResponse, GetUserByIdResponse, 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, 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, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };
|
|
994
|
+
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, 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 };
|