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
|
@@ -690,7 +690,7 @@ class Configuration {
|
|
|
690
690
|
|
|
691
691
|
/**
|
|
692
692
|
* @module purecloud-platform-client-v2/ApiClient
|
|
693
|
-
* @version
|
|
693
|
+
* @version 219.0.0
|
|
694
694
|
*/
|
|
695
695
|
class ApiClient {
|
|
696
696
|
/**
|
|
@@ -2234,7 +2234,7 @@ class AgentAssistantsApi {
|
|
|
2234
2234
|
/**
|
|
2235
2235
|
* AgentAssistants service.
|
|
2236
2236
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
2237
|
-
* @version
|
|
2237
|
+
* @version 219.0.0
|
|
2238
2238
|
*/
|
|
2239
2239
|
|
|
2240
2240
|
/**
|
|
@@ -2610,7 +2610,7 @@ class AgentCopilotApi {
|
|
|
2610
2610
|
/**
|
|
2611
2611
|
* AgentCopilot service.
|
|
2612
2612
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
2613
|
-
* @version
|
|
2613
|
+
* @version 219.0.0
|
|
2614
2614
|
*/
|
|
2615
2615
|
|
|
2616
2616
|
/**
|
|
@@ -2686,7 +2686,7 @@ class AgentUIApi {
|
|
|
2686
2686
|
/**
|
|
2687
2687
|
* AgentUI service.
|
|
2688
2688
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
2689
|
-
* @version
|
|
2689
|
+
* @version 219.0.0
|
|
2690
2690
|
*/
|
|
2691
2691
|
|
|
2692
2692
|
/**
|
|
@@ -2817,7 +2817,7 @@ class AlertingApi {
|
|
|
2817
2817
|
/**
|
|
2818
2818
|
* Alerting service.
|
|
2819
2819
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
2820
|
-
* @version
|
|
2820
|
+
* @version 219.0.0
|
|
2821
2821
|
*/
|
|
2822
2822
|
|
|
2823
2823
|
/**
|
|
@@ -3218,7 +3218,7 @@ class AnalyticsApi {
|
|
|
3218
3218
|
/**
|
|
3219
3219
|
* Analytics service.
|
|
3220
3220
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
3221
|
-
* @version
|
|
3221
|
+
* @version 219.0.0
|
|
3222
3222
|
*/
|
|
3223
3223
|
|
|
3224
3224
|
/**
|
|
@@ -6039,7 +6039,7 @@ class ArchitectApi {
|
|
|
6039
6039
|
/**
|
|
6040
6040
|
* Architect service.
|
|
6041
6041
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
6042
|
-
* @version
|
|
6042
|
+
* @version 219.0.0
|
|
6043
6043
|
*/
|
|
6044
6044
|
|
|
6045
6045
|
/**
|
|
@@ -10332,7 +10332,7 @@ class AuditApi {
|
|
|
10332
10332
|
/**
|
|
10333
10333
|
* Audit service.
|
|
10334
10334
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
10335
|
-
* @version
|
|
10335
|
+
* @version 219.0.0
|
|
10336
10336
|
*/
|
|
10337
10337
|
|
|
10338
10338
|
/**
|
|
@@ -10533,7 +10533,7 @@ class AuthorizationApi {
|
|
|
10533
10533
|
/**
|
|
10534
10534
|
* Authorization service.
|
|
10535
10535
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
10536
|
-
* @version
|
|
10536
|
+
* @version 219.0.0
|
|
10537
10537
|
*/
|
|
10538
10538
|
|
|
10539
10539
|
/**
|
|
@@ -10759,6 +10759,31 @@ class AuthorizationApi {
|
|
|
10759
10759
|
);
|
|
10760
10760
|
}
|
|
10761
10761
|
|
|
10762
|
+
/**
|
|
10763
|
+
* Get a list of soft deleted divisions for the org
|
|
10764
|
+
*
|
|
10765
|
+
* @param {Object} opts Optional parameters
|
|
10766
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
10767
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
10768
|
+
*/
|
|
10769
|
+
getAuthorizationDivisionsDeleted(opts) {
|
|
10770
|
+
opts = opts || {};
|
|
10771
|
+
|
|
10772
|
+
|
|
10773
|
+
return this.apiClient.callApi(
|
|
10774
|
+
'/api/v2/authorization/divisions/deleted',
|
|
10775
|
+
'GET',
|
|
10776
|
+
{ },
|
|
10777
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
10778
|
+
{ },
|
|
10779
|
+
{ },
|
|
10780
|
+
null,
|
|
10781
|
+
['PureCloud OAuth'],
|
|
10782
|
+
['application/json'],
|
|
10783
|
+
['application/json']
|
|
10784
|
+
);
|
|
10785
|
+
}
|
|
10786
|
+
|
|
10762
10787
|
/**
|
|
10763
10788
|
* Retrieve the home division for the organization.
|
|
10764
10789
|
* Will not include object counts.
|
|
@@ -10799,6 +10824,34 @@ class AuthorizationApi {
|
|
|
10799
10824
|
);
|
|
10800
10825
|
}
|
|
10801
10826
|
|
|
10827
|
+
/**
|
|
10828
|
+
* Retrieve a list of all divisions defined for the organization with cursor
|
|
10829
|
+
* Use "after" and "before" param to fetch next/previous page}
|
|
10830
|
+
* @param {Object} opts Optional parameters
|
|
10831
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
10832
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
10833
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
10834
|
+
* @param {Array.<String>} opts.id Optionally request specific divisions by their IDs
|
|
10835
|
+
* @param {String} opts.name Optionally request specific divisions by division name
|
|
10836
|
+
*/
|
|
10837
|
+
getAuthorizationDivisionsQuery(opts) {
|
|
10838
|
+
opts = opts || {};
|
|
10839
|
+
|
|
10840
|
+
|
|
10841
|
+
return this.apiClient.callApi(
|
|
10842
|
+
'/api/v2/authorization/divisions/query',
|
|
10843
|
+
'GET',
|
|
10844
|
+
{ },
|
|
10845
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'name': opts['name'] },
|
|
10846
|
+
{ },
|
|
10847
|
+
{ },
|
|
10848
|
+
null,
|
|
10849
|
+
['PureCloud OAuth'],
|
|
10850
|
+
['application/json'],
|
|
10851
|
+
['application/json']
|
|
10852
|
+
);
|
|
10853
|
+
}
|
|
10854
|
+
|
|
10802
10855
|
/**
|
|
10803
10856
|
* Returns which divisions the current user has the given permission in.
|
|
10804
10857
|
* This route is deprecated, use authorization/divisionspermitted/paged/me instead.
|
|
@@ -12195,7 +12248,7 @@ class BillingApi {
|
|
|
12195
12248
|
/**
|
|
12196
12249
|
* Billing service.
|
|
12197
12250
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
12198
|
-
* @version
|
|
12251
|
+
* @version 219.0.0
|
|
12199
12252
|
*/
|
|
12200
12253
|
|
|
12201
12254
|
/**
|
|
@@ -12275,7 +12328,7 @@ class CarrierServicesApi {
|
|
|
12275
12328
|
/**
|
|
12276
12329
|
* CarrierServices service.
|
|
12277
12330
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
12278
|
-
* @version
|
|
12331
|
+
* @version 219.0.0
|
|
12279
12332
|
*/
|
|
12280
12333
|
|
|
12281
12334
|
/**
|
|
@@ -12345,7 +12398,7 @@ class ChatApi {
|
|
|
12345
12398
|
/**
|
|
12346
12399
|
* Chat service.
|
|
12347
12400
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
12348
|
-
* @version
|
|
12401
|
+
* @version 219.0.0
|
|
12349
12402
|
*/
|
|
12350
12403
|
|
|
12351
12404
|
/**
|
|
@@ -13274,7 +13327,7 @@ class CoachingApi {
|
|
|
13274
13327
|
/**
|
|
13275
13328
|
* Coaching service.
|
|
13276
13329
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
13277
|
-
* @version
|
|
13330
|
+
* @version 219.0.0
|
|
13278
13331
|
*/
|
|
13279
13332
|
|
|
13280
13333
|
/**
|
|
@@ -13851,7 +13904,7 @@ class ContentManagementApi {
|
|
|
13851
13904
|
/**
|
|
13852
13905
|
* ContentManagement service.
|
|
13853
13906
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
13854
|
-
* @version
|
|
13907
|
+
* @version 219.0.0
|
|
13855
13908
|
*/
|
|
13856
13909
|
|
|
13857
13910
|
/**
|
|
@@ -14932,7 +14985,7 @@ class ConversationsApi {
|
|
|
14932
14985
|
/**
|
|
14933
14986
|
* Conversations service.
|
|
14934
14987
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
14935
|
-
* @version
|
|
14988
|
+
* @version 219.0.0
|
|
14936
14989
|
*/
|
|
14937
14990
|
|
|
14938
14991
|
/**
|
|
@@ -22514,7 +22567,7 @@ class DataExtensionsApi {
|
|
|
22514
22567
|
/**
|
|
22515
22568
|
* DataExtensions service.
|
|
22516
22569
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
22517
|
-
* @version
|
|
22570
|
+
* @version 219.0.0
|
|
22518
22571
|
*/
|
|
22519
22572
|
|
|
22520
22573
|
/**
|
|
@@ -22600,7 +22653,7 @@ class DataPrivacyApi {
|
|
|
22600
22653
|
/**
|
|
22601
22654
|
* DataPrivacy service.
|
|
22602
22655
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
22603
|
-
* @version
|
|
22656
|
+
* @version 219.0.0
|
|
22604
22657
|
*/
|
|
22605
22658
|
|
|
22606
22659
|
/**
|
|
@@ -22770,7 +22823,7 @@ class DownloadsApi {
|
|
|
22770
22823
|
/**
|
|
22771
22824
|
* Downloads service.
|
|
22772
22825
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
22773
|
-
* @version
|
|
22826
|
+
* @version 219.0.0
|
|
22774
22827
|
*/
|
|
22775
22828
|
|
|
22776
22829
|
/**
|
|
@@ -22822,7 +22875,7 @@ class EmailsApi {
|
|
|
22822
22875
|
/**
|
|
22823
22876
|
* Emails service.
|
|
22824
22877
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
22825
|
-
* @version
|
|
22878
|
+
* @version 219.0.0
|
|
22826
22879
|
*/
|
|
22827
22880
|
|
|
22828
22881
|
/**
|
|
@@ -22951,7 +23004,7 @@ class EmployeeEngagementApi {
|
|
|
22951
23004
|
/**
|
|
22952
23005
|
* EmployeeEngagement service.
|
|
22953
23006
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
22954
|
-
* @version
|
|
23007
|
+
* @version 219.0.0
|
|
22955
23008
|
*/
|
|
22956
23009
|
|
|
22957
23010
|
/**
|
|
@@ -23102,7 +23155,7 @@ class EventsApi {
|
|
|
23102
23155
|
/**
|
|
23103
23156
|
* Events service.
|
|
23104
23157
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
23105
|
-
* @version
|
|
23158
|
+
* @version 219.0.0
|
|
23106
23159
|
*/
|
|
23107
23160
|
|
|
23108
23161
|
/**
|
|
@@ -23198,7 +23251,7 @@ class ExternalContactsApi {
|
|
|
23198
23251
|
/**
|
|
23199
23252
|
* ExternalContacts service.
|
|
23200
23253
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
23201
|
-
* @version
|
|
23254
|
+
* @version 219.0.0
|
|
23202
23255
|
*/
|
|
23203
23256
|
|
|
23204
23257
|
/**
|
|
@@ -23833,6 +23886,71 @@ class ExternalContactsApi {
|
|
|
23833
23886
|
);
|
|
23834
23887
|
}
|
|
23835
23888
|
|
|
23889
|
+
/**
|
|
23890
|
+
* Get the core types from which all schemas are built.
|
|
23891
|
+
*
|
|
23892
|
+
* @param {String} coreTypeName Name of the core type
|
|
23893
|
+
*/
|
|
23894
|
+
getExternalcontactsContactsSchemasCoretype(coreTypeName) {
|
|
23895
|
+
// verify the required parameter 'coreTypeName' is set
|
|
23896
|
+
if (coreTypeName === undefined || coreTypeName === null) {
|
|
23897
|
+
throw 'Missing the required parameter "coreTypeName" when calling getExternalcontactsContactsSchemasCoretype';
|
|
23898
|
+
}
|
|
23899
|
+
|
|
23900
|
+
return this.apiClient.callApi(
|
|
23901
|
+
'/api/v2/externalcontacts/contacts/schemas/coretypes/{coreTypeName}',
|
|
23902
|
+
'GET',
|
|
23903
|
+
{ 'coreTypeName': coreTypeName },
|
|
23904
|
+
{ },
|
|
23905
|
+
{ },
|
|
23906
|
+
{ },
|
|
23907
|
+
null,
|
|
23908
|
+
['PureCloud OAuth'],
|
|
23909
|
+
['application/json'],
|
|
23910
|
+
['application/json']
|
|
23911
|
+
);
|
|
23912
|
+
}
|
|
23913
|
+
|
|
23914
|
+
/**
|
|
23915
|
+
* Get the core types from which all schemas are built.
|
|
23916
|
+
*
|
|
23917
|
+
*/
|
|
23918
|
+
getExternalcontactsContactsSchemasCoretypes() {
|
|
23919
|
+
|
|
23920
|
+
return this.apiClient.callApi(
|
|
23921
|
+
'/api/v2/externalcontacts/contacts/schemas/coretypes',
|
|
23922
|
+
'GET',
|
|
23923
|
+
{ },
|
|
23924
|
+
{ },
|
|
23925
|
+
{ },
|
|
23926
|
+
{ },
|
|
23927
|
+
null,
|
|
23928
|
+
['PureCloud OAuth'],
|
|
23929
|
+
['application/json'],
|
|
23930
|
+
['application/json']
|
|
23931
|
+
);
|
|
23932
|
+
}
|
|
23933
|
+
|
|
23934
|
+
/**
|
|
23935
|
+
* Get quantitative limits on schemas
|
|
23936
|
+
*
|
|
23937
|
+
*/
|
|
23938
|
+
getExternalcontactsContactsSchemasLimits() {
|
|
23939
|
+
|
|
23940
|
+
return this.apiClient.callApi(
|
|
23941
|
+
'/api/v2/externalcontacts/contacts/schemas/limits',
|
|
23942
|
+
'GET',
|
|
23943
|
+
{ },
|
|
23944
|
+
{ },
|
|
23945
|
+
{ },
|
|
23946
|
+
{ },
|
|
23947
|
+
null,
|
|
23948
|
+
['PureCloud OAuth'],
|
|
23949
|
+
['application/json'],
|
|
23950
|
+
['application/json']
|
|
23951
|
+
);
|
|
23952
|
+
}
|
|
23953
|
+
|
|
23836
23954
|
/**
|
|
23837
23955
|
* Fetch an External Source
|
|
23838
23956
|
*
|
|
@@ -24158,6 +24276,32 @@ class ExternalContactsApi {
|
|
|
24158
24276
|
);
|
|
24159
24277
|
}
|
|
24160
24278
|
|
|
24279
|
+
/**
|
|
24280
|
+
* List the identifiers for an external organization
|
|
24281
|
+
*
|
|
24282
|
+
* @param {String} externalOrganizationId External Organization ID
|
|
24283
|
+
* getExternalcontactsOrganizationIdentifiers is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24284
|
+
*/
|
|
24285
|
+
getExternalcontactsOrganizationIdentifiers(externalOrganizationId) {
|
|
24286
|
+
// verify the required parameter 'externalOrganizationId' is set
|
|
24287
|
+
if (externalOrganizationId === undefined || externalOrganizationId === null) {
|
|
24288
|
+
throw 'Missing the required parameter "externalOrganizationId" when calling getExternalcontactsOrganizationIdentifiers';
|
|
24289
|
+
}
|
|
24290
|
+
|
|
24291
|
+
return this.apiClient.callApi(
|
|
24292
|
+
'/api/v2/externalcontacts/organizations/{externalOrganizationId}/identifiers',
|
|
24293
|
+
'GET',
|
|
24294
|
+
{ 'externalOrganizationId': externalOrganizationId },
|
|
24295
|
+
{ },
|
|
24296
|
+
{ },
|
|
24297
|
+
{ },
|
|
24298
|
+
null,
|
|
24299
|
+
['PureCloud OAuth'],
|
|
24300
|
+
['application/json'],
|
|
24301
|
+
['application/json']
|
|
24302
|
+
);
|
|
24303
|
+
}
|
|
24304
|
+
|
|
24161
24305
|
/**
|
|
24162
24306
|
* Fetch a note for an external organization
|
|
24163
24307
|
*
|
|
@@ -24387,6 +24531,71 @@ class ExternalContactsApi {
|
|
|
24387
24531
|
);
|
|
24388
24532
|
}
|
|
24389
24533
|
|
|
24534
|
+
/**
|
|
24535
|
+
* Get the core types from which all schemas are built.
|
|
24536
|
+
*
|
|
24537
|
+
* @param {String} coreTypeName Name of the core type
|
|
24538
|
+
*/
|
|
24539
|
+
getExternalcontactsOrganizationsSchemasCoretype(coreTypeName) {
|
|
24540
|
+
// verify the required parameter 'coreTypeName' is set
|
|
24541
|
+
if (coreTypeName === undefined || coreTypeName === null) {
|
|
24542
|
+
throw 'Missing the required parameter "coreTypeName" when calling getExternalcontactsOrganizationsSchemasCoretype';
|
|
24543
|
+
}
|
|
24544
|
+
|
|
24545
|
+
return this.apiClient.callApi(
|
|
24546
|
+
'/api/v2/externalcontacts/organizations/schemas/coretypes/{coreTypeName}',
|
|
24547
|
+
'GET',
|
|
24548
|
+
{ 'coreTypeName': coreTypeName },
|
|
24549
|
+
{ },
|
|
24550
|
+
{ },
|
|
24551
|
+
{ },
|
|
24552
|
+
null,
|
|
24553
|
+
['PureCloud OAuth'],
|
|
24554
|
+
['application/json'],
|
|
24555
|
+
['application/json']
|
|
24556
|
+
);
|
|
24557
|
+
}
|
|
24558
|
+
|
|
24559
|
+
/**
|
|
24560
|
+
* Get the core types from which all schemas are built.
|
|
24561
|
+
*
|
|
24562
|
+
*/
|
|
24563
|
+
getExternalcontactsOrganizationsSchemasCoretypes() {
|
|
24564
|
+
|
|
24565
|
+
return this.apiClient.callApi(
|
|
24566
|
+
'/api/v2/externalcontacts/organizations/schemas/coretypes',
|
|
24567
|
+
'GET',
|
|
24568
|
+
{ },
|
|
24569
|
+
{ },
|
|
24570
|
+
{ },
|
|
24571
|
+
{ },
|
|
24572
|
+
null,
|
|
24573
|
+
['PureCloud OAuth'],
|
|
24574
|
+
['application/json'],
|
|
24575
|
+
['application/json']
|
|
24576
|
+
);
|
|
24577
|
+
}
|
|
24578
|
+
|
|
24579
|
+
/**
|
|
24580
|
+
* Get quantitative limits on schemas
|
|
24581
|
+
*
|
|
24582
|
+
*/
|
|
24583
|
+
getExternalcontactsOrganizationsSchemasLimits() {
|
|
24584
|
+
|
|
24585
|
+
return this.apiClient.callApi(
|
|
24586
|
+
'/api/v2/externalcontacts/organizations/schemas/limits',
|
|
24587
|
+
'GET',
|
|
24588
|
+
{ },
|
|
24589
|
+
{ },
|
|
24590
|
+
{ },
|
|
24591
|
+
{ },
|
|
24592
|
+
null,
|
|
24593
|
+
['PureCloud OAuth'],
|
|
24594
|
+
['application/json'],
|
|
24595
|
+
['application/json']
|
|
24596
|
+
);
|
|
24597
|
+
}
|
|
24598
|
+
|
|
24390
24599
|
/**
|
|
24391
24600
|
* Fetch a relationship
|
|
24392
24601
|
*
|
|
@@ -24684,6 +24893,37 @@ class ExternalContactsApi {
|
|
|
24684
24893
|
);
|
|
24685
24894
|
}
|
|
24686
24895
|
|
|
24896
|
+
/**
|
|
24897
|
+
* Claim or release identifiers for an external organization
|
|
24898
|
+
*
|
|
24899
|
+
* @param {String} externalOrganizationId External Organization ID
|
|
24900
|
+
* @param {Object} body ClaimRequest
|
|
24901
|
+
* patchExternalcontactsOrganizationIdentifiers is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24902
|
+
*/
|
|
24903
|
+
patchExternalcontactsOrganizationIdentifiers(externalOrganizationId, body) {
|
|
24904
|
+
// verify the required parameter 'externalOrganizationId' is set
|
|
24905
|
+
if (externalOrganizationId === undefined || externalOrganizationId === null) {
|
|
24906
|
+
throw 'Missing the required parameter "externalOrganizationId" when calling patchExternalcontactsOrganizationIdentifiers';
|
|
24907
|
+
}
|
|
24908
|
+
// verify the required parameter 'body' is set
|
|
24909
|
+
if (body === undefined || body === null) {
|
|
24910
|
+
throw 'Missing the required parameter "body" when calling patchExternalcontactsOrganizationIdentifiers';
|
|
24911
|
+
}
|
|
24912
|
+
|
|
24913
|
+
return this.apiClient.callApi(
|
|
24914
|
+
'/api/v2/externalcontacts/organizations/{externalOrganizationId}/identifiers',
|
|
24915
|
+
'PATCH',
|
|
24916
|
+
{ 'externalOrganizationId': externalOrganizationId },
|
|
24917
|
+
{ },
|
|
24918
|
+
{ },
|
|
24919
|
+
{ },
|
|
24920
|
+
body,
|
|
24921
|
+
['PureCloud OAuth'],
|
|
24922
|
+
['application/json'],
|
|
24923
|
+
['application/json']
|
|
24924
|
+
);
|
|
24925
|
+
}
|
|
24926
|
+
|
|
24687
24927
|
/**
|
|
24688
24928
|
* Bulk fetch contacts
|
|
24689
24929
|
*
|
|
@@ -24760,6 +25000,36 @@ class ExternalContactsApi {
|
|
|
24760
25000
|
);
|
|
24761
25001
|
}
|
|
24762
25002
|
|
|
25003
|
+
/**
|
|
25004
|
+
* Bulk Enrich Contacts - Run up to 10 Enrich operations per request
|
|
25005
|
+
* See the API endpoint /externalcontacts/contacts/enrich for docs on individual Enrich operations.
|
|
25006
|
+
* @param {Object} body Contact Enrich Requests
|
|
25007
|
+
* @param {Object} opts Optional parameters
|
|
25008
|
+
* @param {Boolean} opts.dryRun If true, the request will not make any modifications, but will show you what the end result *would* be.
|
|
25009
|
+
* postExternalcontactsBulkContactsEnrich is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25010
|
+
*/
|
|
25011
|
+
postExternalcontactsBulkContactsEnrich(body, opts) {
|
|
25012
|
+
opts = opts || {};
|
|
25013
|
+
|
|
25014
|
+
// verify the required parameter 'body' is set
|
|
25015
|
+
if (body === undefined || body === null) {
|
|
25016
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsBulkContactsEnrich';
|
|
25017
|
+
}
|
|
25018
|
+
|
|
25019
|
+
return this.apiClient.callApi(
|
|
25020
|
+
'/api/v2/externalcontacts/bulk/contacts/enrich',
|
|
25021
|
+
'POST',
|
|
25022
|
+
{ },
|
|
25023
|
+
{ 'dryRun': opts['dryRun'] },
|
|
25024
|
+
{ },
|
|
25025
|
+
{ },
|
|
25026
|
+
body,
|
|
25027
|
+
['PureCloud OAuth'],
|
|
25028
|
+
['application/json'],
|
|
25029
|
+
['application/json']
|
|
25030
|
+
);
|
|
25031
|
+
}
|
|
25032
|
+
|
|
24763
25033
|
/**
|
|
24764
25034
|
* Bulk remove contacts
|
|
24765
25035
|
*
|
|
@@ -25011,6 +25281,36 @@ class ExternalContactsApi {
|
|
|
25011
25281
|
);
|
|
25012
25282
|
}
|
|
25013
25283
|
|
|
25284
|
+
/**
|
|
25285
|
+
* Bulk enrich external organizations - Run up to 10 Enrich operations per request
|
|
25286
|
+
* See the API endpoint /externalcontacts/organizations/enrich for docs on individual Enrich operations.
|
|
25287
|
+
* @param {Object} body External Organization Enrich Requests
|
|
25288
|
+
* @param {Object} opts Optional parameters
|
|
25289
|
+
* @param {Boolean} opts.dryRun If true, the request will not make any modifications, but will show you what the end result *would* be.
|
|
25290
|
+
* postExternalcontactsBulkOrganizationsEnrich is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25291
|
+
*/
|
|
25292
|
+
postExternalcontactsBulkOrganizationsEnrich(body, opts) {
|
|
25293
|
+
opts = opts || {};
|
|
25294
|
+
|
|
25295
|
+
// verify the required parameter 'body' is set
|
|
25296
|
+
if (body === undefined || body === null) {
|
|
25297
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsBulkOrganizationsEnrich';
|
|
25298
|
+
}
|
|
25299
|
+
|
|
25300
|
+
return this.apiClient.callApi(
|
|
25301
|
+
'/api/v2/externalcontacts/bulk/organizations/enrich',
|
|
25302
|
+
'POST',
|
|
25303
|
+
{ },
|
|
25304
|
+
{ 'dryRun': opts['dryRun'] },
|
|
25305
|
+
{ },
|
|
25306
|
+
{ },
|
|
25307
|
+
body,
|
|
25308
|
+
['PureCloud OAuth'],
|
|
25309
|
+
['application/json'],
|
|
25310
|
+
['application/json']
|
|
25311
|
+
);
|
|
25312
|
+
}
|
|
25313
|
+
|
|
25014
25314
|
/**
|
|
25015
25315
|
* Bulk remove organizations
|
|
25016
25316
|
*
|
|
@@ -25241,6 +25541,36 @@ class ExternalContactsApi {
|
|
|
25241
25541
|
);
|
|
25242
25542
|
}
|
|
25243
25543
|
|
|
25544
|
+
/**
|
|
25545
|
+
* Modify or create an External Contact, with powerful behaviors for finding and combining data with pre-existing Contacts.
|
|
25546
|
+
* 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.
|
|
25547
|
+
* @param {Object} body ContactEnrichRequest
|
|
25548
|
+
* @param {Object} opts Optional parameters
|
|
25549
|
+
* @param {Boolean} opts.dryRun If true, the request will not make any modifications, but will show you what the end result *would* be.
|
|
25550
|
+
* postExternalcontactsContactsEnrich is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25551
|
+
*/
|
|
25552
|
+
postExternalcontactsContactsEnrich(body, opts) {
|
|
25553
|
+
opts = opts || {};
|
|
25554
|
+
|
|
25555
|
+
// verify the required parameter 'body' is set
|
|
25556
|
+
if (body === undefined || body === null) {
|
|
25557
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsContactsEnrich';
|
|
25558
|
+
}
|
|
25559
|
+
|
|
25560
|
+
return this.apiClient.callApi(
|
|
25561
|
+
'/api/v2/externalcontacts/contacts/enrich',
|
|
25562
|
+
'POST',
|
|
25563
|
+
{ },
|
|
25564
|
+
{ 'dryRun': opts['dryRun'] },
|
|
25565
|
+
{ },
|
|
25566
|
+
{ },
|
|
25567
|
+
body,
|
|
25568
|
+
['PureCloud OAuth'],
|
|
25569
|
+
['application/json'],
|
|
25570
|
+
['application/json']
|
|
25571
|
+
);
|
|
25572
|
+
}
|
|
25573
|
+
|
|
25244
25574
|
/**
|
|
25245
25575
|
* Create bulk export
|
|
25246
25576
|
*
|
|
@@ -25266,6 +25596,32 @@ class ExternalContactsApi {
|
|
|
25266
25596
|
);
|
|
25267
25597
|
}
|
|
25268
25598
|
|
|
25599
|
+
/**
|
|
25600
|
+
* Merge up to 25 contacts into a new contact record
|
|
25601
|
+
* 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.
|
|
25602
|
+
* @param {Object} body MergeRequest
|
|
25603
|
+
* postExternalcontactsContactsMerge is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25604
|
+
*/
|
|
25605
|
+
postExternalcontactsContactsMerge(body) {
|
|
25606
|
+
// verify the required parameter 'body' is set
|
|
25607
|
+
if (body === undefined || body === null) {
|
|
25608
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsContactsMerge';
|
|
25609
|
+
}
|
|
25610
|
+
|
|
25611
|
+
return this.apiClient.callApi(
|
|
25612
|
+
'/api/v2/externalcontacts/contacts/merge',
|
|
25613
|
+
'POST',
|
|
25614
|
+
{ },
|
|
25615
|
+
{ },
|
|
25616
|
+
{ },
|
|
25617
|
+
{ },
|
|
25618
|
+
body,
|
|
25619
|
+
['PureCloud OAuth'],
|
|
25620
|
+
['application/json'],
|
|
25621
|
+
['application/json']
|
|
25622
|
+
);
|
|
25623
|
+
}
|
|
25624
|
+
|
|
25269
25625
|
/**
|
|
25270
25626
|
* Create a schema
|
|
25271
25627
|
*
|
|
@@ -25346,6 +25702,66 @@ class ExternalContactsApi {
|
|
|
25346
25702
|
);
|
|
25347
25703
|
}
|
|
25348
25704
|
|
|
25705
|
+
/**
|
|
25706
|
+
* Fetch a contact using an identifier type and value.
|
|
25707
|
+
* Phone number identifier values must be provided with the country code and a leading + symbol. Example: "+1 704 298 4733"
|
|
25708
|
+
* @param {Object} identifier
|
|
25709
|
+
* @param {Object} opts Optional parameters
|
|
25710
|
+
* @param {Array.<String>} opts.expand which field, if any, to expand
|
|
25711
|
+
* postExternalcontactsIdentifierlookupContacts is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25712
|
+
*/
|
|
25713
|
+
postExternalcontactsIdentifierlookupContacts(identifier, opts) {
|
|
25714
|
+
opts = opts || {};
|
|
25715
|
+
|
|
25716
|
+
// verify the required parameter 'identifier' is set
|
|
25717
|
+
if (identifier === undefined || identifier === null) {
|
|
25718
|
+
throw 'Missing the required parameter "identifier" when calling postExternalcontactsIdentifierlookupContacts';
|
|
25719
|
+
}
|
|
25720
|
+
|
|
25721
|
+
return this.apiClient.callApi(
|
|
25722
|
+
'/api/v2/externalcontacts/identifierlookup/contacts',
|
|
25723
|
+
'POST',
|
|
25724
|
+
{ },
|
|
25725
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
25726
|
+
{ },
|
|
25727
|
+
{ },
|
|
25728
|
+
identifier,
|
|
25729
|
+
['PureCloud OAuth'],
|
|
25730
|
+
['application/json'],
|
|
25731
|
+
['application/json']
|
|
25732
|
+
);
|
|
25733
|
+
}
|
|
25734
|
+
|
|
25735
|
+
/**
|
|
25736
|
+
* Fetch an external organization using an identifier type and value.
|
|
25737
|
+
* This endpoint will only accept ExternalId type identifiers.
|
|
25738
|
+
* @param {Object} identifier
|
|
25739
|
+
* @param {Object} opts Optional parameters
|
|
25740
|
+
* @param {Array.<String>} opts.expand which field, if any, to expand
|
|
25741
|
+
* postExternalcontactsIdentifierlookupOrganizations is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25742
|
+
*/
|
|
25743
|
+
postExternalcontactsIdentifierlookupOrganizations(identifier, opts) {
|
|
25744
|
+
opts = opts || {};
|
|
25745
|
+
|
|
25746
|
+
// verify the required parameter 'identifier' is set
|
|
25747
|
+
if (identifier === undefined || identifier === null) {
|
|
25748
|
+
throw 'Missing the required parameter "identifier" when calling postExternalcontactsIdentifierlookupOrganizations';
|
|
25749
|
+
}
|
|
25750
|
+
|
|
25751
|
+
return this.apiClient.callApi(
|
|
25752
|
+
'/api/v2/externalcontacts/identifierlookup/organizations',
|
|
25753
|
+
'POST',
|
|
25754
|
+
{ },
|
|
25755
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
25756
|
+
{ },
|
|
25757
|
+
{ },
|
|
25758
|
+
identifier,
|
|
25759
|
+
['PureCloud OAuth'],
|
|
25760
|
+
['application/json'],
|
|
25761
|
+
['application/json']
|
|
25762
|
+
);
|
|
25763
|
+
}
|
|
25764
|
+
|
|
25349
25765
|
/**
|
|
25350
25766
|
* Create CSV import job
|
|
25351
25767
|
*
|
|
@@ -25473,8 +25889,9 @@ class ExternalContactsApi {
|
|
|
25473
25889
|
|
|
25474
25890
|
/**
|
|
25475
25891
|
* Merge two contacts into a new contact record
|
|
25476
|
-
* Two curated contacts cannot be merged. Refer to the Contact Merging article on the Developer Center for details
|
|
25892
|
+
* 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.
|
|
25477
25893
|
* @param {Object} body MergeRequest
|
|
25894
|
+
* @deprecated
|
|
25478
25895
|
*/
|
|
25479
25896
|
postExternalcontactsMergeContacts(body) {
|
|
25480
25897
|
// verify the required parameter 'body' is set
|
|
@@ -25551,6 +25968,36 @@ class ExternalContactsApi {
|
|
|
25551
25968
|
);
|
|
25552
25969
|
}
|
|
25553
25970
|
|
|
25971
|
+
/**
|
|
25972
|
+
* Modify or create an External Org, with powerful behaviors for finding and combining data with pre-existing External Orgs.
|
|
25973
|
+
* 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
|
|
25974
|
+
* @param {Object} body ExternalOrgEnrichRequest
|
|
25975
|
+
* @param {Object} opts Optional parameters
|
|
25976
|
+
* @param {Boolean} opts.dryRun If true, the request will not make any modifications, but will show you what the end result *would* be.
|
|
25977
|
+
* postExternalcontactsOrganizationsEnrich is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25978
|
+
*/
|
|
25979
|
+
postExternalcontactsOrganizationsEnrich(body, opts) {
|
|
25980
|
+
opts = opts || {};
|
|
25981
|
+
|
|
25982
|
+
// verify the required parameter 'body' is set
|
|
25983
|
+
if (body === undefined || body === null) {
|
|
25984
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsOrganizationsEnrich';
|
|
25985
|
+
}
|
|
25986
|
+
|
|
25987
|
+
return this.apiClient.callApi(
|
|
25988
|
+
'/api/v2/externalcontacts/organizations/enrich',
|
|
25989
|
+
'POST',
|
|
25990
|
+
{ },
|
|
25991
|
+
{ 'dryRun': opts['dryRun'] },
|
|
25992
|
+
{ },
|
|
25993
|
+
{ },
|
|
25994
|
+
body,
|
|
25995
|
+
['PureCloud OAuth'],
|
|
25996
|
+
['application/json'],
|
|
25997
|
+
['application/json']
|
|
25998
|
+
);
|
|
25999
|
+
}
|
|
26000
|
+
|
|
25554
26001
|
/**
|
|
25555
26002
|
* Create a schema
|
|
25556
26003
|
*
|
|
@@ -26007,7 +26454,7 @@ class FaxApi {
|
|
|
26007
26454
|
/**
|
|
26008
26455
|
* Fax service.
|
|
26009
26456
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
26010
|
-
* @version
|
|
26457
|
+
* @version 219.0.0
|
|
26011
26458
|
*/
|
|
26012
26459
|
|
|
26013
26460
|
/**
|
|
@@ -26222,7 +26669,7 @@ class FlowsApi {
|
|
|
26222
26669
|
/**
|
|
26223
26670
|
* Flows service.
|
|
26224
26671
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
26225
|
-
* @version
|
|
26672
|
+
* @version 219.0.0
|
|
26226
26673
|
*/
|
|
26227
26674
|
|
|
26228
26675
|
/**
|
|
@@ -26405,7 +26852,7 @@ class GamificationApi {
|
|
|
26405
26852
|
/**
|
|
26406
26853
|
* Gamification service.
|
|
26407
26854
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
26408
|
-
* @version
|
|
26855
|
+
* @version 219.0.0
|
|
26409
26856
|
*/
|
|
26410
26857
|
|
|
26411
26858
|
/**
|
|
@@ -26445,6 +26892,31 @@ class GamificationApi {
|
|
|
26445
26892
|
);
|
|
26446
26893
|
}
|
|
26447
26894
|
|
|
26895
|
+
/**
|
|
26896
|
+
* Delete a Contest by Id
|
|
26897
|
+
*
|
|
26898
|
+
* @param {String} contestId The ID of the contest
|
|
26899
|
+
*/
|
|
26900
|
+
deleteGamificationContest(contestId) {
|
|
26901
|
+
// verify the required parameter 'contestId' is set
|
|
26902
|
+
if (contestId === undefined || contestId === null) {
|
|
26903
|
+
throw 'Missing the required parameter "contestId" when calling deleteGamificationContest';
|
|
26904
|
+
}
|
|
26905
|
+
|
|
26906
|
+
return this.apiClient.callApi(
|
|
26907
|
+
'/api/v2/gamification/contests/{contestId}',
|
|
26908
|
+
'DELETE',
|
|
26909
|
+
{ 'contestId': contestId },
|
|
26910
|
+
{ },
|
|
26911
|
+
{ },
|
|
26912
|
+
{ },
|
|
26913
|
+
null,
|
|
26914
|
+
['PureCloud OAuth'],
|
|
26915
|
+
['application/json'],
|
|
26916
|
+
['application/json']
|
|
26917
|
+
);
|
|
26918
|
+
}
|
|
26919
|
+
|
|
26448
26920
|
/**
|
|
26449
26921
|
* Get an External Metric Definition
|
|
26450
26922
|
*
|
|
@@ -26495,6 +26967,236 @@ class GamificationApi {
|
|
|
26495
26967
|
);
|
|
26496
26968
|
}
|
|
26497
26969
|
|
|
26970
|
+
/**
|
|
26971
|
+
* Get a Contest by Id
|
|
26972
|
+
*
|
|
26973
|
+
* @param {String} contestId The ID of the contest
|
|
26974
|
+
*/
|
|
26975
|
+
getGamificationContest(contestId) {
|
|
26976
|
+
// verify the required parameter 'contestId' is set
|
|
26977
|
+
if (contestId === undefined || contestId === null) {
|
|
26978
|
+
throw 'Missing the required parameter "contestId" when calling getGamificationContest';
|
|
26979
|
+
}
|
|
26980
|
+
|
|
26981
|
+
return this.apiClient.callApi(
|
|
26982
|
+
'/api/v2/gamification/contests/{contestId}',
|
|
26983
|
+
'GET',
|
|
26984
|
+
{ 'contestId': contestId },
|
|
26985
|
+
{ },
|
|
26986
|
+
{ },
|
|
26987
|
+
{ },
|
|
26988
|
+
null,
|
|
26989
|
+
['PureCloud OAuth'],
|
|
26990
|
+
['application/json'],
|
|
26991
|
+
['application/json']
|
|
26992
|
+
);
|
|
26993
|
+
}
|
|
26994
|
+
|
|
26995
|
+
/**
|
|
26996
|
+
* Get Contest Scores (Admin)
|
|
26997
|
+
*
|
|
26998
|
+
* @param {String} contestId The ID of the contest
|
|
26999
|
+
* @param {Object} opts Optional parameters
|
|
27000
|
+
* @param {Number} opts.pageNumber (default to 1)
|
|
27001
|
+
* @param {Number} opts.pageSize (default to 25)
|
|
27002
|
+
* @param {String} opts.workday Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
27003
|
+
* @param {Object} opts.returnsView Desired response results (default to All)
|
|
27004
|
+
*/
|
|
27005
|
+
getGamificationContestAgentsScores(contestId, opts) {
|
|
27006
|
+
opts = opts || {};
|
|
27007
|
+
|
|
27008
|
+
// verify the required parameter 'contestId' is set
|
|
27009
|
+
if (contestId === undefined || contestId === null) {
|
|
27010
|
+
throw 'Missing the required parameter "contestId" when calling getGamificationContestAgentsScores';
|
|
27011
|
+
}
|
|
27012
|
+
|
|
27013
|
+
return this.apiClient.callApi(
|
|
27014
|
+
'/api/v2/gamification/contests/{contestId}/agents/scores',
|
|
27015
|
+
'GET',
|
|
27016
|
+
{ 'contestId': contestId },
|
|
27017
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'workday': opts['workday'],'returnsView': opts['returnsView'] },
|
|
27018
|
+
{ },
|
|
27019
|
+
{ },
|
|
27020
|
+
null,
|
|
27021
|
+
['PureCloud OAuth'],
|
|
27022
|
+
['application/json'],
|
|
27023
|
+
['application/json']
|
|
27024
|
+
);
|
|
27025
|
+
}
|
|
27026
|
+
|
|
27027
|
+
/**
|
|
27028
|
+
* Get Contest Scores for the requesting Agent/Supervisor
|
|
27029
|
+
*
|
|
27030
|
+
* @param {String} contestId The ID of the contest
|
|
27031
|
+
* @param {Object} opts Optional parameters
|
|
27032
|
+
* @param {Number} opts.pageNumber (default to 1)
|
|
27033
|
+
* @param {Number} opts.pageSize (default to 25)
|
|
27034
|
+
* @param {String} opts.workday Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
27035
|
+
* @param {Object} opts.returnsView Desired response results (Supervisor Only) (default to All)
|
|
27036
|
+
*/
|
|
27037
|
+
getGamificationContestAgentsScoresMe(contestId, opts) {
|
|
27038
|
+
opts = opts || {};
|
|
27039
|
+
|
|
27040
|
+
// verify the required parameter 'contestId' is set
|
|
27041
|
+
if (contestId === undefined || contestId === null) {
|
|
27042
|
+
throw 'Missing the required parameter "contestId" when calling getGamificationContestAgentsScoresMe';
|
|
27043
|
+
}
|
|
27044
|
+
|
|
27045
|
+
return this.apiClient.callApi(
|
|
27046
|
+
'/api/v2/gamification/contests/{contestId}/agents/scores/me',
|
|
27047
|
+
'GET',
|
|
27048
|
+
{ 'contestId': contestId },
|
|
27049
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'workday': opts['workday'],'returnsView': opts['returnsView'] },
|
|
27050
|
+
{ },
|
|
27051
|
+
{ },
|
|
27052
|
+
null,
|
|
27053
|
+
['PureCloud OAuth'],
|
|
27054
|
+
['application/json'],
|
|
27055
|
+
['application/json']
|
|
27056
|
+
);
|
|
27057
|
+
}
|
|
27058
|
+
|
|
27059
|
+
/**
|
|
27060
|
+
* Get a Contest Score Trend (Average Trend)
|
|
27061
|
+
*
|
|
27062
|
+
* @param {String} contestId The ID of the contest
|
|
27063
|
+
*/
|
|
27064
|
+
getGamificationContestAgentsScoresTrends(contestId) {
|
|
27065
|
+
// verify the required parameter 'contestId' is set
|
|
27066
|
+
if (contestId === undefined || contestId === null) {
|
|
27067
|
+
throw 'Missing the required parameter "contestId" when calling getGamificationContestAgentsScoresTrends';
|
|
27068
|
+
}
|
|
27069
|
+
|
|
27070
|
+
return this.apiClient.callApi(
|
|
27071
|
+
'/api/v2/gamification/contests/{contestId}/agents/scores/trends',
|
|
27072
|
+
'GET',
|
|
27073
|
+
{ 'contestId': contestId },
|
|
27074
|
+
{ },
|
|
27075
|
+
{ },
|
|
27076
|
+
{ },
|
|
27077
|
+
null,
|
|
27078
|
+
['PureCloud OAuth'],
|
|
27079
|
+
['application/json'],
|
|
27080
|
+
['application/json']
|
|
27081
|
+
);
|
|
27082
|
+
}
|
|
27083
|
+
|
|
27084
|
+
/**
|
|
27085
|
+
* Get a Contest Score Trend for the requesting Agent
|
|
27086
|
+
*
|
|
27087
|
+
* @param {String} contestId The ID of the contest
|
|
27088
|
+
*/
|
|
27089
|
+
getGamificationContestAgentsScoresTrendsMe(contestId) {
|
|
27090
|
+
// verify the required parameter 'contestId' is set
|
|
27091
|
+
if (contestId === undefined || contestId === null) {
|
|
27092
|
+
throw 'Missing the required parameter "contestId" when calling getGamificationContestAgentsScoresTrendsMe';
|
|
27093
|
+
}
|
|
27094
|
+
|
|
27095
|
+
return this.apiClient.callApi(
|
|
27096
|
+
'/api/v2/gamification/contests/{contestId}/agents/scores/trends/me',
|
|
27097
|
+
'GET',
|
|
27098
|
+
{ 'contestId': contestId },
|
|
27099
|
+
{ },
|
|
27100
|
+
{ },
|
|
27101
|
+
{ },
|
|
27102
|
+
null,
|
|
27103
|
+
['PureCloud OAuth'],
|
|
27104
|
+
['application/json'],
|
|
27105
|
+
['application/json']
|
|
27106
|
+
);
|
|
27107
|
+
}
|
|
27108
|
+
|
|
27109
|
+
/**
|
|
27110
|
+
* Get a Contest Prize Image by Id
|
|
27111
|
+
*
|
|
27112
|
+
* @param {String} contestId The ID of the contest
|
|
27113
|
+
* @param {String} prizeImageId The ID of the prize image
|
|
27114
|
+
*/
|
|
27115
|
+
getGamificationContestPrizeimage(contestId, prizeImageId) {
|
|
27116
|
+
// verify the required parameter 'contestId' is set
|
|
27117
|
+
if (contestId === undefined || contestId === null) {
|
|
27118
|
+
throw 'Missing the required parameter "contestId" when calling getGamificationContestPrizeimage';
|
|
27119
|
+
}
|
|
27120
|
+
// verify the required parameter 'prizeImageId' is set
|
|
27121
|
+
if (prizeImageId === undefined || prizeImageId === null) {
|
|
27122
|
+
throw 'Missing the required parameter "prizeImageId" when calling getGamificationContestPrizeimage';
|
|
27123
|
+
}
|
|
27124
|
+
|
|
27125
|
+
return this.apiClient.callApi(
|
|
27126
|
+
'/api/v2/gamification/contests/{contestId}/prizeimages/{prizeImageId}',
|
|
27127
|
+
'GET',
|
|
27128
|
+
{ 'contestId': contestId,'prizeImageId': prizeImageId },
|
|
27129
|
+
{ },
|
|
27130
|
+
{ },
|
|
27131
|
+
{ },
|
|
27132
|
+
null,
|
|
27133
|
+
['PureCloud OAuth'],
|
|
27134
|
+
['application/json'],
|
|
27135
|
+
['application/json']
|
|
27136
|
+
);
|
|
27137
|
+
}
|
|
27138
|
+
|
|
27139
|
+
/**
|
|
27140
|
+
* Get a List of Contests (Admin)
|
|
27141
|
+
*
|
|
27142
|
+
* @param {Object} opts Optional parameters
|
|
27143
|
+
* @param {Number} opts.pageNumber (default to 1)
|
|
27144
|
+
* @param {Number} opts.pageSize (default to 25)
|
|
27145
|
+
* @param {String} opts.dateStart Start date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
27146
|
+
* @param {String} opts.dateEnd End date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
27147
|
+
* @param {Array.<String>} opts.status
|
|
27148
|
+
* @param {Object} opts.sortBy (default to dateStart)
|
|
27149
|
+
* @param {Object} opts.sortOrder (default to desc)
|
|
27150
|
+
*/
|
|
27151
|
+
getGamificationContests(opts) {
|
|
27152
|
+
opts = opts || {};
|
|
27153
|
+
|
|
27154
|
+
|
|
27155
|
+
return this.apiClient.callApi(
|
|
27156
|
+
'/api/v2/gamification/contests',
|
|
27157
|
+
'GET',
|
|
27158
|
+
{ },
|
|
27159
|
+
{ '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'] },
|
|
27160
|
+
{ },
|
|
27161
|
+
{ },
|
|
27162
|
+
null,
|
|
27163
|
+
['PureCloud OAuth'],
|
|
27164
|
+
['application/json'],
|
|
27165
|
+
['application/json']
|
|
27166
|
+
);
|
|
27167
|
+
}
|
|
27168
|
+
|
|
27169
|
+
/**
|
|
27170
|
+
* Get a List of Contests (Agent/Supervisor)
|
|
27171
|
+
*
|
|
27172
|
+
* @param {Object} opts Optional parameters
|
|
27173
|
+
* @param {Number} opts.pageNumber (default to 1)
|
|
27174
|
+
* @param {Number} opts.pageSize (default to 25)
|
|
27175
|
+
* @param {String} opts.dateStart Start date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
27176
|
+
* @param {String} opts.dateEnd End date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
27177
|
+
* @param {Array.<String>} opts.status
|
|
27178
|
+
* @param {Object} opts.sortBy (default to dateStart)
|
|
27179
|
+
* @param {Object} opts.sortOrder (default to desc)
|
|
27180
|
+
* @param {Object} opts.view (default to participant)
|
|
27181
|
+
*/
|
|
27182
|
+
getGamificationContestsMe(opts) {
|
|
27183
|
+
opts = opts || {};
|
|
27184
|
+
|
|
27185
|
+
|
|
27186
|
+
return this.apiClient.callApi(
|
|
27187
|
+
'/api/v2/gamification/contests/me',
|
|
27188
|
+
'GET',
|
|
27189
|
+
{ },
|
|
27190
|
+
{ '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'] },
|
|
27191
|
+
{ },
|
|
27192
|
+
{ },
|
|
27193
|
+
null,
|
|
27194
|
+
['PureCloud OAuth'],
|
|
27195
|
+
['application/json'],
|
|
27196
|
+
['application/json']
|
|
27197
|
+
);
|
|
27198
|
+
}
|
|
27199
|
+
|
|
26498
27200
|
/**
|
|
26499
27201
|
* Get insights summary
|
|
26500
27202
|
*
|
|
@@ -28145,6 +28847,36 @@ class GamificationApi {
|
|
|
28145
28847
|
);
|
|
28146
28848
|
}
|
|
28147
28849
|
|
|
28850
|
+
/**
|
|
28851
|
+
* Finalize a Contest by Id
|
|
28852
|
+
*
|
|
28853
|
+
* @param {String} contestId The ID of the contest
|
|
28854
|
+
* @param {Object} body Finalize Contest
|
|
28855
|
+
*/
|
|
28856
|
+
patchGamificationContest(contestId, body) {
|
|
28857
|
+
// verify the required parameter 'contestId' is set
|
|
28858
|
+
if (contestId === undefined || contestId === null) {
|
|
28859
|
+
throw 'Missing the required parameter "contestId" when calling patchGamificationContest';
|
|
28860
|
+
}
|
|
28861
|
+
// verify the required parameter 'body' is set
|
|
28862
|
+
if (body === undefined || body === null) {
|
|
28863
|
+
throw 'Missing the required parameter "body" when calling patchGamificationContest';
|
|
28864
|
+
}
|
|
28865
|
+
|
|
28866
|
+
return this.apiClient.callApi(
|
|
28867
|
+
'/api/v2/gamification/contests/{contestId}',
|
|
28868
|
+
'PATCH',
|
|
28869
|
+
{ 'contestId': contestId },
|
|
28870
|
+
{ },
|
|
28871
|
+
{ },
|
|
28872
|
+
{ },
|
|
28873
|
+
body,
|
|
28874
|
+
['PureCloud OAuth'],
|
|
28875
|
+
['application/json'],
|
|
28876
|
+
['application/json']
|
|
28877
|
+
);
|
|
28878
|
+
}
|
|
28879
|
+
|
|
28148
28880
|
/**
|
|
28149
28881
|
* Write External Metric Data
|
|
28150
28882
|
*
|
|
@@ -28193,6 +28925,56 @@ class GamificationApi {
|
|
|
28193
28925
|
);
|
|
28194
28926
|
}
|
|
28195
28927
|
|
|
28928
|
+
/**
|
|
28929
|
+
* Creates a Contest
|
|
28930
|
+
*
|
|
28931
|
+
* @param {Object} body Create Contest
|
|
28932
|
+
*/
|
|
28933
|
+
postGamificationContests(body) {
|
|
28934
|
+
// verify the required parameter 'body' is set
|
|
28935
|
+
if (body === undefined || body === null) {
|
|
28936
|
+
throw 'Missing the required parameter "body" when calling postGamificationContests';
|
|
28937
|
+
}
|
|
28938
|
+
|
|
28939
|
+
return this.apiClient.callApi(
|
|
28940
|
+
'/api/v2/gamification/contests',
|
|
28941
|
+
'POST',
|
|
28942
|
+
{ },
|
|
28943
|
+
{ },
|
|
28944
|
+
{ },
|
|
28945
|
+
{ },
|
|
28946
|
+
body,
|
|
28947
|
+
['PureCloud OAuth'],
|
|
28948
|
+
['application/json'],
|
|
28949
|
+
['application/json']
|
|
28950
|
+
);
|
|
28951
|
+
}
|
|
28952
|
+
|
|
28953
|
+
/**
|
|
28954
|
+
* Generates pre-signed URL to upload a prize image for gamification contests
|
|
28955
|
+
*
|
|
28956
|
+
* @param {Object} body query
|
|
28957
|
+
*/
|
|
28958
|
+
postGamificationContestsUploadsPrizeimages(body) {
|
|
28959
|
+
// verify the required parameter 'body' is set
|
|
28960
|
+
if (body === undefined || body === null) {
|
|
28961
|
+
throw 'Missing the required parameter "body" when calling postGamificationContestsUploadsPrizeimages';
|
|
28962
|
+
}
|
|
28963
|
+
|
|
28964
|
+
return this.apiClient.callApi(
|
|
28965
|
+
'/api/v2/gamification/contests/uploads/prizeimages',
|
|
28966
|
+
'POST',
|
|
28967
|
+
{ },
|
|
28968
|
+
{ },
|
|
28969
|
+
{ },
|
|
28970
|
+
{ },
|
|
28971
|
+
body,
|
|
28972
|
+
['PureCloud OAuth'],
|
|
28973
|
+
['application/json'],
|
|
28974
|
+
['application/json']
|
|
28975
|
+
);
|
|
28976
|
+
}
|
|
28977
|
+
|
|
28196
28978
|
/**
|
|
28197
28979
|
* Activate a performance profile
|
|
28198
28980
|
*
|
|
@@ -28452,6 +29234,36 @@ class GamificationApi {
|
|
|
28452
29234
|
);
|
|
28453
29235
|
}
|
|
28454
29236
|
|
|
29237
|
+
/**
|
|
29238
|
+
* Update a Contest by Id
|
|
29239
|
+
*
|
|
29240
|
+
* @param {String} contestId The ID of the contest
|
|
29241
|
+
* @param {Object} body Contest
|
|
29242
|
+
*/
|
|
29243
|
+
putGamificationContest(contestId, body) {
|
|
29244
|
+
// verify the required parameter 'contestId' is set
|
|
29245
|
+
if (contestId === undefined || contestId === null) {
|
|
29246
|
+
throw 'Missing the required parameter "contestId" when calling putGamificationContest';
|
|
29247
|
+
}
|
|
29248
|
+
// verify the required parameter 'body' is set
|
|
29249
|
+
if (body === undefined || body === null) {
|
|
29250
|
+
throw 'Missing the required parameter "body" when calling putGamificationContest';
|
|
29251
|
+
}
|
|
29252
|
+
|
|
29253
|
+
return this.apiClient.callApi(
|
|
29254
|
+
'/api/v2/gamification/contests/{contestId}',
|
|
29255
|
+
'PUT',
|
|
29256
|
+
{ 'contestId': contestId },
|
|
29257
|
+
{ },
|
|
29258
|
+
{ },
|
|
29259
|
+
{ },
|
|
29260
|
+
body,
|
|
29261
|
+
['PureCloud OAuth'],
|
|
29262
|
+
['application/json'],
|
|
29263
|
+
['application/json']
|
|
29264
|
+
);
|
|
29265
|
+
}
|
|
29266
|
+
|
|
28455
29267
|
/**
|
|
28456
29268
|
* Updates a performance profile
|
|
28457
29269
|
*
|
|
@@ -28547,7 +29359,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
28547
29359
|
/**
|
|
28548
29360
|
* GeneralDataProtectionRegulation service.
|
|
28549
29361
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
28550
|
-
* @version
|
|
29362
|
+
* @version 219.0.0
|
|
28551
29363
|
*/
|
|
28552
29364
|
|
|
28553
29365
|
/**
|
|
@@ -28677,7 +29489,7 @@ class GeolocationApi {
|
|
|
28677
29489
|
/**
|
|
28678
29490
|
* Geolocation service.
|
|
28679
29491
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
28680
|
-
* @version
|
|
29492
|
+
* @version 219.0.0
|
|
28681
29493
|
*/
|
|
28682
29494
|
|
|
28683
29495
|
/**
|
|
@@ -28808,7 +29620,7 @@ class GreetingsApi {
|
|
|
28808
29620
|
/**
|
|
28809
29621
|
* Greetings service.
|
|
28810
29622
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
28811
|
-
* @version
|
|
29623
|
+
* @version 219.0.0
|
|
28812
29624
|
*/
|
|
28813
29625
|
|
|
28814
29626
|
/**
|
|
@@ -29263,7 +30075,7 @@ class GroupsApi {
|
|
|
29263
30075
|
/**
|
|
29264
30076
|
* Groups service.
|
|
29265
30077
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
29266
|
-
* @version
|
|
30078
|
+
* @version 219.0.0
|
|
29267
30079
|
*/
|
|
29268
30080
|
|
|
29269
30081
|
/**
|
|
@@ -29782,7 +30594,7 @@ class IdentityProviderApi {
|
|
|
29782
30594
|
/**
|
|
29783
30595
|
* IdentityProvider service.
|
|
29784
30596
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
29785
|
-
* @version
|
|
30597
|
+
* @version 219.0.0
|
|
29786
30598
|
*/
|
|
29787
30599
|
|
|
29788
30600
|
/**
|
|
@@ -30643,7 +31455,7 @@ class InfrastructureAsCodeApi {
|
|
|
30643
31455
|
/**
|
|
30644
31456
|
* InfrastructureAsCode service.
|
|
30645
31457
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
30646
|
-
* @version
|
|
31458
|
+
* @version 219.0.0
|
|
30647
31459
|
*/
|
|
30648
31460
|
|
|
30649
31461
|
/**
|
|
@@ -30810,7 +31622,7 @@ class IntegrationsApi {
|
|
|
30810
31622
|
/**
|
|
30811
31623
|
* Integrations service.
|
|
30812
31624
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
30813
|
-
* @version
|
|
31625
|
+
* @version 219.0.0
|
|
30814
31626
|
*/
|
|
30815
31627
|
|
|
30816
31628
|
/**
|
|
@@ -33279,7 +34091,7 @@ class JourneyApi {
|
|
|
33279
34091
|
/**
|
|
33280
34092
|
* Journey service.
|
|
33281
34093
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
33282
|
-
* @version
|
|
34094
|
+
* @version 219.0.0
|
|
33283
34095
|
*/
|
|
33284
34096
|
|
|
33285
34097
|
/**
|
|
@@ -35264,7 +36076,7 @@ class KnowledgeApi {
|
|
|
35264
36076
|
/**
|
|
35265
36077
|
* Knowledge service.
|
|
35266
36078
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
35267
|
-
* @version
|
|
36079
|
+
* @version 219.0.0
|
|
35268
36080
|
*/
|
|
35269
36081
|
|
|
35270
36082
|
/**
|
|
@@ -39137,7 +39949,7 @@ class LanguageUnderstandingApi {
|
|
|
39137
39949
|
/**
|
|
39138
39950
|
* LanguageUnderstanding service.
|
|
39139
39951
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
39140
|
-
* @version
|
|
39952
|
+
* @version 219.0.0
|
|
39141
39953
|
*/
|
|
39142
39954
|
|
|
39143
39955
|
/**
|
|
@@ -40170,7 +40982,7 @@ class LanguagesApi {
|
|
|
40170
40982
|
/**
|
|
40171
40983
|
* Languages service.
|
|
40172
40984
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
40173
|
-
* @version
|
|
40985
|
+
* @version 219.0.0
|
|
40174
40986
|
*/
|
|
40175
40987
|
|
|
40176
40988
|
/**
|
|
@@ -40392,7 +41204,7 @@ class LearningApi {
|
|
|
40392
41204
|
/**
|
|
40393
41205
|
* Learning service.
|
|
40394
41206
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
40395
|
-
* @version
|
|
41207
|
+
* @version 219.0.0
|
|
40396
41208
|
*/
|
|
40397
41209
|
|
|
40398
41210
|
/**
|
|
@@ -41421,7 +42233,7 @@ class LicenseApi {
|
|
|
41421
42233
|
/**
|
|
41422
42234
|
* License service.
|
|
41423
42235
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
41424
|
-
* @version
|
|
42236
|
+
* @version 219.0.0
|
|
41425
42237
|
*/
|
|
41426
42238
|
|
|
41427
42239
|
/**
|
|
@@ -41659,7 +42471,7 @@ class LocationsApi {
|
|
|
41659
42471
|
/**
|
|
41660
42472
|
* Locations service.
|
|
41661
42473
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
41662
|
-
* @version
|
|
42474
|
+
* @version 219.0.0
|
|
41663
42475
|
*/
|
|
41664
42476
|
|
|
41665
42477
|
/**
|
|
@@ -41895,7 +42707,7 @@ class LogCaptureApi {
|
|
|
41895
42707
|
/**
|
|
41896
42708
|
* LogCapture service.
|
|
41897
42709
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
41898
|
-
* @version
|
|
42710
|
+
* @version 219.0.0
|
|
41899
42711
|
*/
|
|
41900
42712
|
|
|
41901
42713
|
/**
|
|
@@ -42095,7 +42907,7 @@ class MessagingApi {
|
|
|
42095
42907
|
/**
|
|
42096
42908
|
* Messaging service.
|
|
42097
42909
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
42098
|
-
* @version
|
|
42910
|
+
* @version 219.0.0
|
|
42099
42911
|
*/
|
|
42100
42912
|
|
|
42101
42913
|
/**
|
|
@@ -42454,7 +43266,7 @@ class MobileDevicesApi {
|
|
|
42454
43266
|
/**
|
|
42455
43267
|
* MobileDevices service.
|
|
42456
43268
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
42457
|
-
* @version
|
|
43269
|
+
* @version 219.0.0
|
|
42458
43270
|
*/
|
|
42459
43271
|
|
|
42460
43272
|
/**
|
|
@@ -42605,7 +43417,7 @@ class NotificationsApi {
|
|
|
42605
43417
|
/**
|
|
42606
43418
|
* Notifications service.
|
|
42607
43419
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
42608
|
-
* @version
|
|
43420
|
+
* @version 219.0.0
|
|
42609
43421
|
*/
|
|
42610
43422
|
|
|
42611
43423
|
/**
|
|
@@ -42838,7 +43650,7 @@ class OAuthApi {
|
|
|
42838
43650
|
/**
|
|
42839
43651
|
* OAuth service.
|
|
42840
43652
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
42841
|
-
* @version
|
|
43653
|
+
* @version 219.0.0
|
|
42842
43654
|
*/
|
|
42843
43655
|
|
|
42844
43656
|
/**
|
|
@@ -43204,7 +44016,7 @@ class ObjectsApi {
|
|
|
43204
44016
|
/**
|
|
43205
44017
|
* Objects service.
|
|
43206
44018
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
43207
|
-
* @version
|
|
44019
|
+
* @version 219.0.0
|
|
43208
44020
|
*/
|
|
43209
44021
|
|
|
43210
44022
|
/**
|
|
@@ -43309,6 +44121,31 @@ class ObjectsApi {
|
|
|
43309
44121
|
);
|
|
43310
44122
|
}
|
|
43311
44123
|
|
|
44124
|
+
/**
|
|
44125
|
+
* Get a list of soft deleted divisions for the org
|
|
44126
|
+
*
|
|
44127
|
+
* @param {Object} opts Optional parameters
|
|
44128
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
44129
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
44130
|
+
*/
|
|
44131
|
+
getAuthorizationDivisionsDeleted(opts) {
|
|
44132
|
+
opts = opts || {};
|
|
44133
|
+
|
|
44134
|
+
|
|
44135
|
+
return this.apiClient.callApi(
|
|
44136
|
+
'/api/v2/authorization/divisions/deleted',
|
|
44137
|
+
'GET',
|
|
44138
|
+
{ },
|
|
44139
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
44140
|
+
{ },
|
|
44141
|
+
{ },
|
|
44142
|
+
null,
|
|
44143
|
+
['PureCloud OAuth'],
|
|
44144
|
+
['application/json'],
|
|
44145
|
+
['application/json']
|
|
44146
|
+
);
|
|
44147
|
+
}
|
|
44148
|
+
|
|
43312
44149
|
/**
|
|
43313
44150
|
* Retrieve the home division for the organization.
|
|
43314
44151
|
* Will not include object counts.
|
|
@@ -43349,6 +44186,34 @@ class ObjectsApi {
|
|
|
43349
44186
|
);
|
|
43350
44187
|
}
|
|
43351
44188
|
|
|
44189
|
+
/**
|
|
44190
|
+
* Retrieve a list of all divisions defined for the organization with cursor
|
|
44191
|
+
* Use "after" and "before" param to fetch next/previous page}
|
|
44192
|
+
* @param {Object} opts Optional parameters
|
|
44193
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
44194
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
44195
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
44196
|
+
* @param {Array.<String>} opts.id Optionally request specific divisions by their IDs
|
|
44197
|
+
* @param {String} opts.name Optionally request specific divisions by division name
|
|
44198
|
+
*/
|
|
44199
|
+
getAuthorizationDivisionsQuery(opts) {
|
|
44200
|
+
opts = opts || {};
|
|
44201
|
+
|
|
44202
|
+
|
|
44203
|
+
return this.apiClient.callApi(
|
|
44204
|
+
'/api/v2/authorization/divisions/query',
|
|
44205
|
+
'GET',
|
|
44206
|
+
{ },
|
|
44207
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'name': opts['name'] },
|
|
44208
|
+
{ },
|
|
44209
|
+
{ },
|
|
44210
|
+
null,
|
|
44211
|
+
['PureCloud OAuth'],
|
|
44212
|
+
['application/json'],
|
|
44213
|
+
['application/json']
|
|
44214
|
+
);
|
|
44215
|
+
}
|
|
44216
|
+
|
|
43352
44217
|
/**
|
|
43353
44218
|
* Assign a list of objects to a division
|
|
43354
44219
|
* 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"]
|
|
@@ -43475,7 +44340,7 @@ class OperationalEventsApi {
|
|
|
43475
44340
|
/**
|
|
43476
44341
|
* OperationalEvents service.
|
|
43477
44342
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
43478
|
-
* @version
|
|
44343
|
+
* @version 219.0.0
|
|
43479
44344
|
*/
|
|
43480
44345
|
|
|
43481
44346
|
/**
|
|
@@ -43592,7 +44457,7 @@ class OrganizationApi {
|
|
|
43592
44457
|
/**
|
|
43593
44458
|
* Organization service.
|
|
43594
44459
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
43595
|
-
* @version
|
|
44460
|
+
* @version 219.0.0
|
|
43596
44461
|
*/
|
|
43597
44462
|
|
|
43598
44463
|
/**
|
|
@@ -44067,7 +44932,7 @@ class OrganizationAuthorizationApi {
|
|
|
44067
44932
|
/**
|
|
44068
44933
|
* OrganizationAuthorization service.
|
|
44069
44934
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
44070
|
-
* @version
|
|
44935
|
+
* @version 219.0.0
|
|
44071
44936
|
*/
|
|
44072
44937
|
|
|
44073
44938
|
/**
|
|
@@ -45461,7 +46326,7 @@ class OutboundApi {
|
|
|
45461
46326
|
/**
|
|
45462
46327
|
* Outbound service.
|
|
45463
46328
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
45464
|
-
* @version
|
|
46329
|
+
* @version 219.0.0
|
|
45465
46330
|
*/
|
|
45466
46331
|
|
|
45467
46332
|
/**
|
|
@@ -45948,6 +46813,35 @@ class OutboundApi {
|
|
|
45948
46813
|
);
|
|
45949
46814
|
}
|
|
45950
46815
|
|
|
46816
|
+
/**
|
|
46817
|
+
* Deletes all or expired whatsApp numbers from a DNC list.
|
|
46818
|
+
* This operation is only for Internal DNC lists of whatsApp numbers
|
|
46819
|
+
* @param {String} dncListId DncList ID
|
|
46820
|
+
* @param {Object} opts Optional parameters
|
|
46821
|
+
* @param {Boolean} opts.expiredOnly Set to true to only remove DNC whatsApp numbers that are expired (default to false)
|
|
46822
|
+
*/
|
|
46823
|
+
deleteOutboundDnclistWhatsappnumbers(dncListId, opts) {
|
|
46824
|
+
opts = opts || {};
|
|
46825
|
+
|
|
46826
|
+
// verify the required parameter 'dncListId' is set
|
|
46827
|
+
if (dncListId === undefined || dncListId === null) {
|
|
46828
|
+
throw 'Missing the required parameter "dncListId" when calling deleteOutboundDnclistWhatsappnumbers';
|
|
46829
|
+
}
|
|
46830
|
+
|
|
46831
|
+
return this.apiClient.callApi(
|
|
46832
|
+
'/api/v2/outbound/dnclists/{dncListId}/whatsappnumbers',
|
|
46833
|
+
'DELETE',
|
|
46834
|
+
{ 'dncListId': dncListId },
|
|
46835
|
+
{ 'expiredOnly': opts['expiredOnly'] },
|
|
46836
|
+
{ },
|
|
46837
|
+
{ },
|
|
46838
|
+
null,
|
|
46839
|
+
['PureCloud OAuth'],
|
|
46840
|
+
['application/json'],
|
|
46841
|
+
['application/json']
|
|
46842
|
+
);
|
|
46843
|
+
}
|
|
46844
|
+
|
|
45951
46845
|
/**
|
|
45952
46846
|
* Delete File Specification Template
|
|
45953
46847
|
*
|
|
@@ -48286,6 +49180,36 @@ class OutboundApi {
|
|
|
48286
49180
|
);
|
|
48287
49181
|
}
|
|
48288
49182
|
|
|
49183
|
+
/**
|
|
49184
|
+
* Add entries to or delete entries from a DNC list.
|
|
49185
|
+
* Only Internal DNC lists may be deleted from
|
|
49186
|
+
* @param {String} dncListId DncList ID
|
|
49187
|
+
* @param {Object} body DNC whatsApp numbers
|
|
49188
|
+
*/
|
|
49189
|
+
patchOutboundDnclistWhatsappnumbers(dncListId, body) {
|
|
49190
|
+
// verify the required parameter 'dncListId' is set
|
|
49191
|
+
if (dncListId === undefined || dncListId === null) {
|
|
49192
|
+
throw 'Missing the required parameter "dncListId" when calling patchOutboundDnclistWhatsappnumbers';
|
|
49193
|
+
}
|
|
49194
|
+
// verify the required parameter 'body' is set
|
|
49195
|
+
if (body === undefined || body === null) {
|
|
49196
|
+
throw 'Missing the required parameter "body" when calling patchOutboundDnclistWhatsappnumbers';
|
|
49197
|
+
}
|
|
49198
|
+
|
|
49199
|
+
return this.apiClient.callApi(
|
|
49200
|
+
'/api/v2/outbound/dnclists/{dncListId}/whatsappnumbers',
|
|
49201
|
+
'PATCH',
|
|
49202
|
+
{ 'dncListId': dncListId },
|
|
49203
|
+
{ },
|
|
49204
|
+
{ },
|
|
49205
|
+
{ },
|
|
49206
|
+
body,
|
|
49207
|
+
['PureCloud OAuth'],
|
|
49208
|
+
['application/json'],
|
|
49209
|
+
['application/json']
|
|
49210
|
+
);
|
|
49211
|
+
}
|
|
49212
|
+
|
|
48289
49213
|
/**
|
|
48290
49214
|
* Update the outbound settings for this organization
|
|
48291
49215
|
*
|
|
@@ -50024,7 +50948,7 @@ class PresenceApi {
|
|
|
50024
50948
|
/**
|
|
50025
50949
|
* Presence service.
|
|
50026
50950
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
50027
|
-
* @version
|
|
50951
|
+
* @version 219.0.0
|
|
50028
50952
|
*/
|
|
50029
50953
|
|
|
50030
50954
|
/**
|
|
@@ -50044,10 +50968,10 @@ class PresenceApi {
|
|
|
50044
50968
|
*
|
|
50045
50969
|
* @param {String} definitionId Presence Definition ID
|
|
50046
50970
|
*/
|
|
50047
|
-
|
|
50971
|
+
deletePresenceDefinition0(definitionId) {
|
|
50048
50972
|
// verify the required parameter 'definitionId' is set
|
|
50049
50973
|
if (definitionId === undefined || definitionId === null) {
|
|
50050
|
-
throw 'Missing the required parameter "definitionId" when calling
|
|
50974
|
+
throw 'Missing the required parameter "definitionId" when calling deletePresenceDefinition0';
|
|
50051
50975
|
}
|
|
50052
50976
|
|
|
50053
50977
|
return this.apiClient.callApi(
|
|
@@ -50122,12 +51046,12 @@ class PresenceApi {
|
|
|
50122
51046
|
* @param {Object} opts Optional parameters
|
|
50123
51047
|
* @param {Object} opts.localeCode The locale code to fetch for the presence definition. Use ALL to fetch everything.
|
|
50124
51048
|
*/
|
|
50125
|
-
|
|
51049
|
+
getPresenceDefinition0(definitionId, opts) {
|
|
50126
51050
|
opts = opts || {};
|
|
50127
51051
|
|
|
50128
51052
|
// verify the required parameter 'definitionId' is set
|
|
50129
51053
|
if (definitionId === undefined || definitionId === null) {
|
|
50130
|
-
throw 'Missing the required parameter "definitionId" when calling
|
|
51054
|
+
throw 'Missing the required parameter "definitionId" when calling getPresenceDefinition0';
|
|
50131
51055
|
}
|
|
50132
51056
|
|
|
50133
51057
|
return this.apiClient.callApi(
|
|
@@ -50152,7 +51076,7 @@ class PresenceApi {
|
|
|
50152
51076
|
* @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.
|
|
50153
51077
|
* @param {Object} opts.localeCode The locale code to fetch for the presence definition. Use ALL to fetch everything.
|
|
50154
51078
|
*/
|
|
50155
|
-
|
|
51079
|
+
getPresenceDefinitions0(opts) {
|
|
50156
51080
|
opts = opts || {};
|
|
50157
51081
|
|
|
50158
51082
|
|
|
@@ -50520,10 +51444,10 @@ class PresenceApi {
|
|
|
50520
51444
|
*
|
|
50521
51445
|
* @param {Object} body The Presence Definition to create
|
|
50522
51446
|
*/
|
|
50523
|
-
|
|
51447
|
+
postPresenceDefinitions0(body) {
|
|
50524
51448
|
// verify the required parameter 'body' is set
|
|
50525
51449
|
if (body === undefined || body === null) {
|
|
50526
|
-
throw 'Missing the required parameter "body" when calling
|
|
51450
|
+
throw 'Missing the required parameter "body" when calling postPresenceDefinitions0';
|
|
50527
51451
|
}
|
|
50528
51452
|
|
|
50529
51453
|
return this.apiClient.callApi(
|
|
@@ -50597,14 +51521,14 @@ class PresenceApi {
|
|
|
50597
51521
|
* @param {String} definitionId Presence Definition ID
|
|
50598
51522
|
* @param {Object} body The updated Presence Definition
|
|
50599
51523
|
*/
|
|
50600
|
-
|
|
51524
|
+
putPresenceDefinition0(definitionId, body) {
|
|
50601
51525
|
// verify the required parameter 'definitionId' is set
|
|
50602
51526
|
if (definitionId === undefined || definitionId === null) {
|
|
50603
|
-
throw 'Missing the required parameter "definitionId" when calling
|
|
51527
|
+
throw 'Missing the required parameter "definitionId" when calling putPresenceDefinition0';
|
|
50604
51528
|
}
|
|
50605
51529
|
// verify the required parameter 'body' is set
|
|
50606
51530
|
if (body === undefined || body === null) {
|
|
50607
|
-
throw 'Missing the required parameter "body" when calling
|
|
51531
|
+
throw 'Missing the required parameter "body" when calling putPresenceDefinition0';
|
|
50608
51532
|
}
|
|
50609
51533
|
|
|
50610
51534
|
return this.apiClient.callApi(
|
|
@@ -50768,7 +51692,7 @@ class ProcessAutomationApi {
|
|
|
50768
51692
|
/**
|
|
50769
51693
|
* ProcessAutomation service.
|
|
50770
51694
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
50771
|
-
* @version
|
|
51695
|
+
* @version 219.0.0
|
|
50772
51696
|
*/
|
|
50773
51697
|
|
|
50774
51698
|
/**
|
|
@@ -51007,7 +51931,7 @@ class QualityApi {
|
|
|
51007
51931
|
/**
|
|
51008
51932
|
* Quality service.
|
|
51009
51933
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
51010
|
-
* @version
|
|
51934
|
+
* @version 219.0.0
|
|
51011
51935
|
*/
|
|
51012
51936
|
|
|
51013
51937
|
/**
|
|
@@ -52794,7 +53718,7 @@ class RecordingApi {
|
|
|
52794
53718
|
/**
|
|
52795
53719
|
* Recording service.
|
|
52796
53720
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
52797
|
-
* @version
|
|
53721
|
+
* @version 219.0.0
|
|
52798
53722
|
*/
|
|
52799
53723
|
|
|
52800
53724
|
/**
|
|
@@ -54399,7 +55323,7 @@ class ResponseManagementApi {
|
|
|
54399
55323
|
/**
|
|
54400
55324
|
* ResponseManagement service.
|
|
54401
55325
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
54402
|
-
* @version
|
|
55326
|
+
* @version 219.0.0
|
|
54403
55327
|
*/
|
|
54404
55328
|
|
|
54405
55329
|
/**
|
|
@@ -54909,7 +55833,7 @@ class RoutingApi {
|
|
|
54909
55833
|
/**
|
|
54910
55834
|
* Routing service.
|
|
54911
55835
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
54912
|
-
* @version
|
|
55836
|
+
* @version 219.0.0
|
|
54913
55837
|
*/
|
|
54914
55838
|
|
|
54915
55839
|
/**
|
|
@@ -55819,7 +56743,7 @@ class RoutingApi {
|
|
|
55819
56743
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
55820
56744
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
55821
56745
|
* @param {Boolean} opts.excludeStatus Exclude MX record data (default to false)
|
|
55822
|
-
* @param {String} opts.filter Optional search filter
|
|
56746
|
+
* @param {String} opts.filter Optional search filter that, if defined, use the **filter** syntax, eg: **mySearchedPattern**. Note that **** is considered no filter.
|
|
55823
56747
|
*/
|
|
55824
56748
|
getRoutingEmailDomains(opts) {
|
|
55825
56749
|
opts = opts || {};
|
|
@@ -55918,7 +56842,9 @@ class RoutingApi {
|
|
|
55918
56842
|
* Get outbound domains
|
|
55919
56843
|
*
|
|
55920
56844
|
* @param {Object} opts Optional parameters
|
|
55921
|
-
* @param {
|
|
56845
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
56846
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
56847
|
+
* @param {String} opts.filter Optional search filter that, if defined, use the **filter** syntax, eg: **mySearchedPattern**. Note that **** is considered no filter.
|
|
55922
56848
|
*/
|
|
55923
56849
|
getRoutingEmailOutboundDomains(opts) {
|
|
55924
56850
|
opts = opts || {};
|
|
@@ -55928,7 +56854,7 @@ class RoutingApi {
|
|
|
55928
56854
|
'/api/v2/routing/email/outbound/domains',
|
|
55929
56855
|
'GET',
|
|
55930
56856
|
{ },
|
|
55931
|
-
{ 'filter': opts['filter'] },
|
|
56857
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'filter': opts['filter'] },
|
|
55932
56858
|
{ },
|
|
55933
56859
|
{ },
|
|
55934
56860
|
null,
|
|
@@ -59212,7 +60138,7 @@ class SCIMApi {
|
|
|
59212
60138
|
/**
|
|
59213
60139
|
* SCIM service.
|
|
59214
60140
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
59215
|
-
* @version
|
|
60141
|
+
* @version 219.0.0
|
|
59216
60142
|
*/
|
|
59217
60143
|
|
|
59218
60144
|
/**
|
|
@@ -60089,7 +61015,7 @@ class ScreenRecordingApi {
|
|
|
60089
61015
|
/**
|
|
60090
61016
|
* ScreenRecording service.
|
|
60091
61017
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
60092
|
-
* @version
|
|
61018
|
+
* @version 219.0.0
|
|
60093
61019
|
*/
|
|
60094
61020
|
|
|
60095
61021
|
/**
|
|
@@ -60134,7 +61060,7 @@ class ScriptsApi {
|
|
|
60134
61060
|
/**
|
|
60135
61061
|
* Scripts service.
|
|
60136
61062
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
60137
|
-
* @version
|
|
61063
|
+
* @version 219.0.0
|
|
60138
61064
|
*/
|
|
60139
61065
|
|
|
60140
61066
|
/**
|
|
@@ -60578,7 +61504,7 @@ class SearchApi {
|
|
|
60578
61504
|
/**
|
|
60579
61505
|
* Search service.
|
|
60580
61506
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
60581
|
-
* @version
|
|
61507
|
+
* @version 219.0.0
|
|
60582
61508
|
*/
|
|
60583
61509
|
|
|
60584
61510
|
/**
|
|
@@ -61321,7 +62247,7 @@ class SettingsApi {
|
|
|
61321
62247
|
/**
|
|
61322
62248
|
* Settings service.
|
|
61323
62249
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
61324
|
-
* @version
|
|
62250
|
+
* @version 219.0.0
|
|
61325
62251
|
*/
|
|
61326
62252
|
|
|
61327
62253
|
/**
|
|
@@ -61605,7 +62531,7 @@ class SocialMediaApi {
|
|
|
61605
62531
|
/**
|
|
61606
62532
|
* SocialMedia service.
|
|
61607
62533
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
61608
|
-
* @version
|
|
62534
|
+
* @version 219.0.0
|
|
61609
62535
|
*/
|
|
61610
62536
|
|
|
61611
62537
|
/**
|
|
@@ -62893,7 +63819,7 @@ class SpeechTextAnalyticsApi {
|
|
|
62893
63819
|
/**
|
|
62894
63820
|
* SpeechTextAnalytics service.
|
|
62895
63821
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
62896
|
-
* @version
|
|
63822
|
+
* @version 219.0.0
|
|
62897
63823
|
*/
|
|
62898
63824
|
|
|
62899
63825
|
/**
|
|
@@ -64334,7 +65260,7 @@ class StationsApi {
|
|
|
64334
65260
|
/**
|
|
64335
65261
|
* Stations service.
|
|
64336
65262
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
64337
|
-
* @version
|
|
65263
|
+
* @version 219.0.0
|
|
64338
65264
|
*/
|
|
64339
65265
|
|
|
64340
65266
|
/**
|
|
@@ -64436,7 +65362,7 @@ class SuggestApi {
|
|
|
64436
65362
|
/**
|
|
64437
65363
|
* Suggest service.
|
|
64438
65364
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
64439
|
-
* @version
|
|
65365
|
+
* @version 219.0.0
|
|
64440
65366
|
*/
|
|
64441
65367
|
|
|
64442
65368
|
/**
|
|
@@ -64575,7 +65501,7 @@ class TaskManagementApi {
|
|
|
64575
65501
|
/**
|
|
64576
65502
|
* TaskManagement service.
|
|
64577
65503
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
64578
|
-
* @version
|
|
65504
|
+
* @version 219.0.0
|
|
64579
65505
|
*/
|
|
64580
65506
|
|
|
64581
65507
|
/**
|
|
@@ -65450,6 +66376,71 @@ class TaskManagementApi {
|
|
|
65450
66376
|
);
|
|
65451
66377
|
}
|
|
65452
66378
|
|
|
66379
|
+
/**
|
|
66380
|
+
* Get the core types from which all schemas are built.
|
|
66381
|
+
*
|
|
66382
|
+
* @param {String} coreTypeName Name of the core type
|
|
66383
|
+
*/
|
|
66384
|
+
getTaskmanagementWorkitemsSchemasCoretype(coreTypeName) {
|
|
66385
|
+
// verify the required parameter 'coreTypeName' is set
|
|
66386
|
+
if (coreTypeName === undefined || coreTypeName === null) {
|
|
66387
|
+
throw 'Missing the required parameter "coreTypeName" when calling getTaskmanagementWorkitemsSchemasCoretype';
|
|
66388
|
+
}
|
|
66389
|
+
|
|
66390
|
+
return this.apiClient.callApi(
|
|
66391
|
+
'/api/v2/taskmanagement/workitems/schemas/coretypes/{coreTypeName}',
|
|
66392
|
+
'GET',
|
|
66393
|
+
{ 'coreTypeName': coreTypeName },
|
|
66394
|
+
{ },
|
|
66395
|
+
{ },
|
|
66396
|
+
{ },
|
|
66397
|
+
null,
|
|
66398
|
+
['PureCloud OAuth'],
|
|
66399
|
+
['application/json'],
|
|
66400
|
+
['application/json']
|
|
66401
|
+
);
|
|
66402
|
+
}
|
|
66403
|
+
|
|
66404
|
+
/**
|
|
66405
|
+
* Get the core types from which all schemas are built.
|
|
66406
|
+
*
|
|
66407
|
+
*/
|
|
66408
|
+
getTaskmanagementWorkitemsSchemasCoretypes() {
|
|
66409
|
+
|
|
66410
|
+
return this.apiClient.callApi(
|
|
66411
|
+
'/api/v2/taskmanagement/workitems/schemas/coretypes',
|
|
66412
|
+
'GET',
|
|
66413
|
+
{ },
|
|
66414
|
+
{ },
|
|
66415
|
+
{ },
|
|
66416
|
+
{ },
|
|
66417
|
+
null,
|
|
66418
|
+
['PureCloud OAuth'],
|
|
66419
|
+
['application/json'],
|
|
66420
|
+
['application/json']
|
|
66421
|
+
);
|
|
66422
|
+
}
|
|
66423
|
+
|
|
66424
|
+
/**
|
|
66425
|
+
* Get quantitative limits on schemas
|
|
66426
|
+
*
|
|
66427
|
+
*/
|
|
66428
|
+
getTaskmanagementWorkitemsSchemasLimits() {
|
|
66429
|
+
|
|
66430
|
+
return this.apiClient.callApi(
|
|
66431
|
+
'/api/v2/taskmanagement/workitems/schemas/limits',
|
|
66432
|
+
'GET',
|
|
66433
|
+
{ },
|
|
66434
|
+
{ },
|
|
66435
|
+
{ },
|
|
66436
|
+
{ },
|
|
66437
|
+
null,
|
|
66438
|
+
['PureCloud OAuth'],
|
|
66439
|
+
['application/json'],
|
|
66440
|
+
['application/json']
|
|
66441
|
+
);
|
|
66442
|
+
}
|
|
66443
|
+
|
|
65453
66444
|
/**
|
|
65454
66445
|
* Get a worktype
|
|
65455
66446
|
*
|
|
@@ -66681,7 +67672,7 @@ class TeamsApi {
|
|
|
66681
67672
|
/**
|
|
66682
67673
|
* Teams service.
|
|
66683
67674
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
66684
|
-
* @version
|
|
67675
|
+
* @version 219.0.0
|
|
66685
67676
|
*/
|
|
66686
67677
|
|
|
66687
67678
|
/**
|
|
@@ -66986,7 +67977,7 @@ class TelephonyApi {
|
|
|
66986
67977
|
/**
|
|
66987
67978
|
* Telephony service.
|
|
66988
67979
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
66989
|
-
* @version
|
|
67980
|
+
* @version 219.0.0
|
|
66990
67981
|
*/
|
|
66991
67982
|
|
|
66992
67983
|
/**
|
|
@@ -67168,7 +68159,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
67168
68159
|
/**
|
|
67169
68160
|
* TelephonyProvidersEdge service.
|
|
67170
68161
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
67171
|
-
* @version
|
|
68162
|
+
* @version 219.0.0
|
|
67172
68163
|
*/
|
|
67173
68164
|
|
|
67174
68165
|
/**
|
|
@@ -70620,7 +71611,7 @@ class TextbotsApi {
|
|
|
70620
71611
|
/**
|
|
70621
71612
|
* Textbots service.
|
|
70622
71613
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
70623
|
-
* @version
|
|
71614
|
+
* @version 219.0.0
|
|
70624
71615
|
*/
|
|
70625
71616
|
|
|
70626
71617
|
/**
|
|
@@ -70748,7 +71739,7 @@ class TokensApi {
|
|
|
70748
71739
|
/**
|
|
70749
71740
|
* Tokens service.
|
|
70750
71741
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
70751
|
-
* @version
|
|
71742
|
+
* @version 219.0.0
|
|
70752
71743
|
*/
|
|
70753
71744
|
|
|
70754
71745
|
/**
|
|
@@ -70902,7 +71893,7 @@ class UploadsApi {
|
|
|
70902
71893
|
/**
|
|
70903
71894
|
* Uploads service.
|
|
70904
71895
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
70905
|
-
* @version
|
|
71896
|
+
* @version 219.0.0
|
|
70906
71897
|
*/
|
|
70907
71898
|
|
|
70908
71899
|
/**
|
|
@@ -70947,6 +71938,31 @@ class UploadsApi {
|
|
|
70947
71938
|
);
|
|
70948
71939
|
}
|
|
70949
71940
|
|
|
71941
|
+
/**
|
|
71942
|
+
* Generates pre-signed URL to upload a prize image for gamification contests
|
|
71943
|
+
*
|
|
71944
|
+
* @param {Object} body query
|
|
71945
|
+
*/
|
|
71946
|
+
postGamificationContestsUploadsPrizeimages(body) {
|
|
71947
|
+
// verify the required parameter 'body' is set
|
|
71948
|
+
if (body === undefined || body === null) {
|
|
71949
|
+
throw 'Missing the required parameter "body" when calling postGamificationContestsUploadsPrizeimages';
|
|
71950
|
+
}
|
|
71951
|
+
|
|
71952
|
+
return this.apiClient.callApi(
|
|
71953
|
+
'/api/v2/gamification/contests/uploads/prizeimages',
|
|
71954
|
+
'POST',
|
|
71955
|
+
{ },
|
|
71956
|
+
{ },
|
|
71957
|
+
{ },
|
|
71958
|
+
{ },
|
|
71959
|
+
body,
|
|
71960
|
+
['PureCloud OAuth'],
|
|
71961
|
+
['application/json'],
|
|
71962
|
+
['application/json']
|
|
71963
|
+
);
|
|
71964
|
+
}
|
|
71965
|
+
|
|
70950
71966
|
/**
|
|
70951
71967
|
* Create upload presigned URL for draft function package file.
|
|
70952
71968
|
*
|
|
@@ -71168,7 +72184,7 @@ class UsageApi {
|
|
|
71168
72184
|
/**
|
|
71169
72185
|
* Usage service.
|
|
71170
72186
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
71171
|
-
* @version
|
|
72187
|
+
* @version 219.0.0
|
|
71172
72188
|
*/
|
|
71173
72189
|
|
|
71174
72190
|
/**
|
|
@@ -71383,7 +72399,7 @@ class UserRecordingsApi {
|
|
|
71383
72399
|
/**
|
|
71384
72400
|
* UserRecordings service.
|
|
71385
72401
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
71386
|
-
* @version
|
|
72402
|
+
* @version 219.0.0
|
|
71387
72403
|
*/
|
|
71388
72404
|
|
|
71389
72405
|
/**
|
|
@@ -71598,7 +72614,7 @@ class UsersApi {
|
|
|
71598
72614
|
/**
|
|
71599
72615
|
* Users service.
|
|
71600
72616
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
71601
|
-
* @version
|
|
72617
|
+
* @version 219.0.0
|
|
71602
72618
|
*/
|
|
71603
72619
|
|
|
71604
72620
|
/**
|
|
@@ -74551,7 +75567,7 @@ class UtilitiesApi {
|
|
|
74551
75567
|
/**
|
|
74552
75568
|
* Utilities service.
|
|
74553
75569
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
74554
|
-
* @version
|
|
75570
|
+
* @version 219.0.0
|
|
74555
75571
|
*/
|
|
74556
75572
|
|
|
74557
75573
|
/**
|
|
@@ -74662,7 +75678,7 @@ class VoicemailApi {
|
|
|
74662
75678
|
/**
|
|
74663
75679
|
* Voicemail service.
|
|
74664
75680
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
74665
|
-
* @version
|
|
75681
|
+
* @version 219.0.0
|
|
74666
75682
|
*/
|
|
74667
75683
|
|
|
74668
75684
|
/**
|
|
@@ -75384,7 +76400,7 @@ class WebChatApi {
|
|
|
75384
76400
|
/**
|
|
75385
76401
|
* WebChat service.
|
|
75386
76402
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
75387
|
-
* @version
|
|
76403
|
+
* @version 219.0.0
|
|
75388
76404
|
*/
|
|
75389
76405
|
|
|
75390
76406
|
/**
|
|
@@ -75944,7 +76960,7 @@ class WebDeploymentsApi {
|
|
|
75944
76960
|
/**
|
|
75945
76961
|
* WebDeployments service.
|
|
75946
76962
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
75947
|
-
* @version
|
|
76963
|
+
* @version 219.0.0
|
|
75948
76964
|
*/
|
|
75949
76965
|
|
|
75950
76966
|
/**
|
|
@@ -76528,7 +77544,7 @@ class WebMessagingApi {
|
|
|
76528
77544
|
/**
|
|
76529
77545
|
* WebMessaging service.
|
|
76530
77546
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
76531
|
-
* @version
|
|
77547
|
+
* @version 219.0.0
|
|
76532
77548
|
*/
|
|
76533
77549
|
|
|
76534
77550
|
/**
|
|
@@ -76574,7 +77590,7 @@ class WidgetsApi {
|
|
|
76574
77590
|
/**
|
|
76575
77591
|
* Widgets service.
|
|
76576
77592
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
76577
|
-
* @version
|
|
77593
|
+
* @version 219.0.0
|
|
76578
77594
|
*/
|
|
76579
77595
|
|
|
76580
77596
|
/**
|
|
@@ -76725,7 +77741,7 @@ class WorkforceManagementApi {
|
|
|
76725
77741
|
/**
|
|
76726
77742
|
* WorkforceManagement service.
|
|
76727
77743
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
76728
|
-
* @version
|
|
77744
|
+
* @version 219.0.0
|
|
76729
77745
|
*/
|
|
76730
77746
|
|
|
76731
77747
|
/**
|
|
@@ -79295,8 +80311,9 @@ class WorkforceManagementApi {
|
|
|
79295
80311
|
}
|
|
79296
80312
|
|
|
79297
80313
|
/**
|
|
79298
|
-
* Retrieves delete job status for historical data imports of the organization
|
|
79299
|
-
*
|
|
80314
|
+
* Retrieves delete job status for historical data imports of the organization.
|
|
80315
|
+
* Deprecated: Please use GET /workforcemanagement/historicaldata/bulk/remove/jobs instead.
|
|
80316
|
+
* @deprecated
|
|
79300
80317
|
*/
|
|
79301
80318
|
getWorkforcemanagementHistoricaldataDeletejob() {
|
|
79302
80319
|
|
|
@@ -82868,8 +83885,9 @@ class WorkforceManagementApi {
|
|
|
82868
83885
|
}
|
|
82869
83886
|
|
|
82870
83887
|
/**
|
|
82871
|
-
* Delete the entries of the historical data imports in the organization
|
|
82872
|
-
*
|
|
83888
|
+
* Delete the entries of the historical data imports in the organization.
|
|
83889
|
+
* Deprecated: Please use POST /workforcemanagement/historicaldata/bulk/remove/jobs instead.
|
|
83890
|
+
* @deprecated
|
|
82873
83891
|
*/
|
|
82874
83892
|
postWorkforcemanagementHistoricaldataDeletejob() {
|
|
82875
83893
|
|
|
@@ -84118,7 +85136,7 @@ class WorkforceManagementApi {
|
|
|
84118
85136
|
* </pre>
|
|
84119
85137
|
* </p>
|
|
84120
85138
|
* @module purecloud-platform-client-v2/index
|
|
84121
|
-
* @version
|
|
85139
|
+
* @version 219.0.0
|
|
84122
85140
|
*/
|
|
84123
85141
|
class platformClient {
|
|
84124
85142
|
constructor() {
|