purecloud-platform-client-v2 205.0.0 → 207.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 +102 -3
- package/dist/node/purecloud-platform-client-v2.js +1241 -133
- package/dist/web-amd/purecloud-platform-client-v2.js +1241 -133
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +384 -137
- package/dist/web-cjs/purecloud-platform-client-v2.js +384 -137
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1242 -275
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +40 -18
- 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 +7 -6
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +2 -3
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +9 -5
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +232 -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/JourneyApi.js +191 -4
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -19
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +48 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +101 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/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 +311 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +7 -3
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +27 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +56 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +2 -2
- 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 +60 -1
- package/src/purecloud-platform-client-v2/configuration.js +81 -0
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -5,7 +5,7 @@ class KnowledgeApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Knowledge service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 207.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -343,7 +343,6 @@ class KnowledgeApi {
|
|
|
343
343
|
*
|
|
344
344
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
345
345
|
* @param {String} sourceId Source ID
|
|
346
|
-
* deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
347
346
|
*/
|
|
348
347
|
deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId(knowledgeBaseId, sourceId) {
|
|
349
348
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -374,7 +373,6 @@ class KnowledgeApi {
|
|
|
374
373
|
*
|
|
375
374
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
376
375
|
* @param {String} sourceId Source ID
|
|
377
|
-
* deleteKnowledgeKnowledgebaseSourcesServicenowSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
378
376
|
*/
|
|
379
377
|
deleteKnowledgeKnowledgebaseSourcesServicenowSourceId(knowledgeBaseId, sourceId) {
|
|
380
378
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -405,7 +403,6 @@ class KnowledgeApi {
|
|
|
405
403
|
*
|
|
406
404
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
407
405
|
* @param {String} syncJobId Synchronization job ID
|
|
408
|
-
* deleteKnowledgeKnowledgebaseSynchronizeJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
409
406
|
*/
|
|
410
407
|
deleteKnowledgeKnowledgebaseSynchronizeJob(knowledgeBaseId, syncJobId) {
|
|
411
408
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -532,7 +529,6 @@ class KnowledgeApi {
|
|
|
532
529
|
* Get sync options available for a knowledge-connect integration
|
|
533
530
|
*
|
|
534
531
|
* @param {String} integrationId Integration ID
|
|
535
|
-
* getKnowledgeIntegrationOptions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
536
532
|
*/
|
|
537
533
|
getKnowledgeIntegrationOptions(integrationId) {
|
|
538
534
|
// verify the required parameter 'integrationId' is set
|
|
@@ -1479,7 +1475,6 @@ class KnowledgeApi {
|
|
|
1479
1475
|
* @param {Array.<String>} opts.status If specified, retrieves operations with specified operation status, comma separated values expected.
|
|
1480
1476
|
* @param {String} opts.interval Retrieves the operations modified in specified date and time range. If the after and before cursor parameters are within this interval, it would return valid data, otherwise it throws an error.The dates in the interval are represented in ISO-8601 format: YYYY-MM-DDThh:mm:ssZ/YYYY-MM-DDThh:mm:ssZ
|
|
1481
1477
|
* @param {Array.<String>} opts.sourceId If specified, retrieves operations associated with source ids, comma separated values expected.
|
|
1482
|
-
* getKnowledgeKnowledgebaseOperations is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1483
1478
|
*/
|
|
1484
1479
|
getKnowledgeKnowledgebaseOperations(knowledgeBaseId, opts) {
|
|
1485
1480
|
opts = opts || {};
|
|
@@ -1507,7 +1502,6 @@ class KnowledgeApi {
|
|
|
1507
1502
|
* Get ids of operation creator users and oauth clients
|
|
1508
1503
|
*
|
|
1509
1504
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
1510
|
-
* getKnowledgeKnowledgebaseOperationsUsersQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1511
1505
|
*/
|
|
1512
1506
|
getKnowledgeKnowledgebaseOperationsUsersQuery(knowledgeBaseId) {
|
|
1513
1507
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -1572,7 +1566,6 @@ class KnowledgeApi {
|
|
|
1572
1566
|
* @param {Object} opts.type If specified, retrieves integration sources with specified integration type.
|
|
1573
1567
|
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
1574
1568
|
* @param {Array.<String>} opts.ids If specified, retrieves integration sources with specified IDs.
|
|
1575
|
-
* getKnowledgeKnowledgebaseSources is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1576
1569
|
*/
|
|
1577
1570
|
getKnowledgeKnowledgebaseSources(knowledgeBaseId, opts) {
|
|
1578
1571
|
opts = opts || {};
|
|
@@ -1603,7 +1596,6 @@ class KnowledgeApi {
|
|
|
1603
1596
|
* @param {String} sourceId Source ID
|
|
1604
1597
|
* @param {Object} opts Optional parameters
|
|
1605
1598
|
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
1606
|
-
* getKnowledgeKnowledgebaseSourcesSalesforceSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1607
1599
|
*/
|
|
1608
1600
|
getKnowledgeKnowledgebaseSourcesSalesforceSourceId(knowledgeBaseId, sourceId, opts) {
|
|
1609
1601
|
opts = opts || {};
|
|
@@ -1638,7 +1630,6 @@ class KnowledgeApi {
|
|
|
1638
1630
|
* @param {String} sourceId Source ID
|
|
1639
1631
|
* @param {Object} opts Optional parameters
|
|
1640
1632
|
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
1641
|
-
* getKnowledgeKnowledgebaseSourcesServicenowSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1642
1633
|
*/
|
|
1643
1634
|
getKnowledgeKnowledgebaseSourcesServicenowSourceId(knowledgeBaseId, sourceId, opts) {
|
|
1644
1635
|
opts = opts || {};
|
|
@@ -1671,7 +1662,6 @@ class KnowledgeApi {
|
|
|
1671
1662
|
*
|
|
1672
1663
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
1673
1664
|
* @param {String} syncJobId Synchronization job ID
|
|
1674
|
-
* getKnowledgeKnowledgebaseSynchronizeJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1675
1665
|
*/
|
|
1676
1666
|
getKnowledgeKnowledgebaseSynchronizeJob(knowledgeBaseId, syncJobId) {
|
|
1677
1667
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -2387,7 +2377,6 @@ class KnowledgeApi {
|
|
|
2387
2377
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
2388
2378
|
* @param {String} syncJobId Synchronization job ID
|
|
2389
2379
|
* @param {Object} body
|
|
2390
|
-
* patchKnowledgeKnowledgebaseSynchronizeJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2391
2380
|
*/
|
|
2392
2381
|
patchKnowledgeKnowledgebaseSynchronizeJob(knowledgeBaseId, syncJobId, body) {
|
|
2393
2382
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -3609,7 +3598,6 @@ class KnowledgeApi {
|
|
|
3609
3598
|
*
|
|
3610
3599
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
3611
3600
|
* @param {Object} body
|
|
3612
|
-
* postKnowledgeKnowledgebaseSourcesSalesforce is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3613
3601
|
*/
|
|
3614
3602
|
postKnowledgeKnowledgebaseSourcesSalesforce(knowledgeBaseId, body) {
|
|
3615
3603
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -3640,7 +3628,6 @@ class KnowledgeApi {
|
|
|
3640
3628
|
*
|
|
3641
3629
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
3642
3630
|
* @param {String} sourceId Source ID
|
|
3643
|
-
* postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3644
3631
|
*/
|
|
3645
3632
|
postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync(knowledgeBaseId, sourceId) {
|
|
3646
3633
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -3671,7 +3658,6 @@ class KnowledgeApi {
|
|
|
3671
3658
|
*
|
|
3672
3659
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
3673
3660
|
* @param {Object} body
|
|
3674
|
-
* postKnowledgeKnowledgebaseSourcesServicenow is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3675
3661
|
*/
|
|
3676
3662
|
postKnowledgeKnowledgebaseSourcesServicenow(knowledgeBaseId, body) {
|
|
3677
3663
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -3702,7 +3688,6 @@ class KnowledgeApi {
|
|
|
3702
3688
|
*
|
|
3703
3689
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
3704
3690
|
* @param {String} sourceId Source ID
|
|
3705
|
-
* postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3706
3691
|
*/
|
|
3707
3692
|
postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync(knowledgeBaseId, sourceId) {
|
|
3708
3693
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -3733,7 +3718,6 @@ class KnowledgeApi {
|
|
|
3733
3718
|
*
|
|
3734
3719
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
3735
3720
|
* @param {Object} body
|
|
3736
|
-
* postKnowledgeKnowledgebaseSynchronizeJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3737
3721
|
*/
|
|
3738
3722
|
postKnowledgeKnowledgebaseSynchronizeJobs(knowledgeBaseId, body) {
|
|
3739
3723
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -3821,7 +3805,6 @@ class KnowledgeApi {
|
|
|
3821
3805
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
3822
3806
|
* @param {String} sourceId Source ID
|
|
3823
3807
|
* @param {Object} body
|
|
3824
|
-
* putKnowledgeKnowledgebaseSourcesSalesforceSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3825
3808
|
*/
|
|
3826
3809
|
putKnowledgeKnowledgebaseSourcesSalesforceSourceId(knowledgeBaseId, sourceId, body) {
|
|
3827
3810
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -3857,7 +3840,6 @@ class KnowledgeApi {
|
|
|
3857
3840
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
3858
3841
|
* @param {String} sourceId Source ID
|
|
3859
3842
|
* @param {Object} body
|
|
3860
|
-
* putKnowledgeKnowledgebaseSourcesServicenowSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3861
3843
|
*/
|
|
3862
3844
|
putKnowledgeKnowledgebaseSourcesServicenowSourceId(knowledgeBaseId, sourceId, body) {
|
|
3863
3845
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -5,7 +5,7 @@ class OrganizationAuthorizationApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* OrganizationAuthorization service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 207.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -642,6 +642,26 @@ class OrganizationAuthorizationApi {
|
|
|
642
642
|
);
|
|
643
643
|
}
|
|
644
644
|
|
|
645
|
+
/**
|
|
646
|
+
* Get Customer Care organization ids.
|
|
647
|
+
*
|
|
648
|
+
*/
|
|
649
|
+
getOrgauthorizationTrusteesCare() {
|
|
650
|
+
|
|
651
|
+
return this.apiClient.callApi(
|
|
652
|
+
'/api/v2/orgauthorization/trustees/care',
|
|
653
|
+
'GET',
|
|
654
|
+
{ },
|
|
655
|
+
{ },
|
|
656
|
+
{ },
|
|
657
|
+
{ },
|
|
658
|
+
null,
|
|
659
|
+
['PureCloud OAuth'],
|
|
660
|
+
['application/json'],
|
|
661
|
+
['application/json']
|
|
662
|
+
);
|
|
663
|
+
}
|
|
664
|
+
|
|
645
665
|
/**
|
|
646
666
|
* Get organization authorization trust with Customer Care, if one exists.
|
|
647
667
|
*
|
|
@@ -1029,6 +1049,33 @@ class OrganizationAuthorizationApi {
|
|
|
1029
1049
|
);
|
|
1030
1050
|
}
|
|
1031
1051
|
|
|
1052
|
+
/**
|
|
1053
|
+
* Create a new organization authorization trust with Customer Care. This is required to grant your regional Customer Care organization access to your organization.
|
|
1054
|
+
*
|
|
1055
|
+
* @param {Object} opts Optional parameters
|
|
1056
|
+
* @param {Boolean} opts.assignDefaultRole Assign Admin role to default pairing with Customer Care
|
|
1057
|
+
* @param {Boolean} opts.autoExpire Automatically expire pairing after 30 days
|
|
1058
|
+
* @param {Boolean} opts.assignFullAccess Grant Customer Care full access to the organization
|
|
1059
|
+
* @param {Boolean} opts.allowTrustedUserAccess Make Customer Care a Trusted User
|
|
1060
|
+
*/
|
|
1061
|
+
postOrgauthorizationTrusteesCare(opts) {
|
|
1062
|
+
opts = opts || {};
|
|
1063
|
+
|
|
1064
|
+
|
|
1065
|
+
return this.apiClient.callApi(
|
|
1066
|
+
'/api/v2/orgauthorization/trustees/care',
|
|
1067
|
+
'POST',
|
|
1068
|
+
{ },
|
|
1069
|
+
{ 'assignDefaultRole': opts['assignDefaultRole'],'autoExpire': opts['autoExpire'],'assignFullAccess': opts['assignFullAccess'],'allowTrustedUserAccess': opts['allowTrustedUserAccess'] },
|
|
1070
|
+
{ },
|
|
1071
|
+
{ },
|
|
1072
|
+
null,
|
|
1073
|
+
['PureCloud OAuth'],
|
|
1074
|
+
['application/json'],
|
|
1075
|
+
['application/json']
|
|
1076
|
+
);
|
|
1077
|
+
}
|
|
1078
|
+
|
|
1032
1079
|
/**
|
|
1033
1080
|
* Create a new organization authorization trust with Customer Care. This is required to grant your regional Customer Care organization access to your organization.
|
|
1034
1081
|
*
|
|
@@ -5,7 +5,7 @@ class OutboundApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Outbound service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 207.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -2982,6 +2982,56 @@ class OutboundApi {
|
|
|
2982
2982
|
);
|
|
2983
2983
|
}
|
|
2984
2984
|
|
|
2985
|
+
/**
|
|
2986
|
+
* Start the campaign
|
|
2987
|
+
*
|
|
2988
|
+
* @param {String} campaignId Campaign ID
|
|
2989
|
+
*/
|
|
2990
|
+
postOutboundCampaignStart(campaignId) {
|
|
2991
|
+
// verify the required parameter 'campaignId' is set
|
|
2992
|
+
if (campaignId === undefined || campaignId === null) {
|
|
2993
|
+
throw 'Missing the required parameter "campaignId" when calling postOutboundCampaignStart';
|
|
2994
|
+
}
|
|
2995
|
+
|
|
2996
|
+
return this.apiClient.callApi(
|
|
2997
|
+
'/api/v2/outbound/campaigns/{campaignId}/start',
|
|
2998
|
+
'POST',
|
|
2999
|
+
{ 'campaignId': campaignId },
|
|
3000
|
+
{ },
|
|
3001
|
+
{ },
|
|
3002
|
+
{ },
|
|
3003
|
+
null,
|
|
3004
|
+
['PureCloud OAuth'],
|
|
3005
|
+
['application/json'],
|
|
3006
|
+
['application/json']
|
|
3007
|
+
);
|
|
3008
|
+
}
|
|
3009
|
+
|
|
3010
|
+
/**
|
|
3011
|
+
* Stop the campaign
|
|
3012
|
+
*
|
|
3013
|
+
* @param {String} campaignId Campaign ID
|
|
3014
|
+
*/
|
|
3015
|
+
postOutboundCampaignStop(campaignId) {
|
|
3016
|
+
// verify the required parameter 'campaignId' is set
|
|
3017
|
+
if (campaignId === undefined || campaignId === null) {
|
|
3018
|
+
throw 'Missing the required parameter "campaignId" when calling postOutboundCampaignStop';
|
|
3019
|
+
}
|
|
3020
|
+
|
|
3021
|
+
return this.apiClient.callApi(
|
|
3022
|
+
'/api/v2/outbound/campaigns/{campaignId}/stop',
|
|
3023
|
+
'POST',
|
|
3024
|
+
{ 'campaignId': campaignId },
|
|
3025
|
+
{ },
|
|
3026
|
+
{ },
|
|
3027
|
+
{ },
|
|
3028
|
+
null,
|
|
3029
|
+
['PureCloud OAuth'],
|
|
3030
|
+
['application/json'],
|
|
3031
|
+
['application/json']
|
|
3032
|
+
);
|
|
3033
|
+
}
|
|
3034
|
+
|
|
2985
3035
|
/**
|
|
2986
3036
|
* Create Campaign Rule
|
|
2987
3037
|
*
|
|
@@ -3681,6 +3731,56 @@ class OutboundApi {
|
|
|
3681
3731
|
);
|
|
3682
3732
|
}
|
|
3683
3733
|
|
|
3734
|
+
/**
|
|
3735
|
+
* Start the campaign
|
|
3736
|
+
* Documented permissions are applicable based on campaign type.
|
|
3737
|
+
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
3738
|
+
*/
|
|
3739
|
+
postOutboundMessagingcampaignStart(messagingCampaignId) {
|
|
3740
|
+
// verify the required parameter 'messagingCampaignId' is set
|
|
3741
|
+
if (messagingCampaignId === undefined || messagingCampaignId === null) {
|
|
3742
|
+
throw 'Missing the required parameter "messagingCampaignId" when calling postOutboundMessagingcampaignStart';
|
|
3743
|
+
}
|
|
3744
|
+
|
|
3745
|
+
return this.apiClient.callApi(
|
|
3746
|
+
'/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/start',
|
|
3747
|
+
'POST',
|
|
3748
|
+
{ 'messagingCampaignId': messagingCampaignId },
|
|
3749
|
+
{ },
|
|
3750
|
+
{ },
|
|
3751
|
+
{ },
|
|
3752
|
+
null,
|
|
3753
|
+
['PureCloud OAuth'],
|
|
3754
|
+
['application/json'],
|
|
3755
|
+
['application/json']
|
|
3756
|
+
);
|
|
3757
|
+
}
|
|
3758
|
+
|
|
3759
|
+
/**
|
|
3760
|
+
* Stop the campaign
|
|
3761
|
+
* Documented permissions are applicable based on campaign type.
|
|
3762
|
+
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
3763
|
+
*/
|
|
3764
|
+
postOutboundMessagingcampaignStop(messagingCampaignId) {
|
|
3765
|
+
// verify the required parameter 'messagingCampaignId' is set
|
|
3766
|
+
if (messagingCampaignId === undefined || messagingCampaignId === null) {
|
|
3767
|
+
throw 'Missing the required parameter "messagingCampaignId" when calling postOutboundMessagingcampaignStop';
|
|
3768
|
+
}
|
|
3769
|
+
|
|
3770
|
+
return this.apiClient.callApi(
|
|
3771
|
+
'/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/stop',
|
|
3772
|
+
'POST',
|
|
3773
|
+
{ 'messagingCampaignId': messagingCampaignId },
|
|
3774
|
+
{ },
|
|
3775
|
+
{ },
|
|
3776
|
+
{ },
|
|
3777
|
+
null,
|
|
3778
|
+
['PureCloud OAuth'],
|
|
3779
|
+
['application/json'],
|
|
3780
|
+
['application/json']
|
|
3781
|
+
);
|
|
3782
|
+
}
|
|
3783
|
+
|
|
3684
3784
|
/**
|
|
3685
3785
|
* Create a Messaging Campaign
|
|
3686
3786
|
*
|