purecloud-platform-client-v2 245.1.0 → 247.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 +1255 -104
- package/dist/web-amd/purecloud-platform-client-v2.js +1255 -104
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +485 -149
- package/dist/web-cjs/purecloud-platform-client-v2.js +539 -168
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +738 -285
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +6 -1
- package/src/purecloud-platform-client-v2/api/AIStudioApi.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 +1 -1
- package/src/purecloud-platform-client-v2/api/AssistantCopilotVariationsApi.js +1 -1
- 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/BackgroundAssistantApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BusinessRulesApi.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 +661 -3
- 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 +1 -1
- 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/IntentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +159 -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 +3 -2
- 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 +31 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +26 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +248 -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 +25 -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/UsersRulesApi.js +1 -10
- 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 +18 -6
- 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
|
@@ -748,7 +748,7 @@ class Configuration {
|
|
|
748
748
|
|
|
749
749
|
/**
|
|
750
750
|
* @module purecloud-platform-client-v2/ApiClient
|
|
751
|
-
* @version
|
|
751
|
+
* @version 247.0.0
|
|
752
752
|
*/
|
|
753
753
|
class ApiClient {
|
|
754
754
|
/**
|
|
@@ -2260,12 +2260,17 @@ class ApiClient {
|
|
|
2260
2260
|
request.headers = this.addHeaders(request.headers, data);
|
|
2261
2261
|
} else {
|
|
2262
2262
|
request.setParams(this.serialize(data));
|
|
2263
|
+
request.headers = this.addHeaders(request.headers, {});
|
|
2263
2264
|
}
|
|
2265
|
+
} else {
|
|
2266
|
+
request.headers = this.addHeaders(request.headers, {});
|
|
2264
2267
|
}
|
|
2265
2268
|
break;
|
|
2266
2269
|
case 'oauth2':
|
|
2267
2270
|
if (auth.accessToken) {
|
|
2268
2271
|
request.headers = this.addHeaders(request.headers, {'Authorization': `Bearer ${auth.accessToken}`});
|
|
2272
|
+
} else {
|
|
2273
|
+
request.headers = this.addHeaders(request.headers, {});
|
|
2269
2274
|
}
|
|
2270
2275
|
break;
|
|
2271
2276
|
default:
|
|
@@ -2407,7 +2412,7 @@ class AIStudioApi {
|
|
|
2407
2412
|
/**
|
|
2408
2413
|
* AIStudio service.
|
|
2409
2414
|
* @module purecloud-platform-client-v2/api/AIStudioApi
|
|
2410
|
-
* @version
|
|
2415
|
+
* @version 247.0.0
|
|
2411
2416
|
*/
|
|
2412
2417
|
|
|
2413
2418
|
/**
|
|
@@ -3026,7 +3031,7 @@ class AgentAssistantsApi {
|
|
|
3026
3031
|
/**
|
|
3027
3032
|
* AgentAssistants service.
|
|
3028
3033
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
3029
|
-
* @version
|
|
3034
|
+
* @version 247.0.0
|
|
3030
3035
|
*/
|
|
3031
3036
|
|
|
3032
3037
|
/**
|
|
@@ -3739,7 +3744,7 @@ class AgentCopilotApi {
|
|
|
3739
3744
|
/**
|
|
3740
3745
|
* AgentCopilot service.
|
|
3741
3746
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
3742
|
-
* @version
|
|
3747
|
+
* @version 247.0.0
|
|
3743
3748
|
*/
|
|
3744
3749
|
|
|
3745
3750
|
/**
|
|
@@ -3839,7 +3844,7 @@ class AgentUIApi {
|
|
|
3839
3844
|
/**
|
|
3840
3845
|
* AgentUI service.
|
|
3841
3846
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
3842
|
-
* @version
|
|
3847
|
+
* @version 247.0.0
|
|
3843
3848
|
*/
|
|
3844
3849
|
|
|
3845
3850
|
/**
|
|
@@ -3970,7 +3975,7 @@ class AlertingApi {
|
|
|
3970
3975
|
/**
|
|
3971
3976
|
* Alerting service.
|
|
3972
3977
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
3973
|
-
* @version
|
|
3978
|
+
* @version 247.0.0
|
|
3974
3979
|
*/
|
|
3975
3980
|
|
|
3976
3981
|
/**
|
|
@@ -4371,7 +4376,7 @@ class AnalyticsApi {
|
|
|
4371
4376
|
/**
|
|
4372
4377
|
* Analytics service.
|
|
4373
4378
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
4374
|
-
* @version
|
|
4379
|
+
* @version 247.0.0
|
|
4375
4380
|
*/
|
|
4376
4381
|
|
|
4377
4382
|
/**
|
|
@@ -7808,7 +7813,7 @@ class ArchitectApi {
|
|
|
7808
7813
|
/**
|
|
7809
7814
|
* Architect service.
|
|
7810
7815
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
7811
|
-
* @version
|
|
7816
|
+
* @version 247.0.0
|
|
7812
7817
|
*/
|
|
7813
7818
|
|
|
7814
7819
|
/**
|
|
@@ -12103,7 +12108,7 @@ class AssistantCopilotVariationsApi {
|
|
|
12103
12108
|
/**
|
|
12104
12109
|
* AssistantCopilotVariations service.
|
|
12105
12110
|
* @module purecloud-platform-client-v2/api/AssistantCopilotVariationsApi
|
|
12106
|
-
* @version
|
|
12111
|
+
* @version 247.0.0
|
|
12107
12112
|
*/
|
|
12108
12113
|
|
|
12109
12114
|
/**
|
|
@@ -12274,7 +12279,7 @@ class AuditApi {
|
|
|
12274
12279
|
/**
|
|
12275
12280
|
* Audit service.
|
|
12276
12281
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
12277
|
-
* @version
|
|
12282
|
+
* @version 247.0.0
|
|
12278
12283
|
*/
|
|
12279
12284
|
|
|
12280
12285
|
/**
|
|
@@ -12475,7 +12480,7 @@ class AuthorizationApi {
|
|
|
12475
12480
|
/**
|
|
12476
12481
|
* Authorization service.
|
|
12477
12482
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
12478
|
-
* @version
|
|
12483
|
+
* @version 247.0.0
|
|
12479
12484
|
*/
|
|
12480
12485
|
|
|
12481
12486
|
/**
|
|
@@ -14189,7 +14194,7 @@ class BackgroundAssistantApi {
|
|
|
14189
14194
|
/**
|
|
14190
14195
|
* BackgroundAssistant service.
|
|
14191
14196
|
* @module purecloud-platform-client-v2/api/BackgroundAssistantApi
|
|
14192
|
-
* @version
|
|
14197
|
+
* @version 247.0.0
|
|
14193
14198
|
*/
|
|
14194
14199
|
|
|
14195
14200
|
/**
|
|
@@ -14259,7 +14264,7 @@ class BillingApi {
|
|
|
14259
14264
|
/**
|
|
14260
14265
|
* Billing service.
|
|
14261
14266
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
14262
|
-
* @version
|
|
14267
|
+
* @version 247.0.0
|
|
14263
14268
|
*/
|
|
14264
14269
|
|
|
14265
14270
|
/**
|
|
@@ -14515,7 +14520,7 @@ class BusinessRulesApi {
|
|
|
14515
14520
|
/**
|
|
14516
14521
|
* BusinessRules service.
|
|
14517
14522
|
* @module purecloud-platform-client-v2/api/BusinessRulesApi
|
|
14518
|
-
* @version
|
|
14523
|
+
* @version 247.0.0
|
|
14519
14524
|
*/
|
|
14520
14525
|
|
|
14521
14526
|
/**
|
|
@@ -15402,7 +15407,7 @@ class CarrierServicesApi {
|
|
|
15402
15407
|
/**
|
|
15403
15408
|
* CarrierServices service.
|
|
15404
15409
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
15405
|
-
* @version
|
|
15410
|
+
* @version 247.0.0
|
|
15406
15411
|
*/
|
|
15407
15412
|
|
|
15408
15413
|
/**
|
|
@@ -15472,7 +15477,7 @@ class ChatApi {
|
|
|
15472
15477
|
/**
|
|
15473
15478
|
* Chat service.
|
|
15474
15479
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
15475
|
-
* @version
|
|
15480
|
+
* @version 247.0.0
|
|
15476
15481
|
*/
|
|
15477
15482
|
|
|
15478
15483
|
/**
|
|
@@ -16453,7 +16458,7 @@ class CoachingApi {
|
|
|
16453
16458
|
/**
|
|
16454
16459
|
* Coaching service.
|
|
16455
16460
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
16456
|
-
* @version
|
|
16461
|
+
* @version 247.0.0
|
|
16457
16462
|
*/
|
|
16458
16463
|
|
|
16459
16464
|
/**
|
|
@@ -17080,7 +17085,7 @@ class ContentManagementApi {
|
|
|
17080
17085
|
/**
|
|
17081
17086
|
* ContentManagement service.
|
|
17082
17087
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
17083
|
-
* @version
|
|
17088
|
+
* @version 247.0.0
|
|
17084
17089
|
*/
|
|
17085
17090
|
|
|
17086
17091
|
/**
|
|
@@ -18161,7 +18166,7 @@ class ConversationsApi {
|
|
|
18161
18166
|
/**
|
|
18162
18167
|
* Conversations service.
|
|
18163
18168
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
18164
|
-
* @version
|
|
18169
|
+
* @version 247.0.0
|
|
18165
18170
|
*/
|
|
18166
18171
|
|
|
18167
18172
|
/**
|
|
@@ -18252,6 +18257,36 @@ class ConversationsApi {
|
|
|
18252
18257
|
);
|
|
18253
18258
|
}
|
|
18254
18259
|
|
|
18260
|
+
/**
|
|
18261
|
+
* Delete a custom attributes record.
|
|
18262
|
+
*
|
|
18263
|
+
* @param {String} conversationId conversation ID
|
|
18264
|
+
* @param {String} attributesId attributesId
|
|
18265
|
+
*/
|
|
18266
|
+
deleteConversationCustomattribute(conversationId, attributesId) {
|
|
18267
|
+
// verify the required parameter 'conversationId' is set
|
|
18268
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
18269
|
+
throw 'Missing the required parameter "conversationId" when calling deleteConversationCustomattribute';
|
|
18270
|
+
}
|
|
18271
|
+
// verify the required parameter 'attributesId' is set
|
|
18272
|
+
if (attributesId === undefined || attributesId === null || attributesId === '') {
|
|
18273
|
+
throw 'Missing the required parameter "attributesId" when calling deleteConversationCustomattribute';
|
|
18274
|
+
}
|
|
18275
|
+
|
|
18276
|
+
return this.apiClient.callApi(
|
|
18277
|
+
'/api/v2/conversations/{conversationId}/customattributes/{attributesId}',
|
|
18278
|
+
'DELETE',
|
|
18279
|
+
{ 'conversationId': conversationId,'attributesId': attributesId },
|
|
18280
|
+
{ },
|
|
18281
|
+
{ },
|
|
18282
|
+
{ },
|
|
18283
|
+
null,
|
|
18284
|
+
['PureCloud OAuth'],
|
|
18285
|
+
['application/json'],
|
|
18286
|
+
['application/json']
|
|
18287
|
+
);
|
|
18288
|
+
}
|
|
18289
|
+
|
|
18255
18290
|
/**
|
|
18256
18291
|
* Delete a code used to add a communication to this participant
|
|
18257
18292
|
*
|
|
@@ -18512,6 +18547,32 @@ class ConversationsApi {
|
|
|
18512
18547
|
);
|
|
18513
18548
|
}
|
|
18514
18549
|
|
|
18550
|
+
/**
|
|
18551
|
+
* Delete an Open messaging integration with the Google Business Profile extension
|
|
18552
|
+
* See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.
|
|
18553
|
+
* @param {String} integrationId Integration ID
|
|
18554
|
+
* deleteConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18555
|
+
*/
|
|
18556
|
+
deleteConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileIntegrationId(integrationId) {
|
|
18557
|
+
// verify the required parameter 'integrationId' is set
|
|
18558
|
+
if (integrationId === undefined || integrationId === null || integrationId === '') {
|
|
18559
|
+
throw 'Missing the required parameter "integrationId" when calling deleteConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileIntegrationId';
|
|
18560
|
+
}
|
|
18561
|
+
|
|
18562
|
+
return this.apiClient.callApi(
|
|
18563
|
+
'/api/v2/conversations/messaging/integrations/open/extensions/googlebusinessprofile/{integrationId}',
|
|
18564
|
+
'DELETE',
|
|
18565
|
+
{ 'integrationId': integrationId },
|
|
18566
|
+
{ },
|
|
18567
|
+
{ },
|
|
18568
|
+
{ },
|
|
18569
|
+
null,
|
|
18570
|
+
['PureCloud OAuth'],
|
|
18571
|
+
['application/json'],
|
|
18572
|
+
['application/json']
|
|
18573
|
+
);
|
|
18574
|
+
}
|
|
18575
|
+
|
|
18515
18576
|
/**
|
|
18516
18577
|
* Delete an Open messaging integration
|
|
18517
18578
|
* See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.
|
|
@@ -19037,6 +19098,61 @@ class ConversationsApi {
|
|
|
19037
19098
|
);
|
|
19038
19099
|
}
|
|
19039
19100
|
|
|
19101
|
+
/**
|
|
19102
|
+
* Get custom attributes by id
|
|
19103
|
+
*
|
|
19104
|
+
* @param {String} conversationId conversation ID
|
|
19105
|
+
* @param {String} attributesId attributesId
|
|
19106
|
+
*/
|
|
19107
|
+
getConversationCustomattribute(conversationId, attributesId) {
|
|
19108
|
+
// verify the required parameter 'conversationId' is set
|
|
19109
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
19110
|
+
throw 'Missing the required parameter "conversationId" when calling getConversationCustomattribute';
|
|
19111
|
+
}
|
|
19112
|
+
// verify the required parameter 'attributesId' is set
|
|
19113
|
+
if (attributesId === undefined || attributesId === null || attributesId === '') {
|
|
19114
|
+
throw 'Missing the required parameter "attributesId" when calling getConversationCustomattribute';
|
|
19115
|
+
}
|
|
19116
|
+
|
|
19117
|
+
return this.apiClient.callApi(
|
|
19118
|
+
'/api/v2/conversations/{conversationId}/customattributes/{attributesId}',
|
|
19119
|
+
'GET',
|
|
19120
|
+
{ 'conversationId': conversationId,'attributesId': attributesId },
|
|
19121
|
+
{ },
|
|
19122
|
+
{ },
|
|
19123
|
+
{ },
|
|
19124
|
+
null,
|
|
19125
|
+
['PureCloud OAuth'],
|
|
19126
|
+
['application/json'],
|
|
19127
|
+
['application/json']
|
|
19128
|
+
);
|
|
19129
|
+
}
|
|
19130
|
+
|
|
19131
|
+
/**
|
|
19132
|
+
* Get a list of custom attributes for a conversation.
|
|
19133
|
+
*
|
|
19134
|
+
* @param {String} conversationId conversation ID
|
|
19135
|
+
*/
|
|
19136
|
+
getConversationCustomattributes(conversationId) {
|
|
19137
|
+
// verify the required parameter 'conversationId' is set
|
|
19138
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
19139
|
+
throw 'Missing the required parameter "conversationId" when calling getConversationCustomattributes';
|
|
19140
|
+
}
|
|
19141
|
+
|
|
19142
|
+
return this.apiClient.callApi(
|
|
19143
|
+
'/api/v2/conversations/{conversationId}/customattributes',
|
|
19144
|
+
'GET',
|
|
19145
|
+
{ 'conversationId': conversationId },
|
|
19146
|
+
{ },
|
|
19147
|
+
{ },
|
|
19148
|
+
{ },
|
|
19149
|
+
null,
|
|
19150
|
+
['PureCloud OAuth'],
|
|
19151
|
+
['application/json'],
|
|
19152
|
+
['application/json']
|
|
19153
|
+
);
|
|
19154
|
+
}
|
|
19155
|
+
|
|
19040
19156
|
/**
|
|
19041
19157
|
* Fetch info on a secure session
|
|
19042
19158
|
*
|
|
@@ -20014,6 +20130,171 @@ class ConversationsApi {
|
|
|
20014
20130
|
);
|
|
20015
20131
|
}
|
|
20016
20132
|
|
|
20133
|
+
/**
|
|
20134
|
+
* Get a schema
|
|
20135
|
+
*
|
|
20136
|
+
* @param {String} schemaId Schema ID
|
|
20137
|
+
*/
|
|
20138
|
+
getConversationsCustomattributesSchema(schemaId) {
|
|
20139
|
+
// verify the required parameter 'schemaId' is set
|
|
20140
|
+
if (schemaId === undefined || schemaId === null || schemaId === '') {
|
|
20141
|
+
throw 'Missing the required parameter "schemaId" when calling getConversationsCustomattributesSchema';
|
|
20142
|
+
}
|
|
20143
|
+
|
|
20144
|
+
return this.apiClient.callApi(
|
|
20145
|
+
'/api/v2/conversations/customattributes/schemas/{schemaId}',
|
|
20146
|
+
'GET',
|
|
20147
|
+
{ 'schemaId': schemaId },
|
|
20148
|
+
{ },
|
|
20149
|
+
{ },
|
|
20150
|
+
{ },
|
|
20151
|
+
null,
|
|
20152
|
+
['PureCloud OAuth'],
|
|
20153
|
+
['application/json'],
|
|
20154
|
+
['application/json']
|
|
20155
|
+
);
|
|
20156
|
+
}
|
|
20157
|
+
|
|
20158
|
+
/**
|
|
20159
|
+
* Get a specific version of a schema
|
|
20160
|
+
*
|
|
20161
|
+
* @param {String} schemaId Schema ID
|
|
20162
|
+
* @param {String} versionId Schema version
|
|
20163
|
+
*/
|
|
20164
|
+
getConversationsCustomattributesSchemaVersion(schemaId, versionId) {
|
|
20165
|
+
// verify the required parameter 'schemaId' is set
|
|
20166
|
+
if (schemaId === undefined || schemaId === null || schemaId === '') {
|
|
20167
|
+
throw 'Missing the required parameter "schemaId" when calling getConversationsCustomattributesSchemaVersion';
|
|
20168
|
+
}
|
|
20169
|
+
// verify the required parameter 'versionId' is set
|
|
20170
|
+
if (versionId === undefined || versionId === null || versionId === '') {
|
|
20171
|
+
throw 'Missing the required parameter "versionId" when calling getConversationsCustomattributesSchemaVersion';
|
|
20172
|
+
}
|
|
20173
|
+
|
|
20174
|
+
return this.apiClient.callApi(
|
|
20175
|
+
'/api/v2/conversations/customattributes/schemas/{schemaId}/versions/{versionId}',
|
|
20176
|
+
'GET',
|
|
20177
|
+
{ 'schemaId': schemaId,'versionId': versionId },
|
|
20178
|
+
{ },
|
|
20179
|
+
{ },
|
|
20180
|
+
{ },
|
|
20181
|
+
null,
|
|
20182
|
+
['PureCloud OAuth'],
|
|
20183
|
+
['application/json'],
|
|
20184
|
+
['application/json']
|
|
20185
|
+
);
|
|
20186
|
+
}
|
|
20187
|
+
|
|
20188
|
+
/**
|
|
20189
|
+
* Get all versions of a CCA schema
|
|
20190
|
+
*
|
|
20191
|
+
* @param {String} schemaId Schema ID
|
|
20192
|
+
*/
|
|
20193
|
+
getConversationsCustomattributesSchemaVersions(schemaId) {
|
|
20194
|
+
// verify the required parameter 'schemaId' is set
|
|
20195
|
+
if (schemaId === undefined || schemaId === null || schemaId === '') {
|
|
20196
|
+
throw 'Missing the required parameter "schemaId" when calling getConversationsCustomattributesSchemaVersions';
|
|
20197
|
+
}
|
|
20198
|
+
|
|
20199
|
+
return this.apiClient.callApi(
|
|
20200
|
+
'/api/v2/conversations/customattributes/schemas/{schemaId}/versions',
|
|
20201
|
+
'GET',
|
|
20202
|
+
{ 'schemaId': schemaId },
|
|
20203
|
+
{ },
|
|
20204
|
+
{ },
|
|
20205
|
+
{ },
|
|
20206
|
+
null,
|
|
20207
|
+
['PureCloud OAuth'],
|
|
20208
|
+
['application/json'],
|
|
20209
|
+
['application/json']
|
|
20210
|
+
);
|
|
20211
|
+
}
|
|
20212
|
+
|
|
20213
|
+
/**
|
|
20214
|
+
* Get a list of schemas.
|
|
20215
|
+
*
|
|
20216
|
+
*/
|
|
20217
|
+
getConversationsCustomattributesSchemas() {
|
|
20218
|
+
|
|
20219
|
+
return this.apiClient.callApi(
|
|
20220
|
+
'/api/v2/conversations/customattributes/schemas',
|
|
20221
|
+
'GET',
|
|
20222
|
+
{ },
|
|
20223
|
+
{ },
|
|
20224
|
+
{ },
|
|
20225
|
+
{ },
|
|
20226
|
+
null,
|
|
20227
|
+
['PureCloud OAuth'],
|
|
20228
|
+
['application/json'],
|
|
20229
|
+
['application/json']
|
|
20230
|
+
);
|
|
20231
|
+
}
|
|
20232
|
+
|
|
20233
|
+
/**
|
|
20234
|
+
* Get the core types from which all schemas are built.
|
|
20235
|
+
*
|
|
20236
|
+
* @param {String} coreTypeName Name of the core type
|
|
20237
|
+
*/
|
|
20238
|
+
getConversationsCustomattributesSchemasCoretype(coreTypeName) {
|
|
20239
|
+
// verify the required parameter 'coreTypeName' is set
|
|
20240
|
+
if (coreTypeName === undefined || coreTypeName === null || coreTypeName === '') {
|
|
20241
|
+
throw 'Missing the required parameter "coreTypeName" when calling getConversationsCustomattributesSchemasCoretype';
|
|
20242
|
+
}
|
|
20243
|
+
|
|
20244
|
+
return this.apiClient.callApi(
|
|
20245
|
+
'/api/v2/conversations/customattributes/schemas/coretypes/{coreTypeName}',
|
|
20246
|
+
'GET',
|
|
20247
|
+
{ 'coreTypeName': coreTypeName },
|
|
20248
|
+
{ },
|
|
20249
|
+
{ },
|
|
20250
|
+
{ },
|
|
20251
|
+
null,
|
|
20252
|
+
['PureCloud OAuth'],
|
|
20253
|
+
['application/json'],
|
|
20254
|
+
['application/json']
|
|
20255
|
+
);
|
|
20256
|
+
}
|
|
20257
|
+
|
|
20258
|
+
/**
|
|
20259
|
+
* Get the list of core types enabled for a specific namespace.
|
|
20260
|
+
*
|
|
20261
|
+
*/
|
|
20262
|
+
getConversationsCustomattributesSchemasCoretypes() {
|
|
20263
|
+
|
|
20264
|
+
return this.apiClient.callApi(
|
|
20265
|
+
'/api/v2/conversations/customattributes/schemas/coretypes',
|
|
20266
|
+
'GET',
|
|
20267
|
+
{ },
|
|
20268
|
+
{ },
|
|
20269
|
+
{ },
|
|
20270
|
+
{ },
|
|
20271
|
+
null,
|
|
20272
|
+
['PureCloud OAuth'],
|
|
20273
|
+
['application/json'],
|
|
20274
|
+
['application/json']
|
|
20275
|
+
);
|
|
20276
|
+
}
|
|
20277
|
+
|
|
20278
|
+
/**
|
|
20279
|
+
* Get quantitative limits on schemas
|
|
20280
|
+
*
|
|
20281
|
+
*/
|
|
20282
|
+
getConversationsCustomattributesSchemasLimits() {
|
|
20283
|
+
|
|
20284
|
+
return this.apiClient.callApi(
|
|
20285
|
+
'/api/v2/conversations/customattributes/schemas/limits',
|
|
20286
|
+
'GET',
|
|
20287
|
+
{ },
|
|
20288
|
+
{ },
|
|
20289
|
+
{ },
|
|
20290
|
+
{ },
|
|
20291
|
+
null,
|
|
20292
|
+
['PureCloud OAuth'],
|
|
20293
|
+
['application/json'],
|
|
20294
|
+
['application/json']
|
|
20295
|
+
);
|
|
20296
|
+
}
|
|
20297
|
+
|
|
20017
20298
|
/**
|
|
20018
20299
|
* Get email conversation
|
|
20019
20300
|
*
|
|
@@ -20420,7 +20701,7 @@ class ConversationsApi {
|
|
|
20420
20701
|
|
|
20421
20702
|
/**
|
|
20422
20703
|
* Get media
|
|
20423
|
-
* See https://developer.genesys.cloud/
|
|
20704
|
+
* See https://developer.genesys.cloud/commdigital/digital/messagemediaupload/ for example usage.
|
|
20424
20705
|
* @param {String} conversationId conversationId
|
|
20425
20706
|
* @param {String} communicationId communicationId
|
|
20426
20707
|
* @param {String} mediaId mediaId
|
|
@@ -21132,6 +21413,109 @@ class ConversationsApi {
|
|
|
21132
21413
|
);
|
|
21133
21414
|
}
|
|
21134
21415
|
|
|
21416
|
+
/**
|
|
21417
|
+
* Get an Open messaging integration with the Google Business Profile extension
|
|
21418
|
+
* See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.
|
|
21419
|
+
* @param {String} integrationId Integration ID
|
|
21420
|
+
* @param {Object} opts Optional parameters
|
|
21421
|
+
* @param {Object} opts.expand Expand instructions for the return value.
|
|
21422
|
+
* getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21423
|
+
*/
|
|
21424
|
+
getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileIntegrationId(integrationId, opts) {
|
|
21425
|
+
opts = opts || {};
|
|
21426
|
+
|
|
21427
|
+
// verify the required parameter 'integrationId' is set
|
|
21428
|
+
if (integrationId === undefined || integrationId === null || integrationId === '') {
|
|
21429
|
+
throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileIntegrationId';
|
|
21430
|
+
}
|
|
21431
|
+
|
|
21432
|
+
return this.apiClient.callApi(
|
|
21433
|
+
'/api/v2/conversations/messaging/integrations/open/extensions/googlebusinessprofile/{integrationId}',
|
|
21434
|
+
'GET',
|
|
21435
|
+
{ 'integrationId': integrationId },
|
|
21436
|
+
{ 'expand': opts['expand'] },
|
|
21437
|
+
{ },
|
|
21438
|
+
{ },
|
|
21439
|
+
null,
|
|
21440
|
+
['PureCloud OAuth'],
|
|
21441
|
+
['application/json'],
|
|
21442
|
+
['application/json']
|
|
21443
|
+
);
|
|
21444
|
+
}
|
|
21445
|
+
|
|
21446
|
+
/**
|
|
21447
|
+
* Get Google Business Profile OAuth 2 settings
|
|
21448
|
+
* See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.
|
|
21449
|
+
* getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileOauthSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21450
|
+
*/
|
|
21451
|
+
getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileOauthSettings() {
|
|
21452
|
+
|
|
21453
|
+
return this.apiClient.callApi(
|
|
21454
|
+
'/api/v2/conversations/messaging/integrations/open/extensions/googlebusinessprofile/oauth/settings',
|
|
21455
|
+
'GET',
|
|
21456
|
+
{ },
|
|
21457
|
+
{ },
|
|
21458
|
+
{ },
|
|
21459
|
+
{ },
|
|
21460
|
+
null,
|
|
21461
|
+
['PureCloud OAuth'],
|
|
21462
|
+
['application/json'],
|
|
21463
|
+
['application/json']
|
|
21464
|
+
);
|
|
21465
|
+
}
|
|
21466
|
+
|
|
21467
|
+
/**
|
|
21468
|
+
* Get a Google Auth Token
|
|
21469
|
+
* See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.
|
|
21470
|
+
* @param {String} tokenId Token ID
|
|
21471
|
+
* getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileToken is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21472
|
+
*/
|
|
21473
|
+
getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileToken(tokenId) {
|
|
21474
|
+
// verify the required parameter 'tokenId' is set
|
|
21475
|
+
if (tokenId === undefined || tokenId === null || tokenId === '') {
|
|
21476
|
+
throw 'Missing the required parameter "tokenId" when calling getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileToken';
|
|
21477
|
+
}
|
|
21478
|
+
|
|
21479
|
+
return this.apiClient.callApi(
|
|
21480
|
+
'/api/v2/conversations/messaging/integrations/open/extensions/googlebusinessprofile/tokens/{tokenId}',
|
|
21481
|
+
'GET',
|
|
21482
|
+
{ 'tokenId': tokenId },
|
|
21483
|
+
{ },
|
|
21484
|
+
{ },
|
|
21485
|
+
{ },
|
|
21486
|
+
null,
|
|
21487
|
+
['PureCloud OAuth'],
|
|
21488
|
+
['application/json'],
|
|
21489
|
+
['application/json']
|
|
21490
|
+
);
|
|
21491
|
+
}
|
|
21492
|
+
|
|
21493
|
+
/**
|
|
21494
|
+
* Get Google Business Profile accounts
|
|
21495
|
+
* See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.
|
|
21496
|
+
* @param {String} tokenId Token ID
|
|
21497
|
+
* getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileTokenAccounts is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21498
|
+
*/
|
|
21499
|
+
getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileTokenAccounts(tokenId) {
|
|
21500
|
+
// verify the required parameter 'tokenId' is set
|
|
21501
|
+
if (tokenId === undefined || tokenId === null || tokenId === '') {
|
|
21502
|
+
throw 'Missing the required parameter "tokenId" when calling getConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileTokenAccounts';
|
|
21503
|
+
}
|
|
21504
|
+
|
|
21505
|
+
return this.apiClient.callApi(
|
|
21506
|
+
'/api/v2/conversations/messaging/integrations/open/extensions/googlebusinessprofile/tokens/{tokenId}/accounts',
|
|
21507
|
+
'GET',
|
|
21508
|
+
{ 'tokenId': tokenId },
|
|
21509
|
+
{ },
|
|
21510
|
+
{ },
|
|
21511
|
+
{ },
|
|
21512
|
+
null,
|
|
21513
|
+
['PureCloud OAuth'],
|
|
21514
|
+
['application/json'],
|
|
21515
|
+
['application/json']
|
|
21516
|
+
);
|
|
21517
|
+
}
|
|
21518
|
+
|
|
21135
21519
|
/**
|
|
21136
21520
|
* Get an Open messaging integration
|
|
21137
21521
|
* See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.
|
|
@@ -21678,6 +22062,64 @@ class ConversationsApi {
|
|
|
21678
22062
|
);
|
|
21679
22063
|
}
|
|
21680
22064
|
|
|
22065
|
+
/**
|
|
22066
|
+
* Update a single custom attributes record by amending the data with only the provided fields.
|
|
22067
|
+
*
|
|
22068
|
+
* @param {String} conversationId conversation ID
|
|
22069
|
+
* @param {Object} opts Optional parameters
|
|
22070
|
+
* @param {Object} opts.body
|
|
22071
|
+
*/
|
|
22072
|
+
patchConversationCustomattributes(conversationId, opts) {
|
|
22073
|
+
opts = opts || {};
|
|
22074
|
+
|
|
22075
|
+
// verify the required parameter 'conversationId' is set
|
|
22076
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
22077
|
+
throw 'Missing the required parameter "conversationId" when calling patchConversationCustomattributes';
|
|
22078
|
+
}
|
|
22079
|
+
|
|
22080
|
+
return this.apiClient.callApi(
|
|
22081
|
+
'/api/v2/conversations/{conversationId}/customattributes',
|
|
22082
|
+
'PATCH',
|
|
22083
|
+
{ 'conversationId': conversationId },
|
|
22084
|
+
{ },
|
|
22085
|
+
{ },
|
|
22086
|
+
{ },
|
|
22087
|
+
opts['body'],
|
|
22088
|
+
['PureCloud OAuth'],
|
|
22089
|
+
['application/json'],
|
|
22090
|
+
['application/json']
|
|
22091
|
+
);
|
|
22092
|
+
}
|
|
22093
|
+
|
|
22094
|
+
/**
|
|
22095
|
+
* Update a list of custom attributes record by amending the data with only the provided fields.
|
|
22096
|
+
*
|
|
22097
|
+
* @param {String} conversationId conversation ID
|
|
22098
|
+
* @param {Object} opts Optional parameters
|
|
22099
|
+
* @param {Array.<Object>} opts.body
|
|
22100
|
+
*/
|
|
22101
|
+
patchConversationCustomattributesBulk(conversationId, opts) {
|
|
22102
|
+
opts = opts || {};
|
|
22103
|
+
|
|
22104
|
+
// verify the required parameter 'conversationId' is set
|
|
22105
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
22106
|
+
throw 'Missing the required parameter "conversationId" when calling patchConversationCustomattributesBulk';
|
|
22107
|
+
}
|
|
22108
|
+
|
|
22109
|
+
return this.apiClient.callApi(
|
|
22110
|
+
'/api/v2/conversations/{conversationId}/customattributes/bulk',
|
|
22111
|
+
'PATCH',
|
|
22112
|
+
{ 'conversationId': conversationId },
|
|
22113
|
+
{ },
|
|
22114
|
+
{ },
|
|
22115
|
+
{ },
|
|
22116
|
+
opts['body'],
|
|
22117
|
+
['PureCloud OAuth'],
|
|
22118
|
+
['application/json'],
|
|
22119
|
+
['application/json']
|
|
22120
|
+
);
|
|
22121
|
+
}
|
|
22122
|
+
|
|
21681
22123
|
/**
|
|
21682
22124
|
* Update a participant.
|
|
21683
22125
|
* Update conversation participant.
|
|
@@ -23115,6 +23557,37 @@ class ConversationsApi {
|
|
|
23115
23557
|
);
|
|
23116
23558
|
}
|
|
23117
23559
|
|
|
23560
|
+
/**
|
|
23561
|
+
* Update an Open messaging integration with the Google Business Profile extension
|
|
23562
|
+
* See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.
|
|
23563
|
+
* @param {String} integrationId Integration ID
|
|
23564
|
+
* @param {Object} body GoogleBusinessProfileOpenIntegrationUpdateRequest
|
|
23565
|
+
* patchConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
23566
|
+
*/
|
|
23567
|
+
patchConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileIntegrationId(integrationId, body) {
|
|
23568
|
+
// verify the required parameter 'integrationId' is set
|
|
23569
|
+
if (integrationId === undefined || integrationId === null || integrationId === '') {
|
|
23570
|
+
throw 'Missing the required parameter "integrationId" when calling patchConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileIntegrationId';
|
|
23571
|
+
}
|
|
23572
|
+
// verify the required parameter 'body' is set
|
|
23573
|
+
if (body === undefined || body === null) {
|
|
23574
|
+
throw 'Missing the required parameter "body" when calling patchConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileIntegrationId';
|
|
23575
|
+
}
|
|
23576
|
+
|
|
23577
|
+
return this.apiClient.callApi(
|
|
23578
|
+
'/api/v2/conversations/messaging/integrations/open/extensions/googlebusinessprofile/{integrationId}',
|
|
23579
|
+
'PATCH',
|
|
23580
|
+
{ 'integrationId': integrationId },
|
|
23581
|
+
{ },
|
|
23582
|
+
{ },
|
|
23583
|
+
{ },
|
|
23584
|
+
body,
|
|
23585
|
+
['PureCloud OAuth'],
|
|
23586
|
+
['application/json'],
|
|
23587
|
+
['application/json']
|
|
23588
|
+
);
|
|
23589
|
+
}
|
|
23590
|
+
|
|
23118
23591
|
/**
|
|
23119
23592
|
* Update an Open messaging integration
|
|
23120
23593
|
* See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.
|
|
@@ -25144,6 +25617,56 @@ class ConversationsApi {
|
|
|
25144
25617
|
);
|
|
25145
25618
|
}
|
|
25146
25619
|
|
|
25620
|
+
/**
|
|
25621
|
+
* Create a schema
|
|
25622
|
+
*
|
|
25623
|
+
* @param {Object} body Schema create request body
|
|
25624
|
+
*/
|
|
25625
|
+
postConversationsCustomattributesSchemas(body) {
|
|
25626
|
+
// verify the required parameter 'body' is set
|
|
25627
|
+
if (body === undefined || body === null) {
|
|
25628
|
+
throw 'Missing the required parameter "body" when calling postConversationsCustomattributesSchemas';
|
|
25629
|
+
}
|
|
25630
|
+
|
|
25631
|
+
return this.apiClient.callApi(
|
|
25632
|
+
'/api/v2/conversations/customattributes/schemas',
|
|
25633
|
+
'POST',
|
|
25634
|
+
{ },
|
|
25635
|
+
{ },
|
|
25636
|
+
{ },
|
|
25637
|
+
{ },
|
|
25638
|
+
body,
|
|
25639
|
+
['PureCloud OAuth'],
|
|
25640
|
+
['application/json'],
|
|
25641
|
+
['application/json']
|
|
25642
|
+
);
|
|
25643
|
+
}
|
|
25644
|
+
|
|
25645
|
+
/**
|
|
25646
|
+
* Search resources.
|
|
25647
|
+
*
|
|
25648
|
+
* @param {Object} body Search request options
|
|
25649
|
+
*/
|
|
25650
|
+
postConversationsCustomattributesSearch(body) {
|
|
25651
|
+
// verify the required parameter 'body' is set
|
|
25652
|
+
if (body === undefined || body === null) {
|
|
25653
|
+
throw 'Missing the required parameter "body" when calling postConversationsCustomattributesSearch';
|
|
25654
|
+
}
|
|
25655
|
+
|
|
25656
|
+
return this.apiClient.callApi(
|
|
25657
|
+
'/api/v2/conversations/customattributes/search',
|
|
25658
|
+
'POST',
|
|
25659
|
+
{ },
|
|
25660
|
+
{ },
|
|
25661
|
+
{ },
|
|
25662
|
+
{ },
|
|
25663
|
+
body,
|
|
25664
|
+
['PureCloud OAuth'],
|
|
25665
|
+
['application/json'],
|
|
25666
|
+
['application/json']
|
|
25667
|
+
);
|
|
25668
|
+
}
|
|
25669
|
+
|
|
25147
25670
|
/**
|
|
25148
25671
|
* Send an email to an external conversation. An external conversation is one where the provider is not PureCloud based. This endpoint allows the sender of the external email to reply or send a new message to the existing conversation. The new message will be treated as part of the existing conversation and chained to it.
|
|
25149
25672
|
*
|
|
@@ -25530,7 +26053,7 @@ class ConversationsApi {
|
|
|
25530
26053
|
|
|
25531
26054
|
/**
|
|
25532
26055
|
* Create a URL to upload a message media file
|
|
25533
|
-
* See https://developer.genesys.cloud/
|
|
26056
|
+
* See https://developer.genesys.cloud/commdigital/digital/messagemediaupload/ for example usage.
|
|
25534
26057
|
* @param {String} conversationId conversationId
|
|
25535
26058
|
* @param {String} communicationId communicationId
|
|
25536
26059
|
* @param {Object} body request
|
|
@@ -26071,6 +26594,58 @@ class ConversationsApi {
|
|
|
26071
26594
|
);
|
|
26072
26595
|
}
|
|
26073
26596
|
|
|
26597
|
+
/**
|
|
26598
|
+
* Create an Open messaging integration with the Google Business Profile extension
|
|
26599
|
+
* See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.
|
|
26600
|
+
* @param {Object} body GoogleBusinessProfileOpenIntegrationRequest
|
|
26601
|
+
* postConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofile is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
26602
|
+
*/
|
|
26603
|
+
postConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofile(body) {
|
|
26604
|
+
// verify the required parameter 'body' is set
|
|
26605
|
+
if (body === undefined || body === null) {
|
|
26606
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofile';
|
|
26607
|
+
}
|
|
26608
|
+
|
|
26609
|
+
return this.apiClient.callApi(
|
|
26610
|
+
'/api/v2/conversations/messaging/integrations/open/extensions/googlebusinessprofile',
|
|
26611
|
+
'POST',
|
|
26612
|
+
{ },
|
|
26613
|
+
{ },
|
|
26614
|
+
{ },
|
|
26615
|
+
{ },
|
|
26616
|
+
body,
|
|
26617
|
+
['PureCloud OAuth'],
|
|
26618
|
+
['application/json'],
|
|
26619
|
+
['application/json']
|
|
26620
|
+
);
|
|
26621
|
+
}
|
|
26622
|
+
|
|
26623
|
+
/**
|
|
26624
|
+
* Create a Google Auth Token by exchanging the one-time auth code retrieved from Google
|
|
26625
|
+
* See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.
|
|
26626
|
+
* @param {Object} body GoogleAuthTokenRequest
|
|
26627
|
+
* postConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileTokens is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
26628
|
+
*/
|
|
26629
|
+
postConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileTokens(body) {
|
|
26630
|
+
// verify the required parameter 'body' is set
|
|
26631
|
+
if (body === undefined || body === null) {
|
|
26632
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsOpenExtensionsGooglebusinessprofileTokens';
|
|
26633
|
+
}
|
|
26634
|
+
|
|
26635
|
+
return this.apiClient.callApi(
|
|
26636
|
+
'/api/v2/conversations/messaging/integrations/open/extensions/googlebusinessprofile/tokens',
|
|
26637
|
+
'POST',
|
|
26638
|
+
{ },
|
|
26639
|
+
{ },
|
|
26640
|
+
{ },
|
|
26641
|
+
{ },
|
|
26642
|
+
body,
|
|
26643
|
+
['PureCloud OAuth'],
|
|
26644
|
+
['application/json'],
|
|
26645
|
+
['application/json']
|
|
26646
|
+
);
|
|
26647
|
+
}
|
|
26648
|
+
|
|
26074
26649
|
/**
|
|
26075
26650
|
* Create Twitter Integration
|
|
26076
26651
|
*
|
|
@@ -26396,6 +26971,64 @@ class ConversationsApi {
|
|
|
26396
26971
|
);
|
|
26397
26972
|
}
|
|
26398
26973
|
|
|
26974
|
+
/**
|
|
26975
|
+
* Create or update a single custom attributes record. Updating replaces all data with the provided fields.
|
|
26976
|
+
*
|
|
26977
|
+
* @param {String} conversationId conversation ID
|
|
26978
|
+
* @param {Object} opts Optional parameters
|
|
26979
|
+
* @param {Object} opts.body
|
|
26980
|
+
*/
|
|
26981
|
+
putConversationCustomattributes(conversationId, opts) {
|
|
26982
|
+
opts = opts || {};
|
|
26983
|
+
|
|
26984
|
+
// verify the required parameter 'conversationId' is set
|
|
26985
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
26986
|
+
throw 'Missing the required parameter "conversationId" when calling putConversationCustomattributes';
|
|
26987
|
+
}
|
|
26988
|
+
|
|
26989
|
+
return this.apiClient.callApi(
|
|
26990
|
+
'/api/v2/conversations/{conversationId}/customattributes',
|
|
26991
|
+
'PUT',
|
|
26992
|
+
{ 'conversationId': conversationId },
|
|
26993
|
+
{ },
|
|
26994
|
+
{ },
|
|
26995
|
+
{ },
|
|
26996
|
+
opts['body'],
|
|
26997
|
+
['PureCloud OAuth'],
|
|
26998
|
+
['application/json'],
|
|
26999
|
+
['application/json']
|
|
27000
|
+
);
|
|
27001
|
+
}
|
|
27002
|
+
|
|
27003
|
+
/**
|
|
27004
|
+
* Create or update a list of custom attributes records. Updating replaces all data with the provided fields.
|
|
27005
|
+
*
|
|
27006
|
+
* @param {String} conversationId conversation ID
|
|
27007
|
+
* @param {Object} opts Optional parameters
|
|
27008
|
+
* @param {Array.<Object>} opts.body
|
|
27009
|
+
*/
|
|
27010
|
+
putConversationCustomattributesBulk(conversationId, opts) {
|
|
27011
|
+
opts = opts || {};
|
|
27012
|
+
|
|
27013
|
+
// verify the required parameter 'conversationId' is set
|
|
27014
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
27015
|
+
throw 'Missing the required parameter "conversationId" when calling putConversationCustomattributesBulk';
|
|
27016
|
+
}
|
|
27017
|
+
|
|
27018
|
+
return this.apiClient.callApi(
|
|
27019
|
+
'/api/v2/conversations/{conversationId}/customattributes/bulk',
|
|
27020
|
+
'PUT',
|
|
27021
|
+
{ 'conversationId': conversationId },
|
|
27022
|
+
{ },
|
|
27023
|
+
{ },
|
|
27024
|
+
{ },
|
|
27025
|
+
opts['body'],
|
|
27026
|
+
['PureCloud OAuth'],
|
|
27027
|
+
['application/json'],
|
|
27028
|
+
['application/json']
|
|
27029
|
+
);
|
|
27030
|
+
}
|
|
27031
|
+
|
|
26399
27032
|
/**
|
|
26400
27033
|
* Set flagged reason on conversation participant to indicate bad conversation quality.
|
|
26401
27034
|
*
|
|
@@ -26648,6 +27281,36 @@ class ConversationsApi {
|
|
|
26648
27281
|
);
|
|
26649
27282
|
}
|
|
26650
27283
|
|
|
27284
|
+
/**
|
|
27285
|
+
* Update a schema
|
|
27286
|
+
*
|
|
27287
|
+
* @param {String} schemaId Schema ID
|
|
27288
|
+
* @param {Object} body Schema update request body
|
|
27289
|
+
*/
|
|
27290
|
+
putConversationsCustomattributesSchema(schemaId, body) {
|
|
27291
|
+
// verify the required parameter 'schemaId' is set
|
|
27292
|
+
if (schemaId === undefined || schemaId === null || schemaId === '') {
|
|
27293
|
+
throw 'Missing the required parameter "schemaId" when calling putConversationsCustomattributesSchema';
|
|
27294
|
+
}
|
|
27295
|
+
// verify the required parameter 'body' is set
|
|
27296
|
+
if (body === undefined || body === null) {
|
|
27297
|
+
throw 'Missing the required parameter "body" when calling putConversationsCustomattributesSchema';
|
|
27298
|
+
}
|
|
27299
|
+
|
|
27300
|
+
return this.apiClient.callApi(
|
|
27301
|
+
'/api/v2/conversations/customattributes/schemas/{schemaId}',
|
|
27302
|
+
'PUT',
|
|
27303
|
+
{ 'schemaId': schemaId },
|
|
27304
|
+
{ },
|
|
27305
|
+
{ },
|
|
27306
|
+
{ },
|
|
27307
|
+
body,
|
|
27308
|
+
['PureCloud OAuth'],
|
|
27309
|
+
['application/json'],
|
|
27310
|
+
['application/json']
|
|
27311
|
+
);
|
|
27312
|
+
}
|
|
27313
|
+
|
|
26651
27314
|
/**
|
|
26652
27315
|
* Update conversation draft reply
|
|
26653
27316
|
*
|
|
@@ -27120,7 +27783,7 @@ class DataExtensionsApi {
|
|
|
27120
27783
|
/**
|
|
27121
27784
|
* DataExtensions service.
|
|
27122
27785
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
27123
|
-
* @version
|
|
27786
|
+
* @version 247.0.0
|
|
27124
27787
|
*/
|
|
27125
27788
|
|
|
27126
27789
|
/**
|
|
@@ -27206,7 +27869,7 @@ class DataPrivacyApi {
|
|
|
27206
27869
|
/**
|
|
27207
27870
|
* DataPrivacy service.
|
|
27208
27871
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
27209
|
-
* @version
|
|
27872
|
+
* @version 247.0.0
|
|
27210
27873
|
*/
|
|
27211
27874
|
|
|
27212
27875
|
/**
|
|
@@ -27376,7 +28039,7 @@ class DownloadsApi {
|
|
|
27376
28039
|
/**
|
|
27377
28040
|
* Downloads service.
|
|
27378
28041
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
27379
|
-
* @version
|
|
28042
|
+
* @version 247.0.0
|
|
27380
28043
|
*/
|
|
27381
28044
|
|
|
27382
28045
|
/**
|
|
@@ -27428,7 +28091,7 @@ class EmailsApi {
|
|
|
27428
28091
|
/**
|
|
27429
28092
|
* Emails service.
|
|
27430
28093
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
27431
|
-
* @version
|
|
28094
|
+
* @version 247.0.0
|
|
27432
28095
|
*/
|
|
27433
28096
|
|
|
27434
28097
|
/**
|
|
@@ -27557,7 +28220,7 @@ class EmployeeEngagementApi {
|
|
|
27557
28220
|
/**
|
|
27558
28221
|
* EmployeeEngagement service.
|
|
27559
28222
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
27560
|
-
* @version
|
|
28223
|
+
* @version 247.0.0
|
|
27561
28224
|
*/
|
|
27562
28225
|
|
|
27563
28226
|
/**
|
|
@@ -27737,7 +28400,7 @@ class EventsApi {
|
|
|
27737
28400
|
/**
|
|
27738
28401
|
* Events service.
|
|
27739
28402
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
27740
|
-
* @version
|
|
28403
|
+
* @version 247.0.0
|
|
27741
28404
|
*/
|
|
27742
28405
|
|
|
27743
28406
|
/**
|
|
@@ -27833,7 +28496,7 @@ class ExternalContactsApi {
|
|
|
27833
28496
|
/**
|
|
27834
28497
|
* ExternalContacts service.
|
|
27835
28498
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
27836
|
-
* @version
|
|
28499
|
+
* @version 247.0.0
|
|
27837
28500
|
*/
|
|
27838
28501
|
|
|
27839
28502
|
/**
|
|
@@ -31080,7 +31743,7 @@ class FaxApi {
|
|
|
31080
31743
|
/**
|
|
31081
31744
|
* Fax service.
|
|
31082
31745
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
31083
|
-
* @version
|
|
31746
|
+
* @version 247.0.0
|
|
31084
31747
|
*/
|
|
31085
31748
|
|
|
31086
31749
|
/**
|
|
@@ -31295,7 +31958,7 @@ class FlowsApi {
|
|
|
31295
31958
|
/**
|
|
31296
31959
|
* Flows service.
|
|
31297
31960
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
31298
|
-
* @version
|
|
31961
|
+
* @version 247.0.0
|
|
31299
31962
|
*/
|
|
31300
31963
|
|
|
31301
31964
|
/**
|
|
@@ -31504,7 +32167,7 @@ class GamificationApi {
|
|
|
31504
32167
|
/**
|
|
31505
32168
|
* Gamification service.
|
|
31506
32169
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
31507
|
-
* @version
|
|
32170
|
+
* @version 247.0.0
|
|
31508
32171
|
*/
|
|
31509
32172
|
|
|
31510
32173
|
/**
|
|
@@ -34062,7 +34725,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
34062
34725
|
/**
|
|
34063
34726
|
* GeneralDataProtectionRegulation service.
|
|
34064
34727
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
34065
|
-
* @version
|
|
34728
|
+
* @version 247.0.0
|
|
34066
34729
|
*/
|
|
34067
34730
|
|
|
34068
34731
|
/**
|
|
@@ -34192,7 +34855,7 @@ class GeolocationApi {
|
|
|
34192
34855
|
/**
|
|
34193
34856
|
* Geolocation service.
|
|
34194
34857
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
34195
|
-
* @version
|
|
34858
|
+
* @version 247.0.0
|
|
34196
34859
|
*/
|
|
34197
34860
|
|
|
34198
34861
|
/**
|
|
@@ -34323,7 +34986,7 @@ class GreetingsApi {
|
|
|
34323
34986
|
/**
|
|
34324
34987
|
* Greetings service.
|
|
34325
34988
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
34326
|
-
* @version
|
|
34989
|
+
* @version 247.0.0
|
|
34327
34990
|
*/
|
|
34328
34991
|
|
|
34329
34992
|
/**
|
|
@@ -34865,7 +35528,7 @@ class GroupsApi {
|
|
|
34865
35528
|
/**
|
|
34866
35529
|
* Groups service.
|
|
34867
35530
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
34868
|
-
* @version
|
|
35531
|
+
* @version 247.0.0
|
|
34869
35532
|
*/
|
|
34870
35533
|
|
|
34871
35534
|
/**
|
|
@@ -35384,7 +36047,7 @@ class IdentityProviderApi {
|
|
|
35384
36047
|
/**
|
|
35385
36048
|
* IdentityProvider service.
|
|
35386
36049
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
35387
|
-
* @version
|
|
36050
|
+
* @version 247.0.0
|
|
35388
36051
|
*/
|
|
35389
36052
|
|
|
35390
36053
|
/**
|
|
@@ -36245,7 +36908,7 @@ class InfrastructureAsCodeApi {
|
|
|
36245
36908
|
/**
|
|
36246
36909
|
* InfrastructureAsCode service.
|
|
36247
36910
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
36248
|
-
* @version
|
|
36911
|
+
* @version 247.0.0
|
|
36249
36912
|
*/
|
|
36250
36913
|
|
|
36251
36914
|
/**
|
|
@@ -36412,7 +37075,7 @@ class IntegrationsApi {
|
|
|
36412
37075
|
/**
|
|
36413
37076
|
* Integrations service.
|
|
36414
37077
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
36415
|
-
* @version
|
|
37078
|
+
* @version 247.0.0
|
|
36416
37079
|
*/
|
|
36417
37080
|
|
|
36418
37081
|
/**
|
|
@@ -39062,7 +39725,7 @@ class IntentsApi {
|
|
|
39062
39725
|
/**
|
|
39063
39726
|
* Intents service.
|
|
39064
39727
|
* @module purecloud-platform-client-v2/api/IntentsApi
|
|
39065
|
-
* @version
|
|
39728
|
+
* @version 247.0.0
|
|
39066
39729
|
*/
|
|
39067
39730
|
|
|
39068
39731
|
/**
|
|
@@ -39529,7 +40192,7 @@ class JourneyApi {
|
|
|
39529
40192
|
/**
|
|
39530
40193
|
* Journey service.
|
|
39531
40194
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
39532
|
-
* @version
|
|
40195
|
+
* @version 247.0.0
|
|
39533
40196
|
*/
|
|
39534
40197
|
|
|
39535
40198
|
/**
|
|
@@ -41626,7 +42289,7 @@ class KnowledgeApi {
|
|
|
41626
42289
|
/**
|
|
41627
42290
|
* Knowledge service.
|
|
41628
42291
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
41629
|
-
* @version
|
|
42292
|
+
* @version 247.0.0
|
|
41630
42293
|
*/
|
|
41631
42294
|
|
|
41632
42295
|
/**
|
|
@@ -41941,6 +42604,31 @@ class KnowledgeApi {
|
|
|
41941
42604
|
);
|
|
41942
42605
|
}
|
|
41943
42606
|
|
|
42607
|
+
/**
|
|
42608
|
+
* Delete Knowledge setting.
|
|
42609
|
+
*
|
|
42610
|
+
* @param {String} knowledgeSettingId Knowledge Setting ID.
|
|
42611
|
+
*/
|
|
42612
|
+
deleteKnowledgeSetting(knowledgeSettingId) {
|
|
42613
|
+
// verify the required parameter 'knowledgeSettingId' is set
|
|
42614
|
+
if (knowledgeSettingId === undefined || knowledgeSettingId === null || knowledgeSettingId === '') {
|
|
42615
|
+
throw 'Missing the required parameter "knowledgeSettingId" when calling deleteKnowledgeSetting';
|
|
42616
|
+
}
|
|
42617
|
+
|
|
42618
|
+
return this.apiClient.callApi(
|
|
42619
|
+
'/api/v2/knowledge/settings/{knowledgeSettingId}',
|
|
42620
|
+
'DELETE',
|
|
42621
|
+
{ 'knowledgeSettingId': knowledgeSettingId },
|
|
42622
|
+
{ },
|
|
42623
|
+
{ },
|
|
42624
|
+
{ },
|
|
42625
|
+
null,
|
|
42626
|
+
['PureCloud OAuth'],
|
|
42627
|
+
['application/json'],
|
|
42628
|
+
['application/json']
|
|
42629
|
+
);
|
|
42630
|
+
}
|
|
42631
|
+
|
|
41944
42632
|
/**
|
|
41945
42633
|
* Get categories
|
|
41946
42634
|
*
|
|
@@ -43068,6 +43756,61 @@ class KnowledgeApi {
|
|
|
43068
43756
|
);
|
|
43069
43757
|
}
|
|
43070
43758
|
|
|
43759
|
+
/**
|
|
43760
|
+
* Get Knowledge setting.
|
|
43761
|
+
*
|
|
43762
|
+
* @param {String} knowledgeSettingId Knowledge Setting ID.
|
|
43763
|
+
*/
|
|
43764
|
+
getKnowledgeSetting(knowledgeSettingId) {
|
|
43765
|
+
// verify the required parameter 'knowledgeSettingId' is set
|
|
43766
|
+
if (knowledgeSettingId === undefined || knowledgeSettingId === null || knowledgeSettingId === '') {
|
|
43767
|
+
throw 'Missing the required parameter "knowledgeSettingId" when calling getKnowledgeSetting';
|
|
43768
|
+
}
|
|
43769
|
+
|
|
43770
|
+
return this.apiClient.callApi(
|
|
43771
|
+
'/api/v2/knowledge/settings/{knowledgeSettingId}',
|
|
43772
|
+
'GET',
|
|
43773
|
+
{ 'knowledgeSettingId': knowledgeSettingId },
|
|
43774
|
+
{ },
|
|
43775
|
+
{ },
|
|
43776
|
+
{ },
|
|
43777
|
+
null,
|
|
43778
|
+
['PureCloud OAuth'],
|
|
43779
|
+
['application/json'],
|
|
43780
|
+
['application/json']
|
|
43781
|
+
);
|
|
43782
|
+
}
|
|
43783
|
+
|
|
43784
|
+
/**
|
|
43785
|
+
* Get Knowledge settings.
|
|
43786
|
+
*
|
|
43787
|
+
* @param {Object} opts Optional parameters
|
|
43788
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
43789
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
43790
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
43791
|
+
* @param {String} opts.name Knowledge setting name to search upon.
|
|
43792
|
+
* @param {String} opts.sourceId Source ID to filter knowledge settings by.
|
|
43793
|
+
* @param {Object} opts.sortBy Field to sort the knowledge settings on.
|
|
43794
|
+
* @param {Object} opts.sortOrder Sorting order for knowledge settings.
|
|
43795
|
+
*/
|
|
43796
|
+
getKnowledgeSettings(opts) {
|
|
43797
|
+
opts = opts || {};
|
|
43798
|
+
|
|
43799
|
+
|
|
43800
|
+
return this.apiClient.callApi(
|
|
43801
|
+
'/api/v2/knowledge/settings',
|
|
43802
|
+
'GET',
|
|
43803
|
+
{ },
|
|
43804
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'name': opts['name'],'sourceId': opts['sourceId'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'] },
|
|
43805
|
+
{ },
|
|
43806
|
+
{ },
|
|
43807
|
+
null,
|
|
43808
|
+
['PureCloud OAuth'],
|
|
43809
|
+
['application/json'],
|
|
43810
|
+
['application/json']
|
|
43811
|
+
);
|
|
43812
|
+
}
|
|
43813
|
+
|
|
43071
43814
|
/**
|
|
43072
43815
|
* Update search result.
|
|
43073
43816
|
*
|
|
@@ -43530,6 +44273,36 @@ class KnowledgeApi {
|
|
|
43530
44273
|
);
|
|
43531
44274
|
}
|
|
43532
44275
|
|
|
44276
|
+
/**
|
|
44277
|
+
* Update Knowledge setting.
|
|
44278
|
+
*
|
|
44279
|
+
* @param {String} knowledgeSettingId Knowledge Setting ID.
|
|
44280
|
+
* @param {Object} body
|
|
44281
|
+
*/
|
|
44282
|
+
patchKnowledgeSetting(knowledgeSettingId, body) {
|
|
44283
|
+
// verify the required parameter 'knowledgeSettingId' is set
|
|
44284
|
+
if (knowledgeSettingId === undefined || knowledgeSettingId === null || knowledgeSettingId === '') {
|
|
44285
|
+
throw 'Missing the required parameter "knowledgeSettingId" when calling patchKnowledgeSetting';
|
|
44286
|
+
}
|
|
44287
|
+
// verify the required parameter 'body' is set
|
|
44288
|
+
if (body === undefined || body === null) {
|
|
44289
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeSetting';
|
|
44290
|
+
}
|
|
44291
|
+
|
|
44292
|
+
return this.apiClient.callApi(
|
|
44293
|
+
'/api/v2/knowledge/settings/{knowledgeSettingId}',
|
|
44294
|
+
'PATCH',
|
|
44295
|
+
{ 'knowledgeSettingId': knowledgeSettingId },
|
|
44296
|
+
{ },
|
|
44297
|
+
{ },
|
|
44298
|
+
{ },
|
|
44299
|
+
body,
|
|
44300
|
+
['PureCloud OAuth'],
|
|
44301
|
+
['application/json'],
|
|
44302
|
+
['application/json']
|
|
44303
|
+
);
|
|
44304
|
+
}
|
|
44305
|
+
|
|
43533
44306
|
/**
|
|
43534
44307
|
* Creates a presigned URL for uploading a knowledge import file with a set of documents
|
|
43535
44308
|
*
|
|
@@ -44667,6 +45440,54 @@ class KnowledgeApi {
|
|
|
44667
45440
|
);
|
|
44668
45441
|
}
|
|
44669
45442
|
|
|
45443
|
+
/**
|
|
45444
|
+
* Get Knowledge Search Preview
|
|
45445
|
+
*
|
|
45446
|
+
* @param {Object} opts Optional parameters
|
|
45447
|
+
* @param {Object} opts.body
|
|
45448
|
+
*/
|
|
45449
|
+
postKnowledgeSearchPreview(opts) {
|
|
45450
|
+
opts = opts || {};
|
|
45451
|
+
|
|
45452
|
+
|
|
45453
|
+
return this.apiClient.callApi(
|
|
45454
|
+
'/api/v2/knowledge/search/preview',
|
|
45455
|
+
'POST',
|
|
45456
|
+
{ },
|
|
45457
|
+
{ },
|
|
45458
|
+
{ },
|
|
45459
|
+
{ },
|
|
45460
|
+
opts['body'],
|
|
45461
|
+
['PureCloud OAuth'],
|
|
45462
|
+
['application/json'],
|
|
45463
|
+
['application/json']
|
|
45464
|
+
);
|
|
45465
|
+
}
|
|
45466
|
+
|
|
45467
|
+
/**
|
|
45468
|
+
* Create Knowledge setting.
|
|
45469
|
+
*
|
|
45470
|
+
* @param {Object} opts Optional parameters
|
|
45471
|
+
* @param {Object} opts.body
|
|
45472
|
+
*/
|
|
45473
|
+
postKnowledgeSettings(opts) {
|
|
45474
|
+
opts = opts || {};
|
|
45475
|
+
|
|
45476
|
+
|
|
45477
|
+
return this.apiClient.callApi(
|
|
45478
|
+
'/api/v2/knowledge/settings',
|
|
45479
|
+
'POST',
|
|
45480
|
+
{ },
|
|
45481
|
+
{ },
|
|
45482
|
+
{ },
|
|
45483
|
+
{ },
|
|
45484
|
+
opts['body'],
|
|
45485
|
+
['PureCloud OAuth'],
|
|
45486
|
+
['application/json'],
|
|
45487
|
+
['application/json']
|
|
45488
|
+
);
|
|
45489
|
+
}
|
|
45490
|
+
|
|
44670
45491
|
/**
|
|
44671
45492
|
* Update Salesforce Knowledge integration source
|
|
44672
45493
|
*
|
|
@@ -44743,7 +45564,7 @@ class LanguageUnderstandingApi {
|
|
|
44743
45564
|
/**
|
|
44744
45565
|
* LanguageUnderstanding service.
|
|
44745
45566
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
44746
|
-
* @version
|
|
45567
|
+
* @version 247.0.0
|
|
44747
45568
|
*/
|
|
44748
45569
|
|
|
44749
45570
|
/**
|
|
@@ -45962,7 +46783,7 @@ class LanguagesApi {
|
|
|
45962
46783
|
/**
|
|
45963
46784
|
* Languages service.
|
|
45964
46785
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
45965
|
-
* @version
|
|
46786
|
+
* @version 247.0.0
|
|
45966
46787
|
*/
|
|
45967
46788
|
|
|
45968
46789
|
/**
|
|
@@ -46184,7 +47005,7 @@ class LearningApi {
|
|
|
46184
47005
|
/**
|
|
46185
47006
|
* Learning service.
|
|
46186
47007
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
46187
|
-
* @version
|
|
47008
|
+
* @version 247.0.0
|
|
46188
47009
|
*/
|
|
46189
47010
|
|
|
46190
47011
|
/**
|
|
@@ -47293,7 +48114,7 @@ class LicenseApi {
|
|
|
47293
48114
|
/**
|
|
47294
48115
|
* License service.
|
|
47295
48116
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
47296
|
-
* @version
|
|
48117
|
+
* @version 247.0.0
|
|
47297
48118
|
*/
|
|
47298
48119
|
|
|
47299
48120
|
/**
|
|
@@ -47531,7 +48352,7 @@ class LocationsApi {
|
|
|
47531
48352
|
/**
|
|
47532
48353
|
* Locations service.
|
|
47533
48354
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
47534
|
-
* @version
|
|
48355
|
+
* @version 247.0.0
|
|
47535
48356
|
*/
|
|
47536
48357
|
|
|
47537
48358
|
/**
|
|
@@ -47767,7 +48588,7 @@ class LogCaptureApi {
|
|
|
47767
48588
|
/**
|
|
47768
48589
|
* LogCapture service.
|
|
47769
48590
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
47770
|
-
* @version
|
|
48591
|
+
* @version 247.0.0
|
|
47771
48592
|
*/
|
|
47772
48593
|
|
|
47773
48594
|
/**
|
|
@@ -47966,7 +48787,7 @@ class MessagingApi {
|
|
|
47966
48787
|
/**
|
|
47967
48788
|
* Messaging service.
|
|
47968
48789
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
47969
|
-
* @version
|
|
48790
|
+
* @version 247.0.0
|
|
47970
48791
|
*/
|
|
47971
48792
|
|
|
47972
48793
|
/**
|
|
@@ -48325,7 +49146,7 @@ class MobileDevicesApi {
|
|
|
48325
49146
|
/**
|
|
48326
49147
|
* MobileDevices service.
|
|
48327
49148
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
48328
|
-
* @version
|
|
49149
|
+
* @version 247.0.0
|
|
48329
49150
|
*/
|
|
48330
49151
|
|
|
48331
49152
|
/**
|
|
@@ -48476,7 +49297,7 @@ class NotificationsApi {
|
|
|
48476
49297
|
/**
|
|
48477
49298
|
* Notifications service.
|
|
48478
49299
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
48479
|
-
* @version
|
|
49300
|
+
* @version 247.0.0
|
|
48480
49301
|
*/
|
|
48481
49302
|
|
|
48482
49303
|
/**
|
|
@@ -48709,7 +49530,7 @@ class OAuthApi {
|
|
|
48709
49530
|
/**
|
|
48710
49531
|
* OAuth service.
|
|
48711
49532
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
48712
|
-
* @version
|
|
49533
|
+
* @version 247.0.0
|
|
48713
49534
|
*/
|
|
48714
49535
|
|
|
48715
49536
|
/**
|
|
@@ -49075,7 +49896,7 @@ class ObjectsApi {
|
|
|
49075
49896
|
/**
|
|
49076
49897
|
* Objects service.
|
|
49077
49898
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
49078
|
-
* @version
|
|
49899
|
+
* @version 247.0.0
|
|
49079
49900
|
*/
|
|
49080
49901
|
|
|
49081
49902
|
/**
|
|
@@ -49399,7 +50220,7 @@ class OperationalEventsApi {
|
|
|
49399
50220
|
/**
|
|
49400
50221
|
* OperationalEvents service.
|
|
49401
50222
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
49402
|
-
* @version
|
|
50223
|
+
* @version 247.0.0
|
|
49403
50224
|
*/
|
|
49404
50225
|
|
|
49405
50226
|
/**
|
|
@@ -49516,7 +50337,7 @@ class OrganizationApi {
|
|
|
49516
50337
|
/**
|
|
49517
50338
|
* Organization service.
|
|
49518
50339
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
49519
|
-
* @version
|
|
50340
|
+
* @version 247.0.0
|
|
49520
50341
|
*/
|
|
49521
50342
|
|
|
49522
50343
|
/**
|
|
@@ -49991,7 +50812,7 @@ class OrganizationAuthorizationApi {
|
|
|
49991
50812
|
/**
|
|
49992
50813
|
* OrganizationAuthorization service.
|
|
49993
50814
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
49994
|
-
* @version
|
|
50815
|
+
* @version 247.0.0
|
|
49995
50816
|
*/
|
|
49996
50817
|
|
|
49997
50818
|
/**
|
|
@@ -51385,7 +52206,7 @@ class OutboundApi {
|
|
|
51385
52206
|
/**
|
|
51386
52207
|
* Outbound service.
|
|
51387
52208
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
51388
|
-
* @version
|
|
52209
|
+
* @version 247.0.0
|
|
51389
52210
|
*/
|
|
51390
52211
|
|
|
51391
52212
|
/**
|
|
@@ -56183,7 +57004,7 @@ class PresenceApi {
|
|
|
56183
57004
|
/**
|
|
56184
57005
|
* Presence service.
|
|
56185
57006
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
56186
|
-
* @version
|
|
57007
|
+
* @version 247.0.0
|
|
56187
57008
|
*/
|
|
56188
57009
|
|
|
56189
57010
|
/**
|
|
@@ -56927,7 +57748,7 @@ class ProcessAutomationApi {
|
|
|
56927
57748
|
/**
|
|
56928
57749
|
* ProcessAutomation service.
|
|
56929
57750
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
56930
|
-
* @version
|
|
57751
|
+
* @version 247.0.0
|
|
56931
57752
|
*/
|
|
56932
57753
|
|
|
56933
57754
|
/**
|
|
@@ -57166,7 +57987,7 @@ class QualityApi {
|
|
|
57166
57987
|
/**
|
|
57167
57988
|
* Quality service.
|
|
57168
57989
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
57169
|
-
* @version
|
|
57990
|
+
* @version 247.0.0
|
|
57170
57991
|
*/
|
|
57171
57992
|
|
|
57172
57993
|
/**
|
|
@@ -58614,6 +59435,7 @@ class QualityApi {
|
|
|
58614
59435
|
* @param {String} conversationId conversationId
|
|
58615
59436
|
* @param {Object} body evaluation
|
|
58616
59437
|
* @param {Object} opts Optional parameters
|
|
59438
|
+
* @param {String} opts.idempotencyKey Idempotency key for request deduplication
|
|
58617
59439
|
* @param {String} opts.expand evaluatorId
|
|
58618
59440
|
*/
|
|
58619
59441
|
postQualityConversationEvaluations(conversationId, body, opts) {
|
|
@@ -58633,7 +59455,7 @@ class QualityApi {
|
|
|
58633
59455
|
'POST',
|
|
58634
59456
|
{ 'conversationId': conversationId },
|
|
58635
59457
|
{ 'expand': opts['expand'] },
|
|
58636
|
-
{
|
|
59458
|
+
{ 'Idempotency-Key': opts['idempotencyKey'] },
|
|
58637
59459
|
{ },
|
|
58638
59460
|
body,
|
|
58639
59461
|
['PureCloud OAuth'],
|
|
@@ -59235,7 +60057,7 @@ class RecordingApi {
|
|
|
59235
60057
|
/**
|
|
59236
60058
|
* Recording service.
|
|
59237
60059
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
59238
|
-
* @version
|
|
60060
|
+
* @version 247.0.0
|
|
59239
60061
|
*/
|
|
59240
60062
|
|
|
59241
60063
|
/**
|
|
@@ -60840,7 +61662,7 @@ class ResponseManagementApi {
|
|
|
60840
61662
|
/**
|
|
60841
61663
|
* ResponseManagement service.
|
|
60842
61664
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
60843
|
-
* @version
|
|
61665
|
+
* @version 247.0.0
|
|
60844
61666
|
*/
|
|
60845
61667
|
|
|
60846
61668
|
/**
|
|
@@ -61350,7 +62172,7 @@ class RoutingApi {
|
|
|
61350
62172
|
/**
|
|
61351
62173
|
* Routing service.
|
|
61352
62174
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
61353
|
-
* @version
|
|
62175
|
+
* @version 247.0.0
|
|
61354
62176
|
*/
|
|
61355
62177
|
|
|
61356
62178
|
/**
|
|
@@ -64436,6 +65258,36 @@ class RoutingApi {
|
|
|
64436
65258
|
);
|
|
64437
65259
|
}
|
|
64438
65260
|
|
|
65261
|
+
/**
|
|
65262
|
+
* Update Routing Skill Division
|
|
65263
|
+
*
|
|
65264
|
+
* @param {String} skillId Skill ID
|
|
65265
|
+
* @param {Object} body updateSkillDivisionRequest
|
|
65266
|
+
*/
|
|
65267
|
+
patchRoutingSkill(skillId, body) {
|
|
65268
|
+
// verify the required parameter 'skillId' is set
|
|
65269
|
+
if (skillId === undefined || skillId === null || skillId === '') {
|
|
65270
|
+
throw 'Missing the required parameter "skillId" when calling patchRoutingSkill';
|
|
65271
|
+
}
|
|
65272
|
+
// verify the required parameter 'body' is set
|
|
65273
|
+
if (body === undefined || body === null) {
|
|
65274
|
+
throw 'Missing the required parameter "body" when calling patchRoutingSkill';
|
|
65275
|
+
}
|
|
65276
|
+
|
|
65277
|
+
return this.apiClient.callApi(
|
|
65278
|
+
'/api/v2/routing/skills/{skillId}',
|
|
65279
|
+
'PATCH',
|
|
65280
|
+
{ 'skillId': skillId },
|
|
65281
|
+
{ },
|
|
65282
|
+
{ },
|
|
65283
|
+
{ },
|
|
65284
|
+
body,
|
|
65285
|
+
['PureCloud OAuth'],
|
|
65286
|
+
['application/json'],
|
|
65287
|
+
['application/json']
|
|
65288
|
+
);
|
|
65289
|
+
}
|
|
65290
|
+
|
|
64439
65291
|
/**
|
|
64440
65292
|
* Update skill group definition
|
|
64441
65293
|
*
|
|
@@ -66027,7 +66879,7 @@ class SCIMApi {
|
|
|
66027
66879
|
/**
|
|
66028
66880
|
* SCIM service.
|
|
66029
66881
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
66030
|
-
* @version
|
|
66882
|
+
* @version 247.0.0
|
|
66031
66883
|
*/
|
|
66032
66884
|
|
|
66033
66885
|
/**
|
|
@@ -66904,7 +67756,7 @@ class ScriptsApi {
|
|
|
66904
67756
|
/**
|
|
66905
67757
|
* Scripts service.
|
|
66906
67758
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
66907
|
-
* @version
|
|
67759
|
+
* @version 247.0.0
|
|
66908
67760
|
*/
|
|
66909
67761
|
|
|
66910
67762
|
/**
|
|
@@ -67380,7 +68232,7 @@ class SearchApi {
|
|
|
67380
68232
|
/**
|
|
67381
68233
|
* Search service.
|
|
67382
68234
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
67383
|
-
* @version
|
|
68235
|
+
* @version 247.0.0
|
|
67384
68236
|
*/
|
|
67385
68237
|
|
|
67386
68238
|
/**
|
|
@@ -67651,6 +68503,31 @@ class SearchApi {
|
|
|
67651
68503
|
);
|
|
67652
68504
|
}
|
|
67653
68505
|
|
|
68506
|
+
/**
|
|
68507
|
+
* Search resources.
|
|
68508
|
+
*
|
|
68509
|
+
* @param {Object} body Search request options
|
|
68510
|
+
*/
|
|
68511
|
+
postConversationsCustomattributesSearch(body) {
|
|
68512
|
+
// verify the required parameter 'body' is set
|
|
68513
|
+
if (body === undefined || body === null) {
|
|
68514
|
+
throw 'Missing the required parameter "body" when calling postConversationsCustomattributesSearch';
|
|
68515
|
+
}
|
|
68516
|
+
|
|
68517
|
+
return this.apiClient.callApi(
|
|
68518
|
+
'/api/v2/conversations/customattributes/search',
|
|
68519
|
+
'POST',
|
|
68520
|
+
{ },
|
|
68521
|
+
{ },
|
|
68522
|
+
{ },
|
|
68523
|
+
{ },
|
|
68524
|
+
body,
|
|
68525
|
+
['PureCloud OAuth'],
|
|
68526
|
+
['application/json'],
|
|
68527
|
+
['application/json']
|
|
68528
|
+
);
|
|
68529
|
+
}
|
|
68530
|
+
|
|
67654
68531
|
/**
|
|
67655
68532
|
* Search conversations
|
|
67656
68533
|
*
|
|
@@ -68068,7 +68945,7 @@ class SettingsApi {
|
|
|
68068
68945
|
/**
|
|
68069
68946
|
* Settings service.
|
|
68070
68947
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
68071
|
-
* @version
|
|
68948
|
+
* @version 247.0.0
|
|
68072
68949
|
*/
|
|
68073
68950
|
|
|
68074
68951
|
/**
|
|
@@ -68416,7 +69293,7 @@ class SocialMediaApi {
|
|
|
68416
69293
|
/**
|
|
68417
69294
|
* SocialMedia service.
|
|
68418
69295
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
68419
|
-
* @version
|
|
69296
|
+
* @version 247.0.0
|
|
68420
69297
|
*/
|
|
68421
69298
|
|
|
68422
69299
|
/**
|
|
@@ -68545,6 +69422,41 @@ class SocialMediaApi {
|
|
|
68545
69422
|
);
|
|
68546
69423
|
}
|
|
68547
69424
|
|
|
69425
|
+
/**
|
|
69426
|
+
* Delete a Google Business Profile data ingestion rule.
|
|
69427
|
+
*
|
|
69428
|
+
* @param {String} topicId topicId
|
|
69429
|
+
* @param {String} googleBusinessProfileIngestionRuleId googleBusinessProfileIngestionRuleId
|
|
69430
|
+
* @param {Object} opts Optional parameters
|
|
69431
|
+
* @param {Boolean} opts.hardDelete Determines whether a Google Business Profile data ingestion rule should be soft-deleted (have it's state set to deleted) or hard-deleted (permanently removed). Set to false (soft-delete) by default. (default to false)
|
|
69432
|
+
* deleteSocialmediaTopicDataingestionrulesGooglebusinessprofileGoogleBusinessProfileIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
69433
|
+
*/
|
|
69434
|
+
deleteSocialmediaTopicDataingestionrulesGooglebusinessprofileGoogleBusinessProfileIngestionRuleId(topicId, googleBusinessProfileIngestionRuleId, opts) {
|
|
69435
|
+
opts = opts || {};
|
|
69436
|
+
|
|
69437
|
+
// verify the required parameter 'topicId' is set
|
|
69438
|
+
if (topicId === undefined || topicId === null || topicId === '') {
|
|
69439
|
+
throw 'Missing the required parameter "topicId" when calling deleteSocialmediaTopicDataingestionrulesGooglebusinessprofileGoogleBusinessProfileIngestionRuleId';
|
|
69440
|
+
}
|
|
69441
|
+
// verify the required parameter 'googleBusinessProfileIngestionRuleId' is set
|
|
69442
|
+
if (googleBusinessProfileIngestionRuleId === undefined || googleBusinessProfileIngestionRuleId === null || googleBusinessProfileIngestionRuleId === '') {
|
|
69443
|
+
throw 'Missing the required parameter "googleBusinessProfileIngestionRuleId" when calling deleteSocialmediaTopicDataingestionrulesGooglebusinessprofileGoogleBusinessProfileIngestionRuleId';
|
|
69444
|
+
}
|
|
69445
|
+
|
|
69446
|
+
return this.apiClient.callApi(
|
|
69447
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/googlebusinessprofile/{googleBusinessProfileIngestionRuleId}',
|
|
69448
|
+
'DELETE',
|
|
69449
|
+
{ 'topicId': topicId,'googleBusinessProfileIngestionRuleId': googleBusinessProfileIngestionRuleId },
|
|
69450
|
+
{ 'hardDelete': opts['hardDelete'] },
|
|
69451
|
+
{ },
|
|
69452
|
+
{ },
|
|
69453
|
+
null,
|
|
69454
|
+
['PureCloud OAuth'],
|
|
69455
|
+
['application/json'],
|
|
69456
|
+
['application/json']
|
|
69457
|
+
);
|
|
69458
|
+
}
|
|
69459
|
+
|
|
68548
69460
|
/**
|
|
68549
69461
|
* Delete a Instagram data ingestion rule.
|
|
68550
69462
|
*
|
|
@@ -68983,6 +69895,118 @@ class SocialMediaApi {
|
|
|
68983
69895
|
);
|
|
68984
69896
|
}
|
|
68985
69897
|
|
|
69898
|
+
/**
|
|
69899
|
+
* Get a single Google Business Profile data ingestion rule.
|
|
69900
|
+
*
|
|
69901
|
+
* @param {String} topicId topicId
|
|
69902
|
+
* @param {String} googleBusinessProfileIngestionRuleId googleBusinessProfileIngestionRuleId
|
|
69903
|
+
* @param {Object} opts Optional parameters
|
|
69904
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
69905
|
+
* getSocialmediaTopicDataingestionrulesGooglebusinessprofileGoogleBusinessProfileIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
69906
|
+
*/
|
|
69907
|
+
getSocialmediaTopicDataingestionrulesGooglebusinessprofileGoogleBusinessProfileIngestionRuleId(topicId, googleBusinessProfileIngestionRuleId, opts) {
|
|
69908
|
+
opts = opts || {};
|
|
69909
|
+
|
|
69910
|
+
// verify the required parameter 'topicId' is set
|
|
69911
|
+
if (topicId === undefined || topicId === null || topicId === '') {
|
|
69912
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesGooglebusinessprofileGoogleBusinessProfileIngestionRuleId';
|
|
69913
|
+
}
|
|
69914
|
+
// verify the required parameter 'googleBusinessProfileIngestionRuleId' is set
|
|
69915
|
+
if (googleBusinessProfileIngestionRuleId === undefined || googleBusinessProfileIngestionRuleId === null || googleBusinessProfileIngestionRuleId === '') {
|
|
69916
|
+
throw 'Missing the required parameter "googleBusinessProfileIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesGooglebusinessprofileGoogleBusinessProfileIngestionRuleId';
|
|
69917
|
+
}
|
|
69918
|
+
|
|
69919
|
+
return this.apiClient.callApi(
|
|
69920
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/googlebusinessprofile/{googleBusinessProfileIngestionRuleId}',
|
|
69921
|
+
'GET',
|
|
69922
|
+
{ 'topicId': topicId,'googleBusinessProfileIngestionRuleId': googleBusinessProfileIngestionRuleId },
|
|
69923
|
+
{ 'includeDeleted': opts['includeDeleted'] },
|
|
69924
|
+
{ },
|
|
69925
|
+
{ },
|
|
69926
|
+
null,
|
|
69927
|
+
['PureCloud OAuth'],
|
|
69928
|
+
['application/json'],
|
|
69929
|
+
['application/json']
|
|
69930
|
+
);
|
|
69931
|
+
}
|
|
69932
|
+
|
|
69933
|
+
/**
|
|
69934
|
+
* Get a single Google Business Profile data ingestion rule version.
|
|
69935
|
+
*
|
|
69936
|
+
* @param {String} topicId topicId
|
|
69937
|
+
* @param {String} googleBusinessProfileIngestionRuleId googleBusinessProfileIngestionRuleId
|
|
69938
|
+
* @param {String} dataIngestionRuleVersion version
|
|
69939
|
+
* @param {Object} opts Optional parameters
|
|
69940
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted item in the result.
|
|
69941
|
+
* getSocialmediaTopicDataingestionrulesGooglebusinessprofileGoogleBusinessProfileIngestionRuleIdVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
69942
|
+
*/
|
|
69943
|
+
getSocialmediaTopicDataingestionrulesGooglebusinessprofileGoogleBusinessProfileIngestionRuleIdVersion(topicId, googleBusinessProfileIngestionRuleId, dataIngestionRuleVersion, opts) {
|
|
69944
|
+
opts = opts || {};
|
|
69945
|
+
|
|
69946
|
+
// verify the required parameter 'topicId' is set
|
|
69947
|
+
if (topicId === undefined || topicId === null || topicId === '') {
|
|
69948
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesGooglebusinessprofileGoogleBusinessProfileIngestionRuleIdVersion';
|
|
69949
|
+
}
|
|
69950
|
+
// verify the required parameter 'googleBusinessProfileIngestionRuleId' is set
|
|
69951
|
+
if (googleBusinessProfileIngestionRuleId === undefined || googleBusinessProfileIngestionRuleId === null || googleBusinessProfileIngestionRuleId === '') {
|
|
69952
|
+
throw 'Missing the required parameter "googleBusinessProfileIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesGooglebusinessprofileGoogleBusinessProfileIngestionRuleIdVersion';
|
|
69953
|
+
}
|
|
69954
|
+
// verify the required parameter 'dataIngestionRuleVersion' is set
|
|
69955
|
+
if (dataIngestionRuleVersion === undefined || dataIngestionRuleVersion === null || dataIngestionRuleVersion === '') {
|
|
69956
|
+
throw 'Missing the required parameter "dataIngestionRuleVersion" when calling getSocialmediaTopicDataingestionrulesGooglebusinessprofileGoogleBusinessProfileIngestionRuleIdVersion';
|
|
69957
|
+
}
|
|
69958
|
+
|
|
69959
|
+
return this.apiClient.callApi(
|
|
69960
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/googlebusinessprofile/{googleBusinessProfileIngestionRuleId}/versions/{dataIngestionRuleVersion}',
|
|
69961
|
+
'GET',
|
|
69962
|
+
{ 'topicId': topicId,'googleBusinessProfileIngestionRuleId': googleBusinessProfileIngestionRuleId,'dataIngestionRuleVersion': dataIngestionRuleVersion },
|
|
69963
|
+
{ 'includeDeleted': opts['includeDeleted'] },
|
|
69964
|
+
{ },
|
|
69965
|
+
{ },
|
|
69966
|
+
null,
|
|
69967
|
+
['PureCloud OAuth'],
|
|
69968
|
+
['application/json'],
|
|
69969
|
+
['application/json']
|
|
69970
|
+
);
|
|
69971
|
+
}
|
|
69972
|
+
|
|
69973
|
+
/**
|
|
69974
|
+
* Get the Google Business Profile data ingestion rule versions.
|
|
69975
|
+
*
|
|
69976
|
+
* @param {String} topicId topicId
|
|
69977
|
+
* @param {String} googleBusinessProfileIngestionRuleId googleBusinessProfileIngestionRuleId
|
|
69978
|
+
* @param {Object} opts Optional parameters
|
|
69979
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
69980
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
69981
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
69982
|
+
* getSocialmediaTopicDataingestionrulesGooglebusinessprofileGoogleBusinessProfileIngestionRuleIdVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
69983
|
+
*/
|
|
69984
|
+
getSocialmediaTopicDataingestionrulesGooglebusinessprofileGoogleBusinessProfileIngestionRuleIdVersions(topicId, googleBusinessProfileIngestionRuleId, opts) {
|
|
69985
|
+
opts = opts || {};
|
|
69986
|
+
|
|
69987
|
+
// verify the required parameter 'topicId' is set
|
|
69988
|
+
if (topicId === undefined || topicId === null || topicId === '') {
|
|
69989
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesGooglebusinessprofileGoogleBusinessProfileIngestionRuleIdVersions';
|
|
69990
|
+
}
|
|
69991
|
+
// verify the required parameter 'googleBusinessProfileIngestionRuleId' is set
|
|
69992
|
+
if (googleBusinessProfileIngestionRuleId === undefined || googleBusinessProfileIngestionRuleId === null || googleBusinessProfileIngestionRuleId === '') {
|
|
69993
|
+
throw 'Missing the required parameter "googleBusinessProfileIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesGooglebusinessprofileGoogleBusinessProfileIngestionRuleIdVersions';
|
|
69994
|
+
}
|
|
69995
|
+
|
|
69996
|
+
return this.apiClient.callApi(
|
|
69997
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/googlebusinessprofile/{googleBusinessProfileIngestionRuleId}/versions',
|
|
69998
|
+
'GET',
|
|
69999
|
+
{ 'topicId': topicId,'googleBusinessProfileIngestionRuleId': googleBusinessProfileIngestionRuleId },
|
|
70000
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'includeDeleted': opts['includeDeleted'] },
|
|
70001
|
+
{ },
|
|
70002
|
+
{ },
|
|
70003
|
+
null,
|
|
70004
|
+
['PureCloud OAuth'],
|
|
70005
|
+
['application/json'],
|
|
70006
|
+
['application/json']
|
|
70007
|
+
);
|
|
70008
|
+
}
|
|
70009
|
+
|
|
68986
70010
|
/**
|
|
68987
70011
|
* Get a single Instagram data ingestion rule.
|
|
68988
70012
|
*
|
|
@@ -69402,6 +70426,41 @@ class SocialMediaApi {
|
|
|
69402
70426
|
);
|
|
69403
70427
|
}
|
|
69404
70428
|
|
|
70429
|
+
/**
|
|
70430
|
+
* Update the status of a Google Business Profile data ingestion rule.
|
|
70431
|
+
*
|
|
70432
|
+
* @param {String} topicId topicId
|
|
70433
|
+
* @param {String} googleBusinessProfileIngestionRuleId googleBusinessProfileIngestionRuleId
|
|
70434
|
+
* @param {Object} opts Optional parameters
|
|
70435
|
+
* @param {Object} opts.body
|
|
70436
|
+
* patchSocialmediaTopicDataingestionrulesGooglebusinessprofileGoogleBusinessProfileIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
70437
|
+
*/
|
|
70438
|
+
patchSocialmediaTopicDataingestionrulesGooglebusinessprofileGoogleBusinessProfileIngestionRuleId(topicId, googleBusinessProfileIngestionRuleId, opts) {
|
|
70439
|
+
opts = opts || {};
|
|
70440
|
+
|
|
70441
|
+
// verify the required parameter 'topicId' is set
|
|
70442
|
+
if (topicId === undefined || topicId === null || topicId === '') {
|
|
70443
|
+
throw 'Missing the required parameter "topicId" when calling patchSocialmediaTopicDataingestionrulesGooglebusinessprofileGoogleBusinessProfileIngestionRuleId';
|
|
70444
|
+
}
|
|
70445
|
+
// verify the required parameter 'googleBusinessProfileIngestionRuleId' is set
|
|
70446
|
+
if (googleBusinessProfileIngestionRuleId === undefined || googleBusinessProfileIngestionRuleId === null || googleBusinessProfileIngestionRuleId === '') {
|
|
70447
|
+
throw 'Missing the required parameter "googleBusinessProfileIngestionRuleId" when calling patchSocialmediaTopicDataingestionrulesGooglebusinessprofileGoogleBusinessProfileIngestionRuleId';
|
|
70448
|
+
}
|
|
70449
|
+
|
|
70450
|
+
return this.apiClient.callApi(
|
|
70451
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/googlebusinessprofile/{googleBusinessProfileIngestionRuleId}',
|
|
70452
|
+
'PATCH',
|
|
70453
|
+
{ 'topicId': topicId,'googleBusinessProfileIngestionRuleId': googleBusinessProfileIngestionRuleId },
|
|
70454
|
+
{ },
|
|
70455
|
+
{ },
|
|
70456
|
+
{ },
|
|
70457
|
+
opts['body'],
|
|
70458
|
+
['PureCloud OAuth'],
|
|
70459
|
+
['application/json'],
|
|
70460
|
+
['application/json']
|
|
70461
|
+
);
|
|
70462
|
+
}
|
|
70463
|
+
|
|
69405
70464
|
/**
|
|
69406
70465
|
* Update the status of a Instagram data ingestion rule.
|
|
69407
70466
|
*
|
|
@@ -69636,6 +70695,36 @@ class SocialMediaApi {
|
|
|
69636
70695
|
);
|
|
69637
70696
|
}
|
|
69638
70697
|
|
|
70698
|
+
/**
|
|
70699
|
+
* Create a Google Business Profile data ingestion rule.
|
|
70700
|
+
*
|
|
70701
|
+
* @param {String} topicId topicId
|
|
70702
|
+
* @param {Object} opts Optional parameters
|
|
70703
|
+
* @param {Object} opts.body
|
|
70704
|
+
* postSocialmediaTopicDataingestionrulesGooglebusinessprofile is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
70705
|
+
*/
|
|
70706
|
+
postSocialmediaTopicDataingestionrulesGooglebusinessprofile(topicId, opts) {
|
|
70707
|
+
opts = opts || {};
|
|
70708
|
+
|
|
70709
|
+
// verify the required parameter 'topicId' is set
|
|
70710
|
+
if (topicId === undefined || topicId === null || topicId === '') {
|
|
70711
|
+
throw 'Missing the required parameter "topicId" when calling postSocialmediaTopicDataingestionrulesGooglebusinessprofile';
|
|
70712
|
+
}
|
|
70713
|
+
|
|
70714
|
+
return this.apiClient.callApi(
|
|
70715
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/googlebusinessprofile',
|
|
70716
|
+
'POST',
|
|
70717
|
+
{ 'topicId': topicId },
|
|
70718
|
+
{ },
|
|
70719
|
+
{ },
|
|
70720
|
+
{ },
|
|
70721
|
+
opts['body'],
|
|
70722
|
+
['PureCloud OAuth'],
|
|
70723
|
+
['application/json'],
|
|
70724
|
+
['application/json']
|
|
70725
|
+
);
|
|
70726
|
+
}
|
|
70727
|
+
|
|
69639
70728
|
/**
|
|
69640
70729
|
* Create an Instagram data ingestion rule.
|
|
69641
70730
|
*
|
|
@@ -69905,6 +70994,41 @@ class SocialMediaApi {
|
|
|
69905
70994
|
);
|
|
69906
70995
|
}
|
|
69907
70996
|
|
|
70997
|
+
/**
|
|
70998
|
+
* Update the Google Business Profile data ingestion rule.
|
|
70999
|
+
*
|
|
71000
|
+
* @param {String} topicId topicId
|
|
71001
|
+
* @param {String} googleBusinessProfileIngestionRuleId googleBusinessProfileIngestionRuleId
|
|
71002
|
+
* @param {Object} opts Optional parameters
|
|
71003
|
+
* @param {Object} opts.body
|
|
71004
|
+
* putSocialmediaTopicDataingestionrulesGooglebusinessprofileGoogleBusinessProfileIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
71005
|
+
*/
|
|
71006
|
+
putSocialmediaTopicDataingestionrulesGooglebusinessprofileGoogleBusinessProfileIngestionRuleId(topicId, googleBusinessProfileIngestionRuleId, opts) {
|
|
71007
|
+
opts = opts || {};
|
|
71008
|
+
|
|
71009
|
+
// verify the required parameter 'topicId' is set
|
|
71010
|
+
if (topicId === undefined || topicId === null || topicId === '') {
|
|
71011
|
+
throw 'Missing the required parameter "topicId" when calling putSocialmediaTopicDataingestionrulesGooglebusinessprofileGoogleBusinessProfileIngestionRuleId';
|
|
71012
|
+
}
|
|
71013
|
+
// verify the required parameter 'googleBusinessProfileIngestionRuleId' is set
|
|
71014
|
+
if (googleBusinessProfileIngestionRuleId === undefined || googleBusinessProfileIngestionRuleId === null || googleBusinessProfileIngestionRuleId === '') {
|
|
71015
|
+
throw 'Missing the required parameter "googleBusinessProfileIngestionRuleId" when calling putSocialmediaTopicDataingestionrulesGooglebusinessprofileGoogleBusinessProfileIngestionRuleId';
|
|
71016
|
+
}
|
|
71017
|
+
|
|
71018
|
+
return this.apiClient.callApi(
|
|
71019
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/googlebusinessprofile/{googleBusinessProfileIngestionRuleId}',
|
|
71020
|
+
'PUT',
|
|
71021
|
+
{ 'topicId': topicId,'googleBusinessProfileIngestionRuleId': googleBusinessProfileIngestionRuleId },
|
|
71022
|
+
{ },
|
|
71023
|
+
{ },
|
|
71024
|
+
{ },
|
|
71025
|
+
opts['body'],
|
|
71026
|
+
['PureCloud OAuth'],
|
|
71027
|
+
['application/json'],
|
|
71028
|
+
['application/json']
|
|
71029
|
+
);
|
|
71030
|
+
}
|
|
71031
|
+
|
|
69908
71032
|
/**
|
|
69909
71033
|
* Update the Instagram data ingestion rule.
|
|
69910
71034
|
*
|
|
@@ -70013,7 +71137,7 @@ class SpeechTextAnalyticsApi {
|
|
|
70013
71137
|
/**
|
|
70014
71138
|
* SpeechTextAnalytics service.
|
|
70015
71139
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
70016
|
-
* @version
|
|
71140
|
+
* @version 247.0.0
|
|
70017
71141
|
*/
|
|
70018
71142
|
|
|
70019
71143
|
/**
|
|
@@ -71689,7 +72813,7 @@ class StationsApi {
|
|
|
71689
72813
|
/**
|
|
71690
72814
|
* Stations service.
|
|
71691
72815
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
71692
|
-
* @version
|
|
72816
|
+
* @version 247.0.0
|
|
71693
72817
|
*/
|
|
71694
72818
|
|
|
71695
72819
|
/**
|
|
@@ -71791,7 +72915,7 @@ class SuggestApi {
|
|
|
71791
72915
|
/**
|
|
71792
72916
|
* Suggest service.
|
|
71793
72917
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
71794
|
-
* @version
|
|
72918
|
+
* @version 247.0.0
|
|
71795
72919
|
*/
|
|
71796
72920
|
|
|
71797
72921
|
/**
|
|
@@ -71930,7 +73054,7 @@ class TaskManagementApi {
|
|
|
71930
73054
|
/**
|
|
71931
73055
|
* TaskManagement service.
|
|
71932
73056
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
71933
|
-
* @version
|
|
73057
|
+
* @version 247.0.0
|
|
71934
73058
|
*/
|
|
71935
73059
|
|
|
71936
73060
|
/**
|
|
@@ -74092,7 +75216,7 @@ class TeamsApi {
|
|
|
74092
75216
|
/**
|
|
74093
75217
|
* Teams service.
|
|
74094
75218
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
74095
|
-
* @version
|
|
75219
|
+
* @version 247.0.0
|
|
74096
75220
|
*/
|
|
74097
75221
|
|
|
74098
75222
|
/**
|
|
@@ -74397,7 +75521,7 @@ class TelephonyApi {
|
|
|
74397
75521
|
/**
|
|
74398
75522
|
* Telephony service.
|
|
74399
75523
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
74400
|
-
* @version
|
|
75524
|
+
* @version 247.0.0
|
|
74401
75525
|
*/
|
|
74402
75526
|
|
|
74403
75527
|
/**
|
|
@@ -74457,6 +75581,30 @@ class TelephonyApi {
|
|
|
74457
75581
|
);
|
|
74458
75582
|
}
|
|
74459
75583
|
|
|
75584
|
+
/**
|
|
75585
|
+
* Get the concurrent call metrics for a given organization.
|
|
75586
|
+
*
|
|
75587
|
+
* @param {Object} opts Optional parameters
|
|
75588
|
+
* @param {Object} opts.metricType Flag to indicate metric type to fetch. (default to cloud)
|
|
75589
|
+
*/
|
|
75590
|
+
getTelephonyCallsMetrics(opts) {
|
|
75591
|
+
opts = opts || {};
|
|
75592
|
+
|
|
75593
|
+
|
|
75594
|
+
return this.apiClient.callApi(
|
|
75595
|
+
'/api/v2/telephony/calls/metrics',
|
|
75596
|
+
'GET',
|
|
75597
|
+
{ },
|
|
75598
|
+
{ 'metricType': opts['metricType'] },
|
|
75599
|
+
{ },
|
|
75600
|
+
{ },
|
|
75601
|
+
null,
|
|
75602
|
+
['PureCloud OAuth'],
|
|
75603
|
+
['application/json'],
|
|
75604
|
+
['application/json']
|
|
75605
|
+
);
|
|
75606
|
+
}
|
|
75607
|
+
|
|
74460
75608
|
/**
|
|
74461
75609
|
* Retrieve the list of AWS regions media can stream through.
|
|
74462
75610
|
*
|
|
@@ -74679,7 +75827,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
74679
75827
|
/**
|
|
74680
75828
|
* TelephonyProvidersEdge service.
|
|
74681
75829
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
74682
|
-
* @version
|
|
75830
|
+
* @version 247.0.0
|
|
74683
75831
|
*/
|
|
74684
75832
|
|
|
74685
75833
|
/**
|
|
@@ -78172,7 +79320,7 @@ class TextbotsApi {
|
|
|
78172
79320
|
/**
|
|
78173
79321
|
* Textbots service.
|
|
78174
79322
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
78175
|
-
* @version
|
|
79323
|
+
* @version 247.0.0
|
|
78176
79324
|
*/
|
|
78177
79325
|
|
|
78178
79326
|
/**
|
|
@@ -78301,7 +79449,7 @@ class TokensApi {
|
|
|
78301
79449
|
/**
|
|
78302
79450
|
* Tokens service.
|
|
78303
79451
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
78304
|
-
* @version
|
|
79452
|
+
* @version 247.0.0
|
|
78305
79453
|
*/
|
|
78306
79454
|
|
|
78307
79455
|
/**
|
|
@@ -78455,7 +79603,7 @@ class UploadsApi {
|
|
|
78455
79603
|
/**
|
|
78456
79604
|
* Uploads service.
|
|
78457
79605
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
78458
|
-
* @version
|
|
79606
|
+
* @version 247.0.0
|
|
78459
79607
|
*/
|
|
78460
79608
|
|
|
78461
79609
|
/**
|
|
@@ -78771,7 +79919,7 @@ class UsageApi {
|
|
|
78771
79919
|
/**
|
|
78772
79920
|
* Usage service.
|
|
78773
79921
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
78774
|
-
* @version
|
|
79922
|
+
* @version 247.0.0
|
|
78775
79923
|
*/
|
|
78776
79924
|
|
|
78777
79925
|
/**
|
|
@@ -79106,7 +80254,7 @@ class UserRecordingsApi {
|
|
|
79106
80254
|
/**
|
|
79107
80255
|
* UserRecordings service.
|
|
79108
80256
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
79109
|
-
* @version
|
|
80257
|
+
* @version 247.0.0
|
|
79110
80258
|
*/
|
|
79111
80259
|
|
|
79112
80260
|
/**
|
|
@@ -79290,7 +80438,7 @@ class UsersApi {
|
|
|
79290
80438
|
/**
|
|
79291
80439
|
* Users service.
|
|
79292
80440
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
79293
|
-
* @version
|
|
80441
|
+
* @version 247.0.0
|
|
79294
80442
|
*/
|
|
79295
80443
|
|
|
79296
80444
|
/**
|
|
@@ -82740,7 +83888,7 @@ class UsersRulesApi {
|
|
|
82740
83888
|
/**
|
|
82741
83889
|
* UsersRules service.
|
|
82742
83890
|
* @module purecloud-platform-client-v2/api/UsersRulesApi
|
|
82743
|
-
* @version
|
|
83891
|
+
* @version 247.0.0
|
|
82744
83892
|
*/
|
|
82745
83893
|
|
|
82746
83894
|
/**
|
|
@@ -82759,7 +83907,6 @@ class UsersRulesApi {
|
|
|
82759
83907
|
* Delete an existing users rule
|
|
82760
83908
|
*
|
|
82761
83909
|
* @param {String} ruleId The id of the rule
|
|
82762
|
-
* deleteUsersRule is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
82763
83910
|
*/
|
|
82764
83911
|
deleteUsersRule(ruleId) {
|
|
82765
83912
|
// verify the required parameter 'ruleId' is set
|
|
@@ -82785,7 +83932,6 @@ class UsersRulesApi {
|
|
|
82785
83932
|
* Get a users rule
|
|
82786
83933
|
*
|
|
82787
83934
|
* @param {String} ruleId The ID of the rule to retrieve
|
|
82788
|
-
* getUsersRule is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
82789
83935
|
*/
|
|
82790
83936
|
getUsersRule(ruleId) {
|
|
82791
83937
|
// verify the required parameter 'ruleId' is set
|
|
@@ -82813,7 +83959,6 @@ class UsersRulesApi {
|
|
|
82813
83959
|
* @param {String} ruleId The ID of the rule for which to retrieve dependents
|
|
82814
83960
|
* @param {Object} ruleType The type of the dependent
|
|
82815
83961
|
* @param {String} typeId The type ID of the dependent
|
|
82816
|
-
* getUsersRuleDependentTypeId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
82817
83962
|
*/
|
|
82818
83963
|
getUsersRuleDependentTypeId(ruleId, ruleType, typeId) {
|
|
82819
83964
|
// verify the required parameter 'ruleId' is set
|
|
@@ -82851,7 +83996,6 @@ class UsersRulesApi {
|
|
|
82851
83996
|
* @param {Number} opts.pageSize Number of results per page (default to 25)
|
|
82852
83997
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
82853
83998
|
* @param {Object} opts.sortOrder Sort order for dependents (by last run date, then created date) (default to descending)
|
|
82854
|
-
* getUsersRuleDependents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
82855
83999
|
*/
|
|
82856
84000
|
getUsersRuleDependents(ruleId, opts) {
|
|
82857
84001
|
opts = opts || {};
|
|
@@ -82886,7 +84030,6 @@ class UsersRulesApi {
|
|
|
82886
84030
|
* @param {Boolean} opts.enabled Whether to list enabled or disabled rules
|
|
82887
84031
|
* @param {String} opts.searchTerm a search term for finding a rule by name
|
|
82888
84032
|
* @param {Object} opts.sortOrder sort rules by name, ascending, descending (default to ascending)
|
|
82889
|
-
* getUsersRules is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
82890
84033
|
*/
|
|
82891
84034
|
getUsersRules(types, opts) {
|
|
82892
84035
|
opts = opts || {};
|
|
@@ -82914,7 +84057,6 @@ class UsersRulesApi {
|
|
|
82914
84057
|
* Get the settings for a specific users rule type
|
|
82915
84058
|
*
|
|
82916
84059
|
* @param {Object} ruleType The type of the rule
|
|
82917
|
-
* getUsersRulesSetting is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
82918
84060
|
*/
|
|
82919
84061
|
getUsersRulesSetting(ruleType) {
|
|
82920
84062
|
// verify the required parameter 'ruleType' is set
|
|
@@ -82941,7 +84083,6 @@ class UsersRulesApi {
|
|
|
82941
84083
|
* This will update an existing users rule with the specified fields.
|
|
82942
84084
|
* @param {String} ruleId The ID of the rule to update
|
|
82943
84085
|
* @param {Object} body updateRuleRequest
|
|
82944
|
-
* patchUsersRule is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
82945
84086
|
*/
|
|
82946
84087
|
patchUsersRule(ruleId, body) {
|
|
82947
84088
|
// verify the required parameter 'ruleId' is set
|
|
@@ -82971,7 +84112,6 @@ class UsersRulesApi {
|
|
|
82971
84112
|
* Create a new rule
|
|
82972
84113
|
* This will create a new rule with the specified fields.
|
|
82973
84114
|
* @param {Object} body usersRulesCreateRuleRequest
|
|
82974
|
-
* postUsersRules is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
82975
84115
|
*/
|
|
82976
84116
|
postUsersRules(body) {
|
|
82977
84117
|
// verify the required parameter 'body' is set
|
|
@@ -83000,7 +84140,6 @@ class UsersRulesApi {
|
|
|
83000
84140
|
* @param {Object} opts Optional parameters
|
|
83001
84141
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
83002
84142
|
* @param {Number} opts.pageSize Number of results per page (default to 25)
|
|
83003
|
-
* postUsersRulesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
83004
84143
|
*/
|
|
83005
84144
|
postUsersRulesQuery(body, opts) {
|
|
83006
84145
|
opts = opts || {};
|
|
@@ -83030,7 +84169,7 @@ class UtilitiesApi {
|
|
|
83030
84169
|
/**
|
|
83031
84170
|
* Utilities service.
|
|
83032
84171
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
83033
|
-
* @version
|
|
84172
|
+
* @version 247.0.0
|
|
83034
84173
|
*/
|
|
83035
84174
|
|
|
83036
84175
|
/**
|
|
@@ -83141,7 +84280,7 @@ class VoicemailApi {
|
|
|
83141
84280
|
/**
|
|
83142
84281
|
* Voicemail service.
|
|
83143
84282
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
83144
|
-
* @version
|
|
84283
|
+
* @version 247.0.0
|
|
83145
84284
|
*/
|
|
83146
84285
|
|
|
83147
84286
|
/**
|
|
@@ -83863,7 +85002,7 @@ class WebChatApi {
|
|
|
83863
85002
|
/**
|
|
83864
85003
|
* WebChat service.
|
|
83865
85004
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
83866
|
-
* @version
|
|
85005
|
+
* @version 247.0.0
|
|
83867
85006
|
*/
|
|
83868
85007
|
|
|
83869
85008
|
/**
|
|
@@ -84426,7 +85565,7 @@ class WebDeploymentsApi {
|
|
|
84426
85565
|
/**
|
|
84427
85566
|
* WebDeployments service.
|
|
84428
85567
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
84429
|
-
* @version
|
|
85568
|
+
* @version 247.0.0
|
|
84430
85569
|
*/
|
|
84431
85570
|
|
|
84432
85571
|
/**
|
|
@@ -84578,10 +85717,16 @@ class WebDeploymentsApi {
|
|
|
84578
85717
|
|
|
84579
85718
|
/**
|
|
84580
85719
|
* Get the versions of a configuration
|
|
84581
|
-
*
|
|
85720
|
+
*
|
|
84582
85721
|
* @param {String} configurationId The configuration version ID
|
|
85722
|
+
* @param {Object} opts Optional parameters
|
|
85723
|
+
* @param {String} opts.pageSize Number of entities to return. Defaults to 300.
|
|
85724
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
85725
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
84583
85726
|
*/
|
|
84584
|
-
getWebdeploymentsConfigurationVersions(configurationId) {
|
|
85727
|
+
getWebdeploymentsConfigurationVersions(configurationId, opts) {
|
|
85728
|
+
opts = opts || {};
|
|
85729
|
+
|
|
84585
85730
|
// verify the required parameter 'configurationId' is set
|
|
84586
85731
|
if (configurationId === undefined || configurationId === null || configurationId === '') {
|
|
84587
85732
|
throw 'Missing the required parameter "configurationId" when calling getWebdeploymentsConfigurationVersions';
|
|
@@ -84591,7 +85736,7 @@ class WebDeploymentsApi {
|
|
|
84591
85736
|
'/api/v2/webdeployments/configurations/{configurationId}/versions',
|
|
84592
85737
|
'GET',
|
|
84593
85738
|
{ 'configurationId': configurationId },
|
|
84594
|
-
{
|
|
85739
|
+
{ 'pageSize': opts['pageSize'],'before': opts['before'],'after': opts['after'] },
|
|
84595
85740
|
{ },
|
|
84596
85741
|
{ },
|
|
84597
85742
|
null,
|
|
@@ -84630,6 +85775,9 @@ class WebDeploymentsApi {
|
|
|
84630
85775
|
* View configuration drafts
|
|
84631
85776
|
*
|
|
84632
85777
|
* @param {Object} opts Optional parameters
|
|
85778
|
+
* @param {String} opts.pageSize Number of entities to return. Defaults to 300.
|
|
85779
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
85780
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
84633
85781
|
* @param {Boolean} opts.showOnlyPublished Filter by published status.
|
|
84634
85782
|
*/
|
|
84635
85783
|
getWebdeploymentsConfigurations(opts) {
|
|
@@ -84640,7 +85788,7 @@ class WebDeploymentsApi {
|
|
|
84640
85788
|
'/api/v2/webdeployments/configurations',
|
|
84641
85789
|
'GET',
|
|
84642
85790
|
{ },
|
|
84643
|
-
{ 'showOnlyPublished': opts['showOnlyPublished'] },
|
|
85791
|
+
{ 'pageSize': opts['pageSize'],'before': opts['before'],'after': opts['after'],'showOnlyPublished': opts['showOnlyPublished'] },
|
|
84644
85792
|
{ },
|
|
84645
85793
|
{ },
|
|
84646
85794
|
null,
|
|
@@ -84768,6 +85916,9 @@ class WebDeploymentsApi {
|
|
|
84768
85916
|
* Get deployments
|
|
84769
85917
|
*
|
|
84770
85918
|
* @param {Object} opts Optional parameters
|
|
85919
|
+
* @param {String} opts.pageSize Number of entities to return. Defaults to 300.
|
|
85920
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
85921
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
84771
85922
|
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
84772
85923
|
*/
|
|
84773
85924
|
getWebdeploymentsDeployments(opts) {
|
|
@@ -84778,7 +85929,7 @@ class WebDeploymentsApi {
|
|
|
84778
85929
|
'/api/v2/webdeployments/deployments',
|
|
84779
85930
|
'GET',
|
|
84780
85931
|
{ },
|
|
84781
|
-
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
85932
|
+
{ 'pageSize': opts['pageSize'],'before': opts['before'],'after': opts['after'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
84782
85933
|
{ },
|
|
84783
85934
|
{ },
|
|
84784
85935
|
null,
|
|
@@ -85008,7 +86159,7 @@ class WebMessagingApi {
|
|
|
85008
86159
|
/**
|
|
85009
86160
|
* WebMessaging service.
|
|
85010
86161
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
85011
|
-
* @version
|
|
86162
|
+
* @version 247.0.0
|
|
85012
86163
|
*/
|
|
85013
86164
|
|
|
85014
86165
|
/**
|
|
@@ -85154,7 +86305,7 @@ class WidgetsApi {
|
|
|
85154
86305
|
/**
|
|
85155
86306
|
* Widgets service.
|
|
85156
86307
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
85157
|
-
* @version
|
|
86308
|
+
* @version 247.0.0
|
|
85158
86309
|
*/
|
|
85159
86310
|
|
|
85160
86311
|
/**
|
|
@@ -85305,7 +86456,7 @@ class WorkforceManagementApi {
|
|
|
85305
86456
|
/**
|
|
85306
86457
|
* WorkforceManagement service.
|
|
85307
86458
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
85308
|
-
* @version
|
|
86459
|
+
* @version 247.0.0
|
|
85309
86460
|
*/
|
|
85310
86461
|
|
|
85311
86462
|
/**
|
|
@@ -93596,7 +94747,7 @@ class WorkforceManagementApi {
|
|
|
93596
94747
|
* </pre>
|
|
93597
94748
|
* </p>
|
|
93598
94749
|
* @module purecloud-platform-client-v2/index
|
|
93599
|
-
* @version
|
|
94750
|
+
* @version 247.0.0
|
|
93600
94751
|
*/
|
|
93601
94752
|
class platformClient {
|
|
93602
94753
|
constructor() {
|