purecloud-platform-client-v2 206.0.0 → 208.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 +100 -3
- package/dist/node/purecloud-platform-client-v2.js +979 -173
- package/dist/web-amd/purecloud-platform-client-v2.js +979 -173
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +341 -176
- package/dist/web-cjs/purecloud-platform-client-v2.js +358 -179
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1646 -606
- 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 +3 -2
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +234 -8
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +31 -11
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +136 -4
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +5 -21
- 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 +12 -12
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +55 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +4 -4
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +7 -3
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +55 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +38 -12
- 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 +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 +1 -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 ExternalContactsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* ExternalContacts service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 208.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -104,7 +104,6 @@ class ExternalContactsApi {
|
|
|
104
104
|
* Delete an External Source. WARNING: Any records that reference this External Source will not be automatically cleaned up. Those records will still be editable, but their External IDs may not be fully viewable.
|
|
105
105
|
*
|
|
106
106
|
* @param {String} externalSourceId External Source ID
|
|
107
|
-
* deleteExternalcontactsExternalsource is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
108
107
|
*/
|
|
109
108
|
deleteExternalcontactsExternalsource(externalSourceId) {
|
|
110
109
|
// verify the required parameter 'externalSourceId' is set
|
|
@@ -126,6 +125,31 @@ class ExternalContactsApi {
|
|
|
126
125
|
);
|
|
127
126
|
}
|
|
128
127
|
|
|
128
|
+
/**
|
|
129
|
+
* Delete settings for CSV import
|
|
130
|
+
*
|
|
131
|
+
* @param {String} settingsId Settings id
|
|
132
|
+
*/
|
|
133
|
+
deleteExternalcontactsImportCsvSetting(settingsId) {
|
|
134
|
+
// verify the required parameter 'settingsId' is set
|
|
135
|
+
if (settingsId === undefined || settingsId === null) {
|
|
136
|
+
throw 'Missing the required parameter "settingsId" when calling deleteExternalcontactsImportCsvSetting';
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
return this.apiClient.callApi(
|
|
140
|
+
'/api/v2/externalcontacts/import/csv/settings/{settingsId}',
|
|
141
|
+
'DELETE',
|
|
142
|
+
{ 'settingsId': settingsId },
|
|
143
|
+
{ },
|
|
144
|
+
{ },
|
|
145
|
+
{ },
|
|
146
|
+
null,
|
|
147
|
+
['PureCloud OAuth'],
|
|
148
|
+
['application/json'],
|
|
149
|
+
['application/json']
|
|
150
|
+
);
|
|
151
|
+
}
|
|
152
|
+
|
|
129
153
|
/**
|
|
130
154
|
* Delete an external organization
|
|
131
155
|
*
|
|
@@ -387,7 +411,7 @@ class ExternalContactsApi {
|
|
|
387
411
|
*
|
|
388
412
|
* @param {String} contactId ExternalContact ID
|
|
389
413
|
* @param {Object} opts Optional parameters
|
|
390
|
-
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
414
|
+
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
391
415
|
*/
|
|
392
416
|
getExternalcontactsContactUnresolved(contactId, opts) {
|
|
393
417
|
opts = opts || {};
|
|
@@ -543,7 +567,6 @@ class ExternalContactsApi {
|
|
|
543
567
|
* Fetch an External Source
|
|
544
568
|
*
|
|
545
569
|
* @param {String} externalSourceId External Source ID
|
|
546
|
-
* getExternalcontactsExternalsource is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
547
570
|
*/
|
|
548
571
|
getExternalcontactsExternalsource(externalSourceId) {
|
|
549
572
|
// verify the required parameter 'externalSourceId' is set
|
|
@@ -573,7 +596,6 @@ class ExternalContactsApi {
|
|
|
573
596
|
* @param {Number} opts.limit The number of ExternalSources per page; must be between 10 and 200, default is 100
|
|
574
597
|
* @param {String} opts.name Filter by external source name. Filtering is prefix filtering and not an exact match
|
|
575
598
|
* @param {Boolean} opts.active Filter by active status of external source
|
|
576
|
-
* getExternalcontactsExternalsources is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
577
599
|
*/
|
|
578
600
|
getExternalcontactsExternalsources(opts) {
|
|
579
601
|
opts = opts || {};
|
|
@@ -593,12 +615,113 @@ class ExternalContactsApi {
|
|
|
593
615
|
);
|
|
594
616
|
}
|
|
595
617
|
|
|
618
|
+
/**
|
|
619
|
+
* Get settings for CSV import
|
|
620
|
+
*
|
|
621
|
+
* @param {String} settingsId Settings id
|
|
622
|
+
*/
|
|
623
|
+
getExternalcontactsImportCsvSetting(settingsId) {
|
|
624
|
+
// verify the required parameter 'settingsId' is set
|
|
625
|
+
if (settingsId === undefined || settingsId === null) {
|
|
626
|
+
throw 'Missing the required parameter "settingsId" when calling getExternalcontactsImportCsvSetting';
|
|
627
|
+
}
|
|
628
|
+
|
|
629
|
+
return this.apiClient.callApi(
|
|
630
|
+
'/api/v2/externalcontacts/import/csv/settings/{settingsId}',
|
|
631
|
+
'GET',
|
|
632
|
+
{ 'settingsId': settingsId },
|
|
633
|
+
{ },
|
|
634
|
+
{ },
|
|
635
|
+
{ },
|
|
636
|
+
null,
|
|
637
|
+
['PureCloud OAuth'],
|
|
638
|
+
['application/json'],
|
|
639
|
+
['application/json']
|
|
640
|
+
);
|
|
641
|
+
}
|
|
642
|
+
|
|
643
|
+
/**
|
|
644
|
+
* Retrieve all settings for organization filtered by externalSettingsId if provided
|
|
645
|
+
*
|
|
646
|
+
* @param {Object} opts Optional parameters
|
|
647
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
648
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
649
|
+
* @param {String} opts.externalSettingsId External Settings Id to filter the list.
|
|
650
|
+
*/
|
|
651
|
+
getExternalcontactsImportCsvSettings(opts) {
|
|
652
|
+
opts = opts || {};
|
|
653
|
+
|
|
654
|
+
|
|
655
|
+
return this.apiClient.callApi(
|
|
656
|
+
'/api/v2/externalcontacts/import/csv/settings',
|
|
657
|
+
'GET',
|
|
658
|
+
{ },
|
|
659
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'externalSettingsId': opts['externalSettingsId'] },
|
|
660
|
+
{ },
|
|
661
|
+
{ },
|
|
662
|
+
null,
|
|
663
|
+
['PureCloud OAuth'],
|
|
664
|
+
['application/json'],
|
|
665
|
+
['application/json']
|
|
666
|
+
);
|
|
667
|
+
}
|
|
668
|
+
|
|
669
|
+
/**
|
|
670
|
+
* Get details for CSV upload
|
|
671
|
+
*
|
|
672
|
+
* @param {String} uploadId Upload id
|
|
673
|
+
*/
|
|
674
|
+
getExternalcontactsImportCsvUploadDetails(uploadId) {
|
|
675
|
+
// verify the required parameter 'uploadId' is set
|
|
676
|
+
if (uploadId === undefined || uploadId === null) {
|
|
677
|
+
throw 'Missing the required parameter "uploadId" when calling getExternalcontactsImportCsvUploadDetails';
|
|
678
|
+
}
|
|
679
|
+
|
|
680
|
+
return this.apiClient.callApi(
|
|
681
|
+
'/api/v2/externalcontacts/import/csv/uploads/{uploadId}/details',
|
|
682
|
+
'GET',
|
|
683
|
+
{ 'uploadId': uploadId },
|
|
684
|
+
{ },
|
|
685
|
+
{ },
|
|
686
|
+
{ },
|
|
687
|
+
null,
|
|
688
|
+
['PureCloud OAuth'],
|
|
689
|
+
['application/json'],
|
|
690
|
+
['application/json']
|
|
691
|
+
);
|
|
692
|
+
}
|
|
693
|
+
|
|
694
|
+
/**
|
|
695
|
+
* Get preview for CSV upload
|
|
696
|
+
*
|
|
697
|
+
* @param {String} uploadId Upload id
|
|
698
|
+
*/
|
|
699
|
+
getExternalcontactsImportCsvUploadPreview(uploadId) {
|
|
700
|
+
// verify the required parameter 'uploadId' is set
|
|
701
|
+
if (uploadId === undefined || uploadId === null) {
|
|
702
|
+
throw 'Missing the required parameter "uploadId" when calling getExternalcontactsImportCsvUploadPreview';
|
|
703
|
+
}
|
|
704
|
+
|
|
705
|
+
return this.apiClient.callApi(
|
|
706
|
+
'/api/v2/externalcontacts/import/csv/uploads/{uploadId}/preview',
|
|
707
|
+
'GET',
|
|
708
|
+
{ 'uploadId': uploadId },
|
|
709
|
+
{ },
|
|
710
|
+
{ },
|
|
711
|
+
{ },
|
|
712
|
+
null,
|
|
713
|
+
['PureCloud OAuth'],
|
|
714
|
+
['application/json'],
|
|
715
|
+
['application/json']
|
|
716
|
+
);
|
|
717
|
+
}
|
|
718
|
+
|
|
596
719
|
/**
|
|
597
720
|
* Fetch an external organization
|
|
598
721
|
*
|
|
599
722
|
* @param {String} externalOrganizationId External Organization ID
|
|
600
723
|
* @param {Object} opts Optional parameters
|
|
601
|
-
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
724
|
+
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
602
725
|
* @param {Boolean} opts.includeTrustors (true or false) whether or not to include trustor information embedded in the externalOrganization
|
|
603
726
|
*/
|
|
604
727
|
getExternalcontactsOrganization(externalOrganizationId, opts) {
|
|
@@ -1606,7 +1729,6 @@ class ExternalContactsApi {
|
|
|
1606
1729
|
* Create an External Source
|
|
1607
1730
|
*
|
|
1608
1731
|
* @param {Object} body External Source
|
|
1609
|
-
* postExternalcontactsExternalsources is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1610
1732
|
*/
|
|
1611
1733
|
postExternalcontactsExternalsources(body) {
|
|
1612
1734
|
// verify the required parameter 'body' is set
|
|
@@ -1657,6 +1779,81 @@ class ExternalContactsApi {
|
|
|
1657
1779
|
);
|
|
1658
1780
|
}
|
|
1659
1781
|
|
|
1782
|
+
/**
|
|
1783
|
+
* Create CSV import job
|
|
1784
|
+
*
|
|
1785
|
+
* @param {Object} body ImportRequest
|
|
1786
|
+
*/
|
|
1787
|
+
postExternalcontactsImportCsvJobs(body) {
|
|
1788
|
+
// verify the required parameter 'body' is set
|
|
1789
|
+
if (body === undefined || body === null) {
|
|
1790
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsImportCsvJobs';
|
|
1791
|
+
}
|
|
1792
|
+
|
|
1793
|
+
return this.apiClient.callApi(
|
|
1794
|
+
'/api/v2/externalcontacts/import/csv/jobs',
|
|
1795
|
+
'POST',
|
|
1796
|
+
{ },
|
|
1797
|
+
{ },
|
|
1798
|
+
{ },
|
|
1799
|
+
{ },
|
|
1800
|
+
body,
|
|
1801
|
+
['PureCloud OAuth'],
|
|
1802
|
+
['application/json'],
|
|
1803
|
+
['application/json']
|
|
1804
|
+
);
|
|
1805
|
+
}
|
|
1806
|
+
|
|
1807
|
+
/**
|
|
1808
|
+
* Create settings for CSV import
|
|
1809
|
+
*
|
|
1810
|
+
* @param {Object} body Settings
|
|
1811
|
+
*/
|
|
1812
|
+
postExternalcontactsImportCsvSettings(body) {
|
|
1813
|
+
// verify the required parameter 'body' is set
|
|
1814
|
+
if (body === undefined || body === null) {
|
|
1815
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsImportCsvSettings';
|
|
1816
|
+
}
|
|
1817
|
+
|
|
1818
|
+
return this.apiClient.callApi(
|
|
1819
|
+
'/api/v2/externalcontacts/import/csv/settings',
|
|
1820
|
+
'POST',
|
|
1821
|
+
{ },
|
|
1822
|
+
{ },
|
|
1823
|
+
{ },
|
|
1824
|
+
{ },
|
|
1825
|
+
body,
|
|
1826
|
+
['PureCloud OAuth'],
|
|
1827
|
+
['application/json'],
|
|
1828
|
+
['application/json']
|
|
1829
|
+
);
|
|
1830
|
+
}
|
|
1831
|
+
|
|
1832
|
+
/**
|
|
1833
|
+
* Get url for CSV upload
|
|
1834
|
+
*
|
|
1835
|
+
* @param {Object} body UploadRequest
|
|
1836
|
+
*/
|
|
1837
|
+
postExternalcontactsImportCsvUploads(body) {
|
|
1838
|
+
// verify the required parameter 'body' is set
|
|
1839
|
+
if (body === undefined || body === null) {
|
|
1840
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsImportCsvUploads';
|
|
1841
|
+
}
|
|
1842
|
+
|
|
1843
|
+
return this.apiClient.callApi(
|
|
1844
|
+
'/api/v2/externalcontacts/import/csv/uploads',
|
|
1845
|
+
'POST',
|
|
1846
|
+
{ },
|
|
1847
|
+
{ },
|
|
1848
|
+
{ },
|
|
1849
|
+
{ },
|
|
1850
|
+
body,
|
|
1851
|
+
['PureCloud OAuth'],
|
|
1852
|
+
['application/json'],
|
|
1853
|
+
['application/json']
|
|
1854
|
+
);
|
|
1855
|
+
}
|
|
1856
|
+
|
|
1660
1857
|
/**
|
|
1661
1858
|
* Merge two contacts into a new contact record
|
|
1662
1859
|
* Two curated contacts cannot be merged. Refer to the Contact Merging article on the Developer Center for details
|
|
@@ -1917,7 +2114,6 @@ class ExternalContactsApi {
|
|
|
1917
2114
|
*
|
|
1918
2115
|
* @param {String} externalSourceId External Source ID
|
|
1919
2116
|
* @param {Object} body External Source
|
|
1920
|
-
* putExternalcontactsExternalsource is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1921
2117
|
*/
|
|
1922
2118
|
putExternalcontactsExternalsource(externalSourceId, body) {
|
|
1923
2119
|
// verify the required parameter 'externalSourceId' is set
|
|
@@ -1943,6 +2139,36 @@ class ExternalContactsApi {
|
|
|
1943
2139
|
);
|
|
1944
2140
|
}
|
|
1945
2141
|
|
|
2142
|
+
/**
|
|
2143
|
+
* Update settings for CSV import
|
|
2144
|
+
*
|
|
2145
|
+
* @param {String} settingsId Settings id
|
|
2146
|
+
* @param {Object} body Settings
|
|
2147
|
+
*/
|
|
2148
|
+
putExternalcontactsImportCsvSetting(settingsId, body) {
|
|
2149
|
+
// verify the required parameter 'settingsId' is set
|
|
2150
|
+
if (settingsId === undefined || settingsId === null) {
|
|
2151
|
+
throw 'Missing the required parameter "settingsId" when calling putExternalcontactsImportCsvSetting';
|
|
2152
|
+
}
|
|
2153
|
+
// verify the required parameter 'body' is set
|
|
2154
|
+
if (body === undefined || body === null) {
|
|
2155
|
+
throw 'Missing the required parameter "body" when calling putExternalcontactsImportCsvSetting';
|
|
2156
|
+
}
|
|
2157
|
+
|
|
2158
|
+
return this.apiClient.callApi(
|
|
2159
|
+
'/api/v2/externalcontacts/import/csv/settings/{settingsId}',
|
|
2160
|
+
'PUT',
|
|
2161
|
+
{ 'settingsId': settingsId },
|
|
2162
|
+
{ },
|
|
2163
|
+
{ },
|
|
2164
|
+
{ },
|
|
2165
|
+
body,
|
|
2166
|
+
['PureCloud OAuth'],
|
|
2167
|
+
['application/json'],
|
|
2168
|
+
['application/json']
|
|
2169
|
+
);
|
|
2170
|
+
}
|
|
2171
|
+
|
|
1946
2172
|
/**
|
|
1947
2173
|
* Update an external organization
|
|
1948
2174
|
*
|
|
@@ -5,7 +5,7 @@ class IntegrationsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Integrations service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 208.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -299,8 +299,12 @@ class IntegrationsApi {
|
|
|
299
299
|
*
|
|
300
300
|
* @param {String} actionId actionId
|
|
301
301
|
* @param {String} fileName Name of schema file to be retrieved for this draft.
|
|
302
|
+
* @param {Object} opts Optional parameters
|
|
303
|
+
* @param {Boolean} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
|
|
302
304
|
*/
|
|
303
|
-
getIntegrationsActionDraftSchema(actionId, fileName) {
|
|
305
|
+
getIntegrationsActionDraftSchema(actionId, fileName, opts) {
|
|
306
|
+
opts = opts || {};
|
|
307
|
+
|
|
304
308
|
// verify the required parameter 'actionId' is set
|
|
305
309
|
if (actionId === undefined || actionId === null) {
|
|
306
310
|
throw 'Missing the required parameter "actionId" when calling getIntegrationsActionDraftSchema';
|
|
@@ -314,7 +318,7 @@ class IntegrationsApi {
|
|
|
314
318
|
'/api/v2/integrations/actions/{actionId}/draft/schemas/{fileName}',
|
|
315
319
|
'GET',
|
|
316
320
|
{ 'actionId': actionId,'fileName': fileName },
|
|
317
|
-
{
|
|
321
|
+
{ 'flatten': opts['flatten'] },
|
|
318
322
|
{ },
|
|
319
323
|
{ },
|
|
320
324
|
null,
|
|
@@ -410,8 +414,12 @@ class IntegrationsApi {
|
|
|
410
414
|
*
|
|
411
415
|
* @param {String} actionId actionId
|
|
412
416
|
* @param {String} fileName Name of schema file to be retrieved for this action.
|
|
417
|
+
* @param {Object} opts Optional parameters
|
|
418
|
+
* @param {Boolean} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
|
|
413
419
|
*/
|
|
414
|
-
getIntegrationsActionSchema(actionId, fileName) {
|
|
420
|
+
getIntegrationsActionSchema(actionId, fileName, opts) {
|
|
421
|
+
opts = opts || {};
|
|
422
|
+
|
|
415
423
|
// verify the required parameter 'actionId' is set
|
|
416
424
|
if (actionId === undefined || actionId === null) {
|
|
417
425
|
throw 'Missing the required parameter "actionId" when calling getIntegrationsActionSchema';
|
|
@@ -425,7 +433,7 @@ class IntegrationsApi {
|
|
|
425
433
|
'/api/v2/integrations/actions/{actionId}/schemas/{fileName}',
|
|
426
434
|
'GET',
|
|
427
435
|
{ 'actionId': actionId,'fileName': fileName },
|
|
428
|
-
{
|
|
436
|
+
{ 'flatten': opts['flatten'] },
|
|
429
437
|
{ },
|
|
430
438
|
{ },
|
|
431
439
|
null,
|
|
@@ -1962,8 +1970,12 @@ class IntegrationsApi {
|
|
|
1962
1970
|
*
|
|
1963
1971
|
* @param {String} actionId actionId
|
|
1964
1972
|
* @param {Object.<String, {String: Object}>} body Map of parameters used for variable substitution.
|
|
1973
|
+
* @param {Object} opts Optional parameters
|
|
1974
|
+
* @param {Boolean} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
|
|
1965
1975
|
*/
|
|
1966
|
-
postIntegrationsActionDraftTest(actionId, body) {
|
|
1976
|
+
postIntegrationsActionDraftTest(actionId, body, opts) {
|
|
1977
|
+
opts = opts || {};
|
|
1978
|
+
|
|
1967
1979
|
// verify the required parameter 'actionId' is set
|
|
1968
1980
|
if (actionId === undefined || actionId === null) {
|
|
1969
1981
|
throw 'Missing the required parameter "actionId" when calling postIntegrationsActionDraftTest';
|
|
@@ -1977,7 +1989,7 @@ class IntegrationsApi {
|
|
|
1977
1989
|
'/api/v2/integrations/actions/{actionId}/draft/test',
|
|
1978
1990
|
'POST',
|
|
1979
1991
|
{ 'actionId': actionId },
|
|
1980
|
-
{
|
|
1992
|
+
{ 'flatten': opts['flatten'] },
|
|
1981
1993
|
{ },
|
|
1982
1994
|
{ },
|
|
1983
1995
|
body,
|
|
@@ -1992,8 +2004,12 @@ class IntegrationsApi {
|
|
|
1992
2004
|
*
|
|
1993
2005
|
* @param {String} actionId actionId
|
|
1994
2006
|
* @param {Object.<String, {String: Object}>} body Map of parameters used for variable substitution.
|
|
2007
|
+
* @param {Object} opts Optional parameters
|
|
2008
|
+
* @param {Boolean} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
|
|
1995
2009
|
*/
|
|
1996
|
-
postIntegrationsActionExecute(actionId, body) {
|
|
2010
|
+
postIntegrationsActionExecute(actionId, body, opts) {
|
|
2011
|
+
opts = opts || {};
|
|
2012
|
+
|
|
1997
2013
|
// verify the required parameter 'actionId' is set
|
|
1998
2014
|
if (actionId === undefined || actionId === null) {
|
|
1999
2015
|
throw 'Missing the required parameter "actionId" when calling postIntegrationsActionExecute';
|
|
@@ -2007,7 +2023,7 @@ class IntegrationsApi {
|
|
|
2007
2023
|
'/api/v2/integrations/actions/{actionId}/execute',
|
|
2008
2024
|
'POST',
|
|
2009
2025
|
{ 'actionId': actionId },
|
|
2010
|
-
{
|
|
2026
|
+
{ 'flatten': opts['flatten'] },
|
|
2011
2027
|
{ },
|
|
2012
2028
|
{ },
|
|
2013
2029
|
body,
|
|
@@ -2022,8 +2038,12 @@ class IntegrationsApi {
|
|
|
2022
2038
|
*
|
|
2023
2039
|
* @param {String} actionId actionId
|
|
2024
2040
|
* @param {Object.<String, {String: Object}>} body Map of parameters used for variable substitution.
|
|
2041
|
+
* @param {Object} opts Optional parameters
|
|
2042
|
+
* @param {Boolean} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
|
|
2025
2043
|
*/
|
|
2026
|
-
postIntegrationsActionTest(actionId, body) {
|
|
2044
|
+
postIntegrationsActionTest(actionId, body, opts) {
|
|
2045
|
+
opts = opts || {};
|
|
2046
|
+
|
|
2027
2047
|
// verify the required parameter 'actionId' is set
|
|
2028
2048
|
if (actionId === undefined || actionId === null) {
|
|
2029
2049
|
throw 'Missing the required parameter "actionId" when calling postIntegrationsActionTest';
|
|
@@ -2037,7 +2057,7 @@ class IntegrationsApi {
|
|
|
2037
2057
|
'/api/v2/integrations/actions/{actionId}/test',
|
|
2038
2058
|
'POST',
|
|
2039
2059
|
{ 'actionId': actionId },
|
|
2040
|
-
{
|
|
2060
|
+
{ 'flatten': opts['flatten'] },
|
|
2041
2061
|
{ },
|
|
2042
2062
|
{ },
|
|
2043
2063
|
body,
|