purecloud-platform-client-v2 166.0.0 → 168.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 +747 -205
- package/dist/web-amd/purecloud-platform-client-v2.js +747 -205
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +747 -205
- package/dist/web-cjs/purecloud-platform-client-v2.js +747 -205
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +885 -413
- package/package.json +7 -7
- 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 +3 -3
- 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 +75 -0
- 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 +32 -1
- 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/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +2 -2
- 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 +470 -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 +69 -4
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- 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 +26 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +3 -2
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +3 -2
- 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/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -46
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -81
- 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 +2 -2
- 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 168.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 168.0.0
|
|
1489
1489
|
*/
|
|
1490
1490
|
|
|
1491
1491
|
/**
|
|
@@ -1799,7 +1799,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1799
1799
|
/**
|
|
1800
1800
|
* Analytics service.
|
|
1801
1801
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1802
|
-
* @version
|
|
1802
|
+
* @version 168.0.0
|
|
1803
1803
|
*/
|
|
1804
1804
|
|
|
1805
1805
|
/**
|
|
@@ -3053,7 +3053,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3053
3053
|
/**
|
|
3054
3054
|
* Architect service.
|
|
3055
3055
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
3056
|
-
* @version
|
|
3056
|
+
* @version 168.0.0
|
|
3057
3057
|
*/
|
|
3058
3058
|
|
|
3059
3059
|
/**
|
|
@@ -6101,7 +6101,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6101
6101
|
/**
|
|
6102
6102
|
* Audit service.
|
|
6103
6103
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
6104
|
-
* @version
|
|
6104
|
+
* @version 168.0.0
|
|
6105
6105
|
*/
|
|
6106
6106
|
|
|
6107
6107
|
/**
|
|
@@ -6214,7 +6214,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6214
6214
|
|
|
6215
6215
|
/**
|
|
6216
6216
|
* Create audit query execution
|
|
6217
|
-
*
|
|
6217
|
+
* Use /api/v2/audits/query/servicemapping endpoint for a list of valid values
|
|
6218
6218
|
* @param {Object} body query
|
|
6219
6219
|
*/
|
|
6220
6220
|
postAuditsQuery(body) {
|
|
@@ -6239,7 +6239,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6239
6239
|
|
|
6240
6240
|
/**
|
|
6241
6241
|
* This endpoint will only retrieve 14 days worth of audits for certain services. Please use /query to get a full list and older audits.
|
|
6242
|
-
*
|
|
6242
|
+
* Use /api/v2/audits/query/realtime/servicemapping endpoint for a list of valid values
|
|
6243
6243
|
* @param {Object} body query
|
|
6244
6244
|
* @param {Object} opts Optional parameters
|
|
6245
6245
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
@@ -6272,7 +6272,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6272
6272
|
/**
|
|
6273
6273
|
* Authorization service.
|
|
6274
6274
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
6275
|
-
* @version
|
|
6275
|
+
* @version 168.0.0
|
|
6276
6276
|
*/
|
|
6277
6277
|
|
|
6278
6278
|
/**
|
|
@@ -7501,7 +7501,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7501
7501
|
/**
|
|
7502
7502
|
* Billing service.
|
|
7503
7503
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
7504
|
-
* @version
|
|
7504
|
+
* @version 168.0.0
|
|
7505
7505
|
*/
|
|
7506
7506
|
|
|
7507
7507
|
/**
|
|
@@ -7577,11 +7577,81 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7577
7577
|
|
|
7578
7578
|
}
|
|
7579
7579
|
|
|
7580
|
+
class CarrierServicesApi {
|
|
7581
|
+
/**
|
|
7582
|
+
* CarrierServices service.
|
|
7583
|
+
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
7584
|
+
* @version 168.0.0
|
|
7585
|
+
*/
|
|
7586
|
+
|
|
7587
|
+
/**
|
|
7588
|
+
* Constructs a new CarrierServicesApi.
|
|
7589
|
+
* @alias module:purecloud-platform-client-v2/api/CarrierServicesApi
|
|
7590
|
+
* @class
|
|
7591
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
7592
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
7593
|
+
*/
|
|
7594
|
+
constructor(apiClient) {
|
|
7595
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
7596
|
+
}
|
|
7597
|
+
|
|
7598
|
+
|
|
7599
|
+
/**
|
|
7600
|
+
* Get location for the logged in user
|
|
7601
|
+
*
|
|
7602
|
+
* @param {String} phoneNumber Phone number in E164 format
|
|
7603
|
+
*/
|
|
7604
|
+
getCarrierservicesIntegrationsEmergencylocationsMe(phoneNumber) {
|
|
7605
|
+
// verify the required parameter 'phoneNumber' is set
|
|
7606
|
+
if (phoneNumber === undefined || phoneNumber === null) {
|
|
7607
|
+
throw 'Missing the required parameter "phoneNumber" when calling getCarrierservicesIntegrationsEmergencylocationsMe';
|
|
7608
|
+
}
|
|
7609
|
+
|
|
7610
|
+
return this.apiClient.callApi(
|
|
7611
|
+
'/api/v2/carrierservices/integrations/emergencylocations/me',
|
|
7612
|
+
'GET',
|
|
7613
|
+
{ },
|
|
7614
|
+
{ 'phoneNumber': phoneNumber },
|
|
7615
|
+
{ },
|
|
7616
|
+
{ },
|
|
7617
|
+
null,
|
|
7618
|
+
['PureCloud OAuth'],
|
|
7619
|
+
['application/json'],
|
|
7620
|
+
['application/json']
|
|
7621
|
+
);
|
|
7622
|
+
}
|
|
7623
|
+
|
|
7624
|
+
/**
|
|
7625
|
+
* Set current location for the logged in user
|
|
7626
|
+
*
|
|
7627
|
+
* @param {Object} opts Optional parameters
|
|
7628
|
+
* @param {Object} opts.body
|
|
7629
|
+
*/
|
|
7630
|
+
postCarrierservicesIntegrationsEmergencylocationsMe(opts) {
|
|
7631
|
+
opts = opts || {};
|
|
7632
|
+
|
|
7633
|
+
|
|
7634
|
+
return this.apiClient.callApi(
|
|
7635
|
+
'/api/v2/carrierservices/integrations/emergencylocations/me',
|
|
7636
|
+
'POST',
|
|
7637
|
+
{ },
|
|
7638
|
+
{ },
|
|
7639
|
+
{ },
|
|
7640
|
+
{ },
|
|
7641
|
+
opts['body'],
|
|
7642
|
+
['PureCloud OAuth'],
|
|
7643
|
+
['application/json'],
|
|
7644
|
+
['application/json']
|
|
7645
|
+
);
|
|
7646
|
+
}
|
|
7647
|
+
|
|
7648
|
+
}
|
|
7649
|
+
|
|
7580
7650
|
class ChatApi {
|
|
7581
7651
|
/**
|
|
7582
7652
|
* Chat service.
|
|
7583
7653
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
7584
|
-
* @version
|
|
7654
|
+
* @version 168.0.0
|
|
7585
7655
|
*/
|
|
7586
7656
|
|
|
7587
7657
|
/**
|
|
@@ -7742,7 +7812,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7742
7812
|
/**
|
|
7743
7813
|
* Coaching service.
|
|
7744
7814
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
7745
|
-
* @version
|
|
7815
|
+
* @version 168.0.0
|
|
7746
7816
|
*/
|
|
7747
7817
|
|
|
7748
7818
|
/**
|
|
@@ -8319,7 +8389,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8319
8389
|
/**
|
|
8320
8390
|
* ContentManagement service.
|
|
8321
8391
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
8322
|
-
* @version
|
|
8392
|
+
* @version 168.0.0
|
|
8323
8393
|
*/
|
|
8324
8394
|
|
|
8325
8395
|
/**
|
|
@@ -9459,7 +9529,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9459
9529
|
/**
|
|
9460
9530
|
* Conversations service.
|
|
9461
9531
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
9462
|
-
* @version
|
|
9532
|
+
* @version 168.0.0
|
|
9463
9533
|
*/
|
|
9464
9534
|
|
|
9465
9535
|
/**
|
|
@@ -12724,6 +12794,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12724
12794
|
);
|
|
12725
12795
|
}
|
|
12726
12796
|
|
|
12797
|
+
/**
|
|
12798
|
+
* Reset conversation draft to its initial state and/or auto-fill draft content
|
|
12799
|
+
*
|
|
12800
|
+
* @param {String} conversationId conversationId
|
|
12801
|
+
* @param {Object} opts Optional parameters
|
|
12802
|
+
* @param {Boolean} opts.autoFill autoFill
|
|
12803
|
+
* @param {Boolean} opts.discard discard
|
|
12804
|
+
* @param {Object} opts.body Draft Manipulation Request
|
|
12805
|
+
*/
|
|
12806
|
+
patchConversationsEmailMessagesDraft(conversationId, opts) {
|
|
12807
|
+
opts = opts || {};
|
|
12808
|
+
|
|
12809
|
+
// verify the required parameter 'conversationId' is set
|
|
12810
|
+
if (conversationId === undefined || conversationId === null) {
|
|
12811
|
+
throw 'Missing the required parameter "conversationId" when calling patchConversationsEmailMessagesDraft';
|
|
12812
|
+
}
|
|
12813
|
+
|
|
12814
|
+
return this.apiClient.callApi(
|
|
12815
|
+
'/api/v2/conversations/emails/{conversationId}/messages/draft',
|
|
12816
|
+
'PATCH',
|
|
12817
|
+
{ 'conversationId': conversationId },
|
|
12818
|
+
{ 'autoFill': opts['autoFill'],'discard': opts['discard'] },
|
|
12819
|
+
{ },
|
|
12820
|
+
{ },
|
|
12821
|
+
opts['body'],
|
|
12822
|
+
['PureCloud OAuth'],
|
|
12823
|
+
['application/json'],
|
|
12824
|
+
['application/json']
|
|
12825
|
+
);
|
|
12826
|
+
}
|
|
12827
|
+
|
|
12727
12828
|
/**
|
|
12728
12829
|
* Update conversation participant
|
|
12729
12830
|
*
|
|
@@ -15519,7 +15620,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15519
15620
|
/**
|
|
15520
15621
|
* DataExtensions service.
|
|
15521
15622
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
15522
|
-
* @version
|
|
15623
|
+
* @version 168.0.0
|
|
15523
15624
|
*/
|
|
15524
15625
|
|
|
15525
15626
|
/**
|
|
@@ -15605,7 +15706,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15605
15706
|
/**
|
|
15606
15707
|
* Downloads service.
|
|
15607
15708
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
15608
|
-
* @version
|
|
15709
|
+
* @version 168.0.0
|
|
15609
15710
|
*/
|
|
15610
15711
|
|
|
15611
15712
|
/**
|
|
@@ -15657,7 +15758,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15657
15758
|
/**
|
|
15658
15759
|
* Events service.
|
|
15659
15760
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
15660
|
-
* @version
|
|
15761
|
+
* @version 168.0.0
|
|
15661
15762
|
*/
|
|
15662
15763
|
|
|
15663
15764
|
/**
|
|
@@ -15753,7 +15854,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15753
15854
|
/**
|
|
15754
15855
|
* ExternalContacts service.
|
|
15755
15856
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
15756
|
-
* @version
|
|
15857
|
+
* @version 168.0.0
|
|
15757
15858
|
*/
|
|
15758
15859
|
|
|
15759
15860
|
/**
|
|
@@ -17297,7 +17398,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17297
17398
|
|
|
17298
17399
|
/**
|
|
17299
17400
|
* Merge two contacts into a new contact record
|
|
17300
|
-
*
|
|
17401
|
+
* Two curated contacts cannot be merged. Refer to the Contact Merging article on the Developer Center for details
|
|
17301
17402
|
* @param {Object} body MergeRequest
|
|
17302
17403
|
*/
|
|
17303
17404
|
postExternalcontactsMergeContacts(body) {
|
|
@@ -17711,7 +17812,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17711
17812
|
/**
|
|
17712
17813
|
* Fax service.
|
|
17713
17814
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
17714
|
-
* @version
|
|
17815
|
+
* @version 168.0.0
|
|
17715
17816
|
*/
|
|
17716
17817
|
|
|
17717
17818
|
/**
|
|
@@ -17882,7 +17983,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17882
17983
|
/**
|
|
17883
17984
|
* Flows service.
|
|
17884
17985
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
17885
|
-
* @version
|
|
17986
|
+
* @version 168.0.0
|
|
17886
17987
|
*/
|
|
17887
17988
|
|
|
17888
17989
|
/**
|
|
@@ -17953,7 +18054,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17953
18054
|
/**
|
|
17954
18055
|
* Gamification service.
|
|
17955
18056
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
17956
|
-
* @version
|
|
18057
|
+
* @version 168.0.0
|
|
17957
18058
|
*/
|
|
17958
18059
|
|
|
17959
18060
|
/**
|
|
@@ -18043,6 +18144,420 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18043
18144
|
);
|
|
18044
18145
|
}
|
|
18045
18146
|
|
|
18147
|
+
/**
|
|
18148
|
+
* Get insights summary
|
|
18149
|
+
*
|
|
18150
|
+
* @param {Object} filterType Filter type for the query request.
|
|
18151
|
+
* @param {String} filterId ID for the filter type.
|
|
18152
|
+
* @param {Object} granularity Granularity
|
|
18153
|
+
* @param {String} comparativePeriodStartWorkday The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
18154
|
+
* @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
18155
|
+
* @param {Object} opts Optional parameters
|
|
18156
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
18157
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
18158
|
+
* @param {Object} opts.sortKey Sort key
|
|
18159
|
+
* @param {String} opts.sortMetricId Sort Metric Id
|
|
18160
|
+
* @param {Object} opts.sortOrder Sort order (default to asc)
|
|
18161
|
+
* @param {String} opts.userIds A list of up to 100 comma-separated user Ids
|
|
18162
|
+
*/
|
|
18163
|
+
getGamificationInsights(filterType, filterId, granularity, comparativePeriodStartWorkday, primaryPeriodStartWorkday, opts) {
|
|
18164
|
+
opts = opts || {};
|
|
18165
|
+
|
|
18166
|
+
// verify the required parameter 'filterType' is set
|
|
18167
|
+
if (filterType === undefined || filterType === null) {
|
|
18168
|
+
throw 'Missing the required parameter "filterType" when calling getGamificationInsights';
|
|
18169
|
+
}
|
|
18170
|
+
// verify the required parameter 'filterId' is set
|
|
18171
|
+
if (filterId === undefined || filterId === null) {
|
|
18172
|
+
throw 'Missing the required parameter "filterId" when calling getGamificationInsights';
|
|
18173
|
+
}
|
|
18174
|
+
// verify the required parameter 'granularity' is set
|
|
18175
|
+
if (granularity === undefined || granularity === null) {
|
|
18176
|
+
throw 'Missing the required parameter "granularity" when calling getGamificationInsights';
|
|
18177
|
+
}
|
|
18178
|
+
// verify the required parameter 'comparativePeriodStartWorkday' is set
|
|
18179
|
+
if (comparativePeriodStartWorkday === undefined || comparativePeriodStartWorkday === null) {
|
|
18180
|
+
throw 'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsights';
|
|
18181
|
+
}
|
|
18182
|
+
// verify the required parameter 'primaryPeriodStartWorkday' is set
|
|
18183
|
+
if (primaryPeriodStartWorkday === undefined || primaryPeriodStartWorkday === null) {
|
|
18184
|
+
throw 'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsights';
|
|
18185
|
+
}
|
|
18186
|
+
|
|
18187
|
+
return this.apiClient.callApi(
|
|
18188
|
+
'/api/v2/gamification/insights',
|
|
18189
|
+
'GET',
|
|
18190
|
+
{ },
|
|
18191
|
+
{ 'filterType': filterType,'filterId': filterId,'granularity': granularity,'comparativePeriodStartWorkday': comparativePeriodStartWorkday,'primaryPeriodStartWorkday': primaryPeriodStartWorkday,'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortKey': opts['sortKey'],'sortMetricId': opts['sortMetricId'],'sortOrder': opts['sortOrder'],'userIds': opts['userIds'] },
|
|
18192
|
+
{ },
|
|
18193
|
+
{ },
|
|
18194
|
+
null,
|
|
18195
|
+
['PureCloud OAuth'],
|
|
18196
|
+
['application/json'],
|
|
18197
|
+
['application/json']
|
|
18198
|
+
);
|
|
18199
|
+
}
|
|
18200
|
+
|
|
18201
|
+
/**
|
|
18202
|
+
* Get insights details for the current user
|
|
18203
|
+
*
|
|
18204
|
+
* @param {Object} filterType Filter type for the query request.
|
|
18205
|
+
* @param {String} filterId ID for the filter type.
|
|
18206
|
+
* @param {Object} granularity Granularity
|
|
18207
|
+
* @param {String} comparativePeriodStartWorkday The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
18208
|
+
* @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
18209
|
+
*/
|
|
18210
|
+
getGamificationInsightsDetails(filterType, filterId, granularity, comparativePeriodStartWorkday, primaryPeriodStartWorkday) {
|
|
18211
|
+
// verify the required parameter 'filterType' is set
|
|
18212
|
+
if (filterType === undefined || filterType === null) {
|
|
18213
|
+
throw 'Missing the required parameter "filterType" when calling getGamificationInsightsDetails';
|
|
18214
|
+
}
|
|
18215
|
+
// verify the required parameter 'filterId' is set
|
|
18216
|
+
if (filterId === undefined || filterId === null) {
|
|
18217
|
+
throw 'Missing the required parameter "filterId" when calling getGamificationInsightsDetails';
|
|
18218
|
+
}
|
|
18219
|
+
// verify the required parameter 'granularity' is set
|
|
18220
|
+
if (granularity === undefined || granularity === null) {
|
|
18221
|
+
throw 'Missing the required parameter "granularity" when calling getGamificationInsightsDetails';
|
|
18222
|
+
}
|
|
18223
|
+
// verify the required parameter 'comparativePeriodStartWorkday' is set
|
|
18224
|
+
if (comparativePeriodStartWorkday === undefined || comparativePeriodStartWorkday === null) {
|
|
18225
|
+
throw 'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsDetails';
|
|
18226
|
+
}
|
|
18227
|
+
// verify the required parameter 'primaryPeriodStartWorkday' is set
|
|
18228
|
+
if (primaryPeriodStartWorkday === undefined || primaryPeriodStartWorkday === null) {
|
|
18229
|
+
throw 'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsDetails';
|
|
18230
|
+
}
|
|
18231
|
+
|
|
18232
|
+
return this.apiClient.callApi(
|
|
18233
|
+
'/api/v2/gamification/insights/details',
|
|
18234
|
+
'GET',
|
|
18235
|
+
{ },
|
|
18236
|
+
{ 'filterType': filterType,'filterId': filterId,'granularity': granularity,'comparativePeriodStartWorkday': comparativePeriodStartWorkday,'primaryPeriodStartWorkday': primaryPeriodStartWorkday },
|
|
18237
|
+
{ },
|
|
18238
|
+
{ },
|
|
18239
|
+
null,
|
|
18240
|
+
['PureCloud OAuth'],
|
|
18241
|
+
['application/json'],
|
|
18242
|
+
['application/json']
|
|
18243
|
+
);
|
|
18244
|
+
}
|
|
18245
|
+
|
|
18246
|
+
/**
|
|
18247
|
+
* Get insights overall trend for the current user
|
|
18248
|
+
*
|
|
18249
|
+
* @param {Object} filterType Filter type for the query request.
|
|
18250
|
+
* @param {String} filterId ID for the filter type.
|
|
18251
|
+
* @param {Object} granularity Granularity
|
|
18252
|
+
* @param {String} comparativePeriodStartWorkday The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
18253
|
+
* @param {String} comparativePeriodEndWorkday The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
18254
|
+
* @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
18255
|
+
* @param {String} primaryPeriodEndWorkday The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
18256
|
+
*/
|
|
18257
|
+
getGamificationInsightsGroupsTrends(filterType, filterId, granularity, comparativePeriodStartWorkday, comparativePeriodEndWorkday, primaryPeriodStartWorkday, primaryPeriodEndWorkday) {
|
|
18258
|
+
// verify the required parameter 'filterType' is set
|
|
18259
|
+
if (filterType === undefined || filterType === null) {
|
|
18260
|
+
throw 'Missing the required parameter "filterType" when calling getGamificationInsightsGroupsTrends';
|
|
18261
|
+
}
|
|
18262
|
+
// verify the required parameter 'filterId' is set
|
|
18263
|
+
if (filterId === undefined || filterId === null) {
|
|
18264
|
+
throw 'Missing the required parameter "filterId" when calling getGamificationInsightsGroupsTrends';
|
|
18265
|
+
}
|
|
18266
|
+
// verify the required parameter 'granularity' is set
|
|
18267
|
+
if (granularity === undefined || granularity === null) {
|
|
18268
|
+
throw 'Missing the required parameter "granularity" when calling getGamificationInsightsGroupsTrends';
|
|
18269
|
+
}
|
|
18270
|
+
// verify the required parameter 'comparativePeriodStartWorkday' is set
|
|
18271
|
+
if (comparativePeriodStartWorkday === undefined || comparativePeriodStartWorkday === null) {
|
|
18272
|
+
throw 'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsGroupsTrends';
|
|
18273
|
+
}
|
|
18274
|
+
// verify the required parameter 'comparativePeriodEndWorkday' is set
|
|
18275
|
+
if (comparativePeriodEndWorkday === undefined || comparativePeriodEndWorkday === null) {
|
|
18276
|
+
throw 'Missing the required parameter "comparativePeriodEndWorkday" when calling getGamificationInsightsGroupsTrends';
|
|
18277
|
+
}
|
|
18278
|
+
// verify the required parameter 'primaryPeriodStartWorkday' is set
|
|
18279
|
+
if (primaryPeriodStartWorkday === undefined || primaryPeriodStartWorkday === null) {
|
|
18280
|
+
throw 'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsGroupsTrends';
|
|
18281
|
+
}
|
|
18282
|
+
// verify the required parameter 'primaryPeriodEndWorkday' is set
|
|
18283
|
+
if (primaryPeriodEndWorkday === undefined || primaryPeriodEndWorkday === null) {
|
|
18284
|
+
throw 'Missing the required parameter "primaryPeriodEndWorkday" when calling getGamificationInsightsGroupsTrends';
|
|
18285
|
+
}
|
|
18286
|
+
|
|
18287
|
+
return this.apiClient.callApi(
|
|
18288
|
+
'/api/v2/gamification/insights/groups/trends',
|
|
18289
|
+
'GET',
|
|
18290
|
+
{ },
|
|
18291
|
+
{ 'filterType': filterType,'filterId': filterId,'granularity': granularity,'comparativePeriodStartWorkday': comparativePeriodStartWorkday,'comparativePeriodEndWorkday': comparativePeriodEndWorkday,'primaryPeriodStartWorkday': primaryPeriodStartWorkday,'primaryPeriodEndWorkday': primaryPeriodEndWorkday },
|
|
18292
|
+
{ },
|
|
18293
|
+
{ },
|
|
18294
|
+
null,
|
|
18295
|
+
['PureCloud OAuth'],
|
|
18296
|
+
['application/json'],
|
|
18297
|
+
['application/json']
|
|
18298
|
+
);
|
|
18299
|
+
}
|
|
18300
|
+
|
|
18301
|
+
/**
|
|
18302
|
+
* Get insights overall trend
|
|
18303
|
+
*
|
|
18304
|
+
* @param {Object} filterType Filter type for the query request.
|
|
18305
|
+
* @param {String} filterId ID for the filter type.
|
|
18306
|
+
* @param {Object} granularity Granularity
|
|
18307
|
+
* @param {String} comparativePeriodStartWorkday The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
18308
|
+
* @param {String} comparativePeriodEndWorkday The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
18309
|
+
* @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
18310
|
+
* @param {String} primaryPeriodEndWorkday The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
18311
|
+
*/
|
|
18312
|
+
getGamificationInsightsGroupsTrendsAll(filterType, filterId, granularity, comparativePeriodStartWorkday, comparativePeriodEndWorkday, primaryPeriodStartWorkday, primaryPeriodEndWorkday) {
|
|
18313
|
+
// verify the required parameter 'filterType' is set
|
|
18314
|
+
if (filterType === undefined || filterType === null) {
|
|
18315
|
+
throw 'Missing the required parameter "filterType" when calling getGamificationInsightsGroupsTrendsAll';
|
|
18316
|
+
}
|
|
18317
|
+
// verify the required parameter 'filterId' is set
|
|
18318
|
+
if (filterId === undefined || filterId === null) {
|
|
18319
|
+
throw 'Missing the required parameter "filterId" when calling getGamificationInsightsGroupsTrendsAll';
|
|
18320
|
+
}
|
|
18321
|
+
// verify the required parameter 'granularity' is set
|
|
18322
|
+
if (granularity === undefined || granularity === null) {
|
|
18323
|
+
throw 'Missing the required parameter "granularity" when calling getGamificationInsightsGroupsTrendsAll';
|
|
18324
|
+
}
|
|
18325
|
+
// verify the required parameter 'comparativePeriodStartWorkday' is set
|
|
18326
|
+
if (comparativePeriodStartWorkday === undefined || comparativePeriodStartWorkday === null) {
|
|
18327
|
+
throw 'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsGroupsTrendsAll';
|
|
18328
|
+
}
|
|
18329
|
+
// verify the required parameter 'comparativePeriodEndWorkday' is set
|
|
18330
|
+
if (comparativePeriodEndWorkday === undefined || comparativePeriodEndWorkday === null) {
|
|
18331
|
+
throw 'Missing the required parameter "comparativePeriodEndWorkday" when calling getGamificationInsightsGroupsTrendsAll';
|
|
18332
|
+
}
|
|
18333
|
+
// verify the required parameter 'primaryPeriodStartWorkday' is set
|
|
18334
|
+
if (primaryPeriodStartWorkday === undefined || primaryPeriodStartWorkday === null) {
|
|
18335
|
+
throw 'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsGroupsTrendsAll';
|
|
18336
|
+
}
|
|
18337
|
+
// verify the required parameter 'primaryPeriodEndWorkday' is set
|
|
18338
|
+
if (primaryPeriodEndWorkday === undefined || primaryPeriodEndWorkday === null) {
|
|
18339
|
+
throw 'Missing the required parameter "primaryPeriodEndWorkday" when calling getGamificationInsightsGroupsTrendsAll';
|
|
18340
|
+
}
|
|
18341
|
+
|
|
18342
|
+
return this.apiClient.callApi(
|
|
18343
|
+
'/api/v2/gamification/insights/groups/trends/all',
|
|
18344
|
+
'GET',
|
|
18345
|
+
{ },
|
|
18346
|
+
{ 'filterType': filterType,'filterId': filterId,'granularity': granularity,'comparativePeriodStartWorkday': comparativePeriodStartWorkday,'comparativePeriodEndWorkday': comparativePeriodEndWorkday,'primaryPeriodStartWorkday': primaryPeriodStartWorkday,'primaryPeriodEndWorkday': primaryPeriodEndWorkday },
|
|
18347
|
+
{ },
|
|
18348
|
+
{ },
|
|
18349
|
+
null,
|
|
18350
|
+
['PureCloud OAuth'],
|
|
18351
|
+
['application/json'],
|
|
18352
|
+
['application/json']
|
|
18353
|
+
);
|
|
18354
|
+
}
|
|
18355
|
+
|
|
18356
|
+
/**
|
|
18357
|
+
* Query users in a profile during a period of time
|
|
18358
|
+
*
|
|
18359
|
+
* @param {Object} filterType Filter type for the query request.
|
|
18360
|
+
* @param {String} filterId ID for the filter type.
|
|
18361
|
+
* @param {Object} granularity Granularity
|
|
18362
|
+
* @param {String} startWorkday The start work day. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
18363
|
+
*/
|
|
18364
|
+
getGamificationInsightsMembers(filterType, filterId, granularity, startWorkday) {
|
|
18365
|
+
// verify the required parameter 'filterType' is set
|
|
18366
|
+
if (filterType === undefined || filterType === null) {
|
|
18367
|
+
throw 'Missing the required parameter "filterType" when calling getGamificationInsightsMembers';
|
|
18368
|
+
}
|
|
18369
|
+
// verify the required parameter 'filterId' is set
|
|
18370
|
+
if (filterId === undefined || filterId === null) {
|
|
18371
|
+
throw 'Missing the required parameter "filterId" when calling getGamificationInsightsMembers';
|
|
18372
|
+
}
|
|
18373
|
+
// verify the required parameter 'granularity' is set
|
|
18374
|
+
if (granularity === undefined || granularity === null) {
|
|
18375
|
+
throw 'Missing the required parameter "granularity" when calling getGamificationInsightsMembers';
|
|
18376
|
+
}
|
|
18377
|
+
// verify the required parameter 'startWorkday' is set
|
|
18378
|
+
if (startWorkday === undefined || startWorkday === null) {
|
|
18379
|
+
throw 'Missing the required parameter "startWorkday" when calling getGamificationInsightsMembers';
|
|
18380
|
+
}
|
|
18381
|
+
|
|
18382
|
+
return this.apiClient.callApi(
|
|
18383
|
+
'/api/v2/gamification/insights/members',
|
|
18384
|
+
'GET',
|
|
18385
|
+
{ },
|
|
18386
|
+
{ 'filterType': filterType,'filterId': filterId,'granularity': granularity,'startWorkday': startWorkday },
|
|
18387
|
+
{ },
|
|
18388
|
+
{ },
|
|
18389
|
+
null,
|
|
18390
|
+
['PureCloud OAuth'],
|
|
18391
|
+
['application/json'],
|
|
18392
|
+
['application/json']
|
|
18393
|
+
);
|
|
18394
|
+
}
|
|
18395
|
+
|
|
18396
|
+
/**
|
|
18397
|
+
* Get insights user trend for the current user
|
|
18398
|
+
*
|
|
18399
|
+
* @param {Object} filterType Filter type for the query request.
|
|
18400
|
+
* @param {String} filterId ID for the filter type.
|
|
18401
|
+
* @param {Object} granularity Granularity
|
|
18402
|
+
* @param {String} comparativePeriodStartWorkday The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
18403
|
+
* @param {String} comparativePeriodEndWorkday The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
18404
|
+
* @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
18405
|
+
* @param {String} primaryPeriodEndWorkday The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
18406
|
+
*/
|
|
18407
|
+
getGamificationInsightsTrends(filterType, filterId, granularity, comparativePeriodStartWorkday, comparativePeriodEndWorkday, primaryPeriodStartWorkday, primaryPeriodEndWorkday) {
|
|
18408
|
+
// verify the required parameter 'filterType' is set
|
|
18409
|
+
if (filterType === undefined || filterType === null) {
|
|
18410
|
+
throw 'Missing the required parameter "filterType" when calling getGamificationInsightsTrends';
|
|
18411
|
+
}
|
|
18412
|
+
// verify the required parameter 'filterId' is set
|
|
18413
|
+
if (filterId === undefined || filterId === null) {
|
|
18414
|
+
throw 'Missing the required parameter "filterId" when calling getGamificationInsightsTrends';
|
|
18415
|
+
}
|
|
18416
|
+
// verify the required parameter 'granularity' is set
|
|
18417
|
+
if (granularity === undefined || granularity === null) {
|
|
18418
|
+
throw 'Missing the required parameter "granularity" when calling getGamificationInsightsTrends';
|
|
18419
|
+
}
|
|
18420
|
+
// verify the required parameter 'comparativePeriodStartWorkday' is set
|
|
18421
|
+
if (comparativePeriodStartWorkday === undefined || comparativePeriodStartWorkday === null) {
|
|
18422
|
+
throw 'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsTrends';
|
|
18423
|
+
}
|
|
18424
|
+
// verify the required parameter 'comparativePeriodEndWorkday' is set
|
|
18425
|
+
if (comparativePeriodEndWorkday === undefined || comparativePeriodEndWorkday === null) {
|
|
18426
|
+
throw 'Missing the required parameter "comparativePeriodEndWorkday" when calling getGamificationInsightsTrends';
|
|
18427
|
+
}
|
|
18428
|
+
// verify the required parameter 'primaryPeriodStartWorkday' is set
|
|
18429
|
+
if (primaryPeriodStartWorkday === undefined || primaryPeriodStartWorkday === null) {
|
|
18430
|
+
throw 'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsTrends';
|
|
18431
|
+
}
|
|
18432
|
+
// verify the required parameter 'primaryPeriodEndWorkday' is set
|
|
18433
|
+
if (primaryPeriodEndWorkday === undefined || primaryPeriodEndWorkday === null) {
|
|
18434
|
+
throw 'Missing the required parameter "primaryPeriodEndWorkday" when calling getGamificationInsightsTrends';
|
|
18435
|
+
}
|
|
18436
|
+
|
|
18437
|
+
return this.apiClient.callApi(
|
|
18438
|
+
'/api/v2/gamification/insights/trends',
|
|
18439
|
+
'GET',
|
|
18440
|
+
{ },
|
|
18441
|
+
{ 'filterType': filterType,'filterId': filterId,'granularity': granularity,'comparativePeriodStartWorkday': comparativePeriodStartWorkday,'comparativePeriodEndWorkday': comparativePeriodEndWorkday,'primaryPeriodStartWorkday': primaryPeriodStartWorkday,'primaryPeriodEndWorkday': primaryPeriodEndWorkday },
|
|
18442
|
+
{ },
|
|
18443
|
+
{ },
|
|
18444
|
+
null,
|
|
18445
|
+
['PureCloud OAuth'],
|
|
18446
|
+
['application/json'],
|
|
18447
|
+
['application/json']
|
|
18448
|
+
);
|
|
18449
|
+
}
|
|
18450
|
+
|
|
18451
|
+
/**
|
|
18452
|
+
* Get insights details for the user
|
|
18453
|
+
*
|
|
18454
|
+
* @param {String} userId The ID of a user.
|
|
18455
|
+
* @param {Object} filterType Filter type for the query request.
|
|
18456
|
+
* @param {String} filterId ID for the filter type.
|
|
18457
|
+
* @param {Object} granularity Granularity
|
|
18458
|
+
* @param {String} comparativePeriodStartWorkday The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
18459
|
+
* @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
18460
|
+
*/
|
|
18461
|
+
getGamificationInsightsUserDetails(userId, filterType, filterId, granularity, comparativePeriodStartWorkday, primaryPeriodStartWorkday) {
|
|
18462
|
+
// verify the required parameter 'userId' is set
|
|
18463
|
+
if (userId === undefined || userId === null) {
|
|
18464
|
+
throw 'Missing the required parameter "userId" when calling getGamificationInsightsUserDetails';
|
|
18465
|
+
}
|
|
18466
|
+
// verify the required parameter 'filterType' is set
|
|
18467
|
+
if (filterType === undefined || filterType === null) {
|
|
18468
|
+
throw 'Missing the required parameter "filterType" when calling getGamificationInsightsUserDetails';
|
|
18469
|
+
}
|
|
18470
|
+
// verify the required parameter 'filterId' is set
|
|
18471
|
+
if (filterId === undefined || filterId === null) {
|
|
18472
|
+
throw 'Missing the required parameter "filterId" when calling getGamificationInsightsUserDetails';
|
|
18473
|
+
}
|
|
18474
|
+
// verify the required parameter 'granularity' is set
|
|
18475
|
+
if (granularity === undefined || granularity === null) {
|
|
18476
|
+
throw 'Missing the required parameter "granularity" when calling getGamificationInsightsUserDetails';
|
|
18477
|
+
}
|
|
18478
|
+
// verify the required parameter 'comparativePeriodStartWorkday' is set
|
|
18479
|
+
if (comparativePeriodStartWorkday === undefined || comparativePeriodStartWorkday === null) {
|
|
18480
|
+
throw 'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsUserDetails';
|
|
18481
|
+
}
|
|
18482
|
+
// verify the required parameter 'primaryPeriodStartWorkday' is set
|
|
18483
|
+
if (primaryPeriodStartWorkday === undefined || primaryPeriodStartWorkday === null) {
|
|
18484
|
+
throw 'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsUserDetails';
|
|
18485
|
+
}
|
|
18486
|
+
|
|
18487
|
+
return this.apiClient.callApi(
|
|
18488
|
+
'/api/v2/gamification/insights/users/{userId}/details',
|
|
18489
|
+
'GET',
|
|
18490
|
+
{ 'userId': userId },
|
|
18491
|
+
{ 'filterType': filterType,'filterId': filterId,'granularity': granularity,'comparativePeriodStartWorkday': comparativePeriodStartWorkday,'primaryPeriodStartWorkday': primaryPeriodStartWorkday },
|
|
18492
|
+
{ },
|
|
18493
|
+
{ },
|
|
18494
|
+
null,
|
|
18495
|
+
['PureCloud OAuth'],
|
|
18496
|
+
['application/json'],
|
|
18497
|
+
['application/json']
|
|
18498
|
+
);
|
|
18499
|
+
}
|
|
18500
|
+
|
|
18501
|
+
/**
|
|
18502
|
+
* Get insights user trend for the user
|
|
18503
|
+
*
|
|
18504
|
+
* @param {String} userId The ID of a user.
|
|
18505
|
+
* @param {Object} filterType Filter type for the query request.
|
|
18506
|
+
* @param {String} filterId ID for the filter type.
|
|
18507
|
+
* @param {Object} granularity Granularity
|
|
18508
|
+
* @param {String} comparativePeriodStartWorkday The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
18509
|
+
* @param {String} comparativePeriodEndWorkday The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
18510
|
+
* @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
18511
|
+
* @param {String} primaryPeriodEndWorkday The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
18512
|
+
*/
|
|
18513
|
+
getGamificationInsightsUserTrends(userId, filterType, filterId, granularity, comparativePeriodStartWorkday, comparativePeriodEndWorkday, primaryPeriodStartWorkday, primaryPeriodEndWorkday) {
|
|
18514
|
+
// verify the required parameter 'userId' is set
|
|
18515
|
+
if (userId === undefined || userId === null) {
|
|
18516
|
+
throw 'Missing the required parameter "userId" when calling getGamificationInsightsUserTrends';
|
|
18517
|
+
}
|
|
18518
|
+
// verify the required parameter 'filterType' is set
|
|
18519
|
+
if (filterType === undefined || filterType === null) {
|
|
18520
|
+
throw 'Missing the required parameter "filterType" when calling getGamificationInsightsUserTrends';
|
|
18521
|
+
}
|
|
18522
|
+
// verify the required parameter 'filterId' is set
|
|
18523
|
+
if (filterId === undefined || filterId === null) {
|
|
18524
|
+
throw 'Missing the required parameter "filterId" when calling getGamificationInsightsUserTrends';
|
|
18525
|
+
}
|
|
18526
|
+
// verify the required parameter 'granularity' is set
|
|
18527
|
+
if (granularity === undefined || granularity === null) {
|
|
18528
|
+
throw 'Missing the required parameter "granularity" when calling getGamificationInsightsUserTrends';
|
|
18529
|
+
}
|
|
18530
|
+
// verify the required parameter 'comparativePeriodStartWorkday' is set
|
|
18531
|
+
if (comparativePeriodStartWorkday === undefined || comparativePeriodStartWorkday === null) {
|
|
18532
|
+
throw 'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsUserTrends';
|
|
18533
|
+
}
|
|
18534
|
+
// verify the required parameter 'comparativePeriodEndWorkday' is set
|
|
18535
|
+
if (comparativePeriodEndWorkday === undefined || comparativePeriodEndWorkday === null) {
|
|
18536
|
+
throw 'Missing the required parameter "comparativePeriodEndWorkday" when calling getGamificationInsightsUserTrends';
|
|
18537
|
+
}
|
|
18538
|
+
// verify the required parameter 'primaryPeriodStartWorkday' is set
|
|
18539
|
+
if (primaryPeriodStartWorkday === undefined || primaryPeriodStartWorkday === null) {
|
|
18540
|
+
throw 'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsUserTrends';
|
|
18541
|
+
}
|
|
18542
|
+
// verify the required parameter 'primaryPeriodEndWorkday' is set
|
|
18543
|
+
if (primaryPeriodEndWorkday === undefined || primaryPeriodEndWorkday === null) {
|
|
18544
|
+
throw 'Missing the required parameter "primaryPeriodEndWorkday" when calling getGamificationInsightsUserTrends';
|
|
18545
|
+
}
|
|
18546
|
+
|
|
18547
|
+
return this.apiClient.callApi(
|
|
18548
|
+
'/api/v2/gamification/insights/users/{userId}/trends',
|
|
18549
|
+
'GET',
|
|
18550
|
+
{ 'userId': userId },
|
|
18551
|
+
{ 'filterType': filterType,'filterId': filterId,'granularity': granularity,'comparativePeriodStartWorkday': comparativePeriodStartWorkday,'comparativePeriodEndWorkday': comparativePeriodEndWorkday,'primaryPeriodStartWorkday': primaryPeriodStartWorkday,'primaryPeriodEndWorkday': primaryPeriodEndWorkday },
|
|
18552
|
+
{ },
|
|
18553
|
+
{ },
|
|
18554
|
+
null,
|
|
18555
|
+
['PureCloud OAuth'],
|
|
18556
|
+
['application/json'],
|
|
18557
|
+
['application/json']
|
|
18558
|
+
);
|
|
18559
|
+
}
|
|
18560
|
+
|
|
18046
18561
|
/**
|
|
18047
18562
|
* Leaderboard of the requesting user's division or performance profile
|
|
18048
18563
|
*
|
|
@@ -19475,6 +19990,61 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19475
19990
|
);
|
|
19476
19991
|
}
|
|
19477
19992
|
|
|
19993
|
+
/**
|
|
19994
|
+
* Query performance profiles in date range for a user
|
|
19995
|
+
*
|
|
19996
|
+
* @param {String} userId The ID of a user.
|
|
19997
|
+
* @param {Object} body The date range of work day.
|
|
19998
|
+
*/
|
|
19999
|
+
postGamificationProfilesUserQuery(userId, body) {
|
|
20000
|
+
// verify the required parameter 'userId' is set
|
|
20001
|
+
if (userId === undefined || userId === null) {
|
|
20002
|
+
throw 'Missing the required parameter "userId" when calling postGamificationProfilesUserQuery';
|
|
20003
|
+
}
|
|
20004
|
+
// verify the required parameter 'body' is set
|
|
20005
|
+
if (body === undefined || body === null) {
|
|
20006
|
+
throw 'Missing the required parameter "body" when calling postGamificationProfilesUserQuery';
|
|
20007
|
+
}
|
|
20008
|
+
|
|
20009
|
+
return this.apiClient.callApi(
|
|
20010
|
+
'/api/v2/gamification/profiles/users/{userId}/query',
|
|
20011
|
+
'POST',
|
|
20012
|
+
{ 'userId': userId },
|
|
20013
|
+
{ },
|
|
20014
|
+
{ },
|
|
20015
|
+
{ },
|
|
20016
|
+
body,
|
|
20017
|
+
['PureCloud OAuth'],
|
|
20018
|
+
['application/json'],
|
|
20019
|
+
['application/json']
|
|
20020
|
+
);
|
|
20021
|
+
}
|
|
20022
|
+
|
|
20023
|
+
/**
|
|
20024
|
+
* Query performance profiles in date range for the current user
|
|
20025
|
+
*
|
|
20026
|
+
* @param {Object} body The date range of work day.
|
|
20027
|
+
*/
|
|
20028
|
+
postGamificationProfilesUsersMeQuery(body) {
|
|
20029
|
+
// verify the required parameter 'body' is set
|
|
20030
|
+
if (body === undefined || body === null) {
|
|
20031
|
+
throw 'Missing the required parameter "body" when calling postGamificationProfilesUsersMeQuery';
|
|
20032
|
+
}
|
|
20033
|
+
|
|
20034
|
+
return this.apiClient.callApi(
|
|
20035
|
+
'/api/v2/gamification/profiles/users/me/query',
|
|
20036
|
+
'POST',
|
|
20037
|
+
{ },
|
|
20038
|
+
{ },
|
|
20039
|
+
{ },
|
|
20040
|
+
{ },
|
|
20041
|
+
body,
|
|
20042
|
+
['PureCloud OAuth'],
|
|
20043
|
+
['application/json'],
|
|
20044
|
+
['application/json']
|
|
20045
|
+
);
|
|
20046
|
+
}
|
|
20047
|
+
|
|
19478
20048
|
/**
|
|
19479
20049
|
* Updates a performance profile
|
|
19480
20050
|
*
|
|
@@ -19570,7 +20140,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19570
20140
|
/**
|
|
19571
20141
|
* GeneralDataProtectionRegulation service.
|
|
19572
20142
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
19573
|
-
* @version
|
|
20143
|
+
* @version 168.0.0
|
|
19574
20144
|
*/
|
|
19575
20145
|
|
|
19576
20146
|
/**
|
|
@@ -19700,7 +20270,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19700
20270
|
/**
|
|
19701
20271
|
* Geolocation service.
|
|
19702
20272
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
19703
|
-
* @version
|
|
20273
|
+
* @version 168.0.0
|
|
19704
20274
|
*/
|
|
19705
20275
|
|
|
19706
20276
|
/**
|
|
@@ -19831,7 +20401,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19831
20401
|
/**
|
|
19832
20402
|
* Greetings service.
|
|
19833
20403
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
19834
|
-
* @version
|
|
20404
|
+
* @version 168.0.0
|
|
19835
20405
|
*/
|
|
19836
20406
|
|
|
19837
20407
|
/**
|
|
@@ -20286,7 +20856,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20286
20856
|
/**
|
|
20287
20857
|
* Groups service.
|
|
20288
20858
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
20289
|
-
* @version
|
|
20859
|
+
* @version 168.0.0
|
|
20290
20860
|
*/
|
|
20291
20861
|
|
|
20292
20862
|
/**
|
|
@@ -20692,7 +21262,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20692
21262
|
/**
|
|
20693
21263
|
* IdentityProvider service.
|
|
20694
21264
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
20695
|
-
* @version
|
|
21265
|
+
* @version 168.0.0
|
|
20696
21266
|
*/
|
|
20697
21267
|
|
|
20698
21268
|
/**
|
|
@@ -21448,7 +22018,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21448
22018
|
/**
|
|
21449
22019
|
* InfrastructureAsCode service.
|
|
21450
22020
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
21451
|
-
* @version
|
|
22021
|
+
* @version 168.0.0
|
|
21452
22022
|
*/
|
|
21453
22023
|
|
|
21454
22024
|
/**
|
|
@@ -21463,6 +22033,68 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21463
22033
|
}
|
|
21464
22034
|
|
|
21465
22035
|
|
|
22036
|
+
/**
|
|
22037
|
+
* Get information about an accelerator
|
|
22038
|
+
* Get the complete metadata specification for an accelerator, including requirements and parameters.
|
|
22039
|
+
* @param {String} acceleratorId Accelerator ID
|
|
22040
|
+
* @param {Object} opts Optional parameters
|
|
22041
|
+
* @param {Object} opts.preferredLanguage Preferred Language (default to en-US)
|
|
22042
|
+
*/
|
|
22043
|
+
getInfrastructureascodeAccelerator(acceleratorId, opts) {
|
|
22044
|
+
opts = opts || {};
|
|
22045
|
+
|
|
22046
|
+
// verify the required parameter 'acceleratorId' is set
|
|
22047
|
+
if (acceleratorId === undefined || acceleratorId === null) {
|
|
22048
|
+
throw 'Missing the required parameter "acceleratorId" when calling getInfrastructureascodeAccelerator';
|
|
22049
|
+
}
|
|
22050
|
+
|
|
22051
|
+
return this.apiClient.callApi(
|
|
22052
|
+
'/api/v2/infrastructureascode/accelerators/{acceleratorId}',
|
|
22053
|
+
'GET',
|
|
22054
|
+
{ 'acceleratorId': acceleratorId },
|
|
22055
|
+
{ 'preferredLanguage': opts['preferredLanguage'] },
|
|
22056
|
+
{ },
|
|
22057
|
+
{ },
|
|
22058
|
+
null,
|
|
22059
|
+
['PureCloud OAuth'],
|
|
22060
|
+
['application/json'],
|
|
22061
|
+
['application/json']
|
|
22062
|
+
);
|
|
22063
|
+
}
|
|
22064
|
+
|
|
22065
|
+
/**
|
|
22066
|
+
* Get a list of available accelerators
|
|
22067
|
+
* Search for accelerators that can be run.
|
|
22068
|
+
* @param {Object} opts Optional parameters
|
|
22069
|
+
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
22070
|
+
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
22071
|
+
* @param {String} opts.sortBy variable name requested to sort by
|
|
22072
|
+
* @param {Object} opts.sortOrder Sort order (default to asc)
|
|
22073
|
+
* @param {String} opts.name Filter by name
|
|
22074
|
+
* @param {String} opts.description Filter by description
|
|
22075
|
+
* @param {Object} opts.origin Filter by origin
|
|
22076
|
+
* @param {Object} opts.type Filter by type
|
|
22077
|
+
* @param {String} opts.classification Filter by classification
|
|
22078
|
+
* @param {String} opts.tags Filter by tags
|
|
22079
|
+
*/
|
|
22080
|
+
getInfrastructureascodeAccelerators(opts) {
|
|
22081
|
+
opts = opts || {};
|
|
22082
|
+
|
|
22083
|
+
|
|
22084
|
+
return this.apiClient.callApi(
|
|
22085
|
+
'/api/v2/infrastructureascode/accelerators',
|
|
22086
|
+
'GET',
|
|
22087
|
+
{ },
|
|
22088
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'description': opts['description'],'origin': opts['origin'],'type': opts['type'],'classification': opts['classification'],'tags': opts['tags'] },
|
|
22089
|
+
{ },
|
|
22090
|
+
{ },
|
|
22091
|
+
null,
|
|
22092
|
+
['PureCloud OAuth'],
|
|
22093
|
+
['application/json'],
|
|
22094
|
+
['application/json']
|
|
22095
|
+
);
|
|
22096
|
+
}
|
|
22097
|
+
|
|
21466
22098
|
/**
|
|
21467
22099
|
* Get job status and results
|
|
21468
22100
|
* Get the execution status of a submitted job, optionally including results and error details.
|
|
@@ -21498,8 +22130,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21498
22130
|
* @param {Object} opts Optional parameters
|
|
21499
22131
|
* @param {Number} opts.maxResults Number of jobs to show (default to 1)
|
|
21500
22132
|
* @param {Boolean} opts.includeErrors Include error messages (default to false)
|
|
21501
|
-
* @param {Object} opts.sortBy Sort by (default to
|
|
21502
|
-
* @param {Object} opts.sortOrder Sort order (default to
|
|
22133
|
+
* @param {Object} opts.sortBy Sort by (default to dateSubmitted)
|
|
22134
|
+
* @param {Object} opts.sortOrder Sort order (default to desc)
|
|
22135
|
+
* @param {String} opts.acceleratorId Find only jobs associated with this accelerator
|
|
22136
|
+
* @param {String} opts.submittedBy Find only jobs submitted by this user
|
|
22137
|
+
* @param {Object} opts.status Find only jobs in this state
|
|
21503
22138
|
*/
|
|
21504
22139
|
getInfrastructureascodeJobs(opts) {
|
|
21505
22140
|
opts = opts || {};
|
|
@@ -21509,7 +22144,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21509
22144
|
'/api/v2/infrastructureascode/jobs',
|
|
21510
22145
|
'GET',
|
|
21511
22146
|
{ },
|
|
21512
|
-
{ 'maxResults': opts['maxResults'],'includeErrors': opts['includeErrors'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'] },
|
|
22147
|
+
{ 'maxResults': opts['maxResults'],'includeErrors': opts['includeErrors'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'acceleratorId': opts['acceleratorId'],'submittedBy': opts['submittedBy'],'status': opts['status'] },
|
|
21513
22148
|
{ },
|
|
21514
22149
|
{ },
|
|
21515
22150
|
null,
|
|
@@ -21550,7 +22185,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21550
22185
|
/**
|
|
21551
22186
|
* Integrations service.
|
|
21552
22187
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
21553
|
-
* @version
|
|
22188
|
+
* @version 168.0.0
|
|
21554
22189
|
*/
|
|
21555
22190
|
|
|
21556
22191
|
/**
|
|
@@ -23150,7 +23785,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23150
23785
|
/**
|
|
23151
23786
|
* Journey service.
|
|
23152
23787
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
23153
|
-
* @version
|
|
23788
|
+
* @version 168.0.0
|
|
23154
23789
|
*/
|
|
23155
23790
|
|
|
23156
23791
|
/**
|
|
@@ -24030,7 +24665,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24030
24665
|
/**
|
|
24031
24666
|
* Knowledge service.
|
|
24032
24667
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
24033
|
-
* @version
|
|
24668
|
+
* @version 168.0.0
|
|
24034
24669
|
*/
|
|
24035
24670
|
|
|
24036
24671
|
/**
|
|
@@ -26462,7 +27097,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26462
27097
|
/**
|
|
26463
27098
|
* LanguageUnderstanding service.
|
|
26464
27099
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
26465
|
-
* @version
|
|
27100
|
+
* @version 168.0.0
|
|
26466
27101
|
*/
|
|
26467
27102
|
|
|
26468
27103
|
/**
|
|
@@ -27475,7 +28110,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27475
28110
|
/**
|
|
27476
28111
|
* Languages service.
|
|
27477
28112
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
27478
|
-
* @version
|
|
28113
|
+
* @version 168.0.0
|
|
27479
28114
|
*/
|
|
27480
28115
|
|
|
27481
28116
|
/**
|
|
@@ -27693,7 +28328,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27693
28328
|
/**
|
|
27694
28329
|
* Learning service.
|
|
27695
28330
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
27696
|
-
* @version
|
|
28331
|
+
* @version 168.0.0
|
|
27697
28332
|
*/
|
|
27698
28333
|
|
|
27699
28334
|
/**
|
|
@@ -28508,7 +29143,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28508
29143
|
/**
|
|
28509
29144
|
* License service.
|
|
28510
29145
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
28511
|
-
* @version
|
|
29146
|
+
* @version 168.0.0
|
|
28512
29147
|
*/
|
|
28513
29148
|
|
|
28514
29149
|
/**
|
|
@@ -28746,7 +29381,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28746
29381
|
/**
|
|
28747
29382
|
* Locations service.
|
|
28748
29383
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
28749
|
-
* @version
|
|
29384
|
+
* @version 168.0.0
|
|
28750
29385
|
*/
|
|
28751
29386
|
|
|
28752
29387
|
/**
|
|
@@ -28982,7 +29617,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28982
29617
|
/**
|
|
28983
29618
|
* Messaging service.
|
|
28984
29619
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
28985
|
-
* @version
|
|
29620
|
+
* @version 168.0.0
|
|
28986
29621
|
*/
|
|
28987
29622
|
|
|
28988
29623
|
/**
|
|
@@ -29133,7 +29768,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29133
29768
|
/**
|
|
29134
29769
|
* MobileDevices service.
|
|
29135
29770
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
29136
|
-
* @version
|
|
29771
|
+
* @version 168.0.0
|
|
29137
29772
|
*/
|
|
29138
29773
|
|
|
29139
29774
|
/**
|
|
@@ -29284,7 +29919,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29284
29919
|
/**
|
|
29285
29920
|
* Notifications service.
|
|
29286
29921
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
29287
|
-
* @version
|
|
29922
|
+
* @version 168.0.0
|
|
29288
29923
|
*/
|
|
29289
29924
|
|
|
29290
29925
|
/**
|
|
@@ -29517,7 +30152,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29517
30152
|
/**
|
|
29518
30153
|
* OAuth service.
|
|
29519
30154
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
29520
|
-
* @version
|
|
30155
|
+
* @version 168.0.0
|
|
29521
30156
|
*/
|
|
29522
30157
|
|
|
29523
30158
|
/**
|
|
@@ -29883,7 +30518,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29883
30518
|
/**
|
|
29884
30519
|
* Objects service.
|
|
29885
30520
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
29886
|
-
* @version
|
|
30521
|
+
* @version 168.0.0
|
|
29887
30522
|
*/
|
|
29888
30523
|
|
|
29889
30524
|
/**
|
|
@@ -30154,7 +30789,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30154
30789
|
/**
|
|
30155
30790
|
* Organization service.
|
|
30156
30791
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
30157
|
-
* @version
|
|
30792
|
+
* @version 168.0.0
|
|
30158
30793
|
*/
|
|
30159
30794
|
|
|
30160
30795
|
/**
|
|
@@ -30557,7 +31192,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30557
31192
|
/**
|
|
30558
31193
|
* OrganizationAuthorization service.
|
|
30559
31194
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
30560
|
-
* @version
|
|
31195
|
+
* @version 168.0.0
|
|
30561
31196
|
*/
|
|
30562
31197
|
|
|
30563
31198
|
/**
|
|
@@ -31852,7 +32487,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31852
32487
|
/**
|
|
31853
32488
|
* Outbound service.
|
|
31854
32489
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
31855
|
-
* @version
|
|
32490
|
+
* @version 168.0.0
|
|
31856
32491
|
*/
|
|
31857
32492
|
|
|
31858
32493
|
/**
|
|
@@ -33616,6 +34251,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33616
34251
|
);
|
|
33617
34252
|
}
|
|
33618
34253
|
|
|
34254
|
+
/**
|
|
34255
|
+
* Get messaging campaign diagnostics
|
|
34256
|
+
*
|
|
34257
|
+
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
34258
|
+
*/
|
|
34259
|
+
getOutboundMessagingcampaignDiagnostics(messagingCampaignId) {
|
|
34260
|
+
// verify the required parameter 'messagingCampaignId' is set
|
|
34261
|
+
if (messagingCampaignId === undefined || messagingCampaignId === null) {
|
|
34262
|
+
throw 'Missing the required parameter "messagingCampaignId" when calling getOutboundMessagingcampaignDiagnostics';
|
|
34263
|
+
}
|
|
34264
|
+
|
|
34265
|
+
return this.apiClient.callApi(
|
|
34266
|
+
'/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/diagnostics',
|
|
34267
|
+
'GET',
|
|
34268
|
+
{ 'messagingCampaignId': messagingCampaignId },
|
|
34269
|
+
{ },
|
|
34270
|
+
{ },
|
|
34271
|
+
{ },
|
|
34272
|
+
null,
|
|
34273
|
+
['PureCloud OAuth'],
|
|
34274
|
+
['application/json'],
|
|
34275
|
+
['application/json']
|
|
34276
|
+
);
|
|
34277
|
+
}
|
|
34278
|
+
|
|
33619
34279
|
/**
|
|
33620
34280
|
* Get messaging campaign's progress
|
|
33621
34281
|
*
|
|
@@ -35448,7 +36108,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35448
36108
|
/**
|
|
35449
36109
|
* Presence service.
|
|
35450
36110
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
35451
|
-
* @version
|
|
36111
|
+
* @version 168.0.0
|
|
35452
36112
|
*/
|
|
35453
36113
|
|
|
35454
36114
|
/**
|
|
@@ -35999,7 +36659,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35999
36659
|
/**
|
|
36000
36660
|
* ProcessAutomation service.
|
|
36001
36661
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
36002
|
-
* @version
|
|
36662
|
+
* @version 168.0.0
|
|
36003
36663
|
*/
|
|
36004
36664
|
|
|
36005
36665
|
/**
|
|
@@ -36238,7 +36898,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36238
36898
|
/**
|
|
36239
36899
|
* Quality service.
|
|
36240
36900
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
36241
|
-
* @version
|
|
36901
|
+
* @version 168.0.0
|
|
36242
36902
|
*/
|
|
36243
36903
|
|
|
36244
36904
|
/**
|
|
@@ -37659,7 +38319,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37659
38319
|
* @param {String} evaluationId evaluationId
|
|
37660
38320
|
* @param {Object} body evaluation
|
|
37661
38321
|
* @param {Object} opts Optional parameters
|
|
37662
|
-
* @param {String} opts.expand evaluatorId, evaluationForm
|
|
38322
|
+
* @param {String} opts.expand evaluatorId, evaluationForm, assignee
|
|
37663
38323
|
*/
|
|
37664
38324
|
putQualityConversationEvaluation(conversationId, evaluationId, body, opts) {
|
|
37665
38325
|
opts = opts || {};
|
|
@@ -37817,7 +38477,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37817
38477
|
/**
|
|
37818
38478
|
* Recording service.
|
|
37819
38479
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
37820
|
-
* @version
|
|
38480
|
+
* @version 168.0.0
|
|
37821
38481
|
*/
|
|
37822
38482
|
|
|
37823
38483
|
/**
|
|
@@ -38124,7 +38784,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38124
38784
|
}
|
|
38125
38785
|
|
|
38126
38786
|
/**
|
|
38127
|
-
* Get recording metadata for a conversation. Does not return playable media. Annotations won't be included in the response if recording:recording:view permission is missing.
|
|
38787
|
+
* Get recording metadata for a conversation. Does not return playable media. Annotations won't be included in the response if either recording:recording:view or recording:annotation:view permission is missing.
|
|
38128
38788
|
*
|
|
38129
38789
|
* @param {String} conversationId Conversation ID
|
|
38130
38790
|
*/
|
|
@@ -39454,7 +40114,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39454
40114
|
/**
|
|
39455
40115
|
* ResponseManagement service.
|
|
39456
40116
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
39457
|
-
* @version
|
|
40117
|
+
* @version 168.0.0
|
|
39458
40118
|
*/
|
|
39459
40119
|
|
|
39460
40120
|
/**
|
|
@@ -39551,6 +40211,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39551
40211
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
39552
40212
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
39553
40213
|
* @param {Object} opts.messagingTemplateFilter Returns a list of libraries that contain responses with at least one messaging template defined for a specific message channel
|
|
40214
|
+
* @param {String} opts.libraryPrefix Returns a list of libraries that contain the prefix provided
|
|
39554
40215
|
*/
|
|
39555
40216
|
getResponsemanagementLibraries(opts) {
|
|
39556
40217
|
opts = opts || {};
|
|
@@ -39560,7 +40221,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39560
40221
|
'/api/v2/responsemanagement/libraries',
|
|
39561
40222
|
'GET',
|
|
39562
40223
|
{ },
|
|
39563
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'messagingTemplateFilter': opts['messagingTemplateFilter'] },
|
|
40224
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'messagingTemplateFilter': opts['messagingTemplateFilter'],'libraryPrefix': opts['libraryPrefix'] },
|
|
39564
40225
|
{ },
|
|
39565
40226
|
{ },
|
|
39566
40227
|
null,
|
|
@@ -39938,7 +40599,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39938
40599
|
/**
|
|
39939
40600
|
* Routing service.
|
|
39940
40601
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
39941
|
-
* @version
|
|
40602
|
+
* @version 168.0.0
|
|
39942
40603
|
*/
|
|
39943
40604
|
|
|
39944
40605
|
/**
|
|
@@ -41048,6 +41709,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41048
41709
|
*
|
|
41049
41710
|
* @param {Object} opts Optional parameters
|
|
41050
41711
|
* @param {Object} opts.kpiGroup The Group of Key Performance Indicators to return
|
|
41712
|
+
* @param {Array.<String>} opts.expand Parameter to request additional data to return in KPI payload
|
|
41051
41713
|
*/
|
|
41052
41714
|
getRoutingPredictorsKeyperformanceindicators(opts) {
|
|
41053
41715
|
opts = opts || {};
|
|
@@ -41057,7 +41719,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41057
41719
|
'/api/v2/routing/predictors/keyperformanceindicators',
|
|
41058
41720
|
'GET',
|
|
41059
41721
|
{ },
|
|
41060
|
-
{ 'kpiGroup': opts['kpiGroup'] },
|
|
41722
|
+
{ 'kpiGroup': opts['kpiGroup'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
41061
41723
|
{ },
|
|
41062
41724
|
{ },
|
|
41063
41725
|
null,
|
|
@@ -43446,7 +44108,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43446
44108
|
/**
|
|
43447
44109
|
* SCIM service.
|
|
43448
44110
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
43449
|
-
* @version
|
|
44111
|
+
* @version 168.0.0
|
|
43450
44112
|
*/
|
|
43451
44113
|
|
|
43452
44114
|
/**
|
|
@@ -44323,7 +44985,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44323
44985
|
/**
|
|
44324
44986
|
* Scripts service.
|
|
44325
44987
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
44326
|
-
* @version
|
|
44988
|
+
* @version 168.0.0
|
|
44327
44989
|
*/
|
|
44328
44990
|
|
|
44329
44991
|
/**
|
|
@@ -44742,7 +45404,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44742
45404
|
/**
|
|
44743
45405
|
* Search service.
|
|
44744
45406
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
44745
|
-
* @version
|
|
45407
|
+
* @version 168.0.0
|
|
44746
45408
|
*/
|
|
44747
45409
|
|
|
44748
45410
|
/**
|
|
@@ -45352,7 +46014,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45352
46014
|
/**
|
|
45353
46015
|
* SpeechTextAnalytics service.
|
|
45354
46016
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
45355
|
-
* @version
|
|
46017
|
+
* @version 168.0.0
|
|
45356
46018
|
*/
|
|
45357
46019
|
|
|
45358
46020
|
/**
|
|
@@ -46281,7 +46943,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46281
46943
|
/**
|
|
46282
46944
|
* Stations service.
|
|
46283
46945
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
46284
|
-
* @version
|
|
46946
|
+
* @version 168.0.0
|
|
46285
46947
|
*/
|
|
46286
46948
|
|
|
46287
46949
|
/**
|
|
@@ -46377,58 +47039,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46377
47039
|
);
|
|
46378
47040
|
}
|
|
46379
47041
|
|
|
46380
|
-
/**
|
|
46381
|
-
* Get an organization's StationSettings
|
|
46382
|
-
* This route is deprecated as the FreeSeatingConfiguration feature it references has been removed
|
|
46383
|
-
*/
|
|
46384
|
-
getStationsSettings() {
|
|
46385
|
-
|
|
46386
|
-
return this.apiClient.callApi(
|
|
46387
|
-
'/api/v2/stations/settings',
|
|
46388
|
-
'GET',
|
|
46389
|
-
{ },
|
|
46390
|
-
{ },
|
|
46391
|
-
{ },
|
|
46392
|
-
{ },
|
|
46393
|
-
null,
|
|
46394
|
-
['PureCloud OAuth'],
|
|
46395
|
-
['application/json'],
|
|
46396
|
-
['application/json']
|
|
46397
|
-
);
|
|
46398
|
-
}
|
|
46399
|
-
|
|
46400
|
-
/**
|
|
46401
|
-
* Patch an organization's StationSettings
|
|
46402
|
-
* This route is deprecated as the FreeSeatingConfiguration feature it references has been removed
|
|
46403
|
-
* @param {Object} body Station settings
|
|
46404
|
-
*/
|
|
46405
|
-
patchStationsSettings(body) {
|
|
46406
|
-
// verify the required parameter 'body' is set
|
|
46407
|
-
if (body === undefined || body === null) {
|
|
46408
|
-
throw 'Missing the required parameter "body" when calling patchStationsSettings';
|
|
46409
|
-
}
|
|
46410
|
-
|
|
46411
|
-
return this.apiClient.callApi(
|
|
46412
|
-
'/api/v2/stations/settings',
|
|
46413
|
-
'PATCH',
|
|
46414
|
-
{ },
|
|
46415
|
-
{ },
|
|
46416
|
-
{ },
|
|
46417
|
-
{ },
|
|
46418
|
-
body,
|
|
46419
|
-
['PureCloud OAuth'],
|
|
46420
|
-
['application/json'],
|
|
46421
|
-
['application/json']
|
|
46422
|
-
);
|
|
46423
|
-
}
|
|
46424
|
-
|
|
46425
47042
|
}
|
|
46426
47043
|
|
|
46427
47044
|
class SuggestApi {
|
|
46428
47045
|
/**
|
|
46429
47046
|
* Suggest service.
|
|
46430
47047
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
46431
|
-
* @version
|
|
47048
|
+
* @version 168.0.0
|
|
46432
47049
|
*/
|
|
46433
47050
|
|
|
46434
47051
|
/**
|
|
@@ -46567,7 +47184,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46567
47184
|
/**
|
|
46568
47185
|
* Teams service.
|
|
46569
47186
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
46570
|
-
* @version
|
|
47187
|
+
* @version 168.0.0
|
|
46571
47188
|
*/
|
|
46572
47189
|
|
|
46573
47190
|
/**
|
|
@@ -46838,7 +47455,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46838
47455
|
/**
|
|
46839
47456
|
* Telephony service.
|
|
46840
47457
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
46841
|
-
* @version
|
|
47458
|
+
* @version 168.0.0
|
|
46842
47459
|
*/
|
|
46843
47460
|
|
|
46844
47461
|
/**
|
|
@@ -46966,7 +47583,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46966
47583
|
/**
|
|
46967
47584
|
* TelephonyProvidersEdge service.
|
|
46968
47585
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
46969
|
-
* @version
|
|
47586
|
+
* @version 168.0.0
|
|
46970
47587
|
*/
|
|
46971
47588
|
|
|
46972
47589
|
/**
|
|
@@ -47161,31 +47778,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47161
47778
|
);
|
|
47162
47779
|
}
|
|
47163
47780
|
|
|
47164
|
-
/**
|
|
47165
|
-
* Delete Outbound Route
|
|
47166
|
-
* This route is deprecated, use /telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId} instead.
|
|
47167
|
-
* @param {String} outboundRouteId Outbound route ID
|
|
47168
|
-
*/
|
|
47169
|
-
deleteTelephonyProvidersEdgesOutboundroute(outboundRouteId) {
|
|
47170
|
-
// verify the required parameter 'outboundRouteId' is set
|
|
47171
|
-
if (outboundRouteId === undefined || outboundRouteId === null) {
|
|
47172
|
-
throw 'Missing the required parameter "outboundRouteId" when calling deleteTelephonyProvidersEdgesOutboundroute';
|
|
47173
|
-
}
|
|
47174
|
-
|
|
47175
|
-
return this.apiClient.callApi(
|
|
47176
|
-
'/api/v2/telephony/providers/edges/outboundroutes/{outboundRouteId}',
|
|
47177
|
-
'DELETE',
|
|
47178
|
-
{ 'outboundRouteId': outboundRouteId },
|
|
47179
|
-
{ },
|
|
47180
|
-
{ },
|
|
47181
|
-
{ },
|
|
47182
|
-
null,
|
|
47183
|
-
['PureCloud OAuth'],
|
|
47184
|
-
['application/json'],
|
|
47185
|
-
['application/json']
|
|
47186
|
-
);
|
|
47187
|
-
}
|
|
47188
|
-
|
|
47189
47781
|
/**
|
|
47190
47782
|
* Delete a Phone by ID
|
|
47191
47783
|
*
|
|
@@ -49600,31 +50192,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49600
50192
|
);
|
|
49601
50193
|
}
|
|
49602
50194
|
|
|
49603
|
-
/**
|
|
49604
|
-
* Create outbound rule
|
|
49605
|
-
* This route is deprecated, use /telephony/providers/edges/sites/{siteId}/outboundroutes instead.
|
|
49606
|
-
* @param {Object} body OutboundRoute
|
|
49607
|
-
*/
|
|
49608
|
-
postTelephonyProvidersEdgesOutboundroutes(body) {
|
|
49609
|
-
// verify the required parameter 'body' is set
|
|
49610
|
-
if (body === undefined || body === null) {
|
|
49611
|
-
throw 'Missing the required parameter "body" when calling postTelephonyProvidersEdgesOutboundroutes';
|
|
49612
|
-
}
|
|
49613
|
-
|
|
49614
|
-
return this.apiClient.callApi(
|
|
49615
|
-
'/api/v2/telephony/providers/edges/outboundroutes',
|
|
49616
|
-
'POST',
|
|
49617
|
-
{ },
|
|
49618
|
-
{ },
|
|
49619
|
-
{ },
|
|
49620
|
-
{ },
|
|
49621
|
-
body,
|
|
49622
|
-
['PureCloud OAuth'],
|
|
49623
|
-
['application/json'],
|
|
49624
|
-
['application/json']
|
|
49625
|
-
);
|
|
49626
|
-
}
|
|
49627
|
-
|
|
49628
50195
|
/**
|
|
49629
50196
|
* Reboot a Phone
|
|
49630
50197
|
*
|
|
@@ -50025,36 +50592,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50025
50592
|
);
|
|
50026
50593
|
}
|
|
50027
50594
|
|
|
50028
|
-
/**
|
|
50029
|
-
* Update outbound route
|
|
50030
|
-
* This route is deprecated, use /telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId} instead.
|
|
50031
|
-
* @param {String} outboundRouteId Outbound route ID
|
|
50032
|
-
* @param {Object} body OutboundRoute
|
|
50033
|
-
*/
|
|
50034
|
-
putTelephonyProvidersEdgesOutboundroute(outboundRouteId, body) {
|
|
50035
|
-
// verify the required parameter 'outboundRouteId' is set
|
|
50036
|
-
if (outboundRouteId === undefined || outboundRouteId === null) {
|
|
50037
|
-
throw 'Missing the required parameter "outboundRouteId" when calling putTelephonyProvidersEdgesOutboundroute';
|
|
50038
|
-
}
|
|
50039
|
-
// verify the required parameter 'body' is set
|
|
50040
|
-
if (body === undefined || body === null) {
|
|
50041
|
-
throw 'Missing the required parameter "body" when calling putTelephonyProvidersEdgesOutboundroute';
|
|
50042
|
-
}
|
|
50043
|
-
|
|
50044
|
-
return this.apiClient.callApi(
|
|
50045
|
-
'/api/v2/telephony/providers/edges/outboundroutes/{outboundRouteId}',
|
|
50046
|
-
'PUT',
|
|
50047
|
-
{ 'outboundRouteId': outboundRouteId },
|
|
50048
|
-
{ },
|
|
50049
|
-
{ },
|
|
50050
|
-
{ },
|
|
50051
|
-
body,
|
|
50052
|
-
['PureCloud OAuth'],
|
|
50053
|
-
['application/json'],
|
|
50054
|
-
['application/json']
|
|
50055
|
-
);
|
|
50056
|
-
}
|
|
50057
|
-
|
|
50058
50595
|
/**
|
|
50059
50596
|
* Update a Phone by ID
|
|
50060
50597
|
*
|
|
@@ -50246,7 +50783,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50246
50783
|
/**
|
|
50247
50784
|
* Textbots service.
|
|
50248
50785
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
50249
|
-
* @version
|
|
50786
|
+
* @version 168.0.0
|
|
50250
50787
|
*/
|
|
50251
50788
|
|
|
50252
50789
|
/**
|
|
@@ -50374,7 +50911,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50374
50911
|
/**
|
|
50375
50912
|
* Tokens service.
|
|
50376
50913
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
50377
|
-
* @version
|
|
50914
|
+
* @version 168.0.0
|
|
50378
50915
|
*/
|
|
50379
50916
|
|
|
50380
50917
|
/**
|
|
@@ -50480,7 +51017,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50480
51017
|
/**
|
|
50481
51018
|
* Uploads service.
|
|
50482
51019
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
50483
|
-
* @version
|
|
51020
|
+
* @version 168.0.0
|
|
50484
51021
|
*/
|
|
50485
51022
|
|
|
50486
51023
|
/**
|
|
@@ -50656,7 +51193,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50656
51193
|
/**
|
|
50657
51194
|
* Usage service.
|
|
50658
51195
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
50659
|
-
* @version
|
|
51196
|
+
* @version 168.0.0
|
|
50660
51197
|
*/
|
|
50661
51198
|
|
|
50662
51199
|
/**
|
|
@@ -50816,7 +51353,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50816
51353
|
/**
|
|
50817
51354
|
* UserRecordings service.
|
|
50818
51355
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
50819
|
-
* @version
|
|
51356
|
+
* @version 168.0.0
|
|
50820
51357
|
*/
|
|
50821
51358
|
|
|
50822
51359
|
/**
|
|
@@ -51001,7 +51538,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51001
51538
|
/**
|
|
51002
51539
|
* Users service.
|
|
51003
51540
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
51004
|
-
* @version
|
|
51541
|
+
* @version 168.0.0
|
|
51005
51542
|
*/
|
|
51006
51543
|
|
|
51007
51544
|
/**
|
|
@@ -53391,7 +53928,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53391
53928
|
/**
|
|
53392
53929
|
* Utilities service.
|
|
53393
53930
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
53394
|
-
* @version
|
|
53931
|
+
* @version 168.0.0
|
|
53395
53932
|
*/
|
|
53396
53933
|
|
|
53397
53934
|
/**
|
|
@@ -53502,7 +54039,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53502
54039
|
/**
|
|
53503
54040
|
* Voicemail service.
|
|
53504
54041
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
53505
|
-
* @version
|
|
54042
|
+
* @version 168.0.0
|
|
53506
54043
|
*/
|
|
53507
54044
|
|
|
53508
54045
|
/**
|
|
@@ -54169,7 +54706,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54169
54706
|
/**
|
|
54170
54707
|
* WebChat service.
|
|
54171
54708
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
54172
|
-
* @version
|
|
54709
|
+
* @version 168.0.0
|
|
54173
54710
|
*/
|
|
54174
54711
|
|
|
54175
54712
|
/**
|
|
@@ -54713,7 +55250,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54713
55250
|
/**
|
|
54714
55251
|
* WebDeployments service.
|
|
54715
55252
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
54716
|
-
* @version
|
|
55253
|
+
* @version 168.0.0
|
|
54717
55254
|
*/
|
|
54718
55255
|
|
|
54719
55256
|
/**
|
|
@@ -55235,7 +55772,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55235
55772
|
/**
|
|
55236
55773
|
* WebMessaging service.
|
|
55237
55774
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
55238
|
-
* @version
|
|
55775
|
+
* @version 168.0.0
|
|
55239
55776
|
*/
|
|
55240
55777
|
|
|
55241
55778
|
/**
|
|
@@ -55281,7 +55818,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55281
55818
|
/**
|
|
55282
55819
|
* Widgets service.
|
|
55283
55820
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
55284
|
-
* @version
|
|
55821
|
+
* @version 168.0.0
|
|
55285
55822
|
*/
|
|
55286
55823
|
|
|
55287
55824
|
/**
|
|
@@ -55427,7 +55964,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55427
55964
|
/**
|
|
55428
55965
|
* WorkforceManagement service.
|
|
55429
55966
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
55430
|
-
* @version
|
|
55967
|
+
* @version 168.0.0
|
|
55431
55968
|
*/
|
|
55432
55969
|
|
|
55433
55970
|
/**
|
|
@@ -58350,7 +58887,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58350
58887
|
}
|
|
58351
58888
|
|
|
58352
58889
|
/**
|
|
58353
|
-
*
|
|
58890
|
+
* Deprecated. Use bulk routes instead (/adherence/historical/bulk)
|
|
58354
58891
|
*
|
|
58355
58892
|
* @param {Object} opts Optional parameters
|
|
58356
58893
|
* @param {Object} opts.body body
|
|
@@ -60171,7 +60708,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60171
60708
|
* </pre>
|
|
60172
60709
|
* </p>
|
|
60173
60710
|
* @module purecloud-platform-client-v2/index
|
|
60174
|
-
* @version
|
|
60711
|
+
* @version 168.0.0
|
|
60175
60712
|
*/
|
|
60176
60713
|
class platformClient {
|
|
60177
60714
|
constructor() {
|
|
@@ -60215,6 +60752,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60215
60752
|
* @property {module:purecloud-platform-client-v2/api/BillingApi}
|
|
60216
60753
|
*/
|
|
60217
60754
|
this.BillingApi = BillingApi;
|
|
60755
|
+
/**
|
|
60756
|
+
* The CarrierServicesApi service constructor.
|
|
60757
|
+
* @property {module:purecloud-platform-client-v2/api/CarrierServicesApi}
|
|
60758
|
+
*/
|
|
60759
|
+
this.CarrierServicesApi = CarrierServicesApi;
|
|
60218
60760
|
/**
|
|
60219
60761
|
* The ChatApi service constructor.
|
|
60220
60762
|
* @property {module:purecloud-platform-client-v2/api/ChatApi}
|