purecloud-platform-client-v2 207.0.0 → 209.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 +1392 -162
- package/dist/web-amd/purecloud-platform-client-v2.js +1392 -162
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +511 -178
- package/dist/web-cjs/purecloud-platform-client-v2.js +669 -256
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +4261 -3234
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +4 -4
- 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/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 +1 -2
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +3 -8
- 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 +31 -11
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +136 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +11 -5
- 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 +52 -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 +5 -3
- 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 +40 -36
- 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 +55 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +910 -0
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +4 -4
- 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 +55 -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 +12 -12
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +7 -7
- package/src/purecloud-platform-client-v2/index.js +7 -1
|
@@ -483,7 +483,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
483
483
|
|
|
484
484
|
/**
|
|
485
485
|
* @module purecloud-platform-client-v2/ApiClient
|
|
486
|
-
* @version
|
|
486
|
+
* @version 209.0.0
|
|
487
487
|
*/
|
|
488
488
|
class ApiClient {
|
|
489
489
|
/**
|
|
@@ -1927,7 +1927,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1927
1927
|
/**
|
|
1928
1928
|
* AgentAssistants service.
|
|
1929
1929
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
1930
|
-
* @version
|
|
1930
|
+
* @version 209.0.0
|
|
1931
1931
|
*/
|
|
1932
1932
|
|
|
1933
1933
|
/**
|
|
@@ -2303,7 +2303,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2303
2303
|
/**
|
|
2304
2304
|
* AgentCopilot service.
|
|
2305
2305
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
2306
|
-
* @version
|
|
2306
|
+
* @version 209.0.0
|
|
2307
2307
|
*/
|
|
2308
2308
|
|
|
2309
2309
|
/**
|
|
@@ -2379,7 +2379,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2379
2379
|
/**
|
|
2380
2380
|
* AgentUI service.
|
|
2381
2381
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
2382
|
-
* @version
|
|
2382
|
+
* @version 209.0.0
|
|
2383
2383
|
*/
|
|
2384
2384
|
|
|
2385
2385
|
/**
|
|
@@ -2510,7 +2510,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2510
2510
|
/**
|
|
2511
2511
|
* Alerting service.
|
|
2512
2512
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
2513
|
-
* @version
|
|
2513
|
+
* @version 209.0.0
|
|
2514
2514
|
*/
|
|
2515
2515
|
|
|
2516
2516
|
/**
|
|
@@ -3171,7 +3171,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3171
3171
|
/**
|
|
3172
3172
|
* Analytics service.
|
|
3173
3173
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
3174
|
-
* @version
|
|
3174
|
+
* @version 209.0.0
|
|
3175
3175
|
*/
|
|
3176
3176
|
|
|
3177
3177
|
/**
|
|
@@ -3350,7 +3350,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3350
3350
|
|
|
3351
3351
|
/**
|
|
3352
3352
|
* Get Reporting Turns (division aware).
|
|
3353
|
-
* Returns the reporting turns for the specified flow, filtered by the clients divisions and grouped by session, in reverse chronological order from the date the session was created, with the reporting turns from the most recent session appearing at the start of the list. For pagination, clients should keep sending requests using the value of nextUri in the response, until its no longer present, only then have all items have been returned. Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days.
|
|
3353
|
+
* Returns the reporting turns for the specified flow, filtered by the clients divisions and grouped by session, in reverse chronological order from the date the session was created, with the reporting turns from the most recent session appearing at the start of the list. It is expected that the client will URL encode the request URI once only. For pagination, clients should keep sending requests using the value of nextUri in the response, until its no longer present, only then have all items have been returned. The nextUri value in the response is already URL encoded (so it doesnt need to be encoded again). Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days.
|
|
3354
3354
|
* @param {String} botFlowId ID of the bot flow.
|
|
3355
3355
|
* @param {Object} opts Optional parameters
|
|
3356
3356
|
* @param {String} opts.after The cursor that points to the ID of the last item in the list of entities that has been returned.
|
|
@@ -3385,7 +3385,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3385
3385
|
|
|
3386
3386
|
/**
|
|
3387
3387
|
* Get Reporting Turns.
|
|
3388
|
-
* Deprecated: Please use GET /analytics/botflows/{botFlowId}/divisions/reportingturns instead. Returns the reporting turns grouped by session, in reverse chronological order from the date the session was created, with the reporting turns from the most recent session appearing at the start of the list. For pagination, clients should keep sending requests using the value of nextUri in the response, until its no longer present, only then have all items have been returned. Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days.
|
|
3388
|
+
* Deprecated: Please use GET /analytics/botflows/{botFlowId}/divisions/reportingturns instead. Returns the reporting turns grouped by session, in reverse chronological order from the date the session was created, with the reporting turns from the most recent session appearing at the start of the list. It is expected that the client will URL encode the request URI once only. For pagination, clients should keep sending requests using the value of nextUri in the response, until its no longer present, only then have all items have been returned. The nextUri value in the response is already URL encoded (so it doesnt need to be encoded again). Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days.
|
|
3389
3389
|
* @param {String} botFlowId ID of the bot flow.
|
|
3390
3390
|
* @param {Object} opts Optional parameters
|
|
3391
3391
|
* @param {String} opts.after The cursor that points to the ID of the last item in the list of entities that has been returned.
|
|
@@ -3421,7 +3421,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3421
3421
|
|
|
3422
3422
|
/**
|
|
3423
3423
|
* Get Bot Flow Sessions.
|
|
3424
|
-
* Returns the bot flow sessions in reverse chronological order from the date they were created. For pagination, clients should keep sending requests using the value of nextUri in the response, until its no longer present, only then have all items have been returned. Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days.
|
|
3424
|
+
* Returns the bot flow sessions in reverse chronological order from the date they were created. It is expected that the client will URL encode the request URI once only. For pagination, clients should keep sending requests using the value of nextUri in the response, until its no longer present, only then have all items have been returned. The nextUri value in the response is already URL encoded (so it doesnt need to be encoded again). Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days.
|
|
3425
3425
|
* @param {String} botFlowId ID of the bot flow.
|
|
3426
3426
|
* @param {Object} opts Optional parameters
|
|
3427
3427
|
* @param {String} opts.after The cursor that points to the ID of the last item in the list of entities that has been returned.
|
|
@@ -5784,7 +5784,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5784
5784
|
/**
|
|
5785
5785
|
* Architect service.
|
|
5786
5786
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
5787
|
-
* @version
|
|
5787
|
+
* @version 209.0.0
|
|
5788
5788
|
*/
|
|
5789
5789
|
|
|
5790
5790
|
/**
|
|
@@ -9906,7 +9906,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9906
9906
|
/**
|
|
9907
9907
|
* Audit service.
|
|
9908
9908
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
9909
|
-
* @version
|
|
9909
|
+
* @version 209.0.0
|
|
9910
9910
|
*/
|
|
9911
9911
|
|
|
9912
9912
|
/**
|
|
@@ -10107,7 +10107,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10107
10107
|
/**
|
|
10108
10108
|
* Authorization service.
|
|
10109
10109
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
10110
|
-
* @version
|
|
10110
|
+
* @version 209.0.0
|
|
10111
10111
|
*/
|
|
10112
10112
|
|
|
10113
10113
|
/**
|
|
@@ -11390,7 +11390,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11390
11390
|
/**
|
|
11391
11391
|
* Billing service.
|
|
11392
11392
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
11393
|
-
* @version
|
|
11393
|
+
* @version 209.0.0
|
|
11394
11394
|
*/
|
|
11395
11395
|
|
|
11396
11396
|
/**
|
|
@@ -11470,7 +11470,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11470
11470
|
/**
|
|
11471
11471
|
* CarrierServices service.
|
|
11472
11472
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
11473
|
-
* @version
|
|
11473
|
+
* @version 209.0.0
|
|
11474
11474
|
*/
|
|
11475
11475
|
|
|
11476
11476
|
/**
|
|
@@ -11540,7 +11540,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11540
11540
|
/**
|
|
11541
11541
|
* Chat service.
|
|
11542
11542
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
11543
|
-
* @version
|
|
11543
|
+
* @version 209.0.0
|
|
11544
11544
|
*/
|
|
11545
11545
|
|
|
11546
11546
|
/**
|
|
@@ -12476,7 +12476,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12476
12476
|
/**
|
|
12477
12477
|
* Coaching service.
|
|
12478
12478
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
12479
|
-
* @version
|
|
12479
|
+
* @version 209.0.0
|
|
12480
12480
|
*/
|
|
12481
12481
|
|
|
12482
12482
|
/**
|
|
@@ -13053,7 +13053,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13053
13053
|
/**
|
|
13054
13054
|
* ContentManagement service.
|
|
13055
13055
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
13056
|
-
* @version
|
|
13056
|
+
* @version 209.0.0
|
|
13057
13057
|
*/
|
|
13058
13058
|
|
|
13059
13059
|
/**
|
|
@@ -14134,7 +14134,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14134
14134
|
/**
|
|
14135
14135
|
* Conversations service.
|
|
14136
14136
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
14137
|
-
* @version
|
|
14137
|
+
* @version 209.0.0
|
|
14138
14138
|
*/
|
|
14139
14139
|
|
|
14140
14140
|
/**
|
|
@@ -14920,7 +14920,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14920
14920
|
* Get the summaries of the conversation.
|
|
14921
14921
|
*
|
|
14922
14922
|
* @param {String} conversationId Conversation ID
|
|
14923
|
-
* getConversationSummaries is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14924
14923
|
*/
|
|
14925
14924
|
getConversationSummaries(conversationId) {
|
|
14926
14925
|
// verify the required parameter 'conversationId' is set
|
|
@@ -21276,7 +21275,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21276
21275
|
/**
|
|
21277
21276
|
* DataExtensions service.
|
|
21278
21277
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
21279
|
-
* @version
|
|
21278
|
+
* @version 209.0.0
|
|
21280
21279
|
*/
|
|
21281
21280
|
|
|
21282
21281
|
/**
|
|
@@ -21362,7 +21361,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21362
21361
|
/**
|
|
21363
21362
|
* Downloads service.
|
|
21364
21363
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
21365
|
-
* @version
|
|
21364
|
+
* @version 209.0.0
|
|
21366
21365
|
*/
|
|
21367
21366
|
|
|
21368
21367
|
/**
|
|
@@ -21414,7 +21413,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21414
21413
|
/**
|
|
21415
21414
|
* Emails service.
|
|
21416
21415
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
21417
|
-
* @version
|
|
21416
|
+
* @version 209.0.0
|
|
21418
21417
|
*/
|
|
21419
21418
|
|
|
21420
21419
|
/**
|
|
@@ -21479,7 +21478,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21479
21478
|
/**
|
|
21480
21479
|
* EmployeeEngagement service.
|
|
21481
21480
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
21482
|
-
* @version
|
|
21481
|
+
* @version 209.0.0
|
|
21483
21482
|
*/
|
|
21484
21483
|
|
|
21485
21484
|
/**
|
|
@@ -21630,7 +21629,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21630
21629
|
/**
|
|
21631
21630
|
* Events service.
|
|
21632
21631
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
21633
|
-
* @version
|
|
21632
|
+
* @version 209.0.0
|
|
21634
21633
|
*/
|
|
21635
21634
|
|
|
21636
21635
|
/**
|
|
@@ -21726,7 +21725,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21726
21725
|
/**
|
|
21727
21726
|
* ExternalContacts service.
|
|
21728
21727
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
21729
|
-
* @version
|
|
21728
|
+
* @version 209.0.0
|
|
21730
21729
|
*/
|
|
21731
21730
|
|
|
21732
21731
|
/**
|
|
@@ -21825,7 +21824,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21825
21824
|
* Delete an External Source. WARNING: Any records that reference this External Source will not be automatically cleaned up. Those records will still be editable, but their External IDs may not be fully viewable.
|
|
21826
21825
|
*
|
|
21827
21826
|
* @param {String} externalSourceId External Source ID
|
|
21828
|
-
* deleteExternalcontactsExternalsource is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21829
21827
|
*/
|
|
21830
21828
|
deleteExternalcontactsExternalsource(externalSourceId) {
|
|
21831
21829
|
// verify the required parameter 'externalSourceId' is set
|
|
@@ -22133,7 +22131,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22133
22131
|
*
|
|
22134
22132
|
* @param {String} contactId ExternalContact ID
|
|
22135
22133
|
* @param {Object} opts Optional parameters
|
|
22136
|
-
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
22134
|
+
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
22137
22135
|
*/
|
|
22138
22136
|
getExternalcontactsContactUnresolved(contactId, opts) {
|
|
22139
22137
|
opts = opts || {};
|
|
@@ -22289,7 +22287,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22289
22287
|
* Fetch an External Source
|
|
22290
22288
|
*
|
|
22291
22289
|
* @param {String} externalSourceId External Source ID
|
|
22292
|
-
* getExternalcontactsExternalsource is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
22293
22290
|
*/
|
|
22294
22291
|
getExternalcontactsExternalsource(externalSourceId) {
|
|
22295
22292
|
// verify the required parameter 'externalSourceId' is set
|
|
@@ -22319,7 +22316,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22319
22316
|
* @param {Number} opts.limit The number of ExternalSources per page; must be between 10 and 200, default is 100
|
|
22320
22317
|
* @param {String} opts.name Filter by external source name. Filtering is prefix filtering and not an exact match
|
|
22321
22318
|
* @param {Boolean} opts.active Filter by active status of external source
|
|
22322
|
-
* getExternalcontactsExternalsources is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
22323
22319
|
*/
|
|
22324
22320
|
getExternalcontactsExternalsources(opts) {
|
|
22325
22321
|
opts = opts || {};
|
|
@@ -22445,7 +22441,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22445
22441
|
*
|
|
22446
22442
|
* @param {String} externalOrganizationId External Organization ID
|
|
22447
22443
|
* @param {Object} opts Optional parameters
|
|
22448
|
-
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
22444
|
+
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
22449
22445
|
* @param {Boolean} opts.includeTrustors (true or false) whether or not to include trustor information embedded in the externalOrganization
|
|
22450
22446
|
*/
|
|
22451
22447
|
getExternalcontactsOrganization(externalOrganizationId, opts) {
|
|
@@ -23453,7 +23449,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23453
23449
|
* Create an External Source
|
|
23454
23450
|
*
|
|
23455
23451
|
* @param {Object} body External Source
|
|
23456
|
-
* postExternalcontactsExternalsources is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
23457
23452
|
*/
|
|
23458
23453
|
postExternalcontactsExternalsources(body) {
|
|
23459
23454
|
// verify the required parameter 'body' is set
|
|
@@ -23839,7 +23834,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23839
23834
|
*
|
|
23840
23835
|
* @param {String} externalSourceId External Source ID
|
|
23841
23836
|
* @param {Object} body External Source
|
|
23842
|
-
* putExternalcontactsExternalsource is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
23843
23837
|
*/
|
|
23844
23838
|
putExternalcontactsExternalsource(externalSourceId, body) {
|
|
23845
23839
|
// verify the required parameter 'externalSourceId' is set
|
|
@@ -24056,7 +24050,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24056
24050
|
/**
|
|
24057
24051
|
* Fax service.
|
|
24058
24052
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
24059
|
-
* @version
|
|
24053
|
+
* @version 209.0.0
|
|
24060
24054
|
*/
|
|
24061
24055
|
|
|
24062
24056
|
/**
|
|
@@ -24271,7 +24265,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24271
24265
|
/**
|
|
24272
24266
|
* Flows service.
|
|
24273
24267
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
24274
|
-
* @version
|
|
24268
|
+
* @version 209.0.0
|
|
24275
24269
|
*/
|
|
24276
24270
|
|
|
24277
24271
|
/**
|
|
@@ -24454,7 +24448,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24454
24448
|
/**
|
|
24455
24449
|
* Gamification service.
|
|
24456
24450
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
24457
|
-
* @version
|
|
24451
|
+
* @version 209.0.0
|
|
24458
24452
|
*/
|
|
24459
24453
|
|
|
24460
24454
|
/**
|
|
@@ -26540,7 +26534,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26540
26534
|
/**
|
|
26541
26535
|
* GeneralDataProtectionRegulation service.
|
|
26542
26536
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
26543
|
-
* @version
|
|
26537
|
+
* @version 209.0.0
|
|
26544
26538
|
*/
|
|
26545
26539
|
|
|
26546
26540
|
/**
|
|
@@ -26670,7 +26664,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26670
26664
|
/**
|
|
26671
26665
|
* Geolocation service.
|
|
26672
26666
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
26673
|
-
* @version
|
|
26667
|
+
* @version 209.0.0
|
|
26674
26668
|
*/
|
|
26675
26669
|
|
|
26676
26670
|
/**
|
|
@@ -26801,7 +26795,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26801
26795
|
/**
|
|
26802
26796
|
* Greetings service.
|
|
26803
26797
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
26804
|
-
* @version
|
|
26798
|
+
* @version 209.0.0
|
|
26805
26799
|
*/
|
|
26806
26800
|
|
|
26807
26801
|
/**
|
|
@@ -27256,7 +27250,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27256
27250
|
/**
|
|
27257
27251
|
* Groups service.
|
|
27258
27252
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
27259
|
-
* @version
|
|
27253
|
+
* @version 209.0.0
|
|
27260
27254
|
*/
|
|
27261
27255
|
|
|
27262
27256
|
/**
|
|
@@ -27775,7 +27769,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27775
27769
|
/**
|
|
27776
27770
|
* IdentityProvider service.
|
|
27777
27771
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
27778
|
-
* @version
|
|
27772
|
+
* @version 209.0.0
|
|
27779
27773
|
*/
|
|
27780
27774
|
|
|
27781
27775
|
/**
|
|
@@ -28636,7 +28630,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28636
28630
|
/**
|
|
28637
28631
|
* InfrastructureAsCode service.
|
|
28638
28632
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
28639
|
-
* @version
|
|
28633
|
+
* @version 209.0.0
|
|
28640
28634
|
*/
|
|
28641
28635
|
|
|
28642
28636
|
/**
|
|
@@ -28803,7 +28797,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28803
28797
|
/**
|
|
28804
28798
|
* Integrations service.
|
|
28805
28799
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
28806
|
-
* @version
|
|
28800
|
+
* @version 209.0.0
|
|
28807
28801
|
*/
|
|
28808
28802
|
|
|
28809
28803
|
/**
|
|
@@ -29097,8 +29091,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29097
29091
|
*
|
|
29098
29092
|
* @param {String} actionId actionId
|
|
29099
29093
|
* @param {String} fileName Name of schema file to be retrieved for this draft.
|
|
29094
|
+
* @param {Object} opts Optional parameters
|
|
29095
|
+
* @param {Boolean} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
|
|
29100
29096
|
*/
|
|
29101
|
-
getIntegrationsActionDraftSchema(actionId, fileName) {
|
|
29097
|
+
getIntegrationsActionDraftSchema(actionId, fileName, opts) {
|
|
29098
|
+
opts = opts || {};
|
|
29099
|
+
|
|
29102
29100
|
// verify the required parameter 'actionId' is set
|
|
29103
29101
|
if (actionId === undefined || actionId === null) {
|
|
29104
29102
|
throw 'Missing the required parameter "actionId" when calling getIntegrationsActionDraftSchema';
|
|
@@ -29112,7 +29110,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29112
29110
|
'/api/v2/integrations/actions/{actionId}/draft/schemas/{fileName}',
|
|
29113
29111
|
'GET',
|
|
29114
29112
|
{ 'actionId': actionId,'fileName': fileName },
|
|
29115
|
-
{
|
|
29113
|
+
{ 'flatten': opts['flatten'] },
|
|
29116
29114
|
{ },
|
|
29117
29115
|
{ },
|
|
29118
29116
|
null,
|
|
@@ -29208,8 +29206,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29208
29206
|
*
|
|
29209
29207
|
* @param {String} actionId actionId
|
|
29210
29208
|
* @param {String} fileName Name of schema file to be retrieved for this action.
|
|
29209
|
+
* @param {Object} opts Optional parameters
|
|
29210
|
+
* @param {Boolean} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
|
|
29211
29211
|
*/
|
|
29212
|
-
getIntegrationsActionSchema(actionId, fileName) {
|
|
29212
|
+
getIntegrationsActionSchema(actionId, fileName, opts) {
|
|
29213
|
+
opts = opts || {};
|
|
29214
|
+
|
|
29213
29215
|
// verify the required parameter 'actionId' is set
|
|
29214
29216
|
if (actionId === undefined || actionId === null) {
|
|
29215
29217
|
throw 'Missing the required parameter "actionId" when calling getIntegrationsActionSchema';
|
|
@@ -29223,7 +29225,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29223
29225
|
'/api/v2/integrations/actions/{actionId}/schemas/{fileName}',
|
|
29224
29226
|
'GET',
|
|
29225
29227
|
{ 'actionId': actionId,'fileName': fileName },
|
|
29226
|
-
{
|
|
29228
|
+
{ 'flatten': opts['flatten'] },
|
|
29227
29229
|
{ },
|
|
29228
29230
|
{ },
|
|
29229
29231
|
null,
|
|
@@ -30760,8 +30762,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30760
30762
|
*
|
|
30761
30763
|
* @param {String} actionId actionId
|
|
30762
30764
|
* @param {Object.<String, {String: Object}>} body Map of parameters used for variable substitution.
|
|
30765
|
+
* @param {Object} opts Optional parameters
|
|
30766
|
+
* @param {Boolean} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
|
|
30763
30767
|
*/
|
|
30764
|
-
postIntegrationsActionDraftTest(actionId, body) {
|
|
30768
|
+
postIntegrationsActionDraftTest(actionId, body, opts) {
|
|
30769
|
+
opts = opts || {};
|
|
30770
|
+
|
|
30765
30771
|
// verify the required parameter 'actionId' is set
|
|
30766
30772
|
if (actionId === undefined || actionId === null) {
|
|
30767
30773
|
throw 'Missing the required parameter "actionId" when calling postIntegrationsActionDraftTest';
|
|
@@ -30775,7 +30781,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30775
30781
|
'/api/v2/integrations/actions/{actionId}/draft/test',
|
|
30776
30782
|
'POST',
|
|
30777
30783
|
{ 'actionId': actionId },
|
|
30778
|
-
{
|
|
30784
|
+
{ 'flatten': opts['flatten'] },
|
|
30779
30785
|
{ },
|
|
30780
30786
|
{ },
|
|
30781
30787
|
body,
|
|
@@ -30790,8 +30796,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30790
30796
|
*
|
|
30791
30797
|
* @param {String} actionId actionId
|
|
30792
30798
|
* @param {Object.<String, {String: Object}>} body Map of parameters used for variable substitution.
|
|
30799
|
+
* @param {Object} opts Optional parameters
|
|
30800
|
+
* @param {Boolean} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
|
|
30793
30801
|
*/
|
|
30794
|
-
postIntegrationsActionExecute(actionId, body) {
|
|
30802
|
+
postIntegrationsActionExecute(actionId, body, opts) {
|
|
30803
|
+
opts = opts || {};
|
|
30804
|
+
|
|
30795
30805
|
// verify the required parameter 'actionId' is set
|
|
30796
30806
|
if (actionId === undefined || actionId === null) {
|
|
30797
30807
|
throw 'Missing the required parameter "actionId" when calling postIntegrationsActionExecute';
|
|
@@ -30805,7 +30815,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30805
30815
|
'/api/v2/integrations/actions/{actionId}/execute',
|
|
30806
30816
|
'POST',
|
|
30807
30817
|
{ 'actionId': actionId },
|
|
30808
|
-
{
|
|
30818
|
+
{ 'flatten': opts['flatten'] },
|
|
30809
30819
|
{ },
|
|
30810
30820
|
{ },
|
|
30811
30821
|
body,
|
|
@@ -30820,8 +30830,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30820
30830
|
*
|
|
30821
30831
|
* @param {String} actionId actionId
|
|
30822
30832
|
* @param {Object.<String, {String: Object}>} body Map of parameters used for variable substitution.
|
|
30833
|
+
* @param {Object} opts Optional parameters
|
|
30834
|
+
* @param {Boolean} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
|
|
30823
30835
|
*/
|
|
30824
|
-
postIntegrationsActionTest(actionId, body) {
|
|
30836
|
+
postIntegrationsActionTest(actionId, body, opts) {
|
|
30837
|
+
opts = opts || {};
|
|
30838
|
+
|
|
30825
30839
|
// verify the required parameter 'actionId' is set
|
|
30826
30840
|
if (actionId === undefined || actionId === null) {
|
|
30827
30841
|
throw 'Missing the required parameter "actionId" when calling postIntegrationsActionTest';
|
|
@@ -30835,7 +30849,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30835
30849
|
'/api/v2/integrations/actions/{actionId}/test',
|
|
30836
30850
|
'POST',
|
|
30837
30851
|
{ 'actionId': actionId },
|
|
30838
|
-
{
|
|
30852
|
+
{ 'flatten': opts['flatten'] },
|
|
30839
30853
|
{ },
|
|
30840
30854
|
{ },
|
|
30841
30855
|
body,
|
|
@@ -31225,7 +31239,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31225
31239
|
/**
|
|
31226
31240
|
* Journey service.
|
|
31227
31241
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
31228
|
-
* @version
|
|
31242
|
+
* @version 209.0.0
|
|
31229
31243
|
*/
|
|
31230
31244
|
|
|
31231
31245
|
/**
|
|
@@ -31394,6 +31408,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31394
31408
|
);
|
|
31395
31409
|
}
|
|
31396
31410
|
|
|
31411
|
+
/**
|
|
31412
|
+
* Delete the Schedule of a JourneyView
|
|
31413
|
+
* used for long descriptions
|
|
31414
|
+
* @param {String} viewId Journey View Id
|
|
31415
|
+
*/
|
|
31416
|
+
deleteJourneyViewSchedules(viewId) {
|
|
31417
|
+
// verify the required parameter 'viewId' is set
|
|
31418
|
+
if (viewId === undefined || viewId === null) {
|
|
31419
|
+
throw 'Missing the required parameter "viewId" when calling deleteJourneyViewSchedules';
|
|
31420
|
+
}
|
|
31421
|
+
|
|
31422
|
+
return this.apiClient.callApi(
|
|
31423
|
+
'/api/v2/journey/views/{viewId}/schedules',
|
|
31424
|
+
'DELETE',
|
|
31425
|
+
{ 'viewId': viewId },
|
|
31426
|
+
{ },
|
|
31427
|
+
{ },
|
|
31428
|
+
{ },
|
|
31429
|
+
null,
|
|
31430
|
+
['PureCloud OAuth'],
|
|
31431
|
+
['application/json'],
|
|
31432
|
+
['application/json']
|
|
31433
|
+
);
|
|
31434
|
+
}
|
|
31435
|
+
|
|
31397
31436
|
/**
|
|
31398
31437
|
* Get status for async query for journey aggregates
|
|
31399
31438
|
*
|
|
@@ -32042,6 +32081,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32042
32081
|
);
|
|
32043
32082
|
}
|
|
32044
32083
|
|
|
32084
|
+
/**
|
|
32085
|
+
* Get the Schedule for a JourneyView
|
|
32086
|
+
* used for long descriptions
|
|
32087
|
+
* @param {String} viewId Journey View Id
|
|
32088
|
+
*/
|
|
32089
|
+
getJourneyViewSchedules(viewId) {
|
|
32090
|
+
// verify the required parameter 'viewId' is set
|
|
32091
|
+
if (viewId === undefined || viewId === null) {
|
|
32092
|
+
throw 'Missing the required parameter "viewId" when calling getJourneyViewSchedules';
|
|
32093
|
+
}
|
|
32094
|
+
|
|
32095
|
+
return this.apiClient.callApi(
|
|
32096
|
+
'/api/v2/journey/views/{viewId}/schedules',
|
|
32097
|
+
'GET',
|
|
32098
|
+
{ 'viewId': viewId },
|
|
32099
|
+
{ },
|
|
32100
|
+
{ },
|
|
32101
|
+
{ },
|
|
32102
|
+
null,
|
|
32103
|
+
['PureCloud OAuth'],
|
|
32104
|
+
['application/json'],
|
|
32105
|
+
['application/json']
|
|
32106
|
+
);
|
|
32107
|
+
}
|
|
32108
|
+
|
|
32045
32109
|
/**
|
|
32046
32110
|
* Get a Journey View by ID and version
|
|
32047
32111
|
*
|
|
@@ -32387,6 +32451,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32387
32451
|
);
|
|
32388
32452
|
}
|
|
32389
32453
|
|
|
32454
|
+
/**
|
|
32455
|
+
* Get the journey schedules for an organization.
|
|
32456
|
+
*
|
|
32457
|
+
* @param {Object} opts Optional parameters
|
|
32458
|
+
* @param {Number} opts.pageNumber The number of the page to return (default to 1)
|
|
32459
|
+
* @param {Number} opts.pageSize Max number of entities to return (default to 25)
|
|
32460
|
+
*/
|
|
32461
|
+
getJourneyViewsSchedules(opts) {
|
|
32462
|
+
opts = opts || {};
|
|
32463
|
+
|
|
32464
|
+
|
|
32465
|
+
return this.apiClient.callApi(
|
|
32466
|
+
'/api/v2/journey/views/schedules',
|
|
32467
|
+
'GET',
|
|
32468
|
+
{ },
|
|
32469
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
32470
|
+
{ },
|
|
32471
|
+
{ },
|
|
32472
|
+
null,
|
|
32473
|
+
['PureCloud OAuth'],
|
|
32474
|
+
['application/json'],
|
|
32475
|
+
['application/json']
|
|
32476
|
+
);
|
|
32477
|
+
}
|
|
32478
|
+
|
|
32390
32479
|
/**
|
|
32391
32480
|
* Update single action map.
|
|
32392
32481
|
*
|
|
@@ -32905,6 +32994,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32905
32994
|
);
|
|
32906
32995
|
}
|
|
32907
32996
|
|
|
32997
|
+
/**
|
|
32998
|
+
* Add a new Schedule to a JourneyView
|
|
32999
|
+
*
|
|
33000
|
+
* @param {String} viewId Journey View Id
|
|
33001
|
+
* @param {Object} body journeyViewSchedule
|
|
33002
|
+
*/
|
|
33003
|
+
postJourneyViewSchedules(viewId, body) {
|
|
33004
|
+
// verify the required parameter 'viewId' is set
|
|
33005
|
+
if (viewId === undefined || viewId === null) {
|
|
33006
|
+
throw 'Missing the required parameter "viewId" when calling postJourneyViewSchedules';
|
|
33007
|
+
}
|
|
33008
|
+
// verify the required parameter 'body' is set
|
|
33009
|
+
if (body === undefined || body === null) {
|
|
33010
|
+
throw 'Missing the required parameter "body" when calling postJourneyViewSchedules';
|
|
33011
|
+
}
|
|
33012
|
+
|
|
33013
|
+
return this.apiClient.callApi(
|
|
33014
|
+
'/api/v2/journey/views/{viewId}/schedules',
|
|
33015
|
+
'POST',
|
|
33016
|
+
{ 'viewId': viewId },
|
|
33017
|
+
{ },
|
|
33018
|
+
{ },
|
|
33019
|
+
{ },
|
|
33020
|
+
body,
|
|
33021
|
+
['PureCloud OAuth'],
|
|
33022
|
+
['application/json'],
|
|
33023
|
+
['application/json']
|
|
33024
|
+
);
|
|
33025
|
+
}
|
|
33026
|
+
|
|
32908
33027
|
/**
|
|
32909
33028
|
* Submit a job request for a journey view version.
|
|
32910
33029
|
* used for long descriptions
|
|
@@ -33014,6 +33133,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33014
33133
|
);
|
|
33015
33134
|
}
|
|
33016
33135
|
|
|
33136
|
+
/**
|
|
33137
|
+
* Update the Schedule for a JourneyView
|
|
33138
|
+
* used for long descriptions
|
|
33139
|
+
* @param {String} viewId Journey View Id
|
|
33140
|
+
* @param {Object} body journeyViewSchedule
|
|
33141
|
+
*/
|
|
33142
|
+
putJourneyViewSchedules(viewId, body) {
|
|
33143
|
+
// verify the required parameter 'viewId' is set
|
|
33144
|
+
if (viewId === undefined || viewId === null) {
|
|
33145
|
+
throw 'Missing the required parameter "viewId" when calling putJourneyViewSchedules';
|
|
33146
|
+
}
|
|
33147
|
+
// verify the required parameter 'body' is set
|
|
33148
|
+
if (body === undefined || body === null) {
|
|
33149
|
+
throw 'Missing the required parameter "body" when calling putJourneyViewSchedules';
|
|
33150
|
+
}
|
|
33151
|
+
|
|
33152
|
+
return this.apiClient.callApi(
|
|
33153
|
+
'/api/v2/journey/views/{viewId}/schedules',
|
|
33154
|
+
'PUT',
|
|
33155
|
+
{ 'viewId': viewId },
|
|
33156
|
+
{ },
|
|
33157
|
+
{ },
|
|
33158
|
+
{ },
|
|
33159
|
+
body,
|
|
33160
|
+
['PureCloud OAuth'],
|
|
33161
|
+
['application/json'],
|
|
33162
|
+
['application/json']
|
|
33163
|
+
);
|
|
33164
|
+
}
|
|
33165
|
+
|
|
33017
33166
|
/**
|
|
33018
33167
|
* Update a Journey View by ID and version
|
|
33019
33168
|
* does not create a new version
|
|
@@ -33055,7 +33204,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33055
33204
|
/**
|
|
33056
33205
|
* Knowledge service.
|
|
33057
33206
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
33058
|
-
* @version
|
|
33207
|
+
* @version 209.0.0
|
|
33059
33208
|
*/
|
|
33060
33209
|
|
|
33061
33210
|
/**
|
|
@@ -33579,8 +33728,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33579
33728
|
* Get sync options available for a knowledge-connect integration
|
|
33580
33729
|
*
|
|
33581
33730
|
* @param {String} integrationId Integration ID
|
|
33731
|
+
* @param {Object} opts Optional parameters
|
|
33732
|
+
* @param {Array.<String>} opts.knowledgeBaseIds Narrowing down filtering option results by knowledge base.
|
|
33582
33733
|
*/
|
|
33583
|
-
getKnowledgeIntegrationOptions(integrationId) {
|
|
33734
|
+
getKnowledgeIntegrationOptions(integrationId, opts) {
|
|
33735
|
+
opts = opts || {};
|
|
33736
|
+
|
|
33584
33737
|
// verify the required parameter 'integrationId' is set
|
|
33585
33738
|
if (integrationId === undefined || integrationId === null) {
|
|
33586
33739
|
throw 'Missing the required parameter "integrationId" when calling getKnowledgeIntegrationOptions';
|
|
@@ -33590,7 +33743,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33590
33743
|
'/api/v2/knowledge/integrations/{integrationId}/options',
|
|
33591
33744
|
'GET',
|
|
33592
33745
|
{ 'integrationId': integrationId },
|
|
33593
|
-
{
|
|
33746
|
+
{ 'knowledgeBaseIds': this.apiClient.buildCollectionParam(opts['knowledgeBaseIds'], 'multi') },
|
|
33594
33747
|
{ },
|
|
33595
33748
|
{ },
|
|
33596
33749
|
null,
|
|
@@ -33814,6 +33967,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33814
33967
|
* @param {String} knowledgeBaseId Globally unique identifier for a knowledge base.
|
|
33815
33968
|
* @param {Object} opts Optional parameters
|
|
33816
33969
|
* @param {Object} opts.documentState The state of the document.
|
|
33970
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
33817
33971
|
*/
|
|
33818
33972
|
getKnowledgeKnowledgebaseDocumentVariation(documentVariationId, documentId, knowledgeBaseId, opts) {
|
|
33819
33973
|
opts = opts || {};
|
|
@@ -33835,7 +33989,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33835
33989
|
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}',
|
|
33836
33990
|
'GET',
|
|
33837
33991
|
{ 'documentVariationId': documentVariationId,'documentId': documentId,'knowledgeBaseId': knowledgeBaseId },
|
|
33838
|
-
{ 'documentState': opts['documentState'] },
|
|
33992
|
+
{ 'documentState': opts['documentState'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
33839
33993
|
{ },
|
|
33840
33994
|
{ },
|
|
33841
33995
|
null,
|
|
@@ -33855,6 +34009,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33855
34009
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
33856
34010
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
33857
34011
|
* @param {Object} opts.documentState The state of the document.
|
|
34012
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
33858
34013
|
*/
|
|
33859
34014
|
getKnowledgeKnowledgebaseDocumentVariations(knowledgeBaseId, documentId, opts) {
|
|
33860
34015
|
opts = opts || {};
|
|
@@ -33872,7 +34027,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33872
34027
|
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations',
|
|
33873
34028
|
'GET',
|
|
33874
34029
|
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
33875
|
-
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'documentState': opts['documentState'] },
|
|
34030
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'documentState': opts['documentState'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
33876
34031
|
{ },
|
|
33877
34032
|
{ },
|
|
33878
34033
|
null,
|
|
@@ -36925,7 +37080,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36925
37080
|
/**
|
|
36926
37081
|
* LanguageUnderstanding service.
|
|
36927
37082
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
36928
|
-
* @version
|
|
37083
|
+
* @version 209.0.0
|
|
36929
37084
|
*/
|
|
36930
37085
|
|
|
36931
37086
|
/**
|
|
@@ -37959,7 +38114,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37959
38114
|
/**
|
|
37960
38115
|
* Languages service.
|
|
37961
38116
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
37962
|
-
* @version
|
|
38117
|
+
* @version 209.0.0
|
|
37963
38118
|
*/
|
|
37964
38119
|
|
|
37965
38120
|
/**
|
|
@@ -38181,7 +38336,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38181
38336
|
/**
|
|
38182
38337
|
* Learning service.
|
|
38183
38338
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
38184
|
-
* @version
|
|
38339
|
+
* @version 209.0.0
|
|
38185
38340
|
*/
|
|
38186
38341
|
|
|
38187
38342
|
/**
|
|
@@ -39210,7 +39365,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39210
39365
|
/**
|
|
39211
39366
|
* License service.
|
|
39212
39367
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
39213
|
-
* @version
|
|
39368
|
+
* @version 209.0.0
|
|
39214
39369
|
*/
|
|
39215
39370
|
|
|
39216
39371
|
/**
|
|
@@ -39448,7 +39603,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39448
39603
|
/**
|
|
39449
39604
|
* Locations service.
|
|
39450
39605
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
39451
|
-
* @version
|
|
39606
|
+
* @version 209.0.0
|
|
39452
39607
|
*/
|
|
39453
39608
|
|
|
39454
39609
|
/**
|
|
@@ -39684,7 +39839,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39684
39839
|
/**
|
|
39685
39840
|
* LogCapture service.
|
|
39686
39841
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
39687
|
-
* @version
|
|
39842
|
+
* @version 209.0.0
|
|
39688
39843
|
*/
|
|
39689
39844
|
|
|
39690
39845
|
/**
|
|
@@ -39884,7 +40039,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39884
40039
|
/**
|
|
39885
40040
|
* Messaging service.
|
|
39886
40041
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
39887
|
-
* @version
|
|
40042
|
+
* @version 209.0.0
|
|
39888
40043
|
*/
|
|
39889
40044
|
|
|
39890
40045
|
/**
|
|
@@ -40243,7 +40398,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40243
40398
|
/**
|
|
40244
40399
|
* MobileDevices service.
|
|
40245
40400
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
40246
|
-
* @version
|
|
40401
|
+
* @version 209.0.0
|
|
40247
40402
|
*/
|
|
40248
40403
|
|
|
40249
40404
|
/**
|
|
@@ -40394,7 +40549,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40394
40549
|
/**
|
|
40395
40550
|
* Notifications service.
|
|
40396
40551
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
40397
|
-
* @version
|
|
40552
|
+
* @version 209.0.0
|
|
40398
40553
|
*/
|
|
40399
40554
|
|
|
40400
40555
|
/**
|
|
@@ -40627,7 +40782,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40627
40782
|
/**
|
|
40628
40783
|
* OAuth service.
|
|
40629
40784
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
40630
|
-
* @version
|
|
40785
|
+
* @version 209.0.0
|
|
40631
40786
|
*/
|
|
40632
40787
|
|
|
40633
40788
|
/**
|
|
@@ -40993,7 +41148,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40993
41148
|
/**
|
|
40994
41149
|
* Objects service.
|
|
40995
41150
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
40996
|
-
* @version
|
|
41151
|
+
* @version 209.0.0
|
|
40997
41152
|
*/
|
|
40998
41153
|
|
|
40999
41154
|
/**
|
|
@@ -41263,7 +41418,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41263
41418
|
/**
|
|
41264
41419
|
* OperationalEvents service.
|
|
41265
41420
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
41266
|
-
* @version
|
|
41421
|
+
* @version 209.0.0
|
|
41267
41422
|
*/
|
|
41268
41423
|
|
|
41269
41424
|
/**
|
|
@@ -41323,13 +41478,64 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41323
41478
|
);
|
|
41324
41479
|
}
|
|
41325
41480
|
|
|
41481
|
+
/**
|
|
41482
|
+
* Get aggregates for operational events in a timeframe.
|
|
41483
|
+
*
|
|
41484
|
+
* @param {Object} opts Optional parameters
|
|
41485
|
+
* @param {Object} opts.body
|
|
41486
|
+
*/
|
|
41487
|
+
postUsageEventsAggregatesQuery(opts) {
|
|
41488
|
+
opts = opts || {};
|
|
41489
|
+
|
|
41490
|
+
|
|
41491
|
+
return this.apiClient.callApi(
|
|
41492
|
+
'/api/v2/usage/events/aggregates/query',
|
|
41493
|
+
'POST',
|
|
41494
|
+
{ },
|
|
41495
|
+
{ },
|
|
41496
|
+
{ },
|
|
41497
|
+
{ },
|
|
41498
|
+
opts['body'],
|
|
41499
|
+
['PureCloud OAuth'],
|
|
41500
|
+
['application/json'],
|
|
41501
|
+
['application/json']
|
|
41502
|
+
);
|
|
41503
|
+
}
|
|
41504
|
+
|
|
41505
|
+
/**
|
|
41506
|
+
* Query operational events in a timeframe.
|
|
41507
|
+
*
|
|
41508
|
+
* @param {Object} opts Optional parameters
|
|
41509
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
41510
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
41511
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
41512
|
+
* @param {Object} opts.body
|
|
41513
|
+
*/
|
|
41514
|
+
postUsageEventsQuery(opts) {
|
|
41515
|
+
opts = opts || {};
|
|
41516
|
+
|
|
41517
|
+
|
|
41518
|
+
return this.apiClient.callApi(
|
|
41519
|
+
'/api/v2/usage/events/query',
|
|
41520
|
+
'POST',
|
|
41521
|
+
{ },
|
|
41522
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
41523
|
+
{ },
|
|
41524
|
+
{ },
|
|
41525
|
+
opts['body'],
|
|
41526
|
+
['PureCloud OAuth'],
|
|
41527
|
+
['application/json'],
|
|
41528
|
+
['application/json']
|
|
41529
|
+
);
|
|
41530
|
+
}
|
|
41531
|
+
|
|
41326
41532
|
}
|
|
41327
41533
|
|
|
41328
41534
|
class OrganizationApi {
|
|
41329
41535
|
/**
|
|
41330
41536
|
* Organization service.
|
|
41331
41537
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
41332
|
-
* @version
|
|
41538
|
+
* @version 209.0.0
|
|
41333
41539
|
*/
|
|
41334
41540
|
|
|
41335
41541
|
/**
|
|
@@ -41871,7 +42077,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41871
42077
|
/**
|
|
41872
42078
|
* OrganizationAuthorization service.
|
|
41873
42079
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
41874
|
-
* @version
|
|
42080
|
+
* @version 209.0.0
|
|
41875
42081
|
*/
|
|
41876
42082
|
|
|
41877
42083
|
/**
|
|
@@ -43265,7 +43471,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43265
43471
|
/**
|
|
43266
43472
|
* Outbound service.
|
|
43267
43473
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
43268
|
-
* @version
|
|
43474
|
+
* @version 209.0.0
|
|
43269
43475
|
*/
|
|
43270
43476
|
|
|
43271
43477
|
/**
|
|
@@ -47812,7 +48018,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47812
48018
|
/**
|
|
47813
48019
|
* Presence service.
|
|
47814
48020
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
47815
|
-
* @version
|
|
48021
|
+
* @version 209.0.0
|
|
47816
48022
|
*/
|
|
47817
48023
|
|
|
47818
48024
|
/**
|
|
@@ -48556,7 +48762,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48556
48762
|
/**
|
|
48557
48763
|
* ProcessAutomation service.
|
|
48558
48764
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
48559
|
-
* @version
|
|
48765
|
+
* @version 209.0.0
|
|
48560
48766
|
*/
|
|
48561
48767
|
|
|
48562
48768
|
/**
|
|
@@ -48795,7 +49001,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48795
49001
|
/**
|
|
48796
49002
|
* Quality service.
|
|
48797
49003
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
48798
|
-
* @version
|
|
49004
|
+
* @version 209.0.0
|
|
48799
49005
|
*/
|
|
48800
49006
|
|
|
48801
49007
|
/**
|
|
@@ -49080,6 +49286,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49080
49286
|
* @param {String} opts.group group id
|
|
49081
49287
|
* @param {String} opts.agentTeamId team id of agents requested
|
|
49082
49288
|
* @param {String} opts.formContextId shared id between form versions
|
|
49289
|
+
* @param {Object} opts.userState 'Legacy' fetches active and inactive users when evaluatorUserId or no user filters are supplied; otherwise fetches active users. 'Any' fetches users of 'active', 'inactive' and 'deleted' states. (default to Legacy)
|
|
49083
49290
|
*/
|
|
49084
49291
|
getQualityAgentsActivity(opts) {
|
|
49085
49292
|
opts = opts || {};
|
|
@@ -49089,7 +49296,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49089
49296
|
'/api/v2/quality/agents/activity',
|
|
49090
49297
|
'GET',
|
|
49091
49298
|
{ },
|
|
49092
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'startTime': opts['startTime'],'endTime': opts['endTime'],'agentUserId': this.apiClient.buildCollectionParam(opts['agentUserId'], 'multi'),'evaluatorUserId': opts['evaluatorUserId'],'name': opts['name'],'group': opts['group'],'agentTeamId': opts['agentTeamId'],'formContextId': opts['formContextId'] },
|
|
49299
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'startTime': opts['startTime'],'endTime': opts['endTime'],'agentUserId': this.apiClient.buildCollectionParam(opts['agentUserId'], 'multi'),'evaluatorUserId': opts['evaluatorUserId'],'name': opts['name'],'group': opts['group'],'agentTeamId': opts['agentTeamId'],'formContextId': opts['formContextId'],'userState': opts['userState'] },
|
|
49093
49300
|
{ },
|
|
49094
49301
|
{ },
|
|
49095
49302
|
null,
|
|
@@ -49304,6 +49511,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49304
49511
|
* @param {Boolean} opts.expandAnswerTotalScores get the total scores for evaluations. NOTE: The answers will only be populated if this parameter is set to true in the request.
|
|
49305
49512
|
* @param {Number} opts.maximum the maximum number of results to return
|
|
49306
49513
|
* @param {String} opts.sortOrder NOTE: Does not work when conversationId is supplied.
|
|
49514
|
+
* @param {Boolean} opts.includeDeletedUsers Allow returning an agent or evaluator user with a 'delete' status. Defaults to false. (default to false)
|
|
49307
49515
|
*/
|
|
49308
49516
|
getQualityEvaluationsQuery(opts) {
|
|
49309
49517
|
opts = opts || {};
|
|
@@ -49313,7 +49521,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49313
49521
|
'/api/v2/quality/evaluations/query',
|
|
49314
49522
|
'GET',
|
|
49315
49523
|
{ },
|
|
49316
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'previousPage': opts['previousPage'],'conversationId': opts['conversationId'],'agentUserId': opts['agentUserId'],'agentTeamId': opts['agentTeamId'],'evaluatorUserId': opts['evaluatorUserId'],'assigneeUserId': opts['assigneeUserId'],'queueId': opts['queueId'],'startTime': opts['startTime'],'endTime': opts['endTime'],'formContextId': opts['formContextId'],'evaluationState': this.apiClient.buildCollectionParam(opts['evaluationState'], 'multi'),'isReleased': opts['isReleased'],'agentHasRead': opts['agentHasRead'],'expandAnswerTotalScores': opts['expandAnswerTotalScores'],'maximum': opts['maximum'],'sortOrder': opts['sortOrder'] },
|
|
49524
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'previousPage': opts['previousPage'],'conversationId': opts['conversationId'],'agentUserId': opts['agentUserId'],'agentTeamId': opts['agentTeamId'],'evaluatorUserId': opts['evaluatorUserId'],'assigneeUserId': opts['assigneeUserId'],'queueId': opts['queueId'],'startTime': opts['startTime'],'endTime': opts['endTime'],'formContextId': opts['formContextId'],'evaluationState': this.apiClient.buildCollectionParam(opts['evaluationState'], 'multi'),'isReleased': opts['isReleased'],'agentHasRead': opts['agentHasRead'],'expandAnswerTotalScores': opts['expandAnswerTotalScores'],'maximum': opts['maximum'],'sortOrder': opts['sortOrder'],'includeDeletedUsers': opts['includeDeletedUsers'] },
|
|
49317
49525
|
{ },
|
|
49318
49526
|
{ },
|
|
49319
49527
|
null,
|
|
@@ -50581,7 +50789,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50581
50789
|
/**
|
|
50582
50790
|
* Recording service.
|
|
50583
50791
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
50584
|
-
* @version
|
|
50792
|
+
* @version 209.0.0
|
|
50585
50793
|
*/
|
|
50586
50794
|
|
|
50587
50795
|
/**
|
|
@@ -52240,7 +52448,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52240
52448
|
/**
|
|
52241
52449
|
* ResponseManagement service.
|
|
52242
52450
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
52243
|
-
* @version
|
|
52451
|
+
* @version 209.0.0
|
|
52244
52452
|
*/
|
|
52245
52453
|
|
|
52246
52454
|
/**
|
|
@@ -52750,7 +52958,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52750
52958
|
/**
|
|
52751
52959
|
* Routing service.
|
|
52752
52960
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
52753
|
-
* @version
|
|
52961
|
+
* @version 209.0.0
|
|
52754
52962
|
*/
|
|
52755
52963
|
|
|
52756
52964
|
/**
|
|
@@ -53158,18 +53366,18 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53158
53366
|
/**
|
|
53159
53367
|
* Delete a phone number provisioned for SMS.
|
|
53160
53368
|
*
|
|
53161
|
-
* @param {String}
|
|
53369
|
+
* @param {String} phoneNumberId phone number
|
|
53162
53370
|
*/
|
|
53163
|
-
deleteRoutingSmsPhonenumber(
|
|
53164
|
-
// verify the required parameter '
|
|
53165
|
-
if (
|
|
53166
|
-
throw 'Missing the required parameter "
|
|
53371
|
+
deleteRoutingSmsPhonenumber(phoneNumberId) {
|
|
53372
|
+
// verify the required parameter 'phoneNumberId' is set
|
|
53373
|
+
if (phoneNumberId === undefined || phoneNumberId === null) {
|
|
53374
|
+
throw 'Missing the required parameter "phoneNumberId" when calling deleteRoutingSmsPhonenumber';
|
|
53167
53375
|
}
|
|
53168
53376
|
|
|
53169
53377
|
return this.apiClient.callApi(
|
|
53170
|
-
'/api/v2/routing/sms/phonenumbers/{
|
|
53378
|
+
'/api/v2/routing/sms/phonenumbers/{phoneNumberId}',
|
|
53171
53379
|
'DELETE',
|
|
53172
|
-
{ '
|
|
53380
|
+
{ 'phoneNumberId': phoneNumberId },
|
|
53173
53381
|
{ },
|
|
53174
53382
|
{ },
|
|
53175
53383
|
{ },
|
|
@@ -53335,7 +53543,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53335
53543
|
}
|
|
53336
53544
|
|
|
53337
53545
|
/**
|
|
53338
|
-
* Remove routing language from user
|
|
53546
|
+
* Remove a routing language from a user
|
|
53339
53547
|
*
|
|
53340
53548
|
* @param {String} userId User ID
|
|
53341
53549
|
* @param {String} languageId languageId
|
|
@@ -53365,7 +53573,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53365
53573
|
}
|
|
53366
53574
|
|
|
53367
53575
|
/**
|
|
53368
|
-
* Remove routing skill from user
|
|
53576
|
+
* Remove a routing skill from a user
|
|
53369
53577
|
*
|
|
53370
53578
|
* @param {String} userId User ID
|
|
53371
53579
|
* @param {String} skillId skillId
|
|
@@ -54148,9 +54356,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54148
54356
|
* Get Estimated Wait Time
|
|
54149
54357
|
*
|
|
54150
54358
|
* @param {String} queueId queueId
|
|
54151
|
-
* @param {
|
|
54359
|
+
* @param {Object} mediaType mediaType
|
|
54360
|
+
* @param {Object} opts Optional parameters
|
|
54361
|
+
* @param {String} opts.labelId Unique id that represents the interaction label used with media type for EWT calculation
|
|
54152
54362
|
*/
|
|
54153
|
-
getRoutingQueueMediatypeEstimatedwaittime(queueId, mediaType) {
|
|
54363
|
+
getRoutingQueueMediatypeEstimatedwaittime(queueId, mediaType, opts) {
|
|
54364
|
+
opts = opts || {};
|
|
54365
|
+
|
|
54154
54366
|
// verify the required parameter 'queueId' is set
|
|
54155
54367
|
if (queueId === undefined || queueId === null) {
|
|
54156
54368
|
throw 'Missing the required parameter "queueId" when calling getRoutingQueueMediatypeEstimatedwaittime';
|
|
@@ -54164,7 +54376,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54164
54376
|
'/api/v2/routing/queues/{queueId}/mediatypes/{mediaType}/estimatedwaittime',
|
|
54165
54377
|
'GET',
|
|
54166
54378
|
{ 'queueId': queueId,'mediaType': mediaType },
|
|
54167
|
-
{
|
|
54379
|
+
{ 'labelId': opts['labelId'] },
|
|
54168
54380
|
{ },
|
|
54169
54381
|
{ },
|
|
54170
54382
|
null,
|
|
@@ -54715,22 +54927,22 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54715
54927
|
/**
|
|
54716
54928
|
* Get a phone number provisioned for SMS.
|
|
54717
54929
|
*
|
|
54718
|
-
* @param {String}
|
|
54930
|
+
* @param {String} phoneNumberId phone number
|
|
54719
54931
|
* @param {Object} opts Optional parameters
|
|
54720
54932
|
* @param {Object} opts.expand Expand response with additional information
|
|
54721
54933
|
*/
|
|
54722
|
-
getRoutingSmsPhonenumber(
|
|
54934
|
+
getRoutingSmsPhonenumber(phoneNumberId, opts) {
|
|
54723
54935
|
opts = opts || {};
|
|
54724
54936
|
|
|
54725
|
-
// verify the required parameter '
|
|
54726
|
-
if (
|
|
54727
|
-
throw 'Missing the required parameter "
|
|
54937
|
+
// verify the required parameter 'phoneNumberId' is set
|
|
54938
|
+
if (phoneNumberId === undefined || phoneNumberId === null) {
|
|
54939
|
+
throw 'Missing the required parameter "phoneNumberId" when calling getRoutingSmsPhonenumber';
|
|
54728
54940
|
}
|
|
54729
54941
|
|
|
54730
54942
|
return this.apiClient.callApi(
|
|
54731
|
-
'/api/v2/routing/sms/phonenumbers/{
|
|
54943
|
+
'/api/v2/routing/sms/phonenumbers/{phoneNumberId}',
|
|
54732
54944
|
'GET',
|
|
54733
|
-
{ '
|
|
54945
|
+
{ 'phoneNumberId': phoneNumberId },
|
|
54734
54946
|
{ 'expand': opts['expand'] },
|
|
54735
54947
|
{ },
|
|
54736
54948
|
{ },
|
|
@@ -55144,7 +55356,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55144
55356
|
}
|
|
55145
55357
|
|
|
55146
55358
|
/**
|
|
55147
|
-
* List routing
|
|
55359
|
+
* List routing languages assigned to a user
|
|
55148
55360
|
*
|
|
55149
55361
|
* @param {String} userId User ID
|
|
55150
55362
|
* @param {Object} opts Optional parameters
|
|
@@ -55175,7 +55387,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55175
55387
|
}
|
|
55176
55388
|
|
|
55177
55389
|
/**
|
|
55178
|
-
* List routing skills
|
|
55390
|
+
* List routing skills assigned to a user
|
|
55179
55391
|
*
|
|
55180
55392
|
* @param {String} userId User ID
|
|
55181
55393
|
* @param {Object} opts Optional parameters
|
|
@@ -55637,7 +55849,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55637
55849
|
}
|
|
55638
55850
|
|
|
55639
55851
|
/**
|
|
55640
|
-
* Update routing language proficiency
|
|
55852
|
+
* Update an assigned routing language's proficiency
|
|
55641
55853
|
*
|
|
55642
55854
|
* @param {String} userId User ID
|
|
55643
55855
|
* @param {String} languageId languageId
|
|
@@ -55672,7 +55884,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55672
55884
|
}
|
|
55673
55885
|
|
|
55674
55886
|
/**
|
|
55675
|
-
*
|
|
55887
|
+
* Assign multiple routing languages to a user. Max 50 routing languages in request body
|
|
55676
55888
|
*
|
|
55677
55889
|
* @param {String} userId User ID
|
|
55678
55890
|
* @param {Array.<Object>} body Language
|
|
@@ -55702,7 +55914,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55702
55914
|
}
|
|
55703
55915
|
|
|
55704
55916
|
/**
|
|
55705
|
-
*
|
|
55917
|
+
* Assign multiple routing skills to a user
|
|
55706
55918
|
*
|
|
55707
55919
|
* @param {String} userId User ID
|
|
55708
55920
|
* @param {Array.<Object>} body Skill
|
|
@@ -56398,7 +56610,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56398
56610
|
}
|
|
56399
56611
|
|
|
56400
56612
|
/**
|
|
56401
|
-
*
|
|
56613
|
+
* Assign a routing language to a user
|
|
56402
56614
|
*
|
|
56403
56615
|
* @param {String} userId User ID
|
|
56404
56616
|
* @param {Object} body Language
|
|
@@ -56428,7 +56640,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56428
56640
|
}
|
|
56429
56641
|
|
|
56430
56642
|
/**
|
|
56431
|
-
*
|
|
56643
|
+
* Assign a routing skill to a user
|
|
56432
56644
|
*
|
|
56433
56645
|
* @param {String} userId User ID
|
|
56434
56646
|
* @param {Object} body Skill
|
|
@@ -56655,13 +56867,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56655
56867
|
/**
|
|
56656
56868
|
* Update a phone number provisioned for SMS.
|
|
56657
56869
|
*
|
|
56658
|
-
* @param {String}
|
|
56870
|
+
* @param {String} phoneNumberId phone number
|
|
56659
56871
|
* @param {Object} body SmsPhoneNumber
|
|
56660
56872
|
*/
|
|
56661
|
-
putRoutingSmsPhonenumber(
|
|
56662
|
-
// verify the required parameter '
|
|
56663
|
-
if (
|
|
56664
|
-
throw 'Missing the required parameter "
|
|
56873
|
+
putRoutingSmsPhonenumber(phoneNumberId, body) {
|
|
56874
|
+
// verify the required parameter 'phoneNumberId' is set
|
|
56875
|
+
if (phoneNumberId === undefined || phoneNumberId === null) {
|
|
56876
|
+
throw 'Missing the required parameter "phoneNumberId" when calling putRoutingSmsPhonenumber';
|
|
56665
56877
|
}
|
|
56666
56878
|
// verify the required parameter 'body' is set
|
|
56667
56879
|
if (body === undefined || body === null) {
|
|
@@ -56669,9 +56881,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56669
56881
|
}
|
|
56670
56882
|
|
|
56671
56883
|
return this.apiClient.callApi(
|
|
56672
|
-
'/api/v2/routing/sms/phonenumbers/{
|
|
56884
|
+
'/api/v2/routing/sms/phonenumbers/{phoneNumberId}',
|
|
56673
56885
|
'PUT',
|
|
56674
|
-
{ '
|
|
56886
|
+
{ 'phoneNumberId': phoneNumberId },
|
|
56675
56887
|
{ },
|
|
56676
56888
|
{ },
|
|
56677
56889
|
{ },
|
|
@@ -56828,7 +57040,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56828
57040
|
}
|
|
56829
57041
|
|
|
56830
57042
|
/**
|
|
56831
|
-
* Update routing skill proficiency
|
|
57043
|
+
* Update an assigned routing skill's proficiency
|
|
56832
57044
|
*
|
|
56833
57045
|
* @param {String} userId User ID
|
|
56834
57046
|
* @param {String} skillId skillId
|
|
@@ -56863,7 +57075,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56863
57075
|
}
|
|
56864
57076
|
|
|
56865
57077
|
/**
|
|
56866
|
-
*
|
|
57078
|
+
* Assign multiple routing skills to a user, replacing any current assignments
|
|
56867
57079
|
*
|
|
56868
57080
|
* @param {String} userId User ID
|
|
56869
57081
|
* @param {Array.<Object>} body Skill
|
|
@@ -56898,7 +57110,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56898
57110
|
/**
|
|
56899
57111
|
* SCIM service.
|
|
56900
57112
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
56901
|
-
* @version
|
|
57113
|
+
* @version 209.0.0
|
|
56902
57114
|
*/
|
|
56903
57115
|
|
|
56904
57116
|
/**
|
|
@@ -57775,7 +57987,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57775
57987
|
/**
|
|
57776
57988
|
* ScreenRecording service.
|
|
57777
57989
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
57778
|
-
* @version
|
|
57990
|
+
* @version 209.0.0
|
|
57779
57991
|
*/
|
|
57780
57992
|
|
|
57781
57993
|
/**
|
|
@@ -57820,7 +58032,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57820
58032
|
/**
|
|
57821
58033
|
* Scripts service.
|
|
57822
58034
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
57823
|
-
* @version
|
|
58035
|
+
* @version 209.0.0
|
|
57824
58036
|
*/
|
|
57825
58037
|
|
|
57826
58038
|
/**
|
|
@@ -58264,7 +58476,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58264
58476
|
/**
|
|
58265
58477
|
* Search service.
|
|
58266
58478
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
58267
|
-
* @version
|
|
58479
|
+
* @version 209.0.0
|
|
58268
58480
|
*/
|
|
58269
58481
|
|
|
58270
58482
|
/**
|
|
@@ -58447,6 +58659,35 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58447
58659
|
);
|
|
58448
58660
|
}
|
|
58449
58661
|
|
|
58662
|
+
/**
|
|
58663
|
+
* Search sites using the q64 value returned from a previous search
|
|
58664
|
+
*
|
|
58665
|
+
* @param {String} q64 q64
|
|
58666
|
+
* @param {Object} opts Optional parameters
|
|
58667
|
+
* @param {Array.<String>} opts.expand expand
|
|
58668
|
+
*/
|
|
58669
|
+
getTelephonyProvidersEdgesSitesSearch(q64, opts) {
|
|
58670
|
+
opts = opts || {};
|
|
58671
|
+
|
|
58672
|
+
// verify the required parameter 'q64' is set
|
|
58673
|
+
if (q64 === undefined || q64 === null) {
|
|
58674
|
+
throw 'Missing the required parameter "q64" when calling getTelephonyProvidersEdgesSitesSearch';
|
|
58675
|
+
}
|
|
58676
|
+
|
|
58677
|
+
return this.apiClient.callApi(
|
|
58678
|
+
'/api/v2/telephony/providers/edges/sites/search',
|
|
58679
|
+
'GET',
|
|
58680
|
+
{ },
|
|
58681
|
+
{ 'q64': q64,'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
58682
|
+
{ },
|
|
58683
|
+
{ },
|
|
58684
|
+
null,
|
|
58685
|
+
['PureCloud OAuth'],
|
|
58686
|
+
['application/json'],
|
|
58687
|
+
['application/json']
|
|
58688
|
+
);
|
|
58689
|
+
}
|
|
58690
|
+
|
|
58450
58691
|
/**
|
|
58451
58692
|
* Search users using the q64 value returned from a previous search
|
|
58452
58693
|
*
|
|
@@ -58820,6 +59061,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58820
59061
|
);
|
|
58821
59062
|
}
|
|
58822
59063
|
|
|
59064
|
+
/**
|
|
59065
|
+
* Search sites
|
|
59066
|
+
*
|
|
59067
|
+
* @param {Object} body Search request options
|
|
59068
|
+
*/
|
|
59069
|
+
postTelephonyProvidersEdgesSitesSearch(body) {
|
|
59070
|
+
// verify the required parameter 'body' is set
|
|
59071
|
+
if (body === undefined || body === null) {
|
|
59072
|
+
throw 'Missing the required parameter "body" when calling postTelephonyProvidersEdgesSitesSearch';
|
|
59073
|
+
}
|
|
59074
|
+
|
|
59075
|
+
return this.apiClient.callApi(
|
|
59076
|
+
'/api/v2/telephony/providers/edges/sites/search',
|
|
59077
|
+
'POST',
|
|
59078
|
+
{ },
|
|
59079
|
+
{ },
|
|
59080
|
+
{ },
|
|
59081
|
+
{ },
|
|
59082
|
+
body,
|
|
59083
|
+
['PureCloud OAuth'],
|
|
59084
|
+
['application/json'],
|
|
59085
|
+
['application/json']
|
|
59086
|
+
);
|
|
59087
|
+
}
|
|
59088
|
+
|
|
58823
59089
|
/**
|
|
58824
59090
|
* Search users
|
|
58825
59091
|
*
|
|
@@ -58953,7 +59219,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58953
59219
|
/**
|
|
58954
59220
|
* Settings service.
|
|
58955
59221
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
58956
|
-
* @version
|
|
59222
|
+
* @version 209.0.0
|
|
58957
59223
|
*/
|
|
58958
59224
|
|
|
58959
59225
|
/**
|
|
@@ -59169,11 +59435,916 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59169
59435
|
|
|
59170
59436
|
}
|
|
59171
59437
|
|
|
59438
|
+
class SocialMediaApi {
|
|
59439
|
+
/**
|
|
59440
|
+
* SocialMedia service.
|
|
59441
|
+
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
59442
|
+
* @version 209.0.0
|
|
59443
|
+
*/
|
|
59444
|
+
|
|
59445
|
+
/**
|
|
59446
|
+
* Constructs a new SocialMediaApi.
|
|
59447
|
+
* @alias module:purecloud-platform-client-v2/api/SocialMediaApi
|
|
59448
|
+
* @class
|
|
59449
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
59450
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
59451
|
+
*/
|
|
59452
|
+
constructor(apiClient) {
|
|
59453
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
59454
|
+
}
|
|
59455
|
+
|
|
59456
|
+
|
|
59457
|
+
/**
|
|
59458
|
+
* Delete a social topic.
|
|
59459
|
+
*
|
|
59460
|
+
* @param {String} topicId topicId
|
|
59461
|
+
* @param {Object} opts Optional parameters
|
|
59462
|
+
* @param {Boolean} opts.hardDelete Determines whether a Social topic should be soft-deleted or hard-deleted (permanently removed). Set to false (soft-delete) by default.
|
|
59463
|
+
* deleteSocialmediaTopic is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59464
|
+
*/
|
|
59465
|
+
deleteSocialmediaTopic(topicId, opts) {
|
|
59466
|
+
opts = opts || {};
|
|
59467
|
+
|
|
59468
|
+
// verify the required parameter 'topicId' is set
|
|
59469
|
+
if (topicId === undefined || topicId === null) {
|
|
59470
|
+
throw 'Missing the required parameter "topicId" when calling deleteSocialmediaTopic';
|
|
59471
|
+
}
|
|
59472
|
+
|
|
59473
|
+
return this.apiClient.callApi(
|
|
59474
|
+
'/api/v2/socialmedia/topics/{topicId}',
|
|
59475
|
+
'DELETE',
|
|
59476
|
+
{ 'topicId': topicId },
|
|
59477
|
+
{ 'hardDelete': opts['hardDelete'] },
|
|
59478
|
+
{ },
|
|
59479
|
+
{ },
|
|
59480
|
+
null,
|
|
59481
|
+
['PureCloud OAuth'],
|
|
59482
|
+
['application/json'],
|
|
59483
|
+
['application/json']
|
|
59484
|
+
);
|
|
59485
|
+
}
|
|
59486
|
+
|
|
59487
|
+
/**
|
|
59488
|
+
* Delete a Facebook data ingestion rule.
|
|
59489
|
+
*
|
|
59490
|
+
* @param {String} topicId topicId
|
|
59491
|
+
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
59492
|
+
* @param {Object} opts Optional parameters
|
|
59493
|
+
* @param {Boolean} opts.hardDelete Determines whether a Facebook 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)
|
|
59494
|
+
* deleteSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59495
|
+
*/
|
|
59496
|
+
deleteSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId, facebookIngestionRuleId, opts) {
|
|
59497
|
+
opts = opts || {};
|
|
59498
|
+
|
|
59499
|
+
// verify the required parameter 'topicId' is set
|
|
59500
|
+
if (topicId === undefined || topicId === null) {
|
|
59501
|
+
throw 'Missing the required parameter "topicId" when calling deleteSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';
|
|
59502
|
+
}
|
|
59503
|
+
// verify the required parameter 'facebookIngestionRuleId' is set
|
|
59504
|
+
if (facebookIngestionRuleId === undefined || facebookIngestionRuleId === null) {
|
|
59505
|
+
throw 'Missing the required parameter "facebookIngestionRuleId" when calling deleteSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';
|
|
59506
|
+
}
|
|
59507
|
+
|
|
59508
|
+
return this.apiClient.callApi(
|
|
59509
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}',
|
|
59510
|
+
'DELETE',
|
|
59511
|
+
{ 'topicId': topicId,'facebookIngestionRuleId': facebookIngestionRuleId },
|
|
59512
|
+
{ 'hardDelete': opts['hardDelete'] },
|
|
59513
|
+
{ },
|
|
59514
|
+
{ },
|
|
59515
|
+
null,
|
|
59516
|
+
['PureCloud OAuth'],
|
|
59517
|
+
['application/json'],
|
|
59518
|
+
['application/json']
|
|
59519
|
+
);
|
|
59520
|
+
}
|
|
59521
|
+
|
|
59522
|
+
/**
|
|
59523
|
+
* Delete a open data ingestion rule.
|
|
59524
|
+
*
|
|
59525
|
+
* @param {String} topicId topicId
|
|
59526
|
+
* @param {String} openId openId
|
|
59527
|
+
* @param {Object} opts Optional parameters
|
|
59528
|
+
* @param {Boolean} opts.hardDelete Determines whether a open 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)
|
|
59529
|
+
* deleteSocialmediaTopicDataingestionrulesOpenOpenId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59530
|
+
*/
|
|
59531
|
+
deleteSocialmediaTopicDataingestionrulesOpenOpenId(topicId, openId, opts) {
|
|
59532
|
+
opts = opts || {};
|
|
59533
|
+
|
|
59534
|
+
// verify the required parameter 'topicId' is set
|
|
59535
|
+
if (topicId === undefined || topicId === null) {
|
|
59536
|
+
throw 'Missing the required parameter "topicId" when calling deleteSocialmediaTopicDataingestionrulesOpenOpenId';
|
|
59537
|
+
}
|
|
59538
|
+
// verify the required parameter 'openId' is set
|
|
59539
|
+
if (openId === undefined || openId === null) {
|
|
59540
|
+
throw 'Missing the required parameter "openId" when calling deleteSocialmediaTopicDataingestionrulesOpenOpenId';
|
|
59541
|
+
}
|
|
59542
|
+
|
|
59543
|
+
return this.apiClient.callApi(
|
|
59544
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}',
|
|
59545
|
+
'DELETE',
|
|
59546
|
+
{ 'topicId': topicId,'openId': openId },
|
|
59547
|
+
{ 'hardDelete': opts['hardDelete'] },
|
|
59548
|
+
{ },
|
|
59549
|
+
{ },
|
|
59550
|
+
null,
|
|
59551
|
+
['PureCloud OAuth'],
|
|
59552
|
+
['application/json'],
|
|
59553
|
+
['application/json']
|
|
59554
|
+
);
|
|
59555
|
+
}
|
|
59556
|
+
|
|
59557
|
+
/**
|
|
59558
|
+
* Delete a X (formally Twitter) data ingestion rule.
|
|
59559
|
+
*
|
|
59560
|
+
* @param {String} topicId topicId
|
|
59561
|
+
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
59562
|
+
* @param {Object} opts Optional parameters
|
|
59563
|
+
* @param {Boolean} opts.hardDelete Determines whether a X (formally Twitter) 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)
|
|
59564
|
+
* deleteSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59565
|
+
*/
|
|
59566
|
+
deleteSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId, twitterIngestionRuleId, opts) {
|
|
59567
|
+
opts = opts || {};
|
|
59568
|
+
|
|
59569
|
+
// verify the required parameter 'topicId' is set
|
|
59570
|
+
if (topicId === undefined || topicId === null) {
|
|
59571
|
+
throw 'Missing the required parameter "topicId" when calling deleteSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';
|
|
59572
|
+
}
|
|
59573
|
+
// verify the required parameter 'twitterIngestionRuleId' is set
|
|
59574
|
+
if (twitterIngestionRuleId === undefined || twitterIngestionRuleId === null) {
|
|
59575
|
+
throw 'Missing the required parameter "twitterIngestionRuleId" when calling deleteSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';
|
|
59576
|
+
}
|
|
59577
|
+
|
|
59578
|
+
return this.apiClient.callApi(
|
|
59579
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}',
|
|
59580
|
+
'DELETE',
|
|
59581
|
+
{ 'topicId': topicId,'twitterIngestionRuleId': twitterIngestionRuleId },
|
|
59582
|
+
{ 'hardDelete': opts['hardDelete'] },
|
|
59583
|
+
{ },
|
|
59584
|
+
{ },
|
|
59585
|
+
null,
|
|
59586
|
+
['PureCloud OAuth'],
|
|
59587
|
+
['application/json'],
|
|
59588
|
+
['application/json']
|
|
59589
|
+
);
|
|
59590
|
+
}
|
|
59591
|
+
|
|
59592
|
+
/**
|
|
59593
|
+
* Get a single social topic.
|
|
59594
|
+
*
|
|
59595
|
+
* @param {String} topicId topicId
|
|
59596
|
+
* @param {Object} opts Optional parameters
|
|
59597
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
59598
|
+
* getSocialmediaTopic is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59599
|
+
*/
|
|
59600
|
+
getSocialmediaTopic(topicId, opts) {
|
|
59601
|
+
opts = opts || {};
|
|
59602
|
+
|
|
59603
|
+
// verify the required parameter 'topicId' is set
|
|
59604
|
+
if (topicId === undefined || topicId === null) {
|
|
59605
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopic';
|
|
59606
|
+
}
|
|
59607
|
+
|
|
59608
|
+
return this.apiClient.callApi(
|
|
59609
|
+
'/api/v2/socialmedia/topics/{topicId}',
|
|
59610
|
+
'GET',
|
|
59611
|
+
{ 'topicId': topicId },
|
|
59612
|
+
{ 'includeDeleted': opts['includeDeleted'] },
|
|
59613
|
+
{ },
|
|
59614
|
+
{ },
|
|
59615
|
+
null,
|
|
59616
|
+
['PureCloud OAuth'],
|
|
59617
|
+
['application/json'],
|
|
59618
|
+
['application/json']
|
|
59619
|
+
);
|
|
59620
|
+
}
|
|
59621
|
+
|
|
59622
|
+
/**
|
|
59623
|
+
* Get a single Facebook data ingestion rule.
|
|
59624
|
+
*
|
|
59625
|
+
* @param {String} topicId topicId
|
|
59626
|
+
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
59627
|
+
* @param {Object} opts Optional parameters
|
|
59628
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
59629
|
+
* getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59630
|
+
*/
|
|
59631
|
+
getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId, facebookIngestionRuleId, opts) {
|
|
59632
|
+
opts = opts || {};
|
|
59633
|
+
|
|
59634
|
+
// verify the required parameter 'topicId' is set
|
|
59635
|
+
if (topicId === undefined || topicId === null) {
|
|
59636
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';
|
|
59637
|
+
}
|
|
59638
|
+
// verify the required parameter 'facebookIngestionRuleId' is set
|
|
59639
|
+
if (facebookIngestionRuleId === undefined || facebookIngestionRuleId === null) {
|
|
59640
|
+
throw 'Missing the required parameter "facebookIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';
|
|
59641
|
+
}
|
|
59642
|
+
|
|
59643
|
+
return this.apiClient.callApi(
|
|
59644
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}',
|
|
59645
|
+
'GET',
|
|
59646
|
+
{ 'topicId': topicId,'facebookIngestionRuleId': facebookIngestionRuleId },
|
|
59647
|
+
{ 'includeDeleted': opts['includeDeleted'] },
|
|
59648
|
+
{ },
|
|
59649
|
+
{ },
|
|
59650
|
+
null,
|
|
59651
|
+
['PureCloud OAuth'],
|
|
59652
|
+
['application/json'],
|
|
59653
|
+
['application/json']
|
|
59654
|
+
);
|
|
59655
|
+
}
|
|
59656
|
+
|
|
59657
|
+
/**
|
|
59658
|
+
* Get a single Facebook data ingestion rule version.
|
|
59659
|
+
*
|
|
59660
|
+
* @param {String} topicId topicId
|
|
59661
|
+
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
59662
|
+
* @param {String} dataIngestionRuleVersion version
|
|
59663
|
+
* @param {Object} opts Optional parameters
|
|
59664
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted item in the result.
|
|
59665
|
+
* getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59666
|
+
*/
|
|
59667
|
+
getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion(topicId, facebookIngestionRuleId, dataIngestionRuleVersion, opts) {
|
|
59668
|
+
opts = opts || {};
|
|
59669
|
+
|
|
59670
|
+
// verify the required parameter 'topicId' is set
|
|
59671
|
+
if (topicId === undefined || topicId === null) {
|
|
59672
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion';
|
|
59673
|
+
}
|
|
59674
|
+
// verify the required parameter 'facebookIngestionRuleId' is set
|
|
59675
|
+
if (facebookIngestionRuleId === undefined || facebookIngestionRuleId === null) {
|
|
59676
|
+
throw 'Missing the required parameter "facebookIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion';
|
|
59677
|
+
}
|
|
59678
|
+
// verify the required parameter 'dataIngestionRuleVersion' is set
|
|
59679
|
+
if (dataIngestionRuleVersion === undefined || dataIngestionRuleVersion === null) {
|
|
59680
|
+
throw 'Missing the required parameter "dataIngestionRuleVersion" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion';
|
|
59681
|
+
}
|
|
59682
|
+
|
|
59683
|
+
return this.apiClient.callApi(
|
|
59684
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}/versions/{dataIngestionRuleVersion}',
|
|
59685
|
+
'GET',
|
|
59686
|
+
{ 'topicId': topicId,'facebookIngestionRuleId': facebookIngestionRuleId,'dataIngestionRuleVersion': dataIngestionRuleVersion },
|
|
59687
|
+
{ 'includeDeleted': opts['includeDeleted'] },
|
|
59688
|
+
{ },
|
|
59689
|
+
{ },
|
|
59690
|
+
null,
|
|
59691
|
+
['PureCloud OAuth'],
|
|
59692
|
+
['application/json'],
|
|
59693
|
+
['application/json']
|
|
59694
|
+
);
|
|
59695
|
+
}
|
|
59696
|
+
|
|
59697
|
+
/**
|
|
59698
|
+
* Get the Facebook data ingestion rule versions.
|
|
59699
|
+
*
|
|
59700
|
+
* @param {String} topicId topicId
|
|
59701
|
+
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
59702
|
+
* @param {Object} opts Optional parameters
|
|
59703
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
59704
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
59705
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
59706
|
+
* getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59707
|
+
*/
|
|
59708
|
+
getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersions(topicId, facebookIngestionRuleId, opts) {
|
|
59709
|
+
opts = opts || {};
|
|
59710
|
+
|
|
59711
|
+
// verify the required parameter 'topicId' is set
|
|
59712
|
+
if (topicId === undefined || topicId === null) {
|
|
59713
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersions';
|
|
59714
|
+
}
|
|
59715
|
+
// verify the required parameter 'facebookIngestionRuleId' is set
|
|
59716
|
+
if (facebookIngestionRuleId === undefined || facebookIngestionRuleId === null) {
|
|
59717
|
+
throw 'Missing the required parameter "facebookIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersions';
|
|
59718
|
+
}
|
|
59719
|
+
|
|
59720
|
+
return this.apiClient.callApi(
|
|
59721
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}/versions',
|
|
59722
|
+
'GET',
|
|
59723
|
+
{ 'topicId': topicId,'facebookIngestionRuleId': facebookIngestionRuleId },
|
|
59724
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'includeDeleted': opts['includeDeleted'] },
|
|
59725
|
+
{ },
|
|
59726
|
+
{ },
|
|
59727
|
+
null,
|
|
59728
|
+
['PureCloud OAuth'],
|
|
59729
|
+
['application/json'],
|
|
59730
|
+
['application/json']
|
|
59731
|
+
);
|
|
59732
|
+
}
|
|
59733
|
+
|
|
59734
|
+
/**
|
|
59735
|
+
* Get a single open data ingestion rule.
|
|
59736
|
+
*
|
|
59737
|
+
* @param {String} topicId topicId
|
|
59738
|
+
* @param {String} openId openId
|
|
59739
|
+
* @param {Object} opts Optional parameters
|
|
59740
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
59741
|
+
* getSocialmediaTopicDataingestionrulesOpenOpenId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59742
|
+
*/
|
|
59743
|
+
getSocialmediaTopicDataingestionrulesOpenOpenId(topicId, openId, opts) {
|
|
59744
|
+
opts = opts || {};
|
|
59745
|
+
|
|
59746
|
+
// verify the required parameter 'topicId' is set
|
|
59747
|
+
if (topicId === undefined || topicId === null) {
|
|
59748
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesOpenOpenId';
|
|
59749
|
+
}
|
|
59750
|
+
// verify the required parameter 'openId' is set
|
|
59751
|
+
if (openId === undefined || openId === null) {
|
|
59752
|
+
throw 'Missing the required parameter "openId" when calling getSocialmediaTopicDataingestionrulesOpenOpenId';
|
|
59753
|
+
}
|
|
59754
|
+
|
|
59755
|
+
return this.apiClient.callApi(
|
|
59756
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}',
|
|
59757
|
+
'GET',
|
|
59758
|
+
{ 'topicId': topicId,'openId': openId },
|
|
59759
|
+
{ 'includeDeleted': opts['includeDeleted'] },
|
|
59760
|
+
{ },
|
|
59761
|
+
{ },
|
|
59762
|
+
null,
|
|
59763
|
+
['PureCloud OAuth'],
|
|
59764
|
+
['application/json'],
|
|
59765
|
+
['application/json']
|
|
59766
|
+
);
|
|
59767
|
+
}
|
|
59768
|
+
|
|
59769
|
+
/**
|
|
59770
|
+
* Get a single Open data ingestion rule version.
|
|
59771
|
+
*
|
|
59772
|
+
* @param {String} topicId topicId
|
|
59773
|
+
* @param {String} openId openId
|
|
59774
|
+
* @param {String} dataIngestionRuleVersion version
|
|
59775
|
+
* @param {Object} opts Optional parameters
|
|
59776
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted item in the result.
|
|
59777
|
+
* getSocialmediaTopicDataingestionrulesOpenOpenIdVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59778
|
+
*/
|
|
59779
|
+
getSocialmediaTopicDataingestionrulesOpenOpenIdVersion(topicId, openId, dataIngestionRuleVersion, opts) {
|
|
59780
|
+
opts = opts || {};
|
|
59781
|
+
|
|
59782
|
+
// verify the required parameter 'topicId' is set
|
|
59783
|
+
if (topicId === undefined || topicId === null) {
|
|
59784
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesOpenOpenIdVersion';
|
|
59785
|
+
}
|
|
59786
|
+
// verify the required parameter 'openId' is set
|
|
59787
|
+
if (openId === undefined || openId === null) {
|
|
59788
|
+
throw 'Missing the required parameter "openId" when calling getSocialmediaTopicDataingestionrulesOpenOpenIdVersion';
|
|
59789
|
+
}
|
|
59790
|
+
// verify the required parameter 'dataIngestionRuleVersion' is set
|
|
59791
|
+
if (dataIngestionRuleVersion === undefined || dataIngestionRuleVersion === null) {
|
|
59792
|
+
throw 'Missing the required parameter "dataIngestionRuleVersion" when calling getSocialmediaTopicDataingestionrulesOpenOpenIdVersion';
|
|
59793
|
+
}
|
|
59794
|
+
|
|
59795
|
+
return this.apiClient.callApi(
|
|
59796
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}/versions/{dataIngestionRuleVersion}',
|
|
59797
|
+
'GET',
|
|
59798
|
+
{ 'topicId': topicId,'openId': openId,'dataIngestionRuleVersion': dataIngestionRuleVersion },
|
|
59799
|
+
{ 'includeDeleted': opts['includeDeleted'] },
|
|
59800
|
+
{ },
|
|
59801
|
+
{ },
|
|
59802
|
+
null,
|
|
59803
|
+
['PureCloud OAuth'],
|
|
59804
|
+
['application/json'],
|
|
59805
|
+
['application/json']
|
|
59806
|
+
);
|
|
59807
|
+
}
|
|
59808
|
+
|
|
59809
|
+
/**
|
|
59810
|
+
* Get the Open data ingestion rule versions.
|
|
59811
|
+
*
|
|
59812
|
+
* @param {String} topicId topicId
|
|
59813
|
+
* @param {String} openId openId
|
|
59814
|
+
* @param {Object} opts Optional parameters
|
|
59815
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
59816
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
59817
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
59818
|
+
* getSocialmediaTopicDataingestionrulesOpenOpenIdVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59819
|
+
*/
|
|
59820
|
+
getSocialmediaTopicDataingestionrulesOpenOpenIdVersions(topicId, openId, opts) {
|
|
59821
|
+
opts = opts || {};
|
|
59822
|
+
|
|
59823
|
+
// verify the required parameter 'topicId' is set
|
|
59824
|
+
if (topicId === undefined || topicId === null) {
|
|
59825
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesOpenOpenIdVersions';
|
|
59826
|
+
}
|
|
59827
|
+
// verify the required parameter 'openId' is set
|
|
59828
|
+
if (openId === undefined || openId === null) {
|
|
59829
|
+
throw 'Missing the required parameter "openId" when calling getSocialmediaTopicDataingestionrulesOpenOpenIdVersions';
|
|
59830
|
+
}
|
|
59831
|
+
|
|
59832
|
+
return this.apiClient.callApi(
|
|
59833
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}/versions',
|
|
59834
|
+
'GET',
|
|
59835
|
+
{ 'topicId': topicId,'openId': openId },
|
|
59836
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'includeDeleted': opts['includeDeleted'] },
|
|
59837
|
+
{ },
|
|
59838
|
+
{ },
|
|
59839
|
+
null,
|
|
59840
|
+
['PureCloud OAuth'],
|
|
59841
|
+
['application/json'],
|
|
59842
|
+
['application/json']
|
|
59843
|
+
);
|
|
59844
|
+
}
|
|
59845
|
+
|
|
59846
|
+
/**
|
|
59847
|
+
* Get a single X (formally Twitter) data ingestion rule.
|
|
59848
|
+
*
|
|
59849
|
+
* @param {String} topicId topicId
|
|
59850
|
+
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
59851
|
+
* @param {Object} opts Optional parameters
|
|
59852
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
59853
|
+
* getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59854
|
+
*/
|
|
59855
|
+
getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId, twitterIngestionRuleId, opts) {
|
|
59856
|
+
opts = opts || {};
|
|
59857
|
+
|
|
59858
|
+
// verify the required parameter 'topicId' is set
|
|
59859
|
+
if (topicId === undefined || topicId === null) {
|
|
59860
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';
|
|
59861
|
+
}
|
|
59862
|
+
// verify the required parameter 'twitterIngestionRuleId' is set
|
|
59863
|
+
if (twitterIngestionRuleId === undefined || twitterIngestionRuleId === null) {
|
|
59864
|
+
throw 'Missing the required parameter "twitterIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';
|
|
59865
|
+
}
|
|
59866
|
+
|
|
59867
|
+
return this.apiClient.callApi(
|
|
59868
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}',
|
|
59869
|
+
'GET',
|
|
59870
|
+
{ 'topicId': topicId,'twitterIngestionRuleId': twitterIngestionRuleId },
|
|
59871
|
+
{ 'includeDeleted': opts['includeDeleted'] },
|
|
59872
|
+
{ },
|
|
59873
|
+
{ },
|
|
59874
|
+
null,
|
|
59875
|
+
['PureCloud OAuth'],
|
|
59876
|
+
['application/json'],
|
|
59877
|
+
['application/json']
|
|
59878
|
+
);
|
|
59879
|
+
}
|
|
59880
|
+
|
|
59881
|
+
/**
|
|
59882
|
+
* Get a single X (formally Twitter) data ingestion rule version.
|
|
59883
|
+
*
|
|
59884
|
+
* @param {String} topicId topicId
|
|
59885
|
+
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
59886
|
+
* @param {String} dataIngestionRuleVersion version
|
|
59887
|
+
* @param {Object} opts Optional parameters
|
|
59888
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted item in the result.
|
|
59889
|
+
* getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59890
|
+
*/
|
|
59891
|
+
getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion(topicId, twitterIngestionRuleId, dataIngestionRuleVersion, opts) {
|
|
59892
|
+
opts = opts || {};
|
|
59893
|
+
|
|
59894
|
+
// verify the required parameter 'topicId' is set
|
|
59895
|
+
if (topicId === undefined || topicId === null) {
|
|
59896
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion';
|
|
59897
|
+
}
|
|
59898
|
+
// verify the required parameter 'twitterIngestionRuleId' is set
|
|
59899
|
+
if (twitterIngestionRuleId === undefined || twitterIngestionRuleId === null) {
|
|
59900
|
+
throw 'Missing the required parameter "twitterIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion';
|
|
59901
|
+
}
|
|
59902
|
+
// verify the required parameter 'dataIngestionRuleVersion' is set
|
|
59903
|
+
if (dataIngestionRuleVersion === undefined || dataIngestionRuleVersion === null) {
|
|
59904
|
+
throw 'Missing the required parameter "dataIngestionRuleVersion" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion';
|
|
59905
|
+
}
|
|
59906
|
+
|
|
59907
|
+
return this.apiClient.callApi(
|
|
59908
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}/versions/{dataIngestionRuleVersion}',
|
|
59909
|
+
'GET',
|
|
59910
|
+
{ 'topicId': topicId,'twitterIngestionRuleId': twitterIngestionRuleId,'dataIngestionRuleVersion': dataIngestionRuleVersion },
|
|
59911
|
+
{ 'includeDeleted': opts['includeDeleted'] },
|
|
59912
|
+
{ },
|
|
59913
|
+
{ },
|
|
59914
|
+
null,
|
|
59915
|
+
['PureCloud OAuth'],
|
|
59916
|
+
['application/json'],
|
|
59917
|
+
['application/json']
|
|
59918
|
+
);
|
|
59919
|
+
}
|
|
59920
|
+
|
|
59921
|
+
/**
|
|
59922
|
+
* Get the Open data ingestion rule versions.
|
|
59923
|
+
*
|
|
59924
|
+
* @param {String} topicId topicId
|
|
59925
|
+
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
59926
|
+
* @param {Object} opts Optional parameters
|
|
59927
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
59928
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
59929
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
59930
|
+
* getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59931
|
+
*/
|
|
59932
|
+
getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersions(topicId, twitterIngestionRuleId, opts) {
|
|
59933
|
+
opts = opts || {};
|
|
59934
|
+
|
|
59935
|
+
// verify the required parameter 'topicId' is set
|
|
59936
|
+
if (topicId === undefined || topicId === null) {
|
|
59937
|
+
throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersions';
|
|
59938
|
+
}
|
|
59939
|
+
// verify the required parameter 'twitterIngestionRuleId' is set
|
|
59940
|
+
if (twitterIngestionRuleId === undefined || twitterIngestionRuleId === null) {
|
|
59941
|
+
throw 'Missing the required parameter "twitterIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersions';
|
|
59942
|
+
}
|
|
59943
|
+
|
|
59944
|
+
return this.apiClient.callApi(
|
|
59945
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}/versions',
|
|
59946
|
+
'GET',
|
|
59947
|
+
{ 'topicId': topicId,'twitterIngestionRuleId': twitterIngestionRuleId },
|
|
59948
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'includeDeleted': opts['includeDeleted'] },
|
|
59949
|
+
{ },
|
|
59950
|
+
{ },
|
|
59951
|
+
null,
|
|
59952
|
+
['PureCloud OAuth'],
|
|
59953
|
+
['application/json'],
|
|
59954
|
+
['application/json']
|
|
59955
|
+
);
|
|
59956
|
+
}
|
|
59957
|
+
|
|
59958
|
+
/**
|
|
59959
|
+
* Retrieve all social topics.
|
|
59960
|
+
*
|
|
59961
|
+
* @param {Object} opts Optional parameters
|
|
59962
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
59963
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
59964
|
+
* @param {Array.<String>} opts.divisionIds One or more division IDs. If nothing is provided, the social topics associated withthe list of divisions that the user has access to will be returned.
|
|
59965
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
59966
|
+
* getSocialmediaTopics is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59967
|
+
*/
|
|
59968
|
+
getSocialmediaTopics(opts) {
|
|
59969
|
+
opts = opts || {};
|
|
59970
|
+
|
|
59971
|
+
|
|
59972
|
+
return this.apiClient.callApi(
|
|
59973
|
+
'/api/v2/socialmedia/topics',
|
|
59974
|
+
'GET',
|
|
59975
|
+
{ },
|
|
59976
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'divisionIds': this.apiClient.buildCollectionParam(opts['divisionIds'], 'multi'),'includeDeleted': opts['includeDeleted'] },
|
|
59977
|
+
{ },
|
|
59978
|
+
{ },
|
|
59979
|
+
null,
|
|
59980
|
+
['PureCloud OAuth'],
|
|
59981
|
+
['application/json'],
|
|
59982
|
+
['application/json']
|
|
59983
|
+
);
|
|
59984
|
+
}
|
|
59985
|
+
|
|
59986
|
+
/**
|
|
59987
|
+
* Update a social topic.
|
|
59988
|
+
*
|
|
59989
|
+
* @param {String} topicId topicId
|
|
59990
|
+
* @param {Object} opts Optional parameters
|
|
59991
|
+
* @param {Object} opts.body
|
|
59992
|
+
* patchSocialmediaTopic is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59993
|
+
*/
|
|
59994
|
+
patchSocialmediaTopic(topicId, opts) {
|
|
59995
|
+
opts = opts || {};
|
|
59996
|
+
|
|
59997
|
+
// verify the required parameter 'topicId' is set
|
|
59998
|
+
if (topicId === undefined || topicId === null) {
|
|
59999
|
+
throw 'Missing the required parameter "topicId" when calling patchSocialmediaTopic';
|
|
60000
|
+
}
|
|
60001
|
+
|
|
60002
|
+
return this.apiClient.callApi(
|
|
60003
|
+
'/api/v2/socialmedia/topics/{topicId}',
|
|
60004
|
+
'PATCH',
|
|
60005
|
+
{ 'topicId': topicId },
|
|
60006
|
+
{ },
|
|
60007
|
+
{ },
|
|
60008
|
+
{ },
|
|
60009
|
+
opts['body'],
|
|
60010
|
+
['PureCloud OAuth'],
|
|
60011
|
+
['application/json'],
|
|
60012
|
+
['application/json']
|
|
60013
|
+
);
|
|
60014
|
+
}
|
|
60015
|
+
|
|
60016
|
+
/**
|
|
60017
|
+
* Update the status of a Facebook data ingestion rule.
|
|
60018
|
+
*
|
|
60019
|
+
* @param {String} topicId topicId
|
|
60020
|
+
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
60021
|
+
* @param {Object} opts Optional parameters
|
|
60022
|
+
* @param {Object} opts.body
|
|
60023
|
+
* patchSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60024
|
+
*/
|
|
60025
|
+
patchSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId, facebookIngestionRuleId, opts) {
|
|
60026
|
+
opts = opts || {};
|
|
60027
|
+
|
|
60028
|
+
// verify the required parameter 'topicId' is set
|
|
60029
|
+
if (topicId === undefined || topicId === null) {
|
|
60030
|
+
throw 'Missing the required parameter "topicId" when calling patchSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';
|
|
60031
|
+
}
|
|
60032
|
+
// verify the required parameter 'facebookIngestionRuleId' is set
|
|
60033
|
+
if (facebookIngestionRuleId === undefined || facebookIngestionRuleId === null) {
|
|
60034
|
+
throw 'Missing the required parameter "facebookIngestionRuleId" when calling patchSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';
|
|
60035
|
+
}
|
|
60036
|
+
|
|
60037
|
+
return this.apiClient.callApi(
|
|
60038
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}',
|
|
60039
|
+
'PATCH',
|
|
60040
|
+
{ 'topicId': topicId,'facebookIngestionRuleId': facebookIngestionRuleId },
|
|
60041
|
+
{ },
|
|
60042
|
+
{ },
|
|
60043
|
+
{ },
|
|
60044
|
+
opts['body'],
|
|
60045
|
+
['PureCloud OAuth'],
|
|
60046
|
+
['application/json'],
|
|
60047
|
+
['application/json']
|
|
60048
|
+
);
|
|
60049
|
+
}
|
|
60050
|
+
|
|
60051
|
+
/**
|
|
60052
|
+
* Update the status of a open data ingestion rule.
|
|
60053
|
+
*
|
|
60054
|
+
* @param {String} topicId topicId
|
|
60055
|
+
* @param {String} openId openId
|
|
60056
|
+
* @param {Object} opts Optional parameters
|
|
60057
|
+
* @param {Object} opts.body
|
|
60058
|
+
* patchSocialmediaTopicDataingestionrulesOpenOpenId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60059
|
+
*/
|
|
60060
|
+
patchSocialmediaTopicDataingestionrulesOpenOpenId(topicId, openId, opts) {
|
|
60061
|
+
opts = opts || {};
|
|
60062
|
+
|
|
60063
|
+
// verify the required parameter 'topicId' is set
|
|
60064
|
+
if (topicId === undefined || topicId === null) {
|
|
60065
|
+
throw 'Missing the required parameter "topicId" when calling patchSocialmediaTopicDataingestionrulesOpenOpenId';
|
|
60066
|
+
}
|
|
60067
|
+
// verify the required parameter 'openId' is set
|
|
60068
|
+
if (openId === undefined || openId === null) {
|
|
60069
|
+
throw 'Missing the required parameter "openId" when calling patchSocialmediaTopicDataingestionrulesOpenOpenId';
|
|
60070
|
+
}
|
|
60071
|
+
|
|
60072
|
+
return this.apiClient.callApi(
|
|
60073
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}',
|
|
60074
|
+
'PATCH',
|
|
60075
|
+
{ 'topicId': topicId,'openId': openId },
|
|
60076
|
+
{ },
|
|
60077
|
+
{ },
|
|
60078
|
+
{ },
|
|
60079
|
+
opts['body'],
|
|
60080
|
+
['PureCloud OAuth'],
|
|
60081
|
+
['application/json'],
|
|
60082
|
+
['application/json']
|
|
60083
|
+
);
|
|
60084
|
+
}
|
|
60085
|
+
|
|
60086
|
+
/**
|
|
60087
|
+
* Update the status of a X (formally Twitter) data ingestion rule.
|
|
60088
|
+
*
|
|
60089
|
+
* @param {String} topicId topicId
|
|
60090
|
+
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
60091
|
+
* @param {Object} opts Optional parameters
|
|
60092
|
+
* @param {Object} opts.body
|
|
60093
|
+
* patchSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60094
|
+
*/
|
|
60095
|
+
patchSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId, twitterIngestionRuleId, opts) {
|
|
60096
|
+
opts = opts || {};
|
|
60097
|
+
|
|
60098
|
+
// verify the required parameter 'topicId' is set
|
|
60099
|
+
if (topicId === undefined || topicId === null) {
|
|
60100
|
+
throw 'Missing the required parameter "topicId" when calling patchSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';
|
|
60101
|
+
}
|
|
60102
|
+
// verify the required parameter 'twitterIngestionRuleId' is set
|
|
60103
|
+
if (twitterIngestionRuleId === undefined || twitterIngestionRuleId === null) {
|
|
60104
|
+
throw 'Missing the required parameter "twitterIngestionRuleId" when calling patchSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';
|
|
60105
|
+
}
|
|
60106
|
+
|
|
60107
|
+
return this.apiClient.callApi(
|
|
60108
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}',
|
|
60109
|
+
'PATCH',
|
|
60110
|
+
{ 'topicId': topicId,'twitterIngestionRuleId': twitterIngestionRuleId },
|
|
60111
|
+
{ },
|
|
60112
|
+
{ },
|
|
60113
|
+
{ },
|
|
60114
|
+
opts['body'],
|
|
60115
|
+
['PureCloud OAuth'],
|
|
60116
|
+
['application/json'],
|
|
60117
|
+
['application/json']
|
|
60118
|
+
);
|
|
60119
|
+
}
|
|
60120
|
+
|
|
60121
|
+
/**
|
|
60122
|
+
* Create an Facebook data ingestion rule.
|
|
60123
|
+
*
|
|
60124
|
+
* @param {String} topicId topicId
|
|
60125
|
+
* @param {Object} opts Optional parameters
|
|
60126
|
+
* @param {Object} opts.body
|
|
60127
|
+
* postSocialmediaTopicDataingestionrulesFacebook is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60128
|
+
*/
|
|
60129
|
+
postSocialmediaTopicDataingestionrulesFacebook(topicId, opts) {
|
|
60130
|
+
opts = opts || {};
|
|
60131
|
+
|
|
60132
|
+
// verify the required parameter 'topicId' is set
|
|
60133
|
+
if (topicId === undefined || topicId === null) {
|
|
60134
|
+
throw 'Missing the required parameter "topicId" when calling postSocialmediaTopicDataingestionrulesFacebook';
|
|
60135
|
+
}
|
|
60136
|
+
|
|
60137
|
+
return this.apiClient.callApi(
|
|
60138
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook',
|
|
60139
|
+
'POST',
|
|
60140
|
+
{ 'topicId': topicId },
|
|
60141
|
+
{ },
|
|
60142
|
+
{ },
|
|
60143
|
+
{ },
|
|
60144
|
+
opts['body'],
|
|
60145
|
+
['PureCloud OAuth'],
|
|
60146
|
+
['application/json'],
|
|
60147
|
+
['application/json']
|
|
60148
|
+
);
|
|
60149
|
+
}
|
|
60150
|
+
|
|
60151
|
+
/**
|
|
60152
|
+
* Create an open data ingestion rule.
|
|
60153
|
+
*
|
|
60154
|
+
* @param {String} topicId topicId
|
|
60155
|
+
* @param {Object} opts Optional parameters
|
|
60156
|
+
* @param {Object} opts.body
|
|
60157
|
+
* postSocialmediaTopicDataingestionrulesOpen is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60158
|
+
*/
|
|
60159
|
+
postSocialmediaTopicDataingestionrulesOpen(topicId, opts) {
|
|
60160
|
+
opts = opts || {};
|
|
60161
|
+
|
|
60162
|
+
// verify the required parameter 'topicId' is set
|
|
60163
|
+
if (topicId === undefined || topicId === null) {
|
|
60164
|
+
throw 'Missing the required parameter "topicId" when calling postSocialmediaTopicDataingestionrulesOpen';
|
|
60165
|
+
}
|
|
60166
|
+
|
|
60167
|
+
return this.apiClient.callApi(
|
|
60168
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open',
|
|
60169
|
+
'POST',
|
|
60170
|
+
{ 'topicId': topicId },
|
|
60171
|
+
{ },
|
|
60172
|
+
{ },
|
|
60173
|
+
{ },
|
|
60174
|
+
opts['body'],
|
|
60175
|
+
['PureCloud OAuth'],
|
|
60176
|
+
['application/json'],
|
|
60177
|
+
['application/json']
|
|
60178
|
+
);
|
|
60179
|
+
}
|
|
60180
|
+
|
|
60181
|
+
/**
|
|
60182
|
+
* Create an twitter data ingestion rule.
|
|
60183
|
+
*
|
|
60184
|
+
* @param {String} topicId topicId
|
|
60185
|
+
* @param {Object} opts Optional parameters
|
|
60186
|
+
* @param {Object} opts.body
|
|
60187
|
+
* postSocialmediaTopicDataingestionrulesTwitter is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60188
|
+
*/
|
|
60189
|
+
postSocialmediaTopicDataingestionrulesTwitter(topicId, opts) {
|
|
60190
|
+
opts = opts || {};
|
|
60191
|
+
|
|
60192
|
+
// verify the required parameter 'topicId' is set
|
|
60193
|
+
if (topicId === undefined || topicId === null) {
|
|
60194
|
+
throw 'Missing the required parameter "topicId" when calling postSocialmediaTopicDataingestionrulesTwitter';
|
|
60195
|
+
}
|
|
60196
|
+
|
|
60197
|
+
return this.apiClient.callApi(
|
|
60198
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter',
|
|
60199
|
+
'POST',
|
|
60200
|
+
{ 'topicId': topicId },
|
|
60201
|
+
{ },
|
|
60202
|
+
{ },
|
|
60203
|
+
{ },
|
|
60204
|
+
opts['body'],
|
|
60205
|
+
['PureCloud OAuth'],
|
|
60206
|
+
['application/json'],
|
|
60207
|
+
['application/json']
|
|
60208
|
+
);
|
|
60209
|
+
}
|
|
60210
|
+
|
|
60211
|
+
/**
|
|
60212
|
+
* Create a social topic.
|
|
60213
|
+
*
|
|
60214
|
+
* @param {Object} opts Optional parameters
|
|
60215
|
+
* @param {Object} opts.body
|
|
60216
|
+
* postSocialmediaTopics is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60217
|
+
*/
|
|
60218
|
+
postSocialmediaTopics(opts) {
|
|
60219
|
+
opts = opts || {};
|
|
60220
|
+
|
|
60221
|
+
|
|
60222
|
+
return this.apiClient.callApi(
|
|
60223
|
+
'/api/v2/socialmedia/topics',
|
|
60224
|
+
'POST',
|
|
60225
|
+
{ },
|
|
60226
|
+
{ },
|
|
60227
|
+
{ },
|
|
60228
|
+
{ },
|
|
60229
|
+
opts['body'],
|
|
60230
|
+
['PureCloud OAuth'],
|
|
60231
|
+
['application/json'],
|
|
60232
|
+
['application/json']
|
|
60233
|
+
);
|
|
60234
|
+
}
|
|
60235
|
+
|
|
60236
|
+
/**
|
|
60237
|
+
* Update the Facebook data ingestion rule.
|
|
60238
|
+
*
|
|
60239
|
+
* @param {String} topicId topicId
|
|
60240
|
+
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
60241
|
+
* @param {Object} opts Optional parameters
|
|
60242
|
+
* @param {Object} opts.body
|
|
60243
|
+
* putSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60244
|
+
*/
|
|
60245
|
+
putSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId, facebookIngestionRuleId, opts) {
|
|
60246
|
+
opts = opts || {};
|
|
60247
|
+
|
|
60248
|
+
// verify the required parameter 'topicId' is set
|
|
60249
|
+
if (topicId === undefined || topicId === null) {
|
|
60250
|
+
throw 'Missing the required parameter "topicId" when calling putSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';
|
|
60251
|
+
}
|
|
60252
|
+
// verify the required parameter 'facebookIngestionRuleId' is set
|
|
60253
|
+
if (facebookIngestionRuleId === undefined || facebookIngestionRuleId === null) {
|
|
60254
|
+
throw 'Missing the required parameter "facebookIngestionRuleId" when calling putSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';
|
|
60255
|
+
}
|
|
60256
|
+
|
|
60257
|
+
return this.apiClient.callApi(
|
|
60258
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}',
|
|
60259
|
+
'PUT',
|
|
60260
|
+
{ 'topicId': topicId,'facebookIngestionRuleId': facebookIngestionRuleId },
|
|
60261
|
+
{ },
|
|
60262
|
+
{ },
|
|
60263
|
+
{ },
|
|
60264
|
+
opts['body'],
|
|
60265
|
+
['PureCloud OAuth'],
|
|
60266
|
+
['application/json'],
|
|
60267
|
+
['application/json']
|
|
60268
|
+
);
|
|
60269
|
+
}
|
|
60270
|
+
|
|
60271
|
+
/**
|
|
60272
|
+
* Update the open data ingestion rule.
|
|
60273
|
+
*
|
|
60274
|
+
* @param {String} topicId topicId
|
|
60275
|
+
* @param {String} openId openId
|
|
60276
|
+
* @param {Object} opts Optional parameters
|
|
60277
|
+
* @param {Object} opts.body
|
|
60278
|
+
* putSocialmediaTopicDataingestionrulesOpenOpenId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60279
|
+
*/
|
|
60280
|
+
putSocialmediaTopicDataingestionrulesOpenOpenId(topicId, openId, opts) {
|
|
60281
|
+
opts = opts || {};
|
|
60282
|
+
|
|
60283
|
+
// verify the required parameter 'topicId' is set
|
|
60284
|
+
if (topicId === undefined || topicId === null) {
|
|
60285
|
+
throw 'Missing the required parameter "topicId" when calling putSocialmediaTopicDataingestionrulesOpenOpenId';
|
|
60286
|
+
}
|
|
60287
|
+
// verify the required parameter 'openId' is set
|
|
60288
|
+
if (openId === undefined || openId === null) {
|
|
60289
|
+
throw 'Missing the required parameter "openId" when calling putSocialmediaTopicDataingestionrulesOpenOpenId';
|
|
60290
|
+
}
|
|
60291
|
+
|
|
60292
|
+
return this.apiClient.callApi(
|
|
60293
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}',
|
|
60294
|
+
'PUT',
|
|
60295
|
+
{ 'topicId': topicId,'openId': openId },
|
|
60296
|
+
{ },
|
|
60297
|
+
{ },
|
|
60298
|
+
{ },
|
|
60299
|
+
opts['body'],
|
|
60300
|
+
['PureCloud OAuth'],
|
|
60301
|
+
['application/json'],
|
|
60302
|
+
['application/json']
|
|
60303
|
+
);
|
|
60304
|
+
}
|
|
60305
|
+
|
|
60306
|
+
/**
|
|
60307
|
+
* Update the X (formally Twitter) data ingestion rule.
|
|
60308
|
+
*
|
|
60309
|
+
* @param {String} topicId topicId
|
|
60310
|
+
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
60311
|
+
* @param {Object} opts Optional parameters
|
|
60312
|
+
* @param {Object} opts.body
|
|
60313
|
+
* putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60314
|
+
*/
|
|
60315
|
+
putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId, twitterIngestionRuleId, opts) {
|
|
60316
|
+
opts = opts || {};
|
|
60317
|
+
|
|
60318
|
+
// verify the required parameter 'topicId' is set
|
|
60319
|
+
if (topicId === undefined || topicId === null) {
|
|
60320
|
+
throw 'Missing the required parameter "topicId" when calling putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';
|
|
60321
|
+
}
|
|
60322
|
+
// verify the required parameter 'twitterIngestionRuleId' is set
|
|
60323
|
+
if (twitterIngestionRuleId === undefined || twitterIngestionRuleId === null) {
|
|
60324
|
+
throw 'Missing the required parameter "twitterIngestionRuleId" when calling putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';
|
|
60325
|
+
}
|
|
60326
|
+
|
|
60327
|
+
return this.apiClient.callApi(
|
|
60328
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}',
|
|
60329
|
+
'PUT',
|
|
60330
|
+
{ 'topicId': topicId,'twitterIngestionRuleId': twitterIngestionRuleId },
|
|
60331
|
+
{ },
|
|
60332
|
+
{ },
|
|
60333
|
+
{ },
|
|
60334
|
+
opts['body'],
|
|
60335
|
+
['PureCloud OAuth'],
|
|
60336
|
+
['application/json'],
|
|
60337
|
+
['application/json']
|
|
60338
|
+
);
|
|
60339
|
+
}
|
|
60340
|
+
|
|
60341
|
+
}
|
|
60342
|
+
|
|
59172
60343
|
class SpeechTextAnalyticsApi {
|
|
59173
60344
|
/**
|
|
59174
60345
|
* SpeechTextAnalytics service.
|
|
59175
60346
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
59176
|
-
* @version
|
|
60347
|
+
* @version 209.0.0
|
|
59177
60348
|
*/
|
|
59178
60349
|
|
|
59179
60350
|
/**
|
|
@@ -59992,13 +61163,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59992
61163
|
}
|
|
59993
61164
|
|
|
59994
61165
|
/**
|
|
59995
|
-
* Translate
|
|
61166
|
+
* Translate a single interaction recording (or an email conversation)
|
|
59996
61167
|
*
|
|
59997
61168
|
* @param {String} languageId Target translation language
|
|
59998
61169
|
* @param {String} conversationId Conversation id
|
|
59999
61170
|
* @param {Object} opts Optional parameters
|
|
60000
|
-
* @param {String} opts.communicationId Communication id associated with the conversation
|
|
60001
|
-
* @param {String} opts.recordingId Recording id associated with the communication
|
|
61171
|
+
* @param {String} opts.communicationId Communication id associated with the conversation. Please provide a valid communicationId when requesting non-email interactions.
|
|
61172
|
+
* @param {String} opts.recordingId Recording id associated with the communication. Please provide a valid recordingId when requesting voice interactions.
|
|
60002
61173
|
* getSpeechandtextanalyticsTranslationsLanguageConversation is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60003
61174
|
*/
|
|
60004
61175
|
getSpeechandtextanalyticsTranslationsLanguageConversation(languageId, conversationId, opts) {
|
|
@@ -60508,7 +61679,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60508
61679
|
/**
|
|
60509
61680
|
* Stations service.
|
|
60510
61681
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
60511
|
-
* @version
|
|
61682
|
+
* @version 209.0.0
|
|
60512
61683
|
*/
|
|
60513
61684
|
|
|
60514
61685
|
/**
|
|
@@ -60610,7 +61781,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60610
61781
|
/**
|
|
60611
61782
|
* Suggest service.
|
|
60612
61783
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
60613
|
-
* @version
|
|
61784
|
+
* @version 209.0.0
|
|
60614
61785
|
*/
|
|
60615
61786
|
|
|
60616
61787
|
/**
|
|
@@ -60749,7 +61920,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60749
61920
|
/**
|
|
60750
61921
|
* TaskManagement service.
|
|
60751
61922
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
60752
|
-
* @version
|
|
61923
|
+
* @version 209.0.0
|
|
60753
61924
|
*/
|
|
60754
61925
|
|
|
60755
61926
|
/**
|
|
@@ -62413,7 +63584,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62413
63584
|
/**
|
|
62414
63585
|
* Teams service.
|
|
62415
63586
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
62416
|
-
* @version
|
|
63587
|
+
* @version 209.0.0
|
|
62417
63588
|
*/
|
|
62418
63589
|
|
|
62419
63590
|
/**
|
|
@@ -62718,7 +63889,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62718
63889
|
/**
|
|
62719
63890
|
* Telephony service.
|
|
62720
63891
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
62721
|
-
* @version
|
|
63892
|
+
* @version 209.0.0
|
|
62722
63893
|
*/
|
|
62723
63894
|
|
|
62724
63895
|
/**
|
|
@@ -62900,7 +64071,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62900
64071
|
/**
|
|
62901
64072
|
* TelephonyProvidersEdge service.
|
|
62902
64073
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
62903
|
-
* @version
|
|
64074
|
+
* @version 209.0.0
|
|
62904
64075
|
*/
|
|
62905
64076
|
|
|
62906
64077
|
/**
|
|
@@ -64877,6 +66048,35 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64877
66048
|
);
|
|
64878
66049
|
}
|
|
64879
66050
|
|
|
66051
|
+
/**
|
|
66052
|
+
* Search sites using the q64 value returned from a previous search
|
|
66053
|
+
*
|
|
66054
|
+
* @param {String} q64 q64
|
|
66055
|
+
* @param {Object} opts Optional parameters
|
|
66056
|
+
* @param {Array.<String>} opts.expand expand
|
|
66057
|
+
*/
|
|
66058
|
+
getTelephonyProvidersEdgesSitesSearch(q64, opts) {
|
|
66059
|
+
opts = opts || {};
|
|
66060
|
+
|
|
66061
|
+
// verify the required parameter 'q64' is set
|
|
66062
|
+
if (q64 === undefined || q64 === null) {
|
|
66063
|
+
throw 'Missing the required parameter "q64" when calling getTelephonyProvidersEdgesSitesSearch';
|
|
66064
|
+
}
|
|
66065
|
+
|
|
66066
|
+
return this.apiClient.callApi(
|
|
66067
|
+
'/api/v2/telephony/providers/edges/sites/search',
|
|
66068
|
+
'GET',
|
|
66069
|
+
{ },
|
|
66070
|
+
{ 'q64': q64,'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
66071
|
+
{ },
|
|
66072
|
+
{ },
|
|
66073
|
+
null,
|
|
66074
|
+
['PureCloud OAuth'],
|
|
66075
|
+
['application/json'],
|
|
66076
|
+
['application/json']
|
|
66077
|
+
);
|
|
66078
|
+
}
|
|
66079
|
+
|
|
64880
66080
|
/**
|
|
64881
66081
|
* Get a list of Edge-compatible time zones
|
|
64882
66082
|
*
|
|
@@ -65806,6 +67006,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65806
67006
|
);
|
|
65807
67007
|
}
|
|
65808
67008
|
|
|
67009
|
+
/**
|
|
67010
|
+
* Search sites
|
|
67011
|
+
*
|
|
67012
|
+
* @param {Object} body Search request options
|
|
67013
|
+
*/
|
|
67014
|
+
postTelephonyProvidersEdgesSitesSearch(body) {
|
|
67015
|
+
// verify the required parameter 'body' is set
|
|
67016
|
+
if (body === undefined || body === null) {
|
|
67017
|
+
throw 'Missing the required parameter "body" when calling postTelephonyProvidersEdgesSitesSearch';
|
|
67018
|
+
}
|
|
67019
|
+
|
|
67020
|
+
return this.apiClient.callApi(
|
|
67021
|
+
'/api/v2/telephony/providers/edges/sites/search',
|
|
67022
|
+
'POST',
|
|
67023
|
+
{ },
|
|
67024
|
+
{ },
|
|
67025
|
+
{ },
|
|
67026
|
+
{ },
|
|
67027
|
+
body,
|
|
67028
|
+
['PureCloud OAuth'],
|
|
67029
|
+
['application/json'],
|
|
67030
|
+
['application/json']
|
|
67031
|
+
);
|
|
67032
|
+
}
|
|
67033
|
+
|
|
65809
67034
|
/**
|
|
65810
67035
|
* Create a Trunk Base Settings object
|
|
65811
67036
|
*
|
|
@@ -66297,7 +67522,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66297
67522
|
/**
|
|
66298
67523
|
* Textbots service.
|
|
66299
67524
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
66300
|
-
* @version
|
|
67525
|
+
* @version 209.0.0
|
|
66301
67526
|
*/
|
|
66302
67527
|
|
|
66303
67528
|
/**
|
|
@@ -66425,7 +67650,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66425
67650
|
/**
|
|
66426
67651
|
* Tokens service.
|
|
66427
67652
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
66428
|
-
* @version
|
|
67653
|
+
* @version 209.0.0
|
|
66429
67654
|
*/
|
|
66430
67655
|
|
|
66431
67656
|
/**
|
|
@@ -66579,7 +67804,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66579
67804
|
/**
|
|
66580
67805
|
* Uploads service.
|
|
66581
67806
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
66582
|
-
* @version
|
|
67807
|
+
* @version 209.0.0
|
|
66583
67808
|
*/
|
|
66584
67809
|
|
|
66585
67810
|
/**
|
|
@@ -66848,7 +68073,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66848
68073
|
/**
|
|
66849
68074
|
* Usage service.
|
|
66850
68075
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
66851
|
-
* @version
|
|
68076
|
+
* @version 209.0.0
|
|
66852
68077
|
*/
|
|
66853
68078
|
|
|
66854
68079
|
/**
|
|
@@ -67063,7 +68288,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67063
68288
|
/**
|
|
67064
68289
|
* UserRecordings service.
|
|
67065
68290
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
67066
|
-
* @version
|
|
68291
|
+
* @version 209.0.0
|
|
67067
68292
|
*/
|
|
67068
68293
|
|
|
67069
68294
|
/**
|
|
@@ -67278,7 +68503,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67278
68503
|
/**
|
|
67279
68504
|
* Users service.
|
|
67280
68505
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
67281
|
-
* @version
|
|
68506
|
+
* @version 209.0.0
|
|
67282
68507
|
*/
|
|
67283
68508
|
|
|
67284
68509
|
/**
|
|
@@ -67449,7 +68674,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67449
68674
|
}
|
|
67450
68675
|
|
|
67451
68676
|
/**
|
|
67452
|
-
* Remove routing language from user
|
|
68677
|
+
* Remove a routing language from a user
|
|
67453
68678
|
*
|
|
67454
68679
|
* @param {String} userId User ID
|
|
67455
68680
|
* @param {String} languageId languageId
|
|
@@ -67479,7 +68704,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67479
68704
|
}
|
|
67480
68705
|
|
|
67481
68706
|
/**
|
|
67482
|
-
* Remove routing skill from user
|
|
68707
|
+
* Remove a routing skill from a user
|
|
67483
68708
|
*
|
|
67484
68709
|
* @param {String} userId User ID
|
|
67485
68710
|
* @param {String} skillId skillId
|
|
@@ -68311,7 +69536,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68311
69536
|
}
|
|
68312
69537
|
|
|
68313
69538
|
/**
|
|
68314
|
-
* List routing
|
|
69539
|
+
* List routing languages assigned to a user
|
|
68315
69540
|
*
|
|
68316
69541
|
* @param {String} userId User ID
|
|
68317
69542
|
* @param {Object} opts Optional parameters
|
|
@@ -68342,7 +69567,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68342
69567
|
}
|
|
68343
69568
|
|
|
68344
69569
|
/**
|
|
68345
|
-
* List routing skills
|
|
69570
|
+
* List routing skills assigned to a user
|
|
68346
69571
|
*
|
|
68347
69572
|
* @param {String} userId User ID
|
|
68348
69573
|
* @param {Object} opts Optional parameters
|
|
@@ -68938,7 +70163,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68938
70163
|
}
|
|
68939
70164
|
|
|
68940
70165
|
/**
|
|
68941
|
-
* Update routing language proficiency
|
|
70166
|
+
* Update an assigned routing language's proficiency
|
|
68942
70167
|
*
|
|
68943
70168
|
* @param {String} userId User ID
|
|
68944
70169
|
* @param {String} languageId languageId
|
|
@@ -68973,7 +70198,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68973
70198
|
}
|
|
68974
70199
|
|
|
68975
70200
|
/**
|
|
68976
|
-
*
|
|
70201
|
+
* Assign multiple routing languages to a user. Max 50 routing languages in request body
|
|
68977
70202
|
*
|
|
68978
70203
|
* @param {String} userId User ID
|
|
68979
70204
|
* @param {Array.<Object>} body Language
|
|
@@ -69003,7 +70228,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69003
70228
|
}
|
|
69004
70229
|
|
|
69005
70230
|
/**
|
|
69006
|
-
*
|
|
70231
|
+
* Assign multiple routing skills to a user
|
|
69007
70232
|
*
|
|
69008
70233
|
* @param {String} userId User ID
|
|
69009
70234
|
* @param {Array.<Object>} body Skill
|
|
@@ -69440,7 +70665,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69440
70665
|
}
|
|
69441
70666
|
|
|
69442
70667
|
/**
|
|
69443
|
-
*
|
|
70668
|
+
* Assign a routing language to a user
|
|
69444
70669
|
*
|
|
69445
70670
|
* @param {String} userId User ID
|
|
69446
70671
|
* @param {Object} body Language
|
|
@@ -69470,7 +70695,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69470
70695
|
}
|
|
69471
70696
|
|
|
69472
70697
|
/**
|
|
69473
|
-
*
|
|
70698
|
+
* Assign a routing skill to a user
|
|
69474
70699
|
*
|
|
69475
70700
|
* @param {String} userId User ID
|
|
69476
70701
|
* @param {Object} body Skill
|
|
@@ -69882,7 +71107,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69882
71107
|
}
|
|
69883
71108
|
|
|
69884
71109
|
/**
|
|
69885
|
-
* Update routing skill proficiency
|
|
71110
|
+
* Update an assigned routing skill's proficiency
|
|
69886
71111
|
*
|
|
69887
71112
|
* @param {String} userId User ID
|
|
69888
71113
|
* @param {String} skillId skillId
|
|
@@ -69917,7 +71142,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69917
71142
|
}
|
|
69918
71143
|
|
|
69919
71144
|
/**
|
|
69920
|
-
*
|
|
71145
|
+
* Assign multiple routing skills to a user, replacing any current assignments
|
|
69921
71146
|
*
|
|
69922
71147
|
* @param {String} userId User ID
|
|
69923
71148
|
* @param {Array.<Object>} body Skill
|
|
@@ -70107,7 +71332,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70107
71332
|
/**
|
|
70108
71333
|
* Utilities service.
|
|
70109
71334
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
70110
|
-
* @version
|
|
71335
|
+
* @version 209.0.0
|
|
70111
71336
|
*/
|
|
70112
71337
|
|
|
70113
71338
|
/**
|
|
@@ -70218,7 +71443,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70218
71443
|
/**
|
|
70219
71444
|
* Voicemail service.
|
|
70220
71445
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
70221
|
-
* @version
|
|
71446
|
+
* @version 209.0.0
|
|
70222
71447
|
*/
|
|
70223
71448
|
|
|
70224
71449
|
/**
|
|
@@ -70940,7 +72165,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70940
72165
|
/**
|
|
70941
72166
|
* WebChat service.
|
|
70942
72167
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
70943
|
-
* @version
|
|
72168
|
+
* @version 209.0.0
|
|
70944
72169
|
*/
|
|
70945
72170
|
|
|
70946
72171
|
/**
|
|
@@ -71491,7 +72716,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
71491
72716
|
/**
|
|
71492
72717
|
* WebDeployments service.
|
|
71493
72718
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
71494
|
-
* @version
|
|
72719
|
+
* @version 209.0.0
|
|
71495
72720
|
*/
|
|
71496
72721
|
|
|
71497
72722
|
/**
|
|
@@ -72018,7 +73243,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
72018
73243
|
/**
|
|
72019
73244
|
* WebMessaging service.
|
|
72020
73245
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
72021
|
-
* @version
|
|
73246
|
+
* @version 209.0.0
|
|
72022
73247
|
*/
|
|
72023
73248
|
|
|
72024
73249
|
/**
|
|
@@ -72064,7 +73289,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
72064
73289
|
/**
|
|
72065
73290
|
* Widgets service.
|
|
72066
73291
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
72067
|
-
* @version
|
|
73292
|
+
* @version 209.0.0
|
|
72068
73293
|
*/
|
|
72069
73294
|
|
|
72070
73295
|
/**
|
|
@@ -72210,7 +73435,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
72210
73435
|
/**
|
|
72211
73436
|
* WorkforceManagement service.
|
|
72212
73437
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
72213
|
-
* @version
|
|
73438
|
+
* @version 209.0.0
|
|
72214
73439
|
*/
|
|
72215
73440
|
|
|
72216
73441
|
/**
|
|
@@ -75246,7 +76471,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75246
76471
|
* Gets all the shift trades for a given week
|
|
75247
76472
|
*
|
|
75248
76473
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
75249
|
-
* @param {String} weekDateId The start date of the
|
|
76474
|
+
* @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
75250
76475
|
* @param {Object} opts Optional parameters
|
|
75251
76476
|
* @param {Boolean} opts.evaluateMatches Whether to evaluate the matches for violations (default to true)
|
|
75252
76477
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
@@ -76472,7 +77697,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
76472
77697
|
* Updates a shift trade. This route can only be called by the initiating agent
|
|
76473
77698
|
*
|
|
76474
77699
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
76475
|
-
* @param {String} weekDateId The start date of the
|
|
77700
|
+
* @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
76476
77701
|
* @param {String} tradeId The ID of the shift trade to update
|
|
76477
77702
|
* @param {Object} body body
|
|
76478
77703
|
*/
|
|
@@ -78732,7 +79957,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
78732
79957
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
78733
79958
|
*
|
|
78734
79959
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
78735
|
-
* @param {String} weekDateId The start date of the
|
|
79960
|
+
* @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
78736
79961
|
* @param {String} tradeId The ID of the shift trade to update
|
|
78737
79962
|
* @param {Object} body body
|
|
78738
79963
|
*/
|
|
@@ -78772,7 +79997,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
78772
79997
|
* Adds a shift trade
|
|
78773
79998
|
*
|
|
78774
79999
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
78775
|
-
* @param {String} weekDateId The start date of the
|
|
80000
|
+
* @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
78776
80001
|
* @param {Object} body body
|
|
78777
80002
|
*/
|
|
78778
80003
|
postWorkforcemanagementManagementunitWeekShifttrades(managementUnitId, weekDateId, body) {
|
|
@@ -78807,7 +80032,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
78807
80032
|
* Searches for potential shift trade matches for the current agent
|
|
78808
80033
|
*
|
|
78809
80034
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
78810
|
-
* @param {String} weekDateId The start date of the
|
|
80035
|
+
* @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
78811
80036
|
* @param {Object} body body
|
|
78812
80037
|
* @param {Object} opts Optional parameters
|
|
78813
80038
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
@@ -78846,7 +80071,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
78846
80071
|
* Updates the state of a batch of shift trades
|
|
78847
80072
|
* Admin functionality is not supported with "mine".
|
|
78848
80073
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
78849
|
-
* @param {String} weekDateId The start date of the
|
|
80074
|
+
* @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
78850
80075
|
* @param {Object} body body
|
|
78851
80076
|
* @param {Object} opts Optional parameters
|
|
78852
80077
|
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
@@ -79424,7 +80649,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
79424
80649
|
* </pre>
|
|
79425
80650
|
* </p>
|
|
79426
80651
|
* @module purecloud-platform-client-v2/index
|
|
79427
|
-
* @version
|
|
80652
|
+
* @version 209.0.0
|
|
79428
80653
|
*/
|
|
79429
80654
|
class platformClient {
|
|
79430
80655
|
constructor() {
|
|
@@ -79728,6 +80953,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
79728
80953
|
* @property {module:purecloud-platform-client-v2/api/SettingsApi}
|
|
79729
80954
|
*/
|
|
79730
80955
|
this.SettingsApi = SettingsApi;
|
|
80956
|
+
/**
|
|
80957
|
+
* The SocialMediaApi service constructor.
|
|
80958
|
+
* @property {module:purecloud-platform-client-v2/api/SocialMediaApi}
|
|
80959
|
+
*/
|
|
80960
|
+
this.SocialMediaApi = SocialMediaApi;
|
|
79731
80961
|
/**
|
|
79732
80962
|
* The SpeechTextAnalyticsApi service constructor.
|
|
79733
80963
|
* @property {module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi}
|