@opens/gateways 1.15.14 → 1.15.15

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.
@@ -0,0 +1,12 @@
1
+ /** Call endpoint status returned by the Calls API. */
2
+ type CallEndpointStatus = 'offline' | 'online' | string;
3
+ /** Call endpoint entry returned by the Calls API. */
4
+ interface CallEndpoint {
5
+ endpoint: string;
6
+ status: CallEndpointStatus;
7
+ resource: string;
8
+ technology: string;
9
+ channel_ids: string[];
10
+ }
11
+
12
+ export type { CallEndpoint, CallEndpointStatus };
@@ -0,0 +1,12 @@
1
+ /** Call endpoint status returned by the Calls API. */
2
+ type CallEndpointStatus = 'offline' | 'online' | string;
3
+ /** Call endpoint entry returned by the Calls API. */
4
+ interface CallEndpoint {
5
+ endpoint: string;
6
+ status: CallEndpointStatus;
7
+ resource: string;
8
+ technology: string;
9
+ channel_ids: string[];
10
+ }
11
+
12
+ export type { CallEndpoint, CallEndpointStatus };
@@ -0,0 +1,19 @@
1
+ "use strict";
2
+ var __defProp = Object.defineProperty;
3
+ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
4
+ var __getOwnPropNames = Object.getOwnPropertyNames;
5
+ var __hasOwnProp = Object.prototype.hasOwnProperty;
6
+ var __copyProps = (to, from, except, desc) => {
7
+ if (from && typeof from === "object" || typeof from === "function") {
8
+ for (let key of __getOwnPropNames(from))
9
+ if (!__hasOwnProp.call(to, key) && key !== except)
10
+ __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
11
+ }
12
+ return to;
13
+ };
14
+ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
15
+
16
+ // src/calls/contracts/index.ts
17
+ var contracts_exports = {};
18
+ module.exports = __toCommonJS(contracts_exports);
19
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../../../src/calls/contracts/index.ts"],"sourcesContent":["export * from './endpoint';\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
@@ -0,0 +1 @@
1
+ //# sourceMappingURL=index.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
@@ -20,6 +20,21 @@ interface CompanyData {
20
20
  interface CompanyResponse {
21
21
  company: CompanyData;
22
22
  }
23
+ /** Request payload for updating company settings. */
24
+ interface UpdateCompanyRequest {
25
+ check_bad_password?: boolean;
26
+ limit_bad_password?: number;
27
+ timezone?: string;
28
+ utc?: string;
29
+ }
30
+ /** Request payload for updating the company support widget identifier. */
31
+ interface UpdateSupportWidgetIdRequest {
32
+ support_widget_id: string;
33
+ }
34
+ /** Response returned by the Customer Service API when updating the support widget identifier. */
35
+ interface UpdateSupportWidgetIdResponse {
36
+ company: Pick<CompanyData, 'id' | 'support_widget_id'>;
37
+ }
23
38
 
24
39
  /** Strong password policy options stored in a company config `value_json`. */
25
40
  interface StrongPasswordOptions {
@@ -34,23 +49,100 @@ interface StrongPasswordOptions {
34
49
  /** Minimum password length. */
35
50
  minChars: number;
36
51
  }
37
- /** Response returned by the Customer Service API when fetching strong password options. */
38
- interface StrongPasswordOptionsResponse {
39
- /** Unique identifier of the company config entry. */
52
+ /** Request payload for updating a boolean company config. */
53
+ interface UpdateCompanyBooleanConfigRequest {
54
+ value: boolean;
55
+ }
56
+ /** Request payload for updating a string company config. */
57
+ interface UpdateCompanyStringConfigRequest {
58
+ value: string;
59
+ }
60
+ /** Known company config keys that accept a boolean value. */
61
+ type CompanyBooleanConfigKey = 'mandatory-tag' | 'prevent-tag-edit' | 'inbox-hide-message-enabled' | 'show-deleted-users';
62
+ /** Known company config keys that accept a string value. */
63
+ type CompanyStringConfigKey = 'proxy_ami' | 'snep_password';
64
+ /** Response returned by the Customer Service API for a company config entry. */
65
+ interface CompanyConfigResponse {
40
66
  id: string;
41
- /** Config key, always `"strong-password-options"`. */
42
67
  key: string;
43
- /** String representation of whether the strong password policy is enabled. */
44
- value: string;
45
- /** Structured strong password policy rules. */
46
- value_json: StrongPasswordOptions;
47
- /** Creation timestamp in ISO 8601 format. */
68
+ value: boolean | string | null;
69
+ value_json: StrongPasswordOptions | null;
48
70
  createdAt: string;
49
- /** Last update timestamp in ISO 8601 format. */
50
71
  updatedAt: string;
51
- /** Unique identifier of the company that owns this config. */
52
72
  company_id: string;
53
73
  }
74
+ /** Response returned by the Customer Service API when fetching or updating strong password options. */
75
+ interface StrongPasswordOptionsResponse extends CompanyConfigResponse {
76
+ key: 'strong-password-options';
77
+ value_json: StrongPasswordOptions;
78
+ }
79
+
80
+ /** Queue entry returned by the Customer Service API when listing company queues. */
81
+ interface CompanyQueue {
82
+ name: string;
83
+ musiconhold: string;
84
+ announce: string;
85
+ context: string;
86
+ timeout: string;
87
+ ringinuse: string;
88
+ setinterfacevar: string | null;
89
+ setqueuevar: string | null;
90
+ setqueueentryvar: string | null;
91
+ monitor_format: string | null;
92
+ membermacro: string | null;
93
+ membergosub: string | null;
94
+ queue_youarenext: string;
95
+ queue_thereare: string;
96
+ queue_callswaiting: string;
97
+ queue_quantity1: string | null;
98
+ queue_quantity2: string | null;
99
+ queue_holdtime: string | null;
100
+ queue_minutes: string | null;
101
+ queue_minute: string | null;
102
+ queue_seconds: string | null;
103
+ queue_thankyou: string;
104
+ queue_callerannounce: string | null;
105
+ queue_reporthold: string | null;
106
+ announce_frequency: string;
107
+ announce_to_first_user: string | null;
108
+ min_announce_frequency: string | null;
109
+ announce_round_seconds: string | null;
110
+ announce_holdtime: string | null;
111
+ announce_position: string | null;
112
+ announce_position_limit: string | null;
113
+ periodic_announce: string | null;
114
+ periodic_announce_frequency: string | null;
115
+ relative_periodic_announce: string | null;
116
+ random_periodic_announce: string | null;
117
+ retry: string;
118
+ wrapuptime: string;
119
+ penaltymemberslimit: string | null;
120
+ autofill: string | null;
121
+ monitor_type: string | null;
122
+ autopause: string | null;
123
+ autopausedelay: string | null;
124
+ autopausebusy: string | null;
125
+ autopauseunavail: string | null;
126
+ maxlen: string;
127
+ servicelevel: string;
128
+ strategy: string;
129
+ joinempty: string;
130
+ leavewhenempty: string;
131
+ reportholdtime: string;
132
+ memberdelay: string;
133
+ weight: string;
134
+ timeoutrestart: string | null;
135
+ defaultrule: string | null;
136
+ timeoutpriority: string | null;
137
+ id: string;
138
+ alert_mail: string;
139
+ notify: string;
140
+ csat: string;
141
+ csat_survey_audio: string | null;
142
+ csat_thanks_audio: string | null;
143
+ announce_audio: string | null;
144
+ announce_audio_enabled: string;
145
+ }
54
146
 
55
147
  /** A work group entity nested within {@link WorkGroupListResponse} and {@link WorkGroupResponse}. */
56
148
  interface WorkGroup {
@@ -386,4 +478,4 @@ interface ValidateTwoFactorOtpResponse {
386
478
  validate: boolean;
387
479
  }
388
480
 
389
- export type { ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementAppearance, AnnouncementButton, AnnouncementCompany, AnnouncementListFilters, AnnouncementListResponse, AnnouncementPayload, AnnouncementTargetingRuleUrl, AnnouncementTargetingRules, AnnouncementType, AnnouncementVisualStatus, CompanyData, CompanyResponse, CreateAnnouncementRequest, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse, GetUserByIdResponse, ManagedUser, StrongPasswordOptions, StrongPasswordOptionsResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCompanyUserAvatarResponse, UpdateCompanyUserRequest, UpdateUserPasswordRequest, UpdateUserPasswordResponse, User, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, WorkGroup, WorkGroupListResponse, WorkGroupMember, WorkGroupMembersResponse, WorkGroupResponse };
481
+ export type { ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementAppearance, AnnouncementButton, AnnouncementCompany, AnnouncementListFilters, AnnouncementListResponse, AnnouncementPayload, AnnouncementTargetingRuleUrl, AnnouncementTargetingRules, AnnouncementType, AnnouncementVisualStatus, CompanyBooleanConfigKey, CompanyConfigResponse, CompanyData, CompanyQueue, CompanyResponse, CompanyStringConfigKey, CreateAnnouncementRequest, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse, GetUserByIdResponse, ManagedUser, StrongPasswordOptions, StrongPasswordOptionsResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCompanyBooleanConfigRequest, UpdateCompanyRequest, UpdateCompanyStringConfigRequest, UpdateCompanyUserAvatarResponse, UpdateCompanyUserRequest, UpdateSupportWidgetIdRequest, UpdateSupportWidgetIdResponse, UpdateUserPasswordRequest, UpdateUserPasswordResponse, User, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, WorkGroup, WorkGroupListResponse, WorkGroupMember, WorkGroupMembersResponse, WorkGroupResponse };
@@ -20,6 +20,21 @@ interface CompanyData {
20
20
  interface CompanyResponse {
21
21
  company: CompanyData;
22
22
  }
23
+ /** Request payload for updating company settings. */
24
+ interface UpdateCompanyRequest {
25
+ check_bad_password?: boolean;
26
+ limit_bad_password?: number;
27
+ timezone?: string;
28
+ utc?: string;
29
+ }
30
+ /** Request payload for updating the company support widget identifier. */
31
+ interface UpdateSupportWidgetIdRequest {
32
+ support_widget_id: string;
33
+ }
34
+ /** Response returned by the Customer Service API when updating the support widget identifier. */
35
+ interface UpdateSupportWidgetIdResponse {
36
+ company: Pick<CompanyData, 'id' | 'support_widget_id'>;
37
+ }
23
38
 
24
39
  /** Strong password policy options stored in a company config `value_json`. */
25
40
  interface StrongPasswordOptions {
@@ -34,23 +49,100 @@ interface StrongPasswordOptions {
34
49
  /** Minimum password length. */
35
50
  minChars: number;
36
51
  }
37
- /** Response returned by the Customer Service API when fetching strong password options. */
38
- interface StrongPasswordOptionsResponse {
39
- /** Unique identifier of the company config entry. */
52
+ /** Request payload for updating a boolean company config. */
53
+ interface UpdateCompanyBooleanConfigRequest {
54
+ value: boolean;
55
+ }
56
+ /** Request payload for updating a string company config. */
57
+ interface UpdateCompanyStringConfigRequest {
58
+ value: string;
59
+ }
60
+ /** Known company config keys that accept a boolean value. */
61
+ type CompanyBooleanConfigKey = 'mandatory-tag' | 'prevent-tag-edit' | 'inbox-hide-message-enabled' | 'show-deleted-users';
62
+ /** Known company config keys that accept a string value. */
63
+ type CompanyStringConfigKey = 'proxy_ami' | 'snep_password';
64
+ /** Response returned by the Customer Service API for a company config entry. */
65
+ interface CompanyConfigResponse {
40
66
  id: string;
41
- /** Config key, always `"strong-password-options"`. */
42
67
  key: string;
43
- /** String representation of whether the strong password policy is enabled. */
44
- value: string;
45
- /** Structured strong password policy rules. */
46
- value_json: StrongPasswordOptions;
47
- /** Creation timestamp in ISO 8601 format. */
68
+ value: boolean | string | null;
69
+ value_json: StrongPasswordOptions | null;
48
70
  createdAt: string;
49
- /** Last update timestamp in ISO 8601 format. */
50
71
  updatedAt: string;
51
- /** Unique identifier of the company that owns this config. */
52
72
  company_id: string;
53
73
  }
74
+ /** Response returned by the Customer Service API when fetching or updating strong password options. */
75
+ interface StrongPasswordOptionsResponse extends CompanyConfigResponse {
76
+ key: 'strong-password-options';
77
+ value_json: StrongPasswordOptions;
78
+ }
79
+
80
+ /** Queue entry returned by the Customer Service API when listing company queues. */
81
+ interface CompanyQueue {
82
+ name: string;
83
+ musiconhold: string;
84
+ announce: string;
85
+ context: string;
86
+ timeout: string;
87
+ ringinuse: string;
88
+ setinterfacevar: string | null;
89
+ setqueuevar: string | null;
90
+ setqueueentryvar: string | null;
91
+ monitor_format: string | null;
92
+ membermacro: string | null;
93
+ membergosub: string | null;
94
+ queue_youarenext: string;
95
+ queue_thereare: string;
96
+ queue_callswaiting: string;
97
+ queue_quantity1: string | null;
98
+ queue_quantity2: string | null;
99
+ queue_holdtime: string | null;
100
+ queue_minutes: string | null;
101
+ queue_minute: string | null;
102
+ queue_seconds: string | null;
103
+ queue_thankyou: string;
104
+ queue_callerannounce: string | null;
105
+ queue_reporthold: string | null;
106
+ announce_frequency: string;
107
+ announce_to_first_user: string | null;
108
+ min_announce_frequency: string | null;
109
+ announce_round_seconds: string | null;
110
+ announce_holdtime: string | null;
111
+ announce_position: string | null;
112
+ announce_position_limit: string | null;
113
+ periodic_announce: string | null;
114
+ periodic_announce_frequency: string | null;
115
+ relative_periodic_announce: string | null;
116
+ random_periodic_announce: string | null;
117
+ retry: string;
118
+ wrapuptime: string;
119
+ penaltymemberslimit: string | null;
120
+ autofill: string | null;
121
+ monitor_type: string | null;
122
+ autopause: string | null;
123
+ autopausedelay: string | null;
124
+ autopausebusy: string | null;
125
+ autopauseunavail: string | null;
126
+ maxlen: string;
127
+ servicelevel: string;
128
+ strategy: string;
129
+ joinempty: string;
130
+ leavewhenempty: string;
131
+ reportholdtime: string;
132
+ memberdelay: string;
133
+ weight: string;
134
+ timeoutrestart: string | null;
135
+ defaultrule: string | null;
136
+ timeoutpriority: string | null;
137
+ id: string;
138
+ alert_mail: string;
139
+ notify: string;
140
+ csat: string;
141
+ csat_survey_audio: string | null;
142
+ csat_thanks_audio: string | null;
143
+ announce_audio: string | null;
144
+ announce_audio_enabled: string;
145
+ }
54
146
 
55
147
  /** A work group entity nested within {@link WorkGroupListResponse} and {@link WorkGroupResponse}. */
56
148
  interface WorkGroup {
@@ -386,4 +478,4 @@ interface ValidateTwoFactorOtpResponse {
386
478
  validate: boolean;
387
479
  }
388
480
 
389
- export type { ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementAppearance, AnnouncementButton, AnnouncementCompany, AnnouncementListFilters, AnnouncementListResponse, AnnouncementPayload, AnnouncementTargetingRuleUrl, AnnouncementTargetingRules, AnnouncementType, AnnouncementVisualStatus, CompanyData, CompanyResponse, CreateAnnouncementRequest, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse, GetUserByIdResponse, ManagedUser, StrongPasswordOptions, StrongPasswordOptionsResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCompanyUserAvatarResponse, UpdateCompanyUserRequest, UpdateUserPasswordRequest, UpdateUserPasswordResponse, User, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, WorkGroup, WorkGroupListResponse, WorkGroupMember, WorkGroupMembersResponse, WorkGroupResponse };
481
+ export type { ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementAppearance, AnnouncementButton, AnnouncementCompany, AnnouncementListFilters, AnnouncementListResponse, AnnouncementPayload, AnnouncementTargetingRuleUrl, AnnouncementTargetingRules, AnnouncementType, AnnouncementVisualStatus, CompanyBooleanConfigKey, CompanyConfigResponse, CompanyData, CompanyQueue, CompanyResponse, CompanyStringConfigKey, CreateAnnouncementRequest, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse, GetUserByIdResponse, ManagedUser, StrongPasswordOptions, StrongPasswordOptionsResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCompanyBooleanConfigRequest, UpdateCompanyRequest, UpdateCompanyStringConfigRequest, UpdateCompanyUserAvatarResponse, UpdateCompanyUserRequest, UpdateSupportWidgetIdRequest, UpdateSupportWidgetIdResponse, 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 './company-config';\nexport * from './user';\nexport * from './announcement';\nexport * from './authenticate';\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
1
+ {"version":3,"sources":["../../../src/customer-service/contracts/index.ts"],"sourcesContent":["export * from './work-group';\nexport * from './company';\nexport * from './company-config';\nexport * from './company-queue';\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, StrongPasswordOptionsResponse, User, 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, ManagedUser, StrongPasswordOptions, WorkGroup, WorkGroupMember } from './customer-service/contracts/index.mjs';
2
+ import { CompanyResponse, UpdateCompanyRequest, UpdateSupportWidgetIdRequest, UpdateSupportWidgetIdResponse, CompanyQueue, StrongPasswordOptionsResponse, StrongPasswordOptions, CompanyBooleanConfigKey, UpdateCompanyBooleanConfigRequest, CompanyConfigResponse, CompanyStringConfigKey, UpdateCompanyStringConfigRequest, User, 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, ManagedUser, 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';
@@ -17,6 +17,8 @@ import { ListInvitationsRequest, InvitationResponse, ReplyInvitationRequest, Can
17
17
  export { ForwardMessageDestination, ForwardMessageForwardingMetadata, ForwardMessageMetadata, MessageAttachment, MessageMetadata, MessageReactionResponse, MessageReplyContext, MessageStatusResponse, RoomActiveDates, RoomTagResponse } from './chat-webservice/contracts/index.mjs';
18
18
  import { ListContactHistoryRequest, ContactHistoryResponse } from './call-report/contracts/index.mjs';
19
19
  export { ContactHistoryIndex, ContactHistorySortOrder, ContactInteractionResponse, InteractionCallStepResponse, InteractionChatStepResponse, InteractionMemberResponse, InteractionOrganizationResponse } from './call-report/contracts/index.mjs';
20
+ import { CallEndpoint } from './calls/contracts/index.mjs';
21
+ export { CallEndpointStatus } from './calls/contracts/index.mjs';
20
22
  import { GetCommentHistoryRequest, CommentHistoryPage, CasePermissions, UpdateCasePermissionsRequest, GetCaseFeedByActionsRequest, CaseFeedByActionItem, ListCasesRequest, ListCasesResponse, CreateTimeEntryRequest, CaseTimeEntry, ListTimeEntriesRequest, ListTimeEntriesPage, UpdateTimeEntryRequest, DeleteTimeEntryRequest } from './cases/contracts/index.mjs';
21
23
  export { CaseListItem, CasePermissionsValue, CommentHistoryChangeType, CommentHistoryCursor, CommentHistoryEntry, ListCasesCursor, TimeEntryCursor } from './cases/contracts/index.mjs';
22
24
  import { GetAccessPackagesParams, PaginatedResult, AccessPackage, GetCompanyAccessPackagesParams, CompanyAccessPackageItem, CreateCompanyAccessPackagePayload, UpdateCompanyAccessPackagePayload, GetCompanyResourcesParams, CompanyResource } from './access-hub/contracts/index.mjs';
@@ -36,12 +38,49 @@ declare class CustomerServiceGateway {
36
38
  * @returns The company data wrapped in a {@link CompanyResponse}.
37
39
  */
38
40
  getCompanyById(companyId: string): Promise<CompanyResponse>;
41
+ /**
42
+ * Updates the current company settings.
43
+ * @param payload - The company fields to update.
44
+ * @returns The updated company data wrapped in a {@link CompanyResponse}.
45
+ */
46
+ updateCompany(payload: UpdateCompanyRequest): Promise<CompanyResponse>;
47
+ /**
48
+ * Updates the support widget identifier for the current company.
49
+ * @param payload - The support widget identifier to set.
50
+ * @returns The updated company support widget data.
51
+ */
52
+ updateSupportWidgetId(payload: UpdateSupportWidgetIdRequest): Promise<UpdateSupportWidgetIdResponse>;
53
+ /**
54
+ * Retrieves the list of queues configured for the current company.
55
+ * @returns The company queues.
56
+ */
57
+ getCompanyQueues(): Promise<CompanyQueue[]>;
39
58
  /**
40
59
  * Retrieves the strong password options config for a company.
41
60
  * @param companyId - The unique identifier of the company.
42
61
  * @returns The strong password options company config.
43
62
  */
44
63
  getStrongPasswordOptions(companyId: string): Promise<StrongPasswordOptionsResponse>;
64
+ /**
65
+ * Updates the strong password options config for the current company.
66
+ * @param payload - The strong password policy rules to apply.
67
+ * @returns The updated strong password options company config.
68
+ */
69
+ updateStrongPasswordOptions(payload: StrongPasswordOptions): Promise<StrongPasswordOptionsResponse>;
70
+ /**
71
+ * Updates a boolean company config by key.
72
+ * @param key - The config key to update.
73
+ * @param payload - The boolean value to set.
74
+ * @returns The updated company config entry.
75
+ */
76
+ updateCompanyBooleanConfig(key: CompanyBooleanConfigKey, payload: UpdateCompanyBooleanConfigRequest): Promise<CompanyConfigResponse>;
77
+ /**
78
+ * Updates a string company config by key.
79
+ * @param key - The config key to update.
80
+ * @param payload - The string value to set.
81
+ * @returns The updated company config entry.
82
+ */
83
+ updateCompanyStringConfig(key: CompanyStringConfigKey, payload: UpdateCompanyStringConfigRequest): Promise<CompanyConfigResponse>;
45
84
  /**
46
85
  * Retrieves a user by login email.
47
86
  * @param email - The user email used as login identifier.
@@ -627,6 +666,20 @@ declare class CallReportGateway {
627
666
  listContactHistory(params?: ListContactHistoryRequest): Promise<ContactHistoryResponse>;
628
667
  }
629
668
 
669
+ /**
670
+ * Gateway for interacting with the Calls API.
671
+ */
672
+ declare class CallsGateway {
673
+ private readonly httpClient;
674
+ private readonly baseUrl;
675
+ constructor(httpClient: AxiosInstance, baseUrl: string);
676
+ /**
677
+ * Retrieves all call endpoints and their current status.
678
+ * @returns The list of call endpoints.
679
+ */
680
+ getEndpoints(): Promise<CallEndpoint[]>;
681
+ }
682
+
630
683
  /** Request parameters for retrieving the webhooks scenario for a company. */
631
684
  interface GetWebhooksByCompanyRequest {
632
685
  companyId: string;
@@ -738,6 +791,7 @@ type GatewayMap = {
738
791
  integrations: IntegrationsGateway;
739
792
  'chat-webservice': ChatWebserviceGateway;
740
793
  'call-report': CallReportGateway;
794
+ calls: CallsGateway;
741
795
  cases: CasesGateway;
742
796
  rh: RhGateway;
743
797
  'access-hub': AccessHubGateway;
@@ -780,6 +834,9 @@ interface GatewayClientParams {
780
834
  callReport?: {
781
835
  baseUrl: string;
782
836
  };
837
+ calls?: {
838
+ baseUrl: string;
839
+ };
783
840
  cases?: {
784
841
  baseUrl: string;
785
842
  };
@@ -802,6 +859,7 @@ declare const SERVICE_GATEWAYS: {
802
859
  readonly INTEGRATIONS: "integrations";
803
860
  readonly CHAT_WEBSERVICE: "chat-webservice";
804
861
  readonly CALL_REPORT: "call-report";
862
+ readonly CALLS: "calls";
805
863
  readonly CASES: "cases";
806
864
  readonly RH: "rh";
807
865
  readonly ACCESS_HUB: "access-hub";
@@ -831,4 +889,4 @@ declare const configure: (params: GatewayClientParams) => void;
831
889
  */
832
890
  declare function gateway<T extends keyof GatewayMap>(service: T): GatewayMap[T];
833
891
 
834
- 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, 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, 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, StrongPasswordOptionsResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCasePermissionsRequest, UpdateCompanyAccessPackagePayload, UpdateCompanyUserAvatarResponse, UpdateCompanyUserRequest, UpdateIntegrationActionParams, UpdateIntegrationFieldParams, UpdateMemberInRoomRequest, UpdateTimeEntryRequest, UpdateUserPasswordRequest, UpdateUserPasswordResponse, UploadPresignedUrlResponse, User, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };
892
+ export { AccessPackage, ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementListFilters, AnnouncementListResponse, AnnouncementType, AttachmentByIdResponse, AudioConvertResponse, AutomationPartner, AutomationPartnerAction, CallEndpoint, Campaign, CampaignAccessResponse, CampaignCompanyPaginatedResponse, CampaignCompanyQueryParams, CampaignCompanyResponse, CampaignContactPaginatedResponse, CampaignContactQueryParams, CampaignContactResponse, CampaignContactsDashboardData, CampaignContactsDashboardQueryParams, CampaignPaginatedResponse, CampaignQueryParams, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CancelInvitationRequest, CaseFeedByActionItem, CasePermissions, CaseTimeEntry, CommentHistoryPage, CompanyAccessPackageItem, CompanyBooleanConfigKey, CompanyConfigResponse, CompanyQueue, CompanyResource, CompanyResponse, CompanyStringConfigKey, 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, 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, StrongPasswordOptions, StrongPasswordOptionsResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCasePermissionsRequest, UpdateCompanyAccessPackagePayload, UpdateCompanyBooleanConfigRequest, 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, StrongPasswordOptionsResponse, User, 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, ManagedUser, StrongPasswordOptions, WorkGroup, WorkGroupMember } from './customer-service/contracts/index.js';
2
+ import { CompanyResponse, UpdateCompanyRequest, UpdateSupportWidgetIdRequest, UpdateSupportWidgetIdResponse, CompanyQueue, StrongPasswordOptionsResponse, StrongPasswordOptions, CompanyBooleanConfigKey, UpdateCompanyBooleanConfigRequest, CompanyConfigResponse, CompanyStringConfigKey, UpdateCompanyStringConfigRequest, User, 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, ManagedUser, 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';
@@ -17,6 +17,8 @@ import { ListInvitationsRequest, InvitationResponse, ReplyInvitationRequest, Can
17
17
  export { ForwardMessageDestination, ForwardMessageForwardingMetadata, ForwardMessageMetadata, MessageAttachment, MessageMetadata, MessageReactionResponse, MessageReplyContext, MessageStatusResponse, RoomActiveDates, RoomTagResponse } from './chat-webservice/contracts/index.js';
18
18
  import { ListContactHistoryRequest, ContactHistoryResponse } from './call-report/contracts/index.js';
19
19
  export { ContactHistoryIndex, ContactHistorySortOrder, ContactInteractionResponse, InteractionCallStepResponse, InteractionChatStepResponse, InteractionMemberResponse, InteractionOrganizationResponse } from './call-report/contracts/index.js';
20
+ import { CallEndpoint } from './calls/contracts/index.js';
21
+ export { CallEndpointStatus } from './calls/contracts/index.js';
20
22
  import { GetCommentHistoryRequest, CommentHistoryPage, CasePermissions, UpdateCasePermissionsRequest, GetCaseFeedByActionsRequest, CaseFeedByActionItem, ListCasesRequest, ListCasesResponse, CreateTimeEntryRequest, CaseTimeEntry, ListTimeEntriesRequest, ListTimeEntriesPage, UpdateTimeEntryRequest, DeleteTimeEntryRequest } from './cases/contracts/index.js';
21
23
  export { CaseListItem, CasePermissionsValue, CommentHistoryChangeType, CommentHistoryCursor, CommentHistoryEntry, ListCasesCursor, TimeEntryCursor } from './cases/contracts/index.js';
22
24
  import { GetAccessPackagesParams, PaginatedResult, AccessPackage, GetCompanyAccessPackagesParams, CompanyAccessPackageItem, CreateCompanyAccessPackagePayload, UpdateCompanyAccessPackagePayload, GetCompanyResourcesParams, CompanyResource } from './access-hub/contracts/index.js';
@@ -36,12 +38,49 @@ declare class CustomerServiceGateway {
36
38
  * @returns The company data wrapped in a {@link CompanyResponse}.
37
39
  */
38
40
  getCompanyById(companyId: string): Promise<CompanyResponse>;
41
+ /**
42
+ * Updates the current company settings.
43
+ * @param payload - The company fields to update.
44
+ * @returns The updated company data wrapped in a {@link CompanyResponse}.
45
+ */
46
+ updateCompany(payload: UpdateCompanyRequest): Promise<CompanyResponse>;
47
+ /**
48
+ * Updates the support widget identifier for the current company.
49
+ * @param payload - The support widget identifier to set.
50
+ * @returns The updated company support widget data.
51
+ */
52
+ updateSupportWidgetId(payload: UpdateSupportWidgetIdRequest): Promise<UpdateSupportWidgetIdResponse>;
53
+ /**
54
+ * Retrieves the list of queues configured for the current company.
55
+ * @returns The company queues.
56
+ */
57
+ getCompanyQueues(): Promise<CompanyQueue[]>;
39
58
  /**
40
59
  * Retrieves the strong password options config for a company.
41
60
  * @param companyId - The unique identifier of the company.
42
61
  * @returns The strong password options company config.
43
62
  */
44
63
  getStrongPasswordOptions(companyId: string): Promise<StrongPasswordOptionsResponse>;
64
+ /**
65
+ * Updates the strong password options config for the current company.
66
+ * @param payload - The strong password policy rules to apply.
67
+ * @returns The updated strong password options company config.
68
+ */
69
+ updateStrongPasswordOptions(payload: StrongPasswordOptions): Promise<StrongPasswordOptionsResponse>;
70
+ /**
71
+ * Updates a boolean company config by key.
72
+ * @param key - The config key to update.
73
+ * @param payload - The boolean value to set.
74
+ * @returns The updated company config entry.
75
+ */
76
+ updateCompanyBooleanConfig(key: CompanyBooleanConfigKey, payload: UpdateCompanyBooleanConfigRequest): Promise<CompanyConfigResponse>;
77
+ /**
78
+ * Updates a string company config by key.
79
+ * @param key - The config key to update.
80
+ * @param payload - The string value to set.
81
+ * @returns The updated company config entry.
82
+ */
83
+ updateCompanyStringConfig(key: CompanyStringConfigKey, payload: UpdateCompanyStringConfigRequest): Promise<CompanyConfigResponse>;
45
84
  /**
46
85
  * Retrieves a user by login email.
47
86
  * @param email - The user email used as login identifier.
@@ -627,6 +666,20 @@ declare class CallReportGateway {
627
666
  listContactHistory(params?: ListContactHistoryRequest): Promise<ContactHistoryResponse>;
628
667
  }
629
668
 
669
+ /**
670
+ * Gateway for interacting with the Calls API.
671
+ */
672
+ declare class CallsGateway {
673
+ private readonly httpClient;
674
+ private readonly baseUrl;
675
+ constructor(httpClient: AxiosInstance, baseUrl: string);
676
+ /**
677
+ * Retrieves all call endpoints and their current status.
678
+ * @returns The list of call endpoints.
679
+ */
680
+ getEndpoints(): Promise<CallEndpoint[]>;
681
+ }
682
+
630
683
  /** Request parameters for retrieving the webhooks scenario for a company. */
631
684
  interface GetWebhooksByCompanyRequest {
632
685
  companyId: string;
@@ -738,6 +791,7 @@ type GatewayMap = {
738
791
  integrations: IntegrationsGateway;
739
792
  'chat-webservice': ChatWebserviceGateway;
740
793
  'call-report': CallReportGateway;
794
+ calls: CallsGateway;
741
795
  cases: CasesGateway;
742
796
  rh: RhGateway;
743
797
  'access-hub': AccessHubGateway;
@@ -780,6 +834,9 @@ interface GatewayClientParams {
780
834
  callReport?: {
781
835
  baseUrl: string;
782
836
  };
837
+ calls?: {
838
+ baseUrl: string;
839
+ };
783
840
  cases?: {
784
841
  baseUrl: string;
785
842
  };
@@ -802,6 +859,7 @@ declare const SERVICE_GATEWAYS: {
802
859
  readonly INTEGRATIONS: "integrations";
803
860
  readonly CHAT_WEBSERVICE: "chat-webservice";
804
861
  readonly CALL_REPORT: "call-report";
862
+ readonly CALLS: "calls";
805
863
  readonly CASES: "cases";
806
864
  readonly RH: "rh";
807
865
  readonly ACCESS_HUB: "access-hub";
@@ -831,4 +889,4 @@ declare const configure: (params: GatewayClientParams) => void;
831
889
  */
832
890
  declare function gateway<T extends keyof GatewayMap>(service: T): GatewayMap[T];
833
891
 
834
- 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, 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, 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, StrongPasswordOptionsResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCasePermissionsRequest, UpdateCompanyAccessPackagePayload, UpdateCompanyUserAvatarResponse, UpdateCompanyUserRequest, UpdateIntegrationActionParams, UpdateIntegrationFieldParams, UpdateMemberInRoomRequest, UpdateTimeEntryRequest, UpdateUserPasswordRequest, UpdateUserPasswordResponse, UploadPresignedUrlResponse, User, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };
892
+ export { AccessPackage, ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementListFilters, AnnouncementListResponse, AnnouncementType, AttachmentByIdResponse, AudioConvertResponse, AutomationPartner, AutomationPartnerAction, CallEndpoint, Campaign, CampaignAccessResponse, CampaignCompanyPaginatedResponse, CampaignCompanyQueryParams, CampaignCompanyResponse, CampaignContactPaginatedResponse, CampaignContactQueryParams, CampaignContactResponse, CampaignContactsDashboardData, CampaignContactsDashboardQueryParams, CampaignPaginatedResponse, CampaignQueryParams, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CancelInvitationRequest, CaseFeedByActionItem, CasePermissions, CaseTimeEntry, CommentHistoryPage, CompanyAccessPackageItem, CompanyBooleanConfigKey, CompanyConfigResponse, CompanyQueue, CompanyResource, CompanyResponse, CompanyStringConfigKey, 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, 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, StrongPasswordOptions, StrongPasswordOptionsResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCasePermissionsRequest, UpdateCompanyAccessPackagePayload, UpdateCompanyBooleanConfigRequest, UpdateCompanyRequest, UpdateCompanyStringConfigRequest, UpdateCompanyUserAvatarResponse, UpdateCompanyUserRequest, UpdateIntegrationActionParams, UpdateIntegrationFieldParams, UpdateMemberInRoomRequest, UpdateSupportWidgetIdRequest, UpdateSupportWidgetIdResponse, UpdateTimeEntryRequest, UpdateUserPasswordRequest, UpdateUserPasswordResponse, UploadPresignedUrlResponse, User, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };