purecloud-platform-client-v2 179.3.0 → 181.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 +2 -2
- package/dist/node/purecloud-platform-client-v2.js +538 -166
- package/dist/web-amd/purecloud-platform-client-v2.js +538 -166
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +538 -166
- package/dist/web-cjs/purecloud-platform-client-v2.js +790 -213
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +459 -250
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- 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 +1 -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/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +8 -80
- 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 +59 -3
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.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/EventsApi.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 +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 +73 -2
- 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/OperationalEventsApi.js +71 -0
- 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 +9 -4
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- 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/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/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/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +57 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +86 -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 +92 -2
- 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 +17 -7
- package/src/purecloud-platform-client-v2/index.js +7 -1
|
@@ -399,7 +399,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
399
399
|
|
|
400
400
|
/**
|
|
401
401
|
* @module purecloud-platform-client-v2/ApiClient
|
|
402
|
-
* @version
|
|
402
|
+
* @version 181.0.0
|
|
403
403
|
*/
|
|
404
404
|
class ApiClient {
|
|
405
405
|
/**
|
|
@@ -1485,7 +1485,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1485
1485
|
/**
|
|
1486
1486
|
* Alerting service.
|
|
1487
1487
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1488
|
-
* @version
|
|
1488
|
+
* @version 181.0.0
|
|
1489
1489
|
*/
|
|
1490
1490
|
|
|
1491
1491
|
/**
|
|
@@ -2135,7 +2135,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2135
2135
|
/**
|
|
2136
2136
|
* Analytics service.
|
|
2137
2137
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
2138
|
-
* @version
|
|
2138
|
+
* @version 181.0.0
|
|
2139
2139
|
*/
|
|
2140
2140
|
|
|
2141
2141
|
/**
|
|
@@ -4581,7 +4581,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4581
4581
|
/**
|
|
4582
4582
|
* Architect service.
|
|
4583
4583
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
4584
|
-
* @version
|
|
4584
|
+
* @version 181.0.0
|
|
4585
4585
|
*/
|
|
4586
4586
|
|
|
4587
4587
|
/**
|
|
@@ -8416,7 +8416,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8416
8416
|
/**
|
|
8417
8417
|
* Audit service.
|
|
8418
8418
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
8419
|
-
* @version
|
|
8419
|
+
* @version 181.0.0
|
|
8420
8420
|
*/
|
|
8421
8421
|
|
|
8422
8422
|
/**
|
|
@@ -8587,7 +8587,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8587
8587
|
/**
|
|
8588
8588
|
* Authorization service.
|
|
8589
8589
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
8590
|
-
* @version
|
|
8590
|
+
* @version 181.0.0
|
|
8591
8591
|
*/
|
|
8592
8592
|
|
|
8593
8593
|
/**
|
|
@@ -9818,7 +9818,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9818
9818
|
/**
|
|
9819
9819
|
* Billing service.
|
|
9820
9820
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
9821
|
-
* @version
|
|
9821
|
+
* @version 181.0.0
|
|
9822
9822
|
*/
|
|
9823
9823
|
|
|
9824
9824
|
/**
|
|
@@ -9898,7 +9898,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9898
9898
|
/**
|
|
9899
9899
|
* CarrierServices service.
|
|
9900
9900
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
9901
|
-
* @version
|
|
9901
|
+
* @version 181.0.0
|
|
9902
9902
|
*/
|
|
9903
9903
|
|
|
9904
9904
|
/**
|
|
@@ -9968,7 +9968,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9968
9968
|
/**
|
|
9969
9969
|
* Chat service.
|
|
9970
9970
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
9971
|
-
* @version
|
|
9971
|
+
* @version 181.0.0
|
|
9972
9972
|
*/
|
|
9973
9973
|
|
|
9974
9974
|
/**
|
|
@@ -10107,27 +10107,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10107
10107
|
);
|
|
10108
10108
|
}
|
|
10109
10109
|
|
|
10110
|
-
/**
|
|
10111
|
-
* Get Chat Settings.
|
|
10112
|
-
* This route is deprecated, please use /chats/settings instead
|
|
10113
|
-
* @deprecated
|
|
10114
|
-
*/
|
|
10115
|
-
getChatSettings() {
|
|
10116
|
-
|
|
10117
|
-
return this.apiClient.callApi(
|
|
10118
|
-
'/api/v2/chat/settings',
|
|
10119
|
-
'GET',
|
|
10120
|
-
{ },
|
|
10121
|
-
{ },
|
|
10122
|
-
{ },
|
|
10123
|
-
{ },
|
|
10124
|
-
null,
|
|
10125
|
-
['PureCloud OAuth'],
|
|
10126
|
-
['application/json'],
|
|
10127
|
-
['application/json']
|
|
10128
|
-
);
|
|
10129
|
-
}
|
|
10130
|
-
|
|
10131
10110
|
/**
|
|
10132
10111
|
* Get a message
|
|
10133
10112
|
*
|
|
@@ -10376,32 +10355,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10376
10355
|
);
|
|
10377
10356
|
}
|
|
10378
10357
|
|
|
10379
|
-
/**
|
|
10380
|
-
* Patch Chat Settings.
|
|
10381
|
-
* This route is deprecated, please use /chats/settings instead
|
|
10382
|
-
* @param {Object} body Chat
|
|
10383
|
-
* @deprecated
|
|
10384
|
-
*/
|
|
10385
|
-
patchChatSettings(body) {
|
|
10386
|
-
// verify the required parameter 'body' is set
|
|
10387
|
-
if (body === undefined || body === null) {
|
|
10388
|
-
throw 'Missing the required parameter "body" when calling patchChatSettings';
|
|
10389
|
-
}
|
|
10390
|
-
|
|
10391
|
-
return this.apiClient.callApi(
|
|
10392
|
-
'/api/v2/chat/settings',
|
|
10393
|
-
'PATCH',
|
|
10394
|
-
{ },
|
|
10395
|
-
{ },
|
|
10396
|
-
{ },
|
|
10397
|
-
{ },
|
|
10398
|
-
body,
|
|
10399
|
-
['PureCloud OAuth'],
|
|
10400
|
-
['application/json'],
|
|
10401
|
-
['application/json']
|
|
10402
|
-
);
|
|
10403
|
-
}
|
|
10404
|
-
|
|
10405
10358
|
/**
|
|
10406
10359
|
* Set properties for a room
|
|
10407
10360
|
*
|
|
@@ -10626,13 +10579,14 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10626
10579
|
/**
|
|
10627
10580
|
* Create an adhoc room
|
|
10628
10581
|
*
|
|
10629
|
-
* @param {Object}
|
|
10630
|
-
* @param {Object} opts.body Room properties
|
|
10582
|
+
* @param {Object} body Room properties
|
|
10631
10583
|
* postChatsRooms is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10632
10584
|
*/
|
|
10633
|
-
postChatsRooms(
|
|
10634
|
-
|
|
10635
|
-
|
|
10585
|
+
postChatsRooms(body) {
|
|
10586
|
+
// verify the required parameter 'body' is set
|
|
10587
|
+
if (body === undefined || body === null) {
|
|
10588
|
+
throw 'Missing the required parameter "body" when calling postChatsRooms';
|
|
10589
|
+
}
|
|
10636
10590
|
|
|
10637
10591
|
return this.apiClient.callApi(
|
|
10638
10592
|
'/api/v2/chats/rooms',
|
|
@@ -10641,7 +10595,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10641
10595
|
{ },
|
|
10642
10596
|
{ },
|
|
10643
10597
|
{ },
|
|
10644
|
-
|
|
10598
|
+
body,
|
|
10645
10599
|
['PureCloud OAuth'],
|
|
10646
10600
|
['application/json'],
|
|
10647
10601
|
['application/json']
|
|
@@ -10679,32 +10633,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10679
10633
|
);
|
|
10680
10634
|
}
|
|
10681
10635
|
|
|
10682
|
-
/**
|
|
10683
|
-
* Update Chat Settings.
|
|
10684
|
-
* This route is deprecated, please use /chats/settings instead
|
|
10685
|
-
* @param {Object} body Chat
|
|
10686
|
-
* @deprecated
|
|
10687
|
-
*/
|
|
10688
|
-
putChatSettings(body) {
|
|
10689
|
-
// verify the required parameter 'body' is set
|
|
10690
|
-
if (body === undefined || body === null) {
|
|
10691
|
-
throw 'Missing the required parameter "body" when calling putChatSettings';
|
|
10692
|
-
}
|
|
10693
|
-
|
|
10694
|
-
return this.apiClient.callApi(
|
|
10695
|
-
'/api/v2/chat/settings',
|
|
10696
|
-
'PUT',
|
|
10697
|
-
{ },
|
|
10698
|
-
{ },
|
|
10699
|
-
{ },
|
|
10700
|
-
{ },
|
|
10701
|
-
body,
|
|
10702
|
-
['PureCloud OAuth'],
|
|
10703
|
-
['application/json'],
|
|
10704
|
-
['application/json']
|
|
10705
|
-
);
|
|
10706
|
-
}
|
|
10707
|
-
|
|
10708
10636
|
/**
|
|
10709
10637
|
* Update Chat Settings.
|
|
10710
10638
|
*
|
|
@@ -10736,7 +10664,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10736
10664
|
/**
|
|
10737
10665
|
* Coaching service.
|
|
10738
10666
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
10739
|
-
* @version
|
|
10667
|
+
* @version 181.0.0
|
|
10740
10668
|
*/
|
|
10741
10669
|
|
|
10742
10670
|
/**
|
|
@@ -11313,7 +11241,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11313
11241
|
/**
|
|
11314
11242
|
* ContentManagement service.
|
|
11315
11243
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
11316
|
-
* @version
|
|
11244
|
+
* @version 181.0.0
|
|
11317
11245
|
*/
|
|
11318
11246
|
|
|
11319
11247
|
/**
|
|
@@ -12456,7 +12384,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12456
12384
|
/**
|
|
12457
12385
|
* Conversations service.
|
|
12458
12386
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
12459
|
-
* @version
|
|
12387
|
+
* @version 181.0.0
|
|
12460
12388
|
*/
|
|
12461
12389
|
|
|
12462
12390
|
/**
|
|
@@ -16501,6 +16429,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16501
16429
|
);
|
|
16502
16430
|
}
|
|
16503
16431
|
|
|
16432
|
+
/**
|
|
16433
|
+
* Activate a WhatsApp messaging integration created using the WhatsApp embedded signup flow
|
|
16434
|
+
* Please specify the phone number to associate with this WhatsApp integration from the list of available phone numbers returned to you in the POST call to create the integration. You can then run a GET on the integration to check if its status has been updated to Active
|
|
16435
|
+
* @param {String} integrationId Integration ID
|
|
16436
|
+
* @param {Object} body WhatsAppEmbeddedSignupIntegrationActivationRequest
|
|
16437
|
+
*/
|
|
16438
|
+
patchConversationsMessagingIntegrationsWhatsappEmbeddedsignupIntegrationId(integrationId, body) {
|
|
16439
|
+
// verify the required parameter 'integrationId' is set
|
|
16440
|
+
if (integrationId === undefined || integrationId === null) {
|
|
16441
|
+
throw 'Missing the required parameter "integrationId" when calling patchConversationsMessagingIntegrationsWhatsappEmbeddedsignupIntegrationId';
|
|
16442
|
+
}
|
|
16443
|
+
// verify the required parameter 'body' is set
|
|
16444
|
+
if (body === undefined || body === null) {
|
|
16445
|
+
throw 'Missing the required parameter "body" when calling patchConversationsMessagingIntegrationsWhatsappEmbeddedsignupIntegrationId';
|
|
16446
|
+
}
|
|
16447
|
+
|
|
16448
|
+
return this.apiClient.callApi(
|
|
16449
|
+
'/api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup/{integrationId}',
|
|
16450
|
+
'PATCH',
|
|
16451
|
+
{ 'integrationId': integrationId },
|
|
16452
|
+
{ },
|
|
16453
|
+
{ },
|
|
16454
|
+
{ },
|
|
16455
|
+
body,
|
|
16456
|
+
['PureCloud OAuth'],
|
|
16457
|
+
['application/json'],
|
|
16458
|
+
['application/json']
|
|
16459
|
+
);
|
|
16460
|
+
}
|
|
16461
|
+
|
|
16504
16462
|
/**
|
|
16505
16463
|
* Update or activate a WhatsApp messaging integration
|
|
16506
16464
|
* The following steps are required in order to fully activate a WhatsApp Integration: Initially, you will need to get an activation code by sending: an action set to Activate, and an authenticationMethod choosing from Sms or Voice. Finally, once you have been informed of an activation code on selected authenticationMethod, you will need to confirm the code by sending: an action set to Confirm, and the confirmationCode you have received from Whatsapp.
|
|
@@ -18727,9 +18685,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18727
18685
|
}
|
|
18728
18686
|
|
|
18729
18687
|
/**
|
|
18730
|
-
* Create a WhatsApp Integration
|
|
18731
|
-
* You must be approved by WhatsApp to use this feature. Your approved e164-formatted phone number and valid WhatsApp certificate for your number are required. Your WhatsApp certificate must have valid base64 encoding. Please paste carefully and do not add any leading or trailing spaces. Do not alter any characters. An integration must be activated within 7 days of certificate generation. If you cannot complete the addition and activation of the number within 7 days, please obtain a new certificate before creating the integration. Integrations created with an invalid number or certificate may immediately incur additional integration fees. Please carefully enter your number and certificate as described.
|
|
18688
|
+
* [This API is deprecated. Use POST /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup instead] Create a WhatsApp Integration
|
|
18689
|
+
* [This API is deprecated. Use POST /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup instead] You must be approved by WhatsApp to use this feature. Your approved e164-formatted phone number and valid WhatsApp certificate for your number are required. Your WhatsApp certificate must have valid base64 encoding. Please paste carefully and do not add any leading or trailing spaces. Do not alter any characters. An integration must be activated within 7 days of certificate generation. If you cannot complete the addition and activation of the number within 7 days, please obtain a new certificate before creating the integration. Integrations created with an invalid number or certificate may immediately incur additional integration fees. Please carefully enter your number and certificate as described.
|
|
18732
18690
|
* @param {Object} body WhatsAppIntegrationRequest
|
|
18691
|
+
* @deprecated
|
|
18733
18692
|
*/
|
|
18734
18693
|
postConversationsMessagingIntegrationsWhatsapp(body) {
|
|
18735
18694
|
// verify the required parameter 'body' is set
|
|
@@ -18751,6 +18710,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18751
18710
|
);
|
|
18752
18711
|
}
|
|
18753
18712
|
|
|
18713
|
+
/**
|
|
18714
|
+
* Create a WhatsApp Integration using the WhatsApp embedded signup flow
|
|
18715
|
+
* Use the access token returned from the embedded signup flow to obtain a list of available phone numbers that can be associated with the created integration. The returned WhatsApp integration will initially have a createStatus of Initiated until the list of available phone numbers can be obtained from the provider. Please run a GET on the created integration until it returns a createStatus of Completed, and the list of available phone numbers obtained from the provider. You can then specify one of the available phone numbers in the PATCH call on the integration to activate it.
|
|
18716
|
+
* @param {Object} body WhatsAppEmbeddedSignupIntegrationRequest
|
|
18717
|
+
*/
|
|
18718
|
+
postConversationsMessagingIntegrationsWhatsappEmbeddedsignup(body) {
|
|
18719
|
+
// verify the required parameter 'body' is set
|
|
18720
|
+
if (body === undefined || body === null) {
|
|
18721
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsWhatsappEmbeddedsignup';
|
|
18722
|
+
}
|
|
18723
|
+
|
|
18724
|
+
return this.apiClient.callApi(
|
|
18725
|
+
'/api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup',
|
|
18726
|
+
'POST',
|
|
18727
|
+
{ },
|
|
18728
|
+
{ },
|
|
18729
|
+
{ },
|
|
18730
|
+
{ },
|
|
18731
|
+
body,
|
|
18732
|
+
['PureCloud OAuth'],
|
|
18733
|
+
['application/json'],
|
|
18734
|
+
['application/json']
|
|
18735
|
+
);
|
|
18736
|
+
}
|
|
18737
|
+
|
|
18754
18738
|
/**
|
|
18755
18739
|
* Create a messaging setting
|
|
18756
18740
|
*
|
|
@@ -19540,7 +19524,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19540
19524
|
/**
|
|
19541
19525
|
* DataExtensions service.
|
|
19542
19526
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
19543
|
-
* @version
|
|
19527
|
+
* @version 181.0.0
|
|
19544
19528
|
*/
|
|
19545
19529
|
|
|
19546
19530
|
/**
|
|
@@ -19626,7 +19610,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19626
19610
|
/**
|
|
19627
19611
|
* Downloads service.
|
|
19628
19612
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
19629
|
-
* @version
|
|
19613
|
+
* @version 181.0.0
|
|
19630
19614
|
*/
|
|
19631
19615
|
|
|
19632
19616
|
/**
|
|
@@ -19678,7 +19662,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19678
19662
|
/**
|
|
19679
19663
|
* Emails service.
|
|
19680
19664
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
19681
|
-
* @version
|
|
19665
|
+
* @version 181.0.0
|
|
19682
19666
|
*/
|
|
19683
19667
|
|
|
19684
19668
|
/**
|
|
@@ -19743,7 +19727,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19743
19727
|
/**
|
|
19744
19728
|
* Events service.
|
|
19745
19729
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
19746
|
-
* @version
|
|
19730
|
+
* @version 181.0.0
|
|
19747
19731
|
*/
|
|
19748
19732
|
|
|
19749
19733
|
/**
|
|
@@ -19839,7 +19823,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19839
19823
|
/**
|
|
19840
19824
|
* ExternalContacts service.
|
|
19841
19825
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
19842
|
-
* @version
|
|
19826
|
+
* @version 181.0.0
|
|
19843
19827
|
*/
|
|
19844
19828
|
|
|
19845
19829
|
/**
|
|
@@ -21797,7 +21781,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21797
21781
|
/**
|
|
21798
21782
|
* Fax service.
|
|
21799
21783
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
21800
|
-
* @version
|
|
21784
|
+
* @version 181.0.0
|
|
21801
21785
|
*/
|
|
21802
21786
|
|
|
21803
21787
|
/**
|
|
@@ -21968,7 +21952,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21968
21952
|
/**
|
|
21969
21953
|
* Flows service.
|
|
21970
21954
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
21971
|
-
* @version
|
|
21955
|
+
* @version 181.0.0
|
|
21972
21956
|
*/
|
|
21973
21957
|
|
|
21974
21958
|
/**
|
|
@@ -22152,7 +22136,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22152
22136
|
/**
|
|
22153
22137
|
* Gamification service.
|
|
22154
22138
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
22155
|
-
* @version
|
|
22139
|
+
* @version 181.0.0
|
|
22156
22140
|
*/
|
|
22157
22141
|
|
|
22158
22142
|
/**
|
|
@@ -24238,7 +24222,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24238
24222
|
/**
|
|
24239
24223
|
* GeneralDataProtectionRegulation service.
|
|
24240
24224
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
24241
|
-
* @version
|
|
24225
|
+
* @version 181.0.0
|
|
24242
24226
|
*/
|
|
24243
24227
|
|
|
24244
24228
|
/**
|
|
@@ -24368,7 +24352,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24368
24352
|
/**
|
|
24369
24353
|
* Geolocation service.
|
|
24370
24354
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
24371
|
-
* @version
|
|
24355
|
+
* @version 181.0.0
|
|
24372
24356
|
*/
|
|
24373
24357
|
|
|
24374
24358
|
/**
|
|
@@ -24499,7 +24483,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24499
24483
|
/**
|
|
24500
24484
|
* Greetings service.
|
|
24501
24485
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
24502
|
-
* @version
|
|
24486
|
+
* @version 181.0.0
|
|
24503
24487
|
*/
|
|
24504
24488
|
|
|
24505
24489
|
/**
|
|
@@ -24954,7 +24938,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24954
24938
|
/**
|
|
24955
24939
|
* Groups service.
|
|
24956
24940
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
24957
|
-
* @version
|
|
24941
|
+
* @version 181.0.0
|
|
24958
24942
|
*/
|
|
24959
24943
|
|
|
24960
24944
|
/**
|
|
@@ -25473,7 +25457,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25473
25457
|
/**
|
|
25474
25458
|
* IdentityProvider service.
|
|
25475
25459
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
25476
|
-
* @version
|
|
25460
|
+
* @version 181.0.0
|
|
25477
25461
|
*/
|
|
25478
25462
|
|
|
25479
25463
|
/**
|
|
@@ -26229,7 +26213,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26229
26213
|
/**
|
|
26230
26214
|
* InfrastructureAsCode service.
|
|
26231
26215
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
26232
|
-
* @version
|
|
26216
|
+
* @version 181.0.0
|
|
26233
26217
|
*/
|
|
26234
26218
|
|
|
26235
26219
|
/**
|
|
@@ -26396,7 +26380,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26396
26380
|
/**
|
|
26397
26381
|
* Integrations service.
|
|
26398
26382
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
26399
|
-
* @version
|
|
26383
|
+
* @version 181.0.0
|
|
26400
26384
|
*/
|
|
26401
26385
|
|
|
26402
26386
|
/**
|
|
@@ -28358,7 +28342,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28358
28342
|
/**
|
|
28359
28343
|
* Journey service.
|
|
28360
28344
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
28361
|
-
* @version
|
|
28345
|
+
* @version 181.0.0
|
|
28362
28346
|
*/
|
|
28363
28347
|
|
|
28364
28348
|
/**
|
|
@@ -28800,6 +28784,48 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28800
28784
|
);
|
|
28801
28785
|
}
|
|
28802
28786
|
|
|
28787
|
+
/**
|
|
28788
|
+
* Send a ping.
|
|
28789
|
+
*
|
|
28790
|
+
* @param {String} deploymentId The ID of the deployment sending the ping.
|
|
28791
|
+
* @param {String} customerCookieId ID of the customer associated with the ping.
|
|
28792
|
+
* @param {String} sessionId UUID of the customer session. Use the same Session Id for all pings, AppEvents and ActionEvents in the session
|
|
28793
|
+
* @param {Object} opts Optional parameters
|
|
28794
|
+
* @param {String} opts.dl Document Location: 1) Web Page URL if overridden or URL fragment identifier (window.location.hash). OR 2) Application screen name that the ping request was sent from in the app. e.g. 'home' or 'help. Pings without this parameter will not return actions.
|
|
28795
|
+
* @param {String} opts.dt Document Title. A human readable name for the page or screen
|
|
28796
|
+
* @param {String} opts.appNamespace Namespace of the application (e.g. com.genesys.bancodinero). Used for domain filtering in application sessions
|
|
28797
|
+
* @param {Number} opts.sinceLastBeaconMilliseconds How long (milliseconds) since the last app event or beacon was sent. The response may return a pollInternvalMilliseconds to reduce the frequency of pings.
|
|
28798
|
+
*/
|
|
28799
|
+
getJourneyDeploymentCustomerPing(deploymentId, customerCookieId, sessionId, opts) {
|
|
28800
|
+
opts = opts || {};
|
|
28801
|
+
|
|
28802
|
+
// verify the required parameter 'deploymentId' is set
|
|
28803
|
+
if (deploymentId === undefined || deploymentId === null) {
|
|
28804
|
+
throw 'Missing the required parameter "deploymentId" when calling getJourneyDeploymentCustomerPing';
|
|
28805
|
+
}
|
|
28806
|
+
// verify the required parameter 'customerCookieId' is set
|
|
28807
|
+
if (customerCookieId === undefined || customerCookieId === null) {
|
|
28808
|
+
throw 'Missing the required parameter "customerCookieId" when calling getJourneyDeploymentCustomerPing';
|
|
28809
|
+
}
|
|
28810
|
+
// verify the required parameter 'sessionId' is set
|
|
28811
|
+
if (sessionId === undefined || sessionId === null) {
|
|
28812
|
+
throw 'Missing the required parameter "sessionId" when calling getJourneyDeploymentCustomerPing';
|
|
28813
|
+
}
|
|
28814
|
+
|
|
28815
|
+
return this.apiClient.callApi(
|
|
28816
|
+
'/api/v2/journey/deployments/{deploymentId}/customers/{customerCookieId}/ping',
|
|
28817
|
+
'GET',
|
|
28818
|
+
{ 'deploymentId': deploymentId,'customerCookieId': customerCookieId },
|
|
28819
|
+
{ 'dl': opts['dl'],'dt': opts['dt'],'appNamespace': opts['appNamespace'],'sessionId': sessionId,'sinceLastBeaconMilliseconds': opts['sinceLastBeaconMilliseconds'] },
|
|
28820
|
+
{ },
|
|
28821
|
+
{ },
|
|
28822
|
+
null,
|
|
28823
|
+
['PureCloud OAuth'],
|
|
28824
|
+
['application/json'],
|
|
28825
|
+
['application/json']
|
|
28826
|
+
);
|
|
28827
|
+
}
|
|
28828
|
+
|
|
28803
28829
|
/**
|
|
28804
28830
|
* Retrieve a single outcome.
|
|
28805
28831
|
*
|
|
@@ -29389,13 +29415,42 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29389
29415
|
);
|
|
29390
29416
|
}
|
|
29391
29417
|
|
|
29418
|
+
/**
|
|
29419
|
+
* Sends an action event, which is used for changing the state of actions that have been offered to the user.
|
|
29420
|
+
*
|
|
29421
|
+
* @param {String} deploymentId The ID of the deployment sending the beacon.
|
|
29422
|
+
* @param {Object} body
|
|
29423
|
+
*/
|
|
29424
|
+
postJourneyDeploymentActionevent(deploymentId, body) {
|
|
29425
|
+
// verify the required parameter 'deploymentId' is set
|
|
29426
|
+
if (deploymentId === undefined || deploymentId === null) {
|
|
29427
|
+
throw 'Missing the required parameter "deploymentId" when calling postJourneyDeploymentActionevent';
|
|
29428
|
+
}
|
|
29429
|
+
// verify the required parameter 'body' is set
|
|
29430
|
+
if (body === undefined || body === null) {
|
|
29431
|
+
throw 'Missing the required parameter "body" when calling postJourneyDeploymentActionevent';
|
|
29432
|
+
}
|
|
29433
|
+
|
|
29434
|
+
return this.apiClient.callApi(
|
|
29435
|
+
'/api/v2/journey/deployments/{deploymentId}/actionevent',
|
|
29436
|
+
'POST',
|
|
29437
|
+
{ 'deploymentId': deploymentId },
|
|
29438
|
+
{ },
|
|
29439
|
+
{ },
|
|
29440
|
+
{ },
|
|
29441
|
+
body,
|
|
29442
|
+
['PureCloud OAuth'],
|
|
29443
|
+
['application/json'],
|
|
29444
|
+
['application/json']
|
|
29445
|
+
);
|
|
29446
|
+
}
|
|
29447
|
+
|
|
29392
29448
|
/**
|
|
29393
29449
|
* Send a journey app event, used for tracking customer activity on an application.
|
|
29394
29450
|
*
|
|
29395
29451
|
* @param {String} deploymentId The ID of the deployment sending the app event.
|
|
29396
29452
|
* @param {Object} opts Optional parameters
|
|
29397
29453
|
* @param {Object} opts.body
|
|
29398
|
-
* postJourneyDeploymentAppevents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
29399
29454
|
*/
|
|
29400
29455
|
postJourneyDeploymentAppevents(deploymentId, opts) {
|
|
29401
29456
|
opts = opts || {};
|
|
@@ -29522,7 +29577,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29522
29577
|
/**
|
|
29523
29578
|
* Knowledge service.
|
|
29524
29579
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
29525
|
-
* @version
|
|
29580
|
+
* @version 181.0.0
|
|
29526
29581
|
*/
|
|
29527
29582
|
|
|
29528
29583
|
/**
|
|
@@ -32343,7 +32398,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32343
32398
|
/**
|
|
32344
32399
|
* LanguageUnderstanding service.
|
|
32345
32400
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
32346
|
-
* @version
|
|
32401
|
+
* @version 181.0.0
|
|
32347
32402
|
*/
|
|
32348
32403
|
|
|
32349
32404
|
/**
|
|
@@ -33356,7 +33411,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33356
33411
|
/**
|
|
33357
33412
|
* Languages service.
|
|
33358
33413
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
33359
|
-
* @version
|
|
33414
|
+
* @version 181.0.0
|
|
33360
33415
|
*/
|
|
33361
33416
|
|
|
33362
33417
|
/**
|
|
@@ -33578,7 +33633,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33578
33633
|
/**
|
|
33579
33634
|
* Learning service.
|
|
33580
33635
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
33581
|
-
* @version
|
|
33636
|
+
* @version 181.0.0
|
|
33582
33637
|
*/
|
|
33583
33638
|
|
|
33584
33639
|
/**
|
|
@@ -34397,7 +34452,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34397
34452
|
/**
|
|
34398
34453
|
* License service.
|
|
34399
34454
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
34400
|
-
* @version
|
|
34455
|
+
* @version 181.0.0
|
|
34401
34456
|
*/
|
|
34402
34457
|
|
|
34403
34458
|
/**
|
|
@@ -34635,7 +34690,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34635
34690
|
/**
|
|
34636
34691
|
* Locations service.
|
|
34637
34692
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
34638
|
-
* @version
|
|
34693
|
+
* @version 181.0.0
|
|
34639
34694
|
*/
|
|
34640
34695
|
|
|
34641
34696
|
/**
|
|
@@ -34871,7 +34926,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34871
34926
|
/**
|
|
34872
34927
|
* Messaging service.
|
|
34873
34928
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
34874
|
-
* @version
|
|
34929
|
+
* @version 181.0.0
|
|
34875
34930
|
*/
|
|
34876
34931
|
|
|
34877
34932
|
/**
|
|
@@ -35230,7 +35285,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35230
35285
|
/**
|
|
35231
35286
|
* MobileDevices service.
|
|
35232
35287
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
35233
|
-
* @version
|
|
35288
|
+
* @version 181.0.0
|
|
35234
35289
|
*/
|
|
35235
35290
|
|
|
35236
35291
|
/**
|
|
@@ -35381,7 +35436,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35381
35436
|
/**
|
|
35382
35437
|
* Notifications service.
|
|
35383
35438
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
35384
|
-
* @version
|
|
35439
|
+
* @version 181.0.0
|
|
35385
35440
|
*/
|
|
35386
35441
|
|
|
35387
35442
|
/**
|
|
@@ -35614,7 +35669,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35614
35669
|
/**
|
|
35615
35670
|
* OAuth service.
|
|
35616
35671
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
35617
|
-
* @version
|
|
35672
|
+
* @version 181.0.0
|
|
35618
35673
|
*/
|
|
35619
35674
|
|
|
35620
35675
|
/**
|
|
@@ -35980,7 +36035,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35980
36035
|
/**
|
|
35981
36036
|
* Objects service.
|
|
35982
36037
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
35983
|
-
* @version
|
|
36038
|
+
* @version 181.0.0
|
|
35984
36039
|
*/
|
|
35985
36040
|
|
|
35986
36041
|
/**
|
|
@@ -36247,11 +36302,77 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36247
36302
|
|
|
36248
36303
|
}
|
|
36249
36304
|
|
|
36305
|
+
class OperationalEventsApi {
|
|
36306
|
+
/**
|
|
36307
|
+
* OperationalEvents service.
|
|
36308
|
+
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
36309
|
+
* @version 181.0.0
|
|
36310
|
+
*/
|
|
36311
|
+
|
|
36312
|
+
/**
|
|
36313
|
+
* Constructs a new OperationalEventsApi.
|
|
36314
|
+
* @alias module:purecloud-platform-client-v2/api/OperationalEventsApi
|
|
36315
|
+
* @class
|
|
36316
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
36317
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
36318
|
+
*/
|
|
36319
|
+
constructor(apiClient) {
|
|
36320
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
36321
|
+
}
|
|
36322
|
+
|
|
36323
|
+
|
|
36324
|
+
/**
|
|
36325
|
+
* Get an operational event definition by its id
|
|
36326
|
+
*
|
|
36327
|
+
* @param {String} eventDefinitionId EventDefinition id
|
|
36328
|
+
*/
|
|
36329
|
+
getUsageEventsDefinition(eventDefinitionId) {
|
|
36330
|
+
// verify the required parameter 'eventDefinitionId' is set
|
|
36331
|
+
if (eventDefinitionId === undefined || eventDefinitionId === null) {
|
|
36332
|
+
throw 'Missing the required parameter "eventDefinitionId" when calling getUsageEventsDefinition';
|
|
36333
|
+
}
|
|
36334
|
+
|
|
36335
|
+
return this.apiClient.callApi(
|
|
36336
|
+
'/api/v2/usage/events/definitions/{eventDefinitionId}',
|
|
36337
|
+
'GET',
|
|
36338
|
+
{ 'eventDefinitionId': eventDefinitionId },
|
|
36339
|
+
{ },
|
|
36340
|
+
{ },
|
|
36341
|
+
{ },
|
|
36342
|
+
null,
|
|
36343
|
+
['PureCloud OAuth'],
|
|
36344
|
+
['application/json'],
|
|
36345
|
+
['application/json']
|
|
36346
|
+
);
|
|
36347
|
+
}
|
|
36348
|
+
|
|
36349
|
+
/**
|
|
36350
|
+
* Get all operational event definitions
|
|
36351
|
+
*
|
|
36352
|
+
*/
|
|
36353
|
+
getUsageEventsDefinitions() {
|
|
36354
|
+
|
|
36355
|
+
return this.apiClient.callApi(
|
|
36356
|
+
'/api/v2/usage/events/definitions',
|
|
36357
|
+
'GET',
|
|
36358
|
+
{ },
|
|
36359
|
+
{ },
|
|
36360
|
+
{ },
|
|
36361
|
+
{ },
|
|
36362
|
+
null,
|
|
36363
|
+
['PureCloud OAuth'],
|
|
36364
|
+
['application/json'],
|
|
36365
|
+
['application/json']
|
|
36366
|
+
);
|
|
36367
|
+
}
|
|
36368
|
+
|
|
36369
|
+
}
|
|
36370
|
+
|
|
36250
36371
|
class OrganizationApi {
|
|
36251
36372
|
/**
|
|
36252
36373
|
* Organization service.
|
|
36253
36374
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
36254
|
-
* @version
|
|
36375
|
+
* @version 181.0.0
|
|
36255
36376
|
*/
|
|
36256
36377
|
|
|
36257
36378
|
/**
|
|
@@ -36706,7 +36827,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36706
36827
|
/**
|
|
36707
36828
|
* OrganizationAuthorization service.
|
|
36708
36829
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
36709
|
-
* @version
|
|
36830
|
+
* @version 181.0.0
|
|
36710
36831
|
*/
|
|
36711
36832
|
|
|
36712
36833
|
/**
|
|
@@ -38053,7 +38174,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38053
38174
|
/**
|
|
38054
38175
|
* Outbound service.
|
|
38055
38176
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
38056
|
-
* @version
|
|
38177
|
+
* @version 181.0.0
|
|
38057
38178
|
*/
|
|
38058
38179
|
|
|
38059
38180
|
/**
|
|
@@ -41675,7 +41796,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41675
41796
|
/**
|
|
41676
41797
|
* Presence service.
|
|
41677
41798
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
41678
|
-
* @version
|
|
41799
|
+
* @version 181.0.0
|
|
41679
41800
|
*/
|
|
41680
41801
|
|
|
41681
41802
|
/**
|
|
@@ -41770,9 +41891,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41770
41891
|
* Get a Presence Definition
|
|
41771
41892
|
*
|
|
41772
41893
|
* @param {String} definitionId Presence Definition ID
|
|
41894
|
+
* @param {Object} opts Optional parameters
|
|
41895
|
+
* @param {Object} opts.localeCode The locale code to fetch for the presence definition. Use ALL to fetch everything.
|
|
41773
41896
|
* getPresenceDefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
41774
41897
|
*/
|
|
41775
|
-
getPresenceDefinition0(definitionId) {
|
|
41898
|
+
getPresenceDefinition0(definitionId, opts) {
|
|
41899
|
+
opts = opts || {};
|
|
41900
|
+
|
|
41776
41901
|
// verify the required parameter 'definitionId' is set
|
|
41777
41902
|
if (definitionId === undefined || definitionId === null) {
|
|
41778
41903
|
throw 'Missing the required parameter "definitionId" when calling getPresenceDefinition0';
|
|
@@ -41782,7 +41907,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41782
41907
|
'/api/v2/presence/definitions/{definitionId}',
|
|
41783
41908
|
'GET',
|
|
41784
41909
|
{ 'definitionId': definitionId },
|
|
41785
|
-
{
|
|
41910
|
+
{ 'localeCode': opts['localeCode'] },
|
|
41786
41911
|
{ },
|
|
41787
41912
|
{ },
|
|
41788
41913
|
null,
|
|
@@ -41798,6 +41923,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41798
41923
|
* @param {Object} opts Optional parameters
|
|
41799
41924
|
* @param {String} opts.deactivated Deactivated query can be TRUE or FALSE (default to false)
|
|
41800
41925
|
* @param {Array.<String>} opts.divisionId One or more division IDs. If nothing is provided, the definitions associated withthe list of divisions that the user has access to will be returned.
|
|
41926
|
+
* @param {Object} opts.localeCode The locale code to fetch for the presence definition. Use ALL to fetch everything.
|
|
41801
41927
|
* getPresenceDefinitions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
41802
41928
|
*/
|
|
41803
41929
|
getPresenceDefinitions0(opts) {
|
|
@@ -41808,7 +41934,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41808
41934
|
'/api/v2/presence/definitions',
|
|
41809
41935
|
'GET',
|
|
41810
41936
|
{ },
|
|
41811
|
-
{ 'deactivated': opts['deactivated'],'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi') },
|
|
41937
|
+
{ 'deactivated': opts['deactivated'],'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi'),'localeCode': opts['localeCode'] },
|
|
41812
41938
|
{ },
|
|
41813
41939
|
{ },
|
|
41814
41940
|
null,
|
|
@@ -42414,7 +42540,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42414
42540
|
/**
|
|
42415
42541
|
* ProcessAutomation service.
|
|
42416
42542
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
42417
|
-
* @version
|
|
42543
|
+
* @version 181.0.0
|
|
42418
42544
|
*/
|
|
42419
42545
|
|
|
42420
42546
|
/**
|
|
@@ -42653,7 +42779,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42653
42779
|
/**
|
|
42654
42780
|
* Quality service.
|
|
42655
42781
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
42656
|
-
* @version
|
|
42782
|
+
* @version 181.0.0
|
|
42657
42783
|
*/
|
|
42658
42784
|
|
|
42659
42785
|
/**
|
|
@@ -43362,7 +43488,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43362
43488
|
|
|
43363
43489
|
/**
|
|
43364
43490
|
* Get the list of evaluation forms
|
|
43365
|
-
*
|
|
43491
|
+
* By default, "published" field is always returned as false for all evaluation forms. If you set "expand=publishHistory", then you will be able to get published versions for each corresponding evaluation form. In addition, "questionGroups", the detailed information about evaluation form, is not returned by default. We will enhance this field in the future release.
|
|
43366
43492
|
* @param {Object} opts Optional parameters
|
|
43367
43493
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
43368
43494
|
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
@@ -44407,7 +44533,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44407
44533
|
/**
|
|
44408
44534
|
* Recording service.
|
|
44409
44535
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
44410
|
-
* @version
|
|
44536
|
+
* @version 181.0.0
|
|
44411
44537
|
*/
|
|
44412
44538
|
|
|
44413
44539
|
/**
|
|
@@ -46044,7 +46170,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46044
46170
|
/**
|
|
46045
46171
|
* ResponseManagement service.
|
|
46046
46172
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
46047
|
-
* @version
|
|
46173
|
+
* @version 181.0.0
|
|
46048
46174
|
*/
|
|
46049
46175
|
|
|
46050
46176
|
/**
|
|
@@ -46529,7 +46655,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46529
46655
|
/**
|
|
46530
46656
|
* Routing service.
|
|
46531
46657
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
46532
|
-
* @version
|
|
46658
|
+
* @version 181.0.0
|
|
46533
46659
|
*/
|
|
46534
46660
|
|
|
46535
46661
|
/**
|
|
@@ -50237,7 +50363,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50237
50363
|
/**
|
|
50238
50364
|
* SCIM service.
|
|
50239
50365
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
50240
|
-
* @version
|
|
50366
|
+
* @version 181.0.0
|
|
50241
50367
|
*/
|
|
50242
50368
|
|
|
50243
50369
|
/**
|
|
@@ -51114,7 +51240,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51114
51240
|
/**
|
|
51115
51241
|
* Scripts service.
|
|
51116
51242
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
51117
|
-
* @version
|
|
51243
|
+
* @version 181.0.0
|
|
51118
51244
|
*/
|
|
51119
51245
|
|
|
51120
51246
|
/**
|
|
@@ -51558,7 +51684,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51558
51684
|
/**
|
|
51559
51685
|
* Search service.
|
|
51560
51686
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
51561
|
-
* @version
|
|
51687
|
+
* @version 181.0.0
|
|
51562
51688
|
*/
|
|
51563
51689
|
|
|
51564
51690
|
/**
|
|
@@ -52247,7 +52373,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52247
52373
|
/**
|
|
52248
52374
|
* Settings service.
|
|
52249
52375
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
52250
|
-
* @version
|
|
52376
|
+
* @version 181.0.0
|
|
52251
52377
|
*/
|
|
52252
52378
|
|
|
52253
52379
|
/**
|
|
@@ -52312,7 +52438,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52312
52438
|
/**
|
|
52313
52439
|
* SpeechTextAnalytics service.
|
|
52314
52440
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
52315
|
-
* @version
|
|
52441
|
+
* @version 181.0.0
|
|
52316
52442
|
*/
|
|
52317
52443
|
|
|
52318
52444
|
/**
|
|
@@ -53425,7 +53551,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53425
53551
|
/**
|
|
53426
53552
|
* Stations service.
|
|
53427
53553
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
53428
|
-
* @version
|
|
53554
|
+
* @version 181.0.0
|
|
53429
53555
|
*/
|
|
53430
53556
|
|
|
53431
53557
|
/**
|
|
@@ -53527,7 +53653,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53527
53653
|
/**
|
|
53528
53654
|
* Suggest service.
|
|
53529
53655
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
53530
|
-
* @version
|
|
53656
|
+
* @version 181.0.0
|
|
53531
53657
|
*/
|
|
53532
53658
|
|
|
53533
53659
|
/**
|
|
@@ -53666,7 +53792,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53666
53792
|
/**
|
|
53667
53793
|
* TaskManagement service.
|
|
53668
53794
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
53669
|
-
* @version
|
|
53795
|
+
* @version 181.0.0
|
|
53670
53796
|
*/
|
|
53671
53797
|
|
|
53672
53798
|
/**
|
|
@@ -54947,7 +55073,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54947
55073
|
/**
|
|
54948
55074
|
* Teams service.
|
|
54949
55075
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
54950
|
-
* @version
|
|
55076
|
+
* @version 181.0.0
|
|
54951
55077
|
*/
|
|
54952
55078
|
|
|
54953
55079
|
/**
|
|
@@ -55249,7 +55375,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55249
55375
|
/**
|
|
55250
55376
|
* Telephony service.
|
|
55251
55377
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
55252
|
-
* @version
|
|
55378
|
+
* @version 181.0.0
|
|
55253
55379
|
*/
|
|
55254
55380
|
|
|
55255
55381
|
/**
|
|
@@ -55284,6 +55410,62 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55284
55410
|
);
|
|
55285
55411
|
}
|
|
55286
55412
|
|
|
55413
|
+
/**
|
|
55414
|
+
* Get a SIP message.
|
|
55415
|
+
* Get the raw form of the SIP message
|
|
55416
|
+
* @param {String} conversationId Conversation id
|
|
55417
|
+
* getTelephonySipmessagesConversation is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
55418
|
+
*/
|
|
55419
|
+
getTelephonySipmessagesConversation(conversationId) {
|
|
55420
|
+
// verify the required parameter 'conversationId' is set
|
|
55421
|
+
if (conversationId === undefined || conversationId === null) {
|
|
55422
|
+
throw 'Missing the required parameter "conversationId" when calling getTelephonySipmessagesConversation';
|
|
55423
|
+
}
|
|
55424
|
+
|
|
55425
|
+
return this.apiClient.callApi(
|
|
55426
|
+
'/api/v2/telephony/sipmessages/conversations/{conversationId}',
|
|
55427
|
+
'GET',
|
|
55428
|
+
{ 'conversationId': conversationId },
|
|
55429
|
+
{ },
|
|
55430
|
+
{ },
|
|
55431
|
+
{ },
|
|
55432
|
+
null,
|
|
55433
|
+
['PureCloud OAuth'],
|
|
55434
|
+
['application/json'],
|
|
55435
|
+
['application/json']
|
|
55436
|
+
);
|
|
55437
|
+
}
|
|
55438
|
+
|
|
55439
|
+
/**
|
|
55440
|
+
* Get SIP headers.
|
|
55441
|
+
* Get parsed SIP headers. Returns specific headers if key query parameters are added.
|
|
55442
|
+
* @param {String} conversationId Conversation id
|
|
55443
|
+
* @param {Object} opts Optional parameters
|
|
55444
|
+
* @param {Array.<String>} opts.keys comma-separated list of header identifiers to query. e.g. ruri,to,from
|
|
55445
|
+
* getTelephonySipmessagesConversationHeaders is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
55446
|
+
*/
|
|
55447
|
+
getTelephonySipmessagesConversationHeaders(conversationId, opts) {
|
|
55448
|
+
opts = opts || {};
|
|
55449
|
+
|
|
55450
|
+
// verify the required parameter 'conversationId' is set
|
|
55451
|
+
if (conversationId === undefined || conversationId === null) {
|
|
55452
|
+
throw 'Missing the required parameter "conversationId" when calling getTelephonySipmessagesConversationHeaders';
|
|
55453
|
+
}
|
|
55454
|
+
|
|
55455
|
+
return this.apiClient.callApi(
|
|
55456
|
+
'/api/v2/telephony/sipmessages/conversations/{conversationId}/headers',
|
|
55457
|
+
'GET',
|
|
55458
|
+
{ 'conversationId': conversationId },
|
|
55459
|
+
{ 'keys': this.apiClient.buildCollectionParam(opts['keys'], 'multi') },
|
|
55460
|
+
{ },
|
|
55461
|
+
{ },
|
|
55462
|
+
null,
|
|
55463
|
+
['PureCloud OAuth'],
|
|
55464
|
+
['application/json'],
|
|
55465
|
+
['application/json']
|
|
55466
|
+
);
|
|
55467
|
+
}
|
|
55468
|
+
|
|
55287
55469
|
/**
|
|
55288
55470
|
* Fetch SIP metadata
|
|
55289
55471
|
* Fetch SIP metadata that matches a given parameter. If exactMatch is passed as a parameter only sip records that have exactly that value will be returned. For example, some records contain conversationId but not all relevant records for that call may contain the conversationId so only a partial view of the call will be reflected
|
|
@@ -55377,7 +55559,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55377
55559
|
/**
|
|
55378
55560
|
* TelephonyProvidersEdge service.
|
|
55379
55561
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
55380
|
-
* @version
|
|
55562
|
+
* @version 181.0.0
|
|
55381
55563
|
*/
|
|
55382
55564
|
|
|
55383
55565
|
/**
|
|
@@ -57301,6 +57483,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57301
57483
|
);
|
|
57302
57484
|
}
|
|
57303
57485
|
|
|
57486
|
+
/**
|
|
57487
|
+
* Get site connections for a site.
|
|
57488
|
+
*
|
|
57489
|
+
* @param {String} siteId Site ID
|
|
57490
|
+
*/
|
|
57491
|
+
getTelephonyProvidersEdgesSiteSiteconnections(siteId) {
|
|
57492
|
+
// verify the required parameter 'siteId' is set
|
|
57493
|
+
if (siteId === undefined || siteId === null) {
|
|
57494
|
+
throw 'Missing the required parameter "siteId" when calling getTelephonyProvidersEdgesSiteSiteconnections';
|
|
57495
|
+
}
|
|
57496
|
+
|
|
57497
|
+
return this.apiClient.callApi(
|
|
57498
|
+
'/api/v2/telephony/providers/edges/sites/{siteId}/siteconnections',
|
|
57499
|
+
'GET',
|
|
57500
|
+
{ 'siteId': siteId },
|
|
57501
|
+
{ },
|
|
57502
|
+
{ },
|
|
57503
|
+
{ },
|
|
57504
|
+
null,
|
|
57505
|
+
['PureCloud OAuth'],
|
|
57506
|
+
['application/json'],
|
|
57507
|
+
['application/json']
|
|
57508
|
+
);
|
|
57509
|
+
}
|
|
57510
|
+
|
|
57304
57511
|
/**
|
|
57305
57512
|
* Get the list of Sites.
|
|
57306
57513
|
*
|
|
@@ -57597,6 +57804,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57597
57804
|
);
|
|
57598
57805
|
}
|
|
57599
57806
|
|
|
57807
|
+
/**
|
|
57808
|
+
* Disable site connections for a site.
|
|
57809
|
+
*
|
|
57810
|
+
* @param {String} siteId Site ID
|
|
57811
|
+
* @param {Object} body Site
|
|
57812
|
+
*/
|
|
57813
|
+
patchTelephonyProvidersEdgesSiteSiteconnections(siteId, body) {
|
|
57814
|
+
// verify the required parameter 'siteId' is set
|
|
57815
|
+
if (siteId === undefined || siteId === null) {
|
|
57816
|
+
throw 'Missing the required parameter "siteId" when calling patchTelephonyProvidersEdgesSiteSiteconnections';
|
|
57817
|
+
}
|
|
57818
|
+
// verify the required parameter 'body' is set
|
|
57819
|
+
if (body === undefined || body === null) {
|
|
57820
|
+
throw 'Missing the required parameter "body" when calling patchTelephonyProvidersEdgesSiteSiteconnections';
|
|
57821
|
+
}
|
|
57822
|
+
|
|
57823
|
+
return this.apiClient.callApi(
|
|
57824
|
+
'/api/v2/telephony/providers/edges/sites/{siteId}/siteconnections',
|
|
57825
|
+
'PATCH',
|
|
57826
|
+
{ 'siteId': siteId },
|
|
57827
|
+
{ },
|
|
57828
|
+
{ },
|
|
57829
|
+
{ },
|
|
57830
|
+
body,
|
|
57831
|
+
['PureCloud OAuth'],
|
|
57832
|
+
['application/json'],
|
|
57833
|
+
['application/json']
|
|
57834
|
+
);
|
|
57835
|
+
}
|
|
57836
|
+
|
|
57600
57837
|
/**
|
|
57601
57838
|
* Nslookup request command to collect networking-related information from an Edge for a target IP or host.
|
|
57602
57839
|
*
|
|
@@ -58630,6 +58867,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58630
58867
|
);
|
|
58631
58868
|
}
|
|
58632
58869
|
|
|
58870
|
+
/**
|
|
58871
|
+
* Update site connections for a site.
|
|
58872
|
+
*
|
|
58873
|
+
* @param {String} siteId Site ID
|
|
58874
|
+
* @param {Object} body Site
|
|
58875
|
+
*/
|
|
58876
|
+
putTelephonyProvidersEdgesSiteSiteconnections(siteId, body) {
|
|
58877
|
+
// verify the required parameter 'siteId' is set
|
|
58878
|
+
if (siteId === undefined || siteId === null) {
|
|
58879
|
+
throw 'Missing the required parameter "siteId" when calling putTelephonyProvidersEdgesSiteSiteconnections';
|
|
58880
|
+
}
|
|
58881
|
+
// verify the required parameter 'body' is set
|
|
58882
|
+
if (body === undefined || body === null) {
|
|
58883
|
+
throw 'Missing the required parameter "body" when calling putTelephonyProvidersEdgesSiteSiteconnections';
|
|
58884
|
+
}
|
|
58885
|
+
|
|
58886
|
+
return this.apiClient.callApi(
|
|
58887
|
+
'/api/v2/telephony/providers/edges/sites/{siteId}/siteconnections',
|
|
58888
|
+
'PUT',
|
|
58889
|
+
{ 'siteId': siteId },
|
|
58890
|
+
{ },
|
|
58891
|
+
{ },
|
|
58892
|
+
{ },
|
|
58893
|
+
body,
|
|
58894
|
+
['PureCloud OAuth'],
|
|
58895
|
+
['application/json'],
|
|
58896
|
+
['application/json']
|
|
58897
|
+
);
|
|
58898
|
+
}
|
|
58899
|
+
|
|
58633
58900
|
/**
|
|
58634
58901
|
* Update a Trunk Base Settings object by ID
|
|
58635
58902
|
*
|
|
@@ -58666,7 +58933,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58666
58933
|
/**
|
|
58667
58934
|
* Textbots service.
|
|
58668
58935
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
58669
|
-
* @version
|
|
58936
|
+
* @version 181.0.0
|
|
58670
58937
|
*/
|
|
58671
58938
|
|
|
58672
58939
|
/**
|
|
@@ -58794,7 +59061,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58794
59061
|
/**
|
|
58795
59062
|
* Tokens service.
|
|
58796
59063
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
58797
|
-
* @version
|
|
59064
|
+
* @version 181.0.0
|
|
58798
59065
|
*/
|
|
58799
59066
|
|
|
58800
59067
|
/**
|
|
@@ -58950,7 +59217,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58950
59217
|
/**
|
|
58951
59218
|
* Uploads service.
|
|
58952
59219
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
58953
|
-
* @version
|
|
59220
|
+
* @version 181.0.0
|
|
58954
59221
|
*/
|
|
58955
59222
|
|
|
58956
59223
|
/**
|
|
@@ -59126,7 +59393,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59126
59393
|
/**
|
|
59127
59394
|
* Usage service.
|
|
59128
59395
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
59129
|
-
* @version
|
|
59396
|
+
* @version 181.0.0
|
|
59130
59397
|
*/
|
|
59131
59398
|
|
|
59132
59399
|
/**
|
|
@@ -59336,7 +59603,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59336
59603
|
/**
|
|
59337
59604
|
* UserRecordings service.
|
|
59338
59605
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
59339
|
-
* @version
|
|
59606
|
+
* @version 181.0.0
|
|
59340
59607
|
*/
|
|
59341
59608
|
|
|
59342
59609
|
/**
|
|
@@ -59521,7 +59788,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59521
59788
|
/**
|
|
59522
59789
|
* Users service.
|
|
59523
59790
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
59524
|
-
* @version
|
|
59791
|
+
* @version 181.0.0
|
|
59525
59792
|
*/
|
|
59526
59793
|
|
|
59527
59794
|
/**
|
|
@@ -59756,6 +60023,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59756
60023
|
);
|
|
59757
60024
|
}
|
|
59758
60025
|
|
|
60026
|
+
/**
|
|
60027
|
+
* Delete a verifier
|
|
60028
|
+
*
|
|
60029
|
+
* @param {String} userId User ID
|
|
60030
|
+
* @param {String} verifierId Verifier ID
|
|
60031
|
+
*/
|
|
60032
|
+
deleteUserVerifier(userId, verifierId) {
|
|
60033
|
+
// verify the required parameter 'userId' is set
|
|
60034
|
+
if (userId === undefined || userId === null) {
|
|
60035
|
+
throw 'Missing the required parameter "userId" when calling deleteUserVerifier';
|
|
60036
|
+
}
|
|
60037
|
+
// verify the required parameter 'verifierId' is set
|
|
60038
|
+
if (verifierId === undefined || verifierId === null) {
|
|
60039
|
+
throw 'Missing the required parameter "verifierId" when calling deleteUserVerifier';
|
|
60040
|
+
}
|
|
60041
|
+
|
|
60042
|
+
return this.apiClient.callApi(
|
|
60043
|
+
'/api/v2/users/{userId}/verifiers/{verifierId}',
|
|
60044
|
+
'DELETE',
|
|
60045
|
+
{ 'userId': userId,'verifierId': verifierId },
|
|
60046
|
+
{ },
|
|
60047
|
+
{ },
|
|
60048
|
+
{ },
|
|
60049
|
+
null,
|
|
60050
|
+
['PureCloud OAuth'],
|
|
60051
|
+
['application/json'],
|
|
60052
|
+
['application/json']
|
|
60053
|
+
);
|
|
60054
|
+
}
|
|
60055
|
+
|
|
59759
60056
|
/**
|
|
59760
60057
|
* Get status for async query for user aggregates
|
|
59761
60058
|
*
|
|
@@ -60652,6 +60949,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60652
60949
|
);
|
|
60653
60950
|
}
|
|
60654
60951
|
|
|
60952
|
+
/**
|
|
60953
|
+
* Get a list of verifiers
|
|
60954
|
+
*
|
|
60955
|
+
* @param {String} userId User ID
|
|
60956
|
+
*/
|
|
60957
|
+
getUserVerifiers(userId) {
|
|
60958
|
+
// verify the required parameter 'userId' is set
|
|
60959
|
+
if (userId === undefined || userId === null) {
|
|
60960
|
+
throw 'Missing the required parameter "userId" when calling getUserVerifiers';
|
|
60961
|
+
}
|
|
60962
|
+
|
|
60963
|
+
return this.apiClient.callApi(
|
|
60964
|
+
'/api/v2/users/{userId}/verifiers',
|
|
60965
|
+
'GET',
|
|
60966
|
+
{ 'userId': userId },
|
|
60967
|
+
{ },
|
|
60968
|
+
{ },
|
|
60969
|
+
{ },
|
|
60970
|
+
null,
|
|
60971
|
+
['PureCloud OAuth'],
|
|
60972
|
+
['application/json'],
|
|
60973
|
+
['application/json']
|
|
60974
|
+
);
|
|
60975
|
+
}
|
|
60976
|
+
|
|
60655
60977
|
/**
|
|
60656
60978
|
* Get the list of available users.
|
|
60657
60979
|
*
|
|
@@ -61097,7 +61419,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61097
61419
|
}
|
|
61098
61420
|
|
|
61099
61421
|
/**
|
|
61100
|
-
* Update bulk acd autoanswer on users
|
|
61422
|
+
* Update bulk acd autoanswer on users. Max 50 users can be updated at a time.
|
|
61101
61423
|
*
|
|
61102
61424
|
* @param {Array.<Object>} body Users
|
|
61103
61425
|
*/
|
|
@@ -62076,13 +62398,48 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62076
62398
|
);
|
|
62077
62399
|
}
|
|
62078
62400
|
|
|
62401
|
+
/**
|
|
62402
|
+
* Update a verifier
|
|
62403
|
+
*
|
|
62404
|
+
* @param {String} userId User ID
|
|
62405
|
+
* @param {String} verifierId Verifier ID
|
|
62406
|
+
* @param {Object} body Verifier Update
|
|
62407
|
+
*/
|
|
62408
|
+
putUserVerifier(userId, verifierId, body) {
|
|
62409
|
+
// verify the required parameter 'userId' is set
|
|
62410
|
+
if (userId === undefined || userId === null) {
|
|
62411
|
+
throw 'Missing the required parameter "userId" when calling putUserVerifier';
|
|
62412
|
+
}
|
|
62413
|
+
// verify the required parameter 'verifierId' is set
|
|
62414
|
+
if (verifierId === undefined || verifierId === null) {
|
|
62415
|
+
throw 'Missing the required parameter "verifierId" when calling putUserVerifier';
|
|
62416
|
+
}
|
|
62417
|
+
// verify the required parameter 'body' is set
|
|
62418
|
+
if (body === undefined || body === null) {
|
|
62419
|
+
throw 'Missing the required parameter "body" when calling putUserVerifier';
|
|
62420
|
+
}
|
|
62421
|
+
|
|
62422
|
+
return this.apiClient.callApi(
|
|
62423
|
+
'/api/v2/users/{userId}/verifiers/{verifierId}',
|
|
62424
|
+
'PUT',
|
|
62425
|
+
{ 'userId': userId,'verifierId': verifierId },
|
|
62426
|
+
{ },
|
|
62427
|
+
{ },
|
|
62428
|
+
{ },
|
|
62429
|
+
body,
|
|
62430
|
+
['PureCloud OAuth'],
|
|
62431
|
+
['application/json'],
|
|
62432
|
+
['application/json']
|
|
62433
|
+
);
|
|
62434
|
+
}
|
|
62435
|
+
|
|
62079
62436
|
}
|
|
62080
62437
|
|
|
62081
62438
|
class UtilitiesApi {
|
|
62082
62439
|
/**
|
|
62083
62440
|
* Utilities service.
|
|
62084
62441
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
62085
|
-
* @version
|
|
62442
|
+
* @version 181.0.0
|
|
62086
62443
|
*/
|
|
62087
62444
|
|
|
62088
62445
|
/**
|
|
@@ -62193,7 +62550,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62193
62550
|
/**
|
|
62194
62551
|
* Voicemail service.
|
|
62195
62552
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
62196
|
-
* @version
|
|
62553
|
+
* @version 181.0.0
|
|
62197
62554
|
*/
|
|
62198
62555
|
|
|
62199
62556
|
/**
|
|
@@ -62860,7 +63217,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62860
63217
|
/**
|
|
62861
63218
|
* WebChat service.
|
|
62862
63219
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
62863
|
-
* @version
|
|
63220
|
+
* @version 181.0.0
|
|
62864
63221
|
*/
|
|
62865
63222
|
|
|
62866
63223
|
/**
|
|
@@ -63409,7 +63766,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63409
63766
|
/**
|
|
63410
63767
|
* WebDeployments service.
|
|
63411
63768
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
63412
|
-
* @version
|
|
63769
|
+
* @version 181.0.0
|
|
63413
63770
|
*/
|
|
63414
63771
|
|
|
63415
63772
|
/**
|
|
@@ -63936,7 +64293,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63936
64293
|
/**
|
|
63937
64294
|
* WebMessaging service.
|
|
63938
64295
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
63939
|
-
* @version
|
|
64296
|
+
* @version 181.0.0
|
|
63940
64297
|
*/
|
|
63941
64298
|
|
|
63942
64299
|
/**
|
|
@@ -63982,7 +64339,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63982
64339
|
/**
|
|
63983
64340
|
* Widgets service.
|
|
63984
64341
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
63985
|
-
* @version
|
|
64342
|
+
* @version 181.0.0
|
|
63986
64343
|
*/
|
|
63987
64344
|
|
|
63988
64345
|
/**
|
|
@@ -64128,7 +64485,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64128
64485
|
/**
|
|
64129
64486
|
* WorkforceManagement service.
|
|
64130
64487
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
64131
|
-
* @version
|
|
64488
|
+
* @version 181.0.0
|
|
64132
64489
|
*/
|
|
64133
64490
|
|
|
64134
64491
|
/**
|
|
@@ -64811,8 +65168,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64811
65168
|
* Get activity codes
|
|
64812
65169
|
*
|
|
64813
65170
|
* @param {String} businessUnitId The ID of the business unit, or 'mine' for the business unit of the logged-in user.
|
|
65171
|
+
* @param {Object} opts Optional parameters
|
|
65172
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
64814
65173
|
*/
|
|
64815
|
-
getWorkforcemanagementBusinessunitActivitycodes(businessUnitId) {
|
|
65174
|
+
getWorkforcemanagementBusinessunitActivitycodes(businessUnitId, opts) {
|
|
65175
|
+
opts = opts || {};
|
|
65176
|
+
|
|
64816
65177
|
// verify the required parameter 'businessUnitId' is set
|
|
64817
65178
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
64818
65179
|
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitActivitycodes';
|
|
@@ -64822,7 +65183,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64822
65183
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes',
|
|
64823
65184
|
'GET',
|
|
64824
65185
|
{ 'businessUnitId': businessUnitId },
|
|
64825
|
-
{
|
|
65186
|
+
{ 'forceDownloadService': opts['forceDownloadService'] },
|
|
64826
65187
|
{ },
|
|
64827
65188
|
{ },
|
|
64828
65189
|
null,
|
|
@@ -66212,6 +66573,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66212
66573
|
* @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
66213
66574
|
* @param {Object} opts Optional parameters
|
|
66214
66575
|
* @param {Boolean} opts.evaluateMatches Whether to evaluate the matches for violations (default to true)
|
|
66576
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
66215
66577
|
*/
|
|
66216
66578
|
getWorkforcemanagementManagementunitWeekShifttrades(managementUnitId, weekDateId, opts) {
|
|
66217
66579
|
opts = opts || {};
|
|
@@ -66229,7 +66591,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66229
66591
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades',
|
|
66230
66592
|
'GET',
|
|
66231
66593
|
{ 'managementUnitId': managementUnitId,'weekDateId': weekDateId },
|
|
66232
|
-
{ 'evaluateMatches': opts['evaluateMatches'] },
|
|
66594
|
+
{ 'evaluateMatches': opts['evaluateMatches'],'forceDownloadService': opts['forceDownloadService'] },
|
|
66233
66595
|
{ },
|
|
66234
66596
|
{ },
|
|
66235
66597
|
null,
|
|
@@ -68477,6 +68839,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68477
68839
|
* Request body requires one of the following: User ID is specified, statuses == [Pending] or date range to be specified and less than or equal to 33 days. All other fields are filters
|
|
68478
68840
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
68479
68841
|
* @param {Object} opts Optional parameters
|
|
68842
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
68480
68843
|
* @param {Object} opts.body body
|
|
68481
68844
|
*/
|
|
68482
68845
|
postWorkforcemanagementManagementunitTimeoffrequestsQuery(managementUnitId, opts) {
|
|
@@ -68491,7 +68854,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68491
68854
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/query',
|
|
68492
68855
|
'POST',
|
|
68493
68856
|
{ 'managementUnitId': managementUnitId },
|
|
68494
|
-
{
|
|
68857
|
+
{ 'forceDownloadService': opts['forceDownloadService'] },
|
|
68495
68858
|
{ },
|
|
68496
68859
|
{ },
|
|
68497
68860
|
opts['body'],
|
|
@@ -68715,8 +69078,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68715
69078
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
68716
69079
|
* @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
68717
69080
|
* @param {Object} body body
|
|
69081
|
+
* @param {Object} opts Optional parameters
|
|
69082
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
68718
69083
|
*/
|
|
68719
|
-
postWorkforcemanagementManagementunitWeekShifttradesSearch(managementUnitId, weekDateId, body) {
|
|
69084
|
+
postWorkforcemanagementManagementunitWeekShifttradesSearch(managementUnitId, weekDateId, body, opts) {
|
|
69085
|
+
opts = opts || {};
|
|
69086
|
+
|
|
68720
69087
|
// verify the required parameter 'managementUnitId' is set
|
|
68721
69088
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
68722
69089
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekShifttradesSearch';
|
|
@@ -68734,7 +69101,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68734
69101
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/search',
|
|
68735
69102
|
'POST',
|
|
68736
69103
|
{ 'managementUnitId': managementUnitId,'weekDateId': weekDateId },
|
|
68737
|
-
{
|
|
69104
|
+
{ 'forceDownloadService': opts['forceDownloadService'] },
|
|
68738
69105
|
{ },
|
|
68739
69106
|
{ },
|
|
68740
69107
|
body,
|
|
@@ -69292,7 +69659,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69292
69659
|
* </pre>
|
|
69293
69660
|
* </p>
|
|
69294
69661
|
* @module purecloud-platform-client-v2/index
|
|
69295
|
-
* @version
|
|
69662
|
+
* @version 181.0.0
|
|
69296
69663
|
*/
|
|
69297
69664
|
class platformClient {
|
|
69298
69665
|
constructor() {
|
|
@@ -69496,6 +69863,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69496
69863
|
* @property {module:purecloud-platform-client-v2/api/ObjectsApi}
|
|
69497
69864
|
*/
|
|
69498
69865
|
this.ObjectsApi = ObjectsApi;
|
|
69866
|
+
/**
|
|
69867
|
+
* The OperationalEventsApi service constructor.
|
|
69868
|
+
* @property {module:purecloud-platform-client-v2/api/OperationalEventsApi}
|
|
69869
|
+
*/
|
|
69870
|
+
this.OperationalEventsApi = OperationalEventsApi;
|
|
69499
69871
|
/**
|
|
69500
69872
|
* The OrganizationApi service constructor.
|
|
69501
69873
|
* @property {module:purecloud-platform-client-v2/api/OrganizationApi}
|