purecloud-platform-client-v2 247.1.0 → 249.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 +2057 -116
- package/dist/web-amd/purecloud-platform-client-v2.js +2057 -116
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +626 -121
- package/dist/web-cjs/purecloud-platform-client-v2.js +626 -121
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1404 -337
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AIStudioApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AssistantCopilotVariationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BackgroundAssistantApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BusinessRulesApi.js +6 -6
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CaseManagementApi.js +1100 -0
- 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 +18 -14
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +31 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +501 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +26 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +37 -2
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +57 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +5 -5
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +2 -3
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +46 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersRulesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -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 +152 -5
- package/src/purecloud-platform-client-v2/index.js +7 -1
|
@@ -745,7 +745,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
745
745
|
|
|
746
746
|
/**
|
|
747
747
|
* @module purecloud-platform-client-v2/ApiClient
|
|
748
|
-
* @version
|
|
748
|
+
* @version 249.0.0
|
|
749
749
|
*/
|
|
750
750
|
class ApiClient {
|
|
751
751
|
/**
|
|
@@ -2409,7 +2409,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2409
2409
|
/**
|
|
2410
2410
|
* AIStudio service.
|
|
2411
2411
|
* @module purecloud-platform-client-v2/api/AIStudioApi
|
|
2412
|
-
* @version
|
|
2412
|
+
* @version 249.0.0
|
|
2413
2413
|
*/
|
|
2414
2414
|
|
|
2415
2415
|
/**
|
|
@@ -3028,7 +3028,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3028
3028
|
/**
|
|
3029
3029
|
* AgentAssistants service.
|
|
3030
3030
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
3031
|
-
* @version
|
|
3031
|
+
* @version 249.0.0
|
|
3032
3032
|
*/
|
|
3033
3033
|
|
|
3034
3034
|
/**
|
|
@@ -3741,7 +3741,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3741
3741
|
/**
|
|
3742
3742
|
* AgentCopilot service.
|
|
3743
3743
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
3744
|
-
* @version
|
|
3744
|
+
* @version 249.0.0
|
|
3745
3745
|
*/
|
|
3746
3746
|
|
|
3747
3747
|
/**
|
|
@@ -3841,7 +3841,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3841
3841
|
/**
|
|
3842
3842
|
* AgentUI service.
|
|
3843
3843
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
3844
|
-
* @version
|
|
3844
|
+
* @version 249.0.0
|
|
3845
3845
|
*/
|
|
3846
3846
|
|
|
3847
3847
|
/**
|
|
@@ -3972,7 +3972,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3972
3972
|
/**
|
|
3973
3973
|
* Alerting service.
|
|
3974
3974
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
3975
|
-
* @version
|
|
3975
|
+
* @version 249.0.0
|
|
3976
3976
|
*/
|
|
3977
3977
|
|
|
3978
3978
|
/**
|
|
@@ -4373,7 +4373,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4373
4373
|
/**
|
|
4374
4374
|
* Analytics service.
|
|
4375
4375
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
4376
|
-
* @version
|
|
4376
|
+
* @version 249.0.0
|
|
4377
4377
|
*/
|
|
4378
4378
|
|
|
4379
4379
|
/**
|
|
@@ -7810,7 +7810,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7810
7810
|
/**
|
|
7811
7811
|
* Architect service.
|
|
7812
7812
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
7813
|
-
* @version
|
|
7813
|
+
* @version 249.0.0
|
|
7814
7814
|
*/
|
|
7815
7815
|
|
|
7816
7816
|
/**
|
|
@@ -12105,7 +12105,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12105
12105
|
/**
|
|
12106
12106
|
* AssistantCopilotVariations service.
|
|
12107
12107
|
* @module purecloud-platform-client-v2/api/AssistantCopilotVariationsApi
|
|
12108
|
-
* @version
|
|
12108
|
+
* @version 249.0.0
|
|
12109
12109
|
*/
|
|
12110
12110
|
|
|
12111
12111
|
/**
|
|
@@ -12276,7 +12276,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12276
12276
|
/**
|
|
12277
12277
|
* Audit service.
|
|
12278
12278
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
12279
|
-
* @version
|
|
12279
|
+
* @version 249.0.0
|
|
12280
12280
|
*/
|
|
12281
12281
|
|
|
12282
12282
|
/**
|
|
@@ -12477,7 +12477,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12477
12477
|
/**
|
|
12478
12478
|
* Authorization service.
|
|
12479
12479
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
12480
|
-
* @version
|
|
12480
|
+
* @version 249.0.0
|
|
12481
12481
|
*/
|
|
12482
12482
|
|
|
12483
12483
|
/**
|
|
@@ -14191,7 +14191,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14191
14191
|
/**
|
|
14192
14192
|
* BackgroundAssistant service.
|
|
14193
14193
|
* @module purecloud-platform-client-v2/api/BackgroundAssistantApi
|
|
14194
|
-
* @version
|
|
14194
|
+
* @version 249.0.0
|
|
14195
14195
|
*/
|
|
14196
14196
|
|
|
14197
14197
|
/**
|
|
@@ -14261,7 +14261,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14261
14261
|
/**
|
|
14262
14262
|
* Billing service.
|
|
14263
14263
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
14264
|
-
* @version
|
|
14264
|
+
* @version 249.0.0
|
|
14265
14265
|
*/
|
|
14266
14266
|
|
|
14267
14267
|
/**
|
|
@@ -14517,7 +14517,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14517
14517
|
/**
|
|
14518
14518
|
* BusinessRules service.
|
|
14519
14519
|
* @module purecloud-platform-client-v2/api/BusinessRulesApi
|
|
14520
|
-
* @version
|
|
14520
|
+
* @version 249.0.0
|
|
14521
14521
|
*/
|
|
14522
14522
|
|
|
14523
14523
|
/**
|
|
@@ -14593,7 +14593,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14593
14593
|
|
|
14594
14594
|
/**
|
|
14595
14595
|
* Delete a decision table row
|
|
14596
|
-
*
|
|
14596
|
+
* Required permissions depend on table content: if the table or row contains queue references, routing:queue:view is required in each queues division. Future platform objects will require their associated permissions in the relevant divisions when the table or row contains references to them.
|
|
14597
14597
|
* @param {String} tableId Table ID
|
|
14598
14598
|
* @param {Number} tableVersion Table Version
|
|
14599
14599
|
* @param {String} rowId Row ID
|
|
@@ -14955,7 +14955,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14955
14955
|
|
|
14956
14956
|
/**
|
|
14957
14957
|
* Update a decision table
|
|
14958
|
-
*
|
|
14958
|
+
* Required permissions depend on table content: if the table or row contains queue references, routing:queue:view is required in each queues division. Future platform objects will require their associated permissions in the relevant divisions when the table or row contains references to them.
|
|
14959
14959
|
* @param {String} tableId Table ID
|
|
14960
14960
|
* @param {Object} body Decision Table
|
|
14961
14961
|
*/
|
|
@@ -15120,7 +15120,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15120
15120
|
|
|
15121
15121
|
/**
|
|
15122
15122
|
* Create a decision table row
|
|
15123
|
-
*
|
|
15123
|
+
* Required permissions depend on table content: if the table or row contains queue references, routing:queue:view is required in each queues division. Future platform objects will require their associated permissions in the relevant divisions when the table or row contains references to them.
|
|
15124
15124
|
* @param {String} tableId Table ID
|
|
15125
15125
|
* @param {Number} tableVersion Table Version
|
|
15126
15126
|
* @param {Object} body Create decision table row request
|
|
@@ -15250,7 +15250,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15250
15250
|
|
|
15251
15251
|
/**
|
|
15252
15252
|
* Create a decision table
|
|
15253
|
-
*
|
|
15253
|
+
* Required permissions depend on table content: if the table or row contains queue references, routing:queue:view is required in each queues division. Future platform objects will require their associated permissions in the relevant divisions when the table or row contains references to them.
|
|
15254
15254
|
* @param {Object} body Decision Table
|
|
15255
15255
|
*/
|
|
15256
15256
|
postBusinessrulesDecisiontables(body) {
|
|
@@ -15330,7 +15330,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15330
15330
|
|
|
15331
15331
|
/**
|
|
15332
15332
|
* Full update a decision table row
|
|
15333
|
-
*
|
|
15333
|
+
* Required permissions depend on table content: if the table or row contains queue references, routing:queue:view is required in each queues division. Future platform objects will require their associated permissions in the relevant divisions when the table or row contains references to them.
|
|
15334
15334
|
* @param {String} tableId Table ID
|
|
15335
15335
|
* @param {Number} tableVersion Table Version
|
|
15336
15336
|
* @param {String} rowId Row ID
|
|
@@ -15404,7 +15404,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15404
15404
|
/**
|
|
15405
15405
|
* CarrierServices service.
|
|
15406
15406
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
15407
|
-
* @version
|
|
15407
|
+
* @version 249.0.0
|
|
15408
15408
|
*/
|
|
15409
15409
|
|
|
15410
15410
|
/**
|
|
@@ -15470,11 +15470,1106 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15470
15470
|
|
|
15471
15471
|
}
|
|
15472
15472
|
|
|
15473
|
+
class CaseManagementApi {
|
|
15474
|
+
/**
|
|
15475
|
+
* CaseManagement service.
|
|
15476
|
+
* @module purecloud-platform-client-v2/api/CaseManagementApi
|
|
15477
|
+
* @version 249.0.0
|
|
15478
|
+
*/
|
|
15479
|
+
|
|
15480
|
+
/**
|
|
15481
|
+
* Constructs a new CaseManagementApi.
|
|
15482
|
+
* @alias module:purecloud-platform-client-v2/api/CaseManagementApi
|
|
15483
|
+
* @class
|
|
15484
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
15485
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
15486
|
+
*/
|
|
15487
|
+
constructor(apiClient) {
|
|
15488
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
15489
|
+
}
|
|
15490
|
+
|
|
15491
|
+
|
|
15492
|
+
/**
|
|
15493
|
+
* Delete a Case.
|
|
15494
|
+
*
|
|
15495
|
+
* @param {String} caseId Case ID
|
|
15496
|
+
* deleteCasemanagementCase is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15497
|
+
*/
|
|
15498
|
+
deleteCasemanagementCase(caseId) {
|
|
15499
|
+
// verify the required parameter 'caseId' is set
|
|
15500
|
+
if (caseId === undefined || caseId === null || caseId === '') {
|
|
15501
|
+
throw 'Missing the required parameter "caseId" when calling deleteCasemanagementCase';
|
|
15502
|
+
}
|
|
15503
|
+
|
|
15504
|
+
return this.apiClient.callApi(
|
|
15505
|
+
'/api/v2/casemanagement/cases/{caseId}',
|
|
15506
|
+
'DELETE',
|
|
15507
|
+
{ 'caseId': caseId },
|
|
15508
|
+
{ },
|
|
15509
|
+
{ },
|
|
15510
|
+
{ },
|
|
15511
|
+
null,
|
|
15512
|
+
['PureCloud OAuth'],
|
|
15513
|
+
['application/json'],
|
|
15514
|
+
['application/json']
|
|
15515
|
+
);
|
|
15516
|
+
}
|
|
15517
|
+
|
|
15518
|
+
/**
|
|
15519
|
+
* Delete a Caseplan.
|
|
15520
|
+
*
|
|
15521
|
+
* @param {String} caseplanId Caseplan ID
|
|
15522
|
+
* deleteCasemanagementCaseplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15523
|
+
*/
|
|
15524
|
+
deleteCasemanagementCaseplan(caseplanId) {
|
|
15525
|
+
// verify the required parameter 'caseplanId' is set
|
|
15526
|
+
if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
|
|
15527
|
+
throw 'Missing the required parameter "caseplanId" when calling deleteCasemanagementCaseplan';
|
|
15528
|
+
}
|
|
15529
|
+
|
|
15530
|
+
return this.apiClient.callApi(
|
|
15531
|
+
'/api/v2/casemanagement/caseplans/{caseplanId}',
|
|
15532
|
+
'DELETE',
|
|
15533
|
+
{ 'caseplanId': caseplanId },
|
|
15534
|
+
{ },
|
|
15535
|
+
{ },
|
|
15536
|
+
{ },
|
|
15537
|
+
null,
|
|
15538
|
+
['PureCloud OAuth'],
|
|
15539
|
+
['application/json'],
|
|
15540
|
+
['application/json']
|
|
15541
|
+
);
|
|
15542
|
+
}
|
|
15543
|
+
|
|
15544
|
+
/**
|
|
15545
|
+
* Get a Case.
|
|
15546
|
+
*
|
|
15547
|
+
* @param {String} caseId Case ID
|
|
15548
|
+
* @param {Object} opts Optional parameters
|
|
15549
|
+
* @param {Object} opts.expands Which fields to expand.
|
|
15550
|
+
* getCasemanagementCase is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15551
|
+
*/
|
|
15552
|
+
getCasemanagementCase(caseId, opts) {
|
|
15553
|
+
opts = opts || {};
|
|
15554
|
+
|
|
15555
|
+
// verify the required parameter 'caseId' is set
|
|
15556
|
+
if (caseId === undefined || caseId === null || caseId === '') {
|
|
15557
|
+
throw 'Missing the required parameter "caseId" when calling getCasemanagementCase';
|
|
15558
|
+
}
|
|
15559
|
+
|
|
15560
|
+
return this.apiClient.callApi(
|
|
15561
|
+
'/api/v2/casemanagement/cases/{caseId}',
|
|
15562
|
+
'GET',
|
|
15563
|
+
{ 'caseId': caseId },
|
|
15564
|
+
{ 'expands': opts['expands'] },
|
|
15565
|
+
{ },
|
|
15566
|
+
{ },
|
|
15567
|
+
null,
|
|
15568
|
+
['PureCloud OAuth'],
|
|
15569
|
+
['application/json'],
|
|
15570
|
+
['application/json']
|
|
15571
|
+
);
|
|
15572
|
+
}
|
|
15573
|
+
|
|
15574
|
+
/**
|
|
15575
|
+
* Get a Case Association.
|
|
15576
|
+
*
|
|
15577
|
+
* @param {String} caseId Case ID
|
|
15578
|
+
* @param {String} associationId Case Association ID
|
|
15579
|
+
* getCasemanagementCaseAssociation is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15580
|
+
*/
|
|
15581
|
+
getCasemanagementCaseAssociation(caseId, associationId) {
|
|
15582
|
+
// verify the required parameter 'caseId' is set
|
|
15583
|
+
if (caseId === undefined || caseId === null || caseId === '') {
|
|
15584
|
+
throw 'Missing the required parameter "caseId" when calling getCasemanagementCaseAssociation';
|
|
15585
|
+
}
|
|
15586
|
+
// verify the required parameter 'associationId' is set
|
|
15587
|
+
if (associationId === undefined || associationId === null || associationId === '') {
|
|
15588
|
+
throw 'Missing the required parameter "associationId" when calling getCasemanagementCaseAssociation';
|
|
15589
|
+
}
|
|
15590
|
+
|
|
15591
|
+
return this.apiClient.callApi(
|
|
15592
|
+
'/api/v2/casemanagement/cases/{caseId}/associations/{associationId}',
|
|
15593
|
+
'GET',
|
|
15594
|
+
{ 'caseId': caseId,'associationId': associationId },
|
|
15595
|
+
{ },
|
|
15596
|
+
{ },
|
|
15597
|
+
{ },
|
|
15598
|
+
null,
|
|
15599
|
+
['PureCloud OAuth'],
|
|
15600
|
+
['application/json'],
|
|
15601
|
+
['application/json']
|
|
15602
|
+
);
|
|
15603
|
+
}
|
|
15604
|
+
|
|
15605
|
+
/**
|
|
15606
|
+
* Get a list of case associations for a provided case.
|
|
15607
|
+
*
|
|
15608
|
+
* @param {String} caseId Case ID.
|
|
15609
|
+
* @param {Object} opts Optional parameters
|
|
15610
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
15611
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
15612
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
15613
|
+
* getCasemanagementCaseAssociations is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15614
|
+
*/
|
|
15615
|
+
getCasemanagementCaseAssociations(caseId, opts) {
|
|
15616
|
+
opts = opts || {};
|
|
15617
|
+
|
|
15618
|
+
// verify the required parameter 'caseId' is set
|
|
15619
|
+
if (caseId === undefined || caseId === null || caseId === '') {
|
|
15620
|
+
throw 'Missing the required parameter "caseId" when calling getCasemanagementCaseAssociations';
|
|
15621
|
+
}
|
|
15622
|
+
|
|
15623
|
+
return this.apiClient.callApi(
|
|
15624
|
+
'/api/v2/casemanagement/cases/{caseId}/associations',
|
|
15625
|
+
'GET',
|
|
15626
|
+
{ 'caseId': caseId },
|
|
15627
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
15628
|
+
{ },
|
|
15629
|
+
{ },
|
|
15630
|
+
null,
|
|
15631
|
+
['PureCloud OAuth'],
|
|
15632
|
+
['application/json'],
|
|
15633
|
+
['application/json']
|
|
15634
|
+
);
|
|
15635
|
+
}
|
|
15636
|
+
|
|
15637
|
+
/**
|
|
15638
|
+
* Get a Stage.
|
|
15639
|
+
*
|
|
15640
|
+
* @param {String} caseId Case ID
|
|
15641
|
+
* @param {String} stageId Stage ID
|
|
15642
|
+
* getCasemanagementCaseStage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15643
|
+
*/
|
|
15644
|
+
getCasemanagementCaseStage(caseId, stageId) {
|
|
15645
|
+
// verify the required parameter 'caseId' is set
|
|
15646
|
+
if (caseId === undefined || caseId === null || caseId === '') {
|
|
15647
|
+
throw 'Missing the required parameter "caseId" when calling getCasemanagementCaseStage';
|
|
15648
|
+
}
|
|
15649
|
+
// verify the required parameter 'stageId' is set
|
|
15650
|
+
if (stageId === undefined || stageId === null || stageId === '') {
|
|
15651
|
+
throw 'Missing the required parameter "stageId" when calling getCasemanagementCaseStage';
|
|
15652
|
+
}
|
|
15653
|
+
|
|
15654
|
+
return this.apiClient.callApi(
|
|
15655
|
+
'/api/v2/casemanagement/cases/{caseId}/stages/{stageId}',
|
|
15656
|
+
'GET',
|
|
15657
|
+
{ 'caseId': caseId,'stageId': stageId },
|
|
15658
|
+
{ },
|
|
15659
|
+
{ },
|
|
15660
|
+
{ },
|
|
15661
|
+
null,
|
|
15662
|
+
['PureCloud OAuth'],
|
|
15663
|
+
['application/json'],
|
|
15664
|
+
['application/json']
|
|
15665
|
+
);
|
|
15666
|
+
}
|
|
15667
|
+
|
|
15668
|
+
/**
|
|
15669
|
+
* Get a Step.
|
|
15670
|
+
*
|
|
15671
|
+
* @param {String} caseId Case ID
|
|
15672
|
+
* @param {String} stageId Stage ID
|
|
15673
|
+
* @param {String} stepId Step ID
|
|
15674
|
+
* getCasemanagementCaseStageStep is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15675
|
+
*/
|
|
15676
|
+
getCasemanagementCaseStageStep(caseId, stageId, stepId) {
|
|
15677
|
+
// verify the required parameter 'caseId' is set
|
|
15678
|
+
if (caseId === undefined || caseId === null || caseId === '') {
|
|
15679
|
+
throw 'Missing the required parameter "caseId" when calling getCasemanagementCaseStageStep';
|
|
15680
|
+
}
|
|
15681
|
+
// verify the required parameter 'stageId' is set
|
|
15682
|
+
if (stageId === undefined || stageId === null || stageId === '') {
|
|
15683
|
+
throw 'Missing the required parameter "stageId" when calling getCasemanagementCaseStageStep';
|
|
15684
|
+
}
|
|
15685
|
+
// verify the required parameter 'stepId' is set
|
|
15686
|
+
if (stepId === undefined || stepId === null || stepId === '') {
|
|
15687
|
+
throw 'Missing the required parameter "stepId" when calling getCasemanagementCaseStageStep';
|
|
15688
|
+
}
|
|
15689
|
+
|
|
15690
|
+
return this.apiClient.callApi(
|
|
15691
|
+
'/api/v2/casemanagement/cases/{caseId}/stages/{stageId}/steps/{stepId}',
|
|
15692
|
+
'GET',
|
|
15693
|
+
{ 'caseId': caseId,'stageId': stageId,'stepId': stepId },
|
|
15694
|
+
{ },
|
|
15695
|
+
{ },
|
|
15696
|
+
{ },
|
|
15697
|
+
null,
|
|
15698
|
+
['PureCloud OAuth'],
|
|
15699
|
+
['application/json'],
|
|
15700
|
+
['application/json']
|
|
15701
|
+
);
|
|
15702
|
+
}
|
|
15703
|
+
|
|
15704
|
+
/**
|
|
15705
|
+
* Get a list of Steps.
|
|
15706
|
+
*
|
|
15707
|
+
* @param {String} caseId Case ID
|
|
15708
|
+
* @param {String} stageId Stage ID
|
|
15709
|
+
* @param {Object} opts Optional parameters
|
|
15710
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
15711
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
15712
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
15713
|
+
* getCasemanagementCaseStageSteps is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15714
|
+
*/
|
|
15715
|
+
getCasemanagementCaseStageSteps(caseId, stageId, opts) {
|
|
15716
|
+
opts = opts || {};
|
|
15717
|
+
|
|
15718
|
+
// verify the required parameter 'caseId' is set
|
|
15719
|
+
if (caseId === undefined || caseId === null || caseId === '') {
|
|
15720
|
+
throw 'Missing the required parameter "caseId" when calling getCasemanagementCaseStageSteps';
|
|
15721
|
+
}
|
|
15722
|
+
// verify the required parameter 'stageId' is set
|
|
15723
|
+
if (stageId === undefined || stageId === null || stageId === '') {
|
|
15724
|
+
throw 'Missing the required parameter "stageId" when calling getCasemanagementCaseStageSteps';
|
|
15725
|
+
}
|
|
15726
|
+
|
|
15727
|
+
return this.apiClient.callApi(
|
|
15728
|
+
'/api/v2/casemanagement/cases/{caseId}/stages/{stageId}/steps',
|
|
15729
|
+
'GET',
|
|
15730
|
+
{ 'caseId': caseId,'stageId': stageId },
|
|
15731
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
15732
|
+
{ },
|
|
15733
|
+
{ },
|
|
15734
|
+
null,
|
|
15735
|
+
['PureCloud OAuth'],
|
|
15736
|
+
['application/json'],
|
|
15737
|
+
['application/json']
|
|
15738
|
+
);
|
|
15739
|
+
}
|
|
15740
|
+
|
|
15741
|
+
/**
|
|
15742
|
+
* Get a list of Stages.
|
|
15743
|
+
*
|
|
15744
|
+
* @param {String} caseId Case ID
|
|
15745
|
+
* @param {Object} opts Optional parameters
|
|
15746
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
15747
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
15748
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
15749
|
+
* getCasemanagementCaseStages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15750
|
+
*/
|
|
15751
|
+
getCasemanagementCaseStages(caseId, opts) {
|
|
15752
|
+
opts = opts || {};
|
|
15753
|
+
|
|
15754
|
+
// verify the required parameter 'caseId' is set
|
|
15755
|
+
if (caseId === undefined || caseId === null || caseId === '') {
|
|
15756
|
+
throw 'Missing the required parameter "caseId" when calling getCasemanagementCaseStages';
|
|
15757
|
+
}
|
|
15758
|
+
|
|
15759
|
+
return this.apiClient.callApi(
|
|
15760
|
+
'/api/v2/casemanagement/cases/{caseId}/stages',
|
|
15761
|
+
'GET',
|
|
15762
|
+
{ 'caseId': caseId },
|
|
15763
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
15764
|
+
{ },
|
|
15765
|
+
{ },
|
|
15766
|
+
null,
|
|
15767
|
+
['PureCloud OAuth'],
|
|
15768
|
+
['application/json'],
|
|
15769
|
+
['application/json']
|
|
15770
|
+
);
|
|
15771
|
+
}
|
|
15772
|
+
|
|
15773
|
+
/**
|
|
15774
|
+
* Get a Terminate Job for a Case.
|
|
15775
|
+
*
|
|
15776
|
+
* @param {String} caseId Case ID
|
|
15777
|
+
* @param {String} jobId Job ID
|
|
15778
|
+
* getCasemanagementCaseTerminateJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15779
|
+
*/
|
|
15780
|
+
getCasemanagementCaseTerminateJob(caseId, jobId) {
|
|
15781
|
+
// verify the required parameter 'caseId' is set
|
|
15782
|
+
if (caseId === undefined || caseId === null || caseId === '') {
|
|
15783
|
+
throw 'Missing the required parameter "caseId" when calling getCasemanagementCaseTerminateJob';
|
|
15784
|
+
}
|
|
15785
|
+
// verify the required parameter 'jobId' is set
|
|
15786
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
15787
|
+
throw 'Missing the required parameter "jobId" when calling getCasemanagementCaseTerminateJob';
|
|
15788
|
+
}
|
|
15789
|
+
|
|
15790
|
+
return this.apiClient.callApi(
|
|
15791
|
+
'/api/v2/casemanagement/cases/{caseId}/terminate/jobs/{jobId}',
|
|
15792
|
+
'GET',
|
|
15793
|
+
{ 'caseId': caseId,'jobId': jobId },
|
|
15794
|
+
{ },
|
|
15795
|
+
{ },
|
|
15796
|
+
{ },
|
|
15797
|
+
null,
|
|
15798
|
+
['PureCloud OAuth'],
|
|
15799
|
+
['application/json'],
|
|
15800
|
+
['application/json']
|
|
15801
|
+
);
|
|
15802
|
+
}
|
|
15803
|
+
|
|
15804
|
+
/**
|
|
15805
|
+
* Get a Caseplan.
|
|
15806
|
+
*
|
|
15807
|
+
* @param {String} caseplanId Caseplan ID
|
|
15808
|
+
* getCasemanagementCaseplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15809
|
+
*/
|
|
15810
|
+
getCasemanagementCaseplan(caseplanId) {
|
|
15811
|
+
// verify the required parameter 'caseplanId' is set
|
|
15812
|
+
if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
|
|
15813
|
+
throw 'Missing the required parameter "caseplanId" when calling getCasemanagementCaseplan';
|
|
15814
|
+
}
|
|
15815
|
+
|
|
15816
|
+
return this.apiClient.callApi(
|
|
15817
|
+
'/api/v2/casemanagement/caseplans/{caseplanId}',
|
|
15818
|
+
'GET',
|
|
15819
|
+
{ 'caseplanId': caseplanId },
|
|
15820
|
+
{ },
|
|
15821
|
+
{ },
|
|
15822
|
+
{ },
|
|
15823
|
+
null,
|
|
15824
|
+
['PureCloud OAuth'],
|
|
15825
|
+
['application/json'],
|
|
15826
|
+
['application/json']
|
|
15827
|
+
);
|
|
15828
|
+
}
|
|
15829
|
+
|
|
15830
|
+
/**
|
|
15831
|
+
* Get a Caseplan version.
|
|
15832
|
+
*
|
|
15833
|
+
* @param {String} caseplanId Caseplan ID
|
|
15834
|
+
* @param {String} versionId Version of the caseplan
|
|
15835
|
+
* getCasemanagementCaseplanVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15836
|
+
*/
|
|
15837
|
+
getCasemanagementCaseplanVersion(caseplanId, versionId) {
|
|
15838
|
+
// verify the required parameter 'caseplanId' is set
|
|
15839
|
+
if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
|
|
15840
|
+
throw 'Missing the required parameter "caseplanId" when calling getCasemanagementCaseplanVersion';
|
|
15841
|
+
}
|
|
15842
|
+
// verify the required parameter 'versionId' is set
|
|
15843
|
+
if (versionId === undefined || versionId === null || versionId === '') {
|
|
15844
|
+
throw 'Missing the required parameter "versionId" when calling getCasemanagementCaseplanVersion';
|
|
15845
|
+
}
|
|
15846
|
+
|
|
15847
|
+
return this.apiClient.callApi(
|
|
15848
|
+
'/api/v2/casemanagement/caseplans/{caseplanId}/versions/{versionId}',
|
|
15849
|
+
'GET',
|
|
15850
|
+
{ 'caseplanId': caseplanId,'versionId': versionId },
|
|
15851
|
+
{ },
|
|
15852
|
+
{ },
|
|
15853
|
+
{ },
|
|
15854
|
+
null,
|
|
15855
|
+
['PureCloud OAuth'],
|
|
15856
|
+
['application/json'],
|
|
15857
|
+
['application/json']
|
|
15858
|
+
);
|
|
15859
|
+
}
|
|
15860
|
+
|
|
15861
|
+
/**
|
|
15862
|
+
* Get the dataSchemas for a caseplan version.
|
|
15863
|
+
*
|
|
15864
|
+
* @param {String} caseplanId Caseplan ID
|
|
15865
|
+
* @param {String} versionId Version of the caseplan
|
|
15866
|
+
* getCasemanagementCaseplanVersionDataschemas is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15867
|
+
*/
|
|
15868
|
+
getCasemanagementCaseplanVersionDataschemas(caseplanId, versionId) {
|
|
15869
|
+
// verify the required parameter 'caseplanId' is set
|
|
15870
|
+
if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
|
|
15871
|
+
throw 'Missing the required parameter "caseplanId" when calling getCasemanagementCaseplanVersionDataschemas';
|
|
15872
|
+
}
|
|
15873
|
+
// verify the required parameter 'versionId' is set
|
|
15874
|
+
if (versionId === undefined || versionId === null || versionId === '') {
|
|
15875
|
+
throw 'Missing the required parameter "versionId" when calling getCasemanagementCaseplanVersionDataschemas';
|
|
15876
|
+
}
|
|
15877
|
+
|
|
15878
|
+
return this.apiClient.callApi(
|
|
15879
|
+
'/api/v2/casemanagement/caseplans/{caseplanId}/versions/{versionId}/dataschemas',
|
|
15880
|
+
'GET',
|
|
15881
|
+
{ 'caseplanId': caseplanId,'versionId': versionId },
|
|
15882
|
+
{ },
|
|
15883
|
+
{ },
|
|
15884
|
+
{ },
|
|
15885
|
+
null,
|
|
15886
|
+
['PureCloud OAuth'],
|
|
15887
|
+
['application/json'],
|
|
15888
|
+
['application/json']
|
|
15889
|
+
);
|
|
15890
|
+
}
|
|
15891
|
+
|
|
15892
|
+
/**
|
|
15893
|
+
* Get the intake settings for a Caseplan version.
|
|
15894
|
+
*
|
|
15895
|
+
* @param {String} caseplanId Caseplan ID
|
|
15896
|
+
* @param {String} versionId Version of the caseplan
|
|
15897
|
+
* getCasemanagementCaseplanVersionIntakesettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15898
|
+
*/
|
|
15899
|
+
getCasemanagementCaseplanVersionIntakesettings(caseplanId, versionId) {
|
|
15900
|
+
// verify the required parameter 'caseplanId' is set
|
|
15901
|
+
if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
|
|
15902
|
+
throw 'Missing the required parameter "caseplanId" when calling getCasemanagementCaseplanVersionIntakesettings';
|
|
15903
|
+
}
|
|
15904
|
+
// verify the required parameter 'versionId' is set
|
|
15905
|
+
if (versionId === undefined || versionId === null || versionId === '') {
|
|
15906
|
+
throw 'Missing the required parameter "versionId" when calling getCasemanagementCaseplanVersionIntakesettings';
|
|
15907
|
+
}
|
|
15908
|
+
|
|
15909
|
+
return this.apiClient.callApi(
|
|
15910
|
+
'/api/v2/casemanagement/caseplans/{caseplanId}/versions/{versionId}/intakesettings',
|
|
15911
|
+
'GET',
|
|
15912
|
+
{ 'caseplanId': caseplanId,'versionId': versionId },
|
|
15913
|
+
{ },
|
|
15914
|
+
{ },
|
|
15915
|
+
{ },
|
|
15916
|
+
null,
|
|
15917
|
+
['PureCloud OAuth'],
|
|
15918
|
+
['application/json'],
|
|
15919
|
+
['application/json']
|
|
15920
|
+
);
|
|
15921
|
+
}
|
|
15922
|
+
|
|
15923
|
+
/**
|
|
15924
|
+
* Get a Stageplan.
|
|
15925
|
+
*
|
|
15926
|
+
* @param {String} caseplanId Caseplan ID
|
|
15927
|
+
* @param {String} versionId Version ID
|
|
15928
|
+
* @param {String} stageplanId Stageplan ID
|
|
15929
|
+
* @param {Object} opts Optional parameters
|
|
15930
|
+
* @param {Array.<String>} opts.expands Which fields to expand.
|
|
15931
|
+
* getCasemanagementCaseplanVersionStageplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15932
|
+
*/
|
|
15933
|
+
getCasemanagementCaseplanVersionStageplan(caseplanId, versionId, stageplanId, opts) {
|
|
15934
|
+
opts = opts || {};
|
|
15935
|
+
|
|
15936
|
+
// verify the required parameter 'caseplanId' is set
|
|
15937
|
+
if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
|
|
15938
|
+
throw 'Missing the required parameter "caseplanId" when calling getCasemanagementCaseplanVersionStageplan';
|
|
15939
|
+
}
|
|
15940
|
+
// verify the required parameter 'versionId' is set
|
|
15941
|
+
if (versionId === undefined || versionId === null || versionId === '') {
|
|
15942
|
+
throw 'Missing the required parameter "versionId" when calling getCasemanagementCaseplanVersionStageplan';
|
|
15943
|
+
}
|
|
15944
|
+
// verify the required parameter 'stageplanId' is set
|
|
15945
|
+
if (stageplanId === undefined || stageplanId === null || stageplanId === '') {
|
|
15946
|
+
throw 'Missing the required parameter "stageplanId" when calling getCasemanagementCaseplanVersionStageplan';
|
|
15947
|
+
}
|
|
15948
|
+
|
|
15949
|
+
return this.apiClient.callApi(
|
|
15950
|
+
'/api/v2/casemanagement/caseplans/{caseplanId}/versions/{versionId}/stageplans/{stageplanId}',
|
|
15951
|
+
'GET',
|
|
15952
|
+
{ 'caseplanId': caseplanId,'versionId': versionId,'stageplanId': stageplanId },
|
|
15953
|
+
{ 'expands': this.apiClient.buildCollectionParam(opts['expands'], 'multi') },
|
|
15954
|
+
{ },
|
|
15955
|
+
{ },
|
|
15956
|
+
null,
|
|
15957
|
+
['PureCloud OAuth'],
|
|
15958
|
+
['application/json'],
|
|
15959
|
+
['application/json']
|
|
15960
|
+
);
|
|
15961
|
+
}
|
|
15962
|
+
|
|
15963
|
+
/**
|
|
15964
|
+
* Get a Stepplan.
|
|
15965
|
+
*
|
|
15966
|
+
* @param {String} caseplanId Caseplan ID
|
|
15967
|
+
* @param {String} versionId Version ID
|
|
15968
|
+
* @param {String} stageplanId Stageplan ID
|
|
15969
|
+
* @param {String} stepplanId Stepplan ID
|
|
15970
|
+
* @param {Object} opts Optional parameters
|
|
15971
|
+
* @param {Array.<String>} opts.expands Which fields to expand.
|
|
15972
|
+
* getCasemanagementCaseplanVersionStageplanStepplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15973
|
+
*/
|
|
15974
|
+
getCasemanagementCaseplanVersionStageplanStepplan(caseplanId, versionId, stageplanId, stepplanId, opts) {
|
|
15975
|
+
opts = opts || {};
|
|
15976
|
+
|
|
15977
|
+
// verify the required parameter 'caseplanId' is set
|
|
15978
|
+
if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
|
|
15979
|
+
throw 'Missing the required parameter "caseplanId" when calling getCasemanagementCaseplanVersionStageplanStepplan';
|
|
15980
|
+
}
|
|
15981
|
+
// verify the required parameter 'versionId' is set
|
|
15982
|
+
if (versionId === undefined || versionId === null || versionId === '') {
|
|
15983
|
+
throw 'Missing the required parameter "versionId" when calling getCasemanagementCaseplanVersionStageplanStepplan';
|
|
15984
|
+
}
|
|
15985
|
+
// verify the required parameter 'stageplanId' is set
|
|
15986
|
+
if (stageplanId === undefined || stageplanId === null || stageplanId === '') {
|
|
15987
|
+
throw 'Missing the required parameter "stageplanId" when calling getCasemanagementCaseplanVersionStageplanStepplan';
|
|
15988
|
+
}
|
|
15989
|
+
// verify the required parameter 'stepplanId' is set
|
|
15990
|
+
if (stepplanId === undefined || stepplanId === null || stepplanId === '') {
|
|
15991
|
+
throw 'Missing the required parameter "stepplanId" when calling getCasemanagementCaseplanVersionStageplanStepplan';
|
|
15992
|
+
}
|
|
15993
|
+
|
|
15994
|
+
return this.apiClient.callApi(
|
|
15995
|
+
'/api/v2/casemanagement/caseplans/{caseplanId}/versions/{versionId}/stageplans/{stageplanId}/stepplans/{stepplanId}',
|
|
15996
|
+
'GET',
|
|
15997
|
+
{ 'caseplanId': caseplanId,'versionId': versionId,'stageplanId': stageplanId,'stepplanId': stepplanId },
|
|
15998
|
+
{ 'expands': this.apiClient.buildCollectionParam(opts['expands'], 'multi') },
|
|
15999
|
+
{ },
|
|
16000
|
+
{ },
|
|
16001
|
+
null,
|
|
16002
|
+
['PureCloud OAuth'],
|
|
16003
|
+
['application/json'],
|
|
16004
|
+
['application/json']
|
|
16005
|
+
);
|
|
16006
|
+
}
|
|
16007
|
+
|
|
16008
|
+
/**
|
|
16009
|
+
* Get a list of Stepplans.
|
|
16010
|
+
*
|
|
16011
|
+
* @param {String} caseplanId Caseplan ID
|
|
16012
|
+
* @param {String} versionId Version ID
|
|
16013
|
+
* @param {String} stageplanId Stageplan ID
|
|
16014
|
+
* @param {Object} opts Optional parameters
|
|
16015
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
16016
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
16017
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
16018
|
+
* @param {Array.<String>} opts.expands Which fields to expand.
|
|
16019
|
+
* getCasemanagementCaseplanVersionStageplanStepplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16020
|
+
*/
|
|
16021
|
+
getCasemanagementCaseplanVersionStageplanStepplans(caseplanId, versionId, stageplanId, opts) {
|
|
16022
|
+
opts = opts || {};
|
|
16023
|
+
|
|
16024
|
+
// verify the required parameter 'caseplanId' is set
|
|
16025
|
+
if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
|
|
16026
|
+
throw 'Missing the required parameter "caseplanId" when calling getCasemanagementCaseplanVersionStageplanStepplans';
|
|
16027
|
+
}
|
|
16028
|
+
// verify the required parameter 'versionId' is set
|
|
16029
|
+
if (versionId === undefined || versionId === null || versionId === '') {
|
|
16030
|
+
throw 'Missing the required parameter "versionId" when calling getCasemanagementCaseplanVersionStageplanStepplans';
|
|
16031
|
+
}
|
|
16032
|
+
// verify the required parameter 'stageplanId' is set
|
|
16033
|
+
if (stageplanId === undefined || stageplanId === null || stageplanId === '') {
|
|
16034
|
+
throw 'Missing the required parameter "stageplanId" when calling getCasemanagementCaseplanVersionStageplanStepplans';
|
|
16035
|
+
}
|
|
16036
|
+
|
|
16037
|
+
return this.apiClient.callApi(
|
|
16038
|
+
'/api/v2/casemanagement/caseplans/{caseplanId}/versions/{versionId}/stageplans/{stageplanId}/stepplans',
|
|
16039
|
+
'GET',
|
|
16040
|
+
{ 'caseplanId': caseplanId,'versionId': versionId,'stageplanId': stageplanId },
|
|
16041
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'expands': this.apiClient.buildCollectionParam(opts['expands'], 'multi') },
|
|
16042
|
+
{ },
|
|
16043
|
+
{ },
|
|
16044
|
+
null,
|
|
16045
|
+
['PureCloud OAuth'],
|
|
16046
|
+
['application/json'],
|
|
16047
|
+
['application/json']
|
|
16048
|
+
);
|
|
16049
|
+
}
|
|
16050
|
+
|
|
16051
|
+
/**
|
|
16052
|
+
* Get a list of Stageplans.
|
|
16053
|
+
*
|
|
16054
|
+
* @param {String} caseplanId Caseplan ID
|
|
16055
|
+
* @param {String} versionId Version ID
|
|
16056
|
+
* @param {Object} opts Optional parameters
|
|
16057
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
16058
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
16059
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
16060
|
+
* @param {Array.<String>} opts.expands Which fields to expand.
|
|
16061
|
+
* getCasemanagementCaseplanVersionStageplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16062
|
+
*/
|
|
16063
|
+
getCasemanagementCaseplanVersionStageplans(caseplanId, versionId, opts) {
|
|
16064
|
+
opts = opts || {};
|
|
16065
|
+
|
|
16066
|
+
// verify the required parameter 'caseplanId' is set
|
|
16067
|
+
if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
|
|
16068
|
+
throw 'Missing the required parameter "caseplanId" when calling getCasemanagementCaseplanVersionStageplans';
|
|
16069
|
+
}
|
|
16070
|
+
// verify the required parameter 'versionId' is set
|
|
16071
|
+
if (versionId === undefined || versionId === null || versionId === '') {
|
|
16072
|
+
throw 'Missing the required parameter "versionId" when calling getCasemanagementCaseplanVersionStageplans';
|
|
16073
|
+
}
|
|
16074
|
+
|
|
16075
|
+
return this.apiClient.callApi(
|
|
16076
|
+
'/api/v2/casemanagement/caseplans/{caseplanId}/versions/{versionId}/stageplans',
|
|
16077
|
+
'GET',
|
|
16078
|
+
{ 'caseplanId': caseplanId,'versionId': versionId },
|
|
16079
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'expands': this.apiClient.buildCollectionParam(opts['expands'], 'multi') },
|
|
16080
|
+
{ },
|
|
16081
|
+
{ },
|
|
16082
|
+
null,
|
|
16083
|
+
['PureCloud OAuth'],
|
|
16084
|
+
['application/json'],
|
|
16085
|
+
['application/json']
|
|
16086
|
+
);
|
|
16087
|
+
}
|
|
16088
|
+
|
|
16089
|
+
/**
|
|
16090
|
+
* Get a list of Caseplans.
|
|
16091
|
+
*
|
|
16092
|
+
* @param {Object} opts Optional parameters
|
|
16093
|
+
* @param {String} opts.after The cursor that points to the end of the set of caseplans that has been returned.
|
|
16094
|
+
* @param {Number} opts.pageSize Number of caseplans to return. Maximum of 200.
|
|
16095
|
+
* @param {String} opts.customerIntentId Filter by Customer Intent.
|
|
16096
|
+
* @param {String} opts.divisionIds Filter by Divisions.
|
|
16097
|
+
* getCasemanagementCaseplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16098
|
+
*/
|
|
16099
|
+
getCasemanagementCaseplans(opts) {
|
|
16100
|
+
opts = opts || {};
|
|
16101
|
+
|
|
16102
|
+
|
|
16103
|
+
return this.apiClient.callApi(
|
|
16104
|
+
'/api/v2/casemanagement/caseplans',
|
|
16105
|
+
'GET',
|
|
16106
|
+
{ },
|
|
16107
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'customerIntentId': opts['customerIntentId'],'divisionIds': opts['divisionIds'] },
|
|
16108
|
+
{ },
|
|
16109
|
+
{ },
|
|
16110
|
+
null,
|
|
16111
|
+
['PureCloud OAuth'],
|
|
16112
|
+
['application/json'],
|
|
16113
|
+
['application/json']
|
|
16114
|
+
);
|
|
16115
|
+
}
|
|
16116
|
+
|
|
16117
|
+
/**
|
|
16118
|
+
* Get a list of cases for provided external contact id.
|
|
16119
|
+
*
|
|
16120
|
+
* @param {String} externalContactId External Contact ID
|
|
16121
|
+
* @param {Object} opts Optional parameters
|
|
16122
|
+
* @param {String} opts.after The cursor that points to the end of the set of cases that has been returned.
|
|
16123
|
+
* @param {Number} opts.pageSize Number of cases to return. Maximum of 200.
|
|
16124
|
+
* @param {String} opts.divisionIds Filter by Divisions
|
|
16125
|
+
* @param {Array.<String>} opts.expands Which fields to expand.
|
|
16126
|
+
* getCasemanagementCasesExternalcontact is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16127
|
+
*/
|
|
16128
|
+
getCasemanagementCasesExternalcontact(externalContactId, opts) {
|
|
16129
|
+
opts = opts || {};
|
|
16130
|
+
|
|
16131
|
+
// verify the required parameter 'externalContactId' is set
|
|
16132
|
+
if (externalContactId === undefined || externalContactId === null || externalContactId === '') {
|
|
16133
|
+
throw 'Missing the required parameter "externalContactId" when calling getCasemanagementCasesExternalcontact';
|
|
16134
|
+
}
|
|
16135
|
+
|
|
16136
|
+
return this.apiClient.callApi(
|
|
16137
|
+
'/api/v2/casemanagement/cases/externalcontacts/{externalContactId}',
|
|
16138
|
+
'GET',
|
|
16139
|
+
{ 'externalContactId': externalContactId },
|
|
16140
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'divisionIds': opts['divisionIds'],'expands': this.apiClient.buildCollectionParam(opts['expands'], 'multi') },
|
|
16141
|
+
{ },
|
|
16142
|
+
{ },
|
|
16143
|
+
null,
|
|
16144
|
+
['PureCloud OAuth'],
|
|
16145
|
+
['application/json'],
|
|
16146
|
+
['application/json']
|
|
16147
|
+
);
|
|
16148
|
+
}
|
|
16149
|
+
|
|
16150
|
+
/**
|
|
16151
|
+
* Get a Case by reference.
|
|
16152
|
+
*
|
|
16153
|
+
* @param {String} referenceId Reference
|
|
16154
|
+
* @param {Object} opts Optional parameters
|
|
16155
|
+
* @param {Object} opts.expands Which fields to expand.
|
|
16156
|
+
* getCasemanagementCasesReference is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16157
|
+
*/
|
|
16158
|
+
getCasemanagementCasesReference(referenceId, opts) {
|
|
16159
|
+
opts = opts || {};
|
|
16160
|
+
|
|
16161
|
+
// verify the required parameter 'referenceId' is set
|
|
16162
|
+
if (referenceId === undefined || referenceId === null || referenceId === '') {
|
|
16163
|
+
throw 'Missing the required parameter "referenceId" when calling getCasemanagementCasesReference';
|
|
16164
|
+
}
|
|
16165
|
+
|
|
16166
|
+
return this.apiClient.callApi(
|
|
16167
|
+
'/api/v2/casemanagement/cases/references/{referenceId}',
|
|
16168
|
+
'GET',
|
|
16169
|
+
{ 'referenceId': referenceId },
|
|
16170
|
+
{ 'expands': opts['expands'] },
|
|
16171
|
+
{ },
|
|
16172
|
+
{ },
|
|
16173
|
+
null,
|
|
16174
|
+
['PureCloud OAuth'],
|
|
16175
|
+
['application/json'],
|
|
16176
|
+
['application/json']
|
|
16177
|
+
);
|
|
16178
|
+
}
|
|
16179
|
+
|
|
16180
|
+
/**
|
|
16181
|
+
* Update date due of a Case.
|
|
16182
|
+
*
|
|
16183
|
+
* @param {String} caseId Case ID
|
|
16184
|
+
* @param {Object} body Date due
|
|
16185
|
+
* patchCasemanagementCaseDatedue is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16186
|
+
*/
|
|
16187
|
+
patchCasemanagementCaseDatedue(caseId, body) {
|
|
16188
|
+
// verify the required parameter 'caseId' is set
|
|
16189
|
+
if (caseId === undefined || caseId === null || caseId === '') {
|
|
16190
|
+
throw 'Missing the required parameter "caseId" when calling patchCasemanagementCaseDatedue';
|
|
16191
|
+
}
|
|
16192
|
+
// verify the required parameter 'body' is set
|
|
16193
|
+
if (body === undefined || body === null) {
|
|
16194
|
+
throw 'Missing the required parameter "body" when calling patchCasemanagementCaseDatedue';
|
|
16195
|
+
}
|
|
16196
|
+
|
|
16197
|
+
return this.apiClient.callApi(
|
|
16198
|
+
'/api/v2/casemanagement/cases/{caseId}/datedue',
|
|
16199
|
+
'PATCH',
|
|
16200
|
+
{ 'caseId': caseId },
|
|
16201
|
+
{ },
|
|
16202
|
+
{ },
|
|
16203
|
+
{ },
|
|
16204
|
+
body,
|
|
16205
|
+
['PureCloud OAuth'],
|
|
16206
|
+
['application/json'],
|
|
16207
|
+
['application/json']
|
|
16208
|
+
);
|
|
16209
|
+
}
|
|
16210
|
+
|
|
16211
|
+
/**
|
|
16212
|
+
* Update priority of a Case.
|
|
16213
|
+
*
|
|
16214
|
+
* @param {String} caseId Case ID
|
|
16215
|
+
* @param {Object} body Priority
|
|
16216
|
+
* patchCasemanagementCasePriority is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16217
|
+
*/
|
|
16218
|
+
patchCasemanagementCasePriority(caseId, body) {
|
|
16219
|
+
// verify the required parameter 'caseId' is set
|
|
16220
|
+
if (caseId === undefined || caseId === null || caseId === '') {
|
|
16221
|
+
throw 'Missing the required parameter "caseId" when calling patchCasemanagementCasePriority';
|
|
16222
|
+
}
|
|
16223
|
+
// verify the required parameter 'body' is set
|
|
16224
|
+
if (body === undefined || body === null) {
|
|
16225
|
+
throw 'Missing the required parameter "body" when calling patchCasemanagementCasePriority';
|
|
16226
|
+
}
|
|
16227
|
+
|
|
16228
|
+
return this.apiClient.callApi(
|
|
16229
|
+
'/api/v2/casemanagement/cases/{caseId}/priority',
|
|
16230
|
+
'PATCH',
|
|
16231
|
+
{ 'caseId': caseId },
|
|
16232
|
+
{ },
|
|
16233
|
+
{ },
|
|
16234
|
+
{ },
|
|
16235
|
+
body,
|
|
16236
|
+
['PureCloud OAuth'],
|
|
16237
|
+
['application/json'],
|
|
16238
|
+
['application/json']
|
|
16239
|
+
);
|
|
16240
|
+
}
|
|
16241
|
+
|
|
16242
|
+
/**
|
|
16243
|
+
* Update summary of a Case.
|
|
16244
|
+
*
|
|
16245
|
+
* @param {String} caseId Case ID
|
|
16246
|
+
* @param {Object} body Summary
|
|
16247
|
+
* patchCasemanagementCaseSummary is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16248
|
+
*/
|
|
16249
|
+
patchCasemanagementCaseSummary(caseId, body) {
|
|
16250
|
+
// verify the required parameter 'caseId' is set
|
|
16251
|
+
if (caseId === undefined || caseId === null || caseId === '') {
|
|
16252
|
+
throw 'Missing the required parameter "caseId" when calling patchCasemanagementCaseSummary';
|
|
16253
|
+
}
|
|
16254
|
+
// verify the required parameter 'body' is set
|
|
16255
|
+
if (body === undefined || body === null) {
|
|
16256
|
+
throw 'Missing the required parameter "body" when calling patchCasemanagementCaseSummary';
|
|
16257
|
+
}
|
|
16258
|
+
|
|
16259
|
+
return this.apiClient.callApi(
|
|
16260
|
+
'/api/v2/casemanagement/cases/{caseId}/summary',
|
|
16261
|
+
'PATCH',
|
|
16262
|
+
{ 'caseId': caseId },
|
|
16263
|
+
{ },
|
|
16264
|
+
{ },
|
|
16265
|
+
{ },
|
|
16266
|
+
body,
|
|
16267
|
+
['PureCloud OAuth'],
|
|
16268
|
+
['application/json'],
|
|
16269
|
+
['application/json']
|
|
16270
|
+
);
|
|
16271
|
+
}
|
|
16272
|
+
|
|
16273
|
+
/**
|
|
16274
|
+
* Update the attributes of a Caseplan.
|
|
16275
|
+
*
|
|
16276
|
+
* @param {String} caseplanId Caseplan ID
|
|
16277
|
+
* @param {Object} body Caseplan
|
|
16278
|
+
* patchCasemanagementCaseplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16279
|
+
*/
|
|
16280
|
+
patchCasemanagementCaseplan(caseplanId, body) {
|
|
16281
|
+
// verify the required parameter 'caseplanId' is set
|
|
16282
|
+
if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
|
|
16283
|
+
throw 'Missing the required parameter "caseplanId" when calling patchCasemanagementCaseplan';
|
|
16284
|
+
}
|
|
16285
|
+
// verify the required parameter 'body' is set
|
|
16286
|
+
if (body === undefined || body === null) {
|
|
16287
|
+
throw 'Missing the required parameter "body" when calling patchCasemanagementCaseplan';
|
|
16288
|
+
}
|
|
16289
|
+
|
|
16290
|
+
return this.apiClient.callApi(
|
|
16291
|
+
'/api/v2/casemanagement/caseplans/{caseplanId}',
|
|
16292
|
+
'PATCH',
|
|
16293
|
+
{ 'caseplanId': caseplanId },
|
|
16294
|
+
{ },
|
|
16295
|
+
{ },
|
|
16296
|
+
{ },
|
|
16297
|
+
body,
|
|
16298
|
+
['PureCloud OAuth'],
|
|
16299
|
+
['application/json'],
|
|
16300
|
+
['application/json']
|
|
16301
|
+
);
|
|
16302
|
+
}
|
|
16303
|
+
|
|
16304
|
+
/**
|
|
16305
|
+
* Update the attributes of a Stageplan.
|
|
16306
|
+
*
|
|
16307
|
+
* @param {String} caseplanId Caseplan ID
|
|
16308
|
+
* @param {String} stageplanId Stageplan ID
|
|
16309
|
+
* @param {Object} body Stageplan
|
|
16310
|
+
* patchCasemanagementCaseplanStageplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16311
|
+
*/
|
|
16312
|
+
patchCasemanagementCaseplanStageplan(caseplanId, stageplanId, body) {
|
|
16313
|
+
// verify the required parameter 'caseplanId' is set
|
|
16314
|
+
if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
|
|
16315
|
+
throw 'Missing the required parameter "caseplanId" when calling patchCasemanagementCaseplanStageplan';
|
|
16316
|
+
}
|
|
16317
|
+
// verify the required parameter 'stageplanId' is set
|
|
16318
|
+
if (stageplanId === undefined || stageplanId === null || stageplanId === '') {
|
|
16319
|
+
throw 'Missing the required parameter "stageplanId" when calling patchCasemanagementCaseplanStageplan';
|
|
16320
|
+
}
|
|
16321
|
+
// verify the required parameter 'body' is set
|
|
16322
|
+
if (body === undefined || body === null) {
|
|
16323
|
+
throw 'Missing the required parameter "body" when calling patchCasemanagementCaseplanStageplan';
|
|
16324
|
+
}
|
|
16325
|
+
|
|
16326
|
+
return this.apiClient.callApi(
|
|
16327
|
+
'/api/v2/casemanagement/caseplans/{caseplanId}/stageplans/{stageplanId}',
|
|
16328
|
+
'PATCH',
|
|
16329
|
+
{ 'caseplanId': caseplanId,'stageplanId': stageplanId },
|
|
16330
|
+
{ },
|
|
16331
|
+
{ },
|
|
16332
|
+
{ },
|
|
16333
|
+
body,
|
|
16334
|
+
['PureCloud OAuth'],
|
|
16335
|
+
['application/json'],
|
|
16336
|
+
['application/json']
|
|
16337
|
+
);
|
|
16338
|
+
}
|
|
16339
|
+
|
|
16340
|
+
/**
|
|
16341
|
+
* Update the attributes of a Stepplan.
|
|
16342
|
+
*
|
|
16343
|
+
* @param {String} caseplanId Caseplan ID
|
|
16344
|
+
* @param {String} stageplanId Stageplan ID
|
|
16345
|
+
* @param {String} stepplanId Stepplan ID
|
|
16346
|
+
* @param {Object} body Stepplan
|
|
16347
|
+
* patchCasemanagementCaseplanStageplanStepplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16348
|
+
*/
|
|
16349
|
+
patchCasemanagementCaseplanStageplanStepplan(caseplanId, stageplanId, stepplanId, body) {
|
|
16350
|
+
// verify the required parameter 'caseplanId' is set
|
|
16351
|
+
if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
|
|
16352
|
+
throw 'Missing the required parameter "caseplanId" when calling patchCasemanagementCaseplanStageplanStepplan';
|
|
16353
|
+
}
|
|
16354
|
+
// verify the required parameter 'stageplanId' is set
|
|
16355
|
+
if (stageplanId === undefined || stageplanId === null || stageplanId === '') {
|
|
16356
|
+
throw 'Missing the required parameter "stageplanId" when calling patchCasemanagementCaseplanStageplanStepplan';
|
|
16357
|
+
}
|
|
16358
|
+
// verify the required parameter 'stepplanId' is set
|
|
16359
|
+
if (stepplanId === undefined || stepplanId === null || stepplanId === '') {
|
|
16360
|
+
throw 'Missing the required parameter "stepplanId" when calling patchCasemanagementCaseplanStageplanStepplan';
|
|
16361
|
+
}
|
|
16362
|
+
// verify the required parameter 'body' is set
|
|
16363
|
+
if (body === undefined || body === null) {
|
|
16364
|
+
throw 'Missing the required parameter "body" when calling patchCasemanagementCaseplanStageplanStepplan';
|
|
16365
|
+
}
|
|
16366
|
+
|
|
16367
|
+
return this.apiClient.callApi(
|
|
16368
|
+
'/api/v2/casemanagement/caseplans/{caseplanId}/stageplans/{stageplanId}/stepplans/{stepplanId}',
|
|
16369
|
+
'PATCH',
|
|
16370
|
+
{ 'caseplanId': caseplanId,'stageplanId': stageplanId,'stepplanId': stepplanId },
|
|
16371
|
+
{ },
|
|
16372
|
+
{ },
|
|
16373
|
+
{ },
|
|
16374
|
+
body,
|
|
16375
|
+
['PureCloud OAuth'],
|
|
16376
|
+
['application/json'],
|
|
16377
|
+
['application/json']
|
|
16378
|
+
);
|
|
16379
|
+
}
|
|
16380
|
+
|
|
16381
|
+
/**
|
|
16382
|
+
* Create a case association.
|
|
16383
|
+
*
|
|
16384
|
+
* @param {String} caseId Case ID.
|
|
16385
|
+
* @param {Object} opts Optional parameters
|
|
16386
|
+
* @param {Object} opts.body Case Association
|
|
16387
|
+
* postCasemanagementCaseAssociations is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16388
|
+
*/
|
|
16389
|
+
postCasemanagementCaseAssociations(caseId, opts) {
|
|
16390
|
+
opts = opts || {};
|
|
16391
|
+
|
|
16392
|
+
// verify the required parameter 'caseId' is set
|
|
16393
|
+
if (caseId === undefined || caseId === null || caseId === '') {
|
|
16394
|
+
throw 'Missing the required parameter "caseId" when calling postCasemanagementCaseAssociations';
|
|
16395
|
+
}
|
|
16396
|
+
|
|
16397
|
+
return this.apiClient.callApi(
|
|
16398
|
+
'/api/v2/casemanagement/cases/{caseId}/associations',
|
|
16399
|
+
'POST',
|
|
16400
|
+
{ 'caseId': caseId },
|
|
16401
|
+
{ },
|
|
16402
|
+
{ },
|
|
16403
|
+
{ },
|
|
16404
|
+
opts['body'],
|
|
16405
|
+
['PureCloud OAuth'],
|
|
16406
|
+
['application/json'],
|
|
16407
|
+
['application/json']
|
|
16408
|
+
);
|
|
16409
|
+
}
|
|
16410
|
+
|
|
16411
|
+
/**
|
|
16412
|
+
* Create a Terminate Job for a Case.
|
|
16413
|
+
*
|
|
16414
|
+
* @param {String} caseId Case ID
|
|
16415
|
+
* postCasemanagementCaseTerminateJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16416
|
+
*/
|
|
16417
|
+
postCasemanagementCaseTerminateJobs(caseId) {
|
|
16418
|
+
// verify the required parameter 'caseId' is set
|
|
16419
|
+
if (caseId === undefined || caseId === null || caseId === '') {
|
|
16420
|
+
throw 'Missing the required parameter "caseId" when calling postCasemanagementCaseTerminateJobs';
|
|
16421
|
+
}
|
|
16422
|
+
|
|
16423
|
+
return this.apiClient.callApi(
|
|
16424
|
+
'/api/v2/casemanagement/cases/{caseId}/terminate/jobs',
|
|
16425
|
+
'POST',
|
|
16426
|
+
{ 'caseId': caseId },
|
|
16427
|
+
{ },
|
|
16428
|
+
{ },
|
|
16429
|
+
{ },
|
|
16430
|
+
null,
|
|
16431
|
+
['PureCloud OAuth'],
|
|
16432
|
+
['application/json'],
|
|
16433
|
+
['application/json']
|
|
16434
|
+
);
|
|
16435
|
+
}
|
|
16436
|
+
|
|
16437
|
+
/**
|
|
16438
|
+
* Publish Caseplan.
|
|
16439
|
+
*
|
|
16440
|
+
* @param {String} caseplanId Caseplan ID
|
|
16441
|
+
* postCasemanagementCaseplanPublish is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16442
|
+
*/
|
|
16443
|
+
postCasemanagementCaseplanPublish(caseplanId) {
|
|
16444
|
+
// verify the required parameter 'caseplanId' is set
|
|
16445
|
+
if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
|
|
16446
|
+
throw 'Missing the required parameter "caseplanId" when calling postCasemanagementCaseplanPublish';
|
|
16447
|
+
}
|
|
16448
|
+
|
|
16449
|
+
return this.apiClient.callApi(
|
|
16450
|
+
'/api/v2/casemanagement/caseplans/{caseplanId}/publish',
|
|
16451
|
+
'POST',
|
|
16452
|
+
{ 'caseplanId': caseplanId },
|
|
16453
|
+
{ },
|
|
16454
|
+
{ },
|
|
16455
|
+
{ },
|
|
16456
|
+
null,
|
|
16457
|
+
['PureCloud OAuth'],
|
|
16458
|
+
['application/json'],
|
|
16459
|
+
['application/json']
|
|
16460
|
+
);
|
|
16461
|
+
}
|
|
16462
|
+
|
|
16463
|
+
/**
|
|
16464
|
+
* Create Caseplan version.
|
|
16465
|
+
*
|
|
16466
|
+
* @param {String} caseplanId Caseplan ID
|
|
16467
|
+
* postCasemanagementCaseplanVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16468
|
+
*/
|
|
16469
|
+
postCasemanagementCaseplanVersions(caseplanId) {
|
|
16470
|
+
// verify the required parameter 'caseplanId' is set
|
|
16471
|
+
if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
|
|
16472
|
+
throw 'Missing the required parameter "caseplanId" when calling postCasemanagementCaseplanVersions';
|
|
16473
|
+
}
|
|
16474
|
+
|
|
16475
|
+
return this.apiClient.callApi(
|
|
16476
|
+
'/api/v2/casemanagement/caseplans/{caseplanId}/versions',
|
|
16477
|
+
'POST',
|
|
16478
|
+
{ 'caseplanId': caseplanId },
|
|
16479
|
+
{ },
|
|
16480
|
+
{ },
|
|
16481
|
+
{ },
|
|
16482
|
+
null,
|
|
16483
|
+
['PureCloud OAuth'],
|
|
16484
|
+
['application/json'],
|
|
16485
|
+
['application/json']
|
|
16486
|
+
);
|
|
16487
|
+
}
|
|
16488
|
+
|
|
16489
|
+
/**
|
|
16490
|
+
* Create a Caseplan.
|
|
16491
|
+
*
|
|
16492
|
+
* @param {Object} body Caseplan
|
|
16493
|
+
* postCasemanagementCaseplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16494
|
+
*/
|
|
16495
|
+
postCasemanagementCaseplans(body) {
|
|
16496
|
+
// verify the required parameter 'body' is set
|
|
16497
|
+
if (body === undefined || body === null) {
|
|
16498
|
+
throw 'Missing the required parameter "body" when calling postCasemanagementCaseplans';
|
|
16499
|
+
}
|
|
16500
|
+
|
|
16501
|
+
return this.apiClient.callApi(
|
|
16502
|
+
'/api/v2/casemanagement/caseplans',
|
|
16503
|
+
'POST',
|
|
16504
|
+
{ },
|
|
16505
|
+
{ },
|
|
16506
|
+
{ },
|
|
16507
|
+
{ },
|
|
16508
|
+
body,
|
|
16509
|
+
['PureCloud OAuth'],
|
|
16510
|
+
['application/json'],
|
|
16511
|
+
['application/json']
|
|
16512
|
+
);
|
|
16513
|
+
}
|
|
16514
|
+
|
|
16515
|
+
/**
|
|
16516
|
+
* Create a Case.
|
|
16517
|
+
*
|
|
16518
|
+
* @param {Object} body Case
|
|
16519
|
+
* postCasemanagementCases is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16520
|
+
*/
|
|
16521
|
+
postCasemanagementCases(body) {
|
|
16522
|
+
// verify the required parameter 'body' is set
|
|
16523
|
+
if (body === undefined || body === null) {
|
|
16524
|
+
throw 'Missing the required parameter "body" when calling postCasemanagementCases';
|
|
16525
|
+
}
|
|
16526
|
+
|
|
16527
|
+
return this.apiClient.callApi(
|
|
16528
|
+
'/api/v2/casemanagement/cases',
|
|
16529
|
+
'POST',
|
|
16530
|
+
{ },
|
|
16531
|
+
{ },
|
|
16532
|
+
{ },
|
|
16533
|
+
{ },
|
|
16534
|
+
body,
|
|
16535
|
+
['PureCloud OAuth'],
|
|
16536
|
+
['application/json'],
|
|
16537
|
+
['application/json']
|
|
16538
|
+
);
|
|
16539
|
+
}
|
|
16540
|
+
|
|
16541
|
+
/**
|
|
16542
|
+
* Query for case associations
|
|
16543
|
+
*
|
|
16544
|
+
* @param {Object} opts Optional parameters
|
|
16545
|
+
* @param {Object} opts.body Case Association
|
|
16546
|
+
* postCasemanagementCasesAssociationsQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16547
|
+
*/
|
|
16548
|
+
postCasemanagementCasesAssociationsQuery(opts) {
|
|
16549
|
+
opts = opts || {};
|
|
16550
|
+
|
|
16551
|
+
|
|
16552
|
+
return this.apiClient.callApi(
|
|
16553
|
+
'/api/v2/casemanagement/cases/associations/query',
|
|
16554
|
+
'POST',
|
|
16555
|
+
{ },
|
|
16556
|
+
{ },
|
|
16557
|
+
{ },
|
|
16558
|
+
{ },
|
|
16559
|
+
opts['body'],
|
|
16560
|
+
['PureCloud OAuth'],
|
|
16561
|
+
['application/json'],
|
|
16562
|
+
['application/json']
|
|
16563
|
+
);
|
|
16564
|
+
}
|
|
16565
|
+
|
|
16566
|
+
}
|
|
16567
|
+
|
|
15473
16568
|
class ChatApi {
|
|
15474
16569
|
/**
|
|
15475
16570
|
* Chat service.
|
|
15476
16571
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
15477
|
-
* @version
|
|
16572
|
+
* @version 249.0.0
|
|
15478
16573
|
*/
|
|
15479
16574
|
|
|
15480
16575
|
/**
|
|
@@ -16455,7 +17550,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16455
17550
|
/**
|
|
16456
17551
|
* Coaching service.
|
|
16457
17552
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
16458
|
-
* @version
|
|
17553
|
+
* @version 249.0.0
|
|
16459
17554
|
*/
|
|
16460
17555
|
|
|
16461
17556
|
/**
|
|
@@ -17082,7 +18177,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17082
18177
|
/**
|
|
17083
18178
|
* ContentManagement service.
|
|
17084
18179
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
17085
|
-
* @version
|
|
18180
|
+
* @version 249.0.0
|
|
17086
18181
|
*/
|
|
17087
18182
|
|
|
17088
18183
|
/**
|
|
@@ -18163,7 +19258,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18163
19258
|
/**
|
|
18164
19259
|
* Conversations service.
|
|
18165
19260
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
18166
|
-
* @version
|
|
19261
|
+
* @version 249.0.0
|
|
18167
19262
|
*/
|
|
18168
19263
|
|
|
18169
19264
|
/**
|
|
@@ -19673,8 +20768,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19673
20768
|
}
|
|
19674
20769
|
|
|
19675
20770
|
/**
|
|
19676
|
-
* Get active
|
|
19677
|
-
*
|
|
20771
|
+
* Get the logged-in user's active conversations and their Callback participants state.
|
|
20772
|
+
* This endpoint answers three questions:- Is the user involved in any active conversation? - Does that active conversation include Callbacks? - Is the user directly participating in a Callback within that conversation?
|
|
19678
20773
|
*/
|
|
19679
20774
|
getConversationsCallbacks() {
|
|
19680
20775
|
|
|
@@ -19693,8 +20788,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19693
20788
|
}
|
|
19694
20789
|
|
|
19695
20790
|
/**
|
|
19696
|
-
* Get active
|
|
19697
|
-
*
|
|
20791
|
+
* Get the logged-in user's active conversations and their Call participants state.
|
|
20792
|
+
* This endpoint answers three questions:- Is the user involved in any active conversation? - Does that active conversation include Calls? - Is the user directly participating in a Call within that conversation?
|
|
19698
20793
|
*/
|
|
19699
20794
|
getConversationsCalls() {
|
|
19700
20795
|
|
|
@@ -20351,8 +21446,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20351
21446
|
* Get conversation messages
|
|
20352
21447
|
*
|
|
20353
21448
|
* @param {String} conversationId conversationId
|
|
21449
|
+
* @param {Object} opts Optional parameters
|
|
21450
|
+
* @param {Boolean} opts.includeAgentlessStitchedMessages Whether to include Agentless 'api' type of messages, on stitched conversations. If you provide a conversationId in the agentless email request (/api/v2/conversations/emails/agentless) that matches an existing conversation, then that's a stitched agentless message. (default to false)
|
|
20354
21451
|
*/
|
|
20355
|
-
getConversationsEmailMessages(conversationId) {
|
|
21452
|
+
getConversationsEmailMessages(conversationId, opts) {
|
|
21453
|
+
opts = opts || {};
|
|
21454
|
+
|
|
20356
21455
|
// verify the required parameter 'conversationId' is set
|
|
20357
21456
|
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
20358
21457
|
throw 'Missing the required parameter "conversationId" when calling getConversationsEmailMessages';
|
|
@@ -20362,7 +21461,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20362
21461
|
'/api/v2/conversations/emails/{conversationId}/messages',
|
|
20363
21462
|
'GET',
|
|
20364
21463
|
{ 'conversationId': conversationId },
|
|
20365
|
-
{
|
|
21464
|
+
{ 'includeAgentlessStitchedMessages': opts['includeAgentlessStitchedMessages'] },
|
|
20366
21465
|
{ },
|
|
20367
21466
|
{ },
|
|
20368
21467
|
null,
|
|
@@ -20526,8 +21625,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20526
21625
|
}
|
|
20527
21626
|
|
|
20528
21627
|
/**
|
|
20529
|
-
* Get active
|
|
20530
|
-
*
|
|
21628
|
+
* Get the logged-in user's active conversations and their Email participants state.
|
|
21629
|
+
* This endpoint answers three questions:- Is the user involved in any active conversation? - Does that active conversation include Emails? - Is the user directly participating in an Email within that conversation?
|
|
20531
21630
|
*/
|
|
20532
21631
|
getConversationsEmails() {
|
|
20533
21632
|
|
|
@@ -20571,8 +21670,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20571
21670
|
}
|
|
20572
21671
|
|
|
20573
21672
|
/**
|
|
20574
|
-
* Get
|
|
20575
|
-
*
|
|
21673
|
+
* Get the logged-in user's active conversations and their InternalMessage participants state.
|
|
21674
|
+
* This endpoint answers three questions:- Is the user involved in any active conversation? - Does that active conversation include InternalMessages? - Is the user directly participating in an InternalMessage within that conversation?
|
|
20576
21675
|
*/
|
|
20577
21676
|
getConversationsInternalmessages() {
|
|
20578
21677
|
|
|
@@ -20898,8 +21997,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20898
21997
|
}
|
|
20899
21998
|
|
|
20900
21999
|
/**
|
|
20901
|
-
* Get active
|
|
20902
|
-
*
|
|
22000
|
+
* Get the logged-in user's active conversations and their Message participants state.
|
|
22001
|
+
* This endpoint answers three questions:- Is the user involved in any active conversation? - Does that active conversation include Messages? - Is the user directly participating in a Message within that conversation?
|
|
20903
22002
|
*/
|
|
20904
22003
|
getConversationsMessages() {
|
|
20905
22004
|
|
|
@@ -27636,7 +28735,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27636
28735
|
/**
|
|
27637
28736
|
* Set the organization's default supported content profile that may be assigned to an integration when it is created.
|
|
27638
28737
|
* When an integration is created a supported content ID may be assigned to it. If the supported content ID is not supplied, the default supported content profile will be assigned to it.
|
|
27639
|
-
* @param {Object} body
|
|
28738
|
+
* @param {Object} body Reference to supported content profile
|
|
27640
28739
|
*/
|
|
27641
28740
|
putConversationsMessagingSupportedcontentDefault(body) {
|
|
27642
28741
|
// verify the required parameter 'body' is set
|
|
@@ -27780,7 +28879,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27780
28879
|
/**
|
|
27781
28880
|
* DataExtensions service.
|
|
27782
28881
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
27783
|
-
* @version
|
|
28882
|
+
* @version 249.0.0
|
|
27784
28883
|
*/
|
|
27785
28884
|
|
|
27786
28885
|
/**
|
|
@@ -27866,7 +28965,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27866
28965
|
/**
|
|
27867
28966
|
* DataPrivacy service.
|
|
27868
28967
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
27869
|
-
* @version
|
|
28968
|
+
* @version 249.0.0
|
|
27870
28969
|
*/
|
|
27871
28970
|
|
|
27872
28971
|
/**
|
|
@@ -28036,7 +29135,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28036
29135
|
/**
|
|
28037
29136
|
* Downloads service.
|
|
28038
29137
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
28039
|
-
* @version
|
|
29138
|
+
* @version 249.0.0
|
|
28040
29139
|
*/
|
|
28041
29140
|
|
|
28042
29141
|
/**
|
|
@@ -28088,7 +29187,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28088
29187
|
/**
|
|
28089
29188
|
* Emails service.
|
|
28090
29189
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
28091
|
-
* @version
|
|
29190
|
+
* @version 249.0.0
|
|
28092
29191
|
*/
|
|
28093
29192
|
|
|
28094
29193
|
/**
|
|
@@ -28217,7 +29316,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28217
29316
|
/**
|
|
28218
29317
|
* EmployeeEngagement service.
|
|
28219
29318
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
28220
|
-
* @version
|
|
29319
|
+
* @version 249.0.0
|
|
28221
29320
|
*/
|
|
28222
29321
|
|
|
28223
29322
|
/**
|
|
@@ -28397,7 +29496,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28397
29496
|
/**
|
|
28398
29497
|
* Events service.
|
|
28399
29498
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
28400
|
-
* @version
|
|
29499
|
+
* @version 249.0.0
|
|
28401
29500
|
*/
|
|
28402
29501
|
|
|
28403
29502
|
/**
|
|
@@ -28493,7 +29592,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28493
29592
|
/**
|
|
28494
29593
|
* ExternalContacts service.
|
|
28495
29594
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
28496
|
-
* @version
|
|
29595
|
+
* @version 249.0.0
|
|
28497
29596
|
*/
|
|
28498
29597
|
|
|
28499
29598
|
/**
|
|
@@ -30130,6 +31229,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30130
31229
|
);
|
|
30131
31230
|
}
|
|
30132
31231
|
|
|
31232
|
+
/**
|
|
31233
|
+
* Update specific fields of an external contact
|
|
31234
|
+
*
|
|
31235
|
+
* @param {String} contactId ExternalContact ID
|
|
31236
|
+
* @param {Object} body Contact fields to update
|
|
31237
|
+
*/
|
|
31238
|
+
patchExternalcontactsContact(contactId, body) {
|
|
31239
|
+
// verify the required parameter 'contactId' is set
|
|
31240
|
+
if (contactId === undefined || contactId === null || contactId === '') {
|
|
31241
|
+
throw 'Missing the required parameter "contactId" when calling patchExternalcontactsContact';
|
|
31242
|
+
}
|
|
31243
|
+
// verify the required parameter 'body' is set
|
|
31244
|
+
if (body === undefined || body === null) {
|
|
31245
|
+
throw 'Missing the required parameter "body" when calling patchExternalcontactsContact';
|
|
31246
|
+
}
|
|
31247
|
+
|
|
31248
|
+
return this.apiClient.callApi(
|
|
31249
|
+
'/api/v2/externalcontacts/contacts/{contactId}',
|
|
31250
|
+
'PATCH',
|
|
31251
|
+
{ 'contactId': contactId },
|
|
31252
|
+
{ },
|
|
31253
|
+
{ },
|
|
31254
|
+
{ },
|
|
31255
|
+
body,
|
|
31256
|
+
['PureCloud OAuth'],
|
|
31257
|
+
['application/json'],
|
|
31258
|
+
['application/json']
|
|
31259
|
+
);
|
|
31260
|
+
}
|
|
31261
|
+
|
|
30133
31262
|
/**
|
|
30134
31263
|
* Claim or release identifiers for a contact
|
|
30135
31264
|
*
|
|
@@ -31740,7 +32869,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31740
32869
|
/**
|
|
31741
32870
|
* Fax service.
|
|
31742
32871
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
31743
|
-
* @version
|
|
32872
|
+
* @version 249.0.0
|
|
31744
32873
|
*/
|
|
31745
32874
|
|
|
31746
32875
|
/**
|
|
@@ -31955,7 +33084,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31955
33084
|
/**
|
|
31956
33085
|
* Flows service.
|
|
31957
33086
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
31958
|
-
* @version
|
|
33087
|
+
* @version 249.0.0
|
|
31959
33088
|
*/
|
|
31960
33089
|
|
|
31961
33090
|
/**
|
|
@@ -32164,7 +33293,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32164
33293
|
/**
|
|
32165
33294
|
* Gamification service.
|
|
32166
33295
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
32167
|
-
* @version
|
|
33296
|
+
* @version 249.0.0
|
|
32168
33297
|
*/
|
|
32169
33298
|
|
|
32170
33299
|
/**
|
|
@@ -34722,7 +35851,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34722
35851
|
/**
|
|
34723
35852
|
* GeneralDataProtectionRegulation service.
|
|
34724
35853
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
34725
|
-
* @version
|
|
35854
|
+
* @version 249.0.0
|
|
34726
35855
|
*/
|
|
34727
35856
|
|
|
34728
35857
|
/**
|
|
@@ -34852,7 +35981,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34852
35981
|
/**
|
|
34853
35982
|
* Geolocation service.
|
|
34854
35983
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
34855
|
-
* @version
|
|
35984
|
+
* @version 249.0.0
|
|
34856
35985
|
*/
|
|
34857
35986
|
|
|
34858
35987
|
/**
|
|
@@ -34983,7 +36112,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34983
36112
|
/**
|
|
34984
36113
|
* Greetings service.
|
|
34985
36114
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
34986
|
-
* @version
|
|
36115
|
+
* @version 249.0.0
|
|
34987
36116
|
*/
|
|
34988
36117
|
|
|
34989
36118
|
/**
|
|
@@ -35525,7 +36654,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35525
36654
|
/**
|
|
35526
36655
|
* Groups service.
|
|
35527
36656
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
35528
|
-
* @version
|
|
36657
|
+
* @version 249.0.0
|
|
35529
36658
|
*/
|
|
35530
36659
|
|
|
35531
36660
|
/**
|
|
@@ -36044,7 +37173,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36044
37173
|
/**
|
|
36045
37174
|
* IdentityProvider service.
|
|
36046
37175
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
36047
|
-
* @version
|
|
37176
|
+
* @version 249.0.0
|
|
36048
37177
|
*/
|
|
36049
37178
|
|
|
36050
37179
|
/**
|
|
@@ -36905,7 +38034,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36905
38034
|
/**
|
|
36906
38035
|
* InfrastructureAsCode service.
|
|
36907
38036
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
36908
|
-
* @version
|
|
38037
|
+
* @version 249.0.0
|
|
36909
38038
|
*/
|
|
36910
38039
|
|
|
36911
38040
|
/**
|
|
@@ -37072,7 +38201,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37072
38201
|
/**
|
|
37073
38202
|
* Integrations service.
|
|
37074
38203
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
37075
|
-
* @version
|
|
38204
|
+
* @version 249.0.0
|
|
37076
38205
|
*/
|
|
37077
38206
|
|
|
37078
38207
|
/**
|
|
@@ -39722,7 +40851,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39722
40851
|
/**
|
|
39723
40852
|
* Intents service.
|
|
39724
40853
|
* @module purecloud-platform-client-v2/api/IntentsApi
|
|
39725
|
-
* @version
|
|
40854
|
+
* @version 249.0.0
|
|
39726
40855
|
*/
|
|
39727
40856
|
|
|
39728
40857
|
/**
|
|
@@ -40189,7 +41318,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40189
41318
|
/**
|
|
40190
41319
|
* Journey service.
|
|
40191
41320
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
40192
|
-
* @version
|
|
41321
|
+
* @version 249.0.0
|
|
40193
41322
|
*/
|
|
40194
41323
|
|
|
40195
41324
|
/**
|
|
@@ -42286,7 +43415,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42286
43415
|
/**
|
|
42287
43416
|
* Knowledge service.
|
|
42288
43417
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
42289
|
-
* @version
|
|
43418
|
+
* @version 249.0.0
|
|
42290
43419
|
*/
|
|
42291
43420
|
|
|
42292
43421
|
/**
|
|
@@ -42301,6 +43430,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42301
43430
|
}
|
|
42302
43431
|
|
|
42303
43432
|
|
|
43433
|
+
/**
|
|
43434
|
+
* Delete connection
|
|
43435
|
+
*
|
|
43436
|
+
* @param {String} connectionId Connection ID
|
|
43437
|
+
*/
|
|
43438
|
+
deleteKnowledgeConnection(connectionId) {
|
|
43439
|
+
// verify the required parameter 'connectionId' is set
|
|
43440
|
+
if (connectionId === undefined || connectionId === null || connectionId === '') {
|
|
43441
|
+
throw 'Missing the required parameter "connectionId" when calling deleteKnowledgeConnection';
|
|
43442
|
+
}
|
|
43443
|
+
|
|
43444
|
+
return this.apiClient.callApi(
|
|
43445
|
+
'/api/v2/knowledge/connections/{connectionId}',
|
|
43446
|
+
'DELETE',
|
|
43447
|
+
{ 'connectionId': connectionId },
|
|
43448
|
+
{ },
|
|
43449
|
+
{ },
|
|
43450
|
+
{ },
|
|
43451
|
+
null,
|
|
43452
|
+
['PureCloud OAuth'],
|
|
43453
|
+
['application/json'],
|
|
43454
|
+
['application/json']
|
|
43455
|
+
);
|
|
43456
|
+
}
|
|
43457
|
+
|
|
42304
43458
|
/**
|
|
42305
43459
|
* Delete knowledge base
|
|
42306
43460
|
*
|
|
@@ -42626,6 +43780,109 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42626
43780
|
);
|
|
42627
43781
|
}
|
|
42628
43782
|
|
|
43783
|
+
/**
|
|
43784
|
+
* Delete source
|
|
43785
|
+
*
|
|
43786
|
+
* @param {String} sourceId Source ID
|
|
43787
|
+
*/
|
|
43788
|
+
deleteKnowledgeSource(sourceId) {
|
|
43789
|
+
// verify the required parameter 'sourceId' is set
|
|
43790
|
+
if (sourceId === undefined || sourceId === null || sourceId === '') {
|
|
43791
|
+
throw 'Missing the required parameter "sourceId" when calling deleteKnowledgeSource';
|
|
43792
|
+
}
|
|
43793
|
+
|
|
43794
|
+
return this.apiClient.callApi(
|
|
43795
|
+
'/api/v2/knowledge/sources/{sourceId}',
|
|
43796
|
+
'DELETE',
|
|
43797
|
+
{ 'sourceId': sourceId },
|
|
43798
|
+
{ },
|
|
43799
|
+
{ },
|
|
43800
|
+
{ },
|
|
43801
|
+
null,
|
|
43802
|
+
['PureCloud OAuth'],
|
|
43803
|
+
['application/json'],
|
|
43804
|
+
['application/json']
|
|
43805
|
+
);
|
|
43806
|
+
}
|
|
43807
|
+
|
|
43808
|
+
/**
|
|
43809
|
+
* Get connection
|
|
43810
|
+
*
|
|
43811
|
+
* @param {String} connectionId Connection ID
|
|
43812
|
+
* @param {Object} opts Optional parameters
|
|
43813
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
43814
|
+
*/
|
|
43815
|
+
getKnowledgeConnection(connectionId, opts) {
|
|
43816
|
+
opts = opts || {};
|
|
43817
|
+
|
|
43818
|
+
// verify the required parameter 'connectionId' is set
|
|
43819
|
+
if (connectionId === undefined || connectionId === null || connectionId === '') {
|
|
43820
|
+
throw 'Missing the required parameter "connectionId" when calling getKnowledgeConnection';
|
|
43821
|
+
}
|
|
43822
|
+
|
|
43823
|
+
return this.apiClient.callApi(
|
|
43824
|
+
'/api/v2/knowledge/connections/{connectionId}',
|
|
43825
|
+
'GET',
|
|
43826
|
+
{ 'connectionId': connectionId },
|
|
43827
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
43828
|
+
{ },
|
|
43829
|
+
{ },
|
|
43830
|
+
null,
|
|
43831
|
+
['PureCloud OAuth'],
|
|
43832
|
+
['application/json'],
|
|
43833
|
+
['application/json']
|
|
43834
|
+
);
|
|
43835
|
+
}
|
|
43836
|
+
|
|
43837
|
+
/**
|
|
43838
|
+
* Get connection options
|
|
43839
|
+
*
|
|
43840
|
+
* @param {String} connectionId Connection ID
|
|
43841
|
+
* @param {Object} opts Optional parameters
|
|
43842
|
+
* @param {String} opts.parentId The id of the parent option whose children to be listed.
|
|
43843
|
+
*/
|
|
43844
|
+
getKnowledgeConnectionOptions(connectionId, opts) {
|
|
43845
|
+
opts = opts || {};
|
|
43846
|
+
|
|
43847
|
+
// verify the required parameter 'connectionId' is set
|
|
43848
|
+
if (connectionId === undefined || connectionId === null || connectionId === '') {
|
|
43849
|
+
throw 'Missing the required parameter "connectionId" when calling getKnowledgeConnectionOptions';
|
|
43850
|
+
}
|
|
43851
|
+
|
|
43852
|
+
return this.apiClient.callApi(
|
|
43853
|
+
'/api/v2/knowledge/connections/{connectionId}/options',
|
|
43854
|
+
'GET',
|
|
43855
|
+
{ 'connectionId': connectionId },
|
|
43856
|
+
{ 'parentId': opts['parentId'] },
|
|
43857
|
+
{ },
|
|
43858
|
+
{ },
|
|
43859
|
+
null,
|
|
43860
|
+
['PureCloud OAuth'],
|
|
43861
|
+
['application/json'],
|
|
43862
|
+
['application/json']
|
|
43863
|
+
);
|
|
43864
|
+
}
|
|
43865
|
+
|
|
43866
|
+
/**
|
|
43867
|
+
* Get connections
|
|
43868
|
+
*
|
|
43869
|
+
*/
|
|
43870
|
+
getKnowledgeConnections() {
|
|
43871
|
+
|
|
43872
|
+
return this.apiClient.callApi(
|
|
43873
|
+
'/api/v2/knowledge/connections',
|
|
43874
|
+
'GET',
|
|
43875
|
+
{ },
|
|
43876
|
+
{ },
|
|
43877
|
+
{ },
|
|
43878
|
+
{ },
|
|
43879
|
+
null,
|
|
43880
|
+
['PureCloud OAuth'],
|
|
43881
|
+
['application/json'],
|
|
43882
|
+
['application/json']
|
|
43883
|
+
);
|
|
43884
|
+
}
|
|
43885
|
+
|
|
42629
43886
|
/**
|
|
42630
43887
|
* Get categories
|
|
42631
43888
|
*
|
|
@@ -43808,6 +45065,175 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43808
45065
|
);
|
|
43809
45066
|
}
|
|
43810
45067
|
|
|
45068
|
+
/**
|
|
45069
|
+
* Get source
|
|
45070
|
+
*
|
|
45071
|
+
* @param {String} sourceId Source ID
|
|
45072
|
+
* @param {Object} opts Optional parameters
|
|
45073
|
+
* @param {Array.<String>} opts.expand Optional fields to expand for the Source.
|
|
45074
|
+
*/
|
|
45075
|
+
getKnowledgeSource(sourceId, opts) {
|
|
45076
|
+
opts = opts || {};
|
|
45077
|
+
|
|
45078
|
+
// verify the required parameter 'sourceId' is set
|
|
45079
|
+
if (sourceId === undefined || sourceId === null || sourceId === '') {
|
|
45080
|
+
throw 'Missing the required parameter "sourceId" when calling getKnowledgeSource';
|
|
45081
|
+
}
|
|
45082
|
+
|
|
45083
|
+
return this.apiClient.callApi(
|
|
45084
|
+
'/api/v2/knowledge/sources/{sourceId}',
|
|
45085
|
+
'GET',
|
|
45086
|
+
{ 'sourceId': sourceId },
|
|
45087
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
45088
|
+
{ },
|
|
45089
|
+
{ },
|
|
45090
|
+
null,
|
|
45091
|
+
['PureCloud OAuth'],
|
|
45092
|
+
['application/json'],
|
|
45093
|
+
['application/json']
|
|
45094
|
+
);
|
|
45095
|
+
}
|
|
45096
|
+
|
|
45097
|
+
/**
|
|
45098
|
+
* Get a specific synchronization of a source.
|
|
45099
|
+
*
|
|
45100
|
+
* @param {String} sourceId Source ID
|
|
45101
|
+
* @param {String} synchronizationId Synchronization ID
|
|
45102
|
+
*/
|
|
45103
|
+
getKnowledgeSourceSynchronization(sourceId, synchronizationId) {
|
|
45104
|
+
// verify the required parameter 'sourceId' is set
|
|
45105
|
+
if (sourceId === undefined || sourceId === null || sourceId === '') {
|
|
45106
|
+
throw 'Missing the required parameter "sourceId" when calling getKnowledgeSourceSynchronization';
|
|
45107
|
+
}
|
|
45108
|
+
// verify the required parameter 'synchronizationId' is set
|
|
45109
|
+
if (synchronizationId === undefined || synchronizationId === null || synchronizationId === '') {
|
|
45110
|
+
throw 'Missing the required parameter "synchronizationId" when calling getKnowledgeSourceSynchronization';
|
|
45111
|
+
}
|
|
45112
|
+
|
|
45113
|
+
return this.apiClient.callApi(
|
|
45114
|
+
'/api/v2/knowledge/sources/{sourceId}/synchronizations/{synchronizationId}',
|
|
45115
|
+
'GET',
|
|
45116
|
+
{ 'sourceId': sourceId,'synchronizationId': synchronizationId },
|
|
45117
|
+
{ },
|
|
45118
|
+
{ },
|
|
45119
|
+
{ },
|
|
45120
|
+
null,
|
|
45121
|
+
['PureCloud OAuth'],
|
|
45122
|
+
['application/json'],
|
|
45123
|
+
['application/json']
|
|
45124
|
+
);
|
|
45125
|
+
}
|
|
45126
|
+
|
|
45127
|
+
/**
|
|
45128
|
+
* Get synchronizations of a source.
|
|
45129
|
+
*
|
|
45130
|
+
* @param {String} sourceId Source ID
|
|
45131
|
+
* @param {Object} opts Optional parameters
|
|
45132
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
45133
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
45134
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
45135
|
+
*/
|
|
45136
|
+
getKnowledgeSourceSynchronizations(sourceId, opts) {
|
|
45137
|
+
opts = opts || {};
|
|
45138
|
+
|
|
45139
|
+
// verify the required parameter 'sourceId' is set
|
|
45140
|
+
if (sourceId === undefined || sourceId === null || sourceId === '') {
|
|
45141
|
+
throw 'Missing the required parameter "sourceId" when calling getKnowledgeSourceSynchronizations';
|
|
45142
|
+
}
|
|
45143
|
+
|
|
45144
|
+
return this.apiClient.callApi(
|
|
45145
|
+
'/api/v2/knowledge/sources/{sourceId}/synchronizations',
|
|
45146
|
+
'GET',
|
|
45147
|
+
{ 'sourceId': sourceId },
|
|
45148
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
45149
|
+
{ },
|
|
45150
|
+
{ },
|
|
45151
|
+
null,
|
|
45152
|
+
['PureCloud OAuth'],
|
|
45153
|
+
['application/json'],
|
|
45154
|
+
['application/json']
|
|
45155
|
+
);
|
|
45156
|
+
}
|
|
45157
|
+
|
|
45158
|
+
/**
|
|
45159
|
+
* List sources
|
|
45160
|
+
*
|
|
45161
|
+
* @param {Object} opts Optional parameters
|
|
45162
|
+
* @param {Array.<String>} opts.expand Optional fields to expand for the Source.
|
|
45163
|
+
*/
|
|
45164
|
+
getKnowledgeSources(opts) {
|
|
45165
|
+
opts = opts || {};
|
|
45166
|
+
|
|
45167
|
+
|
|
45168
|
+
return this.apiClient.callApi(
|
|
45169
|
+
'/api/v2/knowledge/sources',
|
|
45170
|
+
'GET',
|
|
45171
|
+
{ },
|
|
45172
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
45173
|
+
{ },
|
|
45174
|
+
{ },
|
|
45175
|
+
null,
|
|
45176
|
+
['PureCloud OAuth'],
|
|
45177
|
+
['application/json'],
|
|
45178
|
+
['application/json']
|
|
45179
|
+
);
|
|
45180
|
+
}
|
|
45181
|
+
|
|
45182
|
+
/**
|
|
45183
|
+
* Get synchronizations of all sources of the organization.
|
|
45184
|
+
*
|
|
45185
|
+
* @param {Object} opts Optional parameters
|
|
45186
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
45187
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
45188
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
45189
|
+
*/
|
|
45190
|
+
getKnowledgeSourcesSynchronizations(opts) {
|
|
45191
|
+
opts = opts || {};
|
|
45192
|
+
|
|
45193
|
+
|
|
45194
|
+
return this.apiClient.callApi(
|
|
45195
|
+
'/api/v2/knowledge/sources/synchronizations',
|
|
45196
|
+
'GET',
|
|
45197
|
+
{ },
|
|
45198
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
45199
|
+
{ },
|
|
45200
|
+
{ },
|
|
45201
|
+
null,
|
|
45202
|
+
['PureCloud OAuth'],
|
|
45203
|
+
['application/json'],
|
|
45204
|
+
['application/json']
|
|
45205
|
+
);
|
|
45206
|
+
}
|
|
45207
|
+
|
|
45208
|
+
/**
|
|
45209
|
+
* Update connection
|
|
45210
|
+
*
|
|
45211
|
+
* @param {String} connectionId Connection ID
|
|
45212
|
+
* @param {Object} opts Optional parameters
|
|
45213
|
+
* @param {Object} opts.body
|
|
45214
|
+
*/
|
|
45215
|
+
patchKnowledgeConnection(connectionId, opts) {
|
|
45216
|
+
opts = opts || {};
|
|
45217
|
+
|
|
45218
|
+
// verify the required parameter 'connectionId' is set
|
|
45219
|
+
if (connectionId === undefined || connectionId === null || connectionId === '') {
|
|
45220
|
+
throw 'Missing the required parameter "connectionId" when calling patchKnowledgeConnection';
|
|
45221
|
+
}
|
|
45222
|
+
|
|
45223
|
+
return this.apiClient.callApi(
|
|
45224
|
+
'/api/v2/knowledge/connections/{connectionId}',
|
|
45225
|
+
'PATCH',
|
|
45226
|
+
{ 'connectionId': connectionId },
|
|
45227
|
+
{ },
|
|
45228
|
+
{ },
|
|
45229
|
+
{ },
|
|
45230
|
+
opts['body'],
|
|
45231
|
+
['PureCloud OAuth'],
|
|
45232
|
+
['application/json'],
|
|
45233
|
+
['application/json']
|
|
45234
|
+
);
|
|
45235
|
+
}
|
|
45236
|
+
|
|
43811
45237
|
/**
|
|
43812
45238
|
* Update search result.
|
|
43813
45239
|
*
|
|
@@ -44300,6 +45726,66 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44300
45726
|
);
|
|
44301
45727
|
}
|
|
44302
45728
|
|
|
45729
|
+
/**
|
|
45730
|
+
* Update synchronization.
|
|
45731
|
+
*
|
|
45732
|
+
* @param {String} sourceId Source ID
|
|
45733
|
+
* @param {String} synchronizationId Synchronization ID
|
|
45734
|
+
* @param {Object} body
|
|
45735
|
+
*/
|
|
45736
|
+
patchKnowledgeSourceSynchronization(sourceId, synchronizationId, body) {
|
|
45737
|
+
// verify the required parameter 'sourceId' is set
|
|
45738
|
+
if (sourceId === undefined || sourceId === null || sourceId === '') {
|
|
45739
|
+
throw 'Missing the required parameter "sourceId" when calling patchKnowledgeSourceSynchronization';
|
|
45740
|
+
}
|
|
45741
|
+
// verify the required parameter 'synchronizationId' is set
|
|
45742
|
+
if (synchronizationId === undefined || synchronizationId === null || synchronizationId === '') {
|
|
45743
|
+
throw 'Missing the required parameter "synchronizationId" when calling patchKnowledgeSourceSynchronization';
|
|
45744
|
+
}
|
|
45745
|
+
// verify the required parameter 'body' is set
|
|
45746
|
+
if (body === undefined || body === null) {
|
|
45747
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeSourceSynchronization';
|
|
45748
|
+
}
|
|
45749
|
+
|
|
45750
|
+
return this.apiClient.callApi(
|
|
45751
|
+
'/api/v2/knowledge/sources/{sourceId}/synchronizations/{synchronizationId}',
|
|
45752
|
+
'PATCH',
|
|
45753
|
+
{ 'sourceId': sourceId,'synchronizationId': synchronizationId },
|
|
45754
|
+
{ },
|
|
45755
|
+
{ },
|
|
45756
|
+
{ },
|
|
45757
|
+
body,
|
|
45758
|
+
['PureCloud OAuth'],
|
|
45759
|
+
['application/json'],
|
|
45760
|
+
['application/json']
|
|
45761
|
+
);
|
|
45762
|
+
}
|
|
45763
|
+
|
|
45764
|
+
/**
|
|
45765
|
+
* Create new connection
|
|
45766
|
+
*
|
|
45767
|
+
* @param {Object} body
|
|
45768
|
+
*/
|
|
45769
|
+
postKnowledgeConnections(body) {
|
|
45770
|
+
// verify the required parameter 'body' is set
|
|
45771
|
+
if (body === undefined || body === null) {
|
|
45772
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeConnections';
|
|
45773
|
+
}
|
|
45774
|
+
|
|
45775
|
+
return this.apiClient.callApi(
|
|
45776
|
+
'/api/v2/knowledge/connections',
|
|
45777
|
+
'POST',
|
|
45778
|
+
{ },
|
|
45779
|
+
{ },
|
|
45780
|
+
{ },
|
|
45781
|
+
{ },
|
|
45782
|
+
body,
|
|
45783
|
+
['PureCloud OAuth'],
|
|
45784
|
+
['application/json'],
|
|
45785
|
+
['application/json']
|
|
45786
|
+
);
|
|
45787
|
+
}
|
|
45788
|
+
|
|
44303
45789
|
/**
|
|
44304
45790
|
* Creates a presigned URL for uploading a knowledge import file with a set of documents
|
|
44305
45791
|
*
|
|
@@ -45437,6 +46923,30 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45437
46923
|
);
|
|
45438
46924
|
}
|
|
45439
46925
|
|
|
46926
|
+
/**
|
|
46927
|
+
* Get Knowledge Search
|
|
46928
|
+
*
|
|
46929
|
+
* @param {Object} opts Optional parameters
|
|
46930
|
+
* @param {Object} opts.body
|
|
46931
|
+
*/
|
|
46932
|
+
postKnowledgeSearch(opts) {
|
|
46933
|
+
opts = opts || {};
|
|
46934
|
+
|
|
46935
|
+
|
|
46936
|
+
return this.apiClient.callApi(
|
|
46937
|
+
'/api/v2/knowledge/search',
|
|
46938
|
+
'POST',
|
|
46939
|
+
{ },
|
|
46940
|
+
{ },
|
|
46941
|
+
{ },
|
|
46942
|
+
{ },
|
|
46943
|
+
opts['body'],
|
|
46944
|
+
['PureCloud OAuth'],
|
|
46945
|
+
['application/json'],
|
|
46946
|
+
['application/json']
|
|
46947
|
+
);
|
|
46948
|
+
}
|
|
46949
|
+
|
|
45440
46950
|
/**
|
|
45441
46951
|
* Get Knowledge Search Preview
|
|
45442
46952
|
*
|
|
@@ -45485,6 +46995,95 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45485
46995
|
);
|
|
45486
46996
|
}
|
|
45487
46997
|
|
|
46998
|
+
/**
|
|
46999
|
+
* Create presigned URL for uploading a file in the synchronization.
|
|
47000
|
+
*
|
|
47001
|
+
* @param {String} sourceId Source ID
|
|
47002
|
+
* @param {String} synchronizationId Synchronization ID
|
|
47003
|
+
* @param {Object} body
|
|
47004
|
+
*/
|
|
47005
|
+
postKnowledgeSourceSynchronizationUploads(sourceId, synchronizationId, body) {
|
|
47006
|
+
// verify the required parameter 'sourceId' is set
|
|
47007
|
+
if (sourceId === undefined || sourceId === null || sourceId === '') {
|
|
47008
|
+
throw 'Missing the required parameter "sourceId" when calling postKnowledgeSourceSynchronizationUploads';
|
|
47009
|
+
}
|
|
47010
|
+
// verify the required parameter 'synchronizationId' is set
|
|
47011
|
+
if (synchronizationId === undefined || synchronizationId === null || synchronizationId === '') {
|
|
47012
|
+
throw 'Missing the required parameter "synchronizationId" when calling postKnowledgeSourceSynchronizationUploads';
|
|
47013
|
+
}
|
|
47014
|
+
// verify the required parameter 'body' is set
|
|
47015
|
+
if (body === undefined || body === null) {
|
|
47016
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeSourceSynchronizationUploads';
|
|
47017
|
+
}
|
|
47018
|
+
|
|
47019
|
+
return this.apiClient.callApi(
|
|
47020
|
+
'/api/v2/knowledge/sources/{sourceId}/synchronizations/{synchronizationId}/uploads',
|
|
47021
|
+
'POST',
|
|
47022
|
+
{ 'sourceId': sourceId,'synchronizationId': synchronizationId },
|
|
47023
|
+
{ },
|
|
47024
|
+
{ },
|
|
47025
|
+
{ },
|
|
47026
|
+
body,
|
|
47027
|
+
['PureCloud OAuth'],
|
|
47028
|
+
['application/json'],
|
|
47029
|
+
['application/json']
|
|
47030
|
+
);
|
|
47031
|
+
}
|
|
47032
|
+
|
|
47033
|
+
/**
|
|
47034
|
+
* Start a manual synchronization from a source.
|
|
47035
|
+
*
|
|
47036
|
+
* @param {String} sourceId Source ID
|
|
47037
|
+
* @param {Object} opts Optional parameters
|
|
47038
|
+
* @param {Object} opts.body
|
|
47039
|
+
*/
|
|
47040
|
+
postKnowledgeSourceSynchronizations(sourceId, opts) {
|
|
47041
|
+
opts = opts || {};
|
|
47042
|
+
|
|
47043
|
+
// verify the required parameter 'sourceId' is set
|
|
47044
|
+
if (sourceId === undefined || sourceId === null || sourceId === '') {
|
|
47045
|
+
throw 'Missing the required parameter "sourceId" when calling postKnowledgeSourceSynchronizations';
|
|
47046
|
+
}
|
|
47047
|
+
|
|
47048
|
+
return this.apiClient.callApi(
|
|
47049
|
+
'/api/v2/knowledge/sources/{sourceId}/synchronizations',
|
|
47050
|
+
'POST',
|
|
47051
|
+
{ 'sourceId': sourceId },
|
|
47052
|
+
{ },
|
|
47053
|
+
{ },
|
|
47054
|
+
{ },
|
|
47055
|
+
opts['body'],
|
|
47056
|
+
['PureCloud OAuth'],
|
|
47057
|
+
['application/json'],
|
|
47058
|
+
['application/json']
|
|
47059
|
+
);
|
|
47060
|
+
}
|
|
47061
|
+
|
|
47062
|
+
/**
|
|
47063
|
+
* Create a new source
|
|
47064
|
+
*
|
|
47065
|
+
* @param {Object} body
|
|
47066
|
+
*/
|
|
47067
|
+
postKnowledgeSources(body) {
|
|
47068
|
+
// verify the required parameter 'body' is set
|
|
47069
|
+
if (body === undefined || body === null) {
|
|
47070
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeSources';
|
|
47071
|
+
}
|
|
47072
|
+
|
|
47073
|
+
return this.apiClient.callApi(
|
|
47074
|
+
'/api/v2/knowledge/sources',
|
|
47075
|
+
'POST',
|
|
47076
|
+
{ },
|
|
47077
|
+
{ },
|
|
47078
|
+
{ },
|
|
47079
|
+
{ },
|
|
47080
|
+
body,
|
|
47081
|
+
['PureCloud OAuth'],
|
|
47082
|
+
['application/json'],
|
|
47083
|
+
['application/json']
|
|
47084
|
+
);
|
|
47085
|
+
}
|
|
47086
|
+
|
|
45488
47087
|
/**
|
|
45489
47088
|
* Update Salesforce Knowledge integration source
|
|
45490
47089
|
*
|
|
@@ -45555,13 +47154,43 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45555
47154
|
);
|
|
45556
47155
|
}
|
|
45557
47156
|
|
|
47157
|
+
/**
|
|
47158
|
+
* Update the source
|
|
47159
|
+
*
|
|
47160
|
+
* @param {String} sourceId Source ID
|
|
47161
|
+
* @param {Object} body
|
|
47162
|
+
*/
|
|
47163
|
+
putKnowledgeSource(sourceId, body) {
|
|
47164
|
+
// verify the required parameter 'sourceId' is set
|
|
47165
|
+
if (sourceId === undefined || sourceId === null || sourceId === '') {
|
|
47166
|
+
throw 'Missing the required parameter "sourceId" when calling putKnowledgeSource';
|
|
47167
|
+
}
|
|
47168
|
+
// verify the required parameter 'body' is set
|
|
47169
|
+
if (body === undefined || body === null) {
|
|
47170
|
+
throw 'Missing the required parameter "body" when calling putKnowledgeSource';
|
|
47171
|
+
}
|
|
47172
|
+
|
|
47173
|
+
return this.apiClient.callApi(
|
|
47174
|
+
'/api/v2/knowledge/sources/{sourceId}',
|
|
47175
|
+
'PUT',
|
|
47176
|
+
{ 'sourceId': sourceId },
|
|
47177
|
+
{ },
|
|
47178
|
+
{ },
|
|
47179
|
+
{ },
|
|
47180
|
+
body,
|
|
47181
|
+
['PureCloud OAuth'],
|
|
47182
|
+
['application/json'],
|
|
47183
|
+
['application/json']
|
|
47184
|
+
);
|
|
47185
|
+
}
|
|
47186
|
+
|
|
45558
47187
|
}
|
|
45559
47188
|
|
|
45560
47189
|
class LanguageUnderstandingApi {
|
|
45561
47190
|
/**
|
|
45562
47191
|
* LanguageUnderstanding service.
|
|
45563
47192
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
45564
|
-
* @version
|
|
47193
|
+
* @version 249.0.0
|
|
45565
47194
|
*/
|
|
45566
47195
|
|
|
45567
47196
|
/**
|
|
@@ -46780,7 +48409,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46780
48409
|
/**
|
|
46781
48410
|
* Languages service.
|
|
46782
48411
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
46783
|
-
* @version
|
|
48412
|
+
* @version 249.0.0
|
|
46784
48413
|
*/
|
|
46785
48414
|
|
|
46786
48415
|
/**
|
|
@@ -47002,7 +48631,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47002
48631
|
/**
|
|
47003
48632
|
* Learning service.
|
|
47004
48633
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
47005
|
-
* @version
|
|
48634
|
+
* @version 249.0.0
|
|
47006
48635
|
*/
|
|
47007
48636
|
|
|
47008
48637
|
/**
|
|
@@ -48111,7 +49740,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48111
49740
|
/**
|
|
48112
49741
|
* License service.
|
|
48113
49742
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
48114
|
-
* @version
|
|
49743
|
+
* @version 249.0.0
|
|
48115
49744
|
*/
|
|
48116
49745
|
|
|
48117
49746
|
/**
|
|
@@ -48270,6 +49899,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48270
49899
|
);
|
|
48271
49900
|
}
|
|
48272
49901
|
|
|
49902
|
+
/**
|
|
49903
|
+
* Get a list of licenses inferred based on a list of permissions
|
|
49904
|
+
*
|
|
49905
|
+
* @param {Object} opts Optional parameters
|
|
49906
|
+
* @param {Array.<String>} opts.body The permissions to use while inferring licenses
|
|
49907
|
+
* postLicenseInferPermissions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
49908
|
+
*/
|
|
49909
|
+
postLicenseInferPermissions(opts) {
|
|
49910
|
+
opts = opts || {};
|
|
49911
|
+
|
|
49912
|
+
|
|
49913
|
+
return this.apiClient.callApi(
|
|
49914
|
+
'/api/v2/license/infer/permissions',
|
|
49915
|
+
'POST',
|
|
49916
|
+
{ },
|
|
49917
|
+
{ },
|
|
49918
|
+
{ },
|
|
49919
|
+
{ },
|
|
49920
|
+
opts['body'],
|
|
49921
|
+
['PureCloud OAuth'],
|
|
49922
|
+
['application/json'],
|
|
49923
|
+
['application/json']
|
|
49924
|
+
);
|
|
49925
|
+
}
|
|
49926
|
+
|
|
48273
49927
|
/**
|
|
48274
49928
|
* Update the organization's license assignments in a batch.
|
|
48275
49929
|
*
|
|
@@ -48349,7 +50003,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48349
50003
|
/**
|
|
48350
50004
|
* Locations service.
|
|
48351
50005
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
48352
|
-
* @version
|
|
50006
|
+
* @version 249.0.0
|
|
48353
50007
|
*/
|
|
48354
50008
|
|
|
48355
50009
|
/**
|
|
@@ -48585,7 +50239,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48585
50239
|
/**
|
|
48586
50240
|
* LogCapture service.
|
|
48587
50241
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
48588
|
-
* @version
|
|
50242
|
+
* @version 249.0.0
|
|
48589
50243
|
*/
|
|
48590
50244
|
|
|
48591
50245
|
/**
|
|
@@ -48784,7 +50438,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48784
50438
|
/**
|
|
48785
50439
|
* Messaging service.
|
|
48786
50440
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
48787
|
-
* @version
|
|
50441
|
+
* @version 249.0.0
|
|
48788
50442
|
*/
|
|
48789
50443
|
|
|
48790
50444
|
/**
|
|
@@ -49143,7 +50797,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49143
50797
|
/**
|
|
49144
50798
|
* MobileDevices service.
|
|
49145
50799
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
49146
|
-
* @version
|
|
50800
|
+
* @version 249.0.0
|
|
49147
50801
|
*/
|
|
49148
50802
|
|
|
49149
50803
|
/**
|
|
@@ -49294,7 +50948,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49294
50948
|
/**
|
|
49295
50949
|
* Notifications service.
|
|
49296
50950
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
49297
|
-
* @version
|
|
50951
|
+
* @version 249.0.0
|
|
49298
50952
|
*/
|
|
49299
50953
|
|
|
49300
50954
|
/**
|
|
@@ -49527,7 +51181,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49527
51181
|
/**
|
|
49528
51182
|
* OAuth service.
|
|
49529
51183
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
49530
|
-
* @version
|
|
51184
|
+
* @version 249.0.0
|
|
49531
51185
|
*/
|
|
49532
51186
|
|
|
49533
51187
|
/**
|
|
@@ -49893,7 +51547,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49893
51547
|
/**
|
|
49894
51548
|
* Objects service.
|
|
49895
51549
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
49896
|
-
* @version
|
|
51550
|
+
* @version 249.0.0
|
|
49897
51551
|
*/
|
|
49898
51552
|
|
|
49899
51553
|
/**
|
|
@@ -50217,7 +51871,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50217
51871
|
/**
|
|
50218
51872
|
* OperationalEvents service.
|
|
50219
51873
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
50220
|
-
* @version
|
|
51874
|
+
* @version 249.0.0
|
|
50221
51875
|
*/
|
|
50222
51876
|
|
|
50223
51877
|
/**
|
|
@@ -50334,7 +51988,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50334
51988
|
/**
|
|
50335
51989
|
* Organization service.
|
|
50336
51990
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
50337
|
-
* @version
|
|
51991
|
+
* @version 249.0.0
|
|
50338
51992
|
*/
|
|
50339
51993
|
|
|
50340
51994
|
/**
|
|
@@ -50809,7 +52463,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50809
52463
|
/**
|
|
50810
52464
|
* OrganizationAuthorization service.
|
|
50811
52465
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
50812
|
-
* @version
|
|
52466
|
+
* @version 249.0.0
|
|
50813
52467
|
*/
|
|
50814
52468
|
|
|
50815
52469
|
/**
|
|
@@ -52203,7 +53857,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52203
53857
|
/**
|
|
52204
53858
|
* Outbound service.
|
|
52205
53859
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
52206
|
-
* @version
|
|
53860
|
+
* @version 249.0.0
|
|
52207
53861
|
*/
|
|
52208
53862
|
|
|
52209
53863
|
/**
|
|
@@ -52424,7 +54078,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52424
54078
|
}
|
|
52425
54079
|
|
|
52426
54080
|
/**
|
|
52427
|
-
* Delete contacts from a contact list.
|
|
54081
|
+
* Delete contacts from a contact list. Only contacts that are not in use by any campaign will be deleted
|
|
52428
54082
|
*
|
|
52429
54083
|
* @param {String} contactListId Contact List ID
|
|
52430
54084
|
* @param {Array.<String>} contactIds ContactIds to delete.
|
|
@@ -54030,6 +55684,41 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54030
55684
|
);
|
|
54031
55685
|
}
|
|
54032
55686
|
|
|
55687
|
+
/**
|
|
55688
|
+
* Get diagnostic summary for a single campaign
|
|
55689
|
+
*
|
|
55690
|
+
* @param {String} campaignId Campaign ID
|
|
55691
|
+
* @param {String} start Start datetime (ISO 8601 or Unix epoch)
|
|
55692
|
+
* @param {String} end End datetime (ISO 8601 or Unix epoch)
|
|
55693
|
+
*/
|
|
55694
|
+
getOutboundDiagnosticsCampaignSummary(campaignId, start, end) {
|
|
55695
|
+
// verify the required parameter 'campaignId' is set
|
|
55696
|
+
if (campaignId === undefined || campaignId === null || campaignId === '') {
|
|
55697
|
+
throw 'Missing the required parameter "campaignId" when calling getOutboundDiagnosticsCampaignSummary';
|
|
55698
|
+
}
|
|
55699
|
+
// verify the required parameter 'start' is set
|
|
55700
|
+
if (start === undefined || start === null) {
|
|
55701
|
+
throw 'Missing the required parameter "start" when calling getOutboundDiagnosticsCampaignSummary';
|
|
55702
|
+
}
|
|
55703
|
+
// verify the required parameter 'end' is set
|
|
55704
|
+
if (end === undefined || end === null) {
|
|
55705
|
+
throw 'Missing the required parameter "end" when calling getOutboundDiagnosticsCampaignSummary';
|
|
55706
|
+
}
|
|
55707
|
+
|
|
55708
|
+
return this.apiClient.callApi(
|
|
55709
|
+
'/api/v2/outbound/diagnostics/campaigns/{campaignId}/summary',
|
|
55710
|
+
'GET',
|
|
55711
|
+
{ 'campaignId': campaignId },
|
|
55712
|
+
{ 'start': start,'end': end },
|
|
55713
|
+
{ },
|
|
55714
|
+
{ },
|
|
55715
|
+
null,
|
|
55716
|
+
['PureCloud OAuth'],
|
|
55717
|
+
['application/json'],
|
|
55718
|
+
['application/json']
|
|
55719
|
+
);
|
|
55720
|
+
}
|
|
55721
|
+
|
|
54033
55722
|
/**
|
|
54034
55723
|
* Get an Outbound Digital Rule Set
|
|
54035
55724
|
*
|
|
@@ -57001,7 +58690,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57001
58690
|
/**
|
|
57002
58691
|
* Presence service.
|
|
57003
58692
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
57004
|
-
* @version
|
|
58693
|
+
* @version 249.0.0
|
|
57005
58694
|
*/
|
|
57006
58695
|
|
|
57007
58696
|
/**
|
|
@@ -57745,7 +59434,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57745
59434
|
/**
|
|
57746
59435
|
* ProcessAutomation service.
|
|
57747
59436
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
57748
|
-
* @version
|
|
59437
|
+
* @version 249.0.0
|
|
57749
59438
|
*/
|
|
57750
59439
|
|
|
57751
59440
|
/**
|
|
@@ -57984,7 +59673,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57984
59673
|
/**
|
|
57985
59674
|
* Quality service.
|
|
57986
59675
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
57987
|
-
* @version
|
|
59676
|
+
* @version 249.0.0
|
|
57988
59677
|
*/
|
|
57989
59678
|
|
|
57990
59679
|
/**
|
|
@@ -60054,7 +61743,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60054
61743
|
/**
|
|
60055
61744
|
* Recording service.
|
|
60056
61745
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
60057
|
-
* @version
|
|
61746
|
+
* @version 249.0.0
|
|
60058
61747
|
*/
|
|
60059
61748
|
|
|
60060
61749
|
/**
|
|
@@ -61659,7 +63348,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61659
63348
|
/**
|
|
61660
63349
|
* ResponseManagement service.
|
|
61661
63350
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
61662
|
-
* @version
|
|
63351
|
+
* @version 249.0.0
|
|
61663
63352
|
*/
|
|
61664
63353
|
|
|
61665
63354
|
/**
|
|
@@ -61961,6 +63650,62 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61961
63650
|
);
|
|
61962
63651
|
}
|
|
61963
63652
|
|
|
63653
|
+
/**
|
|
63654
|
+
* Query libraries using criteria. Users can set DivisionId parameter as '*' to fetch libraries that aren't associated with any divisions.
|
|
63655
|
+
*
|
|
63656
|
+
* @param {Object} body Query criteria
|
|
63657
|
+
* @param {Object} opts Optional parameters
|
|
63658
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
63659
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
63660
|
+
* postResponsemanagementLibrariesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
63661
|
+
*/
|
|
63662
|
+
postResponsemanagementLibrariesQuery(body, opts) {
|
|
63663
|
+
opts = opts || {};
|
|
63664
|
+
|
|
63665
|
+
// verify the required parameter 'body' is set
|
|
63666
|
+
if (body === undefined || body === null) {
|
|
63667
|
+
throw 'Missing the required parameter "body" when calling postResponsemanagementLibrariesQuery';
|
|
63668
|
+
}
|
|
63669
|
+
|
|
63670
|
+
return this.apiClient.callApi(
|
|
63671
|
+
'/api/v2/responsemanagement/libraries/query',
|
|
63672
|
+
'POST',
|
|
63673
|
+
{ },
|
|
63674
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
63675
|
+
{ },
|
|
63676
|
+
{ },
|
|
63677
|
+
body,
|
|
63678
|
+
['PureCloud OAuth'],
|
|
63679
|
+
['application/json'],
|
|
63680
|
+
['application/json']
|
|
63681
|
+
);
|
|
63682
|
+
}
|
|
63683
|
+
|
|
63684
|
+
/**
|
|
63685
|
+
* Get response assets.
|
|
63686
|
+
*
|
|
63687
|
+
* @param {Object} body Asset IDs (max allowed 50)
|
|
63688
|
+
*/
|
|
63689
|
+
postResponsemanagementResponseassetsBulk(body) {
|
|
63690
|
+
// verify the required parameter 'body' is set
|
|
63691
|
+
if (body === undefined || body === null) {
|
|
63692
|
+
throw 'Missing the required parameter "body" when calling postResponsemanagementResponseassetsBulk';
|
|
63693
|
+
}
|
|
63694
|
+
|
|
63695
|
+
return this.apiClient.callApi(
|
|
63696
|
+
'/api/v2/responsemanagement/responseassets/bulk',
|
|
63697
|
+
'POST',
|
|
63698
|
+
{ },
|
|
63699
|
+
{ },
|
|
63700
|
+
{ },
|
|
63701
|
+
{ },
|
|
63702
|
+
body,
|
|
63703
|
+
['PureCloud OAuth'],
|
|
63704
|
+
['application/json'],
|
|
63705
|
+
['application/json']
|
|
63706
|
+
);
|
|
63707
|
+
}
|
|
63708
|
+
|
|
61964
63709
|
/**
|
|
61965
63710
|
* Search response assets
|
|
61966
63711
|
*
|
|
@@ -62169,7 +63914,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62169
63914
|
/**
|
|
62170
63915
|
* Routing service.
|
|
62171
63916
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
62172
|
-
* @version
|
|
63917
|
+
* @version 249.0.0
|
|
62173
63918
|
*/
|
|
62174
63919
|
|
|
62175
63920
|
/**
|
|
@@ -64371,7 +66116,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64371
66116
|
|
|
64372
66117
|
/**
|
|
64373
66118
|
* Get a phone number provisioned for SMS.
|
|
64374
|
-
*
|
|
66119
|
+
* When no supported content profile is explicitly set on an MMS-capable phone number, the system uses the "SMS Default" profile. This default profile allows all media types (\*\/\*) for inbound messages and specific image types (image/gif, image/jpeg, image/png) for outbound messages. The "SMS Default" profile does not have an ID and cannot be modified. To customize media filtering, create and assign a custom supported content profile using the PATCH endpoint.
|
|
64375
66120
|
* @param {String} phoneNumberId phone number
|
|
64376
66121
|
* @param {Object} opts Optional parameters
|
|
64377
66122
|
* @param {Object} opts.expand Expand response with additional information
|
|
@@ -64400,7 +66145,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64400
66145
|
|
|
64401
66146
|
/**
|
|
64402
66147
|
* Get a list of provisioned phone numbers.
|
|
64403
|
-
*
|
|
66148
|
+
* When no supported content profile is explicitly set, the system uses the "SMS Default" profile. This default profile allows all media types (\*\/\*) for inbound messages and specific image types (image/gif, image/jpeg, image/png) for outbound messages. The "SMS Default" profile does not have an ID and cannot be modified. To customize media filtering, create and assign a custom supported content profile.
|
|
64404
66149
|
* @param {Object} opts Optional parameters
|
|
64405
66150
|
* @param {String} opts.phoneNumber Filter on phone number address. Allowable characters are the digits '0-9' and the wild card character '\\*'. If just digits are present, a contains search is done on the address pattern. For example, '317' could be matched anywhere in the address. An '\\*' will match multiple digits. For example, to match a specific area code within the US a pattern like '1317*' could be used.
|
|
64406
66151
|
* @param {Array.<String>} opts.phoneNumberType Filter on phone number type
|
|
@@ -65317,7 +67062,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65317
67062
|
|
|
65318
67063
|
/**
|
|
65319
67064
|
* Update a phone number provisioned for SMS.
|
|
65320
|
-
*
|
|
67065
|
+
* Use this endpoint to assign a custom supported content profile to an MMS-capable phone number. If no supported content profile is set, the phone number uses the "SMS Default" profile, which allows all media types (\*\/\*) for inbound messages and specific image types (image/gif, image/jpeg, image/png) for outbound messages. To customize media filtering, provide a supported content profile ID in the request body.
|
|
65321
67066
|
* @param {String} phoneNumberId phone number
|
|
65322
67067
|
* @param {Object} body SmsPhoneNumberPatchRequest
|
|
65323
67068
|
*/
|
|
@@ -66160,7 +67905,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66160
67905
|
|
|
66161
67906
|
/**
|
|
66162
67907
|
* Provision a phone number for SMS
|
|
66163
|
-
*
|
|
67908
|
+
* When provisioning an MMS-capable phone number, if no supported content profile is specified in the request, the system automatically assigns the "SMS Default" profile. This default profile allows all media types (\*\/\*) for inbound messages and specific image types (image/gif, image/jpeg, image/png) for outbound messages. To use custom media filtering, specify a supported content profile ID in the request body.
|
|
66164
67909
|
* @param {Object} body SmsPhoneNumber
|
|
66165
67910
|
*/
|
|
66166
67911
|
postRoutingSmsPhonenumbers(body) {
|
|
@@ -66876,7 +68621,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66876
68621
|
/**
|
|
66877
68622
|
* SCIM service.
|
|
66878
68623
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
66879
|
-
* @version
|
|
68624
|
+
* @version 249.0.0
|
|
66880
68625
|
*/
|
|
66881
68626
|
|
|
66882
68627
|
/**
|
|
@@ -67753,7 +69498,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67753
69498
|
/**
|
|
67754
69499
|
* Scripts service.
|
|
67755
69500
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
67756
|
-
* @version
|
|
69501
|
+
* @version 249.0.0
|
|
67757
69502
|
*/
|
|
67758
69503
|
|
|
67759
69504
|
/**
|
|
@@ -68229,7 +69974,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68229
69974
|
/**
|
|
68230
69975
|
* Search service.
|
|
68231
69976
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
68232
|
-
* @version
|
|
69977
|
+
* @version 249.0.0
|
|
68233
69978
|
*/
|
|
68234
69979
|
|
|
68235
69980
|
/**
|
|
@@ -68942,7 +70687,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68942
70687
|
/**
|
|
68943
70688
|
* Settings service.
|
|
68944
70689
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
68945
|
-
* @version
|
|
70690
|
+
* @version 249.0.0
|
|
68946
70691
|
*/
|
|
68947
70692
|
|
|
68948
70693
|
/**
|
|
@@ -69290,7 +71035,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69290
71035
|
/**
|
|
69291
71036
|
* SocialMedia service.
|
|
69292
71037
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
69293
|
-
* @version
|
|
71038
|
+
* @version 249.0.0
|
|
69294
71039
|
*/
|
|
69295
71040
|
|
|
69296
71041
|
/**
|
|
@@ -71134,7 +72879,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
71134
72879
|
/**
|
|
71135
72880
|
* SpeechTextAnalytics service.
|
|
71136
72881
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
71137
|
-
* @version
|
|
72882
|
+
* @version 249.0.0
|
|
71138
72883
|
*/
|
|
71139
72884
|
|
|
71140
72885
|
/**
|
|
@@ -72810,7 +74555,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
72810
74555
|
/**
|
|
72811
74556
|
* Stations service.
|
|
72812
74557
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
72813
|
-
* @version
|
|
74558
|
+
* @version 249.0.0
|
|
72814
74559
|
*/
|
|
72815
74560
|
|
|
72816
74561
|
/**
|
|
@@ -72912,7 +74657,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
72912
74657
|
/**
|
|
72913
74658
|
* Suggest service.
|
|
72914
74659
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
72915
|
-
* @version
|
|
74660
|
+
* @version 249.0.0
|
|
72916
74661
|
*/
|
|
72917
74662
|
|
|
72918
74663
|
/**
|
|
@@ -73051,7 +74796,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
73051
74796
|
/**
|
|
73052
74797
|
* TaskManagement service.
|
|
73053
74798
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
73054
|
-
* @version
|
|
74799
|
+
* @version 249.0.0
|
|
73055
74800
|
*/
|
|
73056
74801
|
|
|
73057
74802
|
/**
|
|
@@ -74933,9 +76678,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74933
76678
|
|
|
74934
76679
|
/**
|
|
74935
76680
|
* Query for workitems
|
|
74936
|
-
* This query requires at least one EQ filter on the workbinId, assigneeId or typeId attributes.
|
|
76681
|
+
* This query requires at least one EQ filter on the workbinId, assigneeId, queueId or typeId attributes. A maximum of three filters are allowed.
|
|
74937
76682
|
* @param {Object} body WorkitemQueryPostRequest
|
|
74938
|
-
* postTaskmanagementWorkitemsQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
74939
76683
|
*/
|
|
74940
76684
|
postTaskmanagementWorkitemsQuery(body) {
|
|
74941
76685
|
// verify the required parameter 'body' is set
|
|
@@ -75213,7 +76957,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75213
76957
|
/**
|
|
75214
76958
|
* Teams service.
|
|
75215
76959
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
75216
|
-
* @version
|
|
76960
|
+
* @version 249.0.0
|
|
75217
76961
|
*/
|
|
75218
76962
|
|
|
75219
76963
|
/**
|
|
@@ -75518,7 +77262,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75518
77262
|
/**
|
|
75519
77263
|
* Telephony service.
|
|
75520
77264
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
75521
|
-
* @version
|
|
77265
|
+
* @version 249.0.0
|
|
75522
77266
|
*/
|
|
75523
77267
|
|
|
75524
77268
|
/**
|
|
@@ -75622,6 +77366,26 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75622
77366
|
);
|
|
75623
77367
|
}
|
|
75624
77368
|
|
|
77369
|
+
/**
|
|
77370
|
+
* Get the global telephony configuration.
|
|
77371
|
+
*
|
|
77372
|
+
*/
|
|
77373
|
+
getTelephonySettings() {
|
|
77374
|
+
|
|
77375
|
+
return this.apiClient.callApi(
|
|
77376
|
+
'/api/v2/telephony/settings',
|
|
77377
|
+
'GET',
|
|
77378
|
+
{ },
|
|
77379
|
+
{ },
|
|
77380
|
+
{ },
|
|
77381
|
+
{ },
|
|
77382
|
+
null,
|
|
77383
|
+
['PureCloud OAuth'],
|
|
77384
|
+
['application/json'],
|
|
77385
|
+
['application/json']
|
|
77386
|
+
);
|
|
77387
|
+
}
|
|
77388
|
+
|
|
75625
77389
|
/**
|
|
75626
77390
|
* Get a SIP message.
|
|
75627
77391
|
* Get the raw form of the SIP message
|
|
@@ -75818,13 +77582,38 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75818
77582
|
);
|
|
75819
77583
|
}
|
|
75820
77584
|
|
|
77585
|
+
/**
|
|
77586
|
+
* Update the global telephony configuration.
|
|
77587
|
+
*
|
|
77588
|
+
* @param {Object} body Telephony
|
|
77589
|
+
*/
|
|
77590
|
+
putTelephonySettings(body) {
|
|
77591
|
+
// verify the required parameter 'body' is set
|
|
77592
|
+
if (body === undefined || body === null) {
|
|
77593
|
+
throw 'Missing the required parameter "body" when calling putTelephonySettings';
|
|
77594
|
+
}
|
|
77595
|
+
|
|
77596
|
+
return this.apiClient.callApi(
|
|
77597
|
+
'/api/v2/telephony/settings',
|
|
77598
|
+
'PUT',
|
|
77599
|
+
{ },
|
|
77600
|
+
{ },
|
|
77601
|
+
{ },
|
|
77602
|
+
{ },
|
|
77603
|
+
body,
|
|
77604
|
+
['PureCloud OAuth'],
|
|
77605
|
+
['application/json'],
|
|
77606
|
+
['application/json']
|
|
77607
|
+
);
|
|
77608
|
+
}
|
|
77609
|
+
|
|
75821
77610
|
}
|
|
75822
77611
|
|
|
75823
77612
|
class TelephonyProvidersEdgeApi {
|
|
75824
77613
|
/**
|
|
75825
77614
|
* TelephonyProvidersEdge service.
|
|
75826
77615
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
75827
|
-
* @version
|
|
77616
|
+
* @version 249.0.0
|
|
75828
77617
|
*/
|
|
75829
77618
|
|
|
75830
77619
|
/**
|
|
@@ -79317,7 +81106,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
79317
81106
|
/**
|
|
79318
81107
|
* Textbots service.
|
|
79319
81108
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
79320
|
-
* @version
|
|
81109
|
+
* @version 249.0.0
|
|
79321
81110
|
*/
|
|
79322
81111
|
|
|
79323
81112
|
/**
|
|
@@ -79446,7 +81235,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
79446
81235
|
/**
|
|
79447
81236
|
* Tokens service.
|
|
79448
81237
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
79449
|
-
* @version
|
|
81238
|
+
* @version 249.0.0
|
|
79450
81239
|
*/
|
|
79451
81240
|
|
|
79452
81241
|
/**
|
|
@@ -79600,7 +81389,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
79600
81389
|
/**
|
|
79601
81390
|
* Uploads service.
|
|
79602
81391
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
79603
|
-
* @version
|
|
81392
|
+
* @version 249.0.0
|
|
79604
81393
|
*/
|
|
79605
81394
|
|
|
79606
81395
|
/**
|
|
@@ -79916,7 +81705,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
79916
81705
|
/**
|
|
79917
81706
|
* Usage service.
|
|
79918
81707
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
79919
|
-
* @version
|
|
81708
|
+
* @version 249.0.0
|
|
79920
81709
|
*/
|
|
79921
81710
|
|
|
79922
81711
|
/**
|
|
@@ -80251,7 +82040,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
80251
82040
|
/**
|
|
80252
82041
|
* UserRecordings service.
|
|
80253
82042
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
80254
|
-
* @version
|
|
82043
|
+
* @version 249.0.0
|
|
80255
82044
|
*/
|
|
80256
82045
|
|
|
80257
82046
|
/**
|
|
@@ -80435,7 +82224,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
80435
82224
|
/**
|
|
80436
82225
|
* Users service.
|
|
80437
82226
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
80438
|
-
* @version
|
|
82227
|
+
* @version 249.0.0
|
|
80439
82228
|
*/
|
|
80440
82229
|
|
|
80441
82230
|
/**
|
|
@@ -83885,7 +85674,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83885
85674
|
/**
|
|
83886
85675
|
* UsersRules service.
|
|
83887
85676
|
* @module purecloud-platform-client-v2/api/UsersRulesApi
|
|
83888
|
-
* @version
|
|
85677
|
+
* @version 249.0.0
|
|
83889
85678
|
*/
|
|
83890
85679
|
|
|
83891
85680
|
/**
|
|
@@ -84166,7 +85955,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
84166
85955
|
/**
|
|
84167
85956
|
* Utilities service.
|
|
84168
85957
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
84169
|
-
* @version
|
|
85958
|
+
* @version 249.0.0
|
|
84170
85959
|
*/
|
|
84171
85960
|
|
|
84172
85961
|
/**
|
|
@@ -84277,7 +86066,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
84277
86066
|
/**
|
|
84278
86067
|
* Voicemail service.
|
|
84279
86068
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
84280
|
-
* @version
|
|
86069
|
+
* @version 249.0.0
|
|
84281
86070
|
*/
|
|
84282
86071
|
|
|
84283
86072
|
/**
|
|
@@ -84999,7 +86788,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
84999
86788
|
/**
|
|
85000
86789
|
* WebChat service.
|
|
85001
86790
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
85002
|
-
* @version
|
|
86791
|
+
* @version 249.0.0
|
|
85003
86792
|
*/
|
|
85004
86793
|
|
|
85005
86794
|
/**
|
|
@@ -85562,7 +87351,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85562
87351
|
/**
|
|
85563
87352
|
* WebDeployments service.
|
|
85564
87353
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
85565
|
-
* @version
|
|
87354
|
+
* @version 249.0.0
|
|
85566
87355
|
*/
|
|
85567
87356
|
|
|
85568
87357
|
/**
|
|
@@ -86156,7 +87945,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
86156
87945
|
/**
|
|
86157
87946
|
* WebMessaging service.
|
|
86158
87947
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
86159
|
-
* @version
|
|
87948
|
+
* @version 249.0.0
|
|
86160
87949
|
*/
|
|
86161
87950
|
|
|
86162
87951
|
/**
|
|
@@ -86302,7 +88091,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
86302
88091
|
/**
|
|
86303
88092
|
* Widgets service.
|
|
86304
88093
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
86305
|
-
* @version
|
|
88094
|
+
* @version 249.0.0
|
|
86306
88095
|
*/
|
|
86307
88096
|
|
|
86308
88097
|
/**
|
|
@@ -86453,7 +88242,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
86453
88242
|
/**
|
|
86454
88243
|
* WorkforceManagement service.
|
|
86455
88244
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
86456
|
-
* @version
|
|
88245
|
+
* @version 249.0.0
|
|
86457
88246
|
*/
|
|
86458
88247
|
|
|
86459
88248
|
/**
|
|
@@ -87759,8 +89548,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
87759
89548
|
*
|
|
87760
89549
|
* @param {String} businessUnitId The ID of the business unit
|
|
87761
89550
|
* @param {String} capacityPlanId The ID of the capacity plan
|
|
89551
|
+
* @param {Object} opts Optional parameters
|
|
89552
|
+
* @param {Object} opts.granularity Granularity to access staffing group data, defaults to weekly
|
|
87762
89553
|
*/
|
|
87763
|
-
getWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocations(businessUnitId, capacityPlanId) {
|
|
89554
|
+
getWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocations(businessUnitId, capacityPlanId, opts) {
|
|
89555
|
+
opts = opts || {};
|
|
89556
|
+
|
|
87764
89557
|
// verify the required parameter 'businessUnitId' is set
|
|
87765
89558
|
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
87766
89559
|
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocations';
|
|
@@ -87774,7 +89567,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
87774
89567
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/staffinggroupallocations',
|
|
87775
89568
|
'GET',
|
|
87776
89569
|
{ 'businessUnitId': businessUnitId,'capacityPlanId': capacityPlanId },
|
|
87777
|
-
{
|
|
89570
|
+
{ 'granularity': opts['granularity'] },
|
|
87778
89571
|
{ },
|
|
87779
89572
|
{ },
|
|
87780
89573
|
null,
|
|
@@ -87820,8 +89613,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
87820
89613
|
* @param {String} businessUnitId
|
|
87821
89614
|
* @param {String} weekDateId weekDateId of forecast, format yyyy-MM-dd. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
87822
89615
|
* @param {String} forecastId forecastId of forecast
|
|
89616
|
+
* @param {Object} opts Optional parameters
|
|
89617
|
+
* @param {Object} opts.granularity Granularity to access staffing requirements data, defaults to weekly
|
|
87823
89618
|
*/
|
|
87824
|
-
getWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecast(businessUnitId, weekDateId, forecastId) {
|
|
89619
|
+
getWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecast(businessUnitId, weekDateId, forecastId, opts) {
|
|
89620
|
+
opts = opts || {};
|
|
89621
|
+
|
|
87825
89622
|
// verify the required parameter 'businessUnitId' is set
|
|
87826
89623
|
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
87827
89624
|
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecast';
|
|
@@ -87839,7 +89636,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
87839
89636
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplanning/longtermrequirements/automaticbestmethod/weeks/{weekDateId}/forecasts/{forecastId}',
|
|
87840
89637
|
'GET',
|
|
87841
89638
|
{ 'businessUnitId': businessUnitId,'weekDateId': weekDateId,'forecastId': forecastId },
|
|
87842
|
-
{
|
|
89639
|
+
{ 'granularity': opts['granularity'] },
|
|
87843
89640
|
{ },
|
|
87844
89641
|
{ },
|
|
87845
89642
|
null,
|
|
@@ -88027,6 +89824,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
88027
89824
|
);
|
|
88028
89825
|
}
|
|
88029
89826
|
|
|
89827
|
+
/**
|
|
89828
|
+
* Get minimum staffing settings for a business unit
|
|
89829
|
+
*
|
|
89830
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
89831
|
+
*/
|
|
89832
|
+
getWorkforcemanagementBusinessunitMinimumstaffingSettings(businessUnitId) {
|
|
89833
|
+
// verify the required parameter 'businessUnitId' is set
|
|
89834
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
89835
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitMinimumstaffingSettings';
|
|
89836
|
+
}
|
|
89837
|
+
|
|
89838
|
+
return this.apiClient.callApi(
|
|
89839
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/minimumstaffing/settings',
|
|
89840
|
+
'GET',
|
|
89841
|
+
{ 'businessUnitId': businessUnitId },
|
|
89842
|
+
{ },
|
|
89843
|
+
{ },
|
|
89844
|
+
{ },
|
|
89845
|
+
null,
|
|
89846
|
+
['PureCloud OAuth'],
|
|
89847
|
+
['application/json'],
|
|
89848
|
+
['application/json']
|
|
89849
|
+
);
|
|
89850
|
+
}
|
|
89851
|
+
|
|
88030
89852
|
/**
|
|
88031
89853
|
* Get a planning group
|
|
88032
89854
|
*
|
|
@@ -88082,6 +89904,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
88082
89904
|
);
|
|
88083
89905
|
}
|
|
88084
89906
|
|
|
89907
|
+
/**
|
|
89908
|
+
* Get scheduler settings for a business unit
|
|
89909
|
+
*
|
|
89910
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
89911
|
+
*/
|
|
89912
|
+
getWorkforcemanagementBusinessunitSchedulerSettings(businessUnitId) {
|
|
89913
|
+
// verify the required parameter 'businessUnitId' is set
|
|
89914
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
89915
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitSchedulerSettings';
|
|
89916
|
+
}
|
|
89917
|
+
|
|
89918
|
+
return this.apiClient.callApi(
|
|
89919
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduler/settings',
|
|
89920
|
+
'GET',
|
|
89921
|
+
{ 'businessUnitId': businessUnitId },
|
|
89922
|
+
{ },
|
|
89923
|
+
{ },
|
|
89924
|
+
{ },
|
|
89925
|
+
null,
|
|
89926
|
+
['PureCloud OAuth'],
|
|
89927
|
+
['application/json'],
|
|
89928
|
+
['application/json']
|
|
89929
|
+
);
|
|
89930
|
+
}
|
|
89931
|
+
|
|
88085
89932
|
/**
|
|
88086
89933
|
* Get a scheduling run
|
|
88087
89934
|
*
|
|
@@ -88419,6 +90266,35 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
88419
90266
|
);
|
|
88420
90267
|
}
|
|
88421
90268
|
|
|
90269
|
+
/**
|
|
90270
|
+
* Get users in the business unit
|
|
90271
|
+
*
|
|
90272
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
90273
|
+
* @param {Object} opts Optional parameters
|
|
90274
|
+
* @param {Array.<String>} opts.managementUnitIds The IDs of the management units for which to retrieve users
|
|
90275
|
+
*/
|
|
90276
|
+
getWorkforcemanagementBusinessunitUsers(businessUnitId, opts) {
|
|
90277
|
+
opts = opts || {};
|
|
90278
|
+
|
|
90279
|
+
// verify the required parameter 'businessUnitId' is set
|
|
90280
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
90281
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitUsers';
|
|
90282
|
+
}
|
|
90283
|
+
|
|
90284
|
+
return this.apiClient.callApi(
|
|
90285
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/users',
|
|
90286
|
+
'GET',
|
|
90287
|
+
{ 'businessUnitId': businessUnitId },
|
|
90288
|
+
{ 'managementUnitIds': this.apiClient.buildCollectionParam(opts['managementUnitIds'], 'multi') },
|
|
90289
|
+
{ },
|
|
90290
|
+
{ },
|
|
90291
|
+
null,
|
|
90292
|
+
['PureCloud OAuth'],
|
|
90293
|
+
['application/json'],
|
|
90294
|
+
['application/json']
|
|
90295
|
+
);
|
|
90296
|
+
}
|
|
90297
|
+
|
|
88422
90298
|
/**
|
|
88423
90299
|
* Get the metadata for the schedule, describing which management units and agents are in the scheduleSchedule data can then be loaded with the query route
|
|
88424
90300
|
*
|
|
@@ -90656,6 +92532,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
90656
92532
|
);
|
|
90657
92533
|
}
|
|
90658
92534
|
|
|
92535
|
+
/**
|
|
92536
|
+
* Update minimum staffing settings for a business unit
|
|
92537
|
+
*
|
|
92538
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
92539
|
+
* @param {Object} body body
|
|
92540
|
+
*/
|
|
92541
|
+
patchWorkforcemanagementBusinessunitMinimumstaffingSettings(businessUnitId, body) {
|
|
92542
|
+
// verify the required parameter 'businessUnitId' is set
|
|
92543
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
92544
|
+
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitMinimumstaffingSettings';
|
|
92545
|
+
}
|
|
92546
|
+
// verify the required parameter 'body' is set
|
|
92547
|
+
if (body === undefined || body === null) {
|
|
92548
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitMinimumstaffingSettings';
|
|
92549
|
+
}
|
|
92550
|
+
|
|
92551
|
+
return this.apiClient.callApi(
|
|
92552
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/minimumstaffing/settings',
|
|
92553
|
+
'PATCH',
|
|
92554
|
+
{ 'businessUnitId': businessUnitId },
|
|
92555
|
+
{ },
|
|
92556
|
+
{ },
|
|
92557
|
+
{ },
|
|
92558
|
+
body,
|
|
92559
|
+
['PureCloud OAuth'],
|
|
92560
|
+
['application/json'],
|
|
92561
|
+
['application/json']
|
|
92562
|
+
);
|
|
92563
|
+
}
|
|
92564
|
+
|
|
90659
92565
|
/**
|
|
90660
92566
|
* Updates the planning group
|
|
90661
92567
|
*
|
|
@@ -90691,6 +92597,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
90691
92597
|
);
|
|
90692
92598
|
}
|
|
90693
92599
|
|
|
92600
|
+
/**
|
|
92601
|
+
* Update scheduler settings for a business unit
|
|
92602
|
+
*
|
|
92603
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
92604
|
+
* @param {Object} body body
|
|
92605
|
+
*/
|
|
92606
|
+
patchWorkforcemanagementBusinessunitSchedulerSettings(businessUnitId, body) {
|
|
92607
|
+
// verify the required parameter 'businessUnitId' is set
|
|
92608
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
92609
|
+
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitSchedulerSettings';
|
|
92610
|
+
}
|
|
92611
|
+
// verify the required parameter 'body' is set
|
|
92612
|
+
if (body === undefined || body === null) {
|
|
92613
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitSchedulerSettings';
|
|
92614
|
+
}
|
|
92615
|
+
|
|
92616
|
+
return this.apiClient.callApi(
|
|
92617
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduler/settings',
|
|
92618
|
+
'PATCH',
|
|
92619
|
+
{ 'businessUnitId': businessUnitId },
|
|
92620
|
+
{ },
|
|
92621
|
+
{ },
|
|
92622
|
+
{ },
|
|
92623
|
+
body,
|
|
92624
|
+
['PureCloud OAuth'],
|
|
92625
|
+
['application/json'],
|
|
92626
|
+
['application/json']
|
|
92627
|
+
);
|
|
92628
|
+
}
|
|
92629
|
+
|
|
90694
92630
|
/**
|
|
90695
92631
|
* Mark a schedule run as applied
|
|
90696
92632
|
*
|
|
@@ -94744,7 +96680,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
94744
96680
|
* </pre>
|
|
94745
96681
|
* </p>
|
|
94746
96682
|
* @module purecloud-platform-client-v2/index
|
|
94747
|
-
* @version
|
|
96683
|
+
* @version 249.0.0
|
|
94748
96684
|
*/
|
|
94749
96685
|
class platformClient {
|
|
94750
96686
|
constructor() {
|
|
@@ -94828,6 +96764,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
94828
96764
|
* @property {module:purecloud-platform-client-v2/api/CarrierServicesApi}
|
|
94829
96765
|
*/
|
|
94830
96766
|
this.CarrierServicesApi = CarrierServicesApi;
|
|
96767
|
+
/**
|
|
96768
|
+
* The CaseManagementApi service constructor.
|
|
96769
|
+
* @property {module:purecloud-platform-client-v2/api/CaseManagementApi}
|
|
96770
|
+
*/
|
|
96771
|
+
this.CaseManagementApi = CaseManagementApi;
|
|
94831
96772
|
/**
|
|
94832
96773
|
* The ChatApi service constructor.
|
|
94833
96774
|
* @property {module:purecloud-platform-client-v2/api/ChatApi}
|