purecloud-platform-client-v2 193.0.0 → 195.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 +2 -2
- package/dist/node/purecloud-platform-client-v2.js +748 -406
- package/dist/web-amd/purecloud-platform-client-v2.js +748 -406
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +253 -180
- package/dist/web-cjs/purecloud-platform-client-v2.js +253 -180
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +537 -453
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +4 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +147 -3
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +30 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +26 -316
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +7 -7
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +3 -2
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +174 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +125 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -7
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +165 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -5,7 +5,7 @@ class ConversationsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Conversations service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 195.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -245,32 +245,6 @@ class ConversationsApi {
|
|
|
245
245
|
);
|
|
246
246
|
}
|
|
247
247
|
|
|
248
|
-
/**
|
|
249
|
-
* Delete a LINE messenger integration (Deprecated)
|
|
250
|
-
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-line-third-party-messaging-channel/
|
|
251
|
-
* @param {String} integrationId Integration ID
|
|
252
|
-
* @deprecated
|
|
253
|
-
*/
|
|
254
|
-
deleteConversationsMessagingIntegrationsLineIntegrationId(integrationId) {
|
|
255
|
-
// verify the required parameter 'integrationId' is set
|
|
256
|
-
if (integrationId === undefined || integrationId === null) {
|
|
257
|
-
throw 'Missing the required parameter "integrationId" when calling deleteConversationsMessagingIntegrationsLineIntegrationId';
|
|
258
|
-
}
|
|
259
|
-
|
|
260
|
-
return this.apiClient.callApi(
|
|
261
|
-
'/api/v2/conversations/messaging/integrations/line/{integrationId}',
|
|
262
|
-
'DELETE',
|
|
263
|
-
{ 'integrationId': integrationId },
|
|
264
|
-
{ },
|
|
265
|
-
{ },
|
|
266
|
-
{ },
|
|
267
|
-
null,
|
|
268
|
-
['PureCloud OAuth'],
|
|
269
|
-
['application/json'],
|
|
270
|
-
['application/json']
|
|
271
|
-
);
|
|
272
|
-
}
|
|
273
|
-
|
|
274
248
|
/**
|
|
275
249
|
* Delete an Open messaging integration
|
|
276
250
|
* See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.
|
|
@@ -296,32 +270,6 @@ class ConversationsApi {
|
|
|
296
270
|
);
|
|
297
271
|
}
|
|
298
272
|
|
|
299
|
-
/**
|
|
300
|
-
* Delete a Twitter messaging integration
|
|
301
|
-
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
|
|
302
|
-
* @param {String} integrationId Integration ID
|
|
303
|
-
* @deprecated
|
|
304
|
-
*/
|
|
305
|
-
deleteConversationsMessagingIntegrationsTwitterIntegrationId(integrationId) {
|
|
306
|
-
// verify the required parameter 'integrationId' is set
|
|
307
|
-
if (integrationId === undefined || integrationId === null) {
|
|
308
|
-
throw 'Missing the required parameter "integrationId" when calling deleteConversationsMessagingIntegrationsTwitterIntegrationId';
|
|
309
|
-
}
|
|
310
|
-
|
|
311
|
-
return this.apiClient.callApi(
|
|
312
|
-
'/api/v2/conversations/messaging/integrations/twitter/{integrationId}',
|
|
313
|
-
'DELETE',
|
|
314
|
-
{ 'integrationId': integrationId },
|
|
315
|
-
{ },
|
|
316
|
-
{ },
|
|
317
|
-
{ },
|
|
318
|
-
null,
|
|
319
|
-
['PureCloud OAuth'],
|
|
320
|
-
['application/json'],
|
|
321
|
-
['application/json']
|
|
322
|
-
);
|
|
323
|
-
}
|
|
324
|
-
|
|
325
273
|
/**
|
|
326
274
|
* Delete a WhatsApp messaging integration
|
|
327
275
|
*
|
|
@@ -2281,65 +2229,6 @@ class ConversationsApi {
|
|
|
2281
2229
|
);
|
|
2282
2230
|
}
|
|
2283
2231
|
|
|
2284
|
-
/**
|
|
2285
|
-
* Get a list of LINE messenger Integrations (Deprecated)
|
|
2286
|
-
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-line-third-party-messaging-channel/
|
|
2287
|
-
* @param {Object} opts Optional parameters
|
|
2288
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
2289
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
2290
|
-
* @param {Object} opts.expand Expand instructions for the return value.
|
|
2291
|
-
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
2292
|
-
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
2293
|
-
* @deprecated
|
|
2294
|
-
*/
|
|
2295
|
-
getConversationsMessagingIntegrationsLine(opts) {
|
|
2296
|
-
opts = opts || {};
|
|
2297
|
-
|
|
2298
|
-
|
|
2299
|
-
return this.apiClient.callApi(
|
|
2300
|
-
'/api/v2/conversations/messaging/integrations/line',
|
|
2301
|
-
'GET',
|
|
2302
|
-
{ },
|
|
2303
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
2304
|
-
{ },
|
|
2305
|
-
{ },
|
|
2306
|
-
null,
|
|
2307
|
-
['PureCloud OAuth'],
|
|
2308
|
-
['application/json'],
|
|
2309
|
-
['application/json']
|
|
2310
|
-
);
|
|
2311
|
-
}
|
|
2312
|
-
|
|
2313
|
-
/**
|
|
2314
|
-
* Get a LINE messenger integration (Deprecated)
|
|
2315
|
-
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-line-third-party-messaging-channel/
|
|
2316
|
-
* @param {String} integrationId Integration ID
|
|
2317
|
-
* @param {Object} opts Optional parameters
|
|
2318
|
-
* @param {Object} opts.expand Expand instructions for the return value.
|
|
2319
|
-
* @deprecated
|
|
2320
|
-
*/
|
|
2321
|
-
getConversationsMessagingIntegrationsLineIntegrationId(integrationId, opts) {
|
|
2322
|
-
opts = opts || {};
|
|
2323
|
-
|
|
2324
|
-
// verify the required parameter 'integrationId' is set
|
|
2325
|
-
if (integrationId === undefined || integrationId === null) {
|
|
2326
|
-
throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIntegrationsLineIntegrationId';
|
|
2327
|
-
}
|
|
2328
|
-
|
|
2329
|
-
return this.apiClient.callApi(
|
|
2330
|
-
'/api/v2/conversations/messaging/integrations/line/{integrationId}',
|
|
2331
|
-
'GET',
|
|
2332
|
-
{ 'integrationId': integrationId },
|
|
2333
|
-
{ 'expand': opts['expand'] },
|
|
2334
|
-
{ },
|
|
2335
|
-
{ },
|
|
2336
|
-
null,
|
|
2337
|
-
['PureCloud OAuth'],
|
|
2338
|
-
['application/json'],
|
|
2339
|
-
['application/json']
|
|
2340
|
-
);
|
|
2341
|
-
}
|
|
2342
|
-
|
|
2343
2232
|
/**
|
|
2344
2233
|
* Get a list of Open messaging integrations
|
|
2345
2234
|
* See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.
|
|
@@ -2397,65 +2286,6 @@ class ConversationsApi {
|
|
|
2397
2286
|
);
|
|
2398
2287
|
}
|
|
2399
2288
|
|
|
2400
|
-
/**
|
|
2401
|
-
* Get a list of Twitter Integrations (Deprecated)
|
|
2402
|
-
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
|
|
2403
|
-
* @param {Object} opts Optional parameters
|
|
2404
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
2405
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
2406
|
-
* @param {Object} opts.expand Expand instructions for the return value.
|
|
2407
|
-
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
2408
|
-
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
2409
|
-
* @deprecated
|
|
2410
|
-
*/
|
|
2411
|
-
getConversationsMessagingIntegrationsTwitter(opts) {
|
|
2412
|
-
opts = opts || {};
|
|
2413
|
-
|
|
2414
|
-
|
|
2415
|
-
return this.apiClient.callApi(
|
|
2416
|
-
'/api/v2/conversations/messaging/integrations/twitter',
|
|
2417
|
-
'GET',
|
|
2418
|
-
{ },
|
|
2419
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
2420
|
-
{ },
|
|
2421
|
-
{ },
|
|
2422
|
-
null,
|
|
2423
|
-
['PureCloud OAuth'],
|
|
2424
|
-
['application/json'],
|
|
2425
|
-
['application/json']
|
|
2426
|
-
);
|
|
2427
|
-
}
|
|
2428
|
-
|
|
2429
|
-
/**
|
|
2430
|
-
* Get a Twitter messaging integration (Deprecated)
|
|
2431
|
-
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
|
|
2432
|
-
* @param {String} integrationId Integration ID
|
|
2433
|
-
* @param {Object} opts Optional parameters
|
|
2434
|
-
* @param {Object} opts.expand Expand instructions for the return value.
|
|
2435
|
-
* @deprecated
|
|
2436
|
-
*/
|
|
2437
|
-
getConversationsMessagingIntegrationsTwitterIntegrationId(integrationId, opts) {
|
|
2438
|
-
opts = opts || {};
|
|
2439
|
-
|
|
2440
|
-
// verify the required parameter 'integrationId' is set
|
|
2441
|
-
if (integrationId === undefined || integrationId === null) {
|
|
2442
|
-
throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIntegrationsTwitterIntegrationId';
|
|
2443
|
-
}
|
|
2444
|
-
|
|
2445
|
-
return this.apiClient.callApi(
|
|
2446
|
-
'/api/v2/conversations/messaging/integrations/twitter/{integrationId}',
|
|
2447
|
-
'GET',
|
|
2448
|
-
{ 'integrationId': integrationId },
|
|
2449
|
-
{ 'expand': opts['expand'] },
|
|
2450
|
-
{ },
|
|
2451
|
-
{ },
|
|
2452
|
-
null,
|
|
2453
|
-
['PureCloud OAuth'],
|
|
2454
|
-
['application/json'],
|
|
2455
|
-
['application/json']
|
|
2456
|
-
);
|
|
2457
|
-
}
|
|
2458
|
-
|
|
2459
2289
|
/**
|
|
2460
2290
|
* Get a list of WhatsApp Integrations
|
|
2461
2291
|
*
|
|
@@ -2583,37 +2413,6 @@ class ConversationsApi {
|
|
|
2583
2413
|
);
|
|
2584
2414
|
}
|
|
2585
2415
|
|
|
2586
|
-
/**
|
|
2587
|
-
* Get a list of Messaging Stickers (Deprecated)
|
|
2588
|
-
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-line-third-party-messaging-channel/
|
|
2589
|
-
* @param {Object} messengerType Messenger Type
|
|
2590
|
-
* @param {Object} opts Optional parameters
|
|
2591
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
2592
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
2593
|
-
* @deprecated
|
|
2594
|
-
*/
|
|
2595
|
-
getConversationsMessagingSticker(messengerType, opts) {
|
|
2596
|
-
opts = opts || {};
|
|
2597
|
-
|
|
2598
|
-
// verify the required parameter 'messengerType' is set
|
|
2599
|
-
if (messengerType === undefined || messengerType === null) {
|
|
2600
|
-
throw 'Missing the required parameter "messengerType" when calling getConversationsMessagingSticker';
|
|
2601
|
-
}
|
|
2602
|
-
|
|
2603
|
-
return this.apiClient.callApi(
|
|
2604
|
-
'/api/v2/conversations/messaging/stickers/{messengerType}',
|
|
2605
|
-
'GET',
|
|
2606
|
-
{ 'messengerType': messengerType },
|
|
2607
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
2608
|
-
{ },
|
|
2609
|
-
{ },
|
|
2610
|
-
null,
|
|
2611
|
-
['PureCloud OAuth'],
|
|
2612
|
-
['application/json'],
|
|
2613
|
-
['application/json']
|
|
2614
|
-
);
|
|
2615
|
-
}
|
|
2616
|
-
|
|
2617
2416
|
/**
|
|
2618
2417
|
* Get a list of Supported Content profiles
|
|
2619
2418
|
*
|
|
@@ -4086,37 +3885,6 @@ class ConversationsApi {
|
|
|
4086
3885
|
);
|
|
4087
3886
|
}
|
|
4088
3887
|
|
|
4089
|
-
/**
|
|
4090
|
-
* Update Twitter messaging integration
|
|
4091
|
-
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
|
|
4092
|
-
* @param {String} integrationId Integration ID
|
|
4093
|
-
* @param {Object} body TwitterIntegrationRequest
|
|
4094
|
-
* @deprecated
|
|
4095
|
-
*/
|
|
4096
|
-
patchConversationsMessagingIntegrationsTwitterIntegrationId(integrationId, body) {
|
|
4097
|
-
// verify the required parameter 'integrationId' is set
|
|
4098
|
-
if (integrationId === undefined || integrationId === null) {
|
|
4099
|
-
throw 'Missing the required parameter "integrationId" when calling patchConversationsMessagingIntegrationsTwitterIntegrationId';
|
|
4100
|
-
}
|
|
4101
|
-
// verify the required parameter 'body' is set
|
|
4102
|
-
if (body === undefined || body === null) {
|
|
4103
|
-
throw 'Missing the required parameter "body" when calling patchConversationsMessagingIntegrationsTwitterIntegrationId';
|
|
4104
|
-
}
|
|
4105
|
-
|
|
4106
|
-
return this.apiClient.callApi(
|
|
4107
|
-
'/api/v2/conversations/messaging/integrations/twitter/{integrationId}',
|
|
4108
|
-
'PATCH',
|
|
4109
|
-
{ 'integrationId': integrationId },
|
|
4110
|
-
{ },
|
|
4111
|
-
{ },
|
|
4112
|
-
{ },
|
|
4113
|
-
body,
|
|
4114
|
-
['PureCloud OAuth'],
|
|
4115
|
-
['application/json'],
|
|
4116
|
-
['application/json']
|
|
4117
|
-
);
|
|
4118
|
-
}
|
|
4119
|
-
|
|
4120
3888
|
/**
|
|
4121
3889
|
* Activate a WhatsApp messaging integration created using the WhatsApp embedded signup flow
|
|
4122
3890
|
* Please specify the phone number to associate with this WhatsApp integration from the list of available phone numbers returned to you in the POST call to create the integration. You can then run a GET on the integration to check if its status has been updated to Active
|
|
@@ -5747,6 +5515,31 @@ class ConversationsApi {
|
|
|
5747
5515
|
);
|
|
5748
5516
|
}
|
|
5749
5517
|
|
|
5518
|
+
/**
|
|
5519
|
+
* Reconnect the user to the most recently disconnected customer on a fully disconnected email conversation
|
|
5520
|
+
*
|
|
5521
|
+
* @param {String} conversationId conversationId
|
|
5522
|
+
*/
|
|
5523
|
+
postConversationsEmailReconnect(conversationId) {
|
|
5524
|
+
// verify the required parameter 'conversationId' is set
|
|
5525
|
+
if (conversationId === undefined || conversationId === null) {
|
|
5526
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationsEmailReconnect';
|
|
5527
|
+
}
|
|
5528
|
+
|
|
5529
|
+
return this.apiClient.callApi(
|
|
5530
|
+
'/api/v2/conversations/emails/{conversationId}/reconnect',
|
|
5531
|
+
'POST',
|
|
5532
|
+
{ 'conversationId': conversationId },
|
|
5533
|
+
{ },
|
|
5534
|
+
{ },
|
|
5535
|
+
{ },
|
|
5536
|
+
null,
|
|
5537
|
+
['PureCloud OAuth'],
|
|
5538
|
+
['application/json'],
|
|
5539
|
+
['application/json']
|
|
5540
|
+
);
|
|
5541
|
+
}
|
|
5542
|
+
|
|
5750
5543
|
/**
|
|
5751
5544
|
* Create an email conversation
|
|
5752
5545
|
* If the direction of the request is INBOUND, this will create an external conversation with a third party provider. If the direction of the the request is OUTBOUND, this will create a conversation to send outbound emails on behalf of a queue.
|
|
@@ -6326,32 +6119,6 @@ class ConversationsApi {
|
|
|
6326
6119
|
);
|
|
6327
6120
|
}
|
|
6328
6121
|
|
|
6329
|
-
/**
|
|
6330
|
-
* Create a LINE messenger Integration (Deprecated)
|
|
6331
|
-
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-line-third-party-messaging-channel/
|
|
6332
|
-
* @param {Object} body LineIntegrationRequest
|
|
6333
|
-
* @deprecated
|
|
6334
|
-
*/
|
|
6335
|
-
postConversationsMessagingIntegrationsLine(body) {
|
|
6336
|
-
// verify the required parameter 'body' is set
|
|
6337
|
-
if (body === undefined || body === null) {
|
|
6338
|
-
throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsLine';
|
|
6339
|
-
}
|
|
6340
|
-
|
|
6341
|
-
return this.apiClient.callApi(
|
|
6342
|
-
'/api/v2/conversations/messaging/integrations/line',
|
|
6343
|
-
'POST',
|
|
6344
|
-
{ },
|
|
6345
|
-
{ },
|
|
6346
|
-
{ },
|
|
6347
|
-
{ },
|
|
6348
|
-
body,
|
|
6349
|
-
['PureCloud OAuth'],
|
|
6350
|
-
['application/json'],
|
|
6351
|
-
['application/json']
|
|
6352
|
-
);
|
|
6353
|
-
}
|
|
6354
|
-
|
|
6355
6122
|
/**
|
|
6356
6123
|
* Create an Open messaging integration
|
|
6357
6124
|
* See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.
|
|
@@ -6377,32 +6144,6 @@ class ConversationsApi {
|
|
|
6377
6144
|
);
|
|
6378
6145
|
}
|
|
6379
6146
|
|
|
6380
|
-
/**
|
|
6381
|
-
* Create a Twitter Integration
|
|
6382
|
-
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
|
|
6383
|
-
* @param {Object} body TwitterIntegrationRequest
|
|
6384
|
-
* @deprecated
|
|
6385
|
-
*/
|
|
6386
|
-
postConversationsMessagingIntegrationsTwitter(body) {
|
|
6387
|
-
// verify the required parameter 'body' is set
|
|
6388
|
-
if (body === undefined || body === null) {
|
|
6389
|
-
throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsTwitter';
|
|
6390
|
-
}
|
|
6391
|
-
|
|
6392
|
-
return this.apiClient.callApi(
|
|
6393
|
-
'/api/v2/conversations/messaging/integrations/twitter',
|
|
6394
|
-
'POST',
|
|
6395
|
-
{ },
|
|
6396
|
-
{ },
|
|
6397
|
-
{ },
|
|
6398
|
-
{ },
|
|
6399
|
-
body,
|
|
6400
|
-
['PureCloud OAuth'],
|
|
6401
|
-
['application/json'],
|
|
6402
|
-
['application/json']
|
|
6403
|
-
);
|
|
6404
|
-
}
|
|
6405
|
-
|
|
6406
6147
|
/**
|
|
6407
6148
|
* [This API is deprecated. Use POST /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup instead] Create a WhatsApp Integration
|
|
6408
6149
|
* [This API is deprecated. Use POST /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup instead] You must be approved by WhatsApp to use this feature. Your approved e164-formatted phone number and valid WhatsApp certificate for your number are required. Your WhatsApp certificate must have valid base64 encoding. Please paste carefully and do not add any leading or trailing spaces. Do not alter any characters. An integration must be activated within 7 days of certificate generation. If you cannot complete the addition and activation of the number within 7 days, please obtain a new certificate before creating the integration. Integrations created with an invalid number or certificate may immediately incur additional integration fees. Please carefully enter your number and certificate as described.
|
|
@@ -7043,37 +6784,6 @@ class ConversationsApi {
|
|
|
7043
6784
|
);
|
|
7044
6785
|
}
|
|
7045
6786
|
|
|
7046
|
-
/**
|
|
7047
|
-
* Update a LINE messenger integration (Deprecated)
|
|
7048
|
-
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-line-third-party-messaging-channel/
|
|
7049
|
-
* @param {String} integrationId Integration ID
|
|
7050
|
-
* @param {Object} body LineIntegrationRequest
|
|
7051
|
-
* @deprecated
|
|
7052
|
-
*/
|
|
7053
|
-
putConversationsMessagingIntegrationsLineIntegrationId(integrationId, body) {
|
|
7054
|
-
// verify the required parameter 'integrationId' is set
|
|
7055
|
-
if (integrationId === undefined || integrationId === null) {
|
|
7056
|
-
throw 'Missing the required parameter "integrationId" when calling putConversationsMessagingIntegrationsLineIntegrationId';
|
|
7057
|
-
}
|
|
7058
|
-
// verify the required parameter 'body' is set
|
|
7059
|
-
if (body === undefined || body === null) {
|
|
7060
|
-
throw 'Missing the required parameter "body" when calling putConversationsMessagingIntegrationsLineIntegrationId';
|
|
7061
|
-
}
|
|
7062
|
-
|
|
7063
|
-
return this.apiClient.callApi(
|
|
7064
|
-
'/api/v2/conversations/messaging/integrations/line/{integrationId}',
|
|
7065
|
-
'PUT',
|
|
7066
|
-
{ 'integrationId': integrationId },
|
|
7067
|
-
{ },
|
|
7068
|
-
{ },
|
|
7069
|
-
{ },
|
|
7070
|
-
body,
|
|
7071
|
-
['PureCloud OAuth'],
|
|
7072
|
-
['application/json'],
|
|
7073
|
-
['application/json']
|
|
7074
|
-
);
|
|
7075
|
-
}
|
|
7076
|
-
|
|
7077
6787
|
/**
|
|
7078
6788
|
* Set the organization's default setting that may be applied to to integrations without settings
|
|
7079
6789
|
* When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be assigned to it.
|
|
@@ -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 195.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -518,7 +518,7 @@ class ExternalContactsApi {
|
|
|
518
518
|
*
|
|
519
519
|
* @param {String} externalOrganizationId External Organization ID
|
|
520
520
|
* @param {Object} opts Optional parameters
|
|
521
|
-
* @param {
|
|
521
|
+
* @param {Array.<String>} opts.expand which fields, if any, to expand (externalDataSources)
|
|
522
522
|
* @param {Boolean} opts.includeTrustors (true or false) whether or not to include trustor information embedded in the externalOrganization
|
|
523
523
|
*/
|
|
524
524
|
getExternalcontactsOrganization(externalOrganizationId, opts) {
|
|
@@ -533,7 +533,7 @@ class ExternalContactsApi {
|
|
|
533
533
|
'/api/v2/externalcontacts/organizations/{externalOrganizationId}',
|
|
534
534
|
'GET',
|
|
535
535
|
{ 'externalOrganizationId': externalOrganizationId },
|
|
536
|
-
{ 'expand': opts['expand'],'includeTrustors': opts['includeTrustors'] },
|
|
536
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'includeTrustors': opts['includeTrustors'] },
|
|
537
537
|
{ },
|
|
538
538
|
{ },
|
|
539
539
|
null,
|
|
@@ -649,7 +649,7 @@ class ExternalContactsApi {
|
|
|
649
649
|
* @param {Object} opts Optional parameters
|
|
650
650
|
* @param {Number} opts.pageSize Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 20)
|
|
651
651
|
* @param {Number} opts.pageNumber Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 1)
|
|
652
|
-
* @param {
|
|
652
|
+
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
653
653
|
* @param {String} opts.sortOrder The Relationship field to sort by. Any of: [createDate, relationship]. Direction: [asc, desc]. e.g. createDate:asc, relationship:desc
|
|
654
654
|
*/
|
|
655
655
|
getExternalcontactsOrganizationRelationships(externalOrganizationId, opts) {
|
|
@@ -664,7 +664,7 @@ class ExternalContactsApi {
|
|
|
664
664
|
'/api/v2/externalcontacts/organizations/{externalOrganizationId}/relationships',
|
|
665
665
|
'GET',
|
|
666
666
|
{ 'externalOrganizationId': externalOrganizationId },
|
|
667
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'sortOrder': opts['sortOrder'] },
|
|
667
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'sortOrder': opts['sortOrder'] },
|
|
668
668
|
{ },
|
|
669
669
|
{ },
|
|
670
670
|
null,
|
|
@@ -809,7 +809,7 @@ class ExternalContactsApi {
|
|
|
809
809
|
*
|
|
810
810
|
* @param {String} relationshipId Relationship Id
|
|
811
811
|
* @param {Object} opts Optional parameters
|
|
812
|
-
* @param {
|
|
812
|
+
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
813
813
|
*/
|
|
814
814
|
getExternalcontactsRelationship(relationshipId, opts) {
|
|
815
815
|
opts = opts || {};
|
|
@@ -823,7 +823,7 @@ class ExternalContactsApi {
|
|
|
823
823
|
'/api/v2/externalcontacts/relationships/{relationshipId}',
|
|
824
824
|
'GET',
|
|
825
825
|
{ 'relationshipId': relationshipId },
|
|
826
|
-
{ 'expand': opts['expand'] },
|
|
826
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
827
827
|
{ },
|
|
828
828
|
{ },
|
|
829
829
|
null,
|
|
@@ -5,7 +5,7 @@ class KnowledgeApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Knowledge service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 195.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -1359,6 +1359,7 @@ class KnowledgeApi {
|
|
|
1359
1359
|
* @param {Array.<String>} opts.type If specified, retrieves operations with specified operation type, comma separated values expected.
|
|
1360
1360
|
* @param {Array.<String>} opts.status If specified, retrieves operations with specified operation status, comma separated values expected.
|
|
1361
1361
|
* @param {String} opts.interval Retrieves the operations modified in specified date and time range. If the after and before cursor parameters are within this interval, it would return valid data, otherwise it throws an error.The dates in the interval are represented in ISO-8601 format: YYYY-MM-DDThh:mm:ssZ/YYYY-MM-DDThh:mm:ssZ
|
|
1362
|
+
* @param {Array.<String>} opts.sourceId If specified, retrieves operations associated with source ids, comma separated values expected.
|
|
1362
1363
|
* getKnowledgeKnowledgebaseOperations is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1363
1364
|
*/
|
|
1364
1365
|
getKnowledgeKnowledgebaseOperations(knowledgeBaseId, opts) {
|
|
@@ -1373,7 +1374,7 @@ class KnowledgeApi {
|
|
|
1373
1374
|
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/operations',
|
|
1374
1375
|
'GET',
|
|
1375
1376
|
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
1376
|
-
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'userId': this.apiClient.buildCollectionParam(opts['userId'], 'multi'),'type': this.apiClient.buildCollectionParam(opts['type'], 'multi'),'status': this.apiClient.buildCollectionParam(opts['status'], 'multi'),'interval': opts['interval'] },
|
|
1377
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'userId': this.apiClient.buildCollectionParam(opts['userId'], 'multi'),'type': this.apiClient.buildCollectionParam(opts['type'], 'multi'),'status': this.apiClient.buildCollectionParam(opts['status'], 'multi'),'interval': opts['interval'],'sourceId': this.apiClient.buildCollectionParam(opts['sourceId'], 'multi') },
|
|
1377
1378
|
{ },
|
|
1378
1379
|
{ },
|
|
1379
1380
|
null,
|