purecloud-platform-client-v2 215.0.0 → 217.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 +1303 -493
- package/dist/web-amd/purecloud-platform-client-v2.js +1303 -493
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +435 -231
- package/dist/web-cjs/purecloud-platform-client-v2.js +441 -235
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +826 -472
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.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 -305
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +2 -3
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +112 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +387 -8
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -5
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +174 -2
- 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 +175 -7
- 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 +1 -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 +5 -3
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +21 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +13 -11
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/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 +9 -8
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +3 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +19 -7
- 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 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +4 -59
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +182 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +3 -3
- 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 -3
- 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 +58 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +70 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -687,7 +687,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
687
687
|
|
|
688
688
|
/**
|
|
689
689
|
* @module purecloud-platform-client-v2/ApiClient
|
|
690
|
-
* @version
|
|
690
|
+
* @version 217.0.0
|
|
691
691
|
*/
|
|
692
692
|
class ApiClient {
|
|
693
693
|
/**
|
|
@@ -2231,7 +2231,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2231
2231
|
/**
|
|
2232
2232
|
* AgentAssistants service.
|
|
2233
2233
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
2234
|
-
* @version
|
|
2234
|
+
* @version 217.0.0
|
|
2235
2235
|
*/
|
|
2236
2236
|
|
|
2237
2237
|
/**
|
|
@@ -2607,7 +2607,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2607
2607
|
/**
|
|
2608
2608
|
* AgentCopilot service.
|
|
2609
2609
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
2610
|
-
* @version
|
|
2610
|
+
* @version 217.0.0
|
|
2611
2611
|
*/
|
|
2612
2612
|
|
|
2613
2613
|
/**
|
|
@@ -2683,7 +2683,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2683
2683
|
/**
|
|
2684
2684
|
* AgentUI service.
|
|
2685
2685
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
2686
|
-
* @version
|
|
2686
|
+
* @version 217.0.0
|
|
2687
2687
|
*/
|
|
2688
2688
|
|
|
2689
2689
|
/**
|
|
@@ -2814,7 +2814,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2814
2814
|
/**
|
|
2815
2815
|
* Alerting service.
|
|
2816
2816
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
2817
|
-
* @version
|
|
2817
|
+
* @version 217.0.0
|
|
2818
2818
|
*/
|
|
2819
2819
|
|
|
2820
2820
|
/**
|
|
@@ -2874,58 +2874,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2874
2874
|
);
|
|
2875
2875
|
}
|
|
2876
2876
|
|
|
2877
|
-
/**
|
|
2878
|
-
* Delete an interaction stats alert
|
|
2879
|
-
* Apps should migrate to use DELETE /api/v2/alerting/alerts/{alertId}.
|
|
2880
|
-
* @param {String} alertId Alert ID
|
|
2881
|
-
* @deprecated
|
|
2882
|
-
*/
|
|
2883
|
-
deleteAlertingInteractionstatsAlert(alertId) {
|
|
2884
|
-
// verify the required parameter 'alertId' is set
|
|
2885
|
-
if (alertId === undefined || alertId === null) {
|
|
2886
|
-
throw 'Missing the required parameter "alertId" when calling deleteAlertingInteractionstatsAlert';
|
|
2887
|
-
}
|
|
2888
|
-
|
|
2889
|
-
return this.apiClient.callApi(
|
|
2890
|
-
'/api/v2/alerting/interactionstats/alerts/{alertId}',
|
|
2891
|
-
'DELETE',
|
|
2892
|
-
{ 'alertId': alertId },
|
|
2893
|
-
{ },
|
|
2894
|
-
{ },
|
|
2895
|
-
{ },
|
|
2896
|
-
null,
|
|
2897
|
-
['PureCloud OAuth'],
|
|
2898
|
-
['application/json'],
|
|
2899
|
-
['application/json']
|
|
2900
|
-
);
|
|
2901
|
-
}
|
|
2902
|
-
|
|
2903
|
-
/**
|
|
2904
|
-
* Delete an interaction stats rule
|
|
2905
|
-
* Apps should migrate to use DELETE /api/v2/alerting/rules/{ruleId}.
|
|
2906
|
-
* @param {String} ruleId Rule ID
|
|
2907
|
-
* @deprecated
|
|
2908
|
-
*/
|
|
2909
|
-
deleteAlertingInteractionstatsRule(ruleId) {
|
|
2910
|
-
// verify the required parameter 'ruleId' is set
|
|
2911
|
-
if (ruleId === undefined || ruleId === null) {
|
|
2912
|
-
throw 'Missing the required parameter "ruleId" when calling deleteAlertingInteractionstatsRule';
|
|
2913
|
-
}
|
|
2914
|
-
|
|
2915
|
-
return this.apiClient.callApi(
|
|
2916
|
-
'/api/v2/alerting/interactionstats/rules/{ruleId}',
|
|
2917
|
-
'DELETE',
|
|
2918
|
-
{ 'ruleId': ruleId },
|
|
2919
|
-
{ },
|
|
2920
|
-
{ },
|
|
2921
|
-
{ },
|
|
2922
|
-
null,
|
|
2923
|
-
['PureCloud OAuth'],
|
|
2924
|
-
['application/json'],
|
|
2925
|
-
['application/json']
|
|
2926
|
-
);
|
|
2927
|
-
}
|
|
2928
|
-
|
|
2929
2877
|
/**
|
|
2930
2878
|
* Delete a rule.
|
|
2931
2879
|
*
|
|
@@ -2976,158 +2924,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2976
2924
|
);
|
|
2977
2925
|
}
|
|
2978
2926
|
|
|
2979
|
-
/**
|
|
2980
|
-
* Gets active alert count for a user
|
|
2981
|
-
* Apps should migrate to use POST /api/v2/alerting/alerts/query with the queryType set to Count and alertStatus to Active in the request body.
|
|
2982
|
-
* @deprecated
|
|
2983
|
-
*/
|
|
2984
|
-
getAlertingAlertsActive() {
|
|
2985
|
-
|
|
2986
|
-
return this.apiClient.callApi(
|
|
2987
|
-
'/api/v2/alerting/alerts/active',
|
|
2988
|
-
'GET',
|
|
2989
|
-
{ },
|
|
2990
|
-
{ },
|
|
2991
|
-
{ },
|
|
2992
|
-
{ },
|
|
2993
|
-
null,
|
|
2994
|
-
['PureCloud OAuth'],
|
|
2995
|
-
['application/json'],
|
|
2996
|
-
['application/json']
|
|
2997
|
-
);
|
|
2998
|
-
}
|
|
2999
|
-
|
|
3000
|
-
/**
|
|
3001
|
-
* Get an interaction stats alert
|
|
3002
|
-
* Apps should migrate to use GET /api/v2/alerting/alerts/{alertId}.
|
|
3003
|
-
* @param {String} alertId Alert ID
|
|
3004
|
-
* @param {Object} opts Optional parameters
|
|
3005
|
-
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
3006
|
-
* @deprecated
|
|
3007
|
-
*/
|
|
3008
|
-
getAlertingInteractionstatsAlert(alertId, opts) {
|
|
3009
|
-
opts = opts || {};
|
|
3010
|
-
|
|
3011
|
-
// verify the required parameter 'alertId' is set
|
|
3012
|
-
if (alertId === undefined || alertId === null) {
|
|
3013
|
-
throw 'Missing the required parameter "alertId" when calling getAlertingInteractionstatsAlert';
|
|
3014
|
-
}
|
|
3015
|
-
|
|
3016
|
-
return this.apiClient.callApi(
|
|
3017
|
-
'/api/v2/alerting/interactionstats/alerts/{alertId}',
|
|
3018
|
-
'GET',
|
|
3019
|
-
{ 'alertId': alertId },
|
|
3020
|
-
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
3021
|
-
{ },
|
|
3022
|
-
{ },
|
|
3023
|
-
null,
|
|
3024
|
-
['PureCloud OAuth'],
|
|
3025
|
-
['application/json'],
|
|
3026
|
-
['application/json']
|
|
3027
|
-
);
|
|
3028
|
-
}
|
|
3029
|
-
|
|
3030
|
-
/**
|
|
3031
|
-
* Get interaction stats alert list
|
|
3032
|
-
* Apps should migrate to use POST /api/v2/alerting/alerts/query.
|
|
3033
|
-
* @param {Object} opts Optional parameters
|
|
3034
|
-
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
3035
|
-
* @deprecated
|
|
3036
|
-
*/
|
|
3037
|
-
getAlertingInteractionstatsAlerts(opts) {
|
|
3038
|
-
opts = opts || {};
|
|
3039
|
-
|
|
3040
|
-
|
|
3041
|
-
return this.apiClient.callApi(
|
|
3042
|
-
'/api/v2/alerting/interactionstats/alerts',
|
|
3043
|
-
'GET',
|
|
3044
|
-
{ },
|
|
3045
|
-
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
3046
|
-
{ },
|
|
3047
|
-
{ },
|
|
3048
|
-
null,
|
|
3049
|
-
['PureCloud OAuth'],
|
|
3050
|
-
['application/json'],
|
|
3051
|
-
['application/json']
|
|
3052
|
-
);
|
|
3053
|
-
}
|
|
3054
|
-
|
|
3055
|
-
/**
|
|
3056
|
-
* Gets user unread count of interaction stats alerts
|
|
3057
|
-
* Apps should migrate to use POST /api/v2/alerting/alerts/query with the queryType set to Count and viewStatus to Unread in the request body.
|
|
3058
|
-
* @deprecated
|
|
3059
|
-
*/
|
|
3060
|
-
getAlertingInteractionstatsAlertsUnread() {
|
|
3061
|
-
|
|
3062
|
-
return this.apiClient.callApi(
|
|
3063
|
-
'/api/v2/alerting/interactionstats/alerts/unread',
|
|
3064
|
-
'GET',
|
|
3065
|
-
{ },
|
|
3066
|
-
{ },
|
|
3067
|
-
{ },
|
|
3068
|
-
{ },
|
|
3069
|
-
null,
|
|
3070
|
-
['PureCloud OAuth'],
|
|
3071
|
-
['application/json'],
|
|
3072
|
-
['application/json']
|
|
3073
|
-
);
|
|
3074
|
-
}
|
|
3075
|
-
|
|
3076
|
-
/**
|
|
3077
|
-
* Get an interaction stats rule
|
|
3078
|
-
* Apps should migrate to use GET /api/v2/alerting/rules/{ruleId}.
|
|
3079
|
-
* @param {String} ruleId Rule ID
|
|
3080
|
-
* @param {Object} opts Optional parameters
|
|
3081
|
-
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
3082
|
-
* @deprecated
|
|
3083
|
-
*/
|
|
3084
|
-
getAlertingInteractionstatsRule(ruleId, opts) {
|
|
3085
|
-
opts = opts || {};
|
|
3086
|
-
|
|
3087
|
-
// verify the required parameter 'ruleId' is set
|
|
3088
|
-
if (ruleId === undefined || ruleId === null) {
|
|
3089
|
-
throw 'Missing the required parameter "ruleId" when calling getAlertingInteractionstatsRule';
|
|
3090
|
-
}
|
|
3091
|
-
|
|
3092
|
-
return this.apiClient.callApi(
|
|
3093
|
-
'/api/v2/alerting/interactionstats/rules/{ruleId}',
|
|
3094
|
-
'GET',
|
|
3095
|
-
{ 'ruleId': ruleId },
|
|
3096
|
-
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
3097
|
-
{ },
|
|
3098
|
-
{ },
|
|
3099
|
-
null,
|
|
3100
|
-
['PureCloud OAuth'],
|
|
3101
|
-
['application/json'],
|
|
3102
|
-
['application/json']
|
|
3103
|
-
);
|
|
3104
|
-
}
|
|
3105
|
-
|
|
3106
|
-
/**
|
|
3107
|
-
* Get an interaction stats rule list
|
|
3108
|
-
* Apps should migrate to use POST /api/v2/alerting/rules/query.
|
|
3109
|
-
* @param {Object} opts Optional parameters
|
|
3110
|
-
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
3111
|
-
* @deprecated
|
|
3112
|
-
*/
|
|
3113
|
-
getAlertingInteractionstatsRules(opts) {
|
|
3114
|
-
opts = opts || {};
|
|
3115
|
-
|
|
3116
|
-
|
|
3117
|
-
return this.apiClient.callApi(
|
|
3118
|
-
'/api/v2/alerting/interactionstats/rules',
|
|
3119
|
-
'GET',
|
|
3120
|
-
{ },
|
|
3121
|
-
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
3122
|
-
{ },
|
|
3123
|
-
{ },
|
|
3124
|
-
null,
|
|
3125
|
-
['PureCloud OAuth'],
|
|
3126
|
-
['application/json'],
|
|
3127
|
-
['application/json']
|
|
3128
|
-
);
|
|
3129
|
-
}
|
|
3130
|
-
|
|
3131
2927
|
/**
|
|
3132
2928
|
* Get a rule.
|
|
3133
2929
|
*
|
|
@@ -3280,36 +3076,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3280
3076
|
);
|
|
3281
3077
|
}
|
|
3282
3078
|
|
|
3283
|
-
/**
|
|
3284
|
-
* Create an interaction stats rule
|
|
3285
|
-
* Apps should migrate to use POST /api/v2/alerting/rules.
|
|
3286
|
-
* @param {Object} body AlertingRule
|
|
3287
|
-
* @param {Object} opts Optional parameters
|
|
3288
|
-
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
3289
|
-
* @deprecated
|
|
3290
|
-
*/
|
|
3291
|
-
postAlertingInteractionstatsRules(body, opts) {
|
|
3292
|
-
opts = opts || {};
|
|
3293
|
-
|
|
3294
|
-
// verify the required parameter 'body' is set
|
|
3295
|
-
if (body === undefined || body === null) {
|
|
3296
|
-
throw 'Missing the required parameter "body" when calling postAlertingInteractionstatsRules';
|
|
3297
|
-
}
|
|
3298
|
-
|
|
3299
|
-
return this.apiClient.callApi(
|
|
3300
|
-
'/api/v2/alerting/interactionstats/rules',
|
|
3301
|
-
'POST',
|
|
3302
|
-
{ },
|
|
3303
|
-
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
3304
|
-
{ },
|
|
3305
|
-
{ },
|
|
3306
|
-
body,
|
|
3307
|
-
['PureCloud OAuth'],
|
|
3308
|
-
['application/json'],
|
|
3309
|
-
['application/json']
|
|
3310
|
-
);
|
|
3311
|
-
}
|
|
3312
|
-
|
|
3313
3079
|
/**
|
|
3314
3080
|
* Create a Rule.
|
|
3315
3081
|
*
|
|
@@ -3413,76 +3179,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3413
3179
|
);
|
|
3414
3180
|
}
|
|
3415
3181
|
|
|
3416
|
-
/**
|
|
3417
|
-
* Update an interaction stats alert read status
|
|
3418
|
-
* Apps should migrate to use PUT /api/v2/alerting/alerts/{alertId}.
|
|
3419
|
-
* @param {String} alertId Alert ID
|
|
3420
|
-
* @param {Object} body InteractionStatsAlert
|
|
3421
|
-
* @param {Object} opts Optional parameters
|
|
3422
|
-
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
3423
|
-
* @deprecated
|
|
3424
|
-
*/
|
|
3425
|
-
putAlertingInteractionstatsAlert(alertId, body, opts) {
|
|
3426
|
-
opts = opts || {};
|
|
3427
|
-
|
|
3428
|
-
// verify the required parameter 'alertId' is set
|
|
3429
|
-
if (alertId === undefined || alertId === null) {
|
|
3430
|
-
throw 'Missing the required parameter "alertId" when calling putAlertingInteractionstatsAlert';
|
|
3431
|
-
}
|
|
3432
|
-
// verify the required parameter 'body' is set
|
|
3433
|
-
if (body === undefined || body === null) {
|
|
3434
|
-
throw 'Missing the required parameter "body" when calling putAlertingInteractionstatsAlert';
|
|
3435
|
-
}
|
|
3436
|
-
|
|
3437
|
-
return this.apiClient.callApi(
|
|
3438
|
-
'/api/v2/alerting/interactionstats/alerts/{alertId}',
|
|
3439
|
-
'PUT',
|
|
3440
|
-
{ 'alertId': alertId },
|
|
3441
|
-
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
3442
|
-
{ },
|
|
3443
|
-
{ },
|
|
3444
|
-
body,
|
|
3445
|
-
['PureCloud OAuth'],
|
|
3446
|
-
['application/json'],
|
|
3447
|
-
['application/json']
|
|
3448
|
-
);
|
|
3449
|
-
}
|
|
3450
|
-
|
|
3451
|
-
/**
|
|
3452
|
-
* Update an interaction stats rule
|
|
3453
|
-
* Apps should migrate to use PUT /api/v2/alerting/rules/{ruleId}.
|
|
3454
|
-
* @param {String} ruleId Rule ID
|
|
3455
|
-
* @param {Object} body AlertingRule
|
|
3456
|
-
* @param {Object} opts Optional parameters
|
|
3457
|
-
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
3458
|
-
* @deprecated
|
|
3459
|
-
*/
|
|
3460
|
-
putAlertingInteractionstatsRule(ruleId, body, opts) {
|
|
3461
|
-
opts = opts || {};
|
|
3462
|
-
|
|
3463
|
-
// verify the required parameter 'ruleId' is set
|
|
3464
|
-
if (ruleId === undefined || ruleId === null) {
|
|
3465
|
-
throw 'Missing the required parameter "ruleId" when calling putAlertingInteractionstatsRule';
|
|
3466
|
-
}
|
|
3467
|
-
// verify the required parameter 'body' is set
|
|
3468
|
-
if (body === undefined || body === null) {
|
|
3469
|
-
throw 'Missing the required parameter "body" when calling putAlertingInteractionstatsRule';
|
|
3470
|
-
}
|
|
3471
|
-
|
|
3472
|
-
return this.apiClient.callApi(
|
|
3473
|
-
'/api/v2/alerting/interactionstats/rules/{ruleId}',
|
|
3474
|
-
'PUT',
|
|
3475
|
-
{ 'ruleId': ruleId },
|
|
3476
|
-
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
3477
|
-
{ },
|
|
3478
|
-
{ },
|
|
3479
|
-
body,
|
|
3480
|
-
['PureCloud OAuth'],
|
|
3481
|
-
['application/json'],
|
|
3482
|
-
['application/json']
|
|
3483
|
-
);
|
|
3484
|
-
}
|
|
3485
|
-
|
|
3486
3182
|
/**
|
|
3487
3183
|
* Update a rule
|
|
3488
3184
|
*
|
|
@@ -3519,7 +3215,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3519
3215
|
/**
|
|
3520
3216
|
* Analytics service.
|
|
3521
3217
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
3522
|
-
* @version
|
|
3218
|
+
* @version 217.0.0
|
|
3523
3219
|
*/
|
|
3524
3220
|
|
|
3525
3221
|
/**
|
|
@@ -4396,7 +4092,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4396
4092
|
* @param {Number} opts.pageSize (default to 25)
|
|
4397
4093
|
* @param {Array.<String>} opts.id A list of user IDs to fetch by bulk
|
|
4398
4094
|
* @param {Object} opts.state Only list users of this state
|
|
4399
|
-
* @param {Boolean} opts.deletedOnly Only list deleted dashboards
|
|
4095
|
+
* @param {Boolean} opts.deletedOnly Only list users with deleted dashboards
|
|
4400
4096
|
*/
|
|
4401
4097
|
getAnalyticsReportingDashboardsUsers(opts) {
|
|
4402
4098
|
opts = opts || {};
|
|
@@ -5952,7 +5648,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5952
5648
|
* Query for summary aggregates
|
|
5953
5649
|
*
|
|
5954
5650
|
* @param {Object} body query
|
|
5955
|
-
* postAnalyticsSummariesAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5956
5651
|
*/
|
|
5957
5652
|
postAnalyticsSummariesAggregatesQuery(body) {
|
|
5958
5653
|
// verify the required parameter 'body' is set
|
|
@@ -6344,7 +6039,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6344
6039
|
/**
|
|
6345
6040
|
* Architect service.
|
|
6346
6041
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
6347
|
-
* @version
|
|
6042
|
+
* @version 217.0.0
|
|
6348
6043
|
*/
|
|
6349
6044
|
|
|
6350
6045
|
/**
|
|
@@ -7374,6 +7069,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7374
7069
|
);
|
|
7375
7070
|
}
|
|
7376
7071
|
|
|
7072
|
+
/**
|
|
7073
|
+
* Get an IVR IdentityResolutionConfig.
|
|
7074
|
+
*
|
|
7075
|
+
* @param {String} ivrId IVR id
|
|
7076
|
+
* getArchitectIvrIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7077
|
+
*/
|
|
7078
|
+
getArchitectIvrIdentityresolution(ivrId) {
|
|
7079
|
+
// verify the required parameter 'ivrId' is set
|
|
7080
|
+
if (ivrId === undefined || ivrId === null) {
|
|
7081
|
+
throw 'Missing the required parameter "ivrId" when calling getArchitectIvrIdentityresolution';
|
|
7082
|
+
}
|
|
7083
|
+
|
|
7084
|
+
return this.apiClient.callApi(
|
|
7085
|
+
'/api/v2/architect/ivrs/{ivrId}/identityresolution',
|
|
7086
|
+
'GET',
|
|
7087
|
+
{ 'ivrId': ivrId },
|
|
7088
|
+
{ },
|
|
7089
|
+
{ },
|
|
7090
|
+
{ },
|
|
7091
|
+
null,
|
|
7092
|
+
['PureCloud OAuth'],
|
|
7093
|
+
['application/json'],
|
|
7094
|
+
['application/json']
|
|
7095
|
+
);
|
|
7096
|
+
}
|
|
7097
|
+
|
|
7377
7098
|
/**
|
|
7378
7099
|
* Get IVR configs.
|
|
7379
7100
|
*
|
|
@@ -8648,6 +8369,35 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8648
8369
|
);
|
|
8649
8370
|
}
|
|
8650
8371
|
|
|
8372
|
+
/**
|
|
8373
|
+
* Fetch Architect Export Job Status
|
|
8374
|
+
*
|
|
8375
|
+
* @param {String} jobId Job ID
|
|
8376
|
+
* @param {Object} opts Optional parameters
|
|
8377
|
+
* @param {Array.<String>} opts.expand Which fields, if any, to expand.
|
|
8378
|
+
*/
|
|
8379
|
+
getFlowsExportJob(jobId, opts) {
|
|
8380
|
+
opts = opts || {};
|
|
8381
|
+
|
|
8382
|
+
// verify the required parameter 'jobId' is set
|
|
8383
|
+
if (jobId === undefined || jobId === null) {
|
|
8384
|
+
throw 'Missing the required parameter "jobId" when calling getFlowsExportJob';
|
|
8385
|
+
}
|
|
8386
|
+
|
|
8387
|
+
return this.apiClient.callApi(
|
|
8388
|
+
'/api/v2/flows/export/jobs/{jobId}',
|
|
8389
|
+
'GET',
|
|
8390
|
+
{ 'jobId': jobId },
|
|
8391
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
8392
|
+
{ },
|
|
8393
|
+
{ },
|
|
8394
|
+
null,
|
|
8395
|
+
['PureCloud OAuth'],
|
|
8396
|
+
['application/json'],
|
|
8397
|
+
['application/json']
|
|
8398
|
+
);
|
|
8399
|
+
}
|
|
8400
|
+
|
|
8651
8401
|
/**
|
|
8652
8402
|
* Start a process (job) to prepare a download of a singular flow execution data instance by Id
|
|
8653
8403
|
* Returns a JobResult object that contains an ID that can be used to check status and/or download links when the process (job) is complete.
|
|
@@ -9894,6 +9644,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9894
9644
|
);
|
|
9895
9645
|
}
|
|
9896
9646
|
|
|
9647
|
+
/**
|
|
9648
|
+
* Register Architect Export Job
|
|
9649
|
+
*
|
|
9650
|
+
* @param {Object} body
|
|
9651
|
+
*/
|
|
9652
|
+
postFlowsExportJobs(body) {
|
|
9653
|
+
// verify the required parameter 'body' is set
|
|
9654
|
+
if (body === undefined || body === null) {
|
|
9655
|
+
throw 'Missing the required parameter "body" when calling postFlowsExportJobs';
|
|
9656
|
+
}
|
|
9657
|
+
|
|
9658
|
+
return this.apiClient.callApi(
|
|
9659
|
+
'/api/v2/flows/export/jobs',
|
|
9660
|
+
'POST',
|
|
9661
|
+
{ },
|
|
9662
|
+
{ },
|
|
9663
|
+
{ },
|
|
9664
|
+
{ },
|
|
9665
|
+
body,
|
|
9666
|
+
['PureCloud OAuth'],
|
|
9667
|
+
['application/json'],
|
|
9668
|
+
['application/json']
|
|
9669
|
+
);
|
|
9670
|
+
}
|
|
9671
|
+
|
|
9897
9672
|
/**
|
|
9898
9673
|
* Start a process (job) that will prepare a list of execution data IDs for download.
|
|
9899
9674
|
* Returns a JobResult object that contains an ID that can be used to check status and/or download links when the process (job) is complete.
|
|
@@ -10081,6 +9856,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10081
9856
|
);
|
|
10082
9857
|
}
|
|
10083
9858
|
|
|
9859
|
+
/**
|
|
9860
|
+
* Update an IVR IdentityResolutionConfig.
|
|
9861
|
+
*
|
|
9862
|
+
* @param {String} ivrId IVR id
|
|
9863
|
+
* @param {Object} body
|
|
9864
|
+
* putArchitectIvrIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9865
|
+
*/
|
|
9866
|
+
putArchitectIvrIdentityresolution(ivrId, body) {
|
|
9867
|
+
// verify the required parameter 'ivrId' is set
|
|
9868
|
+
if (ivrId === undefined || ivrId === null) {
|
|
9869
|
+
throw 'Missing the required parameter "ivrId" when calling putArchitectIvrIdentityresolution';
|
|
9870
|
+
}
|
|
9871
|
+
// verify the required parameter 'body' is set
|
|
9872
|
+
if (body === undefined || body === null) {
|
|
9873
|
+
throw 'Missing the required parameter "body" when calling putArchitectIvrIdentityresolution';
|
|
9874
|
+
}
|
|
9875
|
+
|
|
9876
|
+
return this.apiClient.callApi(
|
|
9877
|
+
'/api/v2/architect/ivrs/{ivrId}/identityresolution',
|
|
9878
|
+
'PUT',
|
|
9879
|
+
{ 'ivrId': ivrId },
|
|
9880
|
+
{ },
|
|
9881
|
+
{ },
|
|
9882
|
+
{ },
|
|
9883
|
+
body,
|
|
9884
|
+
['PureCloud OAuth'],
|
|
9885
|
+
['application/json'],
|
|
9886
|
+
['application/json']
|
|
9887
|
+
);
|
|
9888
|
+
}
|
|
9889
|
+
|
|
10084
9890
|
/**
|
|
10085
9891
|
* Update specified user prompt
|
|
10086
9892
|
*
|
|
@@ -10466,7 +10272,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10466
10272
|
/**
|
|
10467
10273
|
* Audit service.
|
|
10468
10274
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
10469
|
-
* @version
|
|
10275
|
+
* @version 217.0.0
|
|
10470
10276
|
*/
|
|
10471
10277
|
|
|
10472
10278
|
/**
|
|
@@ -10667,7 +10473,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10667
10473
|
/**
|
|
10668
10474
|
* Authorization service.
|
|
10669
10475
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
10670
|
-
* @version
|
|
10476
|
+
* @version 217.0.0
|
|
10671
10477
|
*/
|
|
10672
10478
|
|
|
10673
10479
|
/**
|
|
@@ -10687,7 +10493,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10687
10493
|
*
|
|
10688
10494
|
* @param {String} divisionId Division ID
|
|
10689
10495
|
* @param {Object} opts Optional parameters
|
|
10690
|
-
* @param {Boolean} opts.force Force delete this division
|
|
10496
|
+
* @param {Boolean} opts.force DEPRECATED - Force delete this division. Warning: This option may cause any remaining objects in this division to be inaccessible. (default to false)
|
|
10691
10497
|
*/
|
|
10692
10498
|
deleteAuthorizationDivision(divisionId, opts) {
|
|
10693
10499
|
opts = opts || {};
|
|
@@ -10711,6 +10517,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10711
10517
|
);
|
|
10712
10518
|
}
|
|
10713
10519
|
|
|
10520
|
+
/**
|
|
10521
|
+
* Delete an access control policy
|
|
10522
|
+
*
|
|
10523
|
+
* @param {String} targetName The domain:entity:action target to which the policy is applied
|
|
10524
|
+
* @param {String} subjectId The ID of the subject to which the policy is applied
|
|
10525
|
+
* deleteAuthorizationPoliciesTargetSubjectSubjectId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10526
|
+
*/
|
|
10527
|
+
deleteAuthorizationPoliciesTargetSubjectSubjectId(targetName, subjectId) {
|
|
10528
|
+
// verify the required parameter 'targetName' is set
|
|
10529
|
+
if (targetName === undefined || targetName === null) {
|
|
10530
|
+
throw 'Missing the required parameter "targetName" when calling deleteAuthorizationPoliciesTargetSubjectSubjectId';
|
|
10531
|
+
}
|
|
10532
|
+
// verify the required parameter 'subjectId' is set
|
|
10533
|
+
if (subjectId === undefined || subjectId === null) {
|
|
10534
|
+
throw 'Missing the required parameter "subjectId" when calling deleteAuthorizationPoliciesTargetSubjectSubjectId';
|
|
10535
|
+
}
|
|
10536
|
+
|
|
10537
|
+
return this.apiClient.callApi(
|
|
10538
|
+
'/api/v2/authorization/policies/targets/{targetName}/subject/{subjectId}',
|
|
10539
|
+
'DELETE',
|
|
10540
|
+
{ 'targetName': targetName,'subjectId': subjectId },
|
|
10541
|
+
{ },
|
|
10542
|
+
{ },
|
|
10543
|
+
{ },
|
|
10544
|
+
null,
|
|
10545
|
+
['PureCloud OAuth'],
|
|
10546
|
+
['application/json'],
|
|
10547
|
+
['application/json']
|
|
10548
|
+
);
|
|
10549
|
+
}
|
|
10550
|
+
|
|
10714
10551
|
/**
|
|
10715
10552
|
* Delete an organization role.
|
|
10716
10553
|
*
|
|
@@ -11025,6 +10862,198 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11025
10862
|
);
|
|
11026
10863
|
}
|
|
11027
10864
|
|
|
10865
|
+
/**
|
|
10866
|
+
* Get a page of access policies for an organization
|
|
10867
|
+
*
|
|
10868
|
+
* @param {Object} opts Optional parameters
|
|
10869
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
10870
|
+
* @param {Number} opts.pageSize Number of entities to return. Maximum of 200. (default to 25)
|
|
10871
|
+
* getAuthorizationPolicies is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10872
|
+
*/
|
|
10873
|
+
getAuthorizationPolicies(opts) {
|
|
10874
|
+
opts = opts || {};
|
|
10875
|
+
|
|
10876
|
+
|
|
10877
|
+
return this.apiClient.callApi(
|
|
10878
|
+
'/api/v2/authorization/policies',
|
|
10879
|
+
'GET',
|
|
10880
|
+
{ },
|
|
10881
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
10882
|
+
{ },
|
|
10883
|
+
{ },
|
|
10884
|
+
null,
|
|
10885
|
+
['PureCloud OAuth'],
|
|
10886
|
+
['application/json'],
|
|
10887
|
+
['application/json']
|
|
10888
|
+
);
|
|
10889
|
+
}
|
|
10890
|
+
|
|
10891
|
+
/**
|
|
10892
|
+
* Get a page of access policies for a given subject
|
|
10893
|
+
*
|
|
10894
|
+
* @param {String} subjectId The ID of the subject to which policies are applied
|
|
10895
|
+
* @param {Object} opts Optional parameters
|
|
10896
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
10897
|
+
* @param {Number} opts.pageSize Number of entities to return. Maximum of 200. (default to 25)
|
|
10898
|
+
* getAuthorizationPoliciesSubjectSubjectId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10899
|
+
*/
|
|
10900
|
+
getAuthorizationPoliciesSubjectSubjectId(subjectId, opts) {
|
|
10901
|
+
opts = opts || {};
|
|
10902
|
+
|
|
10903
|
+
// verify the required parameter 'subjectId' is set
|
|
10904
|
+
if (subjectId === undefined || subjectId === null) {
|
|
10905
|
+
throw 'Missing the required parameter "subjectId" when calling getAuthorizationPoliciesSubjectSubjectId';
|
|
10906
|
+
}
|
|
10907
|
+
|
|
10908
|
+
return this.apiClient.callApi(
|
|
10909
|
+
'/api/v2/authorization/policies/subject/{subjectId}',
|
|
10910
|
+
'GET',
|
|
10911
|
+
{ 'subjectId': subjectId },
|
|
10912
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
10913
|
+
{ },
|
|
10914
|
+
{ },
|
|
10915
|
+
null,
|
|
10916
|
+
['PureCloud OAuth'],
|
|
10917
|
+
['application/json'],
|
|
10918
|
+
['application/json']
|
|
10919
|
+
);
|
|
10920
|
+
}
|
|
10921
|
+
|
|
10922
|
+
/**
|
|
10923
|
+
* Get a page of access policies for a given policy target
|
|
10924
|
+
*
|
|
10925
|
+
* @param {String} targetName The domain:entity:action resource target to which policies are applied
|
|
10926
|
+
* @param {Object} opts Optional parameters
|
|
10927
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
10928
|
+
* @param {Number} opts.pageSize Number of entities to return. Maximum of 200. (default to 25)
|
|
10929
|
+
* getAuthorizationPoliciesTarget is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10930
|
+
*/
|
|
10931
|
+
getAuthorizationPoliciesTarget(targetName, opts) {
|
|
10932
|
+
opts = opts || {};
|
|
10933
|
+
|
|
10934
|
+
// verify the required parameter 'targetName' is set
|
|
10935
|
+
if (targetName === undefined || targetName === null) {
|
|
10936
|
+
throw 'Missing the required parameter "targetName" when calling getAuthorizationPoliciesTarget';
|
|
10937
|
+
}
|
|
10938
|
+
|
|
10939
|
+
return this.apiClient.callApi(
|
|
10940
|
+
'/api/v2/authorization/policies/targets/{targetName}',
|
|
10941
|
+
'GET',
|
|
10942
|
+
{ 'targetName': targetName },
|
|
10943
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
10944
|
+
{ },
|
|
10945
|
+
{ },
|
|
10946
|
+
null,
|
|
10947
|
+
['PureCloud OAuth'],
|
|
10948
|
+
['application/json'],
|
|
10949
|
+
['application/json']
|
|
10950
|
+
);
|
|
10951
|
+
}
|
|
10952
|
+
|
|
10953
|
+
/**
|
|
10954
|
+
* Get an access control policy for a specified resource target and subject
|
|
10955
|
+
*
|
|
10956
|
+
* @param {String} targetName The domain:entity:action resource target to which the policy is applied
|
|
10957
|
+
* @param {String} subjectId The ID of the subject to which the policy is applied
|
|
10958
|
+
* getAuthorizationPoliciesTargetSubjectSubjectId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10959
|
+
*/
|
|
10960
|
+
getAuthorizationPoliciesTargetSubjectSubjectId(targetName, subjectId) {
|
|
10961
|
+
// verify the required parameter 'targetName' is set
|
|
10962
|
+
if (targetName === undefined || targetName === null) {
|
|
10963
|
+
throw 'Missing the required parameter "targetName" when calling getAuthorizationPoliciesTargetSubjectSubjectId';
|
|
10964
|
+
}
|
|
10965
|
+
// verify the required parameter 'subjectId' is set
|
|
10966
|
+
if (subjectId === undefined || subjectId === null) {
|
|
10967
|
+
throw 'Missing the required parameter "subjectId" when calling getAuthorizationPoliciesTargetSubjectSubjectId';
|
|
10968
|
+
}
|
|
10969
|
+
|
|
10970
|
+
return this.apiClient.callApi(
|
|
10971
|
+
'/api/v2/authorization/policies/targets/{targetName}/subject/{subjectId}',
|
|
10972
|
+
'GET',
|
|
10973
|
+
{ 'targetName': targetName,'subjectId': subjectId },
|
|
10974
|
+
{ },
|
|
10975
|
+
{ },
|
|
10976
|
+
{ },
|
|
10977
|
+
null,
|
|
10978
|
+
['PureCloud OAuth'],
|
|
10979
|
+
['application/json'],
|
|
10980
|
+
['application/json']
|
|
10981
|
+
);
|
|
10982
|
+
}
|
|
10983
|
+
|
|
10984
|
+
/**
|
|
10985
|
+
* Get a map of policy targets to valid attributes for those targets
|
|
10986
|
+
*
|
|
10987
|
+
* getAuthorizationPoliciesTargets is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10988
|
+
*/
|
|
10989
|
+
getAuthorizationPoliciesTargets() {
|
|
10990
|
+
|
|
10991
|
+
return this.apiClient.callApi(
|
|
10992
|
+
'/api/v2/authorization/policies/targets',
|
|
10993
|
+
'GET',
|
|
10994
|
+
{ },
|
|
10995
|
+
{ },
|
|
10996
|
+
{ },
|
|
10997
|
+
{ },
|
|
10998
|
+
null,
|
|
10999
|
+
['PureCloud OAuth'],
|
|
11000
|
+
['application/json'],
|
|
11001
|
+
['application/json']
|
|
11002
|
+
);
|
|
11003
|
+
}
|
|
11004
|
+
|
|
11005
|
+
/**
|
|
11006
|
+
* Get an access control policy with the specified policy ID
|
|
11007
|
+
*
|
|
11008
|
+
* @param {String} policyId The ID of the policy to retrieve
|
|
11009
|
+
* getAuthorizationPolicy is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11010
|
+
*/
|
|
11011
|
+
getAuthorizationPolicy(policyId) {
|
|
11012
|
+
// verify the required parameter 'policyId' is set
|
|
11013
|
+
if (policyId === undefined || policyId === null) {
|
|
11014
|
+
throw 'Missing the required parameter "policyId" when calling getAuthorizationPolicy';
|
|
11015
|
+
}
|
|
11016
|
+
|
|
11017
|
+
return this.apiClient.callApi(
|
|
11018
|
+
'/api/v2/authorization/policies/{policyId}',
|
|
11019
|
+
'GET',
|
|
11020
|
+
{ 'policyId': policyId },
|
|
11021
|
+
{ },
|
|
11022
|
+
{ },
|
|
11023
|
+
{ },
|
|
11024
|
+
null,
|
|
11025
|
+
['PureCloud OAuth'],
|
|
11026
|
+
['application/json'],
|
|
11027
|
+
['application/json']
|
|
11028
|
+
);
|
|
11029
|
+
}
|
|
11030
|
+
|
|
11031
|
+
/**
|
|
11032
|
+
* Get the list of attributes used to evaluate an access control policy with the specified policy ID
|
|
11033
|
+
*
|
|
11034
|
+
* @param {String} policyId The ID of the policy to retrieve attributes
|
|
11035
|
+
* getAuthorizationPolicyAttributes is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11036
|
+
*/
|
|
11037
|
+
getAuthorizationPolicyAttributes(policyId) {
|
|
11038
|
+
// verify the required parameter 'policyId' is set
|
|
11039
|
+
if (policyId === undefined || policyId === null) {
|
|
11040
|
+
throw 'Missing the required parameter "policyId" when calling getAuthorizationPolicyAttributes';
|
|
11041
|
+
}
|
|
11042
|
+
|
|
11043
|
+
return this.apiClient.callApi(
|
|
11044
|
+
'/api/v2/authorization/policies/{policyId}/attributes',
|
|
11045
|
+
'GET',
|
|
11046
|
+
{ 'policyId': policyId },
|
|
11047
|
+
{ },
|
|
11048
|
+
{ },
|
|
11049
|
+
{ },
|
|
11050
|
+
null,
|
|
11051
|
+
['PureCloud OAuth'],
|
|
11052
|
+
['application/json'],
|
|
11053
|
+
['application/json']
|
|
11054
|
+
);
|
|
11055
|
+
}
|
|
11056
|
+
|
|
11028
11057
|
/**
|
|
11029
11058
|
* Get the list of enabled products
|
|
11030
11059
|
* Gets the list of enabled products. Some example product names are: collaborateFree, collaboratePro, communicate, and engage.
|
|
@@ -11439,16 +11468,17 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11439
11468
|
* Recreate a previously deleted division.
|
|
11440
11469
|
*
|
|
11441
11470
|
* @param {String} divisionId Division ID
|
|
11442
|
-
* @param {Object}
|
|
11443
|
-
* @param {Object} opts.body Recreated division data
|
|
11471
|
+
* @param {Object} body Recreated division data
|
|
11444
11472
|
*/
|
|
11445
|
-
postAuthorizationDivisionRestore(divisionId,
|
|
11446
|
-
opts = opts || {};
|
|
11447
|
-
|
|
11473
|
+
postAuthorizationDivisionRestore(divisionId, body) {
|
|
11448
11474
|
// verify the required parameter 'divisionId' is set
|
|
11449
11475
|
if (divisionId === undefined || divisionId === null) {
|
|
11450
11476
|
throw 'Missing the required parameter "divisionId" when calling postAuthorizationDivisionRestore';
|
|
11451
11477
|
}
|
|
11478
|
+
// verify the required parameter 'body' is set
|
|
11479
|
+
if (body === undefined || body === null) {
|
|
11480
|
+
throw 'Missing the required parameter "body" when calling postAuthorizationDivisionRestore';
|
|
11481
|
+
}
|
|
11452
11482
|
|
|
11453
11483
|
return this.apiClient.callApi(
|
|
11454
11484
|
'/api/v2/authorization/divisions/{divisionId}/restore',
|
|
@@ -11457,7 +11487,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11457
11487
|
{ },
|
|
11458
11488
|
{ },
|
|
11459
11489
|
{ },
|
|
11460
|
-
|
|
11490
|
+
body,
|
|
11461
11491
|
['PureCloud OAuth'],
|
|
11462
11492
|
['application/json'],
|
|
11463
11493
|
['application/json']
|
|
@@ -11489,6 +11519,99 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11489
11519
|
);
|
|
11490
11520
|
}
|
|
11491
11521
|
|
|
11522
|
+
/**
|
|
11523
|
+
* Add an access control policy for a specified resource target and subject
|
|
11524
|
+
*
|
|
11525
|
+
* @param {String} targetName The domain:entity:action target to which the policy will be applied
|
|
11526
|
+
* @param {Object} body Access control policy
|
|
11527
|
+
* postAuthorizationPoliciesTarget is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11528
|
+
*/
|
|
11529
|
+
postAuthorizationPoliciesTarget(targetName, body) {
|
|
11530
|
+
// verify the required parameter 'targetName' is set
|
|
11531
|
+
if (targetName === undefined || targetName === null) {
|
|
11532
|
+
throw 'Missing the required parameter "targetName" when calling postAuthorizationPoliciesTarget';
|
|
11533
|
+
}
|
|
11534
|
+
// verify the required parameter 'body' is set
|
|
11535
|
+
if (body === undefined || body === null) {
|
|
11536
|
+
throw 'Missing the required parameter "body" when calling postAuthorizationPoliciesTarget';
|
|
11537
|
+
}
|
|
11538
|
+
|
|
11539
|
+
return this.apiClient.callApi(
|
|
11540
|
+
'/api/v2/authorization/policies/targets/{targetName}',
|
|
11541
|
+
'POST',
|
|
11542
|
+
{ 'targetName': targetName },
|
|
11543
|
+
{ },
|
|
11544
|
+
{ },
|
|
11545
|
+
{ },
|
|
11546
|
+
body,
|
|
11547
|
+
['PureCloud OAuth'],
|
|
11548
|
+
['application/json'],
|
|
11549
|
+
['application/json']
|
|
11550
|
+
);
|
|
11551
|
+
}
|
|
11552
|
+
|
|
11553
|
+
/**
|
|
11554
|
+
* Validate the conditions and attributes of an access control policy for a specified resource target
|
|
11555
|
+
*
|
|
11556
|
+
* @param {String} targetName The domain:entity:action target to which the policy will be applied
|
|
11557
|
+
* @param {Object} body Access control policy
|
|
11558
|
+
* postAuthorizationPoliciesTargetValidate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11559
|
+
*/
|
|
11560
|
+
postAuthorizationPoliciesTargetValidate(targetName, body) {
|
|
11561
|
+
// verify the required parameter 'targetName' is set
|
|
11562
|
+
if (targetName === undefined || targetName === null) {
|
|
11563
|
+
throw 'Missing the required parameter "targetName" when calling postAuthorizationPoliciesTargetValidate';
|
|
11564
|
+
}
|
|
11565
|
+
// verify the required parameter 'body' is set
|
|
11566
|
+
if (body === undefined || body === null) {
|
|
11567
|
+
throw 'Missing the required parameter "body" when calling postAuthorizationPoliciesTargetValidate';
|
|
11568
|
+
}
|
|
11569
|
+
|
|
11570
|
+
return this.apiClient.callApi(
|
|
11571
|
+
'/api/v2/authorization/policies/targets/{targetName}/validate',
|
|
11572
|
+
'POST',
|
|
11573
|
+
{ 'targetName': targetName },
|
|
11574
|
+
{ },
|
|
11575
|
+
{ },
|
|
11576
|
+
{ },
|
|
11577
|
+
body,
|
|
11578
|
+
['PureCloud OAuth'],
|
|
11579
|
+
['application/json'],
|
|
11580
|
+
['application/json']
|
|
11581
|
+
);
|
|
11582
|
+
}
|
|
11583
|
+
|
|
11584
|
+
/**
|
|
11585
|
+
* Simulate a request and evaluate the specified policy ID against the provided values
|
|
11586
|
+
*
|
|
11587
|
+
* @param {String} policyId The ID of the policy to test the simulated data against
|
|
11588
|
+
* @param {Object} body A map of attribute names to type and simulated data value
|
|
11589
|
+
* postAuthorizationPolicySimulate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11590
|
+
*/
|
|
11591
|
+
postAuthorizationPolicySimulate(policyId, body) {
|
|
11592
|
+
// verify the required parameter 'policyId' is set
|
|
11593
|
+
if (policyId === undefined || policyId === null) {
|
|
11594
|
+
throw 'Missing the required parameter "policyId" when calling postAuthorizationPolicySimulate';
|
|
11595
|
+
}
|
|
11596
|
+
// verify the required parameter 'body' is set
|
|
11597
|
+
if (body === undefined || body === null) {
|
|
11598
|
+
throw 'Missing the required parameter "body" when calling postAuthorizationPolicySimulate';
|
|
11599
|
+
}
|
|
11600
|
+
|
|
11601
|
+
return this.apiClient.callApi(
|
|
11602
|
+
'/api/v2/authorization/policies/{policyId}/simulate',
|
|
11603
|
+
'POST',
|
|
11604
|
+
{ 'policyId': policyId },
|
|
11605
|
+
{ },
|
|
11606
|
+
{ },
|
|
11607
|
+
{ },
|
|
11608
|
+
body,
|
|
11609
|
+
['PureCloud OAuth'],
|
|
11610
|
+
['application/json'],
|
|
11611
|
+
['application/json']
|
|
11612
|
+
);
|
|
11613
|
+
}
|
|
11614
|
+
|
|
11492
11615
|
/**
|
|
11493
11616
|
* Bulk-grant subjects and divisions with an organization role.
|
|
11494
11617
|
*
|
|
@@ -11774,6 +11897,68 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11774
11897
|
);
|
|
11775
11898
|
}
|
|
11776
11899
|
|
|
11900
|
+
/**
|
|
11901
|
+
* Add an access control policy for a specified resource target and subject, overwriting any existing policy
|
|
11902
|
+
*
|
|
11903
|
+
* @param {String} targetName The domain:entity:action target to which the policy will be applied
|
|
11904
|
+
* @param {Object} body Access control policy
|
|
11905
|
+
* putAuthorizationPoliciesTarget is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11906
|
+
*/
|
|
11907
|
+
putAuthorizationPoliciesTarget(targetName, body) {
|
|
11908
|
+
// verify the required parameter 'targetName' is set
|
|
11909
|
+
if (targetName === undefined || targetName === null) {
|
|
11910
|
+
throw 'Missing the required parameter "targetName" when calling putAuthorizationPoliciesTarget';
|
|
11911
|
+
}
|
|
11912
|
+
// verify the required parameter 'body' is set
|
|
11913
|
+
if (body === undefined || body === null) {
|
|
11914
|
+
throw 'Missing the required parameter "body" when calling putAuthorizationPoliciesTarget';
|
|
11915
|
+
}
|
|
11916
|
+
|
|
11917
|
+
return this.apiClient.callApi(
|
|
11918
|
+
'/api/v2/authorization/policies/targets/{targetName}',
|
|
11919
|
+
'PUT',
|
|
11920
|
+
{ 'targetName': targetName },
|
|
11921
|
+
{ },
|
|
11922
|
+
{ },
|
|
11923
|
+
{ },
|
|
11924
|
+
body,
|
|
11925
|
+
['PureCloud OAuth'],
|
|
11926
|
+
['application/json'],
|
|
11927
|
+
['application/json']
|
|
11928
|
+
);
|
|
11929
|
+
}
|
|
11930
|
+
|
|
11931
|
+
/**
|
|
11932
|
+
* Update an access control policy with a given ID
|
|
11933
|
+
*
|
|
11934
|
+
* @param {String} policyId The ID of the policy to update
|
|
11935
|
+
* @param {Object} body Access control policy
|
|
11936
|
+
* putAuthorizationPolicy is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11937
|
+
*/
|
|
11938
|
+
putAuthorizationPolicy(policyId, body) {
|
|
11939
|
+
// verify the required parameter 'policyId' is set
|
|
11940
|
+
if (policyId === undefined || policyId === null) {
|
|
11941
|
+
throw 'Missing the required parameter "policyId" when calling putAuthorizationPolicy';
|
|
11942
|
+
}
|
|
11943
|
+
// verify the required parameter 'body' is set
|
|
11944
|
+
if (body === undefined || body === null) {
|
|
11945
|
+
throw 'Missing the required parameter "body" when calling putAuthorizationPolicy';
|
|
11946
|
+
}
|
|
11947
|
+
|
|
11948
|
+
return this.apiClient.callApi(
|
|
11949
|
+
'/api/v2/authorization/policies/{policyId}',
|
|
11950
|
+
'PUT',
|
|
11951
|
+
{ 'policyId': policyId },
|
|
11952
|
+
{ },
|
|
11953
|
+
{ },
|
|
11954
|
+
{ },
|
|
11955
|
+
body,
|
|
11956
|
+
['PureCloud OAuth'],
|
|
11957
|
+
['application/json'],
|
|
11958
|
+
['application/json']
|
|
11959
|
+
);
|
|
11960
|
+
}
|
|
11961
|
+
|
|
11777
11962
|
/**
|
|
11778
11963
|
* Update an organization role.
|
|
11779
11964
|
* Update
|
|
@@ -11950,7 +12135,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11950
12135
|
/**
|
|
11951
12136
|
* Billing service.
|
|
11952
12137
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
11953
|
-
* @version
|
|
12138
|
+
* @version 217.0.0
|
|
11954
12139
|
*/
|
|
11955
12140
|
|
|
11956
12141
|
/**
|
|
@@ -12030,7 +12215,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12030
12215
|
/**
|
|
12031
12216
|
* CarrierServices service.
|
|
12032
12217
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
12033
|
-
* @version
|
|
12218
|
+
* @version 217.0.0
|
|
12034
12219
|
*/
|
|
12035
12220
|
|
|
12036
12221
|
/**
|
|
@@ -12100,7 +12285,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12100
12285
|
/**
|
|
12101
12286
|
* Chat service.
|
|
12102
12287
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
12103
|
-
* @version
|
|
12288
|
+
* @version 217.0.0
|
|
12104
12289
|
*/
|
|
12105
12290
|
|
|
12106
12291
|
/**
|
|
@@ -12574,7 +12759,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12574
12759
|
* Get a user's chat settings
|
|
12575
12760
|
*
|
|
12576
12761
|
* @param {String} userId User ID
|
|
12577
|
-
* getChatsUserSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12578
12762
|
*/
|
|
12579
12763
|
getChatsUserSettings(userId) {
|
|
12580
12764
|
// verify the required parameter 'userId' is set
|
|
@@ -12599,7 +12783,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12599
12783
|
/**
|
|
12600
12784
|
* Get a user's chat settings
|
|
12601
12785
|
*
|
|
12602
|
-
* getChatsUsersMeSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12603
12786
|
*/
|
|
12604
12787
|
getChatsUsersMeSettings() {
|
|
12605
12788
|
|
|
@@ -12747,7 +12930,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12747
12930
|
*
|
|
12748
12931
|
* @param {String} userId User ID
|
|
12749
12932
|
* @param {Object} body
|
|
12750
|
-
* patchChatsUserSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12751
12933
|
*/
|
|
12752
12934
|
patchChatsUserSettings(userId, body) {
|
|
12753
12935
|
// verify the required parameter 'userId' is set
|
|
@@ -12777,7 +12959,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12777
12959
|
* Update a user's chat settings
|
|
12778
12960
|
*
|
|
12779
12961
|
* @param {Object} body
|
|
12780
|
-
* patchChatsUsersMeSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12781
12962
|
*/
|
|
12782
12963
|
patchChatsUsersMeSettings(body) {
|
|
12783
12964
|
// verify the required parameter 'body' is set
|
|
@@ -13036,7 +13217,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13036
13217
|
/**
|
|
13037
13218
|
* Coaching service.
|
|
13038
13219
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
13039
|
-
* @version
|
|
13220
|
+
* @version 217.0.0
|
|
13040
13221
|
*/
|
|
13041
13222
|
|
|
13042
13223
|
/**
|
|
@@ -13613,7 +13794,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13613
13794
|
/**
|
|
13614
13795
|
* ContentManagement service.
|
|
13615
13796
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
13616
|
-
* @version
|
|
13797
|
+
* @version 217.0.0
|
|
13617
13798
|
*/
|
|
13618
13799
|
|
|
13619
13800
|
/**
|
|
@@ -14694,7 +14875,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14694
14875
|
/**
|
|
14695
14876
|
* Conversations service.
|
|
14696
14877
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
14697
|
-
* @version
|
|
14878
|
+
* @version 217.0.0
|
|
14698
14879
|
*/
|
|
14699
14880
|
|
|
14700
14881
|
/**
|
|
@@ -16871,6 +17052,84 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16871
17052
|
);
|
|
16872
17053
|
}
|
|
16873
17054
|
|
|
17055
|
+
/**
|
|
17056
|
+
* Get Facebook messaging integration identity resolution settings
|
|
17057
|
+
*
|
|
17058
|
+
* @param {String} integrationId Integration ID
|
|
17059
|
+
* getConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17060
|
+
*/
|
|
17061
|
+
getConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId(integrationId) {
|
|
17062
|
+
// verify the required parameter 'integrationId' is set
|
|
17063
|
+
if (integrationId === undefined || integrationId === null) {
|
|
17064
|
+
throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId';
|
|
17065
|
+
}
|
|
17066
|
+
|
|
17067
|
+
return this.apiClient.callApi(
|
|
17068
|
+
'/api/v2/conversations/messaging/identityresolution/integrations/facebook/{integrationId}',
|
|
17069
|
+
'GET',
|
|
17070
|
+
{ 'integrationId': integrationId },
|
|
17071
|
+
{ },
|
|
17072
|
+
{ },
|
|
17073
|
+
{ },
|
|
17074
|
+
null,
|
|
17075
|
+
['PureCloud OAuth'],
|
|
17076
|
+
['application/json'],
|
|
17077
|
+
['application/json']
|
|
17078
|
+
);
|
|
17079
|
+
}
|
|
17080
|
+
|
|
17081
|
+
/**
|
|
17082
|
+
* Get an open messaging integration Identity Resolution settings
|
|
17083
|
+
*
|
|
17084
|
+
* @param {String} integrationId Integration ID
|
|
17085
|
+
* getConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17086
|
+
*/
|
|
17087
|
+
getConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId(integrationId) {
|
|
17088
|
+
// verify the required parameter 'integrationId' is set
|
|
17089
|
+
if (integrationId === undefined || integrationId === null) {
|
|
17090
|
+
throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId';
|
|
17091
|
+
}
|
|
17092
|
+
|
|
17093
|
+
return this.apiClient.callApi(
|
|
17094
|
+
'/api/v2/conversations/messaging/identityresolution/integrations/open/{integrationId}',
|
|
17095
|
+
'GET',
|
|
17096
|
+
{ 'integrationId': integrationId },
|
|
17097
|
+
{ },
|
|
17098
|
+
{ },
|
|
17099
|
+
{ },
|
|
17100
|
+
null,
|
|
17101
|
+
['PureCloud OAuth'],
|
|
17102
|
+
['application/json'],
|
|
17103
|
+
['application/json']
|
|
17104
|
+
);
|
|
17105
|
+
}
|
|
17106
|
+
|
|
17107
|
+
/**
|
|
17108
|
+
* Get a whatsApp integration Identity Resolution settings
|
|
17109
|
+
*
|
|
17110
|
+
* @param {String} integrationId Integration ID
|
|
17111
|
+
* getConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17112
|
+
*/
|
|
17113
|
+
getConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId(integrationId) {
|
|
17114
|
+
// verify the required parameter 'integrationId' is set
|
|
17115
|
+
if (integrationId === undefined || integrationId === null) {
|
|
17116
|
+
throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId';
|
|
17117
|
+
}
|
|
17118
|
+
|
|
17119
|
+
return this.apiClient.callApi(
|
|
17120
|
+
'/api/v2/conversations/messaging/identityresolution/integrations/whatsapp/{integrationId}',
|
|
17121
|
+
'GET',
|
|
17122
|
+
{ 'integrationId': integrationId },
|
|
17123
|
+
{ },
|
|
17124
|
+
{ },
|
|
17125
|
+
{ },
|
|
17126
|
+
null,
|
|
17127
|
+
['PureCloud OAuth'],
|
|
17128
|
+
['application/json'],
|
|
17129
|
+
['application/json']
|
|
17130
|
+
);
|
|
17131
|
+
}
|
|
17132
|
+
|
|
16874
17133
|
/**
|
|
16875
17134
|
* Get a list of Integrations
|
|
16876
17135
|
*
|
|
@@ -21536,9 +21795,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21536
21795
|
|
|
21537
21796
|
/**
|
|
21538
21797
|
* Update a conversation by setting its recording state
|
|
21539
|
-
*
|
|
21798
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
21540
21799
|
* @param {String} conversationId conversationId
|
|
21541
21800
|
* @param {Object} body SetRecordingState
|
|
21801
|
+
* @deprecated
|
|
21542
21802
|
*/
|
|
21543
21803
|
putConversationsCobrowsesessionRecordingstate(conversationId, body) {
|
|
21544
21804
|
// verify the required parameter 'conversationId' is set
|
|
@@ -21684,6 +21944,99 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21684
21944
|
);
|
|
21685
21945
|
}
|
|
21686
21946
|
|
|
21947
|
+
/**
|
|
21948
|
+
* Create an identity resolution settings for a Facebook messaging integration
|
|
21949
|
+
*
|
|
21950
|
+
* @param {String} integrationId Integration ID
|
|
21951
|
+
* @param {Object} body IdentityResolutionConfig
|
|
21952
|
+
* putConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21953
|
+
*/
|
|
21954
|
+
putConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId(integrationId, body) {
|
|
21955
|
+
// verify the required parameter 'integrationId' is set
|
|
21956
|
+
if (integrationId === undefined || integrationId === null) {
|
|
21957
|
+
throw 'Missing the required parameter "integrationId" when calling putConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId';
|
|
21958
|
+
}
|
|
21959
|
+
// verify the required parameter 'body' is set
|
|
21960
|
+
if (body === undefined || body === null) {
|
|
21961
|
+
throw 'Missing the required parameter "body" when calling putConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId';
|
|
21962
|
+
}
|
|
21963
|
+
|
|
21964
|
+
return this.apiClient.callApi(
|
|
21965
|
+
'/api/v2/conversations/messaging/identityresolution/integrations/facebook/{integrationId}',
|
|
21966
|
+
'PUT',
|
|
21967
|
+
{ 'integrationId': integrationId },
|
|
21968
|
+
{ },
|
|
21969
|
+
{ },
|
|
21970
|
+
{ },
|
|
21971
|
+
body,
|
|
21972
|
+
['PureCloud OAuth'],
|
|
21973
|
+
['application/json'],
|
|
21974
|
+
['application/json']
|
|
21975
|
+
);
|
|
21976
|
+
}
|
|
21977
|
+
|
|
21978
|
+
/**
|
|
21979
|
+
* Update an open messaging integration Identity Resolution settings
|
|
21980
|
+
*
|
|
21981
|
+
* @param {String} integrationId Integration ID
|
|
21982
|
+
* @param {Object} body
|
|
21983
|
+
* putConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21984
|
+
*/
|
|
21985
|
+
putConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId(integrationId, body) {
|
|
21986
|
+
// verify the required parameter 'integrationId' is set
|
|
21987
|
+
if (integrationId === undefined || integrationId === null) {
|
|
21988
|
+
throw 'Missing the required parameter "integrationId" when calling putConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId';
|
|
21989
|
+
}
|
|
21990
|
+
// verify the required parameter 'body' is set
|
|
21991
|
+
if (body === undefined || body === null) {
|
|
21992
|
+
throw 'Missing the required parameter "body" when calling putConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId';
|
|
21993
|
+
}
|
|
21994
|
+
|
|
21995
|
+
return this.apiClient.callApi(
|
|
21996
|
+
'/api/v2/conversations/messaging/identityresolution/integrations/open/{integrationId}',
|
|
21997
|
+
'PUT',
|
|
21998
|
+
{ 'integrationId': integrationId },
|
|
21999
|
+
{ },
|
|
22000
|
+
{ },
|
|
22001
|
+
{ },
|
|
22002
|
+
body,
|
|
22003
|
+
['PureCloud OAuth'],
|
|
22004
|
+
['application/json'],
|
|
22005
|
+
['application/json']
|
|
22006
|
+
);
|
|
22007
|
+
}
|
|
22008
|
+
|
|
22009
|
+
/**
|
|
22010
|
+
* Update a whatsApp integration Identity Resolution settings
|
|
22011
|
+
*
|
|
22012
|
+
* @param {String} integrationId Integration ID
|
|
22013
|
+
* @param {Object} body
|
|
22014
|
+
* putConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
22015
|
+
*/
|
|
22016
|
+
putConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId(integrationId, body) {
|
|
22017
|
+
// verify the required parameter 'integrationId' is set
|
|
22018
|
+
if (integrationId === undefined || integrationId === null) {
|
|
22019
|
+
throw 'Missing the required parameter "integrationId" when calling putConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId';
|
|
22020
|
+
}
|
|
22021
|
+
// verify the required parameter 'body' is set
|
|
22022
|
+
if (body === undefined || body === null) {
|
|
22023
|
+
throw 'Missing the required parameter "body" when calling putConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId';
|
|
22024
|
+
}
|
|
22025
|
+
|
|
22026
|
+
return this.apiClient.callApi(
|
|
22027
|
+
'/api/v2/conversations/messaging/identityresolution/integrations/whatsapp/{integrationId}',
|
|
22028
|
+
'PUT',
|
|
22029
|
+
{ 'integrationId': integrationId },
|
|
22030
|
+
{ },
|
|
22031
|
+
{ },
|
|
22032
|
+
{ },
|
|
22033
|
+
body,
|
|
22034
|
+
['PureCloud OAuth'],
|
|
22035
|
+
['application/json'],
|
|
22036
|
+
['application/json']
|
|
22037
|
+
);
|
|
22038
|
+
}
|
|
22039
|
+
|
|
21687
22040
|
/**
|
|
21688
22041
|
* Set the organization's default setting that may be applied to to integrations without settings
|
|
21689
22042
|
* When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be assigned to it.
|
|
@@ -21856,7 +22209,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21856
22209
|
/**
|
|
21857
22210
|
* DataExtensions service.
|
|
21858
22211
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
21859
|
-
* @version
|
|
22212
|
+
* @version 217.0.0
|
|
21860
22213
|
*/
|
|
21861
22214
|
|
|
21862
22215
|
/**
|
|
@@ -21942,7 +22295,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21942
22295
|
/**
|
|
21943
22296
|
* DataPrivacy service.
|
|
21944
22297
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
21945
|
-
* @version
|
|
22298
|
+
* @version 217.0.0
|
|
21946
22299
|
*/
|
|
21947
22300
|
|
|
21948
22301
|
/**
|
|
@@ -22112,7 +22465,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22112
22465
|
/**
|
|
22113
22466
|
* Downloads service.
|
|
22114
22467
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
22115
|
-
* @version
|
|
22468
|
+
* @version 217.0.0
|
|
22116
22469
|
*/
|
|
22117
22470
|
|
|
22118
22471
|
/**
|
|
@@ -22164,7 +22517,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22164
22517
|
/**
|
|
22165
22518
|
* Emails service.
|
|
22166
22519
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
22167
|
-
* @version
|
|
22520
|
+
* @version 217.0.0
|
|
22168
22521
|
*/
|
|
22169
22522
|
|
|
22170
22523
|
/**
|
|
@@ -22229,7 +22582,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22229
22582
|
/**
|
|
22230
22583
|
* EmployeeEngagement service.
|
|
22231
22584
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
22232
|
-
* @version
|
|
22585
|
+
* @version 217.0.0
|
|
22233
22586
|
*/
|
|
22234
22587
|
|
|
22235
22588
|
/**
|
|
@@ -22380,7 +22733,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22380
22733
|
/**
|
|
22381
22734
|
* Events service.
|
|
22382
22735
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
22383
|
-
* @version
|
|
22736
|
+
* @version 217.0.0
|
|
22384
22737
|
*/
|
|
22385
22738
|
|
|
22386
22739
|
/**
|
|
@@ -22476,7 +22829,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22476
22829
|
/**
|
|
22477
22830
|
* ExternalContacts service.
|
|
22478
22831
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
22479
|
-
* @version
|
|
22832
|
+
* @version 217.0.0
|
|
22480
22833
|
*/
|
|
22481
22834
|
|
|
22482
22835
|
/**
|
|
@@ -22940,6 +23293,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22940
23293
|
* @param {String} opts.q User supplied search keywords (no special syntax is currently supported)
|
|
22941
23294
|
* @param {String} opts.sortOrder The External Contact field to sort by. Any of: [firstName, lastName, middleName, title]. Direction: [asc, desc]. e.g. firstName:asc, title:desc
|
|
22942
23295
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
23296
|
+
* @param {Array.<String>} opts.divisionIds which divisions to search, up to 50
|
|
22943
23297
|
*/
|
|
22944
23298
|
getExternalcontactsContacts(opts) {
|
|
22945
23299
|
opts = opts || {};
|
|
@@ -22949,7 +23303,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22949
23303
|
'/api/v2/externalcontacts/contacts',
|
|
22950
23304
|
'GET',
|
|
22951
23305
|
{ },
|
|
22952
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'q': opts['q'],'sortOrder': opts['sortOrder'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
23306
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'q': opts['q'],'sortOrder': opts['sortOrder'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'divisionIds': this.apiClient.buildCollectionParam(opts['divisionIds'], 'multi') },
|
|
22953
23307
|
{ },
|
|
22954
23308
|
{ },
|
|
22955
23309
|
null,
|
|
@@ -23216,8 +23570,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23216
23570
|
* Get job based on id
|
|
23217
23571
|
*
|
|
23218
23572
|
* @param {String} jobId Job id
|
|
23573
|
+
* @param {Object} opts Optional parameters
|
|
23574
|
+
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
23219
23575
|
*/
|
|
23220
|
-
getExternalcontactsImportJob(jobId) {
|
|
23576
|
+
getExternalcontactsImportJob(jobId, opts) {
|
|
23577
|
+
opts = opts || {};
|
|
23578
|
+
|
|
23221
23579
|
// verify the required parameter 'jobId' is set
|
|
23222
23580
|
if (jobId === undefined || jobId === null) {
|
|
23223
23581
|
throw 'Missing the required parameter "jobId" when calling getExternalcontactsImportJob';
|
|
@@ -23227,7 +23585,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23227
23585
|
'/api/v2/externalcontacts/import/jobs/{jobId}',
|
|
23228
23586
|
'GET',
|
|
23229
23587
|
{ 'jobId': jobId },
|
|
23230
|
-
{
|
|
23588
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
23231
23589
|
{ },
|
|
23232
23590
|
{ },
|
|
23233
23591
|
null,
|
|
@@ -23241,6 +23599,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23241
23599
|
* List jobs for organization
|
|
23242
23600
|
*
|
|
23243
23601
|
* @param {Object} opts Optional parameters
|
|
23602
|
+
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
23244
23603
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
23245
23604
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 100. (default to 25)
|
|
23246
23605
|
* @param {Object} opts.sortOrder Direction of sorting. (default to Ascending)
|
|
@@ -23254,7 +23613,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23254
23613
|
'/api/v2/externalcontacts/import/jobs',
|
|
23255
23614
|
'GET',
|
|
23256
23615
|
{ },
|
|
23257
|
-
{ 'after': opts['after'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'jobStatus': opts['jobStatus'] },
|
|
23616
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'after': opts['after'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'jobStatus': opts['jobStatus'] },
|
|
23258
23617
|
{ },
|
|
23259
23618
|
{ },
|
|
23260
23619
|
null,
|
|
@@ -23488,6 +23847,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23488
23847
|
* @param {String} opts.sortOrder The Organization field to sort by. Any of: [companyType, industry, name]. Direction: [asc, desc]. e.g. companyType:asc, industry:desc
|
|
23489
23848
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
23490
23849
|
* @param {Boolean} opts.includeTrustors (true or false) whether or not to include trustor information embedded in the externalOrganization
|
|
23850
|
+
* @param {Array.<String>} opts.divisionIds which divisions to search, up to 50
|
|
23491
23851
|
*/
|
|
23492
23852
|
getExternalcontactsOrganizations(opts) {
|
|
23493
23853
|
opts = opts || {};
|
|
@@ -23497,7 +23857,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23497
23857
|
'/api/v2/externalcontacts/organizations',
|
|
23498
23858
|
'GET',
|
|
23499
23859
|
{ },
|
|
23500
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'q': opts['q'],'trustorId': this.apiClient.buildCollectionParam(opts['trustorId'], 'multi'),'sortOrder': opts['sortOrder'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'includeTrustors': opts['includeTrustors'] },
|
|
23860
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'q': opts['q'],'trustorId': this.apiClient.buildCollectionParam(opts['trustorId'], 'multi'),'sortOrder': opts['sortOrder'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'includeTrustors': opts['includeTrustors'],'divisionIds': this.apiClient.buildCollectionParam(opts['divisionIds'], 'multi') },
|
|
23501
23861
|
{ },
|
|
23502
23862
|
{ },
|
|
23503
23863
|
null,
|
|
@@ -23642,6 +24002,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23642
24002
|
* @param {String} lookupVal User supplied value to lookup contacts/externalOrganizations (supports email addresses, e164 phone numbers, Twitter screen names)
|
|
23643
24003
|
* @param {Object} opts Optional parameters
|
|
23644
24004
|
* @param {Array.<String>} opts.expand which field, if any, to expand
|
|
24005
|
+
* @param {String} opts.divisionId Specifies which division to lookup contacts/externalOrganizations in, for the given lookup value (default to *)
|
|
23645
24006
|
*/
|
|
23646
24007
|
getExternalcontactsReversewhitepageslookup(lookupVal, opts) {
|
|
23647
24008
|
opts = opts || {};
|
|
@@ -23655,7 +24016,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23655
24016
|
'/api/v2/externalcontacts/reversewhitepageslookup',
|
|
23656
24017
|
'GET',
|
|
23657
24018
|
{ },
|
|
23658
|
-
{ 'lookupVal': lookupVal,'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
24019
|
+
{ 'lookupVal': lookupVal,'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'divisionId': opts['divisionId'] },
|
|
23659
24020
|
{ },
|
|
23660
24021
|
{ },
|
|
23661
24022
|
null,
|
|
@@ -23671,6 +24032,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23671
24032
|
* @param {Object} opts Optional parameters
|
|
23672
24033
|
* @param {Number} opts.limit The number of contacts per page; must be between 10 and 200, default is 100
|
|
23673
24034
|
* @param {String} opts.cursor Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
|
|
24035
|
+
* @param {String} opts.divisionId The division to scan over (default to *)
|
|
23674
24036
|
*/
|
|
23675
24037
|
getExternalcontactsScanContacts(opts) {
|
|
23676
24038
|
opts = opts || {};
|
|
@@ -23680,6 +24042,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23680
24042
|
'/api/v2/externalcontacts/scan/contacts',
|
|
23681
24043
|
'GET',
|
|
23682
24044
|
{ },
|
|
24045
|
+
{ 'limit': opts['limit'],'cursor': opts['cursor'],'divisionId': opts['divisionId'] },
|
|
24046
|
+
{ },
|
|
24047
|
+
{ },
|
|
24048
|
+
null,
|
|
24049
|
+
['PureCloud OAuth'],
|
|
24050
|
+
['application/json'],
|
|
24051
|
+
['application/json']
|
|
24052
|
+
);
|
|
24053
|
+
}
|
|
24054
|
+
|
|
24055
|
+
/**
|
|
24056
|
+
* Scan for external contacts using paging
|
|
24057
|
+
*
|
|
24058
|
+
* @param {Object} opts Optional parameters
|
|
24059
|
+
* @param {Number} opts.limit The number of contacts per page; must be between 10 and 200, default is 100
|
|
24060
|
+
* @param {String} opts.cursor Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
|
|
24061
|
+
* getExternalcontactsScanContactsDivisionviewsAll is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24062
|
+
*/
|
|
24063
|
+
getExternalcontactsScanContactsDivisionviewsAll(opts) {
|
|
24064
|
+
opts = opts || {};
|
|
24065
|
+
|
|
24066
|
+
|
|
24067
|
+
return this.apiClient.callApi(
|
|
24068
|
+
'/api/v2/externalcontacts/scan/contacts/divisionviews/all',
|
|
24069
|
+
'GET',
|
|
24070
|
+
{ },
|
|
23683
24071
|
{ 'limit': opts['limit'],'cursor': opts['cursor'] },
|
|
23684
24072
|
{ },
|
|
23685
24073
|
{ },
|
|
@@ -23696,6 +24084,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23696
24084
|
* @param {Object} opts Optional parameters
|
|
23697
24085
|
* @param {Number} opts.limit The number of notes per page; must be between 10 and 200, default is 100
|
|
23698
24086
|
* @param {String} opts.cursor Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
|
|
24087
|
+
* @param {String} opts.divisionId The division to scan over (default to *)
|
|
23699
24088
|
*/
|
|
23700
24089
|
getExternalcontactsScanNotes(opts) {
|
|
23701
24090
|
opts = opts || {};
|
|
@@ -23705,6 +24094,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23705
24094
|
'/api/v2/externalcontacts/scan/notes',
|
|
23706
24095
|
'GET',
|
|
23707
24096
|
{ },
|
|
24097
|
+
{ 'limit': opts['limit'],'cursor': opts['cursor'],'divisionId': opts['divisionId'] },
|
|
24098
|
+
{ },
|
|
24099
|
+
{ },
|
|
24100
|
+
null,
|
|
24101
|
+
['PureCloud OAuth'],
|
|
24102
|
+
['application/json'],
|
|
24103
|
+
['application/json']
|
|
24104
|
+
);
|
|
24105
|
+
}
|
|
24106
|
+
|
|
24107
|
+
/**
|
|
24108
|
+
* Scan for notes using paging
|
|
24109
|
+
*
|
|
24110
|
+
* @param {Object} opts Optional parameters
|
|
24111
|
+
* @param {Number} opts.limit The number of notes per page; must be between 10 and 200, default is 100
|
|
24112
|
+
* @param {String} opts.cursor Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
|
|
24113
|
+
* getExternalcontactsScanNotesDivisionviewsAll is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24114
|
+
*/
|
|
24115
|
+
getExternalcontactsScanNotesDivisionviewsAll(opts) {
|
|
24116
|
+
opts = opts || {};
|
|
24117
|
+
|
|
24118
|
+
|
|
24119
|
+
return this.apiClient.callApi(
|
|
24120
|
+
'/api/v2/externalcontacts/scan/notes/divisionviews/all',
|
|
24121
|
+
'GET',
|
|
24122
|
+
{ },
|
|
23708
24123
|
{ 'limit': opts['limit'],'cursor': opts['cursor'] },
|
|
23709
24124
|
{ },
|
|
23710
24125
|
{ },
|
|
@@ -23721,6 +24136,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23721
24136
|
* @param {Object} opts Optional parameters
|
|
23722
24137
|
* @param {Number} opts.limit The number of organizations per page; must be between 10 and 200, default is 100
|
|
23723
24138
|
* @param {String} opts.cursor Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
|
|
24139
|
+
* @param {String} opts.divisionId The division to scan over (default to *)
|
|
23724
24140
|
*/
|
|
23725
24141
|
getExternalcontactsScanOrganizations(opts) {
|
|
23726
24142
|
opts = opts || {};
|
|
@@ -23730,6 +24146,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23730
24146
|
'/api/v2/externalcontacts/scan/organizations',
|
|
23731
24147
|
'GET',
|
|
23732
24148
|
{ },
|
|
24149
|
+
{ 'limit': opts['limit'],'cursor': opts['cursor'],'divisionId': opts['divisionId'] },
|
|
24150
|
+
{ },
|
|
24151
|
+
{ },
|
|
24152
|
+
null,
|
|
24153
|
+
['PureCloud OAuth'],
|
|
24154
|
+
['application/json'],
|
|
24155
|
+
['application/json']
|
|
24156
|
+
);
|
|
24157
|
+
}
|
|
24158
|
+
|
|
24159
|
+
/**
|
|
24160
|
+
* Scan for external organizations using paging
|
|
24161
|
+
*
|
|
24162
|
+
* @param {Object} opts Optional parameters
|
|
24163
|
+
* @param {Number} opts.limit The number of organizations per page; must be between 10 and 200, default is 100
|
|
24164
|
+
* @param {String} opts.cursor Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
|
|
24165
|
+
* getExternalcontactsScanOrganizationsDivisionviewsAll is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24166
|
+
*/
|
|
24167
|
+
getExternalcontactsScanOrganizationsDivisionviewsAll(opts) {
|
|
24168
|
+
opts = opts || {};
|
|
24169
|
+
|
|
24170
|
+
|
|
24171
|
+
return this.apiClient.callApi(
|
|
24172
|
+
'/api/v2/externalcontacts/scan/organizations/divisionviews/all',
|
|
24173
|
+
'GET',
|
|
24174
|
+
{ },
|
|
23733
24175
|
{ 'limit': opts['limit'],'cursor': opts['cursor'] },
|
|
23734
24176
|
{ },
|
|
23735
24177
|
{ },
|
|
@@ -23746,6 +24188,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23746
24188
|
* @param {Object} opts Optional parameters
|
|
23747
24189
|
* @param {Number} opts.limit The number of relationships per page; must be between 10 and 200, default is 100
|
|
23748
24190
|
* @param {String} opts.cursor Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
|
|
24191
|
+
* @param {String} opts.divisionId The division to scan over (default to *)
|
|
23749
24192
|
*/
|
|
23750
24193
|
getExternalcontactsScanRelationships(opts) {
|
|
23751
24194
|
opts = opts || {};
|
|
@@ -23755,6 +24198,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23755
24198
|
'/api/v2/externalcontacts/scan/relationships',
|
|
23756
24199
|
'GET',
|
|
23757
24200
|
{ },
|
|
24201
|
+
{ 'limit': opts['limit'],'cursor': opts['cursor'],'divisionId': opts['divisionId'] },
|
|
24202
|
+
{ },
|
|
24203
|
+
{ },
|
|
24204
|
+
null,
|
|
24205
|
+
['PureCloud OAuth'],
|
|
24206
|
+
['application/json'],
|
|
24207
|
+
['application/json']
|
|
24208
|
+
);
|
|
24209
|
+
}
|
|
24210
|
+
|
|
24211
|
+
/**
|
|
24212
|
+
* Scan for relationships
|
|
24213
|
+
*
|
|
24214
|
+
* @param {Object} opts Optional parameters
|
|
24215
|
+
* @param {Number} opts.limit The number of relationships per page; must be between 10 and 200, default is 100
|
|
24216
|
+
* @param {String} opts.cursor Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
|
|
24217
|
+
* getExternalcontactsScanRelationshipsDivisionviewsAll is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24218
|
+
*/
|
|
24219
|
+
getExternalcontactsScanRelationshipsDivisionviewsAll(opts) {
|
|
24220
|
+
opts = opts || {};
|
|
24221
|
+
|
|
24222
|
+
|
|
24223
|
+
return this.apiClient.callApi(
|
|
24224
|
+
'/api/v2/externalcontacts/scan/relationships/divisionviews/all',
|
|
24225
|
+
'GET',
|
|
24226
|
+
{ },
|
|
23758
24227
|
{ 'limit': opts['limit'],'cursor': opts['cursor'] },
|
|
23759
24228
|
{ },
|
|
23760
24229
|
{ },
|
|
@@ -23845,6 +24314,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23845
24314
|
);
|
|
23846
24315
|
}
|
|
23847
24316
|
|
|
24317
|
+
/**
|
|
24318
|
+
* Bulk fetch contacts across divisions
|
|
24319
|
+
*
|
|
24320
|
+
* @param {Object} body Contact ids
|
|
24321
|
+
* postExternalcontactsBulkContactsDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24322
|
+
*/
|
|
24323
|
+
postExternalcontactsBulkContactsDivisionviews(body) {
|
|
24324
|
+
// verify the required parameter 'body' is set
|
|
24325
|
+
if (body === undefined || body === null) {
|
|
24326
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsBulkContactsDivisionviews';
|
|
24327
|
+
}
|
|
24328
|
+
|
|
24329
|
+
return this.apiClient.callApi(
|
|
24330
|
+
'/api/v2/externalcontacts/bulk/contacts/divisionviews',
|
|
24331
|
+
'POST',
|
|
24332
|
+
{ },
|
|
24333
|
+
{ },
|
|
24334
|
+
{ },
|
|
24335
|
+
{ },
|
|
24336
|
+
body,
|
|
24337
|
+
['PureCloud OAuth'],
|
|
24338
|
+
['application/json'],
|
|
24339
|
+
['application/json']
|
|
24340
|
+
);
|
|
24341
|
+
}
|
|
24342
|
+
|
|
23848
24343
|
/**
|
|
23849
24344
|
* Bulk remove contacts
|
|
23850
24345
|
*
|
|
@@ -24070,6 +24565,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24070
24565
|
);
|
|
24071
24566
|
}
|
|
24072
24567
|
|
|
24568
|
+
/**
|
|
24569
|
+
* Bulk fetch organizations across divisions
|
|
24570
|
+
*
|
|
24571
|
+
* @param {Object} body Organizations ids
|
|
24572
|
+
* postExternalcontactsBulkOrganizationsDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24573
|
+
*/
|
|
24574
|
+
postExternalcontactsBulkOrganizationsDivisionviews(body) {
|
|
24575
|
+
// verify the required parameter 'body' is set
|
|
24576
|
+
if (body === undefined || body === null) {
|
|
24577
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsBulkOrganizationsDivisionviews';
|
|
24578
|
+
}
|
|
24579
|
+
|
|
24580
|
+
return this.apiClient.callApi(
|
|
24581
|
+
'/api/v2/externalcontacts/bulk/organizations/divisionviews',
|
|
24582
|
+
'POST',
|
|
24583
|
+
{ },
|
|
24584
|
+
{ },
|
|
24585
|
+
{ },
|
|
24586
|
+
{ },
|
|
24587
|
+
body,
|
|
24588
|
+
['PureCloud OAuth'],
|
|
24589
|
+
['application/json'],
|
|
24590
|
+
['application/json']
|
|
24591
|
+
);
|
|
24592
|
+
}
|
|
24593
|
+
|
|
24073
24594
|
/**
|
|
24074
24595
|
* Bulk remove organizations
|
|
24075
24596
|
*
|
|
@@ -25041,7 +25562,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25041
25562
|
/**
|
|
25042
25563
|
* Fax service.
|
|
25043
25564
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
25044
|
-
* @version
|
|
25565
|
+
* @version 217.0.0
|
|
25045
25566
|
*/
|
|
25046
25567
|
|
|
25047
25568
|
/**
|
|
@@ -25256,7 +25777,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25256
25777
|
/**
|
|
25257
25778
|
* Flows service.
|
|
25258
25779
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
25259
|
-
* @version
|
|
25780
|
+
* @version 217.0.0
|
|
25260
25781
|
*/
|
|
25261
25782
|
|
|
25262
25783
|
/**
|
|
@@ -25439,7 +25960,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25439
25960
|
/**
|
|
25440
25961
|
* Gamification service.
|
|
25441
25962
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
25442
|
-
* @version
|
|
25963
|
+
* @version 217.0.0
|
|
25443
25964
|
*/
|
|
25444
25965
|
|
|
25445
25966
|
/**
|
|
@@ -27581,7 +28102,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27581
28102
|
/**
|
|
27582
28103
|
* GeneralDataProtectionRegulation service.
|
|
27583
28104
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
27584
|
-
* @version
|
|
28105
|
+
* @version 217.0.0
|
|
27585
28106
|
*/
|
|
27586
28107
|
|
|
27587
28108
|
/**
|
|
@@ -27711,7 +28232,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27711
28232
|
/**
|
|
27712
28233
|
* Geolocation service.
|
|
27713
28234
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
27714
|
-
* @version
|
|
28235
|
+
* @version 217.0.0
|
|
27715
28236
|
*/
|
|
27716
28237
|
|
|
27717
28238
|
/**
|
|
@@ -27842,7 +28363,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27842
28363
|
/**
|
|
27843
28364
|
* Greetings service.
|
|
27844
28365
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
27845
|
-
* @version
|
|
28366
|
+
* @version 217.0.0
|
|
27846
28367
|
*/
|
|
27847
28368
|
|
|
27848
28369
|
/**
|
|
@@ -28297,7 +28818,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28297
28818
|
/**
|
|
28298
28819
|
* Groups service.
|
|
28299
28820
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
28300
|
-
* @version
|
|
28821
|
+
* @version 217.0.0
|
|
28301
28822
|
*/
|
|
28302
28823
|
|
|
28303
28824
|
/**
|
|
@@ -28816,7 +29337,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28816
29337
|
/**
|
|
28817
29338
|
* IdentityProvider service.
|
|
28818
29339
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
28819
|
-
* @version
|
|
29340
|
+
* @version 217.0.0
|
|
28820
29341
|
*/
|
|
28821
29342
|
|
|
28822
29343
|
/**
|
|
@@ -29677,7 +30198,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29677
30198
|
/**
|
|
29678
30199
|
* InfrastructureAsCode service.
|
|
29679
30200
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
29680
|
-
* @version
|
|
30201
|
+
* @version 217.0.0
|
|
29681
30202
|
*/
|
|
29682
30203
|
|
|
29683
30204
|
/**
|
|
@@ -29844,7 +30365,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29844
30365
|
/**
|
|
29845
30366
|
* Integrations service.
|
|
29846
30367
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
29847
|
-
* @version
|
|
30368
|
+
* @version 217.0.0
|
|
29848
30369
|
*/
|
|
29849
30370
|
|
|
29850
30371
|
/**
|
|
@@ -30053,6 +30574,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30053
30574
|
* @param {String} actionId actionId
|
|
30054
30575
|
* @param {Object} opts Optional parameters
|
|
30055
30576
|
* @param {Object} opts.expand Indicates a field in the response which should be expanded.
|
|
30577
|
+
* @param {Object} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
|
|
30056
30578
|
* @param {Object} opts.includeConfig Return config in response. (default to false)
|
|
30057
30579
|
*/
|
|
30058
30580
|
getIntegrationsAction(actionId, opts) {
|
|
@@ -30067,7 +30589,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30067
30589
|
'/api/v2/integrations/actions/{actionId}',
|
|
30068
30590
|
'GET',
|
|
30069
30591
|
{ 'actionId': actionId },
|
|
30070
|
-
{ 'expand': opts['expand'],'includeConfig': opts['includeConfig'] },
|
|
30592
|
+
{ 'expand': opts['expand'],'flatten': opts['flatten'],'includeConfig': opts['includeConfig'] },
|
|
30071
30593
|
{ },
|
|
30072
30594
|
{ },
|
|
30073
30595
|
null,
|
|
@@ -30083,6 +30605,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30083
30605
|
* @param {String} actionId actionId
|
|
30084
30606
|
* @param {Object} opts Optional parameters
|
|
30085
30607
|
* @param {Object} opts.expand Indicates a field in the response which should be expanded.
|
|
30608
|
+
* @param {Object} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
|
|
30086
30609
|
* @param {Object} opts.includeConfig Return config in response. (default to false)
|
|
30087
30610
|
*/
|
|
30088
30611
|
getIntegrationsActionDraft(actionId, opts) {
|
|
@@ -30097,7 +30620,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30097
30620
|
'/api/v2/integrations/actions/{actionId}/draft',
|
|
30098
30621
|
'GET',
|
|
30099
30622
|
{ 'actionId': actionId },
|
|
30100
|
-
{ 'expand': opts['expand'],'includeConfig': opts['includeConfig'] },
|
|
30623
|
+
{ 'expand': opts['expand'],'flatten': opts['flatten'],'includeConfig': opts['includeConfig'] },
|
|
30101
30624
|
{ },
|
|
30102
30625
|
{ },
|
|
30103
30626
|
null,
|
|
@@ -32281,7 +32804,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32281
32804
|
/**
|
|
32282
32805
|
* Journey service.
|
|
32283
32806
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
32284
|
-
* @version
|
|
32807
|
+
* @version 217.0.0
|
|
32285
32808
|
*/
|
|
32286
32809
|
|
|
32287
32810
|
/**
|
|
@@ -33421,6 +33944,26 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33421
33944
|
);
|
|
33422
33945
|
}
|
|
33423
33946
|
|
|
33947
|
+
/**
|
|
33948
|
+
* Get details about the data available for journey queries including oldest and newest event dates
|
|
33949
|
+
*
|
|
33950
|
+
*/
|
|
33951
|
+
getJourneyViewsDataDetails() {
|
|
33952
|
+
|
|
33953
|
+
return this.apiClient.callApi(
|
|
33954
|
+
'/api/v2/journey/views/data/details',
|
|
33955
|
+
'GET',
|
|
33956
|
+
{ },
|
|
33957
|
+
{ },
|
|
33958
|
+
{ },
|
|
33959
|
+
{ },
|
|
33960
|
+
null,
|
|
33961
|
+
['PureCloud OAuth'],
|
|
33962
|
+
['application/json'],
|
|
33963
|
+
['application/json']
|
|
33964
|
+
);
|
|
33965
|
+
}
|
|
33966
|
+
|
|
33424
33967
|
/**
|
|
33425
33968
|
* Get an Event Definition
|
|
33426
33969
|
*
|
|
@@ -34246,7 +34789,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34246
34789
|
/**
|
|
34247
34790
|
* Knowledge service.
|
|
34248
34791
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
34249
|
-
* @version
|
|
34792
|
+
* @version 217.0.0
|
|
34250
34793
|
*/
|
|
34251
34794
|
|
|
34252
34795
|
/**
|
|
@@ -35777,7 +36320,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35777
36320
|
* @param {String} parseJobId Parse job ID
|
|
35778
36321
|
* @param {Object} opts Optional parameters
|
|
35779
36322
|
* @param {Array.<String>} opts.expand If expand contains 'urls' downloadURL and failedEntitiesURL will be filled.
|
|
35780
|
-
* getKnowledgeKnowledgebaseParseJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
35781
36323
|
*/
|
|
35782
36324
|
getKnowledgeKnowledgebaseParseJob(knowledgeBaseId, parseJobId, opts) {
|
|
35783
36325
|
opts = opts || {};
|
|
@@ -36047,7 +36589,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36047
36589
|
*
|
|
36048
36590
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
36049
36591
|
* @param {String} jobId Upload job ID
|
|
36050
|
-
* getKnowledgeKnowledgebaseUploadsUrlsJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
36051
36592
|
*/
|
|
36052
36593
|
getKnowledgeKnowledgebaseUploadsUrlsJob(knowledgeBaseId, jobId) {
|
|
36053
36594
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -36588,7 +37129,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36588
37129
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
36589
37130
|
* @param {String} parseJobId Parse job ID
|
|
36590
37131
|
* @param {Object} body
|
|
36591
|
-
* patchKnowledgeKnowledgebaseParseJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
36592
37132
|
*/
|
|
36593
37133
|
patchKnowledgeKnowledgebaseParseJob(knowledgeBaseId, parseJobId, body) {
|
|
36594
37134
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -37749,7 +38289,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37749
38289
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
37750
38290
|
* @param {String} parseJobId Parse job ID
|
|
37751
38291
|
* @param {Object} body
|
|
37752
|
-
* postKnowledgeKnowledgebaseParseJobImport is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
37753
38292
|
*/
|
|
37754
38293
|
postKnowledgeKnowledgebaseParseJobImport(knowledgeBaseId, parseJobId, body) {
|
|
37755
38294
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -37784,7 +38323,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37784
38323
|
*
|
|
37785
38324
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
37786
38325
|
* @param {Object} body
|
|
37787
|
-
* postKnowledgeKnowledgebaseParseJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
37788
38326
|
*/
|
|
37789
38327
|
postKnowledgeKnowledgebaseParseJobs(knowledgeBaseId, body) {
|
|
37790
38328
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -37875,8 +38413,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37875
38413
|
*
|
|
37876
38414
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
37877
38415
|
* @param {String} sourceId Source ID
|
|
38416
|
+
* @param {Object} opts Optional parameters
|
|
38417
|
+
* @param {Object} opts.body
|
|
37878
38418
|
*/
|
|
37879
|
-
postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync(knowledgeBaseId, sourceId) {
|
|
38419
|
+
postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync(knowledgeBaseId, sourceId, opts) {
|
|
38420
|
+
opts = opts || {};
|
|
38421
|
+
|
|
37880
38422
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
37881
38423
|
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
37882
38424
|
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync';
|
|
@@ -37893,7 +38435,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37893
38435
|
{ },
|
|
37894
38436
|
{ },
|
|
37895
38437
|
{ },
|
|
37896
|
-
|
|
38438
|
+
opts['body'],
|
|
37897
38439
|
['PureCloud OAuth'],
|
|
37898
38440
|
['application/json'],
|
|
37899
38441
|
['application/json']
|
|
@@ -37935,8 +38477,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37935
38477
|
*
|
|
37936
38478
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
37937
38479
|
* @param {String} sourceId Source ID
|
|
38480
|
+
* @param {Object} opts Optional parameters
|
|
38481
|
+
* @param {Object} opts.body
|
|
37938
38482
|
*/
|
|
37939
|
-
postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync(knowledgeBaseId, sourceId) {
|
|
38483
|
+
postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync(knowledgeBaseId, sourceId, opts) {
|
|
38484
|
+
opts = opts || {};
|
|
38485
|
+
|
|
37940
38486
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
37941
38487
|
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
37942
38488
|
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync';
|
|
@@ -37953,7 +38499,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37953
38499
|
{ },
|
|
37954
38500
|
{ },
|
|
37955
38501
|
{ },
|
|
37956
|
-
|
|
38502
|
+
opts['body'],
|
|
37957
38503
|
['PureCloud OAuth'],
|
|
37958
38504
|
['application/json'],
|
|
37959
38505
|
['application/json']
|
|
@@ -37995,7 +38541,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37995
38541
|
*
|
|
37996
38542
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
37997
38543
|
* @param {Object} body uploadRequest
|
|
37998
|
-
* postKnowledgeKnowledgebaseUploadsUrlsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
37999
38544
|
*/
|
|
38000
38545
|
postKnowledgeKnowledgebaseUploadsUrlsJobs(knowledgeBaseId, body) {
|
|
38001
38546
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -38122,7 +38667,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38122
38667
|
/**
|
|
38123
38668
|
* LanguageUnderstanding service.
|
|
38124
38669
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
38125
|
-
* @version
|
|
38670
|
+
* @version 217.0.0
|
|
38126
38671
|
*/
|
|
38127
38672
|
|
|
38128
38673
|
/**
|
|
@@ -39155,7 +39700,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39155
39700
|
/**
|
|
39156
39701
|
* Languages service.
|
|
39157
39702
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
39158
|
-
* @version
|
|
39703
|
+
* @version 217.0.0
|
|
39159
39704
|
*/
|
|
39160
39705
|
|
|
39161
39706
|
/**
|
|
@@ -39377,7 +39922,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39377
39922
|
/**
|
|
39378
39923
|
* Learning service.
|
|
39379
39924
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
39380
|
-
* @version
|
|
39925
|
+
* @version 217.0.0
|
|
39381
39926
|
*/
|
|
39382
39927
|
|
|
39383
39928
|
/**
|
|
@@ -40406,7 +40951,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40406
40951
|
/**
|
|
40407
40952
|
* License service.
|
|
40408
40953
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
40409
|
-
* @version
|
|
40954
|
+
* @version 217.0.0
|
|
40410
40955
|
*/
|
|
40411
40956
|
|
|
40412
40957
|
/**
|
|
@@ -40644,7 +41189,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40644
41189
|
/**
|
|
40645
41190
|
* Locations service.
|
|
40646
41191
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
40647
|
-
* @version
|
|
41192
|
+
* @version 217.0.0
|
|
40648
41193
|
*/
|
|
40649
41194
|
|
|
40650
41195
|
/**
|
|
@@ -40880,7 +41425,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40880
41425
|
/**
|
|
40881
41426
|
* LogCapture service.
|
|
40882
41427
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
40883
|
-
* @version
|
|
41428
|
+
* @version 217.0.0
|
|
40884
41429
|
*/
|
|
40885
41430
|
|
|
40886
41431
|
/**
|
|
@@ -41080,7 +41625,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41080
41625
|
/**
|
|
41081
41626
|
* Messaging service.
|
|
41082
41627
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
41083
|
-
* @version
|
|
41628
|
+
* @version 217.0.0
|
|
41084
41629
|
*/
|
|
41085
41630
|
|
|
41086
41631
|
/**
|
|
@@ -41439,7 +41984,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41439
41984
|
/**
|
|
41440
41985
|
* MobileDevices service.
|
|
41441
41986
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
41442
|
-
* @version
|
|
41987
|
+
* @version 217.0.0
|
|
41443
41988
|
*/
|
|
41444
41989
|
|
|
41445
41990
|
/**
|
|
@@ -41590,7 +42135,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41590
42135
|
/**
|
|
41591
42136
|
* Notifications service.
|
|
41592
42137
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
41593
|
-
* @version
|
|
42138
|
+
* @version 217.0.0
|
|
41594
42139
|
*/
|
|
41595
42140
|
|
|
41596
42141
|
/**
|
|
@@ -41823,7 +42368,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41823
42368
|
/**
|
|
41824
42369
|
* OAuth service.
|
|
41825
42370
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
41826
|
-
* @version
|
|
42371
|
+
* @version 217.0.0
|
|
41827
42372
|
*/
|
|
41828
42373
|
|
|
41829
42374
|
/**
|
|
@@ -42189,7 +42734,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42189
42734
|
/**
|
|
42190
42735
|
* Objects service.
|
|
42191
42736
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
42192
|
-
* @version
|
|
42737
|
+
* @version 217.0.0
|
|
42193
42738
|
*/
|
|
42194
42739
|
|
|
42195
42740
|
/**
|
|
@@ -42209,7 +42754,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42209
42754
|
*
|
|
42210
42755
|
* @param {String} divisionId Division ID
|
|
42211
42756
|
* @param {Object} opts Optional parameters
|
|
42212
|
-
* @param {Boolean} opts.force Force delete this division
|
|
42757
|
+
* @param {Boolean} opts.force DEPRECATED - Force delete this division. Warning: This option may cause any remaining objects in this division to be inaccessible. (default to false)
|
|
42213
42758
|
*/
|
|
42214
42759
|
deleteAuthorizationDivision(divisionId, opts) {
|
|
42215
42760
|
opts = opts || {};
|
|
@@ -42373,16 +42918,17 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42373
42918
|
* Recreate a previously deleted division.
|
|
42374
42919
|
*
|
|
42375
42920
|
* @param {String} divisionId Division ID
|
|
42376
|
-
* @param {Object}
|
|
42377
|
-
* @param {Object} opts.body Recreated division data
|
|
42921
|
+
* @param {Object} body Recreated division data
|
|
42378
42922
|
*/
|
|
42379
|
-
postAuthorizationDivisionRestore(divisionId,
|
|
42380
|
-
opts = opts || {};
|
|
42381
|
-
|
|
42923
|
+
postAuthorizationDivisionRestore(divisionId, body) {
|
|
42382
42924
|
// verify the required parameter 'divisionId' is set
|
|
42383
42925
|
if (divisionId === undefined || divisionId === null) {
|
|
42384
42926
|
throw 'Missing the required parameter "divisionId" when calling postAuthorizationDivisionRestore';
|
|
42385
42927
|
}
|
|
42928
|
+
// verify the required parameter 'body' is set
|
|
42929
|
+
if (body === undefined || body === null) {
|
|
42930
|
+
throw 'Missing the required parameter "body" when calling postAuthorizationDivisionRestore';
|
|
42931
|
+
}
|
|
42386
42932
|
|
|
42387
42933
|
return this.apiClient.callApi(
|
|
42388
42934
|
'/api/v2/authorization/divisions/{divisionId}/restore',
|
|
@@ -42391,7 +42937,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42391
42937
|
{ },
|
|
42392
42938
|
{ },
|
|
42393
42939
|
{ },
|
|
42394
|
-
|
|
42940
|
+
body,
|
|
42395
42941
|
['PureCloud OAuth'],
|
|
42396
42942
|
['application/json'],
|
|
42397
42943
|
['application/json']
|
|
@@ -42459,7 +43005,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42459
43005
|
/**
|
|
42460
43006
|
* OperationalEvents service.
|
|
42461
43007
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
42462
|
-
* @version
|
|
43008
|
+
* @version 217.0.0
|
|
42463
43009
|
*/
|
|
42464
43010
|
|
|
42465
43011
|
/**
|
|
@@ -42576,7 +43122,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42576
43122
|
/**
|
|
42577
43123
|
* Organization service.
|
|
42578
43124
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
42579
|
-
* @version
|
|
43125
|
+
* @version 217.0.0
|
|
42580
43126
|
*/
|
|
42581
43127
|
|
|
42582
43128
|
/**
|
|
@@ -42805,6 +43351,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42805
43351
|
* @param {String} opts.cursor Cursor provided when retrieving the last page
|
|
42806
43352
|
* @param {String} opts.entityId entity id of the count
|
|
42807
43353
|
* @param {String} opts.userId userid of the count
|
|
43354
|
+
* @deprecated
|
|
42808
43355
|
*/
|
|
42809
43356
|
getOrganizationsLimitsNamespaceCounts(namespaceName, opts) {
|
|
42810
43357
|
opts = opts || {};
|
|
@@ -42862,6 +43409,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42862
43409
|
* @param {String} opts.entityId entity id of the count
|
|
42863
43410
|
* @param {String} opts.userId userid of the count
|
|
42864
43411
|
* @param {String} opts.cursor Cursor provided when retrieving the last page
|
|
43412
|
+
* @deprecated
|
|
42865
43413
|
*/
|
|
42866
43414
|
getOrganizationsLimitsNamespaceLimitCounts(namespaceName, limitName, opts) {
|
|
42867
43415
|
opts = opts || {};
|
|
@@ -43118,7 +43666,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43118
43666
|
/**
|
|
43119
43667
|
* OrganizationAuthorization service.
|
|
43120
43668
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
43121
|
-
* @version
|
|
43669
|
+
* @version 217.0.0
|
|
43122
43670
|
*/
|
|
43123
43671
|
|
|
43124
43672
|
/**
|
|
@@ -44512,7 +45060,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44512
45060
|
/**
|
|
44513
45061
|
* Outbound service.
|
|
44514
45062
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
44515
|
-
* @version
|
|
45063
|
+
* @version 217.0.0
|
|
44516
45064
|
*/
|
|
44517
45065
|
|
|
44518
45066
|
/**
|
|
@@ -47341,8 +47889,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47341
47889
|
* Update the outbound settings for this organization
|
|
47342
47890
|
*
|
|
47343
47891
|
* @param {Object} body outboundSettings
|
|
47892
|
+
* @param {Object} opts Optional parameters
|
|
47893
|
+
* @param {Object} opts.useMaxCallsPerAgentDecimal Use maxCallsPerAgent with decimal precision
|
|
47344
47894
|
*/
|
|
47345
|
-
patchOutboundSettings(body) {
|
|
47895
|
+
patchOutboundSettings(body, opts) {
|
|
47896
|
+
opts = opts || {};
|
|
47897
|
+
|
|
47346
47898
|
// verify the required parameter 'body' is set
|
|
47347
47899
|
if (body === undefined || body === null) {
|
|
47348
47900
|
throw 'Missing the required parameter "body" when calling patchOutboundSettings';
|
|
@@ -47352,7 +47904,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47352
47904
|
'/api/v2/outbound/settings',
|
|
47353
47905
|
'PATCH',
|
|
47354
47906
|
{ },
|
|
47355
|
-
{
|
|
47907
|
+
{ 'useMaxCallsPerAgentDecimal': opts['useMaxCallsPerAgentDecimal'] },
|
|
47356
47908
|
{ },
|
|
47357
47909
|
{ },
|
|
47358
47910
|
body,
|
|
@@ -47572,8 +48124,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47572
48124
|
* Create a campaign.
|
|
47573
48125
|
*
|
|
47574
48126
|
* @param {Object} body Campaign
|
|
48127
|
+
* @param {Object} opts Optional parameters
|
|
48128
|
+
* @param {Object} opts.useMaxCallsPerAgentDecimal Use maxCallsPerAgent with decimal precision
|
|
47575
48129
|
*/
|
|
47576
|
-
postOutboundCampaigns(body) {
|
|
48130
|
+
postOutboundCampaigns(body, opts) {
|
|
48131
|
+
opts = opts || {};
|
|
48132
|
+
|
|
47577
48133
|
// verify the required parameter 'body' is set
|
|
47578
48134
|
if (body === undefined || body === null) {
|
|
47579
48135
|
throw 'Missing the required parameter "body" when calling postOutboundCampaigns';
|
|
@@ -47583,7 +48139,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47583
48139
|
'/api/v2/outbound/campaigns',
|
|
47584
48140
|
'POST',
|
|
47585
48141
|
{ },
|
|
47586
|
-
{
|
|
48142
|
+
{ 'useMaxCallsPerAgentDecimal': opts['useMaxCallsPerAgentDecimal'] },
|
|
47587
48143
|
{ },
|
|
47588
48144
|
{ },
|
|
47589
48145
|
body,
|
|
@@ -48487,8 +49043,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48487
49043
|
*
|
|
48488
49044
|
* @param {String} campaignId Campaign ID
|
|
48489
49045
|
* @param {Object} body Campaign
|
|
49046
|
+
* @param {Object} opts Optional parameters
|
|
49047
|
+
* @param {Object} opts.useMaxCallsPerAgentDecimal Use maxCallsPerAgent with decimal precision
|
|
48490
49048
|
*/
|
|
48491
|
-
putOutboundCampaign(campaignId, body) {
|
|
49049
|
+
putOutboundCampaign(campaignId, body, opts) {
|
|
49050
|
+
opts = opts || {};
|
|
49051
|
+
|
|
48492
49052
|
// verify the required parameter 'campaignId' is set
|
|
48493
49053
|
if (campaignId === undefined || campaignId === null) {
|
|
48494
49054
|
throw 'Missing the required parameter "campaignId" when calling putOutboundCampaign';
|
|
@@ -48502,7 +49062,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48502
49062
|
'/api/v2/outbound/campaigns/{campaignId}',
|
|
48503
49063
|
'PUT',
|
|
48504
49064
|
{ 'campaignId': campaignId },
|
|
48505
|
-
{
|
|
49065
|
+
{ 'useMaxCallsPerAgentDecimal': opts['useMaxCallsPerAgentDecimal'] },
|
|
48506
49066
|
{ },
|
|
48507
49067
|
{ },
|
|
48508
49068
|
body,
|
|
@@ -49063,7 +49623,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49063
49623
|
/**
|
|
49064
49624
|
* Presence service.
|
|
49065
49625
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
49066
|
-
* @version
|
|
49626
|
+
* @version 217.0.0
|
|
49067
49627
|
*/
|
|
49068
49628
|
|
|
49069
49629
|
/**
|
|
@@ -49807,7 +50367,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49807
50367
|
/**
|
|
49808
50368
|
* ProcessAutomation service.
|
|
49809
50369
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
49810
|
-
* @version
|
|
50370
|
+
* @version 217.0.0
|
|
49811
50371
|
*/
|
|
49812
50372
|
|
|
49813
50373
|
/**
|
|
@@ -50046,7 +50606,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50046
50606
|
/**
|
|
50047
50607
|
* Quality service.
|
|
50048
50608
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
50049
|
-
* @version
|
|
50609
|
+
* @version 217.0.0
|
|
50050
50610
|
*/
|
|
50051
50611
|
|
|
50052
50612
|
/**
|
|
@@ -51834,7 +52394,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51834
52394
|
/**
|
|
51835
52395
|
* Recording service.
|
|
51836
52396
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
51837
|
-
* @version
|
|
52397
|
+
* @version 217.0.0
|
|
51838
52398
|
*/
|
|
51839
52399
|
|
|
51840
52400
|
/**
|
|
@@ -52046,7 +52606,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52046
52606
|
* @param {Object} opts.messageFormatId The desired media format when downloading a message recording. Valid values:ZIP,NONE (default to ZIP)
|
|
52047
52607
|
* @param {Object} opts.download requesting a download format of the recording. Valid values:true,false (default to false)
|
|
52048
52608
|
* @param {String} opts.fileName the name of the downloaded fileName
|
|
52049
|
-
* @param {String} opts.locale The locale for the requested file when downloading, as an ISO 639-1 code
|
|
52609
|
+
* @param {String} opts.locale The locale for the requested file when downloading or for redacting sensitive information in requested files, as an ISO 639-1 code
|
|
52050
52610
|
* @param {Array.<String>} opts.mediaFormats All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3
|
|
52051
52611
|
*/
|
|
52052
52612
|
getConversationRecording(conversationId, recordingId, opts) {
|
|
@@ -52203,6 +52763,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52203
52763
|
* @param {Number} opts.maxWaitMs The maximum number of milliseconds to wait for the recording to be ready. Must be a positive value. (default to 5000)
|
|
52204
52764
|
* @param {Object} opts.formatId The desired media format. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE. (default to WEBM)
|
|
52205
52765
|
* @param {Array.<String>} opts.mediaFormats All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3.
|
|
52766
|
+
* @param {String} opts.locale The locale used for redacting sensitive information in requested files, as an ISO 639-1 code
|
|
52206
52767
|
*/
|
|
52207
52768
|
getConversationRecordings(conversationId, opts) {
|
|
52208
52769
|
opts = opts || {};
|
|
@@ -52216,7 +52777,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52216
52777
|
'/api/v2/conversations/{conversationId}/recordings',
|
|
52217
52778
|
'GET',
|
|
52218
52779
|
{ 'conversationId': conversationId },
|
|
52219
|
-
{ 'maxWaitMs': opts['maxWaitMs'],'formatId': opts['formatId'],'mediaFormats': this.apiClient.buildCollectionParam(opts['mediaFormats'], 'multi') },
|
|
52780
|
+
{ 'maxWaitMs': opts['maxWaitMs'],'formatId': opts['formatId'],'mediaFormats': this.apiClient.buildCollectionParam(opts['mediaFormats'], 'multi'),'locale': opts['locale'] },
|
|
52220
52781
|
{ },
|
|
52221
52782
|
{ },
|
|
52222
52783
|
null,
|
|
@@ -52718,32 +53279,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52718
53279
|
);
|
|
52719
53280
|
}
|
|
52720
53281
|
|
|
52721
|
-
/**
|
|
52722
|
-
* Retrieves a paged listing of screen recording sessions
|
|
52723
|
-
* Coming soon: This API is deprecated and will be replaced by /api/v2/recordings/screensessions/details
|
|
52724
|
-
* @param {Object} opts Optional parameters
|
|
52725
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
52726
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
52727
|
-
* @deprecated
|
|
52728
|
-
*/
|
|
52729
|
-
getRecordingsScreensessions(opts) {
|
|
52730
|
-
opts = opts || {};
|
|
52731
|
-
|
|
52732
|
-
|
|
52733
|
-
return this.apiClient.callApi(
|
|
52734
|
-
'/api/v2/recordings/screensessions',
|
|
52735
|
-
'GET',
|
|
52736
|
-
{ },
|
|
52737
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
52738
|
-
{ },
|
|
52739
|
-
{ },
|
|
52740
|
-
null,
|
|
52741
|
-
['PureCloud OAuth'],
|
|
52742
|
-
['application/json'],
|
|
52743
|
-
['application/json']
|
|
52744
|
-
);
|
|
52745
|
-
}
|
|
52746
|
-
|
|
52747
53282
|
/**
|
|
52748
53283
|
* Retrieves an object containing the total number of concurrent active screen recordings
|
|
52749
53284
|
*
|
|
@@ -52824,36 +53359,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52824
53359
|
);
|
|
52825
53360
|
}
|
|
52826
53361
|
|
|
52827
|
-
/**
|
|
52828
|
-
* Update a screen recording session
|
|
52829
|
-
* This API is deprecated and the functionality to stop screen recording will be no longer supported.
|
|
52830
|
-
* @param {String} recordingSessionId Screen recording session ID
|
|
52831
|
-
* @param {Object} opts Optional parameters
|
|
52832
|
-
* @param {Object} opts.body
|
|
52833
|
-
* @deprecated
|
|
52834
|
-
*/
|
|
52835
|
-
patchRecordingsScreensession(recordingSessionId, opts) {
|
|
52836
|
-
opts = opts || {};
|
|
52837
|
-
|
|
52838
|
-
// verify the required parameter 'recordingSessionId' is set
|
|
52839
|
-
if (recordingSessionId === undefined || recordingSessionId === null) {
|
|
52840
|
-
throw 'Missing the required parameter "recordingSessionId" when calling patchRecordingsScreensession';
|
|
52841
|
-
}
|
|
52842
|
-
|
|
52843
|
-
return this.apiClient.callApi(
|
|
52844
|
-
'/api/v2/recordings/screensessions/{recordingSessionId}',
|
|
52845
|
-
'PATCH',
|
|
52846
|
-
{ 'recordingSessionId': recordingSessionId },
|
|
52847
|
-
{ },
|
|
52848
|
-
{ },
|
|
52849
|
-
{ },
|
|
52850
|
-
opts['body'],
|
|
52851
|
-
['PureCloud OAuth'],
|
|
52852
|
-
['application/json'],
|
|
52853
|
-
['application/json']
|
|
52854
|
-
);
|
|
52855
|
-
}
|
|
52856
|
-
|
|
52857
53362
|
/**
|
|
52858
53363
|
* Create annotation
|
|
52859
53364
|
*
|
|
@@ -53493,7 +53998,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53493
53998
|
/**
|
|
53494
53999
|
* ResponseManagement service.
|
|
53495
54000
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
53496
|
-
* @version
|
|
54001
|
+
* @version 217.0.0
|
|
53497
54002
|
*/
|
|
53498
54003
|
|
|
53499
54004
|
/**
|
|
@@ -54003,7 +54508,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54003
54508
|
/**
|
|
54004
54509
|
* Routing service.
|
|
54005
54510
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
54006
|
-
* @version
|
|
54511
|
+
* @version 217.0.0
|
|
54007
54512
|
*/
|
|
54008
54513
|
|
|
54009
54514
|
/**
|
|
@@ -54844,6 +55349,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54844
55349
|
);
|
|
54845
55350
|
}
|
|
54846
55351
|
|
|
55352
|
+
/**
|
|
55353
|
+
* Get a route identity resolution setting.
|
|
55354
|
+
*
|
|
55355
|
+
* @param {String} domainName email domain
|
|
55356
|
+
* @param {String} routeId route ID
|
|
55357
|
+
* getRoutingEmailDomainRouteIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
55358
|
+
*/
|
|
55359
|
+
getRoutingEmailDomainRouteIdentityresolution(domainName, routeId) {
|
|
55360
|
+
// verify the required parameter 'domainName' is set
|
|
55361
|
+
if (domainName === undefined || domainName === null) {
|
|
55362
|
+
throw 'Missing the required parameter "domainName" when calling getRoutingEmailDomainRouteIdentityresolution';
|
|
55363
|
+
}
|
|
55364
|
+
// verify the required parameter 'routeId' is set
|
|
55365
|
+
if (routeId === undefined || routeId === null) {
|
|
55366
|
+
throw 'Missing the required parameter "routeId" when calling getRoutingEmailDomainRouteIdentityresolution';
|
|
55367
|
+
}
|
|
55368
|
+
|
|
55369
|
+
return this.apiClient.callApi(
|
|
55370
|
+
'/api/v2/routing/email/domains/{domainName}/routes/{routeId}/identityresolution',
|
|
55371
|
+
'GET',
|
|
55372
|
+
{ 'domainName': domainName,'routeId': routeId },
|
|
55373
|
+
{ },
|
|
55374
|
+
{ },
|
|
55375
|
+
{ },
|
|
55376
|
+
null,
|
|
55377
|
+
['PureCloud OAuth'],
|
|
55378
|
+
['application/json'],
|
|
55379
|
+
['application/json']
|
|
55380
|
+
);
|
|
55381
|
+
}
|
|
55382
|
+
|
|
54847
55383
|
/**
|
|
54848
55384
|
* Get routes
|
|
54849
55385
|
*
|
|
@@ -55397,6 +55933,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55397
55933
|
);
|
|
55398
55934
|
}
|
|
55399
55935
|
|
|
55936
|
+
/**
|
|
55937
|
+
* Get Queue IdentityResolution Settings.
|
|
55938
|
+
*
|
|
55939
|
+
* @param {String} queueId Queue ID
|
|
55940
|
+
* getRoutingQueueIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
55941
|
+
*/
|
|
55942
|
+
getRoutingQueueIdentityresolution(queueId) {
|
|
55943
|
+
// verify the required parameter 'queueId' is set
|
|
55944
|
+
if (queueId === undefined || queueId === null) {
|
|
55945
|
+
throw 'Missing the required parameter "queueId" when calling getRoutingQueueIdentityresolution';
|
|
55946
|
+
}
|
|
55947
|
+
|
|
55948
|
+
return this.apiClient.callApi(
|
|
55949
|
+
'/api/v2/routing/queues/{queueId}/identityresolution',
|
|
55950
|
+
'GET',
|
|
55951
|
+
{ 'queueId': queueId },
|
|
55952
|
+
{ },
|
|
55953
|
+
{ },
|
|
55954
|
+
{ },
|
|
55955
|
+
null,
|
|
55956
|
+
['PureCloud OAuth'],
|
|
55957
|
+
['application/json'],
|
|
55958
|
+
['application/json']
|
|
55959
|
+
);
|
|
55960
|
+
}
|
|
55961
|
+
|
|
55400
55962
|
/**
|
|
55401
55963
|
* Get Estimated Wait Time
|
|
55402
55964
|
*
|
|
@@ -55969,6 +56531,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55969
56531
|
);
|
|
55970
56532
|
}
|
|
55971
56533
|
|
|
56534
|
+
/**
|
|
56535
|
+
* Get a SMS identity resolution settings.
|
|
56536
|
+
*
|
|
56537
|
+
* @param {String} addressId Address ID
|
|
56538
|
+
* getRoutingSmsIdentityresolutionPhonenumber is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
56539
|
+
*/
|
|
56540
|
+
getRoutingSmsIdentityresolutionPhonenumber(addressId) {
|
|
56541
|
+
// verify the required parameter 'addressId' is set
|
|
56542
|
+
if (addressId === undefined || addressId === null) {
|
|
56543
|
+
throw 'Missing the required parameter "addressId" when calling getRoutingSmsIdentityresolutionPhonenumber';
|
|
56544
|
+
}
|
|
56545
|
+
|
|
56546
|
+
return this.apiClient.callApi(
|
|
56547
|
+
'/api/v2/routing/sms/identityresolution/phonenumbers/{addressId}',
|
|
56548
|
+
'GET',
|
|
56549
|
+
{ 'addressId': addressId },
|
|
56550
|
+
{ },
|
|
56551
|
+
{ },
|
|
56552
|
+
{ },
|
|
56553
|
+
null,
|
|
56554
|
+
['PureCloud OAuth'],
|
|
56555
|
+
['application/json'],
|
|
56556
|
+
['application/json']
|
|
56557
|
+
);
|
|
56558
|
+
}
|
|
56559
|
+
|
|
55972
56560
|
/**
|
|
55973
56561
|
* Get a phone number provisioned for SMS.
|
|
55974
56562
|
*
|
|
@@ -57774,6 +58362,42 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57774
58362
|
);
|
|
57775
58363
|
}
|
|
57776
58364
|
|
|
58365
|
+
/**
|
|
58366
|
+
* Update identity resolution settings for a route.
|
|
58367
|
+
*
|
|
58368
|
+
* @param {String} domainName email domain
|
|
58369
|
+
* @param {String} routeId route ID
|
|
58370
|
+
* @param {Object} body
|
|
58371
|
+
* putRoutingEmailDomainRouteIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58372
|
+
*/
|
|
58373
|
+
putRoutingEmailDomainRouteIdentityresolution(domainName, routeId, body) {
|
|
58374
|
+
// verify the required parameter 'domainName' is set
|
|
58375
|
+
if (domainName === undefined || domainName === null) {
|
|
58376
|
+
throw 'Missing the required parameter "domainName" when calling putRoutingEmailDomainRouteIdentityresolution';
|
|
58377
|
+
}
|
|
58378
|
+
// verify the required parameter 'routeId' is set
|
|
58379
|
+
if (routeId === undefined || routeId === null) {
|
|
58380
|
+
throw 'Missing the required parameter "routeId" when calling putRoutingEmailDomainRouteIdentityresolution';
|
|
58381
|
+
}
|
|
58382
|
+
// verify the required parameter 'body' is set
|
|
58383
|
+
if (body === undefined || body === null) {
|
|
58384
|
+
throw 'Missing the required parameter "body" when calling putRoutingEmailDomainRouteIdentityresolution';
|
|
58385
|
+
}
|
|
58386
|
+
|
|
58387
|
+
return this.apiClient.callApi(
|
|
58388
|
+
'/api/v2/routing/email/domains/{domainName}/routes/{routeId}/identityresolution',
|
|
58389
|
+
'PUT',
|
|
58390
|
+
{ 'domainName': domainName,'routeId': routeId },
|
|
58391
|
+
{ },
|
|
58392
|
+
{ },
|
|
58393
|
+
{ },
|
|
58394
|
+
body,
|
|
58395
|
+
['PureCloud OAuth'],
|
|
58396
|
+
['application/json'],
|
|
58397
|
+
['application/json']
|
|
58398
|
+
);
|
|
58399
|
+
}
|
|
58400
|
+
|
|
57777
58401
|
/**
|
|
57778
58402
|
* Request an activation status (cname + dkim) update of an outbound domain
|
|
57779
58403
|
*
|
|
@@ -57859,6 +58483,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57859
58483
|
);
|
|
57860
58484
|
}
|
|
57861
58485
|
|
|
58486
|
+
/**
|
|
58487
|
+
* Update Queue IdentityResolution Settings.
|
|
58488
|
+
*
|
|
58489
|
+
* @param {String} queueId Queue ID
|
|
58490
|
+
* @param {Object} body
|
|
58491
|
+
* putRoutingQueueIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58492
|
+
*/
|
|
58493
|
+
putRoutingQueueIdentityresolution(queueId, body) {
|
|
58494
|
+
// verify the required parameter 'queueId' is set
|
|
58495
|
+
if (queueId === undefined || queueId === null) {
|
|
58496
|
+
throw 'Missing the required parameter "queueId" when calling putRoutingQueueIdentityresolution';
|
|
58497
|
+
}
|
|
58498
|
+
// verify the required parameter 'body' is set
|
|
58499
|
+
if (body === undefined || body === null) {
|
|
58500
|
+
throw 'Missing the required parameter "body" when calling putRoutingQueueIdentityresolution';
|
|
58501
|
+
}
|
|
58502
|
+
|
|
58503
|
+
return this.apiClient.callApi(
|
|
58504
|
+
'/api/v2/routing/queues/{queueId}/identityresolution',
|
|
58505
|
+
'PUT',
|
|
58506
|
+
{ 'queueId': queueId },
|
|
58507
|
+
{ },
|
|
58508
|
+
{ },
|
|
58509
|
+
{ },
|
|
58510
|
+
body,
|
|
58511
|
+
['PureCloud OAuth'],
|
|
58512
|
+
['application/json'],
|
|
58513
|
+
['application/json']
|
|
58514
|
+
);
|
|
58515
|
+
}
|
|
58516
|
+
|
|
57862
58517
|
/**
|
|
57863
58518
|
* Update an organization's routing settings
|
|
57864
58519
|
*
|
|
@@ -57909,6 +58564,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57909
58564
|
);
|
|
57910
58565
|
}
|
|
57911
58566
|
|
|
58567
|
+
/**
|
|
58568
|
+
* Update an SMS identity resolution settings.
|
|
58569
|
+
*
|
|
58570
|
+
* @param {String} addressId Address ID
|
|
58571
|
+
* @param {Object} body
|
|
58572
|
+
* putRoutingSmsIdentityresolutionPhonenumber is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58573
|
+
*/
|
|
58574
|
+
putRoutingSmsIdentityresolutionPhonenumber(addressId, body) {
|
|
58575
|
+
// verify the required parameter 'addressId' is set
|
|
58576
|
+
if (addressId === undefined || addressId === null) {
|
|
58577
|
+
throw 'Missing the required parameter "addressId" when calling putRoutingSmsIdentityresolutionPhonenumber';
|
|
58578
|
+
}
|
|
58579
|
+
// verify the required parameter 'body' is set
|
|
58580
|
+
if (body === undefined || body === null) {
|
|
58581
|
+
throw 'Missing the required parameter "body" when calling putRoutingSmsIdentityresolutionPhonenumber';
|
|
58582
|
+
}
|
|
58583
|
+
|
|
58584
|
+
return this.apiClient.callApi(
|
|
58585
|
+
'/api/v2/routing/sms/identityresolution/phonenumbers/{addressId}',
|
|
58586
|
+
'PUT',
|
|
58587
|
+
{ 'addressId': addressId },
|
|
58588
|
+
{ },
|
|
58589
|
+
{ },
|
|
58590
|
+
{ },
|
|
58591
|
+
body,
|
|
58592
|
+
['PureCloud OAuth'],
|
|
58593
|
+
['application/json'],
|
|
58594
|
+
['application/json']
|
|
58595
|
+
);
|
|
58596
|
+
}
|
|
58597
|
+
|
|
57912
58598
|
/**
|
|
57913
58599
|
* Update the user's Direct Routing Backup settings.
|
|
57914
58600
|
*
|
|
@@ -58125,7 +58811,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58125
58811
|
/**
|
|
58126
58812
|
* SCIM service.
|
|
58127
58813
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
58128
|
-
* @version
|
|
58814
|
+
* @version 217.0.0
|
|
58129
58815
|
*/
|
|
58130
58816
|
|
|
58131
58817
|
/**
|
|
@@ -59002,7 +59688,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59002
59688
|
/**
|
|
59003
59689
|
* ScreenRecording service.
|
|
59004
59690
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
59005
|
-
* @version
|
|
59691
|
+
* @version 217.0.0
|
|
59006
59692
|
*/
|
|
59007
59693
|
|
|
59008
59694
|
/**
|
|
@@ -59047,7 +59733,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59047
59733
|
/**
|
|
59048
59734
|
* Scripts service.
|
|
59049
59735
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
59050
|
-
* @version
|
|
59736
|
+
* @version 217.0.0
|
|
59051
59737
|
*/
|
|
59052
59738
|
|
|
59053
59739
|
/**
|
|
@@ -59491,7 +60177,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59491
60177
|
/**
|
|
59492
60178
|
* Search service.
|
|
59493
60179
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
59494
|
-
* @version
|
|
60180
|
+
* @version 217.0.0
|
|
59495
60181
|
*/
|
|
59496
60182
|
|
|
59497
60183
|
/**
|
|
@@ -60234,7 +60920,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60234
60920
|
/**
|
|
60235
60921
|
* Settings service.
|
|
60236
60922
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
60237
|
-
* @version
|
|
60923
|
+
* @version 217.0.0
|
|
60238
60924
|
*/
|
|
60239
60925
|
|
|
60240
60926
|
/**
|
|
@@ -60454,7 +61140,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60454
61140
|
/**
|
|
60455
61141
|
* SocialMedia service.
|
|
60456
61142
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
60457
|
-
* @version
|
|
61143
|
+
* @version 217.0.0
|
|
60458
61144
|
*/
|
|
60459
61145
|
|
|
60460
61146
|
/**
|
|
@@ -61359,7 +62045,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61359
62045
|
/**
|
|
61360
62046
|
* SpeechTextAnalytics service.
|
|
61361
62047
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
61362
|
-
* @version
|
|
62048
|
+
* @version 217.0.0
|
|
61363
62049
|
*/
|
|
61364
62050
|
|
|
61365
62051
|
/**
|
|
@@ -61527,12 +62213,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61527
62213
|
* Get the list of Speech and Text Analytics categories
|
|
61528
62214
|
*
|
|
61529
62215
|
* @param {Object} opts Optional parameters
|
|
61530
|
-
* @param {Number} opts.pageSize The page size for the listing. The max that will be returned is
|
|
62216
|
+
* @param {Number} opts.pageSize The page size for the listing. The max that will be returned is 25. (default to 25)
|
|
61531
62217
|
* @param {Number} opts.pageNumber The page number for the listing (default to 1)
|
|
61532
62218
|
* @param {String} opts.name The category name filter applied to the listing
|
|
61533
62219
|
* @param {Object} opts.sortOrder The sort order for the listing (default to asc)
|
|
61534
62220
|
* @param {Object} opts.sortBy The field to sort by for the listing (default to name)
|
|
61535
|
-
* @param {Array.<String>} opts.ids Comma separated Category IDs to filter by. Cannot be used with other filters. Maximum of
|
|
62221
|
+
* @param {Array.<String>} opts.ids Comma separated Category IDs to filter by. Cannot be used with other filters. Maximum of 25 IDs allowed.
|
|
61536
62222
|
*/
|
|
61537
62223
|
getSpeechandtextanalyticsCategories(opts) {
|
|
61538
62224
|
opts = opts || {};
|
|
@@ -62800,7 +63486,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62800
63486
|
/**
|
|
62801
63487
|
* Stations service.
|
|
62802
63488
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
62803
|
-
* @version
|
|
63489
|
+
* @version 217.0.0
|
|
62804
63490
|
*/
|
|
62805
63491
|
|
|
62806
63492
|
/**
|
|
@@ -62902,7 +63588,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62902
63588
|
/**
|
|
62903
63589
|
* Suggest service.
|
|
62904
63590
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
62905
|
-
* @version
|
|
63591
|
+
* @version 217.0.0
|
|
62906
63592
|
*/
|
|
62907
63593
|
|
|
62908
63594
|
/**
|
|
@@ -63041,7 +63727,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63041
63727
|
/**
|
|
63042
63728
|
* TaskManagement service.
|
|
63043
63729
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
63044
|
-
* @version
|
|
63730
|
+
* @version 217.0.0
|
|
63045
63731
|
*/
|
|
63046
63732
|
|
|
63047
63733
|
/**
|
|
@@ -65147,7 +65833,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65147
65833
|
/**
|
|
65148
65834
|
* Teams service.
|
|
65149
65835
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
65150
|
-
* @version
|
|
65836
|
+
* @version 217.0.0
|
|
65151
65837
|
*/
|
|
65152
65838
|
|
|
65153
65839
|
/**
|
|
@@ -65452,7 +66138,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65452
66138
|
/**
|
|
65453
66139
|
* Telephony service.
|
|
65454
66140
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
65455
|
-
* @version
|
|
66141
|
+
* @version 217.0.0
|
|
65456
66142
|
*/
|
|
65457
66143
|
|
|
65458
66144
|
/**
|
|
@@ -65634,7 +66320,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65634
66320
|
/**
|
|
65635
66321
|
* TelephonyProvidersEdge service.
|
|
65636
66322
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
65637
|
-
* @version
|
|
66323
|
+
* @version 217.0.0
|
|
65638
66324
|
*/
|
|
65639
66325
|
|
|
65640
66326
|
/**
|
|
@@ -69085,7 +69771,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69085
69771
|
/**
|
|
69086
69772
|
* Textbots service.
|
|
69087
69773
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
69088
|
-
* @version
|
|
69774
|
+
* @version 217.0.0
|
|
69089
69775
|
*/
|
|
69090
69776
|
|
|
69091
69777
|
/**
|
|
@@ -69213,7 +69899,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69213
69899
|
/**
|
|
69214
69900
|
* Tokens service.
|
|
69215
69901
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
69216
|
-
* @version
|
|
69902
|
+
* @version 217.0.0
|
|
69217
69903
|
*/
|
|
69218
69904
|
|
|
69219
69905
|
/**
|
|
@@ -69367,7 +70053,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69367
70053
|
/**
|
|
69368
70054
|
* Uploads service.
|
|
69369
70055
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
69370
|
-
* @version
|
|
70056
|
+
* @version 217.0.0
|
|
69371
70057
|
*/
|
|
69372
70058
|
|
|
69373
70059
|
/**
|
|
@@ -69387,7 +70073,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69387
70073
|
*
|
|
69388
70074
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
69389
70075
|
* @param {String} jobId Upload job ID
|
|
69390
|
-
* getKnowledgeKnowledgebaseUploadsUrlsJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
69391
70076
|
*/
|
|
69392
70077
|
getKnowledgeKnowledgebaseUploadsUrlsJob(knowledgeBaseId, jobId) {
|
|
69393
70078
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -69473,7 +70158,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69473
70158
|
*
|
|
69474
70159
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
69475
70160
|
* @param {Object} body uploadRequest
|
|
69476
|
-
* postKnowledgeKnowledgebaseUploadsUrlsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
69477
70161
|
*/
|
|
69478
70162
|
postKnowledgeKnowledgebaseUploadsUrlsJobs(knowledgeBaseId, body) {
|
|
69479
70163
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -69635,7 +70319,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69635
70319
|
/**
|
|
69636
70320
|
* Usage service.
|
|
69637
70321
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
69638
|
-
* @version
|
|
70322
|
+
* @version 217.0.0
|
|
69639
70323
|
*/
|
|
69640
70324
|
|
|
69641
70325
|
/**
|
|
@@ -69850,7 +70534,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69850
70534
|
/**
|
|
69851
70535
|
* UserRecordings service.
|
|
69852
70536
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
69853
|
-
* @version
|
|
70537
|
+
* @version 217.0.0
|
|
69854
70538
|
*/
|
|
69855
70539
|
|
|
69856
70540
|
/**
|
|
@@ -70065,7 +70749,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70065
70749
|
/**
|
|
70066
70750
|
* Users service.
|
|
70067
70751
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
70068
|
-
* @version
|
|
70752
|
+
* @version 217.0.0
|
|
70069
70753
|
*/
|
|
70070
70754
|
|
|
70071
70755
|
/**
|
|
@@ -73018,7 +73702,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
73018
73702
|
/**
|
|
73019
73703
|
* Utilities service.
|
|
73020
73704
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
73021
|
-
* @version
|
|
73705
|
+
* @version 217.0.0
|
|
73022
73706
|
*/
|
|
73023
73707
|
|
|
73024
73708
|
/**
|
|
@@ -73129,7 +73813,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
73129
73813
|
/**
|
|
73130
73814
|
* Voicemail service.
|
|
73131
73815
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
73132
|
-
* @version
|
|
73816
|
+
* @version 217.0.0
|
|
73133
73817
|
*/
|
|
73134
73818
|
|
|
73135
73819
|
/**
|
|
@@ -73851,7 +74535,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
73851
74535
|
/**
|
|
73852
74536
|
* WebChat service.
|
|
73853
74537
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
73854
|
-
* @version
|
|
74538
|
+
* @version 217.0.0
|
|
73855
74539
|
*/
|
|
73856
74540
|
|
|
73857
74541
|
/**
|
|
@@ -74402,7 +75086,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74402
75086
|
/**
|
|
74403
75087
|
* WebDeployments service.
|
|
74404
75088
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
74405
|
-
* @version
|
|
75089
|
+
* @version 217.0.0
|
|
74406
75090
|
*/
|
|
74407
75091
|
|
|
74408
75092
|
/**
|
|
@@ -74715,6 +75399,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74715
75399
|
);
|
|
74716
75400
|
}
|
|
74717
75401
|
|
|
75402
|
+
/**
|
|
75403
|
+
* Get a deployment identity resolution setting.
|
|
75404
|
+
*
|
|
75405
|
+
* @param {String} deploymentId The deployment ID
|
|
75406
|
+
* getWebdeploymentsDeploymentIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
75407
|
+
*/
|
|
75408
|
+
getWebdeploymentsDeploymentIdentityresolution(deploymentId) {
|
|
75409
|
+
// verify the required parameter 'deploymentId' is set
|
|
75410
|
+
if (deploymentId === undefined || deploymentId === null) {
|
|
75411
|
+
throw 'Missing the required parameter "deploymentId" when calling getWebdeploymentsDeploymentIdentityresolution';
|
|
75412
|
+
}
|
|
75413
|
+
|
|
75414
|
+
return this.apiClient.callApi(
|
|
75415
|
+
'/api/v2/webdeployments/deployments/{deploymentId}/identityresolution',
|
|
75416
|
+
'GET',
|
|
75417
|
+
{ 'deploymentId': deploymentId },
|
|
75418
|
+
{ },
|
|
75419
|
+
{ },
|
|
75420
|
+
{ },
|
|
75421
|
+
null,
|
|
75422
|
+
['PureCloud OAuth'],
|
|
75423
|
+
['application/json'],
|
|
75424
|
+
['application/json']
|
|
75425
|
+
);
|
|
75426
|
+
}
|
|
75427
|
+
|
|
74718
75428
|
/**
|
|
74719
75429
|
* Get deployments
|
|
74720
75430
|
*
|
|
@@ -74923,13 +75633,44 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74923
75633
|
);
|
|
74924
75634
|
}
|
|
74925
75635
|
|
|
75636
|
+
/**
|
|
75637
|
+
* Update identity resolution settings for a deployment.
|
|
75638
|
+
*
|
|
75639
|
+
* @param {String} deploymentId The deployment ID
|
|
75640
|
+
* @param {Object} body
|
|
75641
|
+
* putWebdeploymentsDeploymentIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
75642
|
+
*/
|
|
75643
|
+
putWebdeploymentsDeploymentIdentityresolution(deploymentId, body) {
|
|
75644
|
+
// verify the required parameter 'deploymentId' is set
|
|
75645
|
+
if (deploymentId === undefined || deploymentId === null) {
|
|
75646
|
+
throw 'Missing the required parameter "deploymentId" when calling putWebdeploymentsDeploymentIdentityresolution';
|
|
75647
|
+
}
|
|
75648
|
+
// verify the required parameter 'body' is set
|
|
75649
|
+
if (body === undefined || body === null) {
|
|
75650
|
+
throw 'Missing the required parameter "body" when calling putWebdeploymentsDeploymentIdentityresolution';
|
|
75651
|
+
}
|
|
75652
|
+
|
|
75653
|
+
return this.apiClient.callApi(
|
|
75654
|
+
'/api/v2/webdeployments/deployments/{deploymentId}/identityresolution',
|
|
75655
|
+
'PUT',
|
|
75656
|
+
{ 'deploymentId': deploymentId },
|
|
75657
|
+
{ },
|
|
75658
|
+
{ },
|
|
75659
|
+
{ },
|
|
75660
|
+
body,
|
|
75661
|
+
['PureCloud OAuth'],
|
|
75662
|
+
['application/json'],
|
|
75663
|
+
['application/json']
|
|
75664
|
+
);
|
|
75665
|
+
}
|
|
75666
|
+
|
|
74926
75667
|
}
|
|
74927
75668
|
|
|
74928
75669
|
class WebMessagingApi {
|
|
74929
75670
|
/**
|
|
74930
75671
|
* WebMessaging service.
|
|
74931
75672
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
74932
|
-
* @version
|
|
75673
|
+
* @version 217.0.0
|
|
74933
75674
|
*/
|
|
74934
75675
|
|
|
74935
75676
|
/**
|
|
@@ -74975,7 +75716,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74975
75716
|
/**
|
|
74976
75717
|
* Widgets service.
|
|
74977
75718
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
74978
|
-
* @version
|
|
75719
|
+
* @version 217.0.0
|
|
74979
75720
|
*/
|
|
74980
75721
|
|
|
74981
75722
|
/**
|
|
@@ -75121,7 +75862,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75121
75862
|
/**
|
|
75122
75863
|
* WorkforceManagement service.
|
|
75123
75864
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
75124
|
-
* @version
|
|
75865
|
+
* @version 217.0.0
|
|
75125
75866
|
*/
|
|
75126
75867
|
|
|
75127
75868
|
/**
|
|
@@ -77645,6 +78386,51 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
77645
78386
|
);
|
|
77646
78387
|
}
|
|
77647
78388
|
|
|
78389
|
+
/**
|
|
78390
|
+
* Retrieves delete job status for historical data imports associated with the job id
|
|
78391
|
+
*
|
|
78392
|
+
* @param {String} jobId The job ID of the historical data delete request
|
|
78393
|
+
*/
|
|
78394
|
+
getWorkforcemanagementHistoricaldataBulkRemoveJob(jobId) {
|
|
78395
|
+
// verify the required parameter 'jobId' is set
|
|
78396
|
+
if (jobId === undefined || jobId === null) {
|
|
78397
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementHistoricaldataBulkRemoveJob';
|
|
78398
|
+
}
|
|
78399
|
+
|
|
78400
|
+
return this.apiClient.callApi(
|
|
78401
|
+
'/api/v2/workforcemanagement/historicaldata/bulk/remove/jobs/{jobId}',
|
|
78402
|
+
'GET',
|
|
78403
|
+
{ 'jobId': jobId },
|
|
78404
|
+
{ },
|
|
78405
|
+
{ },
|
|
78406
|
+
{ },
|
|
78407
|
+
null,
|
|
78408
|
+
['PureCloud OAuth'],
|
|
78409
|
+
['application/json'],
|
|
78410
|
+
['application/json']
|
|
78411
|
+
);
|
|
78412
|
+
}
|
|
78413
|
+
|
|
78414
|
+
/**
|
|
78415
|
+
* Retrieves all delete job status for historical data
|
|
78416
|
+
*
|
|
78417
|
+
*/
|
|
78418
|
+
getWorkforcemanagementHistoricaldataBulkRemoveJobs() {
|
|
78419
|
+
|
|
78420
|
+
return this.apiClient.callApi(
|
|
78421
|
+
'/api/v2/workforcemanagement/historicaldata/bulk/remove/jobs',
|
|
78422
|
+
'GET',
|
|
78423
|
+
{ },
|
|
78424
|
+
{ },
|
|
78425
|
+
{ },
|
|
78426
|
+
{ },
|
|
78427
|
+
null,
|
|
78428
|
+
['PureCloud OAuth'],
|
|
78429
|
+
['application/json'],
|
|
78430
|
+
['application/json']
|
|
78431
|
+
);
|
|
78432
|
+
}
|
|
78433
|
+
|
|
77648
78434
|
/**
|
|
77649
78435
|
* Retrieves delete job status for historical data imports of the organization
|
|
77650
78436
|
*
|
|
@@ -81194,6 +81980,30 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
81194
81980
|
);
|
|
81195
81981
|
}
|
|
81196
81982
|
|
|
81983
|
+
/**
|
|
81984
|
+
* Delete the list of the historical data import entries
|
|
81985
|
+
*
|
|
81986
|
+
* @param {Object} opts Optional parameters
|
|
81987
|
+
* @param {Object} opts.body body
|
|
81988
|
+
*/
|
|
81989
|
+
postWorkforcemanagementHistoricaldataBulkRemoveJobs(opts) {
|
|
81990
|
+
opts = opts || {};
|
|
81991
|
+
|
|
81992
|
+
|
|
81993
|
+
return this.apiClient.callApi(
|
|
81994
|
+
'/api/v2/workforcemanagement/historicaldata/bulk/remove/jobs',
|
|
81995
|
+
'POST',
|
|
81996
|
+
{ },
|
|
81997
|
+
{ },
|
|
81998
|
+
{ },
|
|
81999
|
+
{ },
|
|
82000
|
+
opts['body'],
|
|
82001
|
+
['PureCloud OAuth'],
|
|
82002
|
+
['application/json'],
|
|
82003
|
+
['application/json']
|
|
82004
|
+
);
|
|
82005
|
+
}
|
|
82006
|
+
|
|
81197
82007
|
/**
|
|
81198
82008
|
* Delete the entries of the historical data imports in the organization
|
|
81199
82009
|
*
|
|
@@ -82445,7 +83255,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
82445
83255
|
* </pre>
|
|
82446
83256
|
* </p>
|
|
82447
83257
|
* @module purecloud-platform-client-v2/index
|
|
82448
|
-
* @version
|
|
83258
|
+
* @version 217.0.0
|
|
82449
83259
|
*/
|
|
82450
83260
|
class platformClient {
|
|
82451
83261
|
constructor() {
|