purecloud-platform-client-v2 249.0.0 → 250.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 +34 -3
- package/dist/node/purecloud-platform-client-v2.js +20042 -5569
- package/dist/web-amd/purecloud-platform-client-v2.js +20042 -5569
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +11159 -5369
- package/dist/web-cjs/purecloud-platform-client-v2.js +11159 -5369
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +10600 -2242
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +26 -2
- package/src/purecloud-platform-client-v2/api/AIStudioApi.js +136 -40
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +130 -39
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +18 -6
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +29 -9
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +86 -26
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +917 -224
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +754 -226
- package/src/purecloud-platform-client-v2/api/AssistantCopilotVariationsApi.js +36 -11
- package/src/purecloud-platform-client-v2/api/AuditApi.js +38 -12
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +302 -91
- package/src/purecloud-platform-client-v2/api/BackgroundAssistantApi.js +7 -3
- package/src/purecloud-platform-client-v2/api/BillingApi.js +41 -13
- package/src/purecloud-platform-client-v2/api/BusinessRulesApi.js +180 -53
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +11 -4
- package/src/purecloud-platform-client-v2/api/CaseManagementApi.js +187 -56
- package/src/purecloud-platform-client-v2/api/ChatApi.js +223 -65
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +124 -37
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +165 -51
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1992 -578
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +22 -7
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +39 -12
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +4 -2
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +28 -9
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +35 -11
- package/src/purecloud-platform-client-v2/api/EventsApi.js +22 -7
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +700 -206
- package/src/purecloud-platform-client-v2/api/FaxApi.js +49 -15
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +42 -13
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +419 -125
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +21 -7
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +29 -9
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +106 -32
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +103 -31
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +267 -77
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +20 -7
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +461 -139
- package/src/purecloud-platform-client-v2/api/IntentsApi.js +93 -28
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +872 -120
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +618 -185
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +221 -66
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +53 -16
- package/src/purecloud-platform-client-v2/api/LearningApi.js +199 -60
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +51 -16
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +45 -14
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +34 -11
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +84 -25
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +28 -9
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +41 -13
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +72 -22
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +58 -18
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +21 -7
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +122 -36
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +297 -87
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1066 -312
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +162 -48
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +41 -13
- package/src/purecloud-platform-client-v2/api/QualityApi.js +409 -121
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +351 -108
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +113 -34
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +964 -284
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +123 -39
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +50 -17
- package/src/purecloud-platform-client-v2/api/SearchApi.js +147 -44
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +87 -26
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +208 -67
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +389 -114
- package/src/purecloud-platform-client-v2/api/StationsApi.js +18 -6
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +13 -5
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +473 -138
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +55 -17
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +80 -24
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +751 -220
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +25 -8
- package/src/purecloud-platform-client-v2/api/TokensApi.js +35 -11
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +78 -23
- package/src/purecloud-platform-client-v2/api/UsageApi.js +62 -19
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +27 -9
- package/src/purecloud-platform-client-v2/api/UsersApi.js +717 -228
- package/src/purecloud-platform-client-v2/api/UsersRulesApi.js +52 -16
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +25 -8
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +154 -46
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +126 -37
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +120 -36
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +25 -8
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +36 -11
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +2475 -577
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -5,7 +5,7 @@ class OutboundApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Outbound service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 250.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -24,8 +24,12 @@ class OutboundApi {
|
|
|
24
24
|
* Delete attempt limits
|
|
25
25
|
*
|
|
26
26
|
* @param {String} attemptLimitsId Attempt limits ID
|
|
27
|
+
* @param {Object} opts Optional parameters
|
|
28
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
27
29
|
*/
|
|
28
|
-
deleteOutboundAttemptlimit(attemptLimitsId) {
|
|
30
|
+
deleteOutboundAttemptlimit(attemptLimitsId, opts) {
|
|
31
|
+
opts = opts || {};
|
|
32
|
+
|
|
29
33
|
// verify the required parameter 'attemptLimitsId' is set
|
|
30
34
|
if (attemptLimitsId === undefined || attemptLimitsId === null || attemptLimitsId === '') {
|
|
31
35
|
throw 'Missing the required parameter "attemptLimitsId" when calling deleteOutboundAttemptlimit';
|
|
@@ -41,7 +45,8 @@ class OutboundApi {
|
|
|
41
45
|
null,
|
|
42
46
|
['PureCloud OAuth'],
|
|
43
47
|
['application/json'],
|
|
44
|
-
['application/json']
|
|
48
|
+
['application/json'],
|
|
49
|
+
opts['customHeaders']
|
|
45
50
|
);
|
|
46
51
|
}
|
|
47
52
|
|
|
@@ -49,8 +54,12 @@ class OutboundApi {
|
|
|
49
54
|
* Delete callable time set
|
|
50
55
|
*
|
|
51
56
|
* @param {String} callableTimeSetId Callable Time Set ID
|
|
57
|
+
* @param {Object} opts Optional parameters
|
|
58
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
52
59
|
*/
|
|
53
|
-
deleteOutboundCallabletimeset(callableTimeSetId) {
|
|
60
|
+
deleteOutboundCallabletimeset(callableTimeSetId, opts) {
|
|
61
|
+
opts = opts || {};
|
|
62
|
+
|
|
54
63
|
// verify the required parameter 'callableTimeSetId' is set
|
|
55
64
|
if (callableTimeSetId === undefined || callableTimeSetId === null || callableTimeSetId === '') {
|
|
56
65
|
throw 'Missing the required parameter "callableTimeSetId" when calling deleteOutboundCallabletimeset';
|
|
@@ -66,7 +75,8 @@ class OutboundApi {
|
|
|
66
75
|
null,
|
|
67
76
|
['PureCloud OAuth'],
|
|
68
77
|
['application/json'],
|
|
69
|
-
['application/json']
|
|
78
|
+
['application/json'],
|
|
79
|
+
opts['customHeaders']
|
|
70
80
|
);
|
|
71
81
|
}
|
|
72
82
|
|
|
@@ -74,8 +84,12 @@ class OutboundApi {
|
|
|
74
84
|
* Delete a dialer call analysis response set.
|
|
75
85
|
*
|
|
76
86
|
* @param {String} callAnalysisSetId Call Analysis Response Set ID
|
|
87
|
+
* @param {Object} opts Optional parameters
|
|
88
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
77
89
|
*/
|
|
78
|
-
deleteOutboundCallanalysisresponseset(callAnalysisSetId) {
|
|
90
|
+
deleteOutboundCallanalysisresponseset(callAnalysisSetId, opts) {
|
|
91
|
+
opts = opts || {};
|
|
92
|
+
|
|
79
93
|
// verify the required parameter 'callAnalysisSetId' is set
|
|
80
94
|
if (callAnalysisSetId === undefined || callAnalysisSetId === null || callAnalysisSetId === '') {
|
|
81
95
|
throw 'Missing the required parameter "callAnalysisSetId" when calling deleteOutboundCallanalysisresponseset';
|
|
@@ -91,7 +105,8 @@ class OutboundApi {
|
|
|
91
105
|
null,
|
|
92
106
|
['PureCloud OAuth'],
|
|
93
107
|
['application/json'],
|
|
94
|
-
['application/json']
|
|
108
|
+
['application/json'],
|
|
109
|
+
opts['customHeaders']
|
|
95
110
|
);
|
|
96
111
|
}
|
|
97
112
|
|
|
@@ -99,8 +114,12 @@ class OutboundApi {
|
|
|
99
114
|
* Delete a campaign.
|
|
100
115
|
*
|
|
101
116
|
* @param {String} campaignId Campaign ID
|
|
117
|
+
* @param {Object} opts Optional parameters
|
|
118
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
102
119
|
*/
|
|
103
|
-
deleteOutboundCampaign(campaignId) {
|
|
120
|
+
deleteOutboundCampaign(campaignId, opts) {
|
|
121
|
+
opts = opts || {};
|
|
122
|
+
|
|
104
123
|
// verify the required parameter 'campaignId' is set
|
|
105
124
|
if (campaignId === undefined || campaignId === null || campaignId === '') {
|
|
106
125
|
throw 'Missing the required parameter "campaignId" when calling deleteOutboundCampaign';
|
|
@@ -116,7 +135,8 @@ class OutboundApi {
|
|
|
116
135
|
null,
|
|
117
136
|
['PureCloud OAuth'],
|
|
118
137
|
['application/json'],
|
|
119
|
-
['application/json']
|
|
138
|
+
['application/json'],
|
|
139
|
+
opts['customHeaders']
|
|
120
140
|
);
|
|
121
141
|
}
|
|
122
142
|
|
|
@@ -124,8 +144,12 @@ class OutboundApi {
|
|
|
124
144
|
* Reset campaign progress and recycle the campaign
|
|
125
145
|
*
|
|
126
146
|
* @param {String} campaignId Campaign ID
|
|
147
|
+
* @param {Object} opts Optional parameters
|
|
148
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
127
149
|
*/
|
|
128
|
-
deleteOutboundCampaignProgress(campaignId) {
|
|
150
|
+
deleteOutboundCampaignProgress(campaignId, opts) {
|
|
151
|
+
opts = opts || {};
|
|
152
|
+
|
|
129
153
|
// verify the required parameter 'campaignId' is set
|
|
130
154
|
if (campaignId === undefined || campaignId === null || campaignId === '') {
|
|
131
155
|
throw 'Missing the required parameter "campaignId" when calling deleteOutboundCampaignProgress';
|
|
@@ -141,7 +165,8 @@ class OutboundApi {
|
|
|
141
165
|
null,
|
|
142
166
|
['PureCloud OAuth'],
|
|
143
167
|
['application/json'],
|
|
144
|
-
['application/json']
|
|
168
|
+
['application/json'],
|
|
169
|
+
opts['customHeaders']
|
|
145
170
|
);
|
|
146
171
|
}
|
|
147
172
|
|
|
@@ -149,8 +174,12 @@ class OutboundApi {
|
|
|
149
174
|
* Delete Campaign Rule
|
|
150
175
|
*
|
|
151
176
|
* @param {String} campaignRuleId Campaign Rule ID
|
|
177
|
+
* @param {Object} opts Optional parameters
|
|
178
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
152
179
|
*/
|
|
153
|
-
deleteOutboundCampaignrule(campaignRuleId) {
|
|
180
|
+
deleteOutboundCampaignrule(campaignRuleId, opts) {
|
|
181
|
+
opts = opts || {};
|
|
182
|
+
|
|
154
183
|
// verify the required parameter 'campaignRuleId' is set
|
|
155
184
|
if (campaignRuleId === undefined || campaignRuleId === null || campaignRuleId === '') {
|
|
156
185
|
throw 'Missing the required parameter "campaignRuleId" when calling deleteOutboundCampaignrule';
|
|
@@ -166,7 +195,8 @@ class OutboundApi {
|
|
|
166
195
|
null,
|
|
167
196
|
['PureCloud OAuth'],
|
|
168
197
|
['application/json'],
|
|
169
|
-
['application/json']
|
|
198
|
+
['application/json'],
|
|
199
|
+
opts['customHeaders']
|
|
170
200
|
);
|
|
171
201
|
}
|
|
172
202
|
|
|
@@ -174,8 +204,12 @@ class OutboundApi {
|
|
|
174
204
|
* Delete a contact list.
|
|
175
205
|
*
|
|
176
206
|
* @param {String} contactListId ContactList ID
|
|
207
|
+
* @param {Object} opts Optional parameters
|
|
208
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
177
209
|
*/
|
|
178
|
-
deleteOutboundContactlist(contactListId) {
|
|
210
|
+
deleteOutboundContactlist(contactListId, opts) {
|
|
211
|
+
opts = opts || {};
|
|
212
|
+
|
|
179
213
|
// verify the required parameter 'contactListId' is set
|
|
180
214
|
if (contactListId === undefined || contactListId === null || contactListId === '') {
|
|
181
215
|
throw 'Missing the required parameter "contactListId" when calling deleteOutboundContactlist';
|
|
@@ -191,7 +225,8 @@ class OutboundApi {
|
|
|
191
225
|
null,
|
|
192
226
|
['PureCloud OAuth'],
|
|
193
227
|
['application/json'],
|
|
194
|
-
['application/json']
|
|
228
|
+
['application/json'],
|
|
229
|
+
opts['customHeaders']
|
|
195
230
|
);
|
|
196
231
|
}
|
|
197
232
|
|
|
@@ -200,8 +235,12 @@ class OutboundApi {
|
|
|
200
235
|
*
|
|
201
236
|
* @param {String} contactListId Contact List ID
|
|
202
237
|
* @param {String} contactId Contact ID
|
|
238
|
+
* @param {Object} opts Optional parameters
|
|
239
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
203
240
|
*/
|
|
204
|
-
deleteOutboundContactlistContact(contactListId, contactId) {
|
|
241
|
+
deleteOutboundContactlistContact(contactListId, contactId, opts) {
|
|
242
|
+
opts = opts || {};
|
|
243
|
+
|
|
205
244
|
// verify the required parameter 'contactListId' is set
|
|
206
245
|
if (contactListId === undefined || contactListId === null || contactListId === '') {
|
|
207
246
|
throw 'Missing the required parameter "contactListId" when calling deleteOutboundContactlistContact';
|
|
@@ -221,7 +260,8 @@ class OutboundApi {
|
|
|
221
260
|
null,
|
|
222
261
|
['PureCloud OAuth'],
|
|
223
262
|
['application/json'],
|
|
224
|
-
['application/json']
|
|
263
|
+
['application/json'],
|
|
264
|
+
opts['customHeaders']
|
|
225
265
|
);
|
|
226
266
|
}
|
|
227
267
|
|
|
@@ -230,8 +270,12 @@ class OutboundApi {
|
|
|
230
270
|
*
|
|
231
271
|
* @param {String} contactListId Contact List ID
|
|
232
272
|
* @param {Array.<String>} contactIds ContactIds to delete.
|
|
273
|
+
* @param {Object} opts Optional parameters
|
|
274
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
233
275
|
*/
|
|
234
|
-
deleteOutboundContactlistContacts(contactListId, contactIds) {
|
|
276
|
+
deleteOutboundContactlistContacts(contactListId, contactIds, opts) {
|
|
277
|
+
opts = opts || {};
|
|
278
|
+
|
|
235
279
|
// verify the required parameter 'contactListId' is set
|
|
236
280
|
if (contactListId === undefined || contactListId === null || contactListId === '') {
|
|
237
281
|
throw 'Missing the required parameter "contactListId" when calling deleteOutboundContactlistContacts';
|
|
@@ -251,7 +295,8 @@ class OutboundApi {
|
|
|
251
295
|
null,
|
|
252
296
|
['PureCloud OAuth'],
|
|
253
297
|
['application/json'],
|
|
254
|
-
['application/json']
|
|
298
|
+
['application/json'],
|
|
299
|
+
opts['customHeaders']
|
|
255
300
|
);
|
|
256
301
|
}
|
|
257
302
|
|
|
@@ -259,8 +304,12 @@ class OutboundApi {
|
|
|
259
304
|
* Delete Contact List Filter
|
|
260
305
|
*
|
|
261
306
|
* @param {String} contactListFilterId Contact List Filter ID
|
|
307
|
+
* @param {Object} opts Optional parameters
|
|
308
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
262
309
|
*/
|
|
263
|
-
deleteOutboundContactlistfilter(contactListFilterId) {
|
|
310
|
+
deleteOutboundContactlistfilter(contactListFilterId, opts) {
|
|
311
|
+
opts = opts || {};
|
|
312
|
+
|
|
264
313
|
// verify the required parameter 'contactListFilterId' is set
|
|
265
314
|
if (contactListFilterId === undefined || contactListFilterId === null || contactListFilterId === '') {
|
|
266
315
|
throw 'Missing the required parameter "contactListFilterId" when calling deleteOutboundContactlistfilter';
|
|
@@ -276,7 +325,8 @@ class OutboundApi {
|
|
|
276
325
|
null,
|
|
277
326
|
['PureCloud OAuth'],
|
|
278
327
|
['application/json'],
|
|
279
|
-
['application/json']
|
|
328
|
+
['application/json'],
|
|
329
|
+
opts['customHeaders']
|
|
280
330
|
);
|
|
281
331
|
}
|
|
282
332
|
|
|
@@ -284,8 +334,12 @@ class OutboundApi {
|
|
|
284
334
|
* Delete multiple contact lists.
|
|
285
335
|
*
|
|
286
336
|
* @param {Array.<String>} id contact list id(s) to delete
|
|
337
|
+
* @param {Object} opts Optional parameters
|
|
338
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
287
339
|
*/
|
|
288
|
-
deleteOutboundContactlists(id) {
|
|
340
|
+
deleteOutboundContactlists(id, opts) {
|
|
341
|
+
opts = opts || {};
|
|
342
|
+
|
|
289
343
|
// verify the required parameter 'id' is set
|
|
290
344
|
if (id === undefined || id === null) {
|
|
291
345
|
throw 'Missing the required parameter "id" when calling deleteOutboundContactlists';
|
|
@@ -301,7 +355,8 @@ class OutboundApi {
|
|
|
301
355
|
null,
|
|
302
356
|
['PureCloud OAuth'],
|
|
303
357
|
['application/json'],
|
|
304
|
-
['application/json']
|
|
358
|
+
['application/json'],
|
|
359
|
+
opts['customHeaders']
|
|
305
360
|
);
|
|
306
361
|
}
|
|
307
362
|
|
|
@@ -309,8 +364,12 @@ class OutboundApi {
|
|
|
309
364
|
* Delete Contact List Template
|
|
310
365
|
*
|
|
311
366
|
* @param {String} contactListTemplateId ContactListTemplate ID
|
|
367
|
+
* @param {Object} opts Optional parameters
|
|
368
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
312
369
|
*/
|
|
313
|
-
deleteOutboundContactlisttemplate(contactListTemplateId) {
|
|
370
|
+
deleteOutboundContactlisttemplate(contactListTemplateId, opts) {
|
|
371
|
+
opts = opts || {};
|
|
372
|
+
|
|
314
373
|
// verify the required parameter 'contactListTemplateId' is set
|
|
315
374
|
if (contactListTemplateId === undefined || contactListTemplateId === null || contactListTemplateId === '') {
|
|
316
375
|
throw 'Missing the required parameter "contactListTemplateId" when calling deleteOutboundContactlisttemplate';
|
|
@@ -326,7 +385,8 @@ class OutboundApi {
|
|
|
326
385
|
null,
|
|
327
386
|
['PureCloud OAuth'],
|
|
328
387
|
['application/json'],
|
|
329
|
-
['application/json']
|
|
388
|
+
['application/json'],
|
|
389
|
+
opts['customHeaders']
|
|
330
390
|
);
|
|
331
391
|
}
|
|
332
392
|
|
|
@@ -334,8 +394,12 @@ class OutboundApi {
|
|
|
334
394
|
* Delete multiple contact list templates.
|
|
335
395
|
*
|
|
336
396
|
* @param {Array.<String>} id contact list template id(s) to delete
|
|
397
|
+
* @param {Object} opts Optional parameters
|
|
398
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
337
399
|
*/
|
|
338
|
-
deleteOutboundContactlisttemplates(id) {
|
|
400
|
+
deleteOutboundContactlisttemplates(id, opts) {
|
|
401
|
+
opts = opts || {};
|
|
402
|
+
|
|
339
403
|
// verify the required parameter 'id' is set
|
|
340
404
|
if (id === undefined || id === null) {
|
|
341
405
|
throw 'Missing the required parameter "id" when calling deleteOutboundContactlisttemplates';
|
|
@@ -351,7 +415,8 @@ class OutboundApi {
|
|
|
351
415
|
null,
|
|
352
416
|
['PureCloud OAuth'],
|
|
353
417
|
['application/json'],
|
|
354
|
-
['application/json']
|
|
418
|
+
['application/json'],
|
|
419
|
+
opts['customHeaders']
|
|
355
420
|
);
|
|
356
421
|
}
|
|
357
422
|
|
|
@@ -359,8 +424,12 @@ class OutboundApi {
|
|
|
359
424
|
* Delete an Outbound Digital Rule Set
|
|
360
425
|
*
|
|
361
426
|
* @param {String} digitalRuleSetId The Digital Rule Set ID
|
|
427
|
+
* @param {Object} opts Optional parameters
|
|
428
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
362
429
|
*/
|
|
363
|
-
deleteOutboundDigitalruleset(digitalRuleSetId) {
|
|
430
|
+
deleteOutboundDigitalruleset(digitalRuleSetId, opts) {
|
|
431
|
+
opts = opts || {};
|
|
432
|
+
|
|
364
433
|
// verify the required parameter 'digitalRuleSetId' is set
|
|
365
434
|
if (digitalRuleSetId === undefined || digitalRuleSetId === null || digitalRuleSetId === '') {
|
|
366
435
|
throw 'Missing the required parameter "digitalRuleSetId" when calling deleteOutboundDigitalruleset';
|
|
@@ -376,7 +445,8 @@ class OutboundApi {
|
|
|
376
445
|
null,
|
|
377
446
|
['PureCloud OAuth'],
|
|
378
447
|
['application/json'],
|
|
379
|
-
['application/json']
|
|
448
|
+
['application/json'],
|
|
449
|
+
opts['customHeaders']
|
|
380
450
|
);
|
|
381
451
|
}
|
|
382
452
|
|
|
@@ -384,8 +454,12 @@ class OutboundApi {
|
|
|
384
454
|
* Delete dialer DNC list
|
|
385
455
|
*
|
|
386
456
|
* @param {String} dncListId DncList ID
|
|
457
|
+
* @param {Object} opts Optional parameters
|
|
458
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
387
459
|
*/
|
|
388
|
-
deleteOutboundDnclist(dncListId) {
|
|
460
|
+
deleteOutboundDnclist(dncListId, opts) {
|
|
461
|
+
opts = opts || {};
|
|
462
|
+
|
|
389
463
|
// verify the required parameter 'dncListId' is set
|
|
390
464
|
if (dncListId === undefined || dncListId === null || dncListId === '') {
|
|
391
465
|
throw 'Missing the required parameter "dncListId" when calling deleteOutboundDnclist';
|
|
@@ -401,7 +475,8 @@ class OutboundApi {
|
|
|
401
475
|
null,
|
|
402
476
|
['PureCloud OAuth'],
|
|
403
477
|
['application/json'],
|
|
404
|
-
['application/json']
|
|
478
|
+
['application/json'],
|
|
479
|
+
opts['customHeaders']
|
|
405
480
|
);
|
|
406
481
|
}
|
|
407
482
|
|
|
@@ -411,6 +486,7 @@ class OutboundApi {
|
|
|
411
486
|
* @param {String} dncListId DncList ID
|
|
412
487
|
* @param {Object} opts Optional parameters
|
|
413
488
|
* @param {Boolean} opts.expiredOnly Set to true to only remove DNC entries that are expired (default to false)
|
|
489
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
414
490
|
*/
|
|
415
491
|
deleteOutboundDnclistCustomexclusioncolumns(dncListId, opts) {
|
|
416
492
|
opts = opts || {};
|
|
@@ -430,7 +506,8 @@ class OutboundApi {
|
|
|
430
506
|
null,
|
|
431
507
|
['PureCloud OAuth'],
|
|
432
508
|
['application/json'],
|
|
433
|
-
['application/json']
|
|
509
|
+
['application/json'],
|
|
510
|
+
opts['customHeaders']
|
|
434
511
|
);
|
|
435
512
|
}
|
|
436
513
|
|
|
@@ -440,6 +517,7 @@ class OutboundApi {
|
|
|
440
517
|
* @param {String} dncListId DncList ID
|
|
441
518
|
* @param {Object} opts Optional parameters
|
|
442
519
|
* @param {Boolean} opts.expiredOnly Set to true to only remove DNC entries that are expired (default to false)
|
|
520
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
443
521
|
*/
|
|
444
522
|
deleteOutboundDnclistEmailaddresses(dncListId, opts) {
|
|
445
523
|
opts = opts || {};
|
|
@@ -459,7 +537,8 @@ class OutboundApi {
|
|
|
459
537
|
null,
|
|
460
538
|
['PureCloud OAuth'],
|
|
461
539
|
['application/json'],
|
|
462
|
-
['application/json']
|
|
540
|
+
['application/json'],
|
|
541
|
+
opts['customHeaders']
|
|
463
542
|
);
|
|
464
543
|
}
|
|
465
544
|
|
|
@@ -469,6 +548,7 @@ class OutboundApi {
|
|
|
469
548
|
* @param {String} dncListId DncList ID
|
|
470
549
|
* @param {Object} opts Optional parameters
|
|
471
550
|
* @param {Boolean} opts.expiredOnly Set to true to only remove DNC entries that are expired (default to false)
|
|
551
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
472
552
|
*/
|
|
473
553
|
deleteOutboundDnclistPhonenumbers(dncListId, opts) {
|
|
474
554
|
opts = opts || {};
|
|
@@ -488,7 +568,8 @@ class OutboundApi {
|
|
|
488
568
|
null,
|
|
489
569
|
['PureCloud OAuth'],
|
|
490
570
|
['application/json'],
|
|
491
|
-
['application/json']
|
|
571
|
+
['application/json'],
|
|
572
|
+
opts['customHeaders']
|
|
492
573
|
);
|
|
493
574
|
}
|
|
494
575
|
|
|
@@ -498,6 +579,7 @@ class OutboundApi {
|
|
|
498
579
|
* @param {String} dncListId DncList ID
|
|
499
580
|
* @param {Object} opts Optional parameters
|
|
500
581
|
* @param {Boolean} opts.expiredOnly Set to true to only remove DNC whatsApp numbers that are expired (default to false)
|
|
582
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
501
583
|
*/
|
|
502
584
|
deleteOutboundDnclistWhatsappnumbers(dncListId, opts) {
|
|
503
585
|
opts = opts || {};
|
|
@@ -517,7 +599,8 @@ class OutboundApi {
|
|
|
517
599
|
null,
|
|
518
600
|
['PureCloud OAuth'],
|
|
519
601
|
['application/json'],
|
|
520
|
-
['application/json']
|
|
602
|
+
['application/json'],
|
|
603
|
+
opts['customHeaders']
|
|
521
604
|
);
|
|
522
605
|
}
|
|
523
606
|
|
|
@@ -525,8 +608,12 @@ class OutboundApi {
|
|
|
525
608
|
* Delete File Specification Template
|
|
526
609
|
*
|
|
527
610
|
* @param {String} fileSpecificationTemplateId File Specification Template ID
|
|
611
|
+
* @param {Object} opts Optional parameters
|
|
612
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
528
613
|
*/
|
|
529
|
-
deleteOutboundFilespecificationtemplate(fileSpecificationTemplateId) {
|
|
614
|
+
deleteOutboundFilespecificationtemplate(fileSpecificationTemplateId, opts) {
|
|
615
|
+
opts = opts || {};
|
|
616
|
+
|
|
530
617
|
// verify the required parameter 'fileSpecificationTemplateId' is set
|
|
531
618
|
if (fileSpecificationTemplateId === undefined || fileSpecificationTemplateId === null || fileSpecificationTemplateId === '') {
|
|
532
619
|
throw 'Missing the required parameter "fileSpecificationTemplateId" when calling deleteOutboundFilespecificationtemplate';
|
|
@@ -542,7 +629,8 @@ class OutboundApi {
|
|
|
542
629
|
null,
|
|
543
630
|
['PureCloud OAuth'],
|
|
544
631
|
['application/json'],
|
|
545
|
-
['application/json']
|
|
632
|
+
['application/json'],
|
|
633
|
+
opts['customHeaders']
|
|
546
634
|
);
|
|
547
635
|
}
|
|
548
636
|
|
|
@@ -550,8 +638,12 @@ class OutboundApi {
|
|
|
550
638
|
* Delete multiple file specification templates.
|
|
551
639
|
*
|
|
552
640
|
* @param {Array.<String>} id File Specification template id(s) to delete
|
|
641
|
+
* @param {Object} opts Optional parameters
|
|
642
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
553
643
|
*/
|
|
554
|
-
deleteOutboundFilespecificationtemplatesBulk(id) {
|
|
644
|
+
deleteOutboundFilespecificationtemplatesBulk(id, opts) {
|
|
645
|
+
opts = opts || {};
|
|
646
|
+
|
|
555
647
|
// verify the required parameter 'id' is set
|
|
556
648
|
if (id === undefined || id === null) {
|
|
557
649
|
throw 'Missing the required parameter "id" when calling deleteOutboundFilespecificationtemplatesBulk';
|
|
@@ -567,7 +659,8 @@ class OutboundApi {
|
|
|
567
659
|
null,
|
|
568
660
|
['PureCloud OAuth'],
|
|
569
661
|
['application/json'],
|
|
570
|
-
['application/json']
|
|
662
|
+
['application/json'],
|
|
663
|
+
opts['customHeaders']
|
|
571
664
|
);
|
|
572
665
|
}
|
|
573
666
|
|
|
@@ -575,8 +668,12 @@ class OutboundApi {
|
|
|
575
668
|
* Delete Import Template
|
|
576
669
|
*
|
|
577
670
|
* @param {String} importTemplateId Import Template ID
|
|
671
|
+
* @param {Object} opts Optional parameters
|
|
672
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
578
673
|
*/
|
|
579
|
-
deleteOutboundImporttemplate(importTemplateId) {
|
|
674
|
+
deleteOutboundImporttemplate(importTemplateId, opts) {
|
|
675
|
+
opts = opts || {};
|
|
676
|
+
|
|
580
677
|
// verify the required parameter 'importTemplateId' is set
|
|
581
678
|
if (importTemplateId === undefined || importTemplateId === null || importTemplateId === '') {
|
|
582
679
|
throw 'Missing the required parameter "importTemplateId" when calling deleteOutboundImporttemplate';
|
|
@@ -592,7 +689,8 @@ class OutboundApi {
|
|
|
592
689
|
null,
|
|
593
690
|
['PureCloud OAuth'],
|
|
594
691
|
['application/json'],
|
|
595
|
-
['application/json']
|
|
692
|
+
['application/json'],
|
|
693
|
+
opts['customHeaders']
|
|
596
694
|
);
|
|
597
695
|
}
|
|
598
696
|
|
|
@@ -600,8 +698,12 @@ class OutboundApi {
|
|
|
600
698
|
* Delete multiple import templates.
|
|
601
699
|
*
|
|
602
700
|
* @param {Array.<String>} id import template id(s) to delete
|
|
701
|
+
* @param {Object} opts Optional parameters
|
|
702
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
603
703
|
*/
|
|
604
|
-
deleteOutboundImporttemplates(id) {
|
|
704
|
+
deleteOutboundImporttemplates(id, opts) {
|
|
705
|
+
opts = opts || {};
|
|
706
|
+
|
|
605
707
|
// verify the required parameter 'id' is set
|
|
606
708
|
if (id === undefined || id === null) {
|
|
607
709
|
throw 'Missing the required parameter "id" when calling deleteOutboundImporttemplates';
|
|
@@ -617,7 +719,8 @@ class OutboundApi {
|
|
|
617
719
|
null,
|
|
618
720
|
['PureCloud OAuth'],
|
|
619
721
|
['application/json'],
|
|
620
|
-
['application/json']
|
|
722
|
+
['application/json'],
|
|
723
|
+
opts['customHeaders']
|
|
621
724
|
);
|
|
622
725
|
}
|
|
623
726
|
|
|
@@ -625,8 +728,12 @@ class OutboundApi {
|
|
|
625
728
|
* Delete an Outbound Messaging Campaign
|
|
626
729
|
*
|
|
627
730
|
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
731
|
+
* @param {Object} opts Optional parameters
|
|
732
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
628
733
|
*/
|
|
629
|
-
deleteOutboundMessagingcampaign(messagingCampaignId) {
|
|
734
|
+
deleteOutboundMessagingcampaign(messagingCampaignId, opts) {
|
|
735
|
+
opts = opts || {};
|
|
736
|
+
|
|
630
737
|
// verify the required parameter 'messagingCampaignId' is set
|
|
631
738
|
if (messagingCampaignId === undefined || messagingCampaignId === null || messagingCampaignId === '') {
|
|
632
739
|
throw 'Missing the required parameter "messagingCampaignId" when calling deleteOutboundMessagingcampaign';
|
|
@@ -642,7 +749,8 @@ class OutboundApi {
|
|
|
642
749
|
null,
|
|
643
750
|
['PureCloud OAuth'],
|
|
644
751
|
['application/json'],
|
|
645
|
-
['application/json']
|
|
752
|
+
['application/json'],
|
|
753
|
+
opts['customHeaders']
|
|
646
754
|
);
|
|
647
755
|
}
|
|
648
756
|
|
|
@@ -650,8 +758,12 @@ class OutboundApi {
|
|
|
650
758
|
* Reset messaging campaign progress and recycle the messaging campaign
|
|
651
759
|
* Documented permissions are applicable based on campaign type.
|
|
652
760
|
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
761
|
+
* @param {Object} opts Optional parameters
|
|
762
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
653
763
|
*/
|
|
654
|
-
deleteOutboundMessagingcampaignProgress(messagingCampaignId) {
|
|
764
|
+
deleteOutboundMessagingcampaignProgress(messagingCampaignId, opts) {
|
|
765
|
+
opts = opts || {};
|
|
766
|
+
|
|
655
767
|
// verify the required parameter 'messagingCampaignId' is set
|
|
656
768
|
if (messagingCampaignId === undefined || messagingCampaignId === null || messagingCampaignId === '') {
|
|
657
769
|
throw 'Missing the required parameter "messagingCampaignId" when calling deleteOutboundMessagingcampaignProgress';
|
|
@@ -667,7 +779,8 @@ class OutboundApi {
|
|
|
667
779
|
null,
|
|
668
780
|
['PureCloud OAuth'],
|
|
669
781
|
['application/json'],
|
|
670
|
-
['application/json']
|
|
782
|
+
['application/json'],
|
|
783
|
+
opts['customHeaders']
|
|
671
784
|
);
|
|
672
785
|
}
|
|
673
786
|
|
|
@@ -675,8 +788,12 @@ class OutboundApi {
|
|
|
675
788
|
* Delete a Rule Set.
|
|
676
789
|
*
|
|
677
790
|
* @param {String} ruleSetId Rule Set ID
|
|
791
|
+
* @param {Object} opts Optional parameters
|
|
792
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
678
793
|
*/
|
|
679
|
-
deleteOutboundRuleset(ruleSetId) {
|
|
794
|
+
deleteOutboundRuleset(ruleSetId, opts) {
|
|
795
|
+
opts = opts || {};
|
|
796
|
+
|
|
680
797
|
// verify the required parameter 'ruleSetId' is set
|
|
681
798
|
if (ruleSetId === undefined || ruleSetId === null || ruleSetId === '') {
|
|
682
799
|
throw 'Missing the required parameter "ruleSetId" when calling deleteOutboundRuleset';
|
|
@@ -692,7 +809,8 @@ class OutboundApi {
|
|
|
692
809
|
null,
|
|
693
810
|
['PureCloud OAuth'],
|
|
694
811
|
['application/json'],
|
|
695
|
-
['application/json']
|
|
812
|
+
['application/json'],
|
|
813
|
+
opts['customHeaders']
|
|
696
814
|
);
|
|
697
815
|
}
|
|
698
816
|
|
|
@@ -700,8 +818,12 @@ class OutboundApi {
|
|
|
700
818
|
* Delete a dialer campaign schedule.
|
|
701
819
|
*
|
|
702
820
|
* @param {String} campaignId Campaign ID
|
|
821
|
+
* @param {Object} opts Optional parameters
|
|
822
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
703
823
|
*/
|
|
704
|
-
deleteOutboundSchedulesCampaign(campaignId) {
|
|
824
|
+
deleteOutboundSchedulesCampaign(campaignId, opts) {
|
|
825
|
+
opts = opts || {};
|
|
826
|
+
|
|
705
827
|
// verify the required parameter 'campaignId' is set
|
|
706
828
|
if (campaignId === undefined || campaignId === null || campaignId === '') {
|
|
707
829
|
throw 'Missing the required parameter "campaignId" when calling deleteOutboundSchedulesCampaign';
|
|
@@ -717,7 +839,8 @@ class OutboundApi {
|
|
|
717
839
|
null,
|
|
718
840
|
['PureCloud OAuth'],
|
|
719
841
|
['application/json'],
|
|
720
|
-
['application/json']
|
|
842
|
+
['application/json'],
|
|
843
|
+
opts['customHeaders']
|
|
721
844
|
);
|
|
722
845
|
}
|
|
723
846
|
|
|
@@ -725,8 +848,12 @@ class OutboundApi {
|
|
|
725
848
|
* Delete an email campaign schedule.
|
|
726
849
|
*
|
|
727
850
|
* @param {String} emailCampaignId Email Campaign ID
|
|
851
|
+
* @param {Object} opts Optional parameters
|
|
852
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
728
853
|
*/
|
|
729
|
-
deleteOutboundSchedulesEmailcampaign(emailCampaignId) {
|
|
854
|
+
deleteOutboundSchedulesEmailcampaign(emailCampaignId, opts) {
|
|
855
|
+
opts = opts || {};
|
|
856
|
+
|
|
730
857
|
// verify the required parameter 'emailCampaignId' is set
|
|
731
858
|
if (emailCampaignId === undefined || emailCampaignId === null || emailCampaignId === '') {
|
|
732
859
|
throw 'Missing the required parameter "emailCampaignId" when calling deleteOutboundSchedulesEmailcampaign';
|
|
@@ -742,7 +869,8 @@ class OutboundApi {
|
|
|
742
869
|
null,
|
|
743
870
|
['PureCloud OAuth'],
|
|
744
871
|
['application/json'],
|
|
745
|
-
['application/json']
|
|
872
|
+
['application/json'],
|
|
873
|
+
opts['customHeaders']
|
|
746
874
|
);
|
|
747
875
|
}
|
|
748
876
|
|
|
@@ -750,8 +878,12 @@ class OutboundApi {
|
|
|
750
878
|
* Delete a messaging campaign schedule.
|
|
751
879
|
*
|
|
752
880
|
* @param {String} messagingCampaignId Messaging Campaign ID
|
|
881
|
+
* @param {Object} opts Optional parameters
|
|
882
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
753
883
|
*/
|
|
754
|
-
deleteOutboundSchedulesMessagingcampaign(messagingCampaignId) {
|
|
884
|
+
deleteOutboundSchedulesMessagingcampaign(messagingCampaignId, opts) {
|
|
885
|
+
opts = opts || {};
|
|
886
|
+
|
|
755
887
|
// verify the required parameter 'messagingCampaignId' is set
|
|
756
888
|
if (messagingCampaignId === undefined || messagingCampaignId === null || messagingCampaignId === '') {
|
|
757
889
|
throw 'Missing the required parameter "messagingCampaignId" when calling deleteOutboundSchedulesMessagingcampaign';
|
|
@@ -767,7 +899,8 @@ class OutboundApi {
|
|
|
767
899
|
null,
|
|
768
900
|
['PureCloud OAuth'],
|
|
769
901
|
['application/json'],
|
|
770
|
-
['application/json']
|
|
902
|
+
['application/json'],
|
|
903
|
+
opts['customHeaders']
|
|
771
904
|
);
|
|
772
905
|
}
|
|
773
906
|
|
|
@@ -775,8 +908,12 @@ class OutboundApi {
|
|
|
775
908
|
* Delete a dialer sequence schedule.
|
|
776
909
|
*
|
|
777
910
|
* @param {String} sequenceId Sequence ID
|
|
911
|
+
* @param {Object} opts Optional parameters
|
|
912
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
778
913
|
*/
|
|
779
|
-
deleteOutboundSchedulesSequence(sequenceId) {
|
|
914
|
+
deleteOutboundSchedulesSequence(sequenceId, opts) {
|
|
915
|
+
opts = opts || {};
|
|
916
|
+
|
|
780
917
|
// verify the required parameter 'sequenceId' is set
|
|
781
918
|
if (sequenceId === undefined || sequenceId === null || sequenceId === '') {
|
|
782
919
|
throw 'Missing the required parameter "sequenceId" when calling deleteOutboundSchedulesSequence';
|
|
@@ -792,7 +929,8 @@ class OutboundApi {
|
|
|
792
929
|
null,
|
|
793
930
|
['PureCloud OAuth'],
|
|
794
931
|
['application/json'],
|
|
795
|
-
['application/json']
|
|
932
|
+
['application/json'],
|
|
933
|
+
opts['customHeaders']
|
|
796
934
|
);
|
|
797
935
|
}
|
|
798
936
|
|
|
@@ -800,8 +938,12 @@ class OutboundApi {
|
|
|
800
938
|
* Delete a WhatsApp campaign schedule.
|
|
801
939
|
*
|
|
802
940
|
* @param {String} whatsAppCampaignId WhatsApp Campaign ID
|
|
941
|
+
* @param {Object} opts Optional parameters
|
|
942
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
803
943
|
*/
|
|
804
|
-
deleteOutboundSchedulesWhatsappcampaign(whatsAppCampaignId) {
|
|
944
|
+
deleteOutboundSchedulesWhatsappcampaign(whatsAppCampaignId, opts) {
|
|
945
|
+
opts = opts || {};
|
|
946
|
+
|
|
805
947
|
// verify the required parameter 'whatsAppCampaignId' is set
|
|
806
948
|
if (whatsAppCampaignId === undefined || whatsAppCampaignId === null || whatsAppCampaignId === '') {
|
|
807
949
|
throw 'Missing the required parameter "whatsAppCampaignId" when calling deleteOutboundSchedulesWhatsappcampaign';
|
|
@@ -817,7 +959,8 @@ class OutboundApi {
|
|
|
817
959
|
null,
|
|
818
960
|
['PureCloud OAuth'],
|
|
819
961
|
['application/json'],
|
|
820
|
-
['application/json']
|
|
962
|
+
['application/json'],
|
|
963
|
+
opts['customHeaders']
|
|
821
964
|
);
|
|
822
965
|
}
|
|
823
966
|
|
|
@@ -825,8 +968,12 @@ class OutboundApi {
|
|
|
825
968
|
* Delete a dialer campaign sequence.
|
|
826
969
|
*
|
|
827
970
|
* @param {String} sequenceId Campaign Sequence ID
|
|
971
|
+
* @param {Object} opts Optional parameters
|
|
972
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
828
973
|
*/
|
|
829
|
-
deleteOutboundSequence(sequenceId) {
|
|
974
|
+
deleteOutboundSequence(sequenceId, opts) {
|
|
975
|
+
opts = opts || {};
|
|
976
|
+
|
|
830
977
|
// verify the required parameter 'sequenceId' is set
|
|
831
978
|
if (sequenceId === undefined || sequenceId === null || sequenceId === '') {
|
|
832
979
|
throw 'Missing the required parameter "sequenceId" when calling deleteOutboundSequence';
|
|
@@ -842,7 +989,8 @@ class OutboundApi {
|
|
|
842
989
|
null,
|
|
843
990
|
['PureCloud OAuth'],
|
|
844
991
|
['application/json'],
|
|
845
|
-
['application/json']
|
|
992
|
+
['application/json'],
|
|
993
|
+
opts['customHeaders']
|
|
846
994
|
);
|
|
847
995
|
}
|
|
848
996
|
|
|
@@ -850,8 +998,12 @@ class OutboundApi {
|
|
|
850
998
|
* Get attempt limits
|
|
851
999
|
*
|
|
852
1000
|
* @param {String} attemptLimitsId Attempt limits ID
|
|
1001
|
+
* @param {Object} opts Optional parameters
|
|
1002
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
853
1003
|
*/
|
|
854
|
-
getOutboundAttemptlimit(attemptLimitsId) {
|
|
1004
|
+
getOutboundAttemptlimit(attemptLimitsId, opts) {
|
|
1005
|
+
opts = opts || {};
|
|
1006
|
+
|
|
855
1007
|
// verify the required parameter 'attemptLimitsId' is set
|
|
856
1008
|
if (attemptLimitsId === undefined || attemptLimitsId === null || attemptLimitsId === '') {
|
|
857
1009
|
throw 'Missing the required parameter "attemptLimitsId" when calling getOutboundAttemptlimit';
|
|
@@ -867,7 +1019,8 @@ class OutboundApi {
|
|
|
867
1019
|
null,
|
|
868
1020
|
['PureCloud OAuth'],
|
|
869
1021
|
['application/json'],
|
|
870
|
-
['application/json']
|
|
1022
|
+
['application/json'],
|
|
1023
|
+
opts['customHeaders']
|
|
871
1024
|
);
|
|
872
1025
|
}
|
|
873
1026
|
|
|
@@ -882,6 +1035,7 @@ class OutboundApi {
|
|
|
882
1035
|
* @param {String} opts.name Name
|
|
883
1036
|
* @param {String} opts.sortBy Sort by
|
|
884
1037
|
* @param {Object} opts.sortOrder Sort order (default to a)
|
|
1038
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
885
1039
|
*/
|
|
886
1040
|
getOutboundAttemptlimits(opts) {
|
|
887
1041
|
opts = opts || {};
|
|
@@ -897,7 +1051,8 @@ class OutboundApi {
|
|
|
897
1051
|
null,
|
|
898
1052
|
['PureCloud OAuth'],
|
|
899
1053
|
['application/json'],
|
|
900
|
-
['application/json']
|
|
1054
|
+
['application/json'],
|
|
1055
|
+
opts['customHeaders']
|
|
901
1056
|
);
|
|
902
1057
|
}
|
|
903
1058
|
|
|
@@ -905,8 +1060,12 @@ class OutboundApi {
|
|
|
905
1060
|
* Get callable time set
|
|
906
1061
|
*
|
|
907
1062
|
* @param {String} callableTimeSetId Callable Time Set ID
|
|
1063
|
+
* @param {Object} opts Optional parameters
|
|
1064
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
908
1065
|
*/
|
|
909
|
-
getOutboundCallabletimeset(callableTimeSetId) {
|
|
1066
|
+
getOutboundCallabletimeset(callableTimeSetId, opts) {
|
|
1067
|
+
opts = opts || {};
|
|
1068
|
+
|
|
910
1069
|
// verify the required parameter 'callableTimeSetId' is set
|
|
911
1070
|
if (callableTimeSetId === undefined || callableTimeSetId === null || callableTimeSetId === '') {
|
|
912
1071
|
throw 'Missing the required parameter "callableTimeSetId" when calling getOutboundCallabletimeset';
|
|
@@ -922,7 +1081,8 @@ class OutboundApi {
|
|
|
922
1081
|
null,
|
|
923
1082
|
['PureCloud OAuth'],
|
|
924
1083
|
['application/json'],
|
|
925
|
-
['application/json']
|
|
1084
|
+
['application/json'],
|
|
1085
|
+
opts['customHeaders']
|
|
926
1086
|
);
|
|
927
1087
|
}
|
|
928
1088
|
|
|
@@ -937,6 +1097,7 @@ class OutboundApi {
|
|
|
937
1097
|
* @param {String} opts.name Name
|
|
938
1098
|
* @param {String} opts.sortBy Sort by
|
|
939
1099
|
* @param {Object} opts.sortOrder Sort order (default to a)
|
|
1100
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
940
1101
|
*/
|
|
941
1102
|
getOutboundCallabletimesets(opts) {
|
|
942
1103
|
opts = opts || {};
|
|
@@ -952,7 +1113,8 @@ class OutboundApi {
|
|
|
952
1113
|
null,
|
|
953
1114
|
['PureCloud OAuth'],
|
|
954
1115
|
['application/json'],
|
|
955
|
-
['application/json']
|
|
1116
|
+
['application/json'],
|
|
1117
|
+
opts['customHeaders']
|
|
956
1118
|
);
|
|
957
1119
|
}
|
|
958
1120
|
|
|
@@ -960,8 +1122,12 @@ class OutboundApi {
|
|
|
960
1122
|
* Get a dialer call analysis response set.
|
|
961
1123
|
*
|
|
962
1124
|
* @param {String} callAnalysisSetId Call Analysis Response Set ID
|
|
1125
|
+
* @param {Object} opts Optional parameters
|
|
1126
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
963
1127
|
*/
|
|
964
|
-
getOutboundCallanalysisresponseset(callAnalysisSetId) {
|
|
1128
|
+
getOutboundCallanalysisresponseset(callAnalysisSetId, opts) {
|
|
1129
|
+
opts = opts || {};
|
|
1130
|
+
|
|
965
1131
|
// verify the required parameter 'callAnalysisSetId' is set
|
|
966
1132
|
if (callAnalysisSetId === undefined || callAnalysisSetId === null || callAnalysisSetId === '') {
|
|
967
1133
|
throw 'Missing the required parameter "callAnalysisSetId" when calling getOutboundCallanalysisresponseset';
|
|
@@ -977,7 +1143,8 @@ class OutboundApi {
|
|
|
977
1143
|
null,
|
|
978
1144
|
['PureCloud OAuth'],
|
|
979
1145
|
['application/json'],
|
|
980
|
-
['application/json']
|
|
1146
|
+
['application/json'],
|
|
1147
|
+
opts['customHeaders']
|
|
981
1148
|
);
|
|
982
1149
|
}
|
|
983
1150
|
|
|
@@ -992,6 +1159,7 @@ class OutboundApi {
|
|
|
992
1159
|
* @param {String} opts.name Name
|
|
993
1160
|
* @param {String} opts.sortBy Sort by
|
|
994
1161
|
* @param {Object} opts.sortOrder Sort order (default to a)
|
|
1162
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
995
1163
|
*/
|
|
996
1164
|
getOutboundCallanalysisresponsesets(opts) {
|
|
997
1165
|
opts = opts || {};
|
|
@@ -1007,7 +1175,8 @@ class OutboundApi {
|
|
|
1007
1175
|
null,
|
|
1008
1176
|
['PureCloud OAuth'],
|
|
1009
1177
|
['application/json'],
|
|
1010
|
-
['application/json']
|
|
1178
|
+
['application/json'],
|
|
1179
|
+
opts['customHeaders']
|
|
1011
1180
|
);
|
|
1012
1181
|
}
|
|
1013
1182
|
|
|
@@ -1015,8 +1184,12 @@ class OutboundApi {
|
|
|
1015
1184
|
* Get dialer campaign.
|
|
1016
1185
|
*
|
|
1017
1186
|
* @param {String} campaignId Campaign ID
|
|
1187
|
+
* @param {Object} opts Optional parameters
|
|
1188
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1018
1189
|
*/
|
|
1019
|
-
getOutboundCampaign(campaignId) {
|
|
1190
|
+
getOutboundCampaign(campaignId, opts) {
|
|
1191
|
+
opts = opts || {};
|
|
1192
|
+
|
|
1020
1193
|
// verify the required parameter 'campaignId' is set
|
|
1021
1194
|
if (campaignId === undefined || campaignId === null || campaignId === '') {
|
|
1022
1195
|
throw 'Missing the required parameter "campaignId" when calling getOutboundCampaign';
|
|
@@ -1032,7 +1205,8 @@ class OutboundApi {
|
|
|
1032
1205
|
null,
|
|
1033
1206
|
['PureCloud OAuth'],
|
|
1034
1207
|
['application/json'],
|
|
1035
|
-
['application/json']
|
|
1208
|
+
['application/json'],
|
|
1209
|
+
opts['customHeaders']
|
|
1036
1210
|
);
|
|
1037
1211
|
}
|
|
1038
1212
|
|
|
@@ -1040,8 +1214,12 @@ class OutboundApi {
|
|
|
1040
1214
|
* Get a preview of how agents will be mapped to this campaign's contact list.
|
|
1041
1215
|
*
|
|
1042
1216
|
* @param {String} campaignId Campaign ID
|
|
1217
|
+
* @param {Object} opts Optional parameters
|
|
1218
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1043
1219
|
*/
|
|
1044
|
-
getOutboundCampaignAgentownedmappingpreviewResults(campaignId) {
|
|
1220
|
+
getOutboundCampaignAgentownedmappingpreviewResults(campaignId, opts) {
|
|
1221
|
+
opts = opts || {};
|
|
1222
|
+
|
|
1045
1223
|
// verify the required parameter 'campaignId' is set
|
|
1046
1224
|
if (campaignId === undefined || campaignId === null || campaignId === '') {
|
|
1047
1225
|
throw 'Missing the required parameter "campaignId" when calling getOutboundCampaignAgentownedmappingpreviewResults';
|
|
@@ -1057,7 +1235,8 @@ class OutboundApi {
|
|
|
1057
1235
|
null,
|
|
1058
1236
|
['PureCloud OAuth'],
|
|
1059
1237
|
['application/json'],
|
|
1060
|
-
['application/json']
|
|
1238
|
+
['application/json'],
|
|
1239
|
+
opts['customHeaders']
|
|
1061
1240
|
);
|
|
1062
1241
|
}
|
|
1063
1242
|
|
|
@@ -1065,8 +1244,12 @@ class OutboundApi {
|
|
|
1065
1244
|
* Get campaign diagnostics
|
|
1066
1245
|
*
|
|
1067
1246
|
* @param {String} campaignId Campaign ID
|
|
1247
|
+
* @param {Object} opts Optional parameters
|
|
1248
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1068
1249
|
*/
|
|
1069
|
-
getOutboundCampaignDiagnostics(campaignId) {
|
|
1250
|
+
getOutboundCampaignDiagnostics(campaignId, opts) {
|
|
1251
|
+
opts = opts || {};
|
|
1252
|
+
|
|
1070
1253
|
// verify the required parameter 'campaignId' is set
|
|
1071
1254
|
if (campaignId === undefined || campaignId === null || campaignId === '') {
|
|
1072
1255
|
throw 'Missing the required parameter "campaignId" when calling getOutboundCampaignDiagnostics';
|
|
@@ -1082,7 +1265,8 @@ class OutboundApi {
|
|
|
1082
1265
|
null,
|
|
1083
1266
|
['PureCloud OAuth'],
|
|
1084
1267
|
['application/json'],
|
|
1085
|
-
['application/json']
|
|
1268
|
+
['application/json'],
|
|
1269
|
+
opts['customHeaders']
|
|
1086
1270
|
);
|
|
1087
1271
|
}
|
|
1088
1272
|
|
|
@@ -1090,8 +1274,12 @@ class OutboundApi {
|
|
|
1090
1274
|
* Get dialer campaign interactions.
|
|
1091
1275
|
*
|
|
1092
1276
|
* @param {String} campaignId Campaign ID
|
|
1277
|
+
* @param {Object} opts Optional parameters
|
|
1278
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1093
1279
|
*/
|
|
1094
|
-
getOutboundCampaignInteractions(campaignId) {
|
|
1280
|
+
getOutboundCampaignInteractions(campaignId, opts) {
|
|
1281
|
+
opts = opts || {};
|
|
1282
|
+
|
|
1095
1283
|
// verify the required parameter 'campaignId' is set
|
|
1096
1284
|
if (campaignId === undefined || campaignId === null || campaignId === '') {
|
|
1097
1285
|
throw 'Missing the required parameter "campaignId" when calling getOutboundCampaignInteractions';
|
|
@@ -1107,7 +1295,8 @@ class OutboundApi {
|
|
|
1107
1295
|
null,
|
|
1108
1296
|
['PureCloud OAuth'],
|
|
1109
1297
|
['application/json'],
|
|
1110
|
-
['application/json']
|
|
1298
|
+
['application/json'],
|
|
1299
|
+
opts['customHeaders']
|
|
1111
1300
|
);
|
|
1112
1301
|
}
|
|
1113
1302
|
|
|
@@ -1122,6 +1311,7 @@ class OutboundApi {
|
|
|
1122
1311
|
* @param {Boolean} opts.useWeight Enable usage of weight, this value overrides current Campaign's setting in line distribution calculations
|
|
1123
1312
|
* @param {Number} opts.relativeWeight Relative weight to be used in line distribution calculations instead of current Campaign's relative weight
|
|
1124
1313
|
* @param {Number} opts.outboundLineCount The number of outbound lines to be used in line distribution calculations, instead of current Campaign's Outbound Lines Count
|
|
1314
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1125
1315
|
*/
|
|
1126
1316
|
getOutboundCampaignLinedistribution(campaignId, opts) {
|
|
1127
1317
|
opts = opts || {};
|
|
@@ -1141,7 +1331,8 @@ class OutboundApi {
|
|
|
1141
1331
|
null,
|
|
1142
1332
|
['PureCloud OAuth'],
|
|
1143
1333
|
['application/json'],
|
|
1144
|
-
['application/json']
|
|
1334
|
+
['application/json'],
|
|
1335
|
+
opts['customHeaders']
|
|
1145
1336
|
);
|
|
1146
1337
|
}
|
|
1147
1338
|
|
|
@@ -1149,8 +1340,12 @@ class OutboundApi {
|
|
|
1149
1340
|
* Get campaign progress
|
|
1150
1341
|
*
|
|
1151
1342
|
* @param {String} campaignId Campaign ID
|
|
1343
|
+
* @param {Object} opts Optional parameters
|
|
1344
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1152
1345
|
*/
|
|
1153
|
-
getOutboundCampaignProgress(campaignId) {
|
|
1346
|
+
getOutboundCampaignProgress(campaignId, opts) {
|
|
1347
|
+
opts = opts || {};
|
|
1348
|
+
|
|
1154
1349
|
// verify the required parameter 'campaignId' is set
|
|
1155
1350
|
if (campaignId === undefined || campaignId === null || campaignId === '') {
|
|
1156
1351
|
throw 'Missing the required parameter "campaignId" when calling getOutboundCampaignProgress';
|
|
@@ -1166,7 +1361,8 @@ class OutboundApi {
|
|
|
1166
1361
|
null,
|
|
1167
1362
|
['PureCloud OAuth'],
|
|
1168
1363
|
['application/json'],
|
|
1169
|
-
['application/json']
|
|
1364
|
+
['application/json'],
|
|
1365
|
+
opts['customHeaders']
|
|
1170
1366
|
);
|
|
1171
1367
|
}
|
|
1172
1368
|
|
|
@@ -1177,6 +1373,7 @@ class OutboundApi {
|
|
|
1177
1373
|
* @param {Object} opts Optional parameters
|
|
1178
1374
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
1179
1375
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
1376
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1180
1377
|
*/
|
|
1181
1378
|
getOutboundCampaignSkillcombinations(campaignId, opts) {
|
|
1182
1379
|
opts = opts || {};
|
|
@@ -1196,7 +1393,8 @@ class OutboundApi {
|
|
|
1196
1393
|
null,
|
|
1197
1394
|
['PureCloud OAuth'],
|
|
1198
1395
|
['application/json'],
|
|
1199
|
-
['application/json']
|
|
1396
|
+
['application/json'],
|
|
1397
|
+
opts['customHeaders']
|
|
1200
1398
|
);
|
|
1201
1399
|
}
|
|
1202
1400
|
|
|
@@ -1204,8 +1402,12 @@ class OutboundApi {
|
|
|
1204
1402
|
* Get statistics about a Dialer Campaign
|
|
1205
1403
|
*
|
|
1206
1404
|
* @param {String} campaignId Campaign ID
|
|
1405
|
+
* @param {Object} opts Optional parameters
|
|
1406
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1207
1407
|
*/
|
|
1208
|
-
getOutboundCampaignStats(campaignId) {
|
|
1408
|
+
getOutboundCampaignStats(campaignId, opts) {
|
|
1409
|
+
opts = opts || {};
|
|
1410
|
+
|
|
1209
1411
|
// verify the required parameter 'campaignId' is set
|
|
1210
1412
|
if (campaignId === undefined || campaignId === null || campaignId === '') {
|
|
1211
1413
|
throw 'Missing the required parameter "campaignId" when calling getOutboundCampaignStats';
|
|
@@ -1221,7 +1423,8 @@ class OutboundApi {
|
|
|
1221
1423
|
null,
|
|
1222
1424
|
['PureCloud OAuth'],
|
|
1223
1425
|
['application/json'],
|
|
1224
|
-
['application/json']
|
|
1426
|
+
['application/json'],
|
|
1427
|
+
opts['customHeaders']
|
|
1225
1428
|
);
|
|
1226
1429
|
}
|
|
1227
1430
|
|
|
@@ -1229,8 +1432,12 @@ class OutboundApi {
|
|
|
1229
1432
|
* Get Campaign Rule
|
|
1230
1433
|
*
|
|
1231
1434
|
* @param {String} campaignRuleId Campaign Rule ID
|
|
1435
|
+
* @param {Object} opts Optional parameters
|
|
1436
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1232
1437
|
*/
|
|
1233
|
-
getOutboundCampaignrule(campaignRuleId) {
|
|
1438
|
+
getOutboundCampaignrule(campaignRuleId, opts) {
|
|
1439
|
+
opts = opts || {};
|
|
1440
|
+
|
|
1234
1441
|
// verify the required parameter 'campaignRuleId' is set
|
|
1235
1442
|
if (campaignRuleId === undefined || campaignRuleId === null || campaignRuleId === '') {
|
|
1236
1443
|
throw 'Missing the required parameter "campaignRuleId" when calling getOutboundCampaignrule';
|
|
@@ -1246,7 +1453,8 @@ class OutboundApi {
|
|
|
1246
1453
|
null,
|
|
1247
1454
|
['PureCloud OAuth'],
|
|
1248
1455
|
['application/json'],
|
|
1249
|
-
['application/json']
|
|
1456
|
+
['application/json'],
|
|
1457
|
+
opts['customHeaders']
|
|
1250
1458
|
);
|
|
1251
1459
|
}
|
|
1252
1460
|
|
|
@@ -1261,6 +1469,7 @@ class OutboundApi {
|
|
|
1261
1469
|
* @param {String} opts.name Name
|
|
1262
1470
|
* @param {String} opts.sortBy Sort by
|
|
1263
1471
|
* @param {Object} opts.sortOrder Sort order (default to a)
|
|
1472
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1264
1473
|
*/
|
|
1265
1474
|
getOutboundCampaignrules(opts) {
|
|
1266
1475
|
opts = opts || {};
|
|
@@ -1276,7 +1485,8 @@ class OutboundApi {
|
|
|
1276
1485
|
null,
|
|
1277
1486
|
['PureCloud OAuth'],
|
|
1278
1487
|
['application/json'],
|
|
1279
|
-
['application/json']
|
|
1488
|
+
['application/json'],
|
|
1489
|
+
opts['customHeaders']
|
|
1280
1490
|
);
|
|
1281
1491
|
}
|
|
1282
1492
|
|
|
@@ -1297,6 +1507,7 @@ class OutboundApi {
|
|
|
1297
1507
|
* @param {Array.<String>} opts.divisionId Division ID(s)
|
|
1298
1508
|
* @param {String} opts.sortBy Sort by
|
|
1299
1509
|
* @param {Object} opts.sortOrder Sort order (default to a)
|
|
1510
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1300
1511
|
*/
|
|
1301
1512
|
getOutboundCampaigns(opts) {
|
|
1302
1513
|
opts = opts || {};
|
|
@@ -1312,7 +1523,8 @@ class OutboundApi {
|
|
|
1312
1523
|
null,
|
|
1313
1524
|
['PureCloud OAuth'],
|
|
1314
1525
|
['application/json'],
|
|
1315
|
-
['application/json']
|
|
1526
|
+
['application/json'],
|
|
1527
|
+
opts['customHeaders']
|
|
1316
1528
|
);
|
|
1317
1529
|
}
|
|
1318
1530
|
|
|
@@ -1327,6 +1539,7 @@ class OutboundApi {
|
|
|
1327
1539
|
* @param {Array.<String>} opts.divisionId Division ID(s)
|
|
1328
1540
|
* @param {Array.<String>} opts.mediaType Media type(s)
|
|
1329
1541
|
* @param {Object} opts.sortOrder Sort order (default to a)
|
|
1542
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1330
1543
|
*/
|
|
1331
1544
|
getOutboundCampaignsAll(opts) {
|
|
1332
1545
|
opts = opts || {};
|
|
@@ -1342,7 +1555,8 @@ class OutboundApi {
|
|
|
1342
1555
|
null,
|
|
1343
1556
|
['PureCloud OAuth'],
|
|
1344
1557
|
['application/json'],
|
|
1345
|
-
['application/json']
|
|
1558
|
+
['application/json'],
|
|
1559
|
+
opts['customHeaders']
|
|
1346
1560
|
);
|
|
1347
1561
|
}
|
|
1348
1562
|
|
|
@@ -1357,6 +1571,7 @@ class OutboundApi {
|
|
|
1357
1571
|
* @param {Array.<String>} opts.divisionId Division ID(s)
|
|
1358
1572
|
* @param {Array.<String>} opts.mediaType Media type(s)
|
|
1359
1573
|
* @param {Object} opts.sortOrder Sort order (default to a)
|
|
1574
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1360
1575
|
*/
|
|
1361
1576
|
getOutboundCampaignsAllDivisionviews(opts) {
|
|
1362
1577
|
opts = opts || {};
|
|
@@ -1372,7 +1587,8 @@ class OutboundApi {
|
|
|
1372
1587
|
null,
|
|
1373
1588
|
['PureCloud OAuth'],
|
|
1374
1589
|
['application/json'],
|
|
1375
|
-
['application/json']
|
|
1590
|
+
['application/json'],
|
|
1591
|
+
opts['customHeaders']
|
|
1376
1592
|
);
|
|
1377
1593
|
}
|
|
1378
1594
|
|
|
@@ -1380,8 +1596,12 @@ class OutboundApi {
|
|
|
1380
1596
|
* Get a basic Campaign information object
|
|
1381
1597
|
* This returns a simplified version of a Campaign, consisting of name and division.
|
|
1382
1598
|
* @param {String} campaignId Campaign ID
|
|
1599
|
+
* @param {Object} opts Optional parameters
|
|
1600
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1383
1601
|
*/
|
|
1384
|
-
getOutboundCampaignsDivisionview(campaignId) {
|
|
1602
|
+
getOutboundCampaignsDivisionview(campaignId, opts) {
|
|
1603
|
+
opts = opts || {};
|
|
1604
|
+
|
|
1385
1605
|
// verify the required parameter 'campaignId' is set
|
|
1386
1606
|
if (campaignId === undefined || campaignId === null || campaignId === '') {
|
|
1387
1607
|
throw 'Missing the required parameter "campaignId" when calling getOutboundCampaignsDivisionview';
|
|
@@ -1397,7 +1617,8 @@ class OutboundApi {
|
|
|
1397
1617
|
null,
|
|
1398
1618
|
['PureCloud OAuth'],
|
|
1399
1619
|
['application/json'],
|
|
1400
|
-
['application/json']
|
|
1620
|
+
['application/json'],
|
|
1621
|
+
opts['customHeaders']
|
|
1401
1622
|
);
|
|
1402
1623
|
}
|
|
1403
1624
|
|
|
@@ -1412,6 +1633,7 @@ class OutboundApi {
|
|
|
1412
1633
|
* @param {Array.<String>} opts.id id
|
|
1413
1634
|
* @param {String} opts.sortBy Sort by
|
|
1414
1635
|
* @param {Object} opts.sortOrder Sort order (default to a)
|
|
1636
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1415
1637
|
*/
|
|
1416
1638
|
getOutboundCampaignsDivisionviews(opts) {
|
|
1417
1639
|
opts = opts || {};
|
|
@@ -1427,7 +1649,8 @@ class OutboundApi {
|
|
|
1427
1649
|
null,
|
|
1428
1650
|
['PureCloud OAuth'],
|
|
1429
1651
|
['application/json'],
|
|
1430
|
-
['application/json']
|
|
1652
|
+
['application/json'],
|
|
1653
|
+
opts['customHeaders']
|
|
1431
1654
|
);
|
|
1432
1655
|
}
|
|
1433
1656
|
|
|
@@ -1438,6 +1661,7 @@ class OutboundApi {
|
|
|
1438
1661
|
* @param {Object} opts Optional parameters
|
|
1439
1662
|
* @param {Boolean} opts.includeImportStatus Import status (default to false)
|
|
1440
1663
|
* @param {Boolean} opts.includeSize Include size (default to false)
|
|
1664
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1441
1665
|
*/
|
|
1442
1666
|
getOutboundContactlist(contactListId, opts) {
|
|
1443
1667
|
opts = opts || {};
|
|
@@ -1457,7 +1681,8 @@ class OutboundApi {
|
|
|
1457
1681
|
null,
|
|
1458
1682
|
['PureCloud OAuth'],
|
|
1459
1683
|
['application/json'],
|
|
1460
|
-
['application/json']
|
|
1684
|
+
['application/json'],
|
|
1685
|
+
opts['customHeaders']
|
|
1461
1686
|
);
|
|
1462
1687
|
}
|
|
1463
1688
|
|
|
@@ -1466,8 +1691,12 @@ class OutboundApi {
|
|
|
1466
1691
|
*
|
|
1467
1692
|
* @param {String} contactListId Contact List ID
|
|
1468
1693
|
* @param {String} contactId Contact ID
|
|
1694
|
+
* @param {Object} opts Optional parameters
|
|
1695
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1469
1696
|
*/
|
|
1470
|
-
getOutboundContactlistContact(contactListId, contactId) {
|
|
1697
|
+
getOutboundContactlistContact(contactListId, contactId, opts) {
|
|
1698
|
+
opts = opts || {};
|
|
1699
|
+
|
|
1471
1700
|
// verify the required parameter 'contactListId' is set
|
|
1472
1701
|
if (contactListId === undefined || contactListId === null || contactListId === '') {
|
|
1473
1702
|
throw 'Missing the required parameter "contactListId" when calling getOutboundContactlistContact';
|
|
@@ -1487,7 +1716,8 @@ class OutboundApi {
|
|
|
1487
1716
|
null,
|
|
1488
1717
|
['PureCloud OAuth'],
|
|
1489
1718
|
['application/json'],
|
|
1490
|
-
['application/json']
|
|
1719
|
+
['application/json'],
|
|
1720
|
+
opts['customHeaders']
|
|
1491
1721
|
);
|
|
1492
1722
|
}
|
|
1493
1723
|
|
|
@@ -1496,8 +1726,12 @@ class OutboundApi {
|
|
|
1496
1726
|
*
|
|
1497
1727
|
* @param {String} contactListId Contact List ID
|
|
1498
1728
|
* @param {String} jobId Job ID
|
|
1729
|
+
* @param {Object} opts Optional parameters
|
|
1730
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1499
1731
|
*/
|
|
1500
|
-
getOutboundContactlistContactsBulkJob(contactListId, jobId) {
|
|
1732
|
+
getOutboundContactlistContactsBulkJob(contactListId, jobId, opts) {
|
|
1733
|
+
opts = opts || {};
|
|
1734
|
+
|
|
1501
1735
|
// verify the required parameter 'contactListId' is set
|
|
1502
1736
|
if (contactListId === undefined || contactListId === null || contactListId === '') {
|
|
1503
1737
|
throw 'Missing the required parameter "contactListId" when calling getOutboundContactlistContactsBulkJob';
|
|
@@ -1517,7 +1751,8 @@ class OutboundApi {
|
|
|
1517
1751
|
null,
|
|
1518
1752
|
['PureCloud OAuth'],
|
|
1519
1753
|
['application/json'],
|
|
1520
|
-
['application/json']
|
|
1754
|
+
['application/json'],
|
|
1755
|
+
opts['customHeaders']
|
|
1521
1756
|
);
|
|
1522
1757
|
}
|
|
1523
1758
|
|
|
@@ -1525,8 +1760,12 @@ class OutboundApi {
|
|
|
1525
1760
|
* Get 10 most recent bulk operation jobs associated with contact list.
|
|
1526
1761
|
*
|
|
1527
1762
|
* @param {String} contactListId Contact List ID
|
|
1763
|
+
* @param {Object} opts Optional parameters
|
|
1764
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1528
1765
|
*/
|
|
1529
|
-
getOutboundContactlistContactsBulkJobs(contactListId) {
|
|
1766
|
+
getOutboundContactlistContactsBulkJobs(contactListId, opts) {
|
|
1767
|
+
opts = opts || {};
|
|
1768
|
+
|
|
1530
1769
|
// verify the required parameter 'contactListId' is set
|
|
1531
1770
|
if (contactListId === undefined || contactListId === null || contactListId === '') {
|
|
1532
1771
|
throw 'Missing the required parameter "contactListId" when calling getOutboundContactlistContactsBulkJobs';
|
|
@@ -1542,7 +1781,8 @@ class OutboundApi {
|
|
|
1542
1781
|
null,
|
|
1543
1782
|
['PureCloud OAuth'],
|
|
1544
1783
|
['application/json'],
|
|
1545
|
-
['application/json']
|
|
1784
|
+
['application/json'],
|
|
1785
|
+
opts['customHeaders']
|
|
1546
1786
|
);
|
|
1547
1787
|
}
|
|
1548
1788
|
|
|
@@ -1552,6 +1792,7 @@ class OutboundApi {
|
|
|
1552
1792
|
* @param {String} contactListId ContactList ID
|
|
1553
1793
|
* @param {Object} opts Optional parameters
|
|
1554
1794
|
* @param {String} opts.download Redirect to download uri (default to false)
|
|
1795
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1555
1796
|
*/
|
|
1556
1797
|
getOutboundContactlistExport(contactListId, opts) {
|
|
1557
1798
|
opts = opts || {};
|
|
@@ -1571,7 +1812,8 @@ class OutboundApi {
|
|
|
1571
1812
|
null,
|
|
1572
1813
|
['PureCloud OAuth'],
|
|
1573
1814
|
['application/json'],
|
|
1574
|
-
['application/json']
|
|
1815
|
+
['application/json'],
|
|
1816
|
+
opts['customHeaders']
|
|
1575
1817
|
);
|
|
1576
1818
|
}
|
|
1577
1819
|
|
|
@@ -1579,8 +1821,12 @@ class OutboundApi {
|
|
|
1579
1821
|
* Get dialer contactList import status.
|
|
1580
1822
|
*
|
|
1581
1823
|
* @param {String} contactListId ContactList ID
|
|
1824
|
+
* @param {Object} opts Optional parameters
|
|
1825
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1582
1826
|
*/
|
|
1583
|
-
getOutboundContactlistImportstatus(contactListId) {
|
|
1827
|
+
getOutboundContactlistImportstatus(contactListId, opts) {
|
|
1828
|
+
opts = opts || {};
|
|
1829
|
+
|
|
1584
1830
|
// verify the required parameter 'contactListId' is set
|
|
1585
1831
|
if (contactListId === undefined || contactListId === null || contactListId === '') {
|
|
1586
1832
|
throw 'Missing the required parameter "contactListId" when calling getOutboundContactlistImportstatus';
|
|
@@ -1596,7 +1842,8 @@ class OutboundApi {
|
|
|
1596
1842
|
null,
|
|
1597
1843
|
['PureCloud OAuth'],
|
|
1598
1844
|
['application/json'],
|
|
1599
|
-
['application/json']
|
|
1845
|
+
['application/json'],
|
|
1846
|
+
opts['customHeaders']
|
|
1600
1847
|
);
|
|
1601
1848
|
}
|
|
1602
1849
|
|
|
@@ -1604,8 +1851,12 @@ class OutboundApi {
|
|
|
1604
1851
|
* Preview the result of applying Automatic Time Zone Mapping to a contact list
|
|
1605
1852
|
*
|
|
1606
1853
|
* @param {String} contactListId ContactList ID
|
|
1854
|
+
* @param {Object} opts Optional parameters
|
|
1855
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1607
1856
|
*/
|
|
1608
|
-
getOutboundContactlistTimezonemappingpreview(contactListId) {
|
|
1857
|
+
getOutboundContactlistTimezonemappingpreview(contactListId, opts) {
|
|
1858
|
+
opts = opts || {};
|
|
1859
|
+
|
|
1609
1860
|
// verify the required parameter 'contactListId' is set
|
|
1610
1861
|
if (contactListId === undefined || contactListId === null || contactListId === '') {
|
|
1611
1862
|
throw 'Missing the required parameter "contactListId" when calling getOutboundContactlistTimezonemappingpreview';
|
|
@@ -1621,7 +1872,8 @@ class OutboundApi {
|
|
|
1621
1872
|
null,
|
|
1622
1873
|
['PureCloud OAuth'],
|
|
1623
1874
|
['application/json'],
|
|
1624
|
-
['application/json']
|
|
1875
|
+
['application/json'],
|
|
1876
|
+
opts['customHeaders']
|
|
1625
1877
|
);
|
|
1626
1878
|
}
|
|
1627
1879
|
|
|
@@ -1629,8 +1881,12 @@ class OutboundApi {
|
|
|
1629
1881
|
* Get Contact list filter
|
|
1630
1882
|
*
|
|
1631
1883
|
* @param {String} contactListFilterId Contact List Filter ID
|
|
1884
|
+
* @param {Object} opts Optional parameters
|
|
1885
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1632
1886
|
*/
|
|
1633
|
-
getOutboundContactlistfilter(contactListFilterId) {
|
|
1887
|
+
getOutboundContactlistfilter(contactListFilterId, opts) {
|
|
1888
|
+
opts = opts || {};
|
|
1889
|
+
|
|
1634
1890
|
// verify the required parameter 'contactListFilterId' is set
|
|
1635
1891
|
if (contactListFilterId === undefined || contactListFilterId === null || contactListFilterId === '') {
|
|
1636
1892
|
throw 'Missing the required parameter "contactListFilterId" when calling getOutboundContactlistfilter';
|
|
@@ -1646,7 +1902,8 @@ class OutboundApi {
|
|
|
1646
1902
|
null,
|
|
1647
1903
|
['PureCloud OAuth'],
|
|
1648
1904
|
['application/json'],
|
|
1649
|
-
['application/json']
|
|
1905
|
+
['application/json'],
|
|
1906
|
+
opts['customHeaders']
|
|
1650
1907
|
);
|
|
1651
1908
|
}
|
|
1652
1909
|
|
|
@@ -1662,6 +1919,7 @@ class OutboundApi {
|
|
|
1662
1919
|
* @param {String} opts.sortBy Sort by
|
|
1663
1920
|
* @param {Object} opts.sortOrder Sort order (default to a)
|
|
1664
1921
|
* @param {String} opts.contactListId Contact List ID
|
|
1922
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1665
1923
|
*/
|
|
1666
1924
|
getOutboundContactlistfilters(opts) {
|
|
1667
1925
|
opts = opts || {};
|
|
@@ -1677,7 +1935,8 @@ class OutboundApi {
|
|
|
1677
1935
|
null,
|
|
1678
1936
|
['PureCloud OAuth'],
|
|
1679
1937
|
['application/json'],
|
|
1680
|
-
['application/json']
|
|
1938
|
+
['application/json'],
|
|
1939
|
+
opts['customHeaders']
|
|
1681
1940
|
);
|
|
1682
1941
|
}
|
|
1683
1942
|
|
|
@@ -1696,6 +1955,7 @@ class OutboundApi {
|
|
|
1696
1955
|
* @param {Array.<String>} opts.divisionId Division ID(s)
|
|
1697
1956
|
* @param {String} opts.sortBy Sort by
|
|
1698
1957
|
* @param {Object} opts.sortOrder Sort order (default to a)
|
|
1958
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1699
1959
|
*/
|
|
1700
1960
|
getOutboundContactlists(opts) {
|
|
1701
1961
|
opts = opts || {};
|
|
@@ -1711,7 +1971,8 @@ class OutboundApi {
|
|
|
1711
1971
|
null,
|
|
1712
1972
|
['PureCloud OAuth'],
|
|
1713
1973
|
['application/json'],
|
|
1714
|
-
['application/json']
|
|
1974
|
+
['application/json'],
|
|
1975
|
+
opts['customHeaders']
|
|
1715
1976
|
);
|
|
1716
1977
|
}
|
|
1717
1978
|
|
|
@@ -1722,6 +1983,7 @@ class OutboundApi {
|
|
|
1722
1983
|
* @param {Object} opts Optional parameters
|
|
1723
1984
|
* @param {Boolean} opts.includeImportStatus Include import status (default to false)
|
|
1724
1985
|
* @param {Boolean} opts.includeSize Include size (default to false)
|
|
1986
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1725
1987
|
*/
|
|
1726
1988
|
getOutboundContactlistsDivisionview(contactListId, opts) {
|
|
1727
1989
|
opts = opts || {};
|
|
@@ -1741,7 +2003,8 @@ class OutboundApi {
|
|
|
1741
2003
|
null,
|
|
1742
2004
|
['PureCloud OAuth'],
|
|
1743
2005
|
['application/json'],
|
|
1744
|
-
['application/json']
|
|
2006
|
+
['application/json'],
|
|
2007
|
+
opts['customHeaders']
|
|
1745
2008
|
);
|
|
1746
2009
|
}
|
|
1747
2010
|
|
|
@@ -1758,6 +2021,7 @@ class OutboundApi {
|
|
|
1758
2021
|
* @param {Array.<String>} opts.id id
|
|
1759
2022
|
* @param {String} opts.sortBy Sort by
|
|
1760
2023
|
* @param {Object} opts.sortOrder Sort order (default to a)
|
|
2024
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1761
2025
|
*/
|
|
1762
2026
|
getOutboundContactlistsDivisionviews(opts) {
|
|
1763
2027
|
opts = opts || {};
|
|
@@ -1773,7 +2037,8 @@ class OutboundApi {
|
|
|
1773
2037
|
null,
|
|
1774
2038
|
['PureCloud OAuth'],
|
|
1775
2039
|
['application/json'],
|
|
1776
|
-
['application/json']
|
|
2040
|
+
['application/json'],
|
|
2041
|
+
opts['customHeaders']
|
|
1777
2042
|
);
|
|
1778
2043
|
}
|
|
1779
2044
|
|
|
@@ -1781,8 +2046,12 @@ class OutboundApi {
|
|
|
1781
2046
|
* Get Contact List Template
|
|
1782
2047
|
*
|
|
1783
2048
|
* @param {String} contactListTemplateId ContactListTemplate ID
|
|
2049
|
+
* @param {Object} opts Optional parameters
|
|
2050
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1784
2051
|
*/
|
|
1785
|
-
getOutboundContactlisttemplate(contactListTemplateId) {
|
|
2052
|
+
getOutboundContactlisttemplate(contactListTemplateId, opts) {
|
|
2053
|
+
opts = opts || {};
|
|
2054
|
+
|
|
1786
2055
|
// verify the required parameter 'contactListTemplateId' is set
|
|
1787
2056
|
if (contactListTemplateId === undefined || contactListTemplateId === null || contactListTemplateId === '') {
|
|
1788
2057
|
throw 'Missing the required parameter "contactListTemplateId" when calling getOutboundContactlisttemplate';
|
|
@@ -1798,7 +2067,8 @@ class OutboundApi {
|
|
|
1798
2067
|
null,
|
|
1799
2068
|
['PureCloud OAuth'],
|
|
1800
2069
|
['application/json'],
|
|
1801
|
-
['application/json']
|
|
2070
|
+
['application/json'],
|
|
2071
|
+
opts['customHeaders']
|
|
1802
2072
|
);
|
|
1803
2073
|
}
|
|
1804
2074
|
|
|
@@ -1813,6 +2083,7 @@ class OutboundApi {
|
|
|
1813
2083
|
* @param {String} opts.name Name
|
|
1814
2084
|
* @param {String} opts.sortBy Sort by
|
|
1815
2085
|
* @param {Object} opts.sortOrder Sort order (default to a)
|
|
2086
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1816
2087
|
*/
|
|
1817
2088
|
getOutboundContactlisttemplates(opts) {
|
|
1818
2089
|
opts = opts || {};
|
|
@@ -1828,7 +2099,8 @@ class OutboundApi {
|
|
|
1828
2099
|
null,
|
|
1829
2100
|
['PureCloud OAuth'],
|
|
1830
2101
|
['application/json'],
|
|
1831
|
-
['application/json']
|
|
2102
|
+
['application/json'],
|
|
2103
|
+
opts['customHeaders']
|
|
1832
2104
|
);
|
|
1833
2105
|
}
|
|
1834
2106
|
|
|
@@ -1838,8 +2110,12 @@ class OutboundApi {
|
|
|
1838
2110
|
* @param {String} campaignId Campaign ID
|
|
1839
2111
|
* @param {String} start Start datetime (ISO 8601 or Unix epoch)
|
|
1840
2112
|
* @param {String} end End datetime (ISO 8601 or Unix epoch)
|
|
2113
|
+
* @param {Object} opts Optional parameters
|
|
2114
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1841
2115
|
*/
|
|
1842
|
-
getOutboundDiagnosticsCampaignSummary(campaignId, start, end) {
|
|
2116
|
+
getOutboundDiagnosticsCampaignSummary(campaignId, start, end, opts) {
|
|
2117
|
+
opts = opts || {};
|
|
2118
|
+
|
|
1843
2119
|
// verify the required parameter 'campaignId' is set
|
|
1844
2120
|
if (campaignId === undefined || campaignId === null || campaignId === '') {
|
|
1845
2121
|
throw 'Missing the required parameter "campaignId" when calling getOutboundDiagnosticsCampaignSummary';
|
|
@@ -1863,7 +2139,8 @@ class OutboundApi {
|
|
|
1863
2139
|
null,
|
|
1864
2140
|
['PureCloud OAuth'],
|
|
1865
2141
|
['application/json'],
|
|
1866
|
-
['application/json']
|
|
2142
|
+
['application/json'],
|
|
2143
|
+
opts['customHeaders']
|
|
1867
2144
|
);
|
|
1868
2145
|
}
|
|
1869
2146
|
|
|
@@ -1871,8 +2148,12 @@ class OutboundApi {
|
|
|
1871
2148
|
* Get an Outbound Digital Rule Set
|
|
1872
2149
|
*
|
|
1873
2150
|
* @param {String} digitalRuleSetId The Digital Rule Set ID
|
|
2151
|
+
* @param {Object} opts Optional parameters
|
|
2152
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1874
2153
|
*/
|
|
1875
|
-
getOutboundDigitalruleset(digitalRuleSetId) {
|
|
2154
|
+
getOutboundDigitalruleset(digitalRuleSetId, opts) {
|
|
2155
|
+
opts = opts || {};
|
|
2156
|
+
|
|
1876
2157
|
// verify the required parameter 'digitalRuleSetId' is set
|
|
1877
2158
|
if (digitalRuleSetId === undefined || digitalRuleSetId === null || digitalRuleSetId === '') {
|
|
1878
2159
|
throw 'Missing the required parameter "digitalRuleSetId" when calling getOutboundDigitalruleset';
|
|
@@ -1888,7 +2169,8 @@ class OutboundApi {
|
|
|
1888
2169
|
null,
|
|
1889
2170
|
['PureCloud OAuth'],
|
|
1890
2171
|
['application/json'],
|
|
1891
|
-
['application/json']
|
|
2172
|
+
['application/json'],
|
|
2173
|
+
opts['customHeaders']
|
|
1892
2174
|
);
|
|
1893
2175
|
}
|
|
1894
2176
|
|
|
@@ -1902,6 +2184,7 @@ class OutboundApi {
|
|
|
1902
2184
|
* @param {Object} opts.sortOrder The direction to sort (default to ascending)
|
|
1903
2185
|
* @param {String} opts.name Name
|
|
1904
2186
|
* @param {Array.<String>} opts.id A list of digital rule set ids to bulk fetch
|
|
2187
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1905
2188
|
*/
|
|
1906
2189
|
getOutboundDigitalrulesets(opts) {
|
|
1907
2190
|
opts = opts || {};
|
|
@@ -1917,7 +2200,8 @@ class OutboundApi {
|
|
|
1917
2200
|
null,
|
|
1918
2201
|
['PureCloud OAuth'],
|
|
1919
2202
|
['application/json'],
|
|
1920
|
-
['application/json']
|
|
2203
|
+
['application/json'],
|
|
2204
|
+
opts['customHeaders']
|
|
1921
2205
|
);
|
|
1922
2206
|
}
|
|
1923
2207
|
|
|
@@ -1928,6 +2212,7 @@ class OutboundApi {
|
|
|
1928
2212
|
* @param {Object} opts Optional parameters
|
|
1929
2213
|
* @param {Boolean} opts.includeImportStatus Import status (default to false)
|
|
1930
2214
|
* @param {Boolean} opts.includeSize Include size (default to false)
|
|
2215
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1931
2216
|
*/
|
|
1932
2217
|
getOutboundDnclist(dncListId, opts) {
|
|
1933
2218
|
opts = opts || {};
|
|
@@ -1947,7 +2232,8 @@ class OutboundApi {
|
|
|
1947
2232
|
null,
|
|
1948
2233
|
['PureCloud OAuth'],
|
|
1949
2234
|
['application/json'],
|
|
1950
|
-
['application/json']
|
|
2235
|
+
['application/json'],
|
|
2236
|
+
opts['customHeaders']
|
|
1951
2237
|
);
|
|
1952
2238
|
}
|
|
1953
2239
|
|
|
@@ -1957,6 +2243,7 @@ class OutboundApi {
|
|
|
1957
2243
|
* @param {String} dncListId DncList ID
|
|
1958
2244
|
* @param {Object} opts Optional parameters
|
|
1959
2245
|
* @param {String} opts.download Redirect to download uri (default to false)
|
|
2246
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1960
2247
|
*/
|
|
1961
2248
|
getOutboundDnclistExport(dncListId, opts) {
|
|
1962
2249
|
opts = opts || {};
|
|
@@ -1976,7 +2263,8 @@ class OutboundApi {
|
|
|
1976
2263
|
null,
|
|
1977
2264
|
['PureCloud OAuth'],
|
|
1978
2265
|
['application/json'],
|
|
1979
|
-
['application/json']
|
|
2266
|
+
['application/json'],
|
|
2267
|
+
opts['customHeaders']
|
|
1980
2268
|
);
|
|
1981
2269
|
}
|
|
1982
2270
|
|
|
@@ -1984,8 +2272,12 @@ class OutboundApi {
|
|
|
1984
2272
|
* Get dialer dncList import status.
|
|
1985
2273
|
*
|
|
1986
2274
|
* @param {String} dncListId DncList ID
|
|
2275
|
+
* @param {Object} opts Optional parameters
|
|
2276
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1987
2277
|
*/
|
|
1988
|
-
getOutboundDnclistImportstatus(dncListId) {
|
|
2278
|
+
getOutboundDnclistImportstatus(dncListId, opts) {
|
|
2279
|
+
opts = opts || {};
|
|
2280
|
+
|
|
1989
2281
|
// verify the required parameter 'dncListId' is set
|
|
1990
2282
|
if (dncListId === undefined || dncListId === null || dncListId === '') {
|
|
1991
2283
|
throw 'Missing the required parameter "dncListId" when calling getOutboundDnclistImportstatus';
|
|
@@ -2001,7 +2293,8 @@ class OutboundApi {
|
|
|
2001
2293
|
null,
|
|
2002
2294
|
['PureCloud OAuth'],
|
|
2003
2295
|
['application/json'],
|
|
2004
|
-
['application/json']
|
|
2296
|
+
['application/json'],
|
|
2297
|
+
opts['customHeaders']
|
|
2005
2298
|
);
|
|
2006
2299
|
}
|
|
2007
2300
|
|
|
@@ -2020,6 +2313,7 @@ class OutboundApi {
|
|
|
2020
2313
|
* @param {Array.<String>} opts.divisionId Division ID(s)
|
|
2021
2314
|
* @param {String} opts.sortBy Sort by
|
|
2022
2315
|
* @param {Object} opts.sortOrder Sort order
|
|
2316
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2023
2317
|
*/
|
|
2024
2318
|
getOutboundDnclists(opts) {
|
|
2025
2319
|
opts = opts || {};
|
|
@@ -2035,7 +2329,8 @@ class OutboundApi {
|
|
|
2035
2329
|
null,
|
|
2036
2330
|
['PureCloud OAuth'],
|
|
2037
2331
|
['application/json'],
|
|
2038
|
-
['application/json']
|
|
2332
|
+
['application/json'],
|
|
2333
|
+
opts['customHeaders']
|
|
2039
2334
|
);
|
|
2040
2335
|
}
|
|
2041
2336
|
|
|
@@ -2046,6 +2341,7 @@ class OutboundApi {
|
|
|
2046
2341
|
* @param {Object} opts Optional parameters
|
|
2047
2342
|
* @param {Boolean} opts.includeImportStatus Include import status (default to false)
|
|
2048
2343
|
* @param {Boolean} opts.includeSize Include size (default to false)
|
|
2344
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2049
2345
|
*/
|
|
2050
2346
|
getOutboundDnclistsDivisionview(dncListId, opts) {
|
|
2051
2347
|
opts = opts || {};
|
|
@@ -2065,7 +2361,8 @@ class OutboundApi {
|
|
|
2065
2361
|
null,
|
|
2066
2362
|
['PureCloud OAuth'],
|
|
2067
2363
|
['application/json'],
|
|
2068
|
-
['application/json']
|
|
2364
|
+
['application/json'],
|
|
2365
|
+
opts['customHeaders']
|
|
2069
2366
|
);
|
|
2070
2367
|
}
|
|
2071
2368
|
|
|
@@ -2083,6 +2380,7 @@ class OutboundApi {
|
|
|
2083
2380
|
* @param {Array.<String>} opts.id id
|
|
2084
2381
|
* @param {String} opts.sortBy Sort by
|
|
2085
2382
|
* @param {Object} opts.sortOrder Sort order (default to a)
|
|
2383
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2086
2384
|
*/
|
|
2087
2385
|
getOutboundDnclistsDivisionviews(opts) {
|
|
2088
2386
|
opts = opts || {};
|
|
@@ -2098,7 +2396,8 @@ class OutboundApi {
|
|
|
2098
2396
|
null,
|
|
2099
2397
|
['PureCloud OAuth'],
|
|
2100
2398
|
['application/json'],
|
|
2101
|
-
['application/json']
|
|
2399
|
+
['application/json'],
|
|
2400
|
+
opts['customHeaders']
|
|
2102
2401
|
);
|
|
2103
2402
|
}
|
|
2104
2403
|
|
|
@@ -2106,8 +2405,12 @@ class OutboundApi {
|
|
|
2106
2405
|
* Get Dialer Event
|
|
2107
2406
|
*
|
|
2108
2407
|
* @param {String} eventId Event Log ID
|
|
2408
|
+
* @param {Object} opts Optional parameters
|
|
2409
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2109
2410
|
*/
|
|
2110
|
-
getOutboundEvent(eventId) {
|
|
2411
|
+
getOutboundEvent(eventId, opts) {
|
|
2412
|
+
opts = opts || {};
|
|
2413
|
+
|
|
2111
2414
|
// verify the required parameter 'eventId' is set
|
|
2112
2415
|
if (eventId === undefined || eventId === null || eventId === '') {
|
|
2113
2416
|
throw 'Missing the required parameter "eventId" when calling getOutboundEvent';
|
|
@@ -2123,7 +2426,8 @@ class OutboundApi {
|
|
|
2123
2426
|
null,
|
|
2124
2427
|
['PureCloud OAuth'],
|
|
2125
2428
|
['application/json'],
|
|
2126
|
-
['application/json']
|
|
2429
|
+
['application/json'],
|
|
2430
|
+
opts['customHeaders']
|
|
2127
2431
|
);
|
|
2128
2432
|
}
|
|
2129
2433
|
|
|
@@ -2138,6 +2442,7 @@ class OutboundApi {
|
|
|
2138
2442
|
* @param {String} opts.level Level
|
|
2139
2443
|
* @param {String} opts.sortBy Sort by
|
|
2140
2444
|
* @param {Object} opts.sortOrder Sort order (default to a)
|
|
2445
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2141
2446
|
*/
|
|
2142
2447
|
getOutboundEvents(opts) {
|
|
2143
2448
|
opts = opts || {};
|
|
@@ -2153,7 +2458,8 @@ class OutboundApi {
|
|
|
2153
2458
|
null,
|
|
2154
2459
|
['PureCloud OAuth'],
|
|
2155
2460
|
['application/json'],
|
|
2156
|
-
['application/json']
|
|
2461
|
+
['application/json'],
|
|
2462
|
+
opts['customHeaders']
|
|
2157
2463
|
);
|
|
2158
2464
|
}
|
|
2159
2465
|
|
|
@@ -2161,8 +2467,12 @@ class OutboundApi {
|
|
|
2161
2467
|
* Get File Specification Template
|
|
2162
2468
|
*
|
|
2163
2469
|
* @param {String} fileSpecificationTemplateId File Specification Template ID
|
|
2470
|
+
* @param {Object} opts Optional parameters
|
|
2471
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2164
2472
|
*/
|
|
2165
|
-
getOutboundFilespecificationtemplate(fileSpecificationTemplateId) {
|
|
2473
|
+
getOutboundFilespecificationtemplate(fileSpecificationTemplateId, opts) {
|
|
2474
|
+
opts = opts || {};
|
|
2475
|
+
|
|
2166
2476
|
// verify the required parameter 'fileSpecificationTemplateId' is set
|
|
2167
2477
|
if (fileSpecificationTemplateId === undefined || fileSpecificationTemplateId === null || fileSpecificationTemplateId === '') {
|
|
2168
2478
|
throw 'Missing the required parameter "fileSpecificationTemplateId" when calling getOutboundFilespecificationtemplate';
|
|
@@ -2178,7 +2488,8 @@ class OutboundApi {
|
|
|
2178
2488
|
null,
|
|
2179
2489
|
['PureCloud OAuth'],
|
|
2180
2490
|
['application/json'],
|
|
2181
|
-
['application/json']
|
|
2491
|
+
['application/json'],
|
|
2492
|
+
opts['customHeaders']
|
|
2182
2493
|
);
|
|
2183
2494
|
}
|
|
2184
2495
|
|
|
@@ -2193,6 +2504,7 @@ class OutboundApi {
|
|
|
2193
2504
|
* @param {String} opts.name Name
|
|
2194
2505
|
* @param {String} opts.sortBy Sort by
|
|
2195
2506
|
* @param {Object} opts.sortOrder Sort order (default to a)
|
|
2507
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2196
2508
|
*/
|
|
2197
2509
|
getOutboundFilespecificationtemplates(opts) {
|
|
2198
2510
|
opts = opts || {};
|
|
@@ -2208,7 +2520,8 @@ class OutboundApi {
|
|
|
2208
2520
|
null,
|
|
2209
2521
|
['PureCloud OAuth'],
|
|
2210
2522
|
['application/json'],
|
|
2211
|
-
['application/json']
|
|
2523
|
+
['application/json'],
|
|
2524
|
+
opts['customHeaders']
|
|
2212
2525
|
);
|
|
2213
2526
|
}
|
|
2214
2527
|
|
|
@@ -2218,6 +2531,7 @@ class OutboundApi {
|
|
|
2218
2531
|
* @param {String} importTemplateId Import Template ID
|
|
2219
2532
|
* @param {Object} opts Optional parameters
|
|
2220
2533
|
* @param {Boolean} opts.includeImportStatus Import status (default to false)
|
|
2534
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2221
2535
|
*/
|
|
2222
2536
|
getOutboundImporttemplate(importTemplateId, opts) {
|
|
2223
2537
|
opts = opts || {};
|
|
@@ -2237,7 +2551,8 @@ class OutboundApi {
|
|
|
2237
2551
|
null,
|
|
2238
2552
|
['PureCloud OAuth'],
|
|
2239
2553
|
['application/json'],
|
|
2240
|
-
['application/json']
|
|
2554
|
+
['application/json'],
|
|
2555
|
+
opts['customHeaders']
|
|
2241
2556
|
);
|
|
2242
2557
|
}
|
|
2243
2558
|
|
|
@@ -2247,6 +2562,7 @@ class OutboundApi {
|
|
|
2247
2562
|
* @param {String} importTemplateId importTemplateId
|
|
2248
2563
|
* @param {Object} opts Optional parameters
|
|
2249
2564
|
* @param {String} opts.listNamePrefix listNamePrefix
|
|
2565
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2250
2566
|
*/
|
|
2251
2567
|
getOutboundImporttemplateImportstatus(importTemplateId, opts) {
|
|
2252
2568
|
opts = opts || {};
|
|
@@ -2266,7 +2582,8 @@ class OutboundApi {
|
|
|
2266
2582
|
null,
|
|
2267
2583
|
['PureCloud OAuth'],
|
|
2268
2584
|
['application/json'],
|
|
2269
|
-
['application/json']
|
|
2585
|
+
['application/json'],
|
|
2586
|
+
opts['customHeaders']
|
|
2270
2587
|
);
|
|
2271
2588
|
}
|
|
2272
2589
|
|
|
@@ -2283,6 +2600,7 @@ class OutboundApi {
|
|
|
2283
2600
|
* @param {String} opts.sortBy Sort by
|
|
2284
2601
|
* @param {Object} opts.sortOrder Sort order (default to a)
|
|
2285
2602
|
* @param {String} opts.contactListTemplateId Contact List Template ID
|
|
2603
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2286
2604
|
*/
|
|
2287
2605
|
getOutboundImporttemplates(opts) {
|
|
2288
2606
|
opts = opts || {};
|
|
@@ -2298,7 +2616,8 @@ class OutboundApi {
|
|
|
2298
2616
|
null,
|
|
2299
2617
|
['PureCloud OAuth'],
|
|
2300
2618
|
['application/json'],
|
|
2301
|
-
['application/json']
|
|
2619
|
+
['application/json'],
|
|
2620
|
+
opts['customHeaders']
|
|
2302
2621
|
);
|
|
2303
2622
|
}
|
|
2304
2623
|
|
|
@@ -2306,8 +2625,12 @@ class OutboundApi {
|
|
|
2306
2625
|
* Get an Outbound Messaging Campaign
|
|
2307
2626
|
*
|
|
2308
2627
|
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
2628
|
+
* @param {Object} opts Optional parameters
|
|
2629
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2309
2630
|
*/
|
|
2310
|
-
getOutboundMessagingcampaign(messagingCampaignId) {
|
|
2631
|
+
getOutboundMessagingcampaign(messagingCampaignId, opts) {
|
|
2632
|
+
opts = opts || {};
|
|
2633
|
+
|
|
2311
2634
|
// verify the required parameter 'messagingCampaignId' is set
|
|
2312
2635
|
if (messagingCampaignId === undefined || messagingCampaignId === null || messagingCampaignId === '') {
|
|
2313
2636
|
throw 'Missing the required parameter "messagingCampaignId" when calling getOutboundMessagingcampaign';
|
|
@@ -2323,7 +2646,8 @@ class OutboundApi {
|
|
|
2323
2646
|
null,
|
|
2324
2647
|
['PureCloud OAuth'],
|
|
2325
2648
|
['application/json'],
|
|
2326
|
-
['application/json']
|
|
2649
|
+
['application/json'],
|
|
2650
|
+
opts['customHeaders']
|
|
2327
2651
|
);
|
|
2328
2652
|
}
|
|
2329
2653
|
|
|
@@ -2331,8 +2655,12 @@ class OutboundApi {
|
|
|
2331
2655
|
* Get messaging campaign diagnostics
|
|
2332
2656
|
*
|
|
2333
2657
|
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
2658
|
+
* @param {Object} opts Optional parameters
|
|
2659
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2334
2660
|
*/
|
|
2335
|
-
getOutboundMessagingcampaignDiagnostics(messagingCampaignId) {
|
|
2661
|
+
getOutboundMessagingcampaignDiagnostics(messagingCampaignId, opts) {
|
|
2662
|
+
opts = opts || {};
|
|
2663
|
+
|
|
2336
2664
|
// verify the required parameter 'messagingCampaignId' is set
|
|
2337
2665
|
if (messagingCampaignId === undefined || messagingCampaignId === null || messagingCampaignId === '') {
|
|
2338
2666
|
throw 'Missing the required parameter "messagingCampaignId" when calling getOutboundMessagingcampaignDiagnostics';
|
|
@@ -2348,7 +2676,8 @@ class OutboundApi {
|
|
|
2348
2676
|
null,
|
|
2349
2677
|
['PureCloud OAuth'],
|
|
2350
2678
|
['application/json'],
|
|
2351
|
-
['application/json']
|
|
2679
|
+
['application/json'],
|
|
2680
|
+
opts['customHeaders']
|
|
2352
2681
|
);
|
|
2353
2682
|
}
|
|
2354
2683
|
|
|
@@ -2356,8 +2685,12 @@ class OutboundApi {
|
|
|
2356
2685
|
* Get messaging campaign's progress
|
|
2357
2686
|
*
|
|
2358
2687
|
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
2688
|
+
* @param {Object} opts Optional parameters
|
|
2689
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2359
2690
|
*/
|
|
2360
|
-
getOutboundMessagingcampaignProgress(messagingCampaignId) {
|
|
2691
|
+
getOutboundMessagingcampaignProgress(messagingCampaignId, opts) {
|
|
2692
|
+
opts = opts || {};
|
|
2693
|
+
|
|
2361
2694
|
// verify the required parameter 'messagingCampaignId' is set
|
|
2362
2695
|
if (messagingCampaignId === undefined || messagingCampaignId === null || messagingCampaignId === '') {
|
|
2363
2696
|
throw 'Missing the required parameter "messagingCampaignId" when calling getOutboundMessagingcampaignProgress';
|
|
@@ -2373,7 +2706,8 @@ class OutboundApi {
|
|
|
2373
2706
|
null,
|
|
2374
2707
|
['PureCloud OAuth'],
|
|
2375
2708
|
['application/json'],
|
|
2376
|
-
['application/json']
|
|
2709
|
+
['application/json'],
|
|
2710
|
+
opts['customHeaders']
|
|
2377
2711
|
);
|
|
2378
2712
|
}
|
|
2379
2713
|
|
|
@@ -2394,6 +2728,7 @@ class OutboundApi {
|
|
|
2394
2728
|
* @param {String} opts.contentTemplateId Content template ID
|
|
2395
2729
|
* @param {Object} opts.campaignStatus Campaign Status
|
|
2396
2730
|
* @param {Array.<String>} opts.ruleSetIds Ruleset ID(s)
|
|
2731
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2397
2732
|
*/
|
|
2398
2733
|
getOutboundMessagingcampaigns(opts) {
|
|
2399
2734
|
opts = opts || {};
|
|
@@ -2409,7 +2744,8 @@ class OutboundApi {
|
|
|
2409
2744
|
null,
|
|
2410
2745
|
['PureCloud OAuth'],
|
|
2411
2746
|
['application/json'],
|
|
2412
|
-
['application/json']
|
|
2747
|
+
['application/json'],
|
|
2748
|
+
opts['customHeaders']
|
|
2413
2749
|
);
|
|
2414
2750
|
}
|
|
2415
2751
|
|
|
@@ -2417,8 +2753,12 @@ class OutboundApi {
|
|
|
2417
2753
|
* Get a basic Messaging Campaign information object
|
|
2418
2754
|
* This returns a simplified version of a Messaging Campaign, consisting of id, name, and division.
|
|
2419
2755
|
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
2756
|
+
* @param {Object} opts Optional parameters
|
|
2757
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2420
2758
|
*/
|
|
2421
|
-
getOutboundMessagingcampaignsDivisionview(messagingCampaignId) {
|
|
2759
|
+
getOutboundMessagingcampaignsDivisionview(messagingCampaignId, opts) {
|
|
2760
|
+
opts = opts || {};
|
|
2761
|
+
|
|
2422
2762
|
// verify the required parameter 'messagingCampaignId' is set
|
|
2423
2763
|
if (messagingCampaignId === undefined || messagingCampaignId === null || messagingCampaignId === '') {
|
|
2424
2764
|
throw 'Missing the required parameter "messagingCampaignId" when calling getOutboundMessagingcampaignsDivisionview';
|
|
@@ -2434,7 +2774,8 @@ class OutboundApi {
|
|
|
2434
2774
|
null,
|
|
2435
2775
|
['PureCloud OAuth'],
|
|
2436
2776
|
['application/json'],
|
|
2437
|
-
['application/json']
|
|
2777
|
+
['application/json'],
|
|
2778
|
+
opts['customHeaders']
|
|
2438
2779
|
);
|
|
2439
2780
|
}
|
|
2440
2781
|
|
|
@@ -2451,6 +2792,7 @@ class OutboundApi {
|
|
|
2451
2792
|
* @param {String} opts.senderSmsPhoneNumber Sender SMS Phone Number
|
|
2452
2793
|
* @param {String} opts.contentTemplateId Content template ID
|
|
2453
2794
|
* @param {Object} opts.campaignStatus Campaign Status
|
|
2795
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2454
2796
|
*/
|
|
2455
2797
|
getOutboundMessagingcampaignsDivisionviews(opts) {
|
|
2456
2798
|
opts = opts || {};
|
|
@@ -2466,7 +2808,8 @@ class OutboundApi {
|
|
|
2466
2808
|
null,
|
|
2467
2809
|
['PureCloud OAuth'],
|
|
2468
2810
|
['application/json'],
|
|
2469
|
-
['application/json']
|
|
2811
|
+
['application/json'],
|
|
2812
|
+
opts['customHeaders']
|
|
2470
2813
|
);
|
|
2471
2814
|
}
|
|
2472
2815
|
|
|
@@ -2474,9 +2817,13 @@ class OutboundApi {
|
|
|
2474
2817
|
* Get a Rule Set by ID.
|
|
2475
2818
|
*
|
|
2476
2819
|
* @param {String} ruleSetId Rule Set ID
|
|
2820
|
+
* @param {Object} opts Optional parameters
|
|
2821
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2477
2822
|
*/
|
|
2478
|
-
getOutboundRuleset(ruleSetId) {
|
|
2479
|
-
|
|
2823
|
+
getOutboundRuleset(ruleSetId, opts) {
|
|
2824
|
+
opts = opts || {};
|
|
2825
|
+
|
|
2826
|
+
// verify the required parameter 'ruleSetId' is set
|
|
2480
2827
|
if (ruleSetId === undefined || ruleSetId === null || ruleSetId === '') {
|
|
2481
2828
|
throw 'Missing the required parameter "ruleSetId" when calling getOutboundRuleset';
|
|
2482
2829
|
}
|
|
@@ -2491,7 +2838,8 @@ class OutboundApi {
|
|
|
2491
2838
|
null,
|
|
2492
2839
|
['PureCloud OAuth'],
|
|
2493
2840
|
['application/json'],
|
|
2494
|
-
['application/json']
|
|
2841
|
+
['application/json'],
|
|
2842
|
+
opts['customHeaders']
|
|
2495
2843
|
);
|
|
2496
2844
|
}
|
|
2497
2845
|
|
|
@@ -2506,6 +2854,7 @@ class OutboundApi {
|
|
|
2506
2854
|
* @param {String} opts.name Name
|
|
2507
2855
|
* @param {String} opts.sortBy Sort by
|
|
2508
2856
|
* @param {Object} opts.sortOrder Sort order (default to a)
|
|
2857
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2509
2858
|
*/
|
|
2510
2859
|
getOutboundRulesets(opts) {
|
|
2511
2860
|
opts = opts || {};
|
|
@@ -2521,7 +2870,8 @@ class OutboundApi {
|
|
|
2521
2870
|
null,
|
|
2522
2871
|
['PureCloud OAuth'],
|
|
2523
2872
|
['application/json'],
|
|
2524
|
-
['application/json']
|
|
2873
|
+
['application/json'],
|
|
2874
|
+
opts['customHeaders']
|
|
2525
2875
|
);
|
|
2526
2876
|
}
|
|
2527
2877
|
|
|
@@ -2529,8 +2879,12 @@ class OutboundApi {
|
|
|
2529
2879
|
* Get a dialer campaign schedule.
|
|
2530
2880
|
*
|
|
2531
2881
|
* @param {String} campaignId Campaign ID
|
|
2882
|
+
* @param {Object} opts Optional parameters
|
|
2883
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2532
2884
|
*/
|
|
2533
|
-
getOutboundSchedulesCampaign(campaignId) {
|
|
2885
|
+
getOutboundSchedulesCampaign(campaignId, opts) {
|
|
2886
|
+
opts = opts || {};
|
|
2887
|
+
|
|
2534
2888
|
// verify the required parameter 'campaignId' is set
|
|
2535
2889
|
if (campaignId === undefined || campaignId === null || campaignId === '') {
|
|
2536
2890
|
throw 'Missing the required parameter "campaignId" when calling getOutboundSchedulesCampaign';
|
|
@@ -2546,15 +2900,20 @@ class OutboundApi {
|
|
|
2546
2900
|
null,
|
|
2547
2901
|
['PureCloud OAuth'],
|
|
2548
2902
|
['application/json'],
|
|
2549
|
-
['application/json']
|
|
2903
|
+
['application/json'],
|
|
2904
|
+
opts['customHeaders']
|
|
2550
2905
|
);
|
|
2551
2906
|
}
|
|
2552
2907
|
|
|
2553
2908
|
/**
|
|
2554
2909
|
* Query for a list of dialer campaign schedules.
|
|
2555
2910
|
*
|
|
2911
|
+
* @param {Object} opts Optional parameters
|
|
2912
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2556
2913
|
*/
|
|
2557
|
-
getOutboundSchedulesCampaigns() {
|
|
2914
|
+
getOutboundSchedulesCampaigns(opts) {
|
|
2915
|
+
opts = opts || {};
|
|
2916
|
+
|
|
2558
2917
|
|
|
2559
2918
|
return this.apiClient.callApi(
|
|
2560
2919
|
'/api/v2/outbound/schedules/campaigns',
|
|
@@ -2566,7 +2925,8 @@ class OutboundApi {
|
|
|
2566
2925
|
null,
|
|
2567
2926
|
['PureCloud OAuth'],
|
|
2568
2927
|
['application/json'],
|
|
2569
|
-
['application/json']
|
|
2928
|
+
['application/json'],
|
|
2929
|
+
opts['customHeaders']
|
|
2570
2930
|
);
|
|
2571
2931
|
}
|
|
2572
2932
|
|
|
@@ -2574,8 +2934,12 @@ class OutboundApi {
|
|
|
2574
2934
|
* Get an email campaign schedule.
|
|
2575
2935
|
*
|
|
2576
2936
|
* @param {String} emailCampaignId Email Campaign ID
|
|
2937
|
+
* @param {Object} opts Optional parameters
|
|
2938
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2577
2939
|
*/
|
|
2578
|
-
getOutboundSchedulesEmailcampaign(emailCampaignId) {
|
|
2940
|
+
getOutboundSchedulesEmailcampaign(emailCampaignId, opts) {
|
|
2941
|
+
opts = opts || {};
|
|
2942
|
+
|
|
2579
2943
|
// verify the required parameter 'emailCampaignId' is set
|
|
2580
2944
|
if (emailCampaignId === undefined || emailCampaignId === null || emailCampaignId === '') {
|
|
2581
2945
|
throw 'Missing the required parameter "emailCampaignId" when calling getOutboundSchedulesEmailcampaign';
|
|
@@ -2591,15 +2955,20 @@ class OutboundApi {
|
|
|
2591
2955
|
null,
|
|
2592
2956
|
['PureCloud OAuth'],
|
|
2593
2957
|
['application/json'],
|
|
2594
|
-
['application/json']
|
|
2958
|
+
['application/json'],
|
|
2959
|
+
opts['customHeaders']
|
|
2595
2960
|
);
|
|
2596
2961
|
}
|
|
2597
2962
|
|
|
2598
2963
|
/**
|
|
2599
2964
|
* Query for a list of email campaign schedules.
|
|
2600
2965
|
*
|
|
2966
|
+
* @param {Object} opts Optional parameters
|
|
2967
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2601
2968
|
*/
|
|
2602
|
-
getOutboundSchedulesEmailcampaigns() {
|
|
2969
|
+
getOutboundSchedulesEmailcampaigns(opts) {
|
|
2970
|
+
opts = opts || {};
|
|
2971
|
+
|
|
2603
2972
|
|
|
2604
2973
|
return this.apiClient.callApi(
|
|
2605
2974
|
'/api/v2/outbound/schedules/emailcampaigns',
|
|
@@ -2611,7 +2980,8 @@ class OutboundApi {
|
|
|
2611
2980
|
null,
|
|
2612
2981
|
['PureCloud OAuth'],
|
|
2613
2982
|
['application/json'],
|
|
2614
|
-
['application/json']
|
|
2983
|
+
['application/json'],
|
|
2984
|
+
opts['customHeaders']
|
|
2615
2985
|
);
|
|
2616
2986
|
}
|
|
2617
2987
|
|
|
@@ -2619,8 +2989,12 @@ class OutboundApi {
|
|
|
2619
2989
|
* Get a messaging campaign schedule.
|
|
2620
2990
|
*
|
|
2621
2991
|
* @param {String} messagingCampaignId Messaging Campaign ID
|
|
2992
|
+
* @param {Object} opts Optional parameters
|
|
2993
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2622
2994
|
*/
|
|
2623
|
-
getOutboundSchedulesMessagingcampaign(messagingCampaignId) {
|
|
2995
|
+
getOutboundSchedulesMessagingcampaign(messagingCampaignId, opts) {
|
|
2996
|
+
opts = opts || {};
|
|
2997
|
+
|
|
2624
2998
|
// verify the required parameter 'messagingCampaignId' is set
|
|
2625
2999
|
if (messagingCampaignId === undefined || messagingCampaignId === null || messagingCampaignId === '') {
|
|
2626
3000
|
throw 'Missing the required parameter "messagingCampaignId" when calling getOutboundSchedulesMessagingcampaign';
|
|
@@ -2636,15 +3010,20 @@ class OutboundApi {
|
|
|
2636
3010
|
null,
|
|
2637
3011
|
['PureCloud OAuth'],
|
|
2638
3012
|
['application/json'],
|
|
2639
|
-
['application/json']
|
|
3013
|
+
['application/json'],
|
|
3014
|
+
opts['customHeaders']
|
|
2640
3015
|
);
|
|
2641
3016
|
}
|
|
2642
3017
|
|
|
2643
3018
|
/**
|
|
2644
3019
|
* Query for a list of messaging campaign schedules.
|
|
2645
3020
|
*
|
|
3021
|
+
* @param {Object} opts Optional parameters
|
|
3022
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2646
3023
|
*/
|
|
2647
|
-
getOutboundSchedulesMessagingcampaigns() {
|
|
3024
|
+
getOutboundSchedulesMessagingcampaigns(opts) {
|
|
3025
|
+
opts = opts || {};
|
|
3026
|
+
|
|
2648
3027
|
|
|
2649
3028
|
return this.apiClient.callApi(
|
|
2650
3029
|
'/api/v2/outbound/schedules/messagingcampaigns',
|
|
@@ -2656,7 +3035,8 @@ class OutboundApi {
|
|
|
2656
3035
|
null,
|
|
2657
3036
|
['PureCloud OAuth'],
|
|
2658
3037
|
['application/json'],
|
|
2659
|
-
['application/json']
|
|
3038
|
+
['application/json'],
|
|
3039
|
+
opts['customHeaders']
|
|
2660
3040
|
);
|
|
2661
3041
|
}
|
|
2662
3042
|
|
|
@@ -2664,8 +3044,12 @@ class OutboundApi {
|
|
|
2664
3044
|
* Get a dialer sequence schedule.
|
|
2665
3045
|
*
|
|
2666
3046
|
* @param {String} sequenceId Sequence ID
|
|
3047
|
+
* @param {Object} opts Optional parameters
|
|
3048
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2667
3049
|
*/
|
|
2668
|
-
getOutboundSchedulesSequence(sequenceId) {
|
|
3050
|
+
getOutboundSchedulesSequence(sequenceId, opts) {
|
|
3051
|
+
opts = opts || {};
|
|
3052
|
+
|
|
2669
3053
|
// verify the required parameter 'sequenceId' is set
|
|
2670
3054
|
if (sequenceId === undefined || sequenceId === null || sequenceId === '') {
|
|
2671
3055
|
throw 'Missing the required parameter "sequenceId" when calling getOutboundSchedulesSequence';
|
|
@@ -2681,15 +3065,20 @@ class OutboundApi {
|
|
|
2681
3065
|
null,
|
|
2682
3066
|
['PureCloud OAuth'],
|
|
2683
3067
|
['application/json'],
|
|
2684
|
-
['application/json']
|
|
3068
|
+
['application/json'],
|
|
3069
|
+
opts['customHeaders']
|
|
2685
3070
|
);
|
|
2686
3071
|
}
|
|
2687
3072
|
|
|
2688
3073
|
/**
|
|
2689
3074
|
* Query for a list of dialer sequence schedules.
|
|
2690
3075
|
*
|
|
3076
|
+
* @param {Object} opts Optional parameters
|
|
3077
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2691
3078
|
*/
|
|
2692
|
-
getOutboundSchedulesSequences() {
|
|
3079
|
+
getOutboundSchedulesSequences(opts) {
|
|
3080
|
+
opts = opts || {};
|
|
3081
|
+
|
|
2693
3082
|
|
|
2694
3083
|
return this.apiClient.callApi(
|
|
2695
3084
|
'/api/v2/outbound/schedules/sequences',
|
|
@@ -2701,7 +3090,8 @@ class OutboundApi {
|
|
|
2701
3090
|
null,
|
|
2702
3091
|
['PureCloud OAuth'],
|
|
2703
3092
|
['application/json'],
|
|
2704
|
-
['application/json']
|
|
3093
|
+
['application/json'],
|
|
3094
|
+
opts['customHeaders']
|
|
2705
3095
|
);
|
|
2706
3096
|
}
|
|
2707
3097
|
|
|
@@ -2709,8 +3099,12 @@ class OutboundApi {
|
|
|
2709
3099
|
* Get a WhatsApp campaign schedule.
|
|
2710
3100
|
*
|
|
2711
3101
|
* @param {String} whatsAppCampaignId WhatsApp Campaign ID
|
|
3102
|
+
* @param {Object} opts Optional parameters
|
|
3103
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2712
3104
|
*/
|
|
2713
|
-
getOutboundSchedulesWhatsappcampaign(whatsAppCampaignId) {
|
|
3105
|
+
getOutboundSchedulesWhatsappcampaign(whatsAppCampaignId, opts) {
|
|
3106
|
+
opts = opts || {};
|
|
3107
|
+
|
|
2714
3108
|
// verify the required parameter 'whatsAppCampaignId' is set
|
|
2715
3109
|
if (whatsAppCampaignId === undefined || whatsAppCampaignId === null || whatsAppCampaignId === '') {
|
|
2716
3110
|
throw 'Missing the required parameter "whatsAppCampaignId" when calling getOutboundSchedulesWhatsappcampaign';
|
|
@@ -2726,15 +3120,20 @@ class OutboundApi {
|
|
|
2726
3120
|
null,
|
|
2727
3121
|
['PureCloud OAuth'],
|
|
2728
3122
|
['application/json'],
|
|
2729
|
-
['application/json']
|
|
3123
|
+
['application/json'],
|
|
3124
|
+
opts['customHeaders']
|
|
2730
3125
|
);
|
|
2731
3126
|
}
|
|
2732
3127
|
|
|
2733
3128
|
/**
|
|
2734
3129
|
* Query for a list of WhatsApp campaign schedules.
|
|
2735
3130
|
*
|
|
3131
|
+
* @param {Object} opts Optional parameters
|
|
3132
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2736
3133
|
*/
|
|
2737
|
-
getOutboundSchedulesWhatsappcampaigns() {
|
|
3134
|
+
getOutboundSchedulesWhatsappcampaigns(opts) {
|
|
3135
|
+
opts = opts || {};
|
|
3136
|
+
|
|
2738
3137
|
|
|
2739
3138
|
return this.apiClient.callApi(
|
|
2740
3139
|
'/api/v2/outbound/schedules/whatsappcampaigns',
|
|
@@ -2746,7 +3145,8 @@ class OutboundApi {
|
|
|
2746
3145
|
null,
|
|
2747
3146
|
['PureCloud OAuth'],
|
|
2748
3147
|
['application/json'],
|
|
2749
|
-
['application/json']
|
|
3148
|
+
['application/json'],
|
|
3149
|
+
opts['customHeaders']
|
|
2750
3150
|
);
|
|
2751
3151
|
}
|
|
2752
3152
|
|
|
@@ -2754,8 +3154,12 @@ class OutboundApi {
|
|
|
2754
3154
|
* Get a dialer campaign sequence.
|
|
2755
3155
|
*
|
|
2756
3156
|
* @param {String} sequenceId Campaign Sequence ID
|
|
3157
|
+
* @param {Object} opts Optional parameters
|
|
3158
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2757
3159
|
*/
|
|
2758
|
-
getOutboundSequence(sequenceId) {
|
|
3160
|
+
getOutboundSequence(sequenceId, opts) {
|
|
3161
|
+
opts = opts || {};
|
|
3162
|
+
|
|
2759
3163
|
// verify the required parameter 'sequenceId' is set
|
|
2760
3164
|
if (sequenceId === undefined || sequenceId === null || sequenceId === '') {
|
|
2761
3165
|
throw 'Missing the required parameter "sequenceId" when calling getOutboundSequence';
|
|
@@ -2771,7 +3175,8 @@ class OutboundApi {
|
|
|
2771
3175
|
null,
|
|
2772
3176
|
['PureCloud OAuth'],
|
|
2773
3177
|
['application/json'],
|
|
2774
|
-
['application/json']
|
|
3178
|
+
['application/json'],
|
|
3179
|
+
opts['customHeaders']
|
|
2775
3180
|
);
|
|
2776
3181
|
}
|
|
2777
3182
|
|
|
@@ -2786,6 +3191,7 @@ class OutboundApi {
|
|
|
2786
3191
|
* @param {String} opts.name Name
|
|
2787
3192
|
* @param {String} opts.sortBy Sort by
|
|
2788
3193
|
* @param {Object} opts.sortOrder Sort order (default to a)
|
|
3194
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2789
3195
|
*/
|
|
2790
3196
|
getOutboundSequences(opts) {
|
|
2791
3197
|
opts = opts || {};
|
|
@@ -2801,15 +3207,20 @@ class OutboundApi {
|
|
|
2801
3207
|
null,
|
|
2802
3208
|
['PureCloud OAuth'],
|
|
2803
3209
|
['application/json'],
|
|
2804
|
-
['application/json']
|
|
3210
|
+
['application/json'],
|
|
3211
|
+
opts['customHeaders']
|
|
2805
3212
|
);
|
|
2806
3213
|
}
|
|
2807
3214
|
|
|
2808
3215
|
/**
|
|
2809
3216
|
* Get the outbound settings for this organization
|
|
2810
3217
|
*
|
|
3218
|
+
* @param {Object} opts Optional parameters
|
|
3219
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2811
3220
|
*/
|
|
2812
|
-
getOutboundSettings() {
|
|
3221
|
+
getOutboundSettings(opts) {
|
|
3222
|
+
opts = opts || {};
|
|
3223
|
+
|
|
2813
3224
|
|
|
2814
3225
|
return this.apiClient.callApi(
|
|
2815
3226
|
'/api/v2/outbound/settings',
|
|
@@ -2821,15 +3232,20 @@ class OutboundApi {
|
|
|
2821
3232
|
null,
|
|
2822
3233
|
['PureCloud OAuth'],
|
|
2823
3234
|
['application/json'],
|
|
2824
|
-
['application/json']
|
|
3235
|
+
['application/json'],
|
|
3236
|
+
opts['customHeaders']
|
|
2825
3237
|
);
|
|
2826
3238
|
}
|
|
2827
3239
|
|
|
2828
3240
|
/**
|
|
2829
3241
|
* Get the Dialer wrap up code mapping.
|
|
2830
3242
|
*
|
|
3243
|
+
* @param {Object} opts Optional parameters
|
|
3244
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2831
3245
|
*/
|
|
2832
|
-
getOutboundWrapupcodemappings() {
|
|
3246
|
+
getOutboundWrapupcodemappings(opts) {
|
|
3247
|
+
opts = opts || {};
|
|
3248
|
+
|
|
2833
3249
|
|
|
2834
3250
|
return this.apiClient.callApi(
|
|
2835
3251
|
'/api/v2/outbound/wrapupcodemappings',
|
|
@@ -2841,7 +3257,8 @@ class OutboundApi {
|
|
|
2841
3257
|
null,
|
|
2842
3258
|
['PureCloud OAuth'],
|
|
2843
3259
|
['application/json'],
|
|
2844
|
-
['application/json']
|
|
3260
|
+
['application/json'],
|
|
3261
|
+
opts['customHeaders']
|
|
2845
3262
|
);
|
|
2846
3263
|
}
|
|
2847
3264
|
|
|
@@ -2850,8 +3267,12 @@ class OutboundApi {
|
|
|
2850
3267
|
*
|
|
2851
3268
|
* @param {String} campaignId Campaign ID
|
|
2852
3269
|
* @param {Object} body CampaignPatchRequest
|
|
3270
|
+
* @param {Object} opts Optional parameters
|
|
3271
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2853
3272
|
*/
|
|
2854
|
-
patchOutboundCampaign(campaignId, body) {
|
|
3273
|
+
patchOutboundCampaign(campaignId, body, opts) {
|
|
3274
|
+
opts = opts || {};
|
|
3275
|
+
|
|
2855
3276
|
// verify the required parameter 'campaignId' is set
|
|
2856
3277
|
if (campaignId === undefined || campaignId === null || campaignId === '') {
|
|
2857
3278
|
throw 'Missing the required parameter "campaignId" when calling patchOutboundCampaign';
|
|
@@ -2871,7 +3292,8 @@ class OutboundApi {
|
|
|
2871
3292
|
body,
|
|
2872
3293
|
['PureCloud OAuth'],
|
|
2873
3294
|
['application/json'],
|
|
2874
|
-
['application/json']
|
|
3295
|
+
['application/json'],
|
|
3296
|
+
opts['customHeaders']
|
|
2875
3297
|
);
|
|
2876
3298
|
}
|
|
2877
3299
|
|
|
@@ -2880,8 +3302,12 @@ class OutboundApi {
|
|
|
2880
3302
|
* Only Internal DNC lists may be deleted from
|
|
2881
3303
|
* @param {String} dncListId DncList ID
|
|
2882
3304
|
* @param {Object} body DNC Custom exclusion column entries
|
|
3305
|
+
* @param {Object} opts Optional parameters
|
|
3306
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2883
3307
|
*/
|
|
2884
|
-
patchOutboundDnclistCustomexclusioncolumns(dncListId, body) {
|
|
3308
|
+
patchOutboundDnclistCustomexclusioncolumns(dncListId, body, opts) {
|
|
3309
|
+
opts = opts || {};
|
|
3310
|
+
|
|
2885
3311
|
// verify the required parameter 'dncListId' is set
|
|
2886
3312
|
if (dncListId === undefined || dncListId === null || dncListId === '') {
|
|
2887
3313
|
throw 'Missing the required parameter "dncListId" when calling patchOutboundDnclistCustomexclusioncolumns';
|
|
@@ -2901,7 +3327,8 @@ class OutboundApi {
|
|
|
2901
3327
|
body,
|
|
2902
3328
|
['PureCloud OAuth'],
|
|
2903
3329
|
['application/json'],
|
|
2904
|
-
['application/json']
|
|
3330
|
+
['application/json'],
|
|
3331
|
+
opts['customHeaders']
|
|
2905
3332
|
);
|
|
2906
3333
|
}
|
|
2907
3334
|
|
|
@@ -2910,8 +3337,12 @@ class OutboundApi {
|
|
|
2910
3337
|
* Only Internal DNC lists may be added to or deleted from
|
|
2911
3338
|
* @param {String} dncListId DncList ID
|
|
2912
3339
|
* @param {Object} body DNC Emails
|
|
3340
|
+
* @param {Object} opts Optional parameters
|
|
3341
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2913
3342
|
*/
|
|
2914
|
-
patchOutboundDnclistEmailaddresses(dncListId, body) {
|
|
3343
|
+
patchOutboundDnclistEmailaddresses(dncListId, body, opts) {
|
|
3344
|
+
opts = opts || {};
|
|
3345
|
+
|
|
2915
3346
|
// verify the required parameter 'dncListId' is set
|
|
2916
3347
|
if (dncListId === undefined || dncListId === null || dncListId === '') {
|
|
2917
3348
|
throw 'Missing the required parameter "dncListId" when calling patchOutboundDnclistEmailaddresses';
|
|
@@ -2931,7 +3362,8 @@ class OutboundApi {
|
|
|
2931
3362
|
body,
|
|
2932
3363
|
['PureCloud OAuth'],
|
|
2933
3364
|
['application/json'],
|
|
2934
|
-
['application/json']
|
|
3365
|
+
['application/json'],
|
|
3366
|
+
opts['customHeaders']
|
|
2935
3367
|
);
|
|
2936
3368
|
}
|
|
2937
3369
|
|
|
@@ -2940,8 +3372,12 @@ class OutboundApi {
|
|
|
2940
3372
|
* Only Internal DNC lists may be added to deleted from
|
|
2941
3373
|
* @param {String} dncListId DncList ID
|
|
2942
3374
|
* @param {Object} body DNC Phone Numbers
|
|
3375
|
+
* @param {Object} opts Optional parameters
|
|
3376
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2943
3377
|
*/
|
|
2944
|
-
patchOutboundDnclistPhonenumbers(dncListId, body) {
|
|
3378
|
+
patchOutboundDnclistPhonenumbers(dncListId, body, opts) {
|
|
3379
|
+
opts = opts || {};
|
|
3380
|
+
|
|
2945
3381
|
// verify the required parameter 'dncListId' is set
|
|
2946
3382
|
if (dncListId === undefined || dncListId === null || dncListId === '') {
|
|
2947
3383
|
throw 'Missing the required parameter "dncListId" when calling patchOutboundDnclistPhonenumbers';
|
|
@@ -2961,7 +3397,8 @@ class OutboundApi {
|
|
|
2961
3397
|
body,
|
|
2962
3398
|
['PureCloud OAuth'],
|
|
2963
3399
|
['application/json'],
|
|
2964
|
-
['application/json']
|
|
3400
|
+
['application/json'],
|
|
3401
|
+
opts['customHeaders']
|
|
2965
3402
|
);
|
|
2966
3403
|
}
|
|
2967
3404
|
|
|
@@ -2970,8 +3407,12 @@ class OutboundApi {
|
|
|
2970
3407
|
* Only Internal DNC lists may be deleted from
|
|
2971
3408
|
* @param {String} dncListId DncList ID
|
|
2972
3409
|
* @param {Object} body DNC whatsApp numbers
|
|
3410
|
+
* @param {Object} opts Optional parameters
|
|
3411
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2973
3412
|
*/
|
|
2974
|
-
patchOutboundDnclistWhatsappnumbers(dncListId, body) {
|
|
3413
|
+
patchOutboundDnclistWhatsappnumbers(dncListId, body, opts) {
|
|
3414
|
+
opts = opts || {};
|
|
3415
|
+
|
|
2975
3416
|
// verify the required parameter 'dncListId' is set
|
|
2976
3417
|
if (dncListId === undefined || dncListId === null || dncListId === '') {
|
|
2977
3418
|
throw 'Missing the required parameter "dncListId" when calling patchOutboundDnclistWhatsappnumbers';
|
|
@@ -2991,7 +3432,8 @@ class OutboundApi {
|
|
|
2991
3432
|
body,
|
|
2992
3433
|
['PureCloud OAuth'],
|
|
2993
3434
|
['application/json'],
|
|
2994
|
-
['application/json']
|
|
3435
|
+
['application/json'],
|
|
3436
|
+
opts['customHeaders']
|
|
2995
3437
|
);
|
|
2996
3438
|
}
|
|
2997
3439
|
|
|
@@ -3001,6 +3443,7 @@ class OutboundApi {
|
|
|
3001
3443
|
* @param {Object} body outboundSettings
|
|
3002
3444
|
* @param {Object} opts Optional parameters
|
|
3003
3445
|
* @param {Object} opts.useMaxCallsPerAgentDecimal Use maxCallsPerAgent with decimal precision
|
|
3446
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3004
3447
|
*/
|
|
3005
3448
|
patchOutboundSettings(body, opts) {
|
|
3006
3449
|
opts = opts || {};
|
|
@@ -3020,7 +3463,8 @@ class OutboundApi {
|
|
|
3020
3463
|
body,
|
|
3021
3464
|
['PureCloud OAuth'],
|
|
3022
3465
|
['application/json'],
|
|
3023
|
-
['application/json']
|
|
3466
|
+
['application/json'],
|
|
3467
|
+
opts['customHeaders']
|
|
3024
3468
|
);
|
|
3025
3469
|
}
|
|
3026
3470
|
|
|
@@ -3028,8 +3472,12 @@ class OutboundApi {
|
|
|
3028
3472
|
* Create attempt limits
|
|
3029
3473
|
*
|
|
3030
3474
|
* @param {Object} body AttemptLimits
|
|
3475
|
+
* @param {Object} opts Optional parameters
|
|
3476
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3031
3477
|
*/
|
|
3032
|
-
postOutboundAttemptlimits(body) {
|
|
3478
|
+
postOutboundAttemptlimits(body, opts) {
|
|
3479
|
+
opts = opts || {};
|
|
3480
|
+
|
|
3033
3481
|
// verify the required parameter 'body' is set
|
|
3034
3482
|
if (body === undefined || body === null) {
|
|
3035
3483
|
throw 'Missing the required parameter "body" when calling postOutboundAttemptlimits';
|
|
@@ -3045,7 +3493,8 @@ class OutboundApi {
|
|
|
3045
3493
|
body,
|
|
3046
3494
|
['PureCloud OAuth'],
|
|
3047
3495
|
['application/json'],
|
|
3048
|
-
['application/json']
|
|
3496
|
+
['application/json'],
|
|
3497
|
+
opts['customHeaders']
|
|
3049
3498
|
);
|
|
3050
3499
|
}
|
|
3051
3500
|
|
|
@@ -3053,8 +3502,12 @@ class OutboundApi {
|
|
|
3053
3502
|
* Create callable time set
|
|
3054
3503
|
*
|
|
3055
3504
|
* @param {Object} body DialerCallableTimeSet
|
|
3505
|
+
* @param {Object} opts Optional parameters
|
|
3506
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3056
3507
|
*/
|
|
3057
|
-
postOutboundCallabletimesets(body) {
|
|
3508
|
+
postOutboundCallabletimesets(body, opts) {
|
|
3509
|
+
opts = opts || {};
|
|
3510
|
+
|
|
3058
3511
|
// verify the required parameter 'body' is set
|
|
3059
3512
|
if (body === undefined || body === null) {
|
|
3060
3513
|
throw 'Missing the required parameter "body" when calling postOutboundCallabletimesets';
|
|
@@ -3070,7 +3523,8 @@ class OutboundApi {
|
|
|
3070
3523
|
body,
|
|
3071
3524
|
['PureCloud OAuth'],
|
|
3072
3525
|
['application/json'],
|
|
3073
|
-
['application/json']
|
|
3526
|
+
['application/json'],
|
|
3527
|
+
opts['customHeaders']
|
|
3074
3528
|
);
|
|
3075
3529
|
}
|
|
3076
3530
|
|
|
@@ -3078,8 +3532,12 @@ class OutboundApi {
|
|
|
3078
3532
|
* Create a dialer call analysis response set.
|
|
3079
3533
|
*
|
|
3080
3534
|
* @param {Object} body ResponseSet
|
|
3535
|
+
* @param {Object} opts Optional parameters
|
|
3536
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3081
3537
|
*/
|
|
3082
|
-
postOutboundCallanalysisresponsesets(body) {
|
|
3538
|
+
postOutboundCallanalysisresponsesets(body, opts) {
|
|
3539
|
+
opts = opts || {};
|
|
3540
|
+
|
|
3083
3541
|
// verify the required parameter 'body' is set
|
|
3084
3542
|
if (body === undefined || body === null) {
|
|
3085
3543
|
throw 'Missing the required parameter "body" when calling postOutboundCallanalysisresponsesets';
|
|
@@ -3095,7 +3553,8 @@ class OutboundApi {
|
|
|
3095
3553
|
body,
|
|
3096
3554
|
['PureCloud OAuth'],
|
|
3097
3555
|
['application/json'],
|
|
3098
|
-
['application/json']
|
|
3556
|
+
['application/json'],
|
|
3557
|
+
opts['customHeaders']
|
|
3099
3558
|
);
|
|
3100
3559
|
}
|
|
3101
3560
|
|
|
@@ -3103,8 +3562,12 @@ class OutboundApi {
|
|
|
3103
3562
|
* Initiate request for a preview of how agents will be mapped to this campaign's contact list.
|
|
3104
3563
|
*
|
|
3105
3564
|
* @param {String} campaignId Campaign ID
|
|
3565
|
+
* @param {Object} opts Optional parameters
|
|
3566
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3106
3567
|
*/
|
|
3107
|
-
postOutboundCampaignAgentownedmappingpreview(campaignId) {
|
|
3568
|
+
postOutboundCampaignAgentownedmappingpreview(campaignId, opts) {
|
|
3569
|
+
opts = opts || {};
|
|
3570
|
+
|
|
3108
3571
|
// verify the required parameter 'campaignId' is set
|
|
3109
3572
|
if (campaignId === undefined || campaignId === null || campaignId === '') {
|
|
3110
3573
|
throw 'Missing the required parameter "campaignId" when calling postOutboundCampaignAgentownedmappingpreview';
|
|
@@ -3120,7 +3583,8 @@ class OutboundApi {
|
|
|
3120
3583
|
null,
|
|
3121
3584
|
['PureCloud OAuth'],
|
|
3122
3585
|
['application/json'],
|
|
3123
|
-
['application/json']
|
|
3586
|
+
['application/json'],
|
|
3587
|
+
opts['customHeaders']
|
|
3124
3588
|
);
|
|
3125
3589
|
}
|
|
3126
3590
|
|
|
@@ -3129,9 +3593,13 @@ class OutboundApi {
|
|
|
3129
3593
|
* This endpoint is deprecated and may have unexpected results. Please use "/conversations/{conversationId}/participants/{participantId}/callbacks instead."
|
|
3130
3594
|
* @param {String} campaignId Campaign ID
|
|
3131
3595
|
* @param {Object} body ContactCallbackRequest
|
|
3596
|
+
* @param {Object} opts Optional parameters
|
|
3597
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3132
3598
|
* @deprecated
|
|
3133
3599
|
*/
|
|
3134
|
-
postOutboundCampaignCallbackSchedule(campaignId, body) {
|
|
3600
|
+
postOutboundCampaignCallbackSchedule(campaignId, body, opts) {
|
|
3601
|
+
opts = opts || {};
|
|
3602
|
+
|
|
3135
3603
|
// verify the required parameter 'campaignId' is set
|
|
3136
3604
|
if (campaignId === undefined || campaignId === null || campaignId === '') {
|
|
3137
3605
|
throw 'Missing the required parameter "campaignId" when calling postOutboundCampaignCallbackSchedule';
|
|
@@ -3151,7 +3619,8 @@ class OutboundApi {
|
|
|
3151
3619
|
body,
|
|
3152
3620
|
['PureCloud OAuth'],
|
|
3153
3621
|
['application/json'],
|
|
3154
|
-
['application/json']
|
|
3622
|
+
['application/json'],
|
|
3623
|
+
opts['customHeaders']
|
|
3155
3624
|
);
|
|
3156
3625
|
}
|
|
3157
3626
|
|
|
@@ -3159,8 +3628,12 @@ class OutboundApi {
|
|
|
3159
3628
|
* Start the campaign
|
|
3160
3629
|
*
|
|
3161
3630
|
* @param {String} campaignId Campaign ID
|
|
3631
|
+
* @param {Object} opts Optional parameters
|
|
3632
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3162
3633
|
*/
|
|
3163
|
-
postOutboundCampaignStart(campaignId) {
|
|
3634
|
+
postOutboundCampaignStart(campaignId, opts) {
|
|
3635
|
+
opts = opts || {};
|
|
3636
|
+
|
|
3164
3637
|
// verify the required parameter 'campaignId' is set
|
|
3165
3638
|
if (campaignId === undefined || campaignId === null || campaignId === '') {
|
|
3166
3639
|
throw 'Missing the required parameter "campaignId" when calling postOutboundCampaignStart';
|
|
@@ -3176,7 +3649,8 @@ class OutboundApi {
|
|
|
3176
3649
|
null,
|
|
3177
3650
|
['PureCloud OAuth'],
|
|
3178
3651
|
['application/json'],
|
|
3179
|
-
['application/json']
|
|
3652
|
+
['application/json'],
|
|
3653
|
+
opts['customHeaders']
|
|
3180
3654
|
);
|
|
3181
3655
|
}
|
|
3182
3656
|
|
|
@@ -3184,8 +3658,12 @@ class OutboundApi {
|
|
|
3184
3658
|
* Stop the campaign
|
|
3185
3659
|
*
|
|
3186
3660
|
* @param {String} campaignId Campaign ID
|
|
3661
|
+
* @param {Object} opts Optional parameters
|
|
3662
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3187
3663
|
*/
|
|
3188
|
-
postOutboundCampaignStop(campaignId) {
|
|
3664
|
+
postOutboundCampaignStop(campaignId, opts) {
|
|
3665
|
+
opts = opts || {};
|
|
3666
|
+
|
|
3189
3667
|
// verify the required parameter 'campaignId' is set
|
|
3190
3668
|
if (campaignId === undefined || campaignId === null || campaignId === '') {
|
|
3191
3669
|
throw 'Missing the required parameter "campaignId" when calling postOutboundCampaignStop';
|
|
@@ -3201,7 +3679,8 @@ class OutboundApi {
|
|
|
3201
3679
|
null,
|
|
3202
3680
|
['PureCloud OAuth'],
|
|
3203
3681
|
['application/json'],
|
|
3204
|
-
['application/json']
|
|
3682
|
+
['application/json'],
|
|
3683
|
+
opts['customHeaders']
|
|
3205
3684
|
);
|
|
3206
3685
|
}
|
|
3207
3686
|
|
|
@@ -3209,8 +3688,12 @@ class OutboundApi {
|
|
|
3209
3688
|
* Create Campaign Rule
|
|
3210
3689
|
*
|
|
3211
3690
|
* @param {Object} body CampaignRule
|
|
3691
|
+
* @param {Object} opts Optional parameters
|
|
3692
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3212
3693
|
*/
|
|
3213
|
-
postOutboundCampaignrules(body) {
|
|
3694
|
+
postOutboundCampaignrules(body, opts) {
|
|
3695
|
+
opts = opts || {};
|
|
3696
|
+
|
|
3214
3697
|
// verify the required parameter 'body' is set
|
|
3215
3698
|
if (body === undefined || body === null) {
|
|
3216
3699
|
throw 'Missing the required parameter "body" when calling postOutboundCampaignrules';
|
|
@@ -3226,7 +3709,8 @@ class OutboundApi {
|
|
|
3226
3709
|
body,
|
|
3227
3710
|
['PureCloud OAuth'],
|
|
3228
3711
|
['application/json'],
|
|
3229
|
-
['application/json']
|
|
3712
|
+
['application/json'],
|
|
3713
|
+
opts['customHeaders']
|
|
3230
3714
|
);
|
|
3231
3715
|
}
|
|
3232
3716
|
|
|
@@ -3236,6 +3720,7 @@ class OutboundApi {
|
|
|
3236
3720
|
* @param {Object} body Campaign
|
|
3237
3721
|
* @param {Object} opts Optional parameters
|
|
3238
3722
|
* @param {Object} opts.useMaxCallsPerAgentDecimal Use maxCallsPerAgent with decimal precision
|
|
3723
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3239
3724
|
*/
|
|
3240
3725
|
postOutboundCampaigns(body, opts) {
|
|
3241
3726
|
opts = opts || {};
|
|
@@ -3255,7 +3740,8 @@ class OutboundApi {
|
|
|
3255
3740
|
body,
|
|
3256
3741
|
['PureCloud OAuth'],
|
|
3257
3742
|
['application/json'],
|
|
3258
|
-
['application/json']
|
|
3743
|
+
['application/json'],
|
|
3744
|
+
opts['customHeaders']
|
|
3259
3745
|
);
|
|
3260
3746
|
}
|
|
3261
3747
|
|
|
@@ -3263,8 +3749,12 @@ class OutboundApi {
|
|
|
3263
3749
|
* Get performance data for a list of campaigns
|
|
3264
3750
|
*
|
|
3265
3751
|
* @param {Array.<String>} body Campaign IDs. Maximum of 50 IDs allowed.
|
|
3752
|
+
* @param {Object} opts Optional parameters
|
|
3753
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3266
3754
|
*/
|
|
3267
|
-
postOutboundCampaignsPerformanceQuery(body) {
|
|
3755
|
+
postOutboundCampaignsPerformanceQuery(body, opts) {
|
|
3756
|
+
opts = opts || {};
|
|
3757
|
+
|
|
3268
3758
|
// verify the required parameter 'body' is set
|
|
3269
3759
|
if (body === undefined || body === null) {
|
|
3270
3760
|
throw 'Missing the required parameter "body" when calling postOutboundCampaignsPerformanceQuery';
|
|
@@ -3280,7 +3770,8 @@ class OutboundApi {
|
|
|
3280
3770
|
body,
|
|
3281
3771
|
['PureCloud OAuth'],
|
|
3282
3772
|
['application/json'],
|
|
3283
|
-
['application/json']
|
|
3773
|
+
['application/json'],
|
|
3774
|
+
opts['customHeaders']
|
|
3284
3775
|
);
|
|
3285
3776
|
}
|
|
3286
3777
|
|
|
@@ -3288,8 +3779,12 @@ class OutboundApi {
|
|
|
3288
3779
|
* Get progress for a list of campaigns
|
|
3289
3780
|
*
|
|
3290
3781
|
* @param {Array.<String>} body Campaign IDs
|
|
3782
|
+
* @param {Object} opts Optional parameters
|
|
3783
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3291
3784
|
*/
|
|
3292
|
-
postOutboundCampaignsProgress(body) {
|
|
3785
|
+
postOutboundCampaignsProgress(body, opts) {
|
|
3786
|
+
opts = opts || {};
|
|
3787
|
+
|
|
3293
3788
|
// verify the required parameter 'body' is set
|
|
3294
3789
|
if (body === undefined || body === null) {
|
|
3295
3790
|
throw 'Missing the required parameter "body" when calling postOutboundCampaignsProgress';
|
|
@@ -3305,7 +3800,8 @@ class OutboundApi {
|
|
|
3305
3800
|
body,
|
|
3306
3801
|
['PureCloud OAuth'],
|
|
3307
3802
|
['application/json'],
|
|
3308
|
-
['application/json']
|
|
3803
|
+
['application/json'],
|
|
3804
|
+
opts['customHeaders']
|
|
3309
3805
|
);
|
|
3310
3806
|
}
|
|
3311
3807
|
|
|
@@ -3313,8 +3809,12 @@ class OutboundApi {
|
|
|
3313
3809
|
* Deletes all contacts out of a list. All outstanding recalls or rule-scheduled callbacks for non-preview campaigns configured with the contactlist will be cancelled.
|
|
3314
3810
|
*
|
|
3315
3811
|
* @param {String} contactListId Contact List ID
|
|
3812
|
+
* @param {Object} opts Optional parameters
|
|
3813
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3316
3814
|
*/
|
|
3317
|
-
postOutboundContactlistClear(contactListId) {
|
|
3815
|
+
postOutboundContactlistClear(contactListId, opts) {
|
|
3816
|
+
opts = opts || {};
|
|
3817
|
+
|
|
3318
3818
|
// verify the required parameter 'contactListId' is set
|
|
3319
3819
|
if (contactListId === undefined || contactListId === null || contactListId === '') {
|
|
3320
3820
|
throw 'Missing the required parameter "contactListId" when calling postOutboundContactlistClear';
|
|
@@ -3330,7 +3830,8 @@ class OutboundApi {
|
|
|
3330
3830
|
null,
|
|
3331
3831
|
['PureCloud OAuth'],
|
|
3332
3832
|
['application/json'],
|
|
3333
|
-
['application/json']
|
|
3833
|
+
['application/json'],
|
|
3834
|
+
opts['customHeaders']
|
|
3334
3835
|
);
|
|
3335
3836
|
}
|
|
3336
3837
|
|
|
@@ -3343,6 +3844,7 @@ class OutboundApi {
|
|
|
3343
3844
|
* @param {Boolean} opts.priority Contact priority. True means the contact(s) will be dialed next; false means the contact will go to the end of the contact queue.
|
|
3344
3845
|
* @param {Boolean} opts.clearSystemData Clear system data. True means the system columns (attempts, callable status, etc) stored on the contact will be cleared if the contact already exists; false means they won't.
|
|
3345
3846
|
* @param {Boolean} opts.doNotQueue Do not queue. True means that updated contacts will not have their positions in the queue altered, so contacts that have already been dialed will not be redialed. For new contacts, this parameter has no effect; False means that updated contacts will be re-queued, according to the 'priority' parameter.
|
|
3847
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3346
3848
|
*/
|
|
3347
3849
|
postOutboundContactlistContacts(contactListId, body, opts) {
|
|
3348
3850
|
opts = opts || {};
|
|
@@ -3366,7 +3868,8 @@ class OutboundApi {
|
|
|
3366
3868
|
body,
|
|
3367
3869
|
['PureCloud OAuth'],
|
|
3368
3870
|
['application/json'],
|
|
3369
|
-
['application/json']
|
|
3871
|
+
['application/json'],
|
|
3872
|
+
opts['customHeaders']
|
|
3370
3873
|
);
|
|
3371
3874
|
}
|
|
3372
3875
|
|
|
@@ -3375,8 +3878,12 @@ class OutboundApi {
|
|
|
3375
3878
|
*
|
|
3376
3879
|
* @param {String} contactListId Contact List ID
|
|
3377
3880
|
* @param {Array.<String>} body ContactIds to get.
|
|
3881
|
+
* @param {Object} opts Optional parameters
|
|
3882
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3378
3883
|
*/
|
|
3379
|
-
postOutboundContactlistContactsBulk(contactListId, body) {
|
|
3884
|
+
postOutboundContactlistContactsBulk(contactListId, body, opts) {
|
|
3885
|
+
opts = opts || {};
|
|
3886
|
+
|
|
3380
3887
|
// verify the required parameter 'contactListId' is set
|
|
3381
3888
|
if (contactListId === undefined || contactListId === null || contactListId === '') {
|
|
3382
3889
|
throw 'Missing the required parameter "contactListId" when calling postOutboundContactlistContactsBulk';
|
|
@@ -3396,7 +3903,8 @@ class OutboundApi {
|
|
|
3396
3903
|
body,
|
|
3397
3904
|
['PureCloud OAuth'],
|
|
3398
3905
|
['application/json'],
|
|
3399
|
-
['application/json']
|
|
3906
|
+
['application/json'],
|
|
3907
|
+
opts['customHeaders']
|
|
3400
3908
|
);
|
|
3401
3909
|
}
|
|
3402
3910
|
|
|
@@ -3405,8 +3913,12 @@ class OutboundApi {
|
|
|
3405
3913
|
*
|
|
3406
3914
|
* @param {String} contactListId Contact List ID
|
|
3407
3915
|
* @param {Object} body Contact filter information.
|
|
3916
|
+
* @param {Object} opts Optional parameters
|
|
3917
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3408
3918
|
*/
|
|
3409
|
-
postOutboundContactlistContactsBulkRemove(contactListId, body) {
|
|
3919
|
+
postOutboundContactlistContactsBulkRemove(contactListId, body, opts) {
|
|
3920
|
+
opts = opts || {};
|
|
3921
|
+
|
|
3410
3922
|
// verify the required parameter 'contactListId' is set
|
|
3411
3923
|
if (contactListId === undefined || contactListId === null || contactListId === '') {
|
|
3412
3924
|
throw 'Missing the required parameter "contactListId" when calling postOutboundContactlistContactsBulkRemove';
|
|
@@ -3426,7 +3938,8 @@ class OutboundApi {
|
|
|
3426
3938
|
body,
|
|
3427
3939
|
['PureCloud OAuth'],
|
|
3428
3940
|
['application/json'],
|
|
3429
|
-
['application/json']
|
|
3941
|
+
['application/json'],
|
|
3942
|
+
opts['customHeaders']
|
|
3430
3943
|
);
|
|
3431
3944
|
}
|
|
3432
3945
|
|
|
@@ -3435,8 +3948,12 @@ class OutboundApi {
|
|
|
3435
3948
|
*
|
|
3436
3949
|
* @param {String} contactListId Contact List ID
|
|
3437
3950
|
* @param {Object} body Contact bulk edit request information.
|
|
3951
|
+
* @param {Object} opts Optional parameters
|
|
3952
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3438
3953
|
*/
|
|
3439
|
-
postOutboundContactlistContactsBulkUpdate(contactListId, body) {
|
|
3954
|
+
postOutboundContactlistContactsBulkUpdate(contactListId, body, opts) {
|
|
3955
|
+
opts = opts || {};
|
|
3956
|
+
|
|
3440
3957
|
// verify the required parameter 'contactListId' is set
|
|
3441
3958
|
if (contactListId === undefined || contactListId === null || contactListId === '') {
|
|
3442
3959
|
throw 'Missing the required parameter "contactListId" when calling postOutboundContactlistContactsBulkUpdate';
|
|
@@ -3456,7 +3973,8 @@ class OutboundApi {
|
|
|
3456
3973
|
body,
|
|
3457
3974
|
['PureCloud OAuth'],
|
|
3458
3975
|
['application/json'],
|
|
3459
|
-
['application/json']
|
|
3976
|
+
['application/json'],
|
|
3977
|
+
opts['customHeaders']
|
|
3460
3978
|
);
|
|
3461
3979
|
}
|
|
3462
3980
|
|
|
@@ -3465,8 +3983,12 @@ class OutboundApi {
|
|
|
3465
3983
|
*
|
|
3466
3984
|
* @param {String} contactListId Contact List ID
|
|
3467
3985
|
* @param {Object} body Contact search parameters.
|
|
3986
|
+
* @param {Object} opts Optional parameters
|
|
3987
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3468
3988
|
*/
|
|
3469
|
-
postOutboundContactlistContactsSearch(contactListId, body) {
|
|
3989
|
+
postOutboundContactlistContactsSearch(contactListId, body, opts) {
|
|
3990
|
+
opts = opts || {};
|
|
3991
|
+
|
|
3470
3992
|
// verify the required parameter 'contactListId' is set
|
|
3471
3993
|
if (contactListId === undefined || contactListId === null || contactListId === '') {
|
|
3472
3994
|
throw 'Missing the required parameter "contactListId" when calling postOutboundContactlistContactsSearch';
|
|
@@ -3486,7 +4008,8 @@ class OutboundApi {
|
|
|
3486
4008
|
body,
|
|
3487
4009
|
['PureCloud OAuth'],
|
|
3488
4010
|
['application/json'],
|
|
3489
|
-
['application/json']
|
|
4011
|
+
['application/json'],
|
|
4012
|
+
opts['customHeaders']
|
|
3490
4013
|
);
|
|
3491
4014
|
}
|
|
3492
4015
|
|
|
@@ -3496,6 +4019,7 @@ class OutboundApi {
|
|
|
3496
4019
|
* @param {String} contactListId ContactList ID
|
|
3497
4020
|
* @param {Object} opts Optional parameters
|
|
3498
4021
|
* @param {Object} opts.body Export information to get
|
|
4022
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3499
4023
|
*/
|
|
3500
4024
|
postOutboundContactlistExport(contactListId, opts) {
|
|
3501
4025
|
opts = opts || {};
|
|
@@ -3515,7 +4039,8 @@ class OutboundApi {
|
|
|
3515
4039
|
opts['body'],
|
|
3516
4040
|
['PureCloud OAuth'],
|
|
3517
4041
|
['application/json'],
|
|
3518
|
-
['application/json']
|
|
4042
|
+
['application/json'],
|
|
4043
|
+
opts['customHeaders']
|
|
3519
4044
|
);
|
|
3520
4045
|
}
|
|
3521
4046
|
|
|
@@ -3523,8 +4048,12 @@ class OutboundApi {
|
|
|
3523
4048
|
* Create Contact List Filter
|
|
3524
4049
|
*
|
|
3525
4050
|
* @param {Object} body ContactListFilter
|
|
4051
|
+
* @param {Object} opts Optional parameters
|
|
4052
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3526
4053
|
*/
|
|
3527
|
-
postOutboundContactlistfilters(body) {
|
|
4054
|
+
postOutboundContactlistfilters(body, opts) {
|
|
4055
|
+
opts = opts || {};
|
|
4056
|
+
|
|
3528
4057
|
// verify the required parameter 'body' is set
|
|
3529
4058
|
if (body === undefined || body === null) {
|
|
3530
4059
|
throw 'Missing the required parameter "body" when calling postOutboundContactlistfilters';
|
|
@@ -3540,7 +4069,8 @@ class OutboundApi {
|
|
|
3540
4069
|
body,
|
|
3541
4070
|
['PureCloud OAuth'],
|
|
3542
4071
|
['application/json'],
|
|
3543
|
-
['application/json']
|
|
4072
|
+
['application/json'],
|
|
4073
|
+
opts['customHeaders']
|
|
3544
4074
|
);
|
|
3545
4075
|
}
|
|
3546
4076
|
|
|
@@ -3548,8 +4078,12 @@ class OutboundApi {
|
|
|
3548
4078
|
* Retrieve multiple contact list filters
|
|
3549
4079
|
*
|
|
3550
4080
|
* @param {Object} body The contact list filters to retrieve
|
|
4081
|
+
* @param {Object} opts Optional parameters
|
|
4082
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3551
4083
|
*/
|
|
3552
|
-
postOutboundContactlistfiltersBulkRetrieve(body) {
|
|
4084
|
+
postOutboundContactlistfiltersBulkRetrieve(body, opts) {
|
|
4085
|
+
opts = opts || {};
|
|
4086
|
+
|
|
3553
4087
|
// verify the required parameter 'body' is set
|
|
3554
4088
|
if (body === undefined || body === null) {
|
|
3555
4089
|
throw 'Missing the required parameter "body" when calling postOutboundContactlistfiltersBulkRetrieve';
|
|
@@ -3565,7 +4099,8 @@ class OutboundApi {
|
|
|
3565
4099
|
body,
|
|
3566
4100
|
['PureCloud OAuth'],
|
|
3567
4101
|
['application/json'],
|
|
3568
|
-
['application/json']
|
|
4102
|
+
['application/json'],
|
|
4103
|
+
opts['customHeaders']
|
|
3569
4104
|
);
|
|
3570
4105
|
}
|
|
3571
4106
|
|
|
@@ -3573,8 +4108,12 @@ class OutboundApi {
|
|
|
3573
4108
|
* Get a preview of the output of a contact list filter
|
|
3574
4109
|
*
|
|
3575
4110
|
* @param {Object} body ContactListFilter
|
|
4111
|
+
* @param {Object} opts Optional parameters
|
|
4112
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3576
4113
|
*/
|
|
3577
|
-
postOutboundContactlistfiltersPreview(body) {
|
|
4114
|
+
postOutboundContactlistfiltersPreview(body, opts) {
|
|
4115
|
+
opts = opts || {};
|
|
4116
|
+
|
|
3578
4117
|
// verify the required parameter 'body' is set
|
|
3579
4118
|
if (body === undefined || body === null) {
|
|
3580
4119
|
throw 'Missing the required parameter "body" when calling postOutboundContactlistfiltersPreview';
|
|
@@ -3590,7 +4129,8 @@ class OutboundApi {
|
|
|
3590
4129
|
body,
|
|
3591
4130
|
['PureCloud OAuth'],
|
|
3592
4131
|
['application/json'],
|
|
3593
|
-
['application/json']
|
|
4132
|
+
['application/json'],
|
|
4133
|
+
opts['customHeaders']
|
|
3594
4134
|
);
|
|
3595
4135
|
}
|
|
3596
4136
|
|
|
@@ -3598,8 +4138,12 @@ class OutboundApi {
|
|
|
3598
4138
|
* Create a contact List.
|
|
3599
4139
|
*
|
|
3600
4140
|
* @param {Object} body ContactList
|
|
4141
|
+
* @param {Object} opts Optional parameters
|
|
4142
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3601
4143
|
*/
|
|
3602
|
-
postOutboundContactlists(body) {
|
|
4144
|
+
postOutboundContactlists(body, opts) {
|
|
4145
|
+
opts = opts || {};
|
|
4146
|
+
|
|
3603
4147
|
// verify the required parameter 'body' is set
|
|
3604
4148
|
if (body === undefined || body === null) {
|
|
3605
4149
|
throw 'Missing the required parameter "body" when calling postOutboundContactlists';
|
|
@@ -3615,7 +4159,8 @@ class OutboundApi {
|
|
|
3615
4159
|
body,
|
|
3616
4160
|
['PureCloud OAuth'],
|
|
3617
4161
|
['application/json'],
|
|
3618
|
-
['application/json']
|
|
4162
|
+
['application/json'],
|
|
4163
|
+
opts['customHeaders']
|
|
3619
4164
|
);
|
|
3620
4165
|
}
|
|
3621
4166
|
|
|
@@ -3623,8 +4168,12 @@ class OutboundApi {
|
|
|
3623
4168
|
* Generate presigned upload URL for contact list.
|
|
3624
4169
|
*
|
|
3625
4170
|
* @param {Object} body contactListUploadUrlRequest
|
|
4171
|
+
* @param {Object} opts Optional parameters
|
|
4172
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3626
4173
|
*/
|
|
3627
|
-
postOutboundContactlistsUploads(body) {
|
|
4174
|
+
postOutboundContactlistsUploads(body, opts) {
|
|
4175
|
+
opts = opts || {};
|
|
4176
|
+
|
|
3628
4177
|
// verify the required parameter 'body' is set
|
|
3629
4178
|
if (body === undefined || body === null) {
|
|
3630
4179
|
throw 'Missing the required parameter "body" when calling postOutboundContactlistsUploads';
|
|
@@ -3640,7 +4189,8 @@ class OutboundApi {
|
|
|
3640
4189
|
body,
|
|
3641
4190
|
['PureCloud OAuth'],
|
|
3642
4191
|
['application/json'],
|
|
3643
|
-
['application/json']
|
|
4192
|
+
['application/json'],
|
|
4193
|
+
opts['customHeaders']
|
|
3644
4194
|
);
|
|
3645
4195
|
}
|
|
3646
4196
|
|
|
@@ -3648,8 +4198,12 @@ class OutboundApi {
|
|
|
3648
4198
|
* Create Contact List Template
|
|
3649
4199
|
*
|
|
3650
4200
|
* @param {Object} body ContactListTemplate
|
|
4201
|
+
* @param {Object} opts Optional parameters
|
|
4202
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3651
4203
|
*/
|
|
3652
|
-
postOutboundContactlisttemplates(body) {
|
|
4204
|
+
postOutboundContactlisttemplates(body, opts) {
|
|
4205
|
+
opts = opts || {};
|
|
4206
|
+
|
|
3653
4207
|
// verify the required parameter 'body' is set
|
|
3654
4208
|
if (body === undefined || body === null) {
|
|
3655
4209
|
throw 'Missing the required parameter "body" when calling postOutboundContactlisttemplates';
|
|
@@ -3665,7 +4219,8 @@ class OutboundApi {
|
|
|
3665
4219
|
body,
|
|
3666
4220
|
['PureCloud OAuth'],
|
|
3667
4221
|
['application/json'],
|
|
3668
|
-
['application/json']
|
|
4222
|
+
['application/json'],
|
|
4223
|
+
opts['customHeaders']
|
|
3669
4224
|
);
|
|
3670
4225
|
}
|
|
3671
4226
|
|
|
@@ -3673,8 +4228,12 @@ class OutboundApi {
|
|
|
3673
4228
|
* Add multiple contact list templates
|
|
3674
4229
|
*
|
|
3675
4230
|
* @param {Array.<Object>} body contact list template(s) to add
|
|
4231
|
+
* @param {Object} opts Optional parameters
|
|
4232
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3676
4233
|
*/
|
|
3677
|
-
postOutboundContactlisttemplatesBulkAdd(body) {
|
|
4234
|
+
postOutboundContactlisttemplatesBulkAdd(body, opts) {
|
|
4235
|
+
opts = opts || {};
|
|
4236
|
+
|
|
3678
4237
|
// verify the required parameter 'body' is set
|
|
3679
4238
|
if (body === undefined || body === null) {
|
|
3680
4239
|
throw 'Missing the required parameter "body" when calling postOutboundContactlisttemplatesBulkAdd';
|
|
@@ -3690,7 +4249,8 @@ class OutboundApi {
|
|
|
3690
4249
|
body,
|
|
3691
4250
|
['PureCloud OAuth'],
|
|
3692
4251
|
['application/json'],
|
|
3693
|
-
['application/json']
|
|
4252
|
+
['application/json'],
|
|
4253
|
+
opts['customHeaders']
|
|
3694
4254
|
);
|
|
3695
4255
|
}
|
|
3696
4256
|
|
|
@@ -3698,8 +4258,12 @@ class OutboundApi {
|
|
|
3698
4258
|
* Get multiple contact list templates
|
|
3699
4259
|
*
|
|
3700
4260
|
* @param {Object} body contact list templates to get
|
|
4261
|
+
* @param {Object} opts Optional parameters
|
|
4262
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3701
4263
|
*/
|
|
3702
|
-
postOutboundContactlisttemplatesBulkRetrieve(body) {
|
|
4264
|
+
postOutboundContactlisttemplatesBulkRetrieve(body, opts) {
|
|
4265
|
+
opts = opts || {};
|
|
4266
|
+
|
|
3703
4267
|
// verify the required parameter 'body' is set
|
|
3704
4268
|
if (body === undefined || body === null) {
|
|
3705
4269
|
throw 'Missing the required parameter "body" when calling postOutboundContactlisttemplatesBulkRetrieve';
|
|
@@ -3715,7 +4279,8 @@ class OutboundApi {
|
|
|
3715
4279
|
body,
|
|
3716
4280
|
['PureCloud OAuth'],
|
|
3717
4281
|
['application/json'],
|
|
3718
|
-
['application/json']
|
|
4282
|
+
['application/json'],
|
|
4283
|
+
opts['customHeaders']
|
|
3719
4284
|
);
|
|
3720
4285
|
}
|
|
3721
4286
|
|
|
@@ -3723,8 +4288,12 @@ class OutboundApi {
|
|
|
3723
4288
|
* Add phone numbers to a Dialer DNC list.
|
|
3724
4289
|
*
|
|
3725
4290
|
* @param {String} conversationId Conversation ID
|
|
4291
|
+
* @param {Object} opts Optional parameters
|
|
4292
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3726
4293
|
*/
|
|
3727
|
-
postOutboundConversationDnc(conversationId) {
|
|
4294
|
+
postOutboundConversationDnc(conversationId, opts) {
|
|
4295
|
+
opts = opts || {};
|
|
4296
|
+
|
|
3728
4297
|
// verify the required parameter 'conversationId' is set
|
|
3729
4298
|
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
3730
4299
|
throw 'Missing the required parameter "conversationId" when calling postOutboundConversationDnc';
|
|
@@ -3740,7 +4309,8 @@ class OutboundApi {
|
|
|
3740
4309
|
null,
|
|
3741
4310
|
['PureCloud OAuth'],
|
|
3742
4311
|
['application/json'],
|
|
3743
|
-
['application/json']
|
|
4312
|
+
['application/json'],
|
|
4313
|
+
opts['customHeaders']
|
|
3744
4314
|
);
|
|
3745
4315
|
}
|
|
3746
4316
|
|
|
@@ -3748,8 +4318,12 @@ class OutboundApi {
|
|
|
3748
4318
|
* Create an Outbound Digital Rule Set
|
|
3749
4319
|
*
|
|
3750
4320
|
* @param {Object} body Digital Rule Set
|
|
4321
|
+
* @param {Object} opts Optional parameters
|
|
4322
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3751
4323
|
*/
|
|
3752
|
-
postOutboundDigitalrulesets(body) {
|
|
4324
|
+
postOutboundDigitalrulesets(body, opts) {
|
|
4325
|
+
opts = opts || {};
|
|
4326
|
+
|
|
3753
4327
|
// verify the required parameter 'body' is set
|
|
3754
4328
|
if (body === undefined || body === null) {
|
|
3755
4329
|
throw 'Missing the required parameter "body" when calling postOutboundDigitalrulesets';
|
|
@@ -3765,7 +4339,8 @@ class OutboundApi {
|
|
|
3765
4339
|
body,
|
|
3766
4340
|
['PureCloud OAuth'],
|
|
3767
4341
|
['application/json'],
|
|
3768
|
-
['application/json']
|
|
4342
|
+
['application/json'],
|
|
4343
|
+
opts['customHeaders']
|
|
3769
4344
|
);
|
|
3770
4345
|
}
|
|
3771
4346
|
|
|
@@ -3774,8 +4349,12 @@ class OutboundApi {
|
|
|
3774
4349
|
* Only Internal DNC lists may be appended to
|
|
3775
4350
|
* @param {String} dncListId DncList ID
|
|
3776
4351
|
* @param {Array.<String>} body DNC email addresses
|
|
4352
|
+
* @param {Object} opts Optional parameters
|
|
4353
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3777
4354
|
*/
|
|
3778
|
-
postOutboundDnclistEmailaddresses(dncListId, body) {
|
|
4355
|
+
postOutboundDnclistEmailaddresses(dncListId, body, opts) {
|
|
4356
|
+
opts = opts || {};
|
|
4357
|
+
|
|
3779
4358
|
// verify the required parameter 'dncListId' is set
|
|
3780
4359
|
if (dncListId === undefined || dncListId === null || dncListId === '') {
|
|
3781
4360
|
throw 'Missing the required parameter "dncListId" when calling postOutboundDnclistEmailaddresses';
|
|
@@ -3795,7 +4374,8 @@ class OutboundApi {
|
|
|
3795
4374
|
body,
|
|
3796
4375
|
['PureCloud OAuth'],
|
|
3797
4376
|
['application/json'],
|
|
3798
|
-
['application/json']
|
|
4377
|
+
['application/json'],
|
|
4378
|
+
opts['customHeaders']
|
|
3799
4379
|
);
|
|
3800
4380
|
}
|
|
3801
4381
|
|
|
@@ -3803,8 +4383,12 @@ class OutboundApi {
|
|
|
3803
4383
|
* Initiate the export of a dnc list.
|
|
3804
4384
|
* Returns 200 if received OK.
|
|
3805
4385
|
* @param {String} dncListId DncList ID
|
|
4386
|
+
* @param {Object} opts Optional parameters
|
|
4387
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3806
4388
|
*/
|
|
3807
|
-
postOutboundDnclistExport(dncListId) {
|
|
4389
|
+
postOutboundDnclistExport(dncListId, opts) {
|
|
4390
|
+
opts = opts || {};
|
|
4391
|
+
|
|
3808
4392
|
// verify the required parameter 'dncListId' is set
|
|
3809
4393
|
if (dncListId === undefined || dncListId === null || dncListId === '') {
|
|
3810
4394
|
throw 'Missing the required parameter "dncListId" when calling postOutboundDnclistExport';
|
|
@@ -3820,7 +4404,8 @@ class OutboundApi {
|
|
|
3820
4404
|
null,
|
|
3821
4405
|
['PureCloud OAuth'],
|
|
3822
4406
|
['application/json'],
|
|
3823
|
-
['application/json']
|
|
4407
|
+
['application/json'],
|
|
4408
|
+
opts['customHeaders']
|
|
3824
4409
|
);
|
|
3825
4410
|
}
|
|
3826
4411
|
|
|
@@ -3831,6 +4416,7 @@ class OutboundApi {
|
|
|
3831
4416
|
* @param {Array.<String>} body DNC Phone Numbers
|
|
3832
4417
|
* @param {Object} opts Optional parameters
|
|
3833
4418
|
* @param {String} opts.expirationDateTime Expiration date for DNC phone numbers in yyyy-MM-ddTHH:mmZ format
|
|
4419
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3834
4420
|
*/
|
|
3835
4421
|
postOutboundDnclistPhonenumbers(dncListId, body, opts) {
|
|
3836
4422
|
opts = opts || {};
|
|
@@ -3854,7 +4440,8 @@ class OutboundApi {
|
|
|
3854
4440
|
body,
|
|
3855
4441
|
['PureCloud OAuth'],
|
|
3856
4442
|
['application/json'],
|
|
3857
|
-
['application/json']
|
|
4443
|
+
['application/json'],
|
|
4444
|
+
opts['customHeaders']
|
|
3858
4445
|
);
|
|
3859
4446
|
}
|
|
3860
4447
|
|
|
@@ -3862,8 +4449,12 @@ class OutboundApi {
|
|
|
3862
4449
|
* Create dialer DNC list
|
|
3863
4450
|
*
|
|
3864
4451
|
* @param {Object} body DncList
|
|
4452
|
+
* @param {Object} opts Optional parameters
|
|
4453
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3865
4454
|
*/
|
|
3866
|
-
postOutboundDnclists(body) {
|
|
4455
|
+
postOutboundDnclists(body, opts) {
|
|
4456
|
+
opts = opts || {};
|
|
4457
|
+
|
|
3867
4458
|
// verify the required parameter 'body' is set
|
|
3868
4459
|
if (body === undefined || body === null) {
|
|
3869
4460
|
throw 'Missing the required parameter "body" when calling postOutboundDnclists';
|
|
@@ -3879,7 +4470,8 @@ class OutboundApi {
|
|
|
3879
4470
|
body,
|
|
3880
4471
|
['PureCloud OAuth'],
|
|
3881
4472
|
['application/json'],
|
|
3882
|
-
['application/json']
|
|
4473
|
+
['application/json'],
|
|
4474
|
+
opts['customHeaders']
|
|
3883
4475
|
);
|
|
3884
4476
|
}
|
|
3885
4477
|
|
|
@@ -3887,8 +4479,12 @@ class OutboundApi {
|
|
|
3887
4479
|
* Generate presigned upload URL for dnc list.
|
|
3888
4480
|
*
|
|
3889
4481
|
* @param {Object} body dncListUploadUrlRequest
|
|
4482
|
+
* @param {Object} opts Optional parameters
|
|
4483
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3890
4484
|
*/
|
|
3891
|
-
postOutboundDnclistsUploads(body) {
|
|
4485
|
+
postOutboundDnclistsUploads(body, opts) {
|
|
4486
|
+
opts = opts || {};
|
|
4487
|
+
|
|
3892
4488
|
// verify the required parameter 'body' is set
|
|
3893
4489
|
if (body === undefined || body === null) {
|
|
3894
4490
|
throw 'Missing the required parameter "body" when calling postOutboundDnclistsUploads';
|
|
@@ -3904,7 +4500,8 @@ class OutboundApi {
|
|
|
3904
4500
|
body,
|
|
3905
4501
|
['PureCloud OAuth'],
|
|
3906
4502
|
['application/json'],
|
|
3907
|
-
['application/json']
|
|
4503
|
+
['application/json'],
|
|
4504
|
+
opts['customHeaders']
|
|
3908
4505
|
);
|
|
3909
4506
|
}
|
|
3910
4507
|
|
|
@@ -3912,8 +4509,12 @@ class OutboundApi {
|
|
|
3912
4509
|
* Create File Specification Template
|
|
3913
4510
|
*
|
|
3914
4511
|
* @param {Object} body FileSpecificationTemplate
|
|
4512
|
+
* @param {Object} opts Optional parameters
|
|
4513
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3915
4514
|
*/
|
|
3916
|
-
postOutboundFilespecificationtemplates(body) {
|
|
4515
|
+
postOutboundFilespecificationtemplates(body, opts) {
|
|
4516
|
+
opts = opts || {};
|
|
4517
|
+
|
|
3917
4518
|
// verify the required parameter 'body' is set
|
|
3918
4519
|
if (body === undefined || body === null) {
|
|
3919
4520
|
throw 'Missing the required parameter "body" when calling postOutboundFilespecificationtemplates';
|
|
@@ -3929,7 +4530,8 @@ class OutboundApi {
|
|
|
3929
4530
|
body,
|
|
3930
4531
|
['PureCloud OAuth'],
|
|
3931
4532
|
['application/json'],
|
|
3932
|
-
['application/json']
|
|
4533
|
+
['application/json'],
|
|
4534
|
+
opts['customHeaders']
|
|
3933
4535
|
);
|
|
3934
4536
|
}
|
|
3935
4537
|
|
|
@@ -3937,8 +4539,12 @@ class OutboundApi {
|
|
|
3937
4539
|
* Create Import Template
|
|
3938
4540
|
*
|
|
3939
4541
|
* @param {Object} body ImportTemplate
|
|
4542
|
+
* @param {Object} opts Optional parameters
|
|
4543
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3940
4544
|
*/
|
|
3941
|
-
postOutboundImporttemplates(body) {
|
|
4545
|
+
postOutboundImporttemplates(body, opts) {
|
|
4546
|
+
opts = opts || {};
|
|
4547
|
+
|
|
3942
4548
|
// verify the required parameter 'body' is set
|
|
3943
4549
|
if (body === undefined || body === null) {
|
|
3944
4550
|
throw 'Missing the required parameter "body" when calling postOutboundImporttemplates';
|
|
@@ -3954,7 +4560,8 @@ class OutboundApi {
|
|
|
3954
4560
|
body,
|
|
3955
4561
|
['PureCloud OAuth'],
|
|
3956
4562
|
['application/json'],
|
|
3957
|
-
['application/json']
|
|
4563
|
+
['application/json'],
|
|
4564
|
+
opts['customHeaders']
|
|
3958
4565
|
);
|
|
3959
4566
|
}
|
|
3960
4567
|
|
|
@@ -3962,8 +4569,12 @@ class OutboundApi {
|
|
|
3962
4569
|
* Add multiple import templates
|
|
3963
4570
|
*
|
|
3964
4571
|
* @param {Array.<Object>} body import template(s) to add
|
|
4572
|
+
* @param {Object} opts Optional parameters
|
|
4573
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3965
4574
|
*/
|
|
3966
|
-
postOutboundImporttemplatesBulkAdd(body) {
|
|
4575
|
+
postOutboundImporttemplatesBulkAdd(body, opts) {
|
|
4576
|
+
opts = opts || {};
|
|
4577
|
+
|
|
3967
4578
|
// verify the required parameter 'body' is set
|
|
3968
4579
|
if (body === undefined || body === null) {
|
|
3969
4580
|
throw 'Missing the required parameter "body" when calling postOutboundImporttemplatesBulkAdd';
|
|
@@ -3979,7 +4590,8 @@ class OutboundApi {
|
|
|
3979
4590
|
body,
|
|
3980
4591
|
['PureCloud OAuth'],
|
|
3981
4592
|
['application/json'],
|
|
3982
|
-
['application/json']
|
|
4593
|
+
['application/json'],
|
|
4594
|
+
opts['customHeaders']
|
|
3983
4595
|
);
|
|
3984
4596
|
}
|
|
3985
4597
|
|
|
@@ -3987,8 +4599,12 @@ class OutboundApi {
|
|
|
3987
4599
|
* Start the campaign
|
|
3988
4600
|
* Documented permissions are applicable based on campaign type.
|
|
3989
4601
|
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
4602
|
+
* @param {Object} opts Optional parameters
|
|
4603
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3990
4604
|
*/
|
|
3991
|
-
postOutboundMessagingcampaignStart(messagingCampaignId) {
|
|
4605
|
+
postOutboundMessagingcampaignStart(messagingCampaignId, opts) {
|
|
4606
|
+
opts = opts || {};
|
|
4607
|
+
|
|
3992
4608
|
// verify the required parameter 'messagingCampaignId' is set
|
|
3993
4609
|
if (messagingCampaignId === undefined || messagingCampaignId === null || messagingCampaignId === '') {
|
|
3994
4610
|
throw 'Missing the required parameter "messagingCampaignId" when calling postOutboundMessagingcampaignStart';
|
|
@@ -4004,7 +4620,8 @@ class OutboundApi {
|
|
|
4004
4620
|
null,
|
|
4005
4621
|
['PureCloud OAuth'],
|
|
4006
4622
|
['application/json'],
|
|
4007
|
-
['application/json']
|
|
4623
|
+
['application/json'],
|
|
4624
|
+
opts['customHeaders']
|
|
4008
4625
|
);
|
|
4009
4626
|
}
|
|
4010
4627
|
|
|
@@ -4012,8 +4629,12 @@ class OutboundApi {
|
|
|
4012
4629
|
* Stop the campaign
|
|
4013
4630
|
* Documented permissions are applicable based on campaign type.
|
|
4014
4631
|
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
4632
|
+
* @param {Object} opts Optional parameters
|
|
4633
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
4015
4634
|
*/
|
|
4016
|
-
postOutboundMessagingcampaignStop(messagingCampaignId) {
|
|
4635
|
+
postOutboundMessagingcampaignStop(messagingCampaignId, opts) {
|
|
4636
|
+
opts = opts || {};
|
|
4637
|
+
|
|
4017
4638
|
// verify the required parameter 'messagingCampaignId' is set
|
|
4018
4639
|
if (messagingCampaignId === undefined || messagingCampaignId === null || messagingCampaignId === '') {
|
|
4019
4640
|
throw 'Missing the required parameter "messagingCampaignId" when calling postOutboundMessagingcampaignStop';
|
|
@@ -4029,7 +4650,8 @@ class OutboundApi {
|
|
|
4029
4650
|
null,
|
|
4030
4651
|
['PureCloud OAuth'],
|
|
4031
4652
|
['application/json'],
|
|
4032
|
-
['application/json']
|
|
4653
|
+
['application/json'],
|
|
4654
|
+
opts['customHeaders']
|
|
4033
4655
|
);
|
|
4034
4656
|
}
|
|
4035
4657
|
|
|
@@ -4037,8 +4659,12 @@ class OutboundApi {
|
|
|
4037
4659
|
* Create a Messaging Campaign
|
|
4038
4660
|
*
|
|
4039
4661
|
* @param {Object} body Messaging Campaign
|
|
4662
|
+
* @param {Object} opts Optional parameters
|
|
4663
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
4040
4664
|
*/
|
|
4041
|
-
postOutboundMessagingcampaigns(body) {
|
|
4665
|
+
postOutboundMessagingcampaigns(body, opts) {
|
|
4666
|
+
opts = opts || {};
|
|
4667
|
+
|
|
4042
4668
|
// verify the required parameter 'body' is set
|
|
4043
4669
|
if (body === undefined || body === null) {
|
|
4044
4670
|
throw 'Missing the required parameter "body" when calling postOutboundMessagingcampaigns';
|
|
@@ -4054,7 +4680,8 @@ class OutboundApi {
|
|
|
4054
4680
|
body,
|
|
4055
4681
|
['PureCloud OAuth'],
|
|
4056
4682
|
['application/json'],
|
|
4057
|
-
['application/json']
|
|
4683
|
+
['application/json'],
|
|
4684
|
+
opts['customHeaders']
|
|
4058
4685
|
);
|
|
4059
4686
|
}
|
|
4060
4687
|
|
|
@@ -4062,8 +4689,12 @@ class OutboundApi {
|
|
|
4062
4689
|
* Get progress for a list of messaging campaigns
|
|
4063
4690
|
*
|
|
4064
4691
|
* @param {Array.<String>} body Messaging Campaign IDs
|
|
4692
|
+
* @param {Object} opts Optional parameters
|
|
4693
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
4065
4694
|
*/
|
|
4066
|
-
postOutboundMessagingcampaignsProgress(body) {
|
|
4695
|
+
postOutboundMessagingcampaignsProgress(body, opts) {
|
|
4696
|
+
opts = opts || {};
|
|
4697
|
+
|
|
4067
4698
|
// verify the required parameter 'body' is set
|
|
4068
4699
|
if (body === undefined || body === null) {
|
|
4069
4700
|
throw 'Missing the required parameter "body" when calling postOutboundMessagingcampaignsProgress';
|
|
@@ -4079,7 +4710,8 @@ class OutboundApi {
|
|
|
4079
4710
|
body,
|
|
4080
4711
|
['PureCloud OAuth'],
|
|
4081
4712
|
['application/json'],
|
|
4082
|
-
['application/json']
|
|
4713
|
+
['application/json'],
|
|
4714
|
+
opts['customHeaders']
|
|
4083
4715
|
);
|
|
4084
4716
|
}
|
|
4085
4717
|
|
|
@@ -4087,8 +4719,12 @@ class OutboundApi {
|
|
|
4087
4719
|
* Create a Rule Set.
|
|
4088
4720
|
*
|
|
4089
4721
|
* @param {Object} body RuleSet
|
|
4722
|
+
* @param {Object} opts Optional parameters
|
|
4723
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
4090
4724
|
*/
|
|
4091
|
-
postOutboundRulesets(body) {
|
|
4725
|
+
postOutboundRulesets(body, opts) {
|
|
4726
|
+
opts = opts || {};
|
|
4727
|
+
|
|
4092
4728
|
// verify the required parameter 'body' is set
|
|
4093
4729
|
if (body === undefined || body === null) {
|
|
4094
4730
|
throw 'Missing the required parameter "body" when calling postOutboundRulesets';
|
|
@@ -4104,7 +4740,8 @@ class OutboundApi {
|
|
|
4104
4740
|
body,
|
|
4105
4741
|
['PureCloud OAuth'],
|
|
4106
4742
|
['application/json'],
|
|
4107
|
-
['application/json']
|
|
4743
|
+
['application/json'],
|
|
4744
|
+
opts['customHeaders']
|
|
4108
4745
|
);
|
|
4109
4746
|
}
|
|
4110
4747
|
|
|
@@ -4112,8 +4749,12 @@ class OutboundApi {
|
|
|
4112
4749
|
* Create a new campaign sequence.
|
|
4113
4750
|
*
|
|
4114
4751
|
* @param {Object} body Organization
|
|
4752
|
+
* @param {Object} opts Optional parameters
|
|
4753
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
4115
4754
|
*/
|
|
4116
|
-
postOutboundSequences(body) {
|
|
4755
|
+
postOutboundSequences(body, opts) {
|
|
4756
|
+
opts = opts || {};
|
|
4757
|
+
|
|
4117
4758
|
// verify the required parameter 'body' is set
|
|
4118
4759
|
if (body === undefined || body === null) {
|
|
4119
4760
|
throw 'Missing the required parameter "body" when calling postOutboundSequences';
|
|
@@ -4129,7 +4770,8 @@ class OutboundApi {
|
|
|
4129
4770
|
body,
|
|
4130
4771
|
['PureCloud OAuth'],
|
|
4131
4772
|
['application/json'],
|
|
4132
|
-
['application/json']
|
|
4773
|
+
['application/json'],
|
|
4774
|
+
opts['customHeaders']
|
|
4133
4775
|
);
|
|
4134
4776
|
}
|
|
4135
4777
|
|
|
@@ -4138,8 +4780,12 @@ class OutboundApi {
|
|
|
4138
4780
|
*
|
|
4139
4781
|
* @param {String} attemptLimitsId Attempt limits ID
|
|
4140
4782
|
* @param {Object} body AttemptLimits
|
|
4783
|
+
* @param {Object} opts Optional parameters
|
|
4784
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
4141
4785
|
*/
|
|
4142
|
-
putOutboundAttemptlimit(attemptLimitsId, body) {
|
|
4786
|
+
putOutboundAttemptlimit(attemptLimitsId, body, opts) {
|
|
4787
|
+
opts = opts || {};
|
|
4788
|
+
|
|
4143
4789
|
// verify the required parameter 'attemptLimitsId' is set
|
|
4144
4790
|
if (attemptLimitsId === undefined || attemptLimitsId === null || attemptLimitsId === '') {
|
|
4145
4791
|
throw 'Missing the required parameter "attemptLimitsId" when calling putOutboundAttemptlimit';
|
|
@@ -4159,7 +4805,8 @@ class OutboundApi {
|
|
|
4159
4805
|
body,
|
|
4160
4806
|
['PureCloud OAuth'],
|
|
4161
4807
|
['application/json'],
|
|
4162
|
-
['application/json']
|
|
4808
|
+
['application/json'],
|
|
4809
|
+
opts['customHeaders']
|
|
4163
4810
|
);
|
|
4164
4811
|
}
|
|
4165
4812
|
|
|
@@ -4168,8 +4815,12 @@ class OutboundApi {
|
|
|
4168
4815
|
*
|
|
4169
4816
|
* @param {String} callableTimeSetId Callable Time Set ID
|
|
4170
4817
|
* @param {Object} body DialerCallableTimeSet
|
|
4818
|
+
* @param {Object} opts Optional parameters
|
|
4819
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
4171
4820
|
*/
|
|
4172
|
-
putOutboundCallabletimeset(callableTimeSetId, body) {
|
|
4821
|
+
putOutboundCallabletimeset(callableTimeSetId, body, opts) {
|
|
4822
|
+
opts = opts || {};
|
|
4823
|
+
|
|
4173
4824
|
// verify the required parameter 'callableTimeSetId' is set
|
|
4174
4825
|
if (callableTimeSetId === undefined || callableTimeSetId === null || callableTimeSetId === '') {
|
|
4175
4826
|
throw 'Missing the required parameter "callableTimeSetId" when calling putOutboundCallabletimeset';
|
|
@@ -4189,7 +4840,8 @@ class OutboundApi {
|
|
|
4189
4840
|
body,
|
|
4190
4841
|
['PureCloud OAuth'],
|
|
4191
4842
|
['application/json'],
|
|
4192
|
-
['application/json']
|
|
4843
|
+
['application/json'],
|
|
4844
|
+
opts['customHeaders']
|
|
4193
4845
|
);
|
|
4194
4846
|
}
|
|
4195
4847
|
|
|
@@ -4198,8 +4850,12 @@ class OutboundApi {
|
|
|
4198
4850
|
*
|
|
4199
4851
|
* @param {String} callAnalysisSetId Call Analysis Response Set ID
|
|
4200
4852
|
* @param {Object} body ResponseSet
|
|
4853
|
+
* @param {Object} opts Optional parameters
|
|
4854
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
4201
4855
|
*/
|
|
4202
|
-
putOutboundCallanalysisresponseset(callAnalysisSetId, body) {
|
|
4856
|
+
putOutboundCallanalysisresponseset(callAnalysisSetId, body, opts) {
|
|
4857
|
+
opts = opts || {};
|
|
4858
|
+
|
|
4203
4859
|
// verify the required parameter 'callAnalysisSetId' is set
|
|
4204
4860
|
if (callAnalysisSetId === undefined || callAnalysisSetId === null || callAnalysisSetId === '') {
|
|
4205
4861
|
throw 'Missing the required parameter "callAnalysisSetId" when calling putOutboundCallanalysisresponseset';
|
|
@@ -4219,7 +4875,8 @@ class OutboundApi {
|
|
|
4219
4875
|
body,
|
|
4220
4876
|
['PureCloud OAuth'],
|
|
4221
4877
|
['application/json'],
|
|
4222
|
-
['application/json']
|
|
4878
|
+
['application/json'],
|
|
4879
|
+
opts['customHeaders']
|
|
4223
4880
|
);
|
|
4224
4881
|
}
|
|
4225
4882
|
|
|
@@ -4230,6 +4887,7 @@ class OutboundApi {
|
|
|
4230
4887
|
* @param {Object} body Campaign
|
|
4231
4888
|
* @param {Object} opts Optional parameters
|
|
4232
4889
|
* @param {Object} opts.useMaxCallsPerAgentDecimal Use maxCallsPerAgent with decimal precision
|
|
4890
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
4233
4891
|
*/
|
|
4234
4892
|
putOutboundCampaign(campaignId, body, opts) {
|
|
4235
4893
|
opts = opts || {};
|
|
@@ -4253,7 +4911,8 @@ class OutboundApi {
|
|
|
4253
4911
|
body,
|
|
4254
4912
|
['PureCloud OAuth'],
|
|
4255
4913
|
['application/json'],
|
|
4256
|
-
['application/json']
|
|
4914
|
+
['application/json'],
|
|
4915
|
+
opts['customHeaders']
|
|
4257
4916
|
);
|
|
4258
4917
|
}
|
|
4259
4918
|
|
|
@@ -4263,8 +4922,12 @@ class OutboundApi {
|
|
|
4263
4922
|
* @param {String} campaignId Campaign ID
|
|
4264
4923
|
* @param {String} userId Agent's user ID
|
|
4265
4924
|
* @param {Object} body agent
|
|
4925
|
+
* @param {Object} opts Optional parameters
|
|
4926
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
4266
4927
|
*/
|
|
4267
|
-
putOutboundCampaignAgent(campaignId, userId, body) {
|
|
4928
|
+
putOutboundCampaignAgent(campaignId, userId, body, opts) {
|
|
4929
|
+
opts = opts || {};
|
|
4930
|
+
|
|
4268
4931
|
// verify the required parameter 'campaignId' is set
|
|
4269
4932
|
if (campaignId === undefined || campaignId === null || campaignId === '') {
|
|
4270
4933
|
throw 'Missing the required parameter "campaignId" when calling putOutboundCampaignAgent';
|
|
@@ -4288,7 +4951,8 @@ class OutboundApi {
|
|
|
4288
4951
|
body,
|
|
4289
4952
|
['PureCloud OAuth'],
|
|
4290
4953
|
['application/json'],
|
|
4291
|
-
['application/json']
|
|
4954
|
+
['application/json'],
|
|
4955
|
+
opts['customHeaders']
|
|
4292
4956
|
);
|
|
4293
4957
|
}
|
|
4294
4958
|
|
|
@@ -4297,8 +4961,12 @@ class OutboundApi {
|
|
|
4297
4961
|
*
|
|
4298
4962
|
* @param {String} campaignRuleId Campaign Rule ID
|
|
4299
4963
|
* @param {Object} body CampaignRule
|
|
4964
|
+
* @param {Object} opts Optional parameters
|
|
4965
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
4300
4966
|
*/
|
|
4301
|
-
putOutboundCampaignrule(campaignRuleId, body) {
|
|
4967
|
+
putOutboundCampaignrule(campaignRuleId, body, opts) {
|
|
4968
|
+
opts = opts || {};
|
|
4969
|
+
|
|
4302
4970
|
// verify the required parameter 'campaignRuleId' is set
|
|
4303
4971
|
if (campaignRuleId === undefined || campaignRuleId === null || campaignRuleId === '') {
|
|
4304
4972
|
throw 'Missing the required parameter "campaignRuleId" when calling putOutboundCampaignrule';
|
|
@@ -4318,7 +4986,8 @@ class OutboundApi {
|
|
|
4318
4986
|
body,
|
|
4319
4987
|
['PureCloud OAuth'],
|
|
4320
4988
|
['application/json'],
|
|
4321
|
-
['application/json']
|
|
4989
|
+
['application/json'],
|
|
4990
|
+
opts['customHeaders']
|
|
4322
4991
|
);
|
|
4323
4992
|
}
|
|
4324
4993
|
|
|
@@ -4327,8 +4996,12 @@ class OutboundApi {
|
|
|
4327
4996
|
*
|
|
4328
4997
|
* @param {String} contactListId ContactList ID
|
|
4329
4998
|
* @param {Object} body ContactList
|
|
4999
|
+
* @param {Object} opts Optional parameters
|
|
5000
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
4330
5001
|
*/
|
|
4331
|
-
putOutboundContactlist(contactListId, body) {
|
|
5002
|
+
putOutboundContactlist(contactListId, body, opts) {
|
|
5003
|
+
opts = opts || {};
|
|
5004
|
+
|
|
4332
5005
|
// verify the required parameter 'contactListId' is set
|
|
4333
5006
|
if (contactListId === undefined || contactListId === null || contactListId === '') {
|
|
4334
5007
|
throw 'Missing the required parameter "contactListId" when calling putOutboundContactlist';
|
|
@@ -4348,7 +5021,8 @@ class OutboundApi {
|
|
|
4348
5021
|
body,
|
|
4349
5022
|
['PureCloud OAuth'],
|
|
4350
5023
|
['application/json'],
|
|
4351
|
-
['application/json']
|
|
5024
|
+
['application/json'],
|
|
5025
|
+
opts['customHeaders']
|
|
4352
5026
|
);
|
|
4353
5027
|
}
|
|
4354
5028
|
|
|
@@ -4358,8 +5032,12 @@ class OutboundApi {
|
|
|
4358
5032
|
* @param {String} contactListId Contact List ID
|
|
4359
5033
|
* @param {String} contactId Contact ID
|
|
4360
5034
|
* @param {Object} body Contact
|
|
5035
|
+
* @param {Object} opts Optional parameters
|
|
5036
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
4361
5037
|
*/
|
|
4362
|
-
putOutboundContactlistContact(contactListId, contactId, body) {
|
|
5038
|
+
putOutboundContactlistContact(contactListId, contactId, body, opts) {
|
|
5039
|
+
opts = opts || {};
|
|
5040
|
+
|
|
4363
5041
|
// verify the required parameter 'contactListId' is set
|
|
4364
5042
|
if (contactListId === undefined || contactListId === null || contactListId === '') {
|
|
4365
5043
|
throw 'Missing the required parameter "contactListId" when calling putOutboundContactlistContact';
|
|
@@ -4383,7 +5061,8 @@ class OutboundApi {
|
|
|
4383
5061
|
body,
|
|
4384
5062
|
['PureCloud OAuth'],
|
|
4385
5063
|
['application/json'],
|
|
4386
|
-
['application/json']
|
|
5064
|
+
['application/json'],
|
|
5065
|
+
opts['customHeaders']
|
|
4387
5066
|
);
|
|
4388
5067
|
}
|
|
4389
5068
|
|
|
@@ -4392,8 +5071,12 @@ class OutboundApi {
|
|
|
4392
5071
|
*
|
|
4393
5072
|
* @param {String} contactListFilterId Contact List Filter ID
|
|
4394
5073
|
* @param {Object} body ContactListFilter
|
|
5074
|
+
* @param {Object} opts Optional parameters
|
|
5075
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
4395
5076
|
*/
|
|
4396
|
-
putOutboundContactlistfilter(contactListFilterId, body) {
|
|
5077
|
+
putOutboundContactlistfilter(contactListFilterId, body, opts) {
|
|
5078
|
+
opts = opts || {};
|
|
5079
|
+
|
|
4397
5080
|
// verify the required parameter 'contactListFilterId' is set
|
|
4398
5081
|
if (contactListFilterId === undefined || contactListFilterId === null || contactListFilterId === '') {
|
|
4399
5082
|
throw 'Missing the required parameter "contactListFilterId" when calling putOutboundContactlistfilter';
|
|
@@ -4413,7 +5096,8 @@ class OutboundApi {
|
|
|
4413
5096
|
body,
|
|
4414
5097
|
['PureCloud OAuth'],
|
|
4415
5098
|
['application/json'],
|
|
4416
|
-
['application/json']
|
|
5099
|
+
['application/json'],
|
|
5100
|
+
opts['customHeaders']
|
|
4417
5101
|
);
|
|
4418
5102
|
}
|
|
4419
5103
|
|
|
@@ -4422,8 +5106,12 @@ class OutboundApi {
|
|
|
4422
5106
|
*
|
|
4423
5107
|
* @param {String} contactListTemplateId ContactListTemplate ID
|
|
4424
5108
|
* @param {Object} body ContactListTemplate
|
|
5109
|
+
* @param {Object} opts Optional parameters
|
|
5110
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
4425
5111
|
*/
|
|
4426
|
-
putOutboundContactlisttemplate(contactListTemplateId, body) {
|
|
5112
|
+
putOutboundContactlisttemplate(contactListTemplateId, body, opts) {
|
|
5113
|
+
opts = opts || {};
|
|
5114
|
+
|
|
4427
5115
|
// verify the required parameter 'contactListTemplateId' is set
|
|
4428
5116
|
if (contactListTemplateId === undefined || contactListTemplateId === null || contactListTemplateId === '') {
|
|
4429
5117
|
throw 'Missing the required parameter "contactListTemplateId" when calling putOutboundContactlisttemplate';
|
|
@@ -4443,7 +5131,8 @@ class OutboundApi {
|
|
|
4443
5131
|
body,
|
|
4444
5132
|
['PureCloud OAuth'],
|
|
4445
5133
|
['application/json'],
|
|
4446
|
-
['application/json']
|
|
5134
|
+
['application/json'],
|
|
5135
|
+
opts['customHeaders']
|
|
4447
5136
|
);
|
|
4448
5137
|
}
|
|
4449
5138
|
|
|
@@ -4452,8 +5141,12 @@ class OutboundApi {
|
|
|
4452
5141
|
*
|
|
4453
5142
|
* @param {String} digitalRuleSetId The Digital Rule Set ID
|
|
4454
5143
|
* @param {Object} body Digital Rule Set
|
|
5144
|
+
* @param {Object} opts Optional parameters
|
|
5145
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
4455
5146
|
*/
|
|
4456
|
-
putOutboundDigitalruleset(digitalRuleSetId, body) {
|
|
5147
|
+
putOutboundDigitalruleset(digitalRuleSetId, body, opts) {
|
|
5148
|
+
opts = opts || {};
|
|
5149
|
+
|
|
4457
5150
|
// verify the required parameter 'digitalRuleSetId' is set
|
|
4458
5151
|
if (digitalRuleSetId === undefined || digitalRuleSetId === null || digitalRuleSetId === '') {
|
|
4459
5152
|
throw 'Missing the required parameter "digitalRuleSetId" when calling putOutboundDigitalruleset';
|
|
@@ -4473,7 +5166,8 @@ class OutboundApi {
|
|
|
4473
5166
|
body,
|
|
4474
5167
|
['PureCloud OAuth'],
|
|
4475
5168
|
['application/json'],
|
|
4476
|
-
['application/json']
|
|
5169
|
+
['application/json'],
|
|
5170
|
+
opts['customHeaders']
|
|
4477
5171
|
);
|
|
4478
5172
|
}
|
|
4479
5173
|
|
|
@@ -4482,8 +5176,12 @@ class OutboundApi {
|
|
|
4482
5176
|
*
|
|
4483
5177
|
* @param {String} dncListId DncList ID
|
|
4484
5178
|
* @param {Object} body DncList
|
|
5179
|
+
* @param {Object} opts Optional parameters
|
|
5180
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
4485
5181
|
*/
|
|
4486
|
-
putOutboundDnclist(dncListId, body) {
|
|
5182
|
+
putOutboundDnclist(dncListId, body, opts) {
|
|
5183
|
+
opts = opts || {};
|
|
5184
|
+
|
|
4487
5185
|
// verify the required parameter 'dncListId' is set
|
|
4488
5186
|
if (dncListId === undefined || dncListId === null || dncListId === '') {
|
|
4489
5187
|
throw 'Missing the required parameter "dncListId" when calling putOutboundDnclist';
|
|
@@ -4503,7 +5201,8 @@ class OutboundApi {
|
|
|
4503
5201
|
body,
|
|
4504
5202
|
['PureCloud OAuth'],
|
|
4505
5203
|
['application/json'],
|
|
4506
|
-
['application/json']
|
|
5204
|
+
['application/json'],
|
|
5205
|
+
opts['customHeaders']
|
|
4507
5206
|
);
|
|
4508
5207
|
}
|
|
4509
5208
|
|
|
@@ -4512,8 +5211,12 @@ class OutboundApi {
|
|
|
4512
5211
|
*
|
|
4513
5212
|
* @param {String} fileSpecificationTemplateId File Specification Template ID
|
|
4514
5213
|
* @param {Object} body fileSpecificationTemplate
|
|
5214
|
+
* @param {Object} opts Optional parameters
|
|
5215
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
4515
5216
|
*/
|
|
4516
|
-
putOutboundFilespecificationtemplate(fileSpecificationTemplateId, body) {
|
|
5217
|
+
putOutboundFilespecificationtemplate(fileSpecificationTemplateId, body, opts) {
|
|
5218
|
+
opts = opts || {};
|
|
5219
|
+
|
|
4517
5220
|
// verify the required parameter 'fileSpecificationTemplateId' is set
|
|
4518
5221
|
if (fileSpecificationTemplateId === undefined || fileSpecificationTemplateId === null || fileSpecificationTemplateId === '') {
|
|
4519
5222
|
throw 'Missing the required parameter "fileSpecificationTemplateId" when calling putOutboundFilespecificationtemplate';
|
|
@@ -4533,7 +5236,8 @@ class OutboundApi {
|
|
|
4533
5236
|
body,
|
|
4534
5237
|
['PureCloud OAuth'],
|
|
4535
5238
|
['application/json'],
|
|
4536
|
-
['application/json']
|
|
5239
|
+
['application/json'],
|
|
5240
|
+
opts['customHeaders']
|
|
4537
5241
|
);
|
|
4538
5242
|
}
|
|
4539
5243
|
|
|
@@ -4542,8 +5246,12 @@ class OutboundApi {
|
|
|
4542
5246
|
*
|
|
4543
5247
|
* @param {String} importTemplateId Import Template ID
|
|
4544
5248
|
* @param {Object} body importTemplate
|
|
5249
|
+
* @param {Object} opts Optional parameters
|
|
5250
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
4545
5251
|
*/
|
|
4546
|
-
putOutboundImporttemplate(importTemplateId, body) {
|
|
5252
|
+
putOutboundImporttemplate(importTemplateId, body, opts) {
|
|
5253
|
+
opts = opts || {};
|
|
5254
|
+
|
|
4547
5255
|
// verify the required parameter 'importTemplateId' is set
|
|
4548
5256
|
if (importTemplateId === undefined || importTemplateId === null || importTemplateId === '') {
|
|
4549
5257
|
throw 'Missing the required parameter "importTemplateId" when calling putOutboundImporttemplate';
|
|
@@ -4563,7 +5271,8 @@ class OutboundApi {
|
|
|
4563
5271
|
body,
|
|
4564
5272
|
['PureCloud OAuth'],
|
|
4565
5273
|
['application/json'],
|
|
4566
|
-
['application/json']
|
|
5274
|
+
['application/json'],
|
|
5275
|
+
opts['customHeaders']
|
|
4567
5276
|
);
|
|
4568
5277
|
}
|
|
4569
5278
|
|
|
@@ -4572,8 +5281,12 @@ class OutboundApi {
|
|
|
4572
5281
|
*
|
|
4573
5282
|
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
4574
5283
|
* @param {Object} body MessagingCampaign
|
|
5284
|
+
* @param {Object} opts Optional parameters
|
|
5285
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
4575
5286
|
*/
|
|
4576
|
-
putOutboundMessagingcampaign(messagingCampaignId, body) {
|
|
5287
|
+
putOutboundMessagingcampaign(messagingCampaignId, body, opts) {
|
|
5288
|
+
opts = opts || {};
|
|
5289
|
+
|
|
4577
5290
|
// verify the required parameter 'messagingCampaignId' is set
|
|
4578
5291
|
if (messagingCampaignId === undefined || messagingCampaignId === null || messagingCampaignId === '') {
|
|
4579
5292
|
throw 'Missing the required parameter "messagingCampaignId" when calling putOutboundMessagingcampaign';
|
|
@@ -4593,7 +5306,8 @@ class OutboundApi {
|
|
|
4593
5306
|
body,
|
|
4594
5307
|
['PureCloud OAuth'],
|
|
4595
5308
|
['application/json'],
|
|
4596
|
-
['application/json']
|
|
5309
|
+
['application/json'],
|
|
5310
|
+
opts['customHeaders']
|
|
4597
5311
|
);
|
|
4598
5312
|
}
|
|
4599
5313
|
|
|
@@ -4602,8 +5316,12 @@ class OutboundApi {
|
|
|
4602
5316
|
*
|
|
4603
5317
|
* @param {String} ruleSetId Rule Set ID
|
|
4604
5318
|
* @param {Object} body RuleSet
|
|
5319
|
+
* @param {Object} opts Optional parameters
|
|
5320
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
4605
5321
|
*/
|
|
4606
|
-
putOutboundRuleset(ruleSetId, body) {
|
|
5322
|
+
putOutboundRuleset(ruleSetId, body, opts) {
|
|
5323
|
+
opts = opts || {};
|
|
5324
|
+
|
|
4607
5325
|
// verify the required parameter 'ruleSetId' is set
|
|
4608
5326
|
if (ruleSetId === undefined || ruleSetId === null || ruleSetId === '') {
|
|
4609
5327
|
throw 'Missing the required parameter "ruleSetId" when calling putOutboundRuleset';
|
|
@@ -4623,7 +5341,8 @@ class OutboundApi {
|
|
|
4623
5341
|
body,
|
|
4624
5342
|
['PureCloud OAuth'],
|
|
4625
5343
|
['application/json'],
|
|
4626
|
-
['application/json']
|
|
5344
|
+
['application/json'],
|
|
5345
|
+
opts['customHeaders']
|
|
4627
5346
|
);
|
|
4628
5347
|
}
|
|
4629
5348
|
|
|
@@ -4632,8 +5351,12 @@ class OutboundApi {
|
|
|
4632
5351
|
*
|
|
4633
5352
|
* @param {String} campaignId Campaign ID
|
|
4634
5353
|
* @param {Object} body CampaignSchedule
|
|
5354
|
+
* @param {Object} opts Optional parameters
|
|
5355
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
4635
5356
|
*/
|
|
4636
|
-
putOutboundSchedulesCampaign(campaignId, body) {
|
|
5357
|
+
putOutboundSchedulesCampaign(campaignId, body, opts) {
|
|
5358
|
+
opts = opts || {};
|
|
5359
|
+
|
|
4637
5360
|
// verify the required parameter 'campaignId' is set
|
|
4638
5361
|
if (campaignId === undefined || campaignId === null || campaignId === '') {
|
|
4639
5362
|
throw 'Missing the required parameter "campaignId" when calling putOutboundSchedulesCampaign';
|
|
@@ -4653,7 +5376,8 @@ class OutboundApi {
|
|
|
4653
5376
|
body,
|
|
4654
5377
|
['PureCloud OAuth'],
|
|
4655
5378
|
['application/json'],
|
|
4656
|
-
['application/json']
|
|
5379
|
+
['application/json'],
|
|
5380
|
+
opts['customHeaders']
|
|
4657
5381
|
);
|
|
4658
5382
|
}
|
|
4659
5383
|
|
|
@@ -4662,8 +5386,12 @@ class OutboundApi {
|
|
|
4662
5386
|
*
|
|
4663
5387
|
* @param {String} emailCampaignId Email Campaign ID
|
|
4664
5388
|
* @param {Object} body EmailCampaignSchedule
|
|
5389
|
+
* @param {Object} opts Optional parameters
|
|
5390
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
4665
5391
|
*/
|
|
4666
|
-
putOutboundSchedulesEmailcampaign(emailCampaignId, body) {
|
|
5392
|
+
putOutboundSchedulesEmailcampaign(emailCampaignId, body, opts) {
|
|
5393
|
+
opts = opts || {};
|
|
5394
|
+
|
|
4667
5395
|
// verify the required parameter 'emailCampaignId' is set
|
|
4668
5396
|
if (emailCampaignId === undefined || emailCampaignId === null || emailCampaignId === '') {
|
|
4669
5397
|
throw 'Missing the required parameter "emailCampaignId" when calling putOutboundSchedulesEmailcampaign';
|
|
@@ -4683,7 +5411,8 @@ class OutboundApi {
|
|
|
4683
5411
|
body,
|
|
4684
5412
|
['PureCloud OAuth'],
|
|
4685
5413
|
['application/json'],
|
|
4686
|
-
['application/json']
|
|
5414
|
+
['application/json'],
|
|
5415
|
+
opts['customHeaders']
|
|
4687
5416
|
);
|
|
4688
5417
|
}
|
|
4689
5418
|
|
|
@@ -4692,8 +5421,12 @@ class OutboundApi {
|
|
|
4692
5421
|
*
|
|
4693
5422
|
* @param {String} messagingCampaignId Messaging Campaign ID
|
|
4694
5423
|
* @param {Object} body MessagingCampaignSchedule
|
|
5424
|
+
* @param {Object} opts Optional parameters
|
|
5425
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
4695
5426
|
*/
|
|
4696
|
-
putOutboundSchedulesMessagingcampaign(messagingCampaignId, body) {
|
|
5427
|
+
putOutboundSchedulesMessagingcampaign(messagingCampaignId, body, opts) {
|
|
5428
|
+
opts = opts || {};
|
|
5429
|
+
|
|
4697
5430
|
// verify the required parameter 'messagingCampaignId' is set
|
|
4698
5431
|
if (messagingCampaignId === undefined || messagingCampaignId === null || messagingCampaignId === '') {
|
|
4699
5432
|
throw 'Missing the required parameter "messagingCampaignId" when calling putOutboundSchedulesMessagingcampaign';
|
|
@@ -4713,7 +5446,8 @@ class OutboundApi {
|
|
|
4713
5446
|
body,
|
|
4714
5447
|
['PureCloud OAuth'],
|
|
4715
5448
|
['application/json'],
|
|
4716
|
-
['application/json']
|
|
5449
|
+
['application/json'],
|
|
5450
|
+
opts['customHeaders']
|
|
4717
5451
|
);
|
|
4718
5452
|
}
|
|
4719
5453
|
|
|
@@ -4722,8 +5456,12 @@ class OutboundApi {
|
|
|
4722
5456
|
*
|
|
4723
5457
|
* @param {String} sequenceId Sequence ID
|
|
4724
5458
|
* @param {Object} body SequenceSchedule
|
|
5459
|
+
* @param {Object} opts Optional parameters
|
|
5460
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
4725
5461
|
*/
|
|
4726
|
-
putOutboundSchedulesSequence(sequenceId, body) {
|
|
5462
|
+
putOutboundSchedulesSequence(sequenceId, body, opts) {
|
|
5463
|
+
opts = opts || {};
|
|
5464
|
+
|
|
4727
5465
|
// verify the required parameter 'sequenceId' is set
|
|
4728
5466
|
if (sequenceId === undefined || sequenceId === null || sequenceId === '') {
|
|
4729
5467
|
throw 'Missing the required parameter "sequenceId" when calling putOutboundSchedulesSequence';
|
|
@@ -4743,7 +5481,8 @@ class OutboundApi {
|
|
|
4743
5481
|
body,
|
|
4744
5482
|
['PureCloud OAuth'],
|
|
4745
5483
|
['application/json'],
|
|
4746
|
-
['application/json']
|
|
5484
|
+
['application/json'],
|
|
5485
|
+
opts['customHeaders']
|
|
4747
5486
|
);
|
|
4748
5487
|
}
|
|
4749
5488
|
|
|
@@ -4752,8 +5491,12 @@ class OutboundApi {
|
|
|
4752
5491
|
*
|
|
4753
5492
|
* @param {String} whatsAppCampaignId WhatsApp Campaign ID
|
|
4754
5493
|
* @param {Object} body WhatsAppCampaignSchedule
|
|
5494
|
+
* @param {Object} opts Optional parameters
|
|
5495
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
4755
5496
|
*/
|
|
4756
|
-
putOutboundSchedulesWhatsappcampaign(whatsAppCampaignId, body) {
|
|
5497
|
+
putOutboundSchedulesWhatsappcampaign(whatsAppCampaignId, body, opts) {
|
|
5498
|
+
opts = opts || {};
|
|
5499
|
+
|
|
4757
5500
|
// verify the required parameter 'whatsAppCampaignId' is set
|
|
4758
5501
|
if (whatsAppCampaignId === undefined || whatsAppCampaignId === null || whatsAppCampaignId === '') {
|
|
4759
5502
|
throw 'Missing the required parameter "whatsAppCampaignId" when calling putOutboundSchedulesWhatsappcampaign';
|
|
@@ -4773,7 +5516,8 @@ class OutboundApi {
|
|
|
4773
5516
|
body,
|
|
4774
5517
|
['PureCloud OAuth'],
|
|
4775
5518
|
['application/json'],
|
|
4776
|
-
['application/json']
|
|
5519
|
+
['application/json'],
|
|
5520
|
+
opts['customHeaders']
|
|
4777
5521
|
);
|
|
4778
5522
|
}
|
|
4779
5523
|
|
|
@@ -4782,8 +5526,12 @@ class OutboundApi {
|
|
|
4782
5526
|
*
|
|
4783
5527
|
* @param {String} sequenceId Campaign Sequence ID
|
|
4784
5528
|
* @param {Object} body Organization
|
|
5529
|
+
* @param {Object} opts Optional parameters
|
|
5530
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
4785
5531
|
*/
|
|
4786
|
-
putOutboundSequence(sequenceId, body) {
|
|
5532
|
+
putOutboundSequence(sequenceId, body, opts) {
|
|
5533
|
+
opts = opts || {};
|
|
5534
|
+
|
|
4787
5535
|
// verify the required parameter 'sequenceId' is set
|
|
4788
5536
|
if (sequenceId === undefined || sequenceId === null || sequenceId === '') {
|
|
4789
5537
|
throw 'Missing the required parameter "sequenceId" when calling putOutboundSequence';
|
|
@@ -4803,7 +5551,8 @@ class OutboundApi {
|
|
|
4803
5551
|
body,
|
|
4804
5552
|
['PureCloud OAuth'],
|
|
4805
5553
|
['application/json'],
|
|
4806
|
-
['application/json']
|
|
5554
|
+
['application/json'],
|
|
5555
|
+
opts['customHeaders']
|
|
4807
5556
|
);
|
|
4808
5557
|
}
|
|
4809
5558
|
|
|
@@ -4811,8 +5560,12 @@ class OutboundApi {
|
|
|
4811
5560
|
* Update the Dialer wrap up code mapping.
|
|
4812
5561
|
*
|
|
4813
5562
|
* @param {Object} body wrapUpCodeMapping
|
|
5563
|
+
* @param {Object} opts Optional parameters
|
|
5564
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
4814
5565
|
*/
|
|
4815
|
-
putOutboundWrapupcodemappings(body) {
|
|
5566
|
+
putOutboundWrapupcodemappings(body, opts) {
|
|
5567
|
+
opts = opts || {};
|
|
5568
|
+
|
|
4816
5569
|
// verify the required parameter 'body' is set
|
|
4817
5570
|
if (body === undefined || body === null) {
|
|
4818
5571
|
throw 'Missing the required parameter "body" when calling putOutboundWrapupcodemappings';
|
|
@@ -4828,7 +5581,8 @@ class OutboundApi {
|
|
|
4828
5581
|
body,
|
|
4829
5582
|
['PureCloud OAuth'],
|
|
4830
5583
|
['application/json'],
|
|
4831
|
-
['application/json']
|
|
5584
|
+
['application/json'],
|
|
5585
|
+
opts['customHeaders']
|
|
4832
5586
|
);
|
|
4833
5587
|
}
|
|
4834
5588
|
|