purecloud-platform-client-v2 230.0.0 → 232.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 +22 -3
- package/dist/node/purecloud-platform-client-v2.js +1247 -141
- package/dist/web-amd/purecloud-platform-client-v2.js +1247 -141
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +449 -156
- package/dist/web-cjs/purecloud-platform-client-v2.js +571 -223
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1704 -518
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +31 -6
- package/src/purecloud-platform-client-v2/PureCloudRegionHosts.js +2 -0
- package/src/purecloud-platform-client-v2/api/AIStudioApi.js +160 -1
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +25 -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 +83 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.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/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 +238 -4
- 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 +5 -2
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +28 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +187 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +7 -3
- 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 +108 -2
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +3 -3
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +22 -10
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +241 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -32
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +7 -4
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +31 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -5,7 +5,7 @@ class RoutingApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Routing service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 232.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -795,8 +795,12 @@ class RoutingApi {
|
|
|
795
795
|
* Get domain
|
|
796
796
|
*
|
|
797
797
|
* @param {String} domainId domain ID
|
|
798
|
+
* @param {Object} opts Optional parameters
|
|
799
|
+
* @param {Object} opts.expand Expand options. Valid values: settings
|
|
798
800
|
*/
|
|
799
|
-
getRoutingEmailDomain(domainId) {
|
|
801
|
+
getRoutingEmailDomain(domainId, opts) {
|
|
802
|
+
opts = opts || {};
|
|
803
|
+
|
|
800
804
|
// verify the required parameter 'domainId' is set
|
|
801
805
|
if (domainId === undefined || domainId === null || domainId === '') {
|
|
802
806
|
throw 'Missing the required parameter "domainId" when calling getRoutingEmailDomain';
|
|
@@ -806,7 +810,7 @@ class RoutingApi {
|
|
|
806
810
|
'/api/v2/routing/email/domains/{domainId}',
|
|
807
811
|
'GET',
|
|
808
812
|
{ 'domainId': domainId },
|
|
809
|
-
{
|
|
813
|
+
{ 'expand': opts['expand'] },
|
|
810
814
|
{ },
|
|
811
815
|
{ },
|
|
812
816
|
null,
|
|
@@ -920,6 +924,7 @@ class RoutingApi {
|
|
|
920
924
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
921
925
|
* @param {Boolean} opts.excludeStatus Exclude MX record data (default to false)
|
|
922
926
|
* @param {String} opts.filter Optional search filter that, if defined, use the **filter** syntax, eg: **mySearchedPattern**. Note that **** is considered no filter.
|
|
927
|
+
* @param {Object} opts.expand Expand options. Valid values: settings
|
|
923
928
|
*/
|
|
924
929
|
getRoutingEmailDomains(opts) {
|
|
925
930
|
opts = opts || {};
|
|
@@ -929,7 +934,7 @@ class RoutingApi {
|
|
|
929
934
|
'/api/v2/routing/email/domains',
|
|
930
935
|
'GET',
|
|
931
936
|
{ },
|
|
932
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'excludeStatus': opts['excludeStatus'],'filter': opts['filter'] },
|
|
937
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'excludeStatus': opts['excludeStatus'],'filter': opts['filter'],'expand': opts['expand'] },
|
|
933
938
|
{ },
|
|
934
939
|
{ },
|
|
935
940
|
null,
|
|
@@ -943,8 +948,12 @@ class RoutingApi {
|
|
|
943
948
|
* Get domain
|
|
944
949
|
*
|
|
945
950
|
* @param {String} domainId domain ID
|
|
951
|
+
* @param {Object} opts Optional parameters
|
|
952
|
+
* @param {Object} opts.expand Expand options. Valid values: settings
|
|
946
953
|
*/
|
|
947
|
-
getRoutingEmailOutboundDomain(domainId) {
|
|
954
|
+
getRoutingEmailOutboundDomain(domainId, opts) {
|
|
955
|
+
opts = opts || {};
|
|
956
|
+
|
|
948
957
|
// verify the required parameter 'domainId' is set
|
|
949
958
|
if (domainId === undefined || domainId === null || domainId === '') {
|
|
950
959
|
throw 'Missing the required parameter "domainId" when calling getRoutingEmailOutboundDomain';
|
|
@@ -954,7 +963,7 @@ class RoutingApi {
|
|
|
954
963
|
'/api/v2/routing/email/outbound/domains/{domainId}',
|
|
955
964
|
'GET',
|
|
956
965
|
{ 'domainId': domainId },
|
|
957
|
-
{
|
|
966
|
+
{ 'expand': opts['expand'] },
|
|
958
967
|
{ },
|
|
959
968
|
{ },
|
|
960
969
|
null,
|
|
@@ -996,6 +1005,7 @@ class RoutingApi {
|
|
|
996
1005
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
997
1006
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
998
1007
|
* @param {String} opts.filter Optional search filter that, if defined, use the **filter** syntax, eg: **mySearchedPattern**. Note that **** is considered no filter.
|
|
1008
|
+
* @param {Object} opts.expand Expand options. Valid values: settings
|
|
999
1009
|
*/
|
|
1000
1010
|
getRoutingEmailOutboundDomains(opts) {
|
|
1001
1011
|
opts = opts || {};
|
|
@@ -1005,7 +1015,7 @@ class RoutingApi {
|
|
|
1005
1015
|
'/api/v2/routing/email/outbound/domains',
|
|
1006
1016
|
'GET',
|
|
1007
1017
|
{ },
|
|
1008
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'filter': opts['filter'] },
|
|
1018
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'filter': opts['filter'],'expand': opts['expand'] },
|
|
1009
1019
|
{ },
|
|
1010
1020
|
{ },
|
|
1011
1021
|
null,
|
|
@@ -1229,6 +1239,8 @@ class RoutingApi {
|
|
|
1229
1239
|
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
1230
1240
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
1231
1241
|
* @param {Array.<String>} opts.queueId Comma-separated list of queue Ids to filter by.
|
|
1242
|
+
* @param {String} opts.kpiId Standard or custom KPI id used to filter predictors.
|
|
1243
|
+
* @param {Object} opts.state The state used to filter predictors.
|
|
1232
1244
|
*/
|
|
1233
1245
|
getRoutingPredictors(opts) {
|
|
1234
1246
|
opts = opts || {};
|
|
@@ -1238,7 +1250,7 @@ class RoutingApi {
|
|
|
1238
1250
|
'/api/v2/routing/predictors',
|
|
1239
1251
|
'GET',
|
|
1240
1252
|
{ },
|
|
1241
|
-
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'queueId': this.apiClient.buildCollectionParam(opts['queueId'], 'multi') },
|
|
1253
|
+
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'queueId': this.apiClient.buildCollectionParam(opts['queueId'], 'multi'),'kpiId': opts['kpiId'],'state': opts['state'] },
|
|
1242
1254
|
{ },
|
|
1243
1255
|
{ },
|
|
1244
1256
|
null,
|
|
@@ -1307,7 +1319,7 @@ class RoutingApi {
|
|
|
1307
1319
|
*
|
|
1308
1320
|
* @param {String} queueId Queue ID
|
|
1309
1321
|
* @param {Object} opts Optional parameters
|
|
1310
|
-
* @param {
|
|
1322
|
+
* @param {Array.<String>} opts.expand Which fields, if any, to expand.
|
|
1311
1323
|
*/
|
|
1312
1324
|
getRoutingQueueAssistant(queueId, opts) {
|
|
1313
1325
|
opts = opts || {};
|
|
@@ -1321,7 +1333,7 @@ class RoutingApi {
|
|
|
1321
1333
|
'/api/v2/routing/queues/{queueId}/assistant',
|
|
1322
1334
|
'GET',
|
|
1323
1335
|
{ 'queueId': queueId },
|
|
1324
|
-
{ 'expand': opts['expand'] },
|
|
1336
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
1325
1337
|
{ },
|
|
1326
1338
|
{ },
|
|
1327
1339
|
null,
|
|
@@ -5,7 +5,7 @@ class SocialMediaApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* SocialMedia service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 232.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -134,6 +134,40 @@ class SocialMediaApi {
|
|
|
134
134
|
);
|
|
135
135
|
}
|
|
136
136
|
|
|
137
|
+
/**
|
|
138
|
+
* Delete a Instagram data ingestion rule.
|
|
139
|
+
*
|
|
140
|
+
* @param {String} topicId topicId
|
|
141
|
+
* @param {String} instagramIngestionRuleId instagramIngestionRuleId
|
|
142
|
+
* @param {Object} opts Optional parameters
|
|
143
|
+
* @param {Boolean} opts.hardDelete Determines whether a Instagram 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)
|
|
144
|
+
*/
|
|
145
|
+
deleteSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId(topicId, instagramIngestionRuleId, opts) {
|
|
146
|
+
opts = opts || {};
|
|
147
|
+
|
|
148
|
+
// verify the required parameter 'topicId' is set
|
|
149
|
+
if (topicId === undefined || topicId === null || topicId === '') {
|
|
150
|
+
throw 'Missing the required parameter "topicId" when calling deleteSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId';
|
|
151
|
+
}
|
|
152
|
+
// verify the required parameter 'instagramIngestionRuleId' is set
|
|
153
|
+
if (instagramIngestionRuleId === undefined || instagramIngestionRuleId === null || instagramIngestionRuleId === '') {
|
|
154
|
+
throw 'Missing the required parameter "instagramIngestionRuleId" when calling deleteSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId';
|
|
155
|
+
}
|
|
156
|
+
|
|
157
|
+
return this.apiClient.callApi(
|
|
158
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/instagram/{instagramIngestionRuleId}',
|
|
159
|
+
'DELETE',
|
|
160
|
+
{ 'topicId': topicId,'instagramIngestionRuleId': instagramIngestionRuleId },
|
|
161
|
+
{ 'hardDelete': opts['hardDelete'] },
|
|
162
|
+
{ },
|
|
163
|
+
{ },
|
|
164
|
+
null,
|
|
165
|
+
['PureCloud OAuth'],
|
|
166
|
+
['application/json'],
|
|
167
|
+
['application/json']
|
|
168
|
+
);
|
|
169
|
+
}
|
|
170
|
+
|
|
137
171
|
/**
|
|
138
172
|
* Delete a open data ingestion rule.
|
|
139
173
|
*
|
|
@@ -534,6 +568,115 @@ class SocialMediaApi {
|
|
|
534
568
|
);
|
|
535
569
|
}
|
|
536
570
|
|
|
571
|
+
/**
|
|
572
|
+
* Get a single Instagram data ingestion rule.
|
|
573
|
+
*
|
|
574
|
+
* @param {String} topicId topicId
|
|
575
|
+
* @param {String} instagramIngestionRuleId instagramIngestionRuleId
|
|
576
|
+
* @param {Object} opts Optional parameters
|
|
577
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
578
|
+
*/
|
|
579
|
+
getSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId(topicId, instagramIngestionRuleId, opts) {
|
|
580
|
+
opts = opts || {};
|
|
581
|
+
|
|
582
|
+
// verify the required parameter 'topicId' is set
|
|
583
|
+
if (topicId === undefined || topicId === null || topicId === '') {
|
|
584
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId';
|
|
585
|
+
}
|
|
586
|
+
// verify the required parameter 'instagramIngestionRuleId' is set
|
|
587
|
+
if (instagramIngestionRuleId === undefined || instagramIngestionRuleId === null || instagramIngestionRuleId === '') {
|
|
588
|
+
throw 'Missing the required parameter "instagramIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId';
|
|
589
|
+
}
|
|
590
|
+
|
|
591
|
+
return this.apiClient.callApi(
|
|
592
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/instagram/{instagramIngestionRuleId}',
|
|
593
|
+
'GET',
|
|
594
|
+
{ 'topicId': topicId,'instagramIngestionRuleId': instagramIngestionRuleId },
|
|
595
|
+
{ 'includeDeleted': opts['includeDeleted'] },
|
|
596
|
+
{ },
|
|
597
|
+
{ },
|
|
598
|
+
null,
|
|
599
|
+
['PureCloud OAuth'],
|
|
600
|
+
['application/json'],
|
|
601
|
+
['application/json']
|
|
602
|
+
);
|
|
603
|
+
}
|
|
604
|
+
|
|
605
|
+
/**
|
|
606
|
+
* Get a single Instagram data ingestion rule version.
|
|
607
|
+
*
|
|
608
|
+
* @param {String} topicId topicId
|
|
609
|
+
* @param {String} instagramIngestionRuleId instagramIngestionRuleId
|
|
610
|
+
* @param {String} dataIngestionRuleVersion version
|
|
611
|
+
* @param {Object} opts Optional parameters
|
|
612
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted item in the result.
|
|
613
|
+
*/
|
|
614
|
+
getSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleIdVersion(topicId, instagramIngestionRuleId, dataIngestionRuleVersion, opts) {
|
|
615
|
+
opts = opts || {};
|
|
616
|
+
|
|
617
|
+
// verify the required parameter 'topicId' is set
|
|
618
|
+
if (topicId === undefined || topicId === null || topicId === '') {
|
|
619
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleIdVersion';
|
|
620
|
+
}
|
|
621
|
+
// verify the required parameter 'instagramIngestionRuleId' is set
|
|
622
|
+
if (instagramIngestionRuleId === undefined || instagramIngestionRuleId === null || instagramIngestionRuleId === '') {
|
|
623
|
+
throw 'Missing the required parameter "instagramIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleIdVersion';
|
|
624
|
+
}
|
|
625
|
+
// verify the required parameter 'dataIngestionRuleVersion' is set
|
|
626
|
+
if (dataIngestionRuleVersion === undefined || dataIngestionRuleVersion === null || dataIngestionRuleVersion === '') {
|
|
627
|
+
throw 'Missing the required parameter "dataIngestionRuleVersion" when calling getSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleIdVersion';
|
|
628
|
+
}
|
|
629
|
+
|
|
630
|
+
return this.apiClient.callApi(
|
|
631
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/instagram/{instagramIngestionRuleId}/versions/{dataIngestionRuleVersion}',
|
|
632
|
+
'GET',
|
|
633
|
+
{ 'topicId': topicId,'instagramIngestionRuleId': instagramIngestionRuleId,'dataIngestionRuleVersion': dataIngestionRuleVersion },
|
|
634
|
+
{ 'includeDeleted': opts['includeDeleted'] },
|
|
635
|
+
{ },
|
|
636
|
+
{ },
|
|
637
|
+
null,
|
|
638
|
+
['PureCloud OAuth'],
|
|
639
|
+
['application/json'],
|
|
640
|
+
['application/json']
|
|
641
|
+
);
|
|
642
|
+
}
|
|
643
|
+
|
|
644
|
+
/**
|
|
645
|
+
* Get the Instagram data ingestion rule versions.
|
|
646
|
+
*
|
|
647
|
+
* @param {String} topicId topicId
|
|
648
|
+
* @param {String} instagramIngestionRuleId instagramIngestionRuleId
|
|
649
|
+
* @param {Object} opts Optional parameters
|
|
650
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
651
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
652
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
653
|
+
*/
|
|
654
|
+
getSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleIdVersions(topicId, instagramIngestionRuleId, opts) {
|
|
655
|
+
opts = opts || {};
|
|
656
|
+
|
|
657
|
+
// verify the required parameter 'topicId' is set
|
|
658
|
+
if (topicId === undefined || topicId === null || topicId === '') {
|
|
659
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleIdVersions';
|
|
660
|
+
}
|
|
661
|
+
// verify the required parameter 'instagramIngestionRuleId' is set
|
|
662
|
+
if (instagramIngestionRuleId === undefined || instagramIngestionRuleId === null || instagramIngestionRuleId === '') {
|
|
663
|
+
throw 'Missing the required parameter "instagramIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleIdVersions';
|
|
664
|
+
}
|
|
665
|
+
|
|
666
|
+
return this.apiClient.callApi(
|
|
667
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/instagram/{instagramIngestionRuleId}/versions',
|
|
668
|
+
'GET',
|
|
669
|
+
{ 'topicId': topicId,'instagramIngestionRuleId': instagramIngestionRuleId },
|
|
670
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'includeDeleted': opts['includeDeleted'] },
|
|
671
|
+
{ },
|
|
672
|
+
{ },
|
|
673
|
+
null,
|
|
674
|
+
['PureCloud OAuth'],
|
|
675
|
+
['application/json'],
|
|
676
|
+
['application/json']
|
|
677
|
+
);
|
|
678
|
+
}
|
|
679
|
+
|
|
537
680
|
/**
|
|
538
681
|
* Get a single open data ingestion rule.
|
|
539
682
|
*
|
|
@@ -842,6 +985,40 @@ class SocialMediaApi {
|
|
|
842
985
|
);
|
|
843
986
|
}
|
|
844
987
|
|
|
988
|
+
/**
|
|
989
|
+
* Update the status of a Instagram data ingestion rule.
|
|
990
|
+
*
|
|
991
|
+
* @param {String} topicId topicId
|
|
992
|
+
* @param {String} instagramIngestionRuleId instagramIngestionRuleId
|
|
993
|
+
* @param {Object} opts Optional parameters
|
|
994
|
+
* @param {Object} opts.body
|
|
995
|
+
*/
|
|
996
|
+
patchSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId(topicId, instagramIngestionRuleId, opts) {
|
|
997
|
+
opts = opts || {};
|
|
998
|
+
|
|
999
|
+
// verify the required parameter 'topicId' is set
|
|
1000
|
+
if (topicId === undefined || topicId === null || topicId === '') {
|
|
1001
|
+
throw 'Missing the required parameter "topicId" when calling patchSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId';
|
|
1002
|
+
}
|
|
1003
|
+
// verify the required parameter 'instagramIngestionRuleId' is set
|
|
1004
|
+
if (instagramIngestionRuleId === undefined || instagramIngestionRuleId === null || instagramIngestionRuleId === '') {
|
|
1005
|
+
throw 'Missing the required parameter "instagramIngestionRuleId" when calling patchSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId';
|
|
1006
|
+
}
|
|
1007
|
+
|
|
1008
|
+
return this.apiClient.callApi(
|
|
1009
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/instagram/{instagramIngestionRuleId}',
|
|
1010
|
+
'PATCH',
|
|
1011
|
+
{ 'topicId': topicId,'instagramIngestionRuleId': instagramIngestionRuleId },
|
|
1012
|
+
{ },
|
|
1013
|
+
{ },
|
|
1014
|
+
{ },
|
|
1015
|
+
opts['body'],
|
|
1016
|
+
['PureCloud OAuth'],
|
|
1017
|
+
['application/json'],
|
|
1018
|
+
['application/json']
|
|
1019
|
+
);
|
|
1020
|
+
}
|
|
1021
|
+
|
|
845
1022
|
/**
|
|
846
1023
|
* Update the status of a open data ingestion rule.
|
|
847
1024
|
*
|
|
@@ -1042,6 +1219,35 @@ class SocialMediaApi {
|
|
|
1042
1219
|
);
|
|
1043
1220
|
}
|
|
1044
1221
|
|
|
1222
|
+
/**
|
|
1223
|
+
* Create an Instagram data ingestion rule.
|
|
1224
|
+
*
|
|
1225
|
+
* @param {String} topicId topicId
|
|
1226
|
+
* @param {Object} opts Optional parameters
|
|
1227
|
+
* @param {Object} opts.body
|
|
1228
|
+
*/
|
|
1229
|
+
postSocialmediaTopicDataingestionrulesInstagram(topicId, opts) {
|
|
1230
|
+
opts = opts || {};
|
|
1231
|
+
|
|
1232
|
+
// verify the required parameter 'topicId' is set
|
|
1233
|
+
if (topicId === undefined || topicId === null || topicId === '') {
|
|
1234
|
+
throw 'Missing the required parameter "topicId" when calling postSocialmediaTopicDataingestionrulesInstagram';
|
|
1235
|
+
}
|
|
1236
|
+
|
|
1237
|
+
return this.apiClient.callApi(
|
|
1238
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/instagram',
|
|
1239
|
+
'POST',
|
|
1240
|
+
{ 'topicId': topicId },
|
|
1241
|
+
{ },
|
|
1242
|
+
{ },
|
|
1243
|
+
{ },
|
|
1244
|
+
opts['body'],
|
|
1245
|
+
['PureCloud OAuth'],
|
|
1246
|
+
['application/json'],
|
|
1247
|
+
['application/json']
|
|
1248
|
+
);
|
|
1249
|
+
}
|
|
1250
|
+
|
|
1045
1251
|
/**
|
|
1046
1252
|
* Create an open data ingestion rule.
|
|
1047
1253
|
*
|
|
@@ -1282,6 +1488,40 @@ class SocialMediaApi {
|
|
|
1282
1488
|
);
|
|
1283
1489
|
}
|
|
1284
1490
|
|
|
1491
|
+
/**
|
|
1492
|
+
* Update the Instagram data ingestion rule.
|
|
1493
|
+
*
|
|
1494
|
+
* @param {String} topicId topicId
|
|
1495
|
+
* @param {String} instagramIngestionRuleId instagramIngestionRuleId
|
|
1496
|
+
* @param {Object} opts Optional parameters
|
|
1497
|
+
* @param {Object} opts.body
|
|
1498
|
+
*/
|
|
1499
|
+
putSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId(topicId, instagramIngestionRuleId, opts) {
|
|
1500
|
+
opts = opts || {};
|
|
1501
|
+
|
|
1502
|
+
// verify the required parameter 'topicId' is set
|
|
1503
|
+
if (topicId === undefined || topicId === null || topicId === '') {
|
|
1504
|
+
throw 'Missing the required parameter "topicId" when calling putSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId';
|
|
1505
|
+
}
|
|
1506
|
+
// verify the required parameter 'instagramIngestionRuleId' is set
|
|
1507
|
+
if (instagramIngestionRuleId === undefined || instagramIngestionRuleId === null || instagramIngestionRuleId === '') {
|
|
1508
|
+
throw 'Missing the required parameter "instagramIngestionRuleId" when calling putSocialmediaTopicDataingestionrulesInstagramInstagramIngestionRuleId';
|
|
1509
|
+
}
|
|
1510
|
+
|
|
1511
|
+
return this.apiClient.callApi(
|
|
1512
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/instagram/{instagramIngestionRuleId}',
|
|
1513
|
+
'PUT',
|
|
1514
|
+
{ 'topicId': topicId,'instagramIngestionRuleId': instagramIngestionRuleId },
|
|
1515
|
+
{ },
|
|
1516
|
+
{ },
|
|
1517
|
+
{ },
|
|
1518
|
+
opts['body'],
|
|
1519
|
+
['PureCloud OAuth'],
|
|
1520
|
+
['application/json'],
|
|
1521
|
+
['application/json']
|
|
1522
|
+
);
|
|
1523
|
+
}
|
|
1524
|
+
|
|
1285
1525
|
/**
|
|
1286
1526
|
* Update the open data ingestion rule.
|
|
1287
1527
|
*
|
|
@@ -5,7 +5,7 @@ class UserRecordingsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* UserRecordings service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 232.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -74,37 +74,6 @@ class UserRecordingsApi {
|
|
|
74
74
|
);
|
|
75
75
|
}
|
|
76
76
|
|
|
77
|
-
/**
|
|
78
|
-
* Download a user recording.
|
|
79
|
-
* API should migrate to use GET api/v2/userrecordings/{recordingId}/transcoding
|
|
80
|
-
* @param {String} recordingId User Recording ID
|
|
81
|
-
* @param {Object} opts Optional parameters
|
|
82
|
-
* @param {Object} opts.formatId The desired media format. (default to WEBM)
|
|
83
|
-
* @param {Boolean} opts.async When set to true, api will return 202 response until the recording is ready for download
|
|
84
|
-
* @deprecated
|
|
85
|
-
*/
|
|
86
|
-
getUserrecordingMedia(recordingId, opts) {
|
|
87
|
-
opts = opts || {};
|
|
88
|
-
|
|
89
|
-
// verify the required parameter 'recordingId' is set
|
|
90
|
-
if (recordingId === undefined || recordingId === null || recordingId === '') {
|
|
91
|
-
throw 'Missing the required parameter "recordingId" when calling getUserrecordingMedia';
|
|
92
|
-
}
|
|
93
|
-
|
|
94
|
-
return this.apiClient.callApi(
|
|
95
|
-
'/api/v2/userrecordings/{recordingId}/media',
|
|
96
|
-
'GET',
|
|
97
|
-
{ 'recordingId': recordingId },
|
|
98
|
-
{ 'formatId': opts['formatId'],'async': opts['async'] },
|
|
99
|
-
{ },
|
|
100
|
-
{ },
|
|
101
|
-
null,
|
|
102
|
-
['PureCloud OAuth'],
|
|
103
|
-
['application/json'],
|
|
104
|
-
['application/json']
|
|
105
|
-
);
|
|
106
|
-
}
|
|
107
|
-
|
|
108
77
|
/**
|
|
109
78
|
* Download a user recording.
|
|
110
79
|
*
|