purecloud-platform-client-v2 233.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 +503 -1079
- package/dist/web-amd/purecloud-platform-client-v2.js +503 -1079
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +233 -409
- package/dist/web-cjs/purecloud-platform-client-v2.js +233 -409
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +475 -382
- 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 -30
- 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 +42 -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 +61 -880
- 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 +26 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +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 +156 -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 -31
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +7 -3
- 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 +2 -2
- 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 235.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 235.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 235.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 235.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 235.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 235.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 235.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 235.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 235.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 235.0.0
|
|
11772
11816
|
*/
|
|
11773
11817
|
|
|
11774
11818
|
/**
|
|
@@ -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 235.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 235.0.0
|
|
13743
13787
|
*/
|
|
13744
13788
|
|
|
13745
13789
|
/**
|
|
@@ -13760,7 +13804,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13760
13804
|
* @param {String} tableId Table ID
|
|
13761
13805
|
* @param {Object} opts Optional parameters
|
|
13762
13806
|
* @param {Boolean} opts.forceDelete Force delete decision table (under certain conditions) (default to false)
|
|
13763
|
-
* deleteBusinessrulesDecisiontable is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13764
13807
|
*/
|
|
13765
13808
|
deleteBusinessrulesDecisiontable(tableId, opts) {
|
|
13766
13809
|
opts = opts || {};
|
|
@@ -13789,7 +13832,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13789
13832
|
*
|
|
13790
13833
|
* @param {String} tableId Table ID
|
|
13791
13834
|
* @param {Number} tableVersion Table Version
|
|
13792
|
-
* deleteBusinessrulesDecisiontableVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13793
13835
|
*/
|
|
13794
13836
|
deleteBusinessrulesDecisiontableVersion(tableId, tableVersion) {
|
|
13795
13837
|
// verify the required parameter 'tableId' is set
|
|
@@ -13821,7 +13863,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13821
13863
|
* @param {String} tableId Table ID
|
|
13822
13864
|
* @param {Number} tableVersion Table Version
|
|
13823
13865
|
* @param {String} rowId Row ID
|
|
13824
|
-
* deleteBusinessrulesDecisiontableVersionRow is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13825
13866
|
*/
|
|
13826
13867
|
deleteBusinessrulesDecisiontableVersionRow(tableId, tableVersion, rowId) {
|
|
13827
13868
|
// verify the required parameter 'tableId' is set
|
|
@@ -13855,7 +13896,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13855
13896
|
* Delete a schema
|
|
13856
13897
|
*
|
|
13857
13898
|
* @param {String} schemaId Schema ID
|
|
13858
|
-
* deleteBusinessrulesSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13859
13899
|
*/
|
|
13860
13900
|
deleteBusinessrulesSchema(schemaId) {
|
|
13861
13901
|
// verify the required parameter 'schemaId' is set
|
|
@@ -13881,7 +13921,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13881
13921
|
* Get a decision table
|
|
13882
13922
|
*
|
|
13883
13923
|
* @param {String} tableId Table ID
|
|
13884
|
-
* getBusinessrulesDecisiontable is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13885
13924
|
*/
|
|
13886
13925
|
getBusinessrulesDecisiontable(tableId) {
|
|
13887
13926
|
// verify the required parameter 'tableId' is set
|
|
@@ -13908,7 +13947,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13908
13947
|
*
|
|
13909
13948
|
* @param {String} tableId Table ID
|
|
13910
13949
|
* @param {Number} tableVersion Table Version
|
|
13911
|
-
* getBusinessrulesDecisiontableVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13912
13950
|
*/
|
|
13913
13951
|
getBusinessrulesDecisiontableVersion(tableId, tableVersion) {
|
|
13914
13952
|
// verify the required parameter 'tableId' is set
|
|
@@ -13940,7 +13978,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13940
13978
|
* @param {String} tableId Table ID
|
|
13941
13979
|
* @param {Number} tableVersion Table Version
|
|
13942
13980
|
* @param {String} rowId Row ID
|
|
13943
|
-
* getBusinessrulesDecisiontableVersionRow is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13944
13981
|
*/
|
|
13945
13982
|
getBusinessrulesDecisiontableVersionRow(tableId, tableVersion, rowId) {
|
|
13946
13983
|
// verify the required parameter 'tableId' is set
|
|
@@ -13978,7 +14015,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13978
14015
|
* @param {Object} opts Optional parameters
|
|
13979
14016
|
* @param {String} opts.pageNumber Page number of the entities to return. Defaults to 1.
|
|
13980
14017
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 100. Defaults to 25.
|
|
13981
|
-
* getBusinessrulesDecisiontableVersionRows is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13982
14018
|
*/
|
|
13983
14019
|
getBusinessrulesDecisiontableVersionRows(tableId, tableVersion, opts) {
|
|
13984
14020
|
opts = opts || {};
|
|
@@ -14013,7 +14049,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14013
14049
|
* @param {Object} opts Optional parameters
|
|
14014
14050
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
14015
14051
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 100.
|
|
14016
|
-
* getBusinessrulesDecisiontableVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14017
14052
|
*/
|
|
14018
14053
|
getBusinessrulesDecisiontableVersions(tableId, opts) {
|
|
14019
14054
|
opts = opts || {};
|
|
@@ -14045,7 +14080,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14045
14080
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 100.
|
|
14046
14081
|
* @param {Array.<String>} opts.divisionIds One or more comma separated divisions to filters decision tables by. If nothing is provided, the decision tables associated with the list of divisions that the user has access to will be returned.
|
|
14047
14082
|
* @param {String} opts.name Search for decision tables with a name that contains the given search string. Search is case insensitive and will match any table that contains this string in any part of the name.
|
|
14048
|
-
* getBusinessrulesDecisiontables is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14049
14083
|
*/
|
|
14050
14084
|
getBusinessrulesDecisiontables(opts) {
|
|
14051
14085
|
opts = opts || {};
|
|
@@ -14076,7 +14110,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14076
14110
|
* @param {Boolean} opts.withPublishedVersion Filters results to only decision tables that have at least one version in Published status
|
|
14077
14111
|
* @param {Array.<String>} opts.expand Fields to expand in response
|
|
14078
14112
|
* @param {Array.<String>} opts.ids Decision table IDs to search for
|
|
14079
|
-
* getBusinessrulesDecisiontablesSearch is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14080
14113
|
*/
|
|
14081
14114
|
getBusinessrulesDecisiontablesSearch(opts) {
|
|
14082
14115
|
opts = opts || {};
|
|
@@ -14100,7 +14133,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14100
14133
|
* Get a schema
|
|
14101
14134
|
*
|
|
14102
14135
|
* @param {String} schemaId Schema ID
|
|
14103
|
-
* getBusinessrulesSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14104
14136
|
*/
|
|
14105
14137
|
getBusinessrulesSchema(schemaId) {
|
|
14106
14138
|
// verify the required parameter 'schemaId' is set
|
|
@@ -14125,7 +14157,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14125
14157
|
/**
|
|
14126
14158
|
* Get a list of schemas.
|
|
14127
14159
|
*
|
|
14128
|
-
* getBusinessrulesSchemas is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14129
14160
|
*/
|
|
14130
14161
|
getBusinessrulesSchemas() {
|
|
14131
14162
|
|
|
@@ -14147,7 +14178,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14147
14178
|
* Get a specific named core type.
|
|
14148
14179
|
*
|
|
14149
14180
|
* @param {String} coreTypeName The core type's name
|
|
14150
|
-
* getBusinessrulesSchemasCoretype is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14151
14181
|
*/
|
|
14152
14182
|
getBusinessrulesSchemasCoretype(coreTypeName) {
|
|
14153
14183
|
// verify the required parameter 'coreTypeName' is set
|
|
@@ -14172,7 +14202,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14172
14202
|
/**
|
|
14173
14203
|
* Get the core types from which all schemas are built.
|
|
14174
14204
|
*
|
|
14175
|
-
* getBusinessrulesSchemasCoretypes is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14176
14205
|
*/
|
|
14177
14206
|
getBusinessrulesSchemasCoretypes() {
|
|
14178
14207
|
|
|
@@ -14195,7 +14224,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14195
14224
|
*
|
|
14196
14225
|
* @param {String} tableId Table ID
|
|
14197
14226
|
* @param {Object} body Decision Table
|
|
14198
|
-
* patchBusinessrulesDecisiontable is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14199
14227
|
*/
|
|
14200
14228
|
patchBusinessrulesDecisiontable(tableId, body) {
|
|
14201
14229
|
// verify the required parameter 'tableId' is set
|
|
@@ -14227,7 +14255,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14227
14255
|
* @param {String} tableId Table ID
|
|
14228
14256
|
* @param {Number} tableVersion Table Version
|
|
14229
14257
|
* @param {Object} body Decision Table
|
|
14230
|
-
* patchBusinessrulesDecisiontableVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14231
14258
|
*/
|
|
14232
14259
|
patchBusinessrulesDecisiontableVersion(tableId, tableVersion, body) {
|
|
14233
14260
|
// verify the required parameter 'tableId' is set
|
|
@@ -14262,7 +14289,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14262
14289
|
*
|
|
14263
14290
|
* @param {String} tableId Table ID
|
|
14264
14291
|
* @param {Object} body Decision Table
|
|
14265
|
-
* postBusinessrulesDecisiontableExecute is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14266
14292
|
*/
|
|
14267
14293
|
postBusinessrulesDecisiontableExecute(tableId, body) {
|
|
14268
14294
|
// verify the required parameter 'tableId' is set
|
|
@@ -14294,7 +14320,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14294
14320
|
* @param {String} tableId Table ID
|
|
14295
14321
|
* @param {Number} tableVersion Table Version
|
|
14296
14322
|
* @param {Object} body Decision Table
|
|
14297
|
-
* postBusinessrulesDecisiontableVersionCopy is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14298
14323
|
*/
|
|
14299
14324
|
postBusinessrulesDecisiontableVersionCopy(tableId, tableVersion, body) {
|
|
14300
14325
|
// verify the required parameter 'tableId' is set
|
|
@@ -14330,7 +14355,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14330
14355
|
* @param {String} tableId Table ID
|
|
14331
14356
|
* @param {Number} tableVersion Table Version
|
|
14332
14357
|
* @param {Object} body Decision Table
|
|
14333
|
-
* postBusinessrulesDecisiontableVersionExecute is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14334
14358
|
*/
|
|
14335
14359
|
postBusinessrulesDecisiontableVersionExecute(tableId, tableVersion, body) {
|
|
14336
14360
|
// verify the required parameter 'tableId' is set
|
|
@@ -14366,7 +14390,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14366
14390
|
* @param {String} tableId Table ID
|
|
14367
14391
|
* @param {Number} tableVersion Table Version
|
|
14368
14392
|
* @param {Object} body Create decision table row request
|
|
14369
|
-
* postBusinessrulesDecisiontableVersionRows is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14370
14393
|
*/
|
|
14371
14394
|
postBusinessrulesDecisiontableVersionRows(tableId, tableVersion, body) {
|
|
14372
14395
|
// verify the required parameter 'tableId' is set
|
|
@@ -14405,7 +14428,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14405
14428
|
* @param {Object} opts Optional parameters
|
|
14406
14429
|
* @param {String} opts.pageNumber Page number of the entities to return. Defaults to 1.
|
|
14407
14430
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 100. Defaults to 25.
|
|
14408
|
-
* postBusinessrulesDecisiontableVersionRowsSearch is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14409
14431
|
*/
|
|
14410
14432
|
postBusinessrulesDecisiontableVersionRowsSearch(tableId, tableVersion, body, opts) {
|
|
14411
14433
|
opts = opts || {};
|
|
@@ -14442,7 +14464,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14442
14464
|
*
|
|
14443
14465
|
* @param {String} tableId Table ID
|
|
14444
14466
|
* @param {Number} tableVersion Table Version
|
|
14445
|
-
* postBusinessrulesDecisiontableVersionSync is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14446
14467
|
*/
|
|
14447
14468
|
postBusinessrulesDecisiontableVersionSync(tableId, tableVersion) {
|
|
14448
14469
|
// verify the required parameter 'tableId' is set
|
|
@@ -14472,7 +14493,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14472
14493
|
* Create a new decision table version
|
|
14473
14494
|
*
|
|
14474
14495
|
* @param {String} tableId Table ID
|
|
14475
|
-
* postBusinessrulesDecisiontableVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14476
14496
|
*/
|
|
14477
14497
|
postBusinessrulesDecisiontableVersions(tableId) {
|
|
14478
14498
|
// verify the required parameter 'tableId' is set
|
|
@@ -14498,7 +14518,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14498
14518
|
* Create a decision table
|
|
14499
14519
|
*
|
|
14500
14520
|
* @param {Object} body Decision Table
|
|
14501
|
-
* postBusinessrulesDecisiontables is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14502
14521
|
*/
|
|
14503
14522
|
postBusinessrulesDecisiontables(body) {
|
|
14504
14523
|
// verify the required parameter 'body' is set
|
|
@@ -14524,7 +14543,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14524
14543
|
* Create a schema
|
|
14525
14544
|
*
|
|
14526
14545
|
* @param {Object} body Business Rules Schema Create Request
|
|
14527
|
-
* postBusinessrulesSchemas is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14528
14546
|
*/
|
|
14529
14547
|
postBusinessrulesSchemas(body) {
|
|
14530
14548
|
// verify the required parameter 'body' is set
|
|
@@ -14551,7 +14569,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14551
14569
|
*
|
|
14552
14570
|
* @param {String} tableId Table ID
|
|
14553
14571
|
* @param {Number} tableVersion Table Version
|
|
14554
|
-
* putBusinessrulesDecisiontableVersionPublish is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14555
14572
|
*/
|
|
14556
14573
|
putBusinessrulesDecisiontableVersionPublish(tableId, tableVersion) {
|
|
14557
14574
|
// verify the required parameter 'tableId' is set
|
|
@@ -14584,7 +14601,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14584
14601
|
* @param {Number} tableVersion Table Version
|
|
14585
14602
|
* @param {String} rowId Row ID
|
|
14586
14603
|
* @param {Object} body Full update decision table row request
|
|
14587
|
-
* putBusinessrulesDecisiontableVersionRow is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14588
14604
|
*/
|
|
14589
14605
|
putBusinessrulesDecisiontableVersionRow(tableId, tableVersion, rowId, body) {
|
|
14590
14606
|
// verify the required parameter 'tableId' is set
|
|
@@ -14623,7 +14639,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14623
14639
|
*
|
|
14624
14640
|
* @param {String} schemaId Schema ID
|
|
14625
14641
|
* @param {Object} body Business Rules Schema Update Request
|
|
14626
|
-
* putBusinessrulesSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14627
14642
|
*/
|
|
14628
14643
|
putBusinessrulesSchema(schemaId, body) {
|
|
14629
14644
|
// verify the required parameter 'schemaId' is set
|
|
@@ -14655,7 +14670,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14655
14670
|
/**
|
|
14656
14671
|
* CarrierServices service.
|
|
14657
14672
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
14658
|
-
* @version
|
|
14673
|
+
* @version 235.0.0
|
|
14659
14674
|
*/
|
|
14660
14675
|
|
|
14661
14676
|
/**
|
|
@@ -14725,7 +14740,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14725
14740
|
/**
|
|
14726
14741
|
* Chat service.
|
|
14727
14742
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
14728
|
-
* @version
|
|
14743
|
+
* @version 235.0.0
|
|
14729
14744
|
*/
|
|
14730
14745
|
|
|
14731
14746
|
/**
|
|
@@ -15706,7 +15721,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15706
15721
|
/**
|
|
15707
15722
|
* Coaching service.
|
|
15708
15723
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
15709
|
-
* @version
|
|
15724
|
+
* @version 235.0.0
|
|
15710
15725
|
*/
|
|
15711
15726
|
|
|
15712
15727
|
/**
|
|
@@ -16017,6 +16032,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16017
16032
|
);
|
|
16018
16033
|
}
|
|
16019
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
|
+
|
|
16020
16060
|
/**
|
|
16021
16061
|
* Update an existing appointment
|
|
16022
16062
|
* Permission not required if you are the creator or facilitator of the appointment
|
|
@@ -16252,6 +16292,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16252
16292
|
);
|
|
16253
16293
|
}
|
|
16254
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
|
+
|
|
16255
16320
|
/**
|
|
16256
16321
|
* Get list of possible slots where a coaching appointment can be scheduled.
|
|
16257
16322
|
*
|
|
@@ -16283,7 +16348,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16283
16348
|
/**
|
|
16284
16349
|
* ContentManagement service.
|
|
16285
16350
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
16286
|
-
* @version
|
|
16351
|
+
* @version 235.0.0
|
|
16287
16352
|
*/
|
|
16288
16353
|
|
|
16289
16354
|
/**
|
|
@@ -17364,7 +17429,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17364
17429
|
/**
|
|
17365
17430
|
* Conversations service.
|
|
17366
17431
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
17367
|
-
* @version
|
|
17432
|
+
* @version 235.0.0
|
|
17368
17433
|
*/
|
|
17369
17434
|
|
|
17370
17435
|
/**
|
|
@@ -18036,7 +18101,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18036
18101
|
* @param {String} conversationId conversationId
|
|
18037
18102
|
* @param {String} communicationId communicationId
|
|
18038
18103
|
* @param {String} messageId messageId
|
|
18039
|
-
* getConversationCommunicationInternalmessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18040
18104
|
*/
|
|
18041
18105
|
getConversationCommunicationInternalmessage(conversationId, communicationId, messageId) {
|
|
18042
18106
|
// verify the required parameter 'conversationId' is set
|
|
@@ -18074,7 +18138,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18074
18138
|
* @param {Object} opts Optional parameters
|
|
18075
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)
|
|
18076
18140
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
18077
|
-
* getConversationCommunicationInternalmessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18078
18141
|
*/
|
|
18079
18142
|
getConversationCommunicationInternalmessages(conversationId, communicationId, opts) {
|
|
18080
18143
|
opts = opts || {};
|
|
@@ -19336,7 +19399,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19336
19399
|
* Get internal message conversation
|
|
19337
19400
|
*
|
|
19338
19401
|
* @param {String} conversationId conversationId
|
|
19339
|
-
* getConversationsInternalmessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
19340
19402
|
*/
|
|
19341
19403
|
getConversationsInternalmessage(conversationId) {
|
|
19342
19404
|
// verify the required parameter 'conversationId' is set
|
|
@@ -19361,7 +19423,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19361
19423
|
/**
|
|
19362
19424
|
* Get active internal message conversations for the logged in user
|
|
19363
19425
|
*
|
|
19364
|
-
* getConversationsInternalmessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
19365
19426
|
*/
|
|
19366
19427
|
getConversationsInternalmessages() {
|
|
19367
19428
|
|
|
@@ -21183,6 +21244,46 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21183
21244
|
);
|
|
21184
21245
|
}
|
|
21185
21246
|
|
|
21247
|
+
/**
|
|
21248
|
+
* Update conversation participant on behalf of a user
|
|
21249
|
+
*
|
|
21250
|
+
* @param {String} conversationId conversationId
|
|
21251
|
+
* @param {String} participantId participantId
|
|
21252
|
+
* @param {String} userId userId
|
|
21253
|
+
* @param {Object} body Participant request
|
|
21254
|
+
*/
|
|
21255
|
+
patchConversationsCallParticipantUserUserId(conversationId, participantId, userId, body) {
|
|
21256
|
+
// verify the required parameter 'conversationId' is set
|
|
21257
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
21258
|
+
throw 'Missing the required parameter "conversationId" when calling patchConversationsCallParticipantUserUserId';
|
|
21259
|
+
}
|
|
21260
|
+
// verify the required parameter 'participantId' is set
|
|
21261
|
+
if (participantId === undefined || participantId === null || participantId === '') {
|
|
21262
|
+
throw 'Missing the required parameter "participantId" when calling patchConversationsCallParticipantUserUserId';
|
|
21263
|
+
}
|
|
21264
|
+
// verify the required parameter 'userId' is set
|
|
21265
|
+
if (userId === undefined || userId === null || userId === '') {
|
|
21266
|
+
throw 'Missing the required parameter "userId" when calling patchConversationsCallParticipantUserUserId';
|
|
21267
|
+
}
|
|
21268
|
+
// verify the required parameter 'body' is set
|
|
21269
|
+
if (body === undefined || body === null) {
|
|
21270
|
+
throw 'Missing the required parameter "body" when calling patchConversationsCallParticipantUserUserId';
|
|
21271
|
+
}
|
|
21272
|
+
|
|
21273
|
+
return this.apiClient.callApi(
|
|
21274
|
+
'/api/v2/conversations/calls/{conversationId}/participants/{participantId}/user/{userId}',
|
|
21275
|
+
'PATCH',
|
|
21276
|
+
{ 'conversationId': conversationId,'participantId': participantId,'userId': userId },
|
|
21277
|
+
{ },
|
|
21278
|
+
{ },
|
|
21279
|
+
{ },
|
|
21280
|
+
body,
|
|
21281
|
+
['PureCloud OAuth'],
|
|
21282
|
+
['application/json'],
|
|
21283
|
+
['application/json']
|
|
21284
|
+
);
|
|
21285
|
+
}
|
|
21286
|
+
|
|
21186
21287
|
/**
|
|
21187
21288
|
* Update a conversation by disconnecting all of the participants
|
|
21188
21289
|
*
|
|
@@ -22520,7 +22621,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22520
22621
|
* @param {String} conversationId conversationId
|
|
22521
22622
|
* @param {String} communicationId communicationId
|
|
22522
22623
|
* @param {Object} body Message
|
|
22523
|
-
* postConversationCommunicationInternalmessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
22524
22624
|
*/
|
|
22525
22625
|
postConversationCommunicationInternalmessages(conversationId, communicationId, body) {
|
|
22526
22626
|
// verify the required parameter 'conversationId' is set
|
|
@@ -22649,7 +22749,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22649
22749
|
* @param {String} conversationId conversation ID
|
|
22650
22750
|
* @param {String} participantId participant ID
|
|
22651
22751
|
* @param {Object} body Confer request
|
|
22652
|
-
* postConversationParticipantInternalmessagesUsersCommunications is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
22653
22752
|
*/
|
|
22654
22753
|
postConversationParticipantInternalmessagesUsersCommunications(conversationId, participantId, body) {
|
|
22655
22754
|
// verify the required parameter 'conversationId' is set
|
|
@@ -24559,7 +24658,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24559
24658
|
|
|
24560
24659
|
/**
|
|
24561
24660
|
* Get messages in batch
|
|
24562
|
-
* 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"]
|
|
24661
|
+
* 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.
|
|
24563
24662
|
* @param {String} conversationId
|
|
24564
24663
|
* @param {Object} opts Optional parameters
|
|
24565
24664
|
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media) (default to false)
|
|
@@ -25921,7 +26020,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25921
26020
|
/**
|
|
25922
26021
|
* DataExtensions service.
|
|
25923
26022
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
25924
|
-
* @version
|
|
26023
|
+
* @version 235.0.0
|
|
25925
26024
|
*/
|
|
25926
26025
|
|
|
25927
26026
|
/**
|
|
@@ -26007,7 +26106,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26007
26106
|
/**
|
|
26008
26107
|
* DataPrivacy service.
|
|
26009
26108
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
26010
|
-
* @version
|
|
26109
|
+
* @version 235.0.0
|
|
26011
26110
|
*/
|
|
26012
26111
|
|
|
26013
26112
|
/**
|
|
@@ -26177,7 +26276,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26177
26276
|
/**
|
|
26178
26277
|
* Downloads service.
|
|
26179
26278
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
26180
|
-
* @version
|
|
26279
|
+
* @version 235.0.0
|
|
26181
26280
|
*/
|
|
26182
26281
|
|
|
26183
26282
|
/**
|
|
@@ -26229,7 +26328,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26229
26328
|
/**
|
|
26230
26329
|
* Emails service.
|
|
26231
26330
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
26232
|
-
* @version
|
|
26331
|
+
* @version 235.0.0
|
|
26233
26332
|
*/
|
|
26234
26333
|
|
|
26235
26334
|
/**
|
|
@@ -26358,7 +26457,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26358
26457
|
/**
|
|
26359
26458
|
* EmployeeEngagement service.
|
|
26360
26459
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
26361
|
-
* @version
|
|
26460
|
+
* @version 235.0.0
|
|
26362
26461
|
*/
|
|
26363
26462
|
|
|
26364
26463
|
/**
|
|
@@ -26509,7 +26608,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26509
26608
|
/**
|
|
26510
26609
|
* Events service.
|
|
26511
26610
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
26512
|
-
* @version
|
|
26611
|
+
* @version 235.0.0
|
|
26513
26612
|
*/
|
|
26514
26613
|
|
|
26515
26614
|
/**
|
|
@@ -26605,7 +26704,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26605
26704
|
/**
|
|
26606
26705
|
* ExternalContacts service.
|
|
26607
26706
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
26608
|
-
* @version
|
|
26707
|
+
* @version 235.0.0
|
|
26609
26708
|
*/
|
|
26610
26709
|
|
|
26611
26710
|
/**
|
|
@@ -29852,7 +29951,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29852
29951
|
/**
|
|
29853
29952
|
* Fax service.
|
|
29854
29953
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
29855
|
-
* @version
|
|
29954
|
+
* @version 235.0.0
|
|
29856
29955
|
*/
|
|
29857
29956
|
|
|
29858
29957
|
/**
|
|
@@ -30067,7 +30166,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30067
30166
|
/**
|
|
30068
30167
|
* Flows service.
|
|
30069
30168
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
30070
|
-
* @version
|
|
30169
|
+
* @version 235.0.0
|
|
30071
30170
|
*/
|
|
30072
30171
|
|
|
30073
30172
|
/**
|
|
@@ -30276,7 +30375,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30276
30375
|
/**
|
|
30277
30376
|
* Gamification service.
|
|
30278
30377
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
30279
|
-
* @version
|
|
30378
|
+
* @version 235.0.0
|
|
30280
30379
|
*/
|
|
30281
30380
|
|
|
30282
30381
|
/**
|
|
@@ -30831,6 +30930,51 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30831
30930
|
);
|
|
30832
30931
|
}
|
|
30833
30932
|
|
|
30933
|
+
/**
|
|
30934
|
+
* Query managers in a profile during a period of time
|
|
30935
|
+
*
|
|
30936
|
+
* @param {Object} filterType Filter type for the query request.
|
|
30937
|
+
* @param {String} filterId ID for the filter type.
|
|
30938
|
+
* @param {Object} granularity Granularity
|
|
30939
|
+
* @param {String} startWorkday The start work day. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
30940
|
+
* @param {Object} opts Optional parameters
|
|
30941
|
+
* @param {Number} opts.pageSize Page size (default to 100)
|
|
30942
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
30943
|
+
*/
|
|
30944
|
+
getGamificationInsightsManagers(filterType, filterId, granularity, startWorkday, opts) {
|
|
30945
|
+
opts = opts || {};
|
|
30946
|
+
|
|
30947
|
+
// verify the required parameter 'filterType' is set
|
|
30948
|
+
if (filterType === undefined || filterType === null) {
|
|
30949
|
+
throw 'Missing the required parameter "filterType" when calling getGamificationInsightsManagers';
|
|
30950
|
+
}
|
|
30951
|
+
// verify the required parameter 'filterId' is set
|
|
30952
|
+
if (filterId === undefined || filterId === null) {
|
|
30953
|
+
throw 'Missing the required parameter "filterId" when calling getGamificationInsightsManagers';
|
|
30954
|
+
}
|
|
30955
|
+
// verify the required parameter 'granularity' is set
|
|
30956
|
+
if (granularity === undefined || granularity === null) {
|
|
30957
|
+
throw 'Missing the required parameter "granularity" when calling getGamificationInsightsManagers';
|
|
30958
|
+
}
|
|
30959
|
+
// verify the required parameter 'startWorkday' is set
|
|
30960
|
+
if (startWorkday === undefined || startWorkday === null) {
|
|
30961
|
+
throw 'Missing the required parameter "startWorkday" when calling getGamificationInsightsManagers';
|
|
30962
|
+
}
|
|
30963
|
+
|
|
30964
|
+
return this.apiClient.callApi(
|
|
30965
|
+
'/api/v2/gamification/insights/managers',
|
|
30966
|
+
'GET',
|
|
30967
|
+
{ },
|
|
30968
|
+
{ 'filterType': filterType,'filterId': filterId,'granularity': granularity,'startWorkday': startWorkday,'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
30969
|
+
{ },
|
|
30970
|
+
{ },
|
|
30971
|
+
null,
|
|
30972
|
+
['PureCloud OAuth'],
|
|
30973
|
+
['application/json'],
|
|
30974
|
+
['application/json']
|
|
30975
|
+
);
|
|
30976
|
+
}
|
|
30977
|
+
|
|
30834
30978
|
/**
|
|
30835
30979
|
* Query users in a profile during a period of time
|
|
30836
30980
|
*
|
|
@@ -32789,7 +32933,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32789
32933
|
/**
|
|
32790
32934
|
* GeneralDataProtectionRegulation service.
|
|
32791
32935
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
32792
|
-
* @version
|
|
32936
|
+
* @version 235.0.0
|
|
32793
32937
|
*/
|
|
32794
32938
|
|
|
32795
32939
|
/**
|
|
@@ -32919,7 +33063,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32919
33063
|
/**
|
|
32920
33064
|
* Geolocation service.
|
|
32921
33065
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
32922
|
-
* @version
|
|
33066
|
+
* @version 235.0.0
|
|
32923
33067
|
*/
|
|
32924
33068
|
|
|
32925
33069
|
/**
|
|
@@ -33050,7 +33194,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33050
33194
|
/**
|
|
33051
33195
|
* Greetings service.
|
|
33052
33196
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
33053
|
-
* @version
|
|
33197
|
+
* @version 235.0.0
|
|
33054
33198
|
*/
|
|
33055
33199
|
|
|
33056
33200
|
/**
|
|
@@ -33592,7 +33736,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33592
33736
|
/**
|
|
33593
33737
|
* Groups service.
|
|
33594
33738
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
33595
|
-
* @version
|
|
33739
|
+
* @version 235.0.0
|
|
33596
33740
|
*/
|
|
33597
33741
|
|
|
33598
33742
|
/**
|
|
@@ -34111,7 +34255,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34111
34255
|
/**
|
|
34112
34256
|
* IdentityProvider service.
|
|
34113
34257
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
34114
|
-
* @version
|
|
34258
|
+
* @version 235.0.0
|
|
34115
34259
|
*/
|
|
34116
34260
|
|
|
34117
34261
|
/**
|
|
@@ -34972,7 +35116,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34972
35116
|
/**
|
|
34973
35117
|
* InfrastructureAsCode service.
|
|
34974
35118
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
34975
|
-
* @version
|
|
35119
|
+
* @version 235.0.0
|
|
34976
35120
|
*/
|
|
34977
35121
|
|
|
34978
35122
|
/**
|
|
@@ -35139,7 +35283,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35139
35283
|
/**
|
|
35140
35284
|
* Integrations service.
|
|
35141
35285
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
35142
|
-
* @version
|
|
35286
|
+
* @version 235.0.0
|
|
35143
35287
|
*/
|
|
35144
35288
|
|
|
35145
35289
|
/**
|
|
@@ -37787,7 +37931,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37787
37931
|
/**
|
|
37788
37932
|
* Journey service.
|
|
37789
37933
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
37790
|
-
* @version
|
|
37934
|
+
* @version 235.0.0
|
|
37791
37935
|
*/
|
|
37792
37936
|
|
|
37793
37937
|
/**
|
|
@@ -39884,7 +40028,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39884
40028
|
/**
|
|
39885
40029
|
* Knowledge service.
|
|
39886
40030
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
39887
|
-
* @version
|
|
40031
|
+
* @version 235.0.0
|
|
39888
40032
|
*/
|
|
39889
40033
|
|
|
39890
40034
|
/**
|
|
@@ -40109,114 +40253,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40109
40253
|
);
|
|
40110
40254
|
}
|
|
40111
40255
|
|
|
40112
|
-
/**
|
|
40113
|
-
* Delete category
|
|
40114
|
-
*
|
|
40115
|
-
* @param {String} categoryId Category ID
|
|
40116
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
40117
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
40118
|
-
* @deprecated
|
|
40119
|
-
*/
|
|
40120
|
-
deleteKnowledgeKnowledgebaseLanguageCategory(categoryId, knowledgeBaseId, languageCode) {
|
|
40121
|
-
// verify the required parameter 'categoryId' is set
|
|
40122
|
-
if (categoryId === undefined || categoryId === null || categoryId === '') {
|
|
40123
|
-
throw 'Missing the required parameter "categoryId" when calling deleteKnowledgeKnowledgebaseLanguageCategory';
|
|
40124
|
-
}
|
|
40125
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
40126
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
40127
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseLanguageCategory';
|
|
40128
|
-
}
|
|
40129
|
-
// verify the required parameter 'languageCode' is set
|
|
40130
|
-
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
40131
|
-
throw 'Missing the required parameter "languageCode" when calling deleteKnowledgeKnowledgebaseLanguageCategory';
|
|
40132
|
-
}
|
|
40133
|
-
|
|
40134
|
-
return this.apiClient.callApi(
|
|
40135
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories/{categoryId}',
|
|
40136
|
-
'DELETE',
|
|
40137
|
-
{ 'categoryId': categoryId,'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
|
|
40138
|
-
{ },
|
|
40139
|
-
{ },
|
|
40140
|
-
{ },
|
|
40141
|
-
null,
|
|
40142
|
-
['PureCloud OAuth'],
|
|
40143
|
-
['application/json'],
|
|
40144
|
-
['application/json']
|
|
40145
|
-
);
|
|
40146
|
-
}
|
|
40147
|
-
|
|
40148
|
-
/**
|
|
40149
|
-
* Delete document
|
|
40150
|
-
*
|
|
40151
|
-
* @param {String} documentId Document ID
|
|
40152
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
40153
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
40154
|
-
* @deprecated
|
|
40155
|
-
*/
|
|
40156
|
-
deleteKnowledgeKnowledgebaseLanguageDocument(documentId, knowledgeBaseId, languageCode) {
|
|
40157
|
-
// verify the required parameter 'documentId' is set
|
|
40158
|
-
if (documentId === undefined || documentId === null || documentId === '') {
|
|
40159
|
-
throw 'Missing the required parameter "documentId" when calling deleteKnowledgeKnowledgebaseLanguageDocument';
|
|
40160
|
-
}
|
|
40161
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
40162
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
40163
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseLanguageDocument';
|
|
40164
|
-
}
|
|
40165
|
-
// verify the required parameter 'languageCode' is set
|
|
40166
|
-
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
40167
|
-
throw 'Missing the required parameter "languageCode" when calling deleteKnowledgeKnowledgebaseLanguageDocument';
|
|
40168
|
-
}
|
|
40169
|
-
|
|
40170
|
-
return this.apiClient.callApi(
|
|
40171
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}',
|
|
40172
|
-
'DELETE',
|
|
40173
|
-
{ 'documentId': documentId,'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
|
|
40174
|
-
{ },
|
|
40175
|
-
{ },
|
|
40176
|
-
{ },
|
|
40177
|
-
null,
|
|
40178
|
-
['PureCloud OAuth'],
|
|
40179
|
-
['application/json'],
|
|
40180
|
-
['application/json']
|
|
40181
|
-
);
|
|
40182
|
-
}
|
|
40183
|
-
|
|
40184
|
-
/**
|
|
40185
|
-
* Delete import operation
|
|
40186
|
-
*
|
|
40187
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
40188
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
40189
|
-
* @param {String} importId Import ID
|
|
40190
|
-
* @deprecated
|
|
40191
|
-
*/
|
|
40192
|
-
deleteKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId, languageCode, importId) {
|
|
40193
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
40194
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
40195
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseLanguageDocumentsImport';
|
|
40196
|
-
}
|
|
40197
|
-
// verify the required parameter 'languageCode' is set
|
|
40198
|
-
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
40199
|
-
throw 'Missing the required parameter "languageCode" when calling deleteKnowledgeKnowledgebaseLanguageDocumentsImport';
|
|
40200
|
-
}
|
|
40201
|
-
// verify the required parameter 'importId' is set
|
|
40202
|
-
if (importId === undefined || importId === null || importId === '') {
|
|
40203
|
-
throw 'Missing the required parameter "importId" when calling deleteKnowledgeKnowledgebaseLanguageDocumentsImport';
|
|
40204
|
-
}
|
|
40205
|
-
|
|
40206
|
-
return this.apiClient.callApi(
|
|
40207
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/imports/{importId}',
|
|
40208
|
-
'DELETE',
|
|
40209
|
-
{ 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode,'importId': importId },
|
|
40210
|
-
{ },
|
|
40211
|
-
{ },
|
|
40212
|
-
{ },
|
|
40213
|
-
null,
|
|
40214
|
-
['PureCloud OAuth'],
|
|
40215
|
-
['application/json'],
|
|
40216
|
-
['application/json']
|
|
40217
|
-
);
|
|
40218
|
-
}
|
|
40219
|
-
|
|
40220
40256
|
/**
|
|
40221
40257
|
* Delete Salesforce Knowledge integration source
|
|
40222
40258
|
*
|
|
@@ -41040,312 +41076,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41040
41076
|
);
|
|
41041
41077
|
}
|
|
41042
41078
|
|
|
41043
|
-
/**
|
|
41044
|
-
* Get categories
|
|
41045
|
-
*
|
|
41046
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
41047
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
41048
|
-
* @param {Object} opts Optional parameters
|
|
41049
|
-
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
41050
|
-
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
41051
|
-
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
41052
|
-
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
41053
|
-
* @param {String} opts.name Filter to return the categories that starts with the given category name.
|
|
41054
|
-
* @deprecated
|
|
41055
|
-
*/
|
|
41056
|
-
getKnowledgeKnowledgebaseLanguageCategories(knowledgeBaseId, languageCode, opts) {
|
|
41057
|
-
opts = opts || {};
|
|
41058
|
-
|
|
41059
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
41060
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
41061
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageCategories';
|
|
41062
|
-
}
|
|
41063
|
-
// verify the required parameter 'languageCode' is set
|
|
41064
|
-
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
41065
|
-
throw 'Missing the required parameter "languageCode" when calling getKnowledgeKnowledgebaseLanguageCategories';
|
|
41066
|
-
}
|
|
41067
|
-
|
|
41068
|
-
return this.apiClient.callApi(
|
|
41069
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories',
|
|
41070
|
-
'GET',
|
|
41071
|
-
{ 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
|
|
41072
|
-
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'name': opts['name'] },
|
|
41073
|
-
{ },
|
|
41074
|
-
{ },
|
|
41075
|
-
null,
|
|
41076
|
-
['PureCloud OAuth'],
|
|
41077
|
-
['application/json'],
|
|
41078
|
-
['application/json']
|
|
41079
|
-
);
|
|
41080
|
-
}
|
|
41081
|
-
|
|
41082
|
-
/**
|
|
41083
|
-
* Get category
|
|
41084
|
-
*
|
|
41085
|
-
* @param {String} categoryId Category ID
|
|
41086
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
41087
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
41088
|
-
* @deprecated
|
|
41089
|
-
*/
|
|
41090
|
-
getKnowledgeKnowledgebaseLanguageCategory(categoryId, knowledgeBaseId, languageCode) {
|
|
41091
|
-
// verify the required parameter 'categoryId' is set
|
|
41092
|
-
if (categoryId === undefined || categoryId === null || categoryId === '') {
|
|
41093
|
-
throw 'Missing the required parameter "categoryId" when calling getKnowledgeKnowledgebaseLanguageCategory';
|
|
41094
|
-
}
|
|
41095
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
41096
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
41097
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageCategory';
|
|
41098
|
-
}
|
|
41099
|
-
// verify the required parameter 'languageCode' is set
|
|
41100
|
-
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
41101
|
-
throw 'Missing the required parameter "languageCode" when calling getKnowledgeKnowledgebaseLanguageCategory';
|
|
41102
|
-
}
|
|
41103
|
-
|
|
41104
|
-
return this.apiClient.callApi(
|
|
41105
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories/{categoryId}',
|
|
41106
|
-
'GET',
|
|
41107
|
-
{ 'categoryId': categoryId,'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
|
|
41108
|
-
{ },
|
|
41109
|
-
{ },
|
|
41110
|
-
{ },
|
|
41111
|
-
null,
|
|
41112
|
-
['PureCloud OAuth'],
|
|
41113
|
-
['application/json'],
|
|
41114
|
-
['application/json']
|
|
41115
|
-
);
|
|
41116
|
-
}
|
|
41117
|
-
|
|
41118
|
-
/**
|
|
41119
|
-
* Get document
|
|
41120
|
-
*
|
|
41121
|
-
* @param {String} documentId Document ID
|
|
41122
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
41123
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
41124
|
-
* @deprecated
|
|
41125
|
-
*/
|
|
41126
|
-
getKnowledgeKnowledgebaseLanguageDocument(documentId, knowledgeBaseId, languageCode) {
|
|
41127
|
-
// verify the required parameter 'documentId' is set
|
|
41128
|
-
if (documentId === undefined || documentId === null || documentId === '') {
|
|
41129
|
-
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseLanguageDocument';
|
|
41130
|
-
}
|
|
41131
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
41132
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
41133
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageDocument';
|
|
41134
|
-
}
|
|
41135
|
-
// verify the required parameter 'languageCode' is set
|
|
41136
|
-
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
41137
|
-
throw 'Missing the required parameter "languageCode" when calling getKnowledgeKnowledgebaseLanguageDocument';
|
|
41138
|
-
}
|
|
41139
|
-
|
|
41140
|
-
return this.apiClient.callApi(
|
|
41141
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}',
|
|
41142
|
-
'GET',
|
|
41143
|
-
{ 'documentId': documentId,'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
|
|
41144
|
-
{ },
|
|
41145
|
-
{ },
|
|
41146
|
-
{ },
|
|
41147
|
-
null,
|
|
41148
|
-
['PureCloud OAuth'],
|
|
41149
|
-
['application/json'],
|
|
41150
|
-
['application/json']
|
|
41151
|
-
);
|
|
41152
|
-
}
|
|
41153
|
-
|
|
41154
|
-
/**
|
|
41155
|
-
* Get document content upload status
|
|
41156
|
-
*
|
|
41157
|
-
* @param {String} documentId Document ID
|
|
41158
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
41159
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
41160
|
-
* @param {String} uploadId UploadId
|
|
41161
|
-
* @deprecated
|
|
41162
|
-
*/
|
|
41163
|
-
getKnowledgeKnowledgebaseLanguageDocumentUpload(documentId, knowledgeBaseId, languageCode, uploadId) {
|
|
41164
|
-
// verify the required parameter 'documentId' is set
|
|
41165
|
-
if (documentId === undefined || documentId === null || documentId === '') {
|
|
41166
|
-
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseLanguageDocumentUpload';
|
|
41167
|
-
}
|
|
41168
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
41169
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
41170
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageDocumentUpload';
|
|
41171
|
-
}
|
|
41172
|
-
// verify the required parameter 'languageCode' is set
|
|
41173
|
-
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
41174
|
-
throw 'Missing the required parameter "languageCode" when calling getKnowledgeKnowledgebaseLanguageDocumentUpload';
|
|
41175
|
-
}
|
|
41176
|
-
// verify the required parameter 'uploadId' is set
|
|
41177
|
-
if (uploadId === undefined || uploadId === null || uploadId === '') {
|
|
41178
|
-
throw 'Missing the required parameter "uploadId" when calling getKnowledgeKnowledgebaseLanguageDocumentUpload';
|
|
41179
|
-
}
|
|
41180
|
-
|
|
41181
|
-
return this.apiClient.callApi(
|
|
41182
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}/uploads/{uploadId}',
|
|
41183
|
-
'GET',
|
|
41184
|
-
{ 'documentId': documentId,'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode,'uploadId': uploadId },
|
|
41185
|
-
{ },
|
|
41186
|
-
{ },
|
|
41187
|
-
{ },
|
|
41188
|
-
null,
|
|
41189
|
-
['PureCloud OAuth'],
|
|
41190
|
-
['application/json'],
|
|
41191
|
-
['application/json']
|
|
41192
|
-
);
|
|
41193
|
-
}
|
|
41194
|
-
|
|
41195
|
-
/**
|
|
41196
|
-
* Get documents
|
|
41197
|
-
*
|
|
41198
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
41199
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
41200
|
-
* @param {Object} opts Optional parameters
|
|
41201
|
-
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
41202
|
-
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
41203
|
-
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
41204
|
-
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
41205
|
-
* @param {String} opts.categories Filter by categories ids, comma separated values expected.
|
|
41206
|
-
* @param {String} opts.title Filter by document title.
|
|
41207
|
-
* @param {Object} opts.sortBy Sort by.
|
|
41208
|
-
* @param {Object} opts.sortOrder Sort Order.
|
|
41209
|
-
* @param {Array.<String>} opts.documentIds Comma-separated list of document identifiers to fetch by.
|
|
41210
|
-
* @deprecated
|
|
41211
|
-
*/
|
|
41212
|
-
getKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, opts) {
|
|
41213
|
-
opts = opts || {};
|
|
41214
|
-
|
|
41215
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
41216
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
41217
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageDocuments';
|
|
41218
|
-
}
|
|
41219
|
-
// verify the required parameter 'languageCode' is set
|
|
41220
|
-
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
41221
|
-
throw 'Missing the required parameter "languageCode" when calling getKnowledgeKnowledgebaseLanguageDocuments';
|
|
41222
|
-
}
|
|
41223
|
-
|
|
41224
|
-
return this.apiClient.callApi(
|
|
41225
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents',
|
|
41226
|
-
'GET',
|
|
41227
|
-
{ 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
|
|
41228
|
-
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'categories': opts['categories'],'title': opts['title'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'documentIds': this.apiClient.buildCollectionParam(opts['documentIds'], 'multi') },
|
|
41229
|
-
{ },
|
|
41230
|
-
{ },
|
|
41231
|
-
null,
|
|
41232
|
-
['PureCloud OAuth'],
|
|
41233
|
-
['application/json'],
|
|
41234
|
-
['application/json']
|
|
41235
|
-
);
|
|
41236
|
-
}
|
|
41237
|
-
|
|
41238
|
-
/**
|
|
41239
|
-
* Get import operation report
|
|
41240
|
-
*
|
|
41241
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
41242
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
41243
|
-
* @param {String} importId Import ID
|
|
41244
|
-
* @deprecated
|
|
41245
|
-
*/
|
|
41246
|
-
getKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId, languageCode, importId) {
|
|
41247
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
41248
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
41249
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageDocumentsImport';
|
|
41250
|
-
}
|
|
41251
|
-
// verify the required parameter 'languageCode' is set
|
|
41252
|
-
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
41253
|
-
throw 'Missing the required parameter "languageCode" when calling getKnowledgeKnowledgebaseLanguageDocumentsImport';
|
|
41254
|
-
}
|
|
41255
|
-
// verify the required parameter 'importId' is set
|
|
41256
|
-
if (importId === undefined || importId === null || importId === '') {
|
|
41257
|
-
throw 'Missing the required parameter "importId" when calling getKnowledgeKnowledgebaseLanguageDocumentsImport';
|
|
41258
|
-
}
|
|
41259
|
-
|
|
41260
|
-
return this.apiClient.callApi(
|
|
41261
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/imports/{importId}',
|
|
41262
|
-
'GET',
|
|
41263
|
-
{ 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode,'importId': importId },
|
|
41264
|
-
{ },
|
|
41265
|
-
{ },
|
|
41266
|
-
{ },
|
|
41267
|
-
null,
|
|
41268
|
-
['PureCloud OAuth'],
|
|
41269
|
-
['application/json'],
|
|
41270
|
-
['application/json']
|
|
41271
|
-
);
|
|
41272
|
-
}
|
|
41273
|
-
|
|
41274
|
-
/**
|
|
41275
|
-
* Get training detail
|
|
41276
|
-
*
|
|
41277
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
41278
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
41279
|
-
* @param {String} trainingId Training ID
|
|
41280
|
-
* @deprecated
|
|
41281
|
-
*/
|
|
41282
|
-
getKnowledgeKnowledgebaseLanguageTraining(knowledgeBaseId, languageCode, trainingId) {
|
|
41283
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
41284
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
41285
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageTraining';
|
|
41286
|
-
}
|
|
41287
|
-
// verify the required parameter 'languageCode' is set
|
|
41288
|
-
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
41289
|
-
throw 'Missing the required parameter "languageCode" when calling getKnowledgeKnowledgebaseLanguageTraining';
|
|
41290
|
-
}
|
|
41291
|
-
// verify the required parameter 'trainingId' is set
|
|
41292
|
-
if (trainingId === undefined || trainingId === null || trainingId === '') {
|
|
41293
|
-
throw 'Missing the required parameter "trainingId" when calling getKnowledgeKnowledgebaseLanguageTraining';
|
|
41294
|
-
}
|
|
41295
|
-
|
|
41296
|
-
return this.apiClient.callApi(
|
|
41297
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings/{trainingId}',
|
|
41298
|
-
'GET',
|
|
41299
|
-
{ 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode,'trainingId': trainingId },
|
|
41300
|
-
{ },
|
|
41301
|
-
{ },
|
|
41302
|
-
{ },
|
|
41303
|
-
null,
|
|
41304
|
-
['PureCloud OAuth'],
|
|
41305
|
-
['application/json'],
|
|
41306
|
-
['application/json']
|
|
41307
|
-
);
|
|
41308
|
-
}
|
|
41309
|
-
|
|
41310
|
-
/**
|
|
41311
|
-
* Get all trainings information for a knowledgebase
|
|
41312
|
-
*
|
|
41313
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
41314
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
41315
|
-
* @param {Object} opts Optional parameters
|
|
41316
|
-
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
41317
|
-
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
41318
|
-
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
41319
|
-
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
41320
|
-
* @param {Object} opts.knowledgeDocumentsState Return the training with the specified state of the trained documents.
|
|
41321
|
-
* @deprecated
|
|
41322
|
-
*/
|
|
41323
|
-
getKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId, languageCode, opts) {
|
|
41324
|
-
opts = opts || {};
|
|
41325
|
-
|
|
41326
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
41327
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
41328
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageTrainings';
|
|
41329
|
-
}
|
|
41330
|
-
// verify the required parameter 'languageCode' is set
|
|
41331
|
-
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
41332
|
-
throw 'Missing the required parameter "languageCode" when calling getKnowledgeKnowledgebaseLanguageTrainings';
|
|
41333
|
-
}
|
|
41334
|
-
|
|
41335
|
-
return this.apiClient.callApi(
|
|
41336
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings',
|
|
41337
|
-
'GET',
|
|
41338
|
-
{ 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
|
|
41339
|
-
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'knowledgeDocumentsState': opts['knowledgeDocumentsState'] },
|
|
41340
|
-
{ },
|
|
41341
|
-
{ },
|
|
41342
|
-
null,
|
|
41343
|
-
['PureCloud OAuth'],
|
|
41344
|
-
['application/json'],
|
|
41345
|
-
['application/json']
|
|
41346
|
-
);
|
|
41347
|
-
}
|
|
41348
|
-
|
|
41349
41079
|
/**
|
|
41350
41080
|
* Get operations
|
|
41351
41081
|
*
|
|
@@ -42058,165 +41788,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42058
41788
|
);
|
|
42059
41789
|
}
|
|
42060
41790
|
|
|
42061
|
-
/**
|
|
42062
|
-
* Update category
|
|
42063
|
-
*
|
|
42064
|
-
* @param {String} categoryId Category ID
|
|
42065
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
42066
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
42067
|
-
* @param {Object} body
|
|
42068
|
-
* @deprecated
|
|
42069
|
-
*/
|
|
42070
|
-
patchKnowledgeKnowledgebaseLanguageCategory(categoryId, knowledgeBaseId, languageCode, body) {
|
|
42071
|
-
// verify the required parameter 'categoryId' is set
|
|
42072
|
-
if (categoryId === undefined || categoryId === null || categoryId === '') {
|
|
42073
|
-
throw 'Missing the required parameter "categoryId" when calling patchKnowledgeKnowledgebaseLanguageCategory';
|
|
42074
|
-
}
|
|
42075
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
42076
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
42077
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseLanguageCategory';
|
|
42078
|
-
}
|
|
42079
|
-
// verify the required parameter 'languageCode' is set
|
|
42080
|
-
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
42081
|
-
throw 'Missing the required parameter "languageCode" when calling patchKnowledgeKnowledgebaseLanguageCategory';
|
|
42082
|
-
}
|
|
42083
|
-
// verify the required parameter 'body' is set
|
|
42084
|
-
if (body === undefined || body === null) {
|
|
42085
|
-
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseLanguageCategory';
|
|
42086
|
-
}
|
|
42087
|
-
|
|
42088
|
-
return this.apiClient.callApi(
|
|
42089
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories/{categoryId}',
|
|
42090
|
-
'PATCH',
|
|
42091
|
-
{ 'categoryId': categoryId,'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
|
|
42092
|
-
{ },
|
|
42093
|
-
{ },
|
|
42094
|
-
{ },
|
|
42095
|
-
body,
|
|
42096
|
-
['PureCloud OAuth'],
|
|
42097
|
-
['application/json'],
|
|
42098
|
-
['application/json']
|
|
42099
|
-
);
|
|
42100
|
-
}
|
|
42101
|
-
|
|
42102
|
-
/**
|
|
42103
|
-
* Update document
|
|
42104
|
-
*
|
|
42105
|
-
* @param {String} documentId Document ID
|
|
42106
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
42107
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
42108
|
-
* @param {Object} body
|
|
42109
|
-
* @deprecated
|
|
42110
|
-
*/
|
|
42111
|
-
patchKnowledgeKnowledgebaseLanguageDocument(documentId, knowledgeBaseId, languageCode, body) {
|
|
42112
|
-
// verify the required parameter 'documentId' is set
|
|
42113
|
-
if (documentId === undefined || documentId === null || documentId === '') {
|
|
42114
|
-
throw 'Missing the required parameter "documentId" when calling patchKnowledgeKnowledgebaseLanguageDocument';
|
|
42115
|
-
}
|
|
42116
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
42117
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
42118
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseLanguageDocument';
|
|
42119
|
-
}
|
|
42120
|
-
// verify the required parameter 'languageCode' is set
|
|
42121
|
-
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
42122
|
-
throw 'Missing the required parameter "languageCode" when calling patchKnowledgeKnowledgebaseLanguageDocument';
|
|
42123
|
-
}
|
|
42124
|
-
// verify the required parameter 'body' is set
|
|
42125
|
-
if (body === undefined || body === null) {
|
|
42126
|
-
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseLanguageDocument';
|
|
42127
|
-
}
|
|
42128
|
-
|
|
42129
|
-
return this.apiClient.callApi(
|
|
42130
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}',
|
|
42131
|
-
'PATCH',
|
|
42132
|
-
{ 'documentId': documentId,'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
|
|
42133
|
-
{ },
|
|
42134
|
-
{ },
|
|
42135
|
-
{ },
|
|
42136
|
-
body,
|
|
42137
|
-
['PureCloud OAuth'],
|
|
42138
|
-
['application/json'],
|
|
42139
|
-
['application/json']
|
|
42140
|
-
);
|
|
42141
|
-
}
|
|
42142
|
-
|
|
42143
|
-
/**
|
|
42144
|
-
* Update documents collection
|
|
42145
|
-
*
|
|
42146
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
42147
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
42148
|
-
* @param {Array.<Object>} body
|
|
42149
|
-
* @deprecated
|
|
42150
|
-
*/
|
|
42151
|
-
patchKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, body) {
|
|
42152
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
42153
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
42154
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseLanguageDocuments';
|
|
42155
|
-
}
|
|
42156
|
-
// verify the required parameter 'languageCode' is set
|
|
42157
|
-
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
42158
|
-
throw 'Missing the required parameter "languageCode" when calling patchKnowledgeKnowledgebaseLanguageDocuments';
|
|
42159
|
-
}
|
|
42160
|
-
// verify the required parameter 'body' is set
|
|
42161
|
-
if (body === undefined || body === null) {
|
|
42162
|
-
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseLanguageDocuments';
|
|
42163
|
-
}
|
|
42164
|
-
|
|
42165
|
-
return this.apiClient.callApi(
|
|
42166
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents',
|
|
42167
|
-
'PATCH',
|
|
42168
|
-
{ 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
|
|
42169
|
-
{ },
|
|
42170
|
-
{ },
|
|
42171
|
-
{ },
|
|
42172
|
-
body,
|
|
42173
|
-
['PureCloud OAuth'],
|
|
42174
|
-
['application/json'],
|
|
42175
|
-
['application/json']
|
|
42176
|
-
);
|
|
42177
|
-
}
|
|
42178
|
-
|
|
42179
|
-
/**
|
|
42180
|
-
* Start import operation
|
|
42181
|
-
*
|
|
42182
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
42183
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
42184
|
-
* @param {String} importId Import ID
|
|
42185
|
-
* @param {Object} body
|
|
42186
|
-
* @deprecated
|
|
42187
|
-
*/
|
|
42188
|
-
patchKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId, languageCode, importId, body) {
|
|
42189
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
42190
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
42191
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseLanguageDocumentsImport';
|
|
42192
|
-
}
|
|
42193
|
-
// verify the required parameter 'languageCode' is set
|
|
42194
|
-
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
42195
|
-
throw 'Missing the required parameter "languageCode" when calling patchKnowledgeKnowledgebaseLanguageDocumentsImport';
|
|
42196
|
-
}
|
|
42197
|
-
// verify the required parameter 'importId' is set
|
|
42198
|
-
if (importId === undefined || importId === null || importId === '') {
|
|
42199
|
-
throw 'Missing the required parameter "importId" when calling patchKnowledgeKnowledgebaseLanguageDocumentsImport';
|
|
42200
|
-
}
|
|
42201
|
-
// verify the required parameter 'body' is set
|
|
42202
|
-
if (body === undefined || body === null) {
|
|
42203
|
-
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseLanguageDocumentsImport';
|
|
42204
|
-
}
|
|
42205
|
-
|
|
42206
|
-
return this.apiClient.callApi(
|
|
42207
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/imports/{importId}',
|
|
42208
|
-
'PATCH',
|
|
42209
|
-
{ 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode,'importId': importId },
|
|
42210
|
-
{ },
|
|
42211
|
-
{ },
|
|
42212
|
-
{ },
|
|
42213
|
-
body,
|
|
42214
|
-
['PureCloud OAuth'],
|
|
42215
|
-
['application/json'],
|
|
42216
|
-
['application/json']
|
|
42217
|
-
);
|
|
42218
|
-
}
|
|
42219
|
-
|
|
42220
41791
|
/**
|
|
42221
41792
|
* Send update to the parse operation
|
|
42222
41793
|
*
|
|
@@ -43186,222 +42757,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43186
42757
|
);
|
|
43187
42758
|
}
|
|
43188
42759
|
|
|
43189
|
-
/**
|
|
43190
|
-
* Create new category
|
|
43191
|
-
*
|
|
43192
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
43193
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
43194
|
-
* @param {Object} body
|
|
43195
|
-
* @deprecated
|
|
43196
|
-
*/
|
|
43197
|
-
postKnowledgeKnowledgebaseLanguageCategories(knowledgeBaseId, languageCode, body) {
|
|
43198
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
43199
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
43200
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLanguageCategories';
|
|
43201
|
-
}
|
|
43202
|
-
// verify the required parameter 'languageCode' is set
|
|
43203
|
-
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
43204
|
-
throw 'Missing the required parameter "languageCode" when calling postKnowledgeKnowledgebaseLanguageCategories';
|
|
43205
|
-
}
|
|
43206
|
-
// verify the required parameter 'body' is set
|
|
43207
|
-
if (body === undefined || body === null) {
|
|
43208
|
-
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseLanguageCategories';
|
|
43209
|
-
}
|
|
43210
|
-
|
|
43211
|
-
return this.apiClient.callApi(
|
|
43212
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories',
|
|
43213
|
-
'POST',
|
|
43214
|
-
{ 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
|
|
43215
|
-
{ },
|
|
43216
|
-
{ },
|
|
43217
|
-
{ },
|
|
43218
|
-
body,
|
|
43219
|
-
['PureCloud OAuth'],
|
|
43220
|
-
['application/json'],
|
|
43221
|
-
['application/json']
|
|
43222
|
-
);
|
|
43223
|
-
}
|
|
43224
|
-
|
|
43225
|
-
/**
|
|
43226
|
-
* Upload Article Content
|
|
43227
|
-
*
|
|
43228
|
-
* @param {String} documentId Document ID
|
|
43229
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
43230
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
43231
|
-
* @param {Object} body
|
|
43232
|
-
* @deprecated
|
|
43233
|
-
*/
|
|
43234
|
-
postKnowledgeKnowledgebaseLanguageDocumentUploads(documentId, knowledgeBaseId, languageCode, body) {
|
|
43235
|
-
// verify the required parameter 'documentId' is set
|
|
43236
|
-
if (documentId === undefined || documentId === null || documentId === '') {
|
|
43237
|
-
throw 'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseLanguageDocumentUploads';
|
|
43238
|
-
}
|
|
43239
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
43240
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
43241
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLanguageDocumentUploads';
|
|
43242
|
-
}
|
|
43243
|
-
// verify the required parameter 'languageCode' is set
|
|
43244
|
-
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
43245
|
-
throw 'Missing the required parameter "languageCode" when calling postKnowledgeKnowledgebaseLanguageDocumentUploads';
|
|
43246
|
-
}
|
|
43247
|
-
// verify the required parameter 'body' is set
|
|
43248
|
-
if (body === undefined || body === null) {
|
|
43249
|
-
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseLanguageDocumentUploads';
|
|
43250
|
-
}
|
|
43251
|
-
|
|
43252
|
-
return this.apiClient.callApi(
|
|
43253
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}/uploads',
|
|
43254
|
-
'POST',
|
|
43255
|
-
{ 'documentId': documentId,'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
|
|
43256
|
-
{ },
|
|
43257
|
-
{ },
|
|
43258
|
-
{ },
|
|
43259
|
-
body,
|
|
43260
|
-
['PureCloud OAuth'],
|
|
43261
|
-
['application/json'],
|
|
43262
|
-
['application/json']
|
|
43263
|
-
);
|
|
43264
|
-
}
|
|
43265
|
-
|
|
43266
|
-
/**
|
|
43267
|
-
* Create document
|
|
43268
|
-
*
|
|
43269
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
43270
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
43271
|
-
* @param {Object} body
|
|
43272
|
-
* @deprecated
|
|
43273
|
-
*/
|
|
43274
|
-
postKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, body) {
|
|
43275
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
43276
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
43277
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLanguageDocuments';
|
|
43278
|
-
}
|
|
43279
|
-
// verify the required parameter 'languageCode' is set
|
|
43280
|
-
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
43281
|
-
throw 'Missing the required parameter "languageCode" when calling postKnowledgeKnowledgebaseLanguageDocuments';
|
|
43282
|
-
}
|
|
43283
|
-
// verify the required parameter 'body' is set
|
|
43284
|
-
if (body === undefined || body === null) {
|
|
43285
|
-
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseLanguageDocuments';
|
|
43286
|
-
}
|
|
43287
|
-
|
|
43288
|
-
return this.apiClient.callApi(
|
|
43289
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents',
|
|
43290
|
-
'POST',
|
|
43291
|
-
{ 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
|
|
43292
|
-
{ },
|
|
43293
|
-
{ },
|
|
43294
|
-
{ },
|
|
43295
|
-
body,
|
|
43296
|
-
['PureCloud OAuth'],
|
|
43297
|
-
['application/json'],
|
|
43298
|
-
['application/json']
|
|
43299
|
-
);
|
|
43300
|
-
}
|
|
43301
|
-
|
|
43302
|
-
/**
|
|
43303
|
-
* Create import operation
|
|
43304
|
-
*
|
|
43305
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
43306
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
43307
|
-
* @param {Object} body
|
|
43308
|
-
* @deprecated
|
|
43309
|
-
*/
|
|
43310
|
-
postKnowledgeKnowledgebaseLanguageDocumentsImports(knowledgeBaseId, languageCode, body) {
|
|
43311
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
43312
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
43313
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLanguageDocumentsImports';
|
|
43314
|
-
}
|
|
43315
|
-
// verify the required parameter 'languageCode' is set
|
|
43316
|
-
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
43317
|
-
throw 'Missing the required parameter "languageCode" when calling postKnowledgeKnowledgebaseLanguageDocumentsImports';
|
|
43318
|
-
}
|
|
43319
|
-
// verify the required parameter 'body' is set
|
|
43320
|
-
if (body === undefined || body === null) {
|
|
43321
|
-
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseLanguageDocumentsImports';
|
|
43322
|
-
}
|
|
43323
|
-
|
|
43324
|
-
return this.apiClient.callApi(
|
|
43325
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/imports',
|
|
43326
|
-
'POST',
|
|
43327
|
-
{ 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
|
|
43328
|
-
{ },
|
|
43329
|
-
{ },
|
|
43330
|
-
{ },
|
|
43331
|
-
body,
|
|
43332
|
-
['PureCloud OAuth'],
|
|
43333
|
-
['application/json'],
|
|
43334
|
-
['application/json']
|
|
43335
|
-
);
|
|
43336
|
-
}
|
|
43337
|
-
|
|
43338
|
-
/**
|
|
43339
|
-
* Promote trained documents from draft state to active.
|
|
43340
|
-
*
|
|
43341
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
43342
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
43343
|
-
* @param {String} trainingId Training ID
|
|
43344
|
-
* @deprecated
|
|
43345
|
-
*/
|
|
43346
|
-
postKnowledgeKnowledgebaseLanguageTrainingPromote(knowledgeBaseId, languageCode, trainingId) {
|
|
43347
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
43348
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
43349
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLanguageTrainingPromote';
|
|
43350
|
-
}
|
|
43351
|
-
// verify the required parameter 'languageCode' is set
|
|
43352
|
-
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
43353
|
-
throw 'Missing the required parameter "languageCode" when calling postKnowledgeKnowledgebaseLanguageTrainingPromote';
|
|
43354
|
-
}
|
|
43355
|
-
// verify the required parameter 'trainingId' is set
|
|
43356
|
-
if (trainingId === undefined || trainingId === null || trainingId === '') {
|
|
43357
|
-
throw 'Missing the required parameter "trainingId" when calling postKnowledgeKnowledgebaseLanguageTrainingPromote';
|
|
43358
|
-
}
|
|
43359
|
-
|
|
43360
|
-
return this.apiClient.callApi(
|
|
43361
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings/{trainingId}/promote',
|
|
43362
|
-
'POST',
|
|
43363
|
-
{ 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode,'trainingId': trainingId },
|
|
43364
|
-
{ },
|
|
43365
|
-
{ },
|
|
43366
|
-
{ },
|
|
43367
|
-
null,
|
|
43368
|
-
['PureCloud OAuth'],
|
|
43369
|
-
['application/json'],
|
|
43370
|
-
['application/json']
|
|
43371
|
-
);
|
|
43372
|
-
}
|
|
43373
|
-
|
|
43374
|
-
/**
|
|
43375
|
-
* Trigger training
|
|
43376
|
-
*
|
|
43377
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
43378
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
43379
|
-
* @deprecated
|
|
43380
|
-
*/
|
|
43381
|
-
postKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId, languageCode) {
|
|
43382
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
43383
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
43384
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLanguageTrainings';
|
|
43385
|
-
}
|
|
43386
|
-
// verify the required parameter 'languageCode' is set
|
|
43387
|
-
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
43388
|
-
throw 'Missing the required parameter "languageCode" when calling postKnowledgeKnowledgebaseLanguageTrainings';
|
|
43389
|
-
}
|
|
43390
|
-
|
|
43391
|
-
return this.apiClient.callApi(
|
|
43392
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings',
|
|
43393
|
-
'POST',
|
|
43394
|
-
{ 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
|
|
43395
|
-
{ },
|
|
43396
|
-
{ },
|
|
43397
|
-
{ },
|
|
43398
|
-
null,
|
|
43399
|
-
['PureCloud OAuth'],
|
|
43400
|
-
['application/json'],
|
|
43401
|
-
['application/json']
|
|
43402
|
-
);
|
|
43403
|
-
}
|
|
43404
|
-
|
|
43405
42760
|
/**
|
|
43406
42761
|
* Import the parsed articles
|
|
43407
42762
|
*
|
|
@@ -43467,36 +42822,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43467
42822
|
);
|
|
43468
42823
|
}
|
|
43469
42824
|
|
|
43470
|
-
/**
|
|
43471
|
-
* Search Documents
|
|
43472
|
-
*
|
|
43473
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
43474
|
-
* @param {Object} opts Optional parameters
|
|
43475
|
-
* @param {Object} opts.body
|
|
43476
|
-
* @deprecated
|
|
43477
|
-
*/
|
|
43478
|
-
postKnowledgeKnowledgebaseSearch(knowledgeBaseId, opts) {
|
|
43479
|
-
opts = opts || {};
|
|
43480
|
-
|
|
43481
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
43482
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
43483
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSearch';
|
|
43484
|
-
}
|
|
43485
|
-
|
|
43486
|
-
return this.apiClient.callApi(
|
|
43487
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/search',
|
|
43488
|
-
'POST',
|
|
43489
|
-
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
43490
|
-
{ },
|
|
43491
|
-
{ },
|
|
43492
|
-
{ },
|
|
43493
|
-
opts['body'],
|
|
43494
|
-
['PureCloud OAuth'],
|
|
43495
|
-
['application/json'],
|
|
43496
|
-
['application/json']
|
|
43497
|
-
);
|
|
43498
|
-
}
|
|
43499
|
-
|
|
43500
42825
|
/**
|
|
43501
42826
|
* Create Salesforce Knowledge integration source
|
|
43502
42827
|
*
|
|
@@ -43786,7 +43111,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43786
43111
|
/**
|
|
43787
43112
|
* LanguageUnderstanding service.
|
|
43788
43113
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
43789
|
-
* @version
|
|
43114
|
+
* @version 235.0.0
|
|
43790
43115
|
*/
|
|
43791
43116
|
|
|
43792
43117
|
/**
|
|
@@ -45005,7 +44330,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45005
44330
|
/**
|
|
45006
44331
|
* Languages service.
|
|
45007
44332
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
45008
|
-
* @version
|
|
44333
|
+
* @version 235.0.0
|
|
45009
44334
|
*/
|
|
45010
44335
|
|
|
45011
44336
|
/**
|
|
@@ -45227,7 +44552,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45227
44552
|
/**
|
|
45228
44553
|
* Learning service.
|
|
45229
44554
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
45230
|
-
* @version
|
|
44555
|
+
* @version 235.0.0
|
|
45231
44556
|
*/
|
|
45232
44557
|
|
|
45233
44558
|
/**
|
|
@@ -45668,6 +44993,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45668
44993
|
);
|
|
45669
44994
|
}
|
|
45670
44995
|
|
|
44996
|
+
/**
|
|
44997
|
+
* Retrieve the status of the job for the slots where a learning activity can be scheduled.
|
|
44998
|
+
*
|
|
44999
|
+
* @param {String} jobId The ID of the job
|
|
45000
|
+
*/
|
|
45001
|
+
getLearningScheduleslotsJob(jobId) {
|
|
45002
|
+
// verify the required parameter 'jobId' is set
|
|
45003
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
45004
|
+
throw 'Missing the required parameter "jobId" when calling getLearningScheduleslotsJob';
|
|
45005
|
+
}
|
|
45006
|
+
|
|
45007
|
+
return this.apiClient.callApi(
|
|
45008
|
+
'/api/v2/learning/scheduleslots/jobs/{jobId}',
|
|
45009
|
+
'GET',
|
|
45010
|
+
{ 'jobId': jobId },
|
|
45011
|
+
{ },
|
|
45012
|
+
{ },
|
|
45013
|
+
{ },
|
|
45014
|
+
null,
|
|
45015
|
+
['PureCloud OAuth'],
|
|
45016
|
+
['application/json'],
|
|
45017
|
+
['application/json']
|
|
45018
|
+
);
|
|
45019
|
+
}
|
|
45020
|
+
|
|
45671
45021
|
/**
|
|
45672
45022
|
* Get Learning SCORM Result
|
|
45673
45023
|
*
|
|
@@ -46111,6 +45461,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46111
45461
|
);
|
|
46112
45462
|
}
|
|
46113
45463
|
|
|
45464
|
+
/**
|
|
45465
|
+
* Start job to retrieve slots where a learning activity can be scheduled.
|
|
45466
|
+
*
|
|
45467
|
+
* @param {Object} body The slots search request
|
|
45468
|
+
*/
|
|
45469
|
+
postLearningScheduleslotsJobs(body) {
|
|
45470
|
+
// verify the required parameter 'body' is set
|
|
45471
|
+
if (body === undefined || body === null) {
|
|
45472
|
+
throw 'Missing the required parameter "body" when calling postLearningScheduleslotsJobs';
|
|
45473
|
+
}
|
|
45474
|
+
|
|
45475
|
+
return this.apiClient.callApi(
|
|
45476
|
+
'/api/v2/learning/scheduleslots/jobs',
|
|
45477
|
+
'POST',
|
|
45478
|
+
{ },
|
|
45479
|
+
{ },
|
|
45480
|
+
{ },
|
|
45481
|
+
{ },
|
|
45482
|
+
body,
|
|
45483
|
+
['PureCloud OAuth'],
|
|
45484
|
+
['application/json'],
|
|
45485
|
+
['application/json']
|
|
45486
|
+
);
|
|
45487
|
+
}
|
|
45488
|
+
|
|
46114
45489
|
/**
|
|
46115
45490
|
* Get list of possible slots where a learning activity can be scheduled.
|
|
46116
45491
|
*
|
|
@@ -46260,7 +45635,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46260
45635
|
/**
|
|
46261
45636
|
* License service.
|
|
46262
45637
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
46263
|
-
* @version
|
|
45638
|
+
* @version 235.0.0
|
|
46264
45639
|
*/
|
|
46265
45640
|
|
|
46266
45641
|
/**
|
|
@@ -46498,7 +45873,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46498
45873
|
/**
|
|
46499
45874
|
* Locations service.
|
|
46500
45875
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
46501
|
-
* @version
|
|
45876
|
+
* @version 235.0.0
|
|
46502
45877
|
*/
|
|
46503
45878
|
|
|
46504
45879
|
/**
|
|
@@ -46734,7 +46109,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46734
46109
|
/**
|
|
46735
46110
|
* LogCapture service.
|
|
46736
46111
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
46737
|
-
* @version
|
|
46112
|
+
* @version 235.0.0
|
|
46738
46113
|
*/
|
|
46739
46114
|
|
|
46740
46115
|
/**
|
|
@@ -46933,7 +46308,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46933
46308
|
/**
|
|
46934
46309
|
* Messaging service.
|
|
46935
46310
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
46936
|
-
* @version
|
|
46311
|
+
* @version 235.0.0
|
|
46937
46312
|
*/
|
|
46938
46313
|
|
|
46939
46314
|
/**
|
|
@@ -47292,7 +46667,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47292
46667
|
/**
|
|
47293
46668
|
* MobileDevices service.
|
|
47294
46669
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
47295
|
-
* @version
|
|
46670
|
+
* @version 235.0.0
|
|
47296
46671
|
*/
|
|
47297
46672
|
|
|
47298
46673
|
/**
|
|
@@ -47443,7 +46818,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47443
46818
|
/**
|
|
47444
46819
|
* Notifications service.
|
|
47445
46820
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
47446
|
-
* @version
|
|
46821
|
+
* @version 235.0.0
|
|
47447
46822
|
*/
|
|
47448
46823
|
|
|
47449
46824
|
/**
|
|
@@ -47676,7 +47051,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47676
47051
|
/**
|
|
47677
47052
|
* OAuth service.
|
|
47678
47053
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
47679
|
-
* @version
|
|
47054
|
+
* @version 235.0.0
|
|
47680
47055
|
*/
|
|
47681
47056
|
|
|
47682
47057
|
/**
|
|
@@ -48042,7 +47417,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48042
47417
|
/**
|
|
48043
47418
|
* Objects service.
|
|
48044
47419
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
48045
|
-
* @version
|
|
47420
|
+
* @version 235.0.0
|
|
48046
47421
|
*/
|
|
48047
47422
|
|
|
48048
47423
|
/**
|
|
@@ -48366,7 +47741,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48366
47741
|
/**
|
|
48367
47742
|
* OperationalEvents service.
|
|
48368
47743
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
48369
|
-
* @version
|
|
47744
|
+
* @version 235.0.0
|
|
48370
47745
|
*/
|
|
48371
47746
|
|
|
48372
47747
|
/**
|
|
@@ -48483,7 +47858,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48483
47858
|
/**
|
|
48484
47859
|
* Organization service.
|
|
48485
47860
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
48486
|
-
* @version
|
|
47861
|
+
* @version 235.0.0
|
|
48487
47862
|
*/
|
|
48488
47863
|
|
|
48489
47864
|
/**
|
|
@@ -48958,7 +48333,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48958
48333
|
/**
|
|
48959
48334
|
* OrganizationAuthorization service.
|
|
48960
48335
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
48961
|
-
* @version
|
|
48336
|
+
* @version 235.0.0
|
|
48962
48337
|
*/
|
|
48963
48338
|
|
|
48964
48339
|
/**
|
|
@@ -50352,7 +49727,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50352
49727
|
/**
|
|
50353
49728
|
* Outbound service.
|
|
50354
49729
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
50355
|
-
* @version
|
|
49730
|
+
* @version 235.0.0
|
|
50356
49731
|
*/
|
|
50357
49732
|
|
|
50358
49733
|
/**
|
|
@@ -53570,6 +52945,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53570
52945
|
);
|
|
53571
52946
|
}
|
|
53572
52947
|
|
|
52948
|
+
/**
|
|
52949
|
+
* Get performance data for a list of campaigns
|
|
52950
|
+
*
|
|
52951
|
+
* @param {Array.<String>} body Campaign IDs. Maximum of 50 IDs allowed.
|
|
52952
|
+
*/
|
|
52953
|
+
postOutboundCampaignsPerformanceQuery(body) {
|
|
52954
|
+
// verify the required parameter 'body' is set
|
|
52955
|
+
if (body === undefined || body === null) {
|
|
52956
|
+
throw 'Missing the required parameter "body" when calling postOutboundCampaignsPerformanceQuery';
|
|
52957
|
+
}
|
|
52958
|
+
|
|
52959
|
+
return this.apiClient.callApi(
|
|
52960
|
+
'/api/v2/outbound/campaigns/performance/query',
|
|
52961
|
+
'POST',
|
|
52962
|
+
{ },
|
|
52963
|
+
{ },
|
|
52964
|
+
{ },
|
|
52965
|
+
{ },
|
|
52966
|
+
body,
|
|
52967
|
+
['PureCloud OAuth'],
|
|
52968
|
+
['application/json'],
|
|
52969
|
+
['application/json']
|
|
52970
|
+
);
|
|
52971
|
+
}
|
|
52972
|
+
|
|
53573
52973
|
/**
|
|
53574
52974
|
* Get progress for a list of campaigns
|
|
53575
52975
|
*
|
|
@@ -55074,7 +54474,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55074
54474
|
/**
|
|
55075
54475
|
* Presence service.
|
|
55076
54476
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
55077
|
-
* @version
|
|
54477
|
+
* @version 235.0.0
|
|
55078
54478
|
*/
|
|
55079
54479
|
|
|
55080
54480
|
/**
|
|
@@ -55818,7 +55218,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55818
55218
|
/**
|
|
55819
55219
|
* ProcessAutomation service.
|
|
55820
55220
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
55821
|
-
* @version
|
|
55221
|
+
* @version 235.0.0
|
|
55822
55222
|
*/
|
|
55823
55223
|
|
|
55824
55224
|
/**
|
|
@@ -56057,7 +55457,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56057
55457
|
/**
|
|
56058
55458
|
* Quality service.
|
|
56059
55459
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
56060
|
-
* @version
|
|
55460
|
+
* @version 235.0.0
|
|
56061
55461
|
*/
|
|
56062
55462
|
|
|
56063
55463
|
/**
|
|
@@ -57121,59 +56521,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57121
56521
|
);
|
|
57122
56522
|
}
|
|
57123
56523
|
|
|
57124
|
-
/**
|
|
57125
|
-
* Get the most recent published version of an evaluation form across any division.
|
|
57126
|
-
*
|
|
57127
|
-
* @param {String} evaluationFormId Evaluation Form ID
|
|
57128
|
-
* getQualityPublishedformsEvaluationsDivisionview is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57129
|
-
*/
|
|
57130
|
-
getQualityPublishedformsEvaluationsDivisionview(evaluationFormId) {
|
|
57131
|
-
// verify the required parameter 'evaluationFormId' is set
|
|
57132
|
-
if (evaluationFormId === undefined || evaluationFormId === null || evaluationFormId === '') {
|
|
57133
|
-
throw 'Missing the required parameter "evaluationFormId" when calling getQualityPublishedformsEvaluationsDivisionview';
|
|
57134
|
-
}
|
|
57135
|
-
|
|
57136
|
-
return this.apiClient.callApi(
|
|
57137
|
-
'/api/v2/quality/publishedforms/evaluations/divisionviews/{evaluationFormId}',
|
|
57138
|
-
'GET',
|
|
57139
|
-
{ 'evaluationFormId': evaluationFormId },
|
|
57140
|
-
{ },
|
|
57141
|
-
{ },
|
|
57142
|
-
{ },
|
|
57143
|
-
null,
|
|
57144
|
-
['PureCloud OAuth'],
|
|
57145
|
-
['application/json'],
|
|
57146
|
-
['application/json']
|
|
57147
|
-
);
|
|
57148
|
-
}
|
|
57149
|
-
|
|
57150
|
-
/**
|
|
57151
|
-
* Get the published evaluation forms across any division.
|
|
57152
|
-
*
|
|
57153
|
-
* @param {Object} opts Optional parameters
|
|
57154
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
57155
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
57156
|
-
* @param {String} opts.name Name
|
|
57157
|
-
* getQualityPublishedformsEvaluationsDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57158
|
-
*/
|
|
57159
|
-
getQualityPublishedformsEvaluationsDivisionviews(opts) {
|
|
57160
|
-
opts = opts || {};
|
|
57161
|
-
|
|
57162
|
-
|
|
57163
|
-
return this.apiClient.callApi(
|
|
57164
|
-
'/api/v2/quality/publishedforms/evaluations/divisionviews',
|
|
57165
|
-
'GET',
|
|
57166
|
-
{ },
|
|
57167
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'name': opts['name'] },
|
|
57168
|
-
{ },
|
|
57169
|
-
{ },
|
|
57170
|
-
null,
|
|
57171
|
-
['PureCloud OAuth'],
|
|
57172
|
-
['application/json'],
|
|
57173
|
-
['application/json']
|
|
57174
|
-
);
|
|
57175
|
-
}
|
|
57176
|
-
|
|
57177
56524
|
/**
|
|
57178
56525
|
* Get the most recent published version of a survey form.
|
|
57179
56526
|
*
|
|
@@ -57226,59 +56573,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57226
56573
|
);
|
|
57227
56574
|
}
|
|
57228
56575
|
|
|
57229
|
-
/**
|
|
57230
|
-
* Get the most recent published version of an enabled survey form across any division.
|
|
57231
|
-
*
|
|
57232
|
-
* @param {String} surveyFormId Survey Form ID
|
|
57233
|
-
* getQualityPublishedformsSurveysDivisionview is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57234
|
-
*/
|
|
57235
|
-
getQualityPublishedformsSurveysDivisionview(surveyFormId) {
|
|
57236
|
-
// verify the required parameter 'surveyFormId' is set
|
|
57237
|
-
if (surveyFormId === undefined || surveyFormId === null || surveyFormId === '') {
|
|
57238
|
-
throw 'Missing the required parameter "surveyFormId" when calling getQualityPublishedformsSurveysDivisionview';
|
|
57239
|
-
}
|
|
57240
|
-
|
|
57241
|
-
return this.apiClient.callApi(
|
|
57242
|
-
'/api/v2/quality/publishedforms/surveys/divisionviews/{surveyFormId}',
|
|
57243
|
-
'GET',
|
|
57244
|
-
{ 'surveyFormId': surveyFormId },
|
|
57245
|
-
{ },
|
|
57246
|
-
{ },
|
|
57247
|
-
{ },
|
|
57248
|
-
null,
|
|
57249
|
-
['PureCloud OAuth'],
|
|
57250
|
-
['application/json'],
|
|
57251
|
-
['application/json']
|
|
57252
|
-
);
|
|
57253
|
-
}
|
|
57254
|
-
|
|
57255
|
-
/**
|
|
57256
|
-
* Get the published and enabled survey forms across any division.
|
|
57257
|
-
*
|
|
57258
|
-
* @param {Object} opts Optional parameters
|
|
57259
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
57260
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
57261
|
-
* @param {String} opts.name Name
|
|
57262
|
-
* getQualityPublishedformsSurveysDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57263
|
-
*/
|
|
57264
|
-
getQualityPublishedformsSurveysDivisionviews(opts) {
|
|
57265
|
-
opts = opts || {};
|
|
57266
|
-
|
|
57267
|
-
|
|
57268
|
-
return this.apiClient.callApi(
|
|
57269
|
-
'/api/v2/quality/publishedforms/surveys/divisionviews',
|
|
57270
|
-
'GET',
|
|
57271
|
-
{ },
|
|
57272
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'name': opts['name'] },
|
|
57273
|
-
{ },
|
|
57274
|
-
{ },
|
|
57275
|
-
null,
|
|
57276
|
-
['PureCloud OAuth'],
|
|
57277
|
-
['application/json'],
|
|
57278
|
-
['application/json']
|
|
57279
|
-
);
|
|
57280
|
-
}
|
|
57281
|
-
|
|
57282
56576
|
/**
|
|
57283
56577
|
* Get a survey for a conversation
|
|
57284
56578
|
*
|
|
@@ -58002,7 +57296,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58002
57296
|
/**
|
|
58003
57297
|
* Recording service.
|
|
58004
57298
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
58005
|
-
* @version
|
|
57299
|
+
* @version 235.0.0
|
|
58006
57300
|
*/
|
|
58007
57301
|
|
|
58008
57302
|
/**
|
|
@@ -59607,7 +58901,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59607
58901
|
/**
|
|
59608
58902
|
* ResponseManagement service.
|
|
59609
58903
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
59610
|
-
* @version
|
|
58904
|
+
* @version 235.0.0
|
|
59611
58905
|
*/
|
|
59612
58906
|
|
|
59613
58907
|
/**
|
|
@@ -60117,7 +59411,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60117
59411
|
/**
|
|
60118
59412
|
* Routing service.
|
|
60119
59413
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
60120
|
-
* @version
|
|
59414
|
+
* @version 235.0.0
|
|
60121
59415
|
*/
|
|
60122
59416
|
|
|
60123
59417
|
/**
|
|
@@ -60932,6 +60226,56 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60932
60226
|
);
|
|
60933
60227
|
}
|
|
60934
60228
|
|
|
60229
|
+
/**
|
|
60230
|
+
* Get domain dkim settings
|
|
60231
|
+
*
|
|
60232
|
+
* @param {String} domainId domain ID
|
|
60233
|
+
*/
|
|
60234
|
+
getRoutingEmailDomainDkim(domainId) {
|
|
60235
|
+
// verify the required parameter 'domainId' is set
|
|
60236
|
+
if (domainId === undefined || domainId === null || domainId === '') {
|
|
60237
|
+
throw 'Missing the required parameter "domainId" when calling getRoutingEmailDomainDkim';
|
|
60238
|
+
}
|
|
60239
|
+
|
|
60240
|
+
return this.apiClient.callApi(
|
|
60241
|
+
'/api/v2/routing/email/domains/{domainId}/dkim',
|
|
60242
|
+
'GET',
|
|
60243
|
+
{ 'domainId': domainId },
|
|
60244
|
+
{ },
|
|
60245
|
+
{ },
|
|
60246
|
+
{ },
|
|
60247
|
+
null,
|
|
60248
|
+
['PureCloud OAuth'],
|
|
60249
|
+
['application/json'],
|
|
60250
|
+
['application/json']
|
|
60251
|
+
);
|
|
60252
|
+
}
|
|
60253
|
+
|
|
60254
|
+
/**
|
|
60255
|
+
* Get domain mail from settings
|
|
60256
|
+
*
|
|
60257
|
+
* @param {String} domainId domain ID
|
|
60258
|
+
*/
|
|
60259
|
+
getRoutingEmailDomainMailfrom(domainId) {
|
|
60260
|
+
// verify the required parameter 'domainId' is set
|
|
60261
|
+
if (domainId === undefined || domainId === null || domainId === '') {
|
|
60262
|
+
throw 'Missing the required parameter "domainId" when calling getRoutingEmailDomainMailfrom';
|
|
60263
|
+
}
|
|
60264
|
+
|
|
60265
|
+
return this.apiClient.callApi(
|
|
60266
|
+
'/api/v2/routing/email/domains/{domainId}/mailfrom',
|
|
60267
|
+
'GET',
|
|
60268
|
+
{ 'domainId': domainId },
|
|
60269
|
+
{ },
|
|
60270
|
+
{ },
|
|
60271
|
+
{ },
|
|
60272
|
+
null,
|
|
60273
|
+
['PureCloud OAuth'],
|
|
60274
|
+
['application/json'],
|
|
60275
|
+
['application/json']
|
|
60276
|
+
);
|
|
60277
|
+
}
|
|
60278
|
+
|
|
60935
60279
|
/**
|
|
60936
60280
|
* Get a route
|
|
60937
60281
|
*
|
|
@@ -61028,6 +60372,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61028
60372
|
);
|
|
61029
60373
|
}
|
|
61030
60374
|
|
|
60375
|
+
/**
|
|
60376
|
+
* Get domain verification settings
|
|
60377
|
+
*
|
|
60378
|
+
* @param {String} domainId domain ID
|
|
60379
|
+
*/
|
|
60380
|
+
getRoutingEmailDomainVerification(domainId) {
|
|
60381
|
+
// verify the required parameter 'domainId' is set
|
|
60382
|
+
if (domainId === undefined || domainId === null || domainId === '') {
|
|
60383
|
+
throw 'Missing the required parameter "domainId" when calling getRoutingEmailDomainVerification';
|
|
60384
|
+
}
|
|
60385
|
+
|
|
60386
|
+
return this.apiClient.callApi(
|
|
60387
|
+
'/api/v2/routing/email/domains/{domainId}/verification',
|
|
60388
|
+
'GET',
|
|
60389
|
+
{ 'domainId': domainId },
|
|
60390
|
+
{ },
|
|
60391
|
+
{ },
|
|
60392
|
+
{ },
|
|
60393
|
+
null,
|
|
60394
|
+
['PureCloud OAuth'],
|
|
60395
|
+
['application/json'],
|
|
60396
|
+
['application/json']
|
|
60397
|
+
);
|
|
60398
|
+
}
|
|
60399
|
+
|
|
61031
60400
|
/**
|
|
61032
60401
|
* Get domains
|
|
61033
60402
|
*
|
|
@@ -63316,6 +62685,61 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63316
62685
|
);
|
|
63317
62686
|
}
|
|
63318
62687
|
|
|
62688
|
+
/**
|
|
62689
|
+
* Restart domain dkim
|
|
62690
|
+
*
|
|
62691
|
+
* @param {String} domainId domain ID
|
|
62692
|
+
*/
|
|
62693
|
+
postRoutingEmailDomainDkim(domainId) {
|
|
62694
|
+
// verify the required parameter 'domainId' is set
|
|
62695
|
+
if (domainId === undefined || domainId === null || domainId === '') {
|
|
62696
|
+
throw 'Missing the required parameter "domainId" when calling postRoutingEmailDomainDkim';
|
|
62697
|
+
}
|
|
62698
|
+
|
|
62699
|
+
return this.apiClient.callApi(
|
|
62700
|
+
'/api/v2/routing/email/domains/{domainId}/dkim',
|
|
62701
|
+
'POST',
|
|
62702
|
+
{ 'domainId': domainId },
|
|
62703
|
+
{ },
|
|
62704
|
+
{ },
|
|
62705
|
+
{ },
|
|
62706
|
+
null,
|
|
62707
|
+
['PureCloud OAuth'],
|
|
62708
|
+
['application/json'],
|
|
62709
|
+
['application/json']
|
|
62710
|
+
);
|
|
62711
|
+
}
|
|
62712
|
+
|
|
62713
|
+
/**
|
|
62714
|
+
* Set domain mail from settings
|
|
62715
|
+
*
|
|
62716
|
+
* @param {String} domainId domain ID
|
|
62717
|
+
* @param {Object} body Mail From Settings
|
|
62718
|
+
*/
|
|
62719
|
+
postRoutingEmailDomainMailfrom(domainId, body) {
|
|
62720
|
+
// verify the required parameter 'domainId' is set
|
|
62721
|
+
if (domainId === undefined || domainId === null || domainId === '') {
|
|
62722
|
+
throw 'Missing the required parameter "domainId" when calling postRoutingEmailDomainMailfrom';
|
|
62723
|
+
}
|
|
62724
|
+
// verify the required parameter 'body' is set
|
|
62725
|
+
if (body === undefined || body === null) {
|
|
62726
|
+
throw 'Missing the required parameter "body" when calling postRoutingEmailDomainMailfrom';
|
|
62727
|
+
}
|
|
62728
|
+
|
|
62729
|
+
return this.apiClient.callApi(
|
|
62730
|
+
'/api/v2/routing/email/domains/{domainId}/mailfrom',
|
|
62731
|
+
'POST',
|
|
62732
|
+
{ 'domainId': domainId },
|
|
62733
|
+
{ },
|
|
62734
|
+
{ },
|
|
62735
|
+
{ },
|
|
62736
|
+
body,
|
|
62737
|
+
['PureCloud OAuth'],
|
|
62738
|
+
['application/json'],
|
|
62739
|
+
['application/json']
|
|
62740
|
+
);
|
|
62741
|
+
}
|
|
62742
|
+
|
|
63319
62743
|
/**
|
|
63320
62744
|
* Create a route
|
|
63321
62745
|
*
|
|
@@ -63375,6 +62799,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63375
62799
|
);
|
|
63376
62800
|
}
|
|
63377
62801
|
|
|
62802
|
+
/**
|
|
62803
|
+
* Restart domain verification
|
|
62804
|
+
*
|
|
62805
|
+
* @param {String} domainId domain ID
|
|
62806
|
+
*/
|
|
62807
|
+
postRoutingEmailDomainVerification(domainId) {
|
|
62808
|
+
// verify the required parameter 'domainId' is set
|
|
62809
|
+
if (domainId === undefined || domainId === null || domainId === '') {
|
|
62810
|
+
throw 'Missing the required parameter "domainId" when calling postRoutingEmailDomainVerification';
|
|
62811
|
+
}
|
|
62812
|
+
|
|
62813
|
+
return this.apiClient.callApi(
|
|
62814
|
+
'/api/v2/routing/email/domains/{domainId}/verification',
|
|
62815
|
+
'POST',
|
|
62816
|
+
{ 'domainId': domainId },
|
|
62817
|
+
{ },
|
|
62818
|
+
{ },
|
|
62819
|
+
{ },
|
|
62820
|
+
null,
|
|
62821
|
+
['PureCloud OAuth'],
|
|
62822
|
+
['application/json'],
|
|
62823
|
+
['application/json']
|
|
62824
|
+
);
|
|
62825
|
+
}
|
|
62826
|
+
|
|
63378
62827
|
/**
|
|
63379
62828
|
* Create a domain
|
|
63380
62829
|
*
|
|
@@ -64445,7 +63894,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64445
63894
|
/**
|
|
64446
63895
|
* SCIM service.
|
|
64447
63896
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
64448
|
-
* @version
|
|
63897
|
+
* @version 235.0.0
|
|
64449
63898
|
*/
|
|
64450
63899
|
|
|
64451
63900
|
/**
|
|
@@ -65322,7 +64771,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65322
64771
|
/**
|
|
65323
64772
|
* ScreenRecording service.
|
|
65324
64773
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
65325
|
-
* @version
|
|
64774
|
+
* @version 235.0.0
|
|
65326
64775
|
*/
|
|
65327
64776
|
|
|
65328
64777
|
/**
|
|
@@ -65367,7 +64816,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65367
64816
|
/**
|
|
65368
64817
|
* Scripts service.
|
|
65369
64818
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
65370
|
-
* @version
|
|
64819
|
+
* @version 235.0.0
|
|
65371
64820
|
*/
|
|
65372
64821
|
|
|
65373
64822
|
/**
|
|
@@ -65843,7 +65292,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65843
65292
|
/**
|
|
65844
65293
|
* Search service.
|
|
65845
65294
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
65846
|
-
* @version
|
|
65295
|
+
* @version 235.0.0
|
|
65847
65296
|
*/
|
|
65848
65297
|
|
|
65849
65298
|
/**
|
|
@@ -66240,36 +65689,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66240
65689
|
);
|
|
66241
65690
|
}
|
|
66242
65691
|
|
|
66243
|
-
/**
|
|
66244
|
-
* Search Documents
|
|
66245
|
-
*
|
|
66246
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
66247
|
-
* @param {Object} opts Optional parameters
|
|
66248
|
-
* @param {Object} opts.body
|
|
66249
|
-
* @deprecated
|
|
66250
|
-
*/
|
|
66251
|
-
postKnowledgeKnowledgebaseSearch(knowledgeBaseId, opts) {
|
|
66252
|
-
opts = opts || {};
|
|
66253
|
-
|
|
66254
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
66255
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
66256
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSearch';
|
|
66257
|
-
}
|
|
66258
|
-
|
|
66259
|
-
return this.apiClient.callApi(
|
|
66260
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/search',
|
|
66261
|
-
'POST',
|
|
66262
|
-
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
66263
|
-
{ },
|
|
66264
|
-
{ },
|
|
66265
|
-
{ },
|
|
66266
|
-
opts['body'],
|
|
66267
|
-
['PureCloud OAuth'],
|
|
66268
|
-
['application/json'],
|
|
66269
|
-
['application/json']
|
|
66270
|
-
);
|
|
66271
|
-
}
|
|
66272
|
-
|
|
66273
65692
|
/**
|
|
66274
65693
|
* Search locations
|
|
66275
65694
|
*
|
|
@@ -66561,7 +65980,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66561
65980
|
/**
|
|
66562
65981
|
* Settings service.
|
|
66563
65982
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
66564
|
-
* @version
|
|
65983
|
+
* @version 235.0.0
|
|
66565
65984
|
*/
|
|
66566
65985
|
|
|
66567
65986
|
/**
|
|
@@ -66909,7 +66328,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66909
66328
|
/**
|
|
66910
66329
|
* SocialMedia service.
|
|
66911
66330
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
66912
|
-
* @version
|
|
66331
|
+
* @version 235.0.0
|
|
66913
66332
|
*/
|
|
66914
66333
|
|
|
66915
66334
|
/**
|
|
@@ -67252,8 +66671,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67252
66671
|
* Get a single escalation rule.
|
|
67253
66672
|
*
|
|
67254
66673
|
* @param {String} escalationRuleId escalationRuleId
|
|
66674
|
+
* @param {Object} opts Optional parameters
|
|
66675
|
+
* @param {Object} opts.expand which fields, if any, to expand
|
|
67255
66676
|
*/
|
|
67256
|
-
getSocialmediaEscalationrule(escalationRuleId) {
|
|
66677
|
+
getSocialmediaEscalationrule(escalationRuleId, opts) {
|
|
66678
|
+
opts = opts || {};
|
|
66679
|
+
|
|
67257
66680
|
// verify the required parameter 'escalationRuleId' is set
|
|
67258
66681
|
if (escalationRuleId === undefined || escalationRuleId === null || escalationRuleId === '') {
|
|
67259
66682
|
throw 'Missing the required parameter "escalationRuleId" when calling getSocialmediaEscalationrule';
|
|
@@ -67263,7 +66686,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67263
66686
|
'/api/v2/socialmedia/escalationrules/{escalationRuleId}',
|
|
67264
66687
|
'GET',
|
|
67265
66688
|
{ 'escalationRuleId': escalationRuleId },
|
|
67266
|
-
{
|
|
66689
|
+
{ 'expand': opts['expand'] },
|
|
67267
66690
|
{ },
|
|
67268
66691
|
{ },
|
|
67269
66692
|
null,
|
|
@@ -68500,7 +67923,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68500
67923
|
/**
|
|
68501
67924
|
* SpeechTextAnalytics service.
|
|
68502
67925
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
68503
|
-
* @version
|
|
67926
|
+
* @version 235.0.0
|
|
68504
67927
|
*/
|
|
68505
67928
|
|
|
68506
67929
|
/**
|
|
@@ -70147,7 +69570,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70147
69570
|
/**
|
|
70148
69571
|
* Stations service.
|
|
70149
69572
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
70150
|
-
* @version
|
|
69573
|
+
* @version 235.0.0
|
|
70151
69574
|
*/
|
|
70152
69575
|
|
|
70153
69576
|
/**
|
|
@@ -70249,7 +69672,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70249
69672
|
/**
|
|
70250
69673
|
* Suggest service.
|
|
70251
69674
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
70252
|
-
* @version
|
|
69675
|
+
* @version 235.0.0
|
|
70253
69676
|
*/
|
|
70254
69677
|
|
|
70255
69678
|
/**
|
|
@@ -70388,7 +69811,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70388
69811
|
/**
|
|
70389
69812
|
* TaskManagement service.
|
|
70390
69813
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
70391
|
-
* @version
|
|
69814
|
+
* @version 235.0.0
|
|
70392
69815
|
*/
|
|
70393
69816
|
|
|
70394
69817
|
/**
|
|
@@ -72550,7 +71973,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
72550
71973
|
/**
|
|
72551
71974
|
* Teams service.
|
|
72552
71975
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
72553
|
-
* @version
|
|
71976
|
+
* @version 235.0.0
|
|
72554
71977
|
*/
|
|
72555
71978
|
|
|
72556
71979
|
/**
|
|
@@ -72855,7 +72278,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
72855
72278
|
/**
|
|
72856
72279
|
* Telephony service.
|
|
72857
72280
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
72858
|
-
* @version
|
|
72281
|
+
* @version 235.0.0
|
|
72859
72282
|
*/
|
|
72860
72283
|
|
|
72861
72284
|
/**
|
|
@@ -73141,7 +72564,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
73141
72564
|
/**
|
|
73142
72565
|
* TelephonyProvidersEdge service.
|
|
73143
72566
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
73144
|
-
* @version
|
|
72567
|
+
* @version 235.0.0
|
|
73145
72568
|
*/
|
|
73146
72569
|
|
|
73147
72570
|
/**
|
|
@@ -76634,7 +76057,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
76634
76057
|
/**
|
|
76635
76058
|
* Textbots service.
|
|
76636
76059
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
76637
|
-
* @version
|
|
76060
|
+
* @version 235.0.0
|
|
76638
76061
|
*/
|
|
76639
76062
|
|
|
76640
76063
|
/**
|
|
@@ -76763,7 +76186,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
76763
76186
|
/**
|
|
76764
76187
|
* Tokens service.
|
|
76765
76188
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
76766
|
-
* @version
|
|
76189
|
+
* @version 235.0.0
|
|
76767
76190
|
*/
|
|
76768
76191
|
|
|
76769
76192
|
/**
|
|
@@ -76917,7 +76340,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
76917
76340
|
/**
|
|
76918
76341
|
* Uploads service.
|
|
76919
76342
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
76920
|
-
* @version
|
|
76343
|
+
* @version 235.0.0
|
|
76921
76344
|
*/
|
|
76922
76345
|
|
|
76923
76346
|
/**
|
|
@@ -77208,7 +76631,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
77208
76631
|
/**
|
|
77209
76632
|
* Usage service.
|
|
77210
76633
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
77211
|
-
* @version
|
|
76634
|
+
* @version 235.0.0
|
|
77212
76635
|
*/
|
|
77213
76636
|
|
|
77214
76637
|
/**
|
|
@@ -77543,7 +76966,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
77543
76966
|
/**
|
|
77544
76967
|
* UserRecordings service.
|
|
77545
76968
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
77546
|
-
* @version
|
|
76969
|
+
* @version 235.0.0
|
|
77547
76970
|
*/
|
|
77548
76971
|
|
|
77549
76972
|
/**
|
|
@@ -77727,7 +77150,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
77727
77150
|
/**
|
|
77728
77151
|
* Users service.
|
|
77729
77152
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
77730
|
-
* @version
|
|
77153
|
+
* @version 235.0.0
|
|
77731
77154
|
*/
|
|
77732
77155
|
|
|
77733
77156
|
/**
|
|
@@ -80736,7 +80159,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
80736
80159
|
/**
|
|
80737
80160
|
* Utilities service.
|
|
80738
80161
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
80739
|
-
* @version
|
|
80162
|
+
* @version 235.0.0
|
|
80740
80163
|
*/
|
|
80741
80164
|
|
|
80742
80165
|
/**
|
|
@@ -80847,7 +80270,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
80847
80270
|
/**
|
|
80848
80271
|
* Voicemail service.
|
|
80849
80272
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
80850
|
-
* @version
|
|
80273
|
+
* @version 235.0.0
|
|
80851
80274
|
*/
|
|
80852
80275
|
|
|
80853
80276
|
/**
|
|
@@ -81569,7 +80992,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
81569
80992
|
/**
|
|
81570
80993
|
* WebChat service.
|
|
81571
80994
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
81572
|
-
* @version
|
|
80995
|
+
* @version 235.0.0
|
|
81573
80996
|
*/
|
|
81574
80997
|
|
|
81575
80998
|
/**
|
|
@@ -82132,7 +81555,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
82132
81555
|
/**
|
|
82133
81556
|
* WebDeployments service.
|
|
82134
81557
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
82135
|
-
* @version
|
|
81558
|
+
* @version 235.0.0
|
|
82136
81559
|
*/
|
|
82137
81560
|
|
|
82138
81561
|
/**
|
|
@@ -82570,7 +81993,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
82570
81993
|
}
|
|
82571
81994
|
|
|
82572
81995
|
/**
|
|
82573
|
-
* Exchange an oAuth code (obtained using the Authorization Code Flow) for a JWT that can be used by webdeployments.
|
|
81996
|
+
* Exchange an oAuth code (obtained using the Authorization Code Flow or Implicit flow) for a JWT that can be used by webdeployments.
|
|
82574
81997
|
*
|
|
82575
81998
|
* @param {Object} body webDeploymentsOAuthExchangeRequest
|
|
82576
81999
|
*/
|
|
@@ -82714,7 +82137,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
82714
82137
|
/**
|
|
82715
82138
|
* WebMessaging service.
|
|
82716
82139
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
82717
|
-
* @version
|
|
82140
|
+
* @version 235.0.0
|
|
82718
82141
|
*/
|
|
82719
82142
|
|
|
82720
82143
|
/**
|
|
@@ -82860,7 +82283,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
82860
82283
|
/**
|
|
82861
82284
|
* Widgets service.
|
|
82862
82285
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
82863
|
-
* @version
|
|
82286
|
+
* @version 235.0.0
|
|
82864
82287
|
*/
|
|
82865
82288
|
|
|
82866
82289
|
/**
|
|
@@ -83011,7 +82434,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83011
82434
|
/**
|
|
83012
82435
|
* WorkforceManagement service.
|
|
83013
82436
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
83014
|
-
* @version
|
|
82437
|
+
* @version 235.0.0
|
|
83015
82438
|
*/
|
|
83016
82439
|
|
|
83017
82440
|
/**
|
|
@@ -85411,6 +84834,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85411
84834
|
* @param {String} forecastId The ID of the forecast
|
|
85412
84835
|
* @param {Object} opts Optional parameters
|
|
85413
84836
|
* @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
|
|
84837
|
+
* @param {Array.<String>} opts.expand Expand to include minimum staffing values in (staffing requirement response or applied to base staffing requirement values)
|
|
85414
84838
|
*/
|
|
85415
84839
|
getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement(businessUnitId, weekDateId, forecastId, opts) {
|
|
85416
84840
|
opts = opts || {};
|
|
@@ -85432,7 +84856,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85432
84856
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/staffingrequirement',
|
|
85433
84857
|
'GET',
|
|
85434
84858
|
{ 'businessUnitId': businessUnitId,'weekDateId': weekDateId,'forecastId': forecastId },
|
|
85435
|
-
{ 'weekNumbers': this.apiClient.buildCollectionParam(opts['weekNumbers'], 'multi') },
|
|
84859
|
+
{ 'weekNumbers': this.apiClient.buildCollectionParam(opts['weekNumbers'], 'multi'),'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
85436
84860
|
{ },
|
|
85437
84861
|
{ },
|
|
85438
84862
|
null,
|
|
@@ -91011,7 +90435,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
91011
90435
|
* </pre>
|
|
91012
90436
|
* </p>
|
|
91013
90437
|
* @module purecloud-platform-client-v2/index
|
|
91014
|
-
* @version
|
|
90438
|
+
* @version 235.0.0
|
|
91015
90439
|
*/
|
|
91016
90440
|
class platformClient {
|
|
91017
90441
|
constructor() {
|