purecloud-platform-client-v2 214.0.0 → 216.0.0
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/README.md +31 -3
- package/dist/node/purecloud-platform-client-v2.js +649 -118
- package/dist/web-amd/purecloud-platform-client-v2.js +649 -118
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +272 -150
- package/dist/web-cjs/purecloud-platform-client-v2.js +283 -158
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +490 -255
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/AbstractHttpClient.js +29 -0
- package/src/purecloud-platform-client-v2/ApiClient.js +21 -1
- package/src/purecloud-platform-client-v2/DefaultHttpClient.js +41 -0
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -2
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +379 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +9 -4
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +21 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -31
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +3 -3
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +70 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -46,6 +46,35 @@ define(['axios', 'qs'], (function (axios, qs) { 'use strict';
|
|
|
46
46
|
request(httpRequestOptions) {
|
|
47
47
|
throw new Error("method must be implemented");
|
|
48
48
|
}
|
|
49
|
+
|
|
50
|
+
enableHooks() {
|
|
51
|
+
throw new Error("method must be implemented");
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
/**
|
|
55
|
+
* Set a PreHook function that modifies the request config before execution.
|
|
56
|
+
* @param {(config: object) => object | Promise<object> | void} hookFunction
|
|
57
|
+
*/
|
|
58
|
+
setPreHook(hookFunction) {
|
|
59
|
+
if (typeof hookFunction !== "function" || hookFunction.length !== 1) {
|
|
60
|
+
throw new Error("preHook must be a function that accepts (config)");
|
|
61
|
+
}
|
|
62
|
+
this.preHook = hookFunction;
|
|
63
|
+
this.enableHooks();
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
/**
|
|
67
|
+
* Set a PostHook function that processes the response or error after execution.
|
|
68
|
+
* @param {(response: object | null, error: Error | null) => object | Promise<object> | void} hookFunction
|
|
69
|
+
*/
|
|
70
|
+
setPostHook(hookFunction) {
|
|
71
|
+
if (typeof hookFunction !== "function" || hookFunction.length !== 1) {
|
|
72
|
+
throw new Error("postHook must be a function that accepts (response)");
|
|
73
|
+
}
|
|
74
|
+
this.postHook = hookFunction;
|
|
75
|
+
this.enableHooks();
|
|
76
|
+
}
|
|
77
|
+
|
|
49
78
|
}
|
|
50
79
|
|
|
51
80
|
class HttpRequestOptions {
|
|
@@ -124,6 +153,47 @@ define(['axios', 'qs'], (function (axios, qs) { 'use strict';
|
|
|
124
153
|
this._axiosInstance = axios__default["default"].create({});
|
|
125
154
|
}
|
|
126
155
|
|
|
156
|
+
|
|
157
|
+
enableHooks() {
|
|
158
|
+
if (this.preHook && typeof this.preHook === 'function') {
|
|
159
|
+
|
|
160
|
+
if (this.requestInterceptorId !== undefined) {
|
|
161
|
+
axios__default["default"].interceptors.request.eject(this.requestInterceptorId);
|
|
162
|
+
}
|
|
163
|
+
|
|
164
|
+
this.requestInterceptorId = this._axiosInstance.interceptors.request.use(
|
|
165
|
+
async (config) => {
|
|
166
|
+
config = await this.preHook(config); // Call the custom pre-hook
|
|
167
|
+
return config
|
|
168
|
+
},
|
|
169
|
+
(error) => {
|
|
170
|
+
// Handle errors before the request is sent
|
|
171
|
+
console.error('Request Pre-Hook Error:', error.message);
|
|
172
|
+
return Promise.reject(error);
|
|
173
|
+
}
|
|
174
|
+
);
|
|
175
|
+
}
|
|
176
|
+
|
|
177
|
+
if (this.postHook && typeof this.postHook === 'function') {
|
|
178
|
+
// Response interceptor (for post-hooks)
|
|
179
|
+
if (this.responseInterceptorId !== undefined) {
|
|
180
|
+
axios__default["default"].interceptors.response.eject(this.responseInterceptorId);
|
|
181
|
+
}
|
|
182
|
+
|
|
183
|
+
this.responseInterceptorId = this._axiosInstance.interceptors.response.use(
|
|
184
|
+
async (response) => {
|
|
185
|
+
response = await this.postHook(response); // Call the custom post-hook
|
|
186
|
+
return response
|
|
187
|
+
},
|
|
188
|
+
async (error) => {
|
|
189
|
+
console.error('Post-Hook: Response Error', error.message);
|
|
190
|
+
// Optionally call post-hook in case of errors
|
|
191
|
+
return Promise.reject(error);
|
|
192
|
+
}
|
|
193
|
+
);
|
|
194
|
+
}
|
|
195
|
+
}
|
|
196
|
+
|
|
127
197
|
request(httpRequestOptions) {
|
|
128
198
|
if(!(httpRequestOptions instanceof HttpRequestOptions)) {
|
|
129
199
|
throw new Error(`httpRequestOptions must be instance of HttpRequestOptions `);
|
|
@@ -617,7 +687,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
617
687
|
|
|
618
688
|
/**
|
|
619
689
|
* @module purecloud-platform-client-v2/ApiClient
|
|
620
|
-
* @version
|
|
690
|
+
* @version 216.0.0
|
|
621
691
|
*/
|
|
622
692
|
class ApiClient {
|
|
623
693
|
/**
|
|
@@ -872,6 +942,24 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
872
942
|
}
|
|
873
943
|
}
|
|
874
944
|
|
|
945
|
+
/**
|
|
946
|
+
* @description Sets preHook functions for the httpClient
|
|
947
|
+
* @param {string} preHook - method definition for prehook
|
|
948
|
+
*/
|
|
949
|
+
setPreHook(preHook) {
|
|
950
|
+
const httpClient = this.getHttpClient();
|
|
951
|
+
httpClient.setPreHook(preHook);
|
|
952
|
+
}
|
|
953
|
+
|
|
954
|
+
/**
|
|
955
|
+
* @description Sets postHook functions for the httpClient
|
|
956
|
+
* @param {string} postHook - method definition for posthook
|
|
957
|
+
*/
|
|
958
|
+
setPostHook(postHook) {
|
|
959
|
+
const httpClient = this.getHttpClient();
|
|
960
|
+
httpClient.setPostHook(postHook);
|
|
961
|
+
}
|
|
962
|
+
|
|
875
963
|
/**
|
|
876
964
|
* @description Sets the certificate content if MTLS authentication is needed
|
|
877
965
|
* @param {string} certContent - content for certs
|
|
@@ -903,6 +991,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
903
991
|
}
|
|
904
992
|
}
|
|
905
993
|
|
|
994
|
+
|
|
995
|
+
|
|
906
996
|
/**
|
|
907
997
|
* @description Sets the gateway used by the session
|
|
908
998
|
* @param {object} gateway - Gateway Configuration interface
|
|
@@ -2141,7 +2231,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2141
2231
|
/**
|
|
2142
2232
|
* AgentAssistants service.
|
|
2143
2233
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
2144
|
-
* @version
|
|
2234
|
+
* @version 216.0.0
|
|
2145
2235
|
*/
|
|
2146
2236
|
|
|
2147
2237
|
/**
|
|
@@ -2517,7 +2607,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2517
2607
|
/**
|
|
2518
2608
|
* AgentCopilot service.
|
|
2519
2609
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
2520
|
-
* @version
|
|
2610
|
+
* @version 216.0.0
|
|
2521
2611
|
*/
|
|
2522
2612
|
|
|
2523
2613
|
/**
|
|
@@ -2593,7 +2683,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2593
2683
|
/**
|
|
2594
2684
|
* AgentUI service.
|
|
2595
2685
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
2596
|
-
* @version
|
|
2686
|
+
* @version 216.0.0
|
|
2597
2687
|
*/
|
|
2598
2688
|
|
|
2599
2689
|
/**
|
|
@@ -2724,7 +2814,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2724
2814
|
/**
|
|
2725
2815
|
* Alerting service.
|
|
2726
2816
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
2727
|
-
* @version
|
|
2817
|
+
* @version 216.0.0
|
|
2728
2818
|
*/
|
|
2729
2819
|
|
|
2730
2820
|
/**
|
|
@@ -3429,7 +3519,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3429
3519
|
/**
|
|
3430
3520
|
* Analytics service.
|
|
3431
3521
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
3432
|
-
* @version
|
|
3522
|
+
* @version 216.0.0
|
|
3433
3523
|
*/
|
|
3434
3524
|
|
|
3435
3525
|
/**
|
|
@@ -5862,7 +5952,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5862
5952
|
* Query for summary aggregates
|
|
5863
5953
|
*
|
|
5864
5954
|
* @param {Object} body query
|
|
5865
|
-
* postAnalyticsSummariesAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5866
5955
|
*/
|
|
5867
5956
|
postAnalyticsSummariesAggregatesQuery(body) {
|
|
5868
5957
|
// verify the required parameter 'body' is set
|
|
@@ -6254,7 +6343,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6254
6343
|
/**
|
|
6255
6344
|
* Architect service.
|
|
6256
6345
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
6257
|
-
* @version
|
|
6346
|
+
* @version 216.0.0
|
|
6258
6347
|
*/
|
|
6259
6348
|
|
|
6260
6349
|
/**
|
|
@@ -10376,7 +10465,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10376
10465
|
/**
|
|
10377
10466
|
* Audit service.
|
|
10378
10467
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
10379
|
-
* @version
|
|
10468
|
+
* @version 216.0.0
|
|
10380
10469
|
*/
|
|
10381
10470
|
|
|
10382
10471
|
/**
|
|
@@ -10577,7 +10666,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10577
10666
|
/**
|
|
10578
10667
|
* Authorization service.
|
|
10579
10668
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
10580
|
-
* @version
|
|
10669
|
+
* @version 216.0.0
|
|
10581
10670
|
*/
|
|
10582
10671
|
|
|
10583
10672
|
/**
|
|
@@ -10621,6 +10710,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10621
10710
|
);
|
|
10622
10711
|
}
|
|
10623
10712
|
|
|
10713
|
+
/**
|
|
10714
|
+
* Delete an access control policy
|
|
10715
|
+
*
|
|
10716
|
+
* @param {String} targetName The domain:entity:action target to which the policy is applied
|
|
10717
|
+
* @param {String} subjectId The ID of the subject to which the policy is applied
|
|
10718
|
+
* deleteAuthorizationPoliciesTargetSubjectSubjectId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10719
|
+
*/
|
|
10720
|
+
deleteAuthorizationPoliciesTargetSubjectSubjectId(targetName, subjectId) {
|
|
10721
|
+
// verify the required parameter 'targetName' is set
|
|
10722
|
+
if (targetName === undefined || targetName === null) {
|
|
10723
|
+
throw 'Missing the required parameter "targetName" when calling deleteAuthorizationPoliciesTargetSubjectSubjectId';
|
|
10724
|
+
}
|
|
10725
|
+
// verify the required parameter 'subjectId' is set
|
|
10726
|
+
if (subjectId === undefined || subjectId === null) {
|
|
10727
|
+
throw 'Missing the required parameter "subjectId" when calling deleteAuthorizationPoliciesTargetSubjectSubjectId';
|
|
10728
|
+
}
|
|
10729
|
+
|
|
10730
|
+
return this.apiClient.callApi(
|
|
10731
|
+
'/api/v2/authorization/policies/targets/{targetName}/subject/{subjectId}',
|
|
10732
|
+
'DELETE',
|
|
10733
|
+
{ 'targetName': targetName,'subjectId': subjectId },
|
|
10734
|
+
{ },
|
|
10735
|
+
{ },
|
|
10736
|
+
{ },
|
|
10737
|
+
null,
|
|
10738
|
+
['PureCloud OAuth'],
|
|
10739
|
+
['application/json'],
|
|
10740
|
+
['application/json']
|
|
10741
|
+
);
|
|
10742
|
+
}
|
|
10743
|
+
|
|
10624
10744
|
/**
|
|
10625
10745
|
* Delete an organization role.
|
|
10626
10746
|
*
|
|
@@ -10935,6 +11055,198 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10935
11055
|
);
|
|
10936
11056
|
}
|
|
10937
11057
|
|
|
11058
|
+
/**
|
|
11059
|
+
* Get a page of access policies for an organization
|
|
11060
|
+
*
|
|
11061
|
+
* @param {Object} opts Optional parameters
|
|
11062
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
11063
|
+
* @param {Number} opts.pageSize Number of entities to return. Maximum of 200. (default to 25)
|
|
11064
|
+
* getAuthorizationPolicies is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11065
|
+
*/
|
|
11066
|
+
getAuthorizationPolicies(opts) {
|
|
11067
|
+
opts = opts || {};
|
|
11068
|
+
|
|
11069
|
+
|
|
11070
|
+
return this.apiClient.callApi(
|
|
11071
|
+
'/api/v2/authorization/policies',
|
|
11072
|
+
'GET',
|
|
11073
|
+
{ },
|
|
11074
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
11075
|
+
{ },
|
|
11076
|
+
{ },
|
|
11077
|
+
null,
|
|
11078
|
+
['PureCloud OAuth'],
|
|
11079
|
+
['application/json'],
|
|
11080
|
+
['application/json']
|
|
11081
|
+
);
|
|
11082
|
+
}
|
|
11083
|
+
|
|
11084
|
+
/**
|
|
11085
|
+
* Get a page of access policies for a given subject
|
|
11086
|
+
*
|
|
11087
|
+
* @param {String} subjectId The ID of the subject to which policies are applied
|
|
11088
|
+
* @param {Object} opts Optional parameters
|
|
11089
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
11090
|
+
* @param {Number} opts.pageSize Number of entities to return. Maximum of 200. (default to 25)
|
|
11091
|
+
* getAuthorizationPoliciesSubjectSubjectId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11092
|
+
*/
|
|
11093
|
+
getAuthorizationPoliciesSubjectSubjectId(subjectId, opts) {
|
|
11094
|
+
opts = opts || {};
|
|
11095
|
+
|
|
11096
|
+
// verify the required parameter 'subjectId' is set
|
|
11097
|
+
if (subjectId === undefined || subjectId === null) {
|
|
11098
|
+
throw 'Missing the required parameter "subjectId" when calling getAuthorizationPoliciesSubjectSubjectId';
|
|
11099
|
+
}
|
|
11100
|
+
|
|
11101
|
+
return this.apiClient.callApi(
|
|
11102
|
+
'/api/v2/authorization/policies/subject/{subjectId}',
|
|
11103
|
+
'GET',
|
|
11104
|
+
{ 'subjectId': subjectId },
|
|
11105
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
11106
|
+
{ },
|
|
11107
|
+
{ },
|
|
11108
|
+
null,
|
|
11109
|
+
['PureCloud OAuth'],
|
|
11110
|
+
['application/json'],
|
|
11111
|
+
['application/json']
|
|
11112
|
+
);
|
|
11113
|
+
}
|
|
11114
|
+
|
|
11115
|
+
/**
|
|
11116
|
+
* Get a page of access policies for a given policy target
|
|
11117
|
+
*
|
|
11118
|
+
* @param {String} targetName The domain:entity:action resource target to which policies are applied
|
|
11119
|
+
* @param {Object} opts Optional parameters
|
|
11120
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
11121
|
+
* @param {Number} opts.pageSize Number of entities to return. Maximum of 200. (default to 25)
|
|
11122
|
+
* getAuthorizationPoliciesTarget is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11123
|
+
*/
|
|
11124
|
+
getAuthorizationPoliciesTarget(targetName, opts) {
|
|
11125
|
+
opts = opts || {};
|
|
11126
|
+
|
|
11127
|
+
// verify the required parameter 'targetName' is set
|
|
11128
|
+
if (targetName === undefined || targetName === null) {
|
|
11129
|
+
throw 'Missing the required parameter "targetName" when calling getAuthorizationPoliciesTarget';
|
|
11130
|
+
}
|
|
11131
|
+
|
|
11132
|
+
return this.apiClient.callApi(
|
|
11133
|
+
'/api/v2/authorization/policies/targets/{targetName}',
|
|
11134
|
+
'GET',
|
|
11135
|
+
{ 'targetName': targetName },
|
|
11136
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
11137
|
+
{ },
|
|
11138
|
+
{ },
|
|
11139
|
+
null,
|
|
11140
|
+
['PureCloud OAuth'],
|
|
11141
|
+
['application/json'],
|
|
11142
|
+
['application/json']
|
|
11143
|
+
);
|
|
11144
|
+
}
|
|
11145
|
+
|
|
11146
|
+
/**
|
|
11147
|
+
* Get an access control policy for a specified resource target and subject
|
|
11148
|
+
*
|
|
11149
|
+
* @param {String} targetName The domain:entity:action resource target to which the policy is applied
|
|
11150
|
+
* @param {String} subjectId The ID of the subject to which the policy is applied
|
|
11151
|
+
* getAuthorizationPoliciesTargetSubjectSubjectId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11152
|
+
*/
|
|
11153
|
+
getAuthorizationPoliciesTargetSubjectSubjectId(targetName, subjectId) {
|
|
11154
|
+
// verify the required parameter 'targetName' is set
|
|
11155
|
+
if (targetName === undefined || targetName === null) {
|
|
11156
|
+
throw 'Missing the required parameter "targetName" when calling getAuthorizationPoliciesTargetSubjectSubjectId';
|
|
11157
|
+
}
|
|
11158
|
+
// verify the required parameter 'subjectId' is set
|
|
11159
|
+
if (subjectId === undefined || subjectId === null) {
|
|
11160
|
+
throw 'Missing the required parameter "subjectId" when calling getAuthorizationPoliciesTargetSubjectSubjectId';
|
|
11161
|
+
}
|
|
11162
|
+
|
|
11163
|
+
return this.apiClient.callApi(
|
|
11164
|
+
'/api/v2/authorization/policies/targets/{targetName}/subject/{subjectId}',
|
|
11165
|
+
'GET',
|
|
11166
|
+
{ 'targetName': targetName,'subjectId': subjectId },
|
|
11167
|
+
{ },
|
|
11168
|
+
{ },
|
|
11169
|
+
{ },
|
|
11170
|
+
null,
|
|
11171
|
+
['PureCloud OAuth'],
|
|
11172
|
+
['application/json'],
|
|
11173
|
+
['application/json']
|
|
11174
|
+
);
|
|
11175
|
+
}
|
|
11176
|
+
|
|
11177
|
+
/**
|
|
11178
|
+
* Get a map of policy targets to valid attributes for those targets
|
|
11179
|
+
*
|
|
11180
|
+
* getAuthorizationPoliciesTargets is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11181
|
+
*/
|
|
11182
|
+
getAuthorizationPoliciesTargets() {
|
|
11183
|
+
|
|
11184
|
+
return this.apiClient.callApi(
|
|
11185
|
+
'/api/v2/authorization/policies/targets',
|
|
11186
|
+
'GET',
|
|
11187
|
+
{ },
|
|
11188
|
+
{ },
|
|
11189
|
+
{ },
|
|
11190
|
+
{ },
|
|
11191
|
+
null,
|
|
11192
|
+
['PureCloud OAuth'],
|
|
11193
|
+
['application/json'],
|
|
11194
|
+
['application/json']
|
|
11195
|
+
);
|
|
11196
|
+
}
|
|
11197
|
+
|
|
11198
|
+
/**
|
|
11199
|
+
* Get an access control policy with the specified policy ID
|
|
11200
|
+
*
|
|
11201
|
+
* @param {String} policyId The ID of the policy to retrieve
|
|
11202
|
+
* getAuthorizationPolicy is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11203
|
+
*/
|
|
11204
|
+
getAuthorizationPolicy(policyId) {
|
|
11205
|
+
// verify the required parameter 'policyId' is set
|
|
11206
|
+
if (policyId === undefined || policyId === null) {
|
|
11207
|
+
throw 'Missing the required parameter "policyId" when calling getAuthorizationPolicy';
|
|
11208
|
+
}
|
|
11209
|
+
|
|
11210
|
+
return this.apiClient.callApi(
|
|
11211
|
+
'/api/v2/authorization/policies/{policyId}',
|
|
11212
|
+
'GET',
|
|
11213
|
+
{ 'policyId': policyId },
|
|
11214
|
+
{ },
|
|
11215
|
+
{ },
|
|
11216
|
+
{ },
|
|
11217
|
+
null,
|
|
11218
|
+
['PureCloud OAuth'],
|
|
11219
|
+
['application/json'],
|
|
11220
|
+
['application/json']
|
|
11221
|
+
);
|
|
11222
|
+
}
|
|
11223
|
+
|
|
11224
|
+
/**
|
|
11225
|
+
* Get the list of attributes used to evaluate an access control policy with the specified policy ID
|
|
11226
|
+
*
|
|
11227
|
+
* @param {String} policyId The ID of the policy to retrieve attributes
|
|
11228
|
+
* getAuthorizationPolicyAttributes is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11229
|
+
*/
|
|
11230
|
+
getAuthorizationPolicyAttributes(policyId) {
|
|
11231
|
+
// verify the required parameter 'policyId' is set
|
|
11232
|
+
if (policyId === undefined || policyId === null) {
|
|
11233
|
+
throw 'Missing the required parameter "policyId" when calling getAuthorizationPolicyAttributes';
|
|
11234
|
+
}
|
|
11235
|
+
|
|
11236
|
+
return this.apiClient.callApi(
|
|
11237
|
+
'/api/v2/authorization/policies/{policyId}/attributes',
|
|
11238
|
+
'GET',
|
|
11239
|
+
{ 'policyId': policyId },
|
|
11240
|
+
{ },
|
|
11241
|
+
{ },
|
|
11242
|
+
{ },
|
|
11243
|
+
null,
|
|
11244
|
+
['PureCloud OAuth'],
|
|
11245
|
+
['application/json'],
|
|
11246
|
+
['application/json']
|
|
11247
|
+
);
|
|
11248
|
+
}
|
|
11249
|
+
|
|
10938
11250
|
/**
|
|
10939
11251
|
* Get the list of enabled products
|
|
10940
11252
|
* Gets the list of enabled products. Some example product names are: collaborateFree, collaboratePro, communicate, and engage.
|
|
@@ -11399,6 +11711,99 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11399
11711
|
);
|
|
11400
11712
|
}
|
|
11401
11713
|
|
|
11714
|
+
/**
|
|
11715
|
+
* Add an access control policy for a specified resource target and subject
|
|
11716
|
+
*
|
|
11717
|
+
* @param {String} targetName The domain:entity:action target to which the policy will be applied
|
|
11718
|
+
* @param {Object} body Access control policy
|
|
11719
|
+
* postAuthorizationPoliciesTarget is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11720
|
+
*/
|
|
11721
|
+
postAuthorizationPoliciesTarget(targetName, body) {
|
|
11722
|
+
// verify the required parameter 'targetName' is set
|
|
11723
|
+
if (targetName === undefined || targetName === null) {
|
|
11724
|
+
throw 'Missing the required parameter "targetName" when calling postAuthorizationPoliciesTarget';
|
|
11725
|
+
}
|
|
11726
|
+
// verify the required parameter 'body' is set
|
|
11727
|
+
if (body === undefined || body === null) {
|
|
11728
|
+
throw 'Missing the required parameter "body" when calling postAuthorizationPoliciesTarget';
|
|
11729
|
+
}
|
|
11730
|
+
|
|
11731
|
+
return this.apiClient.callApi(
|
|
11732
|
+
'/api/v2/authorization/policies/targets/{targetName}',
|
|
11733
|
+
'POST',
|
|
11734
|
+
{ 'targetName': targetName },
|
|
11735
|
+
{ },
|
|
11736
|
+
{ },
|
|
11737
|
+
{ },
|
|
11738
|
+
body,
|
|
11739
|
+
['PureCloud OAuth'],
|
|
11740
|
+
['application/json'],
|
|
11741
|
+
['application/json']
|
|
11742
|
+
);
|
|
11743
|
+
}
|
|
11744
|
+
|
|
11745
|
+
/**
|
|
11746
|
+
* Validate the conditions and attributes of an access control policy for a specified resource target
|
|
11747
|
+
*
|
|
11748
|
+
* @param {String} targetName The domain:entity:action target to which the policy will be applied
|
|
11749
|
+
* @param {Object} body Access control policy
|
|
11750
|
+
* postAuthorizationPoliciesTargetValidate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11751
|
+
*/
|
|
11752
|
+
postAuthorizationPoliciesTargetValidate(targetName, body) {
|
|
11753
|
+
// verify the required parameter 'targetName' is set
|
|
11754
|
+
if (targetName === undefined || targetName === null) {
|
|
11755
|
+
throw 'Missing the required parameter "targetName" when calling postAuthorizationPoliciesTargetValidate';
|
|
11756
|
+
}
|
|
11757
|
+
// verify the required parameter 'body' is set
|
|
11758
|
+
if (body === undefined || body === null) {
|
|
11759
|
+
throw 'Missing the required parameter "body" when calling postAuthorizationPoliciesTargetValidate';
|
|
11760
|
+
}
|
|
11761
|
+
|
|
11762
|
+
return this.apiClient.callApi(
|
|
11763
|
+
'/api/v2/authorization/policies/targets/{targetName}/validate',
|
|
11764
|
+
'POST',
|
|
11765
|
+
{ 'targetName': targetName },
|
|
11766
|
+
{ },
|
|
11767
|
+
{ },
|
|
11768
|
+
{ },
|
|
11769
|
+
body,
|
|
11770
|
+
['PureCloud OAuth'],
|
|
11771
|
+
['application/json'],
|
|
11772
|
+
['application/json']
|
|
11773
|
+
);
|
|
11774
|
+
}
|
|
11775
|
+
|
|
11776
|
+
/**
|
|
11777
|
+
* Simulate a request and evaluate the specified policy ID against the provided values
|
|
11778
|
+
*
|
|
11779
|
+
* @param {String} policyId The ID of the policy to test the simulated data against
|
|
11780
|
+
* @param {Object} body A map of attribute names to type and simulated data value
|
|
11781
|
+
* postAuthorizationPolicySimulate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11782
|
+
*/
|
|
11783
|
+
postAuthorizationPolicySimulate(policyId, body) {
|
|
11784
|
+
// verify the required parameter 'policyId' is set
|
|
11785
|
+
if (policyId === undefined || policyId === null) {
|
|
11786
|
+
throw 'Missing the required parameter "policyId" when calling postAuthorizationPolicySimulate';
|
|
11787
|
+
}
|
|
11788
|
+
// verify the required parameter 'body' is set
|
|
11789
|
+
if (body === undefined || body === null) {
|
|
11790
|
+
throw 'Missing the required parameter "body" when calling postAuthorizationPolicySimulate';
|
|
11791
|
+
}
|
|
11792
|
+
|
|
11793
|
+
return this.apiClient.callApi(
|
|
11794
|
+
'/api/v2/authorization/policies/{policyId}/simulate',
|
|
11795
|
+
'POST',
|
|
11796
|
+
{ 'policyId': policyId },
|
|
11797
|
+
{ },
|
|
11798
|
+
{ },
|
|
11799
|
+
{ },
|
|
11800
|
+
body,
|
|
11801
|
+
['PureCloud OAuth'],
|
|
11802
|
+
['application/json'],
|
|
11803
|
+
['application/json']
|
|
11804
|
+
);
|
|
11805
|
+
}
|
|
11806
|
+
|
|
11402
11807
|
/**
|
|
11403
11808
|
* Bulk-grant subjects and divisions with an organization role.
|
|
11404
11809
|
*
|
|
@@ -11684,6 +12089,68 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11684
12089
|
);
|
|
11685
12090
|
}
|
|
11686
12091
|
|
|
12092
|
+
/**
|
|
12093
|
+
* Add an access control policy for a specified resource target and subject, overwriting any existing policy
|
|
12094
|
+
*
|
|
12095
|
+
* @param {String} targetName The domain:entity:action target to which the policy will be applied
|
|
12096
|
+
* @param {Object} body Access control policy
|
|
12097
|
+
* putAuthorizationPoliciesTarget is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12098
|
+
*/
|
|
12099
|
+
putAuthorizationPoliciesTarget(targetName, body) {
|
|
12100
|
+
// verify the required parameter 'targetName' is set
|
|
12101
|
+
if (targetName === undefined || targetName === null) {
|
|
12102
|
+
throw 'Missing the required parameter "targetName" when calling putAuthorizationPoliciesTarget';
|
|
12103
|
+
}
|
|
12104
|
+
// verify the required parameter 'body' is set
|
|
12105
|
+
if (body === undefined || body === null) {
|
|
12106
|
+
throw 'Missing the required parameter "body" when calling putAuthorizationPoliciesTarget';
|
|
12107
|
+
}
|
|
12108
|
+
|
|
12109
|
+
return this.apiClient.callApi(
|
|
12110
|
+
'/api/v2/authorization/policies/targets/{targetName}',
|
|
12111
|
+
'PUT',
|
|
12112
|
+
{ 'targetName': targetName },
|
|
12113
|
+
{ },
|
|
12114
|
+
{ },
|
|
12115
|
+
{ },
|
|
12116
|
+
body,
|
|
12117
|
+
['PureCloud OAuth'],
|
|
12118
|
+
['application/json'],
|
|
12119
|
+
['application/json']
|
|
12120
|
+
);
|
|
12121
|
+
}
|
|
12122
|
+
|
|
12123
|
+
/**
|
|
12124
|
+
* Update an access control policy with a given ID
|
|
12125
|
+
*
|
|
12126
|
+
* @param {String} policyId The ID of the policy to update
|
|
12127
|
+
* @param {Object} body Access control policy
|
|
12128
|
+
* putAuthorizationPolicy is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12129
|
+
*/
|
|
12130
|
+
putAuthorizationPolicy(policyId, body) {
|
|
12131
|
+
// verify the required parameter 'policyId' is set
|
|
12132
|
+
if (policyId === undefined || policyId === null) {
|
|
12133
|
+
throw 'Missing the required parameter "policyId" when calling putAuthorizationPolicy';
|
|
12134
|
+
}
|
|
12135
|
+
// verify the required parameter 'body' is set
|
|
12136
|
+
if (body === undefined || body === null) {
|
|
12137
|
+
throw 'Missing the required parameter "body" when calling putAuthorizationPolicy';
|
|
12138
|
+
}
|
|
12139
|
+
|
|
12140
|
+
return this.apiClient.callApi(
|
|
12141
|
+
'/api/v2/authorization/policies/{policyId}',
|
|
12142
|
+
'PUT',
|
|
12143
|
+
{ 'policyId': policyId },
|
|
12144
|
+
{ },
|
|
12145
|
+
{ },
|
|
12146
|
+
{ },
|
|
12147
|
+
body,
|
|
12148
|
+
['PureCloud OAuth'],
|
|
12149
|
+
['application/json'],
|
|
12150
|
+
['application/json']
|
|
12151
|
+
);
|
|
12152
|
+
}
|
|
12153
|
+
|
|
11687
12154
|
/**
|
|
11688
12155
|
* Update an organization role.
|
|
11689
12156
|
* Update
|
|
@@ -11860,7 +12327,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11860
12327
|
/**
|
|
11861
12328
|
* Billing service.
|
|
11862
12329
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
11863
|
-
* @version
|
|
12330
|
+
* @version 216.0.0
|
|
11864
12331
|
*/
|
|
11865
12332
|
|
|
11866
12333
|
/**
|
|
@@ -11940,7 +12407,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11940
12407
|
/**
|
|
11941
12408
|
* CarrierServices service.
|
|
11942
12409
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
11943
|
-
* @version
|
|
12410
|
+
* @version 216.0.0
|
|
11944
12411
|
*/
|
|
11945
12412
|
|
|
11946
12413
|
/**
|
|
@@ -12010,7 +12477,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12010
12477
|
/**
|
|
12011
12478
|
* Chat service.
|
|
12012
12479
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
12013
|
-
* @version
|
|
12480
|
+
* @version 216.0.0
|
|
12014
12481
|
*/
|
|
12015
12482
|
|
|
12016
12483
|
/**
|
|
@@ -12946,7 +13413,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12946
13413
|
/**
|
|
12947
13414
|
* Coaching service.
|
|
12948
13415
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
12949
|
-
* @version
|
|
13416
|
+
* @version 216.0.0
|
|
12950
13417
|
*/
|
|
12951
13418
|
|
|
12952
13419
|
/**
|
|
@@ -13523,7 +13990,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13523
13990
|
/**
|
|
13524
13991
|
* ContentManagement service.
|
|
13525
13992
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
13526
|
-
* @version
|
|
13993
|
+
* @version 216.0.0
|
|
13527
13994
|
*/
|
|
13528
13995
|
|
|
13529
13996
|
/**
|
|
@@ -14604,7 +15071,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14604
15071
|
/**
|
|
14605
15072
|
* Conversations service.
|
|
14606
15073
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
14607
|
-
* @version
|
|
15074
|
+
* @version 216.0.0
|
|
14608
15075
|
*/
|
|
14609
15076
|
|
|
14610
15077
|
/**
|
|
@@ -21766,7 +22233,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21766
22233
|
/**
|
|
21767
22234
|
* DataExtensions service.
|
|
21768
22235
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
21769
|
-
* @version
|
|
22236
|
+
* @version 216.0.0
|
|
21770
22237
|
*/
|
|
21771
22238
|
|
|
21772
22239
|
/**
|
|
@@ -21852,7 +22319,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21852
22319
|
/**
|
|
21853
22320
|
* DataPrivacy service.
|
|
21854
22321
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
21855
|
-
* @version
|
|
22322
|
+
* @version 216.0.0
|
|
21856
22323
|
*/
|
|
21857
22324
|
|
|
21858
22325
|
/**
|
|
@@ -22022,7 +22489,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22022
22489
|
/**
|
|
22023
22490
|
* Downloads service.
|
|
22024
22491
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
22025
|
-
* @version
|
|
22492
|
+
* @version 216.0.0
|
|
22026
22493
|
*/
|
|
22027
22494
|
|
|
22028
22495
|
/**
|
|
@@ -22074,7 +22541,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22074
22541
|
/**
|
|
22075
22542
|
* Emails service.
|
|
22076
22543
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
22077
|
-
* @version
|
|
22544
|
+
* @version 216.0.0
|
|
22078
22545
|
*/
|
|
22079
22546
|
|
|
22080
22547
|
/**
|
|
@@ -22139,7 +22606,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22139
22606
|
/**
|
|
22140
22607
|
* EmployeeEngagement service.
|
|
22141
22608
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
22142
|
-
* @version
|
|
22609
|
+
* @version 216.0.0
|
|
22143
22610
|
*/
|
|
22144
22611
|
|
|
22145
22612
|
/**
|
|
@@ -22290,7 +22757,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22290
22757
|
/**
|
|
22291
22758
|
* Events service.
|
|
22292
22759
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
22293
|
-
* @version
|
|
22760
|
+
* @version 216.0.0
|
|
22294
22761
|
*/
|
|
22295
22762
|
|
|
22296
22763
|
/**
|
|
@@ -22386,7 +22853,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22386
22853
|
/**
|
|
22387
22854
|
* ExternalContacts service.
|
|
22388
22855
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
22389
|
-
* @version
|
|
22856
|
+
* @version 216.0.0
|
|
22390
22857
|
*/
|
|
22391
22858
|
|
|
22392
22859
|
/**
|
|
@@ -23126,8 +23593,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23126
23593
|
* Get job based on id
|
|
23127
23594
|
*
|
|
23128
23595
|
* @param {String} jobId Job id
|
|
23596
|
+
* @param {Object} opts Optional parameters
|
|
23597
|
+
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
23129
23598
|
*/
|
|
23130
|
-
getExternalcontactsImportJob(jobId) {
|
|
23599
|
+
getExternalcontactsImportJob(jobId, opts) {
|
|
23600
|
+
opts = opts || {};
|
|
23601
|
+
|
|
23131
23602
|
// verify the required parameter 'jobId' is set
|
|
23132
23603
|
if (jobId === undefined || jobId === null) {
|
|
23133
23604
|
throw 'Missing the required parameter "jobId" when calling getExternalcontactsImportJob';
|
|
@@ -23137,7 +23608,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23137
23608
|
'/api/v2/externalcontacts/import/jobs/{jobId}',
|
|
23138
23609
|
'GET',
|
|
23139
23610
|
{ 'jobId': jobId },
|
|
23140
|
-
{
|
|
23611
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
23141
23612
|
{ },
|
|
23142
23613
|
{ },
|
|
23143
23614
|
null,
|
|
@@ -23151,6 +23622,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23151
23622
|
* List jobs for organization
|
|
23152
23623
|
*
|
|
23153
23624
|
* @param {Object} opts Optional parameters
|
|
23625
|
+
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
23154
23626
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
23155
23627
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 100. (default to 25)
|
|
23156
23628
|
* @param {Object} opts.sortOrder Direction of sorting. (default to Ascending)
|
|
@@ -23164,7 +23636,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23164
23636
|
'/api/v2/externalcontacts/import/jobs',
|
|
23165
23637
|
'GET',
|
|
23166
23638
|
{ },
|
|
23167
|
-
{ 'after': opts['after'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'jobStatus': opts['jobStatus'] },
|
|
23639
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'after': opts['after'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'jobStatus': opts['jobStatus'] },
|
|
23168
23640
|
{ },
|
|
23169
23641
|
{ },
|
|
23170
23642
|
null,
|
|
@@ -24951,7 +25423,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24951
25423
|
/**
|
|
24952
25424
|
* Fax service.
|
|
24953
25425
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
24954
|
-
* @version
|
|
25426
|
+
* @version 216.0.0
|
|
24955
25427
|
*/
|
|
24956
25428
|
|
|
24957
25429
|
/**
|
|
@@ -25166,7 +25638,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25166
25638
|
/**
|
|
25167
25639
|
* Flows service.
|
|
25168
25640
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
25169
|
-
* @version
|
|
25641
|
+
* @version 216.0.0
|
|
25170
25642
|
*/
|
|
25171
25643
|
|
|
25172
25644
|
/**
|
|
@@ -25349,7 +25821,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25349
25821
|
/**
|
|
25350
25822
|
* Gamification service.
|
|
25351
25823
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
25352
|
-
* @version
|
|
25824
|
+
* @version 216.0.0
|
|
25353
25825
|
*/
|
|
25354
25826
|
|
|
25355
25827
|
/**
|
|
@@ -27491,7 +27963,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27491
27963
|
/**
|
|
27492
27964
|
* GeneralDataProtectionRegulation service.
|
|
27493
27965
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
27494
|
-
* @version
|
|
27966
|
+
* @version 216.0.0
|
|
27495
27967
|
*/
|
|
27496
27968
|
|
|
27497
27969
|
/**
|
|
@@ -27621,7 +28093,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27621
28093
|
/**
|
|
27622
28094
|
* Geolocation service.
|
|
27623
28095
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
27624
|
-
* @version
|
|
28096
|
+
* @version 216.0.0
|
|
27625
28097
|
*/
|
|
27626
28098
|
|
|
27627
28099
|
/**
|
|
@@ -27752,7 +28224,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27752
28224
|
/**
|
|
27753
28225
|
* Greetings service.
|
|
27754
28226
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
27755
|
-
* @version
|
|
28227
|
+
* @version 216.0.0
|
|
27756
28228
|
*/
|
|
27757
28229
|
|
|
27758
28230
|
/**
|
|
@@ -28207,7 +28679,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28207
28679
|
/**
|
|
28208
28680
|
* Groups service.
|
|
28209
28681
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
28210
|
-
* @version
|
|
28682
|
+
* @version 216.0.0
|
|
28211
28683
|
*/
|
|
28212
28684
|
|
|
28213
28685
|
/**
|
|
@@ -28726,7 +29198,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28726
29198
|
/**
|
|
28727
29199
|
* IdentityProvider service.
|
|
28728
29200
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
28729
|
-
* @version
|
|
29201
|
+
* @version 216.0.0
|
|
28730
29202
|
*/
|
|
28731
29203
|
|
|
28732
29204
|
/**
|
|
@@ -29587,7 +30059,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29587
30059
|
/**
|
|
29588
30060
|
* InfrastructureAsCode service.
|
|
29589
30061
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
29590
|
-
* @version
|
|
30062
|
+
* @version 216.0.0
|
|
29591
30063
|
*/
|
|
29592
30064
|
|
|
29593
30065
|
/**
|
|
@@ -29754,7 +30226,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29754
30226
|
/**
|
|
29755
30227
|
* Integrations service.
|
|
29756
30228
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
29757
|
-
* @version
|
|
30229
|
+
* @version 216.0.0
|
|
29758
30230
|
*/
|
|
29759
30231
|
|
|
29760
30232
|
/**
|
|
@@ -32191,7 +32663,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32191
32663
|
/**
|
|
32192
32664
|
* Journey service.
|
|
32193
32665
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
32194
|
-
* @version
|
|
32666
|
+
* @version 216.0.0
|
|
32195
32667
|
*/
|
|
32196
32668
|
|
|
32197
32669
|
/**
|
|
@@ -33331,6 +33803,26 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33331
33803
|
);
|
|
33332
33804
|
}
|
|
33333
33805
|
|
|
33806
|
+
/**
|
|
33807
|
+
* Get details about the data available for journey queries including oldest and newest event dates
|
|
33808
|
+
*
|
|
33809
|
+
*/
|
|
33810
|
+
getJourneyViewsDataDetails() {
|
|
33811
|
+
|
|
33812
|
+
return this.apiClient.callApi(
|
|
33813
|
+
'/api/v2/journey/views/data/details',
|
|
33814
|
+
'GET',
|
|
33815
|
+
{ },
|
|
33816
|
+
{ },
|
|
33817
|
+
{ },
|
|
33818
|
+
{ },
|
|
33819
|
+
null,
|
|
33820
|
+
['PureCloud OAuth'],
|
|
33821
|
+
['application/json'],
|
|
33822
|
+
['application/json']
|
|
33823
|
+
);
|
|
33824
|
+
}
|
|
33825
|
+
|
|
33334
33826
|
/**
|
|
33335
33827
|
* Get an Event Definition
|
|
33336
33828
|
*
|
|
@@ -34156,7 +34648,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34156
34648
|
/**
|
|
34157
34649
|
* Knowledge service.
|
|
34158
34650
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
34159
|
-
* @version
|
|
34651
|
+
* @version 216.0.0
|
|
34160
34652
|
*/
|
|
34161
34653
|
|
|
34162
34654
|
/**
|
|
@@ -38032,7 +38524,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38032
38524
|
/**
|
|
38033
38525
|
* LanguageUnderstanding service.
|
|
38034
38526
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
38035
|
-
* @version
|
|
38527
|
+
* @version 216.0.0
|
|
38036
38528
|
*/
|
|
38037
38529
|
|
|
38038
38530
|
/**
|
|
@@ -39065,7 +39557,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39065
39557
|
/**
|
|
39066
39558
|
* Languages service.
|
|
39067
39559
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
39068
|
-
* @version
|
|
39560
|
+
* @version 216.0.0
|
|
39069
39561
|
*/
|
|
39070
39562
|
|
|
39071
39563
|
/**
|
|
@@ -39287,7 +39779,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39287
39779
|
/**
|
|
39288
39780
|
* Learning service.
|
|
39289
39781
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
39290
|
-
* @version
|
|
39782
|
+
* @version 216.0.0
|
|
39291
39783
|
*/
|
|
39292
39784
|
|
|
39293
39785
|
/**
|
|
@@ -40316,7 +40808,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40316
40808
|
/**
|
|
40317
40809
|
* License service.
|
|
40318
40810
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
40319
|
-
* @version
|
|
40811
|
+
* @version 216.0.0
|
|
40320
40812
|
*/
|
|
40321
40813
|
|
|
40322
40814
|
/**
|
|
@@ -40554,7 +41046,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40554
41046
|
/**
|
|
40555
41047
|
* Locations service.
|
|
40556
41048
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
40557
|
-
* @version
|
|
41049
|
+
* @version 216.0.0
|
|
40558
41050
|
*/
|
|
40559
41051
|
|
|
40560
41052
|
/**
|
|
@@ -40790,7 +41282,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40790
41282
|
/**
|
|
40791
41283
|
* LogCapture service.
|
|
40792
41284
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
40793
|
-
* @version
|
|
41285
|
+
* @version 216.0.0
|
|
40794
41286
|
*/
|
|
40795
41287
|
|
|
40796
41288
|
/**
|
|
@@ -40990,7 +41482,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40990
41482
|
/**
|
|
40991
41483
|
* Messaging service.
|
|
40992
41484
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
40993
|
-
* @version
|
|
41485
|
+
* @version 216.0.0
|
|
40994
41486
|
*/
|
|
40995
41487
|
|
|
40996
41488
|
/**
|
|
@@ -41349,7 +41841,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41349
41841
|
/**
|
|
41350
41842
|
* MobileDevices service.
|
|
41351
41843
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
41352
|
-
* @version
|
|
41844
|
+
* @version 216.0.0
|
|
41353
41845
|
*/
|
|
41354
41846
|
|
|
41355
41847
|
/**
|
|
@@ -41500,7 +41992,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41500
41992
|
/**
|
|
41501
41993
|
* Notifications service.
|
|
41502
41994
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
41503
|
-
* @version
|
|
41995
|
+
* @version 216.0.0
|
|
41504
41996
|
*/
|
|
41505
41997
|
|
|
41506
41998
|
/**
|
|
@@ -41733,7 +42225,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41733
42225
|
/**
|
|
41734
42226
|
* OAuth service.
|
|
41735
42227
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
41736
|
-
* @version
|
|
42228
|
+
* @version 216.0.0
|
|
41737
42229
|
*/
|
|
41738
42230
|
|
|
41739
42231
|
/**
|
|
@@ -42099,7 +42591,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42099
42591
|
/**
|
|
42100
42592
|
* Objects service.
|
|
42101
42593
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
42102
|
-
* @version
|
|
42594
|
+
* @version 216.0.0
|
|
42103
42595
|
*/
|
|
42104
42596
|
|
|
42105
42597
|
/**
|
|
@@ -42369,7 +42861,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42369
42861
|
/**
|
|
42370
42862
|
* OperationalEvents service.
|
|
42371
42863
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
42372
|
-
* @version
|
|
42864
|
+
* @version 216.0.0
|
|
42373
42865
|
*/
|
|
42374
42866
|
|
|
42375
42867
|
/**
|
|
@@ -42486,7 +42978,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42486
42978
|
/**
|
|
42487
42979
|
* Organization service.
|
|
42488
42980
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
42489
|
-
* @version
|
|
42981
|
+
* @version 216.0.0
|
|
42490
42982
|
*/
|
|
42491
42983
|
|
|
42492
42984
|
/**
|
|
@@ -43028,7 +43520,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43028
43520
|
/**
|
|
43029
43521
|
* OrganizationAuthorization service.
|
|
43030
43522
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
43031
|
-
* @version
|
|
43523
|
+
* @version 216.0.0
|
|
43032
43524
|
*/
|
|
43033
43525
|
|
|
43034
43526
|
/**
|
|
@@ -44422,7 +44914,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44422
44914
|
/**
|
|
44423
44915
|
* Outbound service.
|
|
44424
44916
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
44425
|
-
* @version
|
|
44917
|
+
* @version 216.0.0
|
|
44426
44918
|
*/
|
|
44427
44919
|
|
|
44428
44920
|
/**
|
|
@@ -48973,7 +49465,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48973
49465
|
/**
|
|
48974
49466
|
* Presence service.
|
|
48975
49467
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
48976
|
-
* @version
|
|
49468
|
+
* @version 216.0.0
|
|
48977
49469
|
*/
|
|
48978
49470
|
|
|
48979
49471
|
/**
|
|
@@ -49717,7 +50209,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49717
50209
|
/**
|
|
49718
50210
|
* ProcessAutomation service.
|
|
49719
50211
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
49720
|
-
* @version
|
|
50212
|
+
* @version 216.0.0
|
|
49721
50213
|
*/
|
|
49722
50214
|
|
|
49723
50215
|
/**
|
|
@@ -49956,7 +50448,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49956
50448
|
/**
|
|
49957
50449
|
* Quality service.
|
|
49958
50450
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
49959
|
-
* @version
|
|
50451
|
+
* @version 216.0.0
|
|
49960
50452
|
*/
|
|
49961
50453
|
|
|
49962
50454
|
/**
|
|
@@ -51744,7 +52236,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51744
52236
|
/**
|
|
51745
52237
|
* Recording service.
|
|
51746
52238
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
51747
|
-
* @version
|
|
52239
|
+
* @version 216.0.0
|
|
51748
52240
|
*/
|
|
51749
52241
|
|
|
51750
52242
|
/**
|
|
@@ -52734,36 +53226,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52734
53226
|
);
|
|
52735
53227
|
}
|
|
52736
53228
|
|
|
52737
|
-
/**
|
|
52738
|
-
* Update a screen recording session
|
|
52739
|
-
* This API is deprecated and the functionality to stop screen recording will be no longer supported.
|
|
52740
|
-
* @param {String} recordingSessionId Screen recording session ID
|
|
52741
|
-
* @param {Object} opts Optional parameters
|
|
52742
|
-
* @param {Object} opts.body
|
|
52743
|
-
* @deprecated
|
|
52744
|
-
*/
|
|
52745
|
-
patchRecordingsScreensession(recordingSessionId, opts) {
|
|
52746
|
-
opts = opts || {};
|
|
52747
|
-
|
|
52748
|
-
// verify the required parameter 'recordingSessionId' is set
|
|
52749
|
-
if (recordingSessionId === undefined || recordingSessionId === null) {
|
|
52750
|
-
throw 'Missing the required parameter "recordingSessionId" when calling patchRecordingsScreensession';
|
|
52751
|
-
}
|
|
52752
|
-
|
|
52753
|
-
return this.apiClient.callApi(
|
|
52754
|
-
'/api/v2/recordings/screensessions/{recordingSessionId}',
|
|
52755
|
-
'PATCH',
|
|
52756
|
-
{ 'recordingSessionId': recordingSessionId },
|
|
52757
|
-
{ },
|
|
52758
|
-
{ },
|
|
52759
|
-
{ },
|
|
52760
|
-
opts['body'],
|
|
52761
|
-
['PureCloud OAuth'],
|
|
52762
|
-
['application/json'],
|
|
52763
|
-
['application/json']
|
|
52764
|
-
);
|
|
52765
|
-
}
|
|
52766
|
-
|
|
52767
53229
|
/**
|
|
52768
53230
|
* Create annotation
|
|
52769
53231
|
*
|
|
@@ -53403,7 +53865,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53403
53865
|
/**
|
|
53404
53866
|
* ResponseManagement service.
|
|
53405
53867
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
53406
|
-
* @version
|
|
53868
|
+
* @version 216.0.0
|
|
53407
53869
|
*/
|
|
53408
53870
|
|
|
53409
53871
|
/**
|
|
@@ -53913,7 +54375,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53913
54375
|
/**
|
|
53914
54376
|
* Routing service.
|
|
53915
54377
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
53916
|
-
* @version
|
|
54378
|
+
* @version 216.0.0
|
|
53917
54379
|
*/
|
|
53918
54380
|
|
|
53919
54381
|
/**
|
|
@@ -58035,7 +58497,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58035
58497
|
/**
|
|
58036
58498
|
* SCIM service.
|
|
58037
58499
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
58038
|
-
* @version
|
|
58500
|
+
* @version 216.0.0
|
|
58039
58501
|
*/
|
|
58040
58502
|
|
|
58041
58503
|
/**
|
|
@@ -58912,7 +59374,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58912
59374
|
/**
|
|
58913
59375
|
* ScreenRecording service.
|
|
58914
59376
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
58915
|
-
* @version
|
|
59377
|
+
* @version 216.0.0
|
|
58916
59378
|
*/
|
|
58917
59379
|
|
|
58918
59380
|
/**
|
|
@@ -58957,7 +59419,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58957
59419
|
/**
|
|
58958
59420
|
* Scripts service.
|
|
58959
59421
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
58960
|
-
* @version
|
|
59422
|
+
* @version 216.0.0
|
|
58961
59423
|
*/
|
|
58962
59424
|
|
|
58963
59425
|
/**
|
|
@@ -59401,7 +59863,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59401
59863
|
/**
|
|
59402
59864
|
* Search service.
|
|
59403
59865
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
59404
|
-
* @version
|
|
59866
|
+
* @version 216.0.0
|
|
59405
59867
|
*/
|
|
59406
59868
|
|
|
59407
59869
|
/**
|
|
@@ -60144,7 +60606,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60144
60606
|
/**
|
|
60145
60607
|
* Settings service.
|
|
60146
60608
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
60147
|
-
* @version
|
|
60609
|
+
* @version 216.0.0
|
|
60148
60610
|
*/
|
|
60149
60611
|
|
|
60150
60612
|
/**
|
|
@@ -60364,7 +60826,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60364
60826
|
/**
|
|
60365
60827
|
* SocialMedia service.
|
|
60366
60828
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
60367
|
-
* @version
|
|
60829
|
+
* @version 216.0.0
|
|
60368
60830
|
*/
|
|
60369
60831
|
|
|
60370
60832
|
/**
|
|
@@ -61269,7 +61731,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61269
61731
|
/**
|
|
61270
61732
|
* SpeechTextAnalytics service.
|
|
61271
61733
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
61272
|
-
* @version
|
|
61734
|
+
* @version 216.0.0
|
|
61273
61735
|
*/
|
|
61274
61736
|
|
|
61275
61737
|
/**
|
|
@@ -61437,12 +61899,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61437
61899
|
* Get the list of Speech and Text Analytics categories
|
|
61438
61900
|
*
|
|
61439
61901
|
* @param {Object} opts Optional parameters
|
|
61440
|
-
* @param {Number} opts.pageSize The page size for the listing. The max that will be returned is
|
|
61902
|
+
* @param {Number} opts.pageSize The page size for the listing. The max that will be returned is 25. (default to 25)
|
|
61441
61903
|
* @param {Number} opts.pageNumber The page number for the listing (default to 1)
|
|
61442
61904
|
* @param {String} opts.name The category name filter applied to the listing
|
|
61443
61905
|
* @param {Object} opts.sortOrder The sort order for the listing (default to asc)
|
|
61444
61906
|
* @param {Object} opts.sortBy The field to sort by for the listing (default to name)
|
|
61445
|
-
* @param {Array.<String>} opts.ids Comma separated Category IDs to filter by. Cannot be used with other filters. Maximum of
|
|
61907
|
+
* @param {Array.<String>} opts.ids Comma separated Category IDs to filter by. Cannot be used with other filters. Maximum of 25 IDs allowed.
|
|
61446
61908
|
*/
|
|
61447
61909
|
getSpeechandtextanalyticsCategories(opts) {
|
|
61448
61910
|
opts = opts || {};
|
|
@@ -62710,7 +63172,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62710
63172
|
/**
|
|
62711
63173
|
* Stations service.
|
|
62712
63174
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
62713
|
-
* @version
|
|
63175
|
+
* @version 216.0.0
|
|
62714
63176
|
*/
|
|
62715
63177
|
|
|
62716
63178
|
/**
|
|
@@ -62812,7 +63274,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62812
63274
|
/**
|
|
62813
63275
|
* Suggest service.
|
|
62814
63276
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
62815
|
-
* @version
|
|
63277
|
+
* @version 216.0.0
|
|
62816
63278
|
*/
|
|
62817
63279
|
|
|
62818
63280
|
/**
|
|
@@ -62951,7 +63413,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62951
63413
|
/**
|
|
62952
63414
|
* TaskManagement service.
|
|
62953
63415
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
62954
|
-
* @version
|
|
63416
|
+
* @version 216.0.0
|
|
62955
63417
|
*/
|
|
62956
63418
|
|
|
62957
63419
|
/**
|
|
@@ -65057,7 +65519,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65057
65519
|
/**
|
|
65058
65520
|
* Teams service.
|
|
65059
65521
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
65060
|
-
* @version
|
|
65522
|
+
* @version 216.0.0
|
|
65061
65523
|
*/
|
|
65062
65524
|
|
|
65063
65525
|
/**
|
|
@@ -65362,7 +65824,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65362
65824
|
/**
|
|
65363
65825
|
* Telephony service.
|
|
65364
65826
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
65365
|
-
* @version
|
|
65827
|
+
* @version 216.0.0
|
|
65366
65828
|
*/
|
|
65367
65829
|
|
|
65368
65830
|
/**
|
|
@@ -65544,7 +66006,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65544
66006
|
/**
|
|
65545
66007
|
* TelephonyProvidersEdge service.
|
|
65546
66008
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
65547
|
-
* @version
|
|
66009
|
+
* @version 216.0.0
|
|
65548
66010
|
*/
|
|
65549
66011
|
|
|
65550
66012
|
/**
|
|
@@ -68995,7 +69457,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68995
69457
|
/**
|
|
68996
69458
|
* Textbots service.
|
|
68997
69459
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
68998
|
-
* @version
|
|
69460
|
+
* @version 216.0.0
|
|
68999
69461
|
*/
|
|
69000
69462
|
|
|
69001
69463
|
/**
|
|
@@ -69123,7 +69585,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69123
69585
|
/**
|
|
69124
69586
|
* Tokens service.
|
|
69125
69587
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
69126
|
-
* @version
|
|
69588
|
+
* @version 216.0.0
|
|
69127
69589
|
*/
|
|
69128
69590
|
|
|
69129
69591
|
/**
|
|
@@ -69277,7 +69739,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69277
69739
|
/**
|
|
69278
69740
|
* Uploads service.
|
|
69279
69741
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
69280
|
-
* @version
|
|
69742
|
+
* @version 216.0.0
|
|
69281
69743
|
*/
|
|
69282
69744
|
|
|
69283
69745
|
/**
|
|
@@ -69545,7 +70007,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69545
70007
|
/**
|
|
69546
70008
|
* Usage service.
|
|
69547
70009
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
69548
|
-
* @version
|
|
70010
|
+
* @version 216.0.0
|
|
69549
70011
|
*/
|
|
69550
70012
|
|
|
69551
70013
|
/**
|
|
@@ -69760,7 +70222,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69760
70222
|
/**
|
|
69761
70223
|
* UserRecordings service.
|
|
69762
70224
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
69763
|
-
* @version
|
|
70225
|
+
* @version 216.0.0
|
|
69764
70226
|
*/
|
|
69765
70227
|
|
|
69766
70228
|
/**
|
|
@@ -69975,7 +70437,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69975
70437
|
/**
|
|
69976
70438
|
* Users service.
|
|
69977
70439
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
69978
|
-
* @version
|
|
70440
|
+
* @version 216.0.0
|
|
69979
70441
|
*/
|
|
69980
70442
|
|
|
69981
70443
|
/**
|
|
@@ -72928,7 +73390,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
72928
73390
|
/**
|
|
72929
73391
|
* Utilities service.
|
|
72930
73392
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
72931
|
-
* @version
|
|
73393
|
+
* @version 216.0.0
|
|
72932
73394
|
*/
|
|
72933
73395
|
|
|
72934
73396
|
/**
|
|
@@ -73039,7 +73501,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
73039
73501
|
/**
|
|
73040
73502
|
* Voicemail service.
|
|
73041
73503
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
73042
|
-
* @version
|
|
73504
|
+
* @version 216.0.0
|
|
73043
73505
|
*/
|
|
73044
73506
|
|
|
73045
73507
|
/**
|
|
@@ -73761,7 +74223,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
73761
74223
|
/**
|
|
73762
74224
|
* WebChat service.
|
|
73763
74225
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
73764
|
-
* @version
|
|
74226
|
+
* @version 216.0.0
|
|
73765
74227
|
*/
|
|
73766
74228
|
|
|
73767
74229
|
/**
|
|
@@ -74312,7 +74774,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74312
74774
|
/**
|
|
74313
74775
|
* WebDeployments service.
|
|
74314
74776
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
74315
|
-
* @version
|
|
74777
|
+
* @version 216.0.0
|
|
74316
74778
|
*/
|
|
74317
74779
|
|
|
74318
74780
|
/**
|
|
@@ -74839,7 +75301,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74839
75301
|
/**
|
|
74840
75302
|
* WebMessaging service.
|
|
74841
75303
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
74842
|
-
* @version
|
|
75304
|
+
* @version 216.0.0
|
|
74843
75305
|
*/
|
|
74844
75306
|
|
|
74845
75307
|
/**
|
|
@@ -74885,7 +75347,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74885
75347
|
/**
|
|
74886
75348
|
* Widgets service.
|
|
74887
75349
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
74888
|
-
* @version
|
|
75350
|
+
* @version 216.0.0
|
|
74889
75351
|
*/
|
|
74890
75352
|
|
|
74891
75353
|
/**
|
|
@@ -75031,7 +75493,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75031
75493
|
/**
|
|
75032
75494
|
* WorkforceManagement service.
|
|
75033
75495
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
75034
|
-
* @version
|
|
75496
|
+
* @version 216.0.0
|
|
75035
75497
|
*/
|
|
75036
75498
|
|
|
75037
75499
|
/**
|
|
@@ -77555,6 +78017,51 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
77555
78017
|
);
|
|
77556
78018
|
}
|
|
77557
78019
|
|
|
78020
|
+
/**
|
|
78021
|
+
* Retrieves delete job status for historical data imports associated with the job id
|
|
78022
|
+
*
|
|
78023
|
+
* @param {String} jobId The job ID of the historical data delete request
|
|
78024
|
+
*/
|
|
78025
|
+
getWorkforcemanagementHistoricaldataBulkRemoveJob(jobId) {
|
|
78026
|
+
// verify the required parameter 'jobId' is set
|
|
78027
|
+
if (jobId === undefined || jobId === null) {
|
|
78028
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementHistoricaldataBulkRemoveJob';
|
|
78029
|
+
}
|
|
78030
|
+
|
|
78031
|
+
return this.apiClient.callApi(
|
|
78032
|
+
'/api/v2/workforcemanagement/historicaldata/bulk/remove/jobs/{jobId}',
|
|
78033
|
+
'GET',
|
|
78034
|
+
{ 'jobId': jobId },
|
|
78035
|
+
{ },
|
|
78036
|
+
{ },
|
|
78037
|
+
{ },
|
|
78038
|
+
null,
|
|
78039
|
+
['PureCloud OAuth'],
|
|
78040
|
+
['application/json'],
|
|
78041
|
+
['application/json']
|
|
78042
|
+
);
|
|
78043
|
+
}
|
|
78044
|
+
|
|
78045
|
+
/**
|
|
78046
|
+
* Retrieves all delete job status for historical data
|
|
78047
|
+
*
|
|
78048
|
+
*/
|
|
78049
|
+
getWorkforcemanagementHistoricaldataBulkRemoveJobs() {
|
|
78050
|
+
|
|
78051
|
+
return this.apiClient.callApi(
|
|
78052
|
+
'/api/v2/workforcemanagement/historicaldata/bulk/remove/jobs',
|
|
78053
|
+
'GET',
|
|
78054
|
+
{ },
|
|
78055
|
+
{ },
|
|
78056
|
+
{ },
|
|
78057
|
+
{ },
|
|
78058
|
+
null,
|
|
78059
|
+
['PureCloud OAuth'],
|
|
78060
|
+
['application/json'],
|
|
78061
|
+
['application/json']
|
|
78062
|
+
);
|
|
78063
|
+
}
|
|
78064
|
+
|
|
77558
78065
|
/**
|
|
77559
78066
|
* Retrieves delete job status for historical data imports of the organization
|
|
77560
78067
|
*
|
|
@@ -81104,6 +81611,30 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
81104
81611
|
);
|
|
81105
81612
|
}
|
|
81106
81613
|
|
|
81614
|
+
/**
|
|
81615
|
+
* Delete the list of the historical data import entries
|
|
81616
|
+
*
|
|
81617
|
+
* @param {Object} opts Optional parameters
|
|
81618
|
+
* @param {Object} opts.body body
|
|
81619
|
+
*/
|
|
81620
|
+
postWorkforcemanagementHistoricaldataBulkRemoveJobs(opts) {
|
|
81621
|
+
opts = opts || {};
|
|
81622
|
+
|
|
81623
|
+
|
|
81624
|
+
return this.apiClient.callApi(
|
|
81625
|
+
'/api/v2/workforcemanagement/historicaldata/bulk/remove/jobs',
|
|
81626
|
+
'POST',
|
|
81627
|
+
{ },
|
|
81628
|
+
{ },
|
|
81629
|
+
{ },
|
|
81630
|
+
{ },
|
|
81631
|
+
opts['body'],
|
|
81632
|
+
['PureCloud OAuth'],
|
|
81633
|
+
['application/json'],
|
|
81634
|
+
['application/json']
|
|
81635
|
+
);
|
|
81636
|
+
}
|
|
81637
|
+
|
|
81107
81638
|
/**
|
|
81108
81639
|
* Delete the entries of the historical data imports in the organization
|
|
81109
81640
|
*
|
|
@@ -82355,7 +82886,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
82355
82886
|
* </pre>
|
|
82356
82887
|
* </p>
|
|
82357
82888
|
* @module purecloud-platform-client-v2/index
|
|
82358
|
-
* @version
|
|
82889
|
+
* @version 216.0.0
|
|
82359
82890
|
*/
|
|
82360
82891
|
class platformClient {
|
|
82361
82892
|
constructor() {
|