purecloud-platform-client-v2 220.0.0 → 222.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -3
- package/dist/node/purecloud-platform-client-v2.js +1428 -138
- package/dist/web-amd/purecloud-platform-client-v2.js +1428 -138
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +497 -168
- package/dist/web-cjs/purecloud-platform-client-v2.js +497 -168
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1041 -253
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +5 -5
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +177 -1
- package/src/purecloud-platform-client-v2/api/BusinessRulesApi.js +919 -0
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +7 -3
- 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 +153 -14
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +3 -18
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +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 +1 -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 +19 -14
- 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 +65 -1
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -3
- 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 +2 -2
- 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 +3 -2
- 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 -3
- 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 +3 -2
- package/src/purecloud-platform-client-v2/index.js +7 -1
|
@@ -5,7 +5,7 @@ class ChatApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Chat service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 222.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -315,8 +315,12 @@ class ChatApi {
|
|
|
315
315
|
* Get room participants in a room
|
|
316
316
|
*
|
|
317
317
|
* @param {String} roomJid roomJid
|
|
318
|
+
* @param {Object} opts Optional parameters
|
|
319
|
+
* @param {Boolean} opts.notify Whether to get users to notify
|
|
318
320
|
*/
|
|
319
|
-
getChatsRoomParticipants(roomJid) {
|
|
321
|
+
getChatsRoomParticipants(roomJid, opts) {
|
|
322
|
+
opts = opts || {};
|
|
323
|
+
|
|
320
324
|
// verify the required parameter 'roomJid' is set
|
|
321
325
|
if (roomJid === undefined || roomJid === null) {
|
|
322
326
|
throw 'Missing the required parameter "roomJid" when calling getChatsRoomParticipants';
|
|
@@ -326,7 +330,7 @@ class ChatApi {
|
|
|
326
330
|
'/api/v2/chats/rooms/{roomJid}/participants',
|
|
327
331
|
'GET',
|
|
328
332
|
{ 'roomJid': roomJid },
|
|
329
|
-
{
|
|
333
|
+
{ 'notify': opts['notify'] },
|
|
330
334
|
{ },
|
|
331
335
|
{ },
|
|
332
336
|
null,
|
|
@@ -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 222.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -1935,7 +1935,7 @@ class ConversationsApi {
|
|
|
1935
1935
|
*
|
|
1936
1936
|
* @param {String} messageId messageId
|
|
1937
1937
|
* @param {Object} opts Optional parameters
|
|
1938
|
-
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media
|
|
1938
|
+
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media) (default to false)
|
|
1939
1939
|
*/
|
|
1940
1940
|
getConversationsMessageDetails(messageId, opts) {
|
|
1941
1941
|
opts = opts || {};
|
|
@@ -1965,7 +1965,7 @@ class ConversationsApi {
|
|
|
1965
1965
|
* @param {String} conversationId conversationId
|
|
1966
1966
|
* @param {String} messageId messageId
|
|
1967
1967
|
* @param {Object} opts Optional parameters
|
|
1968
|
-
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media
|
|
1968
|
+
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media) (default to false)
|
|
1969
1969
|
*/
|
|
1970
1970
|
getConversationsMessageMessage(conversationId, messageId, opts) {
|
|
1971
1971
|
opts = opts || {};
|
|
@@ -2207,11 +2207,36 @@ class ConversationsApi {
|
|
|
2207
2207
|
);
|
|
2208
2208
|
}
|
|
2209
2209
|
|
|
2210
|
+
/**
|
|
2211
|
+
* Get Apple messaging integration identity resolution settings
|
|
2212
|
+
*
|
|
2213
|
+
* @param {String} integrationId Integration ID
|
|
2214
|
+
* getConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2215
|
+
*/
|
|
2216
|
+
getConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId(integrationId) {
|
|
2217
|
+
// verify the required parameter 'integrationId' is set
|
|
2218
|
+
if (integrationId === undefined || integrationId === null) {
|
|
2219
|
+
throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId';
|
|
2220
|
+
}
|
|
2221
|
+
|
|
2222
|
+
return this.apiClient.callApi(
|
|
2223
|
+
'/api/v2/conversations/messaging/identityresolution/integrations/apple/{integrationId}',
|
|
2224
|
+
'GET',
|
|
2225
|
+
{ 'integrationId': integrationId },
|
|
2226
|
+
{ },
|
|
2227
|
+
{ },
|
|
2228
|
+
{ },
|
|
2229
|
+
null,
|
|
2230
|
+
['PureCloud OAuth'],
|
|
2231
|
+
['application/json'],
|
|
2232
|
+
['application/json']
|
|
2233
|
+
);
|
|
2234
|
+
}
|
|
2235
|
+
|
|
2210
2236
|
/**
|
|
2211
2237
|
* Get Facebook messaging integration identity resolution settings
|
|
2212
2238
|
*
|
|
2213
2239
|
* @param {String} integrationId Integration ID
|
|
2214
|
-
* getConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2215
2240
|
*/
|
|
2216
2241
|
getConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId(integrationId) {
|
|
2217
2242
|
// verify the required parameter 'integrationId' is set
|
|
@@ -2233,11 +2258,35 @@ class ConversationsApi {
|
|
|
2233
2258
|
);
|
|
2234
2259
|
}
|
|
2235
2260
|
|
|
2261
|
+
/**
|
|
2262
|
+
* Get an Instagram integration identity resolution settings
|
|
2263
|
+
*
|
|
2264
|
+
* @param {String} integrationId Integration ID
|
|
2265
|
+
*/
|
|
2266
|
+
getConversationsMessagingIdentityresolutionIntegrationsInstagramIntegrationId(integrationId) {
|
|
2267
|
+
// verify the required parameter 'integrationId' is set
|
|
2268
|
+
if (integrationId === undefined || integrationId === null) {
|
|
2269
|
+
throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIdentityresolutionIntegrationsInstagramIntegrationId';
|
|
2270
|
+
}
|
|
2271
|
+
|
|
2272
|
+
return this.apiClient.callApi(
|
|
2273
|
+
'/api/v2/conversations/messaging/identityresolution/integrations/instagram/{integrationId}',
|
|
2274
|
+
'GET',
|
|
2275
|
+
{ 'integrationId': integrationId },
|
|
2276
|
+
{ },
|
|
2277
|
+
{ },
|
|
2278
|
+
{ },
|
|
2279
|
+
null,
|
|
2280
|
+
['PureCloud OAuth'],
|
|
2281
|
+
['application/json'],
|
|
2282
|
+
['application/json']
|
|
2283
|
+
);
|
|
2284
|
+
}
|
|
2285
|
+
|
|
2236
2286
|
/**
|
|
2237
2287
|
* Get an open messaging integration Identity Resolution settings
|
|
2238
2288
|
*
|
|
2239
2289
|
* @param {String} integrationId Integration ID
|
|
2240
|
-
* getConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2241
2290
|
*/
|
|
2242
2291
|
getConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId(integrationId) {
|
|
2243
2292
|
// verify the required parameter 'integrationId' is set
|
|
@@ -2263,7 +2312,6 @@ class ConversationsApi {
|
|
|
2263
2312
|
* Get a whatsApp integration Identity Resolution settings
|
|
2264
2313
|
*
|
|
2265
2314
|
* @param {String} integrationId Integration ID
|
|
2266
|
-
* getConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2267
2315
|
*/
|
|
2268
2316
|
getConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId(integrationId) {
|
|
2269
2317
|
// verify the required parameter 'integrationId' is set
|
|
@@ -3093,6 +3141,40 @@ class ConversationsApi {
|
|
|
3093
3141
|
);
|
|
3094
3142
|
}
|
|
3095
3143
|
|
|
3144
|
+
/**
|
|
3145
|
+
* Update agent's engagement for the summary.
|
|
3146
|
+
*
|
|
3147
|
+
* @param {String} conversationId Conversation ID
|
|
3148
|
+
* @param {String} summaryId Summary ID
|
|
3149
|
+
* @param {Object} opts Optional parameters
|
|
3150
|
+
* @param {Object} opts.body
|
|
3151
|
+
*/
|
|
3152
|
+
patchConversationSummaryEngagements(conversationId, summaryId, opts) {
|
|
3153
|
+
opts = opts || {};
|
|
3154
|
+
|
|
3155
|
+
// verify the required parameter 'conversationId' is set
|
|
3156
|
+
if (conversationId === undefined || conversationId === null) {
|
|
3157
|
+
throw 'Missing the required parameter "conversationId" when calling patchConversationSummaryEngagements';
|
|
3158
|
+
}
|
|
3159
|
+
// verify the required parameter 'summaryId' is set
|
|
3160
|
+
if (summaryId === undefined || summaryId === null) {
|
|
3161
|
+
throw 'Missing the required parameter "summaryId" when calling patchConversationSummaryEngagements';
|
|
3162
|
+
}
|
|
3163
|
+
|
|
3164
|
+
return this.apiClient.callApi(
|
|
3165
|
+
'/api/v2/conversations/{conversationId}/summaries/{summaryId}/engagements',
|
|
3166
|
+
'PATCH',
|
|
3167
|
+
{ 'conversationId': conversationId,'summaryId': summaryId },
|
|
3168
|
+
{ },
|
|
3169
|
+
{ },
|
|
3170
|
+
{ },
|
|
3171
|
+
opts['body'],
|
|
3172
|
+
['PureCloud OAuth'],
|
|
3173
|
+
['application/json'],
|
|
3174
|
+
['application/json']
|
|
3175
|
+
);
|
|
3176
|
+
}
|
|
3177
|
+
|
|
3096
3178
|
/**
|
|
3097
3179
|
* Update the feedback for the summary.
|
|
3098
3180
|
*
|
|
@@ -3100,7 +3182,6 @@ class ConversationsApi {
|
|
|
3100
3182
|
* @param {String} summaryId Summary ID
|
|
3101
3183
|
* @param {Object} opts Optional parameters
|
|
3102
3184
|
* @param {Object} opts.body
|
|
3103
|
-
* patchConversationSummaryFeedback is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3104
3185
|
*/
|
|
3105
3186
|
patchConversationSummaryFeedback(conversationId, summaryId, opts) {
|
|
3106
3187
|
opts = opts || {};
|
|
@@ -4290,7 +4371,7 @@ class ConversationsApi {
|
|
|
4290
4371
|
|
|
4291
4372
|
/**
|
|
4292
4373
|
* Activate a WhatsApp messaging integration created using the WhatsApp embedded signup flow
|
|
4293
|
-
* Please specify the phone number to associate with this WhatsApp integration from the list of available phone numbers returned to you in the
|
|
4374
|
+
* Please specify the phone number to associate with this WhatsApp integration from the list of available phone numbers returned to you in the GET call on the integration with a createStatus of Completed. You can then run a GET on the integration to check if its status has been updated to Active.
|
|
4294
4375
|
* @param {String} integrationId Integration ID
|
|
4295
4376
|
* @param {Object} body WhatsAppEmbeddedSignupIntegrationActivationRequest
|
|
4296
4377
|
*/
|
|
@@ -6139,12 +6220,12 @@ class ConversationsApi {
|
|
|
6139
6220
|
|
|
6140
6221
|
/**
|
|
6141
6222
|
* Send message
|
|
6142
|
-
* Send message on existing conversation/communication. Only one message body field can be accepted, per request. Example: 1 textBody, 1 mediaId,
|
|
6223
|
+
* Send message on existing conversation/communication. Only one message body field can be accepted, per request. Example: 1 textBody, 1 mediaId, or 1 messageTemplate.
|
|
6143
6224
|
* @param {String} conversationId conversationId
|
|
6144
6225
|
* @param {String} communicationId communicationId
|
|
6145
6226
|
* @param {Object} body Message
|
|
6146
6227
|
* @param {Object} opts Optional parameters
|
|
6147
|
-
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media
|
|
6228
|
+
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media) (default to false)
|
|
6148
6229
|
*/
|
|
6149
6230
|
postConversationsMessageCommunicationMessages(conversationId, communicationId, body, opts) {
|
|
6150
6231
|
opts = opts || {};
|
|
@@ -6376,7 +6457,7 @@ class ConversationsApi {
|
|
|
6376
6457
|
* The path parameter [conversationId] should contain the conversationId of the conversation being filtered. The body should contain the messageId(s) of messages being requested. For example: ["a3069a33b-bbb1-4703-9d68-061d9e9db96e", "55bc6be3-078c-4a49-a4e6-1e05776ed7e8"]
|
|
6377
6458
|
* @param {String} conversationId
|
|
6378
6459
|
* @param {Object} opts Optional parameters
|
|
6379
|
-
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media
|
|
6460
|
+
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media) (default to false)
|
|
6380
6461
|
* @param {Array.<String>} opts.body messageIds
|
|
6381
6462
|
*/
|
|
6382
6463
|
postConversationsMessageMessagesBulk(conversationId, opts) {
|
|
@@ -7358,12 +7439,42 @@ class ConversationsApi {
|
|
|
7358
7439
|
);
|
|
7359
7440
|
}
|
|
7360
7441
|
|
|
7442
|
+
/**
|
|
7443
|
+
* Create an identity resolution settings for a Apple messaging integration
|
|
7444
|
+
*
|
|
7445
|
+
* @param {String} integrationId Integration ID
|
|
7446
|
+
* @param {Object} body IdentityResolutionConfig
|
|
7447
|
+
* putConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7448
|
+
*/
|
|
7449
|
+
putConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId(integrationId, body) {
|
|
7450
|
+
// verify the required parameter 'integrationId' is set
|
|
7451
|
+
if (integrationId === undefined || integrationId === null) {
|
|
7452
|
+
throw 'Missing the required parameter "integrationId" when calling putConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId';
|
|
7453
|
+
}
|
|
7454
|
+
// verify the required parameter 'body' is set
|
|
7455
|
+
if (body === undefined || body === null) {
|
|
7456
|
+
throw 'Missing the required parameter "body" when calling putConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId';
|
|
7457
|
+
}
|
|
7458
|
+
|
|
7459
|
+
return this.apiClient.callApi(
|
|
7460
|
+
'/api/v2/conversations/messaging/identityresolution/integrations/apple/{integrationId}',
|
|
7461
|
+
'PUT',
|
|
7462
|
+
{ 'integrationId': integrationId },
|
|
7463
|
+
{ },
|
|
7464
|
+
{ },
|
|
7465
|
+
{ },
|
|
7466
|
+
body,
|
|
7467
|
+
['PureCloud OAuth'],
|
|
7468
|
+
['application/json'],
|
|
7469
|
+
['application/json']
|
|
7470
|
+
);
|
|
7471
|
+
}
|
|
7472
|
+
|
|
7361
7473
|
/**
|
|
7362
7474
|
* Create an identity resolution settings for a Facebook messaging integration
|
|
7363
7475
|
*
|
|
7364
7476
|
* @param {String} integrationId Integration ID
|
|
7365
7477
|
* @param {Object} body IdentityResolutionConfig
|
|
7366
|
-
* putConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7367
7478
|
*/
|
|
7368
7479
|
putConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId(integrationId, body) {
|
|
7369
7480
|
// verify the required parameter 'integrationId' is set
|
|
@@ -7389,12 +7500,41 @@ class ConversationsApi {
|
|
|
7389
7500
|
);
|
|
7390
7501
|
}
|
|
7391
7502
|
|
|
7503
|
+
/**
|
|
7504
|
+
* Create identity resolution settings for an Instagram messaging integration
|
|
7505
|
+
*
|
|
7506
|
+
* @param {String} integrationId Integration ID
|
|
7507
|
+
* @param {Object} body IdentityResolutionConfig
|
|
7508
|
+
*/
|
|
7509
|
+
putConversationsMessagingIdentityresolutionIntegrationsInstagramIntegrationId(integrationId, body) {
|
|
7510
|
+
// verify the required parameter 'integrationId' is set
|
|
7511
|
+
if (integrationId === undefined || integrationId === null) {
|
|
7512
|
+
throw 'Missing the required parameter "integrationId" when calling putConversationsMessagingIdentityresolutionIntegrationsInstagramIntegrationId';
|
|
7513
|
+
}
|
|
7514
|
+
// verify the required parameter 'body' is set
|
|
7515
|
+
if (body === undefined || body === null) {
|
|
7516
|
+
throw 'Missing the required parameter "body" when calling putConversationsMessagingIdentityresolutionIntegrationsInstagramIntegrationId';
|
|
7517
|
+
}
|
|
7518
|
+
|
|
7519
|
+
return this.apiClient.callApi(
|
|
7520
|
+
'/api/v2/conversations/messaging/identityresolution/integrations/instagram/{integrationId}',
|
|
7521
|
+
'PUT',
|
|
7522
|
+
{ 'integrationId': integrationId },
|
|
7523
|
+
{ },
|
|
7524
|
+
{ },
|
|
7525
|
+
{ },
|
|
7526
|
+
body,
|
|
7527
|
+
['PureCloud OAuth'],
|
|
7528
|
+
['application/json'],
|
|
7529
|
+
['application/json']
|
|
7530
|
+
);
|
|
7531
|
+
}
|
|
7532
|
+
|
|
7392
7533
|
/**
|
|
7393
7534
|
* Update an open messaging integration Identity Resolution settings
|
|
7394
7535
|
*
|
|
7395
7536
|
* @param {String} integrationId Integration ID
|
|
7396
7537
|
* @param {Object} body
|
|
7397
|
-
* putConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7398
7538
|
*/
|
|
7399
7539
|
putConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId(integrationId, body) {
|
|
7400
7540
|
// verify the required parameter 'integrationId' is set
|
|
@@ -7425,7 +7565,6 @@ class ConversationsApi {
|
|
|
7425
7565
|
*
|
|
7426
7566
|
* @param {String} integrationId Integration ID
|
|
7427
7567
|
* @param {Object} body
|
|
7428
|
-
* putConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7429
7568
|
*/
|
|
7430
7569
|
putConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId(integrationId, body) {
|
|
7431
7570
|
// verify the required parameter 'integrationId' is set
|
|
@@ -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 222.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -641,7 +641,7 @@ class ExternalContactsApi {
|
|
|
641
641
|
}
|
|
642
642
|
|
|
643
643
|
/**
|
|
644
|
-
* Get
|
|
644
|
+
* Get a specific named core type.
|
|
645
645
|
*
|
|
646
646
|
* @param {String} coreTypeName Name of the core type
|
|
647
647
|
*/
|
|
@@ -1034,7 +1034,6 @@ class ExternalContactsApi {
|
|
|
1034
1034
|
* List the identifiers for an external organization
|
|
1035
1035
|
*
|
|
1036
1036
|
* @param {String} externalOrganizationId External Organization ID
|
|
1037
|
-
* getExternalcontactsOrganizationIdentifiers is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1038
1037
|
*/
|
|
1039
1038
|
getExternalcontactsOrganizationIdentifiers(externalOrganizationId) {
|
|
1040
1039
|
// verify the required parameter 'externalOrganizationId' is set
|
|
@@ -1286,7 +1285,7 @@ class ExternalContactsApi {
|
|
|
1286
1285
|
}
|
|
1287
1286
|
|
|
1288
1287
|
/**
|
|
1289
|
-
* Get
|
|
1288
|
+
* Get a specific named core type.
|
|
1290
1289
|
*
|
|
1291
1290
|
* @param {String} coreTypeName Name of the core type
|
|
1292
1291
|
*/
|
|
@@ -1441,7 +1440,6 @@ class ExternalContactsApi {
|
|
|
1441
1440
|
* @param {Object} opts Optional parameters
|
|
1442
1441
|
* @param {Number} opts.limit The number of contacts per page; must be between 10 and 200, default is 100
|
|
1443
1442
|
* @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
|
|
1444
|
-
* getExternalcontactsScanContactsDivisionviewsAll is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1445
1443
|
*/
|
|
1446
1444
|
getExternalcontactsScanContactsDivisionviewsAll(opts) {
|
|
1447
1445
|
opts = opts || {};
|
|
@@ -1493,7 +1491,6 @@ class ExternalContactsApi {
|
|
|
1493
1491
|
* @param {Object} opts Optional parameters
|
|
1494
1492
|
* @param {Number} opts.limit The number of notes per page; must be between 10 and 200, default is 100
|
|
1495
1493
|
* @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
|
|
1496
|
-
* getExternalcontactsScanNotesDivisionviewsAll is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1497
1494
|
*/
|
|
1498
1495
|
getExternalcontactsScanNotesDivisionviewsAll(opts) {
|
|
1499
1496
|
opts = opts || {};
|
|
@@ -1545,7 +1542,6 @@ class ExternalContactsApi {
|
|
|
1545
1542
|
* @param {Object} opts Optional parameters
|
|
1546
1543
|
* @param {Number} opts.limit The number of organizations per page; must be between 10 and 200, default is 100
|
|
1547
1544
|
* @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
|
|
1548
|
-
* getExternalcontactsScanOrganizationsDivisionviewsAll is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1549
1545
|
*/
|
|
1550
1546
|
getExternalcontactsScanOrganizationsDivisionviewsAll(opts) {
|
|
1551
1547
|
opts = opts || {};
|
|
@@ -1597,7 +1593,6 @@ class ExternalContactsApi {
|
|
|
1597
1593
|
* @param {Object} opts Optional parameters
|
|
1598
1594
|
* @param {Number} opts.limit The number of relationships per page; must be between 10 and 200, default is 100
|
|
1599
1595
|
* @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
|
-
* getExternalcontactsScanRelationshipsDivisionviewsAll is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1601
1596
|
*/
|
|
1602
1597
|
getExternalcontactsScanRelationshipsDivisionviewsAll(opts) {
|
|
1603
1598
|
opts = opts || {};
|
|
@@ -1652,7 +1647,6 @@ class ExternalContactsApi {
|
|
|
1652
1647
|
*
|
|
1653
1648
|
* @param {String} externalOrganizationId External Organization ID
|
|
1654
1649
|
* @param {Object} body ClaimRequest
|
|
1655
|
-
* patchExternalcontactsOrganizationIdentifiers is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1656
1650
|
*/
|
|
1657
1651
|
patchExternalcontactsOrganizationIdentifiers(externalOrganizationId, body) {
|
|
1658
1652
|
// verify the required parameter 'externalOrganizationId' is set
|
|
@@ -1732,7 +1726,6 @@ class ExternalContactsApi {
|
|
|
1732
1726
|
* Bulk fetch contacts across divisions
|
|
1733
1727
|
*
|
|
1734
1728
|
* @param {Object} body Contact ids
|
|
1735
|
-
* postExternalcontactsBulkContactsDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1736
1729
|
*/
|
|
1737
1730
|
postExternalcontactsBulkContactsDivisionviews(body) {
|
|
1738
1731
|
// verify the required parameter 'body' is set
|
|
@@ -1760,7 +1753,6 @@ class ExternalContactsApi {
|
|
|
1760
1753
|
* @param {Object} body Contact Enrich Requests
|
|
1761
1754
|
* @param {Object} opts Optional parameters
|
|
1762
1755
|
* @param {Boolean} opts.dryRun If true, the request will not make any modifications, but will show you what the end result *would* be.
|
|
1763
|
-
* postExternalcontactsBulkContactsEnrich is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1764
1756
|
*/
|
|
1765
1757
|
postExternalcontactsBulkContactsEnrich(body, opts) {
|
|
1766
1758
|
opts = opts || {};
|
|
@@ -2013,7 +2005,6 @@ class ExternalContactsApi {
|
|
|
2013
2005
|
* Bulk fetch organizations across divisions
|
|
2014
2006
|
*
|
|
2015
2007
|
* @param {Object} body Organizations ids
|
|
2016
|
-
* postExternalcontactsBulkOrganizationsDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2017
2008
|
*/
|
|
2018
2009
|
postExternalcontactsBulkOrganizationsDivisionviews(body) {
|
|
2019
2010
|
// verify the required parameter 'body' is set
|
|
@@ -2041,7 +2032,6 @@ class ExternalContactsApi {
|
|
|
2041
2032
|
* @param {Object} body External Organization Enrich Requests
|
|
2042
2033
|
* @param {Object} opts Optional parameters
|
|
2043
2034
|
* @param {Boolean} opts.dryRun If true, the request will not make any modifications, but will show you what the end result *would* be.
|
|
2044
|
-
* postExternalcontactsBulkOrganizationsEnrich is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2045
2035
|
*/
|
|
2046
2036
|
postExternalcontactsBulkOrganizationsEnrich(body, opts) {
|
|
2047
2037
|
opts = opts || {};
|
|
@@ -2301,7 +2291,6 @@ class ExternalContactsApi {
|
|
|
2301
2291
|
* @param {Object} body ContactEnrichRequest
|
|
2302
2292
|
* @param {Object} opts Optional parameters
|
|
2303
2293
|
* @param {Boolean} opts.dryRun If true, the request will not make any modifications, but will show you what the end result *would* be.
|
|
2304
|
-
* postExternalcontactsContactsEnrich is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2305
2294
|
*/
|
|
2306
2295
|
postExternalcontactsContactsEnrich(body, opts) {
|
|
2307
2296
|
opts = opts || {};
|
|
@@ -2354,7 +2343,6 @@ class ExternalContactsApi {
|
|
|
2354
2343
|
* Merge up to 25 contacts into a new contact record
|
|
2355
2344
|
* 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.
|
|
2356
2345
|
* @param {Object} body MergeRequest
|
|
2357
|
-
* postExternalcontactsContactsMerge is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2358
2346
|
*/
|
|
2359
2347
|
postExternalcontactsContactsMerge(body) {
|
|
2360
2348
|
// verify the required parameter 'body' is set
|
|
@@ -2462,7 +2450,6 @@ class ExternalContactsApi {
|
|
|
2462
2450
|
* @param {Object} identifier
|
|
2463
2451
|
* @param {Object} opts Optional parameters
|
|
2464
2452
|
* @param {Array.<String>} opts.expand which field, if any, to expand
|
|
2465
|
-
* postExternalcontactsIdentifierlookupContacts is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2466
2453
|
*/
|
|
2467
2454
|
postExternalcontactsIdentifierlookupContacts(identifier, opts) {
|
|
2468
2455
|
opts = opts || {};
|
|
@@ -2492,7 +2479,6 @@ class ExternalContactsApi {
|
|
|
2492
2479
|
* @param {Object} identifier
|
|
2493
2480
|
* @param {Object} opts Optional parameters
|
|
2494
2481
|
* @param {Array.<String>} opts.expand which field, if any, to expand
|
|
2495
|
-
* postExternalcontactsIdentifierlookupOrganizations is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2496
2482
|
*/
|
|
2497
2483
|
postExternalcontactsIdentifierlookupOrganizations(identifier, opts) {
|
|
2498
2484
|
opts = opts || {};
|
|
@@ -2728,7 +2714,6 @@ class ExternalContactsApi {
|
|
|
2728
2714
|
* @param {Object} body ExternalOrgEnrichRequest
|
|
2729
2715
|
* @param {Object} opts Optional parameters
|
|
2730
2716
|
* @param {Boolean} opts.dryRun If true, the request will not make any modifications, but will show you what the end result *would* be.
|
|
2731
|
-
* postExternalcontactsOrganizationsEnrich is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2732
2717
|
*/
|
|
2733
2718
|
postExternalcontactsOrganizationsEnrich(body, opts) {
|
|
2734
2719
|
opts = opts || {};
|