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
|
@@ -748,7 +748,7 @@ class Configuration {
|
|
|
748
748
|
|
|
749
749
|
/**
|
|
750
750
|
* @module purecloud-platform-client-v2/ApiClient
|
|
751
|
-
* @version
|
|
751
|
+
* @version 235.0.0
|
|
752
752
|
*/
|
|
753
753
|
class ApiClient {
|
|
754
754
|
/**
|
|
@@ -951,6 +951,50 @@ class ApiClient {
|
|
|
951
951
|
this.config.setEnvironment(environment);
|
|
952
952
|
}
|
|
953
953
|
|
|
954
|
+
/**
|
|
955
|
+
* @description Sets the optional http headers used by the client
|
|
956
|
+
* @param {object} newHeaders - default headers to be used
|
|
957
|
+
*/
|
|
958
|
+
setDefaultHeaders(newHeaders) {
|
|
959
|
+
if (!newHeaders || !(typeof newHeaders === 'object')) {
|
|
960
|
+
throw new Error("default headers must be a map");
|
|
961
|
+
}
|
|
962
|
+
this.defaultHeaders = newHeaders;
|
|
963
|
+
}
|
|
964
|
+
|
|
965
|
+
/**
|
|
966
|
+
* @description Gets the default http headers used by the client
|
|
967
|
+
*/
|
|
968
|
+
getDefaultHeaders() {
|
|
969
|
+
return this.defaultHeaders;
|
|
970
|
+
}
|
|
971
|
+
|
|
972
|
+
/**
|
|
973
|
+
* @description Sets the optional Genesys-App http header used by the client
|
|
974
|
+
* @param {string} headerValue - value for the Genesys-App header
|
|
975
|
+
*/
|
|
976
|
+
setGenesysAppHeader(headerValue) {
|
|
977
|
+
if (!headerValue || !(typeof headerValue === 'string')) throw new Error("headerValue must be a non empty string");
|
|
978
|
+
if (!this.defaultHeaders) {
|
|
979
|
+
this.defaultHeaders = {
|
|
980
|
+
"Genesys-App": headerValue
|
|
981
|
+
};
|
|
982
|
+
} else {
|
|
983
|
+
this.defaultHeaders["Genesys-App"] = headerValue;
|
|
984
|
+
}
|
|
985
|
+
}
|
|
986
|
+
|
|
987
|
+
/**
|
|
988
|
+
* @description Gets the Genesys-App http header used by the client
|
|
989
|
+
*/
|
|
990
|
+
getGenesysAppHeader() {
|
|
991
|
+
if (this.defaultHeaders && this.defaultHeaders["Genesys-App"]) {
|
|
992
|
+
return this.defaultHeaders["Genesys-App"];
|
|
993
|
+
} else {
|
|
994
|
+
return null;
|
|
995
|
+
}
|
|
996
|
+
}
|
|
997
|
+
|
|
954
998
|
/**
|
|
955
999
|
* @description Sets the dynamic HttpClient used by the client
|
|
956
1000
|
* @param {object} httpClient - HttpClient to be injected
|
|
@@ -2317,7 +2361,7 @@ class AIStudioApi {
|
|
|
2317
2361
|
/**
|
|
2318
2362
|
* AIStudio service.
|
|
2319
2363
|
* @module purecloud-platform-client-v2/api/AIStudioApi
|
|
2320
|
-
* @version
|
|
2364
|
+
* @version 235.0.0
|
|
2321
2365
|
*/
|
|
2322
2366
|
|
|
2323
2367
|
/**
|
|
@@ -2889,7 +2933,7 @@ class AgentAssistantsApi {
|
|
|
2889
2933
|
/**
|
|
2890
2934
|
* AgentAssistants service.
|
|
2891
2935
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
2892
|
-
* @version
|
|
2936
|
+
* @version 235.0.0
|
|
2893
2937
|
*/
|
|
2894
2938
|
|
|
2895
2939
|
/**
|
|
@@ -3375,7 +3419,7 @@ class AgentCopilotApi {
|
|
|
3375
3419
|
/**
|
|
3376
3420
|
* AgentCopilot service.
|
|
3377
3421
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
3378
|
-
* @version
|
|
3422
|
+
* @version 235.0.0
|
|
3379
3423
|
*/
|
|
3380
3424
|
|
|
3381
3425
|
/**
|
|
@@ -3475,7 +3519,7 @@ class AgentUIApi {
|
|
|
3475
3519
|
/**
|
|
3476
3520
|
* AgentUI service.
|
|
3477
3521
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
3478
|
-
* @version
|
|
3522
|
+
* @version 235.0.0
|
|
3479
3523
|
*/
|
|
3480
3524
|
|
|
3481
3525
|
/**
|
|
@@ -3606,7 +3650,7 @@ class AlertingApi {
|
|
|
3606
3650
|
/**
|
|
3607
3651
|
* Alerting service.
|
|
3608
3652
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
3609
|
-
* @version
|
|
3653
|
+
* @version 235.0.0
|
|
3610
3654
|
*/
|
|
3611
3655
|
|
|
3612
3656
|
/**
|
|
@@ -4007,7 +4051,7 @@ class AnalyticsApi {
|
|
|
4007
4051
|
/**
|
|
4008
4052
|
* Analytics service.
|
|
4009
4053
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
4010
|
-
* @version
|
|
4054
|
+
* @version 235.0.0
|
|
4011
4055
|
*/
|
|
4012
4056
|
|
|
4013
4057
|
/**
|
|
@@ -7275,7 +7319,7 @@ class ArchitectApi {
|
|
|
7275
7319
|
/**
|
|
7276
7320
|
* Architect service.
|
|
7277
7321
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
7278
|
-
* @version
|
|
7322
|
+
* @version 235.0.0
|
|
7279
7323
|
*/
|
|
7280
7324
|
|
|
7281
7325
|
/**
|
|
@@ -11570,7 +11614,7 @@ class AuditApi {
|
|
|
11570
11614
|
/**
|
|
11571
11615
|
* Audit service.
|
|
11572
11616
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
11573
|
-
* @version
|
|
11617
|
+
* @version 235.0.0
|
|
11574
11618
|
*/
|
|
11575
11619
|
|
|
11576
11620
|
/**
|
|
@@ -11771,7 +11815,7 @@ class AuthorizationApi {
|
|
|
11771
11815
|
/**
|
|
11772
11816
|
* Authorization service.
|
|
11773
11817
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
11774
|
-
* @version
|
|
11818
|
+
* @version 235.0.0
|
|
11775
11819
|
*/
|
|
11776
11820
|
|
|
11777
11821
|
/**
|
|
@@ -13486,7 +13530,7 @@ class BillingApi {
|
|
|
13486
13530
|
/**
|
|
13487
13531
|
* Billing service.
|
|
13488
13532
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
13489
|
-
* @version
|
|
13533
|
+
* @version 235.0.0
|
|
13490
13534
|
*/
|
|
13491
13535
|
|
|
13492
13536
|
/**
|
|
@@ -13742,7 +13786,7 @@ class BusinessRulesApi {
|
|
|
13742
13786
|
/**
|
|
13743
13787
|
* BusinessRules service.
|
|
13744
13788
|
* @module purecloud-platform-client-v2/api/BusinessRulesApi
|
|
13745
|
-
* @version
|
|
13789
|
+
* @version 235.0.0
|
|
13746
13790
|
*/
|
|
13747
13791
|
|
|
13748
13792
|
/**
|
|
@@ -13763,7 +13807,6 @@ class BusinessRulesApi {
|
|
|
13763
13807
|
* @param {String} tableId Table ID
|
|
13764
13808
|
* @param {Object} opts Optional parameters
|
|
13765
13809
|
* @param {Boolean} opts.forceDelete Force delete decision table (under certain conditions) (default to false)
|
|
13766
|
-
* deleteBusinessrulesDecisiontable is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13767
13810
|
*/
|
|
13768
13811
|
deleteBusinessrulesDecisiontable(tableId, opts) {
|
|
13769
13812
|
opts = opts || {};
|
|
@@ -13792,7 +13835,6 @@ class BusinessRulesApi {
|
|
|
13792
13835
|
*
|
|
13793
13836
|
* @param {String} tableId Table ID
|
|
13794
13837
|
* @param {Number} tableVersion Table Version
|
|
13795
|
-
* deleteBusinessrulesDecisiontableVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13796
13838
|
*/
|
|
13797
13839
|
deleteBusinessrulesDecisiontableVersion(tableId, tableVersion) {
|
|
13798
13840
|
// verify the required parameter 'tableId' is set
|
|
@@ -13824,7 +13866,6 @@ class BusinessRulesApi {
|
|
|
13824
13866
|
* @param {String} tableId Table ID
|
|
13825
13867
|
* @param {Number} tableVersion Table Version
|
|
13826
13868
|
* @param {String} rowId Row ID
|
|
13827
|
-
* deleteBusinessrulesDecisiontableVersionRow is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13828
13869
|
*/
|
|
13829
13870
|
deleteBusinessrulesDecisiontableVersionRow(tableId, tableVersion, rowId) {
|
|
13830
13871
|
// verify the required parameter 'tableId' is set
|
|
@@ -13858,7 +13899,6 @@ class BusinessRulesApi {
|
|
|
13858
13899
|
* Delete a schema
|
|
13859
13900
|
*
|
|
13860
13901
|
* @param {String} schemaId Schema ID
|
|
13861
|
-
* deleteBusinessrulesSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13862
13902
|
*/
|
|
13863
13903
|
deleteBusinessrulesSchema(schemaId) {
|
|
13864
13904
|
// verify the required parameter 'schemaId' is set
|
|
@@ -13884,7 +13924,6 @@ class BusinessRulesApi {
|
|
|
13884
13924
|
* Get a decision table
|
|
13885
13925
|
*
|
|
13886
13926
|
* @param {String} tableId Table ID
|
|
13887
|
-
* getBusinessrulesDecisiontable is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13888
13927
|
*/
|
|
13889
13928
|
getBusinessrulesDecisiontable(tableId) {
|
|
13890
13929
|
// verify the required parameter 'tableId' is set
|
|
@@ -13911,7 +13950,6 @@ class BusinessRulesApi {
|
|
|
13911
13950
|
*
|
|
13912
13951
|
* @param {String} tableId Table ID
|
|
13913
13952
|
* @param {Number} tableVersion Table Version
|
|
13914
|
-
* getBusinessrulesDecisiontableVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13915
13953
|
*/
|
|
13916
13954
|
getBusinessrulesDecisiontableVersion(tableId, tableVersion) {
|
|
13917
13955
|
// verify the required parameter 'tableId' is set
|
|
@@ -13943,7 +13981,6 @@ class BusinessRulesApi {
|
|
|
13943
13981
|
* @param {String} tableId Table ID
|
|
13944
13982
|
* @param {Number} tableVersion Table Version
|
|
13945
13983
|
* @param {String} rowId Row ID
|
|
13946
|
-
* getBusinessrulesDecisiontableVersionRow is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13947
13984
|
*/
|
|
13948
13985
|
getBusinessrulesDecisiontableVersionRow(tableId, tableVersion, rowId) {
|
|
13949
13986
|
// verify the required parameter 'tableId' is set
|
|
@@ -13981,7 +14018,6 @@ class BusinessRulesApi {
|
|
|
13981
14018
|
* @param {Object} opts Optional parameters
|
|
13982
14019
|
* @param {String} opts.pageNumber Page number of the entities to return. Defaults to 1.
|
|
13983
14020
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 100. Defaults to 25.
|
|
13984
|
-
* getBusinessrulesDecisiontableVersionRows is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13985
14021
|
*/
|
|
13986
14022
|
getBusinessrulesDecisiontableVersionRows(tableId, tableVersion, opts) {
|
|
13987
14023
|
opts = opts || {};
|
|
@@ -14016,7 +14052,6 @@ class BusinessRulesApi {
|
|
|
14016
14052
|
* @param {Object} opts Optional parameters
|
|
14017
14053
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
14018
14054
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 100.
|
|
14019
|
-
* getBusinessrulesDecisiontableVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14020
14055
|
*/
|
|
14021
14056
|
getBusinessrulesDecisiontableVersions(tableId, opts) {
|
|
14022
14057
|
opts = opts || {};
|
|
@@ -14048,7 +14083,6 @@ class BusinessRulesApi {
|
|
|
14048
14083
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 100.
|
|
14049
14084
|
* @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.
|
|
14050
14085
|
* @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.
|
|
14051
|
-
* getBusinessrulesDecisiontables is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14052
14086
|
*/
|
|
14053
14087
|
getBusinessrulesDecisiontables(opts) {
|
|
14054
14088
|
opts = opts || {};
|
|
@@ -14079,7 +14113,6 @@ class BusinessRulesApi {
|
|
|
14079
14113
|
* @param {Boolean} opts.withPublishedVersion Filters results to only decision tables that have at least one version in Published status
|
|
14080
14114
|
* @param {Array.<String>} opts.expand Fields to expand in response
|
|
14081
14115
|
* @param {Array.<String>} opts.ids Decision table IDs to search for
|
|
14082
|
-
* getBusinessrulesDecisiontablesSearch is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14083
14116
|
*/
|
|
14084
14117
|
getBusinessrulesDecisiontablesSearch(opts) {
|
|
14085
14118
|
opts = opts || {};
|
|
@@ -14103,7 +14136,6 @@ class BusinessRulesApi {
|
|
|
14103
14136
|
* Get a schema
|
|
14104
14137
|
*
|
|
14105
14138
|
* @param {String} schemaId Schema ID
|
|
14106
|
-
* getBusinessrulesSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14107
14139
|
*/
|
|
14108
14140
|
getBusinessrulesSchema(schemaId) {
|
|
14109
14141
|
// verify the required parameter 'schemaId' is set
|
|
@@ -14128,7 +14160,6 @@ class BusinessRulesApi {
|
|
|
14128
14160
|
/**
|
|
14129
14161
|
* Get a list of schemas.
|
|
14130
14162
|
*
|
|
14131
|
-
* getBusinessrulesSchemas is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14132
14163
|
*/
|
|
14133
14164
|
getBusinessrulesSchemas() {
|
|
14134
14165
|
|
|
@@ -14150,7 +14181,6 @@ class BusinessRulesApi {
|
|
|
14150
14181
|
* Get a specific named core type.
|
|
14151
14182
|
*
|
|
14152
14183
|
* @param {String} coreTypeName The core type's name
|
|
14153
|
-
* getBusinessrulesSchemasCoretype is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14154
14184
|
*/
|
|
14155
14185
|
getBusinessrulesSchemasCoretype(coreTypeName) {
|
|
14156
14186
|
// verify the required parameter 'coreTypeName' is set
|
|
@@ -14175,7 +14205,6 @@ class BusinessRulesApi {
|
|
|
14175
14205
|
/**
|
|
14176
14206
|
* Get the core types from which all schemas are built.
|
|
14177
14207
|
*
|
|
14178
|
-
* getBusinessrulesSchemasCoretypes is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14179
14208
|
*/
|
|
14180
14209
|
getBusinessrulesSchemasCoretypes() {
|
|
14181
14210
|
|
|
@@ -14198,7 +14227,6 @@ class BusinessRulesApi {
|
|
|
14198
14227
|
*
|
|
14199
14228
|
* @param {String} tableId Table ID
|
|
14200
14229
|
* @param {Object} body Decision Table
|
|
14201
|
-
* patchBusinessrulesDecisiontable is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14202
14230
|
*/
|
|
14203
14231
|
patchBusinessrulesDecisiontable(tableId, body) {
|
|
14204
14232
|
// verify the required parameter 'tableId' is set
|
|
@@ -14230,7 +14258,6 @@ class BusinessRulesApi {
|
|
|
14230
14258
|
* @param {String} tableId Table ID
|
|
14231
14259
|
* @param {Number} tableVersion Table Version
|
|
14232
14260
|
* @param {Object} body Decision Table
|
|
14233
|
-
* patchBusinessrulesDecisiontableVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14234
14261
|
*/
|
|
14235
14262
|
patchBusinessrulesDecisiontableVersion(tableId, tableVersion, body) {
|
|
14236
14263
|
// verify the required parameter 'tableId' is set
|
|
@@ -14265,7 +14292,6 @@ class BusinessRulesApi {
|
|
|
14265
14292
|
*
|
|
14266
14293
|
* @param {String} tableId Table ID
|
|
14267
14294
|
* @param {Object} body Decision Table
|
|
14268
|
-
* postBusinessrulesDecisiontableExecute is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14269
14295
|
*/
|
|
14270
14296
|
postBusinessrulesDecisiontableExecute(tableId, body) {
|
|
14271
14297
|
// verify the required parameter 'tableId' is set
|
|
@@ -14297,7 +14323,6 @@ class BusinessRulesApi {
|
|
|
14297
14323
|
* @param {String} tableId Table ID
|
|
14298
14324
|
* @param {Number} tableVersion Table Version
|
|
14299
14325
|
* @param {Object} body Decision Table
|
|
14300
|
-
* postBusinessrulesDecisiontableVersionCopy is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14301
14326
|
*/
|
|
14302
14327
|
postBusinessrulesDecisiontableVersionCopy(tableId, tableVersion, body) {
|
|
14303
14328
|
// verify the required parameter 'tableId' is set
|
|
@@ -14333,7 +14358,6 @@ class BusinessRulesApi {
|
|
|
14333
14358
|
* @param {String} tableId Table ID
|
|
14334
14359
|
* @param {Number} tableVersion Table Version
|
|
14335
14360
|
* @param {Object} body Decision Table
|
|
14336
|
-
* postBusinessrulesDecisiontableVersionExecute is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14337
14361
|
*/
|
|
14338
14362
|
postBusinessrulesDecisiontableVersionExecute(tableId, tableVersion, body) {
|
|
14339
14363
|
// verify the required parameter 'tableId' is set
|
|
@@ -14369,7 +14393,6 @@ class BusinessRulesApi {
|
|
|
14369
14393
|
* @param {String} tableId Table ID
|
|
14370
14394
|
* @param {Number} tableVersion Table Version
|
|
14371
14395
|
* @param {Object} body Create decision table row request
|
|
14372
|
-
* postBusinessrulesDecisiontableVersionRows is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14373
14396
|
*/
|
|
14374
14397
|
postBusinessrulesDecisiontableVersionRows(tableId, tableVersion, body) {
|
|
14375
14398
|
// verify the required parameter 'tableId' is set
|
|
@@ -14408,7 +14431,6 @@ class BusinessRulesApi {
|
|
|
14408
14431
|
* @param {Object} opts Optional parameters
|
|
14409
14432
|
* @param {String} opts.pageNumber Page number of the entities to return. Defaults to 1.
|
|
14410
14433
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 100. Defaults to 25.
|
|
14411
|
-
* postBusinessrulesDecisiontableVersionRowsSearch is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14412
14434
|
*/
|
|
14413
14435
|
postBusinessrulesDecisiontableVersionRowsSearch(tableId, tableVersion, body, opts) {
|
|
14414
14436
|
opts = opts || {};
|
|
@@ -14445,7 +14467,6 @@ class BusinessRulesApi {
|
|
|
14445
14467
|
*
|
|
14446
14468
|
* @param {String} tableId Table ID
|
|
14447
14469
|
* @param {Number} tableVersion Table Version
|
|
14448
|
-
* postBusinessrulesDecisiontableVersionSync is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14449
14470
|
*/
|
|
14450
14471
|
postBusinessrulesDecisiontableVersionSync(tableId, tableVersion) {
|
|
14451
14472
|
// verify the required parameter 'tableId' is set
|
|
@@ -14475,7 +14496,6 @@ class BusinessRulesApi {
|
|
|
14475
14496
|
* Create a new decision table version
|
|
14476
14497
|
*
|
|
14477
14498
|
* @param {String} tableId Table ID
|
|
14478
|
-
* postBusinessrulesDecisiontableVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14479
14499
|
*/
|
|
14480
14500
|
postBusinessrulesDecisiontableVersions(tableId) {
|
|
14481
14501
|
// verify the required parameter 'tableId' is set
|
|
@@ -14501,7 +14521,6 @@ class BusinessRulesApi {
|
|
|
14501
14521
|
* Create a decision table
|
|
14502
14522
|
*
|
|
14503
14523
|
* @param {Object} body Decision Table
|
|
14504
|
-
* postBusinessrulesDecisiontables is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14505
14524
|
*/
|
|
14506
14525
|
postBusinessrulesDecisiontables(body) {
|
|
14507
14526
|
// verify the required parameter 'body' is set
|
|
@@ -14527,7 +14546,6 @@ class BusinessRulesApi {
|
|
|
14527
14546
|
* Create a schema
|
|
14528
14547
|
*
|
|
14529
14548
|
* @param {Object} body Business Rules Schema Create Request
|
|
14530
|
-
* postBusinessrulesSchemas is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14531
14549
|
*/
|
|
14532
14550
|
postBusinessrulesSchemas(body) {
|
|
14533
14551
|
// verify the required parameter 'body' is set
|
|
@@ -14554,7 +14572,6 @@ class BusinessRulesApi {
|
|
|
14554
14572
|
*
|
|
14555
14573
|
* @param {String} tableId Table ID
|
|
14556
14574
|
* @param {Number} tableVersion Table Version
|
|
14557
|
-
* putBusinessrulesDecisiontableVersionPublish is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14558
14575
|
*/
|
|
14559
14576
|
putBusinessrulesDecisiontableVersionPublish(tableId, tableVersion) {
|
|
14560
14577
|
// verify the required parameter 'tableId' is set
|
|
@@ -14587,7 +14604,6 @@ class BusinessRulesApi {
|
|
|
14587
14604
|
* @param {Number} tableVersion Table Version
|
|
14588
14605
|
* @param {String} rowId Row ID
|
|
14589
14606
|
* @param {Object} body Full update decision table row request
|
|
14590
|
-
* putBusinessrulesDecisiontableVersionRow is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14591
14607
|
*/
|
|
14592
14608
|
putBusinessrulesDecisiontableVersionRow(tableId, tableVersion, rowId, body) {
|
|
14593
14609
|
// verify the required parameter 'tableId' is set
|
|
@@ -14626,7 +14642,6 @@ class BusinessRulesApi {
|
|
|
14626
14642
|
*
|
|
14627
14643
|
* @param {String} schemaId Schema ID
|
|
14628
14644
|
* @param {Object} body Business Rules Schema Update Request
|
|
14629
|
-
* putBusinessrulesSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14630
14645
|
*/
|
|
14631
14646
|
putBusinessrulesSchema(schemaId, body) {
|
|
14632
14647
|
// verify the required parameter 'schemaId' is set
|
|
@@ -14658,7 +14673,7 @@ class CarrierServicesApi {
|
|
|
14658
14673
|
/**
|
|
14659
14674
|
* CarrierServices service.
|
|
14660
14675
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
14661
|
-
* @version
|
|
14676
|
+
* @version 235.0.0
|
|
14662
14677
|
*/
|
|
14663
14678
|
|
|
14664
14679
|
/**
|
|
@@ -14728,7 +14743,7 @@ class ChatApi {
|
|
|
14728
14743
|
/**
|
|
14729
14744
|
* Chat service.
|
|
14730
14745
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
14731
|
-
* @version
|
|
14746
|
+
* @version 235.0.0
|
|
14732
14747
|
*/
|
|
14733
14748
|
|
|
14734
14749
|
/**
|
|
@@ -15709,7 +15724,7 @@ class CoachingApi {
|
|
|
15709
15724
|
/**
|
|
15710
15725
|
* Coaching service.
|
|
15711
15726
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
15712
|
-
* @version
|
|
15727
|
+
* @version 235.0.0
|
|
15713
15728
|
*/
|
|
15714
15729
|
|
|
15715
15730
|
/**
|
|
@@ -16020,6 +16035,31 @@ class CoachingApi {
|
|
|
16020
16035
|
);
|
|
16021
16036
|
}
|
|
16022
16037
|
|
|
16038
|
+
/**
|
|
16039
|
+
* Retrieve the status of the job for the slots where a coaching appointment can be scheduled.
|
|
16040
|
+
*
|
|
16041
|
+
* @param {String} jobId The ID of job
|
|
16042
|
+
*/
|
|
16043
|
+
getCoachingScheduleslotsJob(jobId) {
|
|
16044
|
+
// verify the required parameter 'jobId' is set
|
|
16045
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
16046
|
+
throw 'Missing the required parameter "jobId" when calling getCoachingScheduleslotsJob';
|
|
16047
|
+
}
|
|
16048
|
+
|
|
16049
|
+
return this.apiClient.callApi(
|
|
16050
|
+
'/api/v2/coaching/scheduleslots/jobs/{jobId}',
|
|
16051
|
+
'GET',
|
|
16052
|
+
{ 'jobId': jobId },
|
|
16053
|
+
{ },
|
|
16054
|
+
{ },
|
|
16055
|
+
{ },
|
|
16056
|
+
null,
|
|
16057
|
+
['PureCloud OAuth'],
|
|
16058
|
+
['application/json'],
|
|
16059
|
+
['application/json']
|
|
16060
|
+
);
|
|
16061
|
+
}
|
|
16062
|
+
|
|
16023
16063
|
/**
|
|
16024
16064
|
* Update an existing appointment
|
|
16025
16065
|
* Permission not required if you are the creator or facilitator of the appointment
|
|
@@ -16255,6 +16295,31 @@ class CoachingApi {
|
|
|
16255
16295
|
);
|
|
16256
16296
|
}
|
|
16257
16297
|
|
|
16298
|
+
/**
|
|
16299
|
+
* Start job to retrieve the slots where a coaching appointment can be scheduled.
|
|
16300
|
+
*
|
|
16301
|
+
* @param {Object} body The slots search request
|
|
16302
|
+
*/
|
|
16303
|
+
postCoachingScheduleslotsJobs(body) {
|
|
16304
|
+
// verify the required parameter 'body' is set
|
|
16305
|
+
if (body === undefined || body === null) {
|
|
16306
|
+
throw 'Missing the required parameter "body" when calling postCoachingScheduleslotsJobs';
|
|
16307
|
+
}
|
|
16308
|
+
|
|
16309
|
+
return this.apiClient.callApi(
|
|
16310
|
+
'/api/v2/coaching/scheduleslots/jobs',
|
|
16311
|
+
'POST',
|
|
16312
|
+
{ },
|
|
16313
|
+
{ },
|
|
16314
|
+
{ },
|
|
16315
|
+
{ },
|
|
16316
|
+
body,
|
|
16317
|
+
['PureCloud OAuth'],
|
|
16318
|
+
['application/json'],
|
|
16319
|
+
['application/json']
|
|
16320
|
+
);
|
|
16321
|
+
}
|
|
16322
|
+
|
|
16258
16323
|
/**
|
|
16259
16324
|
* Get list of possible slots where a coaching appointment can be scheduled.
|
|
16260
16325
|
*
|
|
@@ -16286,7 +16351,7 @@ class ContentManagementApi {
|
|
|
16286
16351
|
/**
|
|
16287
16352
|
* ContentManagement service.
|
|
16288
16353
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
16289
|
-
* @version
|
|
16354
|
+
* @version 235.0.0
|
|
16290
16355
|
*/
|
|
16291
16356
|
|
|
16292
16357
|
/**
|
|
@@ -17367,7 +17432,7 @@ class ConversationsApi {
|
|
|
17367
17432
|
/**
|
|
17368
17433
|
* Conversations service.
|
|
17369
17434
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
17370
|
-
* @version
|
|
17435
|
+
* @version 235.0.0
|
|
17371
17436
|
*/
|
|
17372
17437
|
|
|
17373
17438
|
/**
|
|
@@ -18039,7 +18104,6 @@ class ConversationsApi {
|
|
|
18039
18104
|
* @param {String} conversationId conversationId
|
|
18040
18105
|
* @param {String} communicationId communicationId
|
|
18041
18106
|
* @param {String} messageId messageId
|
|
18042
|
-
* getConversationCommunicationInternalmessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18043
18107
|
*/
|
|
18044
18108
|
getConversationCommunicationInternalmessage(conversationId, communicationId, messageId) {
|
|
18045
18109
|
// verify the required parameter 'conversationId' is set
|
|
@@ -18077,7 +18141,6 @@ class ConversationsApi {
|
|
|
18077
18141
|
* @param {Object} opts Optional parameters
|
|
18078
18142
|
* @param {Number} opts.pageSize Indicates maximum number of results in response. Default page size is 25 results. The maximum page size is 200. (default to 25)
|
|
18079
18143
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
18080
|
-
* getConversationCommunicationInternalmessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18081
18144
|
*/
|
|
18082
18145
|
getConversationCommunicationInternalmessages(conversationId, communicationId, opts) {
|
|
18083
18146
|
opts = opts || {};
|
|
@@ -19339,7 +19402,6 @@ class ConversationsApi {
|
|
|
19339
19402
|
* Get internal message conversation
|
|
19340
19403
|
*
|
|
19341
19404
|
* @param {String} conversationId conversationId
|
|
19342
|
-
* getConversationsInternalmessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
19343
19405
|
*/
|
|
19344
19406
|
getConversationsInternalmessage(conversationId) {
|
|
19345
19407
|
// verify the required parameter 'conversationId' is set
|
|
@@ -19364,7 +19426,6 @@ class ConversationsApi {
|
|
|
19364
19426
|
/**
|
|
19365
19427
|
* Get active internal message conversations for the logged in user
|
|
19366
19428
|
*
|
|
19367
|
-
* getConversationsInternalmessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
19368
19429
|
*/
|
|
19369
19430
|
getConversationsInternalmessages() {
|
|
19370
19431
|
|
|
@@ -21186,6 +21247,46 @@ class ConversationsApi {
|
|
|
21186
21247
|
);
|
|
21187
21248
|
}
|
|
21188
21249
|
|
|
21250
|
+
/**
|
|
21251
|
+
* Update conversation participant on behalf of a user
|
|
21252
|
+
*
|
|
21253
|
+
* @param {String} conversationId conversationId
|
|
21254
|
+
* @param {String} participantId participantId
|
|
21255
|
+
* @param {String} userId userId
|
|
21256
|
+
* @param {Object} body Participant request
|
|
21257
|
+
*/
|
|
21258
|
+
patchConversationsCallParticipantUserUserId(conversationId, participantId, userId, body) {
|
|
21259
|
+
// verify the required parameter 'conversationId' is set
|
|
21260
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
21261
|
+
throw 'Missing the required parameter "conversationId" when calling patchConversationsCallParticipantUserUserId';
|
|
21262
|
+
}
|
|
21263
|
+
// verify the required parameter 'participantId' is set
|
|
21264
|
+
if (participantId === undefined || participantId === null || participantId === '') {
|
|
21265
|
+
throw 'Missing the required parameter "participantId" when calling patchConversationsCallParticipantUserUserId';
|
|
21266
|
+
}
|
|
21267
|
+
// verify the required parameter 'userId' is set
|
|
21268
|
+
if (userId === undefined || userId === null || userId === '') {
|
|
21269
|
+
throw 'Missing the required parameter "userId" when calling patchConversationsCallParticipantUserUserId';
|
|
21270
|
+
}
|
|
21271
|
+
// verify the required parameter 'body' is set
|
|
21272
|
+
if (body === undefined || body === null) {
|
|
21273
|
+
throw 'Missing the required parameter "body" when calling patchConversationsCallParticipantUserUserId';
|
|
21274
|
+
}
|
|
21275
|
+
|
|
21276
|
+
return this.apiClient.callApi(
|
|
21277
|
+
'/api/v2/conversations/calls/{conversationId}/participants/{participantId}/user/{userId}',
|
|
21278
|
+
'PATCH',
|
|
21279
|
+
{ 'conversationId': conversationId,'participantId': participantId,'userId': userId },
|
|
21280
|
+
{ },
|
|
21281
|
+
{ },
|
|
21282
|
+
{ },
|
|
21283
|
+
body,
|
|
21284
|
+
['PureCloud OAuth'],
|
|
21285
|
+
['application/json'],
|
|
21286
|
+
['application/json']
|
|
21287
|
+
);
|
|
21288
|
+
}
|
|
21289
|
+
|
|
21189
21290
|
/**
|
|
21190
21291
|
* Update a conversation by disconnecting all of the participants
|
|
21191
21292
|
*
|
|
@@ -22523,7 +22624,6 @@ class ConversationsApi {
|
|
|
22523
22624
|
* @param {String} conversationId conversationId
|
|
22524
22625
|
* @param {String} communicationId communicationId
|
|
22525
22626
|
* @param {Object} body Message
|
|
22526
|
-
* postConversationCommunicationInternalmessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
22527
22627
|
*/
|
|
22528
22628
|
postConversationCommunicationInternalmessages(conversationId, communicationId, body) {
|
|
22529
22629
|
// verify the required parameter 'conversationId' is set
|
|
@@ -22652,7 +22752,6 @@ class ConversationsApi {
|
|
|
22652
22752
|
* @param {String} conversationId conversation ID
|
|
22653
22753
|
* @param {String} participantId participant ID
|
|
22654
22754
|
* @param {Object} body Confer request
|
|
22655
|
-
* postConversationParticipantInternalmessagesUsersCommunications is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
22656
22755
|
*/
|
|
22657
22756
|
postConversationParticipantInternalmessagesUsersCommunications(conversationId, participantId, body) {
|
|
22658
22757
|
// verify the required parameter 'conversationId' is set
|
|
@@ -24562,7 +24661,7 @@ class ConversationsApi {
|
|
|
24562
24661
|
|
|
24563
24662
|
/**
|
|
24564
24663
|
* Get messages in batch
|
|
24565
|
-
* The path parameter [conversationId] should contain the conversationId of the conversation being filtered. The body should contain the messageId(s) of messages being requested. For example: ["a3069a33b-bbb1-4703-9d68-061d9e9db96e", "55bc6be3-078c-4a49-a4e6-1e05776ed7e8"]
|
|
24664
|
+
* The path parameter [conversationId] should contain the conversationId of the conversation being filtered. The body should contain the messageId(s) of messages being requested. For example: ["a3069a33b-bbb1-4703-9d68-061d9e9db96e", "55bc6be3-078c-4a49-a4e6-1e05776ed7e8"]. The max messages you can request in the body is 1,000. Best practice is to limit to only the messages you need in each request, rather than request large batches by default.
|
|
24566
24665
|
* @param {String} conversationId
|
|
24567
24666
|
* @param {Object} opts Optional parameters
|
|
24568
24667
|
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media) (default to false)
|
|
@@ -25924,7 +26023,7 @@ class DataExtensionsApi {
|
|
|
25924
26023
|
/**
|
|
25925
26024
|
* DataExtensions service.
|
|
25926
26025
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
25927
|
-
* @version
|
|
26026
|
+
* @version 235.0.0
|
|
25928
26027
|
*/
|
|
25929
26028
|
|
|
25930
26029
|
/**
|
|
@@ -26010,7 +26109,7 @@ class DataPrivacyApi {
|
|
|
26010
26109
|
/**
|
|
26011
26110
|
* DataPrivacy service.
|
|
26012
26111
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
26013
|
-
* @version
|
|
26112
|
+
* @version 235.0.0
|
|
26014
26113
|
*/
|
|
26015
26114
|
|
|
26016
26115
|
/**
|
|
@@ -26180,7 +26279,7 @@ class DownloadsApi {
|
|
|
26180
26279
|
/**
|
|
26181
26280
|
* Downloads service.
|
|
26182
26281
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
26183
|
-
* @version
|
|
26282
|
+
* @version 235.0.0
|
|
26184
26283
|
*/
|
|
26185
26284
|
|
|
26186
26285
|
/**
|
|
@@ -26232,7 +26331,7 @@ class EmailsApi {
|
|
|
26232
26331
|
/**
|
|
26233
26332
|
* Emails service.
|
|
26234
26333
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
26235
|
-
* @version
|
|
26334
|
+
* @version 235.0.0
|
|
26236
26335
|
*/
|
|
26237
26336
|
|
|
26238
26337
|
/**
|
|
@@ -26361,7 +26460,7 @@ class EmployeeEngagementApi {
|
|
|
26361
26460
|
/**
|
|
26362
26461
|
* EmployeeEngagement service.
|
|
26363
26462
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
26364
|
-
* @version
|
|
26463
|
+
* @version 235.0.0
|
|
26365
26464
|
*/
|
|
26366
26465
|
|
|
26367
26466
|
/**
|
|
@@ -26512,7 +26611,7 @@ class EventsApi {
|
|
|
26512
26611
|
/**
|
|
26513
26612
|
* Events service.
|
|
26514
26613
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
26515
|
-
* @version
|
|
26614
|
+
* @version 235.0.0
|
|
26516
26615
|
*/
|
|
26517
26616
|
|
|
26518
26617
|
/**
|
|
@@ -26608,7 +26707,7 @@ class ExternalContactsApi {
|
|
|
26608
26707
|
/**
|
|
26609
26708
|
* ExternalContacts service.
|
|
26610
26709
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
26611
|
-
* @version
|
|
26710
|
+
* @version 235.0.0
|
|
26612
26711
|
*/
|
|
26613
26712
|
|
|
26614
26713
|
/**
|
|
@@ -29855,7 +29954,7 @@ class FaxApi {
|
|
|
29855
29954
|
/**
|
|
29856
29955
|
* Fax service.
|
|
29857
29956
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
29858
|
-
* @version
|
|
29957
|
+
* @version 235.0.0
|
|
29859
29958
|
*/
|
|
29860
29959
|
|
|
29861
29960
|
/**
|
|
@@ -30070,7 +30169,7 @@ class FlowsApi {
|
|
|
30070
30169
|
/**
|
|
30071
30170
|
* Flows service.
|
|
30072
30171
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
30073
|
-
* @version
|
|
30172
|
+
* @version 235.0.0
|
|
30074
30173
|
*/
|
|
30075
30174
|
|
|
30076
30175
|
/**
|
|
@@ -30279,7 +30378,7 @@ class GamificationApi {
|
|
|
30279
30378
|
/**
|
|
30280
30379
|
* Gamification service.
|
|
30281
30380
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
30282
|
-
* @version
|
|
30381
|
+
* @version 235.0.0
|
|
30283
30382
|
*/
|
|
30284
30383
|
|
|
30285
30384
|
/**
|
|
@@ -30834,6 +30933,51 @@ class GamificationApi {
|
|
|
30834
30933
|
);
|
|
30835
30934
|
}
|
|
30836
30935
|
|
|
30936
|
+
/**
|
|
30937
|
+
* Query managers in a profile during a period of time
|
|
30938
|
+
*
|
|
30939
|
+
* @param {Object} filterType Filter type for the query request.
|
|
30940
|
+
* @param {String} filterId ID for the filter type.
|
|
30941
|
+
* @param {Object} granularity Granularity
|
|
30942
|
+
* @param {String} startWorkday The start work day. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
30943
|
+
* @param {Object} opts Optional parameters
|
|
30944
|
+
* @param {Number} opts.pageSize Page size (default to 100)
|
|
30945
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
30946
|
+
*/
|
|
30947
|
+
getGamificationInsightsManagers(filterType, filterId, granularity, startWorkday, opts) {
|
|
30948
|
+
opts = opts || {};
|
|
30949
|
+
|
|
30950
|
+
// verify the required parameter 'filterType' is set
|
|
30951
|
+
if (filterType === undefined || filterType === null) {
|
|
30952
|
+
throw 'Missing the required parameter "filterType" when calling getGamificationInsightsManagers';
|
|
30953
|
+
}
|
|
30954
|
+
// verify the required parameter 'filterId' is set
|
|
30955
|
+
if (filterId === undefined || filterId === null) {
|
|
30956
|
+
throw 'Missing the required parameter "filterId" when calling getGamificationInsightsManagers';
|
|
30957
|
+
}
|
|
30958
|
+
// verify the required parameter 'granularity' is set
|
|
30959
|
+
if (granularity === undefined || granularity === null) {
|
|
30960
|
+
throw 'Missing the required parameter "granularity" when calling getGamificationInsightsManagers';
|
|
30961
|
+
}
|
|
30962
|
+
// verify the required parameter 'startWorkday' is set
|
|
30963
|
+
if (startWorkday === undefined || startWorkday === null) {
|
|
30964
|
+
throw 'Missing the required parameter "startWorkday" when calling getGamificationInsightsManagers';
|
|
30965
|
+
}
|
|
30966
|
+
|
|
30967
|
+
return this.apiClient.callApi(
|
|
30968
|
+
'/api/v2/gamification/insights/managers',
|
|
30969
|
+
'GET',
|
|
30970
|
+
{ },
|
|
30971
|
+
{ 'filterType': filterType,'filterId': filterId,'granularity': granularity,'startWorkday': startWorkday,'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
30972
|
+
{ },
|
|
30973
|
+
{ },
|
|
30974
|
+
null,
|
|
30975
|
+
['PureCloud OAuth'],
|
|
30976
|
+
['application/json'],
|
|
30977
|
+
['application/json']
|
|
30978
|
+
);
|
|
30979
|
+
}
|
|
30980
|
+
|
|
30837
30981
|
/**
|
|
30838
30982
|
* Query users in a profile during a period of time
|
|
30839
30983
|
*
|
|
@@ -32792,7 +32936,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
32792
32936
|
/**
|
|
32793
32937
|
* GeneralDataProtectionRegulation service.
|
|
32794
32938
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
32795
|
-
* @version
|
|
32939
|
+
* @version 235.0.0
|
|
32796
32940
|
*/
|
|
32797
32941
|
|
|
32798
32942
|
/**
|
|
@@ -32922,7 +33066,7 @@ class GeolocationApi {
|
|
|
32922
33066
|
/**
|
|
32923
33067
|
* Geolocation service.
|
|
32924
33068
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
32925
|
-
* @version
|
|
33069
|
+
* @version 235.0.0
|
|
32926
33070
|
*/
|
|
32927
33071
|
|
|
32928
33072
|
/**
|
|
@@ -33053,7 +33197,7 @@ class GreetingsApi {
|
|
|
33053
33197
|
/**
|
|
33054
33198
|
* Greetings service.
|
|
33055
33199
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
33056
|
-
* @version
|
|
33200
|
+
* @version 235.0.0
|
|
33057
33201
|
*/
|
|
33058
33202
|
|
|
33059
33203
|
/**
|
|
@@ -33595,7 +33739,7 @@ class GroupsApi {
|
|
|
33595
33739
|
/**
|
|
33596
33740
|
* Groups service.
|
|
33597
33741
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
33598
|
-
* @version
|
|
33742
|
+
* @version 235.0.0
|
|
33599
33743
|
*/
|
|
33600
33744
|
|
|
33601
33745
|
/**
|
|
@@ -34114,7 +34258,7 @@ class IdentityProviderApi {
|
|
|
34114
34258
|
/**
|
|
34115
34259
|
* IdentityProvider service.
|
|
34116
34260
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
34117
|
-
* @version
|
|
34261
|
+
* @version 235.0.0
|
|
34118
34262
|
*/
|
|
34119
34263
|
|
|
34120
34264
|
/**
|
|
@@ -34975,7 +35119,7 @@ class InfrastructureAsCodeApi {
|
|
|
34975
35119
|
/**
|
|
34976
35120
|
* InfrastructureAsCode service.
|
|
34977
35121
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
34978
|
-
* @version
|
|
35122
|
+
* @version 235.0.0
|
|
34979
35123
|
*/
|
|
34980
35124
|
|
|
34981
35125
|
/**
|
|
@@ -35142,7 +35286,7 @@ class IntegrationsApi {
|
|
|
35142
35286
|
/**
|
|
35143
35287
|
* Integrations service.
|
|
35144
35288
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
35145
|
-
* @version
|
|
35289
|
+
* @version 235.0.0
|
|
35146
35290
|
*/
|
|
35147
35291
|
|
|
35148
35292
|
/**
|
|
@@ -37790,7 +37934,7 @@ class JourneyApi {
|
|
|
37790
37934
|
/**
|
|
37791
37935
|
* Journey service.
|
|
37792
37936
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
37793
|
-
* @version
|
|
37937
|
+
* @version 235.0.0
|
|
37794
37938
|
*/
|
|
37795
37939
|
|
|
37796
37940
|
/**
|
|
@@ -39887,7 +40031,7 @@ class KnowledgeApi {
|
|
|
39887
40031
|
/**
|
|
39888
40032
|
* Knowledge service.
|
|
39889
40033
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
39890
|
-
* @version
|
|
40034
|
+
* @version 235.0.0
|
|
39891
40035
|
*/
|
|
39892
40036
|
|
|
39893
40037
|
/**
|
|
@@ -40112,114 +40256,6 @@ class KnowledgeApi {
|
|
|
40112
40256
|
);
|
|
40113
40257
|
}
|
|
40114
40258
|
|
|
40115
|
-
/**
|
|
40116
|
-
* Delete category
|
|
40117
|
-
*
|
|
40118
|
-
* @param {String} categoryId Category ID
|
|
40119
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
40120
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
40121
|
-
* @deprecated
|
|
40122
|
-
*/
|
|
40123
|
-
deleteKnowledgeKnowledgebaseLanguageCategory(categoryId, knowledgeBaseId, languageCode) {
|
|
40124
|
-
// verify the required parameter 'categoryId' is set
|
|
40125
|
-
if (categoryId === undefined || categoryId === null || categoryId === '') {
|
|
40126
|
-
throw 'Missing the required parameter "categoryId" when calling deleteKnowledgeKnowledgebaseLanguageCategory';
|
|
40127
|
-
}
|
|
40128
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
40129
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
40130
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseLanguageCategory';
|
|
40131
|
-
}
|
|
40132
|
-
// verify the required parameter 'languageCode' is set
|
|
40133
|
-
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
40134
|
-
throw 'Missing the required parameter "languageCode" when calling deleteKnowledgeKnowledgebaseLanguageCategory';
|
|
40135
|
-
}
|
|
40136
|
-
|
|
40137
|
-
return this.apiClient.callApi(
|
|
40138
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories/{categoryId}',
|
|
40139
|
-
'DELETE',
|
|
40140
|
-
{ 'categoryId': categoryId,'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
|
|
40141
|
-
{ },
|
|
40142
|
-
{ },
|
|
40143
|
-
{ },
|
|
40144
|
-
null,
|
|
40145
|
-
['PureCloud OAuth'],
|
|
40146
|
-
['application/json'],
|
|
40147
|
-
['application/json']
|
|
40148
|
-
);
|
|
40149
|
-
}
|
|
40150
|
-
|
|
40151
|
-
/**
|
|
40152
|
-
* Delete document
|
|
40153
|
-
*
|
|
40154
|
-
* @param {String} documentId Document ID
|
|
40155
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
40156
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
40157
|
-
* @deprecated
|
|
40158
|
-
*/
|
|
40159
|
-
deleteKnowledgeKnowledgebaseLanguageDocument(documentId, knowledgeBaseId, languageCode) {
|
|
40160
|
-
// verify the required parameter 'documentId' is set
|
|
40161
|
-
if (documentId === undefined || documentId === null || documentId === '') {
|
|
40162
|
-
throw 'Missing the required parameter "documentId" when calling deleteKnowledgeKnowledgebaseLanguageDocument';
|
|
40163
|
-
}
|
|
40164
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
40165
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
40166
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseLanguageDocument';
|
|
40167
|
-
}
|
|
40168
|
-
// verify the required parameter 'languageCode' is set
|
|
40169
|
-
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
40170
|
-
throw 'Missing the required parameter "languageCode" when calling deleteKnowledgeKnowledgebaseLanguageDocument';
|
|
40171
|
-
}
|
|
40172
|
-
|
|
40173
|
-
return this.apiClient.callApi(
|
|
40174
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}',
|
|
40175
|
-
'DELETE',
|
|
40176
|
-
{ 'documentId': documentId,'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
|
|
40177
|
-
{ },
|
|
40178
|
-
{ },
|
|
40179
|
-
{ },
|
|
40180
|
-
null,
|
|
40181
|
-
['PureCloud OAuth'],
|
|
40182
|
-
['application/json'],
|
|
40183
|
-
['application/json']
|
|
40184
|
-
);
|
|
40185
|
-
}
|
|
40186
|
-
|
|
40187
|
-
/**
|
|
40188
|
-
* Delete import operation
|
|
40189
|
-
*
|
|
40190
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
40191
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
40192
|
-
* @param {String} importId Import ID
|
|
40193
|
-
* @deprecated
|
|
40194
|
-
*/
|
|
40195
|
-
deleteKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId, languageCode, importId) {
|
|
40196
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
40197
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
40198
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseLanguageDocumentsImport';
|
|
40199
|
-
}
|
|
40200
|
-
// verify the required parameter 'languageCode' is set
|
|
40201
|
-
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
40202
|
-
throw 'Missing the required parameter "languageCode" when calling deleteKnowledgeKnowledgebaseLanguageDocumentsImport';
|
|
40203
|
-
}
|
|
40204
|
-
// verify the required parameter 'importId' is set
|
|
40205
|
-
if (importId === undefined || importId === null || importId === '') {
|
|
40206
|
-
throw 'Missing the required parameter "importId" when calling deleteKnowledgeKnowledgebaseLanguageDocumentsImport';
|
|
40207
|
-
}
|
|
40208
|
-
|
|
40209
|
-
return this.apiClient.callApi(
|
|
40210
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/imports/{importId}',
|
|
40211
|
-
'DELETE',
|
|
40212
|
-
{ 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode,'importId': importId },
|
|
40213
|
-
{ },
|
|
40214
|
-
{ },
|
|
40215
|
-
{ },
|
|
40216
|
-
null,
|
|
40217
|
-
['PureCloud OAuth'],
|
|
40218
|
-
['application/json'],
|
|
40219
|
-
['application/json']
|
|
40220
|
-
);
|
|
40221
|
-
}
|
|
40222
|
-
|
|
40223
40259
|
/**
|
|
40224
40260
|
* Delete Salesforce Knowledge integration source
|
|
40225
40261
|
*
|
|
@@ -41043,312 +41079,6 @@ class KnowledgeApi {
|
|
|
41043
41079
|
);
|
|
41044
41080
|
}
|
|
41045
41081
|
|
|
41046
|
-
/**
|
|
41047
|
-
* Get categories
|
|
41048
|
-
*
|
|
41049
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
41050
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
41051
|
-
* @param {Object} opts Optional parameters
|
|
41052
|
-
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
41053
|
-
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
41054
|
-
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
41055
|
-
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
41056
|
-
* @param {String} opts.name Filter to return the categories that starts with the given category name.
|
|
41057
|
-
* @deprecated
|
|
41058
|
-
*/
|
|
41059
|
-
getKnowledgeKnowledgebaseLanguageCategories(knowledgeBaseId, languageCode, opts) {
|
|
41060
|
-
opts = opts || {};
|
|
41061
|
-
|
|
41062
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
41063
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
41064
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageCategories';
|
|
41065
|
-
}
|
|
41066
|
-
// verify the required parameter 'languageCode' is set
|
|
41067
|
-
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
41068
|
-
throw 'Missing the required parameter "languageCode" when calling getKnowledgeKnowledgebaseLanguageCategories';
|
|
41069
|
-
}
|
|
41070
|
-
|
|
41071
|
-
return this.apiClient.callApi(
|
|
41072
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories',
|
|
41073
|
-
'GET',
|
|
41074
|
-
{ 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
|
|
41075
|
-
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'name': opts['name'] },
|
|
41076
|
-
{ },
|
|
41077
|
-
{ },
|
|
41078
|
-
null,
|
|
41079
|
-
['PureCloud OAuth'],
|
|
41080
|
-
['application/json'],
|
|
41081
|
-
['application/json']
|
|
41082
|
-
);
|
|
41083
|
-
}
|
|
41084
|
-
|
|
41085
|
-
/**
|
|
41086
|
-
* Get category
|
|
41087
|
-
*
|
|
41088
|
-
* @param {String} categoryId Category ID
|
|
41089
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
41090
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
41091
|
-
* @deprecated
|
|
41092
|
-
*/
|
|
41093
|
-
getKnowledgeKnowledgebaseLanguageCategory(categoryId, knowledgeBaseId, languageCode) {
|
|
41094
|
-
// verify the required parameter 'categoryId' is set
|
|
41095
|
-
if (categoryId === undefined || categoryId === null || categoryId === '') {
|
|
41096
|
-
throw 'Missing the required parameter "categoryId" when calling getKnowledgeKnowledgebaseLanguageCategory';
|
|
41097
|
-
}
|
|
41098
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
41099
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
41100
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageCategory';
|
|
41101
|
-
}
|
|
41102
|
-
// verify the required parameter 'languageCode' is set
|
|
41103
|
-
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
41104
|
-
throw 'Missing the required parameter "languageCode" when calling getKnowledgeKnowledgebaseLanguageCategory';
|
|
41105
|
-
}
|
|
41106
|
-
|
|
41107
|
-
return this.apiClient.callApi(
|
|
41108
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories/{categoryId}',
|
|
41109
|
-
'GET',
|
|
41110
|
-
{ 'categoryId': categoryId,'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
|
|
41111
|
-
{ },
|
|
41112
|
-
{ },
|
|
41113
|
-
{ },
|
|
41114
|
-
null,
|
|
41115
|
-
['PureCloud OAuth'],
|
|
41116
|
-
['application/json'],
|
|
41117
|
-
['application/json']
|
|
41118
|
-
);
|
|
41119
|
-
}
|
|
41120
|
-
|
|
41121
|
-
/**
|
|
41122
|
-
* Get document
|
|
41123
|
-
*
|
|
41124
|
-
* @param {String} documentId Document ID
|
|
41125
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
41126
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
41127
|
-
* @deprecated
|
|
41128
|
-
*/
|
|
41129
|
-
getKnowledgeKnowledgebaseLanguageDocument(documentId, knowledgeBaseId, languageCode) {
|
|
41130
|
-
// verify the required parameter 'documentId' is set
|
|
41131
|
-
if (documentId === undefined || documentId === null || documentId === '') {
|
|
41132
|
-
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseLanguageDocument';
|
|
41133
|
-
}
|
|
41134
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
41135
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
41136
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageDocument';
|
|
41137
|
-
}
|
|
41138
|
-
// verify the required parameter 'languageCode' is set
|
|
41139
|
-
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
41140
|
-
throw 'Missing the required parameter "languageCode" when calling getKnowledgeKnowledgebaseLanguageDocument';
|
|
41141
|
-
}
|
|
41142
|
-
|
|
41143
|
-
return this.apiClient.callApi(
|
|
41144
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}',
|
|
41145
|
-
'GET',
|
|
41146
|
-
{ 'documentId': documentId,'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
|
|
41147
|
-
{ },
|
|
41148
|
-
{ },
|
|
41149
|
-
{ },
|
|
41150
|
-
null,
|
|
41151
|
-
['PureCloud OAuth'],
|
|
41152
|
-
['application/json'],
|
|
41153
|
-
['application/json']
|
|
41154
|
-
);
|
|
41155
|
-
}
|
|
41156
|
-
|
|
41157
|
-
/**
|
|
41158
|
-
* Get document content upload status
|
|
41159
|
-
*
|
|
41160
|
-
* @param {String} documentId Document ID
|
|
41161
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
41162
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
41163
|
-
* @param {String} uploadId UploadId
|
|
41164
|
-
* @deprecated
|
|
41165
|
-
*/
|
|
41166
|
-
getKnowledgeKnowledgebaseLanguageDocumentUpload(documentId, knowledgeBaseId, languageCode, uploadId) {
|
|
41167
|
-
// verify the required parameter 'documentId' is set
|
|
41168
|
-
if (documentId === undefined || documentId === null || documentId === '') {
|
|
41169
|
-
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseLanguageDocumentUpload';
|
|
41170
|
-
}
|
|
41171
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
41172
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
41173
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageDocumentUpload';
|
|
41174
|
-
}
|
|
41175
|
-
// verify the required parameter 'languageCode' is set
|
|
41176
|
-
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
41177
|
-
throw 'Missing the required parameter "languageCode" when calling getKnowledgeKnowledgebaseLanguageDocumentUpload';
|
|
41178
|
-
}
|
|
41179
|
-
// verify the required parameter 'uploadId' is set
|
|
41180
|
-
if (uploadId === undefined || uploadId === null || uploadId === '') {
|
|
41181
|
-
throw 'Missing the required parameter "uploadId" when calling getKnowledgeKnowledgebaseLanguageDocumentUpload';
|
|
41182
|
-
}
|
|
41183
|
-
|
|
41184
|
-
return this.apiClient.callApi(
|
|
41185
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}/uploads/{uploadId}',
|
|
41186
|
-
'GET',
|
|
41187
|
-
{ 'documentId': documentId,'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode,'uploadId': uploadId },
|
|
41188
|
-
{ },
|
|
41189
|
-
{ },
|
|
41190
|
-
{ },
|
|
41191
|
-
null,
|
|
41192
|
-
['PureCloud OAuth'],
|
|
41193
|
-
['application/json'],
|
|
41194
|
-
['application/json']
|
|
41195
|
-
);
|
|
41196
|
-
}
|
|
41197
|
-
|
|
41198
|
-
/**
|
|
41199
|
-
* Get documents
|
|
41200
|
-
*
|
|
41201
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
41202
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
41203
|
-
* @param {Object} opts Optional parameters
|
|
41204
|
-
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
41205
|
-
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
41206
|
-
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
41207
|
-
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
41208
|
-
* @param {String} opts.categories Filter by categories ids, comma separated values expected.
|
|
41209
|
-
* @param {String} opts.title Filter by document title.
|
|
41210
|
-
* @param {Object} opts.sortBy Sort by.
|
|
41211
|
-
* @param {Object} opts.sortOrder Sort Order.
|
|
41212
|
-
* @param {Array.<String>} opts.documentIds Comma-separated list of document identifiers to fetch by.
|
|
41213
|
-
* @deprecated
|
|
41214
|
-
*/
|
|
41215
|
-
getKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, opts) {
|
|
41216
|
-
opts = opts || {};
|
|
41217
|
-
|
|
41218
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
41219
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
41220
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageDocuments';
|
|
41221
|
-
}
|
|
41222
|
-
// verify the required parameter 'languageCode' is set
|
|
41223
|
-
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
41224
|
-
throw 'Missing the required parameter "languageCode" when calling getKnowledgeKnowledgebaseLanguageDocuments';
|
|
41225
|
-
}
|
|
41226
|
-
|
|
41227
|
-
return this.apiClient.callApi(
|
|
41228
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents',
|
|
41229
|
-
'GET',
|
|
41230
|
-
{ 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
|
|
41231
|
-
{ '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') },
|
|
41232
|
-
{ },
|
|
41233
|
-
{ },
|
|
41234
|
-
null,
|
|
41235
|
-
['PureCloud OAuth'],
|
|
41236
|
-
['application/json'],
|
|
41237
|
-
['application/json']
|
|
41238
|
-
);
|
|
41239
|
-
}
|
|
41240
|
-
|
|
41241
|
-
/**
|
|
41242
|
-
* Get import operation report
|
|
41243
|
-
*
|
|
41244
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
41245
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
41246
|
-
* @param {String} importId Import ID
|
|
41247
|
-
* @deprecated
|
|
41248
|
-
*/
|
|
41249
|
-
getKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId, languageCode, importId) {
|
|
41250
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
41251
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
41252
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageDocumentsImport';
|
|
41253
|
-
}
|
|
41254
|
-
// verify the required parameter 'languageCode' is set
|
|
41255
|
-
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
41256
|
-
throw 'Missing the required parameter "languageCode" when calling getKnowledgeKnowledgebaseLanguageDocumentsImport';
|
|
41257
|
-
}
|
|
41258
|
-
// verify the required parameter 'importId' is set
|
|
41259
|
-
if (importId === undefined || importId === null || importId === '') {
|
|
41260
|
-
throw 'Missing the required parameter "importId" when calling getKnowledgeKnowledgebaseLanguageDocumentsImport';
|
|
41261
|
-
}
|
|
41262
|
-
|
|
41263
|
-
return this.apiClient.callApi(
|
|
41264
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/imports/{importId}',
|
|
41265
|
-
'GET',
|
|
41266
|
-
{ 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode,'importId': importId },
|
|
41267
|
-
{ },
|
|
41268
|
-
{ },
|
|
41269
|
-
{ },
|
|
41270
|
-
null,
|
|
41271
|
-
['PureCloud OAuth'],
|
|
41272
|
-
['application/json'],
|
|
41273
|
-
['application/json']
|
|
41274
|
-
);
|
|
41275
|
-
}
|
|
41276
|
-
|
|
41277
|
-
/**
|
|
41278
|
-
* Get training detail
|
|
41279
|
-
*
|
|
41280
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
41281
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
41282
|
-
* @param {String} trainingId Training ID
|
|
41283
|
-
* @deprecated
|
|
41284
|
-
*/
|
|
41285
|
-
getKnowledgeKnowledgebaseLanguageTraining(knowledgeBaseId, languageCode, trainingId) {
|
|
41286
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
41287
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
41288
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageTraining';
|
|
41289
|
-
}
|
|
41290
|
-
// verify the required parameter 'languageCode' is set
|
|
41291
|
-
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
41292
|
-
throw 'Missing the required parameter "languageCode" when calling getKnowledgeKnowledgebaseLanguageTraining';
|
|
41293
|
-
}
|
|
41294
|
-
// verify the required parameter 'trainingId' is set
|
|
41295
|
-
if (trainingId === undefined || trainingId === null || trainingId === '') {
|
|
41296
|
-
throw 'Missing the required parameter "trainingId" when calling getKnowledgeKnowledgebaseLanguageTraining';
|
|
41297
|
-
}
|
|
41298
|
-
|
|
41299
|
-
return this.apiClient.callApi(
|
|
41300
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings/{trainingId}',
|
|
41301
|
-
'GET',
|
|
41302
|
-
{ 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode,'trainingId': trainingId },
|
|
41303
|
-
{ },
|
|
41304
|
-
{ },
|
|
41305
|
-
{ },
|
|
41306
|
-
null,
|
|
41307
|
-
['PureCloud OAuth'],
|
|
41308
|
-
['application/json'],
|
|
41309
|
-
['application/json']
|
|
41310
|
-
);
|
|
41311
|
-
}
|
|
41312
|
-
|
|
41313
|
-
/**
|
|
41314
|
-
* Get all trainings information for a knowledgebase
|
|
41315
|
-
*
|
|
41316
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
41317
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
41318
|
-
* @param {Object} opts Optional parameters
|
|
41319
|
-
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
41320
|
-
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
41321
|
-
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
41322
|
-
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
41323
|
-
* @param {Object} opts.knowledgeDocumentsState Return the training with the specified state of the trained documents.
|
|
41324
|
-
* @deprecated
|
|
41325
|
-
*/
|
|
41326
|
-
getKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId, languageCode, opts) {
|
|
41327
|
-
opts = opts || {};
|
|
41328
|
-
|
|
41329
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
41330
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
41331
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageTrainings';
|
|
41332
|
-
}
|
|
41333
|
-
// verify the required parameter 'languageCode' is set
|
|
41334
|
-
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
41335
|
-
throw 'Missing the required parameter "languageCode" when calling getKnowledgeKnowledgebaseLanguageTrainings';
|
|
41336
|
-
}
|
|
41337
|
-
|
|
41338
|
-
return this.apiClient.callApi(
|
|
41339
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings',
|
|
41340
|
-
'GET',
|
|
41341
|
-
{ 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
|
|
41342
|
-
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'knowledgeDocumentsState': opts['knowledgeDocumentsState'] },
|
|
41343
|
-
{ },
|
|
41344
|
-
{ },
|
|
41345
|
-
null,
|
|
41346
|
-
['PureCloud OAuth'],
|
|
41347
|
-
['application/json'],
|
|
41348
|
-
['application/json']
|
|
41349
|
-
);
|
|
41350
|
-
}
|
|
41351
|
-
|
|
41352
41082
|
/**
|
|
41353
41083
|
* Get operations
|
|
41354
41084
|
*
|
|
@@ -42061,165 +41791,6 @@ class KnowledgeApi {
|
|
|
42061
41791
|
);
|
|
42062
41792
|
}
|
|
42063
41793
|
|
|
42064
|
-
/**
|
|
42065
|
-
* Update category
|
|
42066
|
-
*
|
|
42067
|
-
* @param {String} categoryId Category ID
|
|
42068
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
42069
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
42070
|
-
* @param {Object} body
|
|
42071
|
-
* @deprecated
|
|
42072
|
-
*/
|
|
42073
|
-
patchKnowledgeKnowledgebaseLanguageCategory(categoryId, knowledgeBaseId, languageCode, body) {
|
|
42074
|
-
// verify the required parameter 'categoryId' is set
|
|
42075
|
-
if (categoryId === undefined || categoryId === null || categoryId === '') {
|
|
42076
|
-
throw 'Missing the required parameter "categoryId" when calling patchKnowledgeKnowledgebaseLanguageCategory';
|
|
42077
|
-
}
|
|
42078
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
42079
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
42080
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseLanguageCategory';
|
|
42081
|
-
}
|
|
42082
|
-
// verify the required parameter 'languageCode' is set
|
|
42083
|
-
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
42084
|
-
throw 'Missing the required parameter "languageCode" when calling patchKnowledgeKnowledgebaseLanguageCategory';
|
|
42085
|
-
}
|
|
42086
|
-
// verify the required parameter 'body' is set
|
|
42087
|
-
if (body === undefined || body === null) {
|
|
42088
|
-
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseLanguageCategory';
|
|
42089
|
-
}
|
|
42090
|
-
|
|
42091
|
-
return this.apiClient.callApi(
|
|
42092
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories/{categoryId}',
|
|
42093
|
-
'PATCH',
|
|
42094
|
-
{ 'categoryId': categoryId,'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
|
|
42095
|
-
{ },
|
|
42096
|
-
{ },
|
|
42097
|
-
{ },
|
|
42098
|
-
body,
|
|
42099
|
-
['PureCloud OAuth'],
|
|
42100
|
-
['application/json'],
|
|
42101
|
-
['application/json']
|
|
42102
|
-
);
|
|
42103
|
-
}
|
|
42104
|
-
|
|
42105
|
-
/**
|
|
42106
|
-
* Update document
|
|
42107
|
-
*
|
|
42108
|
-
* @param {String} documentId Document ID
|
|
42109
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
42110
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
42111
|
-
* @param {Object} body
|
|
42112
|
-
* @deprecated
|
|
42113
|
-
*/
|
|
42114
|
-
patchKnowledgeKnowledgebaseLanguageDocument(documentId, knowledgeBaseId, languageCode, body) {
|
|
42115
|
-
// verify the required parameter 'documentId' is set
|
|
42116
|
-
if (documentId === undefined || documentId === null || documentId === '') {
|
|
42117
|
-
throw 'Missing the required parameter "documentId" when calling patchKnowledgeKnowledgebaseLanguageDocument';
|
|
42118
|
-
}
|
|
42119
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
42120
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
42121
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseLanguageDocument';
|
|
42122
|
-
}
|
|
42123
|
-
// verify the required parameter 'languageCode' is set
|
|
42124
|
-
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
42125
|
-
throw 'Missing the required parameter "languageCode" when calling patchKnowledgeKnowledgebaseLanguageDocument';
|
|
42126
|
-
}
|
|
42127
|
-
// verify the required parameter 'body' is set
|
|
42128
|
-
if (body === undefined || body === null) {
|
|
42129
|
-
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseLanguageDocument';
|
|
42130
|
-
}
|
|
42131
|
-
|
|
42132
|
-
return this.apiClient.callApi(
|
|
42133
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}',
|
|
42134
|
-
'PATCH',
|
|
42135
|
-
{ 'documentId': documentId,'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
|
|
42136
|
-
{ },
|
|
42137
|
-
{ },
|
|
42138
|
-
{ },
|
|
42139
|
-
body,
|
|
42140
|
-
['PureCloud OAuth'],
|
|
42141
|
-
['application/json'],
|
|
42142
|
-
['application/json']
|
|
42143
|
-
);
|
|
42144
|
-
}
|
|
42145
|
-
|
|
42146
|
-
/**
|
|
42147
|
-
* Update documents collection
|
|
42148
|
-
*
|
|
42149
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
42150
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
42151
|
-
* @param {Array.<Object>} body
|
|
42152
|
-
* @deprecated
|
|
42153
|
-
*/
|
|
42154
|
-
patchKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, body) {
|
|
42155
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
42156
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
42157
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseLanguageDocuments';
|
|
42158
|
-
}
|
|
42159
|
-
// verify the required parameter 'languageCode' is set
|
|
42160
|
-
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
42161
|
-
throw 'Missing the required parameter "languageCode" when calling patchKnowledgeKnowledgebaseLanguageDocuments';
|
|
42162
|
-
}
|
|
42163
|
-
// verify the required parameter 'body' is set
|
|
42164
|
-
if (body === undefined || body === null) {
|
|
42165
|
-
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseLanguageDocuments';
|
|
42166
|
-
}
|
|
42167
|
-
|
|
42168
|
-
return this.apiClient.callApi(
|
|
42169
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents',
|
|
42170
|
-
'PATCH',
|
|
42171
|
-
{ 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
|
|
42172
|
-
{ },
|
|
42173
|
-
{ },
|
|
42174
|
-
{ },
|
|
42175
|
-
body,
|
|
42176
|
-
['PureCloud OAuth'],
|
|
42177
|
-
['application/json'],
|
|
42178
|
-
['application/json']
|
|
42179
|
-
);
|
|
42180
|
-
}
|
|
42181
|
-
|
|
42182
|
-
/**
|
|
42183
|
-
* Start import operation
|
|
42184
|
-
*
|
|
42185
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
42186
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
42187
|
-
* @param {String} importId Import ID
|
|
42188
|
-
* @param {Object} body
|
|
42189
|
-
* @deprecated
|
|
42190
|
-
*/
|
|
42191
|
-
patchKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId, languageCode, importId, body) {
|
|
42192
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
42193
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
42194
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseLanguageDocumentsImport';
|
|
42195
|
-
}
|
|
42196
|
-
// verify the required parameter 'languageCode' is set
|
|
42197
|
-
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
42198
|
-
throw 'Missing the required parameter "languageCode" when calling patchKnowledgeKnowledgebaseLanguageDocumentsImport';
|
|
42199
|
-
}
|
|
42200
|
-
// verify the required parameter 'importId' is set
|
|
42201
|
-
if (importId === undefined || importId === null || importId === '') {
|
|
42202
|
-
throw 'Missing the required parameter "importId" when calling patchKnowledgeKnowledgebaseLanguageDocumentsImport';
|
|
42203
|
-
}
|
|
42204
|
-
// verify the required parameter 'body' is set
|
|
42205
|
-
if (body === undefined || body === null) {
|
|
42206
|
-
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseLanguageDocumentsImport';
|
|
42207
|
-
}
|
|
42208
|
-
|
|
42209
|
-
return this.apiClient.callApi(
|
|
42210
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/imports/{importId}',
|
|
42211
|
-
'PATCH',
|
|
42212
|
-
{ 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode,'importId': importId },
|
|
42213
|
-
{ },
|
|
42214
|
-
{ },
|
|
42215
|
-
{ },
|
|
42216
|
-
body,
|
|
42217
|
-
['PureCloud OAuth'],
|
|
42218
|
-
['application/json'],
|
|
42219
|
-
['application/json']
|
|
42220
|
-
);
|
|
42221
|
-
}
|
|
42222
|
-
|
|
42223
41794
|
/**
|
|
42224
41795
|
* Send update to the parse operation
|
|
42225
41796
|
*
|
|
@@ -43189,222 +42760,6 @@ class KnowledgeApi {
|
|
|
43189
42760
|
);
|
|
43190
42761
|
}
|
|
43191
42762
|
|
|
43192
|
-
/**
|
|
43193
|
-
* Create new category
|
|
43194
|
-
*
|
|
43195
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
43196
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
43197
|
-
* @param {Object} body
|
|
43198
|
-
* @deprecated
|
|
43199
|
-
*/
|
|
43200
|
-
postKnowledgeKnowledgebaseLanguageCategories(knowledgeBaseId, languageCode, body) {
|
|
43201
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
43202
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
43203
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLanguageCategories';
|
|
43204
|
-
}
|
|
43205
|
-
// verify the required parameter 'languageCode' is set
|
|
43206
|
-
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
43207
|
-
throw 'Missing the required parameter "languageCode" when calling postKnowledgeKnowledgebaseLanguageCategories';
|
|
43208
|
-
}
|
|
43209
|
-
// verify the required parameter 'body' is set
|
|
43210
|
-
if (body === undefined || body === null) {
|
|
43211
|
-
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseLanguageCategories';
|
|
43212
|
-
}
|
|
43213
|
-
|
|
43214
|
-
return this.apiClient.callApi(
|
|
43215
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories',
|
|
43216
|
-
'POST',
|
|
43217
|
-
{ 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
|
|
43218
|
-
{ },
|
|
43219
|
-
{ },
|
|
43220
|
-
{ },
|
|
43221
|
-
body,
|
|
43222
|
-
['PureCloud OAuth'],
|
|
43223
|
-
['application/json'],
|
|
43224
|
-
['application/json']
|
|
43225
|
-
);
|
|
43226
|
-
}
|
|
43227
|
-
|
|
43228
|
-
/**
|
|
43229
|
-
* Upload Article Content
|
|
43230
|
-
*
|
|
43231
|
-
* @param {String} documentId Document ID
|
|
43232
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
43233
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
43234
|
-
* @param {Object} body
|
|
43235
|
-
* @deprecated
|
|
43236
|
-
*/
|
|
43237
|
-
postKnowledgeKnowledgebaseLanguageDocumentUploads(documentId, knowledgeBaseId, languageCode, body) {
|
|
43238
|
-
// verify the required parameter 'documentId' is set
|
|
43239
|
-
if (documentId === undefined || documentId === null || documentId === '') {
|
|
43240
|
-
throw 'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseLanguageDocumentUploads';
|
|
43241
|
-
}
|
|
43242
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
43243
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
43244
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLanguageDocumentUploads';
|
|
43245
|
-
}
|
|
43246
|
-
// verify the required parameter 'languageCode' is set
|
|
43247
|
-
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
43248
|
-
throw 'Missing the required parameter "languageCode" when calling postKnowledgeKnowledgebaseLanguageDocumentUploads';
|
|
43249
|
-
}
|
|
43250
|
-
// verify the required parameter 'body' is set
|
|
43251
|
-
if (body === undefined || body === null) {
|
|
43252
|
-
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseLanguageDocumentUploads';
|
|
43253
|
-
}
|
|
43254
|
-
|
|
43255
|
-
return this.apiClient.callApi(
|
|
43256
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}/uploads',
|
|
43257
|
-
'POST',
|
|
43258
|
-
{ 'documentId': documentId,'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
|
|
43259
|
-
{ },
|
|
43260
|
-
{ },
|
|
43261
|
-
{ },
|
|
43262
|
-
body,
|
|
43263
|
-
['PureCloud OAuth'],
|
|
43264
|
-
['application/json'],
|
|
43265
|
-
['application/json']
|
|
43266
|
-
);
|
|
43267
|
-
}
|
|
43268
|
-
|
|
43269
|
-
/**
|
|
43270
|
-
* Create document
|
|
43271
|
-
*
|
|
43272
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
43273
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
43274
|
-
* @param {Object} body
|
|
43275
|
-
* @deprecated
|
|
43276
|
-
*/
|
|
43277
|
-
postKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, body) {
|
|
43278
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
43279
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
43280
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLanguageDocuments';
|
|
43281
|
-
}
|
|
43282
|
-
// verify the required parameter 'languageCode' is set
|
|
43283
|
-
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
43284
|
-
throw 'Missing the required parameter "languageCode" when calling postKnowledgeKnowledgebaseLanguageDocuments';
|
|
43285
|
-
}
|
|
43286
|
-
// verify the required parameter 'body' is set
|
|
43287
|
-
if (body === undefined || body === null) {
|
|
43288
|
-
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseLanguageDocuments';
|
|
43289
|
-
}
|
|
43290
|
-
|
|
43291
|
-
return this.apiClient.callApi(
|
|
43292
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents',
|
|
43293
|
-
'POST',
|
|
43294
|
-
{ 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
|
|
43295
|
-
{ },
|
|
43296
|
-
{ },
|
|
43297
|
-
{ },
|
|
43298
|
-
body,
|
|
43299
|
-
['PureCloud OAuth'],
|
|
43300
|
-
['application/json'],
|
|
43301
|
-
['application/json']
|
|
43302
|
-
);
|
|
43303
|
-
}
|
|
43304
|
-
|
|
43305
|
-
/**
|
|
43306
|
-
* Create import operation
|
|
43307
|
-
*
|
|
43308
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
43309
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
43310
|
-
* @param {Object} body
|
|
43311
|
-
* @deprecated
|
|
43312
|
-
*/
|
|
43313
|
-
postKnowledgeKnowledgebaseLanguageDocumentsImports(knowledgeBaseId, languageCode, body) {
|
|
43314
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
43315
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
43316
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLanguageDocumentsImports';
|
|
43317
|
-
}
|
|
43318
|
-
// verify the required parameter 'languageCode' is set
|
|
43319
|
-
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
43320
|
-
throw 'Missing the required parameter "languageCode" when calling postKnowledgeKnowledgebaseLanguageDocumentsImports';
|
|
43321
|
-
}
|
|
43322
|
-
// verify the required parameter 'body' is set
|
|
43323
|
-
if (body === undefined || body === null) {
|
|
43324
|
-
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseLanguageDocumentsImports';
|
|
43325
|
-
}
|
|
43326
|
-
|
|
43327
|
-
return this.apiClient.callApi(
|
|
43328
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/imports',
|
|
43329
|
-
'POST',
|
|
43330
|
-
{ 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
|
|
43331
|
-
{ },
|
|
43332
|
-
{ },
|
|
43333
|
-
{ },
|
|
43334
|
-
body,
|
|
43335
|
-
['PureCloud OAuth'],
|
|
43336
|
-
['application/json'],
|
|
43337
|
-
['application/json']
|
|
43338
|
-
);
|
|
43339
|
-
}
|
|
43340
|
-
|
|
43341
|
-
/**
|
|
43342
|
-
* Promote trained documents from draft state to active.
|
|
43343
|
-
*
|
|
43344
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
43345
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
43346
|
-
* @param {String} trainingId Training ID
|
|
43347
|
-
* @deprecated
|
|
43348
|
-
*/
|
|
43349
|
-
postKnowledgeKnowledgebaseLanguageTrainingPromote(knowledgeBaseId, languageCode, trainingId) {
|
|
43350
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
43351
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
43352
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLanguageTrainingPromote';
|
|
43353
|
-
}
|
|
43354
|
-
// verify the required parameter 'languageCode' is set
|
|
43355
|
-
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
43356
|
-
throw 'Missing the required parameter "languageCode" when calling postKnowledgeKnowledgebaseLanguageTrainingPromote';
|
|
43357
|
-
}
|
|
43358
|
-
// verify the required parameter 'trainingId' is set
|
|
43359
|
-
if (trainingId === undefined || trainingId === null || trainingId === '') {
|
|
43360
|
-
throw 'Missing the required parameter "trainingId" when calling postKnowledgeKnowledgebaseLanguageTrainingPromote';
|
|
43361
|
-
}
|
|
43362
|
-
|
|
43363
|
-
return this.apiClient.callApi(
|
|
43364
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings/{trainingId}/promote',
|
|
43365
|
-
'POST',
|
|
43366
|
-
{ 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode,'trainingId': trainingId },
|
|
43367
|
-
{ },
|
|
43368
|
-
{ },
|
|
43369
|
-
{ },
|
|
43370
|
-
null,
|
|
43371
|
-
['PureCloud OAuth'],
|
|
43372
|
-
['application/json'],
|
|
43373
|
-
['application/json']
|
|
43374
|
-
);
|
|
43375
|
-
}
|
|
43376
|
-
|
|
43377
|
-
/**
|
|
43378
|
-
* Trigger training
|
|
43379
|
-
*
|
|
43380
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
43381
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
43382
|
-
* @deprecated
|
|
43383
|
-
*/
|
|
43384
|
-
postKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId, languageCode) {
|
|
43385
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
43386
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
43387
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLanguageTrainings';
|
|
43388
|
-
}
|
|
43389
|
-
// verify the required parameter 'languageCode' is set
|
|
43390
|
-
if (languageCode === undefined || languageCode === null || languageCode === '') {
|
|
43391
|
-
throw 'Missing the required parameter "languageCode" when calling postKnowledgeKnowledgebaseLanguageTrainings';
|
|
43392
|
-
}
|
|
43393
|
-
|
|
43394
|
-
return this.apiClient.callApi(
|
|
43395
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings',
|
|
43396
|
-
'POST',
|
|
43397
|
-
{ 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
|
|
43398
|
-
{ },
|
|
43399
|
-
{ },
|
|
43400
|
-
{ },
|
|
43401
|
-
null,
|
|
43402
|
-
['PureCloud OAuth'],
|
|
43403
|
-
['application/json'],
|
|
43404
|
-
['application/json']
|
|
43405
|
-
);
|
|
43406
|
-
}
|
|
43407
|
-
|
|
43408
42763
|
/**
|
|
43409
42764
|
* Import the parsed articles
|
|
43410
42765
|
*
|
|
@@ -43470,36 +42825,6 @@ class KnowledgeApi {
|
|
|
43470
42825
|
);
|
|
43471
42826
|
}
|
|
43472
42827
|
|
|
43473
|
-
/**
|
|
43474
|
-
* Search Documents
|
|
43475
|
-
*
|
|
43476
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
43477
|
-
* @param {Object} opts Optional parameters
|
|
43478
|
-
* @param {Object} opts.body
|
|
43479
|
-
* @deprecated
|
|
43480
|
-
*/
|
|
43481
|
-
postKnowledgeKnowledgebaseSearch(knowledgeBaseId, opts) {
|
|
43482
|
-
opts = opts || {};
|
|
43483
|
-
|
|
43484
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
43485
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
43486
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSearch';
|
|
43487
|
-
}
|
|
43488
|
-
|
|
43489
|
-
return this.apiClient.callApi(
|
|
43490
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/search',
|
|
43491
|
-
'POST',
|
|
43492
|
-
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
43493
|
-
{ },
|
|
43494
|
-
{ },
|
|
43495
|
-
{ },
|
|
43496
|
-
opts['body'],
|
|
43497
|
-
['PureCloud OAuth'],
|
|
43498
|
-
['application/json'],
|
|
43499
|
-
['application/json']
|
|
43500
|
-
);
|
|
43501
|
-
}
|
|
43502
|
-
|
|
43503
42828
|
/**
|
|
43504
42829
|
* Create Salesforce Knowledge integration source
|
|
43505
42830
|
*
|
|
@@ -43789,7 +43114,7 @@ class LanguageUnderstandingApi {
|
|
|
43789
43114
|
/**
|
|
43790
43115
|
* LanguageUnderstanding service.
|
|
43791
43116
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
43792
|
-
* @version
|
|
43117
|
+
* @version 235.0.0
|
|
43793
43118
|
*/
|
|
43794
43119
|
|
|
43795
43120
|
/**
|
|
@@ -45008,7 +44333,7 @@ class LanguagesApi {
|
|
|
45008
44333
|
/**
|
|
45009
44334
|
* Languages service.
|
|
45010
44335
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
45011
|
-
* @version
|
|
44336
|
+
* @version 235.0.0
|
|
45012
44337
|
*/
|
|
45013
44338
|
|
|
45014
44339
|
/**
|
|
@@ -45230,7 +44555,7 @@ class LearningApi {
|
|
|
45230
44555
|
/**
|
|
45231
44556
|
* Learning service.
|
|
45232
44557
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
45233
|
-
* @version
|
|
44558
|
+
* @version 235.0.0
|
|
45234
44559
|
*/
|
|
45235
44560
|
|
|
45236
44561
|
/**
|
|
@@ -45671,6 +44996,31 @@ class LearningApi {
|
|
|
45671
44996
|
);
|
|
45672
44997
|
}
|
|
45673
44998
|
|
|
44999
|
+
/**
|
|
45000
|
+
* Retrieve the status of the job for the slots where a learning activity can be scheduled.
|
|
45001
|
+
*
|
|
45002
|
+
* @param {String} jobId The ID of the job
|
|
45003
|
+
*/
|
|
45004
|
+
getLearningScheduleslotsJob(jobId) {
|
|
45005
|
+
// verify the required parameter 'jobId' is set
|
|
45006
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
45007
|
+
throw 'Missing the required parameter "jobId" when calling getLearningScheduleslotsJob';
|
|
45008
|
+
}
|
|
45009
|
+
|
|
45010
|
+
return this.apiClient.callApi(
|
|
45011
|
+
'/api/v2/learning/scheduleslots/jobs/{jobId}',
|
|
45012
|
+
'GET',
|
|
45013
|
+
{ 'jobId': jobId },
|
|
45014
|
+
{ },
|
|
45015
|
+
{ },
|
|
45016
|
+
{ },
|
|
45017
|
+
null,
|
|
45018
|
+
['PureCloud OAuth'],
|
|
45019
|
+
['application/json'],
|
|
45020
|
+
['application/json']
|
|
45021
|
+
);
|
|
45022
|
+
}
|
|
45023
|
+
|
|
45674
45024
|
/**
|
|
45675
45025
|
* Get Learning SCORM Result
|
|
45676
45026
|
*
|
|
@@ -46114,6 +45464,31 @@ class LearningApi {
|
|
|
46114
45464
|
);
|
|
46115
45465
|
}
|
|
46116
45466
|
|
|
45467
|
+
/**
|
|
45468
|
+
* Start job to retrieve slots where a learning activity can be scheduled.
|
|
45469
|
+
*
|
|
45470
|
+
* @param {Object} body The slots search request
|
|
45471
|
+
*/
|
|
45472
|
+
postLearningScheduleslotsJobs(body) {
|
|
45473
|
+
// verify the required parameter 'body' is set
|
|
45474
|
+
if (body === undefined || body === null) {
|
|
45475
|
+
throw 'Missing the required parameter "body" when calling postLearningScheduleslotsJobs';
|
|
45476
|
+
}
|
|
45477
|
+
|
|
45478
|
+
return this.apiClient.callApi(
|
|
45479
|
+
'/api/v2/learning/scheduleslots/jobs',
|
|
45480
|
+
'POST',
|
|
45481
|
+
{ },
|
|
45482
|
+
{ },
|
|
45483
|
+
{ },
|
|
45484
|
+
{ },
|
|
45485
|
+
body,
|
|
45486
|
+
['PureCloud OAuth'],
|
|
45487
|
+
['application/json'],
|
|
45488
|
+
['application/json']
|
|
45489
|
+
);
|
|
45490
|
+
}
|
|
45491
|
+
|
|
46117
45492
|
/**
|
|
46118
45493
|
* Get list of possible slots where a learning activity can be scheduled.
|
|
46119
45494
|
*
|
|
@@ -46263,7 +45638,7 @@ class LicenseApi {
|
|
|
46263
45638
|
/**
|
|
46264
45639
|
* License service.
|
|
46265
45640
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
46266
|
-
* @version
|
|
45641
|
+
* @version 235.0.0
|
|
46267
45642
|
*/
|
|
46268
45643
|
|
|
46269
45644
|
/**
|
|
@@ -46501,7 +45876,7 @@ class LocationsApi {
|
|
|
46501
45876
|
/**
|
|
46502
45877
|
* Locations service.
|
|
46503
45878
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
46504
|
-
* @version
|
|
45879
|
+
* @version 235.0.0
|
|
46505
45880
|
*/
|
|
46506
45881
|
|
|
46507
45882
|
/**
|
|
@@ -46737,7 +46112,7 @@ class LogCaptureApi {
|
|
|
46737
46112
|
/**
|
|
46738
46113
|
* LogCapture service.
|
|
46739
46114
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
46740
|
-
* @version
|
|
46115
|
+
* @version 235.0.0
|
|
46741
46116
|
*/
|
|
46742
46117
|
|
|
46743
46118
|
/**
|
|
@@ -46936,7 +46311,7 @@ class MessagingApi {
|
|
|
46936
46311
|
/**
|
|
46937
46312
|
* Messaging service.
|
|
46938
46313
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
46939
|
-
* @version
|
|
46314
|
+
* @version 235.0.0
|
|
46940
46315
|
*/
|
|
46941
46316
|
|
|
46942
46317
|
/**
|
|
@@ -47295,7 +46670,7 @@ class MobileDevicesApi {
|
|
|
47295
46670
|
/**
|
|
47296
46671
|
* MobileDevices service.
|
|
47297
46672
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
47298
|
-
* @version
|
|
46673
|
+
* @version 235.0.0
|
|
47299
46674
|
*/
|
|
47300
46675
|
|
|
47301
46676
|
/**
|
|
@@ -47446,7 +46821,7 @@ class NotificationsApi {
|
|
|
47446
46821
|
/**
|
|
47447
46822
|
* Notifications service.
|
|
47448
46823
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
47449
|
-
* @version
|
|
46824
|
+
* @version 235.0.0
|
|
47450
46825
|
*/
|
|
47451
46826
|
|
|
47452
46827
|
/**
|
|
@@ -47679,7 +47054,7 @@ class OAuthApi {
|
|
|
47679
47054
|
/**
|
|
47680
47055
|
* OAuth service.
|
|
47681
47056
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
47682
|
-
* @version
|
|
47057
|
+
* @version 235.0.0
|
|
47683
47058
|
*/
|
|
47684
47059
|
|
|
47685
47060
|
/**
|
|
@@ -48045,7 +47420,7 @@ class ObjectsApi {
|
|
|
48045
47420
|
/**
|
|
48046
47421
|
* Objects service.
|
|
48047
47422
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
48048
|
-
* @version
|
|
47423
|
+
* @version 235.0.0
|
|
48049
47424
|
*/
|
|
48050
47425
|
|
|
48051
47426
|
/**
|
|
@@ -48369,7 +47744,7 @@ class OperationalEventsApi {
|
|
|
48369
47744
|
/**
|
|
48370
47745
|
* OperationalEvents service.
|
|
48371
47746
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
48372
|
-
* @version
|
|
47747
|
+
* @version 235.0.0
|
|
48373
47748
|
*/
|
|
48374
47749
|
|
|
48375
47750
|
/**
|
|
@@ -48486,7 +47861,7 @@ class OrganizationApi {
|
|
|
48486
47861
|
/**
|
|
48487
47862
|
* Organization service.
|
|
48488
47863
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
48489
|
-
* @version
|
|
47864
|
+
* @version 235.0.0
|
|
48490
47865
|
*/
|
|
48491
47866
|
|
|
48492
47867
|
/**
|
|
@@ -48961,7 +48336,7 @@ class OrganizationAuthorizationApi {
|
|
|
48961
48336
|
/**
|
|
48962
48337
|
* OrganizationAuthorization service.
|
|
48963
48338
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
48964
|
-
* @version
|
|
48339
|
+
* @version 235.0.0
|
|
48965
48340
|
*/
|
|
48966
48341
|
|
|
48967
48342
|
/**
|
|
@@ -50355,7 +49730,7 @@ class OutboundApi {
|
|
|
50355
49730
|
/**
|
|
50356
49731
|
* Outbound service.
|
|
50357
49732
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
50358
|
-
* @version
|
|
49733
|
+
* @version 235.0.0
|
|
50359
49734
|
*/
|
|
50360
49735
|
|
|
50361
49736
|
/**
|
|
@@ -53573,6 +52948,31 @@ class OutboundApi {
|
|
|
53573
52948
|
);
|
|
53574
52949
|
}
|
|
53575
52950
|
|
|
52951
|
+
/**
|
|
52952
|
+
* Get performance data for a list of campaigns
|
|
52953
|
+
*
|
|
52954
|
+
* @param {Array.<String>} body Campaign IDs. Maximum of 50 IDs allowed.
|
|
52955
|
+
*/
|
|
52956
|
+
postOutboundCampaignsPerformanceQuery(body) {
|
|
52957
|
+
// verify the required parameter 'body' is set
|
|
52958
|
+
if (body === undefined || body === null) {
|
|
52959
|
+
throw 'Missing the required parameter "body" when calling postOutboundCampaignsPerformanceQuery';
|
|
52960
|
+
}
|
|
52961
|
+
|
|
52962
|
+
return this.apiClient.callApi(
|
|
52963
|
+
'/api/v2/outbound/campaigns/performance/query',
|
|
52964
|
+
'POST',
|
|
52965
|
+
{ },
|
|
52966
|
+
{ },
|
|
52967
|
+
{ },
|
|
52968
|
+
{ },
|
|
52969
|
+
body,
|
|
52970
|
+
['PureCloud OAuth'],
|
|
52971
|
+
['application/json'],
|
|
52972
|
+
['application/json']
|
|
52973
|
+
);
|
|
52974
|
+
}
|
|
52975
|
+
|
|
53576
52976
|
/**
|
|
53577
52977
|
* Get progress for a list of campaigns
|
|
53578
52978
|
*
|
|
@@ -55077,7 +54477,7 @@ class PresenceApi {
|
|
|
55077
54477
|
/**
|
|
55078
54478
|
* Presence service.
|
|
55079
54479
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
55080
|
-
* @version
|
|
54480
|
+
* @version 235.0.0
|
|
55081
54481
|
*/
|
|
55082
54482
|
|
|
55083
54483
|
/**
|
|
@@ -55821,7 +55221,7 @@ class ProcessAutomationApi {
|
|
|
55821
55221
|
/**
|
|
55822
55222
|
* ProcessAutomation service.
|
|
55823
55223
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
55824
|
-
* @version
|
|
55224
|
+
* @version 235.0.0
|
|
55825
55225
|
*/
|
|
55826
55226
|
|
|
55827
55227
|
/**
|
|
@@ -56060,7 +55460,7 @@ class QualityApi {
|
|
|
56060
55460
|
/**
|
|
56061
55461
|
* Quality service.
|
|
56062
55462
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
56063
|
-
* @version
|
|
55463
|
+
* @version 235.0.0
|
|
56064
55464
|
*/
|
|
56065
55465
|
|
|
56066
55466
|
/**
|
|
@@ -57124,59 +56524,6 @@ class QualityApi {
|
|
|
57124
56524
|
);
|
|
57125
56525
|
}
|
|
57126
56526
|
|
|
57127
|
-
/**
|
|
57128
|
-
* Get the most recent published version of an evaluation form across any division.
|
|
57129
|
-
*
|
|
57130
|
-
* @param {String} evaluationFormId Evaluation Form ID
|
|
57131
|
-
* getQualityPublishedformsEvaluationsDivisionview is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57132
|
-
*/
|
|
57133
|
-
getQualityPublishedformsEvaluationsDivisionview(evaluationFormId) {
|
|
57134
|
-
// verify the required parameter 'evaluationFormId' is set
|
|
57135
|
-
if (evaluationFormId === undefined || evaluationFormId === null || evaluationFormId === '') {
|
|
57136
|
-
throw 'Missing the required parameter "evaluationFormId" when calling getQualityPublishedformsEvaluationsDivisionview';
|
|
57137
|
-
}
|
|
57138
|
-
|
|
57139
|
-
return this.apiClient.callApi(
|
|
57140
|
-
'/api/v2/quality/publishedforms/evaluations/divisionviews/{evaluationFormId}',
|
|
57141
|
-
'GET',
|
|
57142
|
-
{ 'evaluationFormId': evaluationFormId },
|
|
57143
|
-
{ },
|
|
57144
|
-
{ },
|
|
57145
|
-
{ },
|
|
57146
|
-
null,
|
|
57147
|
-
['PureCloud OAuth'],
|
|
57148
|
-
['application/json'],
|
|
57149
|
-
['application/json']
|
|
57150
|
-
);
|
|
57151
|
-
}
|
|
57152
|
-
|
|
57153
|
-
/**
|
|
57154
|
-
* Get the published evaluation forms across any division.
|
|
57155
|
-
*
|
|
57156
|
-
* @param {Object} opts Optional parameters
|
|
57157
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
57158
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
57159
|
-
* @param {String} opts.name Name
|
|
57160
|
-
* getQualityPublishedformsEvaluationsDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57161
|
-
*/
|
|
57162
|
-
getQualityPublishedformsEvaluationsDivisionviews(opts) {
|
|
57163
|
-
opts = opts || {};
|
|
57164
|
-
|
|
57165
|
-
|
|
57166
|
-
return this.apiClient.callApi(
|
|
57167
|
-
'/api/v2/quality/publishedforms/evaluations/divisionviews',
|
|
57168
|
-
'GET',
|
|
57169
|
-
{ },
|
|
57170
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'name': opts['name'] },
|
|
57171
|
-
{ },
|
|
57172
|
-
{ },
|
|
57173
|
-
null,
|
|
57174
|
-
['PureCloud OAuth'],
|
|
57175
|
-
['application/json'],
|
|
57176
|
-
['application/json']
|
|
57177
|
-
);
|
|
57178
|
-
}
|
|
57179
|
-
|
|
57180
56527
|
/**
|
|
57181
56528
|
* Get the most recent published version of a survey form.
|
|
57182
56529
|
*
|
|
@@ -57229,59 +56576,6 @@ class QualityApi {
|
|
|
57229
56576
|
);
|
|
57230
56577
|
}
|
|
57231
56578
|
|
|
57232
|
-
/**
|
|
57233
|
-
* Get the most recent published version of an enabled survey form across any division.
|
|
57234
|
-
*
|
|
57235
|
-
* @param {String} surveyFormId Survey Form ID
|
|
57236
|
-
* getQualityPublishedformsSurveysDivisionview is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57237
|
-
*/
|
|
57238
|
-
getQualityPublishedformsSurveysDivisionview(surveyFormId) {
|
|
57239
|
-
// verify the required parameter 'surveyFormId' is set
|
|
57240
|
-
if (surveyFormId === undefined || surveyFormId === null || surveyFormId === '') {
|
|
57241
|
-
throw 'Missing the required parameter "surveyFormId" when calling getQualityPublishedformsSurveysDivisionview';
|
|
57242
|
-
}
|
|
57243
|
-
|
|
57244
|
-
return this.apiClient.callApi(
|
|
57245
|
-
'/api/v2/quality/publishedforms/surveys/divisionviews/{surveyFormId}',
|
|
57246
|
-
'GET',
|
|
57247
|
-
{ 'surveyFormId': surveyFormId },
|
|
57248
|
-
{ },
|
|
57249
|
-
{ },
|
|
57250
|
-
{ },
|
|
57251
|
-
null,
|
|
57252
|
-
['PureCloud OAuth'],
|
|
57253
|
-
['application/json'],
|
|
57254
|
-
['application/json']
|
|
57255
|
-
);
|
|
57256
|
-
}
|
|
57257
|
-
|
|
57258
|
-
/**
|
|
57259
|
-
* Get the published and enabled survey forms across any division.
|
|
57260
|
-
*
|
|
57261
|
-
* @param {Object} opts Optional parameters
|
|
57262
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
57263
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
57264
|
-
* @param {String} opts.name Name
|
|
57265
|
-
* getQualityPublishedformsSurveysDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57266
|
-
*/
|
|
57267
|
-
getQualityPublishedformsSurveysDivisionviews(opts) {
|
|
57268
|
-
opts = opts || {};
|
|
57269
|
-
|
|
57270
|
-
|
|
57271
|
-
return this.apiClient.callApi(
|
|
57272
|
-
'/api/v2/quality/publishedforms/surveys/divisionviews',
|
|
57273
|
-
'GET',
|
|
57274
|
-
{ },
|
|
57275
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'name': opts['name'] },
|
|
57276
|
-
{ },
|
|
57277
|
-
{ },
|
|
57278
|
-
null,
|
|
57279
|
-
['PureCloud OAuth'],
|
|
57280
|
-
['application/json'],
|
|
57281
|
-
['application/json']
|
|
57282
|
-
);
|
|
57283
|
-
}
|
|
57284
|
-
|
|
57285
56579
|
/**
|
|
57286
56580
|
* Get a survey for a conversation
|
|
57287
56581
|
*
|
|
@@ -58005,7 +57299,7 @@ class RecordingApi {
|
|
|
58005
57299
|
/**
|
|
58006
57300
|
* Recording service.
|
|
58007
57301
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
58008
|
-
* @version
|
|
57302
|
+
* @version 235.0.0
|
|
58009
57303
|
*/
|
|
58010
57304
|
|
|
58011
57305
|
/**
|
|
@@ -59610,7 +58904,7 @@ class ResponseManagementApi {
|
|
|
59610
58904
|
/**
|
|
59611
58905
|
* ResponseManagement service.
|
|
59612
58906
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
59613
|
-
* @version
|
|
58907
|
+
* @version 235.0.0
|
|
59614
58908
|
*/
|
|
59615
58909
|
|
|
59616
58910
|
/**
|
|
@@ -60120,7 +59414,7 @@ class RoutingApi {
|
|
|
60120
59414
|
/**
|
|
60121
59415
|
* Routing service.
|
|
60122
59416
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
60123
|
-
* @version
|
|
59417
|
+
* @version 235.0.0
|
|
60124
59418
|
*/
|
|
60125
59419
|
|
|
60126
59420
|
/**
|
|
@@ -60935,6 +60229,56 @@ class RoutingApi {
|
|
|
60935
60229
|
);
|
|
60936
60230
|
}
|
|
60937
60231
|
|
|
60232
|
+
/**
|
|
60233
|
+
* Get domain dkim settings
|
|
60234
|
+
*
|
|
60235
|
+
* @param {String} domainId domain ID
|
|
60236
|
+
*/
|
|
60237
|
+
getRoutingEmailDomainDkim(domainId) {
|
|
60238
|
+
// verify the required parameter 'domainId' is set
|
|
60239
|
+
if (domainId === undefined || domainId === null || domainId === '') {
|
|
60240
|
+
throw 'Missing the required parameter "domainId" when calling getRoutingEmailDomainDkim';
|
|
60241
|
+
}
|
|
60242
|
+
|
|
60243
|
+
return this.apiClient.callApi(
|
|
60244
|
+
'/api/v2/routing/email/domains/{domainId}/dkim',
|
|
60245
|
+
'GET',
|
|
60246
|
+
{ 'domainId': domainId },
|
|
60247
|
+
{ },
|
|
60248
|
+
{ },
|
|
60249
|
+
{ },
|
|
60250
|
+
null,
|
|
60251
|
+
['PureCloud OAuth'],
|
|
60252
|
+
['application/json'],
|
|
60253
|
+
['application/json']
|
|
60254
|
+
);
|
|
60255
|
+
}
|
|
60256
|
+
|
|
60257
|
+
/**
|
|
60258
|
+
* Get domain mail from settings
|
|
60259
|
+
*
|
|
60260
|
+
* @param {String} domainId domain ID
|
|
60261
|
+
*/
|
|
60262
|
+
getRoutingEmailDomainMailfrom(domainId) {
|
|
60263
|
+
// verify the required parameter 'domainId' is set
|
|
60264
|
+
if (domainId === undefined || domainId === null || domainId === '') {
|
|
60265
|
+
throw 'Missing the required parameter "domainId" when calling getRoutingEmailDomainMailfrom';
|
|
60266
|
+
}
|
|
60267
|
+
|
|
60268
|
+
return this.apiClient.callApi(
|
|
60269
|
+
'/api/v2/routing/email/domains/{domainId}/mailfrom',
|
|
60270
|
+
'GET',
|
|
60271
|
+
{ 'domainId': domainId },
|
|
60272
|
+
{ },
|
|
60273
|
+
{ },
|
|
60274
|
+
{ },
|
|
60275
|
+
null,
|
|
60276
|
+
['PureCloud OAuth'],
|
|
60277
|
+
['application/json'],
|
|
60278
|
+
['application/json']
|
|
60279
|
+
);
|
|
60280
|
+
}
|
|
60281
|
+
|
|
60938
60282
|
/**
|
|
60939
60283
|
* Get a route
|
|
60940
60284
|
*
|
|
@@ -61031,6 +60375,31 @@ class RoutingApi {
|
|
|
61031
60375
|
);
|
|
61032
60376
|
}
|
|
61033
60377
|
|
|
60378
|
+
/**
|
|
60379
|
+
* Get domain verification settings
|
|
60380
|
+
*
|
|
60381
|
+
* @param {String} domainId domain ID
|
|
60382
|
+
*/
|
|
60383
|
+
getRoutingEmailDomainVerification(domainId) {
|
|
60384
|
+
// verify the required parameter 'domainId' is set
|
|
60385
|
+
if (domainId === undefined || domainId === null || domainId === '') {
|
|
60386
|
+
throw 'Missing the required parameter "domainId" when calling getRoutingEmailDomainVerification';
|
|
60387
|
+
}
|
|
60388
|
+
|
|
60389
|
+
return this.apiClient.callApi(
|
|
60390
|
+
'/api/v2/routing/email/domains/{domainId}/verification',
|
|
60391
|
+
'GET',
|
|
60392
|
+
{ 'domainId': domainId },
|
|
60393
|
+
{ },
|
|
60394
|
+
{ },
|
|
60395
|
+
{ },
|
|
60396
|
+
null,
|
|
60397
|
+
['PureCloud OAuth'],
|
|
60398
|
+
['application/json'],
|
|
60399
|
+
['application/json']
|
|
60400
|
+
);
|
|
60401
|
+
}
|
|
60402
|
+
|
|
61034
60403
|
/**
|
|
61035
60404
|
* Get domains
|
|
61036
60405
|
*
|
|
@@ -63319,6 +62688,61 @@ class RoutingApi {
|
|
|
63319
62688
|
);
|
|
63320
62689
|
}
|
|
63321
62690
|
|
|
62691
|
+
/**
|
|
62692
|
+
* Restart domain dkim
|
|
62693
|
+
*
|
|
62694
|
+
* @param {String} domainId domain ID
|
|
62695
|
+
*/
|
|
62696
|
+
postRoutingEmailDomainDkim(domainId) {
|
|
62697
|
+
// verify the required parameter 'domainId' is set
|
|
62698
|
+
if (domainId === undefined || domainId === null || domainId === '') {
|
|
62699
|
+
throw 'Missing the required parameter "domainId" when calling postRoutingEmailDomainDkim';
|
|
62700
|
+
}
|
|
62701
|
+
|
|
62702
|
+
return this.apiClient.callApi(
|
|
62703
|
+
'/api/v2/routing/email/domains/{domainId}/dkim',
|
|
62704
|
+
'POST',
|
|
62705
|
+
{ 'domainId': domainId },
|
|
62706
|
+
{ },
|
|
62707
|
+
{ },
|
|
62708
|
+
{ },
|
|
62709
|
+
null,
|
|
62710
|
+
['PureCloud OAuth'],
|
|
62711
|
+
['application/json'],
|
|
62712
|
+
['application/json']
|
|
62713
|
+
);
|
|
62714
|
+
}
|
|
62715
|
+
|
|
62716
|
+
/**
|
|
62717
|
+
* Set domain mail from settings
|
|
62718
|
+
*
|
|
62719
|
+
* @param {String} domainId domain ID
|
|
62720
|
+
* @param {Object} body Mail From Settings
|
|
62721
|
+
*/
|
|
62722
|
+
postRoutingEmailDomainMailfrom(domainId, body) {
|
|
62723
|
+
// verify the required parameter 'domainId' is set
|
|
62724
|
+
if (domainId === undefined || domainId === null || domainId === '') {
|
|
62725
|
+
throw 'Missing the required parameter "domainId" when calling postRoutingEmailDomainMailfrom';
|
|
62726
|
+
}
|
|
62727
|
+
// verify the required parameter 'body' is set
|
|
62728
|
+
if (body === undefined || body === null) {
|
|
62729
|
+
throw 'Missing the required parameter "body" when calling postRoutingEmailDomainMailfrom';
|
|
62730
|
+
}
|
|
62731
|
+
|
|
62732
|
+
return this.apiClient.callApi(
|
|
62733
|
+
'/api/v2/routing/email/domains/{domainId}/mailfrom',
|
|
62734
|
+
'POST',
|
|
62735
|
+
{ 'domainId': domainId },
|
|
62736
|
+
{ },
|
|
62737
|
+
{ },
|
|
62738
|
+
{ },
|
|
62739
|
+
body,
|
|
62740
|
+
['PureCloud OAuth'],
|
|
62741
|
+
['application/json'],
|
|
62742
|
+
['application/json']
|
|
62743
|
+
);
|
|
62744
|
+
}
|
|
62745
|
+
|
|
63322
62746
|
/**
|
|
63323
62747
|
* Create a route
|
|
63324
62748
|
*
|
|
@@ -63378,6 +62802,31 @@ class RoutingApi {
|
|
|
63378
62802
|
);
|
|
63379
62803
|
}
|
|
63380
62804
|
|
|
62805
|
+
/**
|
|
62806
|
+
* Restart domain verification
|
|
62807
|
+
*
|
|
62808
|
+
* @param {String} domainId domain ID
|
|
62809
|
+
*/
|
|
62810
|
+
postRoutingEmailDomainVerification(domainId) {
|
|
62811
|
+
// verify the required parameter 'domainId' is set
|
|
62812
|
+
if (domainId === undefined || domainId === null || domainId === '') {
|
|
62813
|
+
throw 'Missing the required parameter "domainId" when calling postRoutingEmailDomainVerification';
|
|
62814
|
+
}
|
|
62815
|
+
|
|
62816
|
+
return this.apiClient.callApi(
|
|
62817
|
+
'/api/v2/routing/email/domains/{domainId}/verification',
|
|
62818
|
+
'POST',
|
|
62819
|
+
{ 'domainId': domainId },
|
|
62820
|
+
{ },
|
|
62821
|
+
{ },
|
|
62822
|
+
{ },
|
|
62823
|
+
null,
|
|
62824
|
+
['PureCloud OAuth'],
|
|
62825
|
+
['application/json'],
|
|
62826
|
+
['application/json']
|
|
62827
|
+
);
|
|
62828
|
+
}
|
|
62829
|
+
|
|
63381
62830
|
/**
|
|
63382
62831
|
* Create a domain
|
|
63383
62832
|
*
|
|
@@ -64448,7 +63897,7 @@ class SCIMApi {
|
|
|
64448
63897
|
/**
|
|
64449
63898
|
* SCIM service.
|
|
64450
63899
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
64451
|
-
* @version
|
|
63900
|
+
* @version 235.0.0
|
|
64452
63901
|
*/
|
|
64453
63902
|
|
|
64454
63903
|
/**
|
|
@@ -65325,7 +64774,7 @@ class ScreenRecordingApi {
|
|
|
65325
64774
|
/**
|
|
65326
64775
|
* ScreenRecording service.
|
|
65327
64776
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
65328
|
-
* @version
|
|
64777
|
+
* @version 235.0.0
|
|
65329
64778
|
*/
|
|
65330
64779
|
|
|
65331
64780
|
/**
|
|
@@ -65370,7 +64819,7 @@ class ScriptsApi {
|
|
|
65370
64819
|
/**
|
|
65371
64820
|
* Scripts service.
|
|
65372
64821
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
65373
|
-
* @version
|
|
64822
|
+
* @version 235.0.0
|
|
65374
64823
|
*/
|
|
65375
64824
|
|
|
65376
64825
|
/**
|
|
@@ -65846,7 +65295,7 @@ class SearchApi {
|
|
|
65846
65295
|
/**
|
|
65847
65296
|
* Search service.
|
|
65848
65297
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
65849
|
-
* @version
|
|
65298
|
+
* @version 235.0.0
|
|
65850
65299
|
*/
|
|
65851
65300
|
|
|
65852
65301
|
/**
|
|
@@ -66243,36 +65692,6 @@ class SearchApi {
|
|
|
66243
65692
|
);
|
|
66244
65693
|
}
|
|
66245
65694
|
|
|
66246
|
-
/**
|
|
66247
|
-
* Search Documents
|
|
66248
|
-
*
|
|
66249
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
66250
|
-
* @param {Object} opts Optional parameters
|
|
66251
|
-
* @param {Object} opts.body
|
|
66252
|
-
* @deprecated
|
|
66253
|
-
*/
|
|
66254
|
-
postKnowledgeKnowledgebaseSearch(knowledgeBaseId, opts) {
|
|
66255
|
-
opts = opts || {};
|
|
66256
|
-
|
|
66257
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
66258
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
66259
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSearch';
|
|
66260
|
-
}
|
|
66261
|
-
|
|
66262
|
-
return this.apiClient.callApi(
|
|
66263
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/search',
|
|
66264
|
-
'POST',
|
|
66265
|
-
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
66266
|
-
{ },
|
|
66267
|
-
{ },
|
|
66268
|
-
{ },
|
|
66269
|
-
opts['body'],
|
|
66270
|
-
['PureCloud OAuth'],
|
|
66271
|
-
['application/json'],
|
|
66272
|
-
['application/json']
|
|
66273
|
-
);
|
|
66274
|
-
}
|
|
66275
|
-
|
|
66276
65695
|
/**
|
|
66277
65696
|
* Search locations
|
|
66278
65697
|
*
|
|
@@ -66564,7 +65983,7 @@ class SettingsApi {
|
|
|
66564
65983
|
/**
|
|
66565
65984
|
* Settings service.
|
|
66566
65985
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
66567
|
-
* @version
|
|
65986
|
+
* @version 235.0.0
|
|
66568
65987
|
*/
|
|
66569
65988
|
|
|
66570
65989
|
/**
|
|
@@ -66912,7 +66331,7 @@ class SocialMediaApi {
|
|
|
66912
66331
|
/**
|
|
66913
66332
|
* SocialMedia service.
|
|
66914
66333
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
66915
|
-
* @version
|
|
66334
|
+
* @version 235.0.0
|
|
66916
66335
|
*/
|
|
66917
66336
|
|
|
66918
66337
|
/**
|
|
@@ -67255,8 +66674,12 @@ class SocialMediaApi {
|
|
|
67255
66674
|
* Get a single escalation rule.
|
|
67256
66675
|
*
|
|
67257
66676
|
* @param {String} escalationRuleId escalationRuleId
|
|
66677
|
+
* @param {Object} opts Optional parameters
|
|
66678
|
+
* @param {Object} opts.expand which fields, if any, to expand
|
|
67258
66679
|
*/
|
|
67259
|
-
getSocialmediaEscalationrule(escalationRuleId) {
|
|
66680
|
+
getSocialmediaEscalationrule(escalationRuleId, opts) {
|
|
66681
|
+
opts = opts || {};
|
|
66682
|
+
|
|
67260
66683
|
// verify the required parameter 'escalationRuleId' is set
|
|
67261
66684
|
if (escalationRuleId === undefined || escalationRuleId === null || escalationRuleId === '') {
|
|
67262
66685
|
throw 'Missing the required parameter "escalationRuleId" when calling getSocialmediaEscalationrule';
|
|
@@ -67266,7 +66689,7 @@ class SocialMediaApi {
|
|
|
67266
66689
|
'/api/v2/socialmedia/escalationrules/{escalationRuleId}',
|
|
67267
66690
|
'GET',
|
|
67268
66691
|
{ 'escalationRuleId': escalationRuleId },
|
|
67269
|
-
{
|
|
66692
|
+
{ 'expand': opts['expand'] },
|
|
67270
66693
|
{ },
|
|
67271
66694
|
{ },
|
|
67272
66695
|
null,
|
|
@@ -68503,7 +67926,7 @@ class SpeechTextAnalyticsApi {
|
|
|
68503
67926
|
/**
|
|
68504
67927
|
* SpeechTextAnalytics service.
|
|
68505
67928
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
68506
|
-
* @version
|
|
67929
|
+
* @version 235.0.0
|
|
68507
67930
|
*/
|
|
68508
67931
|
|
|
68509
67932
|
/**
|
|
@@ -70150,7 +69573,7 @@ class StationsApi {
|
|
|
70150
69573
|
/**
|
|
70151
69574
|
* Stations service.
|
|
70152
69575
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
70153
|
-
* @version
|
|
69576
|
+
* @version 235.0.0
|
|
70154
69577
|
*/
|
|
70155
69578
|
|
|
70156
69579
|
/**
|
|
@@ -70252,7 +69675,7 @@ class SuggestApi {
|
|
|
70252
69675
|
/**
|
|
70253
69676
|
* Suggest service.
|
|
70254
69677
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
70255
|
-
* @version
|
|
69678
|
+
* @version 235.0.0
|
|
70256
69679
|
*/
|
|
70257
69680
|
|
|
70258
69681
|
/**
|
|
@@ -70391,7 +69814,7 @@ class TaskManagementApi {
|
|
|
70391
69814
|
/**
|
|
70392
69815
|
* TaskManagement service.
|
|
70393
69816
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
70394
|
-
* @version
|
|
69817
|
+
* @version 235.0.0
|
|
70395
69818
|
*/
|
|
70396
69819
|
|
|
70397
69820
|
/**
|
|
@@ -72553,7 +71976,7 @@ class TeamsApi {
|
|
|
72553
71976
|
/**
|
|
72554
71977
|
* Teams service.
|
|
72555
71978
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
72556
|
-
* @version
|
|
71979
|
+
* @version 235.0.0
|
|
72557
71980
|
*/
|
|
72558
71981
|
|
|
72559
71982
|
/**
|
|
@@ -72858,7 +72281,7 @@ class TelephonyApi {
|
|
|
72858
72281
|
/**
|
|
72859
72282
|
* Telephony service.
|
|
72860
72283
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
72861
|
-
* @version
|
|
72284
|
+
* @version 235.0.0
|
|
72862
72285
|
*/
|
|
72863
72286
|
|
|
72864
72287
|
/**
|
|
@@ -73144,7 +72567,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
73144
72567
|
/**
|
|
73145
72568
|
* TelephonyProvidersEdge service.
|
|
73146
72569
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
73147
|
-
* @version
|
|
72570
|
+
* @version 235.0.0
|
|
73148
72571
|
*/
|
|
73149
72572
|
|
|
73150
72573
|
/**
|
|
@@ -76637,7 +76060,7 @@ class TextbotsApi {
|
|
|
76637
76060
|
/**
|
|
76638
76061
|
* Textbots service.
|
|
76639
76062
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
76640
|
-
* @version
|
|
76063
|
+
* @version 235.0.0
|
|
76641
76064
|
*/
|
|
76642
76065
|
|
|
76643
76066
|
/**
|
|
@@ -76766,7 +76189,7 @@ class TokensApi {
|
|
|
76766
76189
|
/**
|
|
76767
76190
|
* Tokens service.
|
|
76768
76191
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
76769
|
-
* @version
|
|
76192
|
+
* @version 235.0.0
|
|
76770
76193
|
*/
|
|
76771
76194
|
|
|
76772
76195
|
/**
|
|
@@ -76920,7 +76343,7 @@ class UploadsApi {
|
|
|
76920
76343
|
/**
|
|
76921
76344
|
* Uploads service.
|
|
76922
76345
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
76923
|
-
* @version
|
|
76346
|
+
* @version 235.0.0
|
|
76924
76347
|
*/
|
|
76925
76348
|
|
|
76926
76349
|
/**
|
|
@@ -77211,7 +76634,7 @@ class UsageApi {
|
|
|
77211
76634
|
/**
|
|
77212
76635
|
* Usage service.
|
|
77213
76636
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
77214
|
-
* @version
|
|
76637
|
+
* @version 235.0.0
|
|
77215
76638
|
*/
|
|
77216
76639
|
|
|
77217
76640
|
/**
|
|
@@ -77546,7 +76969,7 @@ class UserRecordingsApi {
|
|
|
77546
76969
|
/**
|
|
77547
76970
|
* UserRecordings service.
|
|
77548
76971
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
77549
|
-
* @version
|
|
76972
|
+
* @version 235.0.0
|
|
77550
76973
|
*/
|
|
77551
76974
|
|
|
77552
76975
|
/**
|
|
@@ -77730,7 +77153,7 @@ class UsersApi {
|
|
|
77730
77153
|
/**
|
|
77731
77154
|
* Users service.
|
|
77732
77155
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
77733
|
-
* @version
|
|
77156
|
+
* @version 235.0.0
|
|
77734
77157
|
*/
|
|
77735
77158
|
|
|
77736
77159
|
/**
|
|
@@ -80739,7 +80162,7 @@ class UtilitiesApi {
|
|
|
80739
80162
|
/**
|
|
80740
80163
|
* Utilities service.
|
|
80741
80164
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
80742
|
-
* @version
|
|
80165
|
+
* @version 235.0.0
|
|
80743
80166
|
*/
|
|
80744
80167
|
|
|
80745
80168
|
/**
|
|
@@ -80850,7 +80273,7 @@ class VoicemailApi {
|
|
|
80850
80273
|
/**
|
|
80851
80274
|
* Voicemail service.
|
|
80852
80275
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
80853
|
-
* @version
|
|
80276
|
+
* @version 235.0.0
|
|
80854
80277
|
*/
|
|
80855
80278
|
|
|
80856
80279
|
/**
|
|
@@ -81572,7 +80995,7 @@ class WebChatApi {
|
|
|
81572
80995
|
/**
|
|
81573
80996
|
* WebChat service.
|
|
81574
80997
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
81575
|
-
* @version
|
|
80998
|
+
* @version 235.0.0
|
|
81576
80999
|
*/
|
|
81577
81000
|
|
|
81578
81001
|
/**
|
|
@@ -82135,7 +81558,7 @@ class WebDeploymentsApi {
|
|
|
82135
81558
|
/**
|
|
82136
81559
|
* WebDeployments service.
|
|
82137
81560
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
82138
|
-
* @version
|
|
81561
|
+
* @version 235.0.0
|
|
82139
81562
|
*/
|
|
82140
81563
|
|
|
82141
81564
|
/**
|
|
@@ -82573,7 +81996,7 @@ class WebDeploymentsApi {
|
|
|
82573
81996
|
}
|
|
82574
81997
|
|
|
82575
81998
|
/**
|
|
82576
|
-
* Exchange an oAuth code (obtained using the Authorization Code Flow) for a JWT that can be used by webdeployments.
|
|
81999
|
+
* Exchange an oAuth code (obtained using the Authorization Code Flow or Implicit flow) for a JWT that can be used by webdeployments.
|
|
82577
82000
|
*
|
|
82578
82001
|
* @param {Object} body webDeploymentsOAuthExchangeRequest
|
|
82579
82002
|
*/
|
|
@@ -82717,7 +82140,7 @@ class WebMessagingApi {
|
|
|
82717
82140
|
/**
|
|
82718
82141
|
* WebMessaging service.
|
|
82719
82142
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
82720
|
-
* @version
|
|
82143
|
+
* @version 235.0.0
|
|
82721
82144
|
*/
|
|
82722
82145
|
|
|
82723
82146
|
/**
|
|
@@ -82863,7 +82286,7 @@ class WidgetsApi {
|
|
|
82863
82286
|
/**
|
|
82864
82287
|
* Widgets service.
|
|
82865
82288
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
82866
|
-
* @version
|
|
82289
|
+
* @version 235.0.0
|
|
82867
82290
|
*/
|
|
82868
82291
|
|
|
82869
82292
|
/**
|
|
@@ -83014,7 +82437,7 @@ class WorkforceManagementApi {
|
|
|
83014
82437
|
/**
|
|
83015
82438
|
* WorkforceManagement service.
|
|
83016
82439
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
83017
|
-
* @version
|
|
82440
|
+
* @version 235.0.0
|
|
83018
82441
|
*/
|
|
83019
82442
|
|
|
83020
82443
|
/**
|
|
@@ -85414,6 +84837,7 @@ class WorkforceManagementApi {
|
|
|
85414
84837
|
* @param {String} forecastId The ID of the forecast
|
|
85415
84838
|
* @param {Object} opts Optional parameters
|
|
85416
84839
|
* @param {Array.<String>} opts.weekNumbers The week numbers to fetch (for multi-week forecasts) staffing requirements. Returns all week data if the list is not specified
|
|
84840
|
+
* @param {Array.<String>} opts.expand Expand to include minimum staffing values in (staffing requirement response or applied to base staffing requirement values)
|
|
85417
84841
|
*/
|
|
85418
84842
|
getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement(businessUnitId, weekDateId, forecastId, opts) {
|
|
85419
84843
|
opts = opts || {};
|
|
@@ -85435,7 +84859,7 @@ class WorkforceManagementApi {
|
|
|
85435
84859
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/staffingrequirement',
|
|
85436
84860
|
'GET',
|
|
85437
84861
|
{ 'businessUnitId': businessUnitId,'weekDateId': weekDateId,'forecastId': forecastId },
|
|
85438
|
-
{ 'weekNumbers': this.apiClient.buildCollectionParam(opts['weekNumbers'], 'multi') },
|
|
84862
|
+
{ 'weekNumbers': this.apiClient.buildCollectionParam(opts['weekNumbers'], 'multi'),'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
85439
84863
|
{ },
|
|
85440
84864
|
{ },
|
|
85441
84865
|
null,
|
|
@@ -91014,7 +90438,7 @@ class WorkforceManagementApi {
|
|
|
91014
90438
|
* </pre>
|
|
91015
90439
|
* </p>
|
|
91016
90440
|
* @module purecloud-platform-client-v2/index
|
|
91017
|
-
* @version
|
|
90441
|
+
* @version 235.0.0
|
|
91018
90442
|
*/
|
|
91019
90443
|
class platformClient {
|
|
91020
90444
|
constructor() {
|