@opens/gateways 1.15.3 → 1.15.5

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.
@@ -60,6 +60,7 @@ interface WorkGroupResponse {
60
60
  /** Response returned by the Customer Service API when fetching members of a work group. */
61
61
  type WorkGroupMembersResponse = WorkGroupMember[];
62
62
 
63
+ /** User entity returned by the Customer Service API. */
63
64
  interface User {
64
65
  id: string;
65
66
  username: string;
@@ -71,6 +72,35 @@ interface User {
71
72
  companyId: string;
72
73
  createdAt: string;
73
74
  updatedAt: string;
75
+ password?: string;
76
+ language?: string;
77
+ access_token?: string;
78
+ occupation?: string | null;
79
+ endpoint?: string;
80
+ phone_number?: string | null;
81
+ usercode?: number;
82
+ redefine_code?: number;
83
+ redefine_expires?: string;
84
+ state?: string;
85
+ pause?: string | null;
86
+ last_event_time?: string | null;
87
+ oncall?: boolean;
88
+ ringing?: boolean;
89
+ callnumber?: string;
90
+ timezone?: string;
91
+ utc?: string;
92
+ peer_create?: string;
93
+ token_id?: string;
94
+ tech_channel?: string;
95
+ bad_password?: number | null;
96
+ block_status?: string;
97
+ two_auth_mail?: boolean;
98
+ two_auth_otp?: boolean;
99
+ otp_key?: string | null;
100
+ watching?: boolean;
101
+ trial?: boolean;
102
+ ringing_sound?: string;
103
+ company_id?: string;
74
104
  }
75
105
  interface GetAllUsersParams {
76
106
  status?: string;
@@ -91,6 +121,32 @@ interface ManagedUser {
91
121
  updatedAt: string;
92
122
  }
93
123
  type GetManagedUsersResponse = ManagedUser[];
124
+ /** Request payload for updating a company user. */
125
+ interface UpdateCompanyUserRequest {
126
+ username: string;
127
+ occupation: string;
128
+ email: string;
129
+ two_auth_mail?: boolean;
130
+ two_auth_otp?: boolean;
131
+ }
132
+ /** Request payload for updating the current user's password. */
133
+ interface UpdateUserPasswordRequest {
134
+ password: string;
135
+ new_password: string;
136
+ }
137
+ /** Response returned by the Customer Service API when updating a user password. */
138
+ interface UpdateUserPasswordResponse {
139
+ user: {
140
+ id: string;
141
+ password: string;
142
+ company_id: string;
143
+ updatedAt: string;
144
+ };
145
+ }
146
+ /** Response returned by the Customer Service API when updating a company user avatar. */
147
+ interface UpdateCompanyUserAvatarResponse {
148
+ success: boolean;
149
+ }
94
150
 
95
151
  /** Visual status literals for an announcement payload. */
96
152
  type AnnouncementVisualStatus = 'success' | 'alert' | 'warning' | 'custom';
@@ -277,4 +333,22 @@ interface ActiveAnnouncement {
277
333
  payload: AnnouncementPayload;
278
334
  }
279
335
 
280
- export type { ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementAppearance, AnnouncementButton, AnnouncementCompany, AnnouncementListFilters, AnnouncementListResponse, AnnouncementPayload, AnnouncementTargetingRuleUrl, AnnouncementTargetingRules, AnnouncementType, AnnouncementVisualStatus, CompanyData, CompanyResponse, CreateAnnouncementRequest, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse, ManagedUser, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, User, WorkGroup, WorkGroupListResponse, WorkGroupMember, WorkGroupMembersResponse, WorkGroupResponse };
336
+ /** Request payload for generating a two-factor OTP secret URL. */
337
+ interface GenerateTwoFactorOtpRequest {
338
+ userId: string;
339
+ }
340
+ /** Response returned when generating a two-factor OTP secret URL. */
341
+ interface GenerateTwoFactorOtpResponse {
342
+ url: string;
343
+ }
344
+ /** Request payload for validating a two-factor OTP code. */
345
+ interface ValidateTwoFactorOtpRequest {
346
+ userId: string;
347
+ code: string;
348
+ }
349
+ /** Response returned when validating a two-factor OTP code. */
350
+ interface ValidateTwoFactorOtpResponse {
351
+ validate: boolean;
352
+ }
353
+
354
+ export type { ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementAppearance, AnnouncementButton, AnnouncementCompany, AnnouncementListFilters, AnnouncementListResponse, AnnouncementPayload, AnnouncementTargetingRuleUrl, AnnouncementTargetingRules, AnnouncementType, AnnouncementVisualStatus, CompanyData, CompanyResponse, CreateAnnouncementRequest, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse, ManagedUser, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCompanyUserAvatarResponse, UpdateCompanyUserRequest, UpdateUserPasswordRequest, UpdateUserPasswordResponse, User, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, WorkGroup, WorkGroupListResponse, WorkGroupMember, WorkGroupMembersResponse, WorkGroupResponse };
@@ -60,6 +60,7 @@ interface WorkGroupResponse {
60
60
  /** Response returned by the Customer Service API when fetching members of a work group. */
61
61
  type WorkGroupMembersResponse = WorkGroupMember[];
62
62
 
63
+ /** User entity returned by the Customer Service API. */
63
64
  interface User {
64
65
  id: string;
65
66
  username: string;
@@ -71,6 +72,35 @@ interface User {
71
72
  companyId: string;
72
73
  createdAt: string;
73
74
  updatedAt: string;
75
+ password?: string;
76
+ language?: string;
77
+ access_token?: string;
78
+ occupation?: string | null;
79
+ endpoint?: string;
80
+ phone_number?: string | null;
81
+ usercode?: number;
82
+ redefine_code?: number;
83
+ redefine_expires?: string;
84
+ state?: string;
85
+ pause?: string | null;
86
+ last_event_time?: string | null;
87
+ oncall?: boolean;
88
+ ringing?: boolean;
89
+ callnumber?: string;
90
+ timezone?: string;
91
+ utc?: string;
92
+ peer_create?: string;
93
+ token_id?: string;
94
+ tech_channel?: string;
95
+ bad_password?: number | null;
96
+ block_status?: string;
97
+ two_auth_mail?: boolean;
98
+ two_auth_otp?: boolean;
99
+ otp_key?: string | null;
100
+ watching?: boolean;
101
+ trial?: boolean;
102
+ ringing_sound?: string;
103
+ company_id?: string;
74
104
  }
75
105
  interface GetAllUsersParams {
76
106
  status?: string;
@@ -91,6 +121,32 @@ interface ManagedUser {
91
121
  updatedAt: string;
92
122
  }
93
123
  type GetManagedUsersResponse = ManagedUser[];
124
+ /** Request payload for updating a company user. */
125
+ interface UpdateCompanyUserRequest {
126
+ username: string;
127
+ occupation: string;
128
+ email: string;
129
+ two_auth_mail?: boolean;
130
+ two_auth_otp?: boolean;
131
+ }
132
+ /** Request payload for updating the current user's password. */
133
+ interface UpdateUserPasswordRequest {
134
+ password: string;
135
+ new_password: string;
136
+ }
137
+ /** Response returned by the Customer Service API when updating a user password. */
138
+ interface UpdateUserPasswordResponse {
139
+ user: {
140
+ id: string;
141
+ password: string;
142
+ company_id: string;
143
+ updatedAt: string;
144
+ };
145
+ }
146
+ /** Response returned by the Customer Service API when updating a company user avatar. */
147
+ interface UpdateCompanyUserAvatarResponse {
148
+ success: boolean;
149
+ }
94
150
 
95
151
  /** Visual status literals for an announcement payload. */
96
152
  type AnnouncementVisualStatus = 'success' | 'alert' | 'warning' | 'custom';
@@ -277,4 +333,22 @@ interface ActiveAnnouncement {
277
333
  payload: AnnouncementPayload;
278
334
  }
279
335
 
280
- export type { ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementAppearance, AnnouncementButton, AnnouncementCompany, AnnouncementListFilters, AnnouncementListResponse, AnnouncementPayload, AnnouncementTargetingRuleUrl, AnnouncementTargetingRules, AnnouncementType, AnnouncementVisualStatus, CompanyData, CompanyResponse, CreateAnnouncementRequest, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse, ManagedUser, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, User, WorkGroup, WorkGroupListResponse, WorkGroupMember, WorkGroupMembersResponse, WorkGroupResponse };
336
+ /** Request payload for generating a two-factor OTP secret URL. */
337
+ interface GenerateTwoFactorOtpRequest {
338
+ userId: string;
339
+ }
340
+ /** Response returned when generating a two-factor OTP secret URL. */
341
+ interface GenerateTwoFactorOtpResponse {
342
+ url: string;
343
+ }
344
+ /** Request payload for validating a two-factor OTP code. */
345
+ interface ValidateTwoFactorOtpRequest {
346
+ userId: string;
347
+ code: string;
348
+ }
349
+ /** Response returned when validating a two-factor OTP code. */
350
+ interface ValidateTwoFactorOtpResponse {
351
+ validate: boolean;
352
+ }
353
+
354
+ export type { ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementAppearance, AnnouncementButton, AnnouncementCompany, AnnouncementListFilters, AnnouncementListResponse, AnnouncementPayload, AnnouncementTargetingRuleUrl, AnnouncementTargetingRules, AnnouncementType, AnnouncementVisualStatus, CompanyData, CompanyResponse, CreateAnnouncementRequest, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse, ManagedUser, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCompanyUserAvatarResponse, UpdateCompanyUserRequest, UpdateUserPasswordRequest, UpdateUserPasswordResponse, User, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, WorkGroup, WorkGroupListResponse, WorkGroupMember, WorkGroupMembersResponse, WorkGroupResponse };
@@ -1 +1 @@
1
- {"version":3,"sources":["../../../src/customer-service/contracts/index.ts"],"sourcesContent":["export * from './work-group';\nexport * from './company';\nexport * from './user';\nexport * from './announcement';"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
1
+ {"version":3,"sources":["../../../src/customer-service/contracts/index.ts"],"sourcesContent":["export * from './work-group';\nexport * from './company';\nexport * from './user';\nexport * from './announcement';\nexport * from './authenticate';\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
package/dist/index.d.mts CHANGED
@@ -1,6 +1,6 @@
1
1
  import { AxiosInstance } from 'axios';
2
- import { CompanyResponse, WorkGroupListResponse, WorkGroupResponse, WorkGroupMembersResponse, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse, 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, ManagedUser, User, WorkGroup, WorkGroupMember } from './customer-service/contracts/index.mjs';
2
+ import { CompanyResponse, WorkGroupListResponse, WorkGroupResponse, WorkGroupMembersResponse, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse, UpdateCompanyUserRequest, User, 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, ManagedUser, WorkGroup, WorkGroupMember } from './customer-service/contracts/index.mjs';
4
4
  import { ProviderListResponse, 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 { Config, 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';
@@ -59,6 +59,38 @@ declare class CustomerServiceGateway {
59
59
  getWorkGroupMembers(groupId: string, companyId?: string, profile?: string[]): Promise<WorkGroupMembersResponse>;
60
60
  getAllUsers(params?: GetAllUsersParams): Promise<GetAllUsersResponse>;
61
61
  getManagedUsers(managerId: string): Promise<GetManagedUsersResponse>;
62
+ /**
63
+ * Updates a company user by its unique identifier.
64
+ * @param userId - The unique identifier of the user.
65
+ * @param payload - The user fields to update.
66
+ * @returns The updated user data.
67
+ */
68
+ updateCompanyUser(userId: string, payload: UpdateCompanyUserRequest): Promise<User>;
69
+ /**
70
+ * Updates the current user's password.
71
+ * @param payload - The current password and the new password.
72
+ * @returns The updated user password data.
73
+ */
74
+ updateUserPassword(payload: UpdateUserPasswordRequest): Promise<UpdateUserPasswordResponse>;
75
+ /**
76
+ * Updates a company user's avatar image.
77
+ * @param userId - The unique identifier of the user.
78
+ * @param formData - Multipart form data containing the `avatar` file field.
79
+ * @returns Whether the avatar was updated successfully.
80
+ */
81
+ updateCompanyUserAvatar(userId: string, formData: any): Promise<UpdateCompanyUserAvatarResponse>;
82
+ /**
83
+ * Generates a two-factor OTP secret URL for a user.
84
+ * @param payload - The user identifier.
85
+ * @returns The OTP provisioning URL.
86
+ */
87
+ generateTwoFactorOtp(payload: GenerateTwoFactorOtpRequest): Promise<GenerateTwoFactorOtpResponse>;
88
+ /**
89
+ * Validates a two-factor OTP code for a user.
90
+ * @param payload - The user identifier and OTP code.
91
+ * @returns Whether the OTP code is valid.
92
+ */
93
+ validateTwoFactorOtp(payload: ValidateTwoFactorOtpRequest): Promise<ValidateTwoFactorOtpResponse>;
62
94
  /**
63
95
  * Logs out the current user.
64
96
  */
@@ -764,4 +796,4 @@ declare const configure: (params: GatewayClientParams) => void;
764
796
  */
765
797
  declare function gateway<T extends keyof GatewayMap>(service: T): GatewayMap[T];
766
798
 
767
- export { AccessPackage, ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementListFilters, AnnouncementListResponse, AnnouncementType, AttachmentByIdResponse, AudioConvertResponse, AutomationPartner, AutomationPartnerAction, Campaign, CampaignAccessResponse, CampaignCompanyPaginatedResponse, CampaignCompanyQueryParams, CampaignCompanyResponse, CampaignContactPaginatedResponse, CampaignContactQueryParams, CampaignContactResponse, CampaignContactsDashboardData, CampaignContactsDashboardQueryParams, CampaignPaginatedResponse, CampaignQueryParams, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CancelInvitationRequest, CaseFeedByActionItem, CasePermissions, CaseTimeEntry, CommentHistoryPage, CompanyAccessPackageItem, CompanyResource, CompanyResponse, ConfigListByProviderResponse, ContactCategoryResponse, ContactHistoryResponse, ContactPhoneSearchResponse, CreateAnnouncementRequest, CreateAutomationPartnerRequest, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, CreateCompanyAccessPackagePayload, CreateIntegrationActionRequest, CreateIntegrationFieldRequest, CreateIntegrationPartnerRequest, CreateTimeEntryRequest, CreateWebhookRequest$1 as CreateWebhookRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, DeleteTimeEntryRequest, EnableCampaignCompanyRequest, FindOrCreateQueueRuleRequest, GetAccessPackagesParams, GetAllUsersParams, GetAllUsersResponse, GetAttachmentByIdRequest, GetAutomationPartnerRequest, GetCaseFeedByActionsRequest, GetCommentHistoryRequest, GetCompanyAccessPackagesParams, GetCompanyResourcesParams, GetConfigTemplatesParams, GetConfigTemplatesResponse, GetConfigsByProviderParams, GetContactPhonesParams, GetInitialContextRequest, GetInitialContextResponse, GetIntegrationHooksCatalogRequest, GetIntegrationPartnersByCompanyRequest, GetManagedUsersResponse, GetMemberQueuesRequest, GetMessagesByCursorRequest, GetMessagesByCursorResponse, GetPresignedUrlRequest, GetProviderConfigurationsParams, GetProviderDisplayInfoParams, GetRoomByIdRequest, GetRootRulesRequest, GetServiceGroupsParams, GetWebhooksByCompanyRequest$1 as GetWebhooksByCompanyRequest, HookCatalogItem, IntegrationAction, IntegrationField, IntegrationPartner, InvitationResponse, ListAutomationActionsRequest, ListAutomationPartnersRequest, ListCasesRequest, ListCasesResponse, ListContactHistoryRequest, ListInvitationsRequest, ListLiveUserRoomsRequest, ListTimeEntriesPage, ListTimeEntriesRequest, LiveUserRoomResponse, MarkMessagesAsReadRequest, MarkMessagesAsReadResponse, MessageResponse, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, PaginatedResult, PatchCampaignContactRequest, PatchCampaignRequest, ProviderConfigurationsResponse, ProviderDisplayInfoResponse, ProviderListResponse, Queue, QueueMember, QueueRule, ReplyInvitationRequest, RoomMemberResponse, RoomResponse, RootRulesResponse, SERVICE_GATEWAYS, SERVICE_GATEWAYS as SERVICE_GATEWAYS_TYPE, SendAttachmentMessageResponse, SendMessageRequest, ServiceGroupsResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCasePermissionsRequest, UpdateCompanyAccessPackagePayload, UpdateIntegrationActionParams, UpdateIntegrationFieldParams, UpdateMemberInRoomRequest, UpdateTimeEntryRequest, UploadPresignedUrlResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };
799
+ export { AccessPackage, ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementListFilters, AnnouncementListResponse, AnnouncementType, AttachmentByIdResponse, AudioConvertResponse, AutomationPartner, AutomationPartnerAction, Campaign, CampaignAccessResponse, CampaignCompanyPaginatedResponse, CampaignCompanyQueryParams, CampaignCompanyResponse, CampaignContactPaginatedResponse, CampaignContactQueryParams, CampaignContactResponse, CampaignContactsDashboardData, CampaignContactsDashboardQueryParams, CampaignPaginatedResponse, CampaignQueryParams, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CancelInvitationRequest, CaseFeedByActionItem, CasePermissions, CaseTimeEntry, CommentHistoryPage, CompanyAccessPackageItem, CompanyResource, CompanyResponse, ConfigListByProviderResponse, ContactCategoryResponse, ContactHistoryResponse, ContactPhoneSearchResponse, CreateAnnouncementRequest, CreateAutomationPartnerRequest, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, CreateCompanyAccessPackagePayload, CreateIntegrationActionRequest, CreateIntegrationFieldRequest, CreateIntegrationPartnerRequest, CreateTimeEntryRequest, CreateWebhookRequest$1 as CreateWebhookRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, DeleteTimeEntryRequest, EnableCampaignCompanyRequest, FindOrCreateQueueRuleRequest, 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, 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, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCasePermissionsRequest, UpdateCompanyAccessPackagePayload, UpdateCompanyUserAvatarResponse, UpdateCompanyUserRequest, UpdateIntegrationActionParams, UpdateIntegrationFieldParams, UpdateMemberInRoomRequest, 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, WorkGroupListResponse, WorkGroupResponse, WorkGroupMembersResponse, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse, 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, ManagedUser, User, WorkGroup, WorkGroupMember } from './customer-service/contracts/index.js';
2
+ import { CompanyResponse, WorkGroupListResponse, WorkGroupResponse, WorkGroupMembersResponse, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse, UpdateCompanyUserRequest, User, 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, ManagedUser, WorkGroup, WorkGroupMember } from './customer-service/contracts/index.js';
4
4
  import { ProviderListResponse, 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 { Config, 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';
@@ -59,6 +59,38 @@ declare class CustomerServiceGateway {
59
59
  getWorkGroupMembers(groupId: string, companyId?: string, profile?: string[]): Promise<WorkGroupMembersResponse>;
60
60
  getAllUsers(params?: GetAllUsersParams): Promise<GetAllUsersResponse>;
61
61
  getManagedUsers(managerId: string): Promise<GetManagedUsersResponse>;
62
+ /**
63
+ * Updates a company user by its unique identifier.
64
+ * @param userId - The unique identifier of the user.
65
+ * @param payload - The user fields to update.
66
+ * @returns The updated user data.
67
+ */
68
+ updateCompanyUser(userId: string, payload: UpdateCompanyUserRequest): Promise<User>;
69
+ /**
70
+ * Updates the current user's password.
71
+ * @param payload - The current password and the new password.
72
+ * @returns The updated user password data.
73
+ */
74
+ updateUserPassword(payload: UpdateUserPasswordRequest): Promise<UpdateUserPasswordResponse>;
75
+ /**
76
+ * Updates a company user's avatar image.
77
+ * @param userId - The unique identifier of the user.
78
+ * @param formData - Multipart form data containing the `avatar` file field.
79
+ * @returns Whether the avatar was updated successfully.
80
+ */
81
+ updateCompanyUserAvatar(userId: string, formData: any): Promise<UpdateCompanyUserAvatarResponse>;
82
+ /**
83
+ * Generates a two-factor OTP secret URL for a user.
84
+ * @param payload - The user identifier.
85
+ * @returns The OTP provisioning URL.
86
+ */
87
+ generateTwoFactorOtp(payload: GenerateTwoFactorOtpRequest): Promise<GenerateTwoFactorOtpResponse>;
88
+ /**
89
+ * Validates a two-factor OTP code for a user.
90
+ * @param payload - The user identifier and OTP code.
91
+ * @returns Whether the OTP code is valid.
92
+ */
93
+ validateTwoFactorOtp(payload: ValidateTwoFactorOtpRequest): Promise<ValidateTwoFactorOtpResponse>;
62
94
  /**
63
95
  * Logs out the current user.
64
96
  */
@@ -764,4 +796,4 @@ declare const configure: (params: GatewayClientParams) => void;
764
796
  */
765
797
  declare function gateway<T extends keyof GatewayMap>(service: T): GatewayMap[T];
766
798
 
767
- export { AccessPackage, ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementListFilters, AnnouncementListResponse, AnnouncementType, AttachmentByIdResponse, AudioConvertResponse, AutomationPartner, AutomationPartnerAction, Campaign, CampaignAccessResponse, CampaignCompanyPaginatedResponse, CampaignCompanyQueryParams, CampaignCompanyResponse, CampaignContactPaginatedResponse, CampaignContactQueryParams, CampaignContactResponse, CampaignContactsDashboardData, CampaignContactsDashboardQueryParams, CampaignPaginatedResponse, CampaignQueryParams, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CancelInvitationRequest, CaseFeedByActionItem, CasePermissions, CaseTimeEntry, CommentHistoryPage, CompanyAccessPackageItem, CompanyResource, CompanyResponse, ConfigListByProviderResponse, ContactCategoryResponse, ContactHistoryResponse, ContactPhoneSearchResponse, CreateAnnouncementRequest, CreateAutomationPartnerRequest, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, CreateCompanyAccessPackagePayload, CreateIntegrationActionRequest, CreateIntegrationFieldRequest, CreateIntegrationPartnerRequest, CreateTimeEntryRequest, CreateWebhookRequest$1 as CreateWebhookRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, DeleteTimeEntryRequest, EnableCampaignCompanyRequest, FindOrCreateQueueRuleRequest, GetAccessPackagesParams, GetAllUsersParams, GetAllUsersResponse, GetAttachmentByIdRequest, GetAutomationPartnerRequest, GetCaseFeedByActionsRequest, GetCommentHistoryRequest, GetCompanyAccessPackagesParams, GetCompanyResourcesParams, GetConfigTemplatesParams, GetConfigTemplatesResponse, GetConfigsByProviderParams, GetContactPhonesParams, GetInitialContextRequest, GetInitialContextResponse, GetIntegrationHooksCatalogRequest, GetIntegrationPartnersByCompanyRequest, GetManagedUsersResponse, GetMemberQueuesRequest, GetMessagesByCursorRequest, GetMessagesByCursorResponse, GetPresignedUrlRequest, GetProviderConfigurationsParams, GetProviderDisplayInfoParams, GetRoomByIdRequest, GetRootRulesRequest, GetServiceGroupsParams, GetWebhooksByCompanyRequest$1 as GetWebhooksByCompanyRequest, HookCatalogItem, IntegrationAction, IntegrationField, IntegrationPartner, InvitationResponse, ListAutomationActionsRequest, ListAutomationPartnersRequest, ListCasesRequest, ListCasesResponse, ListContactHistoryRequest, ListInvitationsRequest, ListLiveUserRoomsRequest, ListTimeEntriesPage, ListTimeEntriesRequest, LiveUserRoomResponse, MarkMessagesAsReadRequest, MarkMessagesAsReadResponse, MessageResponse, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, PaginatedResult, PatchCampaignContactRequest, PatchCampaignRequest, ProviderConfigurationsResponse, ProviderDisplayInfoResponse, ProviderListResponse, Queue, QueueMember, QueueRule, ReplyInvitationRequest, RoomMemberResponse, RoomResponse, RootRulesResponse, SERVICE_GATEWAYS, SERVICE_GATEWAYS as SERVICE_GATEWAYS_TYPE, SendAttachmentMessageResponse, SendMessageRequest, ServiceGroupsResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCasePermissionsRequest, UpdateCompanyAccessPackagePayload, UpdateIntegrationActionParams, UpdateIntegrationFieldParams, UpdateMemberInRoomRequest, UpdateTimeEntryRequest, UploadPresignedUrlResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };
799
+ export { AccessPackage, ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementListFilters, AnnouncementListResponse, AnnouncementType, AttachmentByIdResponse, AudioConvertResponse, AutomationPartner, AutomationPartnerAction, Campaign, CampaignAccessResponse, CampaignCompanyPaginatedResponse, CampaignCompanyQueryParams, CampaignCompanyResponse, CampaignContactPaginatedResponse, CampaignContactQueryParams, CampaignContactResponse, CampaignContactsDashboardData, CampaignContactsDashboardQueryParams, CampaignPaginatedResponse, CampaignQueryParams, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CancelInvitationRequest, CaseFeedByActionItem, CasePermissions, CaseTimeEntry, CommentHistoryPage, CompanyAccessPackageItem, CompanyResource, CompanyResponse, ConfigListByProviderResponse, ContactCategoryResponse, ContactHistoryResponse, ContactPhoneSearchResponse, CreateAnnouncementRequest, CreateAutomationPartnerRequest, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, CreateCompanyAccessPackagePayload, CreateIntegrationActionRequest, CreateIntegrationFieldRequest, CreateIntegrationPartnerRequest, CreateTimeEntryRequest, CreateWebhookRequest$1 as CreateWebhookRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, DeleteTimeEntryRequest, EnableCampaignCompanyRequest, FindOrCreateQueueRuleRequest, 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, 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, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCasePermissionsRequest, UpdateCompanyAccessPackagePayload, UpdateCompanyUserAvatarResponse, UpdateCompanyUserRequest, UpdateIntegrationActionParams, UpdateIntegrationFieldParams, UpdateMemberInRoomRequest, UpdateTimeEntryRequest, UpdateUserPasswordRequest, UpdateUserPasswordResponse, UploadPresignedUrlResponse, User, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };
package/dist/index.js CHANGED
@@ -103,6 +103,70 @@ var CustomerServiceGateway = class {
103
103
  const { data } = await this.httpClient.get(`${this.baseUrl}/users/managed/${managerId}`);
104
104
  return data;
105
105
  }
106
+ /**
107
+ * Updates a company user by its unique identifier.
108
+ * @param userId - The unique identifier of the user.
109
+ * @param payload - The user fields to update.
110
+ * @returns The updated user data.
111
+ */
112
+ async updateCompanyUser(userId, payload) {
113
+ const { data } = await this.httpClient.put(`${this.baseUrl}/companies/users/${userId}`, payload);
114
+ return data;
115
+ }
116
+ /**
117
+ * Updates the current user's password.
118
+ * @param payload - The current password and the new password.
119
+ * @returns The updated user password data.
120
+ */
121
+ async updateUserPassword(payload) {
122
+ const { data } = await this.httpClient.put(
123
+ `${this.baseUrl}/companies/users/password`,
124
+ payload
125
+ );
126
+ return data;
127
+ }
128
+ /**
129
+ * Updates a company user's avatar image.
130
+ * @param userId - The unique identifier of the user.
131
+ * @param formData - Multipart form data containing the `avatar` file field.
132
+ * @returns Whether the avatar was updated successfully.
133
+ */
134
+ async updateCompanyUserAvatar(userId, formData) {
135
+ const { data } = await this.httpClient.put(
136
+ `${this.baseUrl}/companies/users/avatar/${userId}`,
137
+ formData,
138
+ {
139
+ headers: {
140
+ "Content-Type": "multipart/form-data"
141
+ }
142
+ }
143
+ );
144
+ return data;
145
+ }
146
+ /**
147
+ * Generates a two-factor OTP secret URL for a user.
148
+ * @param payload - The user identifier.
149
+ * @returns The OTP provisioning URL.
150
+ */
151
+ async generateTwoFactorOtp(payload) {
152
+ const { data } = await this.httpClient.post(
153
+ `${this.baseUrl}/authenticate/twoFactor/otp`,
154
+ payload
155
+ );
156
+ return data;
157
+ }
158
+ /**
159
+ * Validates a two-factor OTP code for a user.
160
+ * @param payload - The user identifier and OTP code.
161
+ * @returns Whether the OTP code is valid.
162
+ */
163
+ async validateTwoFactorOtp(payload) {
164
+ const { data } = await this.httpClient.post(
165
+ `${this.baseUrl}/authenticate/twoFactor/otp/validate`,
166
+ payload
167
+ );
168
+ return data;
169
+ }
106
170
  /**
107
171
  * Logs out the current user.
108
172
  */