purecloud-platform-client-v2 134.0.1 → 136.1.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 +32 -29
- package/dist/node/purecloud-platform-client-v2.js +637 -214
- package/dist/web-amd/purecloud-platform-client-v2.js +637 -214
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +637 -214
- package/dist/web-cjs/purecloud-platform-client-v2.js +647 -225
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +895 -425
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +2 -2
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +50 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.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 +5 -5
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
- 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 +29 -29
- 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/IntegrationsApi.js +11 -9
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -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/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/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +226 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -51
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +132 -5
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +7 -3
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +69 -3
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- 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/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +2 -2
- 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 +51 -51
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -5,7 +5,7 @@ class OutboundApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Outbound service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 136.1.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -355,6 +355,31 @@ class OutboundApi {
|
|
|
355
355
|
);
|
|
356
356
|
}
|
|
357
357
|
|
|
358
|
+
/**
|
|
359
|
+
* Reset messaging campaign progress and recycle the messaging campaign
|
|
360
|
+
*
|
|
361
|
+
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
362
|
+
*/
|
|
363
|
+
deleteOutboundMessagingcampaignProgress(messagingCampaignId) {
|
|
364
|
+
// verify the required parameter 'messagingCampaignId' is set
|
|
365
|
+
if (messagingCampaignId === undefined || messagingCampaignId === null) {
|
|
366
|
+
throw 'Missing the required parameter "messagingCampaignId" when calling deleteOutboundMessagingcampaignProgress';
|
|
367
|
+
}
|
|
368
|
+
|
|
369
|
+
return this.apiClient.callApi(
|
|
370
|
+
'/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/progress',
|
|
371
|
+
'DELETE',
|
|
372
|
+
{ 'messagingCampaignId': messagingCampaignId },
|
|
373
|
+
{ },
|
|
374
|
+
{ },
|
|
375
|
+
{ },
|
|
376
|
+
null,
|
|
377
|
+
['PureCloud OAuth'],
|
|
378
|
+
['application/json'],
|
|
379
|
+
['application/json']
|
|
380
|
+
);
|
|
381
|
+
}
|
|
382
|
+
|
|
358
383
|
/**
|
|
359
384
|
* Delete a Rule Set.
|
|
360
385
|
*
|
|
@@ -405,6 +430,56 @@ class OutboundApi {
|
|
|
405
430
|
);
|
|
406
431
|
}
|
|
407
432
|
|
|
433
|
+
/**
|
|
434
|
+
* Delete an email campaign schedule.
|
|
435
|
+
*
|
|
436
|
+
* @param {String} emailCampaignId Email Campaign ID
|
|
437
|
+
*/
|
|
438
|
+
deleteOutboundSchedulesEmailcampaign(emailCampaignId) {
|
|
439
|
+
// verify the required parameter 'emailCampaignId' is set
|
|
440
|
+
if (emailCampaignId === undefined || emailCampaignId === null) {
|
|
441
|
+
throw 'Missing the required parameter "emailCampaignId" when calling deleteOutboundSchedulesEmailcampaign';
|
|
442
|
+
}
|
|
443
|
+
|
|
444
|
+
return this.apiClient.callApi(
|
|
445
|
+
'/api/v2/outbound/schedules/emailcampaigns/{emailCampaignId}',
|
|
446
|
+
'DELETE',
|
|
447
|
+
{ 'emailCampaignId': emailCampaignId },
|
|
448
|
+
{ },
|
|
449
|
+
{ },
|
|
450
|
+
{ },
|
|
451
|
+
null,
|
|
452
|
+
['PureCloud OAuth'],
|
|
453
|
+
['application/json'],
|
|
454
|
+
['application/json']
|
|
455
|
+
);
|
|
456
|
+
}
|
|
457
|
+
|
|
458
|
+
/**
|
|
459
|
+
* Delete a messaging campaign schedule.
|
|
460
|
+
*
|
|
461
|
+
* @param {String} messagingCampaignId Messaging Campaign ID
|
|
462
|
+
*/
|
|
463
|
+
deleteOutboundSchedulesMessagingcampaign(messagingCampaignId) {
|
|
464
|
+
// verify the required parameter 'messagingCampaignId' is set
|
|
465
|
+
if (messagingCampaignId === undefined || messagingCampaignId === null) {
|
|
466
|
+
throw 'Missing the required parameter "messagingCampaignId" when calling deleteOutboundSchedulesMessagingcampaign';
|
|
467
|
+
}
|
|
468
|
+
|
|
469
|
+
return this.apiClient.callApi(
|
|
470
|
+
'/api/v2/outbound/schedules/messagingcampaigns/{messagingCampaignId}',
|
|
471
|
+
'DELETE',
|
|
472
|
+
{ 'messagingCampaignId': messagingCampaignId },
|
|
473
|
+
{ },
|
|
474
|
+
{ },
|
|
475
|
+
{ },
|
|
476
|
+
null,
|
|
477
|
+
['PureCloud OAuth'],
|
|
478
|
+
['application/json'],
|
|
479
|
+
['application/json']
|
|
480
|
+
);
|
|
481
|
+
}
|
|
482
|
+
|
|
408
483
|
/**
|
|
409
484
|
* Delete a dialer sequence schedule.
|
|
410
485
|
*
|
|
@@ -1741,6 +1816,96 @@ class OutboundApi {
|
|
|
1741
1816
|
);
|
|
1742
1817
|
}
|
|
1743
1818
|
|
|
1819
|
+
/**
|
|
1820
|
+
* Get an email campaign schedule.
|
|
1821
|
+
*
|
|
1822
|
+
* @param {String} emailCampaignId Email Campaign ID
|
|
1823
|
+
*/
|
|
1824
|
+
getOutboundSchedulesEmailcampaign(emailCampaignId) {
|
|
1825
|
+
// verify the required parameter 'emailCampaignId' is set
|
|
1826
|
+
if (emailCampaignId === undefined || emailCampaignId === null) {
|
|
1827
|
+
throw 'Missing the required parameter "emailCampaignId" when calling getOutboundSchedulesEmailcampaign';
|
|
1828
|
+
}
|
|
1829
|
+
|
|
1830
|
+
return this.apiClient.callApi(
|
|
1831
|
+
'/api/v2/outbound/schedules/emailcampaigns/{emailCampaignId}',
|
|
1832
|
+
'GET',
|
|
1833
|
+
{ 'emailCampaignId': emailCampaignId },
|
|
1834
|
+
{ },
|
|
1835
|
+
{ },
|
|
1836
|
+
{ },
|
|
1837
|
+
null,
|
|
1838
|
+
['PureCloud OAuth'],
|
|
1839
|
+
['application/json'],
|
|
1840
|
+
['application/json']
|
|
1841
|
+
);
|
|
1842
|
+
}
|
|
1843
|
+
|
|
1844
|
+
/**
|
|
1845
|
+
* Query for a list of email campaign schedules.
|
|
1846
|
+
*
|
|
1847
|
+
*/
|
|
1848
|
+
getOutboundSchedulesEmailcampaigns() {
|
|
1849
|
+
|
|
1850
|
+
return this.apiClient.callApi(
|
|
1851
|
+
'/api/v2/outbound/schedules/emailcampaigns',
|
|
1852
|
+
'GET',
|
|
1853
|
+
{ },
|
|
1854
|
+
{ },
|
|
1855
|
+
{ },
|
|
1856
|
+
{ },
|
|
1857
|
+
null,
|
|
1858
|
+
['PureCloud OAuth'],
|
|
1859
|
+
['application/json'],
|
|
1860
|
+
['application/json']
|
|
1861
|
+
);
|
|
1862
|
+
}
|
|
1863
|
+
|
|
1864
|
+
/**
|
|
1865
|
+
* Get a messaging campaign schedule.
|
|
1866
|
+
*
|
|
1867
|
+
* @param {String} messagingCampaignId Messaging Campaign ID
|
|
1868
|
+
*/
|
|
1869
|
+
getOutboundSchedulesMessagingcampaign(messagingCampaignId) {
|
|
1870
|
+
// verify the required parameter 'messagingCampaignId' is set
|
|
1871
|
+
if (messagingCampaignId === undefined || messagingCampaignId === null) {
|
|
1872
|
+
throw 'Missing the required parameter "messagingCampaignId" when calling getOutboundSchedulesMessagingcampaign';
|
|
1873
|
+
}
|
|
1874
|
+
|
|
1875
|
+
return this.apiClient.callApi(
|
|
1876
|
+
'/api/v2/outbound/schedules/messagingcampaigns/{messagingCampaignId}',
|
|
1877
|
+
'GET',
|
|
1878
|
+
{ 'messagingCampaignId': messagingCampaignId },
|
|
1879
|
+
{ },
|
|
1880
|
+
{ },
|
|
1881
|
+
{ },
|
|
1882
|
+
null,
|
|
1883
|
+
['PureCloud OAuth'],
|
|
1884
|
+
['application/json'],
|
|
1885
|
+
['application/json']
|
|
1886
|
+
);
|
|
1887
|
+
}
|
|
1888
|
+
|
|
1889
|
+
/**
|
|
1890
|
+
* Query for a list of messaging campaign schedules.
|
|
1891
|
+
*
|
|
1892
|
+
*/
|
|
1893
|
+
getOutboundSchedulesMessagingcampaigns() {
|
|
1894
|
+
|
|
1895
|
+
return this.apiClient.callApi(
|
|
1896
|
+
'/api/v2/outbound/schedules/messagingcampaigns',
|
|
1897
|
+
'GET',
|
|
1898
|
+
{ },
|
|
1899
|
+
{ },
|
|
1900
|
+
{ },
|
|
1901
|
+
{ },
|
|
1902
|
+
null,
|
|
1903
|
+
['PureCloud OAuth'],
|
|
1904
|
+
['application/json'],
|
|
1905
|
+
['application/json']
|
|
1906
|
+
);
|
|
1907
|
+
}
|
|
1908
|
+
|
|
1744
1909
|
/**
|
|
1745
1910
|
* Get a dialer sequence schedule.
|
|
1746
1911
|
*
|
|
@@ -2944,6 +3109,66 @@ class OutboundApi {
|
|
|
2944
3109
|
);
|
|
2945
3110
|
}
|
|
2946
3111
|
|
|
3112
|
+
/**
|
|
3113
|
+
* Update an email campaign schedule.
|
|
3114
|
+
*
|
|
3115
|
+
* @param {String} emailCampaignId Email Campaign ID
|
|
3116
|
+
* @param {Object} body EmailCampaignSchedule
|
|
3117
|
+
*/
|
|
3118
|
+
putOutboundSchedulesEmailcampaign(emailCampaignId, body) {
|
|
3119
|
+
// verify the required parameter 'emailCampaignId' is set
|
|
3120
|
+
if (emailCampaignId === undefined || emailCampaignId === null) {
|
|
3121
|
+
throw 'Missing the required parameter "emailCampaignId" when calling putOutboundSchedulesEmailcampaign';
|
|
3122
|
+
}
|
|
3123
|
+
// verify the required parameter 'body' is set
|
|
3124
|
+
if (body === undefined || body === null) {
|
|
3125
|
+
throw 'Missing the required parameter "body" when calling putOutboundSchedulesEmailcampaign';
|
|
3126
|
+
}
|
|
3127
|
+
|
|
3128
|
+
return this.apiClient.callApi(
|
|
3129
|
+
'/api/v2/outbound/schedules/emailcampaigns/{emailCampaignId}',
|
|
3130
|
+
'PUT',
|
|
3131
|
+
{ 'emailCampaignId': emailCampaignId },
|
|
3132
|
+
{ },
|
|
3133
|
+
{ },
|
|
3134
|
+
{ },
|
|
3135
|
+
body,
|
|
3136
|
+
['PureCloud OAuth'],
|
|
3137
|
+
['application/json'],
|
|
3138
|
+
['application/json']
|
|
3139
|
+
);
|
|
3140
|
+
}
|
|
3141
|
+
|
|
3142
|
+
/**
|
|
3143
|
+
* Update a new messaging campaign schedule.
|
|
3144
|
+
*
|
|
3145
|
+
* @param {String} messagingCampaignId Messaging Campaign ID
|
|
3146
|
+
* @param {Object} body MessagingCampaignSchedule
|
|
3147
|
+
*/
|
|
3148
|
+
putOutboundSchedulesMessagingcampaign(messagingCampaignId, body) {
|
|
3149
|
+
// verify the required parameter 'messagingCampaignId' is set
|
|
3150
|
+
if (messagingCampaignId === undefined || messagingCampaignId === null) {
|
|
3151
|
+
throw 'Missing the required parameter "messagingCampaignId" when calling putOutboundSchedulesMessagingcampaign';
|
|
3152
|
+
}
|
|
3153
|
+
// verify the required parameter 'body' is set
|
|
3154
|
+
if (body === undefined || body === null) {
|
|
3155
|
+
throw 'Missing the required parameter "body" when calling putOutboundSchedulesMessagingcampaign';
|
|
3156
|
+
}
|
|
3157
|
+
|
|
3158
|
+
return this.apiClient.callApi(
|
|
3159
|
+
'/api/v2/outbound/schedules/messagingcampaigns/{messagingCampaignId}',
|
|
3160
|
+
'PUT',
|
|
3161
|
+
{ 'messagingCampaignId': messagingCampaignId },
|
|
3162
|
+
{ },
|
|
3163
|
+
{ },
|
|
3164
|
+
{ },
|
|
3165
|
+
body,
|
|
3166
|
+
['PureCloud OAuth'],
|
|
3167
|
+
['application/json'],
|
|
3168
|
+
['application/json']
|
|
3169
|
+
);
|
|
3170
|
+
}
|
|
3171
|
+
|
|
2947
3172
|
/**
|
|
2948
3173
|
* Update a new sequence schedule.
|
|
2949
3174
|
*
|
|
@@ -5,7 +5,7 @@ class PresenceApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Presence service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 136.1.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -151,31 +151,6 @@ class PresenceApi {
|
|
|
151
151
|
);
|
|
152
152
|
}
|
|
153
153
|
|
|
154
|
-
/**
|
|
155
|
-
* Get a user's Microsoft Teams presence.
|
|
156
|
-
* Gets the presence for a Microsoft Teams user. This will return the Microsoft Teams presence mapped to Genesys Cloud presence with additional activity details in the message field. This presence source is read-only.
|
|
157
|
-
* @param {String} userId user Id
|
|
158
|
-
*/
|
|
159
|
-
getUserPresencesMicrosoftteams(userId) {
|
|
160
|
-
// verify the required parameter 'userId' is set
|
|
161
|
-
if (userId === undefined || userId === null) {
|
|
162
|
-
throw 'Missing the required parameter "userId" when calling getUserPresencesMicrosoftteams';
|
|
163
|
-
}
|
|
164
|
-
|
|
165
|
-
return this.apiClient.callApi(
|
|
166
|
-
'/api/v2/users/{userId}/presences/microsoftteams',
|
|
167
|
-
'GET',
|
|
168
|
-
{ 'userId': userId },
|
|
169
|
-
{ },
|
|
170
|
-
{ },
|
|
171
|
-
{ },
|
|
172
|
-
null,
|
|
173
|
-
['PureCloud OAuth'],
|
|
174
|
-
['application/json'],
|
|
175
|
-
['application/json']
|
|
176
|
-
);
|
|
177
|
-
}
|
|
178
|
-
|
|
179
154
|
/**
|
|
180
155
|
* Get a user's Genesys Cloud presence.
|
|
181
156
|
* Get the default Genesys Cloud user presence source PURECLOUD
|
|
@@ -201,31 +176,6 @@ class PresenceApi {
|
|
|
201
176
|
);
|
|
202
177
|
}
|
|
203
178
|
|
|
204
|
-
/**
|
|
205
|
-
* Get a user's Zoom Phone presence.
|
|
206
|
-
* Gets the presence for a Zoom user. This will return the Zoom Phone presence mapped to Genesys Cloud presence with additional activity details in the message field. This presence source is read-only.
|
|
207
|
-
* @param {String} userId user Id
|
|
208
|
-
*/
|
|
209
|
-
getUserPresencesZoomphone(userId) {
|
|
210
|
-
// verify the required parameter 'userId' is set
|
|
211
|
-
if (userId === undefined || userId === null) {
|
|
212
|
-
throw 'Missing the required parameter "userId" when calling getUserPresencesZoomphone';
|
|
213
|
-
}
|
|
214
|
-
|
|
215
|
-
return this.apiClient.callApi(
|
|
216
|
-
'/api/v2/users/{userId}/presences/zoomphone',
|
|
217
|
-
'GET',
|
|
218
|
-
{ 'userId': userId },
|
|
219
|
-
{ },
|
|
220
|
-
{ },
|
|
221
|
-
{ },
|
|
222
|
-
null,
|
|
223
|
-
['PureCloud OAuth'],
|
|
224
|
-
['application/json'],
|
|
225
|
-
['application/json']
|
|
226
|
-
);
|
|
227
|
-
}
|
|
228
|
-
|
|
229
179
|
/**
|
|
230
180
|
* Patch a user's Presence
|
|
231
181
|
* Patch a user's presence for the specified source that is not specifically listed. The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the 'source' defined in the path as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.
|
|
@@ -5,7 +5,7 @@ class RecordingApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Recording service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 136.1.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -528,6 +528,7 @@ class RecordingApi {
|
|
|
528
528
|
* @param {Boolean} opts.enabled checks to see if policy is enabled - use enabled = true or enabled = false
|
|
529
529
|
* @param {Boolean} opts.summary provides a less verbose response of policy lists. (default to false)
|
|
530
530
|
* @param {Boolean} opts.hasErrors provides a way to fetch all policies with errors or policies that do not have errors
|
|
531
|
+
* @param {Number} opts.deleteDaysThreshold provides a way to fetch all policies with any actions having deleteDays exceeding the provided value
|
|
531
532
|
*/
|
|
532
533
|
getRecordingCrossplatformMediaretentionpolicies(opts) {
|
|
533
534
|
opts = opts || {};
|
|
@@ -537,7 +538,7 @@ class RecordingApi {
|
|
|
537
538
|
'/api/v2/recording/crossplatform/mediaretentionpolicies',
|
|
538
539
|
'GET',
|
|
539
540
|
{ },
|
|
540
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'name': opts['name'],'enabled': opts['enabled'],'summary': opts['summary'],'hasErrors': opts['hasErrors'] },
|
|
541
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'name': opts['name'],'enabled': opts['enabled'],'summary': opts['summary'],'hasErrors': opts['hasErrors'],'deleteDaysThreshold': opts['deleteDaysThreshold'] },
|
|
541
542
|
{ },
|
|
542
543
|
{ },
|
|
543
544
|
null,
|
|
@@ -660,6 +661,51 @@ class RecordingApi {
|
|
|
660
661
|
);
|
|
661
662
|
}
|
|
662
663
|
|
|
664
|
+
/**
|
|
665
|
+
* Get the encryption key configurations
|
|
666
|
+
*
|
|
667
|
+
* @param {String} keyConfigurationId Key Configurations Id
|
|
668
|
+
*/
|
|
669
|
+
getRecordingKeyconfiguration(keyConfigurationId) {
|
|
670
|
+
// verify the required parameter 'keyConfigurationId' is set
|
|
671
|
+
if (keyConfigurationId === undefined || keyConfigurationId === null) {
|
|
672
|
+
throw 'Missing the required parameter "keyConfigurationId" when calling getRecordingKeyconfiguration';
|
|
673
|
+
}
|
|
674
|
+
|
|
675
|
+
return this.apiClient.callApi(
|
|
676
|
+
'/api/v2/recording/keyconfigurations/{keyConfigurationId}',
|
|
677
|
+
'GET',
|
|
678
|
+
{ 'keyConfigurationId': keyConfigurationId },
|
|
679
|
+
{ },
|
|
680
|
+
{ },
|
|
681
|
+
{ },
|
|
682
|
+
null,
|
|
683
|
+
['PureCloud OAuth'],
|
|
684
|
+
['application/json'],
|
|
685
|
+
['application/json']
|
|
686
|
+
);
|
|
687
|
+
}
|
|
688
|
+
|
|
689
|
+
/**
|
|
690
|
+
* Get a list of key configurations data
|
|
691
|
+
*
|
|
692
|
+
*/
|
|
693
|
+
getRecordingKeyconfigurations() {
|
|
694
|
+
|
|
695
|
+
return this.apiClient.callApi(
|
|
696
|
+
'/api/v2/recording/keyconfigurations',
|
|
697
|
+
'GET',
|
|
698
|
+
{ },
|
|
699
|
+
{ },
|
|
700
|
+
{ },
|
|
701
|
+
{ },
|
|
702
|
+
null,
|
|
703
|
+
['PureCloud OAuth'],
|
|
704
|
+
['application/json'],
|
|
705
|
+
['application/json']
|
|
706
|
+
);
|
|
707
|
+
}
|
|
708
|
+
|
|
663
709
|
/**
|
|
664
710
|
* Get the local encryption settings
|
|
665
711
|
*
|
|
@@ -719,6 +765,7 @@ class RecordingApi {
|
|
|
719
765
|
* @param {Boolean} opts.enabled checks to see if policy is enabled - use enabled = true or enabled = false
|
|
720
766
|
* @param {Boolean} opts.summary provides a less verbose response of policy lists. (default to false)
|
|
721
767
|
* @param {Boolean} opts.hasErrors provides a way to fetch all policies with errors or policies that do not have errors
|
|
768
|
+
* @param {Number} opts.deleteDaysThreshold provides a way to fetch all policies with any actions having deleteDays exceeding the provided value
|
|
722
769
|
*/
|
|
723
770
|
getRecordingMediaretentionpolicies(opts) {
|
|
724
771
|
opts = opts || {};
|
|
@@ -728,7 +775,7 @@ class RecordingApi {
|
|
|
728
775
|
'/api/v2/recording/mediaretentionpolicies',
|
|
729
776
|
'GET',
|
|
730
777
|
{ },
|
|
731
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'name': opts['name'],'enabled': opts['enabled'],'summary': opts['summary'],'hasErrors': opts['hasErrors'] },
|
|
778
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'name': opts['name'],'enabled': opts['enabled'],'summary': opts['summary'],'hasErrors': opts['hasErrors'],'deleteDaysThreshold': opts['deleteDaysThreshold'] },
|
|
732
779
|
{ },
|
|
733
780
|
{ },
|
|
734
781
|
null,
|
|
@@ -1032,8 +1079,8 @@ class RecordingApi {
|
|
|
1032
1079
|
}
|
|
1033
1080
|
|
|
1034
1081
|
/**
|
|
1035
|
-
* Create a recording bulk job
|
|
1036
|
-
*
|
|
1082
|
+
* Create a recording bulk job.
|
|
1083
|
+
* Each organization can run up to a maximum of two concurrent jobs that are either in pending or processing state.
|
|
1037
1084
|
* @param {Object} body query
|
|
1038
1085
|
*/
|
|
1039
1086
|
postRecordingJobs(body) {
|
|
@@ -1056,6 +1103,56 @@ class RecordingApi {
|
|
|
1056
1103
|
);
|
|
1057
1104
|
}
|
|
1058
1105
|
|
|
1106
|
+
/**
|
|
1107
|
+
* Setup configurations for encryption key creation
|
|
1108
|
+
*
|
|
1109
|
+
* @param {Object} body Encryption Configuration
|
|
1110
|
+
*/
|
|
1111
|
+
postRecordingKeyconfigurations(body) {
|
|
1112
|
+
// verify the required parameter 'body' is set
|
|
1113
|
+
if (body === undefined || body === null) {
|
|
1114
|
+
throw 'Missing the required parameter "body" when calling postRecordingKeyconfigurations';
|
|
1115
|
+
}
|
|
1116
|
+
|
|
1117
|
+
return this.apiClient.callApi(
|
|
1118
|
+
'/api/v2/recording/keyconfigurations',
|
|
1119
|
+
'POST',
|
|
1120
|
+
{ },
|
|
1121
|
+
{ },
|
|
1122
|
+
{ },
|
|
1123
|
+
{ },
|
|
1124
|
+
body,
|
|
1125
|
+
['PureCloud OAuth'],
|
|
1126
|
+
['application/json'],
|
|
1127
|
+
['application/json']
|
|
1128
|
+
);
|
|
1129
|
+
}
|
|
1130
|
+
|
|
1131
|
+
/**
|
|
1132
|
+
* Validate encryption key configurations without saving it
|
|
1133
|
+
*
|
|
1134
|
+
* @param {Object} body Encryption Configuration
|
|
1135
|
+
*/
|
|
1136
|
+
postRecordingKeyconfigurationsValidate(body) {
|
|
1137
|
+
// verify the required parameter 'body' is set
|
|
1138
|
+
if (body === undefined || body === null) {
|
|
1139
|
+
throw 'Missing the required parameter "body" when calling postRecordingKeyconfigurationsValidate';
|
|
1140
|
+
}
|
|
1141
|
+
|
|
1142
|
+
return this.apiClient.callApi(
|
|
1143
|
+
'/api/v2/recording/keyconfigurations/validate',
|
|
1144
|
+
'POST',
|
|
1145
|
+
{ },
|
|
1146
|
+
{ },
|
|
1147
|
+
{ },
|
|
1148
|
+
{ },
|
|
1149
|
+
body,
|
|
1150
|
+
['PureCloud OAuth'],
|
|
1151
|
+
['application/json'],
|
|
1152
|
+
['application/json']
|
|
1153
|
+
);
|
|
1154
|
+
}
|
|
1155
|
+
|
|
1059
1156
|
/**
|
|
1060
1157
|
* create a local recording key
|
|
1061
1158
|
*
|
|
@@ -1390,6 +1487,36 @@ class RecordingApi {
|
|
|
1390
1487
|
);
|
|
1391
1488
|
}
|
|
1392
1489
|
|
|
1490
|
+
/**
|
|
1491
|
+
* Update the encryption key configurations
|
|
1492
|
+
*
|
|
1493
|
+
* @param {String} keyConfigurationId Key Configurations Id
|
|
1494
|
+
* @param {Object} body Encryption key configuration metadata
|
|
1495
|
+
*/
|
|
1496
|
+
putRecordingKeyconfiguration(keyConfigurationId, body) {
|
|
1497
|
+
// verify the required parameter 'keyConfigurationId' is set
|
|
1498
|
+
if (keyConfigurationId === undefined || keyConfigurationId === null) {
|
|
1499
|
+
throw 'Missing the required parameter "keyConfigurationId" when calling putRecordingKeyconfiguration';
|
|
1500
|
+
}
|
|
1501
|
+
// verify the required parameter 'body' is set
|
|
1502
|
+
if (body === undefined || body === null) {
|
|
1503
|
+
throw 'Missing the required parameter "body" when calling putRecordingKeyconfiguration';
|
|
1504
|
+
}
|
|
1505
|
+
|
|
1506
|
+
return this.apiClient.callApi(
|
|
1507
|
+
'/api/v2/recording/keyconfigurations/{keyConfigurationId}',
|
|
1508
|
+
'PUT',
|
|
1509
|
+
{ 'keyConfigurationId': keyConfigurationId },
|
|
1510
|
+
{ },
|
|
1511
|
+
{ },
|
|
1512
|
+
{ },
|
|
1513
|
+
body,
|
|
1514
|
+
['PureCloud OAuth'],
|
|
1515
|
+
['application/json'],
|
|
1516
|
+
['application/json']
|
|
1517
|
+
);
|
|
1518
|
+
}
|
|
1519
|
+
|
|
1393
1520
|
/**
|
|
1394
1521
|
* Update the local encryption settings
|
|
1395
1522
|
*
|
|
@@ -5,7 +5,7 @@ class RoutingApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Routing service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 136.1.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -664,14 +664,18 @@ class RoutingApi {
|
|
|
664
664
|
/**
|
|
665
665
|
* Get domains
|
|
666
666
|
*
|
|
667
|
+
* @param {Object} opts Optional parameters
|
|
668
|
+
* @param {Boolean} opts.excludeStatus Exclude MX record data (default to false)
|
|
667
669
|
*/
|
|
668
|
-
getRoutingEmailDomains() {
|
|
670
|
+
getRoutingEmailDomains(opts) {
|
|
671
|
+
opts = opts || {};
|
|
672
|
+
|
|
669
673
|
|
|
670
674
|
return this.apiClient.callApi(
|
|
671
675
|
'/api/v2/routing/email/domains',
|
|
672
676
|
'GET',
|
|
673
677
|
{ },
|
|
674
|
-
{
|
|
678
|
+
{ 'excludeStatus': opts['excludeStatus'] },
|
|
675
679
|
{ },
|
|
676
680
|
{ },
|
|
677
681
|
null,
|
|
@@ -5,7 +5,7 @@ class ScriptsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Scripts service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 136.1.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -121,6 +121,7 @@ class ScriptsApi {
|
|
|
121
121
|
* @param {Object} opts.sortBy SortBy
|
|
122
122
|
* @param {Object} opts.sortOrder SortOrder
|
|
123
123
|
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
124
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
124
125
|
*/
|
|
125
126
|
getScripts(opts) {
|
|
126
127
|
opts = opts || {};
|
|
@@ -130,7 +131,40 @@ class ScriptsApi {
|
|
|
130
131
|
'/api/v2/scripts',
|
|
131
132
|
'GET',
|
|
132
133
|
{ },
|
|
133
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'scriptDataVersion': opts['scriptDataVersion'] },
|
|
134
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'scriptDataVersion': opts['scriptDataVersion'],'divisionIds': opts['divisionIds'] },
|
|
135
|
+
{ },
|
|
136
|
+
{ },
|
|
137
|
+
null,
|
|
138
|
+
['PureCloud OAuth'],
|
|
139
|
+
['application/json'],
|
|
140
|
+
['application/json']
|
|
141
|
+
);
|
|
142
|
+
}
|
|
143
|
+
|
|
144
|
+
/**
|
|
145
|
+
* Get the metadata for a list of scripts
|
|
146
|
+
*
|
|
147
|
+
* @param {Object} opts Optional parameters
|
|
148
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
149
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
150
|
+
* @param {String} opts.expand Expand
|
|
151
|
+
* @param {String} opts.name Name filter
|
|
152
|
+
* @param {String} opts.feature Feature filter
|
|
153
|
+
* @param {String} opts.flowId Secure flow id filter
|
|
154
|
+
* @param {Object} opts.sortBy SortBy
|
|
155
|
+
* @param {Object} opts.sortOrder SortOrder
|
|
156
|
+
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
157
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
158
|
+
*/
|
|
159
|
+
getScriptsDivisionviews(opts) {
|
|
160
|
+
opts = opts || {};
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
return this.apiClient.callApi(
|
|
164
|
+
'/api/v2/scripts/divisionviews',
|
|
165
|
+
'GET',
|
|
166
|
+
{ },
|
|
167
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'scriptDataVersion': opts['scriptDataVersion'],'divisionIds': opts['divisionIds'] },
|
|
134
168
|
{ },
|
|
135
169
|
{ },
|
|
136
170
|
null,
|
|
@@ -151,6 +185,7 @@ class ScriptsApi {
|
|
|
151
185
|
* @param {String} opts.feature Feature filter
|
|
152
186
|
* @param {String} opts.flowId Secure flow id filter
|
|
153
187
|
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
188
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
154
189
|
*/
|
|
155
190
|
getScriptsPublished(opts) {
|
|
156
191
|
opts = opts || {};
|
|
@@ -160,7 +195,38 @@ class ScriptsApi {
|
|
|
160
195
|
'/api/v2/scripts/published',
|
|
161
196
|
'GET',
|
|
162
197
|
{ },
|
|
163
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'scriptDataVersion': opts['scriptDataVersion'] },
|
|
198
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'scriptDataVersion': opts['scriptDataVersion'],'divisionIds': opts['divisionIds'] },
|
|
199
|
+
{ },
|
|
200
|
+
{ },
|
|
201
|
+
null,
|
|
202
|
+
['PureCloud OAuth'],
|
|
203
|
+
['application/json'],
|
|
204
|
+
['application/json']
|
|
205
|
+
);
|
|
206
|
+
}
|
|
207
|
+
|
|
208
|
+
/**
|
|
209
|
+
* Get the published scripts metadata.
|
|
210
|
+
*
|
|
211
|
+
* @param {Object} opts Optional parameters
|
|
212
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
213
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
214
|
+
* @param {String} opts.expand Expand
|
|
215
|
+
* @param {String} opts.name Name filter
|
|
216
|
+
* @param {String} opts.feature Feature filter
|
|
217
|
+
* @param {String} opts.flowId Secure flow id filter
|
|
218
|
+
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
219
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
220
|
+
*/
|
|
221
|
+
getScriptsPublishedDivisionviews(opts) {
|
|
222
|
+
opts = opts || {};
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
return this.apiClient.callApi(
|
|
226
|
+
'/api/v2/scripts/published/divisionviews',
|
|
227
|
+
'GET',
|
|
228
|
+
{ },
|
|
229
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'scriptDataVersion': opts['scriptDataVersion'],'divisionIds': opts['divisionIds'] },
|
|
164
230
|
{ },
|
|
165
231
|
{ },
|
|
166
232
|
null,
|