purecloud-platform-client-v2 234.0.0 → 235.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 +276 -198
- package/dist/web-amd/purecloud-platform-client-v2.js +276 -198
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +180 -127
- package/dist/web-cjs/purecloud-platform-client-v2.js +180 -127
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +671 -561
- 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 +1 -1
- 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 +2 -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 +1 -1
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -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
|
@@ -748,7 +748,7 @@ class Configuration {
|
|
|
748
748
|
|
|
749
749
|
/**
|
|
750
750
|
* @module purecloud-platform-client-v2/ApiClient
|
|
751
|
-
* @version
|
|
751
|
+
* @version 235.0.0
|
|
752
752
|
*/
|
|
753
753
|
class ApiClient {
|
|
754
754
|
/**
|
|
@@ -951,6 +951,50 @@ class ApiClient {
|
|
|
951
951
|
this.config.setEnvironment(environment);
|
|
952
952
|
}
|
|
953
953
|
|
|
954
|
+
/**
|
|
955
|
+
* @description Sets the optional http headers used by the client
|
|
956
|
+
* @param {object} newHeaders - default headers to be used
|
|
957
|
+
*/
|
|
958
|
+
setDefaultHeaders(newHeaders) {
|
|
959
|
+
if (!newHeaders || !(typeof newHeaders === 'object')) {
|
|
960
|
+
throw new Error("default headers must be a map");
|
|
961
|
+
}
|
|
962
|
+
this.defaultHeaders = newHeaders;
|
|
963
|
+
}
|
|
964
|
+
|
|
965
|
+
/**
|
|
966
|
+
* @description Gets the default http headers used by the client
|
|
967
|
+
*/
|
|
968
|
+
getDefaultHeaders() {
|
|
969
|
+
return this.defaultHeaders;
|
|
970
|
+
}
|
|
971
|
+
|
|
972
|
+
/**
|
|
973
|
+
* @description Sets the optional Genesys-App http header used by the client
|
|
974
|
+
* @param {string} headerValue - value for the Genesys-App header
|
|
975
|
+
*/
|
|
976
|
+
setGenesysAppHeader(headerValue) {
|
|
977
|
+
if (!headerValue || !(typeof headerValue === 'string')) throw new Error("headerValue must be a non empty string");
|
|
978
|
+
if (!this.defaultHeaders) {
|
|
979
|
+
this.defaultHeaders = {
|
|
980
|
+
"Genesys-App": headerValue
|
|
981
|
+
};
|
|
982
|
+
} else {
|
|
983
|
+
this.defaultHeaders["Genesys-App"] = headerValue;
|
|
984
|
+
}
|
|
985
|
+
}
|
|
986
|
+
|
|
987
|
+
/**
|
|
988
|
+
* @description Gets the Genesys-App http header used by the client
|
|
989
|
+
*/
|
|
990
|
+
getGenesysAppHeader() {
|
|
991
|
+
if (this.defaultHeaders && this.defaultHeaders["Genesys-App"]) {
|
|
992
|
+
return this.defaultHeaders["Genesys-App"];
|
|
993
|
+
} else {
|
|
994
|
+
return null;
|
|
995
|
+
}
|
|
996
|
+
}
|
|
997
|
+
|
|
954
998
|
/**
|
|
955
999
|
* @description Sets the dynamic HttpClient used by the client
|
|
956
1000
|
* @param {object} httpClient - HttpClient to be injected
|
|
@@ -2317,7 +2361,7 @@ class AIStudioApi {
|
|
|
2317
2361
|
/**
|
|
2318
2362
|
* AIStudio service.
|
|
2319
2363
|
* @module purecloud-platform-client-v2/api/AIStudioApi
|
|
2320
|
-
* @version
|
|
2364
|
+
* @version 235.0.0
|
|
2321
2365
|
*/
|
|
2322
2366
|
|
|
2323
2367
|
/**
|
|
@@ -2889,7 +2933,7 @@ class AgentAssistantsApi {
|
|
|
2889
2933
|
/**
|
|
2890
2934
|
* AgentAssistants service.
|
|
2891
2935
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
2892
|
-
* @version
|
|
2936
|
+
* @version 235.0.0
|
|
2893
2937
|
*/
|
|
2894
2938
|
|
|
2895
2939
|
/**
|
|
@@ -3375,7 +3419,7 @@ class AgentCopilotApi {
|
|
|
3375
3419
|
/**
|
|
3376
3420
|
* AgentCopilot service.
|
|
3377
3421
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
3378
|
-
* @version
|
|
3422
|
+
* @version 235.0.0
|
|
3379
3423
|
*/
|
|
3380
3424
|
|
|
3381
3425
|
/**
|
|
@@ -3475,7 +3519,7 @@ class AgentUIApi {
|
|
|
3475
3519
|
/**
|
|
3476
3520
|
* AgentUI service.
|
|
3477
3521
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
3478
|
-
* @version
|
|
3522
|
+
* @version 235.0.0
|
|
3479
3523
|
*/
|
|
3480
3524
|
|
|
3481
3525
|
/**
|
|
@@ -3606,7 +3650,7 @@ class AlertingApi {
|
|
|
3606
3650
|
/**
|
|
3607
3651
|
* Alerting service.
|
|
3608
3652
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
3609
|
-
* @version
|
|
3653
|
+
* @version 235.0.0
|
|
3610
3654
|
*/
|
|
3611
3655
|
|
|
3612
3656
|
/**
|
|
@@ -4007,7 +4051,7 @@ class AnalyticsApi {
|
|
|
4007
4051
|
/**
|
|
4008
4052
|
* Analytics service.
|
|
4009
4053
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
4010
|
-
* @version
|
|
4054
|
+
* @version 235.0.0
|
|
4011
4055
|
*/
|
|
4012
4056
|
|
|
4013
4057
|
/**
|
|
@@ -7275,7 +7319,7 @@ class ArchitectApi {
|
|
|
7275
7319
|
/**
|
|
7276
7320
|
* Architect service.
|
|
7277
7321
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
7278
|
-
* @version
|
|
7322
|
+
* @version 235.0.0
|
|
7279
7323
|
*/
|
|
7280
7324
|
|
|
7281
7325
|
/**
|
|
@@ -11570,7 +11614,7 @@ class AuditApi {
|
|
|
11570
11614
|
/**
|
|
11571
11615
|
* Audit service.
|
|
11572
11616
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
11573
|
-
* @version
|
|
11617
|
+
* @version 235.0.0
|
|
11574
11618
|
*/
|
|
11575
11619
|
|
|
11576
11620
|
/**
|
|
@@ -11771,7 +11815,7 @@ class AuthorizationApi {
|
|
|
11771
11815
|
/**
|
|
11772
11816
|
* Authorization service.
|
|
11773
11817
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
11774
|
-
* @version
|
|
11818
|
+
* @version 235.0.0
|
|
11775
11819
|
*/
|
|
11776
11820
|
|
|
11777
11821
|
/**
|
|
@@ -13486,7 +13530,7 @@ class BillingApi {
|
|
|
13486
13530
|
/**
|
|
13487
13531
|
* Billing service.
|
|
13488
13532
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
13489
|
-
* @version
|
|
13533
|
+
* @version 235.0.0
|
|
13490
13534
|
*/
|
|
13491
13535
|
|
|
13492
13536
|
/**
|
|
@@ -13742,7 +13786,7 @@ class BusinessRulesApi {
|
|
|
13742
13786
|
/**
|
|
13743
13787
|
* BusinessRules service.
|
|
13744
13788
|
* @module purecloud-platform-client-v2/api/BusinessRulesApi
|
|
13745
|
-
* @version
|
|
13789
|
+
* @version 235.0.0
|
|
13746
13790
|
*/
|
|
13747
13791
|
|
|
13748
13792
|
/**
|
|
@@ -14629,7 +14673,7 @@ class CarrierServicesApi {
|
|
|
14629
14673
|
/**
|
|
14630
14674
|
* CarrierServices service.
|
|
14631
14675
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
14632
|
-
* @version
|
|
14676
|
+
* @version 235.0.0
|
|
14633
14677
|
*/
|
|
14634
14678
|
|
|
14635
14679
|
/**
|
|
@@ -14699,7 +14743,7 @@ class ChatApi {
|
|
|
14699
14743
|
/**
|
|
14700
14744
|
* Chat service.
|
|
14701
14745
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
14702
|
-
* @version
|
|
14746
|
+
* @version 235.0.0
|
|
14703
14747
|
*/
|
|
14704
14748
|
|
|
14705
14749
|
/**
|
|
@@ -15680,7 +15724,7 @@ class CoachingApi {
|
|
|
15680
15724
|
/**
|
|
15681
15725
|
* Coaching service.
|
|
15682
15726
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
15683
|
-
* @version
|
|
15727
|
+
* @version 235.0.0
|
|
15684
15728
|
*/
|
|
15685
15729
|
|
|
15686
15730
|
/**
|
|
@@ -15991,6 +16035,31 @@ class CoachingApi {
|
|
|
15991
16035
|
);
|
|
15992
16036
|
}
|
|
15993
16037
|
|
|
16038
|
+
/**
|
|
16039
|
+
* Retrieve the status of the job for the slots where a coaching appointment can be scheduled.
|
|
16040
|
+
*
|
|
16041
|
+
* @param {String} jobId The ID of job
|
|
16042
|
+
*/
|
|
16043
|
+
getCoachingScheduleslotsJob(jobId) {
|
|
16044
|
+
// verify the required parameter 'jobId' is set
|
|
16045
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
16046
|
+
throw 'Missing the required parameter "jobId" when calling getCoachingScheduleslotsJob';
|
|
16047
|
+
}
|
|
16048
|
+
|
|
16049
|
+
return this.apiClient.callApi(
|
|
16050
|
+
'/api/v2/coaching/scheduleslots/jobs/{jobId}',
|
|
16051
|
+
'GET',
|
|
16052
|
+
{ 'jobId': jobId },
|
|
16053
|
+
{ },
|
|
16054
|
+
{ },
|
|
16055
|
+
{ },
|
|
16056
|
+
null,
|
|
16057
|
+
['PureCloud OAuth'],
|
|
16058
|
+
['application/json'],
|
|
16059
|
+
['application/json']
|
|
16060
|
+
);
|
|
16061
|
+
}
|
|
16062
|
+
|
|
15994
16063
|
/**
|
|
15995
16064
|
* Update an existing appointment
|
|
15996
16065
|
* Permission not required if you are the creator or facilitator of the appointment
|
|
@@ -16226,6 +16295,31 @@ class CoachingApi {
|
|
|
16226
16295
|
);
|
|
16227
16296
|
}
|
|
16228
16297
|
|
|
16298
|
+
/**
|
|
16299
|
+
* Start job to retrieve the slots where a coaching appointment can be scheduled.
|
|
16300
|
+
*
|
|
16301
|
+
* @param {Object} body The slots search request
|
|
16302
|
+
*/
|
|
16303
|
+
postCoachingScheduleslotsJobs(body) {
|
|
16304
|
+
// verify the required parameter 'body' is set
|
|
16305
|
+
if (body === undefined || body === null) {
|
|
16306
|
+
throw 'Missing the required parameter "body" when calling postCoachingScheduleslotsJobs';
|
|
16307
|
+
}
|
|
16308
|
+
|
|
16309
|
+
return this.apiClient.callApi(
|
|
16310
|
+
'/api/v2/coaching/scheduleslots/jobs',
|
|
16311
|
+
'POST',
|
|
16312
|
+
{ },
|
|
16313
|
+
{ },
|
|
16314
|
+
{ },
|
|
16315
|
+
{ },
|
|
16316
|
+
body,
|
|
16317
|
+
['PureCloud OAuth'],
|
|
16318
|
+
['application/json'],
|
|
16319
|
+
['application/json']
|
|
16320
|
+
);
|
|
16321
|
+
}
|
|
16322
|
+
|
|
16229
16323
|
/**
|
|
16230
16324
|
* Get list of possible slots where a coaching appointment can be scheduled.
|
|
16231
16325
|
*
|
|
@@ -16257,7 +16351,7 @@ class ContentManagementApi {
|
|
|
16257
16351
|
/**
|
|
16258
16352
|
* ContentManagement service.
|
|
16259
16353
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
16260
|
-
* @version
|
|
16354
|
+
* @version 235.0.0
|
|
16261
16355
|
*/
|
|
16262
16356
|
|
|
16263
16357
|
/**
|
|
@@ -17338,7 +17432,7 @@ class ConversationsApi {
|
|
|
17338
17432
|
/**
|
|
17339
17433
|
* Conversations service.
|
|
17340
17434
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
17341
|
-
* @version
|
|
17435
|
+
* @version 235.0.0
|
|
17342
17436
|
*/
|
|
17343
17437
|
|
|
17344
17438
|
/**
|
|
@@ -18010,7 +18104,6 @@ class ConversationsApi {
|
|
|
18010
18104
|
* @param {String} conversationId conversationId
|
|
18011
18105
|
* @param {String} communicationId communicationId
|
|
18012
18106
|
* @param {String} messageId messageId
|
|
18013
|
-
* getConversationCommunicationInternalmessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18014
18107
|
*/
|
|
18015
18108
|
getConversationCommunicationInternalmessage(conversationId, communicationId, messageId) {
|
|
18016
18109
|
// verify the required parameter 'conversationId' is set
|
|
@@ -18048,7 +18141,6 @@ class ConversationsApi {
|
|
|
18048
18141
|
* @param {Object} opts Optional parameters
|
|
18049
18142
|
* @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)
|
|
18050
18143
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
18051
|
-
* getConversationCommunicationInternalmessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18052
18144
|
*/
|
|
18053
18145
|
getConversationCommunicationInternalmessages(conversationId, communicationId, opts) {
|
|
18054
18146
|
opts = opts || {};
|
|
@@ -19310,7 +19402,6 @@ class ConversationsApi {
|
|
|
19310
19402
|
* Get internal message conversation
|
|
19311
19403
|
*
|
|
19312
19404
|
* @param {String} conversationId conversationId
|
|
19313
|
-
* getConversationsInternalmessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
19314
19405
|
*/
|
|
19315
19406
|
getConversationsInternalmessage(conversationId) {
|
|
19316
19407
|
// verify the required parameter 'conversationId' is set
|
|
@@ -19335,7 +19426,6 @@ class ConversationsApi {
|
|
|
19335
19426
|
/**
|
|
19336
19427
|
* Get active internal message conversations for the logged in user
|
|
19337
19428
|
*
|
|
19338
|
-
* getConversationsInternalmessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
19339
19429
|
*/
|
|
19340
19430
|
getConversationsInternalmessages() {
|
|
19341
19431
|
|
|
@@ -22534,7 +22624,6 @@ class ConversationsApi {
|
|
|
22534
22624
|
* @param {String} conversationId conversationId
|
|
22535
22625
|
* @param {String} communicationId communicationId
|
|
22536
22626
|
* @param {Object} body Message
|
|
22537
|
-
* postConversationCommunicationInternalmessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
22538
22627
|
*/
|
|
22539
22628
|
postConversationCommunicationInternalmessages(conversationId, communicationId, body) {
|
|
22540
22629
|
// verify the required parameter 'conversationId' is set
|
|
@@ -22663,7 +22752,6 @@ class ConversationsApi {
|
|
|
22663
22752
|
* @param {String} conversationId conversation ID
|
|
22664
22753
|
* @param {String} participantId participant ID
|
|
22665
22754
|
* @param {Object} body Confer request
|
|
22666
|
-
* postConversationParticipantInternalmessagesUsersCommunications is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
22667
22755
|
*/
|
|
22668
22756
|
postConversationParticipantInternalmessagesUsersCommunications(conversationId, participantId, body) {
|
|
22669
22757
|
// verify the required parameter 'conversationId' is set
|
|
@@ -24573,7 +24661,7 @@ class ConversationsApi {
|
|
|
24573
24661
|
|
|
24574
24662
|
/**
|
|
24575
24663
|
* Get messages in batch
|
|
24576
|
-
* 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"]
|
|
24664
|
+
* 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.
|
|
24577
24665
|
* @param {String} conversationId
|
|
24578
24666
|
* @param {Object} opts Optional parameters
|
|
24579
24667
|
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media) (default to false)
|
|
@@ -25935,7 +26023,7 @@ class DataExtensionsApi {
|
|
|
25935
26023
|
/**
|
|
25936
26024
|
* DataExtensions service.
|
|
25937
26025
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
25938
|
-
* @version
|
|
26026
|
+
* @version 235.0.0
|
|
25939
26027
|
*/
|
|
25940
26028
|
|
|
25941
26029
|
/**
|
|
@@ -26021,7 +26109,7 @@ class DataPrivacyApi {
|
|
|
26021
26109
|
/**
|
|
26022
26110
|
* DataPrivacy service.
|
|
26023
26111
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
26024
|
-
* @version
|
|
26112
|
+
* @version 235.0.0
|
|
26025
26113
|
*/
|
|
26026
26114
|
|
|
26027
26115
|
/**
|
|
@@ -26191,7 +26279,7 @@ class DownloadsApi {
|
|
|
26191
26279
|
/**
|
|
26192
26280
|
* Downloads service.
|
|
26193
26281
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
26194
|
-
* @version
|
|
26282
|
+
* @version 235.0.0
|
|
26195
26283
|
*/
|
|
26196
26284
|
|
|
26197
26285
|
/**
|
|
@@ -26243,7 +26331,7 @@ class EmailsApi {
|
|
|
26243
26331
|
/**
|
|
26244
26332
|
* Emails service.
|
|
26245
26333
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
26246
|
-
* @version
|
|
26334
|
+
* @version 235.0.0
|
|
26247
26335
|
*/
|
|
26248
26336
|
|
|
26249
26337
|
/**
|
|
@@ -26372,7 +26460,7 @@ class EmployeeEngagementApi {
|
|
|
26372
26460
|
/**
|
|
26373
26461
|
* EmployeeEngagement service.
|
|
26374
26462
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
26375
|
-
* @version
|
|
26463
|
+
* @version 235.0.0
|
|
26376
26464
|
*/
|
|
26377
26465
|
|
|
26378
26466
|
/**
|
|
@@ -26523,7 +26611,7 @@ class EventsApi {
|
|
|
26523
26611
|
/**
|
|
26524
26612
|
* Events service.
|
|
26525
26613
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
26526
|
-
* @version
|
|
26614
|
+
* @version 235.0.0
|
|
26527
26615
|
*/
|
|
26528
26616
|
|
|
26529
26617
|
/**
|
|
@@ -26619,7 +26707,7 @@ class ExternalContactsApi {
|
|
|
26619
26707
|
/**
|
|
26620
26708
|
* ExternalContacts service.
|
|
26621
26709
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
26622
|
-
* @version
|
|
26710
|
+
* @version 235.0.0
|
|
26623
26711
|
*/
|
|
26624
26712
|
|
|
26625
26713
|
/**
|
|
@@ -29866,7 +29954,7 @@ class FaxApi {
|
|
|
29866
29954
|
/**
|
|
29867
29955
|
* Fax service.
|
|
29868
29956
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
29869
|
-
* @version
|
|
29957
|
+
* @version 235.0.0
|
|
29870
29958
|
*/
|
|
29871
29959
|
|
|
29872
29960
|
/**
|
|
@@ -30081,7 +30169,7 @@ class FlowsApi {
|
|
|
30081
30169
|
/**
|
|
30082
30170
|
* Flows service.
|
|
30083
30171
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
30084
|
-
* @version
|
|
30172
|
+
* @version 235.0.0
|
|
30085
30173
|
*/
|
|
30086
30174
|
|
|
30087
30175
|
/**
|
|
@@ -30290,7 +30378,7 @@ class GamificationApi {
|
|
|
30290
30378
|
/**
|
|
30291
30379
|
* Gamification service.
|
|
30292
30380
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
30293
|
-
* @version
|
|
30381
|
+
* @version 235.0.0
|
|
30294
30382
|
*/
|
|
30295
30383
|
|
|
30296
30384
|
/**
|
|
@@ -30845,6 +30933,51 @@ class GamificationApi {
|
|
|
30845
30933
|
);
|
|
30846
30934
|
}
|
|
30847
30935
|
|
|
30936
|
+
/**
|
|
30937
|
+
* Query managers in a profile during a period of time
|
|
30938
|
+
*
|
|
30939
|
+
* @param {Object} filterType Filter type for the query request.
|
|
30940
|
+
* @param {String} filterId ID for the filter type.
|
|
30941
|
+
* @param {Object} granularity Granularity
|
|
30942
|
+
* @param {String} startWorkday The start work day. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
30943
|
+
* @param {Object} opts Optional parameters
|
|
30944
|
+
* @param {Number} opts.pageSize Page size (default to 100)
|
|
30945
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
30946
|
+
*/
|
|
30947
|
+
getGamificationInsightsManagers(filterType, filterId, granularity, startWorkday, opts) {
|
|
30948
|
+
opts = opts || {};
|
|
30949
|
+
|
|
30950
|
+
// verify the required parameter 'filterType' is set
|
|
30951
|
+
if (filterType === undefined || filterType === null) {
|
|
30952
|
+
throw 'Missing the required parameter "filterType" when calling getGamificationInsightsManagers';
|
|
30953
|
+
}
|
|
30954
|
+
// verify the required parameter 'filterId' is set
|
|
30955
|
+
if (filterId === undefined || filterId === null) {
|
|
30956
|
+
throw 'Missing the required parameter "filterId" when calling getGamificationInsightsManagers';
|
|
30957
|
+
}
|
|
30958
|
+
// verify the required parameter 'granularity' is set
|
|
30959
|
+
if (granularity === undefined || granularity === null) {
|
|
30960
|
+
throw 'Missing the required parameter "granularity" when calling getGamificationInsightsManagers';
|
|
30961
|
+
}
|
|
30962
|
+
// verify the required parameter 'startWorkday' is set
|
|
30963
|
+
if (startWorkday === undefined || startWorkday === null) {
|
|
30964
|
+
throw 'Missing the required parameter "startWorkday" when calling getGamificationInsightsManagers';
|
|
30965
|
+
}
|
|
30966
|
+
|
|
30967
|
+
return this.apiClient.callApi(
|
|
30968
|
+
'/api/v2/gamification/insights/managers',
|
|
30969
|
+
'GET',
|
|
30970
|
+
{ },
|
|
30971
|
+
{ 'filterType': filterType,'filterId': filterId,'granularity': granularity,'startWorkday': startWorkday,'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
30972
|
+
{ },
|
|
30973
|
+
{ },
|
|
30974
|
+
null,
|
|
30975
|
+
['PureCloud OAuth'],
|
|
30976
|
+
['application/json'],
|
|
30977
|
+
['application/json']
|
|
30978
|
+
);
|
|
30979
|
+
}
|
|
30980
|
+
|
|
30848
30981
|
/**
|
|
30849
30982
|
* Query users in a profile during a period of time
|
|
30850
30983
|
*
|
|
@@ -32803,7 +32936,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
32803
32936
|
/**
|
|
32804
32937
|
* GeneralDataProtectionRegulation service.
|
|
32805
32938
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
32806
|
-
* @version
|
|
32939
|
+
* @version 235.0.0
|
|
32807
32940
|
*/
|
|
32808
32941
|
|
|
32809
32942
|
/**
|
|
@@ -32933,7 +33066,7 @@ class GeolocationApi {
|
|
|
32933
33066
|
/**
|
|
32934
33067
|
* Geolocation service.
|
|
32935
33068
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
32936
|
-
* @version
|
|
33069
|
+
* @version 235.0.0
|
|
32937
33070
|
*/
|
|
32938
33071
|
|
|
32939
33072
|
/**
|
|
@@ -33064,7 +33197,7 @@ class GreetingsApi {
|
|
|
33064
33197
|
/**
|
|
33065
33198
|
* Greetings service.
|
|
33066
33199
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
33067
|
-
* @version
|
|
33200
|
+
* @version 235.0.0
|
|
33068
33201
|
*/
|
|
33069
33202
|
|
|
33070
33203
|
/**
|
|
@@ -33606,7 +33739,7 @@ class GroupsApi {
|
|
|
33606
33739
|
/**
|
|
33607
33740
|
* Groups service.
|
|
33608
33741
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
33609
|
-
* @version
|
|
33742
|
+
* @version 235.0.0
|
|
33610
33743
|
*/
|
|
33611
33744
|
|
|
33612
33745
|
/**
|
|
@@ -34125,7 +34258,7 @@ class IdentityProviderApi {
|
|
|
34125
34258
|
/**
|
|
34126
34259
|
* IdentityProvider service.
|
|
34127
34260
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
34128
|
-
* @version
|
|
34261
|
+
* @version 235.0.0
|
|
34129
34262
|
*/
|
|
34130
34263
|
|
|
34131
34264
|
/**
|
|
@@ -34986,7 +35119,7 @@ class InfrastructureAsCodeApi {
|
|
|
34986
35119
|
/**
|
|
34987
35120
|
* InfrastructureAsCode service.
|
|
34988
35121
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
34989
|
-
* @version
|
|
35122
|
+
* @version 235.0.0
|
|
34990
35123
|
*/
|
|
34991
35124
|
|
|
34992
35125
|
/**
|
|
@@ -35153,7 +35286,7 @@ class IntegrationsApi {
|
|
|
35153
35286
|
/**
|
|
35154
35287
|
* Integrations service.
|
|
35155
35288
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
35156
|
-
* @version
|
|
35289
|
+
* @version 235.0.0
|
|
35157
35290
|
*/
|
|
35158
35291
|
|
|
35159
35292
|
/**
|
|
@@ -37801,7 +37934,7 @@ class JourneyApi {
|
|
|
37801
37934
|
/**
|
|
37802
37935
|
* Journey service.
|
|
37803
37936
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
37804
|
-
* @version
|
|
37937
|
+
* @version 235.0.0
|
|
37805
37938
|
*/
|
|
37806
37939
|
|
|
37807
37940
|
/**
|
|
@@ -39898,7 +40031,7 @@ class KnowledgeApi {
|
|
|
39898
40031
|
/**
|
|
39899
40032
|
* Knowledge service.
|
|
39900
40033
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
39901
|
-
* @version
|
|
40034
|
+
* @version 235.0.0
|
|
39902
40035
|
*/
|
|
39903
40036
|
|
|
39904
40037
|
/**
|
|
@@ -42981,7 +43114,7 @@ class LanguageUnderstandingApi {
|
|
|
42981
43114
|
/**
|
|
42982
43115
|
* LanguageUnderstanding service.
|
|
42983
43116
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
42984
|
-
* @version
|
|
43117
|
+
* @version 235.0.0
|
|
42985
43118
|
*/
|
|
42986
43119
|
|
|
42987
43120
|
/**
|
|
@@ -44200,7 +44333,7 @@ class LanguagesApi {
|
|
|
44200
44333
|
/**
|
|
44201
44334
|
* Languages service.
|
|
44202
44335
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
44203
|
-
* @version
|
|
44336
|
+
* @version 235.0.0
|
|
44204
44337
|
*/
|
|
44205
44338
|
|
|
44206
44339
|
/**
|
|
@@ -44422,7 +44555,7 @@ class LearningApi {
|
|
|
44422
44555
|
/**
|
|
44423
44556
|
* Learning service.
|
|
44424
44557
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
44425
|
-
* @version
|
|
44558
|
+
* @version 235.0.0
|
|
44426
44559
|
*/
|
|
44427
44560
|
|
|
44428
44561
|
/**
|
|
@@ -44863,6 +44996,31 @@ class LearningApi {
|
|
|
44863
44996
|
);
|
|
44864
44997
|
}
|
|
44865
44998
|
|
|
44999
|
+
/**
|
|
45000
|
+
* Retrieve the status of the job for the slots where a learning activity can be scheduled.
|
|
45001
|
+
*
|
|
45002
|
+
* @param {String} jobId The ID of the job
|
|
45003
|
+
*/
|
|
45004
|
+
getLearningScheduleslotsJob(jobId) {
|
|
45005
|
+
// verify the required parameter 'jobId' is set
|
|
45006
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
45007
|
+
throw 'Missing the required parameter "jobId" when calling getLearningScheduleslotsJob';
|
|
45008
|
+
}
|
|
45009
|
+
|
|
45010
|
+
return this.apiClient.callApi(
|
|
45011
|
+
'/api/v2/learning/scheduleslots/jobs/{jobId}',
|
|
45012
|
+
'GET',
|
|
45013
|
+
{ 'jobId': jobId },
|
|
45014
|
+
{ },
|
|
45015
|
+
{ },
|
|
45016
|
+
{ },
|
|
45017
|
+
null,
|
|
45018
|
+
['PureCloud OAuth'],
|
|
45019
|
+
['application/json'],
|
|
45020
|
+
['application/json']
|
|
45021
|
+
);
|
|
45022
|
+
}
|
|
45023
|
+
|
|
44866
45024
|
/**
|
|
44867
45025
|
* Get Learning SCORM Result
|
|
44868
45026
|
*
|
|
@@ -45306,6 +45464,31 @@ class LearningApi {
|
|
|
45306
45464
|
);
|
|
45307
45465
|
}
|
|
45308
45466
|
|
|
45467
|
+
/**
|
|
45468
|
+
* Start job to retrieve slots where a learning activity can be scheduled.
|
|
45469
|
+
*
|
|
45470
|
+
* @param {Object} body The slots search request
|
|
45471
|
+
*/
|
|
45472
|
+
postLearningScheduleslotsJobs(body) {
|
|
45473
|
+
// verify the required parameter 'body' is set
|
|
45474
|
+
if (body === undefined || body === null) {
|
|
45475
|
+
throw 'Missing the required parameter "body" when calling postLearningScheduleslotsJobs';
|
|
45476
|
+
}
|
|
45477
|
+
|
|
45478
|
+
return this.apiClient.callApi(
|
|
45479
|
+
'/api/v2/learning/scheduleslots/jobs',
|
|
45480
|
+
'POST',
|
|
45481
|
+
{ },
|
|
45482
|
+
{ },
|
|
45483
|
+
{ },
|
|
45484
|
+
{ },
|
|
45485
|
+
body,
|
|
45486
|
+
['PureCloud OAuth'],
|
|
45487
|
+
['application/json'],
|
|
45488
|
+
['application/json']
|
|
45489
|
+
);
|
|
45490
|
+
}
|
|
45491
|
+
|
|
45309
45492
|
/**
|
|
45310
45493
|
* Get list of possible slots where a learning activity can be scheduled.
|
|
45311
45494
|
*
|
|
@@ -45455,7 +45638,7 @@ class LicenseApi {
|
|
|
45455
45638
|
/**
|
|
45456
45639
|
* License service.
|
|
45457
45640
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
45458
|
-
* @version
|
|
45641
|
+
* @version 235.0.0
|
|
45459
45642
|
*/
|
|
45460
45643
|
|
|
45461
45644
|
/**
|
|
@@ -45693,7 +45876,7 @@ class LocationsApi {
|
|
|
45693
45876
|
/**
|
|
45694
45877
|
* Locations service.
|
|
45695
45878
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
45696
|
-
* @version
|
|
45879
|
+
* @version 235.0.0
|
|
45697
45880
|
*/
|
|
45698
45881
|
|
|
45699
45882
|
/**
|
|
@@ -45929,7 +46112,7 @@ class LogCaptureApi {
|
|
|
45929
46112
|
/**
|
|
45930
46113
|
* LogCapture service.
|
|
45931
46114
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
45932
|
-
* @version
|
|
46115
|
+
* @version 235.0.0
|
|
45933
46116
|
*/
|
|
45934
46117
|
|
|
45935
46118
|
/**
|
|
@@ -46128,7 +46311,7 @@ class MessagingApi {
|
|
|
46128
46311
|
/**
|
|
46129
46312
|
* Messaging service.
|
|
46130
46313
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
46131
|
-
* @version
|
|
46314
|
+
* @version 235.0.0
|
|
46132
46315
|
*/
|
|
46133
46316
|
|
|
46134
46317
|
/**
|
|
@@ -46487,7 +46670,7 @@ class MobileDevicesApi {
|
|
|
46487
46670
|
/**
|
|
46488
46671
|
* MobileDevices service.
|
|
46489
46672
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
46490
|
-
* @version
|
|
46673
|
+
* @version 235.0.0
|
|
46491
46674
|
*/
|
|
46492
46675
|
|
|
46493
46676
|
/**
|
|
@@ -46638,7 +46821,7 @@ class NotificationsApi {
|
|
|
46638
46821
|
/**
|
|
46639
46822
|
* Notifications service.
|
|
46640
46823
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
46641
|
-
* @version
|
|
46824
|
+
* @version 235.0.0
|
|
46642
46825
|
*/
|
|
46643
46826
|
|
|
46644
46827
|
/**
|
|
@@ -46871,7 +47054,7 @@ class OAuthApi {
|
|
|
46871
47054
|
/**
|
|
46872
47055
|
* OAuth service.
|
|
46873
47056
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
46874
|
-
* @version
|
|
47057
|
+
* @version 235.0.0
|
|
46875
47058
|
*/
|
|
46876
47059
|
|
|
46877
47060
|
/**
|
|
@@ -47237,7 +47420,7 @@ class ObjectsApi {
|
|
|
47237
47420
|
/**
|
|
47238
47421
|
* Objects service.
|
|
47239
47422
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
47240
|
-
* @version
|
|
47423
|
+
* @version 235.0.0
|
|
47241
47424
|
*/
|
|
47242
47425
|
|
|
47243
47426
|
/**
|
|
@@ -47561,7 +47744,7 @@ class OperationalEventsApi {
|
|
|
47561
47744
|
/**
|
|
47562
47745
|
* OperationalEvents service.
|
|
47563
47746
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
47564
|
-
* @version
|
|
47747
|
+
* @version 235.0.0
|
|
47565
47748
|
*/
|
|
47566
47749
|
|
|
47567
47750
|
/**
|
|
@@ -47678,7 +47861,7 @@ class OrganizationApi {
|
|
|
47678
47861
|
/**
|
|
47679
47862
|
* Organization service.
|
|
47680
47863
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
47681
|
-
* @version
|
|
47864
|
+
* @version 235.0.0
|
|
47682
47865
|
*/
|
|
47683
47866
|
|
|
47684
47867
|
/**
|
|
@@ -48153,7 +48336,7 @@ class OrganizationAuthorizationApi {
|
|
|
48153
48336
|
/**
|
|
48154
48337
|
* OrganizationAuthorization service.
|
|
48155
48338
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
48156
|
-
* @version
|
|
48339
|
+
* @version 235.0.0
|
|
48157
48340
|
*/
|
|
48158
48341
|
|
|
48159
48342
|
/**
|
|
@@ -49547,7 +49730,7 @@ class OutboundApi {
|
|
|
49547
49730
|
/**
|
|
49548
49731
|
* Outbound service.
|
|
49549
49732
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
49550
|
-
* @version
|
|
49733
|
+
* @version 235.0.0
|
|
49551
49734
|
*/
|
|
49552
49735
|
|
|
49553
49736
|
/**
|
|
@@ -54294,7 +54477,7 @@ class PresenceApi {
|
|
|
54294
54477
|
/**
|
|
54295
54478
|
* Presence service.
|
|
54296
54479
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
54297
|
-
* @version
|
|
54480
|
+
* @version 235.0.0
|
|
54298
54481
|
*/
|
|
54299
54482
|
|
|
54300
54483
|
/**
|
|
@@ -55038,7 +55221,7 @@ class ProcessAutomationApi {
|
|
|
55038
55221
|
/**
|
|
55039
55222
|
* ProcessAutomation service.
|
|
55040
55223
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
55041
|
-
* @version
|
|
55224
|
+
* @version 235.0.0
|
|
55042
55225
|
*/
|
|
55043
55226
|
|
|
55044
55227
|
/**
|
|
@@ -55277,7 +55460,7 @@ class QualityApi {
|
|
|
55277
55460
|
/**
|
|
55278
55461
|
* Quality service.
|
|
55279
55462
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
55280
|
-
* @version
|
|
55463
|
+
* @version 235.0.0
|
|
55281
55464
|
*/
|
|
55282
55465
|
|
|
55283
55466
|
/**
|
|
@@ -56341,59 +56524,6 @@ class QualityApi {
|
|
|
56341
56524
|
);
|
|
56342
56525
|
}
|
|
56343
56526
|
|
|
56344
|
-
/**
|
|
56345
|
-
* Get the most recent published version of an evaluation form across any division.
|
|
56346
|
-
*
|
|
56347
|
-
* @param {String} evaluationFormId Evaluation Form ID
|
|
56348
|
-
* getQualityPublishedformsEvaluationsDivisionview is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
56349
|
-
*/
|
|
56350
|
-
getQualityPublishedformsEvaluationsDivisionview(evaluationFormId) {
|
|
56351
|
-
// verify the required parameter 'evaluationFormId' is set
|
|
56352
|
-
if (evaluationFormId === undefined || evaluationFormId === null || evaluationFormId === '') {
|
|
56353
|
-
throw 'Missing the required parameter "evaluationFormId" when calling getQualityPublishedformsEvaluationsDivisionview';
|
|
56354
|
-
}
|
|
56355
|
-
|
|
56356
|
-
return this.apiClient.callApi(
|
|
56357
|
-
'/api/v2/quality/publishedforms/evaluations/divisionviews/{evaluationFormId}',
|
|
56358
|
-
'GET',
|
|
56359
|
-
{ 'evaluationFormId': evaluationFormId },
|
|
56360
|
-
{ },
|
|
56361
|
-
{ },
|
|
56362
|
-
{ },
|
|
56363
|
-
null,
|
|
56364
|
-
['PureCloud OAuth'],
|
|
56365
|
-
['application/json'],
|
|
56366
|
-
['application/json']
|
|
56367
|
-
);
|
|
56368
|
-
}
|
|
56369
|
-
|
|
56370
|
-
/**
|
|
56371
|
-
* Get the published evaluation forms across any division.
|
|
56372
|
-
*
|
|
56373
|
-
* @param {Object} opts Optional parameters
|
|
56374
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
56375
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
56376
|
-
* @param {String} opts.name Name
|
|
56377
|
-
* getQualityPublishedformsEvaluationsDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
56378
|
-
*/
|
|
56379
|
-
getQualityPublishedformsEvaluationsDivisionviews(opts) {
|
|
56380
|
-
opts = opts || {};
|
|
56381
|
-
|
|
56382
|
-
|
|
56383
|
-
return this.apiClient.callApi(
|
|
56384
|
-
'/api/v2/quality/publishedforms/evaluations/divisionviews',
|
|
56385
|
-
'GET',
|
|
56386
|
-
{ },
|
|
56387
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'name': opts['name'] },
|
|
56388
|
-
{ },
|
|
56389
|
-
{ },
|
|
56390
|
-
null,
|
|
56391
|
-
['PureCloud OAuth'],
|
|
56392
|
-
['application/json'],
|
|
56393
|
-
['application/json']
|
|
56394
|
-
);
|
|
56395
|
-
}
|
|
56396
|
-
|
|
56397
56527
|
/**
|
|
56398
56528
|
* Get the most recent published version of a survey form.
|
|
56399
56529
|
*
|
|
@@ -56446,59 +56576,6 @@ class QualityApi {
|
|
|
56446
56576
|
);
|
|
56447
56577
|
}
|
|
56448
56578
|
|
|
56449
|
-
/**
|
|
56450
|
-
* Get the most recent published version of an enabled survey form across any division.
|
|
56451
|
-
*
|
|
56452
|
-
* @param {String} surveyFormId Survey Form ID
|
|
56453
|
-
* getQualityPublishedformsSurveysDivisionview is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
56454
|
-
*/
|
|
56455
|
-
getQualityPublishedformsSurveysDivisionview(surveyFormId) {
|
|
56456
|
-
// verify the required parameter 'surveyFormId' is set
|
|
56457
|
-
if (surveyFormId === undefined || surveyFormId === null || surveyFormId === '') {
|
|
56458
|
-
throw 'Missing the required parameter "surveyFormId" when calling getQualityPublishedformsSurveysDivisionview';
|
|
56459
|
-
}
|
|
56460
|
-
|
|
56461
|
-
return this.apiClient.callApi(
|
|
56462
|
-
'/api/v2/quality/publishedforms/surveys/divisionviews/{surveyFormId}',
|
|
56463
|
-
'GET',
|
|
56464
|
-
{ 'surveyFormId': surveyFormId },
|
|
56465
|
-
{ },
|
|
56466
|
-
{ },
|
|
56467
|
-
{ },
|
|
56468
|
-
null,
|
|
56469
|
-
['PureCloud OAuth'],
|
|
56470
|
-
['application/json'],
|
|
56471
|
-
['application/json']
|
|
56472
|
-
);
|
|
56473
|
-
}
|
|
56474
|
-
|
|
56475
|
-
/**
|
|
56476
|
-
* Get the published and enabled survey forms across any division.
|
|
56477
|
-
*
|
|
56478
|
-
* @param {Object} opts Optional parameters
|
|
56479
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
56480
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
56481
|
-
* @param {String} opts.name Name
|
|
56482
|
-
* getQualityPublishedformsSurveysDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
56483
|
-
*/
|
|
56484
|
-
getQualityPublishedformsSurveysDivisionviews(opts) {
|
|
56485
|
-
opts = opts || {};
|
|
56486
|
-
|
|
56487
|
-
|
|
56488
|
-
return this.apiClient.callApi(
|
|
56489
|
-
'/api/v2/quality/publishedforms/surveys/divisionviews',
|
|
56490
|
-
'GET',
|
|
56491
|
-
{ },
|
|
56492
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'name': opts['name'] },
|
|
56493
|
-
{ },
|
|
56494
|
-
{ },
|
|
56495
|
-
null,
|
|
56496
|
-
['PureCloud OAuth'],
|
|
56497
|
-
['application/json'],
|
|
56498
|
-
['application/json']
|
|
56499
|
-
);
|
|
56500
|
-
}
|
|
56501
|
-
|
|
56502
56579
|
/**
|
|
56503
56580
|
* Get a survey for a conversation
|
|
56504
56581
|
*
|
|
@@ -57222,7 +57299,7 @@ class RecordingApi {
|
|
|
57222
57299
|
/**
|
|
57223
57300
|
* Recording service.
|
|
57224
57301
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
57225
|
-
* @version
|
|
57302
|
+
* @version 235.0.0
|
|
57226
57303
|
*/
|
|
57227
57304
|
|
|
57228
57305
|
/**
|
|
@@ -58827,7 +58904,7 @@ class ResponseManagementApi {
|
|
|
58827
58904
|
/**
|
|
58828
58905
|
* ResponseManagement service.
|
|
58829
58906
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
58830
|
-
* @version
|
|
58907
|
+
* @version 235.0.0
|
|
58831
58908
|
*/
|
|
58832
58909
|
|
|
58833
58910
|
/**
|
|
@@ -59337,7 +59414,7 @@ class RoutingApi {
|
|
|
59337
59414
|
/**
|
|
59338
59415
|
* Routing service.
|
|
59339
59416
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
59340
|
-
* @version
|
|
59417
|
+
* @version 235.0.0
|
|
59341
59418
|
*/
|
|
59342
59419
|
|
|
59343
59420
|
/**
|
|
@@ -63820,7 +63897,7 @@ class SCIMApi {
|
|
|
63820
63897
|
/**
|
|
63821
63898
|
* SCIM service.
|
|
63822
63899
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
63823
|
-
* @version
|
|
63900
|
+
* @version 235.0.0
|
|
63824
63901
|
*/
|
|
63825
63902
|
|
|
63826
63903
|
/**
|
|
@@ -64697,7 +64774,7 @@ class ScreenRecordingApi {
|
|
|
64697
64774
|
/**
|
|
64698
64775
|
* ScreenRecording service.
|
|
64699
64776
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
64700
|
-
* @version
|
|
64777
|
+
* @version 235.0.0
|
|
64701
64778
|
*/
|
|
64702
64779
|
|
|
64703
64780
|
/**
|
|
@@ -64742,7 +64819,7 @@ class ScriptsApi {
|
|
|
64742
64819
|
/**
|
|
64743
64820
|
* Scripts service.
|
|
64744
64821
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
64745
|
-
* @version
|
|
64822
|
+
* @version 235.0.0
|
|
64746
64823
|
*/
|
|
64747
64824
|
|
|
64748
64825
|
/**
|
|
@@ -65218,7 +65295,7 @@ class SearchApi {
|
|
|
65218
65295
|
/**
|
|
65219
65296
|
* Search service.
|
|
65220
65297
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
65221
|
-
* @version
|
|
65298
|
+
* @version 235.0.0
|
|
65222
65299
|
*/
|
|
65223
65300
|
|
|
65224
65301
|
/**
|
|
@@ -65906,7 +65983,7 @@ class SettingsApi {
|
|
|
65906
65983
|
/**
|
|
65907
65984
|
* Settings service.
|
|
65908
65985
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
65909
|
-
* @version
|
|
65986
|
+
* @version 235.0.0
|
|
65910
65987
|
*/
|
|
65911
65988
|
|
|
65912
65989
|
/**
|
|
@@ -66254,7 +66331,7 @@ class SocialMediaApi {
|
|
|
66254
66331
|
/**
|
|
66255
66332
|
* SocialMedia service.
|
|
66256
66333
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
66257
|
-
* @version
|
|
66334
|
+
* @version 235.0.0
|
|
66258
66335
|
*/
|
|
66259
66336
|
|
|
66260
66337
|
/**
|
|
@@ -67849,7 +67926,7 @@ class SpeechTextAnalyticsApi {
|
|
|
67849
67926
|
/**
|
|
67850
67927
|
* SpeechTextAnalytics service.
|
|
67851
67928
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
67852
|
-
* @version
|
|
67929
|
+
* @version 235.0.0
|
|
67853
67930
|
*/
|
|
67854
67931
|
|
|
67855
67932
|
/**
|
|
@@ -69496,7 +69573,7 @@ class StationsApi {
|
|
|
69496
69573
|
/**
|
|
69497
69574
|
* Stations service.
|
|
69498
69575
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
69499
|
-
* @version
|
|
69576
|
+
* @version 235.0.0
|
|
69500
69577
|
*/
|
|
69501
69578
|
|
|
69502
69579
|
/**
|
|
@@ -69598,7 +69675,7 @@ class SuggestApi {
|
|
|
69598
69675
|
/**
|
|
69599
69676
|
* Suggest service.
|
|
69600
69677
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
69601
|
-
* @version
|
|
69678
|
+
* @version 235.0.0
|
|
69602
69679
|
*/
|
|
69603
69680
|
|
|
69604
69681
|
/**
|
|
@@ -69737,7 +69814,7 @@ class TaskManagementApi {
|
|
|
69737
69814
|
/**
|
|
69738
69815
|
* TaskManagement service.
|
|
69739
69816
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
69740
|
-
* @version
|
|
69817
|
+
* @version 235.0.0
|
|
69741
69818
|
*/
|
|
69742
69819
|
|
|
69743
69820
|
/**
|
|
@@ -71899,7 +71976,7 @@ class TeamsApi {
|
|
|
71899
71976
|
/**
|
|
71900
71977
|
* Teams service.
|
|
71901
71978
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
71902
|
-
* @version
|
|
71979
|
+
* @version 235.0.0
|
|
71903
71980
|
*/
|
|
71904
71981
|
|
|
71905
71982
|
/**
|
|
@@ -72204,7 +72281,7 @@ class TelephonyApi {
|
|
|
72204
72281
|
/**
|
|
72205
72282
|
* Telephony service.
|
|
72206
72283
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
72207
|
-
* @version
|
|
72284
|
+
* @version 235.0.0
|
|
72208
72285
|
*/
|
|
72209
72286
|
|
|
72210
72287
|
/**
|
|
@@ -72490,7 +72567,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
72490
72567
|
/**
|
|
72491
72568
|
* TelephonyProvidersEdge service.
|
|
72492
72569
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
72493
|
-
* @version
|
|
72570
|
+
* @version 235.0.0
|
|
72494
72571
|
*/
|
|
72495
72572
|
|
|
72496
72573
|
/**
|
|
@@ -75983,7 +76060,7 @@ class TextbotsApi {
|
|
|
75983
76060
|
/**
|
|
75984
76061
|
* Textbots service.
|
|
75985
76062
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
75986
|
-
* @version
|
|
76063
|
+
* @version 235.0.0
|
|
75987
76064
|
*/
|
|
75988
76065
|
|
|
75989
76066
|
/**
|
|
@@ -76112,7 +76189,7 @@ class TokensApi {
|
|
|
76112
76189
|
/**
|
|
76113
76190
|
* Tokens service.
|
|
76114
76191
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
76115
|
-
* @version
|
|
76192
|
+
* @version 235.0.0
|
|
76116
76193
|
*/
|
|
76117
76194
|
|
|
76118
76195
|
/**
|
|
@@ -76266,7 +76343,7 @@ class UploadsApi {
|
|
|
76266
76343
|
/**
|
|
76267
76344
|
* Uploads service.
|
|
76268
76345
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
76269
|
-
* @version
|
|
76346
|
+
* @version 235.0.0
|
|
76270
76347
|
*/
|
|
76271
76348
|
|
|
76272
76349
|
/**
|
|
@@ -76557,7 +76634,7 @@ class UsageApi {
|
|
|
76557
76634
|
/**
|
|
76558
76635
|
* Usage service.
|
|
76559
76636
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
76560
|
-
* @version
|
|
76637
|
+
* @version 235.0.0
|
|
76561
76638
|
*/
|
|
76562
76639
|
|
|
76563
76640
|
/**
|
|
@@ -76892,7 +76969,7 @@ class UserRecordingsApi {
|
|
|
76892
76969
|
/**
|
|
76893
76970
|
* UserRecordings service.
|
|
76894
76971
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
76895
|
-
* @version
|
|
76972
|
+
* @version 235.0.0
|
|
76896
76973
|
*/
|
|
76897
76974
|
|
|
76898
76975
|
/**
|
|
@@ -77076,7 +77153,7 @@ class UsersApi {
|
|
|
77076
77153
|
/**
|
|
77077
77154
|
* Users service.
|
|
77078
77155
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
77079
|
-
* @version
|
|
77156
|
+
* @version 235.0.0
|
|
77080
77157
|
*/
|
|
77081
77158
|
|
|
77082
77159
|
/**
|
|
@@ -80085,7 +80162,7 @@ class UtilitiesApi {
|
|
|
80085
80162
|
/**
|
|
80086
80163
|
* Utilities service.
|
|
80087
80164
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
80088
|
-
* @version
|
|
80165
|
+
* @version 235.0.0
|
|
80089
80166
|
*/
|
|
80090
80167
|
|
|
80091
80168
|
/**
|
|
@@ -80196,7 +80273,7 @@ class VoicemailApi {
|
|
|
80196
80273
|
/**
|
|
80197
80274
|
* Voicemail service.
|
|
80198
80275
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
80199
|
-
* @version
|
|
80276
|
+
* @version 235.0.0
|
|
80200
80277
|
*/
|
|
80201
80278
|
|
|
80202
80279
|
/**
|
|
@@ -80918,7 +80995,7 @@ class WebChatApi {
|
|
|
80918
80995
|
/**
|
|
80919
80996
|
* WebChat service.
|
|
80920
80997
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
80921
|
-
* @version
|
|
80998
|
+
* @version 235.0.0
|
|
80922
80999
|
*/
|
|
80923
81000
|
|
|
80924
81001
|
/**
|
|
@@ -81481,7 +81558,7 @@ class WebDeploymentsApi {
|
|
|
81481
81558
|
/**
|
|
81482
81559
|
* WebDeployments service.
|
|
81483
81560
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
81484
|
-
* @version
|
|
81561
|
+
* @version 235.0.0
|
|
81485
81562
|
*/
|
|
81486
81563
|
|
|
81487
81564
|
/**
|
|
@@ -82063,7 +82140,7 @@ class WebMessagingApi {
|
|
|
82063
82140
|
/**
|
|
82064
82141
|
* WebMessaging service.
|
|
82065
82142
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
82066
|
-
* @version
|
|
82143
|
+
* @version 235.0.0
|
|
82067
82144
|
*/
|
|
82068
82145
|
|
|
82069
82146
|
/**
|
|
@@ -82209,7 +82286,7 @@ class WidgetsApi {
|
|
|
82209
82286
|
/**
|
|
82210
82287
|
* Widgets service.
|
|
82211
82288
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
82212
|
-
* @version
|
|
82289
|
+
* @version 235.0.0
|
|
82213
82290
|
*/
|
|
82214
82291
|
|
|
82215
82292
|
/**
|
|
@@ -82360,7 +82437,7 @@ class WorkforceManagementApi {
|
|
|
82360
82437
|
/**
|
|
82361
82438
|
* WorkforceManagement service.
|
|
82362
82439
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
82363
|
-
* @version
|
|
82440
|
+
* @version 235.0.0
|
|
82364
82441
|
*/
|
|
82365
82442
|
|
|
82366
82443
|
/**
|
|
@@ -84760,6 +84837,7 @@ class WorkforceManagementApi {
|
|
|
84760
84837
|
* @param {String} forecastId The ID of the forecast
|
|
84761
84838
|
* @param {Object} opts Optional parameters
|
|
84762
84839
|
* @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
|
|
84840
|
+
* @param {Array.<String>} opts.expand Expand to include minimum staffing values in (staffing requirement response or applied to base staffing requirement values)
|
|
84763
84841
|
*/
|
|
84764
84842
|
getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement(businessUnitId, weekDateId, forecastId, opts) {
|
|
84765
84843
|
opts = opts || {};
|
|
@@ -84781,7 +84859,7 @@ class WorkforceManagementApi {
|
|
|
84781
84859
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/staffingrequirement',
|
|
84782
84860
|
'GET',
|
|
84783
84861
|
{ 'businessUnitId': businessUnitId,'weekDateId': weekDateId,'forecastId': forecastId },
|
|
84784
|
-
{ 'weekNumbers': this.apiClient.buildCollectionParam(opts['weekNumbers'], 'multi') },
|
|
84862
|
+
{ 'weekNumbers': this.apiClient.buildCollectionParam(opts['weekNumbers'], 'multi'),'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
84785
84863
|
{ },
|
|
84786
84864
|
{ },
|
|
84787
84865
|
null,
|
|
@@ -90360,7 +90438,7 @@ class WorkforceManagementApi {
|
|
|
90360
90438
|
* </pre>
|
|
90361
90439
|
* </p>
|
|
90362
90440
|
* @module purecloud-platform-client-v2/index
|
|
90363
|
-
* @version
|
|
90441
|
+
* @version 235.0.0
|
|
90364
90442
|
*/
|
|
90365
90443
|
class platformClient {
|
|
90366
90444
|
constructor() {
|