purecloud-platform-client-v2 216.0.0 → 217.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 +826 -457
- package/dist/web-amd/purecloud-platform-client-v2.js +826 -457
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +314 -217
- package/dist/web-cjs/purecloud-platform-client-v2.js +319 -220
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +345 -220
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -305
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +112 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +9 -8
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -5
- 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 +174 -2
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +167 -4
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +5 -3
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +13 -11
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +9 -8
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +3 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +19 -7
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +4 -29
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +182 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +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 -3
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +58 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +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 217.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -2182,6 +2182,84 @@ class ConversationsApi {
|
|
|
2182
2182
|
);
|
|
2183
2183
|
}
|
|
2184
2184
|
|
|
2185
|
+
/**
|
|
2186
|
+
* Get Facebook messaging integration identity resolution settings
|
|
2187
|
+
*
|
|
2188
|
+
* @param {String} integrationId Integration ID
|
|
2189
|
+
* getConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2190
|
+
*/
|
|
2191
|
+
getConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId(integrationId) {
|
|
2192
|
+
// verify the required parameter 'integrationId' is set
|
|
2193
|
+
if (integrationId === undefined || integrationId === null) {
|
|
2194
|
+
throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId';
|
|
2195
|
+
}
|
|
2196
|
+
|
|
2197
|
+
return this.apiClient.callApi(
|
|
2198
|
+
'/api/v2/conversations/messaging/identityresolution/integrations/facebook/{integrationId}',
|
|
2199
|
+
'GET',
|
|
2200
|
+
{ 'integrationId': integrationId },
|
|
2201
|
+
{ },
|
|
2202
|
+
{ },
|
|
2203
|
+
{ },
|
|
2204
|
+
null,
|
|
2205
|
+
['PureCloud OAuth'],
|
|
2206
|
+
['application/json'],
|
|
2207
|
+
['application/json']
|
|
2208
|
+
);
|
|
2209
|
+
}
|
|
2210
|
+
|
|
2211
|
+
/**
|
|
2212
|
+
* Get an open messaging integration Identity Resolution settings
|
|
2213
|
+
*
|
|
2214
|
+
* @param {String} integrationId Integration ID
|
|
2215
|
+
* getConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2216
|
+
*/
|
|
2217
|
+
getConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId(integrationId) {
|
|
2218
|
+
// verify the required parameter 'integrationId' is set
|
|
2219
|
+
if (integrationId === undefined || integrationId === null) {
|
|
2220
|
+
throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId';
|
|
2221
|
+
}
|
|
2222
|
+
|
|
2223
|
+
return this.apiClient.callApi(
|
|
2224
|
+
'/api/v2/conversations/messaging/identityresolution/integrations/open/{integrationId}',
|
|
2225
|
+
'GET',
|
|
2226
|
+
{ 'integrationId': integrationId },
|
|
2227
|
+
{ },
|
|
2228
|
+
{ },
|
|
2229
|
+
{ },
|
|
2230
|
+
null,
|
|
2231
|
+
['PureCloud OAuth'],
|
|
2232
|
+
['application/json'],
|
|
2233
|
+
['application/json']
|
|
2234
|
+
);
|
|
2235
|
+
}
|
|
2236
|
+
|
|
2237
|
+
/**
|
|
2238
|
+
* Get a whatsApp integration Identity Resolution settings
|
|
2239
|
+
*
|
|
2240
|
+
* @param {String} integrationId Integration ID
|
|
2241
|
+
* getConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2242
|
+
*/
|
|
2243
|
+
getConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId(integrationId) {
|
|
2244
|
+
// verify the required parameter 'integrationId' is set
|
|
2245
|
+
if (integrationId === undefined || integrationId === null) {
|
|
2246
|
+
throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId';
|
|
2247
|
+
}
|
|
2248
|
+
|
|
2249
|
+
return this.apiClient.callApi(
|
|
2250
|
+
'/api/v2/conversations/messaging/identityresolution/integrations/whatsapp/{integrationId}',
|
|
2251
|
+
'GET',
|
|
2252
|
+
{ 'integrationId': integrationId },
|
|
2253
|
+
{ },
|
|
2254
|
+
{ },
|
|
2255
|
+
{ },
|
|
2256
|
+
null,
|
|
2257
|
+
['PureCloud OAuth'],
|
|
2258
|
+
['application/json'],
|
|
2259
|
+
['application/json']
|
|
2260
|
+
);
|
|
2261
|
+
}
|
|
2262
|
+
|
|
2185
2263
|
/**
|
|
2186
2264
|
* Get a list of Integrations
|
|
2187
2265
|
*
|
|
@@ -6847,9 +6925,10 @@ class ConversationsApi {
|
|
|
6847
6925
|
|
|
6848
6926
|
/**
|
|
6849
6927
|
* Update a conversation by setting its recording state
|
|
6850
|
-
*
|
|
6928
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
6851
6929
|
* @param {String} conversationId conversationId
|
|
6852
6930
|
* @param {Object} body SetRecordingState
|
|
6931
|
+
* @deprecated
|
|
6853
6932
|
*/
|
|
6854
6933
|
putConversationsCobrowsesessionRecordingstate(conversationId, body) {
|
|
6855
6934
|
// verify the required parameter 'conversationId' is set
|
|
@@ -6995,6 +7074,99 @@ class ConversationsApi {
|
|
|
6995
7074
|
);
|
|
6996
7075
|
}
|
|
6997
7076
|
|
|
7077
|
+
/**
|
|
7078
|
+
* Create an identity resolution settings for a Facebook messaging integration
|
|
7079
|
+
*
|
|
7080
|
+
* @param {String} integrationId Integration ID
|
|
7081
|
+
* @param {Object} body IdentityResolutionConfig
|
|
7082
|
+
* putConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7083
|
+
*/
|
|
7084
|
+
putConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId(integrationId, body) {
|
|
7085
|
+
// verify the required parameter 'integrationId' is set
|
|
7086
|
+
if (integrationId === undefined || integrationId === null) {
|
|
7087
|
+
throw 'Missing the required parameter "integrationId" when calling putConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId';
|
|
7088
|
+
}
|
|
7089
|
+
// verify the required parameter 'body' is set
|
|
7090
|
+
if (body === undefined || body === null) {
|
|
7091
|
+
throw 'Missing the required parameter "body" when calling putConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId';
|
|
7092
|
+
}
|
|
7093
|
+
|
|
7094
|
+
return this.apiClient.callApi(
|
|
7095
|
+
'/api/v2/conversations/messaging/identityresolution/integrations/facebook/{integrationId}',
|
|
7096
|
+
'PUT',
|
|
7097
|
+
{ 'integrationId': integrationId },
|
|
7098
|
+
{ },
|
|
7099
|
+
{ },
|
|
7100
|
+
{ },
|
|
7101
|
+
body,
|
|
7102
|
+
['PureCloud OAuth'],
|
|
7103
|
+
['application/json'],
|
|
7104
|
+
['application/json']
|
|
7105
|
+
);
|
|
7106
|
+
}
|
|
7107
|
+
|
|
7108
|
+
/**
|
|
7109
|
+
* Update an open messaging integration Identity Resolution settings
|
|
7110
|
+
*
|
|
7111
|
+
* @param {String} integrationId Integration ID
|
|
7112
|
+
* @param {Object} body
|
|
7113
|
+
* putConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7114
|
+
*/
|
|
7115
|
+
putConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId(integrationId, body) {
|
|
7116
|
+
// verify the required parameter 'integrationId' is set
|
|
7117
|
+
if (integrationId === undefined || integrationId === null) {
|
|
7118
|
+
throw 'Missing the required parameter "integrationId" when calling putConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId';
|
|
7119
|
+
}
|
|
7120
|
+
// verify the required parameter 'body' is set
|
|
7121
|
+
if (body === undefined || body === null) {
|
|
7122
|
+
throw 'Missing the required parameter "body" when calling putConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId';
|
|
7123
|
+
}
|
|
7124
|
+
|
|
7125
|
+
return this.apiClient.callApi(
|
|
7126
|
+
'/api/v2/conversations/messaging/identityresolution/integrations/open/{integrationId}',
|
|
7127
|
+
'PUT',
|
|
7128
|
+
{ 'integrationId': integrationId },
|
|
7129
|
+
{ },
|
|
7130
|
+
{ },
|
|
7131
|
+
{ },
|
|
7132
|
+
body,
|
|
7133
|
+
['PureCloud OAuth'],
|
|
7134
|
+
['application/json'],
|
|
7135
|
+
['application/json']
|
|
7136
|
+
);
|
|
7137
|
+
}
|
|
7138
|
+
|
|
7139
|
+
/**
|
|
7140
|
+
* Update a whatsApp integration Identity Resolution settings
|
|
7141
|
+
*
|
|
7142
|
+
* @param {String} integrationId Integration ID
|
|
7143
|
+
* @param {Object} body
|
|
7144
|
+
* putConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7145
|
+
*/
|
|
7146
|
+
putConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId(integrationId, body) {
|
|
7147
|
+
// verify the required parameter 'integrationId' is set
|
|
7148
|
+
if (integrationId === undefined || integrationId === null) {
|
|
7149
|
+
throw 'Missing the required parameter "integrationId" when calling putConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId';
|
|
7150
|
+
}
|
|
7151
|
+
// verify the required parameter 'body' is set
|
|
7152
|
+
if (body === undefined || body === null) {
|
|
7153
|
+
throw 'Missing the required parameter "body" when calling putConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId';
|
|
7154
|
+
}
|
|
7155
|
+
|
|
7156
|
+
return this.apiClient.callApi(
|
|
7157
|
+
'/api/v2/conversations/messaging/identityresolution/integrations/whatsapp/{integrationId}',
|
|
7158
|
+
'PUT',
|
|
7159
|
+
{ 'integrationId': integrationId },
|
|
7160
|
+
{ },
|
|
7161
|
+
{ },
|
|
7162
|
+
{ },
|
|
7163
|
+
body,
|
|
7164
|
+
['PureCloud OAuth'],
|
|
7165
|
+
['application/json'],
|
|
7166
|
+
['application/json']
|
|
7167
|
+
);
|
|
7168
|
+
}
|
|
7169
|
+
|
|
6998
7170
|
/**
|
|
6999
7171
|
* Set the organization's default setting that may be applied to to integrations without settings
|
|
7000
7172
|
* 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 217.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -469,6 +469,7 @@ class ExternalContactsApi {
|
|
|
469
469
|
* @param {String} opts.q User supplied search keywords (no special syntax is currently supported)
|
|
470
470
|
* @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
|
|
471
471
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
472
|
+
* @param {Array.<String>} opts.divisionIds which divisions to search, up to 50
|
|
472
473
|
*/
|
|
473
474
|
getExternalcontactsContacts(opts) {
|
|
474
475
|
opts = opts || {};
|
|
@@ -478,7 +479,7 @@ class ExternalContactsApi {
|
|
|
478
479
|
'/api/v2/externalcontacts/contacts',
|
|
479
480
|
'GET',
|
|
480
481
|
{ },
|
|
481
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'q': opts['q'],'sortOrder': opts['sortOrder'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
482
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'q': opts['q'],'sortOrder': opts['sortOrder'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'divisionIds': this.apiClient.buildCollectionParam(opts['divisionIds'], 'multi') },
|
|
482
483
|
{ },
|
|
483
484
|
{ },
|
|
484
485
|
null,
|
|
@@ -1022,6 +1023,7 @@ class ExternalContactsApi {
|
|
|
1022
1023
|
* @param {String} opts.sortOrder The Organization field to sort by. Any of: [companyType, industry, name]. Direction: [asc, desc]. e.g. companyType:asc, industry:desc
|
|
1023
1024
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
1024
1025
|
* @param {Boolean} opts.includeTrustors (true or false) whether or not to include trustor information embedded in the externalOrganization
|
|
1026
|
+
* @param {Array.<String>} opts.divisionIds which divisions to search, up to 50
|
|
1025
1027
|
*/
|
|
1026
1028
|
getExternalcontactsOrganizations(opts) {
|
|
1027
1029
|
opts = opts || {};
|
|
@@ -1031,7 +1033,7 @@ class ExternalContactsApi {
|
|
|
1031
1033
|
'/api/v2/externalcontacts/organizations',
|
|
1032
1034
|
'GET',
|
|
1033
1035
|
{ },
|
|
1034
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'q': opts['q'],'trustorId': this.apiClient.buildCollectionParam(opts['trustorId'], 'multi'),'sortOrder': opts['sortOrder'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'includeTrustors': opts['includeTrustors'] },
|
|
1036
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'q': opts['q'],'trustorId': this.apiClient.buildCollectionParam(opts['trustorId'], 'multi'),'sortOrder': opts['sortOrder'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'includeTrustors': opts['includeTrustors'],'divisionIds': this.apiClient.buildCollectionParam(opts['divisionIds'], 'multi') },
|
|
1035
1037
|
{ },
|
|
1036
1038
|
{ },
|
|
1037
1039
|
null,
|
|
@@ -1176,6 +1178,7 @@ class ExternalContactsApi {
|
|
|
1176
1178
|
* @param {String} lookupVal User supplied value to lookup contacts/externalOrganizations (supports email addresses, e164 phone numbers, Twitter screen names)
|
|
1177
1179
|
* @param {Object} opts Optional parameters
|
|
1178
1180
|
* @param {Array.<String>} opts.expand which field, if any, to expand
|
|
1181
|
+
* @param {String} opts.divisionId Specifies which division to lookup contacts/externalOrganizations in, for the given lookup value (default to *)
|
|
1179
1182
|
*/
|
|
1180
1183
|
getExternalcontactsReversewhitepageslookup(lookupVal, opts) {
|
|
1181
1184
|
opts = opts || {};
|
|
@@ -1189,7 +1192,7 @@ class ExternalContactsApi {
|
|
|
1189
1192
|
'/api/v2/externalcontacts/reversewhitepageslookup',
|
|
1190
1193
|
'GET',
|
|
1191
1194
|
{ },
|
|
1192
|
-
{ 'lookupVal': lookupVal,'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
1195
|
+
{ 'lookupVal': lookupVal,'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'divisionId': opts['divisionId'] },
|
|
1193
1196
|
{ },
|
|
1194
1197
|
{ },
|
|
1195
1198
|
null,
|
|
@@ -1205,6 +1208,7 @@ class ExternalContactsApi {
|
|
|
1205
1208
|
* @param {Object} opts Optional parameters
|
|
1206
1209
|
* @param {Number} opts.limit The number of contacts per page; must be between 10 and 200, default is 100
|
|
1207
1210
|
* @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
|
|
1211
|
+
* @param {String} opts.divisionId The division to scan over (default to *)
|
|
1208
1212
|
*/
|
|
1209
1213
|
getExternalcontactsScanContacts(opts) {
|
|
1210
1214
|
opts = opts || {};
|
|
@@ -1214,6 +1218,32 @@ class ExternalContactsApi {
|
|
|
1214
1218
|
'/api/v2/externalcontacts/scan/contacts',
|
|
1215
1219
|
'GET',
|
|
1216
1220
|
{ },
|
|
1221
|
+
{ 'limit': opts['limit'],'cursor': opts['cursor'],'divisionId': opts['divisionId'] },
|
|
1222
|
+
{ },
|
|
1223
|
+
{ },
|
|
1224
|
+
null,
|
|
1225
|
+
['PureCloud OAuth'],
|
|
1226
|
+
['application/json'],
|
|
1227
|
+
['application/json']
|
|
1228
|
+
);
|
|
1229
|
+
}
|
|
1230
|
+
|
|
1231
|
+
/**
|
|
1232
|
+
* Scan for external contacts using paging
|
|
1233
|
+
*
|
|
1234
|
+
* @param {Object} opts Optional parameters
|
|
1235
|
+
* @param {Number} opts.limit The number of contacts per page; must be between 10 and 200, default is 100
|
|
1236
|
+
* @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
|
|
1237
|
+
* getExternalcontactsScanContactsDivisionviewsAll is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1238
|
+
*/
|
|
1239
|
+
getExternalcontactsScanContactsDivisionviewsAll(opts) {
|
|
1240
|
+
opts = opts || {};
|
|
1241
|
+
|
|
1242
|
+
|
|
1243
|
+
return this.apiClient.callApi(
|
|
1244
|
+
'/api/v2/externalcontacts/scan/contacts/divisionviews/all',
|
|
1245
|
+
'GET',
|
|
1246
|
+
{ },
|
|
1217
1247
|
{ 'limit': opts['limit'],'cursor': opts['cursor'] },
|
|
1218
1248
|
{ },
|
|
1219
1249
|
{ },
|
|
@@ -1230,6 +1260,7 @@ class ExternalContactsApi {
|
|
|
1230
1260
|
* @param {Object} opts Optional parameters
|
|
1231
1261
|
* @param {Number} opts.limit The number of notes per page; must be between 10 and 200, default is 100
|
|
1232
1262
|
* @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
|
|
1263
|
+
* @param {String} opts.divisionId The division to scan over (default to *)
|
|
1233
1264
|
*/
|
|
1234
1265
|
getExternalcontactsScanNotes(opts) {
|
|
1235
1266
|
opts = opts || {};
|
|
@@ -1239,6 +1270,32 @@ class ExternalContactsApi {
|
|
|
1239
1270
|
'/api/v2/externalcontacts/scan/notes',
|
|
1240
1271
|
'GET',
|
|
1241
1272
|
{ },
|
|
1273
|
+
{ 'limit': opts['limit'],'cursor': opts['cursor'],'divisionId': opts['divisionId'] },
|
|
1274
|
+
{ },
|
|
1275
|
+
{ },
|
|
1276
|
+
null,
|
|
1277
|
+
['PureCloud OAuth'],
|
|
1278
|
+
['application/json'],
|
|
1279
|
+
['application/json']
|
|
1280
|
+
);
|
|
1281
|
+
}
|
|
1282
|
+
|
|
1283
|
+
/**
|
|
1284
|
+
* Scan for notes using paging
|
|
1285
|
+
*
|
|
1286
|
+
* @param {Object} opts Optional parameters
|
|
1287
|
+
* @param {Number} opts.limit The number of notes per page; must be between 10 and 200, default is 100
|
|
1288
|
+
* @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
|
|
1289
|
+
* getExternalcontactsScanNotesDivisionviewsAll is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1290
|
+
*/
|
|
1291
|
+
getExternalcontactsScanNotesDivisionviewsAll(opts) {
|
|
1292
|
+
opts = opts || {};
|
|
1293
|
+
|
|
1294
|
+
|
|
1295
|
+
return this.apiClient.callApi(
|
|
1296
|
+
'/api/v2/externalcontacts/scan/notes/divisionviews/all',
|
|
1297
|
+
'GET',
|
|
1298
|
+
{ },
|
|
1242
1299
|
{ 'limit': opts['limit'],'cursor': opts['cursor'] },
|
|
1243
1300
|
{ },
|
|
1244
1301
|
{ },
|
|
@@ -1255,6 +1312,7 @@ class ExternalContactsApi {
|
|
|
1255
1312
|
* @param {Object} opts Optional parameters
|
|
1256
1313
|
* @param {Number} opts.limit The number of organizations per page; must be between 10 and 200, default is 100
|
|
1257
1314
|
* @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
|
|
1315
|
+
* @param {String} opts.divisionId The division to scan over (default to *)
|
|
1258
1316
|
*/
|
|
1259
1317
|
getExternalcontactsScanOrganizations(opts) {
|
|
1260
1318
|
opts = opts || {};
|
|
@@ -1264,6 +1322,32 @@ class ExternalContactsApi {
|
|
|
1264
1322
|
'/api/v2/externalcontacts/scan/organizations',
|
|
1265
1323
|
'GET',
|
|
1266
1324
|
{ },
|
|
1325
|
+
{ 'limit': opts['limit'],'cursor': opts['cursor'],'divisionId': opts['divisionId'] },
|
|
1326
|
+
{ },
|
|
1327
|
+
{ },
|
|
1328
|
+
null,
|
|
1329
|
+
['PureCloud OAuth'],
|
|
1330
|
+
['application/json'],
|
|
1331
|
+
['application/json']
|
|
1332
|
+
);
|
|
1333
|
+
}
|
|
1334
|
+
|
|
1335
|
+
/**
|
|
1336
|
+
* Scan for external organizations using paging
|
|
1337
|
+
*
|
|
1338
|
+
* @param {Object} opts Optional parameters
|
|
1339
|
+
* @param {Number} opts.limit The number of organizations per page; must be between 10 and 200, default is 100
|
|
1340
|
+
* @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
|
|
1341
|
+
* getExternalcontactsScanOrganizationsDivisionviewsAll is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1342
|
+
*/
|
|
1343
|
+
getExternalcontactsScanOrganizationsDivisionviewsAll(opts) {
|
|
1344
|
+
opts = opts || {};
|
|
1345
|
+
|
|
1346
|
+
|
|
1347
|
+
return this.apiClient.callApi(
|
|
1348
|
+
'/api/v2/externalcontacts/scan/organizations/divisionviews/all',
|
|
1349
|
+
'GET',
|
|
1350
|
+
{ },
|
|
1267
1351
|
{ 'limit': opts['limit'],'cursor': opts['cursor'] },
|
|
1268
1352
|
{ },
|
|
1269
1353
|
{ },
|
|
@@ -1280,6 +1364,7 @@ class ExternalContactsApi {
|
|
|
1280
1364
|
* @param {Object} opts Optional parameters
|
|
1281
1365
|
* @param {Number} opts.limit The number of relationships per page; must be between 10 and 200, default is 100
|
|
1282
1366
|
* @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
|
|
1367
|
+
* @param {String} opts.divisionId The division to scan over (default to *)
|
|
1283
1368
|
*/
|
|
1284
1369
|
getExternalcontactsScanRelationships(opts) {
|
|
1285
1370
|
opts = opts || {};
|
|
@@ -1289,6 +1374,32 @@ class ExternalContactsApi {
|
|
|
1289
1374
|
'/api/v2/externalcontacts/scan/relationships',
|
|
1290
1375
|
'GET',
|
|
1291
1376
|
{ },
|
|
1377
|
+
{ 'limit': opts['limit'],'cursor': opts['cursor'],'divisionId': opts['divisionId'] },
|
|
1378
|
+
{ },
|
|
1379
|
+
{ },
|
|
1380
|
+
null,
|
|
1381
|
+
['PureCloud OAuth'],
|
|
1382
|
+
['application/json'],
|
|
1383
|
+
['application/json']
|
|
1384
|
+
);
|
|
1385
|
+
}
|
|
1386
|
+
|
|
1387
|
+
/**
|
|
1388
|
+
* Scan for relationships
|
|
1389
|
+
*
|
|
1390
|
+
* @param {Object} opts Optional parameters
|
|
1391
|
+
* @param {Number} opts.limit The number of relationships per page; must be between 10 and 200, default is 100
|
|
1392
|
+
* @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
|
|
1393
|
+
* getExternalcontactsScanRelationshipsDivisionviewsAll is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1394
|
+
*/
|
|
1395
|
+
getExternalcontactsScanRelationshipsDivisionviewsAll(opts) {
|
|
1396
|
+
opts = opts || {};
|
|
1397
|
+
|
|
1398
|
+
|
|
1399
|
+
return this.apiClient.callApi(
|
|
1400
|
+
'/api/v2/externalcontacts/scan/relationships/divisionviews/all',
|
|
1401
|
+
'GET',
|
|
1402
|
+
{ },
|
|
1292
1403
|
{ 'limit': opts['limit'],'cursor': opts['cursor'] },
|
|
1293
1404
|
{ },
|
|
1294
1405
|
{ },
|
|
@@ -1379,6 +1490,32 @@ class ExternalContactsApi {
|
|
|
1379
1490
|
);
|
|
1380
1491
|
}
|
|
1381
1492
|
|
|
1493
|
+
/**
|
|
1494
|
+
* Bulk fetch contacts across divisions
|
|
1495
|
+
*
|
|
1496
|
+
* @param {Object} body Contact ids
|
|
1497
|
+
* postExternalcontactsBulkContactsDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1498
|
+
*/
|
|
1499
|
+
postExternalcontactsBulkContactsDivisionviews(body) {
|
|
1500
|
+
// verify the required parameter 'body' is set
|
|
1501
|
+
if (body === undefined || body === null) {
|
|
1502
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsBulkContactsDivisionviews';
|
|
1503
|
+
}
|
|
1504
|
+
|
|
1505
|
+
return this.apiClient.callApi(
|
|
1506
|
+
'/api/v2/externalcontacts/bulk/contacts/divisionviews',
|
|
1507
|
+
'POST',
|
|
1508
|
+
{ },
|
|
1509
|
+
{ },
|
|
1510
|
+
{ },
|
|
1511
|
+
{ },
|
|
1512
|
+
body,
|
|
1513
|
+
['PureCloud OAuth'],
|
|
1514
|
+
['application/json'],
|
|
1515
|
+
['application/json']
|
|
1516
|
+
);
|
|
1517
|
+
}
|
|
1518
|
+
|
|
1382
1519
|
/**
|
|
1383
1520
|
* Bulk remove contacts
|
|
1384
1521
|
*
|
|
@@ -1604,6 +1741,32 @@ class ExternalContactsApi {
|
|
|
1604
1741
|
);
|
|
1605
1742
|
}
|
|
1606
1743
|
|
|
1744
|
+
/**
|
|
1745
|
+
* Bulk fetch organizations across divisions
|
|
1746
|
+
*
|
|
1747
|
+
* @param {Object} body Organizations ids
|
|
1748
|
+
* postExternalcontactsBulkOrganizationsDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1749
|
+
*/
|
|
1750
|
+
postExternalcontactsBulkOrganizationsDivisionviews(body) {
|
|
1751
|
+
// verify the required parameter 'body' is set
|
|
1752
|
+
if (body === undefined || body === null) {
|
|
1753
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsBulkOrganizationsDivisionviews';
|
|
1754
|
+
}
|
|
1755
|
+
|
|
1756
|
+
return this.apiClient.callApi(
|
|
1757
|
+
'/api/v2/externalcontacts/bulk/organizations/divisionviews',
|
|
1758
|
+
'POST',
|
|
1759
|
+
{ },
|
|
1760
|
+
{ },
|
|
1761
|
+
{ },
|
|
1762
|
+
{ },
|
|
1763
|
+
body,
|
|
1764
|
+
['PureCloud OAuth'],
|
|
1765
|
+
['application/json'],
|
|
1766
|
+
['application/json']
|
|
1767
|
+
);
|
|
1768
|
+
}
|
|
1769
|
+
|
|
1607
1770
|
/**
|
|
1608
1771
|
* Bulk remove organizations
|
|
1609
1772
|
*
|