purecloud-platform-client-v2 199.0.0 → 201.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 (87) hide show
  1. package/README.md +2 -2
  2. package/dist/node/purecloud-platform-client-v2.js +1565 -120
  3. package/dist/web-amd/purecloud-platform-client-v2.js +1565 -120
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +476 -127
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +592 -159
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +862 -244
  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/AgentUIApi.js +1 -1
  12. package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
  13. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +3 -3
  14. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AuditApi.js +3 -2
  16. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
  17. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
  19. package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  21. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  22. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +21 -1
  39. package/src/purecloud-platform-client-v2/api/JourneyApi.js +10 -3
  40. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/LearningApi.js +4 -4
  44. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  49. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  50. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +68 -1
  54. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/RecordingApi.js +3 -2
  60. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/RoutingApi.js +146 -1
  62. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
  67. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +36 -31
  71. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  76. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  78. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  79. package/src/purecloud-platform-client-v2/api/UsersApi.js +149 -4
  80. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  81. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  82. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  83. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  84. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  85. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  86. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1080 -26
  87. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -402,7 +402,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
402
402
 
403
403
  /**
404
404
  * @module purecloud-platform-client-v2/ApiClient
405
- * @version 199.0.0
405
+ * @version 201.0.0
406
406
  */
407
407
  class ApiClient {
408
408
  /**
@@ -1824,7 +1824,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
1824
1824
  /**
1825
1825
  * AgentUI service.
1826
1826
  * @module purecloud-platform-client-v2/api/AgentUIApi
1827
- * @version 199.0.0
1827
+ * @version 201.0.0
1828
1828
  */
1829
1829
 
1830
1830
  /**
@@ -1955,7 +1955,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
1955
1955
  /**
1956
1956
  * Alerting service.
1957
1957
  * @module purecloud-platform-client-v2/api/AlertingApi
1958
- * @version 199.0.0
1958
+ * @version 201.0.0
1959
1959
  */
1960
1960
 
1961
1961
  /**
@@ -2616,7 +2616,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2616
2616
  /**
2617
2617
  * Analytics service.
2618
2618
  * @module purecloud-platform-client-v2/api/AnalyticsApi
2619
- * @version 199.0.0
2619
+ * @version 201.0.0
2620
2620
  */
2621
2621
 
2622
2622
  /**
@@ -4677,8 +4677,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
4677
4677
  }
4678
4678
 
4679
4679
  /**
4680
- * Query for limits rate limit aggregates. Data populated when limits are exceeded or are close to being exceeded. Not a source of truth for limits hit but a best effort estimate.
4681
- * The max property can be used to determine estimated rate limit value hit.
4680
+ * Query for limits rate limit aggregates. Data populated when limits reach 90% of the maximum. Not a source of truth for limits hit but a best effort estimate.
4681
+ * The max property can be used to determine estimated rate limit value hit. See https://developer.genesys.cloud/organization/organization/limits#available-limits for limits that are trackable (Operational Events Enabled).
4682
4682
  * @param {Object} body query
4683
4683
  */
4684
4684
  postAnalyticsRatelimitsAggregatesQuery(body) {
@@ -5228,7 +5228,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
5228
5228
  /**
5229
5229
  * Architect service.
5230
5230
  * @module purecloud-platform-client-v2/api/ArchitectApi
5231
- * @version 199.0.0
5231
+ * @version 201.0.0
5232
5232
  */
5233
5233
 
5234
5234
  /**
@@ -9374,7 +9374,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
9374
9374
  /**
9375
9375
  * Audit service.
9376
9376
  * @module purecloud-platform-client-v2/api/AuditApi
9377
- * @version 199.0.0
9377
+ * @version 201.0.0
9378
9378
  */
9379
9379
 
9380
9380
  /**
@@ -9462,6 +9462,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
9462
9462
  * @param {String} opts.cursor Indicates where to resume query results (not required for first page)
9463
9463
  * @param {Number} opts.pageSize Indicates maximum number of results in response. Default page size is 25 results. The maximum page size is 500. (default to 25)
9464
9464
  * @param {Array.<String>} opts.expand Which fields, if any, to expand
9465
+ * @param {Boolean} opts.allowRedirect Result sets with large amounts of data will respond with a download url
9465
9466
  */
9466
9467
  getAuditsQueryTransactionIdResults(transactionId, opts) {
9467
9468
  opts = opts || {};
@@ -9475,7 +9476,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
9475
9476
  '/api/v2/audits/query/{transactionId}/results',
9476
9477
  'GET',
9477
9478
  { 'transactionId': transactionId },
9478
- { 'cursor': opts['cursor'],'pageSize': opts['pageSize'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
9479
+ { 'cursor': opts['cursor'],'pageSize': opts['pageSize'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'allowRedirect': opts['allowRedirect'] },
9479
9480
  { },
9480
9481
  { },
9481
9482
  null,
@@ -9574,7 +9575,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
9574
9575
  /**
9575
9576
  * Authorization service.
9576
9577
  * @module purecloud-platform-client-v2/api/AuthorizationApi
9577
- * @version 199.0.0
9578
+ * @version 201.0.0
9578
9579
  */
9579
9580
 
9580
9581
  /**
@@ -10812,7 +10813,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
10812
10813
  /**
10813
10814
  * Billing service.
10814
10815
  * @module purecloud-platform-client-v2/api/BillingApi
10815
- * @version 199.0.0
10816
+ * @version 201.0.0
10816
10817
  */
10817
10818
 
10818
10819
  /**
@@ -10892,7 +10893,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
10892
10893
  /**
10893
10894
  * CarrierServices service.
10894
10895
  * @module purecloud-platform-client-v2/api/CarrierServicesApi
10895
- * @version 199.0.0
10896
+ * @version 201.0.0
10896
10897
  */
10897
10898
 
10898
10899
  /**
@@ -10962,7 +10963,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
10962
10963
  /**
10963
10964
  * Chat service.
10964
10965
  * @module purecloud-platform-client-v2/api/ChatApi
10965
- * @version 199.0.0
10966
+ * @version 201.0.0
10966
10967
  */
10967
10968
 
10968
10969
  /**
@@ -11898,7 +11899,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
11898
11899
  /**
11899
11900
  * Coaching service.
11900
11901
  * @module purecloud-platform-client-v2/api/CoachingApi
11901
- * @version 199.0.0
11902
+ * @version 201.0.0
11902
11903
  */
11903
11904
 
11904
11905
  /**
@@ -12475,7 +12476,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
12475
12476
  /**
12476
12477
  * ContentManagement service.
12477
12478
  * @module purecloud-platform-client-v2/api/ContentManagementApi
12478
- * @version 199.0.0
12479
+ * @version 201.0.0
12479
12480
  */
12480
12481
 
12481
12482
  /**
@@ -13557,7 +13558,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
13557
13558
  /**
13558
13559
  * Conversations service.
13559
13560
  * @module purecloud-platform-client-v2/api/ConversationsApi
13560
- * @version 199.0.0
13561
+ * @version 201.0.0
13561
13562
  */
13562
13563
 
13563
13564
  /**
@@ -20670,7 +20671,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
20670
20671
  /**
20671
20672
  * DataExtensions service.
20672
20673
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
20673
- * @version 199.0.0
20674
+ * @version 201.0.0
20674
20675
  */
20675
20676
 
20676
20677
  /**
@@ -20756,7 +20757,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
20756
20757
  /**
20757
20758
  * Downloads service.
20758
20759
  * @module purecloud-platform-client-v2/api/DownloadsApi
20759
- * @version 199.0.0
20760
+ * @version 201.0.0
20760
20761
  */
20761
20762
 
20762
20763
  /**
@@ -20808,7 +20809,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
20808
20809
  /**
20809
20810
  * Emails service.
20810
20811
  * @module purecloud-platform-client-v2/api/EmailsApi
20811
- * @version 199.0.0
20812
+ * @version 201.0.0
20812
20813
  */
20813
20814
 
20814
20815
  /**
@@ -20873,7 +20874,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
20873
20874
  /**
20874
20875
  * EmployeeEngagement service.
20875
20876
  * @module purecloud-platform-client-v2/api/EmployeeEngagementApi
20876
- * @version 199.0.0
20877
+ * @version 201.0.0
20877
20878
  */
20878
20879
 
20879
20880
  /**
@@ -21024,7 +21025,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
21024
21025
  /**
21025
21026
  * Events service.
21026
21027
  * @module purecloud-platform-client-v2/api/EventsApi
21027
- * @version 199.0.0
21028
+ * @version 201.0.0
21028
21029
  */
21029
21030
 
21030
21031
  /**
@@ -21120,7 +21121,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
21120
21121
  /**
21121
21122
  * ExternalContacts service.
21122
21123
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
21123
- * @version 199.0.0
21124
+ * @version 201.0.0
21124
21125
  */
21125
21126
 
21126
21127
  /**
@@ -23082,7 +23083,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
23082
23083
  /**
23083
23084
  * Fax service.
23084
23085
  * @module purecloud-platform-client-v2/api/FaxApi
23085
- * @version 199.0.0
23086
+ * @version 201.0.0
23086
23087
  */
23087
23088
 
23088
23089
  /**
@@ -23297,7 +23298,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
23297
23298
  /**
23298
23299
  * Flows service.
23299
23300
  * @module purecloud-platform-client-v2/api/FlowsApi
23300
- * @version 199.0.0
23301
+ * @version 201.0.0
23301
23302
  */
23302
23303
 
23303
23304
  /**
@@ -23480,7 +23481,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
23480
23481
  /**
23481
23482
  * Gamification service.
23482
23483
  * @module purecloud-platform-client-v2/api/GamificationApi
23483
- * @version 199.0.0
23484
+ * @version 201.0.0
23484
23485
  */
23485
23486
 
23486
23487
  /**
@@ -25566,7 +25567,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25566
25567
  /**
25567
25568
  * GeneralDataProtectionRegulation service.
25568
25569
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
25569
- * @version 199.0.0
25570
+ * @version 201.0.0
25570
25571
  */
25571
25572
 
25572
25573
  /**
@@ -25696,7 +25697,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25696
25697
  /**
25697
25698
  * Geolocation service.
25698
25699
  * @module purecloud-platform-client-v2/api/GeolocationApi
25699
- * @version 199.0.0
25700
+ * @version 201.0.0
25700
25701
  */
25701
25702
 
25702
25703
  /**
@@ -25827,7 +25828,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25827
25828
  /**
25828
25829
  * Greetings service.
25829
25830
  * @module purecloud-platform-client-v2/api/GreetingsApi
25830
- * @version 199.0.0
25831
+ * @version 201.0.0
25831
25832
  */
25832
25833
 
25833
25834
  /**
@@ -26282,7 +26283,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26282
26283
  /**
26283
26284
  * Groups service.
26284
26285
  * @module purecloud-platform-client-v2/api/GroupsApi
26285
- * @version 199.0.0
26286
+ * @version 201.0.0
26286
26287
  */
26287
26288
 
26288
26289
  /**
@@ -26801,7 +26802,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26801
26802
  /**
26802
26803
  * IdentityProvider service.
26803
26804
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
26804
- * @version 199.0.0
26805
+ * @version 201.0.0
26805
26806
  */
26806
26807
 
26807
26808
  /**
@@ -27662,7 +27663,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
27662
27663
  /**
27663
27664
  * InfrastructureAsCode service.
27664
27665
  * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
27665
- * @version 199.0.0
27666
+ * @version 201.0.0
27666
27667
  */
27667
27668
 
27668
27669
  /**
@@ -27829,7 +27830,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
27829
27830
  /**
27830
27831
  * Integrations service.
27831
27832
  * @module purecloud-platform-client-v2/api/IntegrationsApi
27832
- * @version 199.0.0
27833
+ * @version 201.0.0
27833
27834
  */
27834
27835
 
27835
27836
  /**
@@ -28378,6 +28379,26 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
28378
28379
  );
28379
28380
  }
28380
28381
 
28382
+ /**
28383
+ * Retrieves basic info about trusted root CA certificates
28384
+ *
28385
+ */
28386
+ getIntegrationsActionsCertificatesTruststore() {
28387
+
28388
+ return this.apiClient.callApi(
28389
+ '/api/v2/integrations/actions/certificates/truststore',
28390
+ 'GET',
28391
+ { },
28392
+ { },
28393
+ { },
28394
+ { },
28395
+ null,
28396
+ ['PureCloud OAuth'],
28397
+ ['application/json'],
28398
+ ['application/json']
28399
+ );
28400
+ }
28401
+
28381
28402
  /**
28382
28403
  * Retrieves all action drafts associated with the filters passed in via query param.
28383
28404
  *
@@ -30181,7 +30202,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
30181
30202
  /**
30182
30203
  * Journey service.
30183
30204
  * @module purecloud-platform-client-v2/api/JourneyApi
30184
- * @version 199.0.0
30205
+ * @version 201.0.0
30185
30206
  */
30186
30207
 
30187
30208
  /**
@@ -31137,15 +31158,22 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
31137
31158
  /**
31138
31159
  * Get a list of Journey Views
31139
31160
  *
31161
+ * @param {Object} opts Optional parameters
31162
+ * @param {Number} opts.pageNumber Page number (default to 1)
31163
+ * @param {Number} opts.pageSize Page size (default to 25)
31164
+ * @param {String} opts.nameOrCreatedBy Journey View Name or Created By
31165
+ * @param {Object} opts.expand Parameter to request additional data to return in Journey payload
31140
31166
  * getJourneyViews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
31141
31167
  */
31142
- getJourneyViews() {
31168
+ getJourneyViews(opts) {
31169
+ opts = opts || {};
31170
+
31143
31171
 
31144
31172
  return this.apiClient.callApi(
31145
31173
  '/api/v2/journey/views',
31146
31174
  'GET',
31147
31175
  { },
31148
- { },
31176
+ { 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'nameOrCreatedBy': opts['nameOrCreatedBy'],'expand': opts['expand'] },
31149
31177
  { },
31150
31178
  { },
31151
31179
  null,
@@ -31827,7 +31855,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
31827
31855
  /**
31828
31856
  * Knowledge service.
31829
31857
  * @module purecloud-platform-client-v2/api/KnowledgeApi
31830
- * @version 199.0.0
31858
+ * @version 201.0.0
31831
31859
  */
31832
31860
 
31833
31861
  /**
@@ -35071,7 +35099,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
35071
35099
  /**
35072
35100
  * LanguageUnderstanding service.
35073
35101
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
35074
- * @version 199.0.0
35102
+ * @version 201.0.0
35075
35103
  */
35076
35104
 
35077
35105
  /**
@@ -36105,7 +36133,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
36105
36133
  /**
36106
36134
  * Languages service.
36107
36135
  * @module purecloud-platform-client-v2/api/LanguagesApi
36108
- * @version 199.0.0
36136
+ * @version 201.0.0
36109
36137
  */
36110
36138
 
36111
36139
  /**
@@ -36327,7 +36355,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
36327
36355
  /**
36328
36356
  * Learning service.
36329
36357
  * @module purecloud-platform-client-v2/api/LearningApi
36330
- * @version 199.0.0
36358
+ * @version 201.0.0
36331
36359
  */
36332
36360
 
36333
36361
  /**
@@ -36473,7 +36501,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
36473
36501
  * @param {Object} opts.sortOrder Specifies result set sort order; if not specified, default sort order is descending (Desc) (default to Desc)
36474
36502
  * @param {Object} opts.sortBy Specifies which field to sort the results by, default sort is by recommendedCompletionDate
36475
36503
  * @param {Array.<String>} opts.userId Specifies the list of user IDs to be queried, up to 100 user IDs.
36476
- * @param {Array.<String>} opts.types Specifies the module types to filter by
36504
+ * @param {Array.<String>} opts.types Specifies the module types to filter by. Informational, AssessedContent and Assessment are deprecated
36477
36505
  * @param {Array.<String>} opts.states Specifies the assignment states to filter by
36478
36506
  * @param {Array.<String>} opts.expand Specifies the expand option for returning additional information
36479
36507
  */
@@ -36510,7 +36538,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
36510
36538
  * @param {Number} opts.maxPercentageScore The maximum assessment score for an assignment (completed with assessment) to be included in the results (inclusive)
36511
36539
  * @param {Object} opts.sortOrder Specifies result set sort order; if not specified, default sort order is descending (Desc) (default to Desc)
36512
36540
  * @param {Object} opts.sortBy Specifies which field to sort the results by, default sort is by recommendedCompletionDate
36513
- * @param {Array.<String>} opts.types Specifies the module types to filter by
36541
+ * @param {Array.<String>} opts.types Specifies the module types to filter by. Informational, AssessedContent and Assessment are deprecated
36514
36542
  * @param {Array.<String>} opts.states Specifies the assignment states to filter by
36515
36543
  * @param {Array.<String>} opts.expand Specifies the expand option for returning additional information
36516
36544
  */
@@ -36680,7 +36708,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
36680
36708
  *
36681
36709
  * @param {Object} opts Optional parameters
36682
36710
  * @param {Boolean} opts.isArchived Archive status (default to false)
36683
- * @param {Array.<String>} opts.types Specifies the module types.
36711
+ * @param {Array.<String>} opts.types Specifies the module types. Informational, AssessedContent and Assessment are deprecated
36684
36712
  * @param {Number} opts.pageSize Page size (default to 25)
36685
36713
  * @param {Number} opts.pageNumber Page number (default to 1)
36686
36714
  * @param {Object} opts.sortOrder Sort order (default to ascending)
@@ -37356,7 +37384,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
37356
37384
  /**
37357
37385
  * License service.
37358
37386
  * @module purecloud-platform-client-v2/api/LicenseApi
37359
- * @version 199.0.0
37387
+ * @version 201.0.0
37360
37388
  */
37361
37389
 
37362
37390
  /**
@@ -37594,7 +37622,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
37594
37622
  /**
37595
37623
  * Locations service.
37596
37624
  * @module purecloud-platform-client-v2/api/LocationsApi
37597
- * @version 199.0.0
37625
+ * @version 201.0.0
37598
37626
  */
37599
37627
 
37600
37628
  /**
@@ -37830,7 +37858,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
37830
37858
  /**
37831
37859
  * LogCapture service.
37832
37860
  * @module purecloud-platform-client-v2/api/LogCaptureApi
37833
- * @version 199.0.0
37861
+ * @version 201.0.0
37834
37862
  */
37835
37863
 
37836
37864
  /**
@@ -38030,7 +38058,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
38030
38058
  /**
38031
38059
  * Messaging service.
38032
38060
  * @module purecloud-platform-client-v2/api/MessagingApi
38033
- * @version 199.0.0
38061
+ * @version 201.0.0
38034
38062
  */
38035
38063
 
38036
38064
  /**
@@ -38389,7 +38417,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
38389
38417
  /**
38390
38418
  * MobileDevices service.
38391
38419
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
38392
- * @version 199.0.0
38420
+ * @version 201.0.0
38393
38421
  */
38394
38422
 
38395
38423
  /**
@@ -38540,7 +38568,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
38540
38568
  /**
38541
38569
  * Notifications service.
38542
38570
  * @module purecloud-platform-client-v2/api/NotificationsApi
38543
- * @version 199.0.0
38571
+ * @version 201.0.0
38544
38572
  */
38545
38573
 
38546
38574
  /**
@@ -38773,7 +38801,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
38773
38801
  /**
38774
38802
  * OAuth service.
38775
38803
  * @module purecloud-platform-client-v2/api/OAuthApi
38776
- * @version 199.0.0
38804
+ * @version 201.0.0
38777
38805
  */
38778
38806
 
38779
38807
  /**
@@ -39139,7 +39167,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39139
39167
  /**
39140
39168
  * Objects service.
39141
39169
  * @module purecloud-platform-client-v2/api/ObjectsApi
39142
- * @version 199.0.0
39170
+ * @version 201.0.0
39143
39171
  */
39144
39172
 
39145
39173
  /**
@@ -39409,7 +39437,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39409
39437
  /**
39410
39438
  * OperationalEvents service.
39411
39439
  * @module purecloud-platform-client-v2/api/OperationalEventsApi
39412
- * @version 199.0.0
39440
+ * @version 201.0.0
39413
39441
  */
39414
39442
 
39415
39443
  /**
@@ -39475,7 +39503,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39475
39503
  /**
39476
39504
  * Organization service.
39477
39505
  * @module purecloud-platform-client-v2/api/OrganizationApi
39478
- * @version 199.0.0
39506
+ * @version 201.0.0
39479
39507
  */
39480
39508
 
39481
39509
  /**
@@ -39696,6 +39724,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39696
39724
  );
39697
39725
  }
39698
39726
 
39727
+ /**
39728
+ * Get estimated limit counts for a namespace. This is not a source of truth for limit values but a record of estimates to facilitate limit threshold tracking.
39729
+ * See https://developer.genesys.cloud/organization/organization/limits#available-limits for limits that are trackable (Operational Events Enabled).
39730
+ * @param {String} namespaceName The namespace to get
39731
+ * @param {Object} opts Optional parameters
39732
+ * @param {String} opts.cursor Cursor provided when retrieving the last page
39733
+ * @param {String} opts.entityId entity id of the count
39734
+ * @param {String} opts.userId userid of the count
39735
+ */
39736
+ getOrganizationsLimitsNamespaceCounts(namespaceName, opts) {
39737
+ opts = opts || {};
39738
+
39739
+ // verify the required parameter 'namespaceName' is set
39740
+ if (namespaceName === undefined || namespaceName === null) {
39741
+ throw 'Missing the required parameter "namespaceName" when calling getOrganizationsLimitsNamespaceCounts';
39742
+ }
39743
+
39744
+ return this.apiClient.callApi(
39745
+ '/api/v2/organizations/limits/namespaces/{namespaceName}/counts',
39746
+ 'GET',
39747
+ { 'namespaceName': namespaceName },
39748
+ { 'cursor': opts['cursor'],'entityId': opts['entityId'],'userId': opts['userId'] },
39749
+ { },
39750
+ { },
39751
+ null,
39752
+ ['PureCloud OAuth'],
39753
+ ['application/json'],
39754
+ ['application/json']
39755
+ );
39756
+ }
39757
+
39699
39758
  /**
39700
39759
  * Get the default limits in a namespace for an organization
39701
39760
  *
@@ -39721,6 +39780,42 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39721
39780
  );
39722
39781
  }
39723
39782
 
39783
+ /**
39784
+ * Get estimated limit counts for a namespace and limit name. This is not a source of truth for limit values but a record of estimates to facilitate limit threshold tracking.
39785
+ * See https://developer.genesys.cloud/organization/organization/limits#available-limits for limits that are trackable (Operational Events Enabled).
39786
+ * @param {String} namespaceName The namespace to get
39787
+ * @param {String} limitName The limit to get
39788
+ * @param {Object} opts Optional parameters
39789
+ * @param {String} opts.entityId entity id of the count
39790
+ * @param {String} opts.userId userid of the count
39791
+ * @param {String} opts.cursor Cursor provided when retrieving the last page
39792
+ */
39793
+ getOrganizationsLimitsNamespaceLimitCounts(namespaceName, limitName, opts) {
39794
+ opts = opts || {};
39795
+
39796
+ // verify the required parameter 'namespaceName' is set
39797
+ if (namespaceName === undefined || namespaceName === null) {
39798
+ throw 'Missing the required parameter "namespaceName" when calling getOrganizationsLimitsNamespaceLimitCounts';
39799
+ }
39800
+ // verify the required parameter 'limitName' is set
39801
+ if (limitName === undefined || limitName === null) {
39802
+ throw 'Missing the required parameter "limitName" when calling getOrganizationsLimitsNamespaceLimitCounts';
39803
+ }
39804
+
39805
+ return this.apiClient.callApi(
39806
+ '/api/v2/organizations/limits/namespaces/{namespaceName}/limits/{limitName}/counts',
39807
+ 'GET',
39808
+ { 'namespaceName': namespaceName,'limitName': limitName },
39809
+ { 'entityId': opts['entityId'],'userId': opts['userId'],'cursor': opts['cursor'] },
39810
+ { },
39811
+ { },
39812
+ null,
39813
+ ['PureCloud OAuth'],
39814
+ ['application/json'],
39815
+ ['application/json']
39816
+ );
39817
+ }
39818
+
39724
39819
  /**
39725
39820
  * Get the available limit namespaces
39726
39821
  *
@@ -39950,7 +40045,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39950
40045
  /**
39951
40046
  * OrganizationAuthorization service.
39952
40047
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
39953
- * @version 199.0.0
40048
+ * @version 201.0.0
39954
40049
  */
39955
40050
 
39956
40051
  /**
@@ -41297,7 +41392,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
41297
41392
  /**
41298
41393
  * Outbound service.
41299
41394
  * @module purecloud-platform-client-v2/api/OutboundApi
41300
- * @version 199.0.0
41395
+ * @version 201.0.0
41301
41396
  */
41302
41397
 
41303
41398
  /**
@@ -45659,7 +45754,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
45659
45754
  /**
45660
45755
  * Presence service.
45661
45756
  * @module purecloud-platform-client-v2/api/PresenceApi
45662
- * @version 199.0.0
45757
+ * @version 201.0.0
45663
45758
  */
45664
45759
 
45665
45760
  /**
@@ -46403,7 +46498,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
46403
46498
  /**
46404
46499
  * ProcessAutomation service.
46405
46500
  * @module purecloud-platform-client-v2/api/ProcessAutomationApi
46406
- * @version 199.0.0
46501
+ * @version 201.0.0
46407
46502
  */
46408
46503
 
46409
46504
  /**
@@ -46642,7 +46737,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
46642
46737
  /**
46643
46738
  * Quality service.
46644
46739
  * @module purecloud-platform-client-v2/api/QualityApi
46645
- * @version 199.0.0
46740
+ * @version 201.0.0
46646
46741
  */
46647
46742
 
46648
46743
  /**
@@ -48428,7 +48523,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
48428
48523
  /**
48429
48524
  * Recording service.
48430
48525
  * @module purecloud-platform-client-v2/api/RecordingApi
48431
- * @version 199.0.0
48526
+ * @version 201.0.0
48432
48527
  */
48433
48528
 
48434
48529
  /**
@@ -49420,10 +49515,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
49420
49515
 
49421
49516
  /**
49422
49517
  * Update a screen recording session
49423
- *
49518
+ * This API is deprecated and the functionality to stop screen recording will be no longer supported.
49424
49519
  * @param {String} recordingSessionId Screen recording session ID
49425
49520
  * @param {Object} opts Optional parameters
49426
49521
  * @param {Object} opts.body
49522
+ * @deprecated
49427
49523
  */
49428
49524
  patchRecordingsScreensession(recordingSessionId, opts) {
49429
49525
  opts = opts || {};
@@ -50086,7 +50182,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50086
50182
  /**
50087
50183
  * ResponseManagement service.
50088
50184
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
50089
- * @version 199.0.0
50185
+ * @version 201.0.0
50090
50186
  */
50091
50187
 
50092
50188
  /**
@@ -50596,7 +50692,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50596
50692
  /**
50597
50693
  * Routing service.
50598
50694
  * @module purecloud-platform-client-v2/api/RoutingApi
50599
- * @version 199.0.0
50695
+ * @version 201.0.0
50600
50696
  */
50601
50697
 
50602
50698
  /**
@@ -50636,6 +50732,26 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50636
50732
  );
50637
50733
  }
50638
50734
 
50735
+ /**
50736
+ * Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.
50737
+ *
50738
+ */
50739
+ deleteRoutingDirectroutingbackupSettingsMe() {
50740
+
50741
+ return this.apiClient.callApi(
50742
+ '/api/v2/routing/directroutingbackup/settings/me',
50743
+ 'DELETE',
50744
+ { },
50745
+ { },
50746
+ { },
50747
+ { },
50748
+ null,
50749
+ ['PureCloud OAuth'],
50750
+ ['application/json'],
50751
+ ['application/json']
50752
+ );
50753
+ }
50754
+
50639
50755
  /**
50640
50756
  * Delete a domain
50641
50757
  *
@@ -51006,6 +51122,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
51006
51122
  );
51007
51123
  }
51008
51124
 
51125
+ /**
51126
+ * Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.
51127
+ *
51128
+ * @param {String} userId User ID
51129
+ */
51130
+ deleteRoutingUserDirectroutingbackupSettings(userId) {
51131
+ // verify the required parameter 'userId' is set
51132
+ if (userId === undefined || userId === null) {
51133
+ throw 'Missing the required parameter "userId" when calling deleteRoutingUserDirectroutingbackupSettings';
51134
+ }
51135
+
51136
+ return this.apiClient.callApi(
51137
+ '/api/v2/routing/users/{userId}/directroutingbackup/settings',
51138
+ 'DELETE',
51139
+ { 'userId': userId },
51140
+ { },
51141
+ { },
51142
+ { },
51143
+ null,
51144
+ ['PureCloud OAuth'],
51145
+ ['application/json'],
51146
+ ['application/json']
51147
+ );
51148
+ }
51149
+
51009
51150
  /**
51010
51151
  * Delete the user's max utilization settings and revert to the organization-wide default.
51011
51152
  *
@@ -51317,6 +51458,26 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
51317
51458
  );
51318
51459
  }
51319
51460
 
51461
+ /**
51462
+ * Get the user's Direct Routing Backup settings.
51463
+ *
51464
+ */
51465
+ getRoutingDirectroutingbackupSettingsMe() {
51466
+
51467
+ return this.apiClient.callApi(
51468
+ '/api/v2/routing/directroutingbackup/settings/me',
51469
+ 'GET',
51470
+ { },
51471
+ { },
51472
+ { },
51473
+ { },
51474
+ null,
51475
+ ['PureCloud OAuth'],
51476
+ ['application/json'],
51477
+ ['application/json']
51478
+ );
51479
+ }
51480
+
51320
51481
  /**
51321
51482
  * Get domain
51322
51483
  *
@@ -52527,6 +52688,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
52527
52688
  );
52528
52689
  }
52529
52690
 
52691
+ /**
52692
+ * Get the user's Direct Routing Backup settings.
52693
+ *
52694
+ * @param {String} userId User ID
52695
+ */
52696
+ getRoutingUserDirectroutingbackupSettings(userId) {
52697
+ // verify the required parameter 'userId' is set
52698
+ if (userId === undefined || userId === null) {
52699
+ throw 'Missing the required parameter "userId" when calling getRoutingUserDirectroutingbackupSettings';
52700
+ }
52701
+
52702
+ return this.apiClient.callApi(
52703
+ '/api/v2/routing/users/{userId}/directroutingbackup/settings',
52704
+ 'GET',
52705
+ { 'userId': userId },
52706
+ { },
52707
+ { },
52708
+ { },
52709
+ null,
52710
+ ['PureCloud OAuth'],
52711
+ ['application/json'],
52712
+ ['application/json']
52713
+ );
52714
+ }
52715
+
52530
52716
  /**
52531
52717
  * Get the user's max utilization settings. If not configured, the organization-wide default is returned.
52532
52718
  *
@@ -54184,6 +54370,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
54184
54370
  );
54185
54371
  }
54186
54372
 
54373
+ /**
54374
+ * Update the user's Direct Routing Backup settings.
54375
+ *
54376
+ * @param {Object} body directRoutingBackup
54377
+ */
54378
+ putRoutingDirectroutingbackupSettingsMe(body) {
54379
+ // verify the required parameter 'body' is set
54380
+ if (body === undefined || body === null) {
54381
+ throw 'Missing the required parameter "body" when calling putRoutingDirectroutingbackupSettingsMe';
54382
+ }
54383
+
54384
+ return this.apiClient.callApi(
54385
+ '/api/v2/routing/directroutingbackup/settings/me',
54386
+ 'PUT',
54387
+ { },
54388
+ { },
54389
+ { },
54390
+ { },
54391
+ body,
54392
+ ['PureCloud OAuth'],
54393
+ ['application/json'],
54394
+ ['application/json']
54395
+ );
54396
+ }
54397
+
54187
54398
  /**
54188
54399
  * Update a route
54189
54400
  *
@@ -54384,6 +54595,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
54384
54595
  );
54385
54596
  }
54386
54597
 
54598
+ /**
54599
+ * Update the user's Direct Routing Backup settings.
54600
+ *
54601
+ * @param {String} userId User ID
54602
+ * @param {Object} body directRoutingBackup
54603
+ */
54604
+ putRoutingUserDirectroutingbackupSettings(userId, body) {
54605
+ // verify the required parameter 'userId' is set
54606
+ if (userId === undefined || userId === null) {
54607
+ throw 'Missing the required parameter "userId" when calling putRoutingUserDirectroutingbackupSettings';
54608
+ }
54609
+ // verify the required parameter 'body' is set
54610
+ if (body === undefined || body === null) {
54611
+ throw 'Missing the required parameter "body" when calling putRoutingUserDirectroutingbackupSettings';
54612
+ }
54613
+
54614
+ return this.apiClient.callApi(
54615
+ '/api/v2/routing/users/{userId}/directroutingbackup/settings',
54616
+ 'PUT',
54617
+ { 'userId': userId },
54618
+ { },
54619
+ { },
54620
+ { },
54621
+ body,
54622
+ ['PureCloud OAuth'],
54623
+ ['application/json'],
54624
+ ['application/json']
54625
+ );
54626
+ }
54627
+
54387
54628
  /**
54388
54629
  * Update the user's max utilization settings. Include only those media types requiring custom configuration.
54389
54630
  *
@@ -54570,7 +54811,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
54570
54811
  /**
54571
54812
  * SCIM service.
54572
54813
  * @module purecloud-platform-client-v2/api/SCIMApi
54573
- * @version 199.0.0
54814
+ * @version 201.0.0
54574
54815
  */
54575
54816
 
54576
54817
  /**
@@ -55447,7 +55688,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
55447
55688
  /**
55448
55689
  * ScreenRecording service.
55449
55690
  * @module purecloud-platform-client-v2/api/ScreenRecordingApi
55450
- * @version 199.0.0
55691
+ * @version 201.0.0
55451
55692
  */
55452
55693
 
55453
55694
  /**
@@ -55492,7 +55733,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
55492
55733
  /**
55493
55734
  * Scripts service.
55494
55735
  * @module purecloud-platform-client-v2/api/ScriptsApi
55495
- * @version 199.0.0
55736
+ * @version 201.0.0
55496
55737
  */
55497
55738
 
55498
55739
  /**
@@ -55936,7 +56177,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
55936
56177
  /**
55937
56178
  * Search service.
55938
56179
  * @module purecloud-platform-client-v2/api/SearchApi
55939
- * @version 199.0.0
56180
+ * @version 201.0.0
55940
56181
  */
55941
56182
 
55942
56183
  /**
@@ -56625,7 +56866,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
56625
56866
  /**
56626
56867
  * Settings service.
56627
56868
  * @module purecloud-platform-client-v2/api/SettingsApi
56628
- * @version 199.0.0
56869
+ * @version 201.0.0
56629
56870
  */
56630
56871
 
56631
56872
  /**
@@ -56847,7 +57088,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
56847
57088
  /**
56848
57089
  * SpeechTextAnalytics service.
56849
57090
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
56850
- * @version 199.0.0
57091
+ * @version 201.0.0
56851
57092
  */
56852
57093
 
56853
57094
  /**
@@ -58125,7 +58366,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58125
58366
  /**
58126
58367
  * Stations service.
58127
58368
  * @module purecloud-platform-client-v2/api/StationsApi
58128
- * @version 199.0.0
58369
+ * @version 201.0.0
58129
58370
  */
58130
58371
 
58131
58372
  /**
@@ -58227,7 +58468,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58227
58468
  /**
58228
58469
  * Suggest service.
58229
58470
  * @module purecloud-platform-client-v2/api/SuggestApi
58230
- * @version 199.0.0
58471
+ * @version 201.0.0
58231
58472
  */
58232
58473
 
58233
58474
  /**
@@ -58366,7 +58607,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58366
58607
  /**
58367
58608
  * TaskManagement service.
58368
58609
  * @module purecloud-platform-client-v2/api/TaskManagementApi
58369
- * @version 199.0.0
58610
+ * @version 201.0.0
58370
58611
  */
58371
58612
 
58372
58613
  /**
@@ -59313,16 +59554,17 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
59313
59554
  * Update the attributes of a worktype
59314
59555
  *
59315
59556
  * @param {String} worktypeId Worktype id
59316
- * @param {Object} opts Optional parameters
59317
- * @param {Object} opts.body body
59557
+ * @param {Object} body Worktype
59318
59558
  */
59319
- patchTaskmanagementWorktype(worktypeId, opts) {
59320
- opts = opts || {};
59321
-
59559
+ patchTaskmanagementWorktype(worktypeId, body) {
59322
59560
  // verify the required parameter 'worktypeId' is set
59323
59561
  if (worktypeId === undefined || worktypeId === null) {
59324
59562
  throw 'Missing the required parameter "worktypeId" when calling patchTaskmanagementWorktype';
59325
59563
  }
59564
+ // verify the required parameter 'body' is set
59565
+ if (body === undefined || body === null) {
59566
+ throw 'Missing the required parameter "body" when calling patchTaskmanagementWorktype';
59567
+ }
59326
59568
 
59327
59569
  return this.apiClient.callApi(
59328
59570
  '/api/v2/taskmanagement/worktypes/{worktypeId}',
@@ -59331,7 +59573,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
59331
59573
  { },
59332
59574
  { },
59333
59575
  { },
59334
- opts['body'],
59576
+ body,
59335
59577
  ['PureCloud OAuth'],
59336
59578
  ['application/json'],
59337
59579
  ['application/json']
@@ -59343,12 +59585,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
59343
59585
  *
59344
59586
  * @param {String} worktypeId Worktype id
59345
59587
  * @param {String} statusId Status id
59346
- * @param {Object} opts Optional parameters
59347
- * @param {Object} opts.body body
59588
+ * @param {Object} body Status
59348
59589
  */
59349
- patchTaskmanagementWorktypeStatus(worktypeId, statusId, opts) {
59350
- opts = opts || {};
59351
-
59590
+ patchTaskmanagementWorktypeStatus(worktypeId, statusId, body) {
59352
59591
  // verify the required parameter 'worktypeId' is set
59353
59592
  if (worktypeId === undefined || worktypeId === null) {
59354
59593
  throw 'Missing the required parameter "worktypeId" when calling patchTaskmanagementWorktypeStatus';
@@ -59357,6 +59596,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
59357
59596
  if (statusId === undefined || statusId === null) {
59358
59597
  throw 'Missing the required parameter "statusId" when calling patchTaskmanagementWorktypeStatus';
59359
59598
  }
59599
+ // verify the required parameter 'body' is set
59600
+ if (body === undefined || body === null) {
59601
+ throw 'Missing the required parameter "body" when calling patchTaskmanagementWorktypeStatus';
59602
+ }
59360
59603
 
59361
59604
  return this.apiClient.callApi(
59362
59605
  '/api/v2/taskmanagement/worktypes/{worktypeId}/statuses/{statusId}',
@@ -59365,7 +59608,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
59365
59608
  { },
59366
59609
  { },
59367
59610
  { },
59368
- opts['body'],
59611
+ body,
59369
59612
  ['PureCloud OAuth'],
59370
59613
  ['application/json'],
59371
59614
  ['application/json']
@@ -59375,12 +59618,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
59375
59618
  /**
59376
59619
  * Create a workbin
59377
59620
  *
59378
- * @param {Object} opts Optional parameters
59379
- * @param {Object} opts.body body
59621
+ * @param {Object} body Workbin
59380
59622
  */
59381
- postTaskmanagementWorkbins(opts) {
59382
- opts = opts || {};
59383
-
59623
+ postTaskmanagementWorkbins(body) {
59624
+ // verify the required parameter 'body' is set
59625
+ if (body === undefined || body === null) {
59626
+ throw 'Missing the required parameter "body" when calling postTaskmanagementWorkbins';
59627
+ }
59384
59628
 
59385
59629
  return this.apiClient.callApi(
59386
59630
  '/api/v2/taskmanagement/workbins',
@@ -59389,7 +59633,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
59389
59633
  { },
59390
59634
  { },
59391
59635
  { },
59392
- opts['body'],
59636
+ body,
59393
59637
  ['PureCloud OAuth'],
59394
59638
  ['application/json'],
59395
59639
  ['application/json']
@@ -59605,16 +59849,17 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
59605
59849
  * Add a status to a worktype
59606
59850
  *
59607
59851
  * @param {String} worktypeId Worktype id
59608
- * @param {Object} opts Optional parameters
59609
- * @param {Object} opts.body body
59852
+ * @param {Object} body Status
59610
59853
  */
59611
- postTaskmanagementWorktypeStatuses(worktypeId, opts) {
59612
- opts = opts || {};
59613
-
59854
+ postTaskmanagementWorktypeStatuses(worktypeId, body) {
59614
59855
  // verify the required parameter 'worktypeId' is set
59615
59856
  if (worktypeId === undefined || worktypeId === null) {
59616
59857
  throw 'Missing the required parameter "worktypeId" when calling postTaskmanagementWorktypeStatuses';
59617
59858
  }
59859
+ // verify the required parameter 'body' is set
59860
+ if (body === undefined || body === null) {
59861
+ throw 'Missing the required parameter "body" when calling postTaskmanagementWorktypeStatuses';
59862
+ }
59618
59863
 
59619
59864
  return this.apiClient.callApi(
59620
59865
  '/api/v2/taskmanagement/worktypes/{worktypeId}/statuses',
@@ -59623,7 +59868,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
59623
59868
  { },
59624
59869
  { },
59625
59870
  { },
59626
- opts['body'],
59871
+ body,
59627
59872
  ['PureCloud OAuth'],
59628
59873
  ['application/json'],
59629
59874
  ['application/json']
@@ -59633,12 +59878,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
59633
59878
  /**
59634
59879
  * Create a worktype
59635
59880
  *
59636
- * @param {Object} opts Optional parameters
59637
- * @param {Object} opts.body body
59881
+ * @param {Object} body Worktype
59638
59882
  */
59639
- postTaskmanagementWorktypes(opts) {
59640
- opts = opts || {};
59641
-
59883
+ postTaskmanagementWorktypes(body) {
59884
+ // verify the required parameter 'body' is set
59885
+ if (body === undefined || body === null) {
59886
+ throw 'Missing the required parameter "body" when calling postTaskmanagementWorktypes';
59887
+ }
59642
59888
 
59643
59889
  return this.apiClient.callApi(
59644
59890
  '/api/v2/taskmanagement/worktypes',
@@ -59647,7 +59893,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
59647
59893
  { },
59648
59894
  { },
59649
59895
  { },
59650
- opts['body'],
59896
+ body,
59651
59897
  ['PureCloud OAuth'],
59652
59898
  ['application/json'],
59653
59899
  ['application/json']
@@ -59715,7 +59961,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
59715
59961
  /**
59716
59962
  * Teams service.
59717
59963
  * @module purecloud-platform-client-v2/api/TeamsApi
59718
- * @version 199.0.0
59964
+ * @version 201.0.0
59719
59965
  */
59720
59966
 
59721
59967
  /**
@@ -60016,7 +60262,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
60016
60262
  /**
60017
60263
  * Telephony service.
60018
60264
  * @module purecloud-platform-client-v2/api/TelephonyApi
60019
- * @version 199.0.0
60265
+ * @version 201.0.0
60020
60266
  */
60021
60267
 
60022
60268
  /**
@@ -60198,7 +60444,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
60198
60444
  /**
60199
60445
  * TelephonyProvidersEdge service.
60200
60446
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
60201
- * @version 199.0.0
60447
+ * @version 201.0.0
60202
60448
  */
60203
60449
 
60204
60450
  /**
@@ -63526,7 +63772,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
63526
63772
  /**
63527
63773
  * Textbots service.
63528
63774
  * @module purecloud-platform-client-v2/api/TextbotsApi
63529
- * @version 199.0.0
63775
+ * @version 201.0.0
63530
63776
  */
63531
63777
 
63532
63778
  /**
@@ -63654,7 +63900,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
63654
63900
  /**
63655
63901
  * Tokens service.
63656
63902
  * @module purecloud-platform-client-v2/api/TokensApi
63657
- * @version 199.0.0
63903
+ * @version 201.0.0
63658
63904
  */
63659
63905
 
63660
63906
  /**
@@ -63808,7 +64054,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
63808
64054
  /**
63809
64055
  * Uploads service.
63810
64056
  * @module purecloud-platform-client-v2/api/UploadsApi
63811
- * @version 199.0.0
64057
+ * @version 201.0.0
63812
64058
  */
63813
64059
 
63814
64060
  /**
@@ -64077,7 +64323,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
64077
64323
  /**
64078
64324
  * Usage service.
64079
64325
  * @module purecloud-platform-client-v2/api/UsageApi
64080
- * @version 199.0.0
64326
+ * @version 201.0.0
64081
64327
  */
64082
64328
 
64083
64329
  /**
@@ -64292,7 +64538,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
64292
64538
  /**
64293
64539
  * UserRecordings service.
64294
64540
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
64295
- * @version 199.0.0
64541
+ * @version 201.0.0
64296
64542
  */
64297
64543
 
64298
64544
  /**
@@ -64477,7 +64723,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
64477
64723
  /**
64478
64724
  * Users service.
64479
64725
  * @module purecloud-platform-client-v2/api/UsersApi
64480
- * @version 199.0.0
64726
+ * @version 201.0.0
64481
64727
  */
64482
64728
 
64483
64729
  /**
@@ -64552,6 +64798,51 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
64552
64798
  );
64553
64799
  }
64554
64800
 
64801
+ /**
64802
+ * Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.
64803
+ *
64804
+ */
64805
+ deleteRoutingDirectroutingbackupSettingsMe() {
64806
+
64807
+ return this.apiClient.callApi(
64808
+ '/api/v2/routing/directroutingbackup/settings/me',
64809
+ 'DELETE',
64810
+ { },
64811
+ { },
64812
+ { },
64813
+ { },
64814
+ null,
64815
+ ['PureCloud OAuth'],
64816
+ ['application/json'],
64817
+ ['application/json']
64818
+ );
64819
+ }
64820
+
64821
+ /**
64822
+ * Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.
64823
+ *
64824
+ * @param {String} userId User ID
64825
+ */
64826
+ deleteRoutingUserDirectroutingbackupSettings(userId) {
64827
+ // verify the required parameter 'userId' is set
64828
+ if (userId === undefined || userId === null) {
64829
+ throw 'Missing the required parameter "userId" when calling deleteRoutingUserDirectroutingbackupSettings';
64830
+ }
64831
+
64832
+ return this.apiClient.callApi(
64833
+ '/api/v2/routing/users/{userId}/directroutingbackup/settings',
64834
+ 'DELETE',
64835
+ { 'userId': userId },
64836
+ { },
64837
+ { },
64838
+ { },
64839
+ null,
64840
+ ['PureCloud OAuth'],
64841
+ ['application/json'],
64842
+ ['application/json']
64843
+ );
64844
+ }
64845
+
64555
64846
  /**
64556
64847
  * Delete the user's max utilization settings and revert to the organization-wide default.
64557
64848
  *
@@ -65079,6 +65370,51 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
65079
65370
  );
65080
65371
  }
65081
65372
 
65373
+ /**
65374
+ * Get the user's Direct Routing Backup settings.
65375
+ *
65376
+ */
65377
+ getRoutingDirectroutingbackupSettingsMe() {
65378
+
65379
+ return this.apiClient.callApi(
65380
+ '/api/v2/routing/directroutingbackup/settings/me',
65381
+ 'GET',
65382
+ { },
65383
+ { },
65384
+ { },
65385
+ { },
65386
+ null,
65387
+ ['PureCloud OAuth'],
65388
+ ['application/json'],
65389
+ ['application/json']
65390
+ );
65391
+ }
65392
+
65393
+ /**
65394
+ * Get the user's Direct Routing Backup settings.
65395
+ *
65396
+ * @param {String} userId User ID
65397
+ */
65398
+ getRoutingUserDirectroutingbackupSettings(userId) {
65399
+ // verify the required parameter 'userId' is set
65400
+ if (userId === undefined || userId === null) {
65401
+ throw 'Missing the required parameter "userId" when calling getRoutingUserDirectroutingbackupSettings';
65402
+ }
65403
+
65404
+ return this.apiClient.callApi(
65405
+ '/api/v2/routing/users/{userId}/directroutingbackup/settings',
65406
+ 'GET',
65407
+ { 'userId': userId },
65408
+ { },
65409
+ { },
65410
+ { },
65411
+ null,
65412
+ ['PureCloud OAuth'],
65413
+ ['application/json'],
65414
+ ['application/json']
65415
+ );
65416
+ }
65417
+
65082
65418
  /**
65083
65419
  * Get the user's max utilization settings. If not configured, the organization-wide default is returned.
65084
65420
  *
@@ -65715,7 +66051,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
65715
66051
  * @param {Number} opts.pageSize Page size (default to 25)
65716
66052
  * @param {Number} opts.pageNumber Page number (default to 1)
65717
66053
  * @param {Object} opts.sortOrder Specifies result set sort order sorted by the date due; if not specified, default sort order is descending (Desc) (default to Desc)
65718
- * @param {Array.<String>} opts.types Specifies the activity types.
66054
+ * @param {Array.<String>} opts.types Specifies the activity types. Informational, AssessedContent and Assessment are deprecated
65719
66055
  * @param {Array.<String>} opts.statuses Specifies the activity statuses to filter by
65720
66056
  * @param {Array.<String>} opts.relationship Specifies how the current user relation should be interpreted, and filters the activities returned to only the activities that have the specified relationship. If a value besides Attendee is specified, it will only return Coaching Appointments. If not specified, no filtering is applied.
65721
66057
  */
@@ -65749,7 +66085,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
65749
66085
  * @param {Number} opts.pageSize Page size (default to 25)
65750
66086
  * @param {Number} opts.pageNumber Page number (default to 1)
65751
66087
  * @param {Object} opts.sortOrder Specifies result set sort order sorted by the date due; if not specified, default sort order is descending (Desc) (default to Desc)
65752
- * @param {Array.<String>} opts.types Specifies the activity types.
66088
+ * @param {Array.<String>} opts.types Specifies the activity types. Informational, AssessedContent and Assessment are deprecated
65753
66089
  * @param {Array.<String>} opts.statuses Specifies the activity statuses to filter by
65754
66090
  * @param {Array.<String>} opts.relationship Specifies how the current user relation should be interpreted, and filters the activities returned to only the activities that have the specified relationship. If a value besides Attendee is specified, it will only return Coaching Appointments. If not specified, no filtering is applied.
65755
66091
  */
@@ -65775,7 +66111,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
65775
66111
  * Get a Development Activity
65776
66112
  * Permission not required if you are the attendee, creator or facilitator of the coaching appointment or you are the assigned user of the learning assignment.
65777
66113
  * @param {String} activityId Specifies the activity ID, maps to either assignment or appointment ID
65778
- * @param {Object} type Specifies the activity type.
66114
+ * @param {Object} type Specifies the activity type. Informational, AssessedContent and Assessment are deprecated
65779
66115
  */
65780
66116
  getUsersDevelopmentActivity(activityId, type) {
65781
66117
  // verify the required parameter 'activityId' is set
@@ -66759,6 +67095,61 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
66759
67095
  );
66760
67096
  }
66761
67097
 
67098
+ /**
67099
+ * Update the user's Direct Routing Backup settings.
67100
+ *
67101
+ * @param {Object} body directRoutingBackup
67102
+ */
67103
+ putRoutingDirectroutingbackupSettingsMe(body) {
67104
+ // verify the required parameter 'body' is set
67105
+ if (body === undefined || body === null) {
67106
+ throw 'Missing the required parameter "body" when calling putRoutingDirectroutingbackupSettingsMe';
67107
+ }
67108
+
67109
+ return this.apiClient.callApi(
67110
+ '/api/v2/routing/directroutingbackup/settings/me',
67111
+ 'PUT',
67112
+ { },
67113
+ { },
67114
+ { },
67115
+ { },
67116
+ body,
67117
+ ['PureCloud OAuth'],
67118
+ ['application/json'],
67119
+ ['application/json']
67120
+ );
67121
+ }
67122
+
67123
+ /**
67124
+ * Update the user's Direct Routing Backup settings.
67125
+ *
67126
+ * @param {String} userId User ID
67127
+ * @param {Object} body directRoutingBackup
67128
+ */
67129
+ putRoutingUserDirectroutingbackupSettings(userId, body) {
67130
+ // verify the required parameter 'userId' is set
67131
+ if (userId === undefined || userId === null) {
67132
+ throw 'Missing the required parameter "userId" when calling putRoutingUserDirectroutingbackupSettings';
67133
+ }
67134
+ // verify the required parameter 'body' is set
67135
+ if (body === undefined || body === null) {
67136
+ throw 'Missing the required parameter "body" when calling putRoutingUserDirectroutingbackupSettings';
67137
+ }
67138
+
67139
+ return this.apiClient.callApi(
67140
+ '/api/v2/routing/users/{userId}/directroutingbackup/settings',
67141
+ 'PUT',
67142
+ { 'userId': userId },
67143
+ { },
67144
+ { },
67145
+ { },
67146
+ body,
67147
+ ['PureCloud OAuth'],
67148
+ ['application/json'],
67149
+ ['application/json']
67150
+ );
67151
+ }
67152
+
66762
67153
  /**
66763
67154
  * Update the user's max utilization settings. Include only those media types requiring custom configuration.
66764
67155
  *
@@ -67135,7 +67526,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
67135
67526
  /**
67136
67527
  * Utilities service.
67137
67528
  * @module purecloud-platform-client-v2/api/UtilitiesApi
67138
- * @version 199.0.0
67529
+ * @version 201.0.0
67139
67530
  */
67140
67531
 
67141
67532
  /**
@@ -67246,7 +67637,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
67246
67637
  /**
67247
67638
  * Voicemail service.
67248
67639
  * @module purecloud-platform-client-v2/api/VoicemailApi
67249
- * @version 199.0.0
67640
+ * @version 201.0.0
67250
67641
  */
67251
67642
 
67252
67643
  /**
@@ -67913,7 +68304,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
67913
68304
  /**
67914
68305
  * WebChat service.
67915
68306
  * @module purecloud-platform-client-v2/api/WebChatApi
67916
- * @version 199.0.0
68307
+ * @version 201.0.0
67917
68308
  */
67918
68309
 
67919
68310
  /**
@@ -68464,7 +68855,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
68464
68855
  /**
68465
68856
  * WebDeployments service.
68466
68857
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
68467
- * @version 199.0.0
68858
+ * @version 201.0.0
68468
68859
  */
68469
68860
 
68470
68861
  /**
@@ -68991,7 +69382,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
68991
69382
  /**
68992
69383
  * WebMessaging service.
68993
69384
  * @module purecloud-platform-client-v2/api/WebMessagingApi
68994
- * @version 199.0.0
69385
+ * @version 201.0.0
68995
69386
  */
68996
69387
 
68997
69388
  /**
@@ -69037,7 +69428,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
69037
69428
  /**
69038
69429
  * Widgets service.
69039
69430
  * @module purecloud-platform-client-v2/api/WidgetsApi
69040
- * @version 199.0.0
69431
+ * @version 201.0.0
69041
69432
  */
69042
69433
 
69043
69434
  /**
@@ -69183,7 +69574,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
69183
69574
  /**
69184
69575
  * WorkforceManagement service.
69185
69576
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
69186
- * @version 199.0.0
69577
+ * @version 201.0.0
69187
69578
  */
69188
69579
 
69189
69580
  /**
@@ -69503,6 +69894,71 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
69503
69894
  );
69504
69895
  }
69505
69896
 
69897
+ /**
69898
+ * Delete a work plan bid
69899
+ *
69900
+ * @param {String} businessUnitId The ID of the business unit
69901
+ * @param {String} bidId The ID of the work plan bid
69902
+ */
69903
+ deleteWorkforcemanagementBusinessunitWorkplanbid(businessUnitId, bidId) {
69904
+ // verify the required parameter 'businessUnitId' is set
69905
+ if (businessUnitId === undefined || businessUnitId === null) {
69906
+ throw 'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitWorkplanbid';
69907
+ }
69908
+ // verify the required parameter 'bidId' is set
69909
+ if (bidId === undefined || bidId === null) {
69910
+ throw 'Missing the required parameter "bidId" when calling deleteWorkforcemanagementBusinessunitWorkplanbid';
69911
+ }
69912
+
69913
+ return this.apiClient.callApi(
69914
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}',
69915
+ 'DELETE',
69916
+ { 'businessUnitId': businessUnitId,'bidId': bidId },
69917
+ { },
69918
+ { },
69919
+ { },
69920
+ null,
69921
+ ['PureCloud OAuth'],
69922
+ ['application/json'],
69923
+ ['application/json']
69924
+ );
69925
+ }
69926
+
69927
+ /**
69928
+ * Delete a bid group by bid group Id
69929
+ *
69930
+ * @param {String} businessUnitId The ID of the business unit
69931
+ * @param {String} bidId The work plan bid id of the bid groups
69932
+ * @param {String} bidGroupId Work Plan Bid Group id
69933
+ */
69934
+ deleteWorkforcemanagementBusinessunitWorkplanbidGroup(businessUnitId, bidId, bidGroupId) {
69935
+ // verify the required parameter 'businessUnitId' is set
69936
+ if (businessUnitId === undefined || businessUnitId === null) {
69937
+ throw 'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitWorkplanbidGroup';
69938
+ }
69939
+ // verify the required parameter 'bidId' is set
69940
+ if (bidId === undefined || bidId === null) {
69941
+ throw 'Missing the required parameter "bidId" when calling deleteWorkforcemanagementBusinessunitWorkplanbidGroup';
69942
+ }
69943
+ // verify the required parameter 'bidGroupId' is set
69944
+ if (bidGroupId === undefined || bidGroupId === null) {
69945
+ throw 'Missing the required parameter "bidGroupId" when calling deleteWorkforcemanagementBusinessunitWorkplanbidGroup';
69946
+ }
69947
+
69948
+ return this.apiClient.callApi(
69949
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}',
69950
+ 'DELETE',
69951
+ { 'businessUnitId': businessUnitId,'bidId': bidId,'bidGroupId': bidGroupId },
69952
+ { },
69953
+ { },
69954
+ { },
69955
+ null,
69956
+ ['PureCloud OAuth'],
69957
+ ['application/json'],
69958
+ ['application/json']
69959
+ );
69960
+ }
69961
+
69506
69962
  /**
69507
69963
  * Disable generated calendar link for the current user
69508
69964
  *
@@ -69868,6 +70324,175 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
69868
70324
  );
69869
70325
  }
69870
70326
 
70327
+ /**
70328
+ * Query the status of an alternative shift offers operation. Only the user who started the operation can query the status
70329
+ * Job details are only retained if the initial request returned a 202 ACCEPTED response
70330
+ * @param {String} jobId The ID of the job
70331
+ */
70332
+ getWorkforcemanagementAlternativeshiftsOffersJob(jobId) {
70333
+ // verify the required parameter 'jobId' is set
70334
+ if (jobId === undefined || jobId === null) {
70335
+ throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementAlternativeshiftsOffersJob';
70336
+ }
70337
+
70338
+ return this.apiClient.callApi(
70339
+ '/api/v2/workforcemanagement/alternativeshifts/offers/jobs/{jobId}',
70340
+ 'GET',
70341
+ { 'jobId': jobId },
70342
+ { },
70343
+ { },
70344
+ { },
70345
+ null,
70346
+ ['PureCloud OAuth'],
70347
+ ['application/json'],
70348
+ ['application/json']
70349
+ );
70350
+ }
70351
+
70352
+ /**
70353
+ * Query the status of an alternative shift search offers operation. Only the user who started the operation can query the status
70354
+ * Job details are only retained if the initial request returned a 202 ACCEPTED response
70355
+ * @param {String} jobId The ID of the job
70356
+ */
70357
+ getWorkforcemanagementAlternativeshiftsOffersSearchJob(jobId) {
70358
+ // verify the required parameter 'jobId' is set
70359
+ if (jobId === undefined || jobId === null) {
70360
+ throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementAlternativeshiftsOffersSearchJob';
70361
+ }
70362
+
70363
+ return this.apiClient.callApi(
70364
+ '/api/v2/workforcemanagement/alternativeshifts/offers/search/jobs/{jobId}',
70365
+ 'GET',
70366
+ { 'jobId': jobId },
70367
+ { },
70368
+ { },
70369
+ { },
70370
+ null,
70371
+ ['PureCloud OAuth'],
70372
+ ['application/json'],
70373
+ ['application/json']
70374
+ );
70375
+ }
70376
+
70377
+ /**
70378
+ * Get alternative shifts settings from the current logged in agent’s business unit
70379
+ *
70380
+ */
70381
+ getWorkforcemanagementAlternativeshiftsSettings() {
70382
+
70383
+ return this.apiClient.callApi(
70384
+ '/api/v2/workforcemanagement/alternativeshifts/settings',
70385
+ 'GET',
70386
+ { },
70387
+ { },
70388
+ { },
70389
+ { },
70390
+ null,
70391
+ ['PureCloud OAuth'],
70392
+ ['application/json'],
70393
+ ['application/json']
70394
+ );
70395
+ }
70396
+
70397
+ /**
70398
+ * Get my alternative shift trade by trade ID
70399
+ *
70400
+ * @param {String} tradeId The ID of the alternative shift trade
70401
+ */
70402
+ getWorkforcemanagementAlternativeshiftsTrade(tradeId) {
70403
+ // verify the required parameter 'tradeId' is set
70404
+ if (tradeId === undefined || tradeId === null) {
70405
+ throw 'Missing the required parameter "tradeId" when calling getWorkforcemanagementAlternativeshiftsTrade';
70406
+ }
70407
+
70408
+ return this.apiClient.callApi(
70409
+ '/api/v2/workforcemanagement/alternativeshifts/trades/{tradeId}',
70410
+ 'GET',
70411
+ { 'tradeId': tradeId },
70412
+ { },
70413
+ { },
70414
+ { },
70415
+ null,
70416
+ ['PureCloud OAuth'],
70417
+ ['application/json'],
70418
+ ['application/json']
70419
+ );
70420
+ }
70421
+
70422
+ /**
70423
+ * Get a list of my alternative shifts trades
70424
+ *
70425
+ * @param {Object} opts Optional parameters
70426
+ * @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
70427
+ */
70428
+ getWorkforcemanagementAlternativeshiftsTrades(opts) {
70429
+ opts = opts || {};
70430
+
70431
+
70432
+ return this.apiClient.callApi(
70433
+ '/api/v2/workforcemanagement/alternativeshifts/trades',
70434
+ 'GET',
70435
+ { },
70436
+ { 'forceAsync': opts['forceAsync'] },
70437
+ { },
70438
+ { },
70439
+ null,
70440
+ ['PureCloud OAuth'],
70441
+ ['application/json'],
70442
+ ['application/json']
70443
+ );
70444
+ }
70445
+
70446
+ /**
70447
+ * Query the status of an alternative shift trades operation. Only the user who started the operation can query the status
70448
+ * Job details are only retained if the initial request returned a 202 ACCEPTED response
70449
+ * @param {String} jobId The ID of the job
70450
+ */
70451
+ getWorkforcemanagementAlternativeshiftsTradesJob(jobId) {
70452
+ // verify the required parameter 'jobId' is set
70453
+ if (jobId === undefined || jobId === null) {
70454
+ throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementAlternativeshiftsTradesJob';
70455
+ }
70456
+
70457
+ return this.apiClient.callApi(
70458
+ '/api/v2/workforcemanagement/alternativeshifts/trades/jobs/{jobId}',
70459
+ 'GET',
70460
+ { 'jobId': jobId },
70461
+ { },
70462
+ { },
70463
+ { },
70464
+ null,
70465
+ ['PureCloud OAuth'],
70466
+ ['application/json'],
70467
+ ['application/json']
70468
+ );
70469
+ }
70470
+
70471
+ /**
70472
+ * Query the status of an alternative shift trade state operation. Only the user who started the operation can query the status
70473
+ * Job details are only retained if the initial request returned a 202 ACCEPTED response
70474
+ * @param {String} jobId The ID of the job
70475
+ */
70476
+ getWorkforcemanagementAlternativeshiftsTradesStateJob(jobId) {
70477
+ // verify the required parameter 'jobId' is set
70478
+ if (jobId === undefined || jobId === null) {
70479
+ throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementAlternativeshiftsTradesStateJob';
70480
+ }
70481
+
70482
+ return this.apiClient.callApi(
70483
+ '/api/v2/workforcemanagement/alternativeshifts/trades/state/jobs/{jobId}',
70484
+ 'GET',
70485
+ { 'jobId': jobId },
70486
+ { },
70487
+ { },
70488
+ { },
70489
+ null,
70490
+ ['PureCloud OAuth'],
70491
+ ['application/json'],
70492
+ ['application/json']
70493
+ );
70494
+ }
70495
+
69871
70496
  /**
69872
70497
  * Get business unit
69873
70498
  * Expanding "settings" will retrieve all settings. All other expands will retrieve only the requested settings field(s).
@@ -70079,6 +70704,91 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
70079
70704
  );
70080
70705
  }
70081
70706
 
70707
+ /**
70708
+ * Get alternative shifts settings for a business unit
70709
+ *
70710
+ * @param {String} businessUnitId The ID of the business unit
70711
+ */
70712
+ getWorkforcemanagementBusinessunitAlternativeshiftsSettings(businessUnitId) {
70713
+ // verify the required parameter 'businessUnitId' is set
70714
+ if (businessUnitId === undefined || businessUnitId === null) {
70715
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitAlternativeshiftsSettings';
70716
+ }
70717
+
70718
+ return this.apiClient.callApi(
70719
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/settings',
70720
+ 'GET',
70721
+ { 'businessUnitId': businessUnitId },
70722
+ { },
70723
+ { },
70724
+ { },
70725
+ null,
70726
+ ['PureCloud OAuth'],
70727
+ ['application/json'],
70728
+ ['application/json']
70729
+ );
70730
+ }
70731
+
70732
+ /**
70733
+ * Get an alternative shifts trade in a business unit for a given trade ID
70734
+ *
70735
+ * @param {String} businessUnitId The ID of the business unit
70736
+ * @param {String} tradeId The ID of the alternative shift trade
70737
+ */
70738
+ getWorkforcemanagementBusinessunitAlternativeshiftsTrade(businessUnitId, tradeId) {
70739
+ // verify the required parameter 'businessUnitId' is set
70740
+ if (businessUnitId === undefined || businessUnitId === null) {
70741
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitAlternativeshiftsTrade';
70742
+ }
70743
+ // verify the required parameter 'tradeId' is set
70744
+ if (tradeId === undefined || tradeId === null) {
70745
+ throw 'Missing the required parameter "tradeId" when calling getWorkforcemanagementBusinessunitAlternativeshiftsTrade';
70746
+ }
70747
+
70748
+ return this.apiClient.callApi(
70749
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/trades/{tradeId}',
70750
+ 'GET',
70751
+ { 'businessUnitId': businessUnitId,'tradeId': tradeId },
70752
+ { },
70753
+ { },
70754
+ { },
70755
+ null,
70756
+ ['PureCloud OAuth'],
70757
+ ['application/json'],
70758
+ ['application/json']
70759
+ );
70760
+ }
70761
+
70762
+ /**
70763
+ * Query the status of an alternative shift search trade operation. Only the user who started the operation can query the status
70764
+ * Job details are only retained if the initial request returned a 202 ACCEPTED response
70765
+ * @param {String} businessUnitId The ID of the business unit
70766
+ * @param {String} jobId The ID of the job
70767
+ */
70768
+ getWorkforcemanagementBusinessunitAlternativeshiftsTradesSearchJob(businessUnitId, jobId) {
70769
+ // verify the required parameter 'businessUnitId' is set
70770
+ if (businessUnitId === undefined || businessUnitId === null) {
70771
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitAlternativeshiftsTradesSearchJob';
70772
+ }
70773
+ // verify the required parameter 'jobId' is set
70774
+ if (jobId === undefined || jobId === null) {
70775
+ throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementBusinessunitAlternativeshiftsTradesSearchJob';
70776
+ }
70777
+
70778
+ return this.apiClient.callApi(
70779
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/trades/search/jobs/{jobId}',
70780
+ 'GET',
70781
+ { 'businessUnitId': businessUnitId,'jobId': jobId },
70782
+ { },
70783
+ { },
70784
+ { },
70785
+ null,
70786
+ ['PureCloud OAuth'],
70787
+ ['application/json'],
70788
+ ['application/json']
70789
+ );
70790
+ }
70791
+
70082
70792
  /**
70083
70793
  * Get intraday planning groups for the given date
70084
70794
  *
@@ -71050,6 +71760,161 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
71050
71760
  );
71051
71761
  }
71052
71762
 
71763
+ /**
71764
+ * Get a work plan bid
71765
+ *
71766
+ * @param {String} businessUnitId The ID of the business unit
71767
+ * @param {String} bidId The id of the workplanbid
71768
+ */
71769
+ getWorkforcemanagementBusinessunitWorkplanbid(businessUnitId, bidId) {
71770
+ // verify the required parameter 'businessUnitId' is set
71771
+ if (businessUnitId === undefined || businessUnitId === null) {
71772
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWorkplanbid';
71773
+ }
71774
+ // verify the required parameter 'bidId' is set
71775
+ if (bidId === undefined || bidId === null) {
71776
+ throw 'Missing the required parameter "bidId" when calling getWorkforcemanagementBusinessunitWorkplanbid';
71777
+ }
71778
+
71779
+ return this.apiClient.callApi(
71780
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}',
71781
+ 'GET',
71782
+ { 'businessUnitId': businessUnitId,'bidId': bidId },
71783
+ { },
71784
+ { },
71785
+ { },
71786
+ null,
71787
+ ['PureCloud OAuth'],
71788
+ ['application/json'],
71789
+ ['application/json']
71790
+ );
71791
+ }
71792
+
71793
+ /**
71794
+ * Get a bid group by bid group Id
71795
+ *
71796
+ * @param {String} businessUnitId The ID of the business unit
71797
+ * @param {String} bidId The work plan bid id of the bid groups
71798
+ * @param {String} bidGroupId Work Plan Bid Group id
71799
+ */
71800
+ getWorkforcemanagementBusinessunitWorkplanbidGroup(businessUnitId, bidId, bidGroupId) {
71801
+ // verify the required parameter 'businessUnitId' is set
71802
+ if (businessUnitId === undefined || businessUnitId === null) {
71803
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWorkplanbidGroup';
71804
+ }
71805
+ // verify the required parameter 'bidId' is set
71806
+ if (bidId === undefined || bidId === null) {
71807
+ throw 'Missing the required parameter "bidId" when calling getWorkforcemanagementBusinessunitWorkplanbidGroup';
71808
+ }
71809
+ // verify the required parameter 'bidGroupId' is set
71810
+ if (bidGroupId === undefined || bidGroupId === null) {
71811
+ throw 'Missing the required parameter "bidGroupId" when calling getWorkforcemanagementBusinessunitWorkplanbidGroup';
71812
+ }
71813
+
71814
+ return this.apiClient.callApi(
71815
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}',
71816
+ 'GET',
71817
+ { 'businessUnitId': businessUnitId,'bidId': bidId,'bidGroupId': bidGroupId },
71818
+ { },
71819
+ { },
71820
+ { },
71821
+ null,
71822
+ ['PureCloud OAuth'],
71823
+ ['application/json'],
71824
+ ['application/json']
71825
+ );
71826
+ }
71827
+
71828
+ /**
71829
+ * Gets the work plan preferences of all the agents in the work plan bid group
71830
+ *
71831
+ * @param {String} businessUnitId The ID of the business unit
71832
+ * @param {String} bidId The work plan bid id of the bid groups
71833
+ * @param {String} bidGroupId The ID of the work plan bid group
71834
+ */
71835
+ getWorkforcemanagementBusinessunitWorkplanbidGroupPreferences(businessUnitId, bidId, bidGroupId) {
71836
+ // verify the required parameter 'businessUnitId' is set
71837
+ if (businessUnitId === undefined || businessUnitId === null) {
71838
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWorkplanbidGroupPreferences';
71839
+ }
71840
+ // verify the required parameter 'bidId' is set
71841
+ if (bidId === undefined || bidId === null) {
71842
+ throw 'Missing the required parameter "bidId" when calling getWorkforcemanagementBusinessunitWorkplanbidGroupPreferences';
71843
+ }
71844
+ // verify the required parameter 'bidGroupId' is set
71845
+ if (bidGroupId === undefined || bidGroupId === null) {
71846
+ throw 'Missing the required parameter "bidGroupId" when calling getWorkforcemanagementBusinessunitWorkplanbidGroupPreferences';
71847
+ }
71848
+
71849
+ return this.apiClient.callApi(
71850
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}/preferences',
71851
+ 'GET',
71852
+ { 'businessUnitId': businessUnitId,'bidId': bidId,'bidGroupId': bidGroupId },
71853
+ { },
71854
+ { },
71855
+ { },
71856
+ null,
71857
+ ['PureCloud OAuth'],
71858
+ ['application/json'],
71859
+ ['application/json']
71860
+ );
71861
+ }
71862
+
71863
+ /**
71864
+ * Get summary of bid groups that belong to a work plan bid
71865
+ *
71866
+ * @param {String} businessUnitId The ID of the business unit
71867
+ * @param {String} bidId The work plan bid id of the bid groups
71868
+ */
71869
+ getWorkforcemanagementBusinessunitWorkplanbidGroupsSummary(businessUnitId, bidId) {
71870
+ // verify the required parameter 'businessUnitId' is set
71871
+ if (businessUnitId === undefined || businessUnitId === null) {
71872
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWorkplanbidGroupsSummary';
71873
+ }
71874
+ // verify the required parameter 'bidId' is set
71875
+ if (bidId === undefined || bidId === null) {
71876
+ throw 'Missing the required parameter "bidId" when calling getWorkforcemanagementBusinessunitWorkplanbidGroupsSummary';
71877
+ }
71878
+
71879
+ return this.apiClient.callApi(
71880
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/summary',
71881
+ 'GET',
71882
+ { 'businessUnitId': businessUnitId,'bidId': bidId },
71883
+ { },
71884
+ { },
71885
+ { },
71886
+ null,
71887
+ ['PureCloud OAuth'],
71888
+ ['application/json'],
71889
+ ['application/json']
71890
+ );
71891
+ }
71892
+
71893
+ /**
71894
+ * Get list of work plan bids
71895
+ *
71896
+ * @param {String} businessUnitId The ID of the business unit
71897
+ */
71898
+ getWorkforcemanagementBusinessunitWorkplanbids(businessUnitId) {
71899
+ // verify the required parameter 'businessUnitId' is set
71900
+ if (businessUnitId === undefined || businessUnitId === null) {
71901
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWorkplanbids';
71902
+ }
71903
+
71904
+ return this.apiClient.callApi(
71905
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids',
71906
+ 'GET',
71907
+ { 'businessUnitId': businessUnitId },
71908
+ { },
71909
+ { },
71910
+ { },
71911
+ null,
71912
+ ['PureCloud OAuth'],
71913
+ ['application/json'],
71914
+ ['application/json']
71915
+ );
71916
+ }
71917
+
71053
71918
  /**
71054
71919
  * Get business units
71055
71920
  *
@@ -72144,6 +73009,101 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
72144
73009
  );
72145
73010
  }
72146
73011
 
73012
+ /**
73013
+ * Get work plan bid ranks for a user
73014
+ *
73015
+ * @param {String} userId The userId to whom the work plan bid ranks apply.
73016
+ */
73017
+ getWorkforcemanagementUserWorkplanbidranks(userId) {
73018
+ // verify the required parameter 'userId' is set
73019
+ if (userId === undefined || userId === null) {
73020
+ throw 'Missing the required parameter "userId" when calling getWorkforcemanagementUserWorkplanbidranks';
73021
+ }
73022
+
73023
+ return this.apiClient.callApi(
73024
+ '/api/v2/workforcemanagement/users/{userId}/workplanbidranks',
73025
+ 'GET',
73026
+ { 'userId': userId },
73027
+ { },
73028
+ { },
73029
+ { },
73030
+ null,
73031
+ ['PureCloud OAuth'],
73032
+ ['application/json'],
73033
+ ['application/json']
73034
+ );
73035
+ }
73036
+
73037
+ /**
73038
+ * Gets an agent's work plan bidding preference
73039
+ *
73040
+ * @param {String} bidId The ID of the work plan bid
73041
+ */
73042
+ getWorkforcemanagementWorkplanbidPreferences(bidId) {
73043
+ // verify the required parameter 'bidId' is set
73044
+ if (bidId === undefined || bidId === null) {
73045
+ throw 'Missing the required parameter "bidId" when calling getWorkforcemanagementWorkplanbidPreferences';
73046
+ }
73047
+
73048
+ return this.apiClient.callApi(
73049
+ '/api/v2/workforcemanagement/workplanbids/{bidId}/preferences',
73050
+ 'GET',
73051
+ { 'bidId': bidId },
73052
+ { },
73053
+ { },
73054
+ { },
73055
+ null,
73056
+ ['PureCloud OAuth'],
73057
+ ['application/json'],
73058
+ ['application/json']
73059
+ );
73060
+ }
73061
+
73062
+ /**
73063
+ * Gets an agent's work plans for a bid
73064
+ *
73065
+ * @param {String} bidId The ID of the work plan bid
73066
+ */
73067
+ getWorkforcemanagementWorkplanbidWorkplans(bidId) {
73068
+ // verify the required parameter 'bidId' is set
73069
+ if (bidId === undefined || bidId === null) {
73070
+ throw 'Missing the required parameter "bidId" when calling getWorkforcemanagementWorkplanbidWorkplans';
73071
+ }
73072
+
73073
+ return this.apiClient.callApi(
73074
+ '/api/v2/workforcemanagement/workplanbids/{bidId}/workplans',
73075
+ 'GET',
73076
+ { 'bidId': bidId },
73077
+ { },
73078
+ { },
73079
+ { },
73080
+ null,
73081
+ ['PureCloud OAuth'],
73082
+ ['application/json'],
73083
+ ['application/json']
73084
+ );
73085
+ }
73086
+
73087
+ /**
73088
+ * Gets the list of work plan bids that belong to an agent
73089
+ *
73090
+ */
73091
+ getWorkforcemanagementWorkplanbids() {
73092
+
73093
+ return this.apiClient.callApi(
73094
+ '/api/v2/workforcemanagement/workplanbids',
73095
+ 'GET',
73096
+ { },
73097
+ { },
73098
+ { },
73099
+ { },
73100
+ null,
73101
+ ['PureCloud OAuth'],
73102
+ ['application/json'],
73103
+ ['application/json']
73104
+ );
73105
+ }
73106
+
72147
73107
  /**
72148
73108
  * Update an adherence explanation
72149
73109
  *
@@ -72179,6 +73139,60 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
72179
73139
  );
72180
73140
  }
72181
73141
 
73142
+ /**
73143
+ * Update my alternative shifts trade by trade ID
73144
+ *
73145
+ * @param {String} tradeId The ID of the alternative shift trade
73146
+ * @param {Object} opts Optional parameters
73147
+ * @param {Object} opts.body body
73148
+ */
73149
+ patchWorkforcemanagementAlternativeshiftsTrade(tradeId, opts) {
73150
+ opts = opts || {};
73151
+
73152
+ // verify the required parameter 'tradeId' is set
73153
+ if (tradeId === undefined || tradeId === null) {
73154
+ throw 'Missing the required parameter "tradeId" when calling patchWorkforcemanagementAlternativeshiftsTrade';
73155
+ }
73156
+
73157
+ return this.apiClient.callApi(
73158
+ '/api/v2/workforcemanagement/alternativeshifts/trades/{tradeId}',
73159
+ 'PATCH',
73160
+ { 'tradeId': tradeId },
73161
+ { },
73162
+ { },
73163
+ { },
73164
+ opts['body'],
73165
+ ['PureCloud OAuth'],
73166
+ ['application/json'],
73167
+ ['application/json']
73168
+ );
73169
+ }
73170
+
73171
+ /**
73172
+ * Bulk update alternative shift trade states
73173
+ *
73174
+ * @param {Object} body The request body
73175
+ */
73176
+ patchWorkforcemanagementAlternativeshiftsTradesStateJobs(body) {
73177
+ // verify the required parameter 'body' is set
73178
+ if (body === undefined || body === null) {
73179
+ throw 'Missing the required parameter "body" when calling patchWorkforcemanagementAlternativeshiftsTradesStateJobs';
73180
+ }
73181
+
73182
+ return this.apiClient.callApi(
73183
+ '/api/v2/workforcemanagement/alternativeshifts/trades/state/jobs',
73184
+ 'PATCH',
73185
+ { },
73186
+ { },
73187
+ { },
73188
+ { },
73189
+ body,
73190
+ ['PureCloud OAuth'],
73191
+ ['application/json'],
73192
+ ['application/json']
73193
+ );
73194
+ }
73195
+
72182
73196
  /**
72183
73197
  * Update business unit
72184
73198
  *
@@ -72278,6 +73292,35 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
72278
73292
  );
72279
73293
  }
72280
73294
 
73295
+ /**
73296
+ * Update alternative shifts settings for a business unit
73297
+ *
73298
+ * @param {String} businessUnitId The ID of the business unit
73299
+ * @param {Object} opts Optional parameters
73300
+ * @param {Object} opts.body body
73301
+ */
73302
+ patchWorkforcemanagementBusinessunitAlternativeshiftsSettings(businessUnitId, opts) {
73303
+ opts = opts || {};
73304
+
73305
+ // verify the required parameter 'businessUnitId' is set
73306
+ if (businessUnitId === undefined || businessUnitId === null) {
73307
+ throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitAlternativeshiftsSettings';
73308
+ }
73309
+
73310
+ return this.apiClient.callApi(
73311
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/settings',
73312
+ 'PATCH',
73313
+ { 'businessUnitId': businessUnitId },
73314
+ { },
73315
+ { },
73316
+ { },
73317
+ opts['body'],
73318
+ ['PureCloud OAuth'],
73319
+ ['application/json'],
73320
+ ['application/json']
73321
+ );
73322
+ }
73323
+
72281
73324
  /**
72282
73325
  * Updates the planning group
72283
73326
  *
@@ -72448,6 +73491,119 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
72448
73491
  );
72449
73492
  }
72450
73493
 
73494
+ /**
73495
+ * Update work plan bid
73496
+ *
73497
+ * @param {String} businessUnitId The ID of the business unit
73498
+ * @param {String} bidId The id of the workplanbid
73499
+ * @param {Object} body The work plan bid to be updated
73500
+ */
73501
+ patchWorkforcemanagementBusinessunitWorkplanbid(businessUnitId, bidId, body) {
73502
+ // verify the required parameter 'businessUnitId' is set
73503
+ if (businessUnitId === undefined || businessUnitId === null) {
73504
+ throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitWorkplanbid';
73505
+ }
73506
+ // verify the required parameter 'bidId' is set
73507
+ if (bidId === undefined || bidId === null) {
73508
+ throw 'Missing the required parameter "bidId" when calling patchWorkforcemanagementBusinessunitWorkplanbid';
73509
+ }
73510
+ // verify the required parameter 'body' is set
73511
+ if (body === undefined || body === null) {
73512
+ throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitWorkplanbid';
73513
+ }
73514
+
73515
+ return this.apiClient.callApi(
73516
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}',
73517
+ 'PATCH',
73518
+ { 'businessUnitId': businessUnitId,'bidId': bidId },
73519
+ { },
73520
+ { },
73521
+ { },
73522
+ body,
73523
+ ['PureCloud OAuth'],
73524
+ ['application/json'],
73525
+ ['application/json']
73526
+ );
73527
+ }
73528
+
73529
+ /**
73530
+ * Update a bid group by bid group Id
73531
+ *
73532
+ * @param {String} businessUnitId The ID of the business unit
73533
+ * @param {String} bidId The work plan bid id of the bid groups
73534
+ * @param {String} bidGroupId Work Plan Bid Group id
73535
+ * @param {Object} opts Optional parameters
73536
+ * @param {Object} opts.body body
73537
+ */
73538
+ patchWorkforcemanagementBusinessunitWorkplanbidGroup(businessUnitId, bidId, bidGroupId, opts) {
73539
+ opts = opts || {};
73540
+
73541
+ // verify the required parameter 'businessUnitId' is set
73542
+ if (businessUnitId === undefined || businessUnitId === null) {
73543
+ throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroup';
73544
+ }
73545
+ // verify the required parameter 'bidId' is set
73546
+ if (bidId === undefined || bidId === null) {
73547
+ throw 'Missing the required parameter "bidId" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroup';
73548
+ }
73549
+ // verify the required parameter 'bidGroupId' is set
73550
+ if (bidGroupId === undefined || bidGroupId === null) {
73551
+ throw 'Missing the required parameter "bidGroupId" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroup';
73552
+ }
73553
+
73554
+ return this.apiClient.callApi(
73555
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}',
73556
+ 'PATCH',
73557
+ { 'businessUnitId': businessUnitId,'bidId': bidId,'bidGroupId': bidGroupId },
73558
+ { },
73559
+ { },
73560
+ { },
73561
+ opts['body'],
73562
+ ['PureCloud OAuth'],
73563
+ ['application/json'],
73564
+ ['application/json']
73565
+ );
73566
+ }
73567
+
73568
+ /**
73569
+ * Overrides the assigned work plan for the specified agents
73570
+ *
73571
+ * @param {String} businessUnitId The ID of the business unit
73572
+ * @param {String} bidId The work plan bid id of the bid groups
73573
+ * @param {String} bidGroupId The ID of the work plan bid group
73574
+ * @param {Object} opts Optional parameters
73575
+ * @param {Object} opts.body body
73576
+ */
73577
+ patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences(businessUnitId, bidId, bidGroupId, opts) {
73578
+ opts = opts || {};
73579
+
73580
+ // verify the required parameter 'businessUnitId' is set
73581
+ if (businessUnitId === undefined || businessUnitId === null) {
73582
+ throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences';
73583
+ }
73584
+ // verify the required parameter 'bidId' is set
73585
+ if (bidId === undefined || bidId === null) {
73586
+ throw 'Missing the required parameter "bidId" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences';
73587
+ }
73588
+ // verify the required parameter 'bidGroupId' is set
73589
+ if (bidGroupId === undefined || bidGroupId === null) {
73590
+ throw 'Missing the required parameter "bidGroupId" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences';
73591
+ }
73592
+
73593
+ return this.apiClient.callApi(
73594
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}/preferences',
73595
+ 'PATCH',
73596
+ { 'businessUnitId': businessUnitId,'bidId': bidId,'bidGroupId': bidGroupId },
73597
+ { },
73598
+ { },
73599
+ { },
73600
+ opts['body'],
73601
+ ['PureCloud OAuth'],
73602
+ ['application/json'],
73603
+ ['application/json']
73604
+ );
73605
+ }
73606
+
72451
73607
  /**
72452
73608
  * Update the requested management unit
72453
73609
  *
@@ -72790,6 +73946,89 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
72790
73946
  );
72791
73947
  }
72792
73948
 
73949
+ /**
73950
+ * Update work plan bid ranks for a user
73951
+ *
73952
+ * @param {String} userId The userId to whom the work plan bid ranks apply.
73953
+ * @param {Object} opts Optional parameters
73954
+ * @param {Object} opts.body body
73955
+ */
73956
+ patchWorkforcemanagementUserWorkplanbidranks(userId, opts) {
73957
+ opts = opts || {};
73958
+
73959
+ // verify the required parameter 'userId' is set
73960
+ if (userId === undefined || userId === null) {
73961
+ throw 'Missing the required parameter "userId" when calling patchWorkforcemanagementUserWorkplanbidranks';
73962
+ }
73963
+
73964
+ return this.apiClient.callApi(
73965
+ '/api/v2/workforcemanagement/users/{userId}/workplanbidranks',
73966
+ 'PATCH',
73967
+ { 'userId': userId },
73968
+ { },
73969
+ { },
73970
+ { },
73971
+ opts['body'],
73972
+ ['PureCloud OAuth'],
73973
+ ['application/json'],
73974
+ ['application/json']
73975
+ );
73976
+ }
73977
+
73978
+ /**
73979
+ * Update bulk work plan bid ranks on users. Max 50 users can be updated at a time.
73980
+ *
73981
+ * @param {Array.<Object>} body Users
73982
+ */
73983
+ patchWorkforcemanagementUsersWorkplanbidranksBulk(body) {
73984
+ // verify the required parameter 'body' is set
73985
+ if (body === undefined || body === null) {
73986
+ throw 'Missing the required parameter "body" when calling patchWorkforcemanagementUsersWorkplanbidranksBulk';
73987
+ }
73988
+
73989
+ return this.apiClient.callApi(
73990
+ '/api/v2/workforcemanagement/users/workplanbidranks/bulk',
73991
+ 'PATCH',
73992
+ { },
73993
+ { },
73994
+ { },
73995
+ { },
73996
+ body,
73997
+ ['PureCloud OAuth'],
73998
+ ['application/json'],
73999
+ ['application/json']
74000
+ );
74001
+ }
74002
+
74003
+ /**
74004
+ * Update an agent's work plan bidding preference
74005
+ *
74006
+ * @param {String} bidId The ID of the work plan bid
74007
+ * @param {Object} opts Optional parameters
74008
+ * @param {Object} opts.body body
74009
+ */
74010
+ patchWorkforcemanagementWorkplanbidPreferences(bidId, opts) {
74011
+ opts = opts || {};
74012
+
74013
+ // verify the required parameter 'bidId' is set
74014
+ if (bidId === undefined || bidId === null) {
74015
+ throw 'Missing the required parameter "bidId" when calling patchWorkforcemanagementWorkplanbidPreferences';
74016
+ }
74017
+
74018
+ return this.apiClient.callApi(
74019
+ '/api/v2/workforcemanagement/workplanbids/{bidId}/preferences',
74020
+ 'PATCH',
74021
+ { 'bidId': bidId },
74022
+ { },
74023
+ { },
74024
+ { },
74025
+ opts['body'],
74026
+ ['PureCloud OAuth'],
74027
+ ['application/json'],
74028
+ ['application/json']
74029
+ );
74030
+ }
74031
+
72793
74032
  /**
72794
74033
  * Submit an adherence explanation for the current user
72795
74034
  *
@@ -73056,6 +74295,81 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
73056
74295
  );
73057
74296
  }
73058
74297
 
74298
+ /**
74299
+ * Request a list of alternative shift offers for a given schedule
74300
+ *
74301
+ * @param {Object} body The request body
74302
+ */
74303
+ postWorkforcemanagementAlternativeshiftsOffersJobs(body) {
74304
+ // verify the required parameter 'body' is set
74305
+ if (body === undefined || body === null) {
74306
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementAlternativeshiftsOffersJobs';
74307
+ }
74308
+
74309
+ return this.apiClient.callApi(
74310
+ '/api/v2/workforcemanagement/alternativeshifts/offers/jobs',
74311
+ 'POST',
74312
+ { },
74313
+ { },
74314
+ { },
74315
+ { },
74316
+ body,
74317
+ ['PureCloud OAuth'],
74318
+ ['application/json'],
74319
+ ['application/json']
74320
+ );
74321
+ }
74322
+
74323
+ /**
74324
+ * Request a search of alternative shift offers for a given shift
74325
+ *
74326
+ * @param {Object} body The request body
74327
+ */
74328
+ postWorkforcemanagementAlternativeshiftsOffersSearchJobs(body) {
74329
+ // verify the required parameter 'body' is set
74330
+ if (body === undefined || body === null) {
74331
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementAlternativeshiftsOffersSearchJobs';
74332
+ }
74333
+
74334
+ return this.apiClient.callApi(
74335
+ '/api/v2/workforcemanagement/alternativeshifts/offers/search/jobs',
74336
+ 'POST',
74337
+ { },
74338
+ { },
74339
+ { },
74340
+ { },
74341
+ body,
74342
+ ['PureCloud OAuth'],
74343
+ ['application/json'],
74344
+ ['application/json']
74345
+ );
74346
+ }
74347
+
74348
+ /**
74349
+ * Create my alternative shift trade using an existing offer's jobId
74350
+ *
74351
+ * @param {Object} body The request body
74352
+ */
74353
+ postWorkforcemanagementAlternativeshiftsTrades(body) {
74354
+ // verify the required parameter 'body' is set
74355
+ if (body === undefined || body === null) {
74356
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementAlternativeshiftsTrades';
74357
+ }
74358
+
74359
+ return this.apiClient.callApi(
74360
+ '/api/v2/workforcemanagement/alternativeshifts/trades',
74361
+ 'POST',
74362
+ { },
74363
+ { },
74364
+ { },
74365
+ { },
74366
+ body,
74367
+ ['PureCloud OAuth'],
74368
+ ['application/json'],
74369
+ ['application/json']
74370
+ );
74371
+ }
74372
+
73059
74373
  /**
73060
74374
  * Create a new activity code
73061
74375
  *
@@ -73213,6 +74527,40 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
73213
74527
  );
73214
74528
  }
73215
74529
 
74530
+ /**
74531
+ * List alternative shifts trades for a given management unit or agent
74532
+ *
74533
+ * @param {String} businessUnitId The ID of the business unit
74534
+ * @param {Object} body The request body
74535
+ * @param {Object} opts Optional parameters
74536
+ * @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
74537
+ */
74538
+ postWorkforcemanagementBusinessunitAlternativeshiftsTradesSearch(businessUnitId, body, opts) {
74539
+ opts = opts || {};
74540
+
74541
+ // verify the required parameter 'businessUnitId' is set
74542
+ if (businessUnitId === undefined || businessUnitId === null) {
74543
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitAlternativeshiftsTradesSearch';
74544
+ }
74545
+ // verify the required parameter 'body' is set
74546
+ if (body === undefined || body === null) {
74547
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitAlternativeshiftsTradesSearch';
74548
+ }
74549
+
74550
+ return this.apiClient.callApi(
74551
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/trades/search',
74552
+ 'POST',
74553
+ { 'businessUnitId': businessUnitId },
74554
+ { 'forceAsync': opts['forceAsync'] },
74555
+ { },
74556
+ { },
74557
+ body,
74558
+ ['PureCloud OAuth'],
74559
+ ['application/json'],
74560
+ ['application/json']
74561
+ );
74562
+ }
74563
+
73216
74564
  /**
73217
74565
  * Get intraday data for the given date for the requested planningGroupIds
73218
74566
  *
@@ -74022,6 +75370,103 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
74022
75370
  );
74023
75371
  }
74024
75372
 
75373
+ /**
75374
+ * Copy a work plan bid
75375
+ *
75376
+ * @param {String} businessUnitId The ID of the business unit
75377
+ * @param {String} bidId The ID of the work plan bid to copy
75378
+ * @param {Object} opts Optional parameters
75379
+ * @param {Object} opts.body body
75380
+ */
75381
+ postWorkforcemanagementBusinessunitWorkplanbidCopy(businessUnitId, bidId, opts) {
75382
+ opts = opts || {};
75383
+
75384
+ // verify the required parameter 'businessUnitId' is set
75385
+ if (businessUnitId === undefined || businessUnitId === null) {
75386
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWorkplanbidCopy';
75387
+ }
75388
+ // verify the required parameter 'bidId' is set
75389
+ if (bidId === undefined || bidId === null) {
75390
+ throw 'Missing the required parameter "bidId" when calling postWorkforcemanagementBusinessunitWorkplanbidCopy';
75391
+ }
75392
+
75393
+ return this.apiClient.callApi(
75394
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/copy',
75395
+ 'POST',
75396
+ { 'businessUnitId': businessUnitId,'bidId': bidId },
75397
+ { },
75398
+ { },
75399
+ { },
75400
+ opts['body'],
75401
+ ['PureCloud OAuth'],
75402
+ ['application/json'],
75403
+ ['application/json']
75404
+ );
75405
+ }
75406
+
75407
+ /**
75408
+ * Add a bid group in a given work plan bid
75409
+ *
75410
+ * @param {String} businessUnitId The ID of the business unit
75411
+ * @param {String} bidId The work plan bid id of the bid groups
75412
+ * @param {Object} opts Optional parameters
75413
+ * @param {Object} opts.body body
75414
+ */
75415
+ postWorkforcemanagementBusinessunitWorkplanbidGroups(businessUnitId, bidId, opts) {
75416
+ opts = opts || {};
75417
+
75418
+ // verify the required parameter 'businessUnitId' is set
75419
+ if (businessUnitId === undefined || businessUnitId === null) {
75420
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWorkplanbidGroups';
75421
+ }
75422
+ // verify the required parameter 'bidId' is set
75423
+ if (bidId === undefined || bidId === null) {
75424
+ throw 'Missing the required parameter "bidId" when calling postWorkforcemanagementBusinessunitWorkplanbidGroups';
75425
+ }
75426
+
75427
+ return this.apiClient.callApi(
75428
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups',
75429
+ 'POST',
75430
+ { 'businessUnitId': businessUnitId,'bidId': bidId },
75431
+ { },
75432
+ { },
75433
+ { },
75434
+ opts['body'],
75435
+ ['PureCloud OAuth'],
75436
+ ['application/json'],
75437
+ ['application/json']
75438
+ );
75439
+ }
75440
+
75441
+ /**
75442
+ * Create a new work plan bid
75443
+ *
75444
+ * @param {String} businessUnitId The ID of the business unit
75445
+ * @param {Object} opts Optional parameters
75446
+ * @param {Object} opts.body The work plan bid to be created
75447
+ */
75448
+ postWorkforcemanagementBusinessunitWorkplanbids(businessUnitId, opts) {
75449
+ opts = opts || {};
75450
+
75451
+ // verify the required parameter 'businessUnitId' is set
75452
+ if (businessUnitId === undefined || businessUnitId === null) {
75453
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWorkplanbids';
75454
+ }
75455
+
75456
+ return this.apiClient.callApi(
75457
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids',
75458
+ 'POST',
75459
+ { 'businessUnitId': businessUnitId },
75460
+ { },
75461
+ { },
75462
+ { },
75463
+ opts['body'],
75464
+ ['PureCloud OAuth'],
75465
+ ['application/json'],
75466
+ ['application/json']
75467
+ );
75468
+ }
75469
+
74025
75470
  /**
74026
75471
  * Add a new business unit
74027
75472
  * It may take a minute or two for a new business unit to be available for api operations
@@ -75291,7 +76736,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
75291
76736
  * </pre>
75292
76737
  * </p>
75293
76738
  * @module purecloud-platform-client-v2/index
75294
- * @version 199.0.0
76739
+ * @version 201.0.0
75295
76740
  */
75296
76741
  class platformClient {
75297
76742
  constructor() {