purecloud-platform-client-v2 216.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 +826 -457
- package/dist/web-amd/purecloud-platform-client-v2.js +826 -457
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +314 -217
- package/dist/web-cjs/purecloud-platform-client-v2.js +319 -220
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +345 -220
- 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 -2
- 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 +9 -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 +167 -4
- 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 +1 -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 -29
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -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 +1 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -690,7 +690,7 @@ class Configuration {
|
|
|
690
690
|
|
|
691
691
|
/**
|
|
692
692
|
* @module purecloud-platform-client-v2/ApiClient
|
|
693
|
-
* @version
|
|
693
|
+
* @version 217.0.0
|
|
694
694
|
*/
|
|
695
695
|
class ApiClient {
|
|
696
696
|
/**
|
|
@@ -2234,7 +2234,7 @@ class AgentAssistantsApi {
|
|
|
2234
2234
|
/**
|
|
2235
2235
|
* AgentAssistants service.
|
|
2236
2236
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
2237
|
-
* @version
|
|
2237
|
+
* @version 217.0.0
|
|
2238
2238
|
*/
|
|
2239
2239
|
|
|
2240
2240
|
/**
|
|
@@ -2610,7 +2610,7 @@ class AgentCopilotApi {
|
|
|
2610
2610
|
/**
|
|
2611
2611
|
* AgentCopilot service.
|
|
2612
2612
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
2613
|
-
* @version
|
|
2613
|
+
* @version 217.0.0
|
|
2614
2614
|
*/
|
|
2615
2615
|
|
|
2616
2616
|
/**
|
|
@@ -2686,7 +2686,7 @@ class AgentUIApi {
|
|
|
2686
2686
|
/**
|
|
2687
2687
|
* AgentUI service.
|
|
2688
2688
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
2689
|
-
* @version
|
|
2689
|
+
* @version 217.0.0
|
|
2690
2690
|
*/
|
|
2691
2691
|
|
|
2692
2692
|
/**
|
|
@@ -2817,7 +2817,7 @@ class AlertingApi {
|
|
|
2817
2817
|
/**
|
|
2818
2818
|
* Alerting service.
|
|
2819
2819
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
2820
|
-
* @version
|
|
2820
|
+
* @version 217.0.0
|
|
2821
2821
|
*/
|
|
2822
2822
|
|
|
2823
2823
|
/**
|
|
@@ -2877,58 +2877,6 @@ class AlertingApi {
|
|
|
2877
2877
|
);
|
|
2878
2878
|
}
|
|
2879
2879
|
|
|
2880
|
-
/**
|
|
2881
|
-
* Delete an interaction stats alert
|
|
2882
|
-
* Apps should migrate to use DELETE /api/v2/alerting/alerts/{alertId}.
|
|
2883
|
-
* @param {String} alertId Alert ID
|
|
2884
|
-
* @deprecated
|
|
2885
|
-
*/
|
|
2886
|
-
deleteAlertingInteractionstatsAlert(alertId) {
|
|
2887
|
-
// verify the required parameter 'alertId' is set
|
|
2888
|
-
if (alertId === undefined || alertId === null) {
|
|
2889
|
-
throw 'Missing the required parameter "alertId" when calling deleteAlertingInteractionstatsAlert';
|
|
2890
|
-
}
|
|
2891
|
-
|
|
2892
|
-
return this.apiClient.callApi(
|
|
2893
|
-
'/api/v2/alerting/interactionstats/alerts/{alertId}',
|
|
2894
|
-
'DELETE',
|
|
2895
|
-
{ 'alertId': alertId },
|
|
2896
|
-
{ },
|
|
2897
|
-
{ },
|
|
2898
|
-
{ },
|
|
2899
|
-
null,
|
|
2900
|
-
['PureCloud OAuth'],
|
|
2901
|
-
['application/json'],
|
|
2902
|
-
['application/json']
|
|
2903
|
-
);
|
|
2904
|
-
}
|
|
2905
|
-
|
|
2906
|
-
/**
|
|
2907
|
-
* Delete an interaction stats rule
|
|
2908
|
-
* Apps should migrate to use DELETE /api/v2/alerting/rules/{ruleId}.
|
|
2909
|
-
* @param {String} ruleId Rule ID
|
|
2910
|
-
* @deprecated
|
|
2911
|
-
*/
|
|
2912
|
-
deleteAlertingInteractionstatsRule(ruleId) {
|
|
2913
|
-
// verify the required parameter 'ruleId' is set
|
|
2914
|
-
if (ruleId === undefined || ruleId === null) {
|
|
2915
|
-
throw 'Missing the required parameter "ruleId" when calling deleteAlertingInteractionstatsRule';
|
|
2916
|
-
}
|
|
2917
|
-
|
|
2918
|
-
return this.apiClient.callApi(
|
|
2919
|
-
'/api/v2/alerting/interactionstats/rules/{ruleId}',
|
|
2920
|
-
'DELETE',
|
|
2921
|
-
{ 'ruleId': ruleId },
|
|
2922
|
-
{ },
|
|
2923
|
-
{ },
|
|
2924
|
-
{ },
|
|
2925
|
-
null,
|
|
2926
|
-
['PureCloud OAuth'],
|
|
2927
|
-
['application/json'],
|
|
2928
|
-
['application/json']
|
|
2929
|
-
);
|
|
2930
|
-
}
|
|
2931
|
-
|
|
2932
2880
|
/**
|
|
2933
2881
|
* Delete a rule.
|
|
2934
2882
|
*
|
|
@@ -2979,158 +2927,6 @@ class AlertingApi {
|
|
|
2979
2927
|
);
|
|
2980
2928
|
}
|
|
2981
2929
|
|
|
2982
|
-
/**
|
|
2983
|
-
* Gets active alert count for a user
|
|
2984
|
-
* 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.
|
|
2985
|
-
* @deprecated
|
|
2986
|
-
*/
|
|
2987
|
-
getAlertingAlertsActive() {
|
|
2988
|
-
|
|
2989
|
-
return this.apiClient.callApi(
|
|
2990
|
-
'/api/v2/alerting/alerts/active',
|
|
2991
|
-
'GET',
|
|
2992
|
-
{ },
|
|
2993
|
-
{ },
|
|
2994
|
-
{ },
|
|
2995
|
-
{ },
|
|
2996
|
-
null,
|
|
2997
|
-
['PureCloud OAuth'],
|
|
2998
|
-
['application/json'],
|
|
2999
|
-
['application/json']
|
|
3000
|
-
);
|
|
3001
|
-
}
|
|
3002
|
-
|
|
3003
|
-
/**
|
|
3004
|
-
* Get an interaction stats alert
|
|
3005
|
-
* Apps should migrate to use GET /api/v2/alerting/alerts/{alertId}.
|
|
3006
|
-
* @param {String} alertId Alert ID
|
|
3007
|
-
* @param {Object} opts Optional parameters
|
|
3008
|
-
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
3009
|
-
* @deprecated
|
|
3010
|
-
*/
|
|
3011
|
-
getAlertingInteractionstatsAlert(alertId, opts) {
|
|
3012
|
-
opts = opts || {};
|
|
3013
|
-
|
|
3014
|
-
// verify the required parameter 'alertId' is set
|
|
3015
|
-
if (alertId === undefined || alertId === null) {
|
|
3016
|
-
throw 'Missing the required parameter "alertId" when calling getAlertingInteractionstatsAlert';
|
|
3017
|
-
}
|
|
3018
|
-
|
|
3019
|
-
return this.apiClient.callApi(
|
|
3020
|
-
'/api/v2/alerting/interactionstats/alerts/{alertId}',
|
|
3021
|
-
'GET',
|
|
3022
|
-
{ 'alertId': alertId },
|
|
3023
|
-
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
3024
|
-
{ },
|
|
3025
|
-
{ },
|
|
3026
|
-
null,
|
|
3027
|
-
['PureCloud OAuth'],
|
|
3028
|
-
['application/json'],
|
|
3029
|
-
['application/json']
|
|
3030
|
-
);
|
|
3031
|
-
}
|
|
3032
|
-
|
|
3033
|
-
/**
|
|
3034
|
-
* Get interaction stats alert list
|
|
3035
|
-
* Apps should migrate to use POST /api/v2/alerting/alerts/query.
|
|
3036
|
-
* @param {Object} opts Optional parameters
|
|
3037
|
-
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
3038
|
-
* @deprecated
|
|
3039
|
-
*/
|
|
3040
|
-
getAlertingInteractionstatsAlerts(opts) {
|
|
3041
|
-
opts = opts || {};
|
|
3042
|
-
|
|
3043
|
-
|
|
3044
|
-
return this.apiClient.callApi(
|
|
3045
|
-
'/api/v2/alerting/interactionstats/alerts',
|
|
3046
|
-
'GET',
|
|
3047
|
-
{ },
|
|
3048
|
-
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
3049
|
-
{ },
|
|
3050
|
-
{ },
|
|
3051
|
-
null,
|
|
3052
|
-
['PureCloud OAuth'],
|
|
3053
|
-
['application/json'],
|
|
3054
|
-
['application/json']
|
|
3055
|
-
);
|
|
3056
|
-
}
|
|
3057
|
-
|
|
3058
|
-
/**
|
|
3059
|
-
* Gets user unread count of interaction stats alerts
|
|
3060
|
-
* 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.
|
|
3061
|
-
* @deprecated
|
|
3062
|
-
*/
|
|
3063
|
-
getAlertingInteractionstatsAlertsUnread() {
|
|
3064
|
-
|
|
3065
|
-
return this.apiClient.callApi(
|
|
3066
|
-
'/api/v2/alerting/interactionstats/alerts/unread',
|
|
3067
|
-
'GET',
|
|
3068
|
-
{ },
|
|
3069
|
-
{ },
|
|
3070
|
-
{ },
|
|
3071
|
-
{ },
|
|
3072
|
-
null,
|
|
3073
|
-
['PureCloud OAuth'],
|
|
3074
|
-
['application/json'],
|
|
3075
|
-
['application/json']
|
|
3076
|
-
);
|
|
3077
|
-
}
|
|
3078
|
-
|
|
3079
|
-
/**
|
|
3080
|
-
* Get an interaction stats rule
|
|
3081
|
-
* Apps should migrate to use GET /api/v2/alerting/rules/{ruleId}.
|
|
3082
|
-
* @param {String} ruleId Rule ID
|
|
3083
|
-
* @param {Object} opts Optional parameters
|
|
3084
|
-
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
3085
|
-
* @deprecated
|
|
3086
|
-
*/
|
|
3087
|
-
getAlertingInteractionstatsRule(ruleId, opts) {
|
|
3088
|
-
opts = opts || {};
|
|
3089
|
-
|
|
3090
|
-
// verify the required parameter 'ruleId' is set
|
|
3091
|
-
if (ruleId === undefined || ruleId === null) {
|
|
3092
|
-
throw 'Missing the required parameter "ruleId" when calling getAlertingInteractionstatsRule';
|
|
3093
|
-
}
|
|
3094
|
-
|
|
3095
|
-
return this.apiClient.callApi(
|
|
3096
|
-
'/api/v2/alerting/interactionstats/rules/{ruleId}',
|
|
3097
|
-
'GET',
|
|
3098
|
-
{ 'ruleId': ruleId },
|
|
3099
|
-
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
3100
|
-
{ },
|
|
3101
|
-
{ },
|
|
3102
|
-
null,
|
|
3103
|
-
['PureCloud OAuth'],
|
|
3104
|
-
['application/json'],
|
|
3105
|
-
['application/json']
|
|
3106
|
-
);
|
|
3107
|
-
}
|
|
3108
|
-
|
|
3109
|
-
/**
|
|
3110
|
-
* Get an interaction stats rule list
|
|
3111
|
-
* Apps should migrate to use POST /api/v2/alerting/rules/query.
|
|
3112
|
-
* @param {Object} opts Optional parameters
|
|
3113
|
-
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
3114
|
-
* @deprecated
|
|
3115
|
-
*/
|
|
3116
|
-
getAlertingInteractionstatsRules(opts) {
|
|
3117
|
-
opts = opts || {};
|
|
3118
|
-
|
|
3119
|
-
|
|
3120
|
-
return this.apiClient.callApi(
|
|
3121
|
-
'/api/v2/alerting/interactionstats/rules',
|
|
3122
|
-
'GET',
|
|
3123
|
-
{ },
|
|
3124
|
-
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
3125
|
-
{ },
|
|
3126
|
-
{ },
|
|
3127
|
-
null,
|
|
3128
|
-
['PureCloud OAuth'],
|
|
3129
|
-
['application/json'],
|
|
3130
|
-
['application/json']
|
|
3131
|
-
);
|
|
3132
|
-
}
|
|
3133
|
-
|
|
3134
2930
|
/**
|
|
3135
2931
|
* Get a rule.
|
|
3136
2932
|
*
|
|
@@ -3283,36 +3079,6 @@ class AlertingApi {
|
|
|
3283
3079
|
);
|
|
3284
3080
|
}
|
|
3285
3081
|
|
|
3286
|
-
/**
|
|
3287
|
-
* Create an interaction stats rule
|
|
3288
|
-
* Apps should migrate to use POST /api/v2/alerting/rules.
|
|
3289
|
-
* @param {Object} body AlertingRule
|
|
3290
|
-
* @param {Object} opts Optional parameters
|
|
3291
|
-
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
3292
|
-
* @deprecated
|
|
3293
|
-
*/
|
|
3294
|
-
postAlertingInteractionstatsRules(body, opts) {
|
|
3295
|
-
opts = opts || {};
|
|
3296
|
-
|
|
3297
|
-
// verify the required parameter 'body' is set
|
|
3298
|
-
if (body === undefined || body === null) {
|
|
3299
|
-
throw 'Missing the required parameter "body" when calling postAlertingInteractionstatsRules';
|
|
3300
|
-
}
|
|
3301
|
-
|
|
3302
|
-
return this.apiClient.callApi(
|
|
3303
|
-
'/api/v2/alerting/interactionstats/rules',
|
|
3304
|
-
'POST',
|
|
3305
|
-
{ },
|
|
3306
|
-
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
3307
|
-
{ },
|
|
3308
|
-
{ },
|
|
3309
|
-
body,
|
|
3310
|
-
['PureCloud OAuth'],
|
|
3311
|
-
['application/json'],
|
|
3312
|
-
['application/json']
|
|
3313
|
-
);
|
|
3314
|
-
}
|
|
3315
|
-
|
|
3316
3082
|
/**
|
|
3317
3083
|
* Create a Rule.
|
|
3318
3084
|
*
|
|
@@ -3416,76 +3182,6 @@ class AlertingApi {
|
|
|
3416
3182
|
);
|
|
3417
3183
|
}
|
|
3418
3184
|
|
|
3419
|
-
/**
|
|
3420
|
-
* Update an interaction stats alert read status
|
|
3421
|
-
* Apps should migrate to use PUT /api/v2/alerting/alerts/{alertId}.
|
|
3422
|
-
* @param {String} alertId Alert ID
|
|
3423
|
-
* @param {Object} body InteractionStatsAlert
|
|
3424
|
-
* @param {Object} opts Optional parameters
|
|
3425
|
-
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
3426
|
-
* @deprecated
|
|
3427
|
-
*/
|
|
3428
|
-
putAlertingInteractionstatsAlert(alertId, body, opts) {
|
|
3429
|
-
opts = opts || {};
|
|
3430
|
-
|
|
3431
|
-
// verify the required parameter 'alertId' is set
|
|
3432
|
-
if (alertId === undefined || alertId === null) {
|
|
3433
|
-
throw 'Missing the required parameter "alertId" when calling putAlertingInteractionstatsAlert';
|
|
3434
|
-
}
|
|
3435
|
-
// verify the required parameter 'body' is set
|
|
3436
|
-
if (body === undefined || body === null) {
|
|
3437
|
-
throw 'Missing the required parameter "body" when calling putAlertingInteractionstatsAlert';
|
|
3438
|
-
}
|
|
3439
|
-
|
|
3440
|
-
return this.apiClient.callApi(
|
|
3441
|
-
'/api/v2/alerting/interactionstats/alerts/{alertId}',
|
|
3442
|
-
'PUT',
|
|
3443
|
-
{ 'alertId': alertId },
|
|
3444
|
-
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
3445
|
-
{ },
|
|
3446
|
-
{ },
|
|
3447
|
-
body,
|
|
3448
|
-
['PureCloud OAuth'],
|
|
3449
|
-
['application/json'],
|
|
3450
|
-
['application/json']
|
|
3451
|
-
);
|
|
3452
|
-
}
|
|
3453
|
-
|
|
3454
|
-
/**
|
|
3455
|
-
* Update an interaction stats rule
|
|
3456
|
-
* Apps should migrate to use PUT /api/v2/alerting/rules/{ruleId}.
|
|
3457
|
-
* @param {String} ruleId Rule ID
|
|
3458
|
-
* @param {Object} body AlertingRule
|
|
3459
|
-
* @param {Object} opts Optional parameters
|
|
3460
|
-
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
3461
|
-
* @deprecated
|
|
3462
|
-
*/
|
|
3463
|
-
putAlertingInteractionstatsRule(ruleId, body, opts) {
|
|
3464
|
-
opts = opts || {};
|
|
3465
|
-
|
|
3466
|
-
// verify the required parameter 'ruleId' is set
|
|
3467
|
-
if (ruleId === undefined || ruleId === null) {
|
|
3468
|
-
throw 'Missing the required parameter "ruleId" when calling putAlertingInteractionstatsRule';
|
|
3469
|
-
}
|
|
3470
|
-
// verify the required parameter 'body' is set
|
|
3471
|
-
if (body === undefined || body === null) {
|
|
3472
|
-
throw 'Missing the required parameter "body" when calling putAlertingInteractionstatsRule';
|
|
3473
|
-
}
|
|
3474
|
-
|
|
3475
|
-
return this.apiClient.callApi(
|
|
3476
|
-
'/api/v2/alerting/interactionstats/rules/{ruleId}',
|
|
3477
|
-
'PUT',
|
|
3478
|
-
{ 'ruleId': ruleId },
|
|
3479
|
-
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
3480
|
-
{ },
|
|
3481
|
-
{ },
|
|
3482
|
-
body,
|
|
3483
|
-
['PureCloud OAuth'],
|
|
3484
|
-
['application/json'],
|
|
3485
|
-
['application/json']
|
|
3486
|
-
);
|
|
3487
|
-
}
|
|
3488
|
-
|
|
3489
3185
|
/**
|
|
3490
3186
|
* Update a rule
|
|
3491
3187
|
*
|
|
@@ -3522,7 +3218,7 @@ class AnalyticsApi {
|
|
|
3522
3218
|
/**
|
|
3523
3219
|
* Analytics service.
|
|
3524
3220
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
3525
|
-
* @version
|
|
3221
|
+
* @version 217.0.0
|
|
3526
3222
|
*/
|
|
3527
3223
|
|
|
3528
3224
|
/**
|
|
@@ -4399,7 +4095,7 @@ class AnalyticsApi {
|
|
|
4399
4095
|
* @param {Number} opts.pageSize (default to 25)
|
|
4400
4096
|
* @param {Array.<String>} opts.id A list of user IDs to fetch by bulk
|
|
4401
4097
|
* @param {Object} opts.state Only list users of this state
|
|
4402
|
-
* @param {Boolean} opts.deletedOnly Only list deleted dashboards
|
|
4098
|
+
* @param {Boolean} opts.deletedOnly Only list users with deleted dashboards
|
|
4403
4099
|
*/
|
|
4404
4100
|
getAnalyticsReportingDashboardsUsers(opts) {
|
|
4405
4101
|
opts = opts || {};
|
|
@@ -6346,7 +6042,7 @@ class ArchitectApi {
|
|
|
6346
6042
|
/**
|
|
6347
6043
|
* Architect service.
|
|
6348
6044
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
6349
|
-
* @version
|
|
6045
|
+
* @version 217.0.0
|
|
6350
6046
|
*/
|
|
6351
6047
|
|
|
6352
6048
|
/**
|
|
@@ -7376,6 +7072,32 @@ class ArchitectApi {
|
|
|
7376
7072
|
);
|
|
7377
7073
|
}
|
|
7378
7074
|
|
|
7075
|
+
/**
|
|
7076
|
+
* Get an IVR IdentityResolutionConfig.
|
|
7077
|
+
*
|
|
7078
|
+
* @param {String} ivrId IVR id
|
|
7079
|
+
* getArchitectIvrIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7080
|
+
*/
|
|
7081
|
+
getArchitectIvrIdentityresolution(ivrId) {
|
|
7082
|
+
// verify the required parameter 'ivrId' is set
|
|
7083
|
+
if (ivrId === undefined || ivrId === null) {
|
|
7084
|
+
throw 'Missing the required parameter "ivrId" when calling getArchitectIvrIdentityresolution';
|
|
7085
|
+
}
|
|
7086
|
+
|
|
7087
|
+
return this.apiClient.callApi(
|
|
7088
|
+
'/api/v2/architect/ivrs/{ivrId}/identityresolution',
|
|
7089
|
+
'GET',
|
|
7090
|
+
{ 'ivrId': ivrId },
|
|
7091
|
+
{ },
|
|
7092
|
+
{ },
|
|
7093
|
+
{ },
|
|
7094
|
+
null,
|
|
7095
|
+
['PureCloud OAuth'],
|
|
7096
|
+
['application/json'],
|
|
7097
|
+
['application/json']
|
|
7098
|
+
);
|
|
7099
|
+
}
|
|
7100
|
+
|
|
7379
7101
|
/**
|
|
7380
7102
|
* Get IVR configs.
|
|
7381
7103
|
*
|
|
@@ -8650,6 +8372,35 @@ class ArchitectApi {
|
|
|
8650
8372
|
);
|
|
8651
8373
|
}
|
|
8652
8374
|
|
|
8375
|
+
/**
|
|
8376
|
+
* Fetch Architect Export Job Status
|
|
8377
|
+
*
|
|
8378
|
+
* @param {String} jobId Job ID
|
|
8379
|
+
* @param {Object} opts Optional parameters
|
|
8380
|
+
* @param {Array.<String>} opts.expand Which fields, if any, to expand.
|
|
8381
|
+
*/
|
|
8382
|
+
getFlowsExportJob(jobId, opts) {
|
|
8383
|
+
opts = opts || {};
|
|
8384
|
+
|
|
8385
|
+
// verify the required parameter 'jobId' is set
|
|
8386
|
+
if (jobId === undefined || jobId === null) {
|
|
8387
|
+
throw 'Missing the required parameter "jobId" when calling getFlowsExportJob';
|
|
8388
|
+
}
|
|
8389
|
+
|
|
8390
|
+
return this.apiClient.callApi(
|
|
8391
|
+
'/api/v2/flows/export/jobs/{jobId}',
|
|
8392
|
+
'GET',
|
|
8393
|
+
{ 'jobId': jobId },
|
|
8394
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
8395
|
+
{ },
|
|
8396
|
+
{ },
|
|
8397
|
+
null,
|
|
8398
|
+
['PureCloud OAuth'],
|
|
8399
|
+
['application/json'],
|
|
8400
|
+
['application/json']
|
|
8401
|
+
);
|
|
8402
|
+
}
|
|
8403
|
+
|
|
8653
8404
|
/**
|
|
8654
8405
|
* Start a process (job) to prepare a download of a singular flow execution data instance by Id
|
|
8655
8406
|
* 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.
|
|
@@ -9896,6 +9647,31 @@ class ArchitectApi {
|
|
|
9896
9647
|
);
|
|
9897
9648
|
}
|
|
9898
9649
|
|
|
9650
|
+
/**
|
|
9651
|
+
* Register Architect Export Job
|
|
9652
|
+
*
|
|
9653
|
+
* @param {Object} body
|
|
9654
|
+
*/
|
|
9655
|
+
postFlowsExportJobs(body) {
|
|
9656
|
+
// verify the required parameter 'body' is set
|
|
9657
|
+
if (body === undefined || body === null) {
|
|
9658
|
+
throw 'Missing the required parameter "body" when calling postFlowsExportJobs';
|
|
9659
|
+
}
|
|
9660
|
+
|
|
9661
|
+
return this.apiClient.callApi(
|
|
9662
|
+
'/api/v2/flows/export/jobs',
|
|
9663
|
+
'POST',
|
|
9664
|
+
{ },
|
|
9665
|
+
{ },
|
|
9666
|
+
{ },
|
|
9667
|
+
{ },
|
|
9668
|
+
body,
|
|
9669
|
+
['PureCloud OAuth'],
|
|
9670
|
+
['application/json'],
|
|
9671
|
+
['application/json']
|
|
9672
|
+
);
|
|
9673
|
+
}
|
|
9674
|
+
|
|
9899
9675
|
/**
|
|
9900
9676
|
* Start a process (job) that will prepare a list of execution data IDs for download.
|
|
9901
9677
|
* 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.
|
|
@@ -10083,6 +9859,37 @@ class ArchitectApi {
|
|
|
10083
9859
|
);
|
|
10084
9860
|
}
|
|
10085
9861
|
|
|
9862
|
+
/**
|
|
9863
|
+
* Update an IVR IdentityResolutionConfig.
|
|
9864
|
+
*
|
|
9865
|
+
* @param {String} ivrId IVR id
|
|
9866
|
+
* @param {Object} body
|
|
9867
|
+
* putArchitectIvrIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9868
|
+
*/
|
|
9869
|
+
putArchitectIvrIdentityresolution(ivrId, body) {
|
|
9870
|
+
// verify the required parameter 'ivrId' is set
|
|
9871
|
+
if (ivrId === undefined || ivrId === null) {
|
|
9872
|
+
throw 'Missing the required parameter "ivrId" when calling putArchitectIvrIdentityresolution';
|
|
9873
|
+
}
|
|
9874
|
+
// verify the required parameter 'body' is set
|
|
9875
|
+
if (body === undefined || body === null) {
|
|
9876
|
+
throw 'Missing the required parameter "body" when calling putArchitectIvrIdentityresolution';
|
|
9877
|
+
}
|
|
9878
|
+
|
|
9879
|
+
return this.apiClient.callApi(
|
|
9880
|
+
'/api/v2/architect/ivrs/{ivrId}/identityresolution',
|
|
9881
|
+
'PUT',
|
|
9882
|
+
{ 'ivrId': ivrId },
|
|
9883
|
+
{ },
|
|
9884
|
+
{ },
|
|
9885
|
+
{ },
|
|
9886
|
+
body,
|
|
9887
|
+
['PureCloud OAuth'],
|
|
9888
|
+
['application/json'],
|
|
9889
|
+
['application/json']
|
|
9890
|
+
);
|
|
9891
|
+
}
|
|
9892
|
+
|
|
10086
9893
|
/**
|
|
10087
9894
|
* Update specified user prompt
|
|
10088
9895
|
*
|
|
@@ -10468,7 +10275,7 @@ class AuditApi {
|
|
|
10468
10275
|
/**
|
|
10469
10276
|
* Audit service.
|
|
10470
10277
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
10471
|
-
* @version
|
|
10278
|
+
* @version 217.0.0
|
|
10472
10279
|
*/
|
|
10473
10280
|
|
|
10474
10281
|
/**
|
|
@@ -10669,7 +10476,7 @@ class AuthorizationApi {
|
|
|
10669
10476
|
/**
|
|
10670
10477
|
* Authorization service.
|
|
10671
10478
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
10672
|
-
* @version
|
|
10479
|
+
* @version 217.0.0
|
|
10673
10480
|
*/
|
|
10674
10481
|
|
|
10675
10482
|
/**
|
|
@@ -10689,7 +10496,7 @@ class AuthorizationApi {
|
|
|
10689
10496
|
*
|
|
10690
10497
|
* @param {String} divisionId Division ID
|
|
10691
10498
|
* @param {Object} opts Optional parameters
|
|
10692
|
-
* @param {Boolean} opts.force Force delete this division
|
|
10499
|
+
* @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)
|
|
10693
10500
|
*/
|
|
10694
10501
|
deleteAuthorizationDivision(divisionId, opts) {
|
|
10695
10502
|
opts = opts || {};
|
|
@@ -11664,16 +11471,17 @@ class AuthorizationApi {
|
|
|
11664
11471
|
* Recreate a previously deleted division.
|
|
11665
11472
|
*
|
|
11666
11473
|
* @param {String} divisionId Division ID
|
|
11667
|
-
* @param {Object}
|
|
11668
|
-
* @param {Object} opts.body Recreated division data
|
|
11474
|
+
* @param {Object} body Recreated division data
|
|
11669
11475
|
*/
|
|
11670
|
-
postAuthorizationDivisionRestore(divisionId,
|
|
11671
|
-
opts = opts || {};
|
|
11672
|
-
|
|
11476
|
+
postAuthorizationDivisionRestore(divisionId, body) {
|
|
11673
11477
|
// verify the required parameter 'divisionId' is set
|
|
11674
11478
|
if (divisionId === undefined || divisionId === null) {
|
|
11675
11479
|
throw 'Missing the required parameter "divisionId" when calling postAuthorizationDivisionRestore';
|
|
11676
11480
|
}
|
|
11481
|
+
// verify the required parameter 'body' is set
|
|
11482
|
+
if (body === undefined || body === null) {
|
|
11483
|
+
throw 'Missing the required parameter "body" when calling postAuthorizationDivisionRestore';
|
|
11484
|
+
}
|
|
11677
11485
|
|
|
11678
11486
|
return this.apiClient.callApi(
|
|
11679
11487
|
'/api/v2/authorization/divisions/{divisionId}/restore',
|
|
@@ -11682,7 +11490,7 @@ class AuthorizationApi {
|
|
|
11682
11490
|
{ },
|
|
11683
11491
|
{ },
|
|
11684
11492
|
{ },
|
|
11685
|
-
|
|
11493
|
+
body,
|
|
11686
11494
|
['PureCloud OAuth'],
|
|
11687
11495
|
['application/json'],
|
|
11688
11496
|
['application/json']
|
|
@@ -12330,7 +12138,7 @@ class BillingApi {
|
|
|
12330
12138
|
/**
|
|
12331
12139
|
* Billing service.
|
|
12332
12140
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
12333
|
-
* @version
|
|
12141
|
+
* @version 217.0.0
|
|
12334
12142
|
*/
|
|
12335
12143
|
|
|
12336
12144
|
/**
|
|
@@ -12410,7 +12218,7 @@ class CarrierServicesApi {
|
|
|
12410
12218
|
/**
|
|
12411
12219
|
* CarrierServices service.
|
|
12412
12220
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
12413
|
-
* @version
|
|
12221
|
+
* @version 217.0.0
|
|
12414
12222
|
*/
|
|
12415
12223
|
|
|
12416
12224
|
/**
|
|
@@ -12480,7 +12288,7 @@ class ChatApi {
|
|
|
12480
12288
|
/**
|
|
12481
12289
|
* Chat service.
|
|
12482
12290
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
12483
|
-
* @version
|
|
12291
|
+
* @version 217.0.0
|
|
12484
12292
|
*/
|
|
12485
12293
|
|
|
12486
12294
|
/**
|
|
@@ -12954,7 +12762,6 @@ class ChatApi {
|
|
|
12954
12762
|
* Get a user's chat settings
|
|
12955
12763
|
*
|
|
12956
12764
|
* @param {String} userId User ID
|
|
12957
|
-
* getChatsUserSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12958
12765
|
*/
|
|
12959
12766
|
getChatsUserSettings(userId) {
|
|
12960
12767
|
// verify the required parameter 'userId' is set
|
|
@@ -12979,7 +12786,6 @@ class ChatApi {
|
|
|
12979
12786
|
/**
|
|
12980
12787
|
* Get a user's chat settings
|
|
12981
12788
|
*
|
|
12982
|
-
* getChatsUsersMeSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12983
12789
|
*/
|
|
12984
12790
|
getChatsUsersMeSettings() {
|
|
12985
12791
|
|
|
@@ -13127,7 +12933,6 @@ class ChatApi {
|
|
|
13127
12933
|
*
|
|
13128
12934
|
* @param {String} userId User ID
|
|
13129
12935
|
* @param {Object} body
|
|
13130
|
-
* patchChatsUserSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13131
12936
|
*/
|
|
13132
12937
|
patchChatsUserSettings(userId, body) {
|
|
13133
12938
|
// verify the required parameter 'userId' is set
|
|
@@ -13157,7 +12962,6 @@ class ChatApi {
|
|
|
13157
12962
|
* Update a user's chat settings
|
|
13158
12963
|
*
|
|
13159
12964
|
* @param {Object} body
|
|
13160
|
-
* patchChatsUsersMeSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13161
12965
|
*/
|
|
13162
12966
|
patchChatsUsersMeSettings(body) {
|
|
13163
12967
|
// verify the required parameter 'body' is set
|
|
@@ -13416,7 +13220,7 @@ class CoachingApi {
|
|
|
13416
13220
|
/**
|
|
13417
13221
|
* Coaching service.
|
|
13418
13222
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
13419
|
-
* @version
|
|
13223
|
+
* @version 217.0.0
|
|
13420
13224
|
*/
|
|
13421
13225
|
|
|
13422
13226
|
/**
|
|
@@ -13993,7 +13797,7 @@ class ContentManagementApi {
|
|
|
13993
13797
|
/**
|
|
13994
13798
|
* ContentManagement service.
|
|
13995
13799
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
13996
|
-
* @version
|
|
13800
|
+
* @version 217.0.0
|
|
13997
13801
|
*/
|
|
13998
13802
|
|
|
13999
13803
|
/**
|
|
@@ -15074,7 +14878,7 @@ class ConversationsApi {
|
|
|
15074
14878
|
/**
|
|
15075
14879
|
* Conversations service.
|
|
15076
14880
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
15077
|
-
* @version
|
|
14881
|
+
* @version 217.0.0
|
|
15078
14882
|
*/
|
|
15079
14883
|
|
|
15080
14884
|
/**
|
|
@@ -17251,6 +17055,84 @@ class ConversationsApi {
|
|
|
17251
17055
|
);
|
|
17252
17056
|
}
|
|
17253
17057
|
|
|
17058
|
+
/**
|
|
17059
|
+
* Get Facebook messaging integration identity resolution settings
|
|
17060
|
+
*
|
|
17061
|
+
* @param {String} integrationId Integration ID
|
|
17062
|
+
* getConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17063
|
+
*/
|
|
17064
|
+
getConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId(integrationId) {
|
|
17065
|
+
// verify the required parameter 'integrationId' is set
|
|
17066
|
+
if (integrationId === undefined || integrationId === null) {
|
|
17067
|
+
throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId';
|
|
17068
|
+
}
|
|
17069
|
+
|
|
17070
|
+
return this.apiClient.callApi(
|
|
17071
|
+
'/api/v2/conversations/messaging/identityresolution/integrations/facebook/{integrationId}',
|
|
17072
|
+
'GET',
|
|
17073
|
+
{ 'integrationId': integrationId },
|
|
17074
|
+
{ },
|
|
17075
|
+
{ },
|
|
17076
|
+
{ },
|
|
17077
|
+
null,
|
|
17078
|
+
['PureCloud OAuth'],
|
|
17079
|
+
['application/json'],
|
|
17080
|
+
['application/json']
|
|
17081
|
+
);
|
|
17082
|
+
}
|
|
17083
|
+
|
|
17084
|
+
/**
|
|
17085
|
+
* Get an open messaging integration Identity Resolution settings
|
|
17086
|
+
*
|
|
17087
|
+
* @param {String} integrationId Integration ID
|
|
17088
|
+
* getConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17089
|
+
*/
|
|
17090
|
+
getConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId(integrationId) {
|
|
17091
|
+
// verify the required parameter 'integrationId' is set
|
|
17092
|
+
if (integrationId === undefined || integrationId === null) {
|
|
17093
|
+
throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId';
|
|
17094
|
+
}
|
|
17095
|
+
|
|
17096
|
+
return this.apiClient.callApi(
|
|
17097
|
+
'/api/v2/conversations/messaging/identityresolution/integrations/open/{integrationId}',
|
|
17098
|
+
'GET',
|
|
17099
|
+
{ 'integrationId': integrationId },
|
|
17100
|
+
{ },
|
|
17101
|
+
{ },
|
|
17102
|
+
{ },
|
|
17103
|
+
null,
|
|
17104
|
+
['PureCloud OAuth'],
|
|
17105
|
+
['application/json'],
|
|
17106
|
+
['application/json']
|
|
17107
|
+
);
|
|
17108
|
+
}
|
|
17109
|
+
|
|
17110
|
+
/**
|
|
17111
|
+
* Get a whatsApp integration Identity Resolution settings
|
|
17112
|
+
*
|
|
17113
|
+
* @param {String} integrationId Integration ID
|
|
17114
|
+
* getConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17115
|
+
*/
|
|
17116
|
+
getConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId(integrationId) {
|
|
17117
|
+
// verify the required parameter 'integrationId' is set
|
|
17118
|
+
if (integrationId === undefined || integrationId === null) {
|
|
17119
|
+
throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId';
|
|
17120
|
+
}
|
|
17121
|
+
|
|
17122
|
+
return this.apiClient.callApi(
|
|
17123
|
+
'/api/v2/conversations/messaging/identityresolution/integrations/whatsapp/{integrationId}',
|
|
17124
|
+
'GET',
|
|
17125
|
+
{ 'integrationId': integrationId },
|
|
17126
|
+
{ },
|
|
17127
|
+
{ },
|
|
17128
|
+
{ },
|
|
17129
|
+
null,
|
|
17130
|
+
['PureCloud OAuth'],
|
|
17131
|
+
['application/json'],
|
|
17132
|
+
['application/json']
|
|
17133
|
+
);
|
|
17134
|
+
}
|
|
17135
|
+
|
|
17254
17136
|
/**
|
|
17255
17137
|
* Get a list of Integrations
|
|
17256
17138
|
*
|
|
@@ -21916,9 +21798,10 @@ class ConversationsApi {
|
|
|
21916
21798
|
|
|
21917
21799
|
/**
|
|
21918
21800
|
* Update a conversation by setting its recording state
|
|
21919
|
-
*
|
|
21801
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
21920
21802
|
* @param {String} conversationId conversationId
|
|
21921
21803
|
* @param {Object} body SetRecordingState
|
|
21804
|
+
* @deprecated
|
|
21922
21805
|
*/
|
|
21923
21806
|
putConversationsCobrowsesessionRecordingstate(conversationId, body) {
|
|
21924
21807
|
// verify the required parameter 'conversationId' is set
|
|
@@ -22064,6 +21947,99 @@ class ConversationsApi {
|
|
|
22064
21947
|
);
|
|
22065
21948
|
}
|
|
22066
21949
|
|
|
21950
|
+
/**
|
|
21951
|
+
* Create an identity resolution settings for a Facebook messaging integration
|
|
21952
|
+
*
|
|
21953
|
+
* @param {String} integrationId Integration ID
|
|
21954
|
+
* @param {Object} body IdentityResolutionConfig
|
|
21955
|
+
* putConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21956
|
+
*/
|
|
21957
|
+
putConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId(integrationId, body) {
|
|
21958
|
+
// verify the required parameter 'integrationId' is set
|
|
21959
|
+
if (integrationId === undefined || integrationId === null) {
|
|
21960
|
+
throw 'Missing the required parameter "integrationId" when calling putConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId';
|
|
21961
|
+
}
|
|
21962
|
+
// verify the required parameter 'body' is set
|
|
21963
|
+
if (body === undefined || body === null) {
|
|
21964
|
+
throw 'Missing the required parameter "body" when calling putConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId';
|
|
21965
|
+
}
|
|
21966
|
+
|
|
21967
|
+
return this.apiClient.callApi(
|
|
21968
|
+
'/api/v2/conversations/messaging/identityresolution/integrations/facebook/{integrationId}',
|
|
21969
|
+
'PUT',
|
|
21970
|
+
{ 'integrationId': integrationId },
|
|
21971
|
+
{ },
|
|
21972
|
+
{ },
|
|
21973
|
+
{ },
|
|
21974
|
+
body,
|
|
21975
|
+
['PureCloud OAuth'],
|
|
21976
|
+
['application/json'],
|
|
21977
|
+
['application/json']
|
|
21978
|
+
);
|
|
21979
|
+
}
|
|
21980
|
+
|
|
21981
|
+
/**
|
|
21982
|
+
* Update an open messaging integration Identity Resolution settings
|
|
21983
|
+
*
|
|
21984
|
+
* @param {String} integrationId Integration ID
|
|
21985
|
+
* @param {Object} body
|
|
21986
|
+
* putConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21987
|
+
*/
|
|
21988
|
+
putConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId(integrationId, body) {
|
|
21989
|
+
// verify the required parameter 'integrationId' is set
|
|
21990
|
+
if (integrationId === undefined || integrationId === null) {
|
|
21991
|
+
throw 'Missing the required parameter "integrationId" when calling putConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId';
|
|
21992
|
+
}
|
|
21993
|
+
// verify the required parameter 'body' is set
|
|
21994
|
+
if (body === undefined || body === null) {
|
|
21995
|
+
throw 'Missing the required parameter "body" when calling putConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId';
|
|
21996
|
+
}
|
|
21997
|
+
|
|
21998
|
+
return this.apiClient.callApi(
|
|
21999
|
+
'/api/v2/conversations/messaging/identityresolution/integrations/open/{integrationId}',
|
|
22000
|
+
'PUT',
|
|
22001
|
+
{ 'integrationId': integrationId },
|
|
22002
|
+
{ },
|
|
22003
|
+
{ },
|
|
22004
|
+
{ },
|
|
22005
|
+
body,
|
|
22006
|
+
['PureCloud OAuth'],
|
|
22007
|
+
['application/json'],
|
|
22008
|
+
['application/json']
|
|
22009
|
+
);
|
|
22010
|
+
}
|
|
22011
|
+
|
|
22012
|
+
/**
|
|
22013
|
+
* Update a whatsApp integration Identity Resolution settings
|
|
22014
|
+
*
|
|
22015
|
+
* @param {String} integrationId Integration ID
|
|
22016
|
+
* @param {Object} body
|
|
22017
|
+
* putConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
22018
|
+
*/
|
|
22019
|
+
putConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId(integrationId, body) {
|
|
22020
|
+
// verify the required parameter 'integrationId' is set
|
|
22021
|
+
if (integrationId === undefined || integrationId === null) {
|
|
22022
|
+
throw 'Missing the required parameter "integrationId" when calling putConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId';
|
|
22023
|
+
}
|
|
22024
|
+
// verify the required parameter 'body' is set
|
|
22025
|
+
if (body === undefined || body === null) {
|
|
22026
|
+
throw 'Missing the required parameter "body" when calling putConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId';
|
|
22027
|
+
}
|
|
22028
|
+
|
|
22029
|
+
return this.apiClient.callApi(
|
|
22030
|
+
'/api/v2/conversations/messaging/identityresolution/integrations/whatsapp/{integrationId}',
|
|
22031
|
+
'PUT',
|
|
22032
|
+
{ 'integrationId': integrationId },
|
|
22033
|
+
{ },
|
|
22034
|
+
{ },
|
|
22035
|
+
{ },
|
|
22036
|
+
body,
|
|
22037
|
+
['PureCloud OAuth'],
|
|
22038
|
+
['application/json'],
|
|
22039
|
+
['application/json']
|
|
22040
|
+
);
|
|
22041
|
+
}
|
|
22042
|
+
|
|
22067
22043
|
/**
|
|
22068
22044
|
* Set the organization's default setting that may be applied to to integrations without settings
|
|
22069
22045
|
* 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.
|
|
@@ -22236,7 +22212,7 @@ class DataExtensionsApi {
|
|
|
22236
22212
|
/**
|
|
22237
22213
|
* DataExtensions service.
|
|
22238
22214
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
22239
|
-
* @version
|
|
22215
|
+
* @version 217.0.0
|
|
22240
22216
|
*/
|
|
22241
22217
|
|
|
22242
22218
|
/**
|
|
@@ -22322,7 +22298,7 @@ class DataPrivacyApi {
|
|
|
22322
22298
|
/**
|
|
22323
22299
|
* DataPrivacy service.
|
|
22324
22300
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
22325
|
-
* @version
|
|
22301
|
+
* @version 217.0.0
|
|
22326
22302
|
*/
|
|
22327
22303
|
|
|
22328
22304
|
/**
|
|
@@ -22492,7 +22468,7 @@ class DownloadsApi {
|
|
|
22492
22468
|
/**
|
|
22493
22469
|
* Downloads service.
|
|
22494
22470
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
22495
|
-
* @version
|
|
22471
|
+
* @version 217.0.0
|
|
22496
22472
|
*/
|
|
22497
22473
|
|
|
22498
22474
|
/**
|
|
@@ -22544,7 +22520,7 @@ class EmailsApi {
|
|
|
22544
22520
|
/**
|
|
22545
22521
|
* Emails service.
|
|
22546
22522
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
22547
|
-
* @version
|
|
22523
|
+
* @version 217.0.0
|
|
22548
22524
|
*/
|
|
22549
22525
|
|
|
22550
22526
|
/**
|
|
@@ -22609,7 +22585,7 @@ class EmployeeEngagementApi {
|
|
|
22609
22585
|
/**
|
|
22610
22586
|
* EmployeeEngagement service.
|
|
22611
22587
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
22612
|
-
* @version
|
|
22588
|
+
* @version 217.0.0
|
|
22613
22589
|
*/
|
|
22614
22590
|
|
|
22615
22591
|
/**
|
|
@@ -22760,7 +22736,7 @@ class EventsApi {
|
|
|
22760
22736
|
/**
|
|
22761
22737
|
* Events service.
|
|
22762
22738
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
22763
|
-
* @version
|
|
22739
|
+
* @version 217.0.0
|
|
22764
22740
|
*/
|
|
22765
22741
|
|
|
22766
22742
|
/**
|
|
@@ -22856,7 +22832,7 @@ class ExternalContactsApi {
|
|
|
22856
22832
|
/**
|
|
22857
22833
|
* ExternalContacts service.
|
|
22858
22834
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
22859
|
-
* @version
|
|
22835
|
+
* @version 217.0.0
|
|
22860
22836
|
*/
|
|
22861
22837
|
|
|
22862
22838
|
/**
|
|
@@ -23320,6 +23296,7 @@ class ExternalContactsApi {
|
|
|
23320
23296
|
* @param {String} opts.q User supplied search keywords (no special syntax is currently supported)
|
|
23321
23297
|
* @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
|
|
23322
23298
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
23299
|
+
* @param {Array.<String>} opts.divisionIds which divisions to search, up to 50
|
|
23323
23300
|
*/
|
|
23324
23301
|
getExternalcontactsContacts(opts) {
|
|
23325
23302
|
opts = opts || {};
|
|
@@ -23329,7 +23306,7 @@ class ExternalContactsApi {
|
|
|
23329
23306
|
'/api/v2/externalcontacts/contacts',
|
|
23330
23307
|
'GET',
|
|
23331
23308
|
{ },
|
|
23332
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'q': opts['q'],'sortOrder': opts['sortOrder'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
23309
|
+
{ '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') },
|
|
23333
23310
|
{ },
|
|
23334
23311
|
{ },
|
|
23335
23312
|
null,
|
|
@@ -23873,6 +23850,7 @@ class ExternalContactsApi {
|
|
|
23873
23850
|
* @param {String} opts.sortOrder The Organization field to sort by. Any of: [companyType, industry, name]. Direction: [asc, desc]. e.g. companyType:asc, industry:desc
|
|
23874
23851
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
23875
23852
|
* @param {Boolean} opts.includeTrustors (true or false) whether or not to include trustor information embedded in the externalOrganization
|
|
23853
|
+
* @param {Array.<String>} opts.divisionIds which divisions to search, up to 50
|
|
23876
23854
|
*/
|
|
23877
23855
|
getExternalcontactsOrganizations(opts) {
|
|
23878
23856
|
opts = opts || {};
|
|
@@ -23882,7 +23860,7 @@ class ExternalContactsApi {
|
|
|
23882
23860
|
'/api/v2/externalcontacts/organizations',
|
|
23883
23861
|
'GET',
|
|
23884
23862
|
{ },
|
|
23885
|
-
{ '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'] },
|
|
23863
|
+
{ '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') },
|
|
23886
23864
|
{ },
|
|
23887
23865
|
{ },
|
|
23888
23866
|
null,
|
|
@@ -24027,6 +24005,7 @@ class ExternalContactsApi {
|
|
|
24027
24005
|
* @param {String} lookupVal User supplied value to lookup contacts/externalOrganizations (supports email addresses, e164 phone numbers, Twitter screen names)
|
|
24028
24006
|
* @param {Object} opts Optional parameters
|
|
24029
24007
|
* @param {Array.<String>} opts.expand which field, if any, to expand
|
|
24008
|
+
* @param {String} opts.divisionId Specifies which division to lookup contacts/externalOrganizations in, for the given lookup value (default to *)
|
|
24030
24009
|
*/
|
|
24031
24010
|
getExternalcontactsReversewhitepageslookup(lookupVal, opts) {
|
|
24032
24011
|
opts = opts || {};
|
|
@@ -24040,7 +24019,7 @@ class ExternalContactsApi {
|
|
|
24040
24019
|
'/api/v2/externalcontacts/reversewhitepageslookup',
|
|
24041
24020
|
'GET',
|
|
24042
24021
|
{ },
|
|
24043
|
-
{ 'lookupVal': lookupVal,'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
24022
|
+
{ 'lookupVal': lookupVal,'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'divisionId': opts['divisionId'] },
|
|
24044
24023
|
{ },
|
|
24045
24024
|
{ },
|
|
24046
24025
|
null,
|
|
@@ -24056,6 +24035,7 @@ class ExternalContactsApi {
|
|
|
24056
24035
|
* @param {Object} opts Optional parameters
|
|
24057
24036
|
* @param {Number} opts.limit The number of contacts per page; must be between 10 and 200, default is 100
|
|
24058
24037
|
* @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
|
|
24038
|
+
* @param {String} opts.divisionId The division to scan over (default to *)
|
|
24059
24039
|
*/
|
|
24060
24040
|
getExternalcontactsScanContacts(opts) {
|
|
24061
24041
|
opts = opts || {};
|
|
@@ -24065,6 +24045,32 @@ class ExternalContactsApi {
|
|
|
24065
24045
|
'/api/v2/externalcontacts/scan/contacts',
|
|
24066
24046
|
'GET',
|
|
24067
24047
|
{ },
|
|
24048
|
+
{ 'limit': opts['limit'],'cursor': opts['cursor'],'divisionId': opts['divisionId'] },
|
|
24049
|
+
{ },
|
|
24050
|
+
{ },
|
|
24051
|
+
null,
|
|
24052
|
+
['PureCloud OAuth'],
|
|
24053
|
+
['application/json'],
|
|
24054
|
+
['application/json']
|
|
24055
|
+
);
|
|
24056
|
+
}
|
|
24057
|
+
|
|
24058
|
+
/**
|
|
24059
|
+
* Scan for external contacts using paging
|
|
24060
|
+
*
|
|
24061
|
+
* @param {Object} opts Optional parameters
|
|
24062
|
+
* @param {Number} opts.limit The number of contacts per page; must be between 10 and 200, default is 100
|
|
24063
|
+
* @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
|
|
24064
|
+
* getExternalcontactsScanContactsDivisionviewsAll is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24065
|
+
*/
|
|
24066
|
+
getExternalcontactsScanContactsDivisionviewsAll(opts) {
|
|
24067
|
+
opts = opts || {};
|
|
24068
|
+
|
|
24069
|
+
|
|
24070
|
+
return this.apiClient.callApi(
|
|
24071
|
+
'/api/v2/externalcontacts/scan/contacts/divisionviews/all',
|
|
24072
|
+
'GET',
|
|
24073
|
+
{ },
|
|
24068
24074
|
{ 'limit': opts['limit'],'cursor': opts['cursor'] },
|
|
24069
24075
|
{ },
|
|
24070
24076
|
{ },
|
|
@@ -24081,6 +24087,7 @@ class ExternalContactsApi {
|
|
|
24081
24087
|
* @param {Object} opts Optional parameters
|
|
24082
24088
|
* @param {Number} opts.limit The number of notes per page; must be between 10 and 200, default is 100
|
|
24083
24089
|
* @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
|
|
24090
|
+
* @param {String} opts.divisionId The division to scan over (default to *)
|
|
24084
24091
|
*/
|
|
24085
24092
|
getExternalcontactsScanNotes(opts) {
|
|
24086
24093
|
opts = opts || {};
|
|
@@ -24090,6 +24097,32 @@ class ExternalContactsApi {
|
|
|
24090
24097
|
'/api/v2/externalcontacts/scan/notes',
|
|
24091
24098
|
'GET',
|
|
24092
24099
|
{ },
|
|
24100
|
+
{ 'limit': opts['limit'],'cursor': opts['cursor'],'divisionId': opts['divisionId'] },
|
|
24101
|
+
{ },
|
|
24102
|
+
{ },
|
|
24103
|
+
null,
|
|
24104
|
+
['PureCloud OAuth'],
|
|
24105
|
+
['application/json'],
|
|
24106
|
+
['application/json']
|
|
24107
|
+
);
|
|
24108
|
+
}
|
|
24109
|
+
|
|
24110
|
+
/**
|
|
24111
|
+
* Scan for notes using paging
|
|
24112
|
+
*
|
|
24113
|
+
* @param {Object} opts Optional parameters
|
|
24114
|
+
* @param {Number} opts.limit The number of notes per page; must be between 10 and 200, default is 100
|
|
24115
|
+
* @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
|
|
24116
|
+
* getExternalcontactsScanNotesDivisionviewsAll is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24117
|
+
*/
|
|
24118
|
+
getExternalcontactsScanNotesDivisionviewsAll(opts) {
|
|
24119
|
+
opts = opts || {};
|
|
24120
|
+
|
|
24121
|
+
|
|
24122
|
+
return this.apiClient.callApi(
|
|
24123
|
+
'/api/v2/externalcontacts/scan/notes/divisionviews/all',
|
|
24124
|
+
'GET',
|
|
24125
|
+
{ },
|
|
24093
24126
|
{ 'limit': opts['limit'],'cursor': opts['cursor'] },
|
|
24094
24127
|
{ },
|
|
24095
24128
|
{ },
|
|
@@ -24106,6 +24139,7 @@ class ExternalContactsApi {
|
|
|
24106
24139
|
* @param {Object} opts Optional parameters
|
|
24107
24140
|
* @param {Number} opts.limit The number of organizations per page; must be between 10 and 200, default is 100
|
|
24108
24141
|
* @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
|
|
24142
|
+
* @param {String} opts.divisionId The division to scan over (default to *)
|
|
24109
24143
|
*/
|
|
24110
24144
|
getExternalcontactsScanOrganizations(opts) {
|
|
24111
24145
|
opts = opts || {};
|
|
@@ -24115,6 +24149,32 @@ class ExternalContactsApi {
|
|
|
24115
24149
|
'/api/v2/externalcontacts/scan/organizations',
|
|
24116
24150
|
'GET',
|
|
24117
24151
|
{ },
|
|
24152
|
+
{ 'limit': opts['limit'],'cursor': opts['cursor'],'divisionId': opts['divisionId'] },
|
|
24153
|
+
{ },
|
|
24154
|
+
{ },
|
|
24155
|
+
null,
|
|
24156
|
+
['PureCloud OAuth'],
|
|
24157
|
+
['application/json'],
|
|
24158
|
+
['application/json']
|
|
24159
|
+
);
|
|
24160
|
+
}
|
|
24161
|
+
|
|
24162
|
+
/**
|
|
24163
|
+
* Scan for external organizations using paging
|
|
24164
|
+
*
|
|
24165
|
+
* @param {Object} opts Optional parameters
|
|
24166
|
+
* @param {Number} opts.limit The number of organizations per page; must be between 10 and 200, default is 100
|
|
24167
|
+
* @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
|
|
24168
|
+
* getExternalcontactsScanOrganizationsDivisionviewsAll is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24169
|
+
*/
|
|
24170
|
+
getExternalcontactsScanOrganizationsDivisionviewsAll(opts) {
|
|
24171
|
+
opts = opts || {};
|
|
24172
|
+
|
|
24173
|
+
|
|
24174
|
+
return this.apiClient.callApi(
|
|
24175
|
+
'/api/v2/externalcontacts/scan/organizations/divisionviews/all',
|
|
24176
|
+
'GET',
|
|
24177
|
+
{ },
|
|
24118
24178
|
{ 'limit': opts['limit'],'cursor': opts['cursor'] },
|
|
24119
24179
|
{ },
|
|
24120
24180
|
{ },
|
|
@@ -24131,6 +24191,7 @@ class ExternalContactsApi {
|
|
|
24131
24191
|
* @param {Object} opts Optional parameters
|
|
24132
24192
|
* @param {Number} opts.limit The number of relationships per page; must be between 10 and 200, default is 100
|
|
24133
24193
|
* @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
|
|
24194
|
+
* @param {String} opts.divisionId The division to scan over (default to *)
|
|
24134
24195
|
*/
|
|
24135
24196
|
getExternalcontactsScanRelationships(opts) {
|
|
24136
24197
|
opts = opts || {};
|
|
@@ -24140,6 +24201,32 @@ class ExternalContactsApi {
|
|
|
24140
24201
|
'/api/v2/externalcontacts/scan/relationships',
|
|
24141
24202
|
'GET',
|
|
24142
24203
|
{ },
|
|
24204
|
+
{ 'limit': opts['limit'],'cursor': opts['cursor'],'divisionId': opts['divisionId'] },
|
|
24205
|
+
{ },
|
|
24206
|
+
{ },
|
|
24207
|
+
null,
|
|
24208
|
+
['PureCloud OAuth'],
|
|
24209
|
+
['application/json'],
|
|
24210
|
+
['application/json']
|
|
24211
|
+
);
|
|
24212
|
+
}
|
|
24213
|
+
|
|
24214
|
+
/**
|
|
24215
|
+
* Scan for relationships
|
|
24216
|
+
*
|
|
24217
|
+
* @param {Object} opts Optional parameters
|
|
24218
|
+
* @param {Number} opts.limit The number of relationships per page; must be between 10 and 200, default is 100
|
|
24219
|
+
* @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
|
|
24220
|
+
* getExternalcontactsScanRelationshipsDivisionviewsAll is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24221
|
+
*/
|
|
24222
|
+
getExternalcontactsScanRelationshipsDivisionviewsAll(opts) {
|
|
24223
|
+
opts = opts || {};
|
|
24224
|
+
|
|
24225
|
+
|
|
24226
|
+
return this.apiClient.callApi(
|
|
24227
|
+
'/api/v2/externalcontacts/scan/relationships/divisionviews/all',
|
|
24228
|
+
'GET',
|
|
24229
|
+
{ },
|
|
24143
24230
|
{ 'limit': opts['limit'],'cursor': opts['cursor'] },
|
|
24144
24231
|
{ },
|
|
24145
24232
|
{ },
|
|
@@ -24230,6 +24317,32 @@ class ExternalContactsApi {
|
|
|
24230
24317
|
);
|
|
24231
24318
|
}
|
|
24232
24319
|
|
|
24320
|
+
/**
|
|
24321
|
+
* Bulk fetch contacts across divisions
|
|
24322
|
+
*
|
|
24323
|
+
* @param {Object} body Contact ids
|
|
24324
|
+
* postExternalcontactsBulkContactsDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24325
|
+
*/
|
|
24326
|
+
postExternalcontactsBulkContactsDivisionviews(body) {
|
|
24327
|
+
// verify the required parameter 'body' is set
|
|
24328
|
+
if (body === undefined || body === null) {
|
|
24329
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsBulkContactsDivisionviews';
|
|
24330
|
+
}
|
|
24331
|
+
|
|
24332
|
+
return this.apiClient.callApi(
|
|
24333
|
+
'/api/v2/externalcontacts/bulk/contacts/divisionviews',
|
|
24334
|
+
'POST',
|
|
24335
|
+
{ },
|
|
24336
|
+
{ },
|
|
24337
|
+
{ },
|
|
24338
|
+
{ },
|
|
24339
|
+
body,
|
|
24340
|
+
['PureCloud OAuth'],
|
|
24341
|
+
['application/json'],
|
|
24342
|
+
['application/json']
|
|
24343
|
+
);
|
|
24344
|
+
}
|
|
24345
|
+
|
|
24233
24346
|
/**
|
|
24234
24347
|
* Bulk remove contacts
|
|
24235
24348
|
*
|
|
@@ -24455,6 +24568,32 @@ class ExternalContactsApi {
|
|
|
24455
24568
|
);
|
|
24456
24569
|
}
|
|
24457
24570
|
|
|
24571
|
+
/**
|
|
24572
|
+
* Bulk fetch organizations across divisions
|
|
24573
|
+
*
|
|
24574
|
+
* @param {Object} body Organizations ids
|
|
24575
|
+
* postExternalcontactsBulkOrganizationsDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24576
|
+
*/
|
|
24577
|
+
postExternalcontactsBulkOrganizationsDivisionviews(body) {
|
|
24578
|
+
// verify the required parameter 'body' is set
|
|
24579
|
+
if (body === undefined || body === null) {
|
|
24580
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsBulkOrganizationsDivisionviews';
|
|
24581
|
+
}
|
|
24582
|
+
|
|
24583
|
+
return this.apiClient.callApi(
|
|
24584
|
+
'/api/v2/externalcontacts/bulk/organizations/divisionviews',
|
|
24585
|
+
'POST',
|
|
24586
|
+
{ },
|
|
24587
|
+
{ },
|
|
24588
|
+
{ },
|
|
24589
|
+
{ },
|
|
24590
|
+
body,
|
|
24591
|
+
['PureCloud OAuth'],
|
|
24592
|
+
['application/json'],
|
|
24593
|
+
['application/json']
|
|
24594
|
+
);
|
|
24595
|
+
}
|
|
24596
|
+
|
|
24458
24597
|
/**
|
|
24459
24598
|
* Bulk remove organizations
|
|
24460
24599
|
*
|
|
@@ -25426,7 +25565,7 @@ class FaxApi {
|
|
|
25426
25565
|
/**
|
|
25427
25566
|
* Fax service.
|
|
25428
25567
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
25429
|
-
* @version
|
|
25568
|
+
* @version 217.0.0
|
|
25430
25569
|
*/
|
|
25431
25570
|
|
|
25432
25571
|
/**
|
|
@@ -25641,7 +25780,7 @@ class FlowsApi {
|
|
|
25641
25780
|
/**
|
|
25642
25781
|
* Flows service.
|
|
25643
25782
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
25644
|
-
* @version
|
|
25783
|
+
* @version 217.0.0
|
|
25645
25784
|
*/
|
|
25646
25785
|
|
|
25647
25786
|
/**
|
|
@@ -25824,7 +25963,7 @@ class GamificationApi {
|
|
|
25824
25963
|
/**
|
|
25825
25964
|
* Gamification service.
|
|
25826
25965
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
25827
|
-
* @version
|
|
25966
|
+
* @version 217.0.0
|
|
25828
25967
|
*/
|
|
25829
25968
|
|
|
25830
25969
|
/**
|
|
@@ -27966,7 +28105,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
27966
28105
|
/**
|
|
27967
28106
|
* GeneralDataProtectionRegulation service.
|
|
27968
28107
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
27969
|
-
* @version
|
|
28108
|
+
* @version 217.0.0
|
|
27970
28109
|
*/
|
|
27971
28110
|
|
|
27972
28111
|
/**
|
|
@@ -28096,7 +28235,7 @@ class GeolocationApi {
|
|
|
28096
28235
|
/**
|
|
28097
28236
|
* Geolocation service.
|
|
28098
28237
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
28099
|
-
* @version
|
|
28238
|
+
* @version 217.0.0
|
|
28100
28239
|
*/
|
|
28101
28240
|
|
|
28102
28241
|
/**
|
|
@@ -28227,7 +28366,7 @@ class GreetingsApi {
|
|
|
28227
28366
|
/**
|
|
28228
28367
|
* Greetings service.
|
|
28229
28368
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
28230
|
-
* @version
|
|
28369
|
+
* @version 217.0.0
|
|
28231
28370
|
*/
|
|
28232
28371
|
|
|
28233
28372
|
/**
|
|
@@ -28682,7 +28821,7 @@ class GroupsApi {
|
|
|
28682
28821
|
/**
|
|
28683
28822
|
* Groups service.
|
|
28684
28823
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
28685
|
-
* @version
|
|
28824
|
+
* @version 217.0.0
|
|
28686
28825
|
*/
|
|
28687
28826
|
|
|
28688
28827
|
/**
|
|
@@ -29201,7 +29340,7 @@ class IdentityProviderApi {
|
|
|
29201
29340
|
/**
|
|
29202
29341
|
* IdentityProvider service.
|
|
29203
29342
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
29204
|
-
* @version
|
|
29343
|
+
* @version 217.0.0
|
|
29205
29344
|
*/
|
|
29206
29345
|
|
|
29207
29346
|
/**
|
|
@@ -30062,7 +30201,7 @@ class InfrastructureAsCodeApi {
|
|
|
30062
30201
|
/**
|
|
30063
30202
|
* InfrastructureAsCode service.
|
|
30064
30203
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
30065
|
-
* @version
|
|
30204
|
+
* @version 217.0.0
|
|
30066
30205
|
*/
|
|
30067
30206
|
|
|
30068
30207
|
/**
|
|
@@ -30229,7 +30368,7 @@ class IntegrationsApi {
|
|
|
30229
30368
|
/**
|
|
30230
30369
|
* Integrations service.
|
|
30231
30370
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
30232
|
-
* @version
|
|
30371
|
+
* @version 217.0.0
|
|
30233
30372
|
*/
|
|
30234
30373
|
|
|
30235
30374
|
/**
|
|
@@ -30438,6 +30577,7 @@ class IntegrationsApi {
|
|
|
30438
30577
|
* @param {String} actionId actionId
|
|
30439
30578
|
* @param {Object} opts Optional parameters
|
|
30440
30579
|
* @param {Object} opts.expand Indicates a field in the response which should be expanded.
|
|
30580
|
+
* @param {Object} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
|
|
30441
30581
|
* @param {Object} opts.includeConfig Return config in response. (default to false)
|
|
30442
30582
|
*/
|
|
30443
30583
|
getIntegrationsAction(actionId, opts) {
|
|
@@ -30452,7 +30592,7 @@ class IntegrationsApi {
|
|
|
30452
30592
|
'/api/v2/integrations/actions/{actionId}',
|
|
30453
30593
|
'GET',
|
|
30454
30594
|
{ 'actionId': actionId },
|
|
30455
|
-
{ 'expand': opts['expand'],'includeConfig': opts['includeConfig'] },
|
|
30595
|
+
{ 'expand': opts['expand'],'flatten': opts['flatten'],'includeConfig': opts['includeConfig'] },
|
|
30456
30596
|
{ },
|
|
30457
30597
|
{ },
|
|
30458
30598
|
null,
|
|
@@ -30468,6 +30608,7 @@ class IntegrationsApi {
|
|
|
30468
30608
|
* @param {String} actionId actionId
|
|
30469
30609
|
* @param {Object} opts Optional parameters
|
|
30470
30610
|
* @param {Object} opts.expand Indicates a field in the response which should be expanded.
|
|
30611
|
+
* @param {Object} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
|
|
30471
30612
|
* @param {Object} opts.includeConfig Return config in response. (default to false)
|
|
30472
30613
|
*/
|
|
30473
30614
|
getIntegrationsActionDraft(actionId, opts) {
|
|
@@ -30482,7 +30623,7 @@ class IntegrationsApi {
|
|
|
30482
30623
|
'/api/v2/integrations/actions/{actionId}/draft',
|
|
30483
30624
|
'GET',
|
|
30484
30625
|
{ 'actionId': actionId },
|
|
30485
|
-
{ 'expand': opts['expand'],'includeConfig': opts['includeConfig'] },
|
|
30626
|
+
{ 'expand': opts['expand'],'flatten': opts['flatten'],'includeConfig': opts['includeConfig'] },
|
|
30486
30627
|
{ },
|
|
30487
30628
|
{ },
|
|
30488
30629
|
null,
|
|
@@ -32666,7 +32807,7 @@ class JourneyApi {
|
|
|
32666
32807
|
/**
|
|
32667
32808
|
* Journey service.
|
|
32668
32809
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
32669
|
-
* @version
|
|
32810
|
+
* @version 217.0.0
|
|
32670
32811
|
*/
|
|
32671
32812
|
|
|
32672
32813
|
/**
|
|
@@ -34651,7 +34792,7 @@ class KnowledgeApi {
|
|
|
34651
34792
|
/**
|
|
34652
34793
|
* Knowledge service.
|
|
34653
34794
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
34654
|
-
* @version
|
|
34795
|
+
* @version 217.0.0
|
|
34655
34796
|
*/
|
|
34656
34797
|
|
|
34657
34798
|
/**
|
|
@@ -36182,7 +36323,6 @@ class KnowledgeApi {
|
|
|
36182
36323
|
* @param {String} parseJobId Parse job ID
|
|
36183
36324
|
* @param {Object} opts Optional parameters
|
|
36184
36325
|
* @param {Array.<String>} opts.expand If expand contains 'urls' downloadURL and failedEntitiesURL will be filled.
|
|
36185
|
-
* getKnowledgeKnowledgebaseParseJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
36186
36326
|
*/
|
|
36187
36327
|
getKnowledgeKnowledgebaseParseJob(knowledgeBaseId, parseJobId, opts) {
|
|
36188
36328
|
opts = opts || {};
|
|
@@ -36452,7 +36592,6 @@ class KnowledgeApi {
|
|
|
36452
36592
|
*
|
|
36453
36593
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
36454
36594
|
* @param {String} jobId Upload job ID
|
|
36455
|
-
* getKnowledgeKnowledgebaseUploadsUrlsJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
36456
36595
|
*/
|
|
36457
36596
|
getKnowledgeKnowledgebaseUploadsUrlsJob(knowledgeBaseId, jobId) {
|
|
36458
36597
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -36993,7 +37132,6 @@ class KnowledgeApi {
|
|
|
36993
37132
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
36994
37133
|
* @param {String} parseJobId Parse job ID
|
|
36995
37134
|
* @param {Object} body
|
|
36996
|
-
* patchKnowledgeKnowledgebaseParseJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
36997
37135
|
*/
|
|
36998
37136
|
patchKnowledgeKnowledgebaseParseJob(knowledgeBaseId, parseJobId, body) {
|
|
36999
37137
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -38154,7 +38292,6 @@ class KnowledgeApi {
|
|
|
38154
38292
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
38155
38293
|
* @param {String} parseJobId Parse job ID
|
|
38156
38294
|
* @param {Object} body
|
|
38157
|
-
* postKnowledgeKnowledgebaseParseJobImport is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
38158
38295
|
*/
|
|
38159
38296
|
postKnowledgeKnowledgebaseParseJobImport(knowledgeBaseId, parseJobId, body) {
|
|
38160
38297
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -38189,7 +38326,6 @@ class KnowledgeApi {
|
|
|
38189
38326
|
*
|
|
38190
38327
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
38191
38328
|
* @param {Object} body
|
|
38192
|
-
* postKnowledgeKnowledgebaseParseJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
38193
38329
|
*/
|
|
38194
38330
|
postKnowledgeKnowledgebaseParseJobs(knowledgeBaseId, body) {
|
|
38195
38331
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -38280,8 +38416,12 @@ class KnowledgeApi {
|
|
|
38280
38416
|
*
|
|
38281
38417
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
38282
38418
|
* @param {String} sourceId Source ID
|
|
38419
|
+
* @param {Object} opts Optional parameters
|
|
38420
|
+
* @param {Object} opts.body
|
|
38283
38421
|
*/
|
|
38284
|
-
postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync(knowledgeBaseId, sourceId) {
|
|
38422
|
+
postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync(knowledgeBaseId, sourceId, opts) {
|
|
38423
|
+
opts = opts || {};
|
|
38424
|
+
|
|
38285
38425
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
38286
38426
|
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
38287
38427
|
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync';
|
|
@@ -38298,7 +38438,7 @@ class KnowledgeApi {
|
|
|
38298
38438
|
{ },
|
|
38299
38439
|
{ },
|
|
38300
38440
|
{ },
|
|
38301
|
-
|
|
38441
|
+
opts['body'],
|
|
38302
38442
|
['PureCloud OAuth'],
|
|
38303
38443
|
['application/json'],
|
|
38304
38444
|
['application/json']
|
|
@@ -38340,8 +38480,12 @@ class KnowledgeApi {
|
|
|
38340
38480
|
*
|
|
38341
38481
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
38342
38482
|
* @param {String} sourceId Source ID
|
|
38483
|
+
* @param {Object} opts Optional parameters
|
|
38484
|
+
* @param {Object} opts.body
|
|
38343
38485
|
*/
|
|
38344
|
-
postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync(knowledgeBaseId, sourceId) {
|
|
38486
|
+
postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync(knowledgeBaseId, sourceId, opts) {
|
|
38487
|
+
opts = opts || {};
|
|
38488
|
+
|
|
38345
38489
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
38346
38490
|
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
38347
38491
|
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync';
|
|
@@ -38358,7 +38502,7 @@ class KnowledgeApi {
|
|
|
38358
38502
|
{ },
|
|
38359
38503
|
{ },
|
|
38360
38504
|
{ },
|
|
38361
|
-
|
|
38505
|
+
opts['body'],
|
|
38362
38506
|
['PureCloud OAuth'],
|
|
38363
38507
|
['application/json'],
|
|
38364
38508
|
['application/json']
|
|
@@ -38400,7 +38544,6 @@ class KnowledgeApi {
|
|
|
38400
38544
|
*
|
|
38401
38545
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
38402
38546
|
* @param {Object} body uploadRequest
|
|
38403
|
-
* postKnowledgeKnowledgebaseUploadsUrlsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
38404
38547
|
*/
|
|
38405
38548
|
postKnowledgeKnowledgebaseUploadsUrlsJobs(knowledgeBaseId, body) {
|
|
38406
38549
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -38527,7 +38670,7 @@ class LanguageUnderstandingApi {
|
|
|
38527
38670
|
/**
|
|
38528
38671
|
* LanguageUnderstanding service.
|
|
38529
38672
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
38530
|
-
* @version
|
|
38673
|
+
* @version 217.0.0
|
|
38531
38674
|
*/
|
|
38532
38675
|
|
|
38533
38676
|
/**
|
|
@@ -39560,7 +39703,7 @@ class LanguagesApi {
|
|
|
39560
39703
|
/**
|
|
39561
39704
|
* Languages service.
|
|
39562
39705
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
39563
|
-
* @version
|
|
39706
|
+
* @version 217.0.0
|
|
39564
39707
|
*/
|
|
39565
39708
|
|
|
39566
39709
|
/**
|
|
@@ -39782,7 +39925,7 @@ class LearningApi {
|
|
|
39782
39925
|
/**
|
|
39783
39926
|
* Learning service.
|
|
39784
39927
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
39785
|
-
* @version
|
|
39928
|
+
* @version 217.0.0
|
|
39786
39929
|
*/
|
|
39787
39930
|
|
|
39788
39931
|
/**
|
|
@@ -40811,7 +40954,7 @@ class LicenseApi {
|
|
|
40811
40954
|
/**
|
|
40812
40955
|
* License service.
|
|
40813
40956
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
40814
|
-
* @version
|
|
40957
|
+
* @version 217.0.0
|
|
40815
40958
|
*/
|
|
40816
40959
|
|
|
40817
40960
|
/**
|
|
@@ -41049,7 +41192,7 @@ class LocationsApi {
|
|
|
41049
41192
|
/**
|
|
41050
41193
|
* Locations service.
|
|
41051
41194
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
41052
|
-
* @version
|
|
41195
|
+
* @version 217.0.0
|
|
41053
41196
|
*/
|
|
41054
41197
|
|
|
41055
41198
|
/**
|
|
@@ -41285,7 +41428,7 @@ class LogCaptureApi {
|
|
|
41285
41428
|
/**
|
|
41286
41429
|
* LogCapture service.
|
|
41287
41430
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
41288
|
-
* @version
|
|
41431
|
+
* @version 217.0.0
|
|
41289
41432
|
*/
|
|
41290
41433
|
|
|
41291
41434
|
/**
|
|
@@ -41485,7 +41628,7 @@ class MessagingApi {
|
|
|
41485
41628
|
/**
|
|
41486
41629
|
* Messaging service.
|
|
41487
41630
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
41488
|
-
* @version
|
|
41631
|
+
* @version 217.0.0
|
|
41489
41632
|
*/
|
|
41490
41633
|
|
|
41491
41634
|
/**
|
|
@@ -41844,7 +41987,7 @@ class MobileDevicesApi {
|
|
|
41844
41987
|
/**
|
|
41845
41988
|
* MobileDevices service.
|
|
41846
41989
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
41847
|
-
* @version
|
|
41990
|
+
* @version 217.0.0
|
|
41848
41991
|
*/
|
|
41849
41992
|
|
|
41850
41993
|
/**
|
|
@@ -41995,7 +42138,7 @@ class NotificationsApi {
|
|
|
41995
42138
|
/**
|
|
41996
42139
|
* Notifications service.
|
|
41997
42140
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
41998
|
-
* @version
|
|
42141
|
+
* @version 217.0.0
|
|
41999
42142
|
*/
|
|
42000
42143
|
|
|
42001
42144
|
/**
|
|
@@ -42228,7 +42371,7 @@ class OAuthApi {
|
|
|
42228
42371
|
/**
|
|
42229
42372
|
* OAuth service.
|
|
42230
42373
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
42231
|
-
* @version
|
|
42374
|
+
* @version 217.0.0
|
|
42232
42375
|
*/
|
|
42233
42376
|
|
|
42234
42377
|
/**
|
|
@@ -42594,7 +42737,7 @@ class ObjectsApi {
|
|
|
42594
42737
|
/**
|
|
42595
42738
|
* Objects service.
|
|
42596
42739
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
42597
|
-
* @version
|
|
42740
|
+
* @version 217.0.0
|
|
42598
42741
|
*/
|
|
42599
42742
|
|
|
42600
42743
|
/**
|
|
@@ -42614,7 +42757,7 @@ class ObjectsApi {
|
|
|
42614
42757
|
*
|
|
42615
42758
|
* @param {String} divisionId Division ID
|
|
42616
42759
|
* @param {Object} opts Optional parameters
|
|
42617
|
-
* @param {Boolean} opts.force Force delete this division
|
|
42760
|
+
* @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)
|
|
42618
42761
|
*/
|
|
42619
42762
|
deleteAuthorizationDivision(divisionId, opts) {
|
|
42620
42763
|
opts = opts || {};
|
|
@@ -42778,16 +42921,17 @@ class ObjectsApi {
|
|
|
42778
42921
|
* Recreate a previously deleted division.
|
|
42779
42922
|
*
|
|
42780
42923
|
* @param {String} divisionId Division ID
|
|
42781
|
-
* @param {Object}
|
|
42782
|
-
* @param {Object} opts.body Recreated division data
|
|
42924
|
+
* @param {Object} body Recreated division data
|
|
42783
42925
|
*/
|
|
42784
|
-
postAuthorizationDivisionRestore(divisionId,
|
|
42785
|
-
opts = opts || {};
|
|
42786
|
-
|
|
42926
|
+
postAuthorizationDivisionRestore(divisionId, body) {
|
|
42787
42927
|
// verify the required parameter 'divisionId' is set
|
|
42788
42928
|
if (divisionId === undefined || divisionId === null) {
|
|
42789
42929
|
throw 'Missing the required parameter "divisionId" when calling postAuthorizationDivisionRestore';
|
|
42790
42930
|
}
|
|
42931
|
+
// verify the required parameter 'body' is set
|
|
42932
|
+
if (body === undefined || body === null) {
|
|
42933
|
+
throw 'Missing the required parameter "body" when calling postAuthorizationDivisionRestore';
|
|
42934
|
+
}
|
|
42791
42935
|
|
|
42792
42936
|
return this.apiClient.callApi(
|
|
42793
42937
|
'/api/v2/authorization/divisions/{divisionId}/restore',
|
|
@@ -42796,7 +42940,7 @@ class ObjectsApi {
|
|
|
42796
42940
|
{ },
|
|
42797
42941
|
{ },
|
|
42798
42942
|
{ },
|
|
42799
|
-
|
|
42943
|
+
body,
|
|
42800
42944
|
['PureCloud OAuth'],
|
|
42801
42945
|
['application/json'],
|
|
42802
42946
|
['application/json']
|
|
@@ -42864,7 +43008,7 @@ class OperationalEventsApi {
|
|
|
42864
43008
|
/**
|
|
42865
43009
|
* OperationalEvents service.
|
|
42866
43010
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
42867
|
-
* @version
|
|
43011
|
+
* @version 217.0.0
|
|
42868
43012
|
*/
|
|
42869
43013
|
|
|
42870
43014
|
/**
|
|
@@ -42981,7 +43125,7 @@ class OrganizationApi {
|
|
|
42981
43125
|
/**
|
|
42982
43126
|
* Organization service.
|
|
42983
43127
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
42984
|
-
* @version
|
|
43128
|
+
* @version 217.0.0
|
|
42985
43129
|
*/
|
|
42986
43130
|
|
|
42987
43131
|
/**
|
|
@@ -43210,6 +43354,7 @@ class OrganizationApi {
|
|
|
43210
43354
|
* @param {String} opts.cursor Cursor provided when retrieving the last page
|
|
43211
43355
|
* @param {String} opts.entityId entity id of the count
|
|
43212
43356
|
* @param {String} opts.userId userid of the count
|
|
43357
|
+
* @deprecated
|
|
43213
43358
|
*/
|
|
43214
43359
|
getOrganizationsLimitsNamespaceCounts(namespaceName, opts) {
|
|
43215
43360
|
opts = opts || {};
|
|
@@ -43267,6 +43412,7 @@ class OrganizationApi {
|
|
|
43267
43412
|
* @param {String} opts.entityId entity id of the count
|
|
43268
43413
|
* @param {String} opts.userId userid of the count
|
|
43269
43414
|
* @param {String} opts.cursor Cursor provided when retrieving the last page
|
|
43415
|
+
* @deprecated
|
|
43270
43416
|
*/
|
|
43271
43417
|
getOrganizationsLimitsNamespaceLimitCounts(namespaceName, limitName, opts) {
|
|
43272
43418
|
opts = opts || {};
|
|
@@ -43523,7 +43669,7 @@ class OrganizationAuthorizationApi {
|
|
|
43523
43669
|
/**
|
|
43524
43670
|
* OrganizationAuthorization service.
|
|
43525
43671
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
43526
|
-
* @version
|
|
43672
|
+
* @version 217.0.0
|
|
43527
43673
|
*/
|
|
43528
43674
|
|
|
43529
43675
|
/**
|
|
@@ -44917,7 +45063,7 @@ class OutboundApi {
|
|
|
44917
45063
|
/**
|
|
44918
45064
|
* Outbound service.
|
|
44919
45065
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
44920
|
-
* @version
|
|
45066
|
+
* @version 217.0.0
|
|
44921
45067
|
*/
|
|
44922
45068
|
|
|
44923
45069
|
/**
|
|
@@ -47746,8 +47892,12 @@ class OutboundApi {
|
|
|
47746
47892
|
* Update the outbound settings for this organization
|
|
47747
47893
|
*
|
|
47748
47894
|
* @param {Object} body outboundSettings
|
|
47895
|
+
* @param {Object} opts Optional parameters
|
|
47896
|
+
* @param {Object} opts.useMaxCallsPerAgentDecimal Use maxCallsPerAgent with decimal precision
|
|
47749
47897
|
*/
|
|
47750
|
-
patchOutboundSettings(body) {
|
|
47898
|
+
patchOutboundSettings(body, opts) {
|
|
47899
|
+
opts = opts || {};
|
|
47900
|
+
|
|
47751
47901
|
// verify the required parameter 'body' is set
|
|
47752
47902
|
if (body === undefined || body === null) {
|
|
47753
47903
|
throw 'Missing the required parameter "body" when calling patchOutboundSettings';
|
|
@@ -47757,7 +47907,7 @@ class OutboundApi {
|
|
|
47757
47907
|
'/api/v2/outbound/settings',
|
|
47758
47908
|
'PATCH',
|
|
47759
47909
|
{ },
|
|
47760
|
-
{
|
|
47910
|
+
{ 'useMaxCallsPerAgentDecimal': opts['useMaxCallsPerAgentDecimal'] },
|
|
47761
47911
|
{ },
|
|
47762
47912
|
{ },
|
|
47763
47913
|
body,
|
|
@@ -47977,8 +48127,12 @@ class OutboundApi {
|
|
|
47977
48127
|
* Create a campaign.
|
|
47978
48128
|
*
|
|
47979
48129
|
* @param {Object} body Campaign
|
|
48130
|
+
* @param {Object} opts Optional parameters
|
|
48131
|
+
* @param {Object} opts.useMaxCallsPerAgentDecimal Use maxCallsPerAgent with decimal precision
|
|
47980
48132
|
*/
|
|
47981
|
-
postOutboundCampaigns(body) {
|
|
48133
|
+
postOutboundCampaigns(body, opts) {
|
|
48134
|
+
opts = opts || {};
|
|
48135
|
+
|
|
47982
48136
|
// verify the required parameter 'body' is set
|
|
47983
48137
|
if (body === undefined || body === null) {
|
|
47984
48138
|
throw 'Missing the required parameter "body" when calling postOutboundCampaigns';
|
|
@@ -47988,7 +48142,7 @@ class OutboundApi {
|
|
|
47988
48142
|
'/api/v2/outbound/campaigns',
|
|
47989
48143
|
'POST',
|
|
47990
48144
|
{ },
|
|
47991
|
-
{
|
|
48145
|
+
{ 'useMaxCallsPerAgentDecimal': opts['useMaxCallsPerAgentDecimal'] },
|
|
47992
48146
|
{ },
|
|
47993
48147
|
{ },
|
|
47994
48148
|
body,
|
|
@@ -48892,8 +49046,12 @@ class OutboundApi {
|
|
|
48892
49046
|
*
|
|
48893
49047
|
* @param {String} campaignId Campaign ID
|
|
48894
49048
|
* @param {Object} body Campaign
|
|
49049
|
+
* @param {Object} opts Optional parameters
|
|
49050
|
+
* @param {Object} opts.useMaxCallsPerAgentDecimal Use maxCallsPerAgent with decimal precision
|
|
48895
49051
|
*/
|
|
48896
|
-
putOutboundCampaign(campaignId, body) {
|
|
49052
|
+
putOutboundCampaign(campaignId, body, opts) {
|
|
49053
|
+
opts = opts || {};
|
|
49054
|
+
|
|
48897
49055
|
// verify the required parameter 'campaignId' is set
|
|
48898
49056
|
if (campaignId === undefined || campaignId === null) {
|
|
48899
49057
|
throw 'Missing the required parameter "campaignId" when calling putOutboundCampaign';
|
|
@@ -48907,7 +49065,7 @@ class OutboundApi {
|
|
|
48907
49065
|
'/api/v2/outbound/campaigns/{campaignId}',
|
|
48908
49066
|
'PUT',
|
|
48909
49067
|
{ 'campaignId': campaignId },
|
|
48910
|
-
{
|
|
49068
|
+
{ 'useMaxCallsPerAgentDecimal': opts['useMaxCallsPerAgentDecimal'] },
|
|
48911
49069
|
{ },
|
|
48912
49070
|
{ },
|
|
48913
49071
|
body,
|
|
@@ -49468,7 +49626,7 @@ class PresenceApi {
|
|
|
49468
49626
|
/**
|
|
49469
49627
|
* Presence service.
|
|
49470
49628
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
49471
|
-
* @version
|
|
49629
|
+
* @version 217.0.0
|
|
49472
49630
|
*/
|
|
49473
49631
|
|
|
49474
49632
|
/**
|
|
@@ -50212,7 +50370,7 @@ class ProcessAutomationApi {
|
|
|
50212
50370
|
/**
|
|
50213
50371
|
* ProcessAutomation service.
|
|
50214
50372
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
50215
|
-
* @version
|
|
50373
|
+
* @version 217.0.0
|
|
50216
50374
|
*/
|
|
50217
50375
|
|
|
50218
50376
|
/**
|
|
@@ -50451,7 +50609,7 @@ class QualityApi {
|
|
|
50451
50609
|
/**
|
|
50452
50610
|
* Quality service.
|
|
50453
50611
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
50454
|
-
* @version
|
|
50612
|
+
* @version 217.0.0
|
|
50455
50613
|
*/
|
|
50456
50614
|
|
|
50457
50615
|
/**
|
|
@@ -52239,7 +52397,7 @@ class RecordingApi {
|
|
|
52239
52397
|
/**
|
|
52240
52398
|
* Recording service.
|
|
52241
52399
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
52242
|
-
* @version
|
|
52400
|
+
* @version 217.0.0
|
|
52243
52401
|
*/
|
|
52244
52402
|
|
|
52245
52403
|
/**
|
|
@@ -52451,7 +52609,7 @@ class RecordingApi {
|
|
|
52451
52609
|
* @param {Object} opts.messageFormatId The desired media format when downloading a message recording. Valid values:ZIP,NONE (default to ZIP)
|
|
52452
52610
|
* @param {Object} opts.download requesting a download format of the recording. Valid values:true,false (default to false)
|
|
52453
52611
|
* @param {String} opts.fileName the name of the downloaded fileName
|
|
52454
|
-
* @param {String} opts.locale The locale for the requested file when downloading, as an ISO 639-1 code
|
|
52612
|
+
* @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
|
|
52455
52613
|
* @param {Array.<String>} opts.mediaFormats All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3
|
|
52456
52614
|
*/
|
|
52457
52615
|
getConversationRecording(conversationId, recordingId, opts) {
|
|
@@ -52608,6 +52766,7 @@ class RecordingApi {
|
|
|
52608
52766
|
* @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)
|
|
52609
52767
|
* @param {Object} opts.formatId The desired media format. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE. (default to WEBM)
|
|
52610
52768
|
* @param {Array.<String>} opts.mediaFormats All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3.
|
|
52769
|
+
* @param {String} opts.locale The locale used for redacting sensitive information in requested files, as an ISO 639-1 code
|
|
52611
52770
|
*/
|
|
52612
52771
|
getConversationRecordings(conversationId, opts) {
|
|
52613
52772
|
opts = opts || {};
|
|
@@ -52621,7 +52780,7 @@ class RecordingApi {
|
|
|
52621
52780
|
'/api/v2/conversations/{conversationId}/recordings',
|
|
52622
52781
|
'GET',
|
|
52623
52782
|
{ 'conversationId': conversationId },
|
|
52624
|
-
{ 'maxWaitMs': opts['maxWaitMs'],'formatId': opts['formatId'],'mediaFormats': this.apiClient.buildCollectionParam(opts['mediaFormats'], 'multi') },
|
|
52783
|
+
{ 'maxWaitMs': opts['maxWaitMs'],'formatId': opts['formatId'],'mediaFormats': this.apiClient.buildCollectionParam(opts['mediaFormats'], 'multi'),'locale': opts['locale'] },
|
|
52625
52784
|
{ },
|
|
52626
52785
|
{ },
|
|
52627
52786
|
null,
|
|
@@ -53123,32 +53282,6 @@ class RecordingApi {
|
|
|
53123
53282
|
);
|
|
53124
53283
|
}
|
|
53125
53284
|
|
|
53126
|
-
/**
|
|
53127
|
-
* Retrieves a paged listing of screen recording sessions
|
|
53128
|
-
* Coming soon: This API is deprecated and will be replaced by /api/v2/recordings/screensessions/details
|
|
53129
|
-
* @param {Object} opts Optional parameters
|
|
53130
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
53131
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
53132
|
-
* @deprecated
|
|
53133
|
-
*/
|
|
53134
|
-
getRecordingsScreensessions(opts) {
|
|
53135
|
-
opts = opts || {};
|
|
53136
|
-
|
|
53137
|
-
|
|
53138
|
-
return this.apiClient.callApi(
|
|
53139
|
-
'/api/v2/recordings/screensessions',
|
|
53140
|
-
'GET',
|
|
53141
|
-
{ },
|
|
53142
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
53143
|
-
{ },
|
|
53144
|
-
{ },
|
|
53145
|
-
null,
|
|
53146
|
-
['PureCloud OAuth'],
|
|
53147
|
-
['application/json'],
|
|
53148
|
-
['application/json']
|
|
53149
|
-
);
|
|
53150
|
-
}
|
|
53151
|
-
|
|
53152
53285
|
/**
|
|
53153
53286
|
* Retrieves an object containing the total number of concurrent active screen recordings
|
|
53154
53287
|
*
|
|
@@ -53868,7 +54001,7 @@ class ResponseManagementApi {
|
|
|
53868
54001
|
/**
|
|
53869
54002
|
* ResponseManagement service.
|
|
53870
54003
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
53871
|
-
* @version
|
|
54004
|
+
* @version 217.0.0
|
|
53872
54005
|
*/
|
|
53873
54006
|
|
|
53874
54007
|
/**
|
|
@@ -54378,7 +54511,7 @@ class RoutingApi {
|
|
|
54378
54511
|
/**
|
|
54379
54512
|
* Routing service.
|
|
54380
54513
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
54381
|
-
* @version
|
|
54514
|
+
* @version 217.0.0
|
|
54382
54515
|
*/
|
|
54383
54516
|
|
|
54384
54517
|
/**
|
|
@@ -55219,6 +55352,37 @@ class RoutingApi {
|
|
|
55219
55352
|
);
|
|
55220
55353
|
}
|
|
55221
55354
|
|
|
55355
|
+
/**
|
|
55356
|
+
* Get a route identity resolution setting.
|
|
55357
|
+
*
|
|
55358
|
+
* @param {String} domainName email domain
|
|
55359
|
+
* @param {String} routeId route ID
|
|
55360
|
+
* getRoutingEmailDomainRouteIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
55361
|
+
*/
|
|
55362
|
+
getRoutingEmailDomainRouteIdentityresolution(domainName, routeId) {
|
|
55363
|
+
// verify the required parameter 'domainName' is set
|
|
55364
|
+
if (domainName === undefined || domainName === null) {
|
|
55365
|
+
throw 'Missing the required parameter "domainName" when calling getRoutingEmailDomainRouteIdentityresolution';
|
|
55366
|
+
}
|
|
55367
|
+
// verify the required parameter 'routeId' is set
|
|
55368
|
+
if (routeId === undefined || routeId === null) {
|
|
55369
|
+
throw 'Missing the required parameter "routeId" when calling getRoutingEmailDomainRouteIdentityresolution';
|
|
55370
|
+
}
|
|
55371
|
+
|
|
55372
|
+
return this.apiClient.callApi(
|
|
55373
|
+
'/api/v2/routing/email/domains/{domainName}/routes/{routeId}/identityresolution',
|
|
55374
|
+
'GET',
|
|
55375
|
+
{ 'domainName': domainName,'routeId': routeId },
|
|
55376
|
+
{ },
|
|
55377
|
+
{ },
|
|
55378
|
+
{ },
|
|
55379
|
+
null,
|
|
55380
|
+
['PureCloud OAuth'],
|
|
55381
|
+
['application/json'],
|
|
55382
|
+
['application/json']
|
|
55383
|
+
);
|
|
55384
|
+
}
|
|
55385
|
+
|
|
55222
55386
|
/**
|
|
55223
55387
|
* Get routes
|
|
55224
55388
|
*
|
|
@@ -55772,6 +55936,32 @@ class RoutingApi {
|
|
|
55772
55936
|
);
|
|
55773
55937
|
}
|
|
55774
55938
|
|
|
55939
|
+
/**
|
|
55940
|
+
* Get Queue IdentityResolution Settings.
|
|
55941
|
+
*
|
|
55942
|
+
* @param {String} queueId Queue ID
|
|
55943
|
+
* getRoutingQueueIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
55944
|
+
*/
|
|
55945
|
+
getRoutingQueueIdentityresolution(queueId) {
|
|
55946
|
+
// verify the required parameter 'queueId' is set
|
|
55947
|
+
if (queueId === undefined || queueId === null) {
|
|
55948
|
+
throw 'Missing the required parameter "queueId" when calling getRoutingQueueIdentityresolution';
|
|
55949
|
+
}
|
|
55950
|
+
|
|
55951
|
+
return this.apiClient.callApi(
|
|
55952
|
+
'/api/v2/routing/queues/{queueId}/identityresolution',
|
|
55953
|
+
'GET',
|
|
55954
|
+
{ 'queueId': queueId },
|
|
55955
|
+
{ },
|
|
55956
|
+
{ },
|
|
55957
|
+
{ },
|
|
55958
|
+
null,
|
|
55959
|
+
['PureCloud OAuth'],
|
|
55960
|
+
['application/json'],
|
|
55961
|
+
['application/json']
|
|
55962
|
+
);
|
|
55963
|
+
}
|
|
55964
|
+
|
|
55775
55965
|
/**
|
|
55776
55966
|
* Get Estimated Wait Time
|
|
55777
55967
|
*
|
|
@@ -56344,6 +56534,32 @@ class RoutingApi {
|
|
|
56344
56534
|
);
|
|
56345
56535
|
}
|
|
56346
56536
|
|
|
56537
|
+
/**
|
|
56538
|
+
* Get a SMS identity resolution settings.
|
|
56539
|
+
*
|
|
56540
|
+
* @param {String} addressId Address ID
|
|
56541
|
+
* getRoutingSmsIdentityresolutionPhonenumber is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
56542
|
+
*/
|
|
56543
|
+
getRoutingSmsIdentityresolutionPhonenumber(addressId) {
|
|
56544
|
+
// verify the required parameter 'addressId' is set
|
|
56545
|
+
if (addressId === undefined || addressId === null) {
|
|
56546
|
+
throw 'Missing the required parameter "addressId" when calling getRoutingSmsIdentityresolutionPhonenumber';
|
|
56547
|
+
}
|
|
56548
|
+
|
|
56549
|
+
return this.apiClient.callApi(
|
|
56550
|
+
'/api/v2/routing/sms/identityresolution/phonenumbers/{addressId}',
|
|
56551
|
+
'GET',
|
|
56552
|
+
{ 'addressId': addressId },
|
|
56553
|
+
{ },
|
|
56554
|
+
{ },
|
|
56555
|
+
{ },
|
|
56556
|
+
null,
|
|
56557
|
+
['PureCloud OAuth'],
|
|
56558
|
+
['application/json'],
|
|
56559
|
+
['application/json']
|
|
56560
|
+
);
|
|
56561
|
+
}
|
|
56562
|
+
|
|
56347
56563
|
/**
|
|
56348
56564
|
* Get a phone number provisioned for SMS.
|
|
56349
56565
|
*
|
|
@@ -58149,6 +58365,42 @@ class RoutingApi {
|
|
|
58149
58365
|
);
|
|
58150
58366
|
}
|
|
58151
58367
|
|
|
58368
|
+
/**
|
|
58369
|
+
* Update identity resolution settings for a route.
|
|
58370
|
+
*
|
|
58371
|
+
* @param {String} domainName email domain
|
|
58372
|
+
* @param {String} routeId route ID
|
|
58373
|
+
* @param {Object} body
|
|
58374
|
+
* putRoutingEmailDomainRouteIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58375
|
+
*/
|
|
58376
|
+
putRoutingEmailDomainRouteIdentityresolution(domainName, routeId, body) {
|
|
58377
|
+
// verify the required parameter 'domainName' is set
|
|
58378
|
+
if (domainName === undefined || domainName === null) {
|
|
58379
|
+
throw 'Missing the required parameter "domainName" when calling putRoutingEmailDomainRouteIdentityresolution';
|
|
58380
|
+
}
|
|
58381
|
+
// verify the required parameter 'routeId' is set
|
|
58382
|
+
if (routeId === undefined || routeId === null) {
|
|
58383
|
+
throw 'Missing the required parameter "routeId" when calling putRoutingEmailDomainRouteIdentityresolution';
|
|
58384
|
+
}
|
|
58385
|
+
// verify the required parameter 'body' is set
|
|
58386
|
+
if (body === undefined || body === null) {
|
|
58387
|
+
throw 'Missing the required parameter "body" when calling putRoutingEmailDomainRouteIdentityresolution';
|
|
58388
|
+
}
|
|
58389
|
+
|
|
58390
|
+
return this.apiClient.callApi(
|
|
58391
|
+
'/api/v2/routing/email/domains/{domainName}/routes/{routeId}/identityresolution',
|
|
58392
|
+
'PUT',
|
|
58393
|
+
{ 'domainName': domainName,'routeId': routeId },
|
|
58394
|
+
{ },
|
|
58395
|
+
{ },
|
|
58396
|
+
{ },
|
|
58397
|
+
body,
|
|
58398
|
+
['PureCloud OAuth'],
|
|
58399
|
+
['application/json'],
|
|
58400
|
+
['application/json']
|
|
58401
|
+
);
|
|
58402
|
+
}
|
|
58403
|
+
|
|
58152
58404
|
/**
|
|
58153
58405
|
* Request an activation status (cname + dkim) update of an outbound domain
|
|
58154
58406
|
*
|
|
@@ -58234,6 +58486,37 @@ class RoutingApi {
|
|
|
58234
58486
|
);
|
|
58235
58487
|
}
|
|
58236
58488
|
|
|
58489
|
+
/**
|
|
58490
|
+
* Update Queue IdentityResolution Settings.
|
|
58491
|
+
*
|
|
58492
|
+
* @param {String} queueId Queue ID
|
|
58493
|
+
* @param {Object} body
|
|
58494
|
+
* putRoutingQueueIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58495
|
+
*/
|
|
58496
|
+
putRoutingQueueIdentityresolution(queueId, body) {
|
|
58497
|
+
// verify the required parameter 'queueId' is set
|
|
58498
|
+
if (queueId === undefined || queueId === null) {
|
|
58499
|
+
throw 'Missing the required parameter "queueId" when calling putRoutingQueueIdentityresolution';
|
|
58500
|
+
}
|
|
58501
|
+
// verify the required parameter 'body' is set
|
|
58502
|
+
if (body === undefined || body === null) {
|
|
58503
|
+
throw 'Missing the required parameter "body" when calling putRoutingQueueIdentityresolution';
|
|
58504
|
+
}
|
|
58505
|
+
|
|
58506
|
+
return this.apiClient.callApi(
|
|
58507
|
+
'/api/v2/routing/queues/{queueId}/identityresolution',
|
|
58508
|
+
'PUT',
|
|
58509
|
+
{ 'queueId': queueId },
|
|
58510
|
+
{ },
|
|
58511
|
+
{ },
|
|
58512
|
+
{ },
|
|
58513
|
+
body,
|
|
58514
|
+
['PureCloud OAuth'],
|
|
58515
|
+
['application/json'],
|
|
58516
|
+
['application/json']
|
|
58517
|
+
);
|
|
58518
|
+
}
|
|
58519
|
+
|
|
58237
58520
|
/**
|
|
58238
58521
|
* Update an organization's routing settings
|
|
58239
58522
|
*
|
|
@@ -58284,6 +58567,37 @@ class RoutingApi {
|
|
|
58284
58567
|
);
|
|
58285
58568
|
}
|
|
58286
58569
|
|
|
58570
|
+
/**
|
|
58571
|
+
* Update an SMS identity resolution settings.
|
|
58572
|
+
*
|
|
58573
|
+
* @param {String} addressId Address ID
|
|
58574
|
+
* @param {Object} body
|
|
58575
|
+
* putRoutingSmsIdentityresolutionPhonenumber is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58576
|
+
*/
|
|
58577
|
+
putRoutingSmsIdentityresolutionPhonenumber(addressId, body) {
|
|
58578
|
+
// verify the required parameter 'addressId' is set
|
|
58579
|
+
if (addressId === undefined || addressId === null) {
|
|
58580
|
+
throw 'Missing the required parameter "addressId" when calling putRoutingSmsIdentityresolutionPhonenumber';
|
|
58581
|
+
}
|
|
58582
|
+
// verify the required parameter 'body' is set
|
|
58583
|
+
if (body === undefined || body === null) {
|
|
58584
|
+
throw 'Missing the required parameter "body" when calling putRoutingSmsIdentityresolutionPhonenumber';
|
|
58585
|
+
}
|
|
58586
|
+
|
|
58587
|
+
return this.apiClient.callApi(
|
|
58588
|
+
'/api/v2/routing/sms/identityresolution/phonenumbers/{addressId}',
|
|
58589
|
+
'PUT',
|
|
58590
|
+
{ 'addressId': addressId },
|
|
58591
|
+
{ },
|
|
58592
|
+
{ },
|
|
58593
|
+
{ },
|
|
58594
|
+
body,
|
|
58595
|
+
['PureCloud OAuth'],
|
|
58596
|
+
['application/json'],
|
|
58597
|
+
['application/json']
|
|
58598
|
+
);
|
|
58599
|
+
}
|
|
58600
|
+
|
|
58287
58601
|
/**
|
|
58288
58602
|
* Update the user's Direct Routing Backup settings.
|
|
58289
58603
|
*
|
|
@@ -58500,7 +58814,7 @@ class SCIMApi {
|
|
|
58500
58814
|
/**
|
|
58501
58815
|
* SCIM service.
|
|
58502
58816
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
58503
|
-
* @version
|
|
58817
|
+
* @version 217.0.0
|
|
58504
58818
|
*/
|
|
58505
58819
|
|
|
58506
58820
|
/**
|
|
@@ -59377,7 +59691,7 @@ class ScreenRecordingApi {
|
|
|
59377
59691
|
/**
|
|
59378
59692
|
* ScreenRecording service.
|
|
59379
59693
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
59380
|
-
* @version
|
|
59694
|
+
* @version 217.0.0
|
|
59381
59695
|
*/
|
|
59382
59696
|
|
|
59383
59697
|
/**
|
|
@@ -59422,7 +59736,7 @@ class ScriptsApi {
|
|
|
59422
59736
|
/**
|
|
59423
59737
|
* Scripts service.
|
|
59424
59738
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
59425
|
-
* @version
|
|
59739
|
+
* @version 217.0.0
|
|
59426
59740
|
*/
|
|
59427
59741
|
|
|
59428
59742
|
/**
|
|
@@ -59866,7 +60180,7 @@ class SearchApi {
|
|
|
59866
60180
|
/**
|
|
59867
60181
|
* Search service.
|
|
59868
60182
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
59869
|
-
* @version
|
|
60183
|
+
* @version 217.0.0
|
|
59870
60184
|
*/
|
|
59871
60185
|
|
|
59872
60186
|
/**
|
|
@@ -60609,7 +60923,7 @@ class SettingsApi {
|
|
|
60609
60923
|
/**
|
|
60610
60924
|
* Settings service.
|
|
60611
60925
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
60612
|
-
* @version
|
|
60926
|
+
* @version 217.0.0
|
|
60613
60927
|
*/
|
|
60614
60928
|
|
|
60615
60929
|
/**
|
|
@@ -60829,7 +61143,7 @@ class SocialMediaApi {
|
|
|
60829
61143
|
/**
|
|
60830
61144
|
* SocialMedia service.
|
|
60831
61145
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
60832
|
-
* @version
|
|
61146
|
+
* @version 217.0.0
|
|
60833
61147
|
*/
|
|
60834
61148
|
|
|
60835
61149
|
/**
|
|
@@ -61734,7 +62048,7 @@ class SpeechTextAnalyticsApi {
|
|
|
61734
62048
|
/**
|
|
61735
62049
|
* SpeechTextAnalytics service.
|
|
61736
62050
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
61737
|
-
* @version
|
|
62051
|
+
* @version 217.0.0
|
|
61738
62052
|
*/
|
|
61739
62053
|
|
|
61740
62054
|
/**
|
|
@@ -63175,7 +63489,7 @@ class StationsApi {
|
|
|
63175
63489
|
/**
|
|
63176
63490
|
* Stations service.
|
|
63177
63491
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
63178
|
-
* @version
|
|
63492
|
+
* @version 217.0.0
|
|
63179
63493
|
*/
|
|
63180
63494
|
|
|
63181
63495
|
/**
|
|
@@ -63277,7 +63591,7 @@ class SuggestApi {
|
|
|
63277
63591
|
/**
|
|
63278
63592
|
* Suggest service.
|
|
63279
63593
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
63280
|
-
* @version
|
|
63594
|
+
* @version 217.0.0
|
|
63281
63595
|
*/
|
|
63282
63596
|
|
|
63283
63597
|
/**
|
|
@@ -63416,7 +63730,7 @@ class TaskManagementApi {
|
|
|
63416
63730
|
/**
|
|
63417
63731
|
* TaskManagement service.
|
|
63418
63732
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
63419
|
-
* @version
|
|
63733
|
+
* @version 217.0.0
|
|
63420
63734
|
*/
|
|
63421
63735
|
|
|
63422
63736
|
/**
|
|
@@ -65522,7 +65836,7 @@ class TeamsApi {
|
|
|
65522
65836
|
/**
|
|
65523
65837
|
* Teams service.
|
|
65524
65838
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
65525
|
-
* @version
|
|
65839
|
+
* @version 217.0.0
|
|
65526
65840
|
*/
|
|
65527
65841
|
|
|
65528
65842
|
/**
|
|
@@ -65827,7 +66141,7 @@ class TelephonyApi {
|
|
|
65827
66141
|
/**
|
|
65828
66142
|
* Telephony service.
|
|
65829
66143
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
65830
|
-
* @version
|
|
66144
|
+
* @version 217.0.0
|
|
65831
66145
|
*/
|
|
65832
66146
|
|
|
65833
66147
|
/**
|
|
@@ -66009,7 +66323,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
66009
66323
|
/**
|
|
66010
66324
|
* TelephonyProvidersEdge service.
|
|
66011
66325
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
66012
|
-
* @version
|
|
66326
|
+
* @version 217.0.0
|
|
66013
66327
|
*/
|
|
66014
66328
|
|
|
66015
66329
|
/**
|
|
@@ -69460,7 +69774,7 @@ class TextbotsApi {
|
|
|
69460
69774
|
/**
|
|
69461
69775
|
* Textbots service.
|
|
69462
69776
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
69463
|
-
* @version
|
|
69777
|
+
* @version 217.0.0
|
|
69464
69778
|
*/
|
|
69465
69779
|
|
|
69466
69780
|
/**
|
|
@@ -69588,7 +69902,7 @@ class TokensApi {
|
|
|
69588
69902
|
/**
|
|
69589
69903
|
* Tokens service.
|
|
69590
69904
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
69591
|
-
* @version
|
|
69905
|
+
* @version 217.0.0
|
|
69592
69906
|
*/
|
|
69593
69907
|
|
|
69594
69908
|
/**
|
|
@@ -69742,7 +70056,7 @@ class UploadsApi {
|
|
|
69742
70056
|
/**
|
|
69743
70057
|
* Uploads service.
|
|
69744
70058
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
69745
|
-
* @version
|
|
70059
|
+
* @version 217.0.0
|
|
69746
70060
|
*/
|
|
69747
70061
|
|
|
69748
70062
|
/**
|
|
@@ -69762,7 +70076,6 @@ class UploadsApi {
|
|
|
69762
70076
|
*
|
|
69763
70077
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
69764
70078
|
* @param {String} jobId Upload job ID
|
|
69765
|
-
* getKnowledgeKnowledgebaseUploadsUrlsJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
69766
70079
|
*/
|
|
69767
70080
|
getKnowledgeKnowledgebaseUploadsUrlsJob(knowledgeBaseId, jobId) {
|
|
69768
70081
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -69848,7 +70161,6 @@ class UploadsApi {
|
|
|
69848
70161
|
*
|
|
69849
70162
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
69850
70163
|
* @param {Object} body uploadRequest
|
|
69851
|
-
* postKnowledgeKnowledgebaseUploadsUrlsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
69852
70164
|
*/
|
|
69853
70165
|
postKnowledgeKnowledgebaseUploadsUrlsJobs(knowledgeBaseId, body) {
|
|
69854
70166
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -70010,7 +70322,7 @@ class UsageApi {
|
|
|
70010
70322
|
/**
|
|
70011
70323
|
* Usage service.
|
|
70012
70324
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
70013
|
-
* @version
|
|
70325
|
+
* @version 217.0.0
|
|
70014
70326
|
*/
|
|
70015
70327
|
|
|
70016
70328
|
/**
|
|
@@ -70225,7 +70537,7 @@ class UserRecordingsApi {
|
|
|
70225
70537
|
/**
|
|
70226
70538
|
* UserRecordings service.
|
|
70227
70539
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
70228
|
-
* @version
|
|
70540
|
+
* @version 217.0.0
|
|
70229
70541
|
*/
|
|
70230
70542
|
|
|
70231
70543
|
/**
|
|
@@ -70440,7 +70752,7 @@ class UsersApi {
|
|
|
70440
70752
|
/**
|
|
70441
70753
|
* Users service.
|
|
70442
70754
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
70443
|
-
* @version
|
|
70755
|
+
* @version 217.0.0
|
|
70444
70756
|
*/
|
|
70445
70757
|
|
|
70446
70758
|
/**
|
|
@@ -73393,7 +73705,7 @@ class UtilitiesApi {
|
|
|
73393
73705
|
/**
|
|
73394
73706
|
* Utilities service.
|
|
73395
73707
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
73396
|
-
* @version
|
|
73708
|
+
* @version 217.0.0
|
|
73397
73709
|
*/
|
|
73398
73710
|
|
|
73399
73711
|
/**
|
|
@@ -73504,7 +73816,7 @@ class VoicemailApi {
|
|
|
73504
73816
|
/**
|
|
73505
73817
|
* Voicemail service.
|
|
73506
73818
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
73507
|
-
* @version
|
|
73819
|
+
* @version 217.0.0
|
|
73508
73820
|
*/
|
|
73509
73821
|
|
|
73510
73822
|
/**
|
|
@@ -74226,7 +74538,7 @@ class WebChatApi {
|
|
|
74226
74538
|
/**
|
|
74227
74539
|
* WebChat service.
|
|
74228
74540
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
74229
|
-
* @version
|
|
74541
|
+
* @version 217.0.0
|
|
74230
74542
|
*/
|
|
74231
74543
|
|
|
74232
74544
|
/**
|
|
@@ -74777,7 +75089,7 @@ class WebDeploymentsApi {
|
|
|
74777
75089
|
/**
|
|
74778
75090
|
* WebDeployments service.
|
|
74779
75091
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
74780
|
-
* @version
|
|
75092
|
+
* @version 217.0.0
|
|
74781
75093
|
*/
|
|
74782
75094
|
|
|
74783
75095
|
/**
|
|
@@ -75090,6 +75402,32 @@ class WebDeploymentsApi {
|
|
|
75090
75402
|
);
|
|
75091
75403
|
}
|
|
75092
75404
|
|
|
75405
|
+
/**
|
|
75406
|
+
* Get a deployment identity resolution setting.
|
|
75407
|
+
*
|
|
75408
|
+
* @param {String} deploymentId The deployment ID
|
|
75409
|
+
* getWebdeploymentsDeploymentIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
75410
|
+
*/
|
|
75411
|
+
getWebdeploymentsDeploymentIdentityresolution(deploymentId) {
|
|
75412
|
+
// verify the required parameter 'deploymentId' is set
|
|
75413
|
+
if (deploymentId === undefined || deploymentId === null) {
|
|
75414
|
+
throw 'Missing the required parameter "deploymentId" when calling getWebdeploymentsDeploymentIdentityresolution';
|
|
75415
|
+
}
|
|
75416
|
+
|
|
75417
|
+
return this.apiClient.callApi(
|
|
75418
|
+
'/api/v2/webdeployments/deployments/{deploymentId}/identityresolution',
|
|
75419
|
+
'GET',
|
|
75420
|
+
{ 'deploymentId': deploymentId },
|
|
75421
|
+
{ },
|
|
75422
|
+
{ },
|
|
75423
|
+
{ },
|
|
75424
|
+
null,
|
|
75425
|
+
['PureCloud OAuth'],
|
|
75426
|
+
['application/json'],
|
|
75427
|
+
['application/json']
|
|
75428
|
+
);
|
|
75429
|
+
}
|
|
75430
|
+
|
|
75093
75431
|
/**
|
|
75094
75432
|
* Get deployments
|
|
75095
75433
|
*
|
|
@@ -75298,13 +75636,44 @@ class WebDeploymentsApi {
|
|
|
75298
75636
|
);
|
|
75299
75637
|
}
|
|
75300
75638
|
|
|
75639
|
+
/**
|
|
75640
|
+
* Update identity resolution settings for a deployment.
|
|
75641
|
+
*
|
|
75642
|
+
* @param {String} deploymentId The deployment ID
|
|
75643
|
+
* @param {Object} body
|
|
75644
|
+
* putWebdeploymentsDeploymentIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
75645
|
+
*/
|
|
75646
|
+
putWebdeploymentsDeploymentIdentityresolution(deploymentId, body) {
|
|
75647
|
+
// verify the required parameter 'deploymentId' is set
|
|
75648
|
+
if (deploymentId === undefined || deploymentId === null) {
|
|
75649
|
+
throw 'Missing the required parameter "deploymentId" when calling putWebdeploymentsDeploymentIdentityresolution';
|
|
75650
|
+
}
|
|
75651
|
+
// verify the required parameter 'body' is set
|
|
75652
|
+
if (body === undefined || body === null) {
|
|
75653
|
+
throw 'Missing the required parameter "body" when calling putWebdeploymentsDeploymentIdentityresolution';
|
|
75654
|
+
}
|
|
75655
|
+
|
|
75656
|
+
return this.apiClient.callApi(
|
|
75657
|
+
'/api/v2/webdeployments/deployments/{deploymentId}/identityresolution',
|
|
75658
|
+
'PUT',
|
|
75659
|
+
{ 'deploymentId': deploymentId },
|
|
75660
|
+
{ },
|
|
75661
|
+
{ },
|
|
75662
|
+
{ },
|
|
75663
|
+
body,
|
|
75664
|
+
['PureCloud OAuth'],
|
|
75665
|
+
['application/json'],
|
|
75666
|
+
['application/json']
|
|
75667
|
+
);
|
|
75668
|
+
}
|
|
75669
|
+
|
|
75301
75670
|
}
|
|
75302
75671
|
|
|
75303
75672
|
class WebMessagingApi {
|
|
75304
75673
|
/**
|
|
75305
75674
|
* WebMessaging service.
|
|
75306
75675
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
75307
|
-
* @version
|
|
75676
|
+
* @version 217.0.0
|
|
75308
75677
|
*/
|
|
75309
75678
|
|
|
75310
75679
|
/**
|
|
@@ -75350,7 +75719,7 @@ class WidgetsApi {
|
|
|
75350
75719
|
/**
|
|
75351
75720
|
* Widgets service.
|
|
75352
75721
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
75353
|
-
* @version
|
|
75722
|
+
* @version 217.0.0
|
|
75354
75723
|
*/
|
|
75355
75724
|
|
|
75356
75725
|
/**
|
|
@@ -75496,7 +75865,7 @@ class WorkforceManagementApi {
|
|
|
75496
75865
|
/**
|
|
75497
75866
|
* WorkforceManagement service.
|
|
75498
75867
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
75499
|
-
* @version
|
|
75868
|
+
* @version 217.0.0
|
|
75500
75869
|
*/
|
|
75501
75870
|
|
|
75502
75871
|
/**
|
|
@@ -82889,7 +83258,7 @@ class WorkforceManagementApi {
|
|
|
82889
83258
|
* </pre>
|
|
82890
83259
|
* </p>
|
|
82891
83260
|
* @module purecloud-platform-client-v2/index
|
|
82892
|
-
* @version
|
|
83261
|
+
* @version 217.0.0
|
|
82893
83262
|
*/
|
|
82894
83263
|
class platformClient {
|
|
82895
83264
|
constructor() {
|