purecloud-platform-client-v2 234.0.0 → 236.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 +3 -3
- package/dist/node/purecloud-platform-client-v2.js +314 -200
- package/dist/web-amd/purecloud-platform-client-v2.js +314 -200
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +193 -129
- package/dist/web-cjs/purecloud-platform-client-v2.js +193 -129
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +528 -326
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +45 -1
- package/src/purecloud-platform-client-v2/api/AIStudioApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -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 +2 -2
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BusinessRulesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +51 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +38 -8
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +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 +46 -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 +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 +51 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -107
- 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/ScreenRecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +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 +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +3 -2
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -745,7 +745,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
745
745
|
|
|
746
746
|
/**
|
|
747
747
|
* @module purecloud-platform-client-v2/ApiClient
|
|
748
|
-
* @version
|
|
748
|
+
* @version 236.0.0
|
|
749
749
|
*/
|
|
750
750
|
class ApiClient {
|
|
751
751
|
/**
|
|
@@ -948,6 +948,50 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
948
948
|
this.config.setEnvironment(environment);
|
|
949
949
|
}
|
|
950
950
|
|
|
951
|
+
/**
|
|
952
|
+
* @description Sets the optional http headers used by the client
|
|
953
|
+
* @param {object} newHeaders - default headers to be used
|
|
954
|
+
*/
|
|
955
|
+
setDefaultHeaders(newHeaders) {
|
|
956
|
+
if (!newHeaders || !(typeof newHeaders === 'object')) {
|
|
957
|
+
throw new Error("default headers must be a map");
|
|
958
|
+
}
|
|
959
|
+
this.defaultHeaders = newHeaders;
|
|
960
|
+
}
|
|
961
|
+
|
|
962
|
+
/**
|
|
963
|
+
* @description Gets the default http headers used by the client
|
|
964
|
+
*/
|
|
965
|
+
getDefaultHeaders() {
|
|
966
|
+
return this.defaultHeaders;
|
|
967
|
+
}
|
|
968
|
+
|
|
969
|
+
/**
|
|
970
|
+
* @description Sets the optional Genesys-App http header used by the client
|
|
971
|
+
* @param {string} headerValue - value for the Genesys-App header
|
|
972
|
+
*/
|
|
973
|
+
setGenesysAppHeader(headerValue) {
|
|
974
|
+
if (!headerValue || !(typeof headerValue === 'string')) throw new Error("headerValue must be a non empty string");
|
|
975
|
+
if (!this.defaultHeaders) {
|
|
976
|
+
this.defaultHeaders = {
|
|
977
|
+
"Genesys-App": headerValue
|
|
978
|
+
};
|
|
979
|
+
} else {
|
|
980
|
+
this.defaultHeaders["Genesys-App"] = headerValue;
|
|
981
|
+
}
|
|
982
|
+
}
|
|
983
|
+
|
|
984
|
+
/**
|
|
985
|
+
* @description Gets the Genesys-App http header used by the client
|
|
986
|
+
*/
|
|
987
|
+
getGenesysAppHeader() {
|
|
988
|
+
if (this.defaultHeaders && this.defaultHeaders["Genesys-App"]) {
|
|
989
|
+
return this.defaultHeaders["Genesys-App"];
|
|
990
|
+
} else {
|
|
991
|
+
return null;
|
|
992
|
+
}
|
|
993
|
+
}
|
|
994
|
+
|
|
951
995
|
/**
|
|
952
996
|
* @description Sets the dynamic HttpClient used by the client
|
|
953
997
|
* @param {object} httpClient - HttpClient to be injected
|
|
@@ -2314,7 +2358,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2314
2358
|
/**
|
|
2315
2359
|
* AIStudio service.
|
|
2316
2360
|
* @module purecloud-platform-client-v2/api/AIStudioApi
|
|
2317
|
-
* @version
|
|
2361
|
+
* @version 236.0.0
|
|
2318
2362
|
*/
|
|
2319
2363
|
|
|
2320
2364
|
/**
|
|
@@ -2886,7 +2930,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2886
2930
|
/**
|
|
2887
2931
|
* AgentAssistants service.
|
|
2888
2932
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
2889
|
-
* @version
|
|
2933
|
+
* @version 236.0.0
|
|
2890
2934
|
*/
|
|
2891
2935
|
|
|
2892
2936
|
/**
|
|
@@ -3372,7 +3416,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3372
3416
|
/**
|
|
3373
3417
|
* AgentCopilot service.
|
|
3374
3418
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
3375
|
-
* @version
|
|
3419
|
+
* @version 236.0.0
|
|
3376
3420
|
*/
|
|
3377
3421
|
|
|
3378
3422
|
/**
|
|
@@ -3472,7 +3516,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3472
3516
|
/**
|
|
3473
3517
|
* AgentUI service.
|
|
3474
3518
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
3475
|
-
* @version
|
|
3519
|
+
* @version 236.0.0
|
|
3476
3520
|
*/
|
|
3477
3521
|
|
|
3478
3522
|
/**
|
|
@@ -3603,7 +3647,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3603
3647
|
/**
|
|
3604
3648
|
* Alerting service.
|
|
3605
3649
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
3606
|
-
* @version
|
|
3650
|
+
* @version 236.0.0
|
|
3607
3651
|
*/
|
|
3608
3652
|
|
|
3609
3653
|
/**
|
|
@@ -4004,7 +4048,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4004
4048
|
/**
|
|
4005
4049
|
* Analytics service.
|
|
4006
4050
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
4007
|
-
* @version
|
|
4051
|
+
* @version 236.0.0
|
|
4008
4052
|
*/
|
|
4009
4053
|
|
|
4010
4054
|
/**
|
|
@@ -7272,7 +7316,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7272
7316
|
/**
|
|
7273
7317
|
* Architect service.
|
|
7274
7318
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
7275
|
-
* @version
|
|
7319
|
+
* @version 236.0.0
|
|
7276
7320
|
*/
|
|
7277
7321
|
|
|
7278
7322
|
/**
|
|
@@ -11567,7 +11611,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11567
11611
|
/**
|
|
11568
11612
|
* Audit service.
|
|
11569
11613
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
11570
|
-
* @version
|
|
11614
|
+
* @version 236.0.0
|
|
11571
11615
|
*/
|
|
11572
11616
|
|
|
11573
11617
|
/**
|
|
@@ -11768,7 +11812,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11768
11812
|
/**
|
|
11769
11813
|
* Authorization service.
|
|
11770
11814
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
11771
|
-
* @version
|
|
11815
|
+
* @version 236.0.0
|
|
11772
11816
|
*/
|
|
11773
11817
|
|
|
11774
11818
|
/**
|
|
@@ -12065,7 +12109,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12065
12109
|
* @param {Object} opts Optional parameters
|
|
12066
12110
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
12067
12111
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
12068
|
-
* @param {String} opts.pageSize
|
|
12112
|
+
* @param {String} opts.pageSize Page size (max 200, default 25) (default to 25)
|
|
12069
12113
|
* @param {Array.<String>} opts.id Optionally request specific divisions by their IDs
|
|
12070
12114
|
* @param {String} opts.name Optionally request specific divisions by division name
|
|
12071
12115
|
*/
|
|
@@ -13483,7 +13527,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13483
13527
|
/**
|
|
13484
13528
|
* Billing service.
|
|
13485
13529
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
13486
|
-
* @version
|
|
13530
|
+
* @version 236.0.0
|
|
13487
13531
|
*/
|
|
13488
13532
|
|
|
13489
13533
|
/**
|
|
@@ -13739,7 +13783,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13739
13783
|
/**
|
|
13740
13784
|
* BusinessRules service.
|
|
13741
13785
|
* @module purecloud-platform-client-v2/api/BusinessRulesApi
|
|
13742
|
-
* @version
|
|
13786
|
+
* @version 236.0.0
|
|
13743
13787
|
*/
|
|
13744
13788
|
|
|
13745
13789
|
/**
|
|
@@ -14626,7 +14670,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14626
14670
|
/**
|
|
14627
14671
|
* CarrierServices service.
|
|
14628
14672
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
14629
|
-
* @version
|
|
14673
|
+
* @version 236.0.0
|
|
14630
14674
|
*/
|
|
14631
14675
|
|
|
14632
14676
|
/**
|
|
@@ -14696,7 +14740,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14696
14740
|
/**
|
|
14697
14741
|
* Chat service.
|
|
14698
14742
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
14699
|
-
* @version
|
|
14743
|
+
* @version 236.0.0
|
|
14700
14744
|
*/
|
|
14701
14745
|
|
|
14702
14746
|
/**
|
|
@@ -15677,7 +15721,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15677
15721
|
/**
|
|
15678
15722
|
* Coaching service.
|
|
15679
15723
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
15680
|
-
* @version
|
|
15724
|
+
* @version 236.0.0
|
|
15681
15725
|
*/
|
|
15682
15726
|
|
|
15683
15727
|
/**
|
|
@@ -15988,6 +16032,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15988
16032
|
);
|
|
15989
16033
|
}
|
|
15990
16034
|
|
|
16035
|
+
/**
|
|
16036
|
+
* Retrieve the status of the job for the slots where a coaching appointment can be scheduled.
|
|
16037
|
+
*
|
|
16038
|
+
* @param {String} jobId The ID of job
|
|
16039
|
+
*/
|
|
16040
|
+
getCoachingScheduleslotsJob(jobId) {
|
|
16041
|
+
// verify the required parameter 'jobId' is set
|
|
16042
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
16043
|
+
throw 'Missing the required parameter "jobId" when calling getCoachingScheduleslotsJob';
|
|
16044
|
+
}
|
|
16045
|
+
|
|
16046
|
+
return this.apiClient.callApi(
|
|
16047
|
+
'/api/v2/coaching/scheduleslots/jobs/{jobId}',
|
|
16048
|
+
'GET',
|
|
16049
|
+
{ 'jobId': jobId },
|
|
16050
|
+
{ },
|
|
16051
|
+
{ },
|
|
16052
|
+
{ },
|
|
16053
|
+
null,
|
|
16054
|
+
['PureCloud OAuth'],
|
|
16055
|
+
['application/json'],
|
|
16056
|
+
['application/json']
|
|
16057
|
+
);
|
|
16058
|
+
}
|
|
16059
|
+
|
|
15991
16060
|
/**
|
|
15992
16061
|
* Update an existing appointment
|
|
15993
16062
|
* Permission not required if you are the creator or facilitator of the appointment
|
|
@@ -16223,6 +16292,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16223
16292
|
);
|
|
16224
16293
|
}
|
|
16225
16294
|
|
|
16295
|
+
/**
|
|
16296
|
+
* Start job to retrieve the slots where a coaching appointment can be scheduled.
|
|
16297
|
+
*
|
|
16298
|
+
* @param {Object} body The slots search request
|
|
16299
|
+
*/
|
|
16300
|
+
postCoachingScheduleslotsJobs(body) {
|
|
16301
|
+
// verify the required parameter 'body' is set
|
|
16302
|
+
if (body === undefined || body === null) {
|
|
16303
|
+
throw 'Missing the required parameter "body" when calling postCoachingScheduleslotsJobs';
|
|
16304
|
+
}
|
|
16305
|
+
|
|
16306
|
+
return this.apiClient.callApi(
|
|
16307
|
+
'/api/v2/coaching/scheduleslots/jobs',
|
|
16308
|
+
'POST',
|
|
16309
|
+
{ },
|
|
16310
|
+
{ },
|
|
16311
|
+
{ },
|
|
16312
|
+
{ },
|
|
16313
|
+
body,
|
|
16314
|
+
['PureCloud OAuth'],
|
|
16315
|
+
['application/json'],
|
|
16316
|
+
['application/json']
|
|
16317
|
+
);
|
|
16318
|
+
}
|
|
16319
|
+
|
|
16226
16320
|
/**
|
|
16227
16321
|
* Get list of possible slots where a coaching appointment can be scheduled.
|
|
16228
16322
|
*
|
|
@@ -16254,7 +16348,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16254
16348
|
/**
|
|
16255
16349
|
* ContentManagement service.
|
|
16256
16350
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
16257
|
-
* @version
|
|
16351
|
+
* @version 236.0.0
|
|
16258
16352
|
*/
|
|
16259
16353
|
|
|
16260
16354
|
/**
|
|
@@ -17335,7 +17429,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17335
17429
|
/**
|
|
17336
17430
|
* Conversations service.
|
|
17337
17431
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
17338
|
-
* @version
|
|
17432
|
+
* @version 236.0.0
|
|
17339
17433
|
*/
|
|
17340
17434
|
|
|
17341
17435
|
/**
|
|
@@ -18007,7 +18101,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18007
18101
|
* @param {String} conversationId conversationId
|
|
18008
18102
|
* @param {String} communicationId communicationId
|
|
18009
18103
|
* @param {String} messageId messageId
|
|
18010
|
-
* getConversationCommunicationInternalmessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18011
18104
|
*/
|
|
18012
18105
|
getConversationCommunicationInternalmessage(conversationId, communicationId, messageId) {
|
|
18013
18106
|
// verify the required parameter 'conversationId' is set
|
|
@@ -18045,7 +18138,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18045
18138
|
* @param {Object} opts Optional parameters
|
|
18046
18139
|
* @param {Number} opts.pageSize Indicates maximum number of results in response. Default page size is 25 results. The maximum page size is 200. (default to 25)
|
|
18047
18140
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
18048
|
-
* getConversationCommunicationInternalmessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18049
18141
|
*/
|
|
18050
18142
|
getConversationCommunicationInternalmessages(conversationId, communicationId, opts) {
|
|
18051
18143
|
opts = opts || {};
|
|
@@ -19307,7 +19399,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19307
19399
|
* Get internal message conversation
|
|
19308
19400
|
*
|
|
19309
19401
|
* @param {String} conversationId conversationId
|
|
19310
|
-
* getConversationsInternalmessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
19311
19402
|
*/
|
|
19312
19403
|
getConversationsInternalmessage(conversationId) {
|
|
19313
19404
|
// verify the required parameter 'conversationId' is set
|
|
@@ -19332,7 +19423,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19332
19423
|
/**
|
|
19333
19424
|
* Get active internal message conversations for the logged in user
|
|
19334
19425
|
*
|
|
19335
|
-
* getConversationsInternalmessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
19336
19426
|
*/
|
|
19337
19427
|
getConversationsInternalmessages() {
|
|
19338
19428
|
|
|
@@ -19420,6 +19510,42 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19420
19510
|
);
|
|
19421
19511
|
}
|
|
19422
19512
|
|
|
19513
|
+
/**
|
|
19514
|
+
* Get message media list by status
|
|
19515
|
+
*
|
|
19516
|
+
* @param {String} conversationId conversationId
|
|
19517
|
+
* @param {String} communicationId communicationId
|
|
19518
|
+
* @param {Object} opts Optional parameters
|
|
19519
|
+
* @param {Object} opts.status The status on which to filter the response.
|
|
19520
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
19521
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
19522
|
+
*/
|
|
19523
|
+
getConversationsMessageCommunicationMessagesMedia(conversationId, communicationId, opts) {
|
|
19524
|
+
opts = opts || {};
|
|
19525
|
+
|
|
19526
|
+
// verify the required parameter 'conversationId' is set
|
|
19527
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
19528
|
+
throw 'Missing the required parameter "conversationId" when calling getConversationsMessageCommunicationMessagesMedia';
|
|
19529
|
+
}
|
|
19530
|
+
// verify the required parameter 'communicationId' is set
|
|
19531
|
+
if (communicationId === undefined || communicationId === null || communicationId === '') {
|
|
19532
|
+
throw 'Missing the required parameter "communicationId" when calling getConversationsMessageCommunicationMessagesMedia';
|
|
19533
|
+
}
|
|
19534
|
+
|
|
19535
|
+
return this.apiClient.callApi(
|
|
19536
|
+
'/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages/media',
|
|
19537
|
+
'GET',
|
|
19538
|
+
{ 'conversationId': conversationId,'communicationId': communicationId },
|
|
19539
|
+
{ 'status': opts['status'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
19540
|
+
{ },
|
|
19541
|
+
{ },
|
|
19542
|
+
null,
|
|
19543
|
+
['PureCloud OAuth'],
|
|
19544
|
+
['application/json'],
|
|
19545
|
+
['application/json']
|
|
19546
|
+
);
|
|
19547
|
+
}
|
|
19548
|
+
|
|
19423
19549
|
/**
|
|
19424
19550
|
* Get media
|
|
19425
19551
|
* See https://developer.genesys.cloud/api/rest/v2/conversations/messaging-media-upload for example usage.
|
|
@@ -22531,7 +22657,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22531
22657
|
* @param {String} conversationId conversationId
|
|
22532
22658
|
* @param {String} communicationId communicationId
|
|
22533
22659
|
* @param {Object} body Message
|
|
22534
|
-
* postConversationCommunicationInternalmessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
22535
22660
|
*/
|
|
22536
22661
|
postConversationCommunicationInternalmessages(conversationId, communicationId, body) {
|
|
22537
22662
|
// verify the required parameter 'conversationId' is set
|
|
@@ -22660,7 +22785,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22660
22785
|
* @param {String} conversationId conversation ID
|
|
22661
22786
|
* @param {String} participantId participant ID
|
|
22662
22787
|
* @param {Object} body Confer request
|
|
22663
|
-
* postConversationParticipantInternalmessagesUsersCommunications is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
22664
22788
|
*/
|
|
22665
22789
|
postConversationParticipantInternalmessagesUsersCommunications(conversationId, participantId, body) {
|
|
22666
22790
|
// verify the required parameter 'conversationId' is set
|
|
@@ -24570,7 +24694,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24570
24694
|
|
|
24571
24695
|
/**
|
|
24572
24696
|
* Get messages in batch
|
|
24573
|
-
* The path parameter [conversationId] should contain the conversationId of the conversation being filtered. The body should contain the messageId(s) of messages being requested. For example: ["a3069a33b-bbb1-4703-9d68-061d9e9db96e", "55bc6be3-078c-4a49-a4e6-1e05776ed7e8"]
|
|
24697
|
+
* The path parameter [conversationId] should contain the conversationId of the conversation being filtered. The body should contain the messageId(s) of messages being requested. For example: ["a3069a33b-bbb1-4703-9d68-061d9e9db96e", "55bc6be3-078c-4a49-a4e6-1e05776ed7e8"]. The max messages you can request in the body is 1,000. Best practice is to limit to only the messages you need in each request, rather than request large batches by default.
|
|
24574
24698
|
* @param {String} conversationId
|
|
24575
24699
|
* @param {Object} opts Optional parameters
|
|
24576
24700
|
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media) (default to false)
|
|
@@ -25932,7 +26056,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25932
26056
|
/**
|
|
25933
26057
|
* DataExtensions service.
|
|
25934
26058
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
25935
|
-
* @version
|
|
26059
|
+
* @version 236.0.0
|
|
25936
26060
|
*/
|
|
25937
26061
|
|
|
25938
26062
|
/**
|
|
@@ -26018,7 +26142,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26018
26142
|
/**
|
|
26019
26143
|
* DataPrivacy service.
|
|
26020
26144
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
26021
|
-
* @version
|
|
26145
|
+
* @version 236.0.0
|
|
26022
26146
|
*/
|
|
26023
26147
|
|
|
26024
26148
|
/**
|
|
@@ -26188,7 +26312,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26188
26312
|
/**
|
|
26189
26313
|
* Downloads service.
|
|
26190
26314
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
26191
|
-
* @version
|
|
26315
|
+
* @version 236.0.0
|
|
26192
26316
|
*/
|
|
26193
26317
|
|
|
26194
26318
|
/**
|
|
@@ -26240,7 +26364,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26240
26364
|
/**
|
|
26241
26365
|
* Emails service.
|
|
26242
26366
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
26243
|
-
* @version
|
|
26367
|
+
* @version 236.0.0
|
|
26244
26368
|
*/
|
|
26245
26369
|
|
|
26246
26370
|
/**
|
|
@@ -26369,7 +26493,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26369
26493
|
/**
|
|
26370
26494
|
* EmployeeEngagement service.
|
|
26371
26495
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
26372
|
-
* @version
|
|
26496
|
+
* @version 236.0.0
|
|
26373
26497
|
*/
|
|
26374
26498
|
|
|
26375
26499
|
/**
|
|
@@ -26520,7 +26644,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26520
26644
|
/**
|
|
26521
26645
|
* Events service.
|
|
26522
26646
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
26523
|
-
* @version
|
|
26647
|
+
* @version 236.0.0
|
|
26524
26648
|
*/
|
|
26525
26649
|
|
|
26526
26650
|
/**
|
|
@@ -26616,7 +26740,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26616
26740
|
/**
|
|
26617
26741
|
* ExternalContacts service.
|
|
26618
26742
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
26619
|
-
* @version
|
|
26743
|
+
* @version 236.0.0
|
|
26620
26744
|
*/
|
|
26621
26745
|
|
|
26622
26746
|
/**
|
|
@@ -29863,7 +29987,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29863
29987
|
/**
|
|
29864
29988
|
* Fax service.
|
|
29865
29989
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
29866
|
-
* @version
|
|
29990
|
+
* @version 236.0.0
|
|
29867
29991
|
*/
|
|
29868
29992
|
|
|
29869
29993
|
/**
|
|
@@ -30078,7 +30202,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30078
30202
|
/**
|
|
30079
30203
|
* Flows service.
|
|
30080
30204
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
30081
|
-
* @version
|
|
30205
|
+
* @version 236.0.0
|
|
30082
30206
|
*/
|
|
30083
30207
|
|
|
30084
30208
|
/**
|
|
@@ -30287,7 +30411,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30287
30411
|
/**
|
|
30288
30412
|
* Gamification service.
|
|
30289
30413
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
30290
|
-
* @version
|
|
30414
|
+
* @version 236.0.0
|
|
30291
30415
|
*/
|
|
30292
30416
|
|
|
30293
30417
|
/**
|
|
@@ -30842,6 +30966,51 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30842
30966
|
);
|
|
30843
30967
|
}
|
|
30844
30968
|
|
|
30969
|
+
/**
|
|
30970
|
+
* Query managers in a profile during a period of time
|
|
30971
|
+
*
|
|
30972
|
+
* @param {Object} filterType Filter type for the query request.
|
|
30973
|
+
* @param {String} filterId ID for the filter type.
|
|
30974
|
+
* @param {Object} granularity Granularity
|
|
30975
|
+
* @param {String} startWorkday The start work day. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
30976
|
+
* @param {Object} opts Optional parameters
|
|
30977
|
+
* @param {Number} opts.pageSize Page size (default to 100)
|
|
30978
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
30979
|
+
*/
|
|
30980
|
+
getGamificationInsightsManagers(filterType, filterId, granularity, startWorkday, opts) {
|
|
30981
|
+
opts = opts || {};
|
|
30982
|
+
|
|
30983
|
+
// verify the required parameter 'filterType' is set
|
|
30984
|
+
if (filterType === undefined || filterType === null) {
|
|
30985
|
+
throw 'Missing the required parameter "filterType" when calling getGamificationInsightsManagers';
|
|
30986
|
+
}
|
|
30987
|
+
// verify the required parameter 'filterId' is set
|
|
30988
|
+
if (filterId === undefined || filterId === null) {
|
|
30989
|
+
throw 'Missing the required parameter "filterId" when calling getGamificationInsightsManagers';
|
|
30990
|
+
}
|
|
30991
|
+
// verify the required parameter 'granularity' is set
|
|
30992
|
+
if (granularity === undefined || granularity === null) {
|
|
30993
|
+
throw 'Missing the required parameter "granularity" when calling getGamificationInsightsManagers';
|
|
30994
|
+
}
|
|
30995
|
+
// verify the required parameter 'startWorkday' is set
|
|
30996
|
+
if (startWorkday === undefined || startWorkday === null) {
|
|
30997
|
+
throw 'Missing the required parameter "startWorkday" when calling getGamificationInsightsManagers';
|
|
30998
|
+
}
|
|
30999
|
+
|
|
31000
|
+
return this.apiClient.callApi(
|
|
31001
|
+
'/api/v2/gamification/insights/managers',
|
|
31002
|
+
'GET',
|
|
31003
|
+
{ },
|
|
31004
|
+
{ 'filterType': filterType,'filterId': filterId,'granularity': granularity,'startWorkday': startWorkday,'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
31005
|
+
{ },
|
|
31006
|
+
{ },
|
|
31007
|
+
null,
|
|
31008
|
+
['PureCloud OAuth'],
|
|
31009
|
+
['application/json'],
|
|
31010
|
+
['application/json']
|
|
31011
|
+
);
|
|
31012
|
+
}
|
|
31013
|
+
|
|
30845
31014
|
/**
|
|
30846
31015
|
* Query users in a profile during a period of time
|
|
30847
31016
|
*
|
|
@@ -32800,7 +32969,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32800
32969
|
/**
|
|
32801
32970
|
* GeneralDataProtectionRegulation service.
|
|
32802
32971
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
32803
|
-
* @version
|
|
32972
|
+
* @version 236.0.0
|
|
32804
32973
|
*/
|
|
32805
32974
|
|
|
32806
32975
|
/**
|
|
@@ -32930,7 +33099,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32930
33099
|
/**
|
|
32931
33100
|
* Geolocation service.
|
|
32932
33101
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
32933
|
-
* @version
|
|
33102
|
+
* @version 236.0.0
|
|
32934
33103
|
*/
|
|
32935
33104
|
|
|
32936
33105
|
/**
|
|
@@ -33061,7 +33230,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33061
33230
|
/**
|
|
33062
33231
|
* Greetings service.
|
|
33063
33232
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
33064
|
-
* @version
|
|
33233
|
+
* @version 236.0.0
|
|
33065
33234
|
*/
|
|
33066
33235
|
|
|
33067
33236
|
/**
|
|
@@ -33603,7 +33772,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33603
33772
|
/**
|
|
33604
33773
|
* Groups service.
|
|
33605
33774
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
33606
|
-
* @version
|
|
33775
|
+
* @version 236.0.0
|
|
33607
33776
|
*/
|
|
33608
33777
|
|
|
33609
33778
|
/**
|
|
@@ -34122,7 +34291,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34122
34291
|
/**
|
|
34123
34292
|
* IdentityProvider service.
|
|
34124
34293
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
34125
|
-
* @version
|
|
34294
|
+
* @version 236.0.0
|
|
34126
34295
|
*/
|
|
34127
34296
|
|
|
34128
34297
|
/**
|
|
@@ -34983,7 +35152,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34983
35152
|
/**
|
|
34984
35153
|
* InfrastructureAsCode service.
|
|
34985
35154
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
34986
|
-
* @version
|
|
35155
|
+
* @version 236.0.0
|
|
34987
35156
|
*/
|
|
34988
35157
|
|
|
34989
35158
|
/**
|
|
@@ -35150,7 +35319,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35150
35319
|
/**
|
|
35151
35320
|
* Integrations service.
|
|
35152
35321
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
35153
|
-
* @version
|
|
35322
|
+
* @version 236.0.0
|
|
35154
35323
|
*/
|
|
35155
35324
|
|
|
35156
35325
|
/**
|
|
@@ -37798,7 +37967,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37798
37967
|
/**
|
|
37799
37968
|
* Journey service.
|
|
37800
37969
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
37801
|
-
* @version
|
|
37970
|
+
* @version 236.0.0
|
|
37802
37971
|
*/
|
|
37803
37972
|
|
|
37804
37973
|
/**
|
|
@@ -39895,7 +40064,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39895
40064
|
/**
|
|
39896
40065
|
* Knowledge service.
|
|
39897
40066
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
39898
|
-
* @version
|
|
40067
|
+
* @version 236.0.0
|
|
39899
40068
|
*/
|
|
39900
40069
|
|
|
39901
40070
|
/**
|
|
@@ -42978,7 +43147,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42978
43147
|
/**
|
|
42979
43148
|
* LanguageUnderstanding service.
|
|
42980
43149
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
42981
|
-
* @version
|
|
43150
|
+
* @version 236.0.0
|
|
42982
43151
|
*/
|
|
42983
43152
|
|
|
42984
43153
|
/**
|
|
@@ -44197,7 +44366,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44197
44366
|
/**
|
|
44198
44367
|
* Languages service.
|
|
44199
44368
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
44200
|
-
* @version
|
|
44369
|
+
* @version 236.0.0
|
|
44201
44370
|
*/
|
|
44202
44371
|
|
|
44203
44372
|
/**
|
|
@@ -44419,7 +44588,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44419
44588
|
/**
|
|
44420
44589
|
* Learning service.
|
|
44421
44590
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
44422
|
-
* @version
|
|
44591
|
+
* @version 236.0.0
|
|
44423
44592
|
*/
|
|
44424
44593
|
|
|
44425
44594
|
/**
|
|
@@ -44860,6 +45029,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44860
45029
|
);
|
|
44861
45030
|
}
|
|
44862
45031
|
|
|
45032
|
+
/**
|
|
45033
|
+
* Retrieve the status of the job for the slots where a learning activity can be scheduled.
|
|
45034
|
+
*
|
|
45035
|
+
* @param {String} jobId The ID of the job
|
|
45036
|
+
*/
|
|
45037
|
+
getLearningScheduleslotsJob(jobId) {
|
|
45038
|
+
// verify the required parameter 'jobId' is set
|
|
45039
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
45040
|
+
throw 'Missing the required parameter "jobId" when calling getLearningScheduleslotsJob';
|
|
45041
|
+
}
|
|
45042
|
+
|
|
45043
|
+
return this.apiClient.callApi(
|
|
45044
|
+
'/api/v2/learning/scheduleslots/jobs/{jobId}',
|
|
45045
|
+
'GET',
|
|
45046
|
+
{ 'jobId': jobId },
|
|
45047
|
+
{ },
|
|
45048
|
+
{ },
|
|
45049
|
+
{ },
|
|
45050
|
+
null,
|
|
45051
|
+
['PureCloud OAuth'],
|
|
45052
|
+
['application/json'],
|
|
45053
|
+
['application/json']
|
|
45054
|
+
);
|
|
45055
|
+
}
|
|
45056
|
+
|
|
44863
45057
|
/**
|
|
44864
45058
|
* Get Learning SCORM Result
|
|
44865
45059
|
*
|
|
@@ -45303,6 +45497,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45303
45497
|
);
|
|
45304
45498
|
}
|
|
45305
45499
|
|
|
45500
|
+
/**
|
|
45501
|
+
* Start job to retrieve slots where a learning activity can be scheduled.
|
|
45502
|
+
*
|
|
45503
|
+
* @param {Object} body The slots search request
|
|
45504
|
+
*/
|
|
45505
|
+
postLearningScheduleslotsJobs(body) {
|
|
45506
|
+
// verify the required parameter 'body' is set
|
|
45507
|
+
if (body === undefined || body === null) {
|
|
45508
|
+
throw 'Missing the required parameter "body" when calling postLearningScheduleslotsJobs';
|
|
45509
|
+
}
|
|
45510
|
+
|
|
45511
|
+
return this.apiClient.callApi(
|
|
45512
|
+
'/api/v2/learning/scheduleslots/jobs',
|
|
45513
|
+
'POST',
|
|
45514
|
+
{ },
|
|
45515
|
+
{ },
|
|
45516
|
+
{ },
|
|
45517
|
+
{ },
|
|
45518
|
+
body,
|
|
45519
|
+
['PureCloud OAuth'],
|
|
45520
|
+
['application/json'],
|
|
45521
|
+
['application/json']
|
|
45522
|
+
);
|
|
45523
|
+
}
|
|
45524
|
+
|
|
45306
45525
|
/**
|
|
45307
45526
|
* Get list of possible slots where a learning activity can be scheduled.
|
|
45308
45527
|
*
|
|
@@ -45452,7 +45671,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45452
45671
|
/**
|
|
45453
45672
|
* License service.
|
|
45454
45673
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
45455
|
-
* @version
|
|
45674
|
+
* @version 236.0.0
|
|
45456
45675
|
*/
|
|
45457
45676
|
|
|
45458
45677
|
/**
|
|
@@ -45690,7 +45909,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45690
45909
|
/**
|
|
45691
45910
|
* Locations service.
|
|
45692
45911
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
45693
|
-
* @version
|
|
45912
|
+
* @version 236.0.0
|
|
45694
45913
|
*/
|
|
45695
45914
|
|
|
45696
45915
|
/**
|
|
@@ -45926,7 +46145,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45926
46145
|
/**
|
|
45927
46146
|
* LogCapture service.
|
|
45928
46147
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
45929
|
-
* @version
|
|
46148
|
+
* @version 236.0.0
|
|
45930
46149
|
*/
|
|
45931
46150
|
|
|
45932
46151
|
/**
|
|
@@ -46125,7 +46344,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46125
46344
|
/**
|
|
46126
46345
|
* Messaging service.
|
|
46127
46346
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
46128
|
-
* @version
|
|
46347
|
+
* @version 236.0.0
|
|
46129
46348
|
*/
|
|
46130
46349
|
|
|
46131
46350
|
/**
|
|
@@ -46484,7 +46703,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46484
46703
|
/**
|
|
46485
46704
|
* MobileDevices service.
|
|
46486
46705
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
46487
|
-
* @version
|
|
46706
|
+
* @version 236.0.0
|
|
46488
46707
|
*/
|
|
46489
46708
|
|
|
46490
46709
|
/**
|
|
@@ -46635,7 +46854,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46635
46854
|
/**
|
|
46636
46855
|
* Notifications service.
|
|
46637
46856
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
46638
|
-
* @version
|
|
46857
|
+
* @version 236.0.0
|
|
46639
46858
|
*/
|
|
46640
46859
|
|
|
46641
46860
|
/**
|
|
@@ -46868,7 +47087,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46868
47087
|
/**
|
|
46869
47088
|
* OAuth service.
|
|
46870
47089
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
46871
|
-
* @version
|
|
47090
|
+
* @version 236.0.0
|
|
46872
47091
|
*/
|
|
46873
47092
|
|
|
46874
47093
|
/**
|
|
@@ -47234,7 +47453,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47234
47453
|
/**
|
|
47235
47454
|
* Objects service.
|
|
47236
47455
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
47237
|
-
* @version
|
|
47456
|
+
* @version 236.0.0
|
|
47238
47457
|
*/
|
|
47239
47458
|
|
|
47240
47459
|
/**
|
|
@@ -47410,7 +47629,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47410
47629
|
* @param {Object} opts Optional parameters
|
|
47411
47630
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
47412
47631
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
47413
|
-
* @param {String} opts.pageSize
|
|
47632
|
+
* @param {String} opts.pageSize Page size (max 200, default 25) (default to 25)
|
|
47414
47633
|
* @param {Array.<String>} opts.id Optionally request specific divisions by their IDs
|
|
47415
47634
|
* @param {String} opts.name Optionally request specific divisions by division name
|
|
47416
47635
|
*/
|
|
@@ -47558,7 +47777,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47558
47777
|
/**
|
|
47559
47778
|
* OperationalEvents service.
|
|
47560
47779
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
47561
|
-
* @version
|
|
47780
|
+
* @version 236.0.0
|
|
47562
47781
|
*/
|
|
47563
47782
|
|
|
47564
47783
|
/**
|
|
@@ -47675,7 +47894,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47675
47894
|
/**
|
|
47676
47895
|
* Organization service.
|
|
47677
47896
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
47678
|
-
* @version
|
|
47897
|
+
* @version 236.0.0
|
|
47679
47898
|
*/
|
|
47680
47899
|
|
|
47681
47900
|
/**
|
|
@@ -48150,7 +48369,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48150
48369
|
/**
|
|
48151
48370
|
* OrganizationAuthorization service.
|
|
48152
48371
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
48153
|
-
* @version
|
|
48372
|
+
* @version 236.0.0
|
|
48154
48373
|
*/
|
|
48155
48374
|
|
|
48156
48375
|
/**
|
|
@@ -49544,7 +49763,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49544
49763
|
/**
|
|
49545
49764
|
* Outbound service.
|
|
49546
49765
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
49547
|
-
* @version
|
|
49766
|
+
* @version 236.0.0
|
|
49548
49767
|
*/
|
|
49549
49768
|
|
|
49550
49769
|
/**
|
|
@@ -54291,7 +54510,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54291
54510
|
/**
|
|
54292
54511
|
* Presence service.
|
|
54293
54512
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
54294
|
-
* @version
|
|
54513
|
+
* @version 236.0.0
|
|
54295
54514
|
*/
|
|
54296
54515
|
|
|
54297
54516
|
/**
|
|
@@ -55035,7 +55254,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55035
55254
|
/**
|
|
55036
55255
|
* ProcessAutomation service.
|
|
55037
55256
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
55038
|
-
* @version
|
|
55257
|
+
* @version 236.0.0
|
|
55039
55258
|
*/
|
|
55040
55259
|
|
|
55041
55260
|
/**
|
|
@@ -55274,7 +55493,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55274
55493
|
/**
|
|
55275
55494
|
* Quality service.
|
|
55276
55495
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
55277
|
-
* @version
|
|
55496
|
+
* @version 236.0.0
|
|
55278
55497
|
*/
|
|
55279
55498
|
|
|
55280
55499
|
/**
|
|
@@ -56338,59 +56557,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56338
56557
|
);
|
|
56339
56558
|
}
|
|
56340
56559
|
|
|
56341
|
-
/**
|
|
56342
|
-
* Get the most recent published version of an evaluation form across any division.
|
|
56343
|
-
*
|
|
56344
|
-
* @param {String} evaluationFormId Evaluation Form ID
|
|
56345
|
-
* getQualityPublishedformsEvaluationsDivisionview is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
56346
|
-
*/
|
|
56347
|
-
getQualityPublishedformsEvaluationsDivisionview(evaluationFormId) {
|
|
56348
|
-
// verify the required parameter 'evaluationFormId' is set
|
|
56349
|
-
if (evaluationFormId === undefined || evaluationFormId === null || evaluationFormId === '') {
|
|
56350
|
-
throw 'Missing the required parameter "evaluationFormId" when calling getQualityPublishedformsEvaluationsDivisionview';
|
|
56351
|
-
}
|
|
56352
|
-
|
|
56353
|
-
return this.apiClient.callApi(
|
|
56354
|
-
'/api/v2/quality/publishedforms/evaluations/divisionviews/{evaluationFormId}',
|
|
56355
|
-
'GET',
|
|
56356
|
-
{ 'evaluationFormId': evaluationFormId },
|
|
56357
|
-
{ },
|
|
56358
|
-
{ },
|
|
56359
|
-
{ },
|
|
56360
|
-
null,
|
|
56361
|
-
['PureCloud OAuth'],
|
|
56362
|
-
['application/json'],
|
|
56363
|
-
['application/json']
|
|
56364
|
-
);
|
|
56365
|
-
}
|
|
56366
|
-
|
|
56367
|
-
/**
|
|
56368
|
-
* Get the published evaluation forms across any division.
|
|
56369
|
-
*
|
|
56370
|
-
* @param {Object} opts Optional parameters
|
|
56371
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
56372
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
56373
|
-
* @param {String} opts.name Name
|
|
56374
|
-
* getQualityPublishedformsEvaluationsDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
56375
|
-
*/
|
|
56376
|
-
getQualityPublishedformsEvaluationsDivisionviews(opts) {
|
|
56377
|
-
opts = opts || {};
|
|
56378
|
-
|
|
56379
|
-
|
|
56380
|
-
return this.apiClient.callApi(
|
|
56381
|
-
'/api/v2/quality/publishedforms/evaluations/divisionviews',
|
|
56382
|
-
'GET',
|
|
56383
|
-
{ },
|
|
56384
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'name': opts['name'] },
|
|
56385
|
-
{ },
|
|
56386
|
-
{ },
|
|
56387
|
-
null,
|
|
56388
|
-
['PureCloud OAuth'],
|
|
56389
|
-
['application/json'],
|
|
56390
|
-
['application/json']
|
|
56391
|
-
);
|
|
56392
|
-
}
|
|
56393
|
-
|
|
56394
56560
|
/**
|
|
56395
56561
|
* Get the most recent published version of a survey form.
|
|
56396
56562
|
*
|
|
@@ -56443,59 +56609,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56443
56609
|
);
|
|
56444
56610
|
}
|
|
56445
56611
|
|
|
56446
|
-
/**
|
|
56447
|
-
* Get the most recent published version of an enabled survey form across any division.
|
|
56448
|
-
*
|
|
56449
|
-
* @param {String} surveyFormId Survey Form ID
|
|
56450
|
-
* getQualityPublishedformsSurveysDivisionview is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
56451
|
-
*/
|
|
56452
|
-
getQualityPublishedformsSurveysDivisionview(surveyFormId) {
|
|
56453
|
-
// verify the required parameter 'surveyFormId' is set
|
|
56454
|
-
if (surveyFormId === undefined || surveyFormId === null || surveyFormId === '') {
|
|
56455
|
-
throw 'Missing the required parameter "surveyFormId" when calling getQualityPublishedformsSurveysDivisionview';
|
|
56456
|
-
}
|
|
56457
|
-
|
|
56458
|
-
return this.apiClient.callApi(
|
|
56459
|
-
'/api/v2/quality/publishedforms/surveys/divisionviews/{surveyFormId}',
|
|
56460
|
-
'GET',
|
|
56461
|
-
{ 'surveyFormId': surveyFormId },
|
|
56462
|
-
{ },
|
|
56463
|
-
{ },
|
|
56464
|
-
{ },
|
|
56465
|
-
null,
|
|
56466
|
-
['PureCloud OAuth'],
|
|
56467
|
-
['application/json'],
|
|
56468
|
-
['application/json']
|
|
56469
|
-
);
|
|
56470
|
-
}
|
|
56471
|
-
|
|
56472
|
-
/**
|
|
56473
|
-
* Get the published and enabled survey forms across any division.
|
|
56474
|
-
*
|
|
56475
|
-
* @param {Object} opts Optional parameters
|
|
56476
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
56477
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
56478
|
-
* @param {String} opts.name Name
|
|
56479
|
-
* getQualityPublishedformsSurveysDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
56480
|
-
*/
|
|
56481
|
-
getQualityPublishedformsSurveysDivisionviews(opts) {
|
|
56482
|
-
opts = opts || {};
|
|
56483
|
-
|
|
56484
|
-
|
|
56485
|
-
return this.apiClient.callApi(
|
|
56486
|
-
'/api/v2/quality/publishedforms/surveys/divisionviews',
|
|
56487
|
-
'GET',
|
|
56488
|
-
{ },
|
|
56489
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'name': opts['name'] },
|
|
56490
|
-
{ },
|
|
56491
|
-
{ },
|
|
56492
|
-
null,
|
|
56493
|
-
['PureCloud OAuth'],
|
|
56494
|
-
['application/json'],
|
|
56495
|
-
['application/json']
|
|
56496
|
-
);
|
|
56497
|
-
}
|
|
56498
|
-
|
|
56499
56612
|
/**
|
|
56500
56613
|
* Get a survey for a conversation
|
|
56501
56614
|
*
|
|
@@ -57219,7 +57332,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57219
57332
|
/**
|
|
57220
57333
|
* Recording service.
|
|
57221
57334
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
57222
|
-
* @version
|
|
57335
|
+
* @version 236.0.0
|
|
57223
57336
|
*/
|
|
57224
57337
|
|
|
57225
57338
|
/**
|
|
@@ -58824,7 +58937,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58824
58937
|
/**
|
|
58825
58938
|
* ResponseManagement service.
|
|
58826
58939
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
58827
|
-
* @version
|
|
58940
|
+
* @version 236.0.0
|
|
58828
58941
|
*/
|
|
58829
58942
|
|
|
58830
58943
|
/**
|
|
@@ -59334,7 +59447,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59334
59447
|
/**
|
|
59335
59448
|
* Routing service.
|
|
59336
59449
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
59337
|
-
* @version
|
|
59450
|
+
* @version 236.0.0
|
|
59338
59451
|
*/
|
|
59339
59452
|
|
|
59340
59453
|
/**
|
|
@@ -63817,7 +63930,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63817
63930
|
/**
|
|
63818
63931
|
* SCIM service.
|
|
63819
63932
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
63820
|
-
* @version
|
|
63933
|
+
* @version 236.0.0
|
|
63821
63934
|
*/
|
|
63822
63935
|
|
|
63823
63936
|
/**
|
|
@@ -64694,7 +64807,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64694
64807
|
/**
|
|
64695
64808
|
* ScreenRecording service.
|
|
64696
64809
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
64697
|
-
* @version
|
|
64810
|
+
* @version 236.0.0
|
|
64698
64811
|
*/
|
|
64699
64812
|
|
|
64700
64813
|
/**
|
|
@@ -64739,7 +64852,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64739
64852
|
/**
|
|
64740
64853
|
* Scripts service.
|
|
64741
64854
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
64742
|
-
* @version
|
|
64855
|
+
* @version 236.0.0
|
|
64743
64856
|
*/
|
|
64744
64857
|
|
|
64745
64858
|
/**
|
|
@@ -65215,7 +65328,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65215
65328
|
/**
|
|
65216
65329
|
* Search service.
|
|
65217
65330
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
65218
|
-
* @version
|
|
65331
|
+
* @version 236.0.0
|
|
65219
65332
|
*/
|
|
65220
65333
|
|
|
65221
65334
|
/**
|
|
@@ -65903,7 +66016,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65903
66016
|
/**
|
|
65904
66017
|
* Settings service.
|
|
65905
66018
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
65906
|
-
* @version
|
|
66019
|
+
* @version 236.0.0
|
|
65907
66020
|
*/
|
|
65908
66021
|
|
|
65909
66022
|
/**
|
|
@@ -66251,7 +66364,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66251
66364
|
/**
|
|
66252
66365
|
* SocialMedia service.
|
|
66253
66366
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
66254
|
-
* @version
|
|
66367
|
+
* @version 236.0.0
|
|
66255
66368
|
*/
|
|
66256
66369
|
|
|
66257
66370
|
/**
|
|
@@ -67846,7 +67959,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67846
67959
|
/**
|
|
67847
67960
|
* SpeechTextAnalytics service.
|
|
67848
67961
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
67849
|
-
* @version
|
|
67962
|
+
* @version 236.0.0
|
|
67850
67963
|
*/
|
|
67851
67964
|
|
|
67852
67965
|
/**
|
|
@@ -69493,7 +69606,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69493
69606
|
/**
|
|
69494
69607
|
* Stations service.
|
|
69495
69608
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
69496
|
-
* @version
|
|
69609
|
+
* @version 236.0.0
|
|
69497
69610
|
*/
|
|
69498
69611
|
|
|
69499
69612
|
/**
|
|
@@ -69595,7 +69708,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69595
69708
|
/**
|
|
69596
69709
|
* Suggest service.
|
|
69597
69710
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
69598
|
-
* @version
|
|
69711
|
+
* @version 236.0.0
|
|
69599
69712
|
*/
|
|
69600
69713
|
|
|
69601
69714
|
/**
|
|
@@ -69734,7 +69847,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69734
69847
|
/**
|
|
69735
69848
|
* TaskManagement service.
|
|
69736
69849
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
69737
|
-
* @version
|
|
69850
|
+
* @version 236.0.0
|
|
69738
69851
|
*/
|
|
69739
69852
|
|
|
69740
69853
|
/**
|
|
@@ -71896,7 +72009,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
71896
72009
|
/**
|
|
71897
72010
|
* Teams service.
|
|
71898
72011
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
71899
|
-
* @version
|
|
72012
|
+
* @version 236.0.0
|
|
71900
72013
|
*/
|
|
71901
72014
|
|
|
71902
72015
|
/**
|
|
@@ -72201,7 +72314,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
72201
72314
|
/**
|
|
72202
72315
|
* Telephony service.
|
|
72203
72316
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
72204
|
-
* @version
|
|
72317
|
+
* @version 236.0.0
|
|
72205
72318
|
*/
|
|
72206
72319
|
|
|
72207
72320
|
/**
|
|
@@ -72487,7 +72600,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
72487
72600
|
/**
|
|
72488
72601
|
* TelephonyProvidersEdge service.
|
|
72489
72602
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
72490
|
-
* @version
|
|
72603
|
+
* @version 236.0.0
|
|
72491
72604
|
*/
|
|
72492
72605
|
|
|
72493
72606
|
/**
|
|
@@ -75980,7 +76093,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75980
76093
|
/**
|
|
75981
76094
|
* Textbots service.
|
|
75982
76095
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
75983
|
-
* @version
|
|
76096
|
+
* @version 236.0.0
|
|
75984
76097
|
*/
|
|
75985
76098
|
|
|
75986
76099
|
/**
|
|
@@ -76109,7 +76222,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
76109
76222
|
/**
|
|
76110
76223
|
* Tokens service.
|
|
76111
76224
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
76112
|
-
* @version
|
|
76225
|
+
* @version 236.0.0
|
|
76113
76226
|
*/
|
|
76114
76227
|
|
|
76115
76228
|
/**
|
|
@@ -76263,7 +76376,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
76263
76376
|
/**
|
|
76264
76377
|
* Uploads service.
|
|
76265
76378
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
76266
|
-
* @version
|
|
76379
|
+
* @version 236.0.0
|
|
76267
76380
|
*/
|
|
76268
76381
|
|
|
76269
76382
|
/**
|
|
@@ -76554,7 +76667,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
76554
76667
|
/**
|
|
76555
76668
|
* Usage service.
|
|
76556
76669
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
76557
|
-
* @version
|
|
76670
|
+
* @version 236.0.0
|
|
76558
76671
|
*/
|
|
76559
76672
|
|
|
76560
76673
|
/**
|
|
@@ -76889,7 +77002,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
76889
77002
|
/**
|
|
76890
77003
|
* UserRecordings service.
|
|
76891
77004
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
76892
|
-
* @version
|
|
77005
|
+
* @version 236.0.0
|
|
76893
77006
|
*/
|
|
76894
77007
|
|
|
76895
77008
|
/**
|
|
@@ -77073,7 +77186,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
77073
77186
|
/**
|
|
77074
77187
|
* Users service.
|
|
77075
77188
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
77076
|
-
* @version
|
|
77189
|
+
* @version 236.0.0
|
|
77077
77190
|
*/
|
|
77078
77191
|
|
|
77079
77192
|
/**
|
|
@@ -80082,7 +80195,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
80082
80195
|
/**
|
|
80083
80196
|
* Utilities service.
|
|
80084
80197
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
80085
|
-
* @version
|
|
80198
|
+
* @version 236.0.0
|
|
80086
80199
|
*/
|
|
80087
80200
|
|
|
80088
80201
|
/**
|
|
@@ -80193,7 +80306,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
80193
80306
|
/**
|
|
80194
80307
|
* Voicemail service.
|
|
80195
80308
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
80196
|
-
* @version
|
|
80309
|
+
* @version 236.0.0
|
|
80197
80310
|
*/
|
|
80198
80311
|
|
|
80199
80312
|
/**
|
|
@@ -80915,7 +81028,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
80915
81028
|
/**
|
|
80916
81029
|
* WebChat service.
|
|
80917
81030
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
80918
|
-
* @version
|
|
81031
|
+
* @version 236.0.0
|
|
80919
81032
|
*/
|
|
80920
81033
|
|
|
80921
81034
|
/**
|
|
@@ -81478,7 +81591,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
81478
81591
|
/**
|
|
81479
81592
|
* WebDeployments service.
|
|
81480
81593
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
81481
|
-
* @version
|
|
81594
|
+
* @version 236.0.0
|
|
81482
81595
|
*/
|
|
81483
81596
|
|
|
81484
81597
|
/**
|
|
@@ -82060,7 +82173,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
82060
82173
|
/**
|
|
82061
82174
|
* WebMessaging service.
|
|
82062
82175
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
82063
|
-
* @version
|
|
82176
|
+
* @version 236.0.0
|
|
82064
82177
|
*/
|
|
82065
82178
|
|
|
82066
82179
|
/**
|
|
@@ -82206,7 +82319,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
82206
82319
|
/**
|
|
82207
82320
|
* Widgets service.
|
|
82208
82321
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
82209
|
-
* @version
|
|
82322
|
+
* @version 236.0.0
|
|
82210
82323
|
*/
|
|
82211
82324
|
|
|
82212
82325
|
/**
|
|
@@ -82357,7 +82470,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
82357
82470
|
/**
|
|
82358
82471
|
* WorkforceManagement service.
|
|
82359
82472
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
82360
|
-
* @version
|
|
82473
|
+
* @version 236.0.0
|
|
82361
82474
|
*/
|
|
82362
82475
|
|
|
82363
82476
|
/**
|
|
@@ -84757,6 +84870,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
84757
84870
|
* @param {String} forecastId The ID of the forecast
|
|
84758
84871
|
* @param {Object} opts Optional parameters
|
|
84759
84872
|
* @param {Array.<String>} opts.weekNumbers The week numbers to fetch (for multi-week forecasts) staffing requirements. Returns all week data if the list is not specified
|
|
84873
|
+
* @param {Array.<String>} opts.expand Expand to include minimum staffing values in (staffing requirement response or applied to base staffing requirement values)
|
|
84760
84874
|
*/
|
|
84761
84875
|
getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement(businessUnitId, weekDateId, forecastId, opts) {
|
|
84762
84876
|
opts = opts || {};
|
|
@@ -84778,7 +84892,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
84778
84892
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/staffingrequirement',
|
|
84779
84893
|
'GET',
|
|
84780
84894
|
{ 'businessUnitId': businessUnitId,'weekDateId': weekDateId,'forecastId': forecastId },
|
|
84781
|
-
{ 'weekNumbers': this.apiClient.buildCollectionParam(opts['weekNumbers'], 'multi') },
|
|
84895
|
+
{ 'weekNumbers': this.apiClient.buildCollectionParam(opts['weekNumbers'], 'multi'),'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
84782
84896
|
{ },
|
|
84783
84897
|
{ },
|
|
84784
84898
|
null,
|
|
@@ -90357,7 +90471,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
90357
90471
|
* </pre>
|
|
90358
90472
|
* </p>
|
|
90359
90473
|
* @module purecloud-platform-client-v2/index
|
|
90360
|
-
* @version
|
|
90474
|
+
* @version 236.0.0
|
|
90361
90475
|
*/
|
|
90362
90476
|
class platformClient {
|
|
90363
90477
|
constructor() {
|