purecloud-platform-client-v2 216.0.0 → 218.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 +1546 -567
- package/dist/web-amd/purecloud-platform-client-v2.js +1546 -567
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +502 -282
- package/dist/web-cjs/purecloud-platform-client-v2.js +507 -285
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +951 -292
- 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 -8
- 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 +387 -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 +243 -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 -16
- 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 +1 -68
- 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 -2
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +5 -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 +403 -20
- 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 +3 -2
- 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 +19 -10
- 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 +11 -6
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -687,7 +687,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
687
687
|
|
|
688
688
|
/**
|
|
689
689
|
* @module purecloud-platform-client-v2/ApiClient
|
|
690
|
-
* @version
|
|
690
|
+
* @version 218.0.0
|
|
691
691
|
*/
|
|
692
692
|
class ApiClient {
|
|
693
693
|
/**
|
|
@@ -2231,7 +2231,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2231
2231
|
/**
|
|
2232
2232
|
* AgentAssistants service.
|
|
2233
2233
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
2234
|
-
* @version
|
|
2234
|
+
* @version 218.0.0
|
|
2235
2235
|
*/
|
|
2236
2236
|
|
|
2237
2237
|
/**
|
|
@@ -2607,7 +2607,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2607
2607
|
/**
|
|
2608
2608
|
* AgentCopilot service.
|
|
2609
2609
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
2610
|
-
* @version
|
|
2610
|
+
* @version 218.0.0
|
|
2611
2611
|
*/
|
|
2612
2612
|
|
|
2613
2613
|
/**
|
|
@@ -2683,7 +2683,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2683
2683
|
/**
|
|
2684
2684
|
* AgentUI service.
|
|
2685
2685
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
2686
|
-
* @version
|
|
2686
|
+
* @version 218.0.0
|
|
2687
2687
|
*/
|
|
2688
2688
|
|
|
2689
2689
|
/**
|
|
@@ -2814,7 +2814,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2814
2814
|
/**
|
|
2815
2815
|
* Alerting service.
|
|
2816
2816
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
2817
|
-
* @version
|
|
2817
|
+
* @version 218.0.0
|
|
2818
2818
|
*/
|
|
2819
2819
|
|
|
2820
2820
|
/**
|
|
@@ -2874,58 +2874,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2874
2874
|
);
|
|
2875
2875
|
}
|
|
2876
2876
|
|
|
2877
|
-
/**
|
|
2878
|
-
* Delete an interaction stats alert
|
|
2879
|
-
* Apps should migrate to use DELETE /api/v2/alerting/alerts/{alertId}.
|
|
2880
|
-
* @param {String} alertId Alert ID
|
|
2881
|
-
* @deprecated
|
|
2882
|
-
*/
|
|
2883
|
-
deleteAlertingInteractionstatsAlert(alertId) {
|
|
2884
|
-
// verify the required parameter 'alertId' is set
|
|
2885
|
-
if (alertId === undefined || alertId === null) {
|
|
2886
|
-
throw 'Missing the required parameter "alertId" when calling deleteAlertingInteractionstatsAlert';
|
|
2887
|
-
}
|
|
2888
|
-
|
|
2889
|
-
return this.apiClient.callApi(
|
|
2890
|
-
'/api/v2/alerting/interactionstats/alerts/{alertId}',
|
|
2891
|
-
'DELETE',
|
|
2892
|
-
{ 'alertId': alertId },
|
|
2893
|
-
{ },
|
|
2894
|
-
{ },
|
|
2895
|
-
{ },
|
|
2896
|
-
null,
|
|
2897
|
-
['PureCloud OAuth'],
|
|
2898
|
-
['application/json'],
|
|
2899
|
-
['application/json']
|
|
2900
|
-
);
|
|
2901
|
-
}
|
|
2902
|
-
|
|
2903
|
-
/**
|
|
2904
|
-
* Delete an interaction stats rule
|
|
2905
|
-
* Apps should migrate to use DELETE /api/v2/alerting/rules/{ruleId}.
|
|
2906
|
-
* @param {String} ruleId Rule ID
|
|
2907
|
-
* @deprecated
|
|
2908
|
-
*/
|
|
2909
|
-
deleteAlertingInteractionstatsRule(ruleId) {
|
|
2910
|
-
// verify the required parameter 'ruleId' is set
|
|
2911
|
-
if (ruleId === undefined || ruleId === null) {
|
|
2912
|
-
throw 'Missing the required parameter "ruleId" when calling deleteAlertingInteractionstatsRule';
|
|
2913
|
-
}
|
|
2914
|
-
|
|
2915
|
-
return this.apiClient.callApi(
|
|
2916
|
-
'/api/v2/alerting/interactionstats/rules/{ruleId}',
|
|
2917
|
-
'DELETE',
|
|
2918
|
-
{ 'ruleId': ruleId },
|
|
2919
|
-
{ },
|
|
2920
|
-
{ },
|
|
2921
|
-
{ },
|
|
2922
|
-
null,
|
|
2923
|
-
['PureCloud OAuth'],
|
|
2924
|
-
['application/json'],
|
|
2925
|
-
['application/json']
|
|
2926
|
-
);
|
|
2927
|
-
}
|
|
2928
|
-
|
|
2929
2877
|
/**
|
|
2930
2878
|
* Delete a rule.
|
|
2931
2879
|
*
|
|
@@ -2976,158 +2924,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2976
2924
|
);
|
|
2977
2925
|
}
|
|
2978
2926
|
|
|
2979
|
-
/**
|
|
2980
|
-
* Gets active alert count for a user
|
|
2981
|
-
* Apps should migrate to use POST /api/v2/alerting/alerts/query with the queryType set to Count and alertStatus to Active in the request body.
|
|
2982
|
-
* @deprecated
|
|
2983
|
-
*/
|
|
2984
|
-
getAlertingAlertsActive() {
|
|
2985
|
-
|
|
2986
|
-
return this.apiClient.callApi(
|
|
2987
|
-
'/api/v2/alerting/alerts/active',
|
|
2988
|
-
'GET',
|
|
2989
|
-
{ },
|
|
2990
|
-
{ },
|
|
2991
|
-
{ },
|
|
2992
|
-
{ },
|
|
2993
|
-
null,
|
|
2994
|
-
['PureCloud OAuth'],
|
|
2995
|
-
['application/json'],
|
|
2996
|
-
['application/json']
|
|
2997
|
-
);
|
|
2998
|
-
}
|
|
2999
|
-
|
|
3000
|
-
/**
|
|
3001
|
-
* Get an interaction stats alert
|
|
3002
|
-
* Apps should migrate to use GET /api/v2/alerting/alerts/{alertId}.
|
|
3003
|
-
* @param {String} alertId Alert ID
|
|
3004
|
-
* @param {Object} opts Optional parameters
|
|
3005
|
-
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
3006
|
-
* @deprecated
|
|
3007
|
-
*/
|
|
3008
|
-
getAlertingInteractionstatsAlert(alertId, opts) {
|
|
3009
|
-
opts = opts || {};
|
|
3010
|
-
|
|
3011
|
-
// verify the required parameter 'alertId' is set
|
|
3012
|
-
if (alertId === undefined || alertId === null) {
|
|
3013
|
-
throw 'Missing the required parameter "alertId" when calling getAlertingInteractionstatsAlert';
|
|
3014
|
-
}
|
|
3015
|
-
|
|
3016
|
-
return this.apiClient.callApi(
|
|
3017
|
-
'/api/v2/alerting/interactionstats/alerts/{alertId}',
|
|
3018
|
-
'GET',
|
|
3019
|
-
{ 'alertId': alertId },
|
|
3020
|
-
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
3021
|
-
{ },
|
|
3022
|
-
{ },
|
|
3023
|
-
null,
|
|
3024
|
-
['PureCloud OAuth'],
|
|
3025
|
-
['application/json'],
|
|
3026
|
-
['application/json']
|
|
3027
|
-
);
|
|
3028
|
-
}
|
|
3029
|
-
|
|
3030
|
-
/**
|
|
3031
|
-
* Get interaction stats alert list
|
|
3032
|
-
* Apps should migrate to use POST /api/v2/alerting/alerts/query.
|
|
3033
|
-
* @param {Object} opts Optional parameters
|
|
3034
|
-
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
3035
|
-
* @deprecated
|
|
3036
|
-
*/
|
|
3037
|
-
getAlertingInteractionstatsAlerts(opts) {
|
|
3038
|
-
opts = opts || {};
|
|
3039
|
-
|
|
3040
|
-
|
|
3041
|
-
return this.apiClient.callApi(
|
|
3042
|
-
'/api/v2/alerting/interactionstats/alerts',
|
|
3043
|
-
'GET',
|
|
3044
|
-
{ },
|
|
3045
|
-
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
3046
|
-
{ },
|
|
3047
|
-
{ },
|
|
3048
|
-
null,
|
|
3049
|
-
['PureCloud OAuth'],
|
|
3050
|
-
['application/json'],
|
|
3051
|
-
['application/json']
|
|
3052
|
-
);
|
|
3053
|
-
}
|
|
3054
|
-
|
|
3055
|
-
/**
|
|
3056
|
-
* Gets user unread count of interaction stats alerts
|
|
3057
|
-
* Apps should migrate to use POST /api/v2/alerting/alerts/query with the queryType set to Count and viewStatus to Unread in the request body.
|
|
3058
|
-
* @deprecated
|
|
3059
|
-
*/
|
|
3060
|
-
getAlertingInteractionstatsAlertsUnread() {
|
|
3061
|
-
|
|
3062
|
-
return this.apiClient.callApi(
|
|
3063
|
-
'/api/v2/alerting/interactionstats/alerts/unread',
|
|
3064
|
-
'GET',
|
|
3065
|
-
{ },
|
|
3066
|
-
{ },
|
|
3067
|
-
{ },
|
|
3068
|
-
{ },
|
|
3069
|
-
null,
|
|
3070
|
-
['PureCloud OAuth'],
|
|
3071
|
-
['application/json'],
|
|
3072
|
-
['application/json']
|
|
3073
|
-
);
|
|
3074
|
-
}
|
|
3075
|
-
|
|
3076
|
-
/**
|
|
3077
|
-
* Get an interaction stats rule
|
|
3078
|
-
* Apps should migrate to use GET /api/v2/alerting/rules/{ruleId}.
|
|
3079
|
-
* @param {String} ruleId Rule ID
|
|
3080
|
-
* @param {Object} opts Optional parameters
|
|
3081
|
-
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
3082
|
-
* @deprecated
|
|
3083
|
-
*/
|
|
3084
|
-
getAlertingInteractionstatsRule(ruleId, opts) {
|
|
3085
|
-
opts = opts || {};
|
|
3086
|
-
|
|
3087
|
-
// verify the required parameter 'ruleId' is set
|
|
3088
|
-
if (ruleId === undefined || ruleId === null) {
|
|
3089
|
-
throw 'Missing the required parameter "ruleId" when calling getAlertingInteractionstatsRule';
|
|
3090
|
-
}
|
|
3091
|
-
|
|
3092
|
-
return this.apiClient.callApi(
|
|
3093
|
-
'/api/v2/alerting/interactionstats/rules/{ruleId}',
|
|
3094
|
-
'GET',
|
|
3095
|
-
{ 'ruleId': ruleId },
|
|
3096
|
-
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
3097
|
-
{ },
|
|
3098
|
-
{ },
|
|
3099
|
-
null,
|
|
3100
|
-
['PureCloud OAuth'],
|
|
3101
|
-
['application/json'],
|
|
3102
|
-
['application/json']
|
|
3103
|
-
);
|
|
3104
|
-
}
|
|
3105
|
-
|
|
3106
|
-
/**
|
|
3107
|
-
* Get an interaction stats rule list
|
|
3108
|
-
* Apps should migrate to use POST /api/v2/alerting/rules/query.
|
|
3109
|
-
* @param {Object} opts Optional parameters
|
|
3110
|
-
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
3111
|
-
* @deprecated
|
|
3112
|
-
*/
|
|
3113
|
-
getAlertingInteractionstatsRules(opts) {
|
|
3114
|
-
opts = opts || {};
|
|
3115
|
-
|
|
3116
|
-
|
|
3117
|
-
return this.apiClient.callApi(
|
|
3118
|
-
'/api/v2/alerting/interactionstats/rules',
|
|
3119
|
-
'GET',
|
|
3120
|
-
{ },
|
|
3121
|
-
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
3122
|
-
{ },
|
|
3123
|
-
{ },
|
|
3124
|
-
null,
|
|
3125
|
-
['PureCloud OAuth'],
|
|
3126
|
-
['application/json'],
|
|
3127
|
-
['application/json']
|
|
3128
|
-
);
|
|
3129
|
-
}
|
|
3130
|
-
|
|
3131
2927
|
/**
|
|
3132
2928
|
* Get a rule.
|
|
3133
2929
|
*
|
|
@@ -3280,36 +3076,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3280
3076
|
);
|
|
3281
3077
|
}
|
|
3282
3078
|
|
|
3283
|
-
/**
|
|
3284
|
-
* Create an interaction stats rule
|
|
3285
|
-
* Apps should migrate to use POST /api/v2/alerting/rules.
|
|
3286
|
-
* @param {Object} body AlertingRule
|
|
3287
|
-
* @param {Object} opts Optional parameters
|
|
3288
|
-
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
3289
|
-
* @deprecated
|
|
3290
|
-
*/
|
|
3291
|
-
postAlertingInteractionstatsRules(body, opts) {
|
|
3292
|
-
opts = opts || {};
|
|
3293
|
-
|
|
3294
|
-
// verify the required parameter 'body' is set
|
|
3295
|
-
if (body === undefined || body === null) {
|
|
3296
|
-
throw 'Missing the required parameter "body" when calling postAlertingInteractionstatsRules';
|
|
3297
|
-
}
|
|
3298
|
-
|
|
3299
|
-
return this.apiClient.callApi(
|
|
3300
|
-
'/api/v2/alerting/interactionstats/rules',
|
|
3301
|
-
'POST',
|
|
3302
|
-
{ },
|
|
3303
|
-
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
3304
|
-
{ },
|
|
3305
|
-
{ },
|
|
3306
|
-
body,
|
|
3307
|
-
['PureCloud OAuth'],
|
|
3308
|
-
['application/json'],
|
|
3309
|
-
['application/json']
|
|
3310
|
-
);
|
|
3311
|
-
}
|
|
3312
|
-
|
|
3313
3079
|
/**
|
|
3314
3080
|
* Create a Rule.
|
|
3315
3081
|
*
|
|
@@ -3413,76 +3179,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3413
3179
|
);
|
|
3414
3180
|
}
|
|
3415
3181
|
|
|
3416
|
-
/**
|
|
3417
|
-
* Update an interaction stats alert read status
|
|
3418
|
-
* Apps should migrate to use PUT /api/v2/alerting/alerts/{alertId}.
|
|
3419
|
-
* @param {String} alertId Alert ID
|
|
3420
|
-
* @param {Object} body InteractionStatsAlert
|
|
3421
|
-
* @param {Object} opts Optional parameters
|
|
3422
|
-
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
3423
|
-
* @deprecated
|
|
3424
|
-
*/
|
|
3425
|
-
putAlertingInteractionstatsAlert(alertId, body, opts) {
|
|
3426
|
-
opts = opts || {};
|
|
3427
|
-
|
|
3428
|
-
// verify the required parameter 'alertId' is set
|
|
3429
|
-
if (alertId === undefined || alertId === null) {
|
|
3430
|
-
throw 'Missing the required parameter "alertId" when calling putAlertingInteractionstatsAlert';
|
|
3431
|
-
}
|
|
3432
|
-
// verify the required parameter 'body' is set
|
|
3433
|
-
if (body === undefined || body === null) {
|
|
3434
|
-
throw 'Missing the required parameter "body" when calling putAlertingInteractionstatsAlert';
|
|
3435
|
-
}
|
|
3436
|
-
|
|
3437
|
-
return this.apiClient.callApi(
|
|
3438
|
-
'/api/v2/alerting/interactionstats/alerts/{alertId}',
|
|
3439
|
-
'PUT',
|
|
3440
|
-
{ 'alertId': alertId },
|
|
3441
|
-
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
3442
|
-
{ },
|
|
3443
|
-
{ },
|
|
3444
|
-
body,
|
|
3445
|
-
['PureCloud OAuth'],
|
|
3446
|
-
['application/json'],
|
|
3447
|
-
['application/json']
|
|
3448
|
-
);
|
|
3449
|
-
}
|
|
3450
|
-
|
|
3451
|
-
/**
|
|
3452
|
-
* Update an interaction stats rule
|
|
3453
|
-
* Apps should migrate to use PUT /api/v2/alerting/rules/{ruleId}.
|
|
3454
|
-
* @param {String} ruleId Rule ID
|
|
3455
|
-
* @param {Object} body AlertingRule
|
|
3456
|
-
* @param {Object} opts Optional parameters
|
|
3457
|
-
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
3458
|
-
* @deprecated
|
|
3459
|
-
*/
|
|
3460
|
-
putAlertingInteractionstatsRule(ruleId, body, opts) {
|
|
3461
|
-
opts = opts || {};
|
|
3462
|
-
|
|
3463
|
-
// verify the required parameter 'ruleId' is set
|
|
3464
|
-
if (ruleId === undefined || ruleId === null) {
|
|
3465
|
-
throw 'Missing the required parameter "ruleId" when calling putAlertingInteractionstatsRule';
|
|
3466
|
-
}
|
|
3467
|
-
// verify the required parameter 'body' is set
|
|
3468
|
-
if (body === undefined || body === null) {
|
|
3469
|
-
throw 'Missing the required parameter "body" when calling putAlertingInteractionstatsRule';
|
|
3470
|
-
}
|
|
3471
|
-
|
|
3472
|
-
return this.apiClient.callApi(
|
|
3473
|
-
'/api/v2/alerting/interactionstats/rules/{ruleId}',
|
|
3474
|
-
'PUT',
|
|
3475
|
-
{ 'ruleId': ruleId },
|
|
3476
|
-
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
3477
|
-
{ },
|
|
3478
|
-
{ },
|
|
3479
|
-
body,
|
|
3480
|
-
['PureCloud OAuth'],
|
|
3481
|
-
['application/json'],
|
|
3482
|
-
['application/json']
|
|
3483
|
-
);
|
|
3484
|
-
}
|
|
3485
|
-
|
|
3486
3182
|
/**
|
|
3487
3183
|
* Update a rule
|
|
3488
3184
|
*
|
|
@@ -3519,7 +3215,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3519
3215
|
/**
|
|
3520
3216
|
* Analytics service.
|
|
3521
3217
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
3522
|
-
* @version
|
|
3218
|
+
* @version 218.0.0
|
|
3523
3219
|
*/
|
|
3524
3220
|
|
|
3525
3221
|
/**
|
|
@@ -4396,7 +4092,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4396
4092
|
* @param {Number} opts.pageSize (default to 25)
|
|
4397
4093
|
* @param {Array.<String>} opts.id A list of user IDs to fetch by bulk
|
|
4398
4094
|
* @param {Object} opts.state Only list users of this state
|
|
4399
|
-
* @param {Boolean} opts.deletedOnly Only list deleted dashboards
|
|
4095
|
+
* @param {Boolean} opts.deletedOnly Only list users with deleted dashboards
|
|
4400
4096
|
*/
|
|
4401
4097
|
getAnalyticsReportingDashboardsUsers(opts) {
|
|
4402
4098
|
opts = opts || {};
|
|
@@ -6343,7 +6039,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6343
6039
|
/**
|
|
6344
6040
|
* Architect service.
|
|
6345
6041
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
6346
|
-
* @version
|
|
6042
|
+
* @version 218.0.0
|
|
6347
6043
|
*/
|
|
6348
6044
|
|
|
6349
6045
|
/**
|
|
@@ -7373,6 +7069,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7373
7069
|
);
|
|
7374
7070
|
}
|
|
7375
7071
|
|
|
7072
|
+
/**
|
|
7073
|
+
* Get an IVR IdentityResolutionConfig.
|
|
7074
|
+
*
|
|
7075
|
+
* @param {String} ivrId IVR id
|
|
7076
|
+
* getArchitectIvrIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7077
|
+
*/
|
|
7078
|
+
getArchitectIvrIdentityresolution(ivrId) {
|
|
7079
|
+
// verify the required parameter 'ivrId' is set
|
|
7080
|
+
if (ivrId === undefined || ivrId === null) {
|
|
7081
|
+
throw 'Missing the required parameter "ivrId" when calling getArchitectIvrIdentityresolution';
|
|
7082
|
+
}
|
|
7083
|
+
|
|
7084
|
+
return this.apiClient.callApi(
|
|
7085
|
+
'/api/v2/architect/ivrs/{ivrId}/identityresolution',
|
|
7086
|
+
'GET',
|
|
7087
|
+
{ 'ivrId': ivrId },
|
|
7088
|
+
{ },
|
|
7089
|
+
{ },
|
|
7090
|
+
{ },
|
|
7091
|
+
null,
|
|
7092
|
+
['PureCloud OAuth'],
|
|
7093
|
+
['application/json'],
|
|
7094
|
+
['application/json']
|
|
7095
|
+
);
|
|
7096
|
+
}
|
|
7097
|
+
|
|
7376
7098
|
/**
|
|
7377
7099
|
* Get IVR configs.
|
|
7378
7100
|
*
|
|
@@ -8647,6 +8369,35 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8647
8369
|
);
|
|
8648
8370
|
}
|
|
8649
8371
|
|
|
8372
|
+
/**
|
|
8373
|
+
* Fetch Architect Export Job Status
|
|
8374
|
+
*
|
|
8375
|
+
* @param {String} jobId Job ID
|
|
8376
|
+
* @param {Object} opts Optional parameters
|
|
8377
|
+
* @param {Array.<String>} opts.expand Which fields, if any, to expand.
|
|
8378
|
+
*/
|
|
8379
|
+
getFlowsExportJob(jobId, opts) {
|
|
8380
|
+
opts = opts || {};
|
|
8381
|
+
|
|
8382
|
+
// verify the required parameter 'jobId' is set
|
|
8383
|
+
if (jobId === undefined || jobId === null) {
|
|
8384
|
+
throw 'Missing the required parameter "jobId" when calling getFlowsExportJob';
|
|
8385
|
+
}
|
|
8386
|
+
|
|
8387
|
+
return this.apiClient.callApi(
|
|
8388
|
+
'/api/v2/flows/export/jobs/{jobId}',
|
|
8389
|
+
'GET',
|
|
8390
|
+
{ 'jobId': jobId },
|
|
8391
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
8392
|
+
{ },
|
|
8393
|
+
{ },
|
|
8394
|
+
null,
|
|
8395
|
+
['PureCloud OAuth'],
|
|
8396
|
+
['application/json'],
|
|
8397
|
+
['application/json']
|
|
8398
|
+
);
|
|
8399
|
+
}
|
|
8400
|
+
|
|
8650
8401
|
/**
|
|
8651
8402
|
* Start a process (job) to prepare a download of a singular flow execution data instance by Id
|
|
8652
8403
|
* Returns a JobResult object that contains an ID that can be used to check status and/or download links when the process (job) is complete.
|
|
@@ -9893,6 +9644,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9893
9644
|
);
|
|
9894
9645
|
}
|
|
9895
9646
|
|
|
9647
|
+
/**
|
|
9648
|
+
* Register Architect Export Job
|
|
9649
|
+
*
|
|
9650
|
+
* @param {Object} body
|
|
9651
|
+
*/
|
|
9652
|
+
postFlowsExportJobs(body) {
|
|
9653
|
+
// verify the required parameter 'body' is set
|
|
9654
|
+
if (body === undefined || body === null) {
|
|
9655
|
+
throw 'Missing the required parameter "body" when calling postFlowsExportJobs';
|
|
9656
|
+
}
|
|
9657
|
+
|
|
9658
|
+
return this.apiClient.callApi(
|
|
9659
|
+
'/api/v2/flows/export/jobs',
|
|
9660
|
+
'POST',
|
|
9661
|
+
{ },
|
|
9662
|
+
{ },
|
|
9663
|
+
{ },
|
|
9664
|
+
{ },
|
|
9665
|
+
body,
|
|
9666
|
+
['PureCloud OAuth'],
|
|
9667
|
+
['application/json'],
|
|
9668
|
+
['application/json']
|
|
9669
|
+
);
|
|
9670
|
+
}
|
|
9671
|
+
|
|
9896
9672
|
/**
|
|
9897
9673
|
* Start a process (job) that will prepare a list of execution data IDs for download.
|
|
9898
9674
|
* Returns a JobResult object that contains an ID that can be used to check status and/or download links when the process (job) is complete.
|
|
@@ -10080,6 +9856,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10080
9856
|
);
|
|
10081
9857
|
}
|
|
10082
9858
|
|
|
9859
|
+
/**
|
|
9860
|
+
* Update an IVR IdentityResolutionConfig.
|
|
9861
|
+
*
|
|
9862
|
+
* @param {String} ivrId IVR id
|
|
9863
|
+
* @param {Object} body
|
|
9864
|
+
* putArchitectIvrIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9865
|
+
*/
|
|
9866
|
+
putArchitectIvrIdentityresolution(ivrId, body) {
|
|
9867
|
+
// verify the required parameter 'ivrId' is set
|
|
9868
|
+
if (ivrId === undefined || ivrId === null) {
|
|
9869
|
+
throw 'Missing the required parameter "ivrId" when calling putArchitectIvrIdentityresolution';
|
|
9870
|
+
}
|
|
9871
|
+
// verify the required parameter 'body' is set
|
|
9872
|
+
if (body === undefined || body === null) {
|
|
9873
|
+
throw 'Missing the required parameter "body" when calling putArchitectIvrIdentityresolution';
|
|
9874
|
+
}
|
|
9875
|
+
|
|
9876
|
+
return this.apiClient.callApi(
|
|
9877
|
+
'/api/v2/architect/ivrs/{ivrId}/identityresolution',
|
|
9878
|
+
'PUT',
|
|
9879
|
+
{ 'ivrId': ivrId },
|
|
9880
|
+
{ },
|
|
9881
|
+
{ },
|
|
9882
|
+
{ },
|
|
9883
|
+
body,
|
|
9884
|
+
['PureCloud OAuth'],
|
|
9885
|
+
['application/json'],
|
|
9886
|
+
['application/json']
|
|
9887
|
+
);
|
|
9888
|
+
}
|
|
9889
|
+
|
|
10083
9890
|
/**
|
|
10084
9891
|
* Update specified user prompt
|
|
10085
9892
|
*
|
|
@@ -10465,7 +10272,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10465
10272
|
/**
|
|
10466
10273
|
* Audit service.
|
|
10467
10274
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
10468
|
-
* @version
|
|
10275
|
+
* @version 218.0.0
|
|
10469
10276
|
*/
|
|
10470
10277
|
|
|
10471
10278
|
/**
|
|
@@ -10666,7 +10473,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10666
10473
|
/**
|
|
10667
10474
|
* Authorization service.
|
|
10668
10475
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
10669
|
-
* @version
|
|
10476
|
+
* @version 218.0.0
|
|
10670
10477
|
*/
|
|
10671
10478
|
|
|
10672
10479
|
/**
|
|
@@ -10686,7 +10493,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10686
10493
|
*
|
|
10687
10494
|
* @param {String} divisionId Division ID
|
|
10688
10495
|
* @param {Object} opts Optional parameters
|
|
10689
|
-
* @param {Boolean} opts.force Force delete this division
|
|
10496
|
+
* @param {Boolean} opts.force DEPRECATED - Force delete this division. Warning: This option may cause any remaining objects in this division to be inaccessible. (default to false)
|
|
10690
10497
|
*/
|
|
10691
10498
|
deleteAuthorizationDivision(divisionId, opts) {
|
|
10692
10499
|
opts = opts || {};
|
|
@@ -11661,16 +11468,17 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11661
11468
|
* Recreate a previously deleted division.
|
|
11662
11469
|
*
|
|
11663
11470
|
* @param {String} divisionId Division ID
|
|
11664
|
-
* @param {Object}
|
|
11665
|
-
* @param {Object} opts.body Recreated division data
|
|
11471
|
+
* @param {Object} body Recreated division data
|
|
11666
11472
|
*/
|
|
11667
|
-
postAuthorizationDivisionRestore(divisionId,
|
|
11668
|
-
opts = opts || {};
|
|
11669
|
-
|
|
11473
|
+
postAuthorizationDivisionRestore(divisionId, body) {
|
|
11670
11474
|
// verify the required parameter 'divisionId' is set
|
|
11671
11475
|
if (divisionId === undefined || divisionId === null) {
|
|
11672
11476
|
throw 'Missing the required parameter "divisionId" when calling postAuthorizationDivisionRestore';
|
|
11673
11477
|
}
|
|
11478
|
+
// verify the required parameter 'body' is set
|
|
11479
|
+
if (body === undefined || body === null) {
|
|
11480
|
+
throw 'Missing the required parameter "body" when calling postAuthorizationDivisionRestore';
|
|
11481
|
+
}
|
|
11674
11482
|
|
|
11675
11483
|
return this.apiClient.callApi(
|
|
11676
11484
|
'/api/v2/authorization/divisions/{divisionId}/restore',
|
|
@@ -11679,7 +11487,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11679
11487
|
{ },
|
|
11680
11488
|
{ },
|
|
11681
11489
|
{ },
|
|
11682
|
-
|
|
11490
|
+
body,
|
|
11683
11491
|
['PureCloud OAuth'],
|
|
11684
11492
|
['application/json'],
|
|
11685
11493
|
['application/json']
|
|
@@ -12327,7 +12135,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12327
12135
|
/**
|
|
12328
12136
|
* Billing service.
|
|
12329
12137
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
12330
|
-
* @version
|
|
12138
|
+
* @version 218.0.0
|
|
12331
12139
|
*/
|
|
12332
12140
|
|
|
12333
12141
|
/**
|
|
@@ -12407,7 +12215,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12407
12215
|
/**
|
|
12408
12216
|
* CarrierServices service.
|
|
12409
12217
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
12410
|
-
* @version
|
|
12218
|
+
* @version 218.0.0
|
|
12411
12219
|
*/
|
|
12412
12220
|
|
|
12413
12221
|
/**
|
|
@@ -12477,7 +12285,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12477
12285
|
/**
|
|
12478
12286
|
* Chat service.
|
|
12479
12287
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
12480
|
-
* @version
|
|
12288
|
+
* @version 218.0.0
|
|
12481
12289
|
*/
|
|
12482
12290
|
|
|
12483
12291
|
/**
|
|
@@ -12617,7 +12425,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12617
12425
|
*
|
|
12618
12426
|
* @param {String} userId userId
|
|
12619
12427
|
* @param {String} pinnedMessageId pinnedMessageId
|
|
12620
|
-
* deleteChatsUserMessagesPin is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12621
12428
|
*/
|
|
12622
12429
|
deleteChatsUserMessagesPin(userId, pinnedMessageId) {
|
|
12623
12430
|
// verify the required parameter 'userId' is set
|
|
@@ -12864,7 +12671,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12864
12671
|
* Get information for a 1on1
|
|
12865
12672
|
*
|
|
12866
12673
|
* @param {String} userId userId
|
|
12867
|
-
* getChatsUser is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12868
12674
|
*/
|
|
12869
12675
|
getChatsUser(userId) {
|
|
12870
12676
|
// verify the required parameter 'userId' is set
|
|
@@ -12951,7 +12757,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12951
12757
|
* Get a user's chat settings
|
|
12952
12758
|
*
|
|
12953
12759
|
* @param {String} userId User ID
|
|
12954
|
-
* getChatsUserSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12955
12760
|
*/
|
|
12956
12761
|
getChatsUserSettings(userId) {
|
|
12957
12762
|
// verify the required parameter 'userId' is set
|
|
@@ -12976,7 +12781,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12976
12781
|
/**
|
|
12977
12782
|
* Get a user's chat settings
|
|
12978
12783
|
*
|
|
12979
|
-
* getChatsUsersMeSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12980
12784
|
*/
|
|
12981
12785
|
getChatsUsersMeSettings() {
|
|
12982
12786
|
|
|
@@ -13124,7 +12928,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13124
12928
|
*
|
|
13125
12929
|
* @param {String} userId User ID
|
|
13126
12930
|
* @param {Object} body
|
|
13127
|
-
* patchChatsUserSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13128
12931
|
*/
|
|
13129
12932
|
patchChatsUserSettings(userId, body) {
|
|
13130
12933
|
// verify the required parameter 'userId' is set
|
|
@@ -13154,7 +12957,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13154
12957
|
* Update a user's chat settings
|
|
13155
12958
|
*
|
|
13156
12959
|
* @param {Object} body
|
|
13157
|
-
* patchChatsUsersMeSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13158
12960
|
*/
|
|
13159
12961
|
patchChatsUsersMeSettings(body) {
|
|
13160
12962
|
// verify the required parameter 'body' is set
|
|
@@ -13326,7 +13128,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13326
13128
|
*
|
|
13327
13129
|
* @param {String} userId userId
|
|
13328
13130
|
* @param {Object} body Pinned Message Ids
|
|
13329
|
-
* postChatsUserMessagesPins is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13330
13131
|
*/
|
|
13331
13132
|
postChatsUserMessagesPins(userId, body) {
|
|
13332
13133
|
// verify the required parameter 'userId' is set
|
|
@@ -13413,7 +13214,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13413
13214
|
/**
|
|
13414
13215
|
* Coaching service.
|
|
13415
13216
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
13416
|
-
* @version
|
|
13217
|
+
* @version 218.0.0
|
|
13417
13218
|
*/
|
|
13418
13219
|
|
|
13419
13220
|
/**
|
|
@@ -13990,7 +13791,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13990
13791
|
/**
|
|
13991
13792
|
* ContentManagement service.
|
|
13992
13793
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
13993
|
-
* @version
|
|
13794
|
+
* @version 218.0.0
|
|
13994
13795
|
*/
|
|
13995
13796
|
|
|
13996
13797
|
/**
|
|
@@ -15071,7 +14872,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15071
14872
|
/**
|
|
15072
14873
|
* Conversations service.
|
|
15073
14874
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
15074
|
-
* @version
|
|
14875
|
+
* @version 218.0.0
|
|
15075
14876
|
*/
|
|
15076
14877
|
|
|
15077
14878
|
/**
|
|
@@ -15336,6 +15137,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15336
15137
|
);
|
|
15337
15138
|
}
|
|
15338
15139
|
|
|
15140
|
+
/**
|
|
15141
|
+
* Delete Twitter messaging integration
|
|
15142
|
+
*
|
|
15143
|
+
* @param {String} integrationId Integration ID
|
|
15144
|
+
*/
|
|
15145
|
+
deleteConversationsMessagingIntegrationsTwitterIntegrationId(integrationId) {
|
|
15146
|
+
// verify the required parameter 'integrationId' is set
|
|
15147
|
+
if (integrationId === undefined || integrationId === null) {
|
|
15148
|
+
throw 'Missing the required parameter "integrationId" when calling deleteConversationsMessagingIntegrationsTwitterIntegrationId';
|
|
15149
|
+
}
|
|
15150
|
+
|
|
15151
|
+
return this.apiClient.callApi(
|
|
15152
|
+
'/api/v2/conversations/messaging/integrations/twitter/{integrationId}',
|
|
15153
|
+
'DELETE',
|
|
15154
|
+
{ 'integrationId': integrationId },
|
|
15155
|
+
{ },
|
|
15156
|
+
{ },
|
|
15157
|
+
{ },
|
|
15158
|
+
null,
|
|
15159
|
+
['PureCloud OAuth'],
|
|
15160
|
+
['application/json'],
|
|
15161
|
+
['application/json']
|
|
15162
|
+
);
|
|
15163
|
+
}
|
|
15164
|
+
|
|
15339
15165
|
/**
|
|
15340
15166
|
* Delete a WhatsApp messaging integration
|
|
15341
15167
|
*
|
|
@@ -17248,6 +17074,109 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17248
17074
|
);
|
|
17249
17075
|
}
|
|
17250
17076
|
|
|
17077
|
+
/**
|
|
17078
|
+
* Get Facebook messaging integration identity resolution settings
|
|
17079
|
+
*
|
|
17080
|
+
* @param {String} integrationId Integration ID
|
|
17081
|
+
* getConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17082
|
+
*/
|
|
17083
|
+
getConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId(integrationId) {
|
|
17084
|
+
// verify the required parameter 'integrationId' is set
|
|
17085
|
+
if (integrationId === undefined || integrationId === null) {
|
|
17086
|
+
throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId';
|
|
17087
|
+
}
|
|
17088
|
+
|
|
17089
|
+
return this.apiClient.callApi(
|
|
17090
|
+
'/api/v2/conversations/messaging/identityresolution/integrations/facebook/{integrationId}',
|
|
17091
|
+
'GET',
|
|
17092
|
+
{ 'integrationId': integrationId },
|
|
17093
|
+
{ },
|
|
17094
|
+
{ },
|
|
17095
|
+
{ },
|
|
17096
|
+
null,
|
|
17097
|
+
['PureCloud OAuth'],
|
|
17098
|
+
['application/json'],
|
|
17099
|
+
['application/json']
|
|
17100
|
+
);
|
|
17101
|
+
}
|
|
17102
|
+
|
|
17103
|
+
/**
|
|
17104
|
+
* Get an open messaging integration Identity Resolution settings
|
|
17105
|
+
*
|
|
17106
|
+
* @param {String} integrationId Integration ID
|
|
17107
|
+
* getConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17108
|
+
*/
|
|
17109
|
+
getConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId(integrationId) {
|
|
17110
|
+
// verify the required parameter 'integrationId' is set
|
|
17111
|
+
if (integrationId === undefined || integrationId === null) {
|
|
17112
|
+
throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId';
|
|
17113
|
+
}
|
|
17114
|
+
|
|
17115
|
+
return this.apiClient.callApi(
|
|
17116
|
+
'/api/v2/conversations/messaging/identityresolution/integrations/open/{integrationId}',
|
|
17117
|
+
'GET',
|
|
17118
|
+
{ 'integrationId': integrationId },
|
|
17119
|
+
{ },
|
|
17120
|
+
{ },
|
|
17121
|
+
{ },
|
|
17122
|
+
null,
|
|
17123
|
+
['PureCloud OAuth'],
|
|
17124
|
+
['application/json'],
|
|
17125
|
+
['application/json']
|
|
17126
|
+
);
|
|
17127
|
+
}
|
|
17128
|
+
|
|
17129
|
+
/**
|
|
17130
|
+
* Get a whatsApp integration Identity Resolution settings
|
|
17131
|
+
*
|
|
17132
|
+
* @param {String} integrationId Integration ID
|
|
17133
|
+
* getConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17134
|
+
*/
|
|
17135
|
+
getConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId(integrationId) {
|
|
17136
|
+
// verify the required parameter 'integrationId' is set
|
|
17137
|
+
if (integrationId === undefined || integrationId === null) {
|
|
17138
|
+
throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId';
|
|
17139
|
+
}
|
|
17140
|
+
|
|
17141
|
+
return this.apiClient.callApi(
|
|
17142
|
+
'/api/v2/conversations/messaging/identityresolution/integrations/whatsapp/{integrationId}',
|
|
17143
|
+
'GET',
|
|
17144
|
+
{ 'integrationId': integrationId },
|
|
17145
|
+
{ },
|
|
17146
|
+
{ },
|
|
17147
|
+
{ },
|
|
17148
|
+
null,
|
|
17149
|
+
['PureCloud OAuth'],
|
|
17150
|
+
['application/json'],
|
|
17151
|
+
['application/json']
|
|
17152
|
+
);
|
|
17153
|
+
}
|
|
17154
|
+
|
|
17155
|
+
/**
|
|
17156
|
+
* Get twitter oauth settings to patch an integration
|
|
17157
|
+
*
|
|
17158
|
+
* @param {String} integrationId Integration Id of an existing integration that needs to be patched with new oauth settings
|
|
17159
|
+
*/
|
|
17160
|
+
getConversationsMessagingIntegrationTwitterOauthSettings(integrationId) {
|
|
17161
|
+
// verify the required parameter 'integrationId' is set
|
|
17162
|
+
if (integrationId === undefined || integrationId === null) {
|
|
17163
|
+
throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIntegrationTwitterOauthSettings';
|
|
17164
|
+
}
|
|
17165
|
+
|
|
17166
|
+
return this.apiClient.callApi(
|
|
17167
|
+
'/api/v2/conversations/messaging/integrations/{integrationId}/twitter/oauth/settings',
|
|
17168
|
+
'GET',
|
|
17169
|
+
{ 'integrationId': integrationId },
|
|
17170
|
+
{ },
|
|
17171
|
+
{ },
|
|
17172
|
+
{ },
|
|
17173
|
+
null,
|
|
17174
|
+
['PureCloud OAuth'],
|
|
17175
|
+
['application/json'],
|
|
17176
|
+
['application/json']
|
|
17177
|
+
);
|
|
17178
|
+
}
|
|
17179
|
+
|
|
17251
17180
|
/**
|
|
17252
17181
|
* Get a list of Integrations
|
|
17253
17182
|
*
|
|
@@ -17447,6 +17376,83 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17447
17376
|
);
|
|
17448
17377
|
}
|
|
17449
17378
|
|
|
17379
|
+
/**
|
|
17380
|
+
* Get a list of Twitter Integrations
|
|
17381
|
+
*
|
|
17382
|
+
* @param {Object} opts Optional parameters
|
|
17383
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
17384
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
17385
|
+
* @param {Object} opts.expand Expand instructions for the return value.
|
|
17386
|
+
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
17387
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
17388
|
+
*/
|
|
17389
|
+
getConversationsMessagingIntegrationsTwitter(opts) {
|
|
17390
|
+
opts = opts || {};
|
|
17391
|
+
|
|
17392
|
+
|
|
17393
|
+
return this.apiClient.callApi(
|
|
17394
|
+
'/api/v2/conversations/messaging/integrations/twitter',
|
|
17395
|
+
'GET',
|
|
17396
|
+
{ },
|
|
17397
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
17398
|
+
{ },
|
|
17399
|
+
{ },
|
|
17400
|
+
null,
|
|
17401
|
+
['PureCloud OAuth'],
|
|
17402
|
+
['application/json'],
|
|
17403
|
+
['application/json']
|
|
17404
|
+
);
|
|
17405
|
+
}
|
|
17406
|
+
|
|
17407
|
+
/**
|
|
17408
|
+
* Get Twitter messaging integration
|
|
17409
|
+
*
|
|
17410
|
+
* @param {String} integrationId Integration ID
|
|
17411
|
+
* @param {Object} opts Optional parameters
|
|
17412
|
+
* @param {Object} opts.expand Expand instructions for the return value.
|
|
17413
|
+
*/
|
|
17414
|
+
getConversationsMessagingIntegrationsTwitterIntegrationId(integrationId, opts) {
|
|
17415
|
+
opts = opts || {};
|
|
17416
|
+
|
|
17417
|
+
// verify the required parameter 'integrationId' is set
|
|
17418
|
+
if (integrationId === undefined || integrationId === null) {
|
|
17419
|
+
throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIntegrationsTwitterIntegrationId';
|
|
17420
|
+
}
|
|
17421
|
+
|
|
17422
|
+
return this.apiClient.callApi(
|
|
17423
|
+
'/api/v2/conversations/messaging/integrations/twitter/{integrationId}',
|
|
17424
|
+
'GET',
|
|
17425
|
+
{ 'integrationId': integrationId },
|
|
17426
|
+
{ 'expand': opts['expand'] },
|
|
17427
|
+
{ },
|
|
17428
|
+
{ },
|
|
17429
|
+
null,
|
|
17430
|
+
['PureCloud OAuth'],
|
|
17431
|
+
['application/json'],
|
|
17432
|
+
['application/json']
|
|
17433
|
+
);
|
|
17434
|
+
}
|
|
17435
|
+
|
|
17436
|
+
/**
|
|
17437
|
+
* Get twitter oauth settings
|
|
17438
|
+
*
|
|
17439
|
+
*/
|
|
17440
|
+
getConversationsMessagingIntegrationsTwitterOauthSettings() {
|
|
17441
|
+
|
|
17442
|
+
return this.apiClient.callApi(
|
|
17443
|
+
'/api/v2/conversations/messaging/integrations/twitter/oauth/settings',
|
|
17444
|
+
'GET',
|
|
17445
|
+
{ },
|
|
17446
|
+
{ },
|
|
17447
|
+
{ },
|
|
17448
|
+
{ },
|
|
17449
|
+
null,
|
|
17450
|
+
['PureCloud OAuth'],
|
|
17451
|
+
['application/json'],
|
|
17452
|
+
['application/json']
|
|
17453
|
+
);
|
|
17454
|
+
}
|
|
17455
|
+
|
|
17450
17456
|
/**
|
|
17451
17457
|
* Get a list of WhatsApp Integrations
|
|
17452
17458
|
*
|
|
@@ -19084,6 +19090,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19084
19090
|
);
|
|
19085
19091
|
}
|
|
19086
19092
|
|
|
19093
|
+
/**
|
|
19094
|
+
* Update a Twitter messaging integration
|
|
19095
|
+
*
|
|
19096
|
+
* @param {String} integrationId Integration ID
|
|
19097
|
+
* @param {Object} body TwitterIntegrationUpdateRequest
|
|
19098
|
+
*/
|
|
19099
|
+
patchConversationsMessagingIntegrationsTwitterIntegrationId(integrationId, body) {
|
|
19100
|
+
// verify the required parameter 'integrationId' is set
|
|
19101
|
+
if (integrationId === undefined || integrationId === null) {
|
|
19102
|
+
throw 'Missing the required parameter "integrationId" when calling patchConversationsMessagingIntegrationsTwitterIntegrationId';
|
|
19103
|
+
}
|
|
19104
|
+
// verify the required parameter 'body' is set
|
|
19105
|
+
if (body === undefined || body === null) {
|
|
19106
|
+
throw 'Missing the required parameter "body" when calling patchConversationsMessagingIntegrationsTwitterIntegrationId';
|
|
19107
|
+
}
|
|
19108
|
+
|
|
19109
|
+
return this.apiClient.callApi(
|
|
19110
|
+
'/api/v2/conversations/messaging/integrations/twitter/{integrationId}',
|
|
19111
|
+
'PATCH',
|
|
19112
|
+
{ 'integrationId': integrationId },
|
|
19113
|
+
{ },
|
|
19114
|
+
{ },
|
|
19115
|
+
{ },
|
|
19116
|
+
body,
|
|
19117
|
+
['PureCloud OAuth'],
|
|
19118
|
+
['application/json'],
|
|
19119
|
+
['application/json']
|
|
19120
|
+
);
|
|
19121
|
+
}
|
|
19122
|
+
|
|
19087
19123
|
/**
|
|
19088
19124
|
* Activate a WhatsApp messaging integration created using the WhatsApp embedded signup flow
|
|
19089
19125
|
* Please specify the phone number to associate with this WhatsApp integration from the list of available phone numbers returned to you in the POST call to create the integration. You can then run a GET on the integration to check if its status has been updated to Active
|
|
@@ -21420,6 +21456,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21420
21456
|
);
|
|
21421
21457
|
}
|
|
21422
21458
|
|
|
21459
|
+
/**
|
|
21460
|
+
* Create Twitter Integration
|
|
21461
|
+
*
|
|
21462
|
+
* @param {Object} body TwitterIntegrationRequest
|
|
21463
|
+
*/
|
|
21464
|
+
postConversationsMessagingIntegrationsTwitter(body) {
|
|
21465
|
+
// verify the required parameter 'body' is set
|
|
21466
|
+
if (body === undefined || body === null) {
|
|
21467
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsTwitter';
|
|
21468
|
+
}
|
|
21469
|
+
|
|
21470
|
+
return this.apiClient.callApi(
|
|
21471
|
+
'/api/v2/conversations/messaging/integrations/twitter',
|
|
21472
|
+
'POST',
|
|
21473
|
+
{ },
|
|
21474
|
+
{ },
|
|
21475
|
+
{ },
|
|
21476
|
+
{ },
|
|
21477
|
+
body,
|
|
21478
|
+
['PureCloud OAuth'],
|
|
21479
|
+
['application/json'],
|
|
21480
|
+
['application/json']
|
|
21481
|
+
);
|
|
21482
|
+
}
|
|
21483
|
+
|
|
21423
21484
|
/**
|
|
21424
21485
|
* [This API is deprecated. Use POST /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup instead] Create a WhatsApp Integration
|
|
21425
21486
|
* [This API is deprecated. Use POST /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup instead] You must be approved by WhatsApp to use this feature. Your approved e164-formatted phone number and valid WhatsApp certificate for your number are required. Your WhatsApp certificate must have valid base64 encoding. Please paste carefully and do not add any leading or trailing spaces. Do not alter any characters. An integration must be activated within 7 days of certificate generation. If you cannot complete the addition and activation of the number within 7 days, please obtain a new certificate before creating the integration. Integrations created with an invalid number or certificate may immediately incur additional integration fees. Please carefully enter your number and certificate as described.
|
|
@@ -21625,6 +21686,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21625
21686
|
);
|
|
21626
21687
|
}
|
|
21627
21688
|
|
|
21689
|
+
/**
|
|
21690
|
+
* Create an Agent-Type video conference and assign an agent to it
|
|
21691
|
+
*
|
|
21692
|
+
* @param {String} conversationId conversationId
|
|
21693
|
+
* @param {String} communicationId communicationId
|
|
21694
|
+
* postConversationsVideoAgentconferenceCommunication is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21695
|
+
*/
|
|
21696
|
+
postConversationsVideoAgentconferenceCommunication(conversationId, communicationId) {
|
|
21697
|
+
// verify the required parameter 'conversationId' is set
|
|
21698
|
+
if (conversationId === undefined || conversationId === null) {
|
|
21699
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationsVideoAgentconferenceCommunication';
|
|
21700
|
+
}
|
|
21701
|
+
// verify the required parameter 'communicationId' is set
|
|
21702
|
+
if (communicationId === undefined || communicationId === null) {
|
|
21703
|
+
throw 'Missing the required parameter "communicationId" when calling postConversationsVideoAgentconferenceCommunication';
|
|
21704
|
+
}
|
|
21705
|
+
|
|
21706
|
+
return this.apiClient.callApi(
|
|
21707
|
+
'/api/v2/conversations/videos/{conversationId}/agentconference/communications/{communicationId}',
|
|
21708
|
+
'POST',
|
|
21709
|
+
{ 'conversationId': conversationId,'communicationId': communicationId },
|
|
21710
|
+
{ },
|
|
21711
|
+
{ },
|
|
21712
|
+
{ },
|
|
21713
|
+
null,
|
|
21714
|
+
['PureCloud OAuth'],
|
|
21715
|
+
['application/json'],
|
|
21716
|
+
['application/json']
|
|
21717
|
+
);
|
|
21718
|
+
}
|
|
21719
|
+
|
|
21628
21720
|
/**
|
|
21629
21721
|
* Apply wrap-up for this conversation communication
|
|
21630
21722
|
*
|
|
@@ -21913,9 +22005,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21913
22005
|
|
|
21914
22006
|
/**
|
|
21915
22007
|
* Update a conversation by setting its recording state
|
|
21916
|
-
*
|
|
22008
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
21917
22009
|
* @param {String} conversationId conversationId
|
|
21918
22010
|
* @param {Object} body SetRecordingState
|
|
22011
|
+
* @deprecated
|
|
21919
22012
|
*/
|
|
21920
22013
|
putConversationsCobrowsesessionRecordingstate(conversationId, body) {
|
|
21921
22014
|
// verify the required parameter 'conversationId' is set
|
|
@@ -22061,6 +22154,99 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22061
22154
|
);
|
|
22062
22155
|
}
|
|
22063
22156
|
|
|
22157
|
+
/**
|
|
22158
|
+
* Create an identity resolution settings for a Facebook messaging integration
|
|
22159
|
+
*
|
|
22160
|
+
* @param {String} integrationId Integration ID
|
|
22161
|
+
* @param {Object} body IdentityResolutionConfig
|
|
22162
|
+
* putConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
22163
|
+
*/
|
|
22164
|
+
putConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId(integrationId, body) {
|
|
22165
|
+
// verify the required parameter 'integrationId' is set
|
|
22166
|
+
if (integrationId === undefined || integrationId === null) {
|
|
22167
|
+
throw 'Missing the required parameter "integrationId" when calling putConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId';
|
|
22168
|
+
}
|
|
22169
|
+
// verify the required parameter 'body' is set
|
|
22170
|
+
if (body === undefined || body === null) {
|
|
22171
|
+
throw 'Missing the required parameter "body" when calling putConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId';
|
|
22172
|
+
}
|
|
22173
|
+
|
|
22174
|
+
return this.apiClient.callApi(
|
|
22175
|
+
'/api/v2/conversations/messaging/identityresolution/integrations/facebook/{integrationId}',
|
|
22176
|
+
'PUT',
|
|
22177
|
+
{ 'integrationId': integrationId },
|
|
22178
|
+
{ },
|
|
22179
|
+
{ },
|
|
22180
|
+
{ },
|
|
22181
|
+
body,
|
|
22182
|
+
['PureCloud OAuth'],
|
|
22183
|
+
['application/json'],
|
|
22184
|
+
['application/json']
|
|
22185
|
+
);
|
|
22186
|
+
}
|
|
22187
|
+
|
|
22188
|
+
/**
|
|
22189
|
+
* Update an open messaging integration Identity Resolution settings
|
|
22190
|
+
*
|
|
22191
|
+
* @param {String} integrationId Integration ID
|
|
22192
|
+
* @param {Object} body
|
|
22193
|
+
* putConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
22194
|
+
*/
|
|
22195
|
+
putConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId(integrationId, body) {
|
|
22196
|
+
// verify the required parameter 'integrationId' is set
|
|
22197
|
+
if (integrationId === undefined || integrationId === null) {
|
|
22198
|
+
throw 'Missing the required parameter "integrationId" when calling putConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId';
|
|
22199
|
+
}
|
|
22200
|
+
// verify the required parameter 'body' is set
|
|
22201
|
+
if (body === undefined || body === null) {
|
|
22202
|
+
throw 'Missing the required parameter "body" when calling putConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId';
|
|
22203
|
+
}
|
|
22204
|
+
|
|
22205
|
+
return this.apiClient.callApi(
|
|
22206
|
+
'/api/v2/conversations/messaging/identityresolution/integrations/open/{integrationId}',
|
|
22207
|
+
'PUT',
|
|
22208
|
+
{ 'integrationId': integrationId },
|
|
22209
|
+
{ },
|
|
22210
|
+
{ },
|
|
22211
|
+
{ },
|
|
22212
|
+
body,
|
|
22213
|
+
['PureCloud OAuth'],
|
|
22214
|
+
['application/json'],
|
|
22215
|
+
['application/json']
|
|
22216
|
+
);
|
|
22217
|
+
}
|
|
22218
|
+
|
|
22219
|
+
/**
|
|
22220
|
+
* Update a whatsApp integration Identity Resolution settings
|
|
22221
|
+
*
|
|
22222
|
+
* @param {String} integrationId Integration ID
|
|
22223
|
+
* @param {Object} body
|
|
22224
|
+
* putConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
22225
|
+
*/
|
|
22226
|
+
putConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId(integrationId, body) {
|
|
22227
|
+
// verify the required parameter 'integrationId' is set
|
|
22228
|
+
if (integrationId === undefined || integrationId === null) {
|
|
22229
|
+
throw 'Missing the required parameter "integrationId" when calling putConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId';
|
|
22230
|
+
}
|
|
22231
|
+
// verify the required parameter 'body' is set
|
|
22232
|
+
if (body === undefined || body === null) {
|
|
22233
|
+
throw 'Missing the required parameter "body" when calling putConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId';
|
|
22234
|
+
}
|
|
22235
|
+
|
|
22236
|
+
return this.apiClient.callApi(
|
|
22237
|
+
'/api/v2/conversations/messaging/identityresolution/integrations/whatsapp/{integrationId}',
|
|
22238
|
+
'PUT',
|
|
22239
|
+
{ 'integrationId': integrationId },
|
|
22240
|
+
{ },
|
|
22241
|
+
{ },
|
|
22242
|
+
{ },
|
|
22243
|
+
body,
|
|
22244
|
+
['PureCloud OAuth'],
|
|
22245
|
+
['application/json'],
|
|
22246
|
+
['application/json']
|
|
22247
|
+
);
|
|
22248
|
+
}
|
|
22249
|
+
|
|
22064
22250
|
/**
|
|
22065
22251
|
* Set the organization's default setting that may be applied to to integrations without settings
|
|
22066
22252
|
* 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.
|
|
@@ -22233,7 +22419,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22233
22419
|
/**
|
|
22234
22420
|
* DataExtensions service.
|
|
22235
22421
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
22236
|
-
* @version
|
|
22422
|
+
* @version 218.0.0
|
|
22237
22423
|
*/
|
|
22238
22424
|
|
|
22239
22425
|
/**
|
|
@@ -22319,7 +22505,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22319
22505
|
/**
|
|
22320
22506
|
* DataPrivacy service.
|
|
22321
22507
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
22322
|
-
* @version
|
|
22508
|
+
* @version 218.0.0
|
|
22323
22509
|
*/
|
|
22324
22510
|
|
|
22325
22511
|
/**
|
|
@@ -22489,7 +22675,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22489
22675
|
/**
|
|
22490
22676
|
* Downloads service.
|
|
22491
22677
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
22492
|
-
* @version
|
|
22678
|
+
* @version 218.0.0
|
|
22493
22679
|
*/
|
|
22494
22680
|
|
|
22495
22681
|
/**
|
|
@@ -22541,7 +22727,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22541
22727
|
/**
|
|
22542
22728
|
* Emails service.
|
|
22543
22729
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
22544
|
-
* @version
|
|
22730
|
+
* @version 218.0.0
|
|
22545
22731
|
*/
|
|
22546
22732
|
|
|
22547
22733
|
/**
|
|
@@ -22606,7 +22792,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22606
22792
|
/**
|
|
22607
22793
|
* EmployeeEngagement service.
|
|
22608
22794
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
22609
|
-
* @version
|
|
22795
|
+
* @version 218.0.0
|
|
22610
22796
|
*/
|
|
22611
22797
|
|
|
22612
22798
|
/**
|
|
@@ -22757,7 +22943,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22757
22943
|
/**
|
|
22758
22944
|
* Events service.
|
|
22759
22945
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
22760
|
-
* @version
|
|
22946
|
+
* @version 218.0.0
|
|
22761
22947
|
*/
|
|
22762
22948
|
|
|
22763
22949
|
/**
|
|
@@ -22853,7 +23039,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22853
23039
|
/**
|
|
22854
23040
|
* ExternalContacts service.
|
|
22855
23041
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
22856
|
-
* @version
|
|
23042
|
+
* @version 218.0.0
|
|
22857
23043
|
*/
|
|
22858
23044
|
|
|
22859
23045
|
/**
|
|
@@ -23317,6 +23503,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23317
23503
|
* @param {String} opts.q User supplied search keywords (no special syntax is currently supported)
|
|
23318
23504
|
* @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
|
|
23319
23505
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
23506
|
+
* @param {Array.<String>} opts.divisionIds which divisions to search, up to 50
|
|
23320
23507
|
*/
|
|
23321
23508
|
getExternalcontactsContacts(opts) {
|
|
23322
23509
|
opts = opts || {};
|
|
@@ -23326,7 +23513,58 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23326
23513
|
'/api/v2/externalcontacts/contacts',
|
|
23327
23514
|
'GET',
|
|
23328
23515
|
{ },
|
|
23329
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'q': opts['q'],'sortOrder': opts['sortOrder'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
23516
|
+
{ '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') },
|
|
23517
|
+
{ },
|
|
23518
|
+
{ },
|
|
23519
|
+
null,
|
|
23520
|
+
['PureCloud OAuth'],
|
|
23521
|
+
['application/json'],
|
|
23522
|
+
['application/json']
|
|
23523
|
+
);
|
|
23524
|
+
}
|
|
23525
|
+
|
|
23526
|
+
/**
|
|
23527
|
+
* Get export for exportId
|
|
23528
|
+
*
|
|
23529
|
+
* @param {String} exportId Export id
|
|
23530
|
+
*/
|
|
23531
|
+
getExternalcontactsContactsExport(exportId) {
|
|
23532
|
+
// verify the required parameter 'exportId' is set
|
|
23533
|
+
if (exportId === undefined || exportId === null) {
|
|
23534
|
+
throw 'Missing the required parameter "exportId" when calling getExternalcontactsContactsExport';
|
|
23535
|
+
}
|
|
23536
|
+
|
|
23537
|
+
return this.apiClient.callApi(
|
|
23538
|
+
'/api/v2/externalcontacts/contacts/exports/{exportId}',
|
|
23539
|
+
'GET',
|
|
23540
|
+
{ 'exportId': exportId },
|
|
23541
|
+
{ },
|
|
23542
|
+
{ },
|
|
23543
|
+
{ },
|
|
23544
|
+
null,
|
|
23545
|
+
['PureCloud OAuth'],
|
|
23546
|
+
['application/json'],
|
|
23547
|
+
['application/json']
|
|
23548
|
+
);
|
|
23549
|
+
}
|
|
23550
|
+
|
|
23551
|
+
/**
|
|
23552
|
+
* List exports for organization
|
|
23553
|
+
*
|
|
23554
|
+
* @param {Object} opts Optional parameters
|
|
23555
|
+
* @param {Array.<String>} opts.divisionIds Division IDs of entities
|
|
23556
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities
|
|
23557
|
+
* @param {Number} opts.pageSize Number of entities to return
|
|
23558
|
+
*/
|
|
23559
|
+
getExternalcontactsContactsExports(opts) {
|
|
23560
|
+
opts = opts || {};
|
|
23561
|
+
|
|
23562
|
+
|
|
23563
|
+
return this.apiClient.callApi(
|
|
23564
|
+
'/api/v2/externalcontacts/contacts/exports',
|
|
23565
|
+
'GET',
|
|
23566
|
+
{ },
|
|
23567
|
+
{ 'divisionIds': this.apiClient.buildCollectionParam(opts['divisionIds'], 'multi'),'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
23330
23568
|
{ },
|
|
23331
23569
|
{ },
|
|
23332
23570
|
null,
|
|
@@ -23870,6 +24108,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23870
24108
|
* @param {String} opts.sortOrder The Organization field to sort by. Any of: [companyType, industry, name]. Direction: [asc, desc]. e.g. companyType:asc, industry:desc
|
|
23871
24109
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
23872
24110
|
* @param {Boolean} opts.includeTrustors (true or false) whether or not to include trustor information embedded in the externalOrganization
|
|
24111
|
+
* @param {Array.<String>} opts.divisionIds which divisions to search, up to 50
|
|
23873
24112
|
*/
|
|
23874
24113
|
getExternalcontactsOrganizations(opts) {
|
|
23875
24114
|
opts = opts || {};
|
|
@@ -23879,7 +24118,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23879
24118
|
'/api/v2/externalcontacts/organizations',
|
|
23880
24119
|
'GET',
|
|
23881
24120
|
{ },
|
|
23882
|
-
{ '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'] },
|
|
24121
|
+
{ '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') },
|
|
23883
24122
|
{ },
|
|
23884
24123
|
{ },
|
|
23885
24124
|
null,
|
|
@@ -24024,6 +24263,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24024
24263
|
* @param {String} lookupVal User supplied value to lookup contacts/externalOrganizations (supports email addresses, e164 phone numbers, Twitter screen names)
|
|
24025
24264
|
* @param {Object} opts Optional parameters
|
|
24026
24265
|
* @param {Array.<String>} opts.expand which field, if any, to expand
|
|
24266
|
+
* @param {String} opts.divisionId Specifies which division to lookup contacts/externalOrganizations in, for the given lookup value (default to *)
|
|
24027
24267
|
*/
|
|
24028
24268
|
getExternalcontactsReversewhitepageslookup(lookupVal, opts) {
|
|
24029
24269
|
opts = opts || {};
|
|
@@ -24037,7 +24277,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24037
24277
|
'/api/v2/externalcontacts/reversewhitepageslookup',
|
|
24038
24278
|
'GET',
|
|
24039
24279
|
{ },
|
|
24040
|
-
{ 'lookupVal': lookupVal,'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
24280
|
+
{ 'lookupVal': lookupVal,'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'divisionId': opts['divisionId'] },
|
|
24041
24281
|
{ },
|
|
24042
24282
|
{ },
|
|
24043
24283
|
null,
|
|
@@ -24053,6 +24293,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24053
24293
|
* @param {Object} opts Optional parameters
|
|
24054
24294
|
* @param {Number} opts.limit The number of contacts per page; must be between 10 and 200, default is 100
|
|
24055
24295
|
* @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
|
|
24296
|
+
* @param {String} opts.divisionId The division to scan over (default to *)
|
|
24056
24297
|
*/
|
|
24057
24298
|
getExternalcontactsScanContacts(opts) {
|
|
24058
24299
|
opts = opts || {};
|
|
@@ -24062,6 +24303,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24062
24303
|
'/api/v2/externalcontacts/scan/contacts',
|
|
24063
24304
|
'GET',
|
|
24064
24305
|
{ },
|
|
24306
|
+
{ 'limit': opts['limit'],'cursor': opts['cursor'],'divisionId': opts['divisionId'] },
|
|
24307
|
+
{ },
|
|
24308
|
+
{ },
|
|
24309
|
+
null,
|
|
24310
|
+
['PureCloud OAuth'],
|
|
24311
|
+
['application/json'],
|
|
24312
|
+
['application/json']
|
|
24313
|
+
);
|
|
24314
|
+
}
|
|
24315
|
+
|
|
24316
|
+
/**
|
|
24317
|
+
* Scan for external contacts using paging
|
|
24318
|
+
*
|
|
24319
|
+
* @param {Object} opts Optional parameters
|
|
24320
|
+
* @param {Number} opts.limit The number of contacts per page; must be between 10 and 200, default is 100
|
|
24321
|
+
* @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
|
|
24322
|
+
* getExternalcontactsScanContactsDivisionviewsAll is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24323
|
+
*/
|
|
24324
|
+
getExternalcontactsScanContactsDivisionviewsAll(opts) {
|
|
24325
|
+
opts = opts || {};
|
|
24326
|
+
|
|
24327
|
+
|
|
24328
|
+
return this.apiClient.callApi(
|
|
24329
|
+
'/api/v2/externalcontacts/scan/contacts/divisionviews/all',
|
|
24330
|
+
'GET',
|
|
24331
|
+
{ },
|
|
24065
24332
|
{ 'limit': opts['limit'],'cursor': opts['cursor'] },
|
|
24066
24333
|
{ },
|
|
24067
24334
|
{ },
|
|
@@ -24078,6 +24345,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24078
24345
|
* @param {Object} opts Optional parameters
|
|
24079
24346
|
* @param {Number} opts.limit The number of notes per page; must be between 10 and 200, default is 100
|
|
24080
24347
|
* @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
|
|
24348
|
+
* @param {String} opts.divisionId The division to scan over (default to *)
|
|
24081
24349
|
*/
|
|
24082
24350
|
getExternalcontactsScanNotes(opts) {
|
|
24083
24351
|
opts = opts || {};
|
|
@@ -24087,6 +24355,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24087
24355
|
'/api/v2/externalcontacts/scan/notes',
|
|
24088
24356
|
'GET',
|
|
24089
24357
|
{ },
|
|
24358
|
+
{ 'limit': opts['limit'],'cursor': opts['cursor'],'divisionId': opts['divisionId'] },
|
|
24359
|
+
{ },
|
|
24360
|
+
{ },
|
|
24361
|
+
null,
|
|
24362
|
+
['PureCloud OAuth'],
|
|
24363
|
+
['application/json'],
|
|
24364
|
+
['application/json']
|
|
24365
|
+
);
|
|
24366
|
+
}
|
|
24367
|
+
|
|
24368
|
+
/**
|
|
24369
|
+
* Scan for notes using paging
|
|
24370
|
+
*
|
|
24371
|
+
* @param {Object} opts Optional parameters
|
|
24372
|
+
* @param {Number} opts.limit The number of notes per page; must be between 10 and 200, default is 100
|
|
24373
|
+
* @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
|
|
24374
|
+
* getExternalcontactsScanNotesDivisionviewsAll is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24375
|
+
*/
|
|
24376
|
+
getExternalcontactsScanNotesDivisionviewsAll(opts) {
|
|
24377
|
+
opts = opts || {};
|
|
24378
|
+
|
|
24379
|
+
|
|
24380
|
+
return this.apiClient.callApi(
|
|
24381
|
+
'/api/v2/externalcontacts/scan/notes/divisionviews/all',
|
|
24382
|
+
'GET',
|
|
24383
|
+
{ },
|
|
24090
24384
|
{ 'limit': opts['limit'],'cursor': opts['cursor'] },
|
|
24091
24385
|
{ },
|
|
24092
24386
|
{ },
|
|
@@ -24103,6 +24397,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24103
24397
|
* @param {Object} opts Optional parameters
|
|
24104
24398
|
* @param {Number} opts.limit The number of organizations per page; must be between 10 and 200, default is 100
|
|
24105
24399
|
* @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
|
|
24400
|
+
* @param {String} opts.divisionId The division to scan over (default to *)
|
|
24106
24401
|
*/
|
|
24107
24402
|
getExternalcontactsScanOrganizations(opts) {
|
|
24108
24403
|
opts = opts || {};
|
|
@@ -24112,6 +24407,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24112
24407
|
'/api/v2/externalcontacts/scan/organizations',
|
|
24113
24408
|
'GET',
|
|
24114
24409
|
{ },
|
|
24410
|
+
{ 'limit': opts['limit'],'cursor': opts['cursor'],'divisionId': opts['divisionId'] },
|
|
24411
|
+
{ },
|
|
24412
|
+
{ },
|
|
24413
|
+
null,
|
|
24414
|
+
['PureCloud OAuth'],
|
|
24415
|
+
['application/json'],
|
|
24416
|
+
['application/json']
|
|
24417
|
+
);
|
|
24418
|
+
}
|
|
24419
|
+
|
|
24420
|
+
/**
|
|
24421
|
+
* Scan for external organizations using paging
|
|
24422
|
+
*
|
|
24423
|
+
* @param {Object} opts Optional parameters
|
|
24424
|
+
* @param {Number} opts.limit The number of organizations per page; must be between 10 and 200, default is 100
|
|
24425
|
+
* @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
|
|
24426
|
+
* getExternalcontactsScanOrganizationsDivisionviewsAll is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24427
|
+
*/
|
|
24428
|
+
getExternalcontactsScanOrganizationsDivisionviewsAll(opts) {
|
|
24429
|
+
opts = opts || {};
|
|
24430
|
+
|
|
24431
|
+
|
|
24432
|
+
return this.apiClient.callApi(
|
|
24433
|
+
'/api/v2/externalcontacts/scan/organizations/divisionviews/all',
|
|
24434
|
+
'GET',
|
|
24435
|
+
{ },
|
|
24115
24436
|
{ 'limit': opts['limit'],'cursor': opts['cursor'] },
|
|
24116
24437
|
{ },
|
|
24117
24438
|
{ },
|
|
@@ -24128,6 +24449,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24128
24449
|
* @param {Object} opts Optional parameters
|
|
24129
24450
|
* @param {Number} opts.limit The number of relationships per page; must be between 10 and 200, default is 100
|
|
24130
24451
|
* @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
|
|
24452
|
+
* @param {String} opts.divisionId The division to scan over (default to *)
|
|
24131
24453
|
*/
|
|
24132
24454
|
getExternalcontactsScanRelationships(opts) {
|
|
24133
24455
|
opts = opts || {};
|
|
@@ -24137,6 +24459,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24137
24459
|
'/api/v2/externalcontacts/scan/relationships',
|
|
24138
24460
|
'GET',
|
|
24139
24461
|
{ },
|
|
24462
|
+
{ 'limit': opts['limit'],'cursor': opts['cursor'],'divisionId': opts['divisionId'] },
|
|
24463
|
+
{ },
|
|
24464
|
+
{ },
|
|
24465
|
+
null,
|
|
24466
|
+
['PureCloud OAuth'],
|
|
24467
|
+
['application/json'],
|
|
24468
|
+
['application/json']
|
|
24469
|
+
);
|
|
24470
|
+
}
|
|
24471
|
+
|
|
24472
|
+
/**
|
|
24473
|
+
* Scan for relationships
|
|
24474
|
+
*
|
|
24475
|
+
* @param {Object} opts Optional parameters
|
|
24476
|
+
* @param {Number} opts.limit The number of relationships per page; must be between 10 and 200, default is 100
|
|
24477
|
+
* @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
|
|
24478
|
+
* getExternalcontactsScanRelationshipsDivisionviewsAll is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24479
|
+
*/
|
|
24480
|
+
getExternalcontactsScanRelationshipsDivisionviewsAll(opts) {
|
|
24481
|
+
opts = opts || {};
|
|
24482
|
+
|
|
24483
|
+
|
|
24484
|
+
return this.apiClient.callApi(
|
|
24485
|
+
'/api/v2/externalcontacts/scan/relationships/divisionviews/all',
|
|
24486
|
+
'GET',
|
|
24487
|
+
{ },
|
|
24140
24488
|
{ 'limit': opts['limit'],'cursor': opts['cursor'] },
|
|
24141
24489
|
{ },
|
|
24142
24490
|
{ },
|
|
@@ -24227,6 +24575,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24227
24575
|
);
|
|
24228
24576
|
}
|
|
24229
24577
|
|
|
24578
|
+
/**
|
|
24579
|
+
* Bulk fetch contacts across divisions
|
|
24580
|
+
*
|
|
24581
|
+
* @param {Object} body Contact ids
|
|
24582
|
+
* postExternalcontactsBulkContactsDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24583
|
+
*/
|
|
24584
|
+
postExternalcontactsBulkContactsDivisionviews(body) {
|
|
24585
|
+
// verify the required parameter 'body' is set
|
|
24586
|
+
if (body === undefined || body === null) {
|
|
24587
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsBulkContactsDivisionviews';
|
|
24588
|
+
}
|
|
24589
|
+
|
|
24590
|
+
return this.apiClient.callApi(
|
|
24591
|
+
'/api/v2/externalcontacts/bulk/contacts/divisionviews',
|
|
24592
|
+
'POST',
|
|
24593
|
+
{ },
|
|
24594
|
+
{ },
|
|
24595
|
+
{ },
|
|
24596
|
+
{ },
|
|
24597
|
+
body,
|
|
24598
|
+
['PureCloud OAuth'],
|
|
24599
|
+
['application/json'],
|
|
24600
|
+
['application/json']
|
|
24601
|
+
);
|
|
24602
|
+
}
|
|
24603
|
+
|
|
24230
24604
|
/**
|
|
24231
24605
|
* Bulk remove contacts
|
|
24232
24606
|
*
|
|
@@ -24452,6 +24826,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24452
24826
|
);
|
|
24453
24827
|
}
|
|
24454
24828
|
|
|
24829
|
+
/**
|
|
24830
|
+
* Bulk fetch organizations across divisions
|
|
24831
|
+
*
|
|
24832
|
+
* @param {Object} body Organizations ids
|
|
24833
|
+
* postExternalcontactsBulkOrganizationsDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24834
|
+
*/
|
|
24835
|
+
postExternalcontactsBulkOrganizationsDivisionviews(body) {
|
|
24836
|
+
// verify the required parameter 'body' is set
|
|
24837
|
+
if (body === undefined || body === null) {
|
|
24838
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsBulkOrganizationsDivisionviews';
|
|
24839
|
+
}
|
|
24840
|
+
|
|
24841
|
+
return this.apiClient.callApi(
|
|
24842
|
+
'/api/v2/externalcontacts/bulk/organizations/divisionviews',
|
|
24843
|
+
'POST',
|
|
24844
|
+
{ },
|
|
24845
|
+
{ },
|
|
24846
|
+
{ },
|
|
24847
|
+
{ },
|
|
24848
|
+
body,
|
|
24849
|
+
['PureCloud OAuth'],
|
|
24850
|
+
['application/json'],
|
|
24851
|
+
['application/json']
|
|
24852
|
+
);
|
|
24853
|
+
}
|
|
24854
|
+
|
|
24455
24855
|
/**
|
|
24456
24856
|
* Bulk remove organizations
|
|
24457
24857
|
*
|
|
@@ -24682,6 +25082,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24682
25082
|
);
|
|
24683
25083
|
}
|
|
24684
25084
|
|
|
25085
|
+
/**
|
|
25086
|
+
* Create bulk export
|
|
25087
|
+
*
|
|
25088
|
+
* @param {Object} body Export
|
|
25089
|
+
*/
|
|
25090
|
+
postExternalcontactsContactsExports(body) {
|
|
25091
|
+
// verify the required parameter 'body' is set
|
|
25092
|
+
if (body === undefined || body === null) {
|
|
25093
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsContactsExports';
|
|
25094
|
+
}
|
|
25095
|
+
|
|
25096
|
+
return this.apiClient.callApi(
|
|
25097
|
+
'/api/v2/externalcontacts/contacts/exports',
|
|
25098
|
+
'POST',
|
|
25099
|
+
{ },
|
|
25100
|
+
{ },
|
|
25101
|
+
{ },
|
|
25102
|
+
{ },
|
|
25103
|
+
body,
|
|
25104
|
+
['PureCloud OAuth'],
|
|
25105
|
+
['application/json'],
|
|
25106
|
+
['application/json']
|
|
25107
|
+
);
|
|
25108
|
+
}
|
|
25109
|
+
|
|
24685
25110
|
/**
|
|
24686
25111
|
* Create a schema
|
|
24687
25112
|
*
|
|
@@ -25423,7 +25848,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25423
25848
|
/**
|
|
25424
25849
|
* Fax service.
|
|
25425
25850
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
25426
|
-
* @version
|
|
25851
|
+
* @version 218.0.0
|
|
25427
25852
|
*/
|
|
25428
25853
|
|
|
25429
25854
|
/**
|
|
@@ -25638,7 +26063,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25638
26063
|
/**
|
|
25639
26064
|
* Flows service.
|
|
25640
26065
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
25641
|
-
* @version
|
|
26066
|
+
* @version 218.0.0
|
|
25642
26067
|
*/
|
|
25643
26068
|
|
|
25644
26069
|
/**
|
|
@@ -25821,7 +26246,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25821
26246
|
/**
|
|
25822
26247
|
* Gamification service.
|
|
25823
26248
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
25824
|
-
* @version
|
|
26249
|
+
* @version 218.0.0
|
|
25825
26250
|
*/
|
|
25826
26251
|
|
|
25827
26252
|
/**
|
|
@@ -27963,7 +28388,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27963
28388
|
/**
|
|
27964
28389
|
* GeneralDataProtectionRegulation service.
|
|
27965
28390
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
27966
|
-
* @version
|
|
28391
|
+
* @version 218.0.0
|
|
27967
28392
|
*/
|
|
27968
28393
|
|
|
27969
28394
|
/**
|
|
@@ -28093,7 +28518,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28093
28518
|
/**
|
|
28094
28519
|
* Geolocation service.
|
|
28095
28520
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
28096
|
-
* @version
|
|
28521
|
+
* @version 218.0.0
|
|
28097
28522
|
*/
|
|
28098
28523
|
|
|
28099
28524
|
/**
|
|
@@ -28224,7 +28649,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28224
28649
|
/**
|
|
28225
28650
|
* Greetings service.
|
|
28226
28651
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
28227
|
-
* @version
|
|
28652
|
+
* @version 218.0.0
|
|
28228
28653
|
*/
|
|
28229
28654
|
|
|
28230
28655
|
/**
|
|
@@ -28679,7 +29104,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28679
29104
|
/**
|
|
28680
29105
|
* Groups service.
|
|
28681
29106
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
28682
|
-
* @version
|
|
29107
|
+
* @version 218.0.0
|
|
28683
29108
|
*/
|
|
28684
29109
|
|
|
28685
29110
|
/**
|
|
@@ -29198,7 +29623,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29198
29623
|
/**
|
|
29199
29624
|
* IdentityProvider service.
|
|
29200
29625
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
29201
|
-
* @version
|
|
29626
|
+
* @version 218.0.0
|
|
29202
29627
|
*/
|
|
29203
29628
|
|
|
29204
29629
|
/**
|
|
@@ -30059,7 +30484,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30059
30484
|
/**
|
|
30060
30485
|
* InfrastructureAsCode service.
|
|
30061
30486
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
30062
|
-
* @version
|
|
30487
|
+
* @version 218.0.0
|
|
30063
30488
|
*/
|
|
30064
30489
|
|
|
30065
30490
|
/**
|
|
@@ -30226,7 +30651,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30226
30651
|
/**
|
|
30227
30652
|
* Integrations service.
|
|
30228
30653
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
30229
|
-
* @version
|
|
30654
|
+
* @version 218.0.0
|
|
30230
30655
|
*/
|
|
30231
30656
|
|
|
30232
30657
|
/**
|
|
@@ -30435,6 +30860,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30435
30860
|
* @param {String} actionId actionId
|
|
30436
30861
|
* @param {Object} opts Optional parameters
|
|
30437
30862
|
* @param {Object} opts.expand Indicates a field in the response which should be expanded.
|
|
30863
|
+
* @param {Object} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
|
|
30438
30864
|
* @param {Object} opts.includeConfig Return config in response. (default to false)
|
|
30439
30865
|
*/
|
|
30440
30866
|
getIntegrationsAction(actionId, opts) {
|
|
@@ -30449,7 +30875,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30449
30875
|
'/api/v2/integrations/actions/{actionId}',
|
|
30450
30876
|
'GET',
|
|
30451
30877
|
{ 'actionId': actionId },
|
|
30452
|
-
{ 'expand': opts['expand'],'includeConfig': opts['includeConfig'] },
|
|
30878
|
+
{ 'expand': opts['expand'],'flatten': opts['flatten'],'includeConfig': opts['includeConfig'] },
|
|
30453
30879
|
{ },
|
|
30454
30880
|
{ },
|
|
30455
30881
|
null,
|
|
@@ -30465,6 +30891,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30465
30891
|
* @param {String} actionId actionId
|
|
30466
30892
|
* @param {Object} opts Optional parameters
|
|
30467
30893
|
* @param {Object} opts.expand Indicates a field in the response which should be expanded.
|
|
30894
|
+
* @param {Object} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
|
|
30468
30895
|
* @param {Object} opts.includeConfig Return config in response. (default to false)
|
|
30469
30896
|
*/
|
|
30470
30897
|
getIntegrationsActionDraft(actionId, opts) {
|
|
@@ -30479,7 +30906,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30479
30906
|
'/api/v2/integrations/actions/{actionId}/draft',
|
|
30480
30907
|
'GET',
|
|
30481
30908
|
{ 'actionId': actionId },
|
|
30482
|
-
{ 'expand': opts['expand'],'includeConfig': opts['includeConfig'] },
|
|
30909
|
+
{ 'expand': opts['expand'],'flatten': opts['flatten'],'includeConfig': opts['includeConfig'] },
|
|
30483
30910
|
{ },
|
|
30484
30911
|
{ },
|
|
30485
30912
|
null,
|
|
@@ -32663,7 +33090,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32663
33090
|
/**
|
|
32664
33091
|
* Journey service.
|
|
32665
33092
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
32666
|
-
* @version
|
|
33093
|
+
* @version 218.0.0
|
|
32667
33094
|
*/
|
|
32668
33095
|
|
|
32669
33096
|
/**
|
|
@@ -34648,7 +35075,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34648
35075
|
/**
|
|
34649
35076
|
* Knowledge service.
|
|
34650
35077
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
34651
|
-
* @version
|
|
35078
|
+
* @version 218.0.0
|
|
34652
35079
|
*/
|
|
34653
35080
|
|
|
34654
35081
|
/**
|
|
@@ -35923,7 +36350,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35923
36350
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
35924
36351
|
* @param {String} uploadId UploadId
|
|
35925
36352
|
* @deprecated
|
|
35926
|
-
* getKnowledgeKnowledgebaseLanguageDocumentUpload is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
35927
36353
|
*/
|
|
35928
36354
|
getKnowledgeKnowledgebaseLanguageDocumentUpload(documentId, knowledgeBaseId, languageCode, uploadId) {
|
|
35929
36355
|
// verify the required parameter 'documentId' is set
|
|
@@ -36179,7 +36605,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36179
36605
|
* @param {String} parseJobId Parse job ID
|
|
36180
36606
|
* @param {Object} opts Optional parameters
|
|
36181
36607
|
* @param {Array.<String>} opts.expand If expand contains 'urls' downloadURL and failedEntitiesURL will be filled.
|
|
36182
|
-
* getKnowledgeKnowledgebaseParseJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
36183
36608
|
*/
|
|
36184
36609
|
getKnowledgeKnowledgebaseParseJob(knowledgeBaseId, parseJobId, opts) {
|
|
36185
36610
|
opts = opts || {};
|
|
@@ -36449,7 +36874,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36449
36874
|
*
|
|
36450
36875
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
36451
36876
|
* @param {String} jobId Upload job ID
|
|
36452
|
-
* getKnowledgeKnowledgebaseUploadsUrlsJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
36453
36877
|
*/
|
|
36454
36878
|
getKnowledgeKnowledgebaseUploadsUrlsJob(knowledgeBaseId, jobId) {
|
|
36455
36879
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -36990,7 +37414,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36990
37414
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
36991
37415
|
* @param {String} parseJobId Parse job ID
|
|
36992
37416
|
* @param {Object} body
|
|
36993
|
-
* patchKnowledgeKnowledgebaseParseJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
36994
37417
|
*/
|
|
36995
37418
|
patchKnowledgeKnowledgebaseParseJob(knowledgeBaseId, parseJobId, body) {
|
|
36996
37419
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -37632,7 +38055,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37632
38055
|
*
|
|
37633
38056
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
37634
38057
|
* @param {Object} body
|
|
37635
|
-
* postKnowledgeKnowledgebaseDocumentsBulkRemove is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
37636
38058
|
*/
|
|
37637
38059
|
postKnowledgeKnowledgebaseDocumentsBulkRemove(knowledgeBaseId, body) {
|
|
37638
38060
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -37663,7 +38085,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37663
38085
|
*
|
|
37664
38086
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
37665
38087
|
* @param {Object} body
|
|
37666
|
-
* postKnowledgeKnowledgebaseDocumentsBulkUpdate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
37667
38088
|
*/
|
|
37668
38089
|
postKnowledgeKnowledgebaseDocumentsBulkUpdate(knowledgeBaseId, body) {
|
|
37669
38090
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -37812,7 +38233,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37812
38233
|
*
|
|
37813
38234
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
37814
38235
|
* @param {Object} body
|
|
37815
|
-
* postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
37816
38236
|
*/
|
|
37817
38237
|
postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd(knowledgeBaseId, body) {
|
|
37818
38238
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -37972,7 +38392,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37972
38392
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
37973
38393
|
* @param {Object} body
|
|
37974
38394
|
* @deprecated
|
|
37975
|
-
* postKnowledgeKnowledgebaseLanguageDocumentUploads is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
37976
38395
|
*/
|
|
37977
38396
|
postKnowledgeKnowledgebaseLanguageDocumentUploads(documentId, knowledgeBaseId, languageCode, body) {
|
|
37978
38397
|
// verify the required parameter 'documentId' is set
|
|
@@ -38151,7 +38570,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38151
38570
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
38152
38571
|
* @param {String} parseJobId Parse job ID
|
|
38153
38572
|
* @param {Object} body
|
|
38154
|
-
* postKnowledgeKnowledgebaseParseJobImport is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
38155
38573
|
*/
|
|
38156
38574
|
postKnowledgeKnowledgebaseParseJobImport(knowledgeBaseId, parseJobId, body) {
|
|
38157
38575
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -38186,7 +38604,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38186
38604
|
*
|
|
38187
38605
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
38188
38606
|
* @param {Object} body
|
|
38189
|
-
* postKnowledgeKnowledgebaseParseJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
38190
38607
|
*/
|
|
38191
38608
|
postKnowledgeKnowledgebaseParseJobs(knowledgeBaseId, body) {
|
|
38192
38609
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -38277,8 +38694,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38277
38694
|
*
|
|
38278
38695
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
38279
38696
|
* @param {String} sourceId Source ID
|
|
38697
|
+
* @param {Object} opts Optional parameters
|
|
38698
|
+
* @param {Object} opts.body
|
|
38280
38699
|
*/
|
|
38281
|
-
postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync(knowledgeBaseId, sourceId) {
|
|
38700
|
+
postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync(knowledgeBaseId, sourceId, opts) {
|
|
38701
|
+
opts = opts || {};
|
|
38702
|
+
|
|
38282
38703
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
38283
38704
|
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
38284
38705
|
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync';
|
|
@@ -38295,7 +38716,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38295
38716
|
{ },
|
|
38296
38717
|
{ },
|
|
38297
38718
|
{ },
|
|
38298
|
-
|
|
38719
|
+
opts['body'],
|
|
38299
38720
|
['PureCloud OAuth'],
|
|
38300
38721
|
['application/json'],
|
|
38301
38722
|
['application/json']
|
|
@@ -38337,8 +38758,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38337
38758
|
*
|
|
38338
38759
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
38339
38760
|
* @param {String} sourceId Source ID
|
|
38761
|
+
* @param {Object} opts Optional parameters
|
|
38762
|
+
* @param {Object} opts.body
|
|
38340
38763
|
*/
|
|
38341
|
-
postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync(knowledgeBaseId, sourceId) {
|
|
38764
|
+
postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync(knowledgeBaseId, sourceId, opts) {
|
|
38765
|
+
opts = opts || {};
|
|
38766
|
+
|
|
38342
38767
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
38343
38768
|
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
38344
38769
|
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync';
|
|
@@ -38355,7 +38780,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38355
38780
|
{ },
|
|
38356
38781
|
{ },
|
|
38357
38782
|
{ },
|
|
38358
|
-
|
|
38783
|
+
opts['body'],
|
|
38359
38784
|
['PureCloud OAuth'],
|
|
38360
38785
|
['application/json'],
|
|
38361
38786
|
['application/json']
|
|
@@ -38397,7 +38822,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38397
38822
|
*
|
|
38398
38823
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
38399
38824
|
* @param {Object} body uploadRequest
|
|
38400
|
-
* postKnowledgeKnowledgebaseUploadsUrlsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
38401
38825
|
*/
|
|
38402
38826
|
postKnowledgeKnowledgebaseUploadsUrlsJobs(knowledgeBaseId, body) {
|
|
38403
38827
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -38524,7 +38948,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38524
38948
|
/**
|
|
38525
38949
|
* LanguageUnderstanding service.
|
|
38526
38950
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
38527
|
-
* @version
|
|
38951
|
+
* @version 218.0.0
|
|
38528
38952
|
*/
|
|
38529
38953
|
|
|
38530
38954
|
/**
|
|
@@ -39557,7 +39981,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39557
39981
|
/**
|
|
39558
39982
|
* Languages service.
|
|
39559
39983
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
39560
|
-
* @version
|
|
39984
|
+
* @version 218.0.0
|
|
39561
39985
|
*/
|
|
39562
39986
|
|
|
39563
39987
|
/**
|
|
@@ -39779,7 +40203,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39779
40203
|
/**
|
|
39780
40204
|
* Learning service.
|
|
39781
40205
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
39782
|
-
* @version
|
|
40206
|
+
* @version 218.0.0
|
|
39783
40207
|
*/
|
|
39784
40208
|
|
|
39785
40209
|
/**
|
|
@@ -40808,7 +41232,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40808
41232
|
/**
|
|
40809
41233
|
* License service.
|
|
40810
41234
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
40811
|
-
* @version
|
|
41235
|
+
* @version 218.0.0
|
|
40812
41236
|
*/
|
|
40813
41237
|
|
|
40814
41238
|
/**
|
|
@@ -41046,7 +41470,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41046
41470
|
/**
|
|
41047
41471
|
* Locations service.
|
|
41048
41472
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
41049
|
-
* @version
|
|
41473
|
+
* @version 218.0.0
|
|
41050
41474
|
*/
|
|
41051
41475
|
|
|
41052
41476
|
/**
|
|
@@ -41282,7 +41706,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41282
41706
|
/**
|
|
41283
41707
|
* LogCapture service.
|
|
41284
41708
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
41285
|
-
* @version
|
|
41709
|
+
* @version 218.0.0
|
|
41286
41710
|
*/
|
|
41287
41711
|
|
|
41288
41712
|
/**
|
|
@@ -41482,7 +41906,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41482
41906
|
/**
|
|
41483
41907
|
* Messaging service.
|
|
41484
41908
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
41485
|
-
* @version
|
|
41909
|
+
* @version 218.0.0
|
|
41486
41910
|
*/
|
|
41487
41911
|
|
|
41488
41912
|
/**
|
|
@@ -41841,7 +42265,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41841
42265
|
/**
|
|
41842
42266
|
* MobileDevices service.
|
|
41843
42267
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
41844
|
-
* @version
|
|
42268
|
+
* @version 218.0.0
|
|
41845
42269
|
*/
|
|
41846
42270
|
|
|
41847
42271
|
/**
|
|
@@ -41992,7 +42416,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41992
42416
|
/**
|
|
41993
42417
|
* Notifications service.
|
|
41994
42418
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
41995
|
-
* @version
|
|
42419
|
+
* @version 218.0.0
|
|
41996
42420
|
*/
|
|
41997
42421
|
|
|
41998
42422
|
/**
|
|
@@ -42225,7 +42649,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42225
42649
|
/**
|
|
42226
42650
|
* OAuth service.
|
|
42227
42651
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
42228
|
-
* @version
|
|
42652
|
+
* @version 218.0.0
|
|
42229
42653
|
*/
|
|
42230
42654
|
|
|
42231
42655
|
/**
|
|
@@ -42591,7 +43015,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42591
43015
|
/**
|
|
42592
43016
|
* Objects service.
|
|
42593
43017
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
42594
|
-
* @version
|
|
43018
|
+
* @version 218.0.0
|
|
42595
43019
|
*/
|
|
42596
43020
|
|
|
42597
43021
|
/**
|
|
@@ -42611,7 +43035,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42611
43035
|
*
|
|
42612
43036
|
* @param {String} divisionId Division ID
|
|
42613
43037
|
* @param {Object} opts Optional parameters
|
|
42614
|
-
* @param {Boolean} opts.force Force delete this division
|
|
43038
|
+
* @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)
|
|
42615
43039
|
*/
|
|
42616
43040
|
deleteAuthorizationDivision(divisionId, opts) {
|
|
42617
43041
|
opts = opts || {};
|
|
@@ -42775,16 +43199,17 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42775
43199
|
* Recreate a previously deleted division.
|
|
42776
43200
|
*
|
|
42777
43201
|
* @param {String} divisionId Division ID
|
|
42778
|
-
* @param {Object}
|
|
42779
|
-
* @param {Object} opts.body Recreated division data
|
|
43202
|
+
* @param {Object} body Recreated division data
|
|
42780
43203
|
*/
|
|
42781
|
-
postAuthorizationDivisionRestore(divisionId,
|
|
42782
|
-
opts = opts || {};
|
|
42783
|
-
|
|
43204
|
+
postAuthorizationDivisionRestore(divisionId, body) {
|
|
42784
43205
|
// verify the required parameter 'divisionId' is set
|
|
42785
43206
|
if (divisionId === undefined || divisionId === null) {
|
|
42786
43207
|
throw 'Missing the required parameter "divisionId" when calling postAuthorizationDivisionRestore';
|
|
42787
43208
|
}
|
|
43209
|
+
// verify the required parameter 'body' is set
|
|
43210
|
+
if (body === undefined || body === null) {
|
|
43211
|
+
throw 'Missing the required parameter "body" when calling postAuthorizationDivisionRestore';
|
|
43212
|
+
}
|
|
42788
43213
|
|
|
42789
43214
|
return this.apiClient.callApi(
|
|
42790
43215
|
'/api/v2/authorization/divisions/{divisionId}/restore',
|
|
@@ -42793,7 +43218,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42793
43218
|
{ },
|
|
42794
43219
|
{ },
|
|
42795
43220
|
{ },
|
|
42796
|
-
|
|
43221
|
+
body,
|
|
42797
43222
|
['PureCloud OAuth'],
|
|
42798
43223
|
['application/json'],
|
|
42799
43224
|
['application/json']
|
|
@@ -42861,7 +43286,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42861
43286
|
/**
|
|
42862
43287
|
* OperationalEvents service.
|
|
42863
43288
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
42864
|
-
* @version
|
|
43289
|
+
* @version 218.0.0
|
|
42865
43290
|
*/
|
|
42866
43291
|
|
|
42867
43292
|
/**
|
|
@@ -42978,7 +43403,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42978
43403
|
/**
|
|
42979
43404
|
* Organization service.
|
|
42980
43405
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
42981
|
-
* @version
|
|
43406
|
+
* @version 218.0.0
|
|
42982
43407
|
*/
|
|
42983
43408
|
|
|
42984
43409
|
/**
|
|
@@ -43199,37 +43624,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43199
43624
|
);
|
|
43200
43625
|
}
|
|
43201
43626
|
|
|
43202
|
-
/**
|
|
43203
|
-
* Get estimated limit counts for a namespace. This is not a source of truth for limit values but a record of estimates to facilitate limit threshold tracking.
|
|
43204
|
-
* See https://developer.genesys.cloud/organization/organization/limits#available-limits for limits that are trackable (Operational Events Enabled).
|
|
43205
|
-
* @param {String} namespaceName The namespace to get
|
|
43206
|
-
* @param {Object} opts Optional parameters
|
|
43207
|
-
* @param {String} opts.cursor Cursor provided when retrieving the last page
|
|
43208
|
-
* @param {String} opts.entityId entity id of the count
|
|
43209
|
-
* @param {String} opts.userId userid of the count
|
|
43210
|
-
*/
|
|
43211
|
-
getOrganizationsLimitsNamespaceCounts(namespaceName, opts) {
|
|
43212
|
-
opts = opts || {};
|
|
43213
|
-
|
|
43214
|
-
// verify the required parameter 'namespaceName' is set
|
|
43215
|
-
if (namespaceName === undefined || namespaceName === null) {
|
|
43216
|
-
throw 'Missing the required parameter "namespaceName" when calling getOrganizationsLimitsNamespaceCounts';
|
|
43217
|
-
}
|
|
43218
|
-
|
|
43219
|
-
return this.apiClient.callApi(
|
|
43220
|
-
'/api/v2/organizations/limits/namespaces/{namespaceName}/counts',
|
|
43221
|
-
'GET',
|
|
43222
|
-
{ 'namespaceName': namespaceName },
|
|
43223
|
-
{ 'cursor': opts['cursor'],'entityId': opts['entityId'],'userId': opts['userId'] },
|
|
43224
|
-
{ },
|
|
43225
|
-
{ },
|
|
43226
|
-
null,
|
|
43227
|
-
['PureCloud OAuth'],
|
|
43228
|
-
['application/json'],
|
|
43229
|
-
['application/json']
|
|
43230
|
-
);
|
|
43231
|
-
}
|
|
43232
|
-
|
|
43233
43627
|
/**
|
|
43234
43628
|
* Get the default limits in a namespace for an organization
|
|
43235
43629
|
*
|
|
@@ -43255,42 +43649,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43255
43649
|
);
|
|
43256
43650
|
}
|
|
43257
43651
|
|
|
43258
|
-
/**
|
|
43259
|
-
* Get estimated limit counts for a namespace and limit name. This is not a source of truth for limit values but a record of estimates to facilitate limit threshold tracking.
|
|
43260
|
-
* See https://developer.genesys.cloud/organization/organization/limits#available-limits for limits that are trackable (Operational Events Enabled).
|
|
43261
|
-
* @param {String} namespaceName The namespace to get
|
|
43262
|
-
* @param {String} limitName The limit to get
|
|
43263
|
-
* @param {Object} opts Optional parameters
|
|
43264
|
-
* @param {String} opts.entityId entity id of the count
|
|
43265
|
-
* @param {String} opts.userId userid of the count
|
|
43266
|
-
* @param {String} opts.cursor Cursor provided when retrieving the last page
|
|
43267
|
-
*/
|
|
43268
|
-
getOrganizationsLimitsNamespaceLimitCounts(namespaceName, limitName, opts) {
|
|
43269
|
-
opts = opts || {};
|
|
43270
|
-
|
|
43271
|
-
// verify the required parameter 'namespaceName' is set
|
|
43272
|
-
if (namespaceName === undefined || namespaceName === null) {
|
|
43273
|
-
throw 'Missing the required parameter "namespaceName" when calling getOrganizationsLimitsNamespaceLimitCounts';
|
|
43274
|
-
}
|
|
43275
|
-
// verify the required parameter 'limitName' is set
|
|
43276
|
-
if (limitName === undefined || limitName === null) {
|
|
43277
|
-
throw 'Missing the required parameter "limitName" when calling getOrganizationsLimitsNamespaceLimitCounts';
|
|
43278
|
-
}
|
|
43279
|
-
|
|
43280
|
-
return this.apiClient.callApi(
|
|
43281
|
-
'/api/v2/organizations/limits/namespaces/{namespaceName}/limits/{limitName}/counts',
|
|
43282
|
-
'GET',
|
|
43283
|
-
{ 'namespaceName': namespaceName,'limitName': limitName },
|
|
43284
|
-
{ 'entityId': opts['entityId'],'userId': opts['userId'],'cursor': opts['cursor'] },
|
|
43285
|
-
{ },
|
|
43286
|
-
{ },
|
|
43287
|
-
null,
|
|
43288
|
-
['PureCloud OAuth'],
|
|
43289
|
-
['application/json'],
|
|
43290
|
-
['application/json']
|
|
43291
|
-
);
|
|
43292
|
-
}
|
|
43293
|
-
|
|
43294
43652
|
/**
|
|
43295
43653
|
* Get the available limit namespaces
|
|
43296
43654
|
*
|
|
@@ -43520,7 +43878,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43520
43878
|
/**
|
|
43521
43879
|
* OrganizationAuthorization service.
|
|
43522
43880
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
43523
|
-
* @version
|
|
43881
|
+
* @version 218.0.0
|
|
43524
43882
|
*/
|
|
43525
43883
|
|
|
43526
43884
|
/**
|
|
@@ -44914,7 +45272,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44914
45272
|
/**
|
|
44915
45273
|
* Outbound service.
|
|
44916
45274
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
44917
|
-
* @version
|
|
45275
|
+
* @version 218.0.0
|
|
44918
45276
|
*/
|
|
44919
45277
|
|
|
44920
45278
|
/**
|
|
@@ -47743,8 +48101,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47743
48101
|
* Update the outbound settings for this organization
|
|
47744
48102
|
*
|
|
47745
48103
|
* @param {Object} body outboundSettings
|
|
48104
|
+
* @param {Object} opts Optional parameters
|
|
48105
|
+
* @param {Object} opts.useMaxCallsPerAgentDecimal Use maxCallsPerAgent with decimal precision
|
|
47746
48106
|
*/
|
|
47747
|
-
patchOutboundSettings(body) {
|
|
48107
|
+
patchOutboundSettings(body, opts) {
|
|
48108
|
+
opts = opts || {};
|
|
48109
|
+
|
|
47748
48110
|
// verify the required parameter 'body' is set
|
|
47749
48111
|
if (body === undefined || body === null) {
|
|
47750
48112
|
throw 'Missing the required parameter "body" when calling patchOutboundSettings';
|
|
@@ -47754,7 +48116,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47754
48116
|
'/api/v2/outbound/settings',
|
|
47755
48117
|
'PATCH',
|
|
47756
48118
|
{ },
|
|
47757
|
-
{
|
|
48119
|
+
{ 'useMaxCallsPerAgentDecimal': opts['useMaxCallsPerAgentDecimal'] },
|
|
47758
48120
|
{ },
|
|
47759
48121
|
{ },
|
|
47760
48122
|
body,
|
|
@@ -47974,8 +48336,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47974
48336
|
* Create a campaign.
|
|
47975
48337
|
*
|
|
47976
48338
|
* @param {Object} body Campaign
|
|
48339
|
+
* @param {Object} opts Optional parameters
|
|
48340
|
+
* @param {Object} opts.useMaxCallsPerAgentDecimal Use maxCallsPerAgent with decimal precision
|
|
47977
48341
|
*/
|
|
47978
|
-
postOutboundCampaigns(body) {
|
|
48342
|
+
postOutboundCampaigns(body, opts) {
|
|
48343
|
+
opts = opts || {};
|
|
48344
|
+
|
|
47979
48345
|
// verify the required parameter 'body' is set
|
|
47980
48346
|
if (body === undefined || body === null) {
|
|
47981
48347
|
throw 'Missing the required parameter "body" when calling postOutboundCampaigns';
|
|
@@ -47985,7 +48351,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47985
48351
|
'/api/v2/outbound/campaigns',
|
|
47986
48352
|
'POST',
|
|
47987
48353
|
{ },
|
|
47988
|
-
{
|
|
48354
|
+
{ 'useMaxCallsPerAgentDecimal': opts['useMaxCallsPerAgentDecimal'] },
|
|
47989
48355
|
{ },
|
|
47990
48356
|
{ },
|
|
47991
48357
|
body,
|
|
@@ -48889,8 +49255,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48889
49255
|
*
|
|
48890
49256
|
* @param {String} campaignId Campaign ID
|
|
48891
49257
|
* @param {Object} body Campaign
|
|
49258
|
+
* @param {Object} opts Optional parameters
|
|
49259
|
+
* @param {Object} opts.useMaxCallsPerAgentDecimal Use maxCallsPerAgent with decimal precision
|
|
48892
49260
|
*/
|
|
48893
|
-
putOutboundCampaign(campaignId, body) {
|
|
49261
|
+
putOutboundCampaign(campaignId, body, opts) {
|
|
49262
|
+
opts = opts || {};
|
|
49263
|
+
|
|
48894
49264
|
// verify the required parameter 'campaignId' is set
|
|
48895
49265
|
if (campaignId === undefined || campaignId === null) {
|
|
48896
49266
|
throw 'Missing the required parameter "campaignId" when calling putOutboundCampaign';
|
|
@@ -48904,7 +49274,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48904
49274
|
'/api/v2/outbound/campaigns/{campaignId}',
|
|
48905
49275
|
'PUT',
|
|
48906
49276
|
{ 'campaignId': campaignId },
|
|
48907
|
-
{
|
|
49277
|
+
{ 'useMaxCallsPerAgentDecimal': opts['useMaxCallsPerAgentDecimal'] },
|
|
48908
49278
|
{ },
|
|
48909
49279
|
{ },
|
|
48910
49280
|
body,
|
|
@@ -49465,7 +49835,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49465
49835
|
/**
|
|
49466
49836
|
* Presence service.
|
|
49467
49837
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
49468
|
-
* @version
|
|
49838
|
+
* @version 218.0.0
|
|
49469
49839
|
*/
|
|
49470
49840
|
|
|
49471
49841
|
/**
|
|
@@ -50209,7 +50579,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50209
50579
|
/**
|
|
50210
50580
|
* ProcessAutomation service.
|
|
50211
50581
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
50212
|
-
* @version
|
|
50582
|
+
* @version 218.0.0
|
|
50213
50583
|
*/
|
|
50214
50584
|
|
|
50215
50585
|
/**
|
|
@@ -50448,7 +50818,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50448
50818
|
/**
|
|
50449
50819
|
* Quality service.
|
|
50450
50820
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
50451
|
-
* @version
|
|
50821
|
+
* @version 218.0.0
|
|
50452
50822
|
*/
|
|
50453
50823
|
|
|
50454
50824
|
/**
|
|
@@ -52144,7 +52514,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52144
52514
|
*
|
|
52145
52515
|
* @param {String} formId Form ID
|
|
52146
52516
|
* @param {Object} body AI Scoring Settings
|
|
52147
|
-
* putQualityFormsEvaluationAiscoringSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
52148
52517
|
*/
|
|
52149
52518
|
putQualityFormsEvaluationAiscoringSettings(formId, body) {
|
|
52150
52519
|
// verify the required parameter 'formId' is set
|
|
@@ -52236,7 +52605,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52236
52605
|
/**
|
|
52237
52606
|
* Recording service.
|
|
52238
52607
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
52239
|
-
* @version
|
|
52608
|
+
* @version 218.0.0
|
|
52240
52609
|
*/
|
|
52241
52610
|
|
|
52242
52611
|
/**
|
|
@@ -52448,7 +52817,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52448
52817
|
* @param {Object} opts.messageFormatId The desired media format when downloading a message recording. Valid values:ZIP,NONE (default to ZIP)
|
|
52449
52818
|
* @param {Object} opts.download requesting a download format of the recording. Valid values:true,false (default to false)
|
|
52450
52819
|
* @param {String} opts.fileName the name of the downloaded fileName
|
|
52451
|
-
* @param {String} opts.locale The locale for the requested file when downloading, as an ISO 639-1 code
|
|
52820
|
+
* @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
|
|
52452
52821
|
* @param {Array.<String>} opts.mediaFormats All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3
|
|
52453
52822
|
*/
|
|
52454
52823
|
getConversationRecording(conversationId, recordingId, opts) {
|
|
@@ -52605,6 +52974,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52605
52974
|
* @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)
|
|
52606
52975
|
* @param {Object} opts.formatId The desired media format. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE. (default to WEBM)
|
|
52607
52976
|
* @param {Array.<String>} opts.mediaFormats All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3.
|
|
52977
|
+
* @param {String} opts.locale The locale used for redacting sensitive information in requested files, as an ISO 639-1 code
|
|
52978
|
+
* @param {Boolean} opts.includePauseAnnotationsForScreenRecordings Include applicable Secure Pause annotations from all audio recordings to all screen recordings (default to false)
|
|
52608
52979
|
*/
|
|
52609
52980
|
getConversationRecordings(conversationId, opts) {
|
|
52610
52981
|
opts = opts || {};
|
|
@@ -52618,7 +52989,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52618
52989
|
'/api/v2/conversations/{conversationId}/recordings',
|
|
52619
52990
|
'GET',
|
|
52620
52991
|
{ 'conversationId': conversationId },
|
|
52621
|
-
{ 'maxWaitMs': opts['maxWaitMs'],'formatId': opts['formatId'],'mediaFormats': this.apiClient.buildCollectionParam(opts['mediaFormats'], 'multi') },
|
|
52992
|
+
{ 'maxWaitMs': opts['maxWaitMs'],'formatId': opts['formatId'],'mediaFormats': this.apiClient.buildCollectionParam(opts['mediaFormats'], 'multi'),'locale': opts['locale'],'includePauseAnnotationsForScreenRecordings': opts['includePauseAnnotationsForScreenRecordings'] },
|
|
52622
52993
|
{ },
|
|
52623
52994
|
{ },
|
|
52624
52995
|
null,
|
|
@@ -53120,32 +53491,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53120
53491
|
);
|
|
53121
53492
|
}
|
|
53122
53493
|
|
|
53123
|
-
/**
|
|
53124
|
-
* Retrieves a paged listing of screen recording sessions
|
|
53125
|
-
* Coming soon: This API is deprecated and will be replaced by /api/v2/recordings/screensessions/details
|
|
53126
|
-
* @param {Object} opts Optional parameters
|
|
53127
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
53128
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
53129
|
-
* @deprecated
|
|
53130
|
-
*/
|
|
53131
|
-
getRecordingsScreensessions(opts) {
|
|
53132
|
-
opts = opts || {};
|
|
53133
|
-
|
|
53134
|
-
|
|
53135
|
-
return this.apiClient.callApi(
|
|
53136
|
-
'/api/v2/recordings/screensessions',
|
|
53137
|
-
'GET',
|
|
53138
|
-
{ },
|
|
53139
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
53140
|
-
{ },
|
|
53141
|
-
{ },
|
|
53142
|
-
null,
|
|
53143
|
-
['PureCloud OAuth'],
|
|
53144
|
-
['application/json'],
|
|
53145
|
-
['application/json']
|
|
53146
|
-
);
|
|
53147
|
-
}
|
|
53148
|
-
|
|
53149
53494
|
/**
|
|
53150
53495
|
* Retrieves an object containing the total number of concurrent active screen recordings
|
|
53151
53496
|
*
|
|
@@ -53865,7 +54210,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53865
54210
|
/**
|
|
53866
54211
|
* ResponseManagement service.
|
|
53867
54212
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
53868
|
-
* @version
|
|
54213
|
+
* @version 218.0.0
|
|
53869
54214
|
*/
|
|
53870
54215
|
|
|
53871
54216
|
/**
|
|
@@ -54375,7 +54720,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54375
54720
|
/**
|
|
54376
54721
|
* Routing service.
|
|
54377
54722
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
54378
|
-
* @version
|
|
54723
|
+
* @version 218.0.0
|
|
54379
54724
|
*/
|
|
54380
54725
|
|
|
54381
54726
|
/**
|
|
@@ -55216,6 +55561,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55216
55561
|
);
|
|
55217
55562
|
}
|
|
55218
55563
|
|
|
55564
|
+
/**
|
|
55565
|
+
* Get a route identity resolution setting.
|
|
55566
|
+
*
|
|
55567
|
+
* @param {String} domainName email domain
|
|
55568
|
+
* @param {String} routeId route ID
|
|
55569
|
+
* getRoutingEmailDomainRouteIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
55570
|
+
*/
|
|
55571
|
+
getRoutingEmailDomainRouteIdentityresolution(domainName, routeId) {
|
|
55572
|
+
// verify the required parameter 'domainName' is set
|
|
55573
|
+
if (domainName === undefined || domainName === null) {
|
|
55574
|
+
throw 'Missing the required parameter "domainName" when calling getRoutingEmailDomainRouteIdentityresolution';
|
|
55575
|
+
}
|
|
55576
|
+
// verify the required parameter 'routeId' is set
|
|
55577
|
+
if (routeId === undefined || routeId === null) {
|
|
55578
|
+
throw 'Missing the required parameter "routeId" when calling getRoutingEmailDomainRouteIdentityresolution';
|
|
55579
|
+
}
|
|
55580
|
+
|
|
55581
|
+
return this.apiClient.callApi(
|
|
55582
|
+
'/api/v2/routing/email/domains/{domainName}/routes/{routeId}/identityresolution',
|
|
55583
|
+
'GET',
|
|
55584
|
+
{ 'domainName': domainName,'routeId': routeId },
|
|
55585
|
+
{ },
|
|
55586
|
+
{ },
|
|
55587
|
+
{ },
|
|
55588
|
+
null,
|
|
55589
|
+
['PureCloud OAuth'],
|
|
55590
|
+
['application/json'],
|
|
55591
|
+
['application/json']
|
|
55592
|
+
);
|
|
55593
|
+
}
|
|
55594
|
+
|
|
55219
55595
|
/**
|
|
55220
55596
|
* Get routes
|
|
55221
55597
|
*
|
|
@@ -55769,6 +56145,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55769
56145
|
);
|
|
55770
56146
|
}
|
|
55771
56147
|
|
|
56148
|
+
/**
|
|
56149
|
+
* Get Queue IdentityResolution Settings.
|
|
56150
|
+
*
|
|
56151
|
+
* @param {String} queueId Queue ID
|
|
56152
|
+
* getRoutingQueueIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
56153
|
+
*/
|
|
56154
|
+
getRoutingQueueIdentityresolution(queueId) {
|
|
56155
|
+
// verify the required parameter 'queueId' is set
|
|
56156
|
+
if (queueId === undefined || queueId === null) {
|
|
56157
|
+
throw 'Missing the required parameter "queueId" when calling getRoutingQueueIdentityresolution';
|
|
56158
|
+
}
|
|
56159
|
+
|
|
56160
|
+
return this.apiClient.callApi(
|
|
56161
|
+
'/api/v2/routing/queues/{queueId}/identityresolution',
|
|
56162
|
+
'GET',
|
|
56163
|
+
{ 'queueId': queueId },
|
|
56164
|
+
{ },
|
|
56165
|
+
{ },
|
|
56166
|
+
{ },
|
|
56167
|
+
null,
|
|
56168
|
+
['PureCloud OAuth'],
|
|
56169
|
+
['application/json'],
|
|
56170
|
+
['application/json']
|
|
56171
|
+
);
|
|
56172
|
+
}
|
|
56173
|
+
|
|
55772
56174
|
/**
|
|
55773
56175
|
* Get Estimated Wait Time
|
|
55774
56176
|
*
|
|
@@ -56341,6 +56743,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56341
56743
|
);
|
|
56342
56744
|
}
|
|
56343
56745
|
|
|
56746
|
+
/**
|
|
56747
|
+
* Get a SMS identity resolution settings.
|
|
56748
|
+
*
|
|
56749
|
+
* @param {String} addressId Address ID
|
|
56750
|
+
* getRoutingSmsIdentityresolutionPhonenumber is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
56751
|
+
*/
|
|
56752
|
+
getRoutingSmsIdentityresolutionPhonenumber(addressId) {
|
|
56753
|
+
// verify the required parameter 'addressId' is set
|
|
56754
|
+
if (addressId === undefined || addressId === null) {
|
|
56755
|
+
throw 'Missing the required parameter "addressId" when calling getRoutingSmsIdentityresolutionPhonenumber';
|
|
56756
|
+
}
|
|
56757
|
+
|
|
56758
|
+
return this.apiClient.callApi(
|
|
56759
|
+
'/api/v2/routing/sms/identityresolution/phonenumbers/{addressId}',
|
|
56760
|
+
'GET',
|
|
56761
|
+
{ 'addressId': addressId },
|
|
56762
|
+
{ },
|
|
56763
|
+
{ },
|
|
56764
|
+
{ },
|
|
56765
|
+
null,
|
|
56766
|
+
['PureCloud OAuth'],
|
|
56767
|
+
['application/json'],
|
|
56768
|
+
['application/json']
|
|
56769
|
+
);
|
|
56770
|
+
}
|
|
56771
|
+
|
|
56344
56772
|
/**
|
|
56345
56773
|
* Get a phone number provisioned for SMS.
|
|
56346
56774
|
*
|
|
@@ -58146,6 +58574,42 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58146
58574
|
);
|
|
58147
58575
|
}
|
|
58148
58576
|
|
|
58577
|
+
/**
|
|
58578
|
+
* Update identity resolution settings for a route.
|
|
58579
|
+
*
|
|
58580
|
+
* @param {String} domainName email domain
|
|
58581
|
+
* @param {String} routeId route ID
|
|
58582
|
+
* @param {Object} body
|
|
58583
|
+
* putRoutingEmailDomainRouteIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58584
|
+
*/
|
|
58585
|
+
putRoutingEmailDomainRouteIdentityresolution(domainName, routeId, body) {
|
|
58586
|
+
// verify the required parameter 'domainName' is set
|
|
58587
|
+
if (domainName === undefined || domainName === null) {
|
|
58588
|
+
throw 'Missing the required parameter "domainName" when calling putRoutingEmailDomainRouteIdentityresolution';
|
|
58589
|
+
}
|
|
58590
|
+
// verify the required parameter 'routeId' is set
|
|
58591
|
+
if (routeId === undefined || routeId === null) {
|
|
58592
|
+
throw 'Missing the required parameter "routeId" when calling putRoutingEmailDomainRouteIdentityresolution';
|
|
58593
|
+
}
|
|
58594
|
+
// verify the required parameter 'body' is set
|
|
58595
|
+
if (body === undefined || body === null) {
|
|
58596
|
+
throw 'Missing the required parameter "body" when calling putRoutingEmailDomainRouteIdentityresolution';
|
|
58597
|
+
}
|
|
58598
|
+
|
|
58599
|
+
return this.apiClient.callApi(
|
|
58600
|
+
'/api/v2/routing/email/domains/{domainName}/routes/{routeId}/identityresolution',
|
|
58601
|
+
'PUT',
|
|
58602
|
+
{ 'domainName': domainName,'routeId': routeId },
|
|
58603
|
+
{ },
|
|
58604
|
+
{ },
|
|
58605
|
+
{ },
|
|
58606
|
+
body,
|
|
58607
|
+
['PureCloud OAuth'],
|
|
58608
|
+
['application/json'],
|
|
58609
|
+
['application/json']
|
|
58610
|
+
);
|
|
58611
|
+
}
|
|
58612
|
+
|
|
58149
58613
|
/**
|
|
58150
58614
|
* Request an activation status (cname + dkim) update of an outbound domain
|
|
58151
58615
|
*
|
|
@@ -58231,6 +58695,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58231
58695
|
);
|
|
58232
58696
|
}
|
|
58233
58697
|
|
|
58698
|
+
/**
|
|
58699
|
+
* Update Queue IdentityResolution Settings.
|
|
58700
|
+
*
|
|
58701
|
+
* @param {String} queueId Queue ID
|
|
58702
|
+
* @param {Object} body
|
|
58703
|
+
* putRoutingQueueIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58704
|
+
*/
|
|
58705
|
+
putRoutingQueueIdentityresolution(queueId, body) {
|
|
58706
|
+
// verify the required parameter 'queueId' is set
|
|
58707
|
+
if (queueId === undefined || queueId === null) {
|
|
58708
|
+
throw 'Missing the required parameter "queueId" when calling putRoutingQueueIdentityresolution';
|
|
58709
|
+
}
|
|
58710
|
+
// verify the required parameter 'body' is set
|
|
58711
|
+
if (body === undefined || body === null) {
|
|
58712
|
+
throw 'Missing the required parameter "body" when calling putRoutingQueueIdentityresolution';
|
|
58713
|
+
}
|
|
58714
|
+
|
|
58715
|
+
return this.apiClient.callApi(
|
|
58716
|
+
'/api/v2/routing/queues/{queueId}/identityresolution',
|
|
58717
|
+
'PUT',
|
|
58718
|
+
{ 'queueId': queueId },
|
|
58719
|
+
{ },
|
|
58720
|
+
{ },
|
|
58721
|
+
{ },
|
|
58722
|
+
body,
|
|
58723
|
+
['PureCloud OAuth'],
|
|
58724
|
+
['application/json'],
|
|
58725
|
+
['application/json']
|
|
58726
|
+
);
|
|
58727
|
+
}
|
|
58728
|
+
|
|
58234
58729
|
/**
|
|
58235
58730
|
* Update an organization's routing settings
|
|
58236
58731
|
*
|
|
@@ -58281,6 +58776,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58281
58776
|
);
|
|
58282
58777
|
}
|
|
58283
58778
|
|
|
58779
|
+
/**
|
|
58780
|
+
* Update an SMS identity resolution settings.
|
|
58781
|
+
*
|
|
58782
|
+
* @param {String} addressId Address ID
|
|
58783
|
+
* @param {Object} body
|
|
58784
|
+
* putRoutingSmsIdentityresolutionPhonenumber is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58785
|
+
*/
|
|
58786
|
+
putRoutingSmsIdentityresolutionPhonenumber(addressId, body) {
|
|
58787
|
+
// verify the required parameter 'addressId' is set
|
|
58788
|
+
if (addressId === undefined || addressId === null) {
|
|
58789
|
+
throw 'Missing the required parameter "addressId" when calling putRoutingSmsIdentityresolutionPhonenumber';
|
|
58790
|
+
}
|
|
58791
|
+
// verify the required parameter 'body' is set
|
|
58792
|
+
if (body === undefined || body === null) {
|
|
58793
|
+
throw 'Missing the required parameter "body" when calling putRoutingSmsIdentityresolutionPhonenumber';
|
|
58794
|
+
}
|
|
58795
|
+
|
|
58796
|
+
return this.apiClient.callApi(
|
|
58797
|
+
'/api/v2/routing/sms/identityresolution/phonenumbers/{addressId}',
|
|
58798
|
+
'PUT',
|
|
58799
|
+
{ 'addressId': addressId },
|
|
58800
|
+
{ },
|
|
58801
|
+
{ },
|
|
58802
|
+
{ },
|
|
58803
|
+
body,
|
|
58804
|
+
['PureCloud OAuth'],
|
|
58805
|
+
['application/json'],
|
|
58806
|
+
['application/json']
|
|
58807
|
+
);
|
|
58808
|
+
}
|
|
58809
|
+
|
|
58284
58810
|
/**
|
|
58285
58811
|
* Update the user's Direct Routing Backup settings.
|
|
58286
58812
|
*
|
|
@@ -58497,7 +59023,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58497
59023
|
/**
|
|
58498
59024
|
* SCIM service.
|
|
58499
59025
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
58500
|
-
* @version
|
|
59026
|
+
* @version 218.0.0
|
|
58501
59027
|
*/
|
|
58502
59028
|
|
|
58503
59029
|
/**
|
|
@@ -59374,7 +59900,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59374
59900
|
/**
|
|
59375
59901
|
* ScreenRecording service.
|
|
59376
59902
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
59377
|
-
* @version
|
|
59903
|
+
* @version 218.0.0
|
|
59378
59904
|
*/
|
|
59379
59905
|
|
|
59380
59906
|
/**
|
|
@@ -59419,7 +59945,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59419
59945
|
/**
|
|
59420
59946
|
* Scripts service.
|
|
59421
59947
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
59422
|
-
* @version
|
|
59948
|
+
* @version 218.0.0
|
|
59423
59949
|
*/
|
|
59424
59950
|
|
|
59425
59951
|
/**
|
|
@@ -59863,7 +60389,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59863
60389
|
/**
|
|
59864
60390
|
* Search service.
|
|
59865
60391
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
59866
|
-
* @version
|
|
60392
|
+
* @version 218.0.0
|
|
59867
60393
|
*/
|
|
59868
60394
|
|
|
59869
60395
|
/**
|
|
@@ -60606,7 +61132,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60606
61132
|
/**
|
|
60607
61133
|
* Settings service.
|
|
60608
61134
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
60609
|
-
* @version
|
|
61135
|
+
* @version 218.0.0
|
|
60610
61136
|
*/
|
|
60611
61137
|
|
|
60612
61138
|
/**
|
|
@@ -60826,7 +61352,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60826
61352
|
/**
|
|
60827
61353
|
* SocialMedia service.
|
|
60828
61354
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
60829
|
-
* @version
|
|
61355
|
+
* @version 218.0.0
|
|
60830
61356
|
*/
|
|
60831
61357
|
|
|
60832
61358
|
/**
|
|
@@ -60841,13 +61367,63 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60841
61367
|
}
|
|
60842
61368
|
|
|
60843
61369
|
|
|
61370
|
+
/**
|
|
61371
|
+
* Delete an escalation rule.
|
|
61372
|
+
*
|
|
61373
|
+
* @param {String} escalationRuleId escalationRuleId
|
|
61374
|
+
*/
|
|
61375
|
+
deleteSocialmediaEscalationrule(escalationRuleId) {
|
|
61376
|
+
// verify the required parameter 'escalationRuleId' is set
|
|
61377
|
+
if (escalationRuleId === undefined || escalationRuleId === null) {
|
|
61378
|
+
throw 'Missing the required parameter "escalationRuleId" when calling deleteSocialmediaEscalationrule';
|
|
61379
|
+
}
|
|
61380
|
+
|
|
61381
|
+
return this.apiClient.callApi(
|
|
61382
|
+
'/api/v2/socialmedia/escalationrules/{escalationRuleId}',
|
|
61383
|
+
'DELETE',
|
|
61384
|
+
{ 'escalationRuleId': escalationRuleId },
|
|
61385
|
+
{ },
|
|
61386
|
+
{ },
|
|
61387
|
+
{ },
|
|
61388
|
+
null,
|
|
61389
|
+
['PureCloud OAuth'],
|
|
61390
|
+
['application/json'],
|
|
61391
|
+
['application/json']
|
|
61392
|
+
);
|
|
61393
|
+
}
|
|
61394
|
+
|
|
61395
|
+
/**
|
|
61396
|
+
* Delete a social media message.
|
|
61397
|
+
*
|
|
61398
|
+
* @param {String} messageId messageId
|
|
61399
|
+
* deleteSocialmediaMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
61400
|
+
*/
|
|
61401
|
+
deleteSocialmediaMessage(messageId) {
|
|
61402
|
+
// verify the required parameter 'messageId' is set
|
|
61403
|
+
if (messageId === undefined || messageId === null) {
|
|
61404
|
+
throw 'Missing the required parameter "messageId" when calling deleteSocialmediaMessage';
|
|
61405
|
+
}
|
|
61406
|
+
|
|
61407
|
+
return this.apiClient.callApi(
|
|
61408
|
+
'/api/v2/socialmedia/messages/{messageId}',
|
|
61409
|
+
'DELETE',
|
|
61410
|
+
{ 'messageId': messageId },
|
|
61411
|
+
{ },
|
|
61412
|
+
{ },
|
|
61413
|
+
{ },
|
|
61414
|
+
null,
|
|
61415
|
+
['PureCloud OAuth'],
|
|
61416
|
+
['application/json'],
|
|
61417
|
+
['application/json']
|
|
61418
|
+
);
|
|
61419
|
+
}
|
|
61420
|
+
|
|
60844
61421
|
/**
|
|
60845
61422
|
* Delete a social topic.
|
|
60846
61423
|
*
|
|
60847
61424
|
* @param {String} topicId topicId
|
|
60848
61425
|
* @param {Object} opts Optional parameters
|
|
60849
61426
|
* @param {Boolean} opts.hardDelete Determines whether a Social topic should be soft-deleted or hard-deleted (permanently removed). Set to false (soft-delete) by default.
|
|
60850
|
-
* deleteSocialmediaTopic is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60851
61427
|
*/
|
|
60852
61428
|
deleteSocialmediaTopic(topicId, opts) {
|
|
60853
61429
|
opts = opts || {};
|
|
@@ -60878,7 +61454,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60878
61454
|
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
60879
61455
|
* @param {Object} opts Optional parameters
|
|
60880
61456
|
* @param {Boolean} opts.hardDelete Determines whether a Facebook data ingestion rule should be soft-deleted (have it's state set to deleted) or hard-deleted (permanently removed). Set to false (soft-delete) by default. (default to false)
|
|
60881
|
-
* deleteSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60882
61457
|
*/
|
|
60883
61458
|
deleteSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId, facebookIngestionRuleId, opts) {
|
|
60884
61459
|
opts = opts || {};
|
|
@@ -60948,7 +61523,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60948
61523
|
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
60949
61524
|
* @param {Object} opts Optional parameters
|
|
60950
61525
|
* @param {Boolean} opts.hardDelete Determines whether a X (formally Twitter) data ingestion rule should be soft-deleted (have it's state set to deleted) or hard-deleted (permanently removed). Set to false (soft-delete) by default. (default to false)
|
|
60951
|
-
* deleteSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60952
61526
|
*/
|
|
60953
61527
|
deleteSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId, twitterIngestionRuleId, opts) {
|
|
60954
61528
|
opts = opts || {};
|
|
@@ -60976,13 +61550,175 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60976
61550
|
);
|
|
60977
61551
|
}
|
|
60978
61552
|
|
|
61553
|
+
/**
|
|
61554
|
+
* Get status for async query for social media aggregates
|
|
61555
|
+
*
|
|
61556
|
+
* @param {String} jobId jobId
|
|
61557
|
+
*/
|
|
61558
|
+
getSocialmediaAnalyticsAggregatesJob(jobId) {
|
|
61559
|
+
// verify the required parameter 'jobId' is set
|
|
61560
|
+
if (jobId === undefined || jobId === null) {
|
|
61561
|
+
throw 'Missing the required parameter "jobId" when calling getSocialmediaAnalyticsAggregatesJob';
|
|
61562
|
+
}
|
|
61563
|
+
|
|
61564
|
+
return this.apiClient.callApi(
|
|
61565
|
+
'/api/v2/socialmedia/analytics/aggregates/jobs/{jobId}',
|
|
61566
|
+
'GET',
|
|
61567
|
+
{ 'jobId': jobId },
|
|
61568
|
+
{ },
|
|
61569
|
+
{ },
|
|
61570
|
+
{ },
|
|
61571
|
+
null,
|
|
61572
|
+
['PureCloud OAuth'],
|
|
61573
|
+
['application/json'],
|
|
61574
|
+
['application/json']
|
|
61575
|
+
);
|
|
61576
|
+
}
|
|
61577
|
+
|
|
61578
|
+
/**
|
|
61579
|
+
* Fetch a page of results for an async social media query
|
|
61580
|
+
*
|
|
61581
|
+
* @param {String} jobId jobId
|
|
61582
|
+
* @param {Object} opts Optional parameters
|
|
61583
|
+
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
61584
|
+
*/
|
|
61585
|
+
getSocialmediaAnalyticsAggregatesJobResults(jobId, opts) {
|
|
61586
|
+
opts = opts || {};
|
|
61587
|
+
|
|
61588
|
+
// verify the required parameter 'jobId' is set
|
|
61589
|
+
if (jobId === undefined || jobId === null) {
|
|
61590
|
+
throw 'Missing the required parameter "jobId" when calling getSocialmediaAnalyticsAggregatesJobResults';
|
|
61591
|
+
}
|
|
61592
|
+
|
|
61593
|
+
return this.apiClient.callApi(
|
|
61594
|
+
'/api/v2/socialmedia/analytics/aggregates/jobs/{jobId}/results',
|
|
61595
|
+
'GET',
|
|
61596
|
+
{ 'jobId': jobId },
|
|
61597
|
+
{ 'cursor': opts['cursor'] },
|
|
61598
|
+
{ },
|
|
61599
|
+
{ },
|
|
61600
|
+
null,
|
|
61601
|
+
['PureCloud OAuth'],
|
|
61602
|
+
['application/json'],
|
|
61603
|
+
['application/json']
|
|
61604
|
+
);
|
|
61605
|
+
}
|
|
61606
|
+
|
|
61607
|
+
/**
|
|
61608
|
+
* Get status for async query for social media messages job
|
|
61609
|
+
*
|
|
61610
|
+
* @param {String} jobId jobId
|
|
61611
|
+
*/
|
|
61612
|
+
getSocialmediaAnalyticsMessagesJob(jobId) {
|
|
61613
|
+
// verify the required parameter 'jobId' is set
|
|
61614
|
+
if (jobId === undefined || jobId === null) {
|
|
61615
|
+
throw 'Missing the required parameter "jobId" when calling getSocialmediaAnalyticsMessagesJob';
|
|
61616
|
+
}
|
|
61617
|
+
|
|
61618
|
+
return this.apiClient.callApi(
|
|
61619
|
+
'/api/v2/socialmedia/analytics/messages/jobs/{jobId}',
|
|
61620
|
+
'GET',
|
|
61621
|
+
{ 'jobId': jobId },
|
|
61622
|
+
{ },
|
|
61623
|
+
{ },
|
|
61624
|
+
{ },
|
|
61625
|
+
null,
|
|
61626
|
+
['PureCloud OAuth'],
|
|
61627
|
+
['application/json'],
|
|
61628
|
+
['application/json']
|
|
61629
|
+
);
|
|
61630
|
+
}
|
|
61631
|
+
|
|
61632
|
+
/**
|
|
61633
|
+
* Fetch a page of results for an async social media messages query
|
|
61634
|
+
*
|
|
61635
|
+
* @param {String} jobId jobId
|
|
61636
|
+
* @param {Object} opts Optional parameters
|
|
61637
|
+
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
61638
|
+
*/
|
|
61639
|
+
getSocialmediaAnalyticsMessagesJobResults(jobId, opts) {
|
|
61640
|
+
opts = opts || {};
|
|
61641
|
+
|
|
61642
|
+
// verify the required parameter 'jobId' is set
|
|
61643
|
+
if (jobId === undefined || jobId === null) {
|
|
61644
|
+
throw 'Missing the required parameter "jobId" when calling getSocialmediaAnalyticsMessagesJobResults';
|
|
61645
|
+
}
|
|
61646
|
+
|
|
61647
|
+
return this.apiClient.callApi(
|
|
61648
|
+
'/api/v2/socialmedia/analytics/messages/jobs/{jobId}/results',
|
|
61649
|
+
'GET',
|
|
61650
|
+
{ 'jobId': jobId },
|
|
61651
|
+
{ 'cursor': opts['cursor'] },
|
|
61652
|
+
{ },
|
|
61653
|
+
{ },
|
|
61654
|
+
null,
|
|
61655
|
+
['PureCloud OAuth'],
|
|
61656
|
+
['application/json'],
|
|
61657
|
+
['application/json']
|
|
61658
|
+
);
|
|
61659
|
+
}
|
|
61660
|
+
|
|
61661
|
+
/**
|
|
61662
|
+
* Get a single escalation rule.
|
|
61663
|
+
*
|
|
61664
|
+
* @param {String} escalationRuleId escalationRuleId
|
|
61665
|
+
*/
|
|
61666
|
+
getSocialmediaEscalationrule(escalationRuleId) {
|
|
61667
|
+
// verify the required parameter 'escalationRuleId' is set
|
|
61668
|
+
if (escalationRuleId === undefined || escalationRuleId === null) {
|
|
61669
|
+
throw 'Missing the required parameter "escalationRuleId" when calling getSocialmediaEscalationrule';
|
|
61670
|
+
}
|
|
61671
|
+
|
|
61672
|
+
return this.apiClient.callApi(
|
|
61673
|
+
'/api/v2/socialmedia/escalationrules/{escalationRuleId}',
|
|
61674
|
+
'GET',
|
|
61675
|
+
{ 'escalationRuleId': escalationRuleId },
|
|
61676
|
+
{ },
|
|
61677
|
+
{ },
|
|
61678
|
+
{ },
|
|
61679
|
+
null,
|
|
61680
|
+
['PureCloud OAuth'],
|
|
61681
|
+
['application/json'],
|
|
61682
|
+
['application/json']
|
|
61683
|
+
);
|
|
61684
|
+
}
|
|
61685
|
+
|
|
61686
|
+
/**
|
|
61687
|
+
* Retrieve all escalation rules for a division.
|
|
61688
|
+
*
|
|
61689
|
+
* @param {String} divisionId One division ID
|
|
61690
|
+
* @param {Object} opts Optional parameters
|
|
61691
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
61692
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
61693
|
+
*/
|
|
61694
|
+
getSocialmediaEscalationrules(divisionId, opts) {
|
|
61695
|
+
opts = opts || {};
|
|
61696
|
+
|
|
61697
|
+
// verify the required parameter 'divisionId' is set
|
|
61698
|
+
if (divisionId === undefined || divisionId === null) {
|
|
61699
|
+
throw 'Missing the required parameter "divisionId" when calling getSocialmediaEscalationrules';
|
|
61700
|
+
}
|
|
61701
|
+
|
|
61702
|
+
return this.apiClient.callApi(
|
|
61703
|
+
'/api/v2/socialmedia/escalationrules',
|
|
61704
|
+
'GET',
|
|
61705
|
+
{ },
|
|
61706
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'divisionId': divisionId },
|
|
61707
|
+
{ },
|
|
61708
|
+
{ },
|
|
61709
|
+
null,
|
|
61710
|
+
['PureCloud OAuth'],
|
|
61711
|
+
['application/json'],
|
|
61712
|
+
['application/json']
|
|
61713
|
+
);
|
|
61714
|
+
}
|
|
61715
|
+
|
|
60979
61716
|
/**
|
|
60980
61717
|
* Get a single social topic.
|
|
60981
61718
|
*
|
|
60982
61719
|
* @param {String} topicId topicId
|
|
60983
61720
|
* @param {Object} opts Optional parameters
|
|
60984
61721
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
60985
|
-
* getSocialmediaTopic is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60986
61722
|
*/
|
|
60987
61723
|
getSocialmediaTopic(topicId, opts) {
|
|
60988
61724
|
opts = opts || {};
|
|
@@ -61006,6 +61742,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61006
61742
|
);
|
|
61007
61743
|
}
|
|
61008
61744
|
|
|
61745
|
+
/**
|
|
61746
|
+
* Retrieve all social topic data ingestion rules with pagination.
|
|
61747
|
+
*
|
|
61748
|
+
* @param {String} topicId topicId
|
|
61749
|
+
* @param {Object} opts Optional parameters
|
|
61750
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
61751
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
61752
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
61753
|
+
*/
|
|
61754
|
+
getSocialmediaTopicDataingestionrules(topicId, opts) {
|
|
61755
|
+
opts = opts || {};
|
|
61756
|
+
|
|
61757
|
+
// verify the required parameter 'topicId' is set
|
|
61758
|
+
if (topicId === undefined || topicId === null) {
|
|
61759
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrules';
|
|
61760
|
+
}
|
|
61761
|
+
|
|
61762
|
+
return this.apiClient.callApi(
|
|
61763
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules',
|
|
61764
|
+
'GET',
|
|
61765
|
+
{ 'topicId': topicId },
|
|
61766
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'includeDeleted': opts['includeDeleted'] },
|
|
61767
|
+
{ },
|
|
61768
|
+
{ },
|
|
61769
|
+
null,
|
|
61770
|
+
['PureCloud OAuth'],
|
|
61771
|
+
['application/json'],
|
|
61772
|
+
['application/json']
|
|
61773
|
+
);
|
|
61774
|
+
}
|
|
61775
|
+
|
|
61009
61776
|
/**
|
|
61010
61777
|
* Get a single Facebook data ingestion rule.
|
|
61011
61778
|
*
|
|
@@ -61013,7 +61780,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61013
61780
|
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
61014
61781
|
* @param {Object} opts Optional parameters
|
|
61015
61782
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
61016
|
-
* getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
61017
61783
|
*/
|
|
61018
61784
|
getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId, facebookIngestionRuleId, opts) {
|
|
61019
61785
|
opts = opts || {};
|
|
@@ -61049,7 +61815,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61049
61815
|
* @param {String} dataIngestionRuleVersion version
|
|
61050
61816
|
* @param {Object} opts Optional parameters
|
|
61051
61817
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted item in the result.
|
|
61052
|
-
* getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
61053
61818
|
*/
|
|
61054
61819
|
getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion(topicId, facebookIngestionRuleId, dataIngestionRuleVersion, opts) {
|
|
61055
61820
|
opts = opts || {};
|
|
@@ -61090,7 +61855,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61090
61855
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
61091
61856
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
61092
61857
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
61093
|
-
* getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
61094
61858
|
*/
|
|
61095
61859
|
getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersions(topicId, facebookIngestionRuleId, opts) {
|
|
61096
61860
|
opts = opts || {};
|
|
@@ -61237,7 +62001,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61237
62001
|
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
61238
62002
|
* @param {Object} opts Optional parameters
|
|
61239
62003
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
61240
|
-
* getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
61241
62004
|
*/
|
|
61242
62005
|
getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId, twitterIngestionRuleId, opts) {
|
|
61243
62006
|
opts = opts || {};
|
|
@@ -61273,7 +62036,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61273
62036
|
* @param {String} dataIngestionRuleVersion version
|
|
61274
62037
|
* @param {Object} opts Optional parameters
|
|
61275
62038
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted item in the result.
|
|
61276
|
-
* getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
61277
62039
|
*/
|
|
61278
62040
|
getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion(topicId, twitterIngestionRuleId, dataIngestionRuleVersion, opts) {
|
|
61279
62041
|
opts = opts || {};
|
|
@@ -61314,7 +62076,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61314
62076
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
61315
62077
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
61316
62078
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
61317
|
-
* getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
61318
62079
|
*/
|
|
61319
62080
|
getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersions(topicId, twitterIngestionRuleId, opts) {
|
|
61320
62081
|
opts = opts || {};
|
|
@@ -61350,7 +62111,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61350
62111
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
61351
62112
|
* @param {Array.<String>} opts.divisionIds One or more division IDs. If nothing is provided, the social topics associated withthe list of divisions that the user has access to will be returned.
|
|
61352
62113
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
61353
|
-
* getSocialmediaTopics is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
61354
62114
|
*/
|
|
61355
62115
|
getSocialmediaTopics(opts) {
|
|
61356
62116
|
opts = opts || {};
|
|
@@ -61376,7 +62136,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61376
62136
|
* @param {String} topicId topicId
|
|
61377
62137
|
* @param {Object} opts Optional parameters
|
|
61378
62138
|
* @param {Object} opts.body
|
|
61379
|
-
* patchSocialmediaTopic is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
61380
62139
|
*/
|
|
61381
62140
|
patchSocialmediaTopic(topicId, opts) {
|
|
61382
62141
|
opts = opts || {};
|
|
@@ -61407,7 +62166,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61407
62166
|
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
61408
62167
|
* @param {Object} opts Optional parameters
|
|
61409
62168
|
* @param {Object} opts.body
|
|
61410
|
-
* patchSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
61411
62169
|
*/
|
|
61412
62170
|
patchSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId, facebookIngestionRuleId, opts) {
|
|
61413
62171
|
opts = opts || {};
|
|
@@ -61477,7 +62235,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61477
62235
|
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
61478
62236
|
* @param {Object} opts Optional parameters
|
|
61479
62237
|
* @param {Object} opts.body
|
|
61480
|
-
* patchSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
61481
62238
|
*/
|
|
61482
62239
|
patchSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId, twitterIngestionRuleId, opts) {
|
|
61483
62240
|
opts = opts || {};
|
|
@@ -61505,13 +62262,115 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61505
62262
|
);
|
|
61506
62263
|
}
|
|
61507
62264
|
|
|
62265
|
+
/**
|
|
62266
|
+
* Query for social media aggregates asynchronously
|
|
62267
|
+
*
|
|
62268
|
+
* @param {Object} body query
|
|
62269
|
+
*/
|
|
62270
|
+
postSocialmediaAnalyticsAggregatesJobs(body) {
|
|
62271
|
+
// verify the required parameter 'body' is set
|
|
62272
|
+
if (body === undefined || body === null) {
|
|
62273
|
+
throw 'Missing the required parameter "body" when calling postSocialmediaAnalyticsAggregatesJobs';
|
|
62274
|
+
}
|
|
62275
|
+
|
|
62276
|
+
return this.apiClient.callApi(
|
|
62277
|
+
'/api/v2/socialmedia/analytics/aggregates/jobs',
|
|
62278
|
+
'POST',
|
|
62279
|
+
{ },
|
|
62280
|
+
{ },
|
|
62281
|
+
{ },
|
|
62282
|
+
{ },
|
|
62283
|
+
body,
|
|
62284
|
+
['PureCloud OAuth'],
|
|
62285
|
+
['application/json'],
|
|
62286
|
+
['application/json']
|
|
62287
|
+
);
|
|
62288
|
+
}
|
|
62289
|
+
|
|
62290
|
+
/**
|
|
62291
|
+
* Query for social media messages asynchronously
|
|
62292
|
+
*
|
|
62293
|
+
* @param {Object} body query
|
|
62294
|
+
*/
|
|
62295
|
+
postSocialmediaAnalyticsMessagesJobs(body) {
|
|
62296
|
+
// verify the required parameter 'body' is set
|
|
62297
|
+
if (body === undefined || body === null) {
|
|
62298
|
+
throw 'Missing the required parameter "body" when calling postSocialmediaAnalyticsMessagesJobs';
|
|
62299
|
+
}
|
|
62300
|
+
|
|
62301
|
+
return this.apiClient.callApi(
|
|
62302
|
+
'/api/v2/socialmedia/analytics/messages/jobs',
|
|
62303
|
+
'POST',
|
|
62304
|
+
{ },
|
|
62305
|
+
{ },
|
|
62306
|
+
{ },
|
|
62307
|
+
{ },
|
|
62308
|
+
body,
|
|
62309
|
+
['PureCloud OAuth'],
|
|
62310
|
+
['application/json'],
|
|
62311
|
+
['application/json']
|
|
62312
|
+
);
|
|
62313
|
+
}
|
|
62314
|
+
|
|
62315
|
+
/**
|
|
62316
|
+
* Create an escalation rule.
|
|
62317
|
+
*
|
|
62318
|
+
* @param {Object} opts Optional parameters
|
|
62319
|
+
* @param {Object} opts.body
|
|
62320
|
+
*/
|
|
62321
|
+
postSocialmediaEscalationrules(opts) {
|
|
62322
|
+
opts = opts || {};
|
|
62323
|
+
|
|
62324
|
+
|
|
62325
|
+
return this.apiClient.callApi(
|
|
62326
|
+
'/api/v2/socialmedia/escalationrules',
|
|
62327
|
+
'POST',
|
|
62328
|
+
{ },
|
|
62329
|
+
{ },
|
|
62330
|
+
{ },
|
|
62331
|
+
{ },
|
|
62332
|
+
opts['body'],
|
|
62333
|
+
['PureCloud OAuth'],
|
|
62334
|
+
['application/json'],
|
|
62335
|
+
['application/json']
|
|
62336
|
+
);
|
|
62337
|
+
}
|
|
62338
|
+
|
|
62339
|
+
/**
|
|
62340
|
+
* Escalate message to a conversation manually
|
|
62341
|
+
*
|
|
62342
|
+
* @param {String} divisionId One division ID
|
|
62343
|
+
* @param {Object} opts Optional parameters
|
|
62344
|
+
* @param {Object} opts.body
|
|
62345
|
+
*/
|
|
62346
|
+
postSocialmediaEscalationsMessages(divisionId, opts) {
|
|
62347
|
+
opts = opts || {};
|
|
62348
|
+
|
|
62349
|
+
// verify the required parameter 'divisionId' is set
|
|
62350
|
+
if (divisionId === undefined || divisionId === null) {
|
|
62351
|
+
throw 'Missing the required parameter "divisionId" when calling postSocialmediaEscalationsMessages';
|
|
62352
|
+
}
|
|
62353
|
+
|
|
62354
|
+
return this.apiClient.callApi(
|
|
62355
|
+
'/api/v2/socialmedia/escalations/messages',
|
|
62356
|
+
'POST',
|
|
62357
|
+
{ },
|
|
62358
|
+
{ 'divisionId': divisionId },
|
|
62359
|
+
{ },
|
|
62360
|
+
{ },
|
|
62361
|
+
opts['body'],
|
|
62362
|
+
['PureCloud OAuth'],
|
|
62363
|
+
['application/json'],
|
|
62364
|
+
['application/json']
|
|
62365
|
+
);
|
|
62366
|
+
}
|
|
62367
|
+
|
|
61508
62368
|
/**
|
|
61509
62369
|
* Create an Facebook data ingestion rule.
|
|
61510
62370
|
*
|
|
61511
62371
|
* @param {String} topicId topicId
|
|
61512
62372
|
* @param {Object} opts Optional parameters
|
|
61513
62373
|
* @param {Object} opts.body
|
|
61514
|
-
* postSocialmediaTopicDataingestionrulesFacebook is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
61515
62374
|
*/
|
|
61516
62375
|
postSocialmediaTopicDataingestionrulesFacebook(topicId, opts) {
|
|
61517
62376
|
opts = opts || {};
|
|
@@ -61571,7 +62430,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61571
62430
|
* @param {String} topicId topicId
|
|
61572
62431
|
* @param {Object} opts Optional parameters
|
|
61573
62432
|
* @param {Object} opts.body
|
|
61574
|
-
* postSocialmediaTopicDataingestionrulesTwitter is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
61575
62433
|
*/
|
|
61576
62434
|
postSocialmediaTopicDataingestionrulesTwitter(topicId, opts) {
|
|
61577
62435
|
opts = opts || {};
|
|
@@ -61600,7 +62458,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61600
62458
|
*
|
|
61601
62459
|
* @param {Object} opts Optional parameters
|
|
61602
62460
|
* @param {Object} opts.body
|
|
61603
|
-
* postSocialmediaTopics is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
61604
62461
|
*/
|
|
61605
62462
|
postSocialmediaTopics(opts) {
|
|
61606
62463
|
opts = opts || {};
|
|
@@ -61620,6 +62477,60 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61620
62477
|
);
|
|
61621
62478
|
}
|
|
61622
62479
|
|
|
62480
|
+
/**
|
|
62481
|
+
* Retrieves historical tweet count for search terms, optional countries list and the current limit and usage for the organization.
|
|
62482
|
+
*
|
|
62483
|
+
* @param {Object} body TwitterDataHistoricalTweetRequest
|
|
62484
|
+
*/
|
|
62485
|
+
postSocialmediaTwitterHistoricalTweets(body) {
|
|
62486
|
+
// verify the required parameter 'body' is set
|
|
62487
|
+
if (body === undefined || body === null) {
|
|
62488
|
+
throw 'Missing the required parameter "body" when calling postSocialmediaTwitterHistoricalTweets';
|
|
62489
|
+
}
|
|
62490
|
+
|
|
62491
|
+
return this.apiClient.callApi(
|
|
62492
|
+
'/api/v2/socialmedia/twitter/historical/tweets',
|
|
62493
|
+
'POST',
|
|
62494
|
+
{ },
|
|
62495
|
+
{ },
|
|
62496
|
+
{ },
|
|
62497
|
+
{ },
|
|
62498
|
+
body,
|
|
62499
|
+
['PureCloud OAuth'],
|
|
62500
|
+
['application/json'],
|
|
62501
|
+
['application/json']
|
|
62502
|
+
);
|
|
62503
|
+
}
|
|
62504
|
+
|
|
62505
|
+
/**
|
|
62506
|
+
* Update the escalation rule.
|
|
62507
|
+
*
|
|
62508
|
+
* @param {String} escalationRuleId escalationRuleId
|
|
62509
|
+
* @param {Object} opts Optional parameters
|
|
62510
|
+
* @param {Object} opts.body
|
|
62511
|
+
*/
|
|
62512
|
+
putSocialmediaEscalationrule(escalationRuleId, opts) {
|
|
62513
|
+
opts = opts || {};
|
|
62514
|
+
|
|
62515
|
+
// verify the required parameter 'escalationRuleId' is set
|
|
62516
|
+
if (escalationRuleId === undefined || escalationRuleId === null) {
|
|
62517
|
+
throw 'Missing the required parameter "escalationRuleId" when calling putSocialmediaEscalationrule';
|
|
62518
|
+
}
|
|
62519
|
+
|
|
62520
|
+
return this.apiClient.callApi(
|
|
62521
|
+
'/api/v2/socialmedia/escalationrules/{escalationRuleId}',
|
|
62522
|
+
'PUT',
|
|
62523
|
+
{ 'escalationRuleId': escalationRuleId },
|
|
62524
|
+
{ },
|
|
62525
|
+
{ },
|
|
62526
|
+
{ },
|
|
62527
|
+
opts['body'],
|
|
62528
|
+
['PureCloud OAuth'],
|
|
62529
|
+
['application/json'],
|
|
62530
|
+
['application/json']
|
|
62531
|
+
);
|
|
62532
|
+
}
|
|
62533
|
+
|
|
61623
62534
|
/**
|
|
61624
62535
|
* Update the Facebook data ingestion rule.
|
|
61625
62536
|
*
|
|
@@ -61627,7 +62538,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61627
62538
|
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
61628
62539
|
* @param {Object} opts Optional parameters
|
|
61629
62540
|
* @param {Object} opts.body
|
|
61630
|
-
* putSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
61631
62541
|
*/
|
|
61632
62542
|
putSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId, facebookIngestionRuleId, opts) {
|
|
61633
62543
|
opts = opts || {};
|
|
@@ -61697,7 +62607,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61697
62607
|
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
61698
62608
|
* @param {Object} opts Optional parameters
|
|
61699
62609
|
* @param {Object} opts.body
|
|
61700
|
-
* putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
61701
62610
|
*/
|
|
61702
62611
|
putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId, twitterIngestionRuleId, opts) {
|
|
61703
62612
|
opts = opts || {};
|
|
@@ -61731,7 +62640,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61731
62640
|
/**
|
|
61732
62641
|
* SpeechTextAnalytics service.
|
|
61733
62642
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
61734
|
-
* @version
|
|
62643
|
+
* @version 218.0.0
|
|
61735
62644
|
*/
|
|
61736
62645
|
|
|
61737
62646
|
/**
|
|
@@ -63172,7 +64081,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63172
64081
|
/**
|
|
63173
64082
|
* Stations service.
|
|
63174
64083
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
63175
|
-
* @version
|
|
64084
|
+
* @version 218.0.0
|
|
63176
64085
|
*/
|
|
63177
64086
|
|
|
63178
64087
|
/**
|
|
@@ -63274,7 +64183,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63274
64183
|
/**
|
|
63275
64184
|
* Suggest service.
|
|
63276
64185
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
63277
|
-
* @version
|
|
64186
|
+
* @version 218.0.0
|
|
63278
64187
|
*/
|
|
63279
64188
|
|
|
63280
64189
|
/**
|
|
@@ -63413,7 +64322,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63413
64322
|
/**
|
|
63414
64323
|
* TaskManagement service.
|
|
63415
64324
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
63416
|
-
* @version
|
|
64325
|
+
* @version 218.0.0
|
|
63417
64326
|
*/
|
|
63418
64327
|
|
|
63419
64328
|
/**
|
|
@@ -65519,7 +66428,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65519
66428
|
/**
|
|
65520
66429
|
* Teams service.
|
|
65521
66430
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
65522
|
-
* @version
|
|
66431
|
+
* @version 218.0.0
|
|
65523
66432
|
*/
|
|
65524
66433
|
|
|
65525
66434
|
/**
|
|
@@ -65824,7 +66733,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65824
66733
|
/**
|
|
65825
66734
|
* Telephony service.
|
|
65826
66735
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
65827
|
-
* @version
|
|
66736
|
+
* @version 218.0.0
|
|
65828
66737
|
*/
|
|
65829
66738
|
|
|
65830
66739
|
/**
|
|
@@ -66006,7 +66915,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66006
66915
|
/**
|
|
66007
66916
|
* TelephonyProvidersEdge service.
|
|
66008
66917
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
66009
|
-
* @version
|
|
66918
|
+
* @version 218.0.0
|
|
66010
66919
|
*/
|
|
66011
66920
|
|
|
66012
66921
|
/**
|
|
@@ -67188,6 +68097,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67188
68097
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
67189
68098
|
* @param {String} opts.sortBy Sort by
|
|
67190
68099
|
* @param {String} opts._number Deprecated, filtering by number not supported
|
|
68100
|
+
* @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
|
|
67191
68101
|
*/
|
|
67192
68102
|
getTelephonyProvidersEdgesExtensionpools(opts) {
|
|
67193
68103
|
opts = opts || {};
|
|
@@ -67197,7 +68107,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67197
68107
|
'/api/v2/telephony/providers/edges/extensionpools',
|
|
67198
68108
|
'GET',
|
|
67199
68109
|
{ },
|
|
67200
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'number': opts['_number'] },
|
|
68110
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'number': opts['_number'],'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi') },
|
|
67201
68111
|
{ },
|
|
67202
68112
|
{ },
|
|
67203
68113
|
null,
|
|
@@ -69457,7 +70367,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69457
70367
|
/**
|
|
69458
70368
|
* Textbots service.
|
|
69459
70369
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
69460
|
-
* @version
|
|
70370
|
+
* @version 218.0.0
|
|
69461
70371
|
*/
|
|
69462
70372
|
|
|
69463
70373
|
/**
|
|
@@ -69585,7 +70495,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69585
70495
|
/**
|
|
69586
70496
|
* Tokens service.
|
|
69587
70497
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
69588
|
-
* @version
|
|
70498
|
+
* @version 218.0.0
|
|
69589
70499
|
*/
|
|
69590
70500
|
|
|
69591
70501
|
/**
|
|
@@ -69739,7 +70649,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69739
70649
|
/**
|
|
69740
70650
|
* Uploads service.
|
|
69741
70651
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
69742
|
-
* @version
|
|
70652
|
+
* @version 218.0.0
|
|
69743
70653
|
*/
|
|
69744
70654
|
|
|
69745
70655
|
/**
|
|
@@ -69759,7 +70669,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69759
70669
|
*
|
|
69760
70670
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
69761
70671
|
* @param {String} jobId Upload job ID
|
|
69762
|
-
* getKnowledgeKnowledgebaseUploadsUrlsJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
69763
70672
|
*/
|
|
69764
70673
|
getKnowledgeKnowledgebaseUploadsUrlsJob(knowledgeBaseId, jobId) {
|
|
69765
70674
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -69845,7 +70754,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69845
70754
|
*
|
|
69846
70755
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
69847
70756
|
* @param {Object} body uploadRequest
|
|
69848
|
-
* postKnowledgeKnowledgebaseUploadsUrlsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
69849
70757
|
*/
|
|
69850
70758
|
postKnowledgeKnowledgebaseUploadsUrlsJobs(knowledgeBaseId, body) {
|
|
69851
70759
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -70007,7 +70915,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70007
70915
|
/**
|
|
70008
70916
|
* Usage service.
|
|
70009
70917
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
70010
|
-
* @version
|
|
70918
|
+
* @version 218.0.0
|
|
70011
70919
|
*/
|
|
70012
70920
|
|
|
70013
70921
|
/**
|
|
@@ -70222,7 +71130,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70222
71130
|
/**
|
|
70223
71131
|
* UserRecordings service.
|
|
70224
71132
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
70225
|
-
* @version
|
|
71133
|
+
* @version 218.0.0
|
|
70226
71134
|
*/
|
|
70227
71135
|
|
|
70228
71136
|
/**
|
|
@@ -70437,7 +71345,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70437
71345
|
/**
|
|
70438
71346
|
* Users service.
|
|
70439
71347
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
70440
|
-
* @version
|
|
71348
|
+
* @version 218.0.0
|
|
70441
71349
|
*/
|
|
70442
71350
|
|
|
70443
71351
|
/**
|
|
@@ -73390,7 +74298,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
73390
74298
|
/**
|
|
73391
74299
|
* Utilities service.
|
|
73392
74300
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
73393
|
-
* @version
|
|
74301
|
+
* @version 218.0.0
|
|
73394
74302
|
*/
|
|
73395
74303
|
|
|
73396
74304
|
/**
|
|
@@ -73501,7 +74409,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
73501
74409
|
/**
|
|
73502
74410
|
* Voicemail service.
|
|
73503
74411
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
73504
|
-
* @version
|
|
74412
|
+
* @version 218.0.0
|
|
73505
74413
|
*/
|
|
73506
74414
|
|
|
73507
74415
|
/**
|
|
@@ -74223,7 +75131,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74223
75131
|
/**
|
|
74224
75132
|
* WebChat service.
|
|
74225
75133
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
74226
|
-
* @version
|
|
75134
|
+
* @version 218.0.0
|
|
74227
75135
|
*/
|
|
74228
75136
|
|
|
74229
75137
|
/**
|
|
@@ -74266,9 +75174,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74266
75174
|
|
|
74267
75175
|
/**
|
|
74268
75176
|
* Remove a member from a chat conversation
|
|
74269
|
-
*
|
|
75177
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
74270
75178
|
* @param {String} conversationId conversationId
|
|
74271
75179
|
* @param {String} memberId memberId
|
|
75180
|
+
* @deprecated
|
|
74272
75181
|
*/
|
|
74273
75182
|
deleteWebchatGuestConversationMember(conversationId, memberId) {
|
|
74274
75183
|
// verify the required parameter 'conversationId' is set
|
|
@@ -74394,8 +75303,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74394
75303
|
|
|
74395
75304
|
/**
|
|
74396
75305
|
* Get all media requests to the guest in the conversation
|
|
74397
|
-
*
|
|
75306
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
74398
75307
|
* @param {String} conversationId conversationId
|
|
75308
|
+
* @deprecated
|
|
74399
75309
|
*/
|
|
74400
75310
|
getWebchatGuestConversationMediarequests(conversationId) {
|
|
74401
75311
|
// verify the required parameter 'conversationId' is set
|
|
@@ -74419,9 +75329,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74419
75329
|
|
|
74420
75330
|
/**
|
|
74421
75331
|
* Get a web chat conversation member
|
|
74422
|
-
*
|
|
75332
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
74423
75333
|
* @param {String} conversationId conversationId
|
|
74424
75334
|
* @param {String} memberId memberId
|
|
75335
|
+
* @deprecated
|
|
74425
75336
|
*/
|
|
74426
75337
|
getWebchatGuestConversationMember(conversationId, memberId) {
|
|
74427
75338
|
// verify the required parameter 'conversationId' is set
|
|
@@ -74449,12 +75360,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74449
75360
|
|
|
74450
75361
|
/**
|
|
74451
75362
|
* Get the members of a chat conversation.
|
|
74452
|
-
*
|
|
75363
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
74453
75364
|
* @param {String} conversationId conversationId
|
|
74454
75365
|
* @param {Object} opts Optional parameters
|
|
74455
75366
|
* @param {Number} opts.pageSize The number of entries to return per page, or omitted for the default. (default to 25)
|
|
74456
75367
|
* @param {Number} opts.pageNumber The page number to return, or omitted for the first page. (default to 1)
|
|
74457
75368
|
* @param {Boolean} opts.excludeDisconnectedMembers If true, the results will not contain members who have a DISCONNECTED state. (default to false)
|
|
75369
|
+
* @deprecated
|
|
74458
75370
|
*/
|
|
74459
75371
|
getWebchatGuestConversationMembers(conversationId, opts) {
|
|
74460
75372
|
opts = opts || {};
|
|
@@ -74480,9 +75392,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74480
75392
|
|
|
74481
75393
|
/**
|
|
74482
75394
|
* Get a web chat conversation message
|
|
74483
|
-
*
|
|
75395
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
74484
75396
|
* @param {String} conversationId conversationId
|
|
74485
75397
|
* @param {String} messageId messageId
|
|
75398
|
+
* @deprecated
|
|
74486
75399
|
*/
|
|
74487
75400
|
getWebchatGuestConversationMessage(conversationId, messageId) {
|
|
74488
75401
|
// verify the required parameter 'conversationId' is set
|
|
@@ -74510,13 +75423,14 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74510
75423
|
|
|
74511
75424
|
/**
|
|
74512
75425
|
* Get the messages of a chat conversation.
|
|
74513
|
-
*
|
|
75426
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
74514
75427
|
* @param {String} conversationId conversationId
|
|
74515
75428
|
* @param {Object} opts Optional parameters
|
|
74516
75429
|
* @param {String} opts.after If available, get the messages chronologically after the id of this message
|
|
74517
75430
|
* @param {String} opts.before If available, get the messages chronologically before the id of this message
|
|
74518
75431
|
* @param {Object} opts.sortOrder Sort order (default to ascending)
|
|
74519
75432
|
* @param {Number} opts.maxResults Limit the returned number of messages, up to a maximum of 100 (default to 100)
|
|
75433
|
+
* @deprecated
|
|
74520
75434
|
*/
|
|
74521
75435
|
getWebchatGuestConversationMessages(conversationId, opts) {
|
|
74522
75436
|
opts = opts || {};
|
|
@@ -74624,10 +75538,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74624
75538
|
|
|
74625
75539
|
/**
|
|
74626
75540
|
* Send a message in a chat conversation.
|
|
74627
|
-
*
|
|
75541
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
74628
75542
|
* @param {String} conversationId conversationId
|
|
74629
75543
|
* @param {String} memberId memberId
|
|
74630
75544
|
* @param {Object} body Message
|
|
75545
|
+
* @deprecated
|
|
74631
75546
|
*/
|
|
74632
75547
|
postWebchatGuestConversationMemberMessages(conversationId, memberId, body) {
|
|
74633
75548
|
// verify the required parameter 'conversationId' is set
|
|
@@ -74659,9 +75574,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74659
75574
|
|
|
74660
75575
|
/**
|
|
74661
75576
|
* Send a typing-indicator in a chat conversation.
|
|
74662
|
-
*
|
|
75577
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
74663
75578
|
* @param {String} conversationId conversationId
|
|
74664
75579
|
* @param {String} memberId memberId
|
|
75580
|
+
* @deprecated
|
|
74665
75581
|
*/
|
|
74666
75582
|
postWebchatGuestConversationMemberTyping(conversationId, memberId) {
|
|
74667
75583
|
// verify the required parameter 'conversationId' is set
|
|
@@ -74689,8 +75605,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74689
75605
|
|
|
74690
75606
|
/**
|
|
74691
75607
|
* Create an ACD chat conversation from an external customer.
|
|
74692
|
-
* This endpoint will create a new ACD Chat conversation under the specified Chat Deployment.
|
|
75608
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/. This endpoint will create a new ACD Chat conversation under the specified Chat Deployment. The conversation will begin with a guest member in it (with a role=CUSTOMER) according to the customer information that is supplied. If the guest member is authenticated, the memberAuthToken field should include his JWT as generated by the POST /api/v2/signeddata resource; if the guest member is anonymous (and the Deployment permits it) this field can be omitted. The returned data includes the IDs of the conversation created, along with a newly-create JWT token that you can supply to all future endpoints as authentication to perform operations against that conversation. After successfully creating a conversation, you should connect a websocket to the event stream named in the eventStreamUri field of the response; the conversation is not routed until the event stream is attached.
|
|
74693
75609
|
* @param {Object} body CreateConversationRequest
|
|
75610
|
+
* @deprecated
|
|
74694
75611
|
*/
|
|
74695
75612
|
postWebchatGuestConversations(body) {
|
|
74696
75613
|
// verify the required parameter 'body' is set
|
|
@@ -74774,7 +75691,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74774
75691
|
/**
|
|
74775
75692
|
* WebDeployments service.
|
|
74776
75693
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
74777
|
-
* @version
|
|
75694
|
+
* @version 218.0.0
|
|
74778
75695
|
*/
|
|
74779
75696
|
|
|
74780
75697
|
/**
|
|
@@ -75087,6 +76004,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75087
76004
|
);
|
|
75088
76005
|
}
|
|
75089
76006
|
|
|
76007
|
+
/**
|
|
76008
|
+
* Get a deployment identity resolution setting.
|
|
76009
|
+
*
|
|
76010
|
+
* @param {String} deploymentId The deployment ID
|
|
76011
|
+
* getWebdeploymentsDeploymentIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
76012
|
+
*/
|
|
76013
|
+
getWebdeploymentsDeploymentIdentityresolution(deploymentId) {
|
|
76014
|
+
// verify the required parameter 'deploymentId' is set
|
|
76015
|
+
if (deploymentId === undefined || deploymentId === null) {
|
|
76016
|
+
throw 'Missing the required parameter "deploymentId" when calling getWebdeploymentsDeploymentIdentityresolution';
|
|
76017
|
+
}
|
|
76018
|
+
|
|
76019
|
+
return this.apiClient.callApi(
|
|
76020
|
+
'/api/v2/webdeployments/deployments/{deploymentId}/identityresolution',
|
|
76021
|
+
'GET',
|
|
76022
|
+
{ 'deploymentId': deploymentId },
|
|
76023
|
+
{ },
|
|
76024
|
+
{ },
|
|
76025
|
+
{ },
|
|
76026
|
+
null,
|
|
76027
|
+
['PureCloud OAuth'],
|
|
76028
|
+
['application/json'],
|
|
76029
|
+
['application/json']
|
|
76030
|
+
);
|
|
76031
|
+
}
|
|
76032
|
+
|
|
75090
76033
|
/**
|
|
75091
76034
|
* Get deployments
|
|
75092
76035
|
*
|
|
@@ -75295,13 +76238,44 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75295
76238
|
);
|
|
75296
76239
|
}
|
|
75297
76240
|
|
|
76241
|
+
/**
|
|
76242
|
+
* Update identity resolution settings for a deployment.
|
|
76243
|
+
*
|
|
76244
|
+
* @param {String} deploymentId The deployment ID
|
|
76245
|
+
* @param {Object} body
|
|
76246
|
+
* putWebdeploymentsDeploymentIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
76247
|
+
*/
|
|
76248
|
+
putWebdeploymentsDeploymentIdentityresolution(deploymentId, body) {
|
|
76249
|
+
// verify the required parameter 'deploymentId' is set
|
|
76250
|
+
if (deploymentId === undefined || deploymentId === null) {
|
|
76251
|
+
throw 'Missing the required parameter "deploymentId" when calling putWebdeploymentsDeploymentIdentityresolution';
|
|
76252
|
+
}
|
|
76253
|
+
// verify the required parameter 'body' is set
|
|
76254
|
+
if (body === undefined || body === null) {
|
|
76255
|
+
throw 'Missing the required parameter "body" when calling putWebdeploymentsDeploymentIdentityresolution';
|
|
76256
|
+
}
|
|
76257
|
+
|
|
76258
|
+
return this.apiClient.callApi(
|
|
76259
|
+
'/api/v2/webdeployments/deployments/{deploymentId}/identityresolution',
|
|
76260
|
+
'PUT',
|
|
76261
|
+
{ 'deploymentId': deploymentId },
|
|
76262
|
+
{ },
|
|
76263
|
+
{ },
|
|
76264
|
+
{ },
|
|
76265
|
+
body,
|
|
76266
|
+
['PureCloud OAuth'],
|
|
76267
|
+
['application/json'],
|
|
76268
|
+
['application/json']
|
|
76269
|
+
);
|
|
76270
|
+
}
|
|
76271
|
+
|
|
75298
76272
|
}
|
|
75299
76273
|
|
|
75300
76274
|
class WebMessagingApi {
|
|
75301
76275
|
/**
|
|
75302
76276
|
* WebMessaging service.
|
|
75303
76277
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
75304
|
-
* @version
|
|
76278
|
+
* @version 218.0.0
|
|
75305
76279
|
*/
|
|
75306
76280
|
|
|
75307
76281
|
/**
|
|
@@ -75347,7 +76321,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75347
76321
|
/**
|
|
75348
76322
|
* Widgets service.
|
|
75349
76323
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
75350
|
-
* @version
|
|
76324
|
+
* @version 218.0.0
|
|
75351
76325
|
*/
|
|
75352
76326
|
|
|
75353
76327
|
/**
|
|
@@ -75364,8 +76338,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75364
76338
|
|
|
75365
76339
|
/**
|
|
75366
76340
|
* Delete a Widget deployment
|
|
75367
|
-
*
|
|
76341
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
75368
76342
|
* @param {String} deploymentId Widget Config Id
|
|
76343
|
+
* @deprecated
|
|
75369
76344
|
*/
|
|
75370
76345
|
deleteWidgetsDeployment(deploymentId) {
|
|
75371
76346
|
// verify the required parameter 'deploymentId' is set
|
|
@@ -75389,8 +76364,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75389
76364
|
|
|
75390
76365
|
/**
|
|
75391
76366
|
* Get a Widget deployment
|
|
75392
|
-
*
|
|
76367
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
75393
76368
|
* @param {String} deploymentId Widget Config Id
|
|
76369
|
+
* @deprecated
|
|
75394
76370
|
*/
|
|
75395
76371
|
getWidgetsDeployment(deploymentId) {
|
|
75396
76372
|
// verify the required parameter 'deploymentId' is set
|
|
@@ -75414,7 +76390,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75414
76390
|
|
|
75415
76391
|
/**
|
|
75416
76392
|
* List Widget deployments
|
|
75417
|
-
*
|
|
76393
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
76394
|
+
* @deprecated
|
|
75418
76395
|
*/
|
|
75419
76396
|
getWidgetsDeployments() {
|
|
75420
76397
|
|
|
@@ -75434,8 +76411,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75434
76411
|
|
|
75435
76412
|
/**
|
|
75436
76413
|
* Create Widget deployment
|
|
75437
|
-
*
|
|
76414
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
75438
76415
|
* @param {Object} body Deployment
|
|
76416
|
+
* @deprecated
|
|
75439
76417
|
*/
|
|
75440
76418
|
postWidgetsDeployments(body) {
|
|
75441
76419
|
// verify the required parameter 'body' is set
|
|
@@ -75459,9 +76437,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75459
76437
|
|
|
75460
76438
|
/**
|
|
75461
76439
|
* Update a Widget deployment
|
|
75462
|
-
*
|
|
76440
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
75463
76441
|
* @param {String} deploymentId Widget Config Id
|
|
75464
76442
|
* @param {Object} body Deployment
|
|
76443
|
+
* @deprecated
|
|
75465
76444
|
*/
|
|
75466
76445
|
putWidgetsDeployment(deploymentId, body) {
|
|
75467
76446
|
// verify the required parameter 'deploymentId' is set
|
|
@@ -75493,7 +76472,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75493
76472
|
/**
|
|
75494
76473
|
* WorkforceManagement service.
|
|
75495
76474
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
75496
|
-
* @version
|
|
76475
|
+
* @version 218.0.0
|
|
75497
76476
|
*/
|
|
75498
76477
|
|
|
75499
76478
|
/**
|
|
@@ -82886,7 +83865,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
82886
83865
|
* </pre>
|
|
82887
83866
|
* </p>
|
|
82888
83867
|
* @module purecloud-platform-client-v2/index
|
|
82889
|
-
* @version
|
|
83868
|
+
* @version 218.0.0
|
|
82890
83869
|
*/
|
|
82891
83870
|
class platformClient {
|
|
82892
83871
|
constructor() {
|