purecloud-platform-client-v2 218.1.0 → 219.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 +1118 -100
- package/dist/web-amd/purecloud-platform-client-v2.js +1118 -100
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +349 -100
- package/dist/web-cjs/purecloud-platform-client-v2.js +349 -100
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +499 -8
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +54 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1 -1
- 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 +396 -2
- 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 +366 -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 +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -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 +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 +54 -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 +60 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +11 -11
- 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 +6 -4
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +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 +66 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +26 -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/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +7 -5
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -687,7 +687,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
687
687
|
|
|
688
688
|
/**
|
|
689
689
|
* @module purecloud-platform-client-v2/ApiClient
|
|
690
|
-
* @version
|
|
690
|
+
* @version 219.0.0
|
|
691
691
|
*/
|
|
692
692
|
class ApiClient {
|
|
693
693
|
/**
|
|
@@ -2231,7 +2231,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2231
2231
|
/**
|
|
2232
2232
|
* AgentAssistants service.
|
|
2233
2233
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
2234
|
-
* @version
|
|
2234
|
+
* @version 219.0.0
|
|
2235
2235
|
*/
|
|
2236
2236
|
|
|
2237
2237
|
/**
|
|
@@ -2607,7 +2607,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2607
2607
|
/**
|
|
2608
2608
|
* AgentCopilot service.
|
|
2609
2609
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
2610
|
-
* @version
|
|
2610
|
+
* @version 219.0.0
|
|
2611
2611
|
*/
|
|
2612
2612
|
|
|
2613
2613
|
/**
|
|
@@ -2683,7 +2683,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2683
2683
|
/**
|
|
2684
2684
|
* AgentUI service.
|
|
2685
2685
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
2686
|
-
* @version
|
|
2686
|
+
* @version 219.0.0
|
|
2687
2687
|
*/
|
|
2688
2688
|
|
|
2689
2689
|
/**
|
|
@@ -2814,7 +2814,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2814
2814
|
/**
|
|
2815
2815
|
* Alerting service.
|
|
2816
2816
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
2817
|
-
* @version
|
|
2817
|
+
* @version 219.0.0
|
|
2818
2818
|
*/
|
|
2819
2819
|
|
|
2820
2820
|
/**
|
|
@@ -3215,7 +3215,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3215
3215
|
/**
|
|
3216
3216
|
* Analytics service.
|
|
3217
3217
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
3218
|
-
* @version
|
|
3218
|
+
* @version 219.0.0
|
|
3219
3219
|
*/
|
|
3220
3220
|
|
|
3221
3221
|
/**
|
|
@@ -6036,7 +6036,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6036
6036
|
/**
|
|
6037
6037
|
* Architect service.
|
|
6038
6038
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
6039
|
-
* @version
|
|
6039
|
+
* @version 219.0.0
|
|
6040
6040
|
*/
|
|
6041
6041
|
|
|
6042
6042
|
/**
|
|
@@ -10329,7 +10329,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10329
10329
|
/**
|
|
10330
10330
|
* Audit service.
|
|
10331
10331
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
10332
|
-
* @version
|
|
10332
|
+
* @version 219.0.0
|
|
10333
10333
|
*/
|
|
10334
10334
|
|
|
10335
10335
|
/**
|
|
@@ -10530,7 +10530,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10530
10530
|
/**
|
|
10531
10531
|
* Authorization service.
|
|
10532
10532
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
10533
|
-
* @version
|
|
10533
|
+
* @version 219.0.0
|
|
10534
10534
|
*/
|
|
10535
10535
|
|
|
10536
10536
|
/**
|
|
@@ -10756,6 +10756,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10756
10756
|
);
|
|
10757
10757
|
}
|
|
10758
10758
|
|
|
10759
|
+
/**
|
|
10760
|
+
* Get a list of soft deleted divisions for the org
|
|
10761
|
+
*
|
|
10762
|
+
* @param {Object} opts Optional parameters
|
|
10763
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
10764
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
10765
|
+
*/
|
|
10766
|
+
getAuthorizationDivisionsDeleted(opts) {
|
|
10767
|
+
opts = opts || {};
|
|
10768
|
+
|
|
10769
|
+
|
|
10770
|
+
return this.apiClient.callApi(
|
|
10771
|
+
'/api/v2/authorization/divisions/deleted',
|
|
10772
|
+
'GET',
|
|
10773
|
+
{ },
|
|
10774
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
10775
|
+
{ },
|
|
10776
|
+
{ },
|
|
10777
|
+
null,
|
|
10778
|
+
['PureCloud OAuth'],
|
|
10779
|
+
['application/json'],
|
|
10780
|
+
['application/json']
|
|
10781
|
+
);
|
|
10782
|
+
}
|
|
10783
|
+
|
|
10759
10784
|
/**
|
|
10760
10785
|
* Retrieve the home division for the organization.
|
|
10761
10786
|
* Will not include object counts.
|
|
@@ -10796,6 +10821,34 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10796
10821
|
);
|
|
10797
10822
|
}
|
|
10798
10823
|
|
|
10824
|
+
/**
|
|
10825
|
+
* Retrieve a list of all divisions defined for the organization with cursor
|
|
10826
|
+
* Use "after" and "before" param to fetch next/previous page}
|
|
10827
|
+
* @param {Object} opts Optional parameters
|
|
10828
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
10829
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
10830
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
10831
|
+
* @param {Array.<String>} opts.id Optionally request specific divisions by their IDs
|
|
10832
|
+
* @param {String} opts.name Optionally request specific divisions by division name
|
|
10833
|
+
*/
|
|
10834
|
+
getAuthorizationDivisionsQuery(opts) {
|
|
10835
|
+
opts = opts || {};
|
|
10836
|
+
|
|
10837
|
+
|
|
10838
|
+
return this.apiClient.callApi(
|
|
10839
|
+
'/api/v2/authorization/divisions/query',
|
|
10840
|
+
'GET',
|
|
10841
|
+
{ },
|
|
10842
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'name': opts['name'] },
|
|
10843
|
+
{ },
|
|
10844
|
+
{ },
|
|
10845
|
+
null,
|
|
10846
|
+
['PureCloud OAuth'],
|
|
10847
|
+
['application/json'],
|
|
10848
|
+
['application/json']
|
|
10849
|
+
);
|
|
10850
|
+
}
|
|
10851
|
+
|
|
10799
10852
|
/**
|
|
10800
10853
|
* Returns which divisions the current user has the given permission in.
|
|
10801
10854
|
* This route is deprecated, use authorization/divisionspermitted/paged/me instead.
|
|
@@ -12192,7 +12245,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12192
12245
|
/**
|
|
12193
12246
|
* Billing service.
|
|
12194
12247
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
12195
|
-
* @version
|
|
12248
|
+
* @version 219.0.0
|
|
12196
12249
|
*/
|
|
12197
12250
|
|
|
12198
12251
|
/**
|
|
@@ -12272,7 +12325,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12272
12325
|
/**
|
|
12273
12326
|
* CarrierServices service.
|
|
12274
12327
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
12275
|
-
* @version
|
|
12328
|
+
* @version 219.0.0
|
|
12276
12329
|
*/
|
|
12277
12330
|
|
|
12278
12331
|
/**
|
|
@@ -12342,7 +12395,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12342
12395
|
/**
|
|
12343
12396
|
* Chat service.
|
|
12344
12397
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
12345
|
-
* @version
|
|
12398
|
+
* @version 219.0.0
|
|
12346
12399
|
*/
|
|
12347
12400
|
|
|
12348
12401
|
/**
|
|
@@ -13271,7 +13324,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13271
13324
|
/**
|
|
13272
13325
|
* Coaching service.
|
|
13273
13326
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
13274
|
-
* @version
|
|
13327
|
+
* @version 219.0.0
|
|
13275
13328
|
*/
|
|
13276
13329
|
|
|
13277
13330
|
/**
|
|
@@ -13848,7 +13901,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13848
13901
|
/**
|
|
13849
13902
|
* ContentManagement service.
|
|
13850
13903
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
13851
|
-
* @version
|
|
13904
|
+
* @version 219.0.0
|
|
13852
13905
|
*/
|
|
13853
13906
|
|
|
13854
13907
|
/**
|
|
@@ -14929,7 +14982,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14929
14982
|
/**
|
|
14930
14983
|
* Conversations service.
|
|
14931
14984
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
14932
|
-
* @version
|
|
14985
|
+
* @version 219.0.0
|
|
14933
14986
|
*/
|
|
14934
14987
|
|
|
14935
14988
|
/**
|
|
@@ -22511,7 +22564,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22511
22564
|
/**
|
|
22512
22565
|
* DataExtensions service.
|
|
22513
22566
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
22514
|
-
* @version
|
|
22567
|
+
* @version 219.0.0
|
|
22515
22568
|
*/
|
|
22516
22569
|
|
|
22517
22570
|
/**
|
|
@@ -22597,7 +22650,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22597
22650
|
/**
|
|
22598
22651
|
* DataPrivacy service.
|
|
22599
22652
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
22600
|
-
* @version
|
|
22653
|
+
* @version 219.0.0
|
|
22601
22654
|
*/
|
|
22602
22655
|
|
|
22603
22656
|
/**
|
|
@@ -22767,7 +22820,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22767
22820
|
/**
|
|
22768
22821
|
* Downloads service.
|
|
22769
22822
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
22770
|
-
* @version
|
|
22823
|
+
* @version 219.0.0
|
|
22771
22824
|
*/
|
|
22772
22825
|
|
|
22773
22826
|
/**
|
|
@@ -22819,7 +22872,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22819
22872
|
/**
|
|
22820
22873
|
* Emails service.
|
|
22821
22874
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
22822
|
-
* @version
|
|
22875
|
+
* @version 219.0.0
|
|
22823
22876
|
*/
|
|
22824
22877
|
|
|
22825
22878
|
/**
|
|
@@ -22948,7 +23001,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22948
23001
|
/**
|
|
22949
23002
|
* EmployeeEngagement service.
|
|
22950
23003
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
22951
|
-
* @version
|
|
23004
|
+
* @version 219.0.0
|
|
22952
23005
|
*/
|
|
22953
23006
|
|
|
22954
23007
|
/**
|
|
@@ -23099,7 +23152,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23099
23152
|
/**
|
|
23100
23153
|
* Events service.
|
|
23101
23154
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
23102
|
-
* @version
|
|
23155
|
+
* @version 219.0.0
|
|
23103
23156
|
*/
|
|
23104
23157
|
|
|
23105
23158
|
/**
|
|
@@ -23195,7 +23248,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23195
23248
|
/**
|
|
23196
23249
|
* ExternalContacts service.
|
|
23197
23250
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
23198
|
-
* @version
|
|
23251
|
+
* @version 219.0.0
|
|
23199
23252
|
*/
|
|
23200
23253
|
|
|
23201
23254
|
/**
|
|
@@ -23830,6 +23883,71 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23830
23883
|
);
|
|
23831
23884
|
}
|
|
23832
23885
|
|
|
23886
|
+
/**
|
|
23887
|
+
* Get the core types from which all schemas are built.
|
|
23888
|
+
*
|
|
23889
|
+
* @param {String} coreTypeName Name of the core type
|
|
23890
|
+
*/
|
|
23891
|
+
getExternalcontactsContactsSchemasCoretype(coreTypeName) {
|
|
23892
|
+
// verify the required parameter 'coreTypeName' is set
|
|
23893
|
+
if (coreTypeName === undefined || coreTypeName === null) {
|
|
23894
|
+
throw 'Missing the required parameter "coreTypeName" when calling getExternalcontactsContactsSchemasCoretype';
|
|
23895
|
+
}
|
|
23896
|
+
|
|
23897
|
+
return this.apiClient.callApi(
|
|
23898
|
+
'/api/v2/externalcontacts/contacts/schemas/coretypes/{coreTypeName}',
|
|
23899
|
+
'GET',
|
|
23900
|
+
{ 'coreTypeName': coreTypeName },
|
|
23901
|
+
{ },
|
|
23902
|
+
{ },
|
|
23903
|
+
{ },
|
|
23904
|
+
null,
|
|
23905
|
+
['PureCloud OAuth'],
|
|
23906
|
+
['application/json'],
|
|
23907
|
+
['application/json']
|
|
23908
|
+
);
|
|
23909
|
+
}
|
|
23910
|
+
|
|
23911
|
+
/**
|
|
23912
|
+
* Get the core types from which all schemas are built.
|
|
23913
|
+
*
|
|
23914
|
+
*/
|
|
23915
|
+
getExternalcontactsContactsSchemasCoretypes() {
|
|
23916
|
+
|
|
23917
|
+
return this.apiClient.callApi(
|
|
23918
|
+
'/api/v2/externalcontacts/contacts/schemas/coretypes',
|
|
23919
|
+
'GET',
|
|
23920
|
+
{ },
|
|
23921
|
+
{ },
|
|
23922
|
+
{ },
|
|
23923
|
+
{ },
|
|
23924
|
+
null,
|
|
23925
|
+
['PureCloud OAuth'],
|
|
23926
|
+
['application/json'],
|
|
23927
|
+
['application/json']
|
|
23928
|
+
);
|
|
23929
|
+
}
|
|
23930
|
+
|
|
23931
|
+
/**
|
|
23932
|
+
* Get quantitative limits on schemas
|
|
23933
|
+
*
|
|
23934
|
+
*/
|
|
23935
|
+
getExternalcontactsContactsSchemasLimits() {
|
|
23936
|
+
|
|
23937
|
+
return this.apiClient.callApi(
|
|
23938
|
+
'/api/v2/externalcontacts/contacts/schemas/limits',
|
|
23939
|
+
'GET',
|
|
23940
|
+
{ },
|
|
23941
|
+
{ },
|
|
23942
|
+
{ },
|
|
23943
|
+
{ },
|
|
23944
|
+
null,
|
|
23945
|
+
['PureCloud OAuth'],
|
|
23946
|
+
['application/json'],
|
|
23947
|
+
['application/json']
|
|
23948
|
+
);
|
|
23949
|
+
}
|
|
23950
|
+
|
|
23833
23951
|
/**
|
|
23834
23952
|
* Fetch an External Source
|
|
23835
23953
|
*
|
|
@@ -24155,6 +24273,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24155
24273
|
);
|
|
24156
24274
|
}
|
|
24157
24275
|
|
|
24276
|
+
/**
|
|
24277
|
+
* List the identifiers for an external organization
|
|
24278
|
+
*
|
|
24279
|
+
* @param {String} externalOrganizationId External Organization ID
|
|
24280
|
+
* getExternalcontactsOrganizationIdentifiers is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24281
|
+
*/
|
|
24282
|
+
getExternalcontactsOrganizationIdentifiers(externalOrganizationId) {
|
|
24283
|
+
// verify the required parameter 'externalOrganizationId' is set
|
|
24284
|
+
if (externalOrganizationId === undefined || externalOrganizationId === null) {
|
|
24285
|
+
throw 'Missing the required parameter "externalOrganizationId" when calling getExternalcontactsOrganizationIdentifiers';
|
|
24286
|
+
}
|
|
24287
|
+
|
|
24288
|
+
return this.apiClient.callApi(
|
|
24289
|
+
'/api/v2/externalcontacts/organizations/{externalOrganizationId}/identifiers',
|
|
24290
|
+
'GET',
|
|
24291
|
+
{ 'externalOrganizationId': externalOrganizationId },
|
|
24292
|
+
{ },
|
|
24293
|
+
{ },
|
|
24294
|
+
{ },
|
|
24295
|
+
null,
|
|
24296
|
+
['PureCloud OAuth'],
|
|
24297
|
+
['application/json'],
|
|
24298
|
+
['application/json']
|
|
24299
|
+
);
|
|
24300
|
+
}
|
|
24301
|
+
|
|
24158
24302
|
/**
|
|
24159
24303
|
* Fetch a note for an external organization
|
|
24160
24304
|
*
|
|
@@ -24384,6 +24528,71 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24384
24528
|
);
|
|
24385
24529
|
}
|
|
24386
24530
|
|
|
24531
|
+
/**
|
|
24532
|
+
* Get the core types from which all schemas are built.
|
|
24533
|
+
*
|
|
24534
|
+
* @param {String} coreTypeName Name of the core type
|
|
24535
|
+
*/
|
|
24536
|
+
getExternalcontactsOrganizationsSchemasCoretype(coreTypeName) {
|
|
24537
|
+
// verify the required parameter 'coreTypeName' is set
|
|
24538
|
+
if (coreTypeName === undefined || coreTypeName === null) {
|
|
24539
|
+
throw 'Missing the required parameter "coreTypeName" when calling getExternalcontactsOrganizationsSchemasCoretype';
|
|
24540
|
+
}
|
|
24541
|
+
|
|
24542
|
+
return this.apiClient.callApi(
|
|
24543
|
+
'/api/v2/externalcontacts/organizations/schemas/coretypes/{coreTypeName}',
|
|
24544
|
+
'GET',
|
|
24545
|
+
{ 'coreTypeName': coreTypeName },
|
|
24546
|
+
{ },
|
|
24547
|
+
{ },
|
|
24548
|
+
{ },
|
|
24549
|
+
null,
|
|
24550
|
+
['PureCloud OAuth'],
|
|
24551
|
+
['application/json'],
|
|
24552
|
+
['application/json']
|
|
24553
|
+
);
|
|
24554
|
+
}
|
|
24555
|
+
|
|
24556
|
+
/**
|
|
24557
|
+
* Get the core types from which all schemas are built.
|
|
24558
|
+
*
|
|
24559
|
+
*/
|
|
24560
|
+
getExternalcontactsOrganizationsSchemasCoretypes() {
|
|
24561
|
+
|
|
24562
|
+
return this.apiClient.callApi(
|
|
24563
|
+
'/api/v2/externalcontacts/organizations/schemas/coretypes',
|
|
24564
|
+
'GET',
|
|
24565
|
+
{ },
|
|
24566
|
+
{ },
|
|
24567
|
+
{ },
|
|
24568
|
+
{ },
|
|
24569
|
+
null,
|
|
24570
|
+
['PureCloud OAuth'],
|
|
24571
|
+
['application/json'],
|
|
24572
|
+
['application/json']
|
|
24573
|
+
);
|
|
24574
|
+
}
|
|
24575
|
+
|
|
24576
|
+
/**
|
|
24577
|
+
* Get quantitative limits on schemas
|
|
24578
|
+
*
|
|
24579
|
+
*/
|
|
24580
|
+
getExternalcontactsOrganizationsSchemasLimits() {
|
|
24581
|
+
|
|
24582
|
+
return this.apiClient.callApi(
|
|
24583
|
+
'/api/v2/externalcontacts/organizations/schemas/limits',
|
|
24584
|
+
'GET',
|
|
24585
|
+
{ },
|
|
24586
|
+
{ },
|
|
24587
|
+
{ },
|
|
24588
|
+
{ },
|
|
24589
|
+
null,
|
|
24590
|
+
['PureCloud OAuth'],
|
|
24591
|
+
['application/json'],
|
|
24592
|
+
['application/json']
|
|
24593
|
+
);
|
|
24594
|
+
}
|
|
24595
|
+
|
|
24387
24596
|
/**
|
|
24388
24597
|
* Fetch a relationship
|
|
24389
24598
|
*
|
|
@@ -24681,6 +24890,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24681
24890
|
);
|
|
24682
24891
|
}
|
|
24683
24892
|
|
|
24893
|
+
/**
|
|
24894
|
+
* Claim or release identifiers for an external organization
|
|
24895
|
+
*
|
|
24896
|
+
* @param {String} externalOrganizationId External Organization ID
|
|
24897
|
+
* @param {Object} body ClaimRequest
|
|
24898
|
+
* patchExternalcontactsOrganizationIdentifiers is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24899
|
+
*/
|
|
24900
|
+
patchExternalcontactsOrganizationIdentifiers(externalOrganizationId, body) {
|
|
24901
|
+
// verify the required parameter 'externalOrganizationId' is set
|
|
24902
|
+
if (externalOrganizationId === undefined || externalOrganizationId === null) {
|
|
24903
|
+
throw 'Missing the required parameter "externalOrganizationId" when calling patchExternalcontactsOrganizationIdentifiers';
|
|
24904
|
+
}
|
|
24905
|
+
// verify the required parameter 'body' is set
|
|
24906
|
+
if (body === undefined || body === null) {
|
|
24907
|
+
throw 'Missing the required parameter "body" when calling patchExternalcontactsOrganizationIdentifiers';
|
|
24908
|
+
}
|
|
24909
|
+
|
|
24910
|
+
return this.apiClient.callApi(
|
|
24911
|
+
'/api/v2/externalcontacts/organizations/{externalOrganizationId}/identifiers',
|
|
24912
|
+
'PATCH',
|
|
24913
|
+
{ 'externalOrganizationId': externalOrganizationId },
|
|
24914
|
+
{ },
|
|
24915
|
+
{ },
|
|
24916
|
+
{ },
|
|
24917
|
+
body,
|
|
24918
|
+
['PureCloud OAuth'],
|
|
24919
|
+
['application/json'],
|
|
24920
|
+
['application/json']
|
|
24921
|
+
);
|
|
24922
|
+
}
|
|
24923
|
+
|
|
24684
24924
|
/**
|
|
24685
24925
|
* Bulk fetch contacts
|
|
24686
24926
|
*
|
|
@@ -24757,6 +24997,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24757
24997
|
);
|
|
24758
24998
|
}
|
|
24759
24999
|
|
|
25000
|
+
/**
|
|
25001
|
+
* Bulk Enrich Contacts - Run up to 10 Enrich operations per request
|
|
25002
|
+
* See the API endpoint /externalcontacts/contacts/enrich for docs on individual Enrich operations.
|
|
25003
|
+
* @param {Object} body Contact Enrich Requests
|
|
25004
|
+
* @param {Object} opts Optional parameters
|
|
25005
|
+
* @param {Boolean} opts.dryRun If true, the request will not make any modifications, but will show you what the end result *would* be.
|
|
25006
|
+
* postExternalcontactsBulkContactsEnrich is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25007
|
+
*/
|
|
25008
|
+
postExternalcontactsBulkContactsEnrich(body, opts) {
|
|
25009
|
+
opts = opts || {};
|
|
25010
|
+
|
|
25011
|
+
// verify the required parameter 'body' is set
|
|
25012
|
+
if (body === undefined || body === null) {
|
|
25013
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsBulkContactsEnrich';
|
|
25014
|
+
}
|
|
25015
|
+
|
|
25016
|
+
return this.apiClient.callApi(
|
|
25017
|
+
'/api/v2/externalcontacts/bulk/contacts/enrich',
|
|
25018
|
+
'POST',
|
|
25019
|
+
{ },
|
|
25020
|
+
{ 'dryRun': opts['dryRun'] },
|
|
25021
|
+
{ },
|
|
25022
|
+
{ },
|
|
25023
|
+
body,
|
|
25024
|
+
['PureCloud OAuth'],
|
|
25025
|
+
['application/json'],
|
|
25026
|
+
['application/json']
|
|
25027
|
+
);
|
|
25028
|
+
}
|
|
25029
|
+
|
|
24760
25030
|
/**
|
|
24761
25031
|
* Bulk remove contacts
|
|
24762
25032
|
*
|
|
@@ -25008,6 +25278,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25008
25278
|
);
|
|
25009
25279
|
}
|
|
25010
25280
|
|
|
25281
|
+
/**
|
|
25282
|
+
* Bulk enrich external organizations - Run up to 10 Enrich operations per request
|
|
25283
|
+
* See the API endpoint /externalcontacts/organizations/enrich for docs on individual Enrich operations.
|
|
25284
|
+
* @param {Object} body External Organization Enrich Requests
|
|
25285
|
+
* @param {Object} opts Optional parameters
|
|
25286
|
+
* @param {Boolean} opts.dryRun If true, the request will not make any modifications, but will show you what the end result *would* be.
|
|
25287
|
+
* postExternalcontactsBulkOrganizationsEnrich is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25288
|
+
*/
|
|
25289
|
+
postExternalcontactsBulkOrganizationsEnrich(body, opts) {
|
|
25290
|
+
opts = opts || {};
|
|
25291
|
+
|
|
25292
|
+
// verify the required parameter 'body' is set
|
|
25293
|
+
if (body === undefined || body === null) {
|
|
25294
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsBulkOrganizationsEnrich';
|
|
25295
|
+
}
|
|
25296
|
+
|
|
25297
|
+
return this.apiClient.callApi(
|
|
25298
|
+
'/api/v2/externalcontacts/bulk/organizations/enrich',
|
|
25299
|
+
'POST',
|
|
25300
|
+
{ },
|
|
25301
|
+
{ 'dryRun': opts['dryRun'] },
|
|
25302
|
+
{ },
|
|
25303
|
+
{ },
|
|
25304
|
+
body,
|
|
25305
|
+
['PureCloud OAuth'],
|
|
25306
|
+
['application/json'],
|
|
25307
|
+
['application/json']
|
|
25308
|
+
);
|
|
25309
|
+
}
|
|
25310
|
+
|
|
25011
25311
|
/**
|
|
25012
25312
|
* Bulk remove organizations
|
|
25013
25313
|
*
|
|
@@ -25238,6 +25538,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25238
25538
|
);
|
|
25239
25539
|
}
|
|
25240
25540
|
|
|
25541
|
+
/**
|
|
25542
|
+
* Modify or create an External Contact, with powerful behaviors for finding and combining data with pre-existing Contacts.
|
|
25543
|
+
* You may also submit multiple Enrich operations in one request via the Bulk Enrich API at /externalcontacts/bulk/contacts. A 201 response status indicates that a new Contact was created, whereas a 200 status indicates that a Contact was updated or a merge occurred.
|
|
25544
|
+
* @param {Object} body ContactEnrichRequest
|
|
25545
|
+
* @param {Object} opts Optional parameters
|
|
25546
|
+
* @param {Boolean} opts.dryRun If true, the request will not make any modifications, but will show you what the end result *would* be.
|
|
25547
|
+
* postExternalcontactsContactsEnrich is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25548
|
+
*/
|
|
25549
|
+
postExternalcontactsContactsEnrich(body, opts) {
|
|
25550
|
+
opts = opts || {};
|
|
25551
|
+
|
|
25552
|
+
// verify the required parameter 'body' is set
|
|
25553
|
+
if (body === undefined || body === null) {
|
|
25554
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsContactsEnrich';
|
|
25555
|
+
}
|
|
25556
|
+
|
|
25557
|
+
return this.apiClient.callApi(
|
|
25558
|
+
'/api/v2/externalcontacts/contacts/enrich',
|
|
25559
|
+
'POST',
|
|
25560
|
+
{ },
|
|
25561
|
+
{ 'dryRun': opts['dryRun'] },
|
|
25562
|
+
{ },
|
|
25563
|
+
{ },
|
|
25564
|
+
body,
|
|
25565
|
+
['PureCloud OAuth'],
|
|
25566
|
+
['application/json'],
|
|
25567
|
+
['application/json']
|
|
25568
|
+
);
|
|
25569
|
+
}
|
|
25570
|
+
|
|
25241
25571
|
/**
|
|
25242
25572
|
* Create bulk export
|
|
25243
25573
|
*
|
|
@@ -25263,6 +25593,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25263
25593
|
);
|
|
25264
25594
|
}
|
|
25265
25595
|
|
|
25596
|
+
/**
|
|
25597
|
+
* Merge up to 25 contacts into a new contact record
|
|
25598
|
+
* Merge operation may fail if the resulting mergeset exceeds our default limit of 52. The valueOverride field lets you override any of the Contact fields post-merge. If any Contact field is left null in `valueOverride`, it will be taken from the most recently-modified contact in the merge set. Exception for *phone/*email fields: Conflicting data will be moved to any other available phone/email fields in the merged contact.
|
|
25599
|
+
* @param {Object} body MergeRequest
|
|
25600
|
+
* postExternalcontactsContactsMerge is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25601
|
+
*/
|
|
25602
|
+
postExternalcontactsContactsMerge(body) {
|
|
25603
|
+
// verify the required parameter 'body' is set
|
|
25604
|
+
if (body === undefined || body === null) {
|
|
25605
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsContactsMerge';
|
|
25606
|
+
}
|
|
25607
|
+
|
|
25608
|
+
return this.apiClient.callApi(
|
|
25609
|
+
'/api/v2/externalcontacts/contacts/merge',
|
|
25610
|
+
'POST',
|
|
25611
|
+
{ },
|
|
25612
|
+
{ },
|
|
25613
|
+
{ },
|
|
25614
|
+
{ },
|
|
25615
|
+
body,
|
|
25616
|
+
['PureCloud OAuth'],
|
|
25617
|
+
['application/json'],
|
|
25618
|
+
['application/json']
|
|
25619
|
+
);
|
|
25620
|
+
}
|
|
25621
|
+
|
|
25266
25622
|
/**
|
|
25267
25623
|
* Create a schema
|
|
25268
25624
|
*
|
|
@@ -25343,6 +25699,66 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25343
25699
|
);
|
|
25344
25700
|
}
|
|
25345
25701
|
|
|
25702
|
+
/**
|
|
25703
|
+
* Fetch a contact using an identifier type and value.
|
|
25704
|
+
* Phone number identifier values must be provided with the country code and a leading + symbol. Example: "+1 704 298 4733"
|
|
25705
|
+
* @param {Object} identifier
|
|
25706
|
+
* @param {Object} opts Optional parameters
|
|
25707
|
+
* @param {Array.<String>} opts.expand which field, if any, to expand
|
|
25708
|
+
* postExternalcontactsIdentifierlookupContacts is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25709
|
+
*/
|
|
25710
|
+
postExternalcontactsIdentifierlookupContacts(identifier, opts) {
|
|
25711
|
+
opts = opts || {};
|
|
25712
|
+
|
|
25713
|
+
// verify the required parameter 'identifier' is set
|
|
25714
|
+
if (identifier === undefined || identifier === null) {
|
|
25715
|
+
throw 'Missing the required parameter "identifier" when calling postExternalcontactsIdentifierlookupContacts';
|
|
25716
|
+
}
|
|
25717
|
+
|
|
25718
|
+
return this.apiClient.callApi(
|
|
25719
|
+
'/api/v2/externalcontacts/identifierlookup/contacts',
|
|
25720
|
+
'POST',
|
|
25721
|
+
{ },
|
|
25722
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
25723
|
+
{ },
|
|
25724
|
+
{ },
|
|
25725
|
+
identifier,
|
|
25726
|
+
['PureCloud OAuth'],
|
|
25727
|
+
['application/json'],
|
|
25728
|
+
['application/json']
|
|
25729
|
+
);
|
|
25730
|
+
}
|
|
25731
|
+
|
|
25732
|
+
/**
|
|
25733
|
+
* Fetch an external organization using an identifier type and value.
|
|
25734
|
+
* This endpoint will only accept ExternalId type identifiers.
|
|
25735
|
+
* @param {Object} identifier
|
|
25736
|
+
* @param {Object} opts Optional parameters
|
|
25737
|
+
* @param {Array.<String>} opts.expand which field, if any, to expand
|
|
25738
|
+
* postExternalcontactsIdentifierlookupOrganizations is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25739
|
+
*/
|
|
25740
|
+
postExternalcontactsIdentifierlookupOrganizations(identifier, opts) {
|
|
25741
|
+
opts = opts || {};
|
|
25742
|
+
|
|
25743
|
+
// verify the required parameter 'identifier' is set
|
|
25744
|
+
if (identifier === undefined || identifier === null) {
|
|
25745
|
+
throw 'Missing the required parameter "identifier" when calling postExternalcontactsIdentifierlookupOrganizations';
|
|
25746
|
+
}
|
|
25747
|
+
|
|
25748
|
+
return this.apiClient.callApi(
|
|
25749
|
+
'/api/v2/externalcontacts/identifierlookup/organizations',
|
|
25750
|
+
'POST',
|
|
25751
|
+
{ },
|
|
25752
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
25753
|
+
{ },
|
|
25754
|
+
{ },
|
|
25755
|
+
identifier,
|
|
25756
|
+
['PureCloud OAuth'],
|
|
25757
|
+
['application/json'],
|
|
25758
|
+
['application/json']
|
|
25759
|
+
);
|
|
25760
|
+
}
|
|
25761
|
+
|
|
25346
25762
|
/**
|
|
25347
25763
|
* Create CSV import job
|
|
25348
25764
|
*
|
|
@@ -25470,8 +25886,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25470
25886
|
|
|
25471
25887
|
/**
|
|
25472
25888
|
* Merge two contacts into a new contact record
|
|
25473
|
-
* Two curated contacts cannot be merged. Refer to the Contact Merging article on the Developer Center for details
|
|
25889
|
+
* Two curated contacts cannot be merged. Refer to the Contact Merging article on the Developer Center for details. Deprecated: This API has been superseded by a new merge API. You are encouraged to instead use /api/v2/externalcontacts/contacts/merge, which supports merging up to 25 Contacts of any type, and overriding specific fields in the resulting Contact.
|
|
25474
25890
|
* @param {Object} body MergeRequest
|
|
25891
|
+
* @deprecated
|
|
25475
25892
|
*/
|
|
25476
25893
|
postExternalcontactsMergeContacts(body) {
|
|
25477
25894
|
// verify the required parameter 'body' is set
|
|
@@ -25548,6 +25965,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25548
25965
|
);
|
|
25549
25966
|
}
|
|
25550
25967
|
|
|
25968
|
+
/**
|
|
25969
|
+
* Modify or create an External Org, with powerful behaviors for finding and combining data with pre-existing External Orgs.
|
|
25970
|
+
* You may also submit multiple Enrich operations in one request via the Bulk Enrich API at /externalcontacts/bulk/organizations. A 201 response status indicates that a new External Organization was created, whereas a 200 status indicates that an External Organization was updated
|
|
25971
|
+
* @param {Object} body ExternalOrgEnrichRequest
|
|
25972
|
+
* @param {Object} opts Optional parameters
|
|
25973
|
+
* @param {Boolean} opts.dryRun If true, the request will not make any modifications, but will show you what the end result *would* be.
|
|
25974
|
+
* postExternalcontactsOrganizationsEnrich is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25975
|
+
*/
|
|
25976
|
+
postExternalcontactsOrganizationsEnrich(body, opts) {
|
|
25977
|
+
opts = opts || {};
|
|
25978
|
+
|
|
25979
|
+
// verify the required parameter 'body' is set
|
|
25980
|
+
if (body === undefined || body === null) {
|
|
25981
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsOrganizationsEnrich';
|
|
25982
|
+
}
|
|
25983
|
+
|
|
25984
|
+
return this.apiClient.callApi(
|
|
25985
|
+
'/api/v2/externalcontacts/organizations/enrich',
|
|
25986
|
+
'POST',
|
|
25987
|
+
{ },
|
|
25988
|
+
{ 'dryRun': opts['dryRun'] },
|
|
25989
|
+
{ },
|
|
25990
|
+
{ },
|
|
25991
|
+
body,
|
|
25992
|
+
['PureCloud OAuth'],
|
|
25993
|
+
['application/json'],
|
|
25994
|
+
['application/json']
|
|
25995
|
+
);
|
|
25996
|
+
}
|
|
25997
|
+
|
|
25551
25998
|
/**
|
|
25552
25999
|
* Create a schema
|
|
25553
26000
|
*
|
|
@@ -26004,7 +26451,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26004
26451
|
/**
|
|
26005
26452
|
* Fax service.
|
|
26006
26453
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
26007
|
-
* @version
|
|
26454
|
+
* @version 219.0.0
|
|
26008
26455
|
*/
|
|
26009
26456
|
|
|
26010
26457
|
/**
|
|
@@ -26219,7 +26666,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26219
26666
|
/**
|
|
26220
26667
|
* Flows service.
|
|
26221
26668
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
26222
|
-
* @version
|
|
26669
|
+
* @version 219.0.0
|
|
26223
26670
|
*/
|
|
26224
26671
|
|
|
26225
26672
|
/**
|
|
@@ -26402,7 +26849,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26402
26849
|
/**
|
|
26403
26850
|
* Gamification service.
|
|
26404
26851
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
26405
|
-
* @version
|
|
26852
|
+
* @version 219.0.0
|
|
26406
26853
|
*/
|
|
26407
26854
|
|
|
26408
26855
|
/**
|
|
@@ -26442,6 +26889,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26442
26889
|
);
|
|
26443
26890
|
}
|
|
26444
26891
|
|
|
26892
|
+
/**
|
|
26893
|
+
* Delete a Contest by Id
|
|
26894
|
+
*
|
|
26895
|
+
* @param {String} contestId The ID of the contest
|
|
26896
|
+
*/
|
|
26897
|
+
deleteGamificationContest(contestId) {
|
|
26898
|
+
// verify the required parameter 'contestId' is set
|
|
26899
|
+
if (contestId === undefined || contestId === null) {
|
|
26900
|
+
throw 'Missing the required parameter "contestId" when calling deleteGamificationContest';
|
|
26901
|
+
}
|
|
26902
|
+
|
|
26903
|
+
return this.apiClient.callApi(
|
|
26904
|
+
'/api/v2/gamification/contests/{contestId}',
|
|
26905
|
+
'DELETE',
|
|
26906
|
+
{ 'contestId': contestId },
|
|
26907
|
+
{ },
|
|
26908
|
+
{ },
|
|
26909
|
+
{ },
|
|
26910
|
+
null,
|
|
26911
|
+
['PureCloud OAuth'],
|
|
26912
|
+
['application/json'],
|
|
26913
|
+
['application/json']
|
|
26914
|
+
);
|
|
26915
|
+
}
|
|
26916
|
+
|
|
26445
26917
|
/**
|
|
26446
26918
|
* Get an External Metric Definition
|
|
26447
26919
|
*
|
|
@@ -26492,6 +26964,236 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26492
26964
|
);
|
|
26493
26965
|
}
|
|
26494
26966
|
|
|
26967
|
+
/**
|
|
26968
|
+
* Get a Contest by Id
|
|
26969
|
+
*
|
|
26970
|
+
* @param {String} contestId The ID of the contest
|
|
26971
|
+
*/
|
|
26972
|
+
getGamificationContest(contestId) {
|
|
26973
|
+
// verify the required parameter 'contestId' is set
|
|
26974
|
+
if (contestId === undefined || contestId === null) {
|
|
26975
|
+
throw 'Missing the required parameter "contestId" when calling getGamificationContest';
|
|
26976
|
+
}
|
|
26977
|
+
|
|
26978
|
+
return this.apiClient.callApi(
|
|
26979
|
+
'/api/v2/gamification/contests/{contestId}',
|
|
26980
|
+
'GET',
|
|
26981
|
+
{ 'contestId': contestId },
|
|
26982
|
+
{ },
|
|
26983
|
+
{ },
|
|
26984
|
+
{ },
|
|
26985
|
+
null,
|
|
26986
|
+
['PureCloud OAuth'],
|
|
26987
|
+
['application/json'],
|
|
26988
|
+
['application/json']
|
|
26989
|
+
);
|
|
26990
|
+
}
|
|
26991
|
+
|
|
26992
|
+
/**
|
|
26993
|
+
* Get Contest Scores (Admin)
|
|
26994
|
+
*
|
|
26995
|
+
* @param {String} contestId The ID of the contest
|
|
26996
|
+
* @param {Object} opts Optional parameters
|
|
26997
|
+
* @param {Number} opts.pageNumber (default to 1)
|
|
26998
|
+
* @param {Number} opts.pageSize (default to 25)
|
|
26999
|
+
* @param {String} opts.workday Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
27000
|
+
* @param {Object} opts.returnsView Desired response results (default to All)
|
|
27001
|
+
*/
|
|
27002
|
+
getGamificationContestAgentsScores(contestId, opts) {
|
|
27003
|
+
opts = opts || {};
|
|
27004
|
+
|
|
27005
|
+
// verify the required parameter 'contestId' is set
|
|
27006
|
+
if (contestId === undefined || contestId === null) {
|
|
27007
|
+
throw 'Missing the required parameter "contestId" when calling getGamificationContestAgentsScores';
|
|
27008
|
+
}
|
|
27009
|
+
|
|
27010
|
+
return this.apiClient.callApi(
|
|
27011
|
+
'/api/v2/gamification/contests/{contestId}/agents/scores',
|
|
27012
|
+
'GET',
|
|
27013
|
+
{ 'contestId': contestId },
|
|
27014
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'workday': opts['workday'],'returnsView': opts['returnsView'] },
|
|
27015
|
+
{ },
|
|
27016
|
+
{ },
|
|
27017
|
+
null,
|
|
27018
|
+
['PureCloud OAuth'],
|
|
27019
|
+
['application/json'],
|
|
27020
|
+
['application/json']
|
|
27021
|
+
);
|
|
27022
|
+
}
|
|
27023
|
+
|
|
27024
|
+
/**
|
|
27025
|
+
* Get Contest Scores for the requesting Agent/Supervisor
|
|
27026
|
+
*
|
|
27027
|
+
* @param {String} contestId The ID of the contest
|
|
27028
|
+
* @param {Object} opts Optional parameters
|
|
27029
|
+
* @param {Number} opts.pageNumber (default to 1)
|
|
27030
|
+
* @param {Number} opts.pageSize (default to 25)
|
|
27031
|
+
* @param {String} opts.workday Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
27032
|
+
* @param {Object} opts.returnsView Desired response results (Supervisor Only) (default to All)
|
|
27033
|
+
*/
|
|
27034
|
+
getGamificationContestAgentsScoresMe(contestId, opts) {
|
|
27035
|
+
opts = opts || {};
|
|
27036
|
+
|
|
27037
|
+
// verify the required parameter 'contestId' is set
|
|
27038
|
+
if (contestId === undefined || contestId === null) {
|
|
27039
|
+
throw 'Missing the required parameter "contestId" when calling getGamificationContestAgentsScoresMe';
|
|
27040
|
+
}
|
|
27041
|
+
|
|
27042
|
+
return this.apiClient.callApi(
|
|
27043
|
+
'/api/v2/gamification/contests/{contestId}/agents/scores/me',
|
|
27044
|
+
'GET',
|
|
27045
|
+
{ 'contestId': contestId },
|
|
27046
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'workday': opts['workday'],'returnsView': opts['returnsView'] },
|
|
27047
|
+
{ },
|
|
27048
|
+
{ },
|
|
27049
|
+
null,
|
|
27050
|
+
['PureCloud OAuth'],
|
|
27051
|
+
['application/json'],
|
|
27052
|
+
['application/json']
|
|
27053
|
+
);
|
|
27054
|
+
}
|
|
27055
|
+
|
|
27056
|
+
/**
|
|
27057
|
+
* Get a Contest Score Trend (Average Trend)
|
|
27058
|
+
*
|
|
27059
|
+
* @param {String} contestId The ID of the contest
|
|
27060
|
+
*/
|
|
27061
|
+
getGamificationContestAgentsScoresTrends(contestId) {
|
|
27062
|
+
// verify the required parameter 'contestId' is set
|
|
27063
|
+
if (contestId === undefined || contestId === null) {
|
|
27064
|
+
throw 'Missing the required parameter "contestId" when calling getGamificationContestAgentsScoresTrends';
|
|
27065
|
+
}
|
|
27066
|
+
|
|
27067
|
+
return this.apiClient.callApi(
|
|
27068
|
+
'/api/v2/gamification/contests/{contestId}/agents/scores/trends',
|
|
27069
|
+
'GET',
|
|
27070
|
+
{ 'contestId': contestId },
|
|
27071
|
+
{ },
|
|
27072
|
+
{ },
|
|
27073
|
+
{ },
|
|
27074
|
+
null,
|
|
27075
|
+
['PureCloud OAuth'],
|
|
27076
|
+
['application/json'],
|
|
27077
|
+
['application/json']
|
|
27078
|
+
);
|
|
27079
|
+
}
|
|
27080
|
+
|
|
27081
|
+
/**
|
|
27082
|
+
* Get a Contest Score Trend for the requesting Agent
|
|
27083
|
+
*
|
|
27084
|
+
* @param {String} contestId The ID of the contest
|
|
27085
|
+
*/
|
|
27086
|
+
getGamificationContestAgentsScoresTrendsMe(contestId) {
|
|
27087
|
+
// verify the required parameter 'contestId' is set
|
|
27088
|
+
if (contestId === undefined || contestId === null) {
|
|
27089
|
+
throw 'Missing the required parameter "contestId" when calling getGamificationContestAgentsScoresTrendsMe';
|
|
27090
|
+
}
|
|
27091
|
+
|
|
27092
|
+
return this.apiClient.callApi(
|
|
27093
|
+
'/api/v2/gamification/contests/{contestId}/agents/scores/trends/me',
|
|
27094
|
+
'GET',
|
|
27095
|
+
{ 'contestId': contestId },
|
|
27096
|
+
{ },
|
|
27097
|
+
{ },
|
|
27098
|
+
{ },
|
|
27099
|
+
null,
|
|
27100
|
+
['PureCloud OAuth'],
|
|
27101
|
+
['application/json'],
|
|
27102
|
+
['application/json']
|
|
27103
|
+
);
|
|
27104
|
+
}
|
|
27105
|
+
|
|
27106
|
+
/**
|
|
27107
|
+
* Get a Contest Prize Image by Id
|
|
27108
|
+
*
|
|
27109
|
+
* @param {String} contestId The ID of the contest
|
|
27110
|
+
* @param {String} prizeImageId The ID of the prize image
|
|
27111
|
+
*/
|
|
27112
|
+
getGamificationContestPrizeimage(contestId, prizeImageId) {
|
|
27113
|
+
// verify the required parameter 'contestId' is set
|
|
27114
|
+
if (contestId === undefined || contestId === null) {
|
|
27115
|
+
throw 'Missing the required parameter "contestId" when calling getGamificationContestPrizeimage';
|
|
27116
|
+
}
|
|
27117
|
+
// verify the required parameter 'prizeImageId' is set
|
|
27118
|
+
if (prizeImageId === undefined || prizeImageId === null) {
|
|
27119
|
+
throw 'Missing the required parameter "prizeImageId" when calling getGamificationContestPrizeimage';
|
|
27120
|
+
}
|
|
27121
|
+
|
|
27122
|
+
return this.apiClient.callApi(
|
|
27123
|
+
'/api/v2/gamification/contests/{contestId}/prizeimages/{prizeImageId}',
|
|
27124
|
+
'GET',
|
|
27125
|
+
{ 'contestId': contestId,'prizeImageId': prizeImageId },
|
|
27126
|
+
{ },
|
|
27127
|
+
{ },
|
|
27128
|
+
{ },
|
|
27129
|
+
null,
|
|
27130
|
+
['PureCloud OAuth'],
|
|
27131
|
+
['application/json'],
|
|
27132
|
+
['application/json']
|
|
27133
|
+
);
|
|
27134
|
+
}
|
|
27135
|
+
|
|
27136
|
+
/**
|
|
27137
|
+
* Get a List of Contests (Admin)
|
|
27138
|
+
*
|
|
27139
|
+
* @param {Object} opts Optional parameters
|
|
27140
|
+
* @param {Number} opts.pageNumber (default to 1)
|
|
27141
|
+
* @param {Number} opts.pageSize (default to 25)
|
|
27142
|
+
* @param {String} opts.dateStart Start date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
27143
|
+
* @param {String} opts.dateEnd End date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
27144
|
+
* @param {Array.<String>} opts.status
|
|
27145
|
+
* @param {Object} opts.sortBy (default to dateStart)
|
|
27146
|
+
* @param {Object} opts.sortOrder (default to desc)
|
|
27147
|
+
*/
|
|
27148
|
+
getGamificationContests(opts) {
|
|
27149
|
+
opts = opts || {};
|
|
27150
|
+
|
|
27151
|
+
|
|
27152
|
+
return this.apiClient.callApi(
|
|
27153
|
+
'/api/v2/gamification/contests',
|
|
27154
|
+
'GET',
|
|
27155
|
+
{ },
|
|
27156
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'dateStart': opts['dateStart'],'dateEnd': opts['dateEnd'],'status': this.apiClient.buildCollectionParam(opts['status'], 'multi'),'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'] },
|
|
27157
|
+
{ },
|
|
27158
|
+
{ },
|
|
27159
|
+
null,
|
|
27160
|
+
['PureCloud OAuth'],
|
|
27161
|
+
['application/json'],
|
|
27162
|
+
['application/json']
|
|
27163
|
+
);
|
|
27164
|
+
}
|
|
27165
|
+
|
|
27166
|
+
/**
|
|
27167
|
+
* Get a List of Contests (Agent/Supervisor)
|
|
27168
|
+
*
|
|
27169
|
+
* @param {Object} opts Optional parameters
|
|
27170
|
+
* @param {Number} opts.pageNumber (default to 1)
|
|
27171
|
+
* @param {Number} opts.pageSize (default to 25)
|
|
27172
|
+
* @param {String} opts.dateStart Start date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
27173
|
+
* @param {String} opts.dateEnd End date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
27174
|
+
* @param {Array.<String>} opts.status
|
|
27175
|
+
* @param {Object} opts.sortBy (default to dateStart)
|
|
27176
|
+
* @param {Object} opts.sortOrder (default to desc)
|
|
27177
|
+
* @param {Object} opts.view (default to participant)
|
|
27178
|
+
*/
|
|
27179
|
+
getGamificationContestsMe(opts) {
|
|
27180
|
+
opts = opts || {};
|
|
27181
|
+
|
|
27182
|
+
|
|
27183
|
+
return this.apiClient.callApi(
|
|
27184
|
+
'/api/v2/gamification/contests/me',
|
|
27185
|
+
'GET',
|
|
27186
|
+
{ },
|
|
27187
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'dateStart': opts['dateStart'],'dateEnd': opts['dateEnd'],'status': this.apiClient.buildCollectionParam(opts['status'], 'multi'),'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'view': opts['view'] },
|
|
27188
|
+
{ },
|
|
27189
|
+
{ },
|
|
27190
|
+
null,
|
|
27191
|
+
['PureCloud OAuth'],
|
|
27192
|
+
['application/json'],
|
|
27193
|
+
['application/json']
|
|
27194
|
+
);
|
|
27195
|
+
}
|
|
27196
|
+
|
|
26495
27197
|
/**
|
|
26496
27198
|
* Get insights summary
|
|
26497
27199
|
*
|
|
@@ -28142,6 +28844,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28142
28844
|
);
|
|
28143
28845
|
}
|
|
28144
28846
|
|
|
28847
|
+
/**
|
|
28848
|
+
* Finalize a Contest by Id
|
|
28849
|
+
*
|
|
28850
|
+
* @param {String} contestId The ID of the contest
|
|
28851
|
+
* @param {Object} body Finalize Contest
|
|
28852
|
+
*/
|
|
28853
|
+
patchGamificationContest(contestId, body) {
|
|
28854
|
+
// verify the required parameter 'contestId' is set
|
|
28855
|
+
if (contestId === undefined || contestId === null) {
|
|
28856
|
+
throw 'Missing the required parameter "contestId" when calling patchGamificationContest';
|
|
28857
|
+
}
|
|
28858
|
+
// verify the required parameter 'body' is set
|
|
28859
|
+
if (body === undefined || body === null) {
|
|
28860
|
+
throw 'Missing the required parameter "body" when calling patchGamificationContest';
|
|
28861
|
+
}
|
|
28862
|
+
|
|
28863
|
+
return this.apiClient.callApi(
|
|
28864
|
+
'/api/v2/gamification/contests/{contestId}',
|
|
28865
|
+
'PATCH',
|
|
28866
|
+
{ 'contestId': contestId },
|
|
28867
|
+
{ },
|
|
28868
|
+
{ },
|
|
28869
|
+
{ },
|
|
28870
|
+
body,
|
|
28871
|
+
['PureCloud OAuth'],
|
|
28872
|
+
['application/json'],
|
|
28873
|
+
['application/json']
|
|
28874
|
+
);
|
|
28875
|
+
}
|
|
28876
|
+
|
|
28145
28877
|
/**
|
|
28146
28878
|
* Write External Metric Data
|
|
28147
28879
|
*
|
|
@@ -28190,6 +28922,56 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28190
28922
|
);
|
|
28191
28923
|
}
|
|
28192
28924
|
|
|
28925
|
+
/**
|
|
28926
|
+
* Creates a Contest
|
|
28927
|
+
*
|
|
28928
|
+
* @param {Object} body Create Contest
|
|
28929
|
+
*/
|
|
28930
|
+
postGamificationContests(body) {
|
|
28931
|
+
// verify the required parameter 'body' is set
|
|
28932
|
+
if (body === undefined || body === null) {
|
|
28933
|
+
throw 'Missing the required parameter "body" when calling postGamificationContests';
|
|
28934
|
+
}
|
|
28935
|
+
|
|
28936
|
+
return this.apiClient.callApi(
|
|
28937
|
+
'/api/v2/gamification/contests',
|
|
28938
|
+
'POST',
|
|
28939
|
+
{ },
|
|
28940
|
+
{ },
|
|
28941
|
+
{ },
|
|
28942
|
+
{ },
|
|
28943
|
+
body,
|
|
28944
|
+
['PureCloud OAuth'],
|
|
28945
|
+
['application/json'],
|
|
28946
|
+
['application/json']
|
|
28947
|
+
);
|
|
28948
|
+
}
|
|
28949
|
+
|
|
28950
|
+
/**
|
|
28951
|
+
* Generates pre-signed URL to upload a prize image for gamification contests
|
|
28952
|
+
*
|
|
28953
|
+
* @param {Object} body query
|
|
28954
|
+
*/
|
|
28955
|
+
postGamificationContestsUploadsPrizeimages(body) {
|
|
28956
|
+
// verify the required parameter 'body' is set
|
|
28957
|
+
if (body === undefined || body === null) {
|
|
28958
|
+
throw 'Missing the required parameter "body" when calling postGamificationContestsUploadsPrizeimages';
|
|
28959
|
+
}
|
|
28960
|
+
|
|
28961
|
+
return this.apiClient.callApi(
|
|
28962
|
+
'/api/v2/gamification/contests/uploads/prizeimages',
|
|
28963
|
+
'POST',
|
|
28964
|
+
{ },
|
|
28965
|
+
{ },
|
|
28966
|
+
{ },
|
|
28967
|
+
{ },
|
|
28968
|
+
body,
|
|
28969
|
+
['PureCloud OAuth'],
|
|
28970
|
+
['application/json'],
|
|
28971
|
+
['application/json']
|
|
28972
|
+
);
|
|
28973
|
+
}
|
|
28974
|
+
|
|
28193
28975
|
/**
|
|
28194
28976
|
* Activate a performance profile
|
|
28195
28977
|
*
|
|
@@ -28449,6 +29231,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28449
29231
|
);
|
|
28450
29232
|
}
|
|
28451
29233
|
|
|
29234
|
+
/**
|
|
29235
|
+
* Update a Contest by Id
|
|
29236
|
+
*
|
|
29237
|
+
* @param {String} contestId The ID of the contest
|
|
29238
|
+
* @param {Object} body Contest
|
|
29239
|
+
*/
|
|
29240
|
+
putGamificationContest(contestId, body) {
|
|
29241
|
+
// verify the required parameter 'contestId' is set
|
|
29242
|
+
if (contestId === undefined || contestId === null) {
|
|
29243
|
+
throw 'Missing the required parameter "contestId" when calling putGamificationContest';
|
|
29244
|
+
}
|
|
29245
|
+
// verify the required parameter 'body' is set
|
|
29246
|
+
if (body === undefined || body === null) {
|
|
29247
|
+
throw 'Missing the required parameter "body" when calling putGamificationContest';
|
|
29248
|
+
}
|
|
29249
|
+
|
|
29250
|
+
return this.apiClient.callApi(
|
|
29251
|
+
'/api/v2/gamification/contests/{contestId}',
|
|
29252
|
+
'PUT',
|
|
29253
|
+
{ 'contestId': contestId },
|
|
29254
|
+
{ },
|
|
29255
|
+
{ },
|
|
29256
|
+
{ },
|
|
29257
|
+
body,
|
|
29258
|
+
['PureCloud OAuth'],
|
|
29259
|
+
['application/json'],
|
|
29260
|
+
['application/json']
|
|
29261
|
+
);
|
|
29262
|
+
}
|
|
29263
|
+
|
|
28452
29264
|
/**
|
|
28453
29265
|
* Updates a performance profile
|
|
28454
29266
|
*
|
|
@@ -28544,7 +29356,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28544
29356
|
/**
|
|
28545
29357
|
* GeneralDataProtectionRegulation service.
|
|
28546
29358
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
28547
|
-
* @version
|
|
29359
|
+
* @version 219.0.0
|
|
28548
29360
|
*/
|
|
28549
29361
|
|
|
28550
29362
|
/**
|
|
@@ -28674,7 +29486,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28674
29486
|
/**
|
|
28675
29487
|
* Geolocation service.
|
|
28676
29488
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
28677
|
-
* @version
|
|
29489
|
+
* @version 219.0.0
|
|
28678
29490
|
*/
|
|
28679
29491
|
|
|
28680
29492
|
/**
|
|
@@ -28805,7 +29617,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28805
29617
|
/**
|
|
28806
29618
|
* Greetings service.
|
|
28807
29619
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
28808
|
-
* @version
|
|
29620
|
+
* @version 219.0.0
|
|
28809
29621
|
*/
|
|
28810
29622
|
|
|
28811
29623
|
/**
|
|
@@ -29260,7 +30072,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29260
30072
|
/**
|
|
29261
30073
|
* Groups service.
|
|
29262
30074
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
29263
|
-
* @version
|
|
30075
|
+
* @version 219.0.0
|
|
29264
30076
|
*/
|
|
29265
30077
|
|
|
29266
30078
|
/**
|
|
@@ -29779,7 +30591,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29779
30591
|
/**
|
|
29780
30592
|
* IdentityProvider service.
|
|
29781
30593
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
29782
|
-
* @version
|
|
30594
|
+
* @version 219.0.0
|
|
29783
30595
|
*/
|
|
29784
30596
|
|
|
29785
30597
|
/**
|
|
@@ -30640,7 +31452,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30640
31452
|
/**
|
|
30641
31453
|
* InfrastructureAsCode service.
|
|
30642
31454
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
30643
|
-
* @version
|
|
31455
|
+
* @version 219.0.0
|
|
30644
31456
|
*/
|
|
30645
31457
|
|
|
30646
31458
|
/**
|
|
@@ -30807,7 +31619,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30807
31619
|
/**
|
|
30808
31620
|
* Integrations service.
|
|
30809
31621
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
30810
|
-
* @version
|
|
31622
|
+
* @version 219.0.0
|
|
30811
31623
|
*/
|
|
30812
31624
|
|
|
30813
31625
|
/**
|
|
@@ -33276,7 +34088,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33276
34088
|
/**
|
|
33277
34089
|
* Journey service.
|
|
33278
34090
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
33279
|
-
* @version
|
|
34091
|
+
* @version 219.0.0
|
|
33280
34092
|
*/
|
|
33281
34093
|
|
|
33282
34094
|
/**
|
|
@@ -35261,7 +36073,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35261
36073
|
/**
|
|
35262
36074
|
* Knowledge service.
|
|
35263
36075
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
35264
|
-
* @version
|
|
36076
|
+
* @version 219.0.0
|
|
35265
36077
|
*/
|
|
35266
36078
|
|
|
35267
36079
|
/**
|
|
@@ -39134,7 +39946,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39134
39946
|
/**
|
|
39135
39947
|
* LanguageUnderstanding service.
|
|
39136
39948
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
39137
|
-
* @version
|
|
39949
|
+
* @version 219.0.0
|
|
39138
39950
|
*/
|
|
39139
39951
|
|
|
39140
39952
|
/**
|
|
@@ -40167,7 +40979,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40167
40979
|
/**
|
|
40168
40980
|
* Languages service.
|
|
40169
40981
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
40170
|
-
* @version
|
|
40982
|
+
* @version 219.0.0
|
|
40171
40983
|
*/
|
|
40172
40984
|
|
|
40173
40985
|
/**
|
|
@@ -40389,7 +41201,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40389
41201
|
/**
|
|
40390
41202
|
* Learning service.
|
|
40391
41203
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
40392
|
-
* @version
|
|
41204
|
+
* @version 219.0.0
|
|
40393
41205
|
*/
|
|
40394
41206
|
|
|
40395
41207
|
/**
|
|
@@ -41418,7 +42230,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41418
42230
|
/**
|
|
41419
42231
|
* License service.
|
|
41420
42232
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
41421
|
-
* @version
|
|
42233
|
+
* @version 219.0.0
|
|
41422
42234
|
*/
|
|
41423
42235
|
|
|
41424
42236
|
/**
|
|
@@ -41656,7 +42468,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41656
42468
|
/**
|
|
41657
42469
|
* Locations service.
|
|
41658
42470
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
41659
|
-
* @version
|
|
42471
|
+
* @version 219.0.0
|
|
41660
42472
|
*/
|
|
41661
42473
|
|
|
41662
42474
|
/**
|
|
@@ -41892,7 +42704,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41892
42704
|
/**
|
|
41893
42705
|
* LogCapture service.
|
|
41894
42706
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
41895
|
-
* @version
|
|
42707
|
+
* @version 219.0.0
|
|
41896
42708
|
*/
|
|
41897
42709
|
|
|
41898
42710
|
/**
|
|
@@ -42092,7 +42904,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42092
42904
|
/**
|
|
42093
42905
|
* Messaging service.
|
|
42094
42906
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
42095
|
-
* @version
|
|
42907
|
+
* @version 219.0.0
|
|
42096
42908
|
*/
|
|
42097
42909
|
|
|
42098
42910
|
/**
|
|
@@ -42451,7 +43263,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42451
43263
|
/**
|
|
42452
43264
|
* MobileDevices service.
|
|
42453
43265
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
42454
|
-
* @version
|
|
43266
|
+
* @version 219.0.0
|
|
42455
43267
|
*/
|
|
42456
43268
|
|
|
42457
43269
|
/**
|
|
@@ -42602,7 +43414,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42602
43414
|
/**
|
|
42603
43415
|
* Notifications service.
|
|
42604
43416
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
42605
|
-
* @version
|
|
43417
|
+
* @version 219.0.0
|
|
42606
43418
|
*/
|
|
42607
43419
|
|
|
42608
43420
|
/**
|
|
@@ -42835,7 +43647,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42835
43647
|
/**
|
|
42836
43648
|
* OAuth service.
|
|
42837
43649
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
42838
|
-
* @version
|
|
43650
|
+
* @version 219.0.0
|
|
42839
43651
|
*/
|
|
42840
43652
|
|
|
42841
43653
|
/**
|
|
@@ -43201,7 +44013,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43201
44013
|
/**
|
|
43202
44014
|
* Objects service.
|
|
43203
44015
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
43204
|
-
* @version
|
|
44016
|
+
* @version 219.0.0
|
|
43205
44017
|
*/
|
|
43206
44018
|
|
|
43207
44019
|
/**
|
|
@@ -43306,6 +44118,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43306
44118
|
);
|
|
43307
44119
|
}
|
|
43308
44120
|
|
|
44121
|
+
/**
|
|
44122
|
+
* Get a list of soft deleted divisions for the org
|
|
44123
|
+
*
|
|
44124
|
+
* @param {Object} opts Optional parameters
|
|
44125
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
44126
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
44127
|
+
*/
|
|
44128
|
+
getAuthorizationDivisionsDeleted(opts) {
|
|
44129
|
+
opts = opts || {};
|
|
44130
|
+
|
|
44131
|
+
|
|
44132
|
+
return this.apiClient.callApi(
|
|
44133
|
+
'/api/v2/authorization/divisions/deleted',
|
|
44134
|
+
'GET',
|
|
44135
|
+
{ },
|
|
44136
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
44137
|
+
{ },
|
|
44138
|
+
{ },
|
|
44139
|
+
null,
|
|
44140
|
+
['PureCloud OAuth'],
|
|
44141
|
+
['application/json'],
|
|
44142
|
+
['application/json']
|
|
44143
|
+
);
|
|
44144
|
+
}
|
|
44145
|
+
|
|
43309
44146
|
/**
|
|
43310
44147
|
* Retrieve the home division for the organization.
|
|
43311
44148
|
* Will not include object counts.
|
|
@@ -43346,6 +44183,34 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43346
44183
|
);
|
|
43347
44184
|
}
|
|
43348
44185
|
|
|
44186
|
+
/**
|
|
44187
|
+
* Retrieve a list of all divisions defined for the organization with cursor
|
|
44188
|
+
* Use "after" and "before" param to fetch next/previous page}
|
|
44189
|
+
* @param {Object} opts Optional parameters
|
|
44190
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
44191
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
44192
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
44193
|
+
* @param {Array.<String>} opts.id Optionally request specific divisions by their IDs
|
|
44194
|
+
* @param {String} opts.name Optionally request specific divisions by division name
|
|
44195
|
+
*/
|
|
44196
|
+
getAuthorizationDivisionsQuery(opts) {
|
|
44197
|
+
opts = opts || {};
|
|
44198
|
+
|
|
44199
|
+
|
|
44200
|
+
return this.apiClient.callApi(
|
|
44201
|
+
'/api/v2/authorization/divisions/query',
|
|
44202
|
+
'GET',
|
|
44203
|
+
{ },
|
|
44204
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'name': opts['name'] },
|
|
44205
|
+
{ },
|
|
44206
|
+
{ },
|
|
44207
|
+
null,
|
|
44208
|
+
['PureCloud OAuth'],
|
|
44209
|
+
['application/json'],
|
|
44210
|
+
['application/json']
|
|
44211
|
+
);
|
|
44212
|
+
}
|
|
44213
|
+
|
|
43349
44214
|
/**
|
|
43350
44215
|
* Assign a list of objects to a division
|
|
43351
44216
|
* Set the division of a specified list of objects. The objects must all be of the same type, one of: CAMPAIGN, MANAGEMENTUNIT, FLOW, QUEUE, DATATABLES or USER. The body of the request is a list of object IDs, which are expected to be GUIDs, e.g. ["206ce31f-61ec-40ed-a8b1-be6f06303998","250a754e-f5e4-4f51-800f-a92f09d3bf8c"]
|
|
@@ -43472,7 +44337,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43472
44337
|
/**
|
|
43473
44338
|
* OperationalEvents service.
|
|
43474
44339
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
43475
|
-
* @version
|
|
44340
|
+
* @version 219.0.0
|
|
43476
44341
|
*/
|
|
43477
44342
|
|
|
43478
44343
|
/**
|
|
@@ -43589,7 +44454,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43589
44454
|
/**
|
|
43590
44455
|
* Organization service.
|
|
43591
44456
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
43592
|
-
* @version
|
|
44457
|
+
* @version 219.0.0
|
|
43593
44458
|
*/
|
|
43594
44459
|
|
|
43595
44460
|
/**
|
|
@@ -44064,7 +44929,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44064
44929
|
/**
|
|
44065
44930
|
* OrganizationAuthorization service.
|
|
44066
44931
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
44067
|
-
* @version
|
|
44932
|
+
* @version 219.0.0
|
|
44068
44933
|
*/
|
|
44069
44934
|
|
|
44070
44935
|
/**
|
|
@@ -45458,7 +46323,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45458
46323
|
/**
|
|
45459
46324
|
* Outbound service.
|
|
45460
46325
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
45461
|
-
* @version
|
|
46326
|
+
* @version 219.0.0
|
|
45462
46327
|
*/
|
|
45463
46328
|
|
|
45464
46329
|
/**
|
|
@@ -45945,6 +46810,35 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45945
46810
|
);
|
|
45946
46811
|
}
|
|
45947
46812
|
|
|
46813
|
+
/**
|
|
46814
|
+
* Deletes all or expired whatsApp numbers from a DNC list.
|
|
46815
|
+
* This operation is only for Internal DNC lists of whatsApp numbers
|
|
46816
|
+
* @param {String} dncListId DncList ID
|
|
46817
|
+
* @param {Object} opts Optional parameters
|
|
46818
|
+
* @param {Boolean} opts.expiredOnly Set to true to only remove DNC whatsApp numbers that are expired (default to false)
|
|
46819
|
+
*/
|
|
46820
|
+
deleteOutboundDnclistWhatsappnumbers(dncListId, opts) {
|
|
46821
|
+
opts = opts || {};
|
|
46822
|
+
|
|
46823
|
+
// verify the required parameter 'dncListId' is set
|
|
46824
|
+
if (dncListId === undefined || dncListId === null) {
|
|
46825
|
+
throw 'Missing the required parameter "dncListId" when calling deleteOutboundDnclistWhatsappnumbers';
|
|
46826
|
+
}
|
|
46827
|
+
|
|
46828
|
+
return this.apiClient.callApi(
|
|
46829
|
+
'/api/v2/outbound/dnclists/{dncListId}/whatsappnumbers',
|
|
46830
|
+
'DELETE',
|
|
46831
|
+
{ 'dncListId': dncListId },
|
|
46832
|
+
{ 'expiredOnly': opts['expiredOnly'] },
|
|
46833
|
+
{ },
|
|
46834
|
+
{ },
|
|
46835
|
+
null,
|
|
46836
|
+
['PureCloud OAuth'],
|
|
46837
|
+
['application/json'],
|
|
46838
|
+
['application/json']
|
|
46839
|
+
);
|
|
46840
|
+
}
|
|
46841
|
+
|
|
45948
46842
|
/**
|
|
45949
46843
|
* Delete File Specification Template
|
|
45950
46844
|
*
|
|
@@ -48283,6 +49177,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48283
49177
|
);
|
|
48284
49178
|
}
|
|
48285
49179
|
|
|
49180
|
+
/**
|
|
49181
|
+
* Add entries to or delete entries from a DNC list.
|
|
49182
|
+
* Only Internal DNC lists may be deleted from
|
|
49183
|
+
* @param {String} dncListId DncList ID
|
|
49184
|
+
* @param {Object} body DNC whatsApp numbers
|
|
49185
|
+
*/
|
|
49186
|
+
patchOutboundDnclistWhatsappnumbers(dncListId, body) {
|
|
49187
|
+
// verify the required parameter 'dncListId' is set
|
|
49188
|
+
if (dncListId === undefined || dncListId === null) {
|
|
49189
|
+
throw 'Missing the required parameter "dncListId" when calling patchOutboundDnclistWhatsappnumbers';
|
|
49190
|
+
}
|
|
49191
|
+
// verify the required parameter 'body' is set
|
|
49192
|
+
if (body === undefined || body === null) {
|
|
49193
|
+
throw 'Missing the required parameter "body" when calling patchOutboundDnclistWhatsappnumbers';
|
|
49194
|
+
}
|
|
49195
|
+
|
|
49196
|
+
return this.apiClient.callApi(
|
|
49197
|
+
'/api/v2/outbound/dnclists/{dncListId}/whatsappnumbers',
|
|
49198
|
+
'PATCH',
|
|
49199
|
+
{ 'dncListId': dncListId },
|
|
49200
|
+
{ },
|
|
49201
|
+
{ },
|
|
49202
|
+
{ },
|
|
49203
|
+
body,
|
|
49204
|
+
['PureCloud OAuth'],
|
|
49205
|
+
['application/json'],
|
|
49206
|
+
['application/json']
|
|
49207
|
+
);
|
|
49208
|
+
}
|
|
49209
|
+
|
|
48286
49210
|
/**
|
|
48287
49211
|
* Update the outbound settings for this organization
|
|
48288
49212
|
*
|
|
@@ -50021,7 +50945,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50021
50945
|
/**
|
|
50022
50946
|
* Presence service.
|
|
50023
50947
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
50024
|
-
* @version
|
|
50948
|
+
* @version 219.0.0
|
|
50025
50949
|
*/
|
|
50026
50950
|
|
|
50027
50951
|
/**
|
|
@@ -50041,10 +50965,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50041
50965
|
*
|
|
50042
50966
|
* @param {String} definitionId Presence Definition ID
|
|
50043
50967
|
*/
|
|
50044
|
-
|
|
50968
|
+
deletePresenceDefinition0(definitionId) {
|
|
50045
50969
|
// verify the required parameter 'definitionId' is set
|
|
50046
50970
|
if (definitionId === undefined || definitionId === null) {
|
|
50047
|
-
throw 'Missing the required parameter "definitionId" when calling
|
|
50971
|
+
throw 'Missing the required parameter "definitionId" when calling deletePresenceDefinition0';
|
|
50048
50972
|
}
|
|
50049
50973
|
|
|
50050
50974
|
return this.apiClient.callApi(
|
|
@@ -50119,12 +51043,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50119
51043
|
* @param {Object} opts Optional parameters
|
|
50120
51044
|
* @param {Object} opts.localeCode The locale code to fetch for the presence definition. Use ALL to fetch everything.
|
|
50121
51045
|
*/
|
|
50122
|
-
|
|
51046
|
+
getPresenceDefinition0(definitionId, opts) {
|
|
50123
51047
|
opts = opts || {};
|
|
50124
51048
|
|
|
50125
51049
|
// verify the required parameter 'definitionId' is set
|
|
50126
51050
|
if (definitionId === undefined || definitionId === null) {
|
|
50127
|
-
throw 'Missing the required parameter "definitionId" when calling
|
|
51051
|
+
throw 'Missing the required parameter "definitionId" when calling getPresenceDefinition0';
|
|
50128
51052
|
}
|
|
50129
51053
|
|
|
50130
51054
|
return this.apiClient.callApi(
|
|
@@ -50149,7 +51073,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50149
51073
|
* @param {Array.<String>} opts.divisionId One or more division IDs. If nothing is provided, the definitions associated withthe list of divisions that the user has access to will be returned.
|
|
50150
51074
|
* @param {Object} opts.localeCode The locale code to fetch for the presence definition. Use ALL to fetch everything.
|
|
50151
51075
|
*/
|
|
50152
|
-
|
|
51076
|
+
getPresenceDefinitions0(opts) {
|
|
50153
51077
|
opts = opts || {};
|
|
50154
51078
|
|
|
50155
51079
|
|
|
@@ -50517,10 +51441,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50517
51441
|
*
|
|
50518
51442
|
* @param {Object} body The Presence Definition to create
|
|
50519
51443
|
*/
|
|
50520
|
-
|
|
51444
|
+
postPresenceDefinitions0(body) {
|
|
50521
51445
|
// verify the required parameter 'body' is set
|
|
50522
51446
|
if (body === undefined || body === null) {
|
|
50523
|
-
throw 'Missing the required parameter "body" when calling
|
|
51447
|
+
throw 'Missing the required parameter "body" when calling postPresenceDefinitions0';
|
|
50524
51448
|
}
|
|
50525
51449
|
|
|
50526
51450
|
return this.apiClient.callApi(
|
|
@@ -50594,14 +51518,14 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50594
51518
|
* @param {String} definitionId Presence Definition ID
|
|
50595
51519
|
* @param {Object} body The updated Presence Definition
|
|
50596
51520
|
*/
|
|
50597
|
-
|
|
51521
|
+
putPresenceDefinition0(definitionId, body) {
|
|
50598
51522
|
// verify the required parameter 'definitionId' is set
|
|
50599
51523
|
if (definitionId === undefined || definitionId === null) {
|
|
50600
|
-
throw 'Missing the required parameter "definitionId" when calling
|
|
51524
|
+
throw 'Missing the required parameter "definitionId" when calling putPresenceDefinition0';
|
|
50601
51525
|
}
|
|
50602
51526
|
// verify the required parameter 'body' is set
|
|
50603
51527
|
if (body === undefined || body === null) {
|
|
50604
|
-
throw 'Missing the required parameter "body" when calling
|
|
51528
|
+
throw 'Missing the required parameter "body" when calling putPresenceDefinition0';
|
|
50605
51529
|
}
|
|
50606
51530
|
|
|
50607
51531
|
return this.apiClient.callApi(
|
|
@@ -50765,7 +51689,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50765
51689
|
/**
|
|
50766
51690
|
* ProcessAutomation service.
|
|
50767
51691
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
50768
|
-
* @version
|
|
51692
|
+
* @version 219.0.0
|
|
50769
51693
|
*/
|
|
50770
51694
|
|
|
50771
51695
|
/**
|
|
@@ -51004,7 +51928,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51004
51928
|
/**
|
|
51005
51929
|
* Quality service.
|
|
51006
51930
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
51007
|
-
* @version
|
|
51931
|
+
* @version 219.0.0
|
|
51008
51932
|
*/
|
|
51009
51933
|
|
|
51010
51934
|
/**
|
|
@@ -52791,7 +53715,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52791
53715
|
/**
|
|
52792
53716
|
* Recording service.
|
|
52793
53717
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
52794
|
-
* @version
|
|
53718
|
+
* @version 219.0.0
|
|
52795
53719
|
*/
|
|
52796
53720
|
|
|
52797
53721
|
/**
|
|
@@ -54396,7 +55320,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54396
55320
|
/**
|
|
54397
55321
|
* ResponseManagement service.
|
|
54398
55322
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
54399
|
-
* @version
|
|
55323
|
+
* @version 219.0.0
|
|
54400
55324
|
*/
|
|
54401
55325
|
|
|
54402
55326
|
/**
|
|
@@ -54906,7 +55830,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54906
55830
|
/**
|
|
54907
55831
|
* Routing service.
|
|
54908
55832
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
54909
|
-
* @version
|
|
55833
|
+
* @version 219.0.0
|
|
54910
55834
|
*/
|
|
54911
55835
|
|
|
54912
55836
|
/**
|
|
@@ -55816,7 +56740,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55816
56740
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
55817
56741
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
55818
56742
|
* @param {Boolean} opts.excludeStatus Exclude MX record data (default to false)
|
|
55819
|
-
* @param {String} opts.filter Optional search filter
|
|
56743
|
+
* @param {String} opts.filter Optional search filter that, if defined, use the **filter** syntax, eg: **mySearchedPattern**. Note that **** is considered no filter.
|
|
55820
56744
|
*/
|
|
55821
56745
|
getRoutingEmailDomains(opts) {
|
|
55822
56746
|
opts = opts || {};
|
|
@@ -55915,7 +56839,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55915
56839
|
* Get outbound domains
|
|
55916
56840
|
*
|
|
55917
56841
|
* @param {Object} opts Optional parameters
|
|
55918
|
-
* @param {
|
|
56842
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
56843
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
56844
|
+
* @param {String} opts.filter Optional search filter that, if defined, use the **filter** syntax, eg: **mySearchedPattern**. Note that **** is considered no filter.
|
|
55919
56845
|
*/
|
|
55920
56846
|
getRoutingEmailOutboundDomains(opts) {
|
|
55921
56847
|
opts = opts || {};
|
|
@@ -55925,7 +56851,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55925
56851
|
'/api/v2/routing/email/outbound/domains',
|
|
55926
56852
|
'GET',
|
|
55927
56853
|
{ },
|
|
55928
|
-
{ 'filter': opts['filter'] },
|
|
56854
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'filter': opts['filter'] },
|
|
55929
56855
|
{ },
|
|
55930
56856
|
{ },
|
|
55931
56857
|
null,
|
|
@@ -59209,7 +60135,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59209
60135
|
/**
|
|
59210
60136
|
* SCIM service.
|
|
59211
60137
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
59212
|
-
* @version
|
|
60138
|
+
* @version 219.0.0
|
|
59213
60139
|
*/
|
|
59214
60140
|
|
|
59215
60141
|
/**
|
|
@@ -60086,7 +61012,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60086
61012
|
/**
|
|
60087
61013
|
* ScreenRecording service.
|
|
60088
61014
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
60089
|
-
* @version
|
|
61015
|
+
* @version 219.0.0
|
|
60090
61016
|
*/
|
|
60091
61017
|
|
|
60092
61018
|
/**
|
|
@@ -60131,7 +61057,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60131
61057
|
/**
|
|
60132
61058
|
* Scripts service.
|
|
60133
61059
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
60134
|
-
* @version
|
|
61060
|
+
* @version 219.0.0
|
|
60135
61061
|
*/
|
|
60136
61062
|
|
|
60137
61063
|
/**
|
|
@@ -60575,7 +61501,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60575
61501
|
/**
|
|
60576
61502
|
* Search service.
|
|
60577
61503
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
60578
|
-
* @version
|
|
61504
|
+
* @version 219.0.0
|
|
60579
61505
|
*/
|
|
60580
61506
|
|
|
60581
61507
|
/**
|
|
@@ -61318,7 +62244,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61318
62244
|
/**
|
|
61319
62245
|
* Settings service.
|
|
61320
62246
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
61321
|
-
* @version
|
|
62247
|
+
* @version 219.0.0
|
|
61322
62248
|
*/
|
|
61323
62249
|
|
|
61324
62250
|
/**
|
|
@@ -61602,7 +62528,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61602
62528
|
/**
|
|
61603
62529
|
* SocialMedia service.
|
|
61604
62530
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
61605
|
-
* @version
|
|
62531
|
+
* @version 219.0.0
|
|
61606
62532
|
*/
|
|
61607
62533
|
|
|
61608
62534
|
/**
|
|
@@ -62890,7 +63816,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62890
63816
|
/**
|
|
62891
63817
|
* SpeechTextAnalytics service.
|
|
62892
63818
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
62893
|
-
* @version
|
|
63819
|
+
* @version 219.0.0
|
|
62894
63820
|
*/
|
|
62895
63821
|
|
|
62896
63822
|
/**
|
|
@@ -64331,7 +65257,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64331
65257
|
/**
|
|
64332
65258
|
* Stations service.
|
|
64333
65259
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
64334
|
-
* @version
|
|
65260
|
+
* @version 219.0.0
|
|
64335
65261
|
*/
|
|
64336
65262
|
|
|
64337
65263
|
/**
|
|
@@ -64433,7 +65359,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64433
65359
|
/**
|
|
64434
65360
|
* Suggest service.
|
|
64435
65361
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
64436
|
-
* @version
|
|
65362
|
+
* @version 219.0.0
|
|
64437
65363
|
*/
|
|
64438
65364
|
|
|
64439
65365
|
/**
|
|
@@ -64572,7 +65498,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64572
65498
|
/**
|
|
64573
65499
|
* TaskManagement service.
|
|
64574
65500
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
64575
|
-
* @version
|
|
65501
|
+
* @version 219.0.0
|
|
64576
65502
|
*/
|
|
64577
65503
|
|
|
64578
65504
|
/**
|
|
@@ -65447,6 +66373,71 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65447
66373
|
);
|
|
65448
66374
|
}
|
|
65449
66375
|
|
|
66376
|
+
/**
|
|
66377
|
+
* Get the core types from which all schemas are built.
|
|
66378
|
+
*
|
|
66379
|
+
* @param {String} coreTypeName Name of the core type
|
|
66380
|
+
*/
|
|
66381
|
+
getTaskmanagementWorkitemsSchemasCoretype(coreTypeName) {
|
|
66382
|
+
// verify the required parameter 'coreTypeName' is set
|
|
66383
|
+
if (coreTypeName === undefined || coreTypeName === null) {
|
|
66384
|
+
throw 'Missing the required parameter "coreTypeName" when calling getTaskmanagementWorkitemsSchemasCoretype';
|
|
66385
|
+
}
|
|
66386
|
+
|
|
66387
|
+
return this.apiClient.callApi(
|
|
66388
|
+
'/api/v2/taskmanagement/workitems/schemas/coretypes/{coreTypeName}',
|
|
66389
|
+
'GET',
|
|
66390
|
+
{ 'coreTypeName': coreTypeName },
|
|
66391
|
+
{ },
|
|
66392
|
+
{ },
|
|
66393
|
+
{ },
|
|
66394
|
+
null,
|
|
66395
|
+
['PureCloud OAuth'],
|
|
66396
|
+
['application/json'],
|
|
66397
|
+
['application/json']
|
|
66398
|
+
);
|
|
66399
|
+
}
|
|
66400
|
+
|
|
66401
|
+
/**
|
|
66402
|
+
* Get the core types from which all schemas are built.
|
|
66403
|
+
*
|
|
66404
|
+
*/
|
|
66405
|
+
getTaskmanagementWorkitemsSchemasCoretypes() {
|
|
66406
|
+
|
|
66407
|
+
return this.apiClient.callApi(
|
|
66408
|
+
'/api/v2/taskmanagement/workitems/schemas/coretypes',
|
|
66409
|
+
'GET',
|
|
66410
|
+
{ },
|
|
66411
|
+
{ },
|
|
66412
|
+
{ },
|
|
66413
|
+
{ },
|
|
66414
|
+
null,
|
|
66415
|
+
['PureCloud OAuth'],
|
|
66416
|
+
['application/json'],
|
|
66417
|
+
['application/json']
|
|
66418
|
+
);
|
|
66419
|
+
}
|
|
66420
|
+
|
|
66421
|
+
/**
|
|
66422
|
+
* Get quantitative limits on schemas
|
|
66423
|
+
*
|
|
66424
|
+
*/
|
|
66425
|
+
getTaskmanagementWorkitemsSchemasLimits() {
|
|
66426
|
+
|
|
66427
|
+
return this.apiClient.callApi(
|
|
66428
|
+
'/api/v2/taskmanagement/workitems/schemas/limits',
|
|
66429
|
+
'GET',
|
|
66430
|
+
{ },
|
|
66431
|
+
{ },
|
|
66432
|
+
{ },
|
|
66433
|
+
{ },
|
|
66434
|
+
null,
|
|
66435
|
+
['PureCloud OAuth'],
|
|
66436
|
+
['application/json'],
|
|
66437
|
+
['application/json']
|
|
66438
|
+
);
|
|
66439
|
+
}
|
|
66440
|
+
|
|
65450
66441
|
/**
|
|
65451
66442
|
* Get a worktype
|
|
65452
66443
|
*
|
|
@@ -66678,7 +67669,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66678
67669
|
/**
|
|
66679
67670
|
* Teams service.
|
|
66680
67671
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
66681
|
-
* @version
|
|
67672
|
+
* @version 219.0.0
|
|
66682
67673
|
*/
|
|
66683
67674
|
|
|
66684
67675
|
/**
|
|
@@ -66983,7 +67974,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66983
67974
|
/**
|
|
66984
67975
|
* Telephony service.
|
|
66985
67976
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
66986
|
-
* @version
|
|
67977
|
+
* @version 219.0.0
|
|
66987
67978
|
*/
|
|
66988
67979
|
|
|
66989
67980
|
/**
|
|
@@ -67165,7 +68156,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67165
68156
|
/**
|
|
67166
68157
|
* TelephonyProvidersEdge service.
|
|
67167
68158
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
67168
|
-
* @version
|
|
68159
|
+
* @version 219.0.0
|
|
67169
68160
|
*/
|
|
67170
68161
|
|
|
67171
68162
|
/**
|
|
@@ -70617,7 +71608,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70617
71608
|
/**
|
|
70618
71609
|
* Textbots service.
|
|
70619
71610
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
70620
|
-
* @version
|
|
71611
|
+
* @version 219.0.0
|
|
70621
71612
|
*/
|
|
70622
71613
|
|
|
70623
71614
|
/**
|
|
@@ -70745,7 +71736,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70745
71736
|
/**
|
|
70746
71737
|
* Tokens service.
|
|
70747
71738
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
70748
|
-
* @version
|
|
71739
|
+
* @version 219.0.0
|
|
70749
71740
|
*/
|
|
70750
71741
|
|
|
70751
71742
|
/**
|
|
@@ -70899,7 +71890,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70899
71890
|
/**
|
|
70900
71891
|
* Uploads service.
|
|
70901
71892
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
70902
|
-
* @version
|
|
71893
|
+
* @version 219.0.0
|
|
70903
71894
|
*/
|
|
70904
71895
|
|
|
70905
71896
|
/**
|
|
@@ -70944,6 +71935,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70944
71935
|
);
|
|
70945
71936
|
}
|
|
70946
71937
|
|
|
71938
|
+
/**
|
|
71939
|
+
* Generates pre-signed URL to upload a prize image for gamification contests
|
|
71940
|
+
*
|
|
71941
|
+
* @param {Object} body query
|
|
71942
|
+
*/
|
|
71943
|
+
postGamificationContestsUploadsPrizeimages(body) {
|
|
71944
|
+
// verify the required parameter 'body' is set
|
|
71945
|
+
if (body === undefined || body === null) {
|
|
71946
|
+
throw 'Missing the required parameter "body" when calling postGamificationContestsUploadsPrizeimages';
|
|
71947
|
+
}
|
|
71948
|
+
|
|
71949
|
+
return this.apiClient.callApi(
|
|
71950
|
+
'/api/v2/gamification/contests/uploads/prizeimages',
|
|
71951
|
+
'POST',
|
|
71952
|
+
{ },
|
|
71953
|
+
{ },
|
|
71954
|
+
{ },
|
|
71955
|
+
{ },
|
|
71956
|
+
body,
|
|
71957
|
+
['PureCloud OAuth'],
|
|
71958
|
+
['application/json'],
|
|
71959
|
+
['application/json']
|
|
71960
|
+
);
|
|
71961
|
+
}
|
|
71962
|
+
|
|
70947
71963
|
/**
|
|
70948
71964
|
* Create upload presigned URL for draft function package file.
|
|
70949
71965
|
*
|
|
@@ -71165,7 +72181,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
71165
72181
|
/**
|
|
71166
72182
|
* Usage service.
|
|
71167
72183
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
71168
|
-
* @version
|
|
72184
|
+
* @version 219.0.0
|
|
71169
72185
|
*/
|
|
71170
72186
|
|
|
71171
72187
|
/**
|
|
@@ -71380,7 +72396,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
71380
72396
|
/**
|
|
71381
72397
|
* UserRecordings service.
|
|
71382
72398
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
71383
|
-
* @version
|
|
72399
|
+
* @version 219.0.0
|
|
71384
72400
|
*/
|
|
71385
72401
|
|
|
71386
72402
|
/**
|
|
@@ -71595,7 +72611,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
71595
72611
|
/**
|
|
71596
72612
|
* Users service.
|
|
71597
72613
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
71598
|
-
* @version
|
|
72614
|
+
* @version 219.0.0
|
|
71599
72615
|
*/
|
|
71600
72616
|
|
|
71601
72617
|
/**
|
|
@@ -74548,7 +75564,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74548
75564
|
/**
|
|
74549
75565
|
* Utilities service.
|
|
74550
75566
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
74551
|
-
* @version
|
|
75567
|
+
* @version 219.0.0
|
|
74552
75568
|
*/
|
|
74553
75569
|
|
|
74554
75570
|
/**
|
|
@@ -74659,7 +75675,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74659
75675
|
/**
|
|
74660
75676
|
* Voicemail service.
|
|
74661
75677
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
74662
|
-
* @version
|
|
75678
|
+
* @version 219.0.0
|
|
74663
75679
|
*/
|
|
74664
75680
|
|
|
74665
75681
|
/**
|
|
@@ -75381,7 +76397,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75381
76397
|
/**
|
|
75382
76398
|
* WebChat service.
|
|
75383
76399
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
75384
|
-
* @version
|
|
76400
|
+
* @version 219.0.0
|
|
75385
76401
|
*/
|
|
75386
76402
|
|
|
75387
76403
|
/**
|
|
@@ -75941,7 +76957,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75941
76957
|
/**
|
|
75942
76958
|
* WebDeployments service.
|
|
75943
76959
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
75944
|
-
* @version
|
|
76960
|
+
* @version 219.0.0
|
|
75945
76961
|
*/
|
|
75946
76962
|
|
|
75947
76963
|
/**
|
|
@@ -76525,7 +77541,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
76525
77541
|
/**
|
|
76526
77542
|
* WebMessaging service.
|
|
76527
77543
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
76528
|
-
* @version
|
|
77544
|
+
* @version 219.0.0
|
|
76529
77545
|
*/
|
|
76530
77546
|
|
|
76531
77547
|
/**
|
|
@@ -76571,7 +77587,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
76571
77587
|
/**
|
|
76572
77588
|
* Widgets service.
|
|
76573
77589
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
76574
|
-
* @version
|
|
77590
|
+
* @version 219.0.0
|
|
76575
77591
|
*/
|
|
76576
77592
|
|
|
76577
77593
|
/**
|
|
@@ -76722,7 +77738,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
76722
77738
|
/**
|
|
76723
77739
|
* WorkforceManagement service.
|
|
76724
77740
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
76725
|
-
* @version
|
|
77741
|
+
* @version 219.0.0
|
|
76726
77742
|
*/
|
|
76727
77743
|
|
|
76728
77744
|
/**
|
|
@@ -79292,8 +80308,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
79292
80308
|
}
|
|
79293
80309
|
|
|
79294
80310
|
/**
|
|
79295
|
-
* Retrieves delete job status for historical data imports of the organization
|
|
79296
|
-
*
|
|
80311
|
+
* Retrieves delete job status for historical data imports of the organization.
|
|
80312
|
+
* Deprecated: Please use GET /workforcemanagement/historicaldata/bulk/remove/jobs instead.
|
|
80313
|
+
* @deprecated
|
|
79297
80314
|
*/
|
|
79298
80315
|
getWorkforcemanagementHistoricaldataDeletejob() {
|
|
79299
80316
|
|
|
@@ -82865,8 +83882,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
82865
83882
|
}
|
|
82866
83883
|
|
|
82867
83884
|
/**
|
|
82868
|
-
* Delete the entries of the historical data imports in the organization
|
|
82869
|
-
*
|
|
83885
|
+
* Delete the entries of the historical data imports in the organization.
|
|
83886
|
+
* Deprecated: Please use POST /workforcemanagement/historicaldata/bulk/remove/jobs instead.
|
|
83887
|
+
* @deprecated
|
|
82870
83888
|
*/
|
|
82871
83889
|
postWorkforcemanagementHistoricaldataDeletejob() {
|
|
82872
83890
|
|
|
@@ -84115,7 +85133,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
84115
85133
|
* </pre>
|
|
84116
85134
|
* </p>
|
|
84117
85135
|
* @module purecloud-platform-client-v2/index
|
|
84118
|
-
* @version
|
|
85136
|
+
* @version 219.0.0
|
|
84119
85137
|
*/
|
|
84120
85138
|
class platformClient {
|
|
84121
85139
|
constructor() {
|