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 ExternalContactsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* ExternalContacts service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 250.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -24,8 +24,12 @@ class ExternalContactsApi {
|
|
|
24
24
|
* Delete an external contact
|
|
25
25
|
*
|
|
26
26
|
* @param {String} contactId ExternalContact ID
|
|
27
|
+
* @param {Object} opts Optional parameters
|
|
28
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
27
29
|
*/
|
|
28
|
-
deleteExternalcontactsContact(contactId) {
|
|
30
|
+
deleteExternalcontactsContact(contactId, opts) {
|
|
31
|
+
opts = opts || {};
|
|
32
|
+
|
|
29
33
|
// verify the required parameter 'contactId' is set
|
|
30
34
|
if (contactId === undefined || contactId === null || contactId === '') {
|
|
31
35
|
throw 'Missing the required parameter "contactId" when calling deleteExternalcontactsContact';
|
|
@@ -41,7 +45,8 @@ class ExternalContactsApi {
|
|
|
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
|
|
|
@@ -50,8 +55,12 @@ class ExternalContactsApi {
|
|
|
50
55
|
*
|
|
51
56
|
* @param {String} contactId ExternalContact Id
|
|
52
57
|
* @param {String} noteId Note Id
|
|
58
|
+
* @param {Object} opts Optional parameters
|
|
59
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
53
60
|
*/
|
|
54
|
-
deleteExternalcontactsContactNote(contactId, noteId) {
|
|
61
|
+
deleteExternalcontactsContactNote(contactId, noteId, opts) {
|
|
62
|
+
opts = opts || {};
|
|
63
|
+
|
|
55
64
|
// verify the required parameter 'contactId' is set
|
|
56
65
|
if (contactId === undefined || contactId === null || contactId === '') {
|
|
57
66
|
throw 'Missing the required parameter "contactId" when calling deleteExternalcontactsContactNote';
|
|
@@ -71,7 +80,8 @@ class ExternalContactsApi {
|
|
|
71
80
|
null,
|
|
72
81
|
['PureCloud OAuth'],
|
|
73
82
|
['application/json'],
|
|
74
|
-
['application/json']
|
|
83
|
+
['application/json'],
|
|
84
|
+
opts['customHeaders']
|
|
75
85
|
);
|
|
76
86
|
}
|
|
77
87
|
|
|
@@ -79,8 +89,12 @@ class ExternalContactsApi {
|
|
|
79
89
|
* Delete a schema
|
|
80
90
|
*
|
|
81
91
|
* @param {String} schemaId Schema ID
|
|
92
|
+
* @param {Object} opts Optional parameters
|
|
93
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
82
94
|
*/
|
|
83
|
-
deleteExternalcontactsContactsSchema(schemaId) {
|
|
95
|
+
deleteExternalcontactsContactsSchema(schemaId, opts) {
|
|
96
|
+
opts = opts || {};
|
|
97
|
+
|
|
84
98
|
// verify the required parameter 'schemaId' is set
|
|
85
99
|
if (schemaId === undefined || schemaId === null || schemaId === '') {
|
|
86
100
|
throw 'Missing the required parameter "schemaId" when calling deleteExternalcontactsContactsSchema';
|
|
@@ -96,7 +110,8 @@ class ExternalContactsApi {
|
|
|
96
110
|
null,
|
|
97
111
|
['PureCloud OAuth'],
|
|
98
112
|
['application/json'],
|
|
99
|
-
['application/json']
|
|
113
|
+
['application/json'],
|
|
114
|
+
opts['customHeaders']
|
|
100
115
|
);
|
|
101
116
|
}
|
|
102
117
|
|
|
@@ -104,8 +119,12 @@ class ExternalContactsApi {
|
|
|
104
119
|
* Delete an External Source. WARNING: Any records that reference this External Source will not be automatically cleaned up. Those records will still be editable, but their External IDs may not be fully viewable.
|
|
105
120
|
*
|
|
106
121
|
* @param {String} externalSourceId External Source ID
|
|
122
|
+
* @param {Object} opts Optional parameters
|
|
123
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
107
124
|
*/
|
|
108
|
-
deleteExternalcontactsExternalsource(externalSourceId) {
|
|
125
|
+
deleteExternalcontactsExternalsource(externalSourceId, opts) {
|
|
126
|
+
opts = opts || {};
|
|
127
|
+
|
|
109
128
|
// verify the required parameter 'externalSourceId' is set
|
|
110
129
|
if (externalSourceId === undefined || externalSourceId === null || externalSourceId === '') {
|
|
111
130
|
throw 'Missing the required parameter "externalSourceId" when calling deleteExternalcontactsExternalsource';
|
|
@@ -121,7 +140,8 @@ class ExternalContactsApi {
|
|
|
121
140
|
null,
|
|
122
141
|
['PureCloud OAuth'],
|
|
123
142
|
['application/json'],
|
|
124
|
-
['application/json']
|
|
143
|
+
['application/json'],
|
|
144
|
+
opts['customHeaders']
|
|
125
145
|
);
|
|
126
146
|
}
|
|
127
147
|
|
|
@@ -129,8 +149,12 @@ class ExternalContactsApi {
|
|
|
129
149
|
* Delete settings for CSV import
|
|
130
150
|
*
|
|
131
151
|
* @param {String} settingsId Settings id
|
|
152
|
+
* @param {Object} opts Optional parameters
|
|
153
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
132
154
|
*/
|
|
133
|
-
deleteExternalcontactsImportCsvSetting(settingsId) {
|
|
155
|
+
deleteExternalcontactsImportCsvSetting(settingsId, opts) {
|
|
156
|
+
opts = opts || {};
|
|
157
|
+
|
|
134
158
|
// verify the required parameter 'settingsId' is set
|
|
135
159
|
if (settingsId === undefined || settingsId === null || settingsId === '') {
|
|
136
160
|
throw 'Missing the required parameter "settingsId" when calling deleteExternalcontactsImportCsvSetting';
|
|
@@ -146,7 +170,8 @@ class ExternalContactsApi {
|
|
|
146
170
|
null,
|
|
147
171
|
['PureCloud OAuth'],
|
|
148
172
|
['application/json'],
|
|
149
|
-
['application/json']
|
|
173
|
+
['application/json'],
|
|
174
|
+
opts['customHeaders']
|
|
150
175
|
);
|
|
151
176
|
}
|
|
152
177
|
|
|
@@ -154,8 +179,12 @@ class ExternalContactsApi {
|
|
|
154
179
|
* Delete Settings
|
|
155
180
|
*
|
|
156
181
|
* @param {String} settingsId Settings id
|
|
182
|
+
* @param {Object} opts Optional parameters
|
|
183
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
157
184
|
*/
|
|
158
|
-
deleteExternalcontactsImportSetting(settingsId) {
|
|
185
|
+
deleteExternalcontactsImportSetting(settingsId, opts) {
|
|
186
|
+
opts = opts || {};
|
|
187
|
+
|
|
159
188
|
// verify the required parameter 'settingsId' is set
|
|
160
189
|
if (settingsId === undefined || settingsId === null || settingsId === '') {
|
|
161
190
|
throw 'Missing the required parameter "settingsId" when calling deleteExternalcontactsImportSetting';
|
|
@@ -171,7 +200,8 @@ class ExternalContactsApi {
|
|
|
171
200
|
null,
|
|
172
201
|
['PureCloud OAuth'],
|
|
173
202
|
['application/json'],
|
|
174
|
-
['application/json']
|
|
203
|
+
['application/json'],
|
|
204
|
+
opts['customHeaders']
|
|
175
205
|
);
|
|
176
206
|
}
|
|
177
207
|
|
|
@@ -179,8 +209,12 @@ class ExternalContactsApi {
|
|
|
179
209
|
* Delete an external organization
|
|
180
210
|
*
|
|
181
211
|
* @param {String} externalOrganizationId External Organization ID
|
|
212
|
+
* @param {Object} opts Optional parameters
|
|
213
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
182
214
|
*/
|
|
183
|
-
deleteExternalcontactsOrganization(externalOrganizationId) {
|
|
215
|
+
deleteExternalcontactsOrganization(externalOrganizationId, opts) {
|
|
216
|
+
opts = opts || {};
|
|
217
|
+
|
|
184
218
|
// verify the required parameter 'externalOrganizationId' is set
|
|
185
219
|
if (externalOrganizationId === undefined || externalOrganizationId === null || externalOrganizationId === '') {
|
|
186
220
|
throw 'Missing the required parameter "externalOrganizationId" when calling deleteExternalcontactsOrganization';
|
|
@@ -196,7 +230,8 @@ class ExternalContactsApi {
|
|
|
196
230
|
null,
|
|
197
231
|
['PureCloud OAuth'],
|
|
198
232
|
['application/json'],
|
|
199
|
-
['application/json']
|
|
233
|
+
['application/json'],
|
|
234
|
+
opts['customHeaders']
|
|
200
235
|
);
|
|
201
236
|
}
|
|
202
237
|
|
|
@@ -205,8 +240,12 @@ class ExternalContactsApi {
|
|
|
205
240
|
*
|
|
206
241
|
* @param {String} externalOrganizationId External Organization Id
|
|
207
242
|
* @param {String} noteId Note Id
|
|
243
|
+
* @param {Object} opts Optional parameters
|
|
244
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
208
245
|
*/
|
|
209
|
-
deleteExternalcontactsOrganizationNote(externalOrganizationId, noteId) {
|
|
246
|
+
deleteExternalcontactsOrganizationNote(externalOrganizationId, noteId, opts) {
|
|
247
|
+
opts = opts || {};
|
|
248
|
+
|
|
210
249
|
// verify the required parameter 'externalOrganizationId' is set
|
|
211
250
|
if (externalOrganizationId === undefined || externalOrganizationId === null || externalOrganizationId === '') {
|
|
212
251
|
throw 'Missing the required parameter "externalOrganizationId" when calling deleteExternalcontactsOrganizationNote';
|
|
@@ -226,7 +265,8 @@ class ExternalContactsApi {
|
|
|
226
265
|
null,
|
|
227
266
|
['PureCloud OAuth'],
|
|
228
267
|
['application/json'],
|
|
229
|
-
['application/json']
|
|
268
|
+
['application/json'],
|
|
269
|
+
opts['customHeaders']
|
|
230
270
|
);
|
|
231
271
|
}
|
|
232
272
|
|
|
@@ -234,8 +274,12 @@ class ExternalContactsApi {
|
|
|
234
274
|
* Unlink the Trustor for this External Organization
|
|
235
275
|
*
|
|
236
276
|
* @param {String} externalOrganizationId External Organization ID
|
|
277
|
+
* @param {Object} opts Optional parameters
|
|
278
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
237
279
|
*/
|
|
238
|
-
deleteExternalcontactsOrganizationTrustor(externalOrganizationId) {
|
|
280
|
+
deleteExternalcontactsOrganizationTrustor(externalOrganizationId, opts) {
|
|
281
|
+
opts = opts || {};
|
|
282
|
+
|
|
239
283
|
// verify the required parameter 'externalOrganizationId' is set
|
|
240
284
|
if (externalOrganizationId === undefined || externalOrganizationId === null || externalOrganizationId === '') {
|
|
241
285
|
throw 'Missing the required parameter "externalOrganizationId" when calling deleteExternalcontactsOrganizationTrustor';
|
|
@@ -251,7 +295,8 @@ class ExternalContactsApi {
|
|
|
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 ExternalContactsApi {
|
|
|
259
304
|
* Delete a relationship
|
|
260
305
|
*
|
|
261
306
|
* @param {String} relationshipId Relationship Id
|
|
307
|
+
* @param {Object} opts Optional parameters
|
|
308
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
262
309
|
*/
|
|
263
|
-
deleteExternalcontactsRelationship(relationshipId) {
|
|
310
|
+
deleteExternalcontactsRelationship(relationshipId, opts) {
|
|
311
|
+
opts = opts || {};
|
|
312
|
+
|
|
264
313
|
// verify the required parameter 'relationshipId' is set
|
|
265
314
|
if (relationshipId === undefined || relationshipId === null || relationshipId === '') {
|
|
266
315
|
throw 'Missing the required parameter "relationshipId" when calling deleteExternalcontactsRelationship';
|
|
@@ -276,7 +325,8 @@ class ExternalContactsApi {
|
|
|
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
|
|
|
@@ -286,6 +336,7 @@ class ExternalContactsApi {
|
|
|
286
336
|
* @param {String} contactId ExternalContact ID
|
|
287
337
|
* @param {Object} opts Optional parameters
|
|
288
338
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
339
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
289
340
|
*/
|
|
290
341
|
getExternalcontactsContact(contactId, opts) {
|
|
291
342
|
opts = opts || {};
|
|
@@ -305,7 +356,8 @@ class ExternalContactsApi {
|
|
|
305
356
|
null,
|
|
306
357
|
['PureCloud OAuth'],
|
|
307
358
|
['application/json'],
|
|
308
|
-
['application/json']
|
|
359
|
+
['application/json'],
|
|
360
|
+
opts['customHeaders']
|
|
309
361
|
);
|
|
310
362
|
}
|
|
311
363
|
|
|
@@ -313,8 +365,12 @@ class ExternalContactsApi {
|
|
|
313
365
|
* List the identifiers for a contact
|
|
314
366
|
*
|
|
315
367
|
* @param {String} contactId ExternalContact ID
|
|
368
|
+
* @param {Object} opts Optional parameters
|
|
369
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
316
370
|
*/
|
|
317
|
-
getExternalcontactsContactIdentifiers(contactId) {
|
|
371
|
+
getExternalcontactsContactIdentifiers(contactId, opts) {
|
|
372
|
+
opts = opts || {};
|
|
373
|
+
|
|
318
374
|
// verify the required parameter 'contactId' is set
|
|
319
375
|
if (contactId === undefined || contactId === null || contactId === '') {
|
|
320
376
|
throw 'Missing the required parameter "contactId" when calling getExternalcontactsContactIdentifiers';
|
|
@@ -330,7 +386,8 @@ class ExternalContactsApi {
|
|
|
330
386
|
null,
|
|
331
387
|
['PureCloud OAuth'],
|
|
332
388
|
['application/json'],
|
|
333
|
-
['application/json']
|
|
389
|
+
['application/json'],
|
|
390
|
+
opts['customHeaders']
|
|
334
391
|
);
|
|
335
392
|
}
|
|
336
393
|
|
|
@@ -341,6 +398,7 @@ class ExternalContactsApi {
|
|
|
341
398
|
* @param {Object} opts Optional parameters
|
|
342
399
|
* @param {Boolean} opts.includeMerged Indicates whether to return segment assignments from all external contacts in the merge-set of the given one.
|
|
343
400
|
* @param {Number} opts.limit Number of entities to return. Default of 25, maximum of 500.
|
|
401
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
344
402
|
*/
|
|
345
403
|
getExternalcontactsContactJourneySegments(contactId, opts) {
|
|
346
404
|
opts = opts || {};
|
|
@@ -360,7 +418,8 @@ class ExternalContactsApi {
|
|
|
360
418
|
null,
|
|
361
419
|
['PureCloud OAuth'],
|
|
362
420
|
['application/json'],
|
|
363
|
-
['application/json']
|
|
421
|
+
['application/json'],
|
|
422
|
+
opts['customHeaders']
|
|
364
423
|
);
|
|
365
424
|
}
|
|
366
425
|
|
|
@@ -372,6 +431,7 @@ class ExternalContactsApi {
|
|
|
372
431
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
373
432
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
374
433
|
* @param {Boolean} opts.includeMerged Indicates whether to return sessions from all external contacts in the merge-set of the given one.
|
|
434
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
375
435
|
*/
|
|
376
436
|
getExternalcontactsContactJourneySessions(contactId, opts) {
|
|
377
437
|
opts = opts || {};
|
|
@@ -391,7 +451,8 @@ class ExternalContactsApi {
|
|
|
391
451
|
null,
|
|
392
452
|
['PureCloud OAuth'],
|
|
393
453
|
['application/json'],
|
|
394
|
-
['application/json']
|
|
454
|
+
['application/json'],
|
|
455
|
+
opts['customHeaders']
|
|
395
456
|
);
|
|
396
457
|
}
|
|
397
458
|
|
|
@@ -402,6 +463,7 @@ class ExternalContactsApi {
|
|
|
402
463
|
* @param {String} noteId Note Id
|
|
403
464
|
* @param {Object} opts Optional parameters
|
|
404
465
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
466
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
405
467
|
*/
|
|
406
468
|
getExternalcontactsContactNote(contactId, noteId, opts) {
|
|
407
469
|
opts = opts || {};
|
|
@@ -425,7 +487,8 @@ class ExternalContactsApi {
|
|
|
425
487
|
null,
|
|
426
488
|
['PureCloud OAuth'],
|
|
427
489
|
['application/json'],
|
|
428
|
-
['application/json']
|
|
490
|
+
['application/json'],
|
|
491
|
+
opts['customHeaders']
|
|
429
492
|
);
|
|
430
493
|
}
|
|
431
494
|
|
|
@@ -438,6 +501,7 @@ class ExternalContactsApi {
|
|
|
438
501
|
* @param {Number} opts.pageNumber Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 1)
|
|
439
502
|
* @param {String} opts.sortOrder The Note field to sort by. Any of: [createDate]. Direction: [asc, desc]. e.g. createDate:asc, createDate:desc
|
|
440
503
|
* @param {Array.<String>} opts.expand which fields, if any, to expand. mergeset will include notes attached to ancestor contacts which have been merged into this one.
|
|
504
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
441
505
|
*/
|
|
442
506
|
getExternalcontactsContactNotes(contactId, opts) {
|
|
443
507
|
opts = opts || {};
|
|
@@ -457,7 +521,8 @@ class ExternalContactsApi {
|
|
|
457
521
|
null,
|
|
458
522
|
['PureCloud OAuth'],
|
|
459
523
|
['application/json'],
|
|
460
|
-
['application/json']
|
|
524
|
+
['application/json'],
|
|
525
|
+
opts['customHeaders']
|
|
461
526
|
);
|
|
462
527
|
}
|
|
463
528
|
|
|
@@ -467,6 +532,7 @@ class ExternalContactsApi {
|
|
|
467
532
|
* @param {String} contactId ExternalContact ID
|
|
468
533
|
* @param {Object} opts Optional parameters
|
|
469
534
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
535
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
470
536
|
*/
|
|
471
537
|
getExternalcontactsContactUnresolved(contactId, opts) {
|
|
472
538
|
opts = opts || {};
|
|
@@ -486,7 +552,8 @@ class ExternalContactsApi {
|
|
|
486
552
|
null,
|
|
487
553
|
['PureCloud OAuth'],
|
|
488
554
|
['application/json'],
|
|
489
|
-
['application/json']
|
|
555
|
+
['application/json'],
|
|
556
|
+
opts['customHeaders']
|
|
490
557
|
);
|
|
491
558
|
}
|
|
492
559
|
|
|
@@ -500,6 +567,7 @@ class ExternalContactsApi {
|
|
|
500
567
|
* @param {String} opts.sortOrder The External Contact field to sort by. Any of: [firstName, lastName, middleName, title]. Direction: [asc, desc]. e.g. firstName:asc, title:desc
|
|
501
568
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
502
569
|
* @param {Array.<String>} opts.divisionIds which divisions to search, up to 50
|
|
570
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
503
571
|
*/
|
|
504
572
|
getExternalcontactsContacts(opts) {
|
|
505
573
|
opts = opts || {};
|
|
@@ -515,7 +583,8 @@ class ExternalContactsApi {
|
|
|
515
583
|
null,
|
|
516
584
|
['PureCloud OAuth'],
|
|
517
585
|
['application/json'],
|
|
518
|
-
['application/json']
|
|
586
|
+
['application/json'],
|
|
587
|
+
opts['customHeaders']
|
|
519
588
|
);
|
|
520
589
|
}
|
|
521
590
|
|
|
@@ -523,8 +592,12 @@ class ExternalContactsApi {
|
|
|
523
592
|
* Get export for exportId
|
|
524
593
|
*
|
|
525
594
|
* @param {String} exportId Export id
|
|
595
|
+
* @param {Object} opts Optional parameters
|
|
596
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
526
597
|
*/
|
|
527
|
-
getExternalcontactsContactsExport(exportId) {
|
|
598
|
+
getExternalcontactsContactsExport(exportId, opts) {
|
|
599
|
+
opts = opts || {};
|
|
600
|
+
|
|
528
601
|
// verify the required parameter 'exportId' is set
|
|
529
602
|
if (exportId === undefined || exportId === null || exportId === '') {
|
|
530
603
|
throw 'Missing the required parameter "exportId" when calling getExternalcontactsContactsExport';
|
|
@@ -540,7 +613,8 @@ class ExternalContactsApi {
|
|
|
540
613
|
null,
|
|
541
614
|
['PureCloud OAuth'],
|
|
542
615
|
['application/json'],
|
|
543
|
-
['application/json']
|
|
616
|
+
['application/json'],
|
|
617
|
+
opts['customHeaders']
|
|
544
618
|
);
|
|
545
619
|
}
|
|
546
620
|
|
|
@@ -551,6 +625,7 @@ class ExternalContactsApi {
|
|
|
551
625
|
* @param {Array.<String>} opts.divisionIds Division IDs of entities
|
|
552
626
|
* @param {String} opts.after The cursor that points to the end of the set of entities
|
|
553
627
|
* @param {Number} opts.pageSize Number of entities to return
|
|
628
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
554
629
|
*/
|
|
555
630
|
getExternalcontactsContactsExports(opts) {
|
|
556
631
|
opts = opts || {};
|
|
@@ -566,7 +641,8 @@ class ExternalContactsApi {
|
|
|
566
641
|
null,
|
|
567
642
|
['PureCloud OAuth'],
|
|
568
643
|
['application/json'],
|
|
569
|
-
['application/json']
|
|
644
|
+
['application/json'],
|
|
645
|
+
opts['customHeaders']
|
|
570
646
|
);
|
|
571
647
|
}
|
|
572
648
|
|
|
@@ -574,8 +650,12 @@ class ExternalContactsApi {
|
|
|
574
650
|
* Get a schema
|
|
575
651
|
*
|
|
576
652
|
* @param {String} schemaId Schema ID
|
|
653
|
+
* @param {Object} opts Optional parameters
|
|
654
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
577
655
|
*/
|
|
578
|
-
getExternalcontactsContactsSchema(schemaId) {
|
|
656
|
+
getExternalcontactsContactsSchema(schemaId, opts) {
|
|
657
|
+
opts = opts || {};
|
|
658
|
+
|
|
579
659
|
// verify the required parameter 'schemaId' is set
|
|
580
660
|
if (schemaId === undefined || schemaId === null || schemaId === '') {
|
|
581
661
|
throw 'Missing the required parameter "schemaId" when calling getExternalcontactsContactsSchema';
|
|
@@ -591,7 +671,8 @@ class ExternalContactsApi {
|
|
|
591
671
|
null,
|
|
592
672
|
['PureCloud OAuth'],
|
|
593
673
|
['application/json'],
|
|
594
|
-
['application/json']
|
|
674
|
+
['application/json'],
|
|
675
|
+
opts['customHeaders']
|
|
595
676
|
);
|
|
596
677
|
}
|
|
597
678
|
|
|
@@ -600,8 +681,12 @@ class ExternalContactsApi {
|
|
|
600
681
|
*
|
|
601
682
|
* @param {String} schemaId Schema ID
|
|
602
683
|
* @param {String} versionId Schema version
|
|
684
|
+
* @param {Object} opts Optional parameters
|
|
685
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
603
686
|
*/
|
|
604
|
-
getExternalcontactsContactsSchemaVersion(schemaId, versionId) {
|
|
687
|
+
getExternalcontactsContactsSchemaVersion(schemaId, versionId, opts) {
|
|
688
|
+
opts = opts || {};
|
|
689
|
+
|
|
605
690
|
// verify the required parameter 'schemaId' is set
|
|
606
691
|
if (schemaId === undefined || schemaId === null || schemaId === '') {
|
|
607
692
|
throw 'Missing the required parameter "schemaId" when calling getExternalcontactsContactsSchemaVersion';
|
|
@@ -621,7 +706,8 @@ class ExternalContactsApi {
|
|
|
621
706
|
null,
|
|
622
707
|
['PureCloud OAuth'],
|
|
623
708
|
['application/json'],
|
|
624
|
-
['application/json']
|
|
709
|
+
['application/json'],
|
|
710
|
+
opts['customHeaders']
|
|
625
711
|
);
|
|
626
712
|
}
|
|
627
713
|
|
|
@@ -629,8 +715,12 @@ class ExternalContactsApi {
|
|
|
629
715
|
* Get all versions of an external contact's schema
|
|
630
716
|
*
|
|
631
717
|
* @param {String} schemaId Schema ID
|
|
718
|
+
* @param {Object} opts Optional parameters
|
|
719
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
632
720
|
*/
|
|
633
|
-
getExternalcontactsContactsSchemaVersions(schemaId) {
|
|
721
|
+
getExternalcontactsContactsSchemaVersions(schemaId, opts) {
|
|
722
|
+
opts = opts || {};
|
|
723
|
+
|
|
634
724
|
// verify the required parameter 'schemaId' is set
|
|
635
725
|
if (schemaId === undefined || schemaId === null || schemaId === '') {
|
|
636
726
|
throw 'Missing the required parameter "schemaId" when calling getExternalcontactsContactsSchemaVersions';
|
|
@@ -646,15 +736,20 @@ class ExternalContactsApi {
|
|
|
646
736
|
null,
|
|
647
737
|
['PureCloud OAuth'],
|
|
648
738
|
['application/json'],
|
|
649
|
-
['application/json']
|
|
739
|
+
['application/json'],
|
|
740
|
+
opts['customHeaders']
|
|
650
741
|
);
|
|
651
742
|
}
|
|
652
743
|
|
|
653
744
|
/**
|
|
654
745
|
* Get a list of schemas.
|
|
655
746
|
*
|
|
747
|
+
* @param {Object} opts Optional parameters
|
|
748
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
656
749
|
*/
|
|
657
|
-
getExternalcontactsContactsSchemas() {
|
|
750
|
+
getExternalcontactsContactsSchemas(opts) {
|
|
751
|
+
opts = opts || {};
|
|
752
|
+
|
|
658
753
|
|
|
659
754
|
return this.apiClient.callApi(
|
|
660
755
|
'/api/v2/externalcontacts/contacts/schemas',
|
|
@@ -666,7 +761,8 @@ class ExternalContactsApi {
|
|
|
666
761
|
null,
|
|
667
762
|
['PureCloud OAuth'],
|
|
668
763
|
['application/json'],
|
|
669
|
-
['application/json']
|
|
764
|
+
['application/json'],
|
|
765
|
+
opts['customHeaders']
|
|
670
766
|
);
|
|
671
767
|
}
|
|
672
768
|
|
|
@@ -674,8 +770,12 @@ class ExternalContactsApi {
|
|
|
674
770
|
* Get a specific named core type.
|
|
675
771
|
*
|
|
676
772
|
* @param {String} coreTypeName Name of the core type
|
|
773
|
+
* @param {Object} opts Optional parameters
|
|
774
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
677
775
|
*/
|
|
678
|
-
getExternalcontactsContactsSchemasCoretype(coreTypeName) {
|
|
776
|
+
getExternalcontactsContactsSchemasCoretype(coreTypeName, opts) {
|
|
777
|
+
opts = opts || {};
|
|
778
|
+
|
|
679
779
|
// verify the required parameter 'coreTypeName' is set
|
|
680
780
|
if (coreTypeName === undefined || coreTypeName === null || coreTypeName === '') {
|
|
681
781
|
throw 'Missing the required parameter "coreTypeName" when calling getExternalcontactsContactsSchemasCoretype';
|
|
@@ -691,15 +791,20 @@ class ExternalContactsApi {
|
|
|
691
791
|
null,
|
|
692
792
|
['PureCloud OAuth'],
|
|
693
793
|
['application/json'],
|
|
694
|
-
['application/json']
|
|
794
|
+
['application/json'],
|
|
795
|
+
opts['customHeaders']
|
|
695
796
|
);
|
|
696
797
|
}
|
|
697
798
|
|
|
698
799
|
/**
|
|
699
800
|
* Get the core types from which all schemas are built.
|
|
700
801
|
*
|
|
802
|
+
* @param {Object} opts Optional parameters
|
|
803
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
701
804
|
*/
|
|
702
|
-
getExternalcontactsContactsSchemasCoretypes() {
|
|
805
|
+
getExternalcontactsContactsSchemasCoretypes(opts) {
|
|
806
|
+
opts = opts || {};
|
|
807
|
+
|
|
703
808
|
|
|
704
809
|
return this.apiClient.callApi(
|
|
705
810
|
'/api/v2/externalcontacts/contacts/schemas/coretypes',
|
|
@@ -711,15 +816,20 @@ class ExternalContactsApi {
|
|
|
711
816
|
null,
|
|
712
817
|
['PureCloud OAuth'],
|
|
713
818
|
['application/json'],
|
|
714
|
-
['application/json']
|
|
819
|
+
['application/json'],
|
|
820
|
+
opts['customHeaders']
|
|
715
821
|
);
|
|
716
822
|
}
|
|
717
823
|
|
|
718
824
|
/**
|
|
719
825
|
* Get quantitative limits on schemas
|
|
720
826
|
*
|
|
827
|
+
* @param {Object} opts Optional parameters
|
|
828
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
721
829
|
*/
|
|
722
|
-
getExternalcontactsContactsSchemasLimits() {
|
|
830
|
+
getExternalcontactsContactsSchemasLimits(opts) {
|
|
831
|
+
opts = opts || {};
|
|
832
|
+
|
|
723
833
|
|
|
724
834
|
return this.apiClient.callApi(
|
|
725
835
|
'/api/v2/externalcontacts/contacts/schemas/limits',
|
|
@@ -731,7 +841,8 @@ class ExternalContactsApi {
|
|
|
731
841
|
null,
|
|
732
842
|
['PureCloud OAuth'],
|
|
733
843
|
['application/json'],
|
|
734
|
-
['application/json']
|
|
844
|
+
['application/json'],
|
|
845
|
+
opts['customHeaders']
|
|
735
846
|
);
|
|
736
847
|
}
|
|
737
848
|
|
|
@@ -739,8 +850,12 @@ class ExternalContactsApi {
|
|
|
739
850
|
* Fetch an External Source
|
|
740
851
|
*
|
|
741
852
|
* @param {String} externalSourceId External Source ID
|
|
853
|
+
* @param {Object} opts Optional parameters
|
|
854
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
742
855
|
*/
|
|
743
|
-
getExternalcontactsExternalsource(externalSourceId) {
|
|
856
|
+
getExternalcontactsExternalsource(externalSourceId, opts) {
|
|
857
|
+
opts = opts || {};
|
|
858
|
+
|
|
744
859
|
// verify the required parameter 'externalSourceId' is set
|
|
745
860
|
if (externalSourceId === undefined || externalSourceId === null || externalSourceId === '') {
|
|
746
861
|
throw 'Missing the required parameter "externalSourceId" when calling getExternalcontactsExternalsource';
|
|
@@ -756,7 +871,8 @@ class ExternalContactsApi {
|
|
|
756
871
|
null,
|
|
757
872
|
['PureCloud OAuth'],
|
|
758
873
|
['application/json'],
|
|
759
|
-
['application/json']
|
|
874
|
+
['application/json'],
|
|
875
|
+
opts['customHeaders']
|
|
760
876
|
);
|
|
761
877
|
}
|
|
762
878
|
|
|
@@ -768,6 +884,7 @@ class ExternalContactsApi {
|
|
|
768
884
|
* @param {Number} opts.limit The number of ExternalSources per page; must be between 10 and 200, default is 100
|
|
769
885
|
* @param {String} opts.name Filter by external source name. Filtering is prefix filtering and not an exact match
|
|
770
886
|
* @param {Boolean} opts.active Filter by active status of external source
|
|
887
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
771
888
|
*/
|
|
772
889
|
getExternalcontactsExternalsources(opts) {
|
|
773
890
|
opts = opts || {};
|
|
@@ -783,7 +900,8 @@ class ExternalContactsApi {
|
|
|
783
900
|
null,
|
|
784
901
|
['PureCloud OAuth'],
|
|
785
902
|
['application/json'],
|
|
786
|
-
['application/json']
|
|
903
|
+
['application/json'],
|
|
904
|
+
opts['customHeaders']
|
|
787
905
|
);
|
|
788
906
|
}
|
|
789
907
|
|
|
@@ -791,8 +909,12 @@ class ExternalContactsApi {
|
|
|
791
909
|
* Get settings for CSV import
|
|
792
910
|
*
|
|
793
911
|
* @param {String} settingsId Settings id
|
|
912
|
+
* @param {Object} opts Optional parameters
|
|
913
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
794
914
|
*/
|
|
795
|
-
getExternalcontactsImportCsvSetting(settingsId) {
|
|
915
|
+
getExternalcontactsImportCsvSetting(settingsId, opts) {
|
|
916
|
+
opts = opts || {};
|
|
917
|
+
|
|
796
918
|
// verify the required parameter 'settingsId' is set
|
|
797
919
|
if (settingsId === undefined || settingsId === null || settingsId === '') {
|
|
798
920
|
throw 'Missing the required parameter "settingsId" when calling getExternalcontactsImportCsvSetting';
|
|
@@ -808,7 +930,8 @@ class ExternalContactsApi {
|
|
|
808
930
|
null,
|
|
809
931
|
['PureCloud OAuth'],
|
|
810
932
|
['application/json'],
|
|
811
|
-
['application/json']
|
|
933
|
+
['application/json'],
|
|
934
|
+
opts['customHeaders']
|
|
812
935
|
);
|
|
813
936
|
}
|
|
814
937
|
|
|
@@ -819,6 +942,7 @@ class ExternalContactsApi {
|
|
|
819
942
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
820
943
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
821
944
|
* @param {String} opts.externalSettingsId External Settings Id to filter the list.
|
|
945
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
822
946
|
*/
|
|
823
947
|
getExternalcontactsImportCsvSettings(opts) {
|
|
824
948
|
opts = opts || {};
|
|
@@ -834,7 +958,8 @@ class ExternalContactsApi {
|
|
|
834
958
|
null,
|
|
835
959
|
['PureCloud OAuth'],
|
|
836
960
|
['application/json'],
|
|
837
|
-
['application/json']
|
|
961
|
+
['application/json'],
|
|
962
|
+
opts['customHeaders']
|
|
838
963
|
);
|
|
839
964
|
}
|
|
840
965
|
|
|
@@ -842,8 +967,12 @@ class ExternalContactsApi {
|
|
|
842
967
|
* Get details for CSV upload
|
|
843
968
|
*
|
|
844
969
|
* @param {String} uploadId Upload id
|
|
970
|
+
* @param {Object} opts Optional parameters
|
|
971
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
845
972
|
*/
|
|
846
|
-
getExternalcontactsImportCsvUploadDetails(uploadId) {
|
|
973
|
+
getExternalcontactsImportCsvUploadDetails(uploadId, opts) {
|
|
974
|
+
opts = opts || {};
|
|
975
|
+
|
|
847
976
|
// verify the required parameter 'uploadId' is set
|
|
848
977
|
if (uploadId === undefined || uploadId === null || uploadId === '') {
|
|
849
978
|
throw 'Missing the required parameter "uploadId" when calling getExternalcontactsImportCsvUploadDetails';
|
|
@@ -859,7 +988,8 @@ class ExternalContactsApi {
|
|
|
859
988
|
null,
|
|
860
989
|
['PureCloud OAuth'],
|
|
861
990
|
['application/json'],
|
|
862
|
-
['application/json']
|
|
991
|
+
['application/json'],
|
|
992
|
+
opts['customHeaders']
|
|
863
993
|
);
|
|
864
994
|
}
|
|
865
995
|
|
|
@@ -867,8 +997,12 @@ class ExternalContactsApi {
|
|
|
867
997
|
* Get preview for CSV upload
|
|
868
998
|
*
|
|
869
999
|
* @param {String} uploadId Upload id
|
|
1000
|
+
* @param {Object} opts Optional parameters
|
|
1001
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
870
1002
|
*/
|
|
871
|
-
getExternalcontactsImportCsvUploadPreview(uploadId) {
|
|
1003
|
+
getExternalcontactsImportCsvUploadPreview(uploadId, opts) {
|
|
1004
|
+
opts = opts || {};
|
|
1005
|
+
|
|
872
1006
|
// verify the required parameter 'uploadId' is set
|
|
873
1007
|
if (uploadId === undefined || uploadId === null || uploadId === '') {
|
|
874
1008
|
throw 'Missing the required parameter "uploadId" when calling getExternalcontactsImportCsvUploadPreview';
|
|
@@ -884,7 +1018,8 @@ class ExternalContactsApi {
|
|
|
884
1018
|
null,
|
|
885
1019
|
['PureCloud OAuth'],
|
|
886
1020
|
['application/json'],
|
|
887
|
-
['application/json']
|
|
1021
|
+
['application/json'],
|
|
1022
|
+
opts['customHeaders']
|
|
888
1023
|
);
|
|
889
1024
|
}
|
|
890
1025
|
|
|
@@ -894,6 +1029,7 @@ class ExternalContactsApi {
|
|
|
894
1029
|
* @param {String} jobId Job id
|
|
895
1030
|
* @param {Object} opts Optional parameters
|
|
896
1031
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
1032
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
897
1033
|
*/
|
|
898
1034
|
getExternalcontactsImportJob(jobId, opts) {
|
|
899
1035
|
opts = opts || {};
|
|
@@ -913,7 +1049,8 @@ class ExternalContactsApi {
|
|
|
913
1049
|
null,
|
|
914
1050
|
['PureCloud OAuth'],
|
|
915
1051
|
['application/json'],
|
|
916
|
-
['application/json']
|
|
1052
|
+
['application/json'],
|
|
1053
|
+
opts['customHeaders']
|
|
917
1054
|
);
|
|
918
1055
|
}
|
|
919
1056
|
|
|
@@ -926,6 +1063,7 @@ class ExternalContactsApi {
|
|
|
926
1063
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 100. (default to 25)
|
|
927
1064
|
* @param {Object} opts.sortOrder Direction of sorting. (default to Ascending)
|
|
928
1065
|
* @param {Object} opts.jobStatus Search term to filter by jobStatus
|
|
1066
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
929
1067
|
*/
|
|
930
1068
|
getExternalcontactsImportJobs(opts) {
|
|
931
1069
|
opts = opts || {};
|
|
@@ -941,7 +1079,8 @@ class ExternalContactsApi {
|
|
|
941
1079
|
null,
|
|
942
1080
|
['PureCloud OAuth'],
|
|
943
1081
|
['application/json'],
|
|
944
|
-
['application/json']
|
|
1082
|
+
['application/json'],
|
|
1083
|
+
opts['customHeaders']
|
|
945
1084
|
);
|
|
946
1085
|
}
|
|
947
1086
|
|
|
@@ -949,8 +1088,12 @@ class ExternalContactsApi {
|
|
|
949
1088
|
* Get setting based on id
|
|
950
1089
|
*
|
|
951
1090
|
* @param {String} settingsId Settings id
|
|
1091
|
+
* @param {Object} opts Optional parameters
|
|
1092
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
952
1093
|
*/
|
|
953
|
-
getExternalcontactsImportSetting(settingsId) {
|
|
1094
|
+
getExternalcontactsImportSetting(settingsId, opts) {
|
|
1095
|
+
opts = opts || {};
|
|
1096
|
+
|
|
954
1097
|
// verify the required parameter 'settingsId' is set
|
|
955
1098
|
if (settingsId === undefined || settingsId === null || settingsId === '') {
|
|
956
1099
|
throw 'Missing the required parameter "settingsId" when calling getExternalcontactsImportSetting';
|
|
@@ -966,7 +1109,8 @@ class ExternalContactsApi {
|
|
|
966
1109
|
null,
|
|
967
1110
|
['PureCloud OAuth'],
|
|
968
1111
|
['application/json'],
|
|
969
|
-
['application/json']
|
|
1112
|
+
['application/json'],
|
|
1113
|
+
opts['customHeaders']
|
|
970
1114
|
);
|
|
971
1115
|
}
|
|
972
1116
|
|
|
@@ -978,6 +1122,7 @@ class ExternalContactsApi {
|
|
|
978
1122
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 100. (default to 25)
|
|
979
1123
|
* @param {Object} opts.sortOrder Direction of sorting. (default to Ascending)
|
|
980
1124
|
* @param {String} opts.name Search term to filter by settings name
|
|
1125
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
981
1126
|
*/
|
|
982
1127
|
getExternalcontactsImportSettings(opts) {
|
|
983
1128
|
opts = opts || {};
|
|
@@ -993,7 +1138,8 @@ class ExternalContactsApi {
|
|
|
993
1138
|
null,
|
|
994
1139
|
['PureCloud OAuth'],
|
|
995
1140
|
['application/json'],
|
|
996
|
-
['application/json']
|
|
1141
|
+
['application/json'],
|
|
1142
|
+
opts['customHeaders']
|
|
997
1143
|
);
|
|
998
1144
|
}
|
|
999
1145
|
|
|
@@ -1004,6 +1150,7 @@ class ExternalContactsApi {
|
|
|
1004
1150
|
* @param {Object} opts Optional parameters
|
|
1005
1151
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
1006
1152
|
* @param {Boolean} opts.includeTrustors (true or false) whether or not to include trustor information embedded in the externalOrganization
|
|
1153
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1007
1154
|
*/
|
|
1008
1155
|
getExternalcontactsOrganization(externalOrganizationId, opts) {
|
|
1009
1156
|
opts = opts || {};
|
|
@@ -1023,7 +1170,8 @@ class ExternalContactsApi {
|
|
|
1023
1170
|
null,
|
|
1024
1171
|
['PureCloud OAuth'],
|
|
1025
1172
|
['application/json'],
|
|
1026
|
-
['application/json']
|
|
1173
|
+
['application/json'],
|
|
1174
|
+
opts['customHeaders']
|
|
1027
1175
|
);
|
|
1028
1176
|
}
|
|
1029
1177
|
|
|
@@ -1037,6 +1185,7 @@ class ExternalContactsApi {
|
|
|
1037
1185
|
* @param {String} opts.q User supplied search keywords (no special syntax is currently supported)
|
|
1038
1186
|
* @param {String} opts.sortOrder The External Contact field to sort by. Any of: [firstName, lastName, middleName, title]. Direction: [asc, desc]. e.g. firstName:asc, title:desc
|
|
1039
1187
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
1188
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1040
1189
|
*/
|
|
1041
1190
|
getExternalcontactsOrganizationContacts(externalOrganizationId, opts) {
|
|
1042
1191
|
opts = opts || {};
|
|
@@ -1056,7 +1205,8 @@ class ExternalContactsApi {
|
|
|
1056
1205
|
null,
|
|
1057
1206
|
['PureCloud OAuth'],
|
|
1058
1207
|
['application/json'],
|
|
1059
|
-
['application/json']
|
|
1208
|
+
['application/json'],
|
|
1209
|
+
opts['customHeaders']
|
|
1060
1210
|
);
|
|
1061
1211
|
}
|
|
1062
1212
|
|
|
@@ -1064,8 +1214,12 @@ class ExternalContactsApi {
|
|
|
1064
1214
|
* List the identifiers for an external organization
|
|
1065
1215
|
*
|
|
1066
1216
|
* @param {String} externalOrganizationId External Organization ID
|
|
1217
|
+
* @param {Object} opts Optional parameters
|
|
1218
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1067
1219
|
*/
|
|
1068
|
-
getExternalcontactsOrganizationIdentifiers(externalOrganizationId) {
|
|
1220
|
+
getExternalcontactsOrganizationIdentifiers(externalOrganizationId, opts) {
|
|
1221
|
+
opts = opts || {};
|
|
1222
|
+
|
|
1069
1223
|
// verify the required parameter 'externalOrganizationId' is set
|
|
1070
1224
|
if (externalOrganizationId === undefined || externalOrganizationId === null || externalOrganizationId === '') {
|
|
1071
1225
|
throw 'Missing the required parameter "externalOrganizationId" when calling getExternalcontactsOrganizationIdentifiers';
|
|
@@ -1081,7 +1235,8 @@ class ExternalContactsApi {
|
|
|
1081
1235
|
null,
|
|
1082
1236
|
['PureCloud OAuth'],
|
|
1083
1237
|
['application/json'],
|
|
1084
|
-
['application/json']
|
|
1238
|
+
['application/json'],
|
|
1239
|
+
opts['customHeaders']
|
|
1085
1240
|
);
|
|
1086
1241
|
}
|
|
1087
1242
|
|
|
@@ -1092,6 +1247,7 @@ class ExternalContactsApi {
|
|
|
1092
1247
|
* @param {String} noteId Note Id
|
|
1093
1248
|
* @param {Object} opts Optional parameters
|
|
1094
1249
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
1250
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1095
1251
|
*/
|
|
1096
1252
|
getExternalcontactsOrganizationNote(externalOrganizationId, noteId, opts) {
|
|
1097
1253
|
opts = opts || {};
|
|
@@ -1115,7 +1271,8 @@ class ExternalContactsApi {
|
|
|
1115
1271
|
null,
|
|
1116
1272
|
['PureCloud OAuth'],
|
|
1117
1273
|
['application/json'],
|
|
1118
|
-
['application/json']
|
|
1274
|
+
['application/json'],
|
|
1275
|
+
opts['customHeaders']
|
|
1119
1276
|
);
|
|
1120
1277
|
}
|
|
1121
1278
|
|
|
@@ -1128,6 +1285,7 @@ class ExternalContactsApi {
|
|
|
1128
1285
|
* @param {Number} opts.pageNumber Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 1)
|
|
1129
1286
|
* @param {String} opts.sortOrder The Note field to sort by. Any of: [createDate]. Direction: [asc, desc]. e.g. createDate:asc, createDate:desc
|
|
1130
1287
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
1288
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1131
1289
|
*/
|
|
1132
1290
|
getExternalcontactsOrganizationNotes(externalOrganizationId, opts) {
|
|
1133
1291
|
opts = opts || {};
|
|
@@ -1147,7 +1305,8 @@ class ExternalContactsApi {
|
|
|
1147
1305
|
null,
|
|
1148
1306
|
['PureCloud OAuth'],
|
|
1149
1307
|
['application/json'],
|
|
1150
|
-
['application/json']
|
|
1308
|
+
['application/json'],
|
|
1309
|
+
opts['customHeaders']
|
|
1151
1310
|
);
|
|
1152
1311
|
}
|
|
1153
1312
|
|
|
@@ -1160,6 +1319,7 @@ class ExternalContactsApi {
|
|
|
1160
1319
|
* @param {Number} opts.pageNumber Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 1)
|
|
1161
1320
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
1162
1321
|
* @param {String} opts.sortOrder The Relationship field to sort by. Any of: [createDate, relationship]. Direction: [asc, desc]. e.g. createDate:asc, relationship:desc
|
|
1322
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1163
1323
|
*/
|
|
1164
1324
|
getExternalcontactsOrganizationRelationships(externalOrganizationId, opts) {
|
|
1165
1325
|
opts = opts || {};
|
|
@@ -1179,7 +1339,8 @@ class ExternalContactsApi {
|
|
|
1179
1339
|
null,
|
|
1180
1340
|
['PureCloud OAuth'],
|
|
1181
1341
|
['application/json'],
|
|
1182
|
-
['application/json']
|
|
1342
|
+
['application/json'],
|
|
1343
|
+
opts['customHeaders']
|
|
1183
1344
|
);
|
|
1184
1345
|
}
|
|
1185
1346
|
|
|
@@ -1195,6 +1356,7 @@ class ExternalContactsApi {
|
|
|
1195
1356
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
1196
1357
|
* @param {Boolean} opts.includeTrustors (true or false) whether or not to include trustor information embedded in the externalOrganization
|
|
1197
1358
|
* @param {Array.<String>} opts.divisionIds which divisions to search, up to 50
|
|
1359
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1198
1360
|
*/
|
|
1199
1361
|
getExternalcontactsOrganizations(opts) {
|
|
1200
1362
|
opts = opts || {};
|
|
@@ -1210,7 +1372,8 @@ class ExternalContactsApi {
|
|
|
1210
1372
|
null,
|
|
1211
1373
|
['PureCloud OAuth'],
|
|
1212
1374
|
['application/json'],
|
|
1213
|
-
['application/json']
|
|
1375
|
+
['application/json'],
|
|
1376
|
+
opts['customHeaders']
|
|
1214
1377
|
);
|
|
1215
1378
|
}
|
|
1216
1379
|
|
|
@@ -1218,8 +1381,12 @@ class ExternalContactsApi {
|
|
|
1218
1381
|
* Get a schema
|
|
1219
1382
|
*
|
|
1220
1383
|
* @param {String} schemaId Schema ID
|
|
1384
|
+
* @param {Object} opts Optional parameters
|
|
1385
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1221
1386
|
*/
|
|
1222
|
-
getExternalcontactsOrganizationsSchema(schemaId) {
|
|
1387
|
+
getExternalcontactsOrganizationsSchema(schemaId, opts) {
|
|
1388
|
+
opts = opts || {};
|
|
1389
|
+
|
|
1223
1390
|
// verify the required parameter 'schemaId' is set
|
|
1224
1391
|
if (schemaId === undefined || schemaId === null || schemaId === '') {
|
|
1225
1392
|
throw 'Missing the required parameter "schemaId" when calling getExternalcontactsOrganizationsSchema';
|
|
@@ -1235,7 +1402,8 @@ class ExternalContactsApi {
|
|
|
1235
1402
|
null,
|
|
1236
1403
|
['PureCloud OAuth'],
|
|
1237
1404
|
['application/json'],
|
|
1238
|
-
['application/json']
|
|
1405
|
+
['application/json'],
|
|
1406
|
+
opts['customHeaders']
|
|
1239
1407
|
);
|
|
1240
1408
|
}
|
|
1241
1409
|
|
|
@@ -1244,8 +1412,12 @@ class ExternalContactsApi {
|
|
|
1244
1412
|
*
|
|
1245
1413
|
* @param {String} schemaId Schema ID
|
|
1246
1414
|
* @param {String} versionId Schema version
|
|
1415
|
+
* @param {Object} opts Optional parameters
|
|
1416
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1247
1417
|
*/
|
|
1248
|
-
getExternalcontactsOrganizationsSchemaVersion(schemaId, versionId) {
|
|
1418
|
+
getExternalcontactsOrganizationsSchemaVersion(schemaId, versionId, opts) {
|
|
1419
|
+
opts = opts || {};
|
|
1420
|
+
|
|
1249
1421
|
// verify the required parameter 'schemaId' is set
|
|
1250
1422
|
if (schemaId === undefined || schemaId === null || schemaId === '') {
|
|
1251
1423
|
throw 'Missing the required parameter "schemaId" when calling getExternalcontactsOrganizationsSchemaVersion';
|
|
@@ -1265,7 +1437,8 @@ class ExternalContactsApi {
|
|
|
1265
1437
|
null,
|
|
1266
1438
|
['PureCloud OAuth'],
|
|
1267
1439
|
['application/json'],
|
|
1268
|
-
['application/json']
|
|
1440
|
+
['application/json'],
|
|
1441
|
+
opts['customHeaders']
|
|
1269
1442
|
);
|
|
1270
1443
|
}
|
|
1271
1444
|
|
|
@@ -1273,8 +1446,12 @@ class ExternalContactsApi {
|
|
|
1273
1446
|
* Get all versions of an external organization's schema
|
|
1274
1447
|
*
|
|
1275
1448
|
* @param {String} schemaId Schema ID
|
|
1449
|
+
* @param {Object} opts Optional parameters
|
|
1450
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1276
1451
|
*/
|
|
1277
|
-
getExternalcontactsOrganizationsSchemaVersions(schemaId) {
|
|
1452
|
+
getExternalcontactsOrganizationsSchemaVersions(schemaId, opts) {
|
|
1453
|
+
opts = opts || {};
|
|
1454
|
+
|
|
1278
1455
|
// verify the required parameter 'schemaId' is set
|
|
1279
1456
|
if (schemaId === undefined || schemaId === null || schemaId === '') {
|
|
1280
1457
|
throw 'Missing the required parameter "schemaId" when calling getExternalcontactsOrganizationsSchemaVersions';
|
|
@@ -1290,15 +1467,20 @@ class ExternalContactsApi {
|
|
|
1290
1467
|
null,
|
|
1291
1468
|
['PureCloud OAuth'],
|
|
1292
1469
|
['application/json'],
|
|
1293
|
-
['application/json']
|
|
1470
|
+
['application/json'],
|
|
1471
|
+
opts['customHeaders']
|
|
1294
1472
|
);
|
|
1295
1473
|
}
|
|
1296
1474
|
|
|
1297
1475
|
/**
|
|
1298
1476
|
* Get a list of schemas.
|
|
1299
1477
|
*
|
|
1478
|
+
* @param {Object} opts Optional parameters
|
|
1479
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1300
1480
|
*/
|
|
1301
|
-
getExternalcontactsOrganizationsSchemas() {
|
|
1481
|
+
getExternalcontactsOrganizationsSchemas(opts) {
|
|
1482
|
+
opts = opts || {};
|
|
1483
|
+
|
|
1302
1484
|
|
|
1303
1485
|
return this.apiClient.callApi(
|
|
1304
1486
|
'/api/v2/externalcontacts/organizations/schemas',
|
|
@@ -1310,7 +1492,8 @@ class ExternalContactsApi {
|
|
|
1310
1492
|
null,
|
|
1311
1493
|
['PureCloud OAuth'],
|
|
1312
1494
|
['application/json'],
|
|
1313
|
-
['application/json']
|
|
1495
|
+
['application/json'],
|
|
1496
|
+
opts['customHeaders']
|
|
1314
1497
|
);
|
|
1315
1498
|
}
|
|
1316
1499
|
|
|
@@ -1318,8 +1501,12 @@ class ExternalContactsApi {
|
|
|
1318
1501
|
* Get a specific named core type.
|
|
1319
1502
|
*
|
|
1320
1503
|
* @param {String} coreTypeName Name of the core type
|
|
1504
|
+
* @param {Object} opts Optional parameters
|
|
1505
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1321
1506
|
*/
|
|
1322
|
-
getExternalcontactsOrganizationsSchemasCoretype(coreTypeName) {
|
|
1507
|
+
getExternalcontactsOrganizationsSchemasCoretype(coreTypeName, opts) {
|
|
1508
|
+
opts = opts || {};
|
|
1509
|
+
|
|
1323
1510
|
// verify the required parameter 'coreTypeName' is set
|
|
1324
1511
|
if (coreTypeName === undefined || coreTypeName === null || coreTypeName === '') {
|
|
1325
1512
|
throw 'Missing the required parameter "coreTypeName" when calling getExternalcontactsOrganizationsSchemasCoretype';
|
|
@@ -1335,15 +1522,20 @@ class ExternalContactsApi {
|
|
|
1335
1522
|
null,
|
|
1336
1523
|
['PureCloud OAuth'],
|
|
1337
1524
|
['application/json'],
|
|
1338
|
-
['application/json']
|
|
1525
|
+
['application/json'],
|
|
1526
|
+
opts['customHeaders']
|
|
1339
1527
|
);
|
|
1340
1528
|
}
|
|
1341
1529
|
|
|
1342
1530
|
/**
|
|
1343
1531
|
* Get the core types from which all schemas are built.
|
|
1344
1532
|
*
|
|
1533
|
+
* @param {Object} opts Optional parameters
|
|
1534
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1345
1535
|
*/
|
|
1346
|
-
getExternalcontactsOrganizationsSchemasCoretypes() {
|
|
1536
|
+
getExternalcontactsOrganizationsSchemasCoretypes(opts) {
|
|
1537
|
+
opts = opts || {};
|
|
1538
|
+
|
|
1347
1539
|
|
|
1348
1540
|
return this.apiClient.callApi(
|
|
1349
1541
|
'/api/v2/externalcontacts/organizations/schemas/coretypes',
|
|
@@ -1355,15 +1547,20 @@ class ExternalContactsApi {
|
|
|
1355
1547
|
null,
|
|
1356
1548
|
['PureCloud OAuth'],
|
|
1357
1549
|
['application/json'],
|
|
1358
|
-
['application/json']
|
|
1550
|
+
['application/json'],
|
|
1551
|
+
opts['customHeaders']
|
|
1359
1552
|
);
|
|
1360
1553
|
}
|
|
1361
1554
|
|
|
1362
1555
|
/**
|
|
1363
1556
|
* Get quantitative limits on schemas
|
|
1364
1557
|
*
|
|
1558
|
+
* @param {Object} opts Optional parameters
|
|
1559
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1365
1560
|
*/
|
|
1366
|
-
getExternalcontactsOrganizationsSchemasLimits() {
|
|
1561
|
+
getExternalcontactsOrganizationsSchemasLimits(opts) {
|
|
1562
|
+
opts = opts || {};
|
|
1563
|
+
|
|
1367
1564
|
|
|
1368
1565
|
return this.apiClient.callApi(
|
|
1369
1566
|
'/api/v2/externalcontacts/organizations/schemas/limits',
|
|
@@ -1375,7 +1572,8 @@ class ExternalContactsApi {
|
|
|
1375
1572
|
null,
|
|
1376
1573
|
['PureCloud OAuth'],
|
|
1377
1574
|
['application/json'],
|
|
1378
|
-
['application/json']
|
|
1575
|
+
['application/json'],
|
|
1576
|
+
opts['customHeaders']
|
|
1379
1577
|
);
|
|
1380
1578
|
}
|
|
1381
1579
|
|
|
@@ -1385,6 +1583,7 @@ class ExternalContactsApi {
|
|
|
1385
1583
|
* @param {String} relationshipId Relationship Id
|
|
1386
1584
|
* @param {Object} opts Optional parameters
|
|
1387
1585
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
1586
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1388
1587
|
*/
|
|
1389
1588
|
getExternalcontactsRelationship(relationshipId, opts) {
|
|
1390
1589
|
opts = opts || {};
|
|
@@ -1404,7 +1603,8 @@ class ExternalContactsApi {
|
|
|
1404
1603
|
null,
|
|
1405
1604
|
['PureCloud OAuth'],
|
|
1406
1605
|
['application/json'],
|
|
1407
|
-
['application/json']
|
|
1606
|
+
['application/json'],
|
|
1607
|
+
opts['customHeaders']
|
|
1408
1608
|
);
|
|
1409
1609
|
}
|
|
1410
1610
|
|
|
@@ -1415,6 +1615,7 @@ class ExternalContactsApi {
|
|
|
1415
1615
|
* @param {Object} opts Optional parameters
|
|
1416
1616
|
* @param {Array.<String>} opts.expand which field, if any, to expand
|
|
1417
1617
|
* @param {String} opts.divisionId Specifies which division to lookup contacts in, for the given lookup value (default to *)
|
|
1618
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1418
1619
|
*/
|
|
1419
1620
|
getExternalcontactsReversewhitepageslookup(lookupVal, opts) {
|
|
1420
1621
|
opts = opts || {};
|
|
@@ -1434,7 +1635,8 @@ class ExternalContactsApi {
|
|
|
1434
1635
|
null,
|
|
1435
1636
|
['PureCloud OAuth'],
|
|
1436
1637
|
['application/json'],
|
|
1437
|
-
['application/json']
|
|
1638
|
+
['application/json'],
|
|
1639
|
+
opts['customHeaders']
|
|
1438
1640
|
);
|
|
1439
1641
|
}
|
|
1440
1642
|
|
|
@@ -1445,6 +1647,7 @@ class ExternalContactsApi {
|
|
|
1445
1647
|
* @param {Number} opts.limit The number of contacts per page; must be between 10 and 200, default is 100
|
|
1446
1648
|
* @param {String} opts.cursor Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
|
|
1447
1649
|
* @param {String} opts.divisionId The division to scan over (default to *)
|
|
1650
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1448
1651
|
*/
|
|
1449
1652
|
getExternalcontactsScanContacts(opts) {
|
|
1450
1653
|
opts = opts || {};
|
|
@@ -1460,7 +1663,8 @@ class ExternalContactsApi {
|
|
|
1460
1663
|
null,
|
|
1461
1664
|
['PureCloud OAuth'],
|
|
1462
1665
|
['application/json'],
|
|
1463
|
-
['application/json']
|
|
1666
|
+
['application/json'],
|
|
1667
|
+
opts['customHeaders']
|
|
1464
1668
|
);
|
|
1465
1669
|
}
|
|
1466
1670
|
|
|
@@ -1470,6 +1674,7 @@ class ExternalContactsApi {
|
|
|
1470
1674
|
* @param {Object} opts Optional parameters
|
|
1471
1675
|
* @param {Number} opts.limit The number of contacts per page; must be between 10 and 200, default is 100
|
|
1472
1676
|
* @param {String} opts.cursor Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
|
|
1677
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1473
1678
|
*/
|
|
1474
1679
|
getExternalcontactsScanContactsDivisionviewsAll(opts) {
|
|
1475
1680
|
opts = opts || {};
|
|
@@ -1485,7 +1690,8 @@ class ExternalContactsApi {
|
|
|
1485
1690
|
null,
|
|
1486
1691
|
['PureCloud OAuth'],
|
|
1487
1692
|
['application/json'],
|
|
1488
|
-
['application/json']
|
|
1693
|
+
['application/json'],
|
|
1694
|
+
opts['customHeaders']
|
|
1489
1695
|
);
|
|
1490
1696
|
}
|
|
1491
1697
|
|
|
@@ -1496,6 +1702,7 @@ class ExternalContactsApi {
|
|
|
1496
1702
|
* @param {Number} opts.limit The number of notes per page; must be between 10 and 200, default is 100
|
|
1497
1703
|
* @param {String} opts.cursor Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
|
|
1498
1704
|
* @param {String} opts.divisionId The division to scan over (default to *)
|
|
1705
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1499
1706
|
*/
|
|
1500
1707
|
getExternalcontactsScanNotes(opts) {
|
|
1501
1708
|
opts = opts || {};
|
|
@@ -1511,7 +1718,8 @@ class ExternalContactsApi {
|
|
|
1511
1718
|
null,
|
|
1512
1719
|
['PureCloud OAuth'],
|
|
1513
1720
|
['application/json'],
|
|
1514
|
-
['application/json']
|
|
1721
|
+
['application/json'],
|
|
1722
|
+
opts['customHeaders']
|
|
1515
1723
|
);
|
|
1516
1724
|
}
|
|
1517
1725
|
|
|
@@ -1521,6 +1729,7 @@ class ExternalContactsApi {
|
|
|
1521
1729
|
* @param {Object} opts Optional parameters
|
|
1522
1730
|
* @param {Number} opts.limit The number of notes per page; must be between 10 and 200, default is 100
|
|
1523
1731
|
* @param {String} opts.cursor Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
|
|
1732
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1524
1733
|
*/
|
|
1525
1734
|
getExternalcontactsScanNotesDivisionviewsAll(opts) {
|
|
1526
1735
|
opts = opts || {};
|
|
@@ -1536,7 +1745,8 @@ class ExternalContactsApi {
|
|
|
1536
1745
|
null,
|
|
1537
1746
|
['PureCloud OAuth'],
|
|
1538
1747
|
['application/json'],
|
|
1539
|
-
['application/json']
|
|
1748
|
+
['application/json'],
|
|
1749
|
+
opts['customHeaders']
|
|
1540
1750
|
);
|
|
1541
1751
|
}
|
|
1542
1752
|
|
|
@@ -1547,6 +1757,7 @@ class ExternalContactsApi {
|
|
|
1547
1757
|
* @param {Number} opts.limit The number of organizations per page; must be between 10 and 200, default is 100
|
|
1548
1758
|
* @param {String} opts.cursor Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
|
|
1549
1759
|
* @param {String} opts.divisionId The division to scan over (default to *)
|
|
1760
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1550
1761
|
*/
|
|
1551
1762
|
getExternalcontactsScanOrganizations(opts) {
|
|
1552
1763
|
opts = opts || {};
|
|
@@ -1562,7 +1773,8 @@ class ExternalContactsApi {
|
|
|
1562
1773
|
null,
|
|
1563
1774
|
['PureCloud OAuth'],
|
|
1564
1775
|
['application/json'],
|
|
1565
|
-
['application/json']
|
|
1776
|
+
['application/json'],
|
|
1777
|
+
opts['customHeaders']
|
|
1566
1778
|
);
|
|
1567
1779
|
}
|
|
1568
1780
|
|
|
@@ -1572,6 +1784,7 @@ class ExternalContactsApi {
|
|
|
1572
1784
|
* @param {Object} opts Optional parameters
|
|
1573
1785
|
* @param {Number} opts.limit The number of organizations per page; must be between 10 and 200, default is 100
|
|
1574
1786
|
* @param {String} opts.cursor Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
|
|
1787
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1575
1788
|
*/
|
|
1576
1789
|
getExternalcontactsScanOrganizationsDivisionviewsAll(opts) {
|
|
1577
1790
|
opts = opts || {};
|
|
@@ -1587,7 +1800,8 @@ class ExternalContactsApi {
|
|
|
1587
1800
|
null,
|
|
1588
1801
|
['PureCloud OAuth'],
|
|
1589
1802
|
['application/json'],
|
|
1590
|
-
['application/json']
|
|
1803
|
+
['application/json'],
|
|
1804
|
+
opts['customHeaders']
|
|
1591
1805
|
);
|
|
1592
1806
|
}
|
|
1593
1807
|
|
|
@@ -1598,6 +1812,7 @@ class ExternalContactsApi {
|
|
|
1598
1812
|
* @param {Number} opts.limit The number of relationships per page; must be between 10 and 200, default is 100
|
|
1599
1813
|
* @param {String} opts.cursor Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
|
|
1600
1814
|
* @param {String} opts.divisionId The division to scan over (default to *)
|
|
1815
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1601
1816
|
*/
|
|
1602
1817
|
getExternalcontactsScanRelationships(opts) {
|
|
1603
1818
|
opts = opts || {};
|
|
@@ -1613,7 +1828,8 @@ class ExternalContactsApi {
|
|
|
1613
1828
|
null,
|
|
1614
1829
|
['PureCloud OAuth'],
|
|
1615
1830
|
['application/json'],
|
|
1616
|
-
['application/json']
|
|
1831
|
+
['application/json'],
|
|
1832
|
+
opts['customHeaders']
|
|
1617
1833
|
);
|
|
1618
1834
|
}
|
|
1619
1835
|
|
|
@@ -1623,6 +1839,7 @@ class ExternalContactsApi {
|
|
|
1623
1839
|
* @param {Object} opts Optional parameters
|
|
1624
1840
|
* @param {Number} opts.limit The number of relationships per page; must be between 10 and 200, default is 100
|
|
1625
1841
|
* @param {String} opts.cursor Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
|
|
1842
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1626
1843
|
*/
|
|
1627
1844
|
getExternalcontactsScanRelationshipsDivisionviewsAll(opts) {
|
|
1628
1845
|
opts = opts || {};
|
|
@@ -1638,7 +1855,8 @@ class ExternalContactsApi {
|
|
|
1638
1855
|
null,
|
|
1639
1856
|
['PureCloud OAuth'],
|
|
1640
1857
|
['application/json'],
|
|
1641
|
-
['application/json']
|
|
1858
|
+
['application/json'],
|
|
1859
|
+
opts['customHeaders']
|
|
1642
1860
|
);
|
|
1643
1861
|
}
|
|
1644
1862
|
|
|
@@ -1647,8 +1865,12 @@ class ExternalContactsApi {
|
|
|
1647
1865
|
*
|
|
1648
1866
|
* @param {String} contactId ExternalContact ID
|
|
1649
1867
|
* @param {Object} body Contact fields to update
|
|
1868
|
+
* @param {Object} opts Optional parameters
|
|
1869
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1650
1870
|
*/
|
|
1651
|
-
patchExternalcontactsContact(contactId, body) {
|
|
1871
|
+
patchExternalcontactsContact(contactId, body, opts) {
|
|
1872
|
+
opts = opts || {};
|
|
1873
|
+
|
|
1652
1874
|
// verify the required parameter 'contactId' is set
|
|
1653
1875
|
if (contactId === undefined || contactId === null || contactId === '') {
|
|
1654
1876
|
throw 'Missing the required parameter "contactId" when calling patchExternalcontactsContact';
|
|
@@ -1668,7 +1890,8 @@ class ExternalContactsApi {
|
|
|
1668
1890
|
body,
|
|
1669
1891
|
['PureCloud OAuth'],
|
|
1670
1892
|
['application/json'],
|
|
1671
|
-
['application/json']
|
|
1893
|
+
['application/json'],
|
|
1894
|
+
opts['customHeaders']
|
|
1672
1895
|
);
|
|
1673
1896
|
}
|
|
1674
1897
|
|
|
@@ -1677,8 +1900,12 @@ class ExternalContactsApi {
|
|
|
1677
1900
|
*
|
|
1678
1901
|
* @param {String} contactId ExternalContact ID
|
|
1679
1902
|
* @param {Object} body ClaimRequest
|
|
1903
|
+
* @param {Object} opts Optional parameters
|
|
1904
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1680
1905
|
*/
|
|
1681
|
-
patchExternalcontactsContactIdentifiers(contactId, body) {
|
|
1906
|
+
patchExternalcontactsContactIdentifiers(contactId, body, opts) {
|
|
1907
|
+
opts = opts || {};
|
|
1908
|
+
|
|
1682
1909
|
// verify the required parameter 'contactId' is set
|
|
1683
1910
|
if (contactId === undefined || contactId === null || contactId === '') {
|
|
1684
1911
|
throw 'Missing the required parameter "contactId" when calling patchExternalcontactsContactIdentifiers';
|
|
@@ -1698,7 +1925,8 @@ class ExternalContactsApi {
|
|
|
1698
1925
|
body,
|
|
1699
1926
|
['PureCloud OAuth'],
|
|
1700
1927
|
['application/json'],
|
|
1701
|
-
['application/json']
|
|
1928
|
+
['application/json'],
|
|
1929
|
+
opts['customHeaders']
|
|
1702
1930
|
);
|
|
1703
1931
|
}
|
|
1704
1932
|
|
|
@@ -1707,8 +1935,12 @@ class ExternalContactsApi {
|
|
|
1707
1935
|
*
|
|
1708
1936
|
* @param {String} externalOrganizationId External Organization ID
|
|
1709
1937
|
* @param {Object} body ClaimRequest
|
|
1938
|
+
* @param {Object} opts Optional parameters
|
|
1939
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1710
1940
|
*/
|
|
1711
|
-
patchExternalcontactsOrganizationIdentifiers(externalOrganizationId, body) {
|
|
1941
|
+
patchExternalcontactsOrganizationIdentifiers(externalOrganizationId, body, opts) {
|
|
1942
|
+
opts = opts || {};
|
|
1943
|
+
|
|
1712
1944
|
// verify the required parameter 'externalOrganizationId' is set
|
|
1713
1945
|
if (externalOrganizationId === undefined || externalOrganizationId === null || externalOrganizationId === '') {
|
|
1714
1946
|
throw 'Missing the required parameter "externalOrganizationId" when calling patchExternalcontactsOrganizationIdentifiers';
|
|
@@ -1728,7 +1960,8 @@ class ExternalContactsApi {
|
|
|
1728
1960
|
body,
|
|
1729
1961
|
['PureCloud OAuth'],
|
|
1730
1962
|
['application/json'],
|
|
1731
|
-
['application/json']
|
|
1963
|
+
['application/json'],
|
|
1964
|
+
opts['customHeaders']
|
|
1732
1965
|
);
|
|
1733
1966
|
}
|
|
1734
1967
|
|
|
@@ -1736,8 +1969,12 @@ class ExternalContactsApi {
|
|
|
1736
1969
|
* Bulk fetch contacts
|
|
1737
1970
|
*
|
|
1738
1971
|
* @param {Object} body Contact ids
|
|
1972
|
+
* @param {Object} opts Optional parameters
|
|
1973
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1739
1974
|
*/
|
|
1740
|
-
postExternalcontactsBulkContacts(body) {
|
|
1975
|
+
postExternalcontactsBulkContacts(body, opts) {
|
|
1976
|
+
opts = opts || {};
|
|
1977
|
+
|
|
1741
1978
|
// verify the required parameter 'body' is set
|
|
1742
1979
|
if (body === undefined || body === null) {
|
|
1743
1980
|
throw 'Missing the required parameter "body" when calling postExternalcontactsBulkContacts';
|
|
@@ -1753,7 +1990,8 @@ class ExternalContactsApi {
|
|
|
1753
1990
|
body,
|
|
1754
1991
|
['PureCloud OAuth'],
|
|
1755
1992
|
['application/json'],
|
|
1756
|
-
['application/json']
|
|
1993
|
+
['application/json'],
|
|
1994
|
+
opts['customHeaders']
|
|
1757
1995
|
);
|
|
1758
1996
|
}
|
|
1759
1997
|
|
|
@@ -1761,8 +1999,12 @@ class ExternalContactsApi {
|
|
|
1761
1999
|
* Bulk add contacts
|
|
1762
2000
|
*
|
|
1763
2001
|
* @param {Object} body Contacts
|
|
2002
|
+
* @param {Object} opts Optional parameters
|
|
2003
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1764
2004
|
*/
|
|
1765
|
-
postExternalcontactsBulkContactsAdd(body) {
|
|
2005
|
+
postExternalcontactsBulkContactsAdd(body, opts) {
|
|
2006
|
+
opts = opts || {};
|
|
2007
|
+
|
|
1766
2008
|
// verify the required parameter 'body' is set
|
|
1767
2009
|
if (body === undefined || body === null) {
|
|
1768
2010
|
throw 'Missing the required parameter "body" when calling postExternalcontactsBulkContactsAdd';
|
|
@@ -1778,7 +2020,8 @@ class ExternalContactsApi {
|
|
|
1778
2020
|
body,
|
|
1779
2021
|
['PureCloud OAuth'],
|
|
1780
2022
|
['application/json'],
|
|
1781
|
-
['application/json']
|
|
2023
|
+
['application/json'],
|
|
2024
|
+
opts['customHeaders']
|
|
1782
2025
|
);
|
|
1783
2026
|
}
|
|
1784
2027
|
|
|
@@ -1786,8 +2029,12 @@ class ExternalContactsApi {
|
|
|
1786
2029
|
* Bulk fetch contacts across divisions
|
|
1787
2030
|
*
|
|
1788
2031
|
* @param {Object} body Contact ids
|
|
2032
|
+
* @param {Object} opts Optional parameters
|
|
2033
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1789
2034
|
*/
|
|
1790
|
-
postExternalcontactsBulkContactsDivisionviews(body) {
|
|
2035
|
+
postExternalcontactsBulkContactsDivisionviews(body, opts) {
|
|
2036
|
+
opts = opts || {};
|
|
2037
|
+
|
|
1791
2038
|
// verify the required parameter 'body' is set
|
|
1792
2039
|
if (body === undefined || body === null) {
|
|
1793
2040
|
throw 'Missing the required parameter "body" when calling postExternalcontactsBulkContactsDivisionviews';
|
|
@@ -1803,7 +2050,8 @@ class ExternalContactsApi {
|
|
|
1803
2050
|
body,
|
|
1804
2051
|
['PureCloud OAuth'],
|
|
1805
2052
|
['application/json'],
|
|
1806
|
-
['application/json']
|
|
2053
|
+
['application/json'],
|
|
2054
|
+
opts['customHeaders']
|
|
1807
2055
|
);
|
|
1808
2056
|
}
|
|
1809
2057
|
|
|
@@ -1813,6 +2061,7 @@ class ExternalContactsApi {
|
|
|
1813
2061
|
* @param {Object} body Contact Enrich Requests
|
|
1814
2062
|
* @param {Object} opts Optional parameters
|
|
1815
2063
|
* @param {Boolean} opts.dryRun If true, the request will not make any modifications, but will show you what the end result *would* be.
|
|
2064
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1816
2065
|
*/
|
|
1817
2066
|
postExternalcontactsBulkContactsEnrich(body, opts) {
|
|
1818
2067
|
opts = opts || {};
|
|
@@ -1832,7 +2081,8 @@ class ExternalContactsApi {
|
|
|
1832
2081
|
body,
|
|
1833
2082
|
['PureCloud OAuth'],
|
|
1834
2083
|
['application/json'],
|
|
1835
|
-
['application/json']
|
|
2084
|
+
['application/json'],
|
|
2085
|
+
opts['customHeaders']
|
|
1836
2086
|
);
|
|
1837
2087
|
}
|
|
1838
2088
|
|
|
@@ -1840,8 +2090,12 @@ class ExternalContactsApi {
|
|
|
1840
2090
|
* Bulk remove contacts
|
|
1841
2091
|
*
|
|
1842
2092
|
* @param {Object} body Contact ids
|
|
2093
|
+
* @param {Object} opts Optional parameters
|
|
2094
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1843
2095
|
*/
|
|
1844
|
-
postExternalcontactsBulkContactsRemove(body) {
|
|
2096
|
+
postExternalcontactsBulkContactsRemove(body, opts) {
|
|
2097
|
+
opts = opts || {};
|
|
2098
|
+
|
|
1845
2099
|
// verify the required parameter 'body' is set
|
|
1846
2100
|
if (body === undefined || body === null) {
|
|
1847
2101
|
throw 'Missing the required parameter "body" when calling postExternalcontactsBulkContactsRemove';
|
|
@@ -1857,7 +2111,8 @@ class ExternalContactsApi {
|
|
|
1857
2111
|
body,
|
|
1858
2112
|
['PureCloud OAuth'],
|
|
1859
2113
|
['application/json'],
|
|
1860
|
-
['application/json']
|
|
2114
|
+
['application/json'],
|
|
2115
|
+
opts['customHeaders']
|
|
1861
2116
|
);
|
|
1862
2117
|
}
|
|
1863
2118
|
|
|
@@ -1865,8 +2120,12 @@ class ExternalContactsApi {
|
|
|
1865
2120
|
* Bulk fetch unresolved ancestor contacts
|
|
1866
2121
|
*
|
|
1867
2122
|
* @param {Object} body Contact ids
|
|
2123
|
+
* @param {Object} opts Optional parameters
|
|
2124
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1868
2125
|
*/
|
|
1869
|
-
postExternalcontactsBulkContactsUnresolved(body) {
|
|
2126
|
+
postExternalcontactsBulkContactsUnresolved(body, opts) {
|
|
2127
|
+
opts = opts || {};
|
|
2128
|
+
|
|
1870
2129
|
// verify the required parameter 'body' is set
|
|
1871
2130
|
if (body === undefined || body === null) {
|
|
1872
2131
|
throw 'Missing the required parameter "body" when calling postExternalcontactsBulkContactsUnresolved';
|
|
@@ -1882,7 +2141,8 @@ class ExternalContactsApi {
|
|
|
1882
2141
|
body,
|
|
1883
2142
|
['PureCloud OAuth'],
|
|
1884
2143
|
['application/json'],
|
|
1885
|
-
['application/json']
|
|
2144
|
+
['application/json'],
|
|
2145
|
+
opts['customHeaders']
|
|
1886
2146
|
);
|
|
1887
2147
|
}
|
|
1888
2148
|
|
|
@@ -1890,8 +2150,12 @@ class ExternalContactsApi {
|
|
|
1890
2150
|
* Bulk update contacts
|
|
1891
2151
|
*
|
|
1892
2152
|
* @param {Object} body Contacts
|
|
2153
|
+
* @param {Object} opts Optional parameters
|
|
2154
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1893
2155
|
*/
|
|
1894
|
-
postExternalcontactsBulkContactsUpdate(body) {
|
|
2156
|
+
postExternalcontactsBulkContactsUpdate(body, opts) {
|
|
2157
|
+
opts = opts || {};
|
|
2158
|
+
|
|
1895
2159
|
// verify the required parameter 'body' is set
|
|
1896
2160
|
if (body === undefined || body === null) {
|
|
1897
2161
|
throw 'Missing the required parameter "body" when calling postExternalcontactsBulkContactsUpdate';
|
|
@@ -1907,7 +2171,8 @@ class ExternalContactsApi {
|
|
|
1907
2171
|
body,
|
|
1908
2172
|
['PureCloud OAuth'],
|
|
1909
2173
|
['application/json'],
|
|
1910
|
-
['application/json']
|
|
2174
|
+
['application/json'],
|
|
2175
|
+
opts['customHeaders']
|
|
1911
2176
|
);
|
|
1912
2177
|
}
|
|
1913
2178
|
|
|
@@ -1915,8 +2180,12 @@ class ExternalContactsApi {
|
|
|
1915
2180
|
* Bulk fetch notes
|
|
1916
2181
|
*
|
|
1917
2182
|
* @param {Object} body Note ids
|
|
2183
|
+
* @param {Object} opts Optional parameters
|
|
2184
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1918
2185
|
*/
|
|
1919
|
-
postExternalcontactsBulkNotes(body) {
|
|
2186
|
+
postExternalcontactsBulkNotes(body, opts) {
|
|
2187
|
+
opts = opts || {};
|
|
2188
|
+
|
|
1920
2189
|
// verify the required parameter 'body' is set
|
|
1921
2190
|
if (body === undefined || body === null) {
|
|
1922
2191
|
throw 'Missing the required parameter "body" when calling postExternalcontactsBulkNotes';
|
|
@@ -1932,7 +2201,8 @@ class ExternalContactsApi {
|
|
|
1932
2201
|
body,
|
|
1933
2202
|
['PureCloud OAuth'],
|
|
1934
2203
|
['application/json'],
|
|
1935
|
-
['application/json']
|
|
2204
|
+
['application/json'],
|
|
2205
|
+
opts['customHeaders']
|
|
1936
2206
|
);
|
|
1937
2207
|
}
|
|
1938
2208
|
|
|
@@ -1940,8 +2210,12 @@ class ExternalContactsApi {
|
|
|
1940
2210
|
* Bulk add notes
|
|
1941
2211
|
*
|
|
1942
2212
|
* @param {Object} body Notes
|
|
2213
|
+
* @param {Object} opts Optional parameters
|
|
2214
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1943
2215
|
*/
|
|
1944
|
-
postExternalcontactsBulkNotesAdd(body) {
|
|
2216
|
+
postExternalcontactsBulkNotesAdd(body, opts) {
|
|
2217
|
+
opts = opts || {};
|
|
2218
|
+
|
|
1945
2219
|
// verify the required parameter 'body' is set
|
|
1946
2220
|
if (body === undefined || body === null) {
|
|
1947
2221
|
throw 'Missing the required parameter "body" when calling postExternalcontactsBulkNotesAdd';
|
|
@@ -1957,7 +2231,8 @@ class ExternalContactsApi {
|
|
|
1957
2231
|
body,
|
|
1958
2232
|
['PureCloud OAuth'],
|
|
1959
2233
|
['application/json'],
|
|
1960
|
-
['application/json']
|
|
2234
|
+
['application/json'],
|
|
2235
|
+
opts['customHeaders']
|
|
1961
2236
|
);
|
|
1962
2237
|
}
|
|
1963
2238
|
|
|
@@ -1965,8 +2240,12 @@ class ExternalContactsApi {
|
|
|
1965
2240
|
* Bulk remove notes
|
|
1966
2241
|
*
|
|
1967
2242
|
* @param {Object} body Note ids
|
|
2243
|
+
* @param {Object} opts Optional parameters
|
|
2244
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1968
2245
|
*/
|
|
1969
|
-
postExternalcontactsBulkNotesRemove(body) {
|
|
2246
|
+
postExternalcontactsBulkNotesRemove(body, opts) {
|
|
2247
|
+
opts = opts || {};
|
|
2248
|
+
|
|
1970
2249
|
// verify the required parameter 'body' is set
|
|
1971
2250
|
if (body === undefined || body === null) {
|
|
1972
2251
|
throw 'Missing the required parameter "body" when calling postExternalcontactsBulkNotesRemove';
|
|
@@ -1982,7 +2261,8 @@ class ExternalContactsApi {
|
|
|
1982
2261
|
body,
|
|
1983
2262
|
['PureCloud OAuth'],
|
|
1984
2263
|
['application/json'],
|
|
1985
|
-
['application/json']
|
|
2264
|
+
['application/json'],
|
|
2265
|
+
opts['customHeaders']
|
|
1986
2266
|
);
|
|
1987
2267
|
}
|
|
1988
2268
|
|
|
@@ -1990,8 +2270,12 @@ class ExternalContactsApi {
|
|
|
1990
2270
|
* Bulk update notes
|
|
1991
2271
|
*
|
|
1992
2272
|
* @param {Object} body Notes
|
|
2273
|
+
* @param {Object} opts Optional parameters
|
|
2274
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1993
2275
|
*/
|
|
1994
|
-
postExternalcontactsBulkNotesUpdate(body) {
|
|
2276
|
+
postExternalcontactsBulkNotesUpdate(body, opts) {
|
|
2277
|
+
opts = opts || {};
|
|
2278
|
+
|
|
1995
2279
|
// verify the required parameter 'body' is set
|
|
1996
2280
|
if (body === undefined || body === null) {
|
|
1997
2281
|
throw 'Missing the required parameter "body" when calling postExternalcontactsBulkNotesUpdate';
|
|
@@ -2007,7 +2291,8 @@ class ExternalContactsApi {
|
|
|
2007
2291
|
body,
|
|
2008
2292
|
['PureCloud OAuth'],
|
|
2009
2293
|
['application/json'],
|
|
2010
|
-
['application/json']
|
|
2294
|
+
['application/json'],
|
|
2295
|
+
opts['customHeaders']
|
|
2011
2296
|
);
|
|
2012
2297
|
}
|
|
2013
2298
|
|
|
@@ -2015,8 +2300,12 @@ class ExternalContactsApi {
|
|
|
2015
2300
|
* Bulk fetch organizations
|
|
2016
2301
|
*
|
|
2017
2302
|
* @param {Object} body Organizations ids
|
|
2303
|
+
* @param {Object} opts Optional parameters
|
|
2304
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2018
2305
|
*/
|
|
2019
|
-
postExternalcontactsBulkOrganizations(body) {
|
|
2306
|
+
postExternalcontactsBulkOrganizations(body, opts) {
|
|
2307
|
+
opts = opts || {};
|
|
2308
|
+
|
|
2020
2309
|
// verify the required parameter 'body' is set
|
|
2021
2310
|
if (body === undefined || body === null) {
|
|
2022
2311
|
throw 'Missing the required parameter "body" when calling postExternalcontactsBulkOrganizations';
|
|
@@ -2032,7 +2321,8 @@ class ExternalContactsApi {
|
|
|
2032
2321
|
body,
|
|
2033
2322
|
['PureCloud OAuth'],
|
|
2034
2323
|
['application/json'],
|
|
2035
|
-
['application/json']
|
|
2324
|
+
['application/json'],
|
|
2325
|
+
opts['customHeaders']
|
|
2036
2326
|
);
|
|
2037
2327
|
}
|
|
2038
2328
|
|
|
@@ -2040,8 +2330,12 @@ class ExternalContactsApi {
|
|
|
2040
2330
|
* Bulk add organizations
|
|
2041
2331
|
*
|
|
2042
2332
|
* @param {Object} body Organizations
|
|
2333
|
+
* @param {Object} opts Optional parameters
|
|
2334
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2043
2335
|
*/
|
|
2044
|
-
postExternalcontactsBulkOrganizationsAdd(body) {
|
|
2336
|
+
postExternalcontactsBulkOrganizationsAdd(body, opts) {
|
|
2337
|
+
opts = opts || {};
|
|
2338
|
+
|
|
2045
2339
|
// verify the required parameter 'body' is set
|
|
2046
2340
|
if (body === undefined || body === null) {
|
|
2047
2341
|
throw 'Missing the required parameter "body" when calling postExternalcontactsBulkOrganizationsAdd';
|
|
@@ -2057,7 +2351,8 @@ class ExternalContactsApi {
|
|
|
2057
2351
|
body,
|
|
2058
2352
|
['PureCloud OAuth'],
|
|
2059
2353
|
['application/json'],
|
|
2060
|
-
['application/json']
|
|
2354
|
+
['application/json'],
|
|
2355
|
+
opts['customHeaders']
|
|
2061
2356
|
);
|
|
2062
2357
|
}
|
|
2063
2358
|
|
|
@@ -2065,8 +2360,12 @@ class ExternalContactsApi {
|
|
|
2065
2360
|
* Bulk fetch organizations across divisions
|
|
2066
2361
|
*
|
|
2067
2362
|
* @param {Object} body Organizations ids
|
|
2363
|
+
* @param {Object} opts Optional parameters
|
|
2364
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2068
2365
|
*/
|
|
2069
|
-
postExternalcontactsBulkOrganizationsDivisionviews(body) {
|
|
2366
|
+
postExternalcontactsBulkOrganizationsDivisionviews(body, opts) {
|
|
2367
|
+
opts = opts || {};
|
|
2368
|
+
|
|
2070
2369
|
// verify the required parameter 'body' is set
|
|
2071
2370
|
if (body === undefined || body === null) {
|
|
2072
2371
|
throw 'Missing the required parameter "body" when calling postExternalcontactsBulkOrganizationsDivisionviews';
|
|
@@ -2082,7 +2381,8 @@ class ExternalContactsApi {
|
|
|
2082
2381
|
body,
|
|
2083
2382
|
['PureCloud OAuth'],
|
|
2084
2383
|
['application/json'],
|
|
2085
|
-
['application/json']
|
|
2384
|
+
['application/json'],
|
|
2385
|
+
opts['customHeaders']
|
|
2086
2386
|
);
|
|
2087
2387
|
}
|
|
2088
2388
|
|
|
@@ -2092,6 +2392,7 @@ class ExternalContactsApi {
|
|
|
2092
2392
|
* @param {Object} body External Organization Enrich Requests
|
|
2093
2393
|
* @param {Object} opts Optional parameters
|
|
2094
2394
|
* @param {Boolean} opts.dryRun If true, the request will not make any modifications, but will show you what the end result *would* be.
|
|
2395
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2095
2396
|
*/
|
|
2096
2397
|
postExternalcontactsBulkOrganizationsEnrich(body, opts) {
|
|
2097
2398
|
opts = opts || {};
|
|
@@ -2111,7 +2412,8 @@ class ExternalContactsApi {
|
|
|
2111
2412
|
body,
|
|
2112
2413
|
['PureCloud OAuth'],
|
|
2113
2414
|
['application/json'],
|
|
2114
|
-
['application/json']
|
|
2415
|
+
['application/json'],
|
|
2416
|
+
opts['customHeaders']
|
|
2115
2417
|
);
|
|
2116
2418
|
}
|
|
2117
2419
|
|
|
@@ -2119,8 +2421,12 @@ class ExternalContactsApi {
|
|
|
2119
2421
|
* Bulk remove organizations
|
|
2120
2422
|
*
|
|
2121
2423
|
* @param {Object} body Organization ids
|
|
2424
|
+
* @param {Object} opts Optional parameters
|
|
2425
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2122
2426
|
*/
|
|
2123
|
-
postExternalcontactsBulkOrganizationsRemove(body) {
|
|
2427
|
+
postExternalcontactsBulkOrganizationsRemove(body, opts) {
|
|
2428
|
+
opts = opts || {};
|
|
2429
|
+
|
|
2124
2430
|
// verify the required parameter 'body' is set
|
|
2125
2431
|
if (body === undefined || body === null) {
|
|
2126
2432
|
throw 'Missing the required parameter "body" when calling postExternalcontactsBulkOrganizationsRemove';
|
|
@@ -2136,7 +2442,8 @@ class ExternalContactsApi {
|
|
|
2136
2442
|
body,
|
|
2137
2443
|
['PureCloud OAuth'],
|
|
2138
2444
|
['application/json'],
|
|
2139
|
-
['application/json']
|
|
2445
|
+
['application/json'],
|
|
2446
|
+
opts['customHeaders']
|
|
2140
2447
|
);
|
|
2141
2448
|
}
|
|
2142
2449
|
|
|
@@ -2144,8 +2451,12 @@ class ExternalContactsApi {
|
|
|
2144
2451
|
* Bulk update organizations
|
|
2145
2452
|
*
|
|
2146
2453
|
* @param {Object} body Organizations
|
|
2454
|
+
* @param {Object} opts Optional parameters
|
|
2455
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2147
2456
|
*/
|
|
2148
|
-
postExternalcontactsBulkOrganizationsUpdate(body) {
|
|
2457
|
+
postExternalcontactsBulkOrganizationsUpdate(body, opts) {
|
|
2458
|
+
opts = opts || {};
|
|
2459
|
+
|
|
2149
2460
|
// verify the required parameter 'body' is set
|
|
2150
2461
|
if (body === undefined || body === null) {
|
|
2151
2462
|
throw 'Missing the required parameter "body" when calling postExternalcontactsBulkOrganizationsUpdate';
|
|
@@ -2161,7 +2472,8 @@ class ExternalContactsApi {
|
|
|
2161
2472
|
body,
|
|
2162
2473
|
['PureCloud OAuth'],
|
|
2163
2474
|
['application/json'],
|
|
2164
|
-
['application/json']
|
|
2475
|
+
['application/json'],
|
|
2476
|
+
opts['customHeaders']
|
|
2165
2477
|
);
|
|
2166
2478
|
}
|
|
2167
2479
|
|
|
@@ -2169,8 +2481,12 @@ class ExternalContactsApi {
|
|
|
2169
2481
|
* Bulk fetch relationships
|
|
2170
2482
|
*
|
|
2171
2483
|
* @param {Object} body Relationships ids
|
|
2484
|
+
* @param {Object} opts Optional parameters
|
|
2485
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2172
2486
|
*/
|
|
2173
|
-
postExternalcontactsBulkRelationships(body) {
|
|
2487
|
+
postExternalcontactsBulkRelationships(body, opts) {
|
|
2488
|
+
opts = opts || {};
|
|
2489
|
+
|
|
2174
2490
|
// verify the required parameter 'body' is set
|
|
2175
2491
|
if (body === undefined || body === null) {
|
|
2176
2492
|
throw 'Missing the required parameter "body" when calling postExternalcontactsBulkRelationships';
|
|
@@ -2186,7 +2502,8 @@ class ExternalContactsApi {
|
|
|
2186
2502
|
body,
|
|
2187
2503
|
['PureCloud OAuth'],
|
|
2188
2504
|
['application/json'],
|
|
2189
|
-
['application/json']
|
|
2505
|
+
['application/json'],
|
|
2506
|
+
opts['customHeaders']
|
|
2190
2507
|
);
|
|
2191
2508
|
}
|
|
2192
2509
|
|
|
@@ -2194,8 +2511,12 @@ class ExternalContactsApi {
|
|
|
2194
2511
|
* Bulk add relationships
|
|
2195
2512
|
*
|
|
2196
2513
|
* @param {Object} body Relationships
|
|
2514
|
+
* @param {Object} opts Optional parameters
|
|
2515
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2197
2516
|
*/
|
|
2198
|
-
postExternalcontactsBulkRelationshipsAdd(body) {
|
|
2517
|
+
postExternalcontactsBulkRelationshipsAdd(body, opts) {
|
|
2518
|
+
opts = opts || {};
|
|
2519
|
+
|
|
2199
2520
|
// verify the required parameter 'body' is set
|
|
2200
2521
|
if (body === undefined || body === null) {
|
|
2201
2522
|
throw 'Missing the required parameter "body" when calling postExternalcontactsBulkRelationshipsAdd';
|
|
@@ -2211,7 +2532,8 @@ class ExternalContactsApi {
|
|
|
2211
2532
|
body,
|
|
2212
2533
|
['PureCloud OAuth'],
|
|
2213
2534
|
['application/json'],
|
|
2214
|
-
['application/json']
|
|
2535
|
+
['application/json'],
|
|
2536
|
+
opts['customHeaders']
|
|
2215
2537
|
);
|
|
2216
2538
|
}
|
|
2217
2539
|
|
|
@@ -2219,8 +2541,12 @@ class ExternalContactsApi {
|
|
|
2219
2541
|
* Bulk remove relationships
|
|
2220
2542
|
*
|
|
2221
2543
|
* @param {Object} body Relationships ids
|
|
2544
|
+
* @param {Object} opts Optional parameters
|
|
2545
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2222
2546
|
*/
|
|
2223
|
-
postExternalcontactsBulkRelationshipsRemove(body) {
|
|
2547
|
+
postExternalcontactsBulkRelationshipsRemove(body, opts) {
|
|
2548
|
+
opts = opts || {};
|
|
2549
|
+
|
|
2224
2550
|
// verify the required parameter 'body' is set
|
|
2225
2551
|
if (body === undefined || body === null) {
|
|
2226
2552
|
throw 'Missing the required parameter "body" when calling postExternalcontactsBulkRelationshipsRemove';
|
|
@@ -2236,7 +2562,8 @@ class ExternalContactsApi {
|
|
|
2236
2562
|
body,
|
|
2237
2563
|
['PureCloud OAuth'],
|
|
2238
2564
|
['application/json'],
|
|
2239
|
-
['application/json']
|
|
2565
|
+
['application/json'],
|
|
2566
|
+
opts['customHeaders']
|
|
2240
2567
|
);
|
|
2241
2568
|
}
|
|
2242
2569
|
|
|
@@ -2244,8 +2571,12 @@ class ExternalContactsApi {
|
|
|
2244
2571
|
* Bulk update relationships
|
|
2245
2572
|
*
|
|
2246
2573
|
* @param {Object} body Relationships
|
|
2574
|
+
* @param {Object} opts Optional parameters
|
|
2575
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2247
2576
|
*/
|
|
2248
|
-
postExternalcontactsBulkRelationshipsUpdate(body) {
|
|
2577
|
+
postExternalcontactsBulkRelationshipsUpdate(body, opts) {
|
|
2578
|
+
opts = opts || {};
|
|
2579
|
+
|
|
2249
2580
|
// verify the required parameter 'body' is set
|
|
2250
2581
|
if (body === undefined || body === null) {
|
|
2251
2582
|
throw 'Missing the required parameter "body" when calling postExternalcontactsBulkRelationshipsUpdate';
|
|
@@ -2261,7 +2592,8 @@ class ExternalContactsApi {
|
|
|
2261
2592
|
body,
|
|
2262
2593
|
['PureCloud OAuth'],
|
|
2263
2594
|
['application/json'],
|
|
2264
|
-
['application/json']
|
|
2595
|
+
['application/json'],
|
|
2596
|
+
opts['customHeaders']
|
|
2265
2597
|
);
|
|
2266
2598
|
}
|
|
2267
2599
|
|
|
@@ -2271,6 +2603,7 @@ class ExternalContactsApi {
|
|
|
2271
2603
|
* @param {String} contactId ExternalContact ID
|
|
2272
2604
|
* @param {Object} opts Optional parameters
|
|
2273
2605
|
* @param {Object} opts.body
|
|
2606
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2274
2607
|
*/
|
|
2275
2608
|
postExternalcontactsContactJourneySegments(contactId, opts) {
|
|
2276
2609
|
opts = opts || {};
|
|
@@ -2290,7 +2623,8 @@ class ExternalContactsApi {
|
|
|
2290
2623
|
opts['body'],
|
|
2291
2624
|
['PureCloud OAuth'],
|
|
2292
2625
|
['application/json'],
|
|
2293
|
-
['application/json']
|
|
2626
|
+
['application/json'],
|
|
2627
|
+
opts['customHeaders']
|
|
2294
2628
|
);
|
|
2295
2629
|
}
|
|
2296
2630
|
|
|
@@ -2299,8 +2633,12 @@ class ExternalContactsApi {
|
|
|
2299
2633
|
*
|
|
2300
2634
|
* @param {String} contactId ExternalContact Id
|
|
2301
2635
|
* @param {Object} body ExternalContact
|
|
2636
|
+
* @param {Object} opts Optional parameters
|
|
2637
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2302
2638
|
*/
|
|
2303
|
-
postExternalcontactsContactNotes(contactId, body) {
|
|
2639
|
+
postExternalcontactsContactNotes(contactId, body, opts) {
|
|
2640
|
+
opts = opts || {};
|
|
2641
|
+
|
|
2304
2642
|
// verify the required parameter 'contactId' is set
|
|
2305
2643
|
if (contactId === undefined || contactId === null || contactId === '') {
|
|
2306
2644
|
throw 'Missing the required parameter "contactId" when calling postExternalcontactsContactNotes';
|
|
@@ -2320,7 +2658,8 @@ class ExternalContactsApi {
|
|
|
2320
2658
|
body,
|
|
2321
2659
|
['PureCloud OAuth'],
|
|
2322
2660
|
['application/json'],
|
|
2323
|
-
['application/json']
|
|
2661
|
+
['application/json'],
|
|
2662
|
+
opts['customHeaders']
|
|
2324
2663
|
);
|
|
2325
2664
|
}
|
|
2326
2665
|
|
|
@@ -2328,8 +2667,12 @@ class ExternalContactsApi {
|
|
|
2328
2667
|
* Promote an observed contact (ephemeral or identified) to a curated contact
|
|
2329
2668
|
*
|
|
2330
2669
|
* @param {String} contactId ExternalContact ID
|
|
2670
|
+
* @param {Object} opts Optional parameters
|
|
2671
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2331
2672
|
*/
|
|
2332
|
-
postExternalcontactsContactPromotion(contactId) {
|
|
2673
|
+
postExternalcontactsContactPromotion(contactId, opts) {
|
|
2674
|
+
opts = opts || {};
|
|
2675
|
+
|
|
2333
2676
|
// verify the required parameter 'contactId' is set
|
|
2334
2677
|
if (contactId === undefined || contactId === null || contactId === '') {
|
|
2335
2678
|
throw 'Missing the required parameter "contactId" when calling postExternalcontactsContactPromotion';
|
|
@@ -2345,7 +2688,8 @@ class ExternalContactsApi {
|
|
|
2345
2688
|
null,
|
|
2346
2689
|
['PureCloud OAuth'],
|
|
2347
2690
|
['application/json'],
|
|
2348
|
-
['application/json']
|
|
2691
|
+
['application/json'],
|
|
2692
|
+
opts['customHeaders']
|
|
2349
2693
|
);
|
|
2350
2694
|
}
|
|
2351
2695
|
|
|
@@ -2353,8 +2697,12 @@ class ExternalContactsApi {
|
|
|
2353
2697
|
* Create an external contact
|
|
2354
2698
|
*
|
|
2355
2699
|
* @param {Object} body ExternalContact
|
|
2700
|
+
* @param {Object} opts Optional parameters
|
|
2701
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2356
2702
|
*/
|
|
2357
|
-
postExternalcontactsContacts(body) {
|
|
2703
|
+
postExternalcontactsContacts(body, opts) {
|
|
2704
|
+
opts = opts || {};
|
|
2705
|
+
|
|
2358
2706
|
// verify the required parameter 'body' is set
|
|
2359
2707
|
if (body === undefined || body === null) {
|
|
2360
2708
|
throw 'Missing the required parameter "body" when calling postExternalcontactsContacts';
|
|
@@ -2370,7 +2718,8 @@ class ExternalContactsApi {
|
|
|
2370
2718
|
body,
|
|
2371
2719
|
['PureCloud OAuth'],
|
|
2372
2720
|
['application/json'],
|
|
2373
|
-
['application/json']
|
|
2721
|
+
['application/json'],
|
|
2722
|
+
opts['customHeaders']
|
|
2374
2723
|
);
|
|
2375
2724
|
}
|
|
2376
2725
|
|
|
@@ -2380,6 +2729,7 @@ class ExternalContactsApi {
|
|
|
2380
2729
|
* @param {Object} body ContactEnrichRequest
|
|
2381
2730
|
* @param {Object} opts Optional parameters
|
|
2382
2731
|
* @param {Boolean} opts.dryRun If true, the request will not make any modifications, but will show you what the end result *would* be.
|
|
2732
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2383
2733
|
*/
|
|
2384
2734
|
postExternalcontactsContactsEnrich(body, opts) {
|
|
2385
2735
|
opts = opts || {};
|
|
@@ -2399,7 +2749,8 @@ class ExternalContactsApi {
|
|
|
2399
2749
|
body,
|
|
2400
2750
|
['PureCloud OAuth'],
|
|
2401
2751
|
['application/json'],
|
|
2402
|
-
['application/json']
|
|
2752
|
+
['application/json'],
|
|
2753
|
+
opts['customHeaders']
|
|
2403
2754
|
);
|
|
2404
2755
|
}
|
|
2405
2756
|
|
|
@@ -2407,8 +2758,12 @@ class ExternalContactsApi {
|
|
|
2407
2758
|
* Create bulk export
|
|
2408
2759
|
*
|
|
2409
2760
|
* @param {Object} body Export
|
|
2761
|
+
* @param {Object} opts Optional parameters
|
|
2762
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2410
2763
|
*/
|
|
2411
|
-
postExternalcontactsContactsExports(body) {
|
|
2764
|
+
postExternalcontactsContactsExports(body, opts) {
|
|
2765
|
+
opts = opts || {};
|
|
2766
|
+
|
|
2412
2767
|
// verify the required parameter 'body' is set
|
|
2413
2768
|
if (body === undefined || body === null) {
|
|
2414
2769
|
throw 'Missing the required parameter "body" when calling postExternalcontactsContactsExports';
|
|
@@ -2424,7 +2779,8 @@ class ExternalContactsApi {
|
|
|
2424
2779
|
body,
|
|
2425
2780
|
['PureCloud OAuth'],
|
|
2426
2781
|
['application/json'],
|
|
2427
|
-
['application/json']
|
|
2782
|
+
['application/json'],
|
|
2783
|
+
opts['customHeaders']
|
|
2428
2784
|
);
|
|
2429
2785
|
}
|
|
2430
2786
|
|
|
@@ -2432,8 +2788,12 @@ class ExternalContactsApi {
|
|
|
2432
2788
|
* Merge up to 25 contacts into a new contact record
|
|
2433
2789
|
* Merge operation may fail if the resulting mergeset exceeds our default limit of 52. The valueOverride field lets you override any of the Contact fields post-merge. If any Contact field is left null in `valueOverride`, it will be taken from the most recently-modified contact in the merge set. Exception for *phone/*email fields: Conflicting data will be moved to any other available phone/email fields in the merged contact.
|
|
2434
2790
|
* @param {Object} body MergeRequest
|
|
2791
|
+
* @param {Object} opts Optional parameters
|
|
2792
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2435
2793
|
*/
|
|
2436
|
-
postExternalcontactsContactsMerge(body) {
|
|
2794
|
+
postExternalcontactsContactsMerge(body, opts) {
|
|
2795
|
+
opts = opts || {};
|
|
2796
|
+
|
|
2437
2797
|
// verify the required parameter 'body' is set
|
|
2438
2798
|
if (body === undefined || body === null) {
|
|
2439
2799
|
throw 'Missing the required parameter "body" when calling postExternalcontactsContactsMerge';
|
|
@@ -2449,7 +2809,8 @@ class ExternalContactsApi {
|
|
|
2449
2809
|
body,
|
|
2450
2810
|
['PureCloud OAuth'],
|
|
2451
2811
|
['application/json'],
|
|
2452
|
-
['application/json']
|
|
2812
|
+
['application/json'],
|
|
2813
|
+
opts['customHeaders']
|
|
2453
2814
|
);
|
|
2454
2815
|
}
|
|
2455
2816
|
|
|
@@ -2457,8 +2818,12 @@ class ExternalContactsApi {
|
|
|
2457
2818
|
* Create a schema
|
|
2458
2819
|
*
|
|
2459
2820
|
* @param {Object} body Schema
|
|
2821
|
+
* @param {Object} opts Optional parameters
|
|
2822
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2460
2823
|
*/
|
|
2461
|
-
postExternalcontactsContactsSchemas(body) {
|
|
2824
|
+
postExternalcontactsContactsSchemas(body, opts) {
|
|
2825
|
+
opts = opts || {};
|
|
2826
|
+
|
|
2462
2827
|
// verify the required parameter 'body' is set
|
|
2463
2828
|
if (body === undefined || body === null) {
|
|
2464
2829
|
throw 'Missing the required parameter "body" when calling postExternalcontactsContactsSchemas';
|
|
@@ -2474,7 +2839,8 @@ class ExternalContactsApi {
|
|
|
2474
2839
|
body,
|
|
2475
2840
|
['PureCloud OAuth'],
|
|
2476
2841
|
['application/json'],
|
|
2477
|
-
['application/json']
|
|
2842
|
+
['application/json'],
|
|
2843
|
+
opts['customHeaders']
|
|
2478
2844
|
);
|
|
2479
2845
|
}
|
|
2480
2846
|
|
|
@@ -2482,8 +2848,12 @@ class ExternalContactsApi {
|
|
|
2482
2848
|
* Create an External Source
|
|
2483
2849
|
*
|
|
2484
2850
|
* @param {Object} body External Source
|
|
2851
|
+
* @param {Object} opts Optional parameters
|
|
2852
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2485
2853
|
*/
|
|
2486
|
-
postExternalcontactsExternalsources(body) {
|
|
2854
|
+
postExternalcontactsExternalsources(body, opts) {
|
|
2855
|
+
opts = opts || {};
|
|
2856
|
+
|
|
2487
2857
|
// verify the required parameter 'body' is set
|
|
2488
2858
|
if (body === undefined || body === null) {
|
|
2489
2859
|
throw 'Missing the required parameter "body" when calling postExternalcontactsExternalsources';
|
|
@@ -2499,7 +2869,8 @@ class ExternalContactsApi {
|
|
|
2499
2869
|
body,
|
|
2500
2870
|
['PureCloud OAuth'],
|
|
2501
2871
|
['application/json'],
|
|
2502
|
-
['application/json']
|
|
2872
|
+
['application/json'],
|
|
2873
|
+
opts['customHeaders']
|
|
2503
2874
|
);
|
|
2504
2875
|
}
|
|
2505
2876
|
|
|
@@ -2509,6 +2880,7 @@ class ExternalContactsApi {
|
|
|
2509
2880
|
* @param {Object} identifier
|
|
2510
2881
|
* @param {Object} opts Optional parameters
|
|
2511
2882
|
* @param {Array.<String>} opts.expand which field, if any, to expand
|
|
2883
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2512
2884
|
* @deprecated
|
|
2513
2885
|
*/
|
|
2514
2886
|
postExternalcontactsIdentifierlookup(identifier, opts) {
|
|
@@ -2529,7 +2901,8 @@ class ExternalContactsApi {
|
|
|
2529
2901
|
identifier,
|
|
2530
2902
|
['PureCloud OAuth'],
|
|
2531
2903
|
['application/json'],
|
|
2532
|
-
['application/json']
|
|
2904
|
+
['application/json'],
|
|
2905
|
+
opts['customHeaders']
|
|
2533
2906
|
);
|
|
2534
2907
|
}
|
|
2535
2908
|
|
|
@@ -2539,6 +2912,7 @@ class ExternalContactsApi {
|
|
|
2539
2912
|
* @param {Object} identifier
|
|
2540
2913
|
* @param {Object} opts Optional parameters
|
|
2541
2914
|
* @param {Array.<String>} opts.expand which field, if any, to expand
|
|
2915
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2542
2916
|
*/
|
|
2543
2917
|
postExternalcontactsIdentifierlookupContacts(identifier, opts) {
|
|
2544
2918
|
opts = opts || {};
|
|
@@ -2558,7 +2932,8 @@ class ExternalContactsApi {
|
|
|
2558
2932
|
identifier,
|
|
2559
2933
|
['PureCloud OAuth'],
|
|
2560
2934
|
['application/json'],
|
|
2561
|
-
['application/json']
|
|
2935
|
+
['application/json'],
|
|
2936
|
+
opts['customHeaders']
|
|
2562
2937
|
);
|
|
2563
2938
|
}
|
|
2564
2939
|
|
|
@@ -2568,6 +2943,7 @@ class ExternalContactsApi {
|
|
|
2568
2943
|
* @param {Object} identifier
|
|
2569
2944
|
* @param {Object} opts Optional parameters
|
|
2570
2945
|
* @param {Array.<String>} opts.expand which field, if any, to expand
|
|
2946
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2571
2947
|
*/
|
|
2572
2948
|
postExternalcontactsIdentifierlookupOrganizations(identifier, opts) {
|
|
2573
2949
|
opts = opts || {};
|
|
@@ -2587,7 +2963,8 @@ class ExternalContactsApi {
|
|
|
2587
2963
|
identifier,
|
|
2588
2964
|
['PureCloud OAuth'],
|
|
2589
2965
|
['application/json'],
|
|
2590
|
-
['application/json']
|
|
2966
|
+
['application/json'],
|
|
2967
|
+
opts['customHeaders']
|
|
2591
2968
|
);
|
|
2592
2969
|
}
|
|
2593
2970
|
|
|
@@ -2595,8 +2972,12 @@ class ExternalContactsApi {
|
|
|
2595
2972
|
* Create CSV import job
|
|
2596
2973
|
*
|
|
2597
2974
|
* @param {Object} body ImportRequest
|
|
2975
|
+
* @param {Object} opts Optional parameters
|
|
2976
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2598
2977
|
*/
|
|
2599
|
-
postExternalcontactsImportCsvJobs(body) {
|
|
2978
|
+
postExternalcontactsImportCsvJobs(body, opts) {
|
|
2979
|
+
opts = opts || {};
|
|
2980
|
+
|
|
2600
2981
|
// verify the required parameter 'body' is set
|
|
2601
2982
|
if (body === undefined || body === null) {
|
|
2602
2983
|
throw 'Missing the required parameter "body" when calling postExternalcontactsImportCsvJobs';
|
|
@@ -2612,7 +2993,8 @@ class ExternalContactsApi {
|
|
|
2612
2993
|
body,
|
|
2613
2994
|
['PureCloud OAuth'],
|
|
2614
2995
|
['application/json'],
|
|
2615
|
-
['application/json']
|
|
2996
|
+
['application/json'],
|
|
2997
|
+
opts['customHeaders']
|
|
2616
2998
|
);
|
|
2617
2999
|
}
|
|
2618
3000
|
|
|
@@ -2620,8 +3002,12 @@ class ExternalContactsApi {
|
|
|
2620
3002
|
* Create settings for CSV import
|
|
2621
3003
|
*
|
|
2622
3004
|
* @param {Object} body Settings
|
|
3005
|
+
* @param {Object} opts Optional parameters
|
|
3006
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2623
3007
|
*/
|
|
2624
|
-
postExternalcontactsImportCsvSettings(body) {
|
|
3008
|
+
postExternalcontactsImportCsvSettings(body, opts) {
|
|
3009
|
+
opts = opts || {};
|
|
3010
|
+
|
|
2625
3011
|
// verify the required parameter 'body' is set
|
|
2626
3012
|
if (body === undefined || body === null) {
|
|
2627
3013
|
throw 'Missing the required parameter "body" when calling postExternalcontactsImportCsvSettings';
|
|
@@ -2637,7 +3023,8 @@ class ExternalContactsApi {
|
|
|
2637
3023
|
body,
|
|
2638
3024
|
['PureCloud OAuth'],
|
|
2639
3025
|
['application/json'],
|
|
2640
|
-
['application/json']
|
|
3026
|
+
['application/json'],
|
|
3027
|
+
opts['customHeaders']
|
|
2641
3028
|
);
|
|
2642
3029
|
}
|
|
2643
3030
|
|
|
@@ -2645,8 +3032,12 @@ class ExternalContactsApi {
|
|
|
2645
3032
|
* Get url for CSV upload
|
|
2646
3033
|
*
|
|
2647
3034
|
* @param {Object} body UploadRequest
|
|
3035
|
+
* @param {Object} opts Optional parameters
|
|
3036
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2648
3037
|
*/
|
|
2649
|
-
postExternalcontactsImportCsvUploads(body) {
|
|
3038
|
+
postExternalcontactsImportCsvUploads(body, opts) {
|
|
3039
|
+
opts = opts || {};
|
|
3040
|
+
|
|
2650
3041
|
// verify the required parameter 'body' is set
|
|
2651
3042
|
if (body === undefined || body === null) {
|
|
2652
3043
|
throw 'Missing the required parameter "body" when calling postExternalcontactsImportCsvUploads';
|
|
@@ -2662,7 +3053,8 @@ class ExternalContactsApi {
|
|
|
2662
3053
|
body,
|
|
2663
3054
|
['PureCloud OAuth'],
|
|
2664
3055
|
['application/json'],
|
|
2665
|
-
['application/json']
|
|
3056
|
+
['application/json'],
|
|
3057
|
+
opts['customHeaders']
|
|
2666
3058
|
);
|
|
2667
3059
|
}
|
|
2668
3060
|
|
|
@@ -2670,8 +3062,12 @@ class ExternalContactsApi {
|
|
|
2670
3062
|
* Create a new job
|
|
2671
3063
|
*
|
|
2672
3064
|
* @param {Object} body Job
|
|
3065
|
+
* @param {Object} opts Optional parameters
|
|
3066
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2673
3067
|
*/
|
|
2674
|
-
postExternalcontactsImportJobs(body) {
|
|
3068
|
+
postExternalcontactsImportJobs(body, opts) {
|
|
3069
|
+
opts = opts || {};
|
|
3070
|
+
|
|
2675
3071
|
// verify the required parameter 'body' is set
|
|
2676
3072
|
if (body === undefined || body === null) {
|
|
2677
3073
|
throw 'Missing the required parameter "body" when calling postExternalcontactsImportJobs';
|
|
@@ -2687,7 +3083,8 @@ class ExternalContactsApi {
|
|
|
2687
3083
|
body,
|
|
2688
3084
|
['PureCloud OAuth'],
|
|
2689
3085
|
['application/json'],
|
|
2690
|
-
['application/json']
|
|
3086
|
+
['application/json'],
|
|
3087
|
+
opts['customHeaders']
|
|
2691
3088
|
);
|
|
2692
3089
|
}
|
|
2693
3090
|
|
|
@@ -2695,8 +3092,12 @@ class ExternalContactsApi {
|
|
|
2695
3092
|
* Create a new settings
|
|
2696
3093
|
*
|
|
2697
3094
|
* @param {Object} body Setting
|
|
3095
|
+
* @param {Object} opts Optional parameters
|
|
3096
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2698
3097
|
*/
|
|
2699
|
-
postExternalcontactsImportSettings(body) {
|
|
3098
|
+
postExternalcontactsImportSettings(body, opts) {
|
|
3099
|
+
opts = opts || {};
|
|
3100
|
+
|
|
2700
3101
|
// verify the required parameter 'body' is set
|
|
2701
3102
|
if (body === undefined || body === null) {
|
|
2702
3103
|
throw 'Missing the required parameter "body" when calling postExternalcontactsImportSettings';
|
|
@@ -2712,7 +3113,8 @@ class ExternalContactsApi {
|
|
|
2712
3113
|
body,
|
|
2713
3114
|
['PureCloud OAuth'],
|
|
2714
3115
|
['application/json'],
|
|
2715
|
-
['application/json']
|
|
3116
|
+
['application/json'],
|
|
3117
|
+
opts['customHeaders']
|
|
2716
3118
|
);
|
|
2717
3119
|
}
|
|
2718
3120
|
|
|
@@ -2720,9 +3122,13 @@ class ExternalContactsApi {
|
|
|
2720
3122
|
* Merge two contacts into a new contact record
|
|
2721
3123
|
* Two curated contacts cannot be merged. Refer to the Contact Merging article on the Developer Center for details. Deprecated: This API has been superseded by a new merge API. You are encouraged to instead use /api/v2/externalcontacts/contacts/merge, which supports merging up to 25 Contacts of any type, and overriding specific fields in the resulting Contact.
|
|
2722
3124
|
* @param {Object} body MergeRequest
|
|
3125
|
+
* @param {Object} opts Optional parameters
|
|
3126
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2723
3127
|
* @deprecated
|
|
2724
3128
|
*/
|
|
2725
|
-
postExternalcontactsMergeContacts(body) {
|
|
3129
|
+
postExternalcontactsMergeContacts(body, opts) {
|
|
3130
|
+
opts = opts || {};
|
|
3131
|
+
|
|
2726
3132
|
// verify the required parameter 'body' is set
|
|
2727
3133
|
if (body === undefined || body === null) {
|
|
2728
3134
|
throw 'Missing the required parameter "body" when calling postExternalcontactsMergeContacts';
|
|
@@ -2738,7 +3144,8 @@ class ExternalContactsApi {
|
|
|
2738
3144
|
body,
|
|
2739
3145
|
['PureCloud OAuth'],
|
|
2740
3146
|
['application/json'],
|
|
2741
|
-
['application/json']
|
|
3147
|
+
['application/json'],
|
|
3148
|
+
opts['customHeaders']
|
|
2742
3149
|
);
|
|
2743
3150
|
}
|
|
2744
3151
|
|
|
@@ -2747,8 +3154,12 @@ class ExternalContactsApi {
|
|
|
2747
3154
|
*
|
|
2748
3155
|
* @param {String} externalOrganizationId External Organization Id
|
|
2749
3156
|
* @param {Object} body ExternalContact
|
|
3157
|
+
* @param {Object} opts Optional parameters
|
|
3158
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2750
3159
|
*/
|
|
2751
|
-
postExternalcontactsOrganizationNotes(externalOrganizationId, body) {
|
|
3160
|
+
postExternalcontactsOrganizationNotes(externalOrganizationId, body, opts) {
|
|
3161
|
+
opts = opts || {};
|
|
3162
|
+
|
|
2752
3163
|
// verify the required parameter 'externalOrganizationId' is set
|
|
2753
3164
|
if (externalOrganizationId === undefined || externalOrganizationId === null || externalOrganizationId === '') {
|
|
2754
3165
|
throw 'Missing the required parameter "externalOrganizationId" when calling postExternalcontactsOrganizationNotes';
|
|
@@ -2768,7 +3179,8 @@ class ExternalContactsApi {
|
|
|
2768
3179
|
body,
|
|
2769
3180
|
['PureCloud OAuth'],
|
|
2770
3181
|
['application/json'],
|
|
2771
|
-
['application/json']
|
|
3182
|
+
['application/json'],
|
|
3183
|
+
opts['customHeaders']
|
|
2772
3184
|
);
|
|
2773
3185
|
}
|
|
2774
3186
|
|
|
@@ -2776,8 +3188,12 @@ class ExternalContactsApi {
|
|
|
2776
3188
|
* Create an external organization
|
|
2777
3189
|
*
|
|
2778
3190
|
* @param {Object} body ExternalOrganization
|
|
3191
|
+
* @param {Object} opts Optional parameters
|
|
3192
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2779
3193
|
*/
|
|
2780
|
-
postExternalcontactsOrganizations(body) {
|
|
3194
|
+
postExternalcontactsOrganizations(body, opts) {
|
|
3195
|
+
opts = opts || {};
|
|
3196
|
+
|
|
2781
3197
|
// verify the required parameter 'body' is set
|
|
2782
3198
|
if (body === undefined || body === null) {
|
|
2783
3199
|
throw 'Missing the required parameter "body" when calling postExternalcontactsOrganizations';
|
|
@@ -2793,7 +3209,8 @@ class ExternalContactsApi {
|
|
|
2793
3209
|
body,
|
|
2794
3210
|
['PureCloud OAuth'],
|
|
2795
3211
|
['application/json'],
|
|
2796
|
-
['application/json']
|
|
3212
|
+
['application/json'],
|
|
3213
|
+
opts['customHeaders']
|
|
2797
3214
|
);
|
|
2798
3215
|
}
|
|
2799
3216
|
|
|
@@ -2803,6 +3220,7 @@ class ExternalContactsApi {
|
|
|
2803
3220
|
* @param {Object} body ExternalOrgEnrichRequest
|
|
2804
3221
|
* @param {Object} opts Optional parameters
|
|
2805
3222
|
* @param {Boolean} opts.dryRun If true, the request will not make any modifications, but will show you what the end result *would* be.
|
|
3223
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2806
3224
|
*/
|
|
2807
3225
|
postExternalcontactsOrganizationsEnrich(body, opts) {
|
|
2808
3226
|
opts = opts || {};
|
|
@@ -2822,7 +3240,8 @@ class ExternalContactsApi {
|
|
|
2822
3240
|
body,
|
|
2823
3241
|
['PureCloud OAuth'],
|
|
2824
3242
|
['application/json'],
|
|
2825
|
-
['application/json']
|
|
3243
|
+
['application/json'],
|
|
3244
|
+
opts['customHeaders']
|
|
2826
3245
|
);
|
|
2827
3246
|
}
|
|
2828
3247
|
|
|
@@ -2830,8 +3249,12 @@ class ExternalContactsApi {
|
|
|
2830
3249
|
* Create a schema
|
|
2831
3250
|
*
|
|
2832
3251
|
* @param {Object} body Schema
|
|
3252
|
+
* @param {Object} opts Optional parameters
|
|
3253
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2833
3254
|
*/
|
|
2834
|
-
postExternalcontactsOrganizationsSchemas(body) {
|
|
3255
|
+
postExternalcontactsOrganizationsSchemas(body, opts) {
|
|
3256
|
+
opts = opts || {};
|
|
3257
|
+
|
|
2835
3258
|
// verify the required parameter 'body' is set
|
|
2836
3259
|
if (body === undefined || body === null) {
|
|
2837
3260
|
throw 'Missing the required parameter "body" when calling postExternalcontactsOrganizationsSchemas';
|
|
@@ -2847,7 +3270,8 @@ class ExternalContactsApi {
|
|
|
2847
3270
|
body,
|
|
2848
3271
|
['PureCloud OAuth'],
|
|
2849
3272
|
['application/json'],
|
|
2850
|
-
['application/json']
|
|
3273
|
+
['application/json'],
|
|
3274
|
+
opts['customHeaders']
|
|
2851
3275
|
);
|
|
2852
3276
|
}
|
|
2853
3277
|
|
|
@@ -2855,8 +3279,12 @@ class ExternalContactsApi {
|
|
|
2855
3279
|
* Create a relationship
|
|
2856
3280
|
*
|
|
2857
3281
|
* @param {Object} body Relationship
|
|
3282
|
+
* @param {Object} opts Optional parameters
|
|
3283
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2858
3284
|
*/
|
|
2859
|
-
postExternalcontactsRelationships(body) {
|
|
3285
|
+
postExternalcontactsRelationships(body, opts) {
|
|
3286
|
+
opts = opts || {};
|
|
3287
|
+
|
|
2860
3288
|
// verify the required parameter 'body' is set
|
|
2861
3289
|
if (body === undefined || body === null) {
|
|
2862
3290
|
throw 'Missing the required parameter "body" when calling postExternalcontactsRelationships';
|
|
@@ -2872,7 +3300,8 @@ class ExternalContactsApi {
|
|
|
2872
3300
|
body,
|
|
2873
3301
|
['PureCloud OAuth'],
|
|
2874
3302
|
['application/json'],
|
|
2875
|
-
['application/json']
|
|
3303
|
+
['application/json'],
|
|
3304
|
+
opts['customHeaders']
|
|
2876
3305
|
);
|
|
2877
3306
|
}
|
|
2878
3307
|
|
|
@@ -2881,8 +3310,12 @@ class ExternalContactsApi {
|
|
|
2881
3310
|
*
|
|
2882
3311
|
* @param {String} contactId ExternalContact ID
|
|
2883
3312
|
* @param {Object} body ExternalContact
|
|
3313
|
+
* @param {Object} opts Optional parameters
|
|
3314
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2884
3315
|
*/
|
|
2885
|
-
putExternalcontactsContact(contactId, body) {
|
|
3316
|
+
putExternalcontactsContact(contactId, body, opts) {
|
|
3317
|
+
opts = opts || {};
|
|
3318
|
+
|
|
2886
3319
|
// verify the required parameter 'contactId' is set
|
|
2887
3320
|
if (contactId === undefined || contactId === null || contactId === '') {
|
|
2888
3321
|
throw 'Missing the required parameter "contactId" when calling putExternalcontactsContact';
|
|
@@ -2902,7 +3335,8 @@ class ExternalContactsApi {
|
|
|
2902
3335
|
body,
|
|
2903
3336
|
['PureCloud OAuth'],
|
|
2904
3337
|
['application/json'],
|
|
2905
|
-
['application/json']
|
|
3338
|
+
['application/json'],
|
|
3339
|
+
opts['customHeaders']
|
|
2906
3340
|
);
|
|
2907
3341
|
}
|
|
2908
3342
|
|
|
@@ -2912,8 +3346,12 @@ class ExternalContactsApi {
|
|
|
2912
3346
|
* @param {String} contactId ExternalContact Id
|
|
2913
3347
|
* @param {String} noteId Note Id
|
|
2914
3348
|
* @param {Object} body Note
|
|
3349
|
+
* @param {Object} opts Optional parameters
|
|
3350
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2915
3351
|
*/
|
|
2916
|
-
putExternalcontactsContactNote(contactId, noteId, body) {
|
|
3352
|
+
putExternalcontactsContactNote(contactId, noteId, body, opts) {
|
|
3353
|
+
opts = opts || {};
|
|
3354
|
+
|
|
2917
3355
|
// verify the required parameter 'contactId' is set
|
|
2918
3356
|
if (contactId === undefined || contactId === null || contactId === '') {
|
|
2919
3357
|
throw 'Missing the required parameter "contactId" when calling putExternalcontactsContactNote';
|
|
@@ -2937,7 +3375,8 @@ class ExternalContactsApi {
|
|
|
2937
3375
|
body,
|
|
2938
3376
|
['PureCloud OAuth'],
|
|
2939
3377
|
['application/json'],
|
|
2940
|
-
['application/json']
|
|
3378
|
+
['application/json'],
|
|
3379
|
+
opts['customHeaders']
|
|
2941
3380
|
);
|
|
2942
3381
|
}
|
|
2943
3382
|
|
|
@@ -2946,8 +3385,12 @@ class ExternalContactsApi {
|
|
|
2946
3385
|
*
|
|
2947
3386
|
* @param {String} schemaId Schema ID
|
|
2948
3387
|
* @param {Object} body Data Schema
|
|
3388
|
+
* @param {Object} opts Optional parameters
|
|
3389
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2949
3390
|
*/
|
|
2950
|
-
putExternalcontactsContactsSchema(schemaId, body) {
|
|
3391
|
+
putExternalcontactsContactsSchema(schemaId, body, opts) {
|
|
3392
|
+
opts = opts || {};
|
|
3393
|
+
|
|
2951
3394
|
// verify the required parameter 'schemaId' is set
|
|
2952
3395
|
if (schemaId === undefined || schemaId === null || schemaId === '') {
|
|
2953
3396
|
throw 'Missing the required parameter "schemaId" when calling putExternalcontactsContactsSchema';
|
|
@@ -2967,7 +3410,8 @@ class ExternalContactsApi {
|
|
|
2967
3410
|
body,
|
|
2968
3411
|
['PureCloud OAuth'],
|
|
2969
3412
|
['application/json'],
|
|
2970
|
-
['application/json']
|
|
3413
|
+
['application/json'],
|
|
3414
|
+
opts['customHeaders']
|
|
2971
3415
|
);
|
|
2972
3416
|
}
|
|
2973
3417
|
|
|
@@ -2976,8 +3420,12 @@ class ExternalContactsApi {
|
|
|
2976
3420
|
* To associate, supply a value for the externalContactId. To disassociate, do not include the property at all.
|
|
2977
3421
|
* @param {String} conversationId Conversation ID
|
|
2978
3422
|
* @param {Object} body ConversationAssociation
|
|
3423
|
+
* @param {Object} opts Optional parameters
|
|
3424
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2979
3425
|
*/
|
|
2980
|
-
putExternalcontactsConversation(conversationId, body) {
|
|
3426
|
+
putExternalcontactsConversation(conversationId, body, opts) {
|
|
3427
|
+
opts = opts || {};
|
|
3428
|
+
|
|
2981
3429
|
// verify the required parameter 'conversationId' is set
|
|
2982
3430
|
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
2983
3431
|
throw 'Missing the required parameter "conversationId" when calling putExternalcontactsConversation';
|
|
@@ -2997,7 +3445,8 @@ class ExternalContactsApi {
|
|
|
2997
3445
|
body,
|
|
2998
3446
|
['PureCloud OAuth'],
|
|
2999
3447
|
['application/json'],
|
|
3000
|
-
['application/json']
|
|
3448
|
+
['application/json'],
|
|
3449
|
+
opts['customHeaders']
|
|
3001
3450
|
);
|
|
3002
3451
|
}
|
|
3003
3452
|
|
|
@@ -3006,8 +3455,12 @@ class ExternalContactsApi {
|
|
|
3006
3455
|
*
|
|
3007
3456
|
* @param {String} externalSourceId External Source ID
|
|
3008
3457
|
* @param {Object} body External Source
|
|
3458
|
+
* @param {Object} opts Optional parameters
|
|
3459
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3009
3460
|
*/
|
|
3010
|
-
putExternalcontactsExternalsource(externalSourceId, body) {
|
|
3461
|
+
putExternalcontactsExternalsource(externalSourceId, body, opts) {
|
|
3462
|
+
opts = opts || {};
|
|
3463
|
+
|
|
3011
3464
|
// verify the required parameter 'externalSourceId' is set
|
|
3012
3465
|
if (externalSourceId === undefined || externalSourceId === null || externalSourceId === '') {
|
|
3013
3466
|
throw 'Missing the required parameter "externalSourceId" when calling putExternalcontactsExternalsource';
|
|
@@ -3027,7 +3480,8 @@ class ExternalContactsApi {
|
|
|
3027
3480
|
body,
|
|
3028
3481
|
['PureCloud OAuth'],
|
|
3029
3482
|
['application/json'],
|
|
3030
|
-
['application/json']
|
|
3483
|
+
['application/json'],
|
|
3484
|
+
opts['customHeaders']
|
|
3031
3485
|
);
|
|
3032
3486
|
}
|
|
3033
3487
|
|
|
@@ -3036,8 +3490,12 @@ class ExternalContactsApi {
|
|
|
3036
3490
|
*
|
|
3037
3491
|
* @param {String} settingsId Settings id
|
|
3038
3492
|
* @param {Object} body Settings
|
|
3493
|
+
* @param {Object} opts Optional parameters
|
|
3494
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3039
3495
|
*/
|
|
3040
|
-
putExternalcontactsImportCsvSetting(settingsId, body) {
|
|
3496
|
+
putExternalcontactsImportCsvSetting(settingsId, body, opts) {
|
|
3497
|
+
opts = opts || {};
|
|
3498
|
+
|
|
3041
3499
|
// verify the required parameter 'settingsId' is set
|
|
3042
3500
|
if (settingsId === undefined || settingsId === null || settingsId === '') {
|
|
3043
3501
|
throw 'Missing the required parameter "settingsId" when calling putExternalcontactsImportCsvSetting';
|
|
@@ -3057,7 +3515,8 @@ class ExternalContactsApi {
|
|
|
3057
3515
|
body,
|
|
3058
3516
|
['PureCloud OAuth'],
|
|
3059
3517
|
['application/json'],
|
|
3060
|
-
['application/json']
|
|
3518
|
+
['application/json'],
|
|
3519
|
+
opts['customHeaders']
|
|
3061
3520
|
);
|
|
3062
3521
|
}
|
|
3063
3522
|
|
|
@@ -3066,8 +3525,12 @@ class ExternalContactsApi {
|
|
|
3066
3525
|
*
|
|
3067
3526
|
* @param {String} jobId Job id
|
|
3068
3527
|
* @param {Object} body Status of the Job's workflow
|
|
3528
|
+
* @param {Object} opts Optional parameters
|
|
3529
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3069
3530
|
*/
|
|
3070
|
-
putExternalcontactsImportJob(jobId, body) {
|
|
3531
|
+
putExternalcontactsImportJob(jobId, body, opts) {
|
|
3532
|
+
opts = opts || {};
|
|
3533
|
+
|
|
3071
3534
|
// verify the required parameter 'jobId' is set
|
|
3072
3535
|
if (jobId === undefined || jobId === null || jobId === '') {
|
|
3073
3536
|
throw 'Missing the required parameter "jobId" when calling putExternalcontactsImportJob';
|
|
@@ -3087,7 +3550,8 @@ class ExternalContactsApi {
|
|
|
3087
3550
|
body,
|
|
3088
3551
|
['PureCloud OAuth'],
|
|
3089
3552
|
['application/json'],
|
|
3090
|
-
['application/json']
|
|
3553
|
+
['application/json'],
|
|
3554
|
+
opts['customHeaders']
|
|
3091
3555
|
);
|
|
3092
3556
|
}
|
|
3093
3557
|
|
|
@@ -3096,8 +3560,12 @@ class ExternalContactsApi {
|
|
|
3096
3560
|
*
|
|
3097
3561
|
* @param {String} settingsId Settings id
|
|
3098
3562
|
* @param {Object} body Setting
|
|
3563
|
+
* @param {Object} opts Optional parameters
|
|
3564
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3099
3565
|
*/
|
|
3100
|
-
putExternalcontactsImportSetting(settingsId, body) {
|
|
3566
|
+
putExternalcontactsImportSetting(settingsId, body, opts) {
|
|
3567
|
+
opts = opts || {};
|
|
3568
|
+
|
|
3101
3569
|
// verify the required parameter 'settingsId' is set
|
|
3102
3570
|
if (settingsId === undefined || settingsId === null || settingsId === '') {
|
|
3103
3571
|
throw 'Missing the required parameter "settingsId" when calling putExternalcontactsImportSetting';
|
|
@@ -3117,7 +3585,8 @@ class ExternalContactsApi {
|
|
|
3117
3585
|
body,
|
|
3118
3586
|
['PureCloud OAuth'],
|
|
3119
3587
|
['application/json'],
|
|
3120
|
-
['application/json']
|
|
3588
|
+
['application/json'],
|
|
3589
|
+
opts['customHeaders']
|
|
3121
3590
|
);
|
|
3122
3591
|
}
|
|
3123
3592
|
|
|
@@ -3126,8 +3595,12 @@ class ExternalContactsApi {
|
|
|
3126
3595
|
*
|
|
3127
3596
|
* @param {String} externalOrganizationId External Organization ID
|
|
3128
3597
|
* @param {Object} body ExternalOrganization
|
|
3598
|
+
* @param {Object} opts Optional parameters
|
|
3599
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3129
3600
|
*/
|
|
3130
|
-
putExternalcontactsOrganization(externalOrganizationId, body) {
|
|
3601
|
+
putExternalcontactsOrganization(externalOrganizationId, body, opts) {
|
|
3602
|
+
opts = opts || {};
|
|
3603
|
+
|
|
3131
3604
|
// verify the required parameter 'externalOrganizationId' is set
|
|
3132
3605
|
if (externalOrganizationId === undefined || externalOrganizationId === null || externalOrganizationId === '') {
|
|
3133
3606
|
throw 'Missing the required parameter "externalOrganizationId" when calling putExternalcontactsOrganization';
|
|
@@ -3147,7 +3620,8 @@ class ExternalContactsApi {
|
|
|
3147
3620
|
body,
|
|
3148
3621
|
['PureCloud OAuth'],
|
|
3149
3622
|
['application/json'],
|
|
3150
|
-
['application/json']
|
|
3623
|
+
['application/json'],
|
|
3624
|
+
opts['customHeaders']
|
|
3151
3625
|
);
|
|
3152
3626
|
}
|
|
3153
3627
|
|
|
@@ -3157,8 +3631,12 @@ class ExternalContactsApi {
|
|
|
3157
3631
|
* @param {String} externalOrganizationId External Organization Id
|
|
3158
3632
|
* @param {String} noteId Note Id
|
|
3159
3633
|
* @param {Object} body Note
|
|
3634
|
+
* @param {Object} opts Optional parameters
|
|
3635
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3160
3636
|
*/
|
|
3161
|
-
putExternalcontactsOrganizationNote(externalOrganizationId, noteId, body) {
|
|
3637
|
+
putExternalcontactsOrganizationNote(externalOrganizationId, noteId, body, opts) {
|
|
3638
|
+
opts = opts || {};
|
|
3639
|
+
|
|
3162
3640
|
// verify the required parameter 'externalOrganizationId' is set
|
|
3163
3641
|
if (externalOrganizationId === undefined || externalOrganizationId === null || externalOrganizationId === '') {
|
|
3164
3642
|
throw 'Missing the required parameter "externalOrganizationId" when calling putExternalcontactsOrganizationNote';
|
|
@@ -3182,7 +3660,8 @@ class ExternalContactsApi {
|
|
|
3182
3660
|
body,
|
|
3183
3661
|
['PureCloud OAuth'],
|
|
3184
3662
|
['application/json'],
|
|
3185
|
-
['application/json']
|
|
3663
|
+
['application/json'],
|
|
3664
|
+
opts['customHeaders']
|
|
3186
3665
|
);
|
|
3187
3666
|
}
|
|
3188
3667
|
|
|
@@ -3191,8 +3670,12 @@ class ExternalContactsApi {
|
|
|
3191
3670
|
*
|
|
3192
3671
|
* @param {String} externalOrganizationId External Organization ID
|
|
3193
3672
|
* @param {String} trustorId Trustor ID
|
|
3673
|
+
* @param {Object} opts Optional parameters
|
|
3674
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3194
3675
|
*/
|
|
3195
|
-
putExternalcontactsOrganizationTrustorTrustorId(externalOrganizationId, trustorId) {
|
|
3676
|
+
putExternalcontactsOrganizationTrustorTrustorId(externalOrganizationId, trustorId, opts) {
|
|
3677
|
+
opts = opts || {};
|
|
3678
|
+
|
|
3196
3679
|
// verify the required parameter 'externalOrganizationId' is set
|
|
3197
3680
|
if (externalOrganizationId === undefined || externalOrganizationId === null || externalOrganizationId === '') {
|
|
3198
3681
|
throw 'Missing the required parameter "externalOrganizationId" when calling putExternalcontactsOrganizationTrustorTrustorId';
|
|
@@ -3212,7 +3695,8 @@ class ExternalContactsApi {
|
|
|
3212
3695
|
null,
|
|
3213
3696
|
['PureCloud OAuth'],
|
|
3214
3697
|
['application/json'],
|
|
3215
|
-
['application/json']
|
|
3698
|
+
['application/json'],
|
|
3699
|
+
opts['customHeaders']
|
|
3216
3700
|
);
|
|
3217
3701
|
}
|
|
3218
3702
|
|
|
@@ -3221,8 +3705,12 @@ class ExternalContactsApi {
|
|
|
3221
3705
|
*
|
|
3222
3706
|
* @param {String} schemaId Schema ID
|
|
3223
3707
|
* @param {Object} body Data Schema
|
|
3708
|
+
* @param {Object} opts Optional parameters
|
|
3709
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3224
3710
|
*/
|
|
3225
|
-
putExternalcontactsOrganizationsSchema(schemaId, body) {
|
|
3711
|
+
putExternalcontactsOrganizationsSchema(schemaId, body, opts) {
|
|
3712
|
+
opts = opts || {};
|
|
3713
|
+
|
|
3226
3714
|
// verify the required parameter 'schemaId' is set
|
|
3227
3715
|
if (schemaId === undefined || schemaId === null || schemaId === '') {
|
|
3228
3716
|
throw 'Missing the required parameter "schemaId" when calling putExternalcontactsOrganizationsSchema';
|
|
@@ -3242,7 +3730,8 @@ class ExternalContactsApi {
|
|
|
3242
3730
|
body,
|
|
3243
3731
|
['PureCloud OAuth'],
|
|
3244
3732
|
['application/json'],
|
|
3245
|
-
['application/json']
|
|
3733
|
+
['application/json'],
|
|
3734
|
+
opts['customHeaders']
|
|
3246
3735
|
);
|
|
3247
3736
|
}
|
|
3248
3737
|
|
|
@@ -3251,8 +3740,12 @@ class ExternalContactsApi {
|
|
|
3251
3740
|
*
|
|
3252
3741
|
* @param {String} relationshipId Relationship Id
|
|
3253
3742
|
* @param {Object} body Relationship
|
|
3743
|
+
* @param {Object} opts Optional parameters
|
|
3744
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3254
3745
|
*/
|
|
3255
|
-
putExternalcontactsRelationship(relationshipId, body) {
|
|
3746
|
+
putExternalcontactsRelationship(relationshipId, body, opts) {
|
|
3747
|
+
opts = opts || {};
|
|
3748
|
+
|
|
3256
3749
|
// verify the required parameter 'relationshipId' is set
|
|
3257
3750
|
if (relationshipId === undefined || relationshipId === null || relationshipId === '') {
|
|
3258
3751
|
throw 'Missing the required parameter "relationshipId" when calling putExternalcontactsRelationship';
|
|
@@ -3272,7 +3765,8 @@ class ExternalContactsApi {
|
|
|
3272
3765
|
body,
|
|
3273
3766
|
['PureCloud OAuth'],
|
|
3274
3767
|
['application/json'],
|
|
3275
|
-
['application/json']
|
|
3768
|
+
['application/json'],
|
|
3769
|
+
opts['customHeaders']
|
|
3276
3770
|
);
|
|
3277
3771
|
}
|
|
3278
3772
|
|