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
@@ -399,7 +399,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
399
399
 
400
400
  /**
401
401
  * @module purecloud-platform-client-v2/ApiClient
402
- * @version 146.0.0
402
+ * @version 148.0.0
403
403
  */
404
404
  class ApiClient {
405
405
  /**
@@ -1478,7 +1478,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
1478
1478
  /**
1479
1479
  * Alerting service.
1480
1480
  * @module purecloud-platform-client-v2/api/AlertingApi
1481
- * @version 146.0.0
1481
+ * @version 148.0.0
1482
1482
  */
1483
1483
 
1484
1484
  /**
@@ -1792,7 +1792,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
1792
1792
  /**
1793
1793
  * Analytics service.
1794
1794
  * @module purecloud-platform-client-v2/api/AnalyticsApi
1795
- * @version 146.0.0
1795
+ * @version 148.0.0
1796
1796
  */
1797
1797
 
1798
1798
  /**
@@ -2038,6 +2038,26 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2038
2038
  );
2039
2039
  }
2040
2040
 
2041
+ /**
2042
+ * Get analytics data retention setting
2043
+ *
2044
+ */
2045
+ getAnalyticsDataretentionSettings() {
2046
+
2047
+ return this.apiClient.callApi(
2048
+ '/api/v2/analytics/dataretention/settings',
2049
+ 'GET',
2050
+ { },
2051
+ { },
2052
+ { },
2053
+ { },
2054
+ null,
2055
+ ['PureCloud OAuth'],
2056
+ ['application/json'],
2057
+ ['application/json']
2058
+ );
2059
+ }
2060
+
2041
2061
  /**
2042
2062
  * Get all view export requests for a user
2043
2063
  *
@@ -2938,6 +2958,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2938
2958
  );
2939
2959
  }
2940
2960
 
2961
+ /**
2962
+ * Update analytics data retention setting
2963
+ *
2964
+ * @param {Object} body retentionDays
2965
+ */
2966
+ putAnalyticsDataretentionSettings(body) {
2967
+ // verify the required parameter 'body' is set
2968
+ if (body === undefined || body === null) {
2969
+ throw 'Missing the required parameter "body" when calling putAnalyticsDataretentionSettings';
2970
+ }
2971
+
2972
+ return this.apiClient.callApi(
2973
+ '/api/v2/analytics/dataretention/settings',
2974
+ 'PUT',
2975
+ { },
2976
+ { },
2977
+ { },
2978
+ { },
2979
+ body,
2980
+ ['PureCloud OAuth'],
2981
+ ['application/json'],
2982
+ ['application/json']
2983
+ );
2984
+ }
2985
+
2941
2986
  /**
2942
2987
  * Update a scheduled report job.
2943
2988
  *
@@ -2974,7 +3019,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2974
3019
  /**
2975
3020
  * Architect service.
2976
3021
  * @module purecloud-platform-client-v2/api/ArchitectApi
2977
- * @version 146.0.0
3022
+ * @version 148.0.0
2978
3023
  */
2979
3024
 
2980
3025
  /**
@@ -6020,7 +6065,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
6020
6065
  /**
6021
6066
  * Audit service.
6022
6067
  * @module purecloud-platform-client-v2/api/AuditApi
6023
- * @version 146.0.0
6068
+ * @version 148.0.0
6024
6069
  */
6025
6070
 
6026
6071
  /**
@@ -6191,7 +6236,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
6191
6236
  /**
6192
6237
  * Authorization service.
6193
6238
  * @module purecloud-platform-client-v2/api/AuthorizationApi
6194
- * @version 146.0.0
6239
+ * @version 148.0.0
6195
6240
  */
6196
6241
 
6197
6242
  /**
@@ -7374,7 +7419,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
7374
7419
  /**
7375
7420
  * Billing service.
7376
7421
  * @module purecloud-platform-client-v2/api/BillingApi
7377
- * @version 146.0.0
7422
+ * @version 148.0.0
7378
7423
  */
7379
7424
 
7380
7425
  /**
@@ -7454,7 +7499,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
7454
7499
  /**
7455
7500
  * Chat service.
7456
7501
  * @module purecloud-platform-client-v2/api/ChatApi
7457
- * @version 146.0.0
7502
+ * @version 148.0.0
7458
7503
  */
7459
7504
 
7460
7505
  /**
@@ -7545,7 +7590,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
7545
7590
  /**
7546
7591
  * Coaching service.
7547
7592
  * @module purecloud-platform-client-v2/api/CoachingApi
7548
- * @version 146.0.0
7593
+ * @version 148.0.0
7549
7594
  */
7550
7595
 
7551
7596
  /**
@@ -8122,7 +8167,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
8122
8167
  /**
8123
8168
  * ContentManagement service.
8124
8169
  * @module purecloud-platform-client-v2/api/ContentManagementApi
8125
- * @version 146.0.0
8170
+ * @version 148.0.0
8126
8171
  */
8127
8172
 
8128
8173
  /**
@@ -9262,7 +9307,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
9262
9307
  /**
9263
9308
  * Conversations service.
9264
9309
  * @module purecloud-platform-client-v2/api/ConversationsApi
9265
- * @version 146.0.0
9310
+ * @version 148.0.0
9266
9311
  */
9267
9312
 
9268
9313
  /**
@@ -14406,7 +14451,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
14406
14451
  /**
14407
14452
  * DataExtensions service.
14408
14453
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
14409
- * @version 146.0.0
14454
+ * @version 148.0.0
14410
14455
  */
14411
14456
 
14412
14457
  /**
@@ -14492,7 +14537,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
14492
14537
  /**
14493
14538
  * ExternalContacts service.
14494
14539
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
14495
- * @version 146.0.0
14540
+ * @version 148.0.0
14496
14541
  */
14497
14542
 
14498
14543
  /**
@@ -16235,7 +16280,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
16235
16280
  /**
16236
16281
  * Fax service.
16237
16282
  * @module purecloud-platform-client-v2/api/FaxApi
16238
- * @version 146.0.0
16283
+ * @version 148.0.0
16239
16284
  */
16240
16285
 
16241
16286
  /**
@@ -16406,7 +16451,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
16406
16451
  /**
16407
16452
  * Flows service.
16408
16453
  * @module purecloud-platform-client-v2/api/FlowsApi
16409
- * @version 146.0.0
16454
+ * @version 148.0.0
16410
16455
  */
16411
16456
 
16412
16457
  /**
@@ -16477,7 +16522,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
16477
16522
  /**
16478
16523
  * Gamification service.
16479
16524
  * @module purecloud-platform-client-v2/api/GamificationApi
16480
- * @version 146.0.0
16525
+ * @version 148.0.0
16481
16526
  */
16482
16527
 
16483
16528
  /**
@@ -16770,31 +16815,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
16770
16815
  );
16771
16816
  }
16772
16817
 
16773
- /**
16774
- * All gamified metrics for a given profile
16775
- * This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics instead.
16776
- * @param {Object} opts Optional parameters
16777
- * @param {String} opts.performanceProfileId The profile id of the metrics you are trying to retrieve. The DEFAULT profile is used if nothing is given.
16778
- * @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
16779
- */
16780
- getGamificationMetrics(opts) {
16781
- opts = opts || {};
16782
-
16783
-
16784
- return this.apiClient.callApi(
16785
- '/api/v2/gamification/metrics',
16786
- 'GET',
16787
- { },
16788
- { 'performanceProfileId': opts['performanceProfileId'],'workday': opts['workday'] },
16789
- { },
16790
- { },
16791
- null,
16792
- ['PureCloud OAuth'],
16793
- ['application/json'],
16794
- ['application/json']
16795
- );
16796
- }
16797
-
16798
16818
  /**
16799
16819
  * Performance profile by id
16800
16820
  *
@@ -17850,31 +17870,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
17850
17870
  );
17851
17871
  }
17852
17872
 
17853
- /**
17854
- * Creates a gamified metric with a given metric definition and metric objective
17855
- * This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics instead.
17856
- * @param {Object} body Metric
17857
- */
17858
- postGamificationMetrics(body) {
17859
- // verify the required parameter 'body' is set
17860
- if (body === undefined || body === null) {
17861
- throw 'Missing the required parameter "body" when calling postGamificationMetrics';
17862
- }
17863
-
17864
- return this.apiClient.callApi(
17865
- '/api/v2/gamification/metrics',
17866
- 'POST',
17867
- { },
17868
- { },
17869
- { },
17870
- { },
17871
- body,
17872
- ['PureCloud OAuth'],
17873
- ['application/json'],
17874
- ['application/json']
17875
- );
17876
- }
17877
-
17878
17873
  /**
17879
17874
  * Activate a performance profile
17880
17875
  *
@@ -18208,7 +18203,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
18208
18203
  /**
18209
18204
  * GeneralDataProtectionRegulation service.
18210
18205
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
18211
- * @version 146.0.0
18206
+ * @version 148.0.0
18212
18207
  */
18213
18208
 
18214
18209
  /**
@@ -18338,7 +18333,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
18338
18333
  /**
18339
18334
  * Geolocation service.
18340
18335
  * @module purecloud-platform-client-v2/api/GeolocationApi
18341
- * @version 146.0.0
18336
+ * @version 148.0.0
18342
18337
  */
18343
18338
 
18344
18339
  /**
@@ -18469,7 +18464,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
18469
18464
  /**
18470
18465
  * Greetings service.
18471
18466
  * @module purecloud-platform-client-v2/api/GreetingsApi
18472
- * @version 146.0.0
18467
+ * @version 148.0.0
18473
18468
  */
18474
18469
 
18475
18470
  /**
@@ -18924,7 +18919,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
18924
18919
  /**
18925
18920
  * Groups service.
18926
18921
  * @module purecloud-platform-client-v2/api/GroupsApi
18927
- * @version 146.0.0
18922
+ * @version 148.0.0
18928
18923
  */
18929
18924
 
18930
18925
  /**
@@ -19194,6 +19189,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
19194
19189
  * @param {Number} opts.pageSize Page size (default to 25)
19195
19190
  * @param {Number} opts.pageNumber Page number (default to 1)
19196
19191
  * @param {Array.<String>} opts.id id
19192
+ * @param {Array.<String>} opts.jabberId A list of jabberIds to fetch by bulk (cannot be used with the id parameter)
19197
19193
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
19198
19194
  */
19199
19195
  getProfilesGroups(opts) {
@@ -19204,7 +19200,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
19204
19200
  '/api/v2/profiles/groups',
19205
19201
  'GET',
19206
19202
  { },
19207
- { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'sortOrder': opts['sortOrder'] },
19203
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'jabberId': this.apiClient.buildCollectionParam(opts['jabberId'], 'multi'),'sortOrder': opts['sortOrder'] },
19208
19204
  { },
19209
19205
  { },
19210
19206
  null,
@@ -19329,7 +19325,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
19329
19325
  /**
19330
19326
  * IdentityProvider service.
19331
19327
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
19332
- * @version 146.0.0
19328
+ * @version 148.0.0
19333
19329
  */
19334
19330
 
19335
19331
  /**
@@ -20085,7 +20081,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
20085
20081
  /**
20086
20082
  * Integrations service.
20087
20083
  * @module purecloud-platform-client-v2/api/IntegrationsApi
20088
- * @version 146.0.0
20084
+ * @version 148.0.0
20089
20085
  */
20090
20086
 
20091
20087
  /**
@@ -20843,59 +20839,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
20843
20839
  );
20844
20840
  }
20845
20841
 
20846
- /**
20847
- * List all events
20848
- *
20849
- * @param {Object} opts Optional parameters
20850
- * @param {Number} opts.pageSize Page size (default to 25)
20851
- * @param {Number} opts.pageNumber Page number (default to 1)
20852
- * @param {String} opts.sortBy Sort by (default to timestamp)
20853
- * @param {String} opts.sortOrder Order by (default to descending)
20854
- * @param {String} opts.entityId Include only events with this entity ID
20855
- */
20856
- getIntegrationsEventlog(opts) {
20857
- opts = opts || {};
20858
-
20859
-
20860
- return this.apiClient.callApi(
20861
- '/api/v2/integrations/eventlog',
20862
- 'GET',
20863
- { },
20864
- { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'entityId': opts['entityId'] },
20865
- { },
20866
- { },
20867
- null,
20868
- ['PureCloud OAuth'],
20869
- ['application/json'],
20870
- ['application/json']
20871
- );
20872
- }
20873
-
20874
- /**
20875
- * Get a single event
20876
- *
20877
- * @param {String} eventId Event Id
20878
- */
20879
- getIntegrationsEventlogEventId(eventId) {
20880
- // verify the required parameter 'eventId' is set
20881
- if (eventId === undefined || eventId === null) {
20882
- throw 'Missing the required parameter "eventId" when calling getIntegrationsEventlogEventId';
20883
- }
20884
-
20885
- return this.apiClient.callApi(
20886
- '/api/v2/integrations/eventlog/{eventId}',
20887
- 'GET',
20888
- { 'eventId': eventId },
20889
- { },
20890
- { },
20891
- { },
20892
- null,
20893
- ['PureCloud OAuth'],
20894
- ['application/json'],
20895
- ['application/json']
20896
- );
20897
- }
20898
-
20899
20842
  /**
20900
20843
  * Get details about a Dialogflow agent
20901
20844
  *
@@ -21619,30 +21562,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
21619
21562
  );
21620
21563
  }
21621
21564
 
21622
- /**
21623
- * Add a vendor connection
21624
- *
21625
- * @param {Object} opts Optional parameters
21626
- * @param {Object} opts.body
21627
- */
21628
- postIntegrationsWorkforcemanagementVendorconnection(opts) {
21629
- opts = opts || {};
21630
-
21631
-
21632
- return this.apiClient.callApi(
21633
- '/api/v2/integrations/workforcemanagement/vendorconnection',
21634
- 'POST',
21635
- { },
21636
- { },
21637
- { },
21638
- { },
21639
- opts['body'],
21640
- ['PureCloud OAuth'],
21641
- ['application/json'],
21642
- ['application/json']
21643
- );
21644
- }
21645
-
21646
21565
  /**
21647
21566
  * Update integration configuration.
21648
21567
  *
@@ -21762,7 +21681,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
21762
21681
  /**
21763
21682
  * Journey service.
21764
21683
  * @module purecloud-platform-client-v2/api/JourneyApi
21765
- * @version 146.0.0
21684
+ * @version 148.0.0
21766
21685
  */
21767
21686
 
21768
21687
  /**
@@ -21937,6 +21856,56 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
21937
21856
  );
21938
21857
  }
21939
21858
 
21859
+ /**
21860
+ * Get status of job.
21861
+ *
21862
+ * @param {String} jobId ID of the job.
21863
+ */
21864
+ getJourneyActionmapsEstimatesJob(jobId) {
21865
+ // verify the required parameter 'jobId' is set
21866
+ if (jobId === undefined || jobId === null) {
21867
+ throw 'Missing the required parameter "jobId" when calling getJourneyActionmapsEstimatesJob';
21868
+ }
21869
+
21870
+ return this.apiClient.callApi(
21871
+ '/api/v2/journey/actionmaps/estimates/jobs/{jobId}',
21872
+ 'GET',
21873
+ { 'jobId': jobId },
21874
+ { },
21875
+ { },
21876
+ { },
21877
+ null,
21878
+ ['PureCloud OAuth'],
21879
+ ['application/json'],
21880
+ ['application/json']
21881
+ );
21882
+ }
21883
+
21884
+ /**
21885
+ * Get estimates from completed job.
21886
+ *
21887
+ * @param {String} jobId ID of the job.
21888
+ */
21889
+ getJourneyActionmapsEstimatesJobResults(jobId) {
21890
+ // verify the required parameter 'jobId' is set
21891
+ if (jobId === undefined || jobId === null) {
21892
+ throw 'Missing the required parameter "jobId" when calling getJourneyActionmapsEstimatesJobResults';
21893
+ }
21894
+
21895
+ return this.apiClient.callApi(
21896
+ '/api/v2/journey/actionmaps/estimates/jobs/{jobId}/results',
21897
+ 'GET',
21898
+ { 'jobId': jobId },
21899
+ { },
21900
+ { },
21901
+ { },
21902
+ null,
21903
+ ['PureCloud OAuth'],
21904
+ ['application/json'],
21905
+ ['application/json']
21906
+ );
21907
+ }
21908
+
21940
21909
  /**
21941
21910
  * Retrieve a single action target.
21942
21911
  *
@@ -22395,6 +22364,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
22395
22364
  );
22396
22365
  }
22397
22366
 
22367
+ /**
22368
+ * Query for estimates
22369
+ *
22370
+ * @param {Object} body audience estimator request
22371
+ */
22372
+ postJourneyActionmapsEstimatesJobs(body) {
22373
+ // verify the required parameter 'body' is set
22374
+ if (body === undefined || body === null) {
22375
+ throw 'Missing the required parameter "body" when calling postJourneyActionmapsEstimatesJobs';
22376
+ }
22377
+
22378
+ return this.apiClient.callApi(
22379
+ '/api/v2/journey/actionmaps/estimates/jobs',
22380
+ 'POST',
22381
+ { },
22382
+ { },
22383
+ { },
22384
+ { },
22385
+ body,
22386
+ ['PureCloud OAuth'],
22387
+ ['application/json'],
22388
+ ['application/json']
22389
+ );
22390
+ }
22391
+
22398
22392
  /**
22399
22393
  * Create a single action template.
22400
22394
  *
@@ -22473,7 +22467,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
22473
22467
  /**
22474
22468
  * Knowledge service.
22475
22469
  * @module purecloud-platform-client-v2/api/KnowledgeApi
22476
- * @version 146.0.0
22470
+ * @version 148.0.0
22477
22471
  */
22478
22472
 
22479
22473
  /**
@@ -23270,6 +23264,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
23270
23264
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
23271
23265
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
23272
23266
  * @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
23267
+ * @param {Array.<String>} opts.documentId Retrieves the specified documents, comma separated values expected.
23273
23268
  * @param {Array.<String>} opts.categoryId If specified, retrieves documents associated with category ids, comma separated values expected.
23274
23269
  * @param {Boolean} opts.includeSubcategories Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories.
23275
23270
  * @param {Boolean} opts.includeDrafts If includeDrafts is true, Documents in the draft state are also returned in the response.
@@ -23288,7 +23283,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
23288
23283
  '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents',
23289
23284
  'GET',
23290
23285
  { 'knowledgeBaseId': knowledgeBaseId },
23291
- { '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') },
23286
+ { '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') },
23292
23287
  { },
23293
23288
  { },
23294
23289
  null,
@@ -24905,7 +24900,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
24905
24900
  /**
24906
24901
  * LanguageUnderstanding service.
24907
24902
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
24908
- * @version 146.0.0
24903
+ * @version 148.0.0
24909
24904
  */
24910
24905
 
24911
24906
  /**
@@ -25809,7 +25804,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25809
25804
  /**
25810
25805
  * Languages service.
25811
25806
  * @module purecloud-platform-client-v2/api/LanguagesApi
25812
- * @version 146.0.0
25807
+ * @version 148.0.0
25813
25808
  */
25814
25809
 
25815
25810
  /**
@@ -26077,7 +26072,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26077
26072
  /**
26078
26073
  * Learning service.
26079
26074
  * @module purecloud-platform-client-v2/api/LearningApi
26080
- * @version 146.0.0
26075
+ * @version 148.0.0
26081
26076
  */
26082
26077
 
26083
26078
  /**
@@ -26837,7 +26832,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26837
26832
  /**
26838
26833
  * License service.
26839
26834
  * @module purecloud-platform-client-v2/api/LicenseApi
26840
- * @version 146.0.0
26835
+ * @version 148.0.0
26841
26836
  */
26842
26837
 
26843
26838
  /**
@@ -27075,7 +27070,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
27075
27070
  /**
27076
27071
  * Locations service.
27077
27072
  * @module purecloud-platform-client-v2/api/LocationsApi
27078
- * @version 146.0.0
27073
+ * @version 148.0.0
27079
27074
  */
27080
27075
 
27081
27076
  /**
@@ -27311,7 +27306,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
27311
27306
  /**
27312
27307
  * Messaging service.
27313
27308
  * @module purecloud-platform-client-v2/api/MessagingApi
27314
- * @version 146.0.0
27309
+ * @version 148.0.0
27315
27310
  */
27316
27311
 
27317
27312
  /**
@@ -27462,7 +27457,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
27462
27457
  /**
27463
27458
  * MobileDevices service.
27464
27459
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
27465
- * @version 146.0.0
27460
+ * @version 148.0.0
27466
27461
  */
27467
27462
 
27468
27463
  /**
@@ -27613,7 +27608,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
27613
27608
  /**
27614
27609
  * Notifications service.
27615
27610
  * @module purecloud-platform-client-v2/api/NotificationsApi
27616
- * @version 146.0.0
27611
+ * @version 148.0.0
27617
27612
  */
27618
27613
 
27619
27614
  /**
@@ -27838,7 +27833,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
27838
27833
  /**
27839
27834
  * OAuth service.
27840
27835
  * @module purecloud-platform-client-v2/api/OAuthApi
27841
- * @version 146.0.0
27836
+ * @version 148.0.0
27842
27837
  */
27843
27838
 
27844
27839
  /**
@@ -28204,7 +28199,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
28204
28199
  /**
28205
28200
  * Objects service.
28206
28201
  * @module purecloud-platform-client-v2/api/ObjectsApi
28207
- * @version 146.0.0
28202
+ * @version 148.0.0
28208
28203
  */
28209
28204
 
28210
28205
  /**
@@ -28475,7 +28470,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
28475
28470
  /**
28476
28471
  * Organization service.
28477
28472
  * @module purecloud-platform-client-v2/api/OrganizationApi
28478
- * @version 146.0.0
28473
+ * @version 148.0.0
28479
28474
  */
28480
28475
 
28481
28476
  /**
@@ -28878,7 +28873,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
28878
28873
  /**
28879
28874
  * OrganizationAuthorization service.
28880
28875
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
28881
- * @version 146.0.0
28876
+ * @version 148.0.0
28882
28877
  */
28883
28878
 
28884
28879
  /**
@@ -29803,7 +29798,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
29803
29798
  /**
29804
29799
  * Outbound service.
29805
29800
  * @module purecloud-platform-client-v2/api/OutboundApi
29806
- * @version 146.0.0
29801
+ * @version 148.0.0
29807
29802
  */
29808
29803
 
29809
29804
  /**
@@ -30103,6 +30098,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
30103
30098
  );
30104
30099
  }
30105
30100
 
30101
+ /**
30102
+ * Delete an Outbound Digital Rule Set
30103
+ *
30104
+ * @param {String} digitalRuleSetId The Digital Rule Set ID
30105
+ */
30106
+ deleteOutboundDigitalruleset(digitalRuleSetId) {
30107
+ // verify the required parameter 'digitalRuleSetId' is set
30108
+ if (digitalRuleSetId === undefined || digitalRuleSetId === null) {
30109
+ throw 'Missing the required parameter "digitalRuleSetId" when calling deleteOutboundDigitalruleset';
30110
+ }
30111
+
30112
+ return this.apiClient.callApi(
30113
+ '/api/v2/outbound/digitalrulesets/{digitalRuleSetId}',
30114
+ 'DELETE',
30115
+ { 'digitalRuleSetId': digitalRuleSetId },
30116
+ { },
30117
+ { },
30118
+ { },
30119
+ null,
30120
+ ['PureCloud OAuth'],
30121
+ ['application/json'],
30122
+ ['application/json']
30123
+ );
30124
+ }
30125
+
30106
30126
  /**
30107
30127
  * Delete dialer DNC list
30108
30128
  *
@@ -31140,6 +31160,60 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
31140
31160
  );
31141
31161
  }
31142
31162
 
31163
+ /**
31164
+ * Get an Outbound Digital Rule Set
31165
+ *
31166
+ * @param {String} digitalRuleSetId The Digital Rule Set ID
31167
+ */
31168
+ getOutboundDigitalruleset(digitalRuleSetId) {
31169
+ // verify the required parameter 'digitalRuleSetId' is set
31170
+ if (digitalRuleSetId === undefined || digitalRuleSetId === null) {
31171
+ throw 'Missing the required parameter "digitalRuleSetId" when calling getOutboundDigitalruleset';
31172
+ }
31173
+
31174
+ return this.apiClient.callApi(
31175
+ '/api/v2/outbound/digitalrulesets/{digitalRuleSetId}',
31176
+ 'GET',
31177
+ { 'digitalRuleSetId': digitalRuleSetId },
31178
+ { },
31179
+ { },
31180
+ { },
31181
+ null,
31182
+ ['PureCloud OAuth'],
31183
+ ['application/json'],
31184
+ ['application/json']
31185
+ );
31186
+ }
31187
+
31188
+ /**
31189
+ * Query a list of Outbound Digital Rule Sets
31190
+ *
31191
+ * @param {Object} opts Optional parameters
31192
+ * @param {Number} opts.pageSize Page size. The max that will be returned is 100. (default to 25)
31193
+ * @param {Number} opts.pageNumber Page number (default to 1)
31194
+ * @param {Object} opts.sortBy The field to sort by (default to name)
31195
+ * @param {Object} opts.sortOrder The direction to sort (default to ascending)
31196
+ * @param {String} opts.name Name
31197
+ * @param {Array.<String>} opts.id A list of digital rule set ids to bulk fetch
31198
+ */
31199
+ getOutboundDigitalrulesets(opts) {
31200
+ opts = opts || {};
31201
+
31202
+
31203
+ return this.apiClient.callApi(
31204
+ '/api/v2/outbound/digitalrulesets',
31205
+ 'GET',
31206
+ { },
31207
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi') },
31208
+ { },
31209
+ { },
31210
+ null,
31211
+ ['PureCloud OAuth'],
31212
+ ['application/json'],
31213
+ ['application/json']
31214
+ );
31215
+ }
31216
+
31143
31217
  /**
31144
31218
  * Get dialer DNC list
31145
31219
  *
@@ -32323,6 +32397,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
32323
32397
  );
32324
32398
  }
32325
32399
 
32400
+ /**
32401
+ * Create an Outbound Digital Rule Set
32402
+ *
32403
+ * @param {Object} body Digital Rule Set
32404
+ */
32405
+ postOutboundDigitalrulesets(body) {
32406
+ // verify the required parameter 'body' is set
32407
+ if (body === undefined || body === null) {
32408
+ throw 'Missing the required parameter "body" when calling postOutboundDigitalrulesets';
32409
+ }
32410
+
32411
+ return this.apiClient.callApi(
32412
+ '/api/v2/outbound/digitalrulesets',
32413
+ 'POST',
32414
+ { },
32415
+ { },
32416
+ { },
32417
+ { },
32418
+ body,
32419
+ ['PureCloud OAuth'],
32420
+ ['application/json'],
32421
+ ['application/json']
32422
+ );
32423
+ }
32424
+
32326
32425
  /**
32327
32426
  * Initiate the export of a dnc list.
32328
32427
  * Returns 200 if received OK.
@@ -32787,6 +32886,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
32787
32886
  );
32788
32887
  }
32789
32888
 
32889
+ /**
32890
+ * Update an Outbound Digital Rule Set
32891
+ *
32892
+ * @param {String} digitalRuleSetId The Digital Rule Set ID
32893
+ * @param {Object} body Digital Rule Set
32894
+ */
32895
+ putOutboundDigitalruleset(digitalRuleSetId, body) {
32896
+ // verify the required parameter 'digitalRuleSetId' is set
32897
+ if (digitalRuleSetId === undefined || digitalRuleSetId === null) {
32898
+ throw 'Missing the required parameter "digitalRuleSetId" when calling putOutboundDigitalruleset';
32899
+ }
32900
+ // verify the required parameter 'body' is set
32901
+ if (body === undefined || body === null) {
32902
+ throw 'Missing the required parameter "body" when calling putOutboundDigitalruleset';
32903
+ }
32904
+
32905
+ return this.apiClient.callApi(
32906
+ '/api/v2/outbound/digitalrulesets/{digitalRuleSetId}',
32907
+ 'PUT',
32908
+ { 'digitalRuleSetId': digitalRuleSetId },
32909
+ { },
32910
+ { },
32911
+ { },
32912
+ body,
32913
+ ['PureCloud OAuth'],
32914
+ ['application/json'],
32915
+ ['application/json']
32916
+ );
32917
+ }
32918
+
32790
32919
  /**
32791
32920
  * Update dialer DNC list
32792
32921
  *
@@ -33058,7 +33187,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
33058
33187
  /**
33059
33188
  * Presence service.
33060
33189
  * @module purecloud-platform-client-v2/api/PresenceApi
33061
- * @version 146.0.0
33190
+ * @version 148.0.0
33062
33191
  */
33063
33192
 
33064
33193
  /**
@@ -33376,11 +33505,249 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
33376
33505
 
33377
33506
  }
33378
33507
 
33508
+ class ProcessAutomationApi {
33509
+ /**
33510
+ * ProcessAutomation service.
33511
+ * @module purecloud-platform-client-v2/api/ProcessAutomationApi
33512
+ * @version 148.0.0
33513
+ */
33514
+
33515
+ /**
33516
+ * Constructs a new ProcessAutomationApi.
33517
+ * @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi
33518
+ * @class
33519
+ * @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
33520
+ * default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
33521
+ */
33522
+ constructor(apiClient) {
33523
+ this.apiClient = apiClient || ApiClient.instance;
33524
+ }
33525
+
33526
+
33527
+ /**
33528
+ * Delete a Trigger
33529
+ *
33530
+ * @param {String} triggerId triggerId
33531
+ */
33532
+ deleteProcessautomationTrigger(triggerId) {
33533
+ // verify the required parameter 'triggerId' is set
33534
+ if (triggerId === undefined || triggerId === null) {
33535
+ throw 'Missing the required parameter "triggerId" when calling deleteProcessautomationTrigger';
33536
+ }
33537
+
33538
+ return this.apiClient.callApi(
33539
+ '/api/v2/processautomation/triggers/{triggerId}',
33540
+ 'DELETE',
33541
+ { 'triggerId': triggerId },
33542
+ { },
33543
+ { },
33544
+ { },
33545
+ null,
33546
+ ['PureCloud OAuth'],
33547
+ ['application/json'],
33548
+ ['application/json']
33549
+ );
33550
+ }
33551
+
33552
+ /**
33553
+ * Retrieve a single Trigger matching id.
33554
+ *
33555
+ * @param {String} triggerId triggerId
33556
+ */
33557
+ getProcessautomationTrigger(triggerId) {
33558
+ // verify the required parameter 'triggerId' is set
33559
+ if (triggerId === undefined || triggerId === null) {
33560
+ throw 'Missing the required parameter "triggerId" when calling getProcessautomationTrigger';
33561
+ }
33562
+
33563
+ return this.apiClient.callApi(
33564
+ '/api/v2/processautomation/triggers/{triggerId}',
33565
+ 'GET',
33566
+ { 'triggerId': triggerId },
33567
+ { },
33568
+ { },
33569
+ { },
33570
+ null,
33571
+ ['PureCloud OAuth'],
33572
+ ['application/json'],
33573
+ ['application/json']
33574
+ );
33575
+ }
33576
+
33577
+ /**
33578
+ * Retrieves all triggers
33579
+ *
33580
+ * @param {Object} opts Optional parameters
33581
+ * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
33582
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
33583
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
33584
+ * @param {String} opts.topicName Topic name
33585
+ * @param {Boolean} opts.enabled Boolean indicating desired enabled state of triggers
33586
+ */
33587
+ getProcessautomationTriggers(opts) {
33588
+ opts = opts || {};
33589
+
33590
+
33591
+ return this.apiClient.callApi(
33592
+ '/api/v2/processautomation/triggers',
33593
+ 'GET',
33594
+ { },
33595
+ { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'topicName': opts['topicName'],'enabled': opts['enabled'] },
33596
+ { },
33597
+ { },
33598
+ null,
33599
+ ['PureCloud OAuth'],
33600
+ ['application/json'],
33601
+ ['application/json']
33602
+ );
33603
+ }
33604
+
33605
+ /**
33606
+ * Get topics available for organization
33607
+ *
33608
+ * @param {Object} opts Optional parameters
33609
+ * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
33610
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
33611
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
33612
+ */
33613
+ getProcessautomationTriggersTopics(opts) {
33614
+ opts = opts || {};
33615
+
33616
+
33617
+ return this.apiClient.callApi(
33618
+ '/api/v2/processautomation/triggers/topics',
33619
+ 'GET',
33620
+ { },
33621
+ { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'] },
33622
+ { },
33623
+ { },
33624
+ null,
33625
+ ['PureCloud OAuth'],
33626
+ ['application/json'],
33627
+ ['application/json']
33628
+ );
33629
+ }
33630
+
33631
+ /**
33632
+ * Test the matching of a Trigger based on provided event body
33633
+ *
33634
+ * @param {String} triggerId triggerId
33635
+ * @param {Object} opts Optional parameters
33636
+ * @param {String} opts.body eventBody
33637
+ */
33638
+ postProcessautomationTriggerTest(triggerId, opts) {
33639
+ opts = opts || {};
33640
+
33641
+ // verify the required parameter 'triggerId' is set
33642
+ if (triggerId === undefined || triggerId === null) {
33643
+ throw 'Missing the required parameter "triggerId" when calling postProcessautomationTriggerTest';
33644
+ }
33645
+
33646
+ return this.apiClient.callApi(
33647
+ '/api/v2/processautomation/triggers/{triggerId}/test',
33648
+ 'POST',
33649
+ { 'triggerId': triggerId },
33650
+ { },
33651
+ { },
33652
+ { },
33653
+ opts['body'],
33654
+ ['PureCloud OAuth'],
33655
+ ['application/json'],
33656
+ ['application/json']
33657
+ );
33658
+ }
33659
+
33660
+ /**
33661
+ * Create a Trigger
33662
+ *
33663
+ * @param {Object} body Input used to create a Trigger.
33664
+ */
33665
+ postProcessautomationTriggers(body) {
33666
+ // verify the required parameter 'body' is set
33667
+ if (body === undefined || body === null) {
33668
+ throw 'Missing the required parameter "body" when calling postProcessautomationTriggers';
33669
+ }
33670
+
33671
+ return this.apiClient.callApi(
33672
+ '/api/v2/processautomation/triggers',
33673
+ 'POST',
33674
+ { },
33675
+ { },
33676
+ { },
33677
+ { },
33678
+ body,
33679
+ ['PureCloud OAuth'],
33680
+ ['application/json'],
33681
+ ['application/json']
33682
+ );
33683
+ }
33684
+
33685
+ /**
33686
+ * Test the matching of all organization Triggers on given topic using provided event body
33687
+ *
33688
+ * @param {String} topicName topicName
33689
+ * @param {Object} opts Optional parameters
33690
+ * @param {String} opts.body eventBody
33691
+ */
33692
+ postProcessautomationTriggersTopicTest(topicName, opts) {
33693
+ opts = opts || {};
33694
+
33695
+ // verify the required parameter 'topicName' is set
33696
+ if (topicName === undefined || topicName === null) {
33697
+ throw 'Missing the required parameter "topicName" when calling postProcessautomationTriggersTopicTest';
33698
+ }
33699
+
33700
+ return this.apiClient.callApi(
33701
+ '/api/v2/processautomation/triggers/topics/{topicName}/test',
33702
+ 'POST',
33703
+ { 'topicName': topicName },
33704
+ { },
33705
+ { },
33706
+ { },
33707
+ opts['body'],
33708
+ ['PureCloud OAuth'],
33709
+ ['application/json'],
33710
+ ['application/json']
33711
+ );
33712
+ }
33713
+
33714
+ /**
33715
+ * Update a Trigger
33716
+ *
33717
+ * @param {String} triggerId triggerId
33718
+ * @param {Object} body Input to update Trigger. (topicName cannot be updated, a new trigger must be created to use a new topicName)
33719
+ */
33720
+ putProcessautomationTrigger(triggerId, body) {
33721
+ // verify the required parameter 'triggerId' is set
33722
+ if (triggerId === undefined || triggerId === null) {
33723
+ throw 'Missing the required parameter "triggerId" when calling putProcessautomationTrigger';
33724
+ }
33725
+ // verify the required parameter 'body' is set
33726
+ if (body === undefined || body === null) {
33727
+ throw 'Missing the required parameter "body" when calling putProcessautomationTrigger';
33728
+ }
33729
+
33730
+ return this.apiClient.callApi(
33731
+ '/api/v2/processautomation/triggers/{triggerId}',
33732
+ 'PUT',
33733
+ { 'triggerId': triggerId },
33734
+ { },
33735
+ { },
33736
+ { },
33737
+ body,
33738
+ ['PureCloud OAuth'],
33739
+ ['application/json'],
33740
+ ['application/json']
33741
+ );
33742
+ }
33743
+
33744
+ }
33745
+
33379
33746
  class QualityApi {
33380
33747
  /**
33381
33748
  * Quality service.
33382
33749
  * @module purecloud-platform-client-v2/api/QualityApi
33383
- * @version 146.0.0
33750
+ * @version 148.0.0
33384
33751
  */
33385
33752
 
33386
33753
  /**
@@ -33890,7 +34257,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
33890
34257
  * @param {String} opts.sortBy variable name requested to sort by
33891
34258
  * @param {String} opts.nextPage next page token
33892
34259
  * @param {String} opts.previousPage Previous page token
33893
- * @param {String} opts.expand Expand
34260
+ * @param {Object} opts.expand If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions
33894
34261
  * @param {String} opts.name Name
33895
34262
  * @param {String} opts.sortOrder Order to sort results, either asc or desc
33896
34263
  */
@@ -33977,7 +34344,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
33977
34344
  * @param {String} opts.sortBy variable name requested to sort by
33978
34345
  * @param {String} opts.nextPage next page token
33979
34346
  * @param {String} opts.previousPage Previous page token
33980
- * @param {String} opts.expand Expand
34347
+ * @param {Object} opts.expand If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions
33981
34348
  * @param {String} opts.name Name
33982
34349
  * @param {String} opts.sortOrder Order to sort results, either asc or desc
33983
34350
  */
@@ -34088,7 +34455,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
34088
34455
  * @param {String} opts.sortBy variable name requested to sort by
34089
34456
  * @param {String} opts.nextPage next page token
34090
34457
  * @param {String} opts.previousPage Previous page token
34091
- * @param {String} opts.expand Expand
34458
+ * @param {Object} opts.expand If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions
34092
34459
  * @param {String} opts.name Name
34093
34460
  * @param {String} opts.sortOrder Order to sort results, either asc or desc
34094
34461
  */
@@ -34958,7 +35325,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
34958
35325
  /**
34959
35326
  * Recording service.
34960
35327
  * @module purecloud-platform-client-v2/api/RecordingApi
34961
- * @version 146.0.0
35328
+ * @version 148.0.0
34962
35329
  */
34963
35330
 
34964
35331
  /**
@@ -35832,6 +36199,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
35832
36199
  );
35833
36200
  }
35834
36201
 
36202
+ /**
36203
+ * Query for recording retention data
36204
+ *
36205
+ * @param {Number} retentionThresholdDays Fetch retention data for recordings retained for more days than the provided value.
36206
+ * @param {Object} opts Optional parameters
36207
+ * @param {String} opts.cursor Indicates where to resume query results (not required for first page)
36208
+ * @param {Number} opts.pageSize Page size. Maximum is 500. (default to 25)
36209
+ */
36210
+ getRecordingsRetentionQuery(retentionThresholdDays, opts) {
36211
+ opts = opts || {};
36212
+
36213
+ // verify the required parameter 'retentionThresholdDays' is set
36214
+ if (retentionThresholdDays === undefined || retentionThresholdDays === null) {
36215
+ throw 'Missing the required parameter "retentionThresholdDays" when calling getRecordingsRetentionQuery';
36216
+ }
36217
+
36218
+ return this.apiClient.callApi(
36219
+ '/api/v2/recordings/retention/query',
36220
+ 'GET',
36221
+ { },
36222
+ { 'retentionThresholdDays': retentionThresholdDays,'cursor': opts['cursor'],'pageSize': opts['pageSize'] },
36223
+ { },
36224
+ { },
36225
+ null,
36226
+ ['PureCloud OAuth'],
36227
+ ['application/json'],
36228
+ ['application/json']
36229
+ );
36230
+ }
36231
+
35835
36232
  /**
35836
36233
  * Retrieves a paged listing of screen recording sessions
35837
36234
  *
@@ -36611,7 +37008,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
36611
37008
  /**
36612
37009
  * ResponseManagement service.
36613
37010
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
36614
- * @version 146.0.0
37011
+ * @version 148.0.0
36615
37012
  */
36616
37013
 
36617
37014
  /**
@@ -37095,7 +37492,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
37095
37492
  /**
37096
37493
  * Routing service.
37097
37494
  * @module purecloud-platform-client-v2/api/RoutingApi
37098
- * @version 146.0.0
37495
+ * @version 148.0.0
37099
37496
  */
37100
37497
 
37101
37498
  /**
@@ -40036,7 +40433,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
40036
40433
  /**
40037
40434
  * SCIM service.
40038
40435
  * @module purecloud-platform-client-v2/api/SCIMApi
40039
- * @version 146.0.0
40436
+ * @version 148.0.0
40040
40437
  */
40041
40438
 
40042
40439
  /**
@@ -40913,7 +41310,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
40913
41310
  /**
40914
41311
  * Scripts service.
40915
41312
  * @module purecloud-platform-client-v2/api/ScriptsApi
40916
- * @version 146.0.0
41313
+ * @version 148.0.0
40917
41314
  */
40918
41315
 
40919
41316
  /**
@@ -41332,7 +41729,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
41332
41729
  /**
41333
41730
  * Search service.
41334
41731
  * @module purecloud-platform-client-v2/api/SearchApi
41335
- * @version 146.0.0
41732
+ * @version 148.0.0
41336
41733
  */
41337
41734
 
41338
41735
  /**
@@ -41892,7 +42289,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
41892
42289
  /**
41893
42290
  * SpeechTextAnalytics service.
41894
42291
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
41895
- * @version 146.0.0
42292
+ * @version 148.0.0
41896
42293
  */
41897
42294
 
41898
42295
  /**
@@ -42746,7 +43143,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
42746
43143
  /**
42747
43144
  * Stations service.
42748
43145
  * @module purecloud-platform-client-v2/api/StationsApi
42749
- * @version 146.0.0
43146
+ * @version 148.0.0
42750
43147
  */
42751
43148
 
42752
43149
  /**
@@ -42893,7 +43290,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
42893
43290
  /**
42894
43291
  * Suggest service.
42895
43292
  * @module purecloud-platform-client-v2/api/SuggestApi
42896
- * @version 146.0.0
43293
+ * @version 148.0.0
42897
43294
  */
42898
43295
 
42899
43296
  /**
@@ -43032,7 +43429,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
43032
43429
  /**
43033
43430
  * Teams service.
43034
43431
  * @module purecloud-platform-client-v2/api/TeamsApi
43035
- * @version 146.0.0
43432
+ * @version 148.0.0
43036
43433
  */
43037
43434
 
43038
43435
  /**
@@ -43211,7 +43608,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
43211
43608
  /**
43212
43609
  * Telephony service.
43213
43610
  * @module purecloud-platform-client-v2/api/TelephonyApi
43214
- * @version 146.0.0
43611
+ * @version 148.0.0
43215
43612
  */
43216
43613
 
43217
43614
  /**
@@ -43319,7 +43716,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
43319
43716
  /**
43320
43717
  * TelephonyProvidersEdge service.
43321
43718
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
43322
- * @version 146.0.0
43719
+ * @version 148.0.0
43323
43720
  */
43324
43721
 
43325
43722
  /**
@@ -46952,7 +47349,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
46952
47349
  /**
46953
47350
  * Textbots service.
46954
47351
  * @module purecloud-platform-client-v2/api/TextbotsApi
46955
- * @version 146.0.0
47352
+ * @version 148.0.0
46956
47353
  */
46957
47354
 
46958
47355
  /**
@@ -47080,7 +47477,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
47080
47477
  /**
47081
47478
  * Tokens service.
47082
47479
  * @module purecloud-platform-client-v2/api/TokensApi
47083
- * @version 146.0.0
47480
+ * @version 148.0.0
47084
47481
  */
47085
47482
 
47086
47483
  /**
@@ -47186,7 +47583,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
47186
47583
  /**
47187
47584
  * Uploads service.
47188
47585
  * @module purecloud-platform-client-v2/api/UploadsApi
47189
- * @version 146.0.0
47586
+ * @version 148.0.0
47190
47587
  */
47191
47588
 
47192
47589
  /**
@@ -47362,7 +47759,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
47362
47759
  /**
47363
47760
  * Usage service.
47364
47761
  * @module purecloud-platform-client-v2/api/UsageApi
47365
- * @version 146.0.0
47762
+ * @version 148.0.0
47366
47763
  */
47367
47764
 
47368
47765
  /**
@@ -47433,7 +47830,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
47433
47830
  /**
47434
47831
  * UserRecordings service.
47435
47832
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
47436
- * @version 146.0.0
47833
+ * @version 148.0.0
47437
47834
  */
47438
47835
 
47439
47836
  /**
@@ -47508,6 +47905,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
47508
47905
  * @param {String} recordingId User Recording ID
47509
47906
  * @param {Object} opts Optional parameters
47510
47907
  * @param {Object} opts.formatId The desired media format. (default to WEBM)
47908
+ * @param {Boolean} opts.async When set to true, api will return 202 response until the recording is ready for download
47511
47909
  */
47512
47910
  getUserrecordingMedia(recordingId, opts) {
47513
47911
  opts = opts || {};
@@ -47521,7 +47919,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
47521
47919
  '/api/v2/userrecordings/{recordingId}/media',
47522
47920
  'GET',
47523
47921
  { 'recordingId': recordingId },
47524
- { 'formatId': opts['formatId'] },
47922
+ { 'formatId': opts['formatId'],'async': opts['async'] },
47525
47923
  { },
47526
47924
  { },
47527
47925
  null,
@@ -47617,7 +48015,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
47617
48015
  /**
47618
48016
  * Users service.
47619
48017
  * @module purecloud-platform-client-v2/api/UsersApi
47620
- * @version 146.0.0
48018
+ * @version 148.0.0
47621
48019
  */
47622
48020
 
47623
48021
  /**
@@ -49359,6 +49757,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
49359
49757
  );
49360
49758
  }
49361
49759
 
49760
+ /**
49761
+ * Create mapping between external identifier and user. Limit 100 per entity.
49762
+ * Authority Name and External key are case sensitive.
49763
+ * @param {String} userId User ID
49764
+ * @param {Object} body
49765
+ */
49766
+ postUserExternalid(userId, body) {
49767
+ // verify the required parameter 'userId' is set
49768
+ if (userId === undefined || userId === null) {
49769
+ throw 'Missing the required parameter "userId" when calling postUserExternalid';
49770
+ }
49771
+ // verify the required parameter 'body' is set
49772
+ if (body === undefined || body === null) {
49773
+ throw 'Missing the required parameter "body" when calling postUserExternalid';
49774
+ }
49775
+
49776
+ return this.apiClient.callApi(
49777
+ '/api/v2/users/{userId}/externalid',
49778
+ 'POST',
49779
+ { 'userId': userId },
49780
+ { },
49781
+ { },
49782
+ { },
49783
+ body,
49784
+ ['PureCloud OAuth'],
49785
+ ['application/json'],
49786
+ ['application/json']
49787
+ );
49788
+ }
49789
+
49362
49790
  /**
49363
49791
  * Send an activation email to the user
49364
49792
  *
@@ -49919,7 +50347,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
49919
50347
  /**
49920
50348
  * Utilities service.
49921
50349
  * @module purecloud-platform-client-v2/api/UtilitiesApi
49922
- * @version 146.0.0
50350
+ * @version 148.0.0
49923
50351
  */
49924
50352
 
49925
50353
  /**
@@ -50030,7 +50458,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50030
50458
  /**
50031
50459
  * Voicemail service.
50032
50460
  * @module purecloud-platform-client-v2/api/VoicemailApi
50033
- * @version 146.0.0
50461
+ * @version 148.0.0
50034
50462
  */
50035
50463
 
50036
50464
  /**
@@ -50697,7 +51125,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50697
51125
  /**
50698
51126
  * WebChat service.
50699
51127
  * @module purecloud-platform-client-v2/api/WebChatApi
50700
- * @version 146.0.0
51128
+ * @version 148.0.0
50701
51129
  */
50702
51130
 
50703
51131
  /**
@@ -51241,7 +51669,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
51241
51669
  /**
51242
51670
  * WebDeployments service.
51243
51671
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
51244
- * @version 146.0.0
51672
+ * @version 148.0.0
51245
51673
  */
51246
51674
 
51247
51675
  /**
@@ -51435,6 +51863,35 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
51435
51863
  );
51436
51864
  }
51437
51865
 
51866
+ /**
51867
+ * Get active configuration for a given deployment
51868
+ *
51869
+ * @param {String} deploymentId The deployment ID
51870
+ * @param {Object} opts Optional parameters
51871
+ * @param {String} opts.type Get active configuration on a deployment
51872
+ */
51873
+ getWebdeploymentsDeploymentConfigurations(deploymentId, opts) {
51874
+ opts = opts || {};
51875
+
51876
+ // verify the required parameter 'deploymentId' is set
51877
+ if (deploymentId === undefined || deploymentId === null) {
51878
+ throw 'Missing the required parameter "deploymentId" when calling getWebdeploymentsDeploymentConfigurations';
51879
+ }
51880
+
51881
+ return this.apiClient.callApi(
51882
+ '/api/v2/webdeployments/deployments/{deploymentId}/configurations',
51883
+ 'GET',
51884
+ { 'deploymentId': deploymentId },
51885
+ { 'type': opts['type'] },
51886
+ { },
51887
+ { },
51888
+ null,
51889
+ ['PureCloud OAuth'],
51890
+ ['application/json'],
51891
+ ['application/json']
51892
+ );
51893
+ }
51894
+
51438
51895
  /**
51439
51896
  * Get deployments
51440
51897
  *
@@ -51596,7 +52053,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
51596
52053
  /**
51597
52054
  * WebMessaging service.
51598
52055
  * @module purecloud-platform-client-v2/api/WebMessagingApi
51599
- * @version 146.0.0
52056
+ * @version 148.0.0
51600
52057
  */
51601
52058
 
51602
52059
  /**
@@ -51642,7 +52099,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
51642
52099
  /**
51643
52100
  * Widgets service.
51644
52101
  * @module purecloud-platform-client-v2/api/WidgetsApi
51645
- * @version 146.0.0
52102
+ * @version 148.0.0
51646
52103
  */
51647
52104
 
51648
52105
  /**
@@ -51788,7 +52245,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
51788
52245
  /**
51789
52246
  * WorkforceManagement service.
51790
52247
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
51791
- * @version 146.0.0
52248
+ * @version 148.0.0
51792
52249
  */
51793
52250
 
51794
52251
  /**
@@ -56064,7 +56521,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
56064
56521
  * </pre>
56065
56522
  * </p>
56066
56523
  * @module purecloud-platform-client-v2/index
56067
- * @version 146.0.0
56524
+ * @version 148.0.0
56068
56525
  */
56069
56526
  class platformClient {
56070
56527
  constructor() {
@@ -56263,6 +56720,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
56263
56720
  * @property {module:purecloud-platform-client-v2/api/PresenceApi}
56264
56721
  */
56265
56722
  this.PresenceApi = PresenceApi;
56723
+ /**
56724
+ * The ProcessAutomationApi service constructor.
56725
+ * @property {module:purecloud-platform-client-v2/api/ProcessAutomationApi}
56726
+ */
56727
+ this.ProcessAutomationApi = ProcessAutomationApi;
56266
56728
  /**
56267
56729
  * The QualityApi service constructor.
56268
56730
  * @property {module:purecloud-platform-client-v2/api/QualityApi}