purecloud-platform-client-v2 146.0.0 → 148.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.
Files changed (75) hide show
  1. package/README.md +2 -2
  2. package/dist/node/purecloud-platform-client-v2.js +660 -198
  3. package/dist/web-amd/purecloud-platform-client-v2.js +660 -198
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +660 -198
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +661 -199
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +490 -145
  9. package/package.json +1 -1
  10. package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
  11. package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
  12. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +46 -1
  13. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
  14. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
  16. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  17. package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  19. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1 -1
  21. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  22. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -51
  26. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/GroupsApi.js +3 -2
  30. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -78
  32. package/src/purecloud-platform-client-v2/api/JourneyApi.js +76 -1
  33. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +3 -2
  34. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  44. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/OutboundApi.js +135 -1
  47. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +243 -0
  49. package/src/purecloud-platform-client-v2/api/QualityApi.js +4 -4
  50. package/src/purecloud-platform-client-v2/api/RecordingApi.js +31 -1
  51. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  60. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +3 -2
  67. package/src/purecloud-platform-client-v2/api/UsersApi.js +31 -1
  68. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +30 -1
  72. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/index.js +7 -1
@@ -2279,7 +2279,7 @@ class Configuration {
2279
2279
 
2280
2280
  /**
2281
2281
  * @module purecloud-platform-client-v2/ApiClient
2282
- * @version 146.0.0
2282
+ * @version 148.0.0
2283
2283
  */
2284
2284
  class ApiClient {
2285
2285
  /**
@@ -3351,7 +3351,7 @@ class AlertingApi {
3351
3351
  /**
3352
3352
  * Alerting service.
3353
3353
  * @module purecloud-platform-client-v2/api/AlertingApi
3354
- * @version 146.0.0
3354
+ * @version 148.0.0
3355
3355
  */
3356
3356
 
3357
3357
  /**
@@ -3665,7 +3665,7 @@ class AnalyticsApi {
3665
3665
  /**
3666
3666
  * Analytics service.
3667
3667
  * @module purecloud-platform-client-v2/api/AnalyticsApi
3668
- * @version 146.0.0
3668
+ * @version 148.0.0
3669
3669
  */
3670
3670
 
3671
3671
  /**
@@ -3911,6 +3911,26 @@ class AnalyticsApi {
3911
3911
  );
3912
3912
  }
3913
3913
 
3914
+ /**
3915
+ * Get analytics data retention setting
3916
+ *
3917
+ */
3918
+ getAnalyticsDataretentionSettings() {
3919
+
3920
+ return this.apiClient.callApi(
3921
+ '/api/v2/analytics/dataretention/settings',
3922
+ 'GET',
3923
+ { },
3924
+ { },
3925
+ { },
3926
+ { },
3927
+ null,
3928
+ ['PureCloud OAuth'],
3929
+ ['application/json'],
3930
+ ['application/json']
3931
+ );
3932
+ }
3933
+
3914
3934
  /**
3915
3935
  * Get all view export requests for a user
3916
3936
  *
@@ -4811,6 +4831,31 @@ class AnalyticsApi {
4811
4831
  );
4812
4832
  }
4813
4833
 
4834
+ /**
4835
+ * Update analytics data retention setting
4836
+ *
4837
+ * @param {Object} body retentionDays
4838
+ */
4839
+ putAnalyticsDataretentionSettings(body) {
4840
+ // verify the required parameter 'body' is set
4841
+ if (body === undefined || body === null) {
4842
+ throw 'Missing the required parameter "body" when calling putAnalyticsDataretentionSettings';
4843
+ }
4844
+
4845
+ return this.apiClient.callApi(
4846
+ '/api/v2/analytics/dataretention/settings',
4847
+ 'PUT',
4848
+ { },
4849
+ { },
4850
+ { },
4851
+ { },
4852
+ body,
4853
+ ['PureCloud OAuth'],
4854
+ ['application/json'],
4855
+ ['application/json']
4856
+ );
4857
+ }
4858
+
4814
4859
  /**
4815
4860
  * Update a scheduled report job.
4816
4861
  *
@@ -4847,7 +4892,7 @@ class ArchitectApi {
4847
4892
  /**
4848
4893
  * Architect service.
4849
4894
  * @module purecloud-platform-client-v2/api/ArchitectApi
4850
- * @version 146.0.0
4895
+ * @version 148.0.0
4851
4896
  */
4852
4897
 
4853
4898
  /**
@@ -7893,7 +7938,7 @@ class AuditApi {
7893
7938
  /**
7894
7939
  * Audit service.
7895
7940
  * @module purecloud-platform-client-v2/api/AuditApi
7896
- * @version 146.0.0
7941
+ * @version 148.0.0
7897
7942
  */
7898
7943
 
7899
7944
  /**
@@ -8064,7 +8109,7 @@ class AuthorizationApi {
8064
8109
  /**
8065
8110
  * Authorization service.
8066
8111
  * @module purecloud-platform-client-v2/api/AuthorizationApi
8067
- * @version 146.0.0
8112
+ * @version 148.0.0
8068
8113
  */
8069
8114
 
8070
8115
  /**
@@ -9247,7 +9292,7 @@ class BillingApi {
9247
9292
  /**
9248
9293
  * Billing service.
9249
9294
  * @module purecloud-platform-client-v2/api/BillingApi
9250
- * @version 146.0.0
9295
+ * @version 148.0.0
9251
9296
  */
9252
9297
 
9253
9298
  /**
@@ -9327,7 +9372,7 @@ class ChatApi {
9327
9372
  /**
9328
9373
  * Chat service.
9329
9374
  * @module purecloud-platform-client-v2/api/ChatApi
9330
- * @version 146.0.0
9375
+ * @version 148.0.0
9331
9376
  */
9332
9377
 
9333
9378
  /**
@@ -9418,7 +9463,7 @@ class CoachingApi {
9418
9463
  /**
9419
9464
  * Coaching service.
9420
9465
  * @module purecloud-platform-client-v2/api/CoachingApi
9421
- * @version 146.0.0
9466
+ * @version 148.0.0
9422
9467
  */
9423
9468
 
9424
9469
  /**
@@ -9995,7 +10040,7 @@ class ContentManagementApi {
9995
10040
  /**
9996
10041
  * ContentManagement service.
9997
10042
  * @module purecloud-platform-client-v2/api/ContentManagementApi
9998
- * @version 146.0.0
10043
+ * @version 148.0.0
9999
10044
  */
10000
10045
 
10001
10046
  /**
@@ -11135,7 +11180,7 @@ class ConversationsApi {
11135
11180
  /**
11136
11181
  * Conversations service.
11137
11182
  * @module purecloud-platform-client-v2/api/ConversationsApi
11138
- * @version 146.0.0
11183
+ * @version 148.0.0
11139
11184
  */
11140
11185
 
11141
11186
  /**
@@ -16279,7 +16324,7 @@ class DataExtensionsApi {
16279
16324
  /**
16280
16325
  * DataExtensions service.
16281
16326
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
16282
- * @version 146.0.0
16327
+ * @version 148.0.0
16283
16328
  */
16284
16329
 
16285
16330
  /**
@@ -16365,7 +16410,7 @@ class ExternalContactsApi {
16365
16410
  /**
16366
16411
  * ExternalContacts service.
16367
16412
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
16368
- * @version 146.0.0
16413
+ * @version 148.0.0
16369
16414
  */
16370
16415
 
16371
16416
  /**
@@ -18108,7 +18153,7 @@ class FaxApi {
18108
18153
  /**
18109
18154
  * Fax service.
18110
18155
  * @module purecloud-platform-client-v2/api/FaxApi
18111
- * @version 146.0.0
18156
+ * @version 148.0.0
18112
18157
  */
18113
18158
 
18114
18159
  /**
@@ -18279,7 +18324,7 @@ class FlowsApi {
18279
18324
  /**
18280
18325
  * Flows service.
18281
18326
  * @module purecloud-platform-client-v2/api/FlowsApi
18282
- * @version 146.0.0
18327
+ * @version 148.0.0
18283
18328
  */
18284
18329
 
18285
18330
  /**
@@ -18350,7 +18395,7 @@ class GamificationApi {
18350
18395
  /**
18351
18396
  * Gamification service.
18352
18397
  * @module purecloud-platform-client-v2/api/GamificationApi
18353
- * @version 146.0.0
18398
+ * @version 148.0.0
18354
18399
  */
18355
18400
 
18356
18401
  /**
@@ -18643,31 +18688,6 @@ class GamificationApi {
18643
18688
  );
18644
18689
  }
18645
18690
 
18646
- /**
18647
- * All gamified metrics for a given profile
18648
- * This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics instead.
18649
- * @param {Object} opts Optional parameters
18650
- * @param {String} opts.performanceProfileId The profile id of the metrics you are trying to retrieve. The DEFAULT profile is used if nothing is given.
18651
- * @param {String} opts.workday The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18652
- */
18653
- getGamificationMetrics(opts) {
18654
- opts = opts || {};
18655
-
18656
-
18657
- return this.apiClient.callApi(
18658
- '/api/v2/gamification/metrics',
18659
- 'GET',
18660
- { },
18661
- { 'performanceProfileId': opts['performanceProfileId'],'workday': opts['workday'] },
18662
- { },
18663
- { },
18664
- null,
18665
- ['PureCloud OAuth'],
18666
- ['application/json'],
18667
- ['application/json']
18668
- );
18669
- }
18670
-
18671
18691
  /**
18672
18692
  * Performance profile by id
18673
18693
  *
@@ -19723,31 +19743,6 @@ class GamificationApi {
19723
19743
  );
19724
19744
  }
19725
19745
 
19726
- /**
19727
- * Creates a gamified metric with a given metric definition and metric objective
19728
- * This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics instead.
19729
- * @param {Object} body Metric
19730
- */
19731
- postGamificationMetrics(body) {
19732
- // verify the required parameter 'body' is set
19733
- if (body === undefined || body === null) {
19734
- throw 'Missing the required parameter "body" when calling postGamificationMetrics';
19735
- }
19736
-
19737
- return this.apiClient.callApi(
19738
- '/api/v2/gamification/metrics',
19739
- 'POST',
19740
- { },
19741
- { },
19742
- { },
19743
- { },
19744
- body,
19745
- ['PureCloud OAuth'],
19746
- ['application/json'],
19747
- ['application/json']
19748
- );
19749
- }
19750
-
19751
19746
  /**
19752
19747
  * Activate a performance profile
19753
19748
  *
@@ -20081,7 +20076,7 @@ class GeneralDataProtectionRegulationApi {
20081
20076
  /**
20082
20077
  * GeneralDataProtectionRegulation service.
20083
20078
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
20084
- * @version 146.0.0
20079
+ * @version 148.0.0
20085
20080
  */
20086
20081
 
20087
20082
  /**
@@ -20211,7 +20206,7 @@ class GeolocationApi {
20211
20206
  /**
20212
20207
  * Geolocation service.
20213
20208
  * @module purecloud-platform-client-v2/api/GeolocationApi
20214
- * @version 146.0.0
20209
+ * @version 148.0.0
20215
20210
  */
20216
20211
 
20217
20212
  /**
@@ -20342,7 +20337,7 @@ class GreetingsApi {
20342
20337
  /**
20343
20338
  * Greetings service.
20344
20339
  * @module purecloud-platform-client-v2/api/GreetingsApi
20345
- * @version 146.0.0
20340
+ * @version 148.0.0
20346
20341
  */
20347
20342
 
20348
20343
  /**
@@ -20797,7 +20792,7 @@ class GroupsApi {
20797
20792
  /**
20798
20793
  * Groups service.
20799
20794
  * @module purecloud-platform-client-v2/api/GroupsApi
20800
- * @version 146.0.0
20795
+ * @version 148.0.0
20801
20796
  */
20802
20797
 
20803
20798
  /**
@@ -21067,6 +21062,7 @@ class GroupsApi {
21067
21062
  * @param {Number} opts.pageSize Page size (default to 25)
21068
21063
  * @param {Number} opts.pageNumber Page number (default to 1)
21069
21064
  * @param {Array.<String>} opts.id id
21065
+ * @param {Array.<String>} opts.jabberId A list of jabberIds to fetch by bulk (cannot be used with the id parameter)
21070
21066
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
21071
21067
  */
21072
21068
  getProfilesGroups(opts) {
@@ -21077,7 +21073,7 @@ class GroupsApi {
21077
21073
  '/api/v2/profiles/groups',
21078
21074
  'GET',
21079
21075
  { },
21080
- { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'sortOrder': opts['sortOrder'] },
21076
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'jabberId': this.apiClient.buildCollectionParam(opts['jabberId'], 'multi'),'sortOrder': opts['sortOrder'] },
21081
21077
  { },
21082
21078
  { },
21083
21079
  null,
@@ -21202,7 +21198,7 @@ class IdentityProviderApi {
21202
21198
  /**
21203
21199
  * IdentityProvider service.
21204
21200
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
21205
- * @version 146.0.0
21201
+ * @version 148.0.0
21206
21202
  */
21207
21203
 
21208
21204
  /**
@@ -21958,7 +21954,7 @@ class IntegrationsApi {
21958
21954
  /**
21959
21955
  * Integrations service.
21960
21956
  * @module purecloud-platform-client-v2/api/IntegrationsApi
21961
- * @version 146.0.0
21957
+ * @version 148.0.0
21962
21958
  */
21963
21959
 
21964
21960
  /**
@@ -22716,59 +22712,6 @@ class IntegrationsApi {
22716
22712
  );
22717
22713
  }
22718
22714
 
22719
- /**
22720
- * List all events
22721
- *
22722
- * @param {Object} opts Optional parameters
22723
- * @param {Number} opts.pageSize Page size (default to 25)
22724
- * @param {Number} opts.pageNumber Page number (default to 1)
22725
- * @param {String} opts.sortBy Sort by (default to timestamp)
22726
- * @param {String} opts.sortOrder Order by (default to descending)
22727
- * @param {String} opts.entityId Include only events with this entity ID
22728
- */
22729
- getIntegrationsEventlog(opts) {
22730
- opts = opts || {};
22731
-
22732
-
22733
- return this.apiClient.callApi(
22734
- '/api/v2/integrations/eventlog',
22735
- 'GET',
22736
- { },
22737
- { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'entityId': opts['entityId'] },
22738
- { },
22739
- { },
22740
- null,
22741
- ['PureCloud OAuth'],
22742
- ['application/json'],
22743
- ['application/json']
22744
- );
22745
- }
22746
-
22747
- /**
22748
- * Get a single event
22749
- *
22750
- * @param {String} eventId Event Id
22751
- */
22752
- getIntegrationsEventlogEventId(eventId) {
22753
- // verify the required parameter 'eventId' is set
22754
- if (eventId === undefined || eventId === null) {
22755
- throw 'Missing the required parameter "eventId" when calling getIntegrationsEventlogEventId';
22756
- }
22757
-
22758
- return this.apiClient.callApi(
22759
- '/api/v2/integrations/eventlog/{eventId}',
22760
- 'GET',
22761
- { 'eventId': eventId },
22762
- { },
22763
- { },
22764
- { },
22765
- null,
22766
- ['PureCloud OAuth'],
22767
- ['application/json'],
22768
- ['application/json']
22769
- );
22770
- }
22771
-
22772
22715
  /**
22773
22716
  * Get details about a Dialogflow agent
22774
22717
  *
@@ -23492,30 +23435,6 @@ class IntegrationsApi {
23492
23435
  );
23493
23436
  }
23494
23437
 
23495
- /**
23496
- * Add a vendor connection
23497
- *
23498
- * @param {Object} opts Optional parameters
23499
- * @param {Object} opts.body
23500
- */
23501
- postIntegrationsWorkforcemanagementVendorconnection(opts) {
23502
- opts = opts || {};
23503
-
23504
-
23505
- return this.apiClient.callApi(
23506
- '/api/v2/integrations/workforcemanagement/vendorconnection',
23507
- 'POST',
23508
- { },
23509
- { },
23510
- { },
23511
- { },
23512
- opts['body'],
23513
- ['PureCloud OAuth'],
23514
- ['application/json'],
23515
- ['application/json']
23516
- );
23517
- }
23518
-
23519
23438
  /**
23520
23439
  * Update integration configuration.
23521
23440
  *
@@ -23635,7 +23554,7 @@ class JourneyApi {
23635
23554
  /**
23636
23555
  * Journey service.
23637
23556
  * @module purecloud-platform-client-v2/api/JourneyApi
23638
- * @version 146.0.0
23557
+ * @version 148.0.0
23639
23558
  */
23640
23559
 
23641
23560
  /**
@@ -23810,6 +23729,56 @@ class JourneyApi {
23810
23729
  );
23811
23730
  }
23812
23731
 
23732
+ /**
23733
+ * Get status of job.
23734
+ *
23735
+ * @param {String} jobId ID of the job.
23736
+ */
23737
+ getJourneyActionmapsEstimatesJob(jobId) {
23738
+ // verify the required parameter 'jobId' is set
23739
+ if (jobId === undefined || jobId === null) {
23740
+ throw 'Missing the required parameter "jobId" when calling getJourneyActionmapsEstimatesJob';
23741
+ }
23742
+
23743
+ return this.apiClient.callApi(
23744
+ '/api/v2/journey/actionmaps/estimates/jobs/{jobId}',
23745
+ 'GET',
23746
+ { 'jobId': jobId },
23747
+ { },
23748
+ { },
23749
+ { },
23750
+ null,
23751
+ ['PureCloud OAuth'],
23752
+ ['application/json'],
23753
+ ['application/json']
23754
+ );
23755
+ }
23756
+
23757
+ /**
23758
+ * Get estimates from completed job.
23759
+ *
23760
+ * @param {String} jobId ID of the job.
23761
+ */
23762
+ getJourneyActionmapsEstimatesJobResults(jobId) {
23763
+ // verify the required parameter 'jobId' is set
23764
+ if (jobId === undefined || jobId === null) {
23765
+ throw 'Missing the required parameter "jobId" when calling getJourneyActionmapsEstimatesJobResults';
23766
+ }
23767
+
23768
+ return this.apiClient.callApi(
23769
+ '/api/v2/journey/actionmaps/estimates/jobs/{jobId}/results',
23770
+ 'GET',
23771
+ { 'jobId': jobId },
23772
+ { },
23773
+ { },
23774
+ { },
23775
+ null,
23776
+ ['PureCloud OAuth'],
23777
+ ['application/json'],
23778
+ ['application/json']
23779
+ );
23780
+ }
23781
+
23813
23782
  /**
23814
23783
  * Retrieve a single action target.
23815
23784
  *
@@ -24268,6 +24237,31 @@ class JourneyApi {
24268
24237
  );
24269
24238
  }
24270
24239
 
24240
+ /**
24241
+ * Query for estimates
24242
+ *
24243
+ * @param {Object} body audience estimator request
24244
+ */
24245
+ postJourneyActionmapsEstimatesJobs(body) {
24246
+ // verify the required parameter 'body' is set
24247
+ if (body === undefined || body === null) {
24248
+ throw 'Missing the required parameter "body" when calling postJourneyActionmapsEstimatesJobs';
24249
+ }
24250
+
24251
+ return this.apiClient.callApi(
24252
+ '/api/v2/journey/actionmaps/estimates/jobs',
24253
+ 'POST',
24254
+ { },
24255
+ { },
24256
+ { },
24257
+ { },
24258
+ body,
24259
+ ['PureCloud OAuth'],
24260
+ ['application/json'],
24261
+ ['application/json']
24262
+ );
24263
+ }
24264
+
24271
24265
  /**
24272
24266
  * Create a single action template.
24273
24267
  *
@@ -24346,7 +24340,7 @@ class KnowledgeApi {
24346
24340
  /**
24347
24341
  * Knowledge service.
24348
24342
  * @module purecloud-platform-client-v2/api/KnowledgeApi
24349
- * @version 146.0.0
24343
+ * @version 148.0.0
24350
24344
  */
24351
24345
 
24352
24346
  /**
@@ -25143,6 +25137,7 @@ class KnowledgeApi {
25143
25137
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
25144
25138
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
25145
25139
  * @param {String} opts.interval Retrieves the documents modified in specified date and time range. If the after and before cursor parameters are within this interval, it would return valid data, otherwise it throws an error.The dates in the interval are represented in ISO-8601 format: YYYY-MM-DDThh:mm:ssZ/YYYY-MM-DDThh:mm:ssZ
25140
+ * @param {Array.<String>} opts.documentId Retrieves the specified documents, comma separated values expected.
25146
25141
  * @param {Array.<String>} opts.categoryId If specified, retrieves documents associated with category ids, comma separated values expected.
25147
25142
  * @param {Boolean} opts.includeSubcategories Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories.
25148
25143
  * @param {Boolean} opts.includeDrafts If includeDrafts is true, Documents in the draft state are also returned in the response.
@@ -25161,7 +25156,7 @@ class KnowledgeApi {
25161
25156
  '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents',
25162
25157
  'GET',
25163
25158
  { 'knowledgeBaseId': knowledgeBaseId },
25164
- { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'interval': opts['interval'],'categoryId': this.apiClient.buildCollectionParam(opts['categoryId'], 'multi'),'includeSubcategories': opts['includeSubcategories'],'includeDrafts': opts['includeDrafts'],'labelIds': this.apiClient.buildCollectionParam(opts['labelIds'], 'multi'),'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
25159
+ { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'interval': opts['interval'],'documentId': this.apiClient.buildCollectionParam(opts['documentId'], 'multi'),'categoryId': this.apiClient.buildCollectionParam(opts['categoryId'], 'multi'),'includeSubcategories': opts['includeSubcategories'],'includeDrafts': opts['includeDrafts'],'labelIds': this.apiClient.buildCollectionParam(opts['labelIds'], 'multi'),'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
25165
25160
  { },
25166
25161
  { },
25167
25162
  null,
@@ -26778,7 +26773,7 @@ class LanguageUnderstandingApi {
26778
26773
  /**
26779
26774
  * LanguageUnderstanding service.
26780
26775
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
26781
- * @version 146.0.0
26776
+ * @version 148.0.0
26782
26777
  */
26783
26778
 
26784
26779
  /**
@@ -27682,7 +27677,7 @@ class LanguagesApi {
27682
27677
  /**
27683
27678
  * Languages service.
27684
27679
  * @module purecloud-platform-client-v2/api/LanguagesApi
27685
- * @version 146.0.0
27680
+ * @version 148.0.0
27686
27681
  */
27687
27682
 
27688
27683
  /**
@@ -27950,7 +27945,7 @@ class LearningApi {
27950
27945
  /**
27951
27946
  * Learning service.
27952
27947
  * @module purecloud-platform-client-v2/api/LearningApi
27953
- * @version 146.0.0
27948
+ * @version 148.0.0
27954
27949
  */
27955
27950
 
27956
27951
  /**
@@ -28710,7 +28705,7 @@ class LicenseApi {
28710
28705
  /**
28711
28706
  * License service.
28712
28707
  * @module purecloud-platform-client-v2/api/LicenseApi
28713
- * @version 146.0.0
28708
+ * @version 148.0.0
28714
28709
  */
28715
28710
 
28716
28711
  /**
@@ -28948,7 +28943,7 @@ class LocationsApi {
28948
28943
  /**
28949
28944
  * Locations service.
28950
28945
  * @module purecloud-platform-client-v2/api/LocationsApi
28951
- * @version 146.0.0
28946
+ * @version 148.0.0
28952
28947
  */
28953
28948
 
28954
28949
  /**
@@ -29184,7 +29179,7 @@ class MessagingApi {
29184
29179
  /**
29185
29180
  * Messaging service.
29186
29181
  * @module purecloud-platform-client-v2/api/MessagingApi
29187
- * @version 146.0.0
29182
+ * @version 148.0.0
29188
29183
  */
29189
29184
 
29190
29185
  /**
@@ -29335,7 +29330,7 @@ class MobileDevicesApi {
29335
29330
  /**
29336
29331
  * MobileDevices service.
29337
29332
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
29338
- * @version 146.0.0
29333
+ * @version 148.0.0
29339
29334
  */
29340
29335
 
29341
29336
  /**
@@ -29486,7 +29481,7 @@ class NotificationsApi {
29486
29481
  /**
29487
29482
  * Notifications service.
29488
29483
  * @module purecloud-platform-client-v2/api/NotificationsApi
29489
- * @version 146.0.0
29484
+ * @version 148.0.0
29490
29485
  */
29491
29486
 
29492
29487
  /**
@@ -29711,7 +29706,7 @@ class OAuthApi {
29711
29706
  /**
29712
29707
  * OAuth service.
29713
29708
  * @module purecloud-platform-client-v2/api/OAuthApi
29714
- * @version 146.0.0
29709
+ * @version 148.0.0
29715
29710
  */
29716
29711
 
29717
29712
  /**
@@ -30077,7 +30072,7 @@ class ObjectsApi {
30077
30072
  /**
30078
30073
  * Objects service.
30079
30074
  * @module purecloud-platform-client-v2/api/ObjectsApi
30080
- * @version 146.0.0
30075
+ * @version 148.0.0
30081
30076
  */
30082
30077
 
30083
30078
  /**
@@ -30348,7 +30343,7 @@ class OrganizationApi {
30348
30343
  /**
30349
30344
  * Organization service.
30350
30345
  * @module purecloud-platform-client-v2/api/OrganizationApi
30351
- * @version 146.0.0
30346
+ * @version 148.0.0
30352
30347
  */
30353
30348
 
30354
30349
  /**
@@ -30751,7 +30746,7 @@ class OrganizationAuthorizationApi {
30751
30746
  /**
30752
30747
  * OrganizationAuthorization service.
30753
30748
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
30754
- * @version 146.0.0
30749
+ * @version 148.0.0
30755
30750
  */
30756
30751
 
30757
30752
  /**
@@ -31676,7 +31671,7 @@ class OutboundApi {
31676
31671
  /**
31677
31672
  * Outbound service.
31678
31673
  * @module purecloud-platform-client-v2/api/OutboundApi
31679
- * @version 146.0.0
31674
+ * @version 148.0.0
31680
31675
  */
31681
31676
 
31682
31677
  /**
@@ -31976,6 +31971,31 @@ class OutboundApi {
31976
31971
  );
31977
31972
  }
31978
31973
 
31974
+ /**
31975
+ * Delete an Outbound Digital Rule Set
31976
+ *
31977
+ * @param {String} digitalRuleSetId The Digital Rule Set ID
31978
+ */
31979
+ deleteOutboundDigitalruleset(digitalRuleSetId) {
31980
+ // verify the required parameter 'digitalRuleSetId' is set
31981
+ if (digitalRuleSetId === undefined || digitalRuleSetId === null) {
31982
+ throw 'Missing the required parameter "digitalRuleSetId" when calling deleteOutboundDigitalruleset';
31983
+ }
31984
+
31985
+ return this.apiClient.callApi(
31986
+ '/api/v2/outbound/digitalrulesets/{digitalRuleSetId}',
31987
+ 'DELETE',
31988
+ { 'digitalRuleSetId': digitalRuleSetId },
31989
+ { },
31990
+ { },
31991
+ { },
31992
+ null,
31993
+ ['PureCloud OAuth'],
31994
+ ['application/json'],
31995
+ ['application/json']
31996
+ );
31997
+ }
31998
+
31979
31999
  /**
31980
32000
  * Delete dialer DNC list
31981
32001
  *
@@ -33013,6 +33033,60 @@ class OutboundApi {
33013
33033
  );
33014
33034
  }
33015
33035
 
33036
+ /**
33037
+ * Get an Outbound Digital Rule Set
33038
+ *
33039
+ * @param {String} digitalRuleSetId The Digital Rule Set ID
33040
+ */
33041
+ getOutboundDigitalruleset(digitalRuleSetId) {
33042
+ // verify the required parameter 'digitalRuleSetId' is set
33043
+ if (digitalRuleSetId === undefined || digitalRuleSetId === null) {
33044
+ throw 'Missing the required parameter "digitalRuleSetId" when calling getOutboundDigitalruleset';
33045
+ }
33046
+
33047
+ return this.apiClient.callApi(
33048
+ '/api/v2/outbound/digitalrulesets/{digitalRuleSetId}',
33049
+ 'GET',
33050
+ { 'digitalRuleSetId': digitalRuleSetId },
33051
+ { },
33052
+ { },
33053
+ { },
33054
+ null,
33055
+ ['PureCloud OAuth'],
33056
+ ['application/json'],
33057
+ ['application/json']
33058
+ );
33059
+ }
33060
+
33061
+ /**
33062
+ * Query a list of Outbound Digital Rule Sets
33063
+ *
33064
+ * @param {Object} opts Optional parameters
33065
+ * @param {Number} opts.pageSize Page size. The max that will be returned is 100. (default to 25)
33066
+ * @param {Number} opts.pageNumber Page number (default to 1)
33067
+ * @param {Object} opts.sortBy The field to sort by (default to name)
33068
+ * @param {Object} opts.sortOrder The direction to sort (default to ascending)
33069
+ * @param {String} opts.name Name
33070
+ * @param {Array.<String>} opts.id A list of digital rule set ids to bulk fetch
33071
+ */
33072
+ getOutboundDigitalrulesets(opts) {
33073
+ opts = opts || {};
33074
+
33075
+
33076
+ return this.apiClient.callApi(
33077
+ '/api/v2/outbound/digitalrulesets',
33078
+ 'GET',
33079
+ { },
33080
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi') },
33081
+ { },
33082
+ { },
33083
+ null,
33084
+ ['PureCloud OAuth'],
33085
+ ['application/json'],
33086
+ ['application/json']
33087
+ );
33088
+ }
33089
+
33016
33090
  /**
33017
33091
  * Get dialer DNC list
33018
33092
  *
@@ -34196,6 +34270,31 @@ class OutboundApi {
34196
34270
  );
34197
34271
  }
34198
34272
 
34273
+ /**
34274
+ * Create an Outbound Digital Rule Set
34275
+ *
34276
+ * @param {Object} body Digital Rule Set
34277
+ */
34278
+ postOutboundDigitalrulesets(body) {
34279
+ // verify the required parameter 'body' is set
34280
+ if (body === undefined || body === null) {
34281
+ throw 'Missing the required parameter "body" when calling postOutboundDigitalrulesets';
34282
+ }
34283
+
34284
+ return this.apiClient.callApi(
34285
+ '/api/v2/outbound/digitalrulesets',
34286
+ 'POST',
34287
+ { },
34288
+ { },
34289
+ { },
34290
+ { },
34291
+ body,
34292
+ ['PureCloud OAuth'],
34293
+ ['application/json'],
34294
+ ['application/json']
34295
+ );
34296
+ }
34297
+
34199
34298
  /**
34200
34299
  * Initiate the export of a dnc list.
34201
34300
  * Returns 200 if received OK.
@@ -34660,6 +34759,36 @@ class OutboundApi {
34660
34759
  );
34661
34760
  }
34662
34761
 
34762
+ /**
34763
+ * Update an Outbound Digital Rule Set
34764
+ *
34765
+ * @param {String} digitalRuleSetId The Digital Rule Set ID
34766
+ * @param {Object} body Digital Rule Set
34767
+ */
34768
+ putOutboundDigitalruleset(digitalRuleSetId, body) {
34769
+ // verify the required parameter 'digitalRuleSetId' is set
34770
+ if (digitalRuleSetId === undefined || digitalRuleSetId === null) {
34771
+ throw 'Missing the required parameter "digitalRuleSetId" when calling putOutboundDigitalruleset';
34772
+ }
34773
+ // verify the required parameter 'body' is set
34774
+ if (body === undefined || body === null) {
34775
+ throw 'Missing the required parameter "body" when calling putOutboundDigitalruleset';
34776
+ }
34777
+
34778
+ return this.apiClient.callApi(
34779
+ '/api/v2/outbound/digitalrulesets/{digitalRuleSetId}',
34780
+ 'PUT',
34781
+ { 'digitalRuleSetId': digitalRuleSetId },
34782
+ { },
34783
+ { },
34784
+ { },
34785
+ body,
34786
+ ['PureCloud OAuth'],
34787
+ ['application/json'],
34788
+ ['application/json']
34789
+ );
34790
+ }
34791
+
34663
34792
  /**
34664
34793
  * Update dialer DNC list
34665
34794
  *
@@ -34931,7 +35060,7 @@ class PresenceApi {
34931
35060
  /**
34932
35061
  * Presence service.
34933
35062
  * @module purecloud-platform-client-v2/api/PresenceApi
34934
- * @version 146.0.0
35063
+ * @version 148.0.0
34935
35064
  */
34936
35065
 
34937
35066
  /**
@@ -35249,11 +35378,249 @@ class PresenceApi {
35249
35378
 
35250
35379
  }
35251
35380
 
35381
+ class ProcessAutomationApi {
35382
+ /**
35383
+ * ProcessAutomation service.
35384
+ * @module purecloud-platform-client-v2/api/ProcessAutomationApi
35385
+ * @version 148.0.0
35386
+ */
35387
+
35388
+ /**
35389
+ * Constructs a new ProcessAutomationApi.
35390
+ * @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi
35391
+ * @class
35392
+ * @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
35393
+ * default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
35394
+ */
35395
+ constructor(apiClient) {
35396
+ this.apiClient = apiClient || ApiClient.instance;
35397
+ }
35398
+
35399
+
35400
+ /**
35401
+ * Delete a Trigger
35402
+ *
35403
+ * @param {String} triggerId triggerId
35404
+ */
35405
+ deleteProcessautomationTrigger(triggerId) {
35406
+ // verify the required parameter 'triggerId' is set
35407
+ if (triggerId === undefined || triggerId === null) {
35408
+ throw 'Missing the required parameter "triggerId" when calling deleteProcessautomationTrigger';
35409
+ }
35410
+
35411
+ return this.apiClient.callApi(
35412
+ '/api/v2/processautomation/triggers/{triggerId}',
35413
+ 'DELETE',
35414
+ { 'triggerId': triggerId },
35415
+ { },
35416
+ { },
35417
+ { },
35418
+ null,
35419
+ ['PureCloud OAuth'],
35420
+ ['application/json'],
35421
+ ['application/json']
35422
+ );
35423
+ }
35424
+
35425
+ /**
35426
+ * Retrieve a single Trigger matching id.
35427
+ *
35428
+ * @param {String} triggerId triggerId
35429
+ */
35430
+ getProcessautomationTrigger(triggerId) {
35431
+ // verify the required parameter 'triggerId' is set
35432
+ if (triggerId === undefined || triggerId === null) {
35433
+ throw 'Missing the required parameter "triggerId" when calling getProcessautomationTrigger';
35434
+ }
35435
+
35436
+ return this.apiClient.callApi(
35437
+ '/api/v2/processautomation/triggers/{triggerId}',
35438
+ 'GET',
35439
+ { 'triggerId': triggerId },
35440
+ { },
35441
+ { },
35442
+ { },
35443
+ null,
35444
+ ['PureCloud OAuth'],
35445
+ ['application/json'],
35446
+ ['application/json']
35447
+ );
35448
+ }
35449
+
35450
+ /**
35451
+ * Retrieves all triggers
35452
+ *
35453
+ * @param {Object} opts Optional parameters
35454
+ * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
35455
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
35456
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
35457
+ * @param {String} opts.topicName Topic name
35458
+ * @param {Boolean} opts.enabled Boolean indicating desired enabled state of triggers
35459
+ */
35460
+ getProcessautomationTriggers(opts) {
35461
+ opts = opts || {};
35462
+
35463
+
35464
+ return this.apiClient.callApi(
35465
+ '/api/v2/processautomation/triggers',
35466
+ 'GET',
35467
+ { },
35468
+ { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'topicName': opts['topicName'],'enabled': opts['enabled'] },
35469
+ { },
35470
+ { },
35471
+ null,
35472
+ ['PureCloud OAuth'],
35473
+ ['application/json'],
35474
+ ['application/json']
35475
+ );
35476
+ }
35477
+
35478
+ /**
35479
+ * Get topics available for organization
35480
+ *
35481
+ * @param {Object} opts Optional parameters
35482
+ * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
35483
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
35484
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
35485
+ */
35486
+ getProcessautomationTriggersTopics(opts) {
35487
+ opts = opts || {};
35488
+
35489
+
35490
+ return this.apiClient.callApi(
35491
+ '/api/v2/processautomation/triggers/topics',
35492
+ 'GET',
35493
+ { },
35494
+ { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'] },
35495
+ { },
35496
+ { },
35497
+ null,
35498
+ ['PureCloud OAuth'],
35499
+ ['application/json'],
35500
+ ['application/json']
35501
+ );
35502
+ }
35503
+
35504
+ /**
35505
+ * Test the matching of a Trigger based on provided event body
35506
+ *
35507
+ * @param {String} triggerId triggerId
35508
+ * @param {Object} opts Optional parameters
35509
+ * @param {String} opts.body eventBody
35510
+ */
35511
+ postProcessautomationTriggerTest(triggerId, opts) {
35512
+ opts = opts || {};
35513
+
35514
+ // verify the required parameter 'triggerId' is set
35515
+ if (triggerId === undefined || triggerId === null) {
35516
+ throw 'Missing the required parameter "triggerId" when calling postProcessautomationTriggerTest';
35517
+ }
35518
+
35519
+ return this.apiClient.callApi(
35520
+ '/api/v2/processautomation/triggers/{triggerId}/test',
35521
+ 'POST',
35522
+ { 'triggerId': triggerId },
35523
+ { },
35524
+ { },
35525
+ { },
35526
+ opts['body'],
35527
+ ['PureCloud OAuth'],
35528
+ ['application/json'],
35529
+ ['application/json']
35530
+ );
35531
+ }
35532
+
35533
+ /**
35534
+ * Create a Trigger
35535
+ *
35536
+ * @param {Object} body Input used to create a Trigger.
35537
+ */
35538
+ postProcessautomationTriggers(body) {
35539
+ // verify the required parameter 'body' is set
35540
+ if (body === undefined || body === null) {
35541
+ throw 'Missing the required parameter "body" when calling postProcessautomationTriggers';
35542
+ }
35543
+
35544
+ return this.apiClient.callApi(
35545
+ '/api/v2/processautomation/triggers',
35546
+ 'POST',
35547
+ { },
35548
+ { },
35549
+ { },
35550
+ { },
35551
+ body,
35552
+ ['PureCloud OAuth'],
35553
+ ['application/json'],
35554
+ ['application/json']
35555
+ );
35556
+ }
35557
+
35558
+ /**
35559
+ * Test the matching of all organization Triggers on given topic using provided event body
35560
+ *
35561
+ * @param {String} topicName topicName
35562
+ * @param {Object} opts Optional parameters
35563
+ * @param {String} opts.body eventBody
35564
+ */
35565
+ postProcessautomationTriggersTopicTest(topicName, opts) {
35566
+ opts = opts || {};
35567
+
35568
+ // verify the required parameter 'topicName' is set
35569
+ if (topicName === undefined || topicName === null) {
35570
+ throw 'Missing the required parameter "topicName" when calling postProcessautomationTriggersTopicTest';
35571
+ }
35572
+
35573
+ return this.apiClient.callApi(
35574
+ '/api/v2/processautomation/triggers/topics/{topicName}/test',
35575
+ 'POST',
35576
+ { 'topicName': topicName },
35577
+ { },
35578
+ { },
35579
+ { },
35580
+ opts['body'],
35581
+ ['PureCloud OAuth'],
35582
+ ['application/json'],
35583
+ ['application/json']
35584
+ );
35585
+ }
35586
+
35587
+ /**
35588
+ * Update a Trigger
35589
+ *
35590
+ * @param {String} triggerId triggerId
35591
+ * @param {Object} body Input to update Trigger. (topicName cannot be updated, a new trigger must be created to use a new topicName)
35592
+ */
35593
+ putProcessautomationTrigger(triggerId, body) {
35594
+ // verify the required parameter 'triggerId' is set
35595
+ if (triggerId === undefined || triggerId === null) {
35596
+ throw 'Missing the required parameter "triggerId" when calling putProcessautomationTrigger';
35597
+ }
35598
+ // verify the required parameter 'body' is set
35599
+ if (body === undefined || body === null) {
35600
+ throw 'Missing the required parameter "body" when calling putProcessautomationTrigger';
35601
+ }
35602
+
35603
+ return this.apiClient.callApi(
35604
+ '/api/v2/processautomation/triggers/{triggerId}',
35605
+ 'PUT',
35606
+ { 'triggerId': triggerId },
35607
+ { },
35608
+ { },
35609
+ { },
35610
+ body,
35611
+ ['PureCloud OAuth'],
35612
+ ['application/json'],
35613
+ ['application/json']
35614
+ );
35615
+ }
35616
+
35617
+ }
35618
+
35252
35619
  class QualityApi {
35253
35620
  /**
35254
35621
  * Quality service.
35255
35622
  * @module purecloud-platform-client-v2/api/QualityApi
35256
- * @version 146.0.0
35623
+ * @version 148.0.0
35257
35624
  */
35258
35625
 
35259
35626
  /**
@@ -35763,7 +36130,7 @@ class QualityApi {
35763
36130
  * @param {String} opts.sortBy variable name requested to sort by
35764
36131
  * @param {String} opts.nextPage next page token
35765
36132
  * @param {String} opts.previousPage Previous page token
35766
- * @param {String} opts.expand Expand
36133
+ * @param {Object} opts.expand If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions
35767
36134
  * @param {String} opts.name Name
35768
36135
  * @param {String} opts.sortOrder Order to sort results, either asc or desc
35769
36136
  */
@@ -35850,7 +36217,7 @@ class QualityApi {
35850
36217
  * @param {String} opts.sortBy variable name requested to sort by
35851
36218
  * @param {String} opts.nextPage next page token
35852
36219
  * @param {String} opts.previousPage Previous page token
35853
- * @param {String} opts.expand Expand
36220
+ * @param {Object} opts.expand If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions
35854
36221
  * @param {String} opts.name Name
35855
36222
  * @param {String} opts.sortOrder Order to sort results, either asc or desc
35856
36223
  */
@@ -35961,7 +36328,7 @@ class QualityApi {
35961
36328
  * @param {String} opts.sortBy variable name requested to sort by
35962
36329
  * @param {String} opts.nextPage next page token
35963
36330
  * @param {String} opts.previousPage Previous page token
35964
- * @param {String} opts.expand Expand
36331
+ * @param {Object} opts.expand If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions
35965
36332
  * @param {String} opts.name Name
35966
36333
  * @param {String} opts.sortOrder Order to sort results, either asc or desc
35967
36334
  */
@@ -36831,7 +37198,7 @@ class RecordingApi {
36831
37198
  /**
36832
37199
  * Recording service.
36833
37200
  * @module purecloud-platform-client-v2/api/RecordingApi
36834
- * @version 146.0.0
37201
+ * @version 148.0.0
36835
37202
  */
36836
37203
 
36837
37204
  /**
@@ -37705,6 +38072,36 @@ class RecordingApi {
37705
38072
  );
37706
38073
  }
37707
38074
 
38075
+ /**
38076
+ * Query for recording retention data
38077
+ *
38078
+ * @param {Number} retentionThresholdDays Fetch retention data for recordings retained for more days than the provided value.
38079
+ * @param {Object} opts Optional parameters
38080
+ * @param {String} opts.cursor Indicates where to resume query results (not required for first page)
38081
+ * @param {Number} opts.pageSize Page size. Maximum is 500. (default to 25)
38082
+ */
38083
+ getRecordingsRetentionQuery(retentionThresholdDays, opts) {
38084
+ opts = opts || {};
38085
+
38086
+ // verify the required parameter 'retentionThresholdDays' is set
38087
+ if (retentionThresholdDays === undefined || retentionThresholdDays === null) {
38088
+ throw 'Missing the required parameter "retentionThresholdDays" when calling getRecordingsRetentionQuery';
38089
+ }
38090
+
38091
+ return this.apiClient.callApi(
38092
+ '/api/v2/recordings/retention/query',
38093
+ 'GET',
38094
+ { },
38095
+ { 'retentionThresholdDays': retentionThresholdDays,'cursor': opts['cursor'],'pageSize': opts['pageSize'] },
38096
+ { },
38097
+ { },
38098
+ null,
38099
+ ['PureCloud OAuth'],
38100
+ ['application/json'],
38101
+ ['application/json']
38102
+ );
38103
+ }
38104
+
37708
38105
  /**
37709
38106
  * Retrieves a paged listing of screen recording sessions
37710
38107
  *
@@ -38484,7 +38881,7 @@ class ResponseManagementApi {
38484
38881
  /**
38485
38882
  * ResponseManagement service.
38486
38883
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
38487
- * @version 146.0.0
38884
+ * @version 148.0.0
38488
38885
  */
38489
38886
 
38490
38887
  /**
@@ -38968,7 +39365,7 @@ class RoutingApi {
38968
39365
  /**
38969
39366
  * Routing service.
38970
39367
  * @module purecloud-platform-client-v2/api/RoutingApi
38971
- * @version 146.0.0
39368
+ * @version 148.0.0
38972
39369
  */
38973
39370
 
38974
39371
  /**
@@ -41909,7 +42306,7 @@ class SCIMApi {
41909
42306
  /**
41910
42307
  * SCIM service.
41911
42308
  * @module purecloud-platform-client-v2/api/SCIMApi
41912
- * @version 146.0.0
42309
+ * @version 148.0.0
41913
42310
  */
41914
42311
 
41915
42312
  /**
@@ -42786,7 +43183,7 @@ class ScriptsApi {
42786
43183
  /**
42787
43184
  * Scripts service.
42788
43185
  * @module purecloud-platform-client-v2/api/ScriptsApi
42789
- * @version 146.0.0
43186
+ * @version 148.0.0
42790
43187
  */
42791
43188
 
42792
43189
  /**
@@ -43205,7 +43602,7 @@ class SearchApi {
43205
43602
  /**
43206
43603
  * Search service.
43207
43604
  * @module purecloud-platform-client-v2/api/SearchApi
43208
- * @version 146.0.0
43605
+ * @version 148.0.0
43209
43606
  */
43210
43607
 
43211
43608
  /**
@@ -43765,7 +44162,7 @@ class SpeechTextAnalyticsApi {
43765
44162
  /**
43766
44163
  * SpeechTextAnalytics service.
43767
44164
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
43768
- * @version 146.0.0
44165
+ * @version 148.0.0
43769
44166
  */
43770
44167
 
43771
44168
  /**
@@ -44619,7 +45016,7 @@ class StationsApi {
44619
45016
  /**
44620
45017
  * Stations service.
44621
45018
  * @module purecloud-platform-client-v2/api/StationsApi
44622
- * @version 146.0.0
45019
+ * @version 148.0.0
44623
45020
  */
44624
45021
 
44625
45022
  /**
@@ -44766,7 +45163,7 @@ class SuggestApi {
44766
45163
  /**
44767
45164
  * Suggest service.
44768
45165
  * @module purecloud-platform-client-v2/api/SuggestApi
44769
- * @version 146.0.0
45166
+ * @version 148.0.0
44770
45167
  */
44771
45168
 
44772
45169
  /**
@@ -44905,7 +45302,7 @@ class TeamsApi {
44905
45302
  /**
44906
45303
  * Teams service.
44907
45304
  * @module purecloud-platform-client-v2/api/TeamsApi
44908
- * @version 146.0.0
45305
+ * @version 148.0.0
44909
45306
  */
44910
45307
 
44911
45308
  /**
@@ -45084,7 +45481,7 @@ class TelephonyApi {
45084
45481
  /**
45085
45482
  * Telephony service.
45086
45483
  * @module purecloud-platform-client-v2/api/TelephonyApi
45087
- * @version 146.0.0
45484
+ * @version 148.0.0
45088
45485
  */
45089
45486
 
45090
45487
  /**
@@ -45192,7 +45589,7 @@ class TelephonyProvidersEdgeApi {
45192
45589
  /**
45193
45590
  * TelephonyProvidersEdge service.
45194
45591
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
45195
- * @version 146.0.0
45592
+ * @version 148.0.0
45196
45593
  */
45197
45594
 
45198
45595
  /**
@@ -48825,7 +49222,7 @@ class TextbotsApi {
48825
49222
  /**
48826
49223
  * Textbots service.
48827
49224
  * @module purecloud-platform-client-v2/api/TextbotsApi
48828
- * @version 146.0.0
49225
+ * @version 148.0.0
48829
49226
  */
48830
49227
 
48831
49228
  /**
@@ -48953,7 +49350,7 @@ class TokensApi {
48953
49350
  /**
48954
49351
  * Tokens service.
48955
49352
  * @module purecloud-platform-client-v2/api/TokensApi
48956
- * @version 146.0.0
49353
+ * @version 148.0.0
48957
49354
  */
48958
49355
 
48959
49356
  /**
@@ -49059,7 +49456,7 @@ class UploadsApi {
49059
49456
  /**
49060
49457
  * Uploads service.
49061
49458
  * @module purecloud-platform-client-v2/api/UploadsApi
49062
- * @version 146.0.0
49459
+ * @version 148.0.0
49063
49460
  */
49064
49461
 
49065
49462
  /**
@@ -49235,7 +49632,7 @@ class UsageApi {
49235
49632
  /**
49236
49633
  * Usage service.
49237
49634
  * @module purecloud-platform-client-v2/api/UsageApi
49238
- * @version 146.0.0
49635
+ * @version 148.0.0
49239
49636
  */
49240
49637
 
49241
49638
  /**
@@ -49306,7 +49703,7 @@ class UserRecordingsApi {
49306
49703
  /**
49307
49704
  * UserRecordings service.
49308
49705
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
49309
- * @version 146.0.0
49706
+ * @version 148.0.0
49310
49707
  */
49311
49708
 
49312
49709
  /**
@@ -49381,6 +49778,7 @@ class UserRecordingsApi {
49381
49778
  * @param {String} recordingId User Recording ID
49382
49779
  * @param {Object} opts Optional parameters
49383
49780
  * @param {Object} opts.formatId The desired media format. (default to WEBM)
49781
+ * @param {Boolean} opts.async When set to true, api will return 202 response until the recording is ready for download
49384
49782
  */
49385
49783
  getUserrecordingMedia(recordingId, opts) {
49386
49784
  opts = opts || {};
@@ -49394,7 +49792,7 @@ class UserRecordingsApi {
49394
49792
  '/api/v2/userrecordings/{recordingId}/media',
49395
49793
  'GET',
49396
49794
  { 'recordingId': recordingId },
49397
- { 'formatId': opts['formatId'] },
49795
+ { 'formatId': opts['formatId'],'async': opts['async'] },
49398
49796
  { },
49399
49797
  { },
49400
49798
  null,
@@ -49490,7 +49888,7 @@ class UsersApi {
49490
49888
  /**
49491
49889
  * Users service.
49492
49890
  * @module purecloud-platform-client-v2/api/UsersApi
49493
- * @version 146.0.0
49891
+ * @version 148.0.0
49494
49892
  */
49495
49893
 
49496
49894
  /**
@@ -51232,6 +51630,36 @@ class UsersApi {
51232
51630
  );
51233
51631
  }
51234
51632
 
51633
+ /**
51634
+ * Create mapping between external identifier and user. Limit 100 per entity.
51635
+ * Authority Name and External key are case sensitive.
51636
+ * @param {String} userId User ID
51637
+ * @param {Object} body
51638
+ */
51639
+ postUserExternalid(userId, body) {
51640
+ // verify the required parameter 'userId' is set
51641
+ if (userId === undefined || userId === null) {
51642
+ throw 'Missing the required parameter "userId" when calling postUserExternalid';
51643
+ }
51644
+ // verify the required parameter 'body' is set
51645
+ if (body === undefined || body === null) {
51646
+ throw 'Missing the required parameter "body" when calling postUserExternalid';
51647
+ }
51648
+
51649
+ return this.apiClient.callApi(
51650
+ '/api/v2/users/{userId}/externalid',
51651
+ 'POST',
51652
+ { 'userId': userId },
51653
+ { },
51654
+ { },
51655
+ { },
51656
+ body,
51657
+ ['PureCloud OAuth'],
51658
+ ['application/json'],
51659
+ ['application/json']
51660
+ );
51661
+ }
51662
+
51235
51663
  /**
51236
51664
  * Send an activation email to the user
51237
51665
  *
@@ -51792,7 +52220,7 @@ class UtilitiesApi {
51792
52220
  /**
51793
52221
  * Utilities service.
51794
52222
  * @module purecloud-platform-client-v2/api/UtilitiesApi
51795
- * @version 146.0.0
52223
+ * @version 148.0.0
51796
52224
  */
51797
52225
 
51798
52226
  /**
@@ -51903,7 +52331,7 @@ class VoicemailApi {
51903
52331
  /**
51904
52332
  * Voicemail service.
51905
52333
  * @module purecloud-platform-client-v2/api/VoicemailApi
51906
- * @version 146.0.0
52334
+ * @version 148.0.0
51907
52335
  */
51908
52336
 
51909
52337
  /**
@@ -52570,7 +52998,7 @@ class WebChatApi {
52570
52998
  /**
52571
52999
  * WebChat service.
52572
53000
  * @module purecloud-platform-client-v2/api/WebChatApi
52573
- * @version 146.0.0
53001
+ * @version 148.0.0
52574
53002
  */
52575
53003
 
52576
53004
  /**
@@ -53114,7 +53542,7 @@ class WebDeploymentsApi {
53114
53542
  /**
53115
53543
  * WebDeployments service.
53116
53544
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
53117
- * @version 146.0.0
53545
+ * @version 148.0.0
53118
53546
  */
53119
53547
 
53120
53548
  /**
@@ -53308,6 +53736,35 @@ class WebDeploymentsApi {
53308
53736
  );
53309
53737
  }
53310
53738
 
53739
+ /**
53740
+ * Get active configuration for a given deployment
53741
+ *
53742
+ * @param {String} deploymentId The deployment ID
53743
+ * @param {Object} opts Optional parameters
53744
+ * @param {String} opts.type Get active configuration on a deployment
53745
+ */
53746
+ getWebdeploymentsDeploymentConfigurations(deploymentId, opts) {
53747
+ opts = opts || {};
53748
+
53749
+ // verify the required parameter 'deploymentId' is set
53750
+ if (deploymentId === undefined || deploymentId === null) {
53751
+ throw 'Missing the required parameter "deploymentId" when calling getWebdeploymentsDeploymentConfigurations';
53752
+ }
53753
+
53754
+ return this.apiClient.callApi(
53755
+ '/api/v2/webdeployments/deployments/{deploymentId}/configurations',
53756
+ 'GET',
53757
+ { 'deploymentId': deploymentId },
53758
+ { 'type': opts['type'] },
53759
+ { },
53760
+ { },
53761
+ null,
53762
+ ['PureCloud OAuth'],
53763
+ ['application/json'],
53764
+ ['application/json']
53765
+ );
53766
+ }
53767
+
53311
53768
  /**
53312
53769
  * Get deployments
53313
53770
  *
@@ -53469,7 +53926,7 @@ class WebMessagingApi {
53469
53926
  /**
53470
53927
  * WebMessaging service.
53471
53928
  * @module purecloud-platform-client-v2/api/WebMessagingApi
53472
- * @version 146.0.0
53929
+ * @version 148.0.0
53473
53930
  */
53474
53931
 
53475
53932
  /**
@@ -53515,7 +53972,7 @@ class WidgetsApi {
53515
53972
  /**
53516
53973
  * Widgets service.
53517
53974
  * @module purecloud-platform-client-v2/api/WidgetsApi
53518
- * @version 146.0.0
53975
+ * @version 148.0.0
53519
53976
  */
53520
53977
 
53521
53978
  /**
@@ -53661,7 +54118,7 @@ class WorkforceManagementApi {
53661
54118
  /**
53662
54119
  * WorkforceManagement service.
53663
54120
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
53664
- * @version 146.0.0
54121
+ * @version 148.0.0
53665
54122
  */
53666
54123
 
53667
54124
  /**
@@ -57937,7 +58394,7 @@ class WorkforceManagementApi {
57937
58394
  * </pre>
57938
58395
  * </p>
57939
58396
  * @module purecloud-platform-client-v2/index
57940
- * @version 146.0.0
58397
+ * @version 148.0.0
57941
58398
  */
57942
58399
  class platformClient {
57943
58400
  constructor() {
@@ -58136,6 +58593,11 @@ class platformClient {
58136
58593
  * @property {module:purecloud-platform-client-v2/api/PresenceApi}
58137
58594
  */
58138
58595
  this.PresenceApi = PresenceApi;
58596
+ /**
58597
+ * The ProcessAutomationApi service constructor.
58598
+ * @property {module:purecloud-platform-client-v2/api/ProcessAutomationApi}
58599
+ */
58600
+ this.ProcessAutomationApi = ProcessAutomationApi;
58139
58601
  /**
58140
58602
  * The QualityApi service constructor.
58141
58603
  * @property {module:purecloud-platform-client-v2/api/QualityApi}