purecloud-platform-client-v2 168.1.0 → 169.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 +2 -35
- package/dist/node/purecloud-platform-client-v2.js +281 -84
- package/dist/web-amd/purecloud-platform-client-v2.js +281 -84
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +281 -84
- package/dist/web-cjs/purecloud-platform-client-v2.js +329 -111
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +230 -77
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/AuditApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +4 -2
- package/src/purecloud-platform-client-v2/api/BillingApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/ChatApi.js +5 -2
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +3 -2
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +3 -3
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/EventsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/FaxApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +5 -2
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +24 -4
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +6 -2
- package/src/purecloud-platform-client-v2/api/LearningApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +12 -7
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +60 -8
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +3 -2
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/QualityApi.js +11 -2
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +7 -2
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/SearchApi.js +3 -2
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +26 -2
- package/src/purecloud-platform-client-v2/api/StationsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +3 -2
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/TokensApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/UsageApi.js +52 -2
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/UsersApi.js +8 -2
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +7 -2
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +7 -2
- package/src/purecloud-platform-client-v2/index.js +1 -1
package/dist/web-cjs/bundle.js
CHANGED
|
@@ -2279,7 +2279,7 @@ class Configuration {
|
|
|
2279
2279
|
|
|
2280
2280
|
/**
|
|
2281
2281
|
* @module purecloud-platform-client-v2/ApiClient
|
|
2282
|
-
* @version
|
|
2282
|
+
* @version 169.0.0
|
|
2283
2283
|
*/
|
|
2284
2284
|
class ApiClient {
|
|
2285
2285
|
/**
|
|
@@ -3358,7 +3358,7 @@ class AlertingApi {
|
|
|
3358
3358
|
/**
|
|
3359
3359
|
* Alerting service.
|
|
3360
3360
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
3361
|
-
* @version
|
|
3361
|
+
* @version 169.0.0
|
|
3362
3362
|
*/
|
|
3363
3363
|
|
|
3364
3364
|
/**
|
|
@@ -3672,7 +3672,7 @@ class AnalyticsApi {
|
|
|
3672
3672
|
/**
|
|
3673
3673
|
* Analytics service.
|
|
3674
3674
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
3675
|
-
* @version
|
|
3675
|
+
* @version 169.0.0
|
|
3676
3676
|
*/
|
|
3677
3677
|
|
|
3678
3678
|
/**
|
|
@@ -4926,7 +4926,7 @@ class ArchitectApi {
|
|
|
4926
4926
|
/**
|
|
4927
4927
|
* Architect service.
|
|
4928
4928
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
4929
|
-
* @version
|
|
4929
|
+
* @version 169.0.0
|
|
4930
4930
|
*/
|
|
4931
4931
|
|
|
4932
4932
|
/**
|
|
@@ -7974,7 +7974,7 @@ class AuditApi {
|
|
|
7974
7974
|
/**
|
|
7975
7975
|
* Audit service.
|
|
7976
7976
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
7977
|
-
* @version
|
|
7977
|
+
* @version 169.0.0
|
|
7978
7978
|
*/
|
|
7979
7979
|
|
|
7980
7980
|
/**
|
|
@@ -8145,7 +8145,7 @@ class AuthorizationApi {
|
|
|
8145
8145
|
/**
|
|
8146
8146
|
* Authorization service.
|
|
8147
8147
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
8148
|
-
* @version
|
|
8148
|
+
* @version 169.0.0
|
|
8149
8149
|
*/
|
|
8150
8150
|
|
|
8151
8151
|
/**
|
|
@@ -8386,6 +8386,7 @@ class AuthorizationApi {
|
|
|
8386
8386
|
* @param {String} permission The permission string, including the object to access, e.g. routing:queue:view
|
|
8387
8387
|
* @param {Object} opts Optional parameters
|
|
8388
8388
|
* @param {String} opts.name Search term to filter by division name
|
|
8389
|
+
* @deprecated
|
|
8389
8390
|
*/
|
|
8390
8391
|
getAuthorizationDivisionspermittedMe(permission, opts) {
|
|
8391
8392
|
opts = opts || {};
|
|
@@ -8447,6 +8448,7 @@ class AuthorizationApi {
|
|
|
8447
8448
|
* @param {Object} opts Optional parameters
|
|
8448
8449
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
8449
8450
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
8451
|
+
* @deprecated
|
|
8450
8452
|
*/
|
|
8451
8453
|
getAuthorizationDivisionspermittedPagedSubjectId(subjectId, permission, opts) {
|
|
8452
8454
|
opts = opts || {};
|
|
@@ -9374,7 +9376,7 @@ class BillingApi {
|
|
|
9374
9376
|
/**
|
|
9375
9377
|
* Billing service.
|
|
9376
9378
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
9377
|
-
* @version
|
|
9379
|
+
* @version 169.0.0
|
|
9378
9380
|
*/
|
|
9379
9381
|
|
|
9380
9382
|
/**
|
|
@@ -9454,7 +9456,7 @@ class CarrierServicesApi {
|
|
|
9454
9456
|
/**
|
|
9455
9457
|
* CarrierServices service.
|
|
9456
9458
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
9457
|
-
* @version
|
|
9459
|
+
* @version 169.0.0
|
|
9458
9460
|
*/
|
|
9459
9461
|
|
|
9460
9462
|
/**
|
|
@@ -9524,7 +9526,7 @@ class ChatApi {
|
|
|
9524
9526
|
/**
|
|
9525
9527
|
* Chat service.
|
|
9526
9528
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
9527
|
-
* @version
|
|
9529
|
+
* @version 169.0.0
|
|
9528
9530
|
*/
|
|
9529
9531
|
|
|
9530
9532
|
/**
|
|
@@ -9542,6 +9544,7 @@ class ChatApi {
|
|
|
9542
9544
|
/**
|
|
9543
9545
|
* Get Chat Settings.
|
|
9544
9546
|
* This route is deprecated, please use /chats/settings instead
|
|
9547
|
+
* @deprecated
|
|
9545
9548
|
*/
|
|
9546
9549
|
getChatSettings() {
|
|
9547
9550
|
|
|
@@ -9583,6 +9586,7 @@ class ChatApi {
|
|
|
9583
9586
|
* Patch Chat Settings.
|
|
9584
9587
|
* This route is deprecated, please use /chats/settings instead
|
|
9585
9588
|
* @param {Object} body Chat
|
|
9589
|
+
* @deprecated
|
|
9586
9590
|
*/
|
|
9587
9591
|
patchChatSettings(body) {
|
|
9588
9592
|
// verify the required parameter 'body' is set
|
|
@@ -9633,6 +9637,7 @@ class ChatApi {
|
|
|
9633
9637
|
* Update Chat Settings.
|
|
9634
9638
|
* This route is deprecated, please use /chats/settings instead
|
|
9635
9639
|
* @param {Object} body Chat
|
|
9640
|
+
* @deprecated
|
|
9636
9641
|
*/
|
|
9637
9642
|
putChatSettings(body) {
|
|
9638
9643
|
// verify the required parameter 'body' is set
|
|
@@ -9685,7 +9690,7 @@ class CoachingApi {
|
|
|
9685
9690
|
/**
|
|
9686
9691
|
* Coaching service.
|
|
9687
9692
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
9688
|
-
* @version
|
|
9693
|
+
* @version 169.0.0
|
|
9689
9694
|
*/
|
|
9690
9695
|
|
|
9691
9696
|
/**
|
|
@@ -10262,7 +10267,7 @@ class ContentManagementApi {
|
|
|
10262
10267
|
/**
|
|
10263
10268
|
* ContentManagement service.
|
|
10264
10269
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
10265
|
-
* @version
|
|
10270
|
+
* @version 169.0.0
|
|
10266
10271
|
*/
|
|
10267
10272
|
|
|
10268
10273
|
/**
|
|
@@ -10549,6 +10554,7 @@ class ContentManagementApi {
|
|
|
10549
10554
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
10550
10555
|
* @param {String} opts.sortBy name or dateCreated
|
|
10551
10556
|
* @param {String} opts.sortOrder ascending or descending (default to ascending)
|
|
10557
|
+
* @deprecated
|
|
10552
10558
|
*/
|
|
10553
10559
|
getContentmanagementDocuments(workspaceId, opts) {
|
|
10554
10560
|
opts = opts || {};
|
|
@@ -11402,7 +11408,7 @@ class ConversationsApi {
|
|
|
11402
11408
|
/**
|
|
11403
11409
|
* Conversations service.
|
|
11404
11410
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
11405
|
-
* @version
|
|
11411
|
+
* @version 169.0.0
|
|
11406
11412
|
*/
|
|
11407
11413
|
|
|
11408
11414
|
/**
|
|
@@ -16607,7 +16613,7 @@ class ConversationsApi {
|
|
|
16607
16613
|
|
|
16608
16614
|
/**
|
|
16609
16615
|
* Send an agentless outbound message
|
|
16610
|
-
* Send an agentless (api participant) outbound message using a client credential grant. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope.
|
|
16616
|
+
* Send an agentless (api participant) outbound message using a client credential grant. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. If there is already a connected conversation between the fromAddress and toAddress specified, the useExistingActiveConversation param can be used to barge in to the ongoing conversation.
|
|
16611
16617
|
* @param {Object} body Create agentless outbound messaging request
|
|
16612
16618
|
*/
|
|
16613
16619
|
postConversationsMessagesAgentless(body) {
|
|
@@ -17493,7 +17499,7 @@ class DataExtensionsApi {
|
|
|
17493
17499
|
/**
|
|
17494
17500
|
* DataExtensions service.
|
|
17495
17501
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
17496
|
-
* @version
|
|
17502
|
+
* @version 169.0.0
|
|
17497
17503
|
*/
|
|
17498
17504
|
|
|
17499
17505
|
/**
|
|
@@ -17579,7 +17585,7 @@ class DownloadsApi {
|
|
|
17579
17585
|
/**
|
|
17580
17586
|
* Downloads service.
|
|
17581
17587
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
17582
|
-
* @version
|
|
17588
|
+
* @version 169.0.0
|
|
17583
17589
|
*/
|
|
17584
17590
|
|
|
17585
17591
|
/**
|
|
@@ -17631,7 +17637,7 @@ class EventsApi {
|
|
|
17631
17637
|
/**
|
|
17632
17638
|
* Events service.
|
|
17633
17639
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
17634
|
-
* @version
|
|
17640
|
+
* @version 169.0.0
|
|
17635
17641
|
*/
|
|
17636
17642
|
|
|
17637
17643
|
/**
|
|
@@ -17727,7 +17733,7 @@ class ExternalContactsApi {
|
|
|
17727
17733
|
/**
|
|
17728
17734
|
* ExternalContacts service.
|
|
17729
17735
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
17730
|
-
* @version
|
|
17736
|
+
* @version 169.0.0
|
|
17731
17737
|
*/
|
|
17732
17738
|
|
|
17733
17739
|
/**
|
|
@@ -19685,7 +19691,7 @@ class FaxApi {
|
|
|
19685
19691
|
/**
|
|
19686
19692
|
* Fax service.
|
|
19687
19693
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
19688
|
-
* @version
|
|
19694
|
+
* @version 169.0.0
|
|
19689
19695
|
*/
|
|
19690
19696
|
|
|
19691
19697
|
/**
|
|
@@ -19856,7 +19862,7 @@ class FlowsApi {
|
|
|
19856
19862
|
/**
|
|
19857
19863
|
* Flows service.
|
|
19858
19864
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
19859
|
-
* @version
|
|
19865
|
+
* @version 169.0.0
|
|
19860
19866
|
*/
|
|
19861
19867
|
|
|
19862
19868
|
/**
|
|
@@ -19927,7 +19933,7 @@ class GamificationApi {
|
|
|
19927
19933
|
/**
|
|
19928
19934
|
* Gamification service.
|
|
19929
19935
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
19930
|
-
* @version
|
|
19936
|
+
* @version 169.0.0
|
|
19931
19937
|
*/
|
|
19932
19938
|
|
|
19933
19939
|
/**
|
|
@@ -22013,7 +22019,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
22013
22019
|
/**
|
|
22014
22020
|
* GeneralDataProtectionRegulation service.
|
|
22015
22021
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
22016
|
-
* @version
|
|
22022
|
+
* @version 169.0.0
|
|
22017
22023
|
*/
|
|
22018
22024
|
|
|
22019
22025
|
/**
|
|
@@ -22143,7 +22149,7 @@ class GeolocationApi {
|
|
|
22143
22149
|
/**
|
|
22144
22150
|
* Geolocation service.
|
|
22145
22151
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
22146
|
-
* @version
|
|
22152
|
+
* @version 169.0.0
|
|
22147
22153
|
*/
|
|
22148
22154
|
|
|
22149
22155
|
/**
|
|
@@ -22274,7 +22280,7 @@ class GreetingsApi {
|
|
|
22274
22280
|
/**
|
|
22275
22281
|
* Greetings service.
|
|
22276
22282
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
22277
|
-
* @version
|
|
22283
|
+
* @version 169.0.0
|
|
22278
22284
|
*/
|
|
22279
22285
|
|
|
22280
22286
|
/**
|
|
@@ -22729,7 +22735,7 @@ class GroupsApi {
|
|
|
22729
22735
|
/**
|
|
22730
22736
|
* Groups service.
|
|
22731
22737
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
22732
|
-
* @version
|
|
22738
|
+
* @version 169.0.0
|
|
22733
22739
|
*/
|
|
22734
22740
|
|
|
22735
22741
|
/**
|
|
@@ -22803,6 +22809,7 @@ class GroupsApi {
|
|
|
22803
22809
|
* Fetch field config for an entity type
|
|
22804
22810
|
*
|
|
22805
22811
|
* @param {Object} type Field type
|
|
22812
|
+
* @deprecated
|
|
22806
22813
|
*/
|
|
22807
22814
|
getFieldconfig(type) {
|
|
22808
22815
|
// verify the required parameter 'type' is set
|
|
@@ -22912,6 +22919,7 @@ class GroupsApi {
|
|
|
22912
22919
|
* @param {String} groupId groupId
|
|
22913
22920
|
* @param {Object} opts Optional parameters
|
|
22914
22921
|
* @param {String} opts.fields Comma separated fields to return. Allowable values can be found by querying /api/v2/fieldconfig?type=group and using the key for the elements returned by the fieldList
|
|
22922
|
+
* @deprecated
|
|
22915
22923
|
*/
|
|
22916
22924
|
getGroupProfile(groupId, opts) {
|
|
22917
22925
|
opts = opts || {};
|
|
@@ -23001,6 +23009,7 @@ class GroupsApi {
|
|
|
23001
23009
|
* @param {Array.<String>} opts.id id
|
|
23002
23010
|
* @param {Array.<String>} opts.jabberId A list of jabberIds to fetch by bulk (cannot be used with the id parameter)
|
|
23003
23011
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
|
|
23012
|
+
* @deprecated
|
|
23004
23013
|
*/
|
|
23005
23014
|
getProfilesGroups(opts) {
|
|
23006
23015
|
opts = opts || {};
|
|
@@ -23135,7 +23144,7 @@ class IdentityProviderApi {
|
|
|
23135
23144
|
/**
|
|
23136
23145
|
* IdentityProvider service.
|
|
23137
23146
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
23138
|
-
* @version
|
|
23147
|
+
* @version 169.0.0
|
|
23139
23148
|
*/
|
|
23140
23149
|
|
|
23141
23150
|
/**
|
|
@@ -23891,7 +23900,7 @@ class InfrastructureAsCodeApi {
|
|
|
23891
23900
|
/**
|
|
23892
23901
|
* InfrastructureAsCode service.
|
|
23893
23902
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
23894
|
-
* @version
|
|
23903
|
+
* @version 169.0.0
|
|
23895
23904
|
*/
|
|
23896
23905
|
|
|
23897
23906
|
/**
|
|
@@ -24058,7 +24067,7 @@ class IntegrationsApi {
|
|
|
24058
24067
|
/**
|
|
24059
24068
|
* Integrations service.
|
|
24060
24069
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
24061
|
-
* @version
|
|
24070
|
+
* @version 169.0.0
|
|
24062
24071
|
*/
|
|
24063
24072
|
|
|
24064
24073
|
/**
|
|
@@ -25658,7 +25667,7 @@ class JourneyApi {
|
|
|
25658
25667
|
/**
|
|
25659
25668
|
* Journey service.
|
|
25660
25669
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
25661
|
-
* @version
|
|
25670
|
+
* @version 169.0.0
|
|
25662
25671
|
*/
|
|
25663
25672
|
|
|
25664
25673
|
/**
|
|
@@ -26538,7 +26547,7 @@ class KnowledgeApi {
|
|
|
26538
26547
|
/**
|
|
26539
26548
|
* Knowledge service.
|
|
26540
26549
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
26541
|
-
* @version
|
|
26550
|
+
* @version 169.0.0
|
|
26542
26551
|
*/
|
|
26543
26552
|
|
|
26544
26553
|
/**
|
|
@@ -26769,6 +26778,7 @@ class KnowledgeApi {
|
|
|
26769
26778
|
* @param {String} categoryId Category ID
|
|
26770
26779
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
26771
26780
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
26781
|
+
* @deprecated
|
|
26772
26782
|
*/
|
|
26773
26783
|
deleteKnowledgeKnowledgebaseLanguageCategory(categoryId, knowledgeBaseId, languageCode) {
|
|
26774
26784
|
// verify the required parameter 'categoryId' is set
|
|
@@ -26804,6 +26814,7 @@ class KnowledgeApi {
|
|
|
26804
26814
|
* @param {String} documentId Document ID
|
|
26805
26815
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
26806
26816
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
26817
|
+
* @deprecated
|
|
26807
26818
|
*/
|
|
26808
26819
|
deleteKnowledgeKnowledgebaseLanguageDocument(documentId, knowledgeBaseId, languageCode) {
|
|
26809
26820
|
// verify the required parameter 'documentId' is set
|
|
@@ -26839,6 +26850,7 @@ class KnowledgeApi {
|
|
|
26839
26850
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
26840
26851
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
26841
26852
|
* @param {String} importId Import ID
|
|
26853
|
+
* @deprecated
|
|
26842
26854
|
*/
|
|
26843
26855
|
deleteKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId, languageCode, importId) {
|
|
26844
26856
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -27497,6 +27509,7 @@ class KnowledgeApi {
|
|
|
27497
27509
|
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
27498
27510
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
27499
27511
|
* @param {String} opts.name Filter to return the categories that starts with the given category name.
|
|
27512
|
+
* @deprecated
|
|
27500
27513
|
*/
|
|
27501
27514
|
getKnowledgeKnowledgebaseLanguageCategories(knowledgeBaseId, languageCode, opts) {
|
|
27502
27515
|
opts = opts || {};
|
|
@@ -27530,6 +27543,7 @@ class KnowledgeApi {
|
|
|
27530
27543
|
* @param {String} categoryId Category ID
|
|
27531
27544
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
27532
27545
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
27546
|
+
* @deprecated
|
|
27533
27547
|
*/
|
|
27534
27548
|
getKnowledgeKnowledgebaseLanguageCategory(categoryId, knowledgeBaseId, languageCode) {
|
|
27535
27549
|
// verify the required parameter 'categoryId' is set
|
|
@@ -27565,6 +27579,7 @@ class KnowledgeApi {
|
|
|
27565
27579
|
* @param {String} documentId Document ID
|
|
27566
27580
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
27567
27581
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
27582
|
+
* @deprecated
|
|
27568
27583
|
*/
|
|
27569
27584
|
getKnowledgeKnowledgebaseLanguageDocument(documentId, knowledgeBaseId, languageCode) {
|
|
27570
27585
|
// verify the required parameter 'documentId' is set
|
|
@@ -27609,6 +27624,7 @@ class KnowledgeApi {
|
|
|
27609
27624
|
* @param {Object} opts.sortBy Sort by.
|
|
27610
27625
|
* @param {Object} opts.sortOrder Sort Order.
|
|
27611
27626
|
* @param {Array.<String>} opts.documentIds Comma-separated list of document identifiers to fetch by.
|
|
27627
|
+
* @deprecated
|
|
27612
27628
|
*/
|
|
27613
27629
|
getKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, opts) {
|
|
27614
27630
|
opts = opts || {};
|
|
@@ -27642,6 +27658,7 @@ class KnowledgeApi {
|
|
|
27642
27658
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
27643
27659
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
27644
27660
|
* @param {String} importId Import ID
|
|
27661
|
+
* @deprecated
|
|
27645
27662
|
*/
|
|
27646
27663
|
getKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId, languageCode, importId) {
|
|
27647
27664
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -27677,6 +27694,7 @@ class KnowledgeApi {
|
|
|
27677
27694
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
27678
27695
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
27679
27696
|
* @param {String} trainingId Training ID
|
|
27697
|
+
* @deprecated
|
|
27680
27698
|
*/
|
|
27681
27699
|
getKnowledgeKnowledgebaseLanguageTraining(knowledgeBaseId, languageCode, trainingId) {
|
|
27682
27700
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -27717,6 +27735,7 @@ class KnowledgeApi {
|
|
|
27717
27735
|
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
27718
27736
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
27719
27737
|
* @param {Object} opts.knowledgeDocumentsState Return the training with the specified state of the trained documents.
|
|
27738
|
+
* @deprecated
|
|
27720
27739
|
*/
|
|
27721
27740
|
getKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId, languageCode, opts) {
|
|
27722
27741
|
opts = opts || {};
|
|
@@ -27852,8 +27871,8 @@ class KnowledgeApi {
|
|
|
27852
27871
|
* @param {Object} opts Optional parameters
|
|
27853
27872
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
27854
27873
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
27855
|
-
* @param {String} opts.limit Number of entities to return. Maximum of
|
|
27856
|
-
* @param {String} opts.pageSize Number of entities to return. Maximum of
|
|
27874
|
+
* @param {String} opts.limit Number of entities to return. Maximum of 100. Deprecated in favour of pageSize
|
|
27875
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 100.
|
|
27857
27876
|
* @param {String} opts.name Filter by Name.
|
|
27858
27877
|
* @param {Object} opts.coreLanguage Filter by core language.
|
|
27859
27878
|
* @param {Boolean} opts.published Filter by published status.
|
|
@@ -28164,6 +28183,7 @@ class KnowledgeApi {
|
|
|
28164
28183
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
28165
28184
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
28166
28185
|
* @param {Object} body
|
|
28186
|
+
* @deprecated
|
|
28167
28187
|
*/
|
|
28168
28188
|
patchKnowledgeKnowledgebaseLanguageCategory(categoryId, knowledgeBaseId, languageCode, body) {
|
|
28169
28189
|
// verify the required parameter 'categoryId' is set
|
|
@@ -28204,6 +28224,7 @@ class KnowledgeApi {
|
|
|
28204
28224
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
28205
28225
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
28206
28226
|
* @param {Object} body
|
|
28227
|
+
* @deprecated
|
|
28207
28228
|
*/
|
|
28208
28229
|
patchKnowledgeKnowledgebaseLanguageDocument(documentId, knowledgeBaseId, languageCode, body) {
|
|
28209
28230
|
// verify the required parameter 'documentId' is set
|
|
@@ -28243,6 +28264,7 @@ class KnowledgeApi {
|
|
|
28243
28264
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
28244
28265
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
28245
28266
|
* @param {Array.<Object>} body
|
|
28267
|
+
* @deprecated
|
|
28246
28268
|
*/
|
|
28247
28269
|
patchKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, body) {
|
|
28248
28270
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -28279,6 +28301,7 @@ class KnowledgeApi {
|
|
|
28279
28301
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
28280
28302
|
* @param {String} importId Import ID
|
|
28281
28303
|
* @param {Object} body
|
|
28304
|
+
* @deprecated
|
|
28282
28305
|
*/
|
|
28283
28306
|
patchKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId, languageCode, importId, body) {
|
|
28284
28307
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -28746,6 +28769,7 @@ class KnowledgeApi {
|
|
|
28746
28769
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
28747
28770
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
28748
28771
|
* @param {Object} body
|
|
28772
|
+
* @deprecated
|
|
28749
28773
|
*/
|
|
28750
28774
|
postKnowledgeKnowledgebaseLanguageCategories(knowledgeBaseId, languageCode, body) {
|
|
28751
28775
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -28781,6 +28805,7 @@ class KnowledgeApi {
|
|
|
28781
28805
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
28782
28806
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
28783
28807
|
* @param {Object} body
|
|
28808
|
+
* @deprecated
|
|
28784
28809
|
*/
|
|
28785
28810
|
postKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, body) {
|
|
28786
28811
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -28816,6 +28841,7 @@ class KnowledgeApi {
|
|
|
28816
28841
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
28817
28842
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
28818
28843
|
* @param {Object} body
|
|
28844
|
+
* @deprecated
|
|
28819
28845
|
*/
|
|
28820
28846
|
postKnowledgeKnowledgebaseLanguageDocumentsImports(knowledgeBaseId, languageCode, body) {
|
|
28821
28847
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -28851,6 +28877,7 @@ class KnowledgeApi {
|
|
|
28851
28877
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
28852
28878
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
28853
28879
|
* @param {String} trainingId Training ID
|
|
28880
|
+
* @deprecated
|
|
28854
28881
|
*/
|
|
28855
28882
|
postKnowledgeKnowledgebaseLanguageTrainingPromote(knowledgeBaseId, languageCode, trainingId) {
|
|
28856
28883
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -28885,6 +28912,7 @@ class KnowledgeApi {
|
|
|
28885
28912
|
*
|
|
28886
28913
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
28887
28914
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
28915
|
+
* @deprecated
|
|
28888
28916
|
*/
|
|
28889
28917
|
postKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId, languageCode) {
|
|
28890
28918
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -28916,6 +28944,7 @@ class KnowledgeApi {
|
|
|
28916
28944
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
28917
28945
|
* @param {Object} opts Optional parameters
|
|
28918
28946
|
* @param {Object} opts.body
|
|
28947
|
+
* @deprecated
|
|
28919
28948
|
*/
|
|
28920
28949
|
postKnowledgeKnowledgebaseSearch(knowledgeBaseId, opts) {
|
|
28921
28950
|
opts = opts || {};
|
|
@@ -28970,7 +28999,7 @@ class LanguageUnderstandingApi {
|
|
|
28970
28999
|
/**
|
|
28971
29000
|
* LanguageUnderstanding service.
|
|
28972
29001
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
28973
|
-
* @version
|
|
29002
|
+
* @version 169.0.0
|
|
28974
29003
|
*/
|
|
28975
29004
|
|
|
28976
29005
|
/**
|
|
@@ -29983,7 +30012,7 @@ class LanguagesApi {
|
|
|
29983
30012
|
/**
|
|
29984
30013
|
* Languages service.
|
|
29985
30014
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
29986
|
-
* @version
|
|
30015
|
+
* @version 169.0.0
|
|
29987
30016
|
*/
|
|
29988
30017
|
|
|
29989
30018
|
/**
|
|
@@ -30002,6 +30031,7 @@ class LanguagesApi {
|
|
|
30002
30031
|
* Delete Language (Deprecated)
|
|
30003
30032
|
* This endpoint is deprecated. Please see the Routing API (DELETE /api/v2/routing/languages/{languageId})
|
|
30004
30033
|
* @param {String} languageId Language ID
|
|
30034
|
+
* @deprecated
|
|
30005
30035
|
*/
|
|
30006
30036
|
deleteLanguage(languageId) {
|
|
30007
30037
|
// verify the required parameter 'languageId' is set
|
|
@@ -30027,6 +30057,7 @@ class LanguagesApi {
|
|
|
30027
30057
|
* Get Language (Deprecated)
|
|
30028
30058
|
* This endpoint is deprecated. Please see the Routing API (GET /api/v2/routing/languages/{languageId})
|
|
30029
30059
|
* @param {String} languageId Language ID
|
|
30060
|
+
* @deprecated
|
|
30030
30061
|
*/
|
|
30031
30062
|
getLanguage(languageId) {
|
|
30032
30063
|
// verify the required parameter 'languageId' is set
|
|
@@ -30056,6 +30087,7 @@ class LanguagesApi {
|
|
|
30056
30087
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
30057
30088
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
|
|
30058
30089
|
* @param {String} opts.name Name
|
|
30090
|
+
* @deprecated
|
|
30059
30091
|
*/
|
|
30060
30092
|
getLanguages(opts) {
|
|
30061
30093
|
opts = opts || {};
|
|
@@ -30174,6 +30206,7 @@ class LanguagesApi {
|
|
|
30174
30206
|
* Create Language (Deprecated)
|
|
30175
30207
|
* This endpoint is deprecated. Please see the Routing API. (POST /api/v2/routing/languages
|
|
30176
30208
|
* @param {Object} body Language
|
|
30209
|
+
* @deprecated
|
|
30177
30210
|
*/
|
|
30178
30211
|
postLanguages(body) {
|
|
30179
30212
|
// verify the required parameter 'body' is set
|
|
@@ -30201,7 +30234,7 @@ class LearningApi {
|
|
|
30201
30234
|
/**
|
|
30202
30235
|
* Learning service.
|
|
30203
30236
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
30204
|
-
* @version
|
|
30237
|
+
* @version 169.0.0
|
|
30205
30238
|
*/
|
|
30206
30239
|
|
|
30207
30240
|
/**
|
|
@@ -31016,7 +31049,7 @@ class LicenseApi {
|
|
|
31016
31049
|
/**
|
|
31017
31050
|
* License service.
|
|
31018
31051
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
31019
|
-
* @version
|
|
31052
|
+
* @version 169.0.0
|
|
31020
31053
|
*/
|
|
31021
31054
|
|
|
31022
31055
|
/**
|
|
@@ -31254,7 +31287,7 @@ class LocationsApi {
|
|
|
31254
31287
|
/**
|
|
31255
31288
|
* Locations service.
|
|
31256
31289
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
31257
|
-
* @version
|
|
31290
|
+
* @version 169.0.0
|
|
31258
31291
|
*/
|
|
31259
31292
|
|
|
31260
31293
|
/**
|
|
@@ -31490,7 +31523,7 @@ class MessagingApi {
|
|
|
31490
31523
|
/**
|
|
31491
31524
|
* Messaging service.
|
|
31492
31525
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
31493
|
-
* @version
|
|
31526
|
+
* @version 169.0.0
|
|
31494
31527
|
*/
|
|
31495
31528
|
|
|
31496
31529
|
/**
|
|
@@ -31507,8 +31540,9 @@ class MessagingApi {
|
|
|
31507
31540
|
|
|
31508
31541
|
/**
|
|
31509
31542
|
* Delete a supported content profile
|
|
31510
|
-
*
|
|
31543
|
+
* Deprecated - use DELETE /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
|
|
31511
31544
|
* @param {String} supportedContentId Supported Content ID
|
|
31545
|
+
* @deprecated
|
|
31512
31546
|
*/
|
|
31513
31547
|
deleteMessagingSupportedcontentSupportedContentId(supportedContentId) {
|
|
31514
31548
|
// verify the required parameter 'supportedContentId' is set
|
|
@@ -31532,10 +31566,11 @@ class MessagingApi {
|
|
|
31532
31566
|
|
|
31533
31567
|
/**
|
|
31534
31568
|
* Get a list of Supported Content profiles
|
|
31535
|
-
*
|
|
31569
|
+
* Deprecated - use GET /api/v2/conversations/messaging/supportedcontent as replacement
|
|
31536
31570
|
* @param {Object} opts Optional parameters
|
|
31537
31571
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
31538
31572
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
31573
|
+
* @deprecated
|
|
31539
31574
|
*/
|
|
31540
31575
|
getMessagingSupportedcontent(opts) {
|
|
31541
31576
|
opts = opts || {};
|
|
@@ -31557,8 +31592,9 @@ class MessagingApi {
|
|
|
31557
31592
|
|
|
31558
31593
|
/**
|
|
31559
31594
|
* Get a supported content profile
|
|
31560
|
-
*
|
|
31595
|
+
* Deprecated - use GET /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
|
|
31561
31596
|
* @param {String} supportedContentId Supported Content ID
|
|
31597
|
+
* @deprecated
|
|
31562
31598
|
*/
|
|
31563
31599
|
getMessagingSupportedcontentSupportedContentId(supportedContentId) {
|
|
31564
31600
|
// verify the required parameter 'supportedContentId' is set
|
|
@@ -31582,9 +31618,10 @@ class MessagingApi {
|
|
|
31582
31618
|
|
|
31583
31619
|
/**
|
|
31584
31620
|
* Update a supported content profile
|
|
31585
|
-
*
|
|
31621
|
+
* Deprecated - use PATCH /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
|
|
31586
31622
|
* @param {String} supportedContentId Supported Content ID
|
|
31587
31623
|
* @param {Object} body SupportedContent
|
|
31624
|
+
* @deprecated
|
|
31588
31625
|
*/
|
|
31589
31626
|
patchMessagingSupportedcontentSupportedContentId(supportedContentId, body) {
|
|
31590
31627
|
// verify the required parameter 'supportedContentId' is set
|
|
@@ -31612,8 +31649,9 @@ class MessagingApi {
|
|
|
31612
31649
|
|
|
31613
31650
|
/**
|
|
31614
31651
|
* Create a Supported Content profile
|
|
31615
|
-
*
|
|
31652
|
+
* Deprecated - use POST /api/v2/conversations/messaging/supportedcontent as replacement
|
|
31616
31653
|
* @param {Object} body SupportedContent
|
|
31654
|
+
* @deprecated
|
|
31617
31655
|
*/
|
|
31618
31656
|
postMessagingSupportedcontent(body) {
|
|
31619
31657
|
// verify the required parameter 'body' is set
|
|
@@ -31641,7 +31679,7 @@ class MobileDevicesApi {
|
|
|
31641
31679
|
/**
|
|
31642
31680
|
* MobileDevices service.
|
|
31643
31681
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
31644
|
-
* @version
|
|
31682
|
+
* @version 169.0.0
|
|
31645
31683
|
*/
|
|
31646
31684
|
|
|
31647
31685
|
/**
|
|
@@ -31792,7 +31830,7 @@ class NotificationsApi {
|
|
|
31792
31830
|
/**
|
|
31793
31831
|
* Notifications service.
|
|
31794
31832
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
31795
|
-
* @version
|
|
31833
|
+
* @version 169.0.0
|
|
31796
31834
|
*/
|
|
31797
31835
|
|
|
31798
31836
|
/**
|
|
@@ -32025,7 +32063,7 @@ class OAuthApi {
|
|
|
32025
32063
|
/**
|
|
32026
32064
|
* OAuth service.
|
|
32027
32065
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
32028
|
-
* @version
|
|
32066
|
+
* @version 169.0.0
|
|
32029
32067
|
*/
|
|
32030
32068
|
|
|
32031
32069
|
/**
|
|
@@ -32391,7 +32429,7 @@ class ObjectsApi {
|
|
|
32391
32429
|
/**
|
|
32392
32430
|
* Objects service.
|
|
32393
32431
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
32394
|
-
* @version
|
|
32432
|
+
* @version 169.0.0
|
|
32395
32433
|
*/
|
|
32396
32434
|
|
|
32397
32435
|
/**
|
|
@@ -32662,7 +32700,7 @@ class OrganizationApi {
|
|
|
32662
32700
|
/**
|
|
32663
32701
|
* Organization service.
|
|
32664
32702
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
32665
|
-
* @version
|
|
32703
|
+
* @version 169.0.0
|
|
32666
32704
|
*/
|
|
32667
32705
|
|
|
32668
32706
|
/**
|
|
@@ -32681,6 +32719,7 @@ class OrganizationApi {
|
|
|
32681
32719
|
* Fetch field config for an entity type
|
|
32682
32720
|
*
|
|
32683
32721
|
* @param {Object} type Field type
|
|
32722
|
+
* @deprecated
|
|
32684
32723
|
*/
|
|
32685
32724
|
getFieldconfig(type) {
|
|
32686
32725
|
// verify the required parameter 'type' is set
|
|
@@ -32703,9 +32742,30 @@ class OrganizationApi {
|
|
|
32703
32742
|
}
|
|
32704
32743
|
|
|
32705
32744
|
/**
|
|
32706
|
-
*
|
|
32745
|
+
* Gets the organization's settings
|
|
32707
32746
|
*
|
|
32708
32747
|
*/
|
|
32748
|
+
getOrganizationsAuthenticationSettings() {
|
|
32749
|
+
|
|
32750
|
+
return this.apiClient.callApi(
|
|
32751
|
+
'/api/v2/organizations/authentication/settings',
|
|
32752
|
+
'GET',
|
|
32753
|
+
{ },
|
|
32754
|
+
{ },
|
|
32755
|
+
{ },
|
|
32756
|
+
{ },
|
|
32757
|
+
null,
|
|
32758
|
+
['PureCloud OAuth'],
|
|
32759
|
+
['application/json'],
|
|
32760
|
+
['application/json']
|
|
32761
|
+
);
|
|
32762
|
+
}
|
|
32763
|
+
|
|
32764
|
+
/**
|
|
32765
|
+
* Get the list of domains that will be allowed to embed PureCloud applications
|
|
32766
|
+
* This route is deprecated, please use /api/v2/organizations/authentication/settings instead
|
|
32767
|
+
* @deprecated
|
|
32768
|
+
*/
|
|
32709
32769
|
getOrganizationsEmbeddedintegration() {
|
|
32710
32770
|
|
|
32711
32771
|
return this.apiClient.callApi(
|
|
@@ -32724,7 +32784,8 @@ class OrganizationApi {
|
|
|
32724
32784
|
|
|
32725
32785
|
/**
|
|
32726
32786
|
* Get organization IP address whitelist settings
|
|
32727
|
-
*
|
|
32787
|
+
* This route is deprecated, please use /api/v2/organizations/authentication/settings instead
|
|
32788
|
+
* @deprecated
|
|
32728
32789
|
*/
|
|
32729
32790
|
getOrganizationsIpaddressauthentication() {
|
|
32730
32791
|
|
|
@@ -32911,8 +32972,9 @@ class OrganizationApi {
|
|
|
32911
32972
|
}
|
|
32912
32973
|
|
|
32913
32974
|
/**
|
|
32914
|
-
*
|
|
32975
|
+
* This route is deprecated, please use /api/v2/organizations/authentication/settings instead
|
|
32915
32976
|
*
|
|
32977
|
+
* @deprecated
|
|
32916
32978
|
*/
|
|
32917
32979
|
getOrganizationsWhitelist() {
|
|
32918
32980
|
|
|
@@ -32930,6 +32992,31 @@ class OrganizationApi {
|
|
|
32930
32992
|
);
|
|
32931
32993
|
}
|
|
32932
32994
|
|
|
32995
|
+
/**
|
|
32996
|
+
* Update the organization's settings
|
|
32997
|
+
*
|
|
32998
|
+
* @param {Object} body Org settings
|
|
32999
|
+
*/
|
|
33000
|
+
patchOrganizationsAuthenticationSettings(body) {
|
|
33001
|
+
// verify the required parameter 'body' is set
|
|
33002
|
+
if (body === undefined || body === null) {
|
|
33003
|
+
throw 'Missing the required parameter "body" when calling patchOrganizationsAuthenticationSettings';
|
|
33004
|
+
}
|
|
33005
|
+
|
|
33006
|
+
return this.apiClient.callApi(
|
|
33007
|
+
'/api/v2/organizations/authentication/settings',
|
|
33008
|
+
'PATCH',
|
|
33009
|
+
{ },
|
|
33010
|
+
{ },
|
|
33011
|
+
{ },
|
|
33012
|
+
{ },
|
|
33013
|
+
body,
|
|
33014
|
+
['PureCloud OAuth'],
|
|
33015
|
+
['application/json'],
|
|
33016
|
+
['application/json']
|
|
33017
|
+
);
|
|
33018
|
+
}
|
|
33019
|
+
|
|
32933
33020
|
/**
|
|
32934
33021
|
* Update organization
|
|
32935
33022
|
*
|
|
@@ -32962,8 +33049,9 @@ class OrganizationApi {
|
|
|
32962
33049
|
|
|
32963
33050
|
/**
|
|
32964
33051
|
* Update the list of domains that will be allowed to embed PureCloud applications
|
|
32965
|
-
*
|
|
33052
|
+
* This route is deprecated, please use /api/v2/organizations/authentication/settings instead
|
|
32966
33053
|
* @param {Object} body Whitelist settings
|
|
33054
|
+
* @deprecated
|
|
32967
33055
|
*/
|
|
32968
33056
|
putOrganizationsEmbeddedintegration(body) {
|
|
32969
33057
|
// verify the required parameter 'body' is set
|
|
@@ -32987,8 +33075,9 @@ class OrganizationApi {
|
|
|
32987
33075
|
|
|
32988
33076
|
/**
|
|
32989
33077
|
* Update organization IP address whitelist settings
|
|
32990
|
-
*
|
|
33078
|
+
* This route is deprecated, please use /api/v2/organizations/authentication/settings instead
|
|
32991
33079
|
* @param {Object} body IP address Whitelist settings
|
|
33080
|
+
* @deprecated
|
|
32992
33081
|
*/
|
|
32993
33082
|
putOrganizationsIpaddressauthentication(body) {
|
|
32994
33083
|
// verify the required parameter 'body' is set
|
|
@@ -33035,9 +33124,10 @@ class OrganizationApi {
|
|
|
33035
33124
|
}
|
|
33036
33125
|
|
|
33037
33126
|
/**
|
|
33038
|
-
*
|
|
33127
|
+
* This route is deprecated, please use /api/v2/organizations/authentication/settings instead
|
|
33039
33128
|
*
|
|
33040
33129
|
* @param {Object} body Whitelist settings
|
|
33130
|
+
* @deprecated
|
|
33041
33131
|
*/
|
|
33042
33132
|
putOrganizationsWhitelist(body) {
|
|
33043
33133
|
// verify the required parameter 'body' is set
|
|
@@ -33065,7 +33155,7 @@ class OrganizationAuthorizationApi {
|
|
|
33065
33155
|
/**
|
|
33066
33156
|
* OrganizationAuthorization service.
|
|
33067
33157
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
33068
|
-
* @version
|
|
33158
|
+
* @version 169.0.0
|
|
33069
33159
|
*/
|
|
33070
33160
|
|
|
33071
33161
|
/**
|
|
@@ -34360,7 +34450,7 @@ class OutboundApi {
|
|
|
34360
34450
|
/**
|
|
34361
34451
|
* Outbound service.
|
|
34362
34452
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
34363
|
-
* @version
|
|
34453
|
+
* @version 169.0.0
|
|
34364
34454
|
*/
|
|
34365
34455
|
|
|
34366
34456
|
/**
|
|
@@ -36845,6 +36935,7 @@ class OutboundApi {
|
|
|
36845
36935
|
* This endpoint is deprecated and may have unexpected results. Please use "/conversations/{conversationId}/participants/{participantId}/callbacks instead."
|
|
36846
36936
|
* @param {String} campaignId Campaign ID
|
|
36847
36937
|
* @param {Object} body ContactCallbackRequest
|
|
36938
|
+
* @deprecated
|
|
36848
36939
|
*/
|
|
36849
36940
|
postOutboundCampaignCallbackSchedule(campaignId, body) {
|
|
36850
36941
|
// verify the required parameter 'campaignId' is set
|
|
@@ -37981,7 +38072,7 @@ class PresenceApi {
|
|
|
37981
38072
|
/**
|
|
37982
38073
|
* Presence service.
|
|
37983
38074
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
37984
|
-
* @version
|
|
38075
|
+
* @version 169.0.0
|
|
37985
38076
|
*/
|
|
37986
38077
|
|
|
37987
38078
|
/**
|
|
@@ -38532,7 +38623,7 @@ class ProcessAutomationApi {
|
|
|
38532
38623
|
/**
|
|
38533
38624
|
* ProcessAutomation service.
|
|
38534
38625
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
38535
|
-
* @version
|
|
38626
|
+
* @version 169.0.0
|
|
38536
38627
|
*/
|
|
38537
38628
|
|
|
38538
38629
|
/**
|
|
@@ -38771,7 +38862,7 @@ class QualityApi {
|
|
|
38771
38862
|
/**
|
|
38772
38863
|
* Quality service.
|
|
38773
38864
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
38774
|
-
* @version
|
|
38865
|
+
* @version 169.0.0
|
|
38775
38866
|
*/
|
|
38776
38867
|
|
|
38777
38868
|
/**
|
|
@@ -38854,6 +38945,7 @@ class QualityApi {
|
|
|
38854
38945
|
* Delete an evaluation form.
|
|
38855
38946
|
*
|
|
38856
38947
|
* @param {String} formId Form ID
|
|
38948
|
+
* @deprecated
|
|
38857
38949
|
*/
|
|
38858
38950
|
deleteQualityForm(formId) {
|
|
38859
38951
|
// verify the required parameter 'formId' is set
|
|
@@ -39222,6 +39314,7 @@ class QualityApi {
|
|
|
39222
39314
|
* Get an evaluation form
|
|
39223
39315
|
*
|
|
39224
39316
|
* @param {String} formId Form ID
|
|
39317
|
+
* @deprecated
|
|
39225
39318
|
*/
|
|
39226
39319
|
getQualityForm(formId) {
|
|
39227
39320
|
// verify the required parameter 'formId' is set
|
|
@@ -39250,6 +39343,7 @@ class QualityApi {
|
|
|
39250
39343
|
* @param {Object} opts Optional parameters
|
|
39251
39344
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
39252
39345
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
39346
|
+
* @deprecated
|
|
39253
39347
|
*/
|
|
39254
39348
|
getQualityFormVersions(formId, opts) {
|
|
39255
39349
|
opts = opts || {};
|
|
@@ -39285,6 +39379,7 @@ class QualityApi {
|
|
|
39285
39379
|
* @param {Object} opts.expand If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions
|
|
39286
39380
|
* @param {String} opts.name Name
|
|
39287
39381
|
* @param {String} opts.sortOrder Order to sort results, either asc or desc
|
|
39382
|
+
* @deprecated
|
|
39288
39383
|
*/
|
|
39289
39384
|
getQualityForms(opts) {
|
|
39290
39385
|
opts = opts || {};
|
|
@@ -39560,6 +39655,7 @@ class QualityApi {
|
|
|
39560
39655
|
* Get the published evaluation forms.
|
|
39561
39656
|
*
|
|
39562
39657
|
* @param {String} formId Form ID
|
|
39658
|
+
* @deprecated
|
|
39563
39659
|
*/
|
|
39564
39660
|
getQualityPublishedform(formId) {
|
|
39565
39661
|
// verify the required parameter 'formId' is set
|
|
@@ -39589,6 +39685,7 @@ class QualityApi {
|
|
|
39589
39685
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
39590
39686
|
* @param {String} opts.name Name
|
|
39591
39687
|
* @param {Boolean} opts.onlyLatestPerContext onlyLatestPerContext (default to false)
|
|
39688
|
+
* @deprecated
|
|
39592
39689
|
*/
|
|
39593
39690
|
getQualityPublishedforms(opts) {
|
|
39594
39691
|
opts = opts || {};
|
|
@@ -39984,6 +40081,7 @@ class QualityApi {
|
|
|
39984
40081
|
* Create an evaluation form.
|
|
39985
40082
|
*
|
|
39986
40083
|
* @param {Object} body Evaluation form
|
|
40084
|
+
* @deprecated
|
|
39987
40085
|
*/
|
|
39988
40086
|
postQualityForms(body) {
|
|
39989
40087
|
// verify the required parameter 'body' is set
|
|
@@ -40059,6 +40157,7 @@ class QualityApi {
|
|
|
40059
40157
|
* Publish an evaluation form.
|
|
40060
40158
|
*
|
|
40061
40159
|
* @param {Object} body Publish request containing id of form to publish
|
|
40160
|
+
* @deprecated
|
|
40062
40161
|
*/
|
|
40063
40162
|
postQualityPublishedforms(body) {
|
|
40064
40163
|
// verify the required parameter 'body' is set
|
|
@@ -40229,6 +40328,7 @@ class QualityApi {
|
|
|
40229
40328
|
*
|
|
40230
40329
|
* @param {String} formId Form ID
|
|
40231
40330
|
* @param {Object} body Evaluation form
|
|
40331
|
+
* @deprecated
|
|
40232
40332
|
*/
|
|
40233
40333
|
putQualityForm(formId, body) {
|
|
40234
40334
|
// verify the required parameter 'formId' is set
|
|
@@ -40350,7 +40450,7 @@ class RecordingApi {
|
|
|
40350
40450
|
/**
|
|
40351
40451
|
* Recording service.
|
|
40352
40452
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
40353
|
-
* @version
|
|
40453
|
+
* @version 169.0.0
|
|
40354
40454
|
*/
|
|
40355
40455
|
|
|
40356
40456
|
/**
|
|
@@ -41987,7 +42087,7 @@ class ResponseManagementApi {
|
|
|
41987
42087
|
/**
|
|
41988
42088
|
* ResponseManagement service.
|
|
41989
42089
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
41990
|
-
* @version
|
|
42090
|
+
* @version 169.0.0
|
|
41991
42091
|
*/
|
|
41992
42092
|
|
|
41993
42093
|
/**
|
|
@@ -42472,7 +42572,7 @@ class RoutingApi {
|
|
|
42472
42572
|
/**
|
|
42473
42573
|
* Routing service.
|
|
42474
42574
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
42475
|
-
* @version
|
|
42575
|
+
* @version 169.0.0
|
|
42476
42576
|
*/
|
|
42477
42577
|
|
|
42478
42578
|
/**
|
|
@@ -42706,6 +42806,7 @@ class RoutingApi {
|
|
|
42706
42806
|
*
|
|
42707
42807
|
* @param {String} queueId Queue ID
|
|
42708
42808
|
* @param {String} memberId Member ID
|
|
42809
|
+
* @deprecated
|
|
42709
42810
|
*/
|
|
42710
42811
|
deleteRoutingQueueUser(queueId, memberId) {
|
|
42711
42812
|
// verify the required parameter 'queueId' is set
|
|
@@ -43797,6 +43898,7 @@ class RoutingApi {
|
|
|
43797
43898
|
* @param {Array.<String>} opts.languages Filter by language
|
|
43798
43899
|
* @param {Array.<String>} opts.routingStatus Filter by routing status
|
|
43799
43900
|
* @param {Array.<String>} opts.presence Filter by presence
|
|
43901
|
+
* @deprecated
|
|
43800
43902
|
*/
|
|
43801
43903
|
getRoutingQueueUsers(queueId, opts) {
|
|
43802
43904
|
opts = opts || {};
|
|
@@ -44754,6 +44856,7 @@ class RoutingApi {
|
|
|
44754
44856
|
* @param {String} queueId Queue ID
|
|
44755
44857
|
* @param {String} memberId Member ID
|
|
44756
44858
|
* @param {Object} body Queue Member
|
|
44859
|
+
* @deprecated
|
|
44757
44860
|
*/
|
|
44758
44861
|
patchRoutingQueueUser(queueId, memberId, body) {
|
|
44759
44862
|
// verify the required parameter 'queueId' is set
|
|
@@ -44788,6 +44891,7 @@ class RoutingApi {
|
|
|
44788
44891
|
*
|
|
44789
44892
|
* @param {String} queueId Queue ID
|
|
44790
44893
|
* @param {Array.<Object>} body Queue Members
|
|
44894
|
+
* @deprecated
|
|
44791
44895
|
*/
|
|
44792
44896
|
patchRoutingQueueUsers(queueId, body) {
|
|
44793
44897
|
// verify the required parameter 'queueId' is set
|
|
@@ -45329,6 +45433,7 @@ class RoutingApi {
|
|
|
45329
45433
|
* @param {Array.<Object>} body Queue Members
|
|
45330
45434
|
* @param {Object} opts Optional parameters
|
|
45331
45435
|
* @param {Boolean} opts._delete True to delete queue members (default to false)
|
|
45436
|
+
* @deprecated
|
|
45332
45437
|
*/
|
|
45333
45438
|
postRoutingQueueUsers(queueId, body, opts) {
|
|
45334
45439
|
opts = opts || {};
|
|
@@ -45981,7 +46086,7 @@ class SCIMApi {
|
|
|
45981
46086
|
/**
|
|
45982
46087
|
* SCIM service.
|
|
45983
46088
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
45984
|
-
* @version
|
|
46089
|
+
* @version 169.0.0
|
|
45985
46090
|
*/
|
|
45986
46091
|
|
|
45987
46092
|
/**
|
|
@@ -46858,7 +46963,7 @@ class ScriptsApi {
|
|
|
46858
46963
|
/**
|
|
46859
46964
|
* Scripts service.
|
|
46860
46965
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
46861
|
-
* @version
|
|
46966
|
+
* @version 169.0.0
|
|
46862
46967
|
*/
|
|
46863
46968
|
|
|
46864
46969
|
/**
|
|
@@ -47277,7 +47382,7 @@ class SearchApi {
|
|
|
47277
47382
|
/**
|
|
47278
47383
|
* Search service.
|
|
47279
47384
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
47280
|
-
* @version
|
|
47385
|
+
* @version 169.0.0
|
|
47281
47386
|
*/
|
|
47282
47387
|
|
|
47283
47388
|
/**
|
|
@@ -47650,6 +47755,7 @@ class SearchApi {
|
|
|
47650
47755
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
47651
47756
|
* @param {Object} opts Optional parameters
|
|
47652
47757
|
* @param {Object} opts.body
|
|
47758
|
+
* @deprecated
|
|
47653
47759
|
*/
|
|
47654
47760
|
postKnowledgeKnowledgebaseSearch(knowledgeBaseId, opts) {
|
|
47655
47761
|
opts = opts || {};
|
|
@@ -47887,7 +47993,7 @@ class SpeechTextAnalyticsApi {
|
|
|
47887
47993
|
/**
|
|
47888
47994
|
* SpeechTextAnalytics service.
|
|
47889
47995
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
47890
|
-
* @version
|
|
47996
|
+
* @version 169.0.0
|
|
47891
47997
|
*/
|
|
47892
47998
|
|
|
47893
47999
|
/**
|
|
@@ -48440,6 +48546,30 @@ class SpeechTextAnalyticsApi {
|
|
|
48440
48546
|
);
|
|
48441
48547
|
}
|
|
48442
48548
|
|
|
48549
|
+
/**
|
|
48550
|
+
* Get the list of general topics from the org and the system with their current status
|
|
48551
|
+
*
|
|
48552
|
+
* @param {Object} opts Optional parameters
|
|
48553
|
+
* @param {Object} opts.dialect The dialect of the general topics, dialect format is {language}-{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard
|
|
48554
|
+
*/
|
|
48555
|
+
getSpeechandtextanalyticsTopicsGeneralStatus(opts) {
|
|
48556
|
+
opts = opts || {};
|
|
48557
|
+
|
|
48558
|
+
|
|
48559
|
+
return this.apiClient.callApi(
|
|
48560
|
+
'/api/v2/speechandtextanalytics/topics/general/status',
|
|
48561
|
+
'GET',
|
|
48562
|
+
{ },
|
|
48563
|
+
{ 'dialect': opts['dialect'] },
|
|
48564
|
+
{ },
|
|
48565
|
+
{ },
|
|
48566
|
+
null,
|
|
48567
|
+
['PureCloud OAuth'],
|
|
48568
|
+
['application/json'],
|
|
48569
|
+
['application/json']
|
|
48570
|
+
);
|
|
48571
|
+
}
|
|
48572
|
+
|
|
48443
48573
|
/**
|
|
48444
48574
|
* Get a Speech and Text Analytics publish topics job by id
|
|
48445
48575
|
*
|
|
@@ -48816,7 +48946,7 @@ class StationsApi {
|
|
|
48816
48946
|
/**
|
|
48817
48947
|
* Stations service.
|
|
48818
48948
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
48819
|
-
* @version
|
|
48949
|
+
* @version 169.0.0
|
|
48820
48950
|
*/
|
|
48821
48951
|
|
|
48822
48952
|
/**
|
|
@@ -48918,7 +49048,7 @@ class SuggestApi {
|
|
|
48918
49048
|
/**
|
|
48919
49049
|
* Suggest service.
|
|
48920
49050
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
48921
|
-
* @version
|
|
49051
|
+
* @version 169.0.0
|
|
48922
49052
|
*/
|
|
48923
49053
|
|
|
48924
49054
|
/**
|
|
@@ -49057,7 +49187,7 @@ class TeamsApi {
|
|
|
49057
49187
|
/**
|
|
49058
49188
|
* Teams service.
|
|
49059
49189
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
49060
|
-
* @version
|
|
49190
|
+
* @version 169.0.0
|
|
49061
49191
|
*/
|
|
49062
49192
|
|
|
49063
49193
|
/**
|
|
@@ -49328,7 +49458,7 @@ class TelephonyApi {
|
|
|
49328
49458
|
/**
|
|
49329
49459
|
* Telephony service.
|
|
49330
49460
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
49331
|
-
* @version
|
|
49461
|
+
* @version 169.0.0
|
|
49332
49462
|
*/
|
|
49333
49463
|
|
|
49334
49464
|
/**
|
|
@@ -49456,7 +49586,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
49456
49586
|
/**
|
|
49457
49587
|
* TelephonyProvidersEdge service.
|
|
49458
49588
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
49459
|
-
* @version
|
|
49589
|
+
* @version 169.0.0
|
|
49460
49590
|
*/
|
|
49461
49591
|
|
|
49462
49592
|
/**
|
|
@@ -50850,6 +50980,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
50850
50980
|
* Get outbound route
|
|
50851
50981
|
* This route is deprecated, use /telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId} instead.
|
|
50852
50982
|
* @param {String} outboundRouteId Outbound route ID
|
|
50983
|
+
* @deprecated
|
|
50853
50984
|
*/
|
|
50854
50985
|
getTelephonyProvidersEdgesOutboundroute(outboundRouteId) {
|
|
50855
50986
|
// verify the required parameter 'outboundRouteId' is set
|
|
@@ -52656,7 +52787,7 @@ class TextbotsApi {
|
|
|
52656
52787
|
/**
|
|
52657
52788
|
* Textbots service.
|
|
52658
52789
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
52659
|
-
* @version
|
|
52790
|
+
* @version 169.0.0
|
|
52660
52791
|
*/
|
|
52661
52792
|
|
|
52662
52793
|
/**
|
|
@@ -52784,7 +52915,7 @@ class TokensApi {
|
|
|
52784
52915
|
/**
|
|
52785
52916
|
* Tokens service.
|
|
52786
52917
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
52787
|
-
* @version
|
|
52918
|
+
* @version 169.0.0
|
|
52788
52919
|
*/
|
|
52789
52920
|
|
|
52790
52921
|
/**
|
|
@@ -52890,7 +53021,7 @@ class UploadsApi {
|
|
|
52890
53021
|
/**
|
|
52891
53022
|
* Uploads service.
|
|
52892
53023
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
52893
|
-
* @version
|
|
53024
|
+
* @version 169.0.0
|
|
52894
53025
|
*/
|
|
52895
53026
|
|
|
52896
53027
|
/**
|
|
@@ -53066,7 +53197,7 @@ class UsageApi {
|
|
|
53066
53197
|
/**
|
|
53067
53198
|
* Usage service.
|
|
53068
53199
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
53069
|
-
* @version
|
|
53200
|
+
* @version 169.0.0
|
|
53070
53201
|
*/
|
|
53071
53202
|
|
|
53072
53203
|
/**
|
|
@@ -53165,6 +53296,31 @@ class UsageApi {
|
|
|
53165
53296
|
);
|
|
53166
53297
|
}
|
|
53167
53298
|
|
|
53299
|
+
/**
|
|
53300
|
+
* Get the results of a usage search
|
|
53301
|
+
*
|
|
53302
|
+
* @param {String} executionId ID of the search execution
|
|
53303
|
+
*/
|
|
53304
|
+
getUsageSimplesearchExecutionIdResults(executionId) {
|
|
53305
|
+
// verify the required parameter 'executionId' is set
|
|
53306
|
+
if (executionId === undefined || executionId === null) {
|
|
53307
|
+
throw 'Missing the required parameter "executionId" when calling getUsageSimplesearchExecutionIdResults';
|
|
53308
|
+
}
|
|
53309
|
+
|
|
53310
|
+
return this.apiClient.callApi(
|
|
53311
|
+
'/api/v2/usage/simplesearch/{executionId}/results',
|
|
53312
|
+
'GET',
|
|
53313
|
+
{ 'executionId': executionId },
|
|
53314
|
+
{ },
|
|
53315
|
+
{ },
|
|
53316
|
+
{ },
|
|
53317
|
+
null,
|
|
53318
|
+
['PureCloud OAuth'],
|
|
53319
|
+
['application/json'],
|
|
53320
|
+
['application/json']
|
|
53321
|
+
);
|
|
53322
|
+
}
|
|
53323
|
+
|
|
53168
53324
|
/**
|
|
53169
53325
|
* Query for OAuth client API usage
|
|
53170
53326
|
* After calling this method, you will then need to poll for the query results based on the returned execution Id
|
|
@@ -53220,13 +53376,38 @@ class UsageApi {
|
|
|
53220
53376
|
);
|
|
53221
53377
|
}
|
|
53222
53378
|
|
|
53379
|
+
/**
|
|
53380
|
+
* Search organization API Usage -
|
|
53381
|
+
* After calling this method, you will then need to poll for the query results based on the returned execution Id
|
|
53382
|
+
* @param {Object} body SimpleSearch
|
|
53383
|
+
*/
|
|
53384
|
+
postUsageSimplesearch(body) {
|
|
53385
|
+
// verify the required parameter 'body' is set
|
|
53386
|
+
if (body === undefined || body === null) {
|
|
53387
|
+
throw 'Missing the required parameter "body" when calling postUsageSimplesearch';
|
|
53388
|
+
}
|
|
53389
|
+
|
|
53390
|
+
return this.apiClient.callApi(
|
|
53391
|
+
'/api/v2/usage/simplesearch',
|
|
53392
|
+
'POST',
|
|
53393
|
+
{ },
|
|
53394
|
+
{ },
|
|
53395
|
+
{ },
|
|
53396
|
+
{ },
|
|
53397
|
+
body,
|
|
53398
|
+
['PureCloud OAuth'],
|
|
53399
|
+
['application/json'],
|
|
53400
|
+
['application/json']
|
|
53401
|
+
);
|
|
53402
|
+
}
|
|
53403
|
+
|
|
53223
53404
|
}
|
|
53224
53405
|
|
|
53225
53406
|
class UserRecordingsApi {
|
|
53226
53407
|
/**
|
|
53227
53408
|
* UserRecordings service.
|
|
53228
53409
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
53229
|
-
* @version
|
|
53410
|
+
* @version 169.0.0
|
|
53230
53411
|
*/
|
|
53231
53412
|
|
|
53232
53413
|
/**
|
|
@@ -53411,7 +53592,7 @@ class UsersApi {
|
|
|
53411
53592
|
/**
|
|
53412
53593
|
* Users service.
|
|
53413
53594
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
53414
|
-
* @version
|
|
53595
|
+
* @version 169.0.0
|
|
53415
53596
|
*/
|
|
53416
53597
|
|
|
53417
53598
|
/**
|
|
@@ -53727,6 +53908,7 @@ class UsersApi {
|
|
|
53727
53908
|
* @param {String} permission The permission string, including the object to access, e.g. routing:queue:view
|
|
53728
53909
|
* @param {Object} opts Optional parameters
|
|
53729
53910
|
* @param {String} opts.name Search term to filter by division name
|
|
53911
|
+
* @deprecated
|
|
53730
53912
|
*/
|
|
53731
53913
|
getAuthorizationDivisionspermittedMe(permission, opts) {
|
|
53732
53914
|
opts = opts || {};
|
|
@@ -53788,6 +53970,7 @@ class UsersApi {
|
|
|
53788
53970
|
* @param {Object} opts Optional parameters
|
|
53789
53971
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
53790
53972
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
53973
|
+
* @deprecated
|
|
53791
53974
|
*/
|
|
53792
53975
|
getAuthorizationDivisionspermittedPagedSubjectId(subjectId, permission, opts) {
|
|
53793
53976
|
opts = opts || {};
|
|
@@ -53864,6 +54047,7 @@ class UsersApi {
|
|
|
53864
54047
|
* Fetch field config for an entity type
|
|
53865
54048
|
*
|
|
53866
54049
|
* @param {Object} type Field type
|
|
54050
|
+
* @deprecated
|
|
53867
54051
|
*/
|
|
53868
54052
|
getFieldconfig(type) {
|
|
53869
54053
|
// verify the required parameter 'type' is set
|
|
@@ -53896,6 +54080,7 @@ class UsersApi {
|
|
|
53896
54080
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
|
|
53897
54081
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
53898
54082
|
* @param {Object} opts.integrationPresenceSource Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an expand.
|
|
54083
|
+
* @deprecated
|
|
53899
54084
|
*/
|
|
53900
54085
|
getProfilesUsers(opts) {
|
|
53901
54086
|
opts = opts || {};
|
|
@@ -54063,6 +54248,7 @@ class UsersApi {
|
|
|
54063
54248
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
54064
54249
|
* @param {String} opts.sortOrder Sort order (default to ASC)
|
|
54065
54250
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
54251
|
+
* @deprecated
|
|
54066
54252
|
*/
|
|
54067
54253
|
getUserFavorites(userId, opts) {
|
|
54068
54254
|
opts = opts || {};
|
|
@@ -54148,6 +54334,7 @@ class UsersApi {
|
|
|
54148
54334
|
* @param {Object} opts Optional parameters
|
|
54149
54335
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
54150
54336
|
* @param {Object} opts.integrationPresenceSource Gets an integration presence for a user instead of their default.
|
|
54337
|
+
* @deprecated
|
|
54151
54338
|
*/
|
|
54152
54339
|
getUserProfile(userId, opts) {
|
|
54153
54340
|
opts = opts || {};
|
|
@@ -55801,7 +55988,7 @@ class UtilitiesApi {
|
|
|
55801
55988
|
/**
|
|
55802
55989
|
* Utilities service.
|
|
55803
55990
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
55804
|
-
* @version
|
|
55991
|
+
* @version 169.0.0
|
|
55805
55992
|
*/
|
|
55806
55993
|
|
|
55807
55994
|
/**
|
|
@@ -55912,7 +56099,7 @@ class VoicemailApi {
|
|
|
55912
56099
|
/**
|
|
55913
56100
|
* Voicemail service.
|
|
55914
56101
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
55915
|
-
* @version
|
|
56102
|
+
* @version 169.0.0
|
|
55916
56103
|
*/
|
|
55917
56104
|
|
|
55918
56105
|
/**
|
|
@@ -56579,7 +56766,7 @@ class WebChatApi {
|
|
|
56579
56766
|
/**
|
|
56580
56767
|
* WebChat service.
|
|
56581
56768
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
56582
|
-
* @version
|
|
56769
|
+
* @version 169.0.0
|
|
56583
56770
|
*/
|
|
56584
56771
|
|
|
56585
56772
|
/**
|
|
@@ -56598,6 +56785,7 @@ class WebChatApi {
|
|
|
56598
56785
|
* Delete a WebChat deployment
|
|
56599
56786
|
*
|
|
56600
56787
|
* @param {String} deploymentId Deployment Id
|
|
56788
|
+
* @deprecated
|
|
56601
56789
|
*/
|
|
56602
56790
|
deleteWebchatDeployment(deploymentId) {
|
|
56603
56791
|
// verify the required parameter 'deploymentId' is set
|
|
@@ -56673,6 +56861,7 @@ class WebChatApi {
|
|
|
56673
56861
|
* Get a WebChat deployment
|
|
56674
56862
|
*
|
|
56675
56863
|
* @param {String} deploymentId Deployment Id
|
|
56864
|
+
* @deprecated
|
|
56676
56865
|
*/
|
|
56677
56866
|
getWebchatDeployment(deploymentId) {
|
|
56678
56867
|
// verify the required parameter 'deploymentId' is set
|
|
@@ -56697,6 +56886,7 @@ class WebChatApi {
|
|
|
56697
56886
|
/**
|
|
56698
56887
|
* List WebChat deployments
|
|
56699
56888
|
*
|
|
56889
|
+
* @deprecated
|
|
56700
56890
|
*/
|
|
56701
56891
|
getWebchatDeployments() {
|
|
56702
56892
|
|
|
@@ -56951,6 +57141,7 @@ class WebChatApi {
|
|
|
56951
57141
|
* Create WebChat deployment
|
|
56952
57142
|
*
|
|
56953
57143
|
* @param {Object} body Deployment
|
|
57144
|
+
* @deprecated
|
|
56954
57145
|
*/
|
|
56955
57146
|
postWebchatDeployments(body) {
|
|
56956
57147
|
// verify the required parameter 'body' is set
|
|
@@ -57067,6 +57258,7 @@ class WebChatApi {
|
|
|
57067
57258
|
*
|
|
57068
57259
|
* @param {String} deploymentId Deployment Id
|
|
57069
57260
|
* @param {Object} body Deployment
|
|
57261
|
+
* @deprecated
|
|
57070
57262
|
*/
|
|
57071
57263
|
putWebchatDeployment(deploymentId, body) {
|
|
57072
57264
|
// verify the required parameter 'deploymentId' is set
|
|
@@ -57123,7 +57315,7 @@ class WebDeploymentsApi {
|
|
|
57123
57315
|
/**
|
|
57124
57316
|
* WebDeployments service.
|
|
57125
57317
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
57126
|
-
* @version
|
|
57318
|
+
* @version 169.0.0
|
|
57127
57319
|
*/
|
|
57128
57320
|
|
|
57129
57321
|
/**
|
|
@@ -57645,7 +57837,7 @@ class WebMessagingApi {
|
|
|
57645
57837
|
/**
|
|
57646
57838
|
* WebMessaging service.
|
|
57647
57839
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
57648
|
-
* @version
|
|
57840
|
+
* @version 169.0.0
|
|
57649
57841
|
*/
|
|
57650
57842
|
|
|
57651
57843
|
/**
|
|
@@ -57691,7 +57883,7 @@ class WidgetsApi {
|
|
|
57691
57883
|
/**
|
|
57692
57884
|
* Widgets service.
|
|
57693
57885
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
57694
|
-
* @version
|
|
57886
|
+
* @version 169.0.0
|
|
57695
57887
|
*/
|
|
57696
57888
|
|
|
57697
57889
|
/**
|
|
@@ -57837,7 +58029,7 @@ class WorkforceManagementApi {
|
|
|
57837
58029
|
/**
|
|
57838
58030
|
* WorkforceManagement service.
|
|
57839
58031
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
57840
|
-
* @version
|
|
58032
|
+
* @version 169.0.0
|
|
57841
58033
|
*/
|
|
57842
58034
|
|
|
57843
58035
|
/**
|
|
@@ -59379,6 +59571,7 @@ class WorkforceManagementApi {
|
|
|
59379
59571
|
* Get activity codes
|
|
59380
59572
|
*
|
|
59381
59573
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
59574
|
+
* @deprecated
|
|
59382
59575
|
*/
|
|
59383
59576
|
getWorkforcemanagementManagementunitActivitycodes(managementUnitId) {
|
|
59384
59577
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -59791,6 +59984,7 @@ class WorkforceManagementApi {
|
|
|
59791
59984
|
* @param {Object} opts Optional parameters
|
|
59792
59985
|
* @param {Object} opts.expand Which fields, if any, to expand
|
|
59793
59986
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
59987
|
+
* @deprecated
|
|
59794
59988
|
*/
|
|
59795
59989
|
getWorkforcemanagementManagementunitWeekSchedule(managementUnitId, weekId, scheduleId, opts) {
|
|
59796
59990
|
opts = opts || {};
|
|
@@ -59831,6 +60025,7 @@ class WorkforceManagementApi {
|
|
|
59831
60025
|
* @param {Boolean} opts.includeOnlyPublished Return only published schedules
|
|
59832
60026
|
* @param {String} opts.earliestWeekDate The start date of the earliest week to query in yyyy-MM-dd format
|
|
59833
60027
|
* @param {String} opts.latestWeekDate The start date of the latest week to query in yyyy-MM-dd format
|
|
60028
|
+
* @deprecated
|
|
59834
60029
|
*/
|
|
59835
60030
|
getWorkforcemanagementManagementunitWeekSchedules(managementUnitId, weekId, opts) {
|
|
59836
60031
|
opts = opts || {};
|
|
@@ -61789,6 +61984,7 @@ class WorkforceManagementApi {
|
|
|
61789
61984
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
61790
61985
|
* @param {Object} opts Optional parameters
|
|
61791
61986
|
* @param {Object} opts.body body
|
|
61987
|
+
* @deprecated
|
|
61792
61988
|
*/
|
|
61793
61989
|
postWorkforcemanagementManagementunitSchedulesSearch(managementUnitId, opts) {
|
|
61794
61990
|
opts = opts || {};
|
|
@@ -62449,6 +62645,7 @@ class WorkforceManagementApi {
|
|
|
62449
62645
|
*
|
|
62450
62646
|
* @param {Object} opts Optional parameters
|
|
62451
62647
|
* @param {Object} opts.body body
|
|
62648
|
+
* @deprecated
|
|
62452
62649
|
*/
|
|
62453
62650
|
postWorkforcemanagementSchedules(opts) {
|
|
62454
62651
|
opts = opts || {};
|
|
@@ -62639,7 +62836,7 @@ class WorkforceManagementApi {
|
|
|
62639
62836
|
* </pre>
|
|
62640
62837
|
* </p>
|
|
62641
62838
|
* @module purecloud-platform-client-v2/index
|
|
62642
|
-
* @version
|
|
62839
|
+
* @version 169.0.0
|
|
62643
62840
|
*/
|
|
62644
62841
|
class platformClient {
|
|
62645
62842
|
constructor() {
|