@opens/gateways 1.16.1 → 1.16.3
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 +89 -10
- package/dist/customer-service/contracts/index.d.ts +89 -10
- package/dist/index.d.mts +15 -7
- package/dist/index.d.ts +15 -7
- package/dist/index.js +18 -5
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +18 -5
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
|
@@ -61,12 +61,18 @@ interface UpdateCompanyBooleanConfigRequest {
|
|
|
61
61
|
interface UpdateCompanyStringConfigRequest {
|
|
62
62
|
value: string;
|
|
63
63
|
}
|
|
64
|
+
/** Request payload for updating a JSON company config. */
|
|
65
|
+
interface UpdateCompanyJsonConfigRequest {
|
|
66
|
+
valueJson: StrongPasswordOptions;
|
|
67
|
+
}
|
|
64
68
|
/** Known company config keys that accept a boolean value. */
|
|
65
69
|
type CompanyBooleanConfigKey = 'mandatory-tag' | 'prevent-tag-edit' | 'inbox-hide-message-enabled' | 'show-deleted-users';
|
|
66
70
|
/** Known company config keys that accept a string value. */
|
|
67
71
|
type CompanyStringConfigKey = 'proxy_ami' | 'snep_password' | 'snep_ip';
|
|
72
|
+
/** Known company config keys that accept a JSON value. */
|
|
73
|
+
type CompanyJsonConfigKey = 'strong-password-options';
|
|
68
74
|
/** Known company config keys for fetching a single config entry. */
|
|
69
|
-
type CompanyConfigKey = CompanyBooleanConfigKey | CompanyStringConfigKey |
|
|
75
|
+
type CompanyConfigKey = CompanyBooleanConfigKey | CompanyStringConfigKey | CompanyJsonConfigKey;
|
|
70
76
|
/** Response returned by the Customer Service API for a company config entry. */
|
|
71
77
|
interface CompanyConfigResponse {
|
|
72
78
|
id: string;
|
|
@@ -193,6 +199,20 @@ interface WorkGroupResponse {
|
|
|
193
199
|
/** Response returned by the Customer Service API when fetching members of a work group. */
|
|
194
200
|
type WorkGroupMembersResponse = WorkGroupMember[];
|
|
195
201
|
|
|
202
|
+
/** User bond returned by the Customer Service API. */
|
|
203
|
+
interface UserBond {
|
|
204
|
+
id: string;
|
|
205
|
+
queue: string;
|
|
206
|
+
type: 'queue' | 'work_group';
|
|
207
|
+
permission: 'superviser' | 'manager' | 'member';
|
|
208
|
+
user_id: string;
|
|
209
|
+
group_id: string | null;
|
|
210
|
+
company_id: string;
|
|
211
|
+
group_name: string | null;
|
|
212
|
+
createdAt: string;
|
|
213
|
+
updatedAt: string;
|
|
214
|
+
workgroups_bonds?: WorkGroup;
|
|
215
|
+
}
|
|
196
216
|
/** User entity returned by the Customer Service API. */
|
|
197
217
|
interface User {
|
|
198
218
|
id: string;
|
|
@@ -200,9 +220,9 @@ interface User {
|
|
|
200
220
|
email: string;
|
|
201
221
|
profile: 'p_admin' | 'p_manager' | 'p_corporative' | 'p_agent';
|
|
202
222
|
language: string;
|
|
203
|
-
access_token
|
|
223
|
+
access_token?: string;
|
|
204
224
|
occupation: string;
|
|
205
|
-
endpoint: string;
|
|
225
|
+
endpoint: string | null;
|
|
206
226
|
phone_number: string | null;
|
|
207
227
|
usercode: number;
|
|
208
228
|
queues: unknown[] | null;
|
|
@@ -213,20 +233,20 @@ interface User {
|
|
|
213
233
|
redefine_expires: string;
|
|
214
234
|
state: string;
|
|
215
235
|
pause: Record<string, unknown> | null;
|
|
216
|
-
last_event_time: string;
|
|
236
|
+
last_event_time: string | null;
|
|
217
237
|
oncall: boolean;
|
|
218
|
-
ringing: boolean;
|
|
219
|
-
callnumber: string;
|
|
238
|
+
ringing: boolean | null;
|
|
239
|
+
callnumber: string | null;
|
|
220
240
|
timezone: string;
|
|
221
241
|
utc: string;
|
|
222
|
-
peer_create: string;
|
|
242
|
+
peer_create: string | null;
|
|
223
243
|
token_id: string;
|
|
224
|
-
tech_channel: string;
|
|
244
|
+
tech_channel: string | null;
|
|
225
245
|
bad_password: number;
|
|
226
246
|
block_status: string;
|
|
227
247
|
two_auth_mail: boolean;
|
|
228
248
|
two_auth_otp: boolean;
|
|
229
|
-
otp_key
|
|
249
|
+
otp_key?: string | null;
|
|
230
250
|
watching: boolean;
|
|
231
251
|
trial: boolean;
|
|
232
252
|
ringing_sound: string | null;
|
|
@@ -234,6 +254,9 @@ interface User {
|
|
|
234
254
|
updatedAt: string;
|
|
235
255
|
company_id: string;
|
|
236
256
|
password?: string;
|
|
257
|
+
mobile_access?: boolean;
|
|
258
|
+
company?: CompanyData;
|
|
259
|
+
users_bonds?: UserBond[];
|
|
237
260
|
}
|
|
238
261
|
interface GetAllUsersParams {
|
|
239
262
|
status?: string;
|
|
@@ -284,6 +307,62 @@ interface UpdateUserPasswordResponse {
|
|
|
284
307
|
interface UpdateCompanyUserAvatarResponse {
|
|
285
308
|
success: boolean;
|
|
286
309
|
}
|
|
310
|
+
/** Allowed user status values for listing filters. */
|
|
311
|
+
type ListUsersStatus = 'new' | 'activated' | 'disabled';
|
|
312
|
+
/** Allowed user profile values for listing filters. */
|
|
313
|
+
type ListUsersProfile = 'p_admin' | 'p_manager' | 'p_corporative' | 'p_agent';
|
|
314
|
+
/** Allowed user type values for listing filters. */
|
|
315
|
+
type ListUsersType = 'user' | 'opens';
|
|
316
|
+
/**
|
|
317
|
+
* Optional associations loaded via `include`.
|
|
318
|
+
* `logs` is not allowed. Unknown or duplicated values return `400`.
|
|
319
|
+
*/
|
|
320
|
+
type ListUsersInclude = 'company' | 'bonds' | 'workgroups';
|
|
321
|
+
/**
|
|
322
|
+
* Query parameters for `GET /users`.
|
|
323
|
+
*
|
|
324
|
+
* Company is resolved from the authenticated token first; `companyId` is used only when the token has none.
|
|
325
|
+
* List filters may be sent as repeated query keys (for example `status[]=new&status[]=activated`).
|
|
326
|
+
*/
|
|
327
|
+
interface ListUsersRequest {
|
|
328
|
+
/** Current page, starting at 1. Defaults to `1`. */
|
|
329
|
+
page?: number;
|
|
330
|
+
/** Page size between 1 and 100. Defaults to `20`. */
|
|
331
|
+
pageSize?: number;
|
|
332
|
+
/** Company UUID used only when the token does not contain `companyId`. */
|
|
333
|
+
companyId?: string;
|
|
334
|
+
/** Case-insensitive search on `username` and `email`. Minimum of 2 characters. */
|
|
335
|
+
search?: string;
|
|
336
|
+
/** Filters by the `mobile_access` field. */
|
|
337
|
+
mobileAccess?: boolean;
|
|
338
|
+
/** Allowed values: `new`, `activated`, `disabled`. */
|
|
339
|
+
status?: ListUsersStatus[];
|
|
340
|
+
/** Allowed values: `p_admin`, `p_manager`, `p_corporative`, `p_agent`. */
|
|
341
|
+
profile?: ListUsersProfile[];
|
|
342
|
+
/** Allowed values: `user`, `opens`. */
|
|
343
|
+
type?: ListUsersType;
|
|
344
|
+
/** Restricts the result to the given user UUIDs. */
|
|
345
|
+
ids?: string[];
|
|
346
|
+
/** Excludes users; takes precedence when an id is also present in `ids`. */
|
|
347
|
+
excludeIds?: string[];
|
|
348
|
+
/** Returns users linked to any of the given workgroup UUIDs. */
|
|
349
|
+
workgroupIds?: string[];
|
|
350
|
+
/**
|
|
351
|
+
* Associations to load.
|
|
352
|
+
* `company` → `company`, `bonds` → `users_bonds`,
|
|
353
|
+
* `workgroups` → `users_bonds` of type `work_group` with nested `workgroups_bonds`.
|
|
354
|
+
*/
|
|
355
|
+
include?: ListUsersInclude[];
|
|
356
|
+
}
|
|
357
|
+
/** Paginated response returned by `GET /users`. */
|
|
358
|
+
interface ListUsersResponse {
|
|
359
|
+
/** Users in the current page. */
|
|
360
|
+
data: User[];
|
|
361
|
+
/** Total number of users matching the filters. */
|
|
362
|
+
total: number;
|
|
363
|
+
/** Whether another page is available. */
|
|
364
|
+
hasMore: boolean;
|
|
365
|
+
}
|
|
287
366
|
|
|
288
367
|
/** Visual status literals for an announcement payload. */
|
|
289
368
|
type AnnouncementVisualStatus = 'success' | 'alert' | 'warning' | 'custom';
|
|
@@ -488,4 +567,4 @@ interface ValidateTwoFactorOtpResponse {
|
|
|
488
567
|
validate: boolean;
|
|
489
568
|
}
|
|
490
569
|
|
|
491
|
-
export type { ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementAppearance, AnnouncementButton, AnnouncementCompany, AnnouncementListFilters, AnnouncementListResponse, AnnouncementPayload, AnnouncementTargetingRuleUrl, AnnouncementTargetingRules, AnnouncementType, AnnouncementVisualStatus, CompanyBooleanConfigKey, CompanyConfigKey, CompanyConfigResponse, CompanyData, CompanyQueue, CompanyResponse, CompanyStringConfigKey, CompanyWithConfigsResponse, CreateAnnouncementRequest, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse, GetSupportWidgetIdResponse, GetUserByIdResponse, ManagedUser, StrongPasswordOptions, StrongPasswordOptionsResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCompanyBooleanConfigRequest, UpdateCompanyRequest, UpdateCompanyStringConfigRequest, UpdateCompanyUserAvatarResponse, UpdateCompanyUserRequest, UpdateSupportWidgetIdRequest, UpdateSupportWidgetIdResponse, UpdateUserPasswordRequest, UpdateUserPasswordResponse, User, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, WorkGroup, WorkGroupListResponse, WorkGroupMember, WorkGroupMembersResponse, WorkGroupResponse };
|
|
570
|
+
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 };
|
|
@@ -61,12 +61,18 @@ interface UpdateCompanyBooleanConfigRequest {
|
|
|
61
61
|
interface UpdateCompanyStringConfigRequest {
|
|
62
62
|
value: string;
|
|
63
63
|
}
|
|
64
|
+
/** Request payload for updating a JSON company config. */
|
|
65
|
+
interface UpdateCompanyJsonConfigRequest {
|
|
66
|
+
valueJson: StrongPasswordOptions;
|
|
67
|
+
}
|
|
64
68
|
/** Known company config keys that accept a boolean value. */
|
|
65
69
|
type CompanyBooleanConfigKey = 'mandatory-tag' | 'prevent-tag-edit' | 'inbox-hide-message-enabled' | 'show-deleted-users';
|
|
66
70
|
/** Known company config keys that accept a string value. */
|
|
67
71
|
type CompanyStringConfigKey = 'proxy_ami' | 'snep_password' | 'snep_ip';
|
|
72
|
+
/** Known company config keys that accept a JSON value. */
|
|
73
|
+
type CompanyJsonConfigKey = 'strong-password-options';
|
|
68
74
|
/** Known company config keys for fetching a single config entry. */
|
|
69
|
-
type CompanyConfigKey = CompanyBooleanConfigKey | CompanyStringConfigKey |
|
|
75
|
+
type CompanyConfigKey = CompanyBooleanConfigKey | CompanyStringConfigKey | CompanyJsonConfigKey;
|
|
70
76
|
/** Response returned by the Customer Service API for a company config entry. */
|
|
71
77
|
interface CompanyConfigResponse {
|
|
72
78
|
id: string;
|
|
@@ -193,6 +199,20 @@ interface WorkGroupResponse {
|
|
|
193
199
|
/** Response returned by the Customer Service API when fetching members of a work group. */
|
|
194
200
|
type WorkGroupMembersResponse = WorkGroupMember[];
|
|
195
201
|
|
|
202
|
+
/** User bond returned by the Customer Service API. */
|
|
203
|
+
interface UserBond {
|
|
204
|
+
id: string;
|
|
205
|
+
queue: string;
|
|
206
|
+
type: 'queue' | 'work_group';
|
|
207
|
+
permission: 'superviser' | 'manager' | 'member';
|
|
208
|
+
user_id: string;
|
|
209
|
+
group_id: string | null;
|
|
210
|
+
company_id: string;
|
|
211
|
+
group_name: string | null;
|
|
212
|
+
createdAt: string;
|
|
213
|
+
updatedAt: string;
|
|
214
|
+
workgroups_bonds?: WorkGroup;
|
|
215
|
+
}
|
|
196
216
|
/** User entity returned by the Customer Service API. */
|
|
197
217
|
interface User {
|
|
198
218
|
id: string;
|
|
@@ -200,9 +220,9 @@ interface User {
|
|
|
200
220
|
email: string;
|
|
201
221
|
profile: 'p_admin' | 'p_manager' | 'p_corporative' | 'p_agent';
|
|
202
222
|
language: string;
|
|
203
|
-
access_token
|
|
223
|
+
access_token?: string;
|
|
204
224
|
occupation: string;
|
|
205
|
-
endpoint: string;
|
|
225
|
+
endpoint: string | null;
|
|
206
226
|
phone_number: string | null;
|
|
207
227
|
usercode: number;
|
|
208
228
|
queues: unknown[] | null;
|
|
@@ -213,20 +233,20 @@ interface User {
|
|
|
213
233
|
redefine_expires: string;
|
|
214
234
|
state: string;
|
|
215
235
|
pause: Record<string, unknown> | null;
|
|
216
|
-
last_event_time: string;
|
|
236
|
+
last_event_time: string | null;
|
|
217
237
|
oncall: boolean;
|
|
218
|
-
ringing: boolean;
|
|
219
|
-
callnumber: string;
|
|
238
|
+
ringing: boolean | null;
|
|
239
|
+
callnumber: string | null;
|
|
220
240
|
timezone: string;
|
|
221
241
|
utc: string;
|
|
222
|
-
peer_create: string;
|
|
242
|
+
peer_create: string | null;
|
|
223
243
|
token_id: string;
|
|
224
|
-
tech_channel: string;
|
|
244
|
+
tech_channel: string | null;
|
|
225
245
|
bad_password: number;
|
|
226
246
|
block_status: string;
|
|
227
247
|
two_auth_mail: boolean;
|
|
228
248
|
two_auth_otp: boolean;
|
|
229
|
-
otp_key
|
|
249
|
+
otp_key?: string | null;
|
|
230
250
|
watching: boolean;
|
|
231
251
|
trial: boolean;
|
|
232
252
|
ringing_sound: string | null;
|
|
@@ -234,6 +254,9 @@ interface User {
|
|
|
234
254
|
updatedAt: string;
|
|
235
255
|
company_id: string;
|
|
236
256
|
password?: string;
|
|
257
|
+
mobile_access?: boolean;
|
|
258
|
+
company?: CompanyData;
|
|
259
|
+
users_bonds?: UserBond[];
|
|
237
260
|
}
|
|
238
261
|
interface GetAllUsersParams {
|
|
239
262
|
status?: string;
|
|
@@ -284,6 +307,62 @@ interface UpdateUserPasswordResponse {
|
|
|
284
307
|
interface UpdateCompanyUserAvatarResponse {
|
|
285
308
|
success: boolean;
|
|
286
309
|
}
|
|
310
|
+
/** Allowed user status values for listing filters. */
|
|
311
|
+
type ListUsersStatus = 'new' | 'activated' | 'disabled';
|
|
312
|
+
/** Allowed user profile values for listing filters. */
|
|
313
|
+
type ListUsersProfile = 'p_admin' | 'p_manager' | 'p_corporative' | 'p_agent';
|
|
314
|
+
/** Allowed user type values for listing filters. */
|
|
315
|
+
type ListUsersType = 'user' | 'opens';
|
|
316
|
+
/**
|
|
317
|
+
* Optional associations loaded via `include`.
|
|
318
|
+
* `logs` is not allowed. Unknown or duplicated values return `400`.
|
|
319
|
+
*/
|
|
320
|
+
type ListUsersInclude = 'company' | 'bonds' | 'workgroups';
|
|
321
|
+
/**
|
|
322
|
+
* Query parameters for `GET /users`.
|
|
323
|
+
*
|
|
324
|
+
* Company is resolved from the authenticated token first; `companyId` is used only when the token has none.
|
|
325
|
+
* List filters may be sent as repeated query keys (for example `status[]=new&status[]=activated`).
|
|
326
|
+
*/
|
|
327
|
+
interface ListUsersRequest {
|
|
328
|
+
/** Current page, starting at 1. Defaults to `1`. */
|
|
329
|
+
page?: number;
|
|
330
|
+
/** Page size between 1 and 100. Defaults to `20`. */
|
|
331
|
+
pageSize?: number;
|
|
332
|
+
/** Company UUID used only when the token does not contain `companyId`. */
|
|
333
|
+
companyId?: string;
|
|
334
|
+
/** Case-insensitive search on `username` and `email`. Minimum of 2 characters. */
|
|
335
|
+
search?: string;
|
|
336
|
+
/** Filters by the `mobile_access` field. */
|
|
337
|
+
mobileAccess?: boolean;
|
|
338
|
+
/** Allowed values: `new`, `activated`, `disabled`. */
|
|
339
|
+
status?: ListUsersStatus[];
|
|
340
|
+
/** Allowed values: `p_admin`, `p_manager`, `p_corporative`, `p_agent`. */
|
|
341
|
+
profile?: ListUsersProfile[];
|
|
342
|
+
/** Allowed values: `user`, `opens`. */
|
|
343
|
+
type?: ListUsersType;
|
|
344
|
+
/** Restricts the result to the given user UUIDs. */
|
|
345
|
+
ids?: string[];
|
|
346
|
+
/** Excludes users; takes precedence when an id is also present in `ids`. */
|
|
347
|
+
excludeIds?: string[];
|
|
348
|
+
/** Returns users linked to any of the given workgroup UUIDs. */
|
|
349
|
+
workgroupIds?: string[];
|
|
350
|
+
/**
|
|
351
|
+
* Associations to load.
|
|
352
|
+
* `company` → `company`, `bonds` → `users_bonds`,
|
|
353
|
+
* `workgroups` → `users_bonds` of type `work_group` with nested `workgroups_bonds`.
|
|
354
|
+
*/
|
|
355
|
+
include?: ListUsersInclude[];
|
|
356
|
+
}
|
|
357
|
+
/** Paginated response returned by `GET /users`. */
|
|
358
|
+
interface ListUsersResponse {
|
|
359
|
+
/** Users in the current page. */
|
|
360
|
+
data: User[];
|
|
361
|
+
/** Total number of users matching the filters. */
|
|
362
|
+
total: number;
|
|
363
|
+
/** Whether another page is available. */
|
|
364
|
+
hasMore: boolean;
|
|
365
|
+
}
|
|
287
366
|
|
|
288
367
|
/** Visual status literals for an announcement payload. */
|
|
289
368
|
type AnnouncementVisualStatus = 'success' | 'alert' | 'warning' | 'custom';
|
|
@@ -488,4 +567,4 @@ interface ValidateTwoFactorOtpResponse {
|
|
|
488
567
|
validate: boolean;
|
|
489
568
|
}
|
|
490
569
|
|
|
491
|
-
export type { ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementAppearance, AnnouncementButton, AnnouncementCompany, AnnouncementListFilters, AnnouncementListResponse, AnnouncementPayload, AnnouncementTargetingRuleUrl, AnnouncementTargetingRules, AnnouncementType, AnnouncementVisualStatus, CompanyBooleanConfigKey, CompanyConfigKey, CompanyConfigResponse, CompanyData, CompanyQueue, CompanyResponse, CompanyStringConfigKey, CompanyWithConfigsResponse, CreateAnnouncementRequest, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse, GetSupportWidgetIdResponse, GetUserByIdResponse, ManagedUser, StrongPasswordOptions, StrongPasswordOptionsResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCompanyBooleanConfigRequest, UpdateCompanyRequest, UpdateCompanyStringConfigRequest, UpdateCompanyUserAvatarResponse, UpdateCompanyUserRequest, UpdateSupportWidgetIdRequest, UpdateSupportWidgetIdResponse, UpdateUserPasswordRequest, UpdateUserPasswordResponse, User, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, WorkGroup, WorkGroupListResponse, WorkGroupMember, WorkGroupMembersResponse, WorkGroupResponse };
|
|
570
|
+
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 };
|
package/dist/index.d.mts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { AxiosInstance } from 'axios';
|
|
2
|
-
import { CompanyResponse, UpdateCompanyRequest, GetSupportWidgetIdResponse, UpdateSupportWidgetIdRequest, UpdateSupportWidgetIdResponse, CompanyQueue, CompanyWithConfigsResponse, StrongPasswordOptionsResponse, CompanyConfigKey, CompanyConfigResponse,
|
|
3
|
-
export { AnnouncementAppearance, AnnouncementButton, AnnouncementCompany, AnnouncementPayload, AnnouncementTargetingRuleUrl, AnnouncementTargetingRules, AnnouncementVisualStatus, CompanyData, ManagedUser, WorkGroup, WorkGroupMember } 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, 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
|
+
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';
|
|
6
6
|
import { CampaignQueryParams, CampaignPaginatedResponse, Campaign, CreateCampaignRequest, PatchCampaignRequest, CampaignContactQueryParams, CampaignContactPaginatedResponse, CampaignContactResponse, CreateCampaignContactRequest, PatchCampaignContactRequest, CampaignContactsDashboardQueryParams, CampaignContactsDashboardData, CampaignUser, CampaignWorkGroupQueryParams, CampaignWorkGroupPaginatedResponse, CreateCampaignWorkGroupRequest, CampaignWorkGroup, CampaignCompanyQueryParams, CampaignCompanyPaginatedResponse, CampaignCompanyResponse, EnableCampaignCompanyRequest, CampaignAccessResponse } from './campaigns/contracts/index.mjs';
|
|
@@ -79,11 +79,12 @@ declare class CustomerServiceGateway {
|
|
|
79
79
|
*/
|
|
80
80
|
getStrongPasswordOptions(companyId: string): Promise<StrongPasswordOptionsResponse>;
|
|
81
81
|
/**
|
|
82
|
-
* Updates
|
|
83
|
-
* @param
|
|
84
|
-
* @
|
|
82
|
+
* Updates a JSON company config by key.
|
|
83
|
+
* @param key - The config key to update.
|
|
84
|
+
* @param payload - The JSON value to set.
|
|
85
|
+
* @returns The updated company config entry.
|
|
85
86
|
*/
|
|
86
|
-
|
|
87
|
+
updateCompanyJsonConfig(key: CompanyJsonConfigKey, payload: UpdateCompanyJsonConfigRequest): Promise<CompanyConfigResponse>;
|
|
87
88
|
/**
|
|
88
89
|
* Updates a boolean company config by key.
|
|
89
90
|
* @param key - The config key to update.
|
|
@@ -104,6 +105,13 @@ declare class CustomerServiceGateway {
|
|
|
104
105
|
* @returns The user data.
|
|
105
106
|
*/
|
|
106
107
|
getUserByLogin(email: string): Promise<User>;
|
|
108
|
+
/**
|
|
109
|
+
* Lists company users with filters, pagination and optional associations.
|
|
110
|
+
* Company is resolved from the authenticated token, or from `companyId` when the token has none.
|
|
111
|
+
* @param query - Pagination, filters and `include` associations.
|
|
112
|
+
* @returns Paginated users.
|
|
113
|
+
*/
|
|
114
|
+
listUsers(query?: ListUsersRequest): Promise<ListUsersResponse>;
|
|
107
115
|
/**
|
|
108
116
|
* Retrieves all work groups for a company.
|
|
109
117
|
* @param companyId - The unique identifier of the company.
|
|
@@ -920,4 +928,4 @@ declare const configure: (params: GatewayClientParams) => void;
|
|
|
920
928
|
*/
|
|
921
929
|
declare function gateway<T extends keyof GatewayMap>(service: T): GatewayMap[T];
|
|
922
930
|
|
|
923
|
-
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, CommentHistoryPage, CompanyAccessPackageItem, CompanyBooleanConfigKey, CompanyConfigKey, CompanyConfigResponse, 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, 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,
|
|
931
|
+
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, 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 };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { AxiosInstance } from 'axios';
|
|
2
|
-
import { CompanyResponse, UpdateCompanyRequest, GetSupportWidgetIdResponse, UpdateSupportWidgetIdRequest, UpdateSupportWidgetIdResponse, CompanyQueue, CompanyWithConfigsResponse, StrongPasswordOptionsResponse, CompanyConfigKey, CompanyConfigResponse,
|
|
3
|
-
export { AnnouncementAppearance, AnnouncementButton, AnnouncementCompany, AnnouncementPayload, AnnouncementTargetingRuleUrl, AnnouncementTargetingRules, AnnouncementVisualStatus, CompanyData, ManagedUser, WorkGroup, WorkGroupMember } 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, 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
|
+
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';
|
|
6
6
|
import { CampaignQueryParams, CampaignPaginatedResponse, Campaign, CreateCampaignRequest, PatchCampaignRequest, CampaignContactQueryParams, CampaignContactPaginatedResponse, CampaignContactResponse, CreateCampaignContactRequest, PatchCampaignContactRequest, CampaignContactsDashboardQueryParams, CampaignContactsDashboardData, CampaignUser, CampaignWorkGroupQueryParams, CampaignWorkGroupPaginatedResponse, CreateCampaignWorkGroupRequest, CampaignWorkGroup, CampaignCompanyQueryParams, CampaignCompanyPaginatedResponse, CampaignCompanyResponse, EnableCampaignCompanyRequest, CampaignAccessResponse } from './campaigns/contracts/index.js';
|
|
@@ -79,11 +79,12 @@ declare class CustomerServiceGateway {
|
|
|
79
79
|
*/
|
|
80
80
|
getStrongPasswordOptions(companyId: string): Promise<StrongPasswordOptionsResponse>;
|
|
81
81
|
/**
|
|
82
|
-
* Updates
|
|
83
|
-
* @param
|
|
84
|
-
* @
|
|
82
|
+
* Updates a JSON company config by key.
|
|
83
|
+
* @param key - The config key to update.
|
|
84
|
+
* @param payload - The JSON value to set.
|
|
85
|
+
* @returns The updated company config entry.
|
|
85
86
|
*/
|
|
86
|
-
|
|
87
|
+
updateCompanyJsonConfig(key: CompanyJsonConfigKey, payload: UpdateCompanyJsonConfigRequest): Promise<CompanyConfigResponse>;
|
|
87
88
|
/**
|
|
88
89
|
* Updates a boolean company config by key.
|
|
89
90
|
* @param key - The config key to update.
|
|
@@ -104,6 +105,13 @@ declare class CustomerServiceGateway {
|
|
|
104
105
|
* @returns The user data.
|
|
105
106
|
*/
|
|
106
107
|
getUserByLogin(email: string): Promise<User>;
|
|
108
|
+
/**
|
|
109
|
+
* Lists company users with filters, pagination and optional associations.
|
|
110
|
+
* Company is resolved from the authenticated token, or from `companyId` when the token has none.
|
|
111
|
+
* @param query - Pagination, filters and `include` associations.
|
|
112
|
+
* @returns Paginated users.
|
|
113
|
+
*/
|
|
114
|
+
listUsers(query?: ListUsersRequest): Promise<ListUsersResponse>;
|
|
107
115
|
/**
|
|
108
116
|
* Retrieves all work groups for a company.
|
|
109
117
|
* @param companyId - The unique identifier of the company.
|
|
@@ -920,4 +928,4 @@ declare const configure: (params: GatewayClientParams) => void;
|
|
|
920
928
|
*/
|
|
921
929
|
declare function gateway<T extends keyof GatewayMap>(service: T): GatewayMap[T];
|
|
922
930
|
|
|
923
|
-
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, CommentHistoryPage, CompanyAccessPackageItem, CompanyBooleanConfigKey, CompanyConfigKey, CompanyConfigResponse, 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, 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,
|
|
931
|
+
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, 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 };
|
package/dist/index.js
CHANGED
|
@@ -119,13 +119,14 @@ var CustomerServiceGateway = class {
|
|
|
119
119
|
return data;
|
|
120
120
|
}
|
|
121
121
|
/**
|
|
122
|
-
* Updates
|
|
123
|
-
* @param
|
|
124
|
-
* @
|
|
122
|
+
* Updates a JSON company config by key.
|
|
123
|
+
* @param key - The config key to update.
|
|
124
|
+
* @param payload - The JSON value to set.
|
|
125
|
+
* @returns The updated company config entry.
|
|
125
126
|
*/
|
|
126
|
-
async
|
|
127
|
+
async updateCompanyJsonConfig(key, payload) {
|
|
127
128
|
const { data } = await this.httpClient.put(
|
|
128
|
-
`${this.baseUrl}/companies/configs
|
|
129
|
+
`${this.baseUrl}/companies/configs/${key}`,
|
|
129
130
|
payload
|
|
130
131
|
);
|
|
131
132
|
return data;
|
|
@@ -165,6 +166,18 @@ var CustomerServiceGateway = class {
|
|
|
165
166
|
const { data } = await this.httpClient.get(`${this.baseUrl}/users/login/${email}`);
|
|
166
167
|
return data;
|
|
167
168
|
}
|
|
169
|
+
/**
|
|
170
|
+
* Lists company users with filters, pagination and optional associations.
|
|
171
|
+
* Company is resolved from the authenticated token, or from `companyId` when the token has none.
|
|
172
|
+
* @param query - Pagination, filters and `include` associations.
|
|
173
|
+
* @returns Paginated users.
|
|
174
|
+
*/
|
|
175
|
+
async listUsers(query) {
|
|
176
|
+
const { data } = await this.httpClient.get(`${this.baseUrl}/users`, {
|
|
177
|
+
params: query
|
|
178
|
+
});
|
|
179
|
+
return data;
|
|
180
|
+
}
|
|
168
181
|
/**
|
|
169
182
|
* Retrieves all work groups for a company.
|
|
170
183
|
* @param companyId - The unique identifier of the company.
|