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
@@ -405,7 +405,7 @@ class Configuration {
405
405
 
406
406
  /**
407
407
  * @module purecloud-platform-client-v2/ApiClient
408
- * @version 199.0.0
408
+ * @version 201.0.0
409
409
  */
410
410
  class ApiClient {
411
411
  /**
@@ -1827,7 +1827,7 @@ class AgentUIApi {
1827
1827
  /**
1828
1828
  * AgentUI service.
1829
1829
  * @module purecloud-platform-client-v2/api/AgentUIApi
1830
- * @version 199.0.0
1830
+ * @version 201.0.0
1831
1831
  */
1832
1832
 
1833
1833
  /**
@@ -1958,7 +1958,7 @@ class AlertingApi {
1958
1958
  /**
1959
1959
  * Alerting service.
1960
1960
  * @module purecloud-platform-client-v2/api/AlertingApi
1961
- * @version 199.0.0
1961
+ * @version 201.0.0
1962
1962
  */
1963
1963
 
1964
1964
  /**
@@ -2619,7 +2619,7 @@ class AnalyticsApi {
2619
2619
  /**
2620
2620
  * Analytics service.
2621
2621
  * @module purecloud-platform-client-v2/api/AnalyticsApi
2622
- * @version 199.0.0
2622
+ * @version 201.0.0
2623
2623
  */
2624
2624
 
2625
2625
  /**
@@ -4680,8 +4680,8 @@ class AnalyticsApi {
4680
4680
  }
4681
4681
 
4682
4682
  /**
4683
- * 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.
4684
- * The max property can be used to determine estimated rate limit value hit.
4683
+ * 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.
4684
+ * 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).
4685
4685
  * @param {Object} body query
4686
4686
  */
4687
4687
  postAnalyticsRatelimitsAggregatesQuery(body) {
@@ -5231,7 +5231,7 @@ class ArchitectApi {
5231
5231
  /**
5232
5232
  * Architect service.
5233
5233
  * @module purecloud-platform-client-v2/api/ArchitectApi
5234
- * @version 199.0.0
5234
+ * @version 201.0.0
5235
5235
  */
5236
5236
 
5237
5237
  /**
@@ -9377,7 +9377,7 @@ class AuditApi {
9377
9377
  /**
9378
9378
  * Audit service.
9379
9379
  * @module purecloud-platform-client-v2/api/AuditApi
9380
- * @version 199.0.0
9380
+ * @version 201.0.0
9381
9381
  */
9382
9382
 
9383
9383
  /**
@@ -9465,6 +9465,7 @@ class AuditApi {
9465
9465
  * @param {String} opts.cursor Indicates where to resume query results (not required for first page)
9466
9466
  * @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)
9467
9467
  * @param {Array.<String>} opts.expand Which fields, if any, to expand
9468
+ * @param {Boolean} opts.allowRedirect Result sets with large amounts of data will respond with a download url
9468
9469
  */
9469
9470
  getAuditsQueryTransactionIdResults(transactionId, opts) {
9470
9471
  opts = opts || {};
@@ -9478,7 +9479,7 @@ class AuditApi {
9478
9479
  '/api/v2/audits/query/{transactionId}/results',
9479
9480
  'GET',
9480
9481
  { 'transactionId': transactionId },
9481
- { 'cursor': opts['cursor'],'pageSize': opts['pageSize'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
9482
+ { 'cursor': opts['cursor'],'pageSize': opts['pageSize'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'allowRedirect': opts['allowRedirect'] },
9482
9483
  { },
9483
9484
  { },
9484
9485
  null,
@@ -9577,7 +9578,7 @@ class AuthorizationApi {
9577
9578
  /**
9578
9579
  * Authorization service.
9579
9580
  * @module purecloud-platform-client-v2/api/AuthorizationApi
9580
- * @version 199.0.0
9581
+ * @version 201.0.0
9581
9582
  */
9582
9583
 
9583
9584
  /**
@@ -10815,7 +10816,7 @@ class BillingApi {
10815
10816
  /**
10816
10817
  * Billing service.
10817
10818
  * @module purecloud-platform-client-v2/api/BillingApi
10818
- * @version 199.0.0
10819
+ * @version 201.0.0
10819
10820
  */
10820
10821
 
10821
10822
  /**
@@ -10895,7 +10896,7 @@ class CarrierServicesApi {
10895
10896
  /**
10896
10897
  * CarrierServices service.
10897
10898
  * @module purecloud-platform-client-v2/api/CarrierServicesApi
10898
- * @version 199.0.0
10899
+ * @version 201.0.0
10899
10900
  */
10900
10901
 
10901
10902
  /**
@@ -10965,7 +10966,7 @@ class ChatApi {
10965
10966
  /**
10966
10967
  * Chat service.
10967
10968
  * @module purecloud-platform-client-v2/api/ChatApi
10968
- * @version 199.0.0
10969
+ * @version 201.0.0
10969
10970
  */
10970
10971
 
10971
10972
  /**
@@ -11901,7 +11902,7 @@ class CoachingApi {
11901
11902
  /**
11902
11903
  * Coaching service.
11903
11904
  * @module purecloud-platform-client-v2/api/CoachingApi
11904
- * @version 199.0.0
11905
+ * @version 201.0.0
11905
11906
  */
11906
11907
 
11907
11908
  /**
@@ -12478,7 +12479,7 @@ class ContentManagementApi {
12478
12479
  /**
12479
12480
  * ContentManagement service.
12480
12481
  * @module purecloud-platform-client-v2/api/ContentManagementApi
12481
- * @version 199.0.0
12482
+ * @version 201.0.0
12482
12483
  */
12483
12484
 
12484
12485
  /**
@@ -13560,7 +13561,7 @@ class ConversationsApi {
13560
13561
  /**
13561
13562
  * Conversations service.
13562
13563
  * @module purecloud-platform-client-v2/api/ConversationsApi
13563
- * @version 199.0.0
13564
+ * @version 201.0.0
13564
13565
  */
13565
13566
 
13566
13567
  /**
@@ -20673,7 +20674,7 @@ class DataExtensionsApi {
20673
20674
  /**
20674
20675
  * DataExtensions service.
20675
20676
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
20676
- * @version 199.0.0
20677
+ * @version 201.0.0
20677
20678
  */
20678
20679
 
20679
20680
  /**
@@ -20759,7 +20760,7 @@ class DownloadsApi {
20759
20760
  /**
20760
20761
  * Downloads service.
20761
20762
  * @module purecloud-platform-client-v2/api/DownloadsApi
20762
- * @version 199.0.0
20763
+ * @version 201.0.0
20763
20764
  */
20764
20765
 
20765
20766
  /**
@@ -20811,7 +20812,7 @@ class EmailsApi {
20811
20812
  /**
20812
20813
  * Emails service.
20813
20814
  * @module purecloud-platform-client-v2/api/EmailsApi
20814
- * @version 199.0.0
20815
+ * @version 201.0.0
20815
20816
  */
20816
20817
 
20817
20818
  /**
@@ -20876,7 +20877,7 @@ class EmployeeEngagementApi {
20876
20877
  /**
20877
20878
  * EmployeeEngagement service.
20878
20879
  * @module purecloud-platform-client-v2/api/EmployeeEngagementApi
20879
- * @version 199.0.0
20880
+ * @version 201.0.0
20880
20881
  */
20881
20882
 
20882
20883
  /**
@@ -21027,7 +21028,7 @@ class EventsApi {
21027
21028
  /**
21028
21029
  * Events service.
21029
21030
  * @module purecloud-platform-client-v2/api/EventsApi
21030
- * @version 199.0.0
21031
+ * @version 201.0.0
21031
21032
  */
21032
21033
 
21033
21034
  /**
@@ -21123,7 +21124,7 @@ class ExternalContactsApi {
21123
21124
  /**
21124
21125
  * ExternalContacts service.
21125
21126
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
21126
- * @version 199.0.0
21127
+ * @version 201.0.0
21127
21128
  */
21128
21129
 
21129
21130
  /**
@@ -23085,7 +23086,7 @@ class FaxApi {
23085
23086
  /**
23086
23087
  * Fax service.
23087
23088
  * @module purecloud-platform-client-v2/api/FaxApi
23088
- * @version 199.0.0
23089
+ * @version 201.0.0
23089
23090
  */
23090
23091
 
23091
23092
  /**
@@ -23300,7 +23301,7 @@ class FlowsApi {
23300
23301
  /**
23301
23302
  * Flows service.
23302
23303
  * @module purecloud-platform-client-v2/api/FlowsApi
23303
- * @version 199.0.0
23304
+ * @version 201.0.0
23304
23305
  */
23305
23306
 
23306
23307
  /**
@@ -23483,7 +23484,7 @@ class GamificationApi {
23483
23484
  /**
23484
23485
  * Gamification service.
23485
23486
  * @module purecloud-platform-client-v2/api/GamificationApi
23486
- * @version 199.0.0
23487
+ * @version 201.0.0
23487
23488
  */
23488
23489
 
23489
23490
  /**
@@ -25569,7 +25570,7 @@ class GeneralDataProtectionRegulationApi {
25569
25570
  /**
25570
25571
  * GeneralDataProtectionRegulation service.
25571
25572
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
25572
- * @version 199.0.0
25573
+ * @version 201.0.0
25573
25574
  */
25574
25575
 
25575
25576
  /**
@@ -25699,7 +25700,7 @@ class GeolocationApi {
25699
25700
  /**
25700
25701
  * Geolocation service.
25701
25702
  * @module purecloud-platform-client-v2/api/GeolocationApi
25702
- * @version 199.0.0
25703
+ * @version 201.0.0
25703
25704
  */
25704
25705
 
25705
25706
  /**
@@ -25830,7 +25831,7 @@ class GreetingsApi {
25830
25831
  /**
25831
25832
  * Greetings service.
25832
25833
  * @module purecloud-platform-client-v2/api/GreetingsApi
25833
- * @version 199.0.0
25834
+ * @version 201.0.0
25834
25835
  */
25835
25836
 
25836
25837
  /**
@@ -26285,7 +26286,7 @@ class GroupsApi {
26285
26286
  /**
26286
26287
  * Groups service.
26287
26288
  * @module purecloud-platform-client-v2/api/GroupsApi
26288
- * @version 199.0.0
26289
+ * @version 201.0.0
26289
26290
  */
26290
26291
 
26291
26292
  /**
@@ -26804,7 +26805,7 @@ class IdentityProviderApi {
26804
26805
  /**
26805
26806
  * IdentityProvider service.
26806
26807
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
26807
- * @version 199.0.0
26808
+ * @version 201.0.0
26808
26809
  */
26809
26810
 
26810
26811
  /**
@@ -27665,7 +27666,7 @@ class InfrastructureAsCodeApi {
27665
27666
  /**
27666
27667
  * InfrastructureAsCode service.
27667
27668
  * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
27668
- * @version 199.0.0
27669
+ * @version 201.0.0
27669
27670
  */
27670
27671
 
27671
27672
  /**
@@ -27832,7 +27833,7 @@ class IntegrationsApi {
27832
27833
  /**
27833
27834
  * Integrations service.
27834
27835
  * @module purecloud-platform-client-v2/api/IntegrationsApi
27835
- * @version 199.0.0
27836
+ * @version 201.0.0
27836
27837
  */
27837
27838
 
27838
27839
  /**
@@ -28381,6 +28382,26 @@ class IntegrationsApi {
28381
28382
  );
28382
28383
  }
28383
28384
 
28385
+ /**
28386
+ * Retrieves basic info about trusted root CA certificates
28387
+ *
28388
+ */
28389
+ getIntegrationsActionsCertificatesTruststore() {
28390
+
28391
+ return this.apiClient.callApi(
28392
+ '/api/v2/integrations/actions/certificates/truststore',
28393
+ 'GET',
28394
+ { },
28395
+ { },
28396
+ { },
28397
+ { },
28398
+ null,
28399
+ ['PureCloud OAuth'],
28400
+ ['application/json'],
28401
+ ['application/json']
28402
+ );
28403
+ }
28404
+
28384
28405
  /**
28385
28406
  * Retrieves all action drafts associated with the filters passed in via query param.
28386
28407
  *
@@ -30184,7 +30205,7 @@ class JourneyApi {
30184
30205
  /**
30185
30206
  * Journey service.
30186
30207
  * @module purecloud-platform-client-v2/api/JourneyApi
30187
- * @version 199.0.0
30208
+ * @version 201.0.0
30188
30209
  */
30189
30210
 
30190
30211
  /**
@@ -31140,15 +31161,22 @@ class JourneyApi {
31140
31161
  /**
31141
31162
  * Get a list of Journey Views
31142
31163
  *
31164
+ * @param {Object} opts Optional parameters
31165
+ * @param {Number} opts.pageNumber Page number (default to 1)
31166
+ * @param {Number} opts.pageSize Page size (default to 25)
31167
+ * @param {String} opts.nameOrCreatedBy Journey View Name or Created By
31168
+ * @param {Object} opts.expand Parameter to request additional data to return in Journey payload
31143
31169
  * getJourneyViews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
31144
31170
  */
31145
- getJourneyViews() {
31171
+ getJourneyViews(opts) {
31172
+ opts = opts || {};
31173
+
31146
31174
 
31147
31175
  return this.apiClient.callApi(
31148
31176
  '/api/v2/journey/views',
31149
31177
  'GET',
31150
31178
  { },
31151
- { },
31179
+ { 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'nameOrCreatedBy': opts['nameOrCreatedBy'],'expand': opts['expand'] },
31152
31180
  { },
31153
31181
  { },
31154
31182
  null,
@@ -31830,7 +31858,7 @@ class KnowledgeApi {
31830
31858
  /**
31831
31859
  * Knowledge service.
31832
31860
  * @module purecloud-platform-client-v2/api/KnowledgeApi
31833
- * @version 199.0.0
31861
+ * @version 201.0.0
31834
31862
  */
31835
31863
 
31836
31864
  /**
@@ -35074,7 +35102,7 @@ class LanguageUnderstandingApi {
35074
35102
  /**
35075
35103
  * LanguageUnderstanding service.
35076
35104
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
35077
- * @version 199.0.0
35105
+ * @version 201.0.0
35078
35106
  */
35079
35107
 
35080
35108
  /**
@@ -36108,7 +36136,7 @@ class LanguagesApi {
36108
36136
  /**
36109
36137
  * Languages service.
36110
36138
  * @module purecloud-platform-client-v2/api/LanguagesApi
36111
- * @version 199.0.0
36139
+ * @version 201.0.0
36112
36140
  */
36113
36141
 
36114
36142
  /**
@@ -36330,7 +36358,7 @@ class LearningApi {
36330
36358
  /**
36331
36359
  * Learning service.
36332
36360
  * @module purecloud-platform-client-v2/api/LearningApi
36333
- * @version 199.0.0
36361
+ * @version 201.0.0
36334
36362
  */
36335
36363
 
36336
36364
  /**
@@ -36476,7 +36504,7 @@ class LearningApi {
36476
36504
  * @param {Object} opts.sortOrder Specifies result set sort order; if not specified, default sort order is descending (Desc) (default to Desc)
36477
36505
  * @param {Object} opts.sortBy Specifies which field to sort the results by, default sort is by recommendedCompletionDate
36478
36506
  * @param {Array.<String>} opts.userId Specifies the list of user IDs to be queried, up to 100 user IDs.
36479
- * @param {Array.<String>} opts.types Specifies the module types to filter by
36507
+ * @param {Array.<String>} opts.types Specifies the module types to filter by. Informational, AssessedContent and Assessment are deprecated
36480
36508
  * @param {Array.<String>} opts.states Specifies the assignment states to filter by
36481
36509
  * @param {Array.<String>} opts.expand Specifies the expand option for returning additional information
36482
36510
  */
@@ -36513,7 +36541,7 @@ class LearningApi {
36513
36541
  * @param {Number} opts.maxPercentageScore The maximum assessment score for an assignment (completed with assessment) to be included in the results (inclusive)
36514
36542
  * @param {Object} opts.sortOrder Specifies result set sort order; if not specified, default sort order is descending (Desc) (default to Desc)
36515
36543
  * @param {Object} opts.sortBy Specifies which field to sort the results by, default sort is by recommendedCompletionDate
36516
- * @param {Array.<String>} opts.types Specifies the module types to filter by
36544
+ * @param {Array.<String>} opts.types Specifies the module types to filter by. Informational, AssessedContent and Assessment are deprecated
36517
36545
  * @param {Array.<String>} opts.states Specifies the assignment states to filter by
36518
36546
  * @param {Array.<String>} opts.expand Specifies the expand option for returning additional information
36519
36547
  */
@@ -36683,7 +36711,7 @@ class LearningApi {
36683
36711
  *
36684
36712
  * @param {Object} opts Optional parameters
36685
36713
  * @param {Boolean} opts.isArchived Archive status (default to false)
36686
- * @param {Array.<String>} opts.types Specifies the module types.
36714
+ * @param {Array.<String>} opts.types Specifies the module types. Informational, AssessedContent and Assessment are deprecated
36687
36715
  * @param {Number} opts.pageSize Page size (default to 25)
36688
36716
  * @param {Number} opts.pageNumber Page number (default to 1)
36689
36717
  * @param {Object} opts.sortOrder Sort order (default to ascending)
@@ -37359,7 +37387,7 @@ class LicenseApi {
37359
37387
  /**
37360
37388
  * License service.
37361
37389
  * @module purecloud-platform-client-v2/api/LicenseApi
37362
- * @version 199.0.0
37390
+ * @version 201.0.0
37363
37391
  */
37364
37392
 
37365
37393
  /**
@@ -37597,7 +37625,7 @@ class LocationsApi {
37597
37625
  /**
37598
37626
  * Locations service.
37599
37627
  * @module purecloud-platform-client-v2/api/LocationsApi
37600
- * @version 199.0.0
37628
+ * @version 201.0.0
37601
37629
  */
37602
37630
 
37603
37631
  /**
@@ -37833,7 +37861,7 @@ class LogCaptureApi {
37833
37861
  /**
37834
37862
  * LogCapture service.
37835
37863
  * @module purecloud-platform-client-v2/api/LogCaptureApi
37836
- * @version 199.0.0
37864
+ * @version 201.0.0
37837
37865
  */
37838
37866
 
37839
37867
  /**
@@ -38033,7 +38061,7 @@ class MessagingApi {
38033
38061
  /**
38034
38062
  * Messaging service.
38035
38063
  * @module purecloud-platform-client-v2/api/MessagingApi
38036
- * @version 199.0.0
38064
+ * @version 201.0.0
38037
38065
  */
38038
38066
 
38039
38067
  /**
@@ -38392,7 +38420,7 @@ class MobileDevicesApi {
38392
38420
  /**
38393
38421
  * MobileDevices service.
38394
38422
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
38395
- * @version 199.0.0
38423
+ * @version 201.0.0
38396
38424
  */
38397
38425
 
38398
38426
  /**
@@ -38543,7 +38571,7 @@ class NotificationsApi {
38543
38571
  /**
38544
38572
  * Notifications service.
38545
38573
  * @module purecloud-platform-client-v2/api/NotificationsApi
38546
- * @version 199.0.0
38574
+ * @version 201.0.0
38547
38575
  */
38548
38576
 
38549
38577
  /**
@@ -38776,7 +38804,7 @@ class OAuthApi {
38776
38804
  /**
38777
38805
  * OAuth service.
38778
38806
  * @module purecloud-platform-client-v2/api/OAuthApi
38779
- * @version 199.0.0
38807
+ * @version 201.0.0
38780
38808
  */
38781
38809
 
38782
38810
  /**
@@ -39142,7 +39170,7 @@ class ObjectsApi {
39142
39170
  /**
39143
39171
  * Objects service.
39144
39172
  * @module purecloud-platform-client-v2/api/ObjectsApi
39145
- * @version 199.0.0
39173
+ * @version 201.0.0
39146
39174
  */
39147
39175
 
39148
39176
  /**
@@ -39412,7 +39440,7 @@ class OperationalEventsApi {
39412
39440
  /**
39413
39441
  * OperationalEvents service.
39414
39442
  * @module purecloud-platform-client-v2/api/OperationalEventsApi
39415
- * @version 199.0.0
39443
+ * @version 201.0.0
39416
39444
  */
39417
39445
 
39418
39446
  /**
@@ -39478,7 +39506,7 @@ class OrganizationApi {
39478
39506
  /**
39479
39507
  * Organization service.
39480
39508
  * @module purecloud-platform-client-v2/api/OrganizationApi
39481
- * @version 199.0.0
39509
+ * @version 201.0.0
39482
39510
  */
39483
39511
 
39484
39512
  /**
@@ -39699,6 +39727,37 @@ class OrganizationApi {
39699
39727
  );
39700
39728
  }
39701
39729
 
39730
+ /**
39731
+ * 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.
39732
+ * See https://developer.genesys.cloud/organization/organization/limits#available-limits for limits that are trackable (Operational Events Enabled).
39733
+ * @param {String} namespaceName The namespace to get
39734
+ * @param {Object} opts Optional parameters
39735
+ * @param {String} opts.cursor Cursor provided when retrieving the last page
39736
+ * @param {String} opts.entityId entity id of the count
39737
+ * @param {String} opts.userId userid of the count
39738
+ */
39739
+ getOrganizationsLimitsNamespaceCounts(namespaceName, opts) {
39740
+ opts = opts || {};
39741
+
39742
+ // verify the required parameter 'namespaceName' is set
39743
+ if (namespaceName === undefined || namespaceName === null) {
39744
+ throw 'Missing the required parameter "namespaceName" when calling getOrganizationsLimitsNamespaceCounts';
39745
+ }
39746
+
39747
+ return this.apiClient.callApi(
39748
+ '/api/v2/organizations/limits/namespaces/{namespaceName}/counts',
39749
+ 'GET',
39750
+ { 'namespaceName': namespaceName },
39751
+ { 'cursor': opts['cursor'],'entityId': opts['entityId'],'userId': opts['userId'] },
39752
+ { },
39753
+ { },
39754
+ null,
39755
+ ['PureCloud OAuth'],
39756
+ ['application/json'],
39757
+ ['application/json']
39758
+ );
39759
+ }
39760
+
39702
39761
  /**
39703
39762
  * Get the default limits in a namespace for an organization
39704
39763
  *
@@ -39724,6 +39783,42 @@ class OrganizationApi {
39724
39783
  );
39725
39784
  }
39726
39785
 
39786
+ /**
39787
+ * 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.
39788
+ * See https://developer.genesys.cloud/organization/organization/limits#available-limits for limits that are trackable (Operational Events Enabled).
39789
+ * @param {String} namespaceName The namespace to get
39790
+ * @param {String} limitName The limit to get
39791
+ * @param {Object} opts Optional parameters
39792
+ * @param {String} opts.entityId entity id of the count
39793
+ * @param {String} opts.userId userid of the count
39794
+ * @param {String} opts.cursor Cursor provided when retrieving the last page
39795
+ */
39796
+ getOrganizationsLimitsNamespaceLimitCounts(namespaceName, limitName, opts) {
39797
+ opts = opts || {};
39798
+
39799
+ // verify the required parameter 'namespaceName' is set
39800
+ if (namespaceName === undefined || namespaceName === null) {
39801
+ throw 'Missing the required parameter "namespaceName" when calling getOrganizationsLimitsNamespaceLimitCounts';
39802
+ }
39803
+ // verify the required parameter 'limitName' is set
39804
+ if (limitName === undefined || limitName === null) {
39805
+ throw 'Missing the required parameter "limitName" when calling getOrganizationsLimitsNamespaceLimitCounts';
39806
+ }
39807
+
39808
+ return this.apiClient.callApi(
39809
+ '/api/v2/organizations/limits/namespaces/{namespaceName}/limits/{limitName}/counts',
39810
+ 'GET',
39811
+ { 'namespaceName': namespaceName,'limitName': limitName },
39812
+ { 'entityId': opts['entityId'],'userId': opts['userId'],'cursor': opts['cursor'] },
39813
+ { },
39814
+ { },
39815
+ null,
39816
+ ['PureCloud OAuth'],
39817
+ ['application/json'],
39818
+ ['application/json']
39819
+ );
39820
+ }
39821
+
39727
39822
  /**
39728
39823
  * Get the available limit namespaces
39729
39824
  *
@@ -39953,7 +40048,7 @@ class OrganizationAuthorizationApi {
39953
40048
  /**
39954
40049
  * OrganizationAuthorization service.
39955
40050
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
39956
- * @version 199.0.0
40051
+ * @version 201.0.0
39957
40052
  */
39958
40053
 
39959
40054
  /**
@@ -41300,7 +41395,7 @@ class OutboundApi {
41300
41395
  /**
41301
41396
  * Outbound service.
41302
41397
  * @module purecloud-platform-client-v2/api/OutboundApi
41303
- * @version 199.0.0
41398
+ * @version 201.0.0
41304
41399
  */
41305
41400
 
41306
41401
  /**
@@ -45662,7 +45757,7 @@ class PresenceApi {
45662
45757
  /**
45663
45758
  * Presence service.
45664
45759
  * @module purecloud-platform-client-v2/api/PresenceApi
45665
- * @version 199.0.0
45760
+ * @version 201.0.0
45666
45761
  */
45667
45762
 
45668
45763
  /**
@@ -46406,7 +46501,7 @@ class ProcessAutomationApi {
46406
46501
  /**
46407
46502
  * ProcessAutomation service.
46408
46503
  * @module purecloud-platform-client-v2/api/ProcessAutomationApi
46409
- * @version 199.0.0
46504
+ * @version 201.0.0
46410
46505
  */
46411
46506
 
46412
46507
  /**
@@ -46645,7 +46740,7 @@ class QualityApi {
46645
46740
  /**
46646
46741
  * Quality service.
46647
46742
  * @module purecloud-platform-client-v2/api/QualityApi
46648
- * @version 199.0.0
46743
+ * @version 201.0.0
46649
46744
  */
46650
46745
 
46651
46746
  /**
@@ -48431,7 +48526,7 @@ class RecordingApi {
48431
48526
  /**
48432
48527
  * Recording service.
48433
48528
  * @module purecloud-platform-client-v2/api/RecordingApi
48434
- * @version 199.0.0
48529
+ * @version 201.0.0
48435
48530
  */
48436
48531
 
48437
48532
  /**
@@ -49423,10 +49518,11 @@ class RecordingApi {
49423
49518
 
49424
49519
  /**
49425
49520
  * Update a screen recording session
49426
- *
49521
+ * This API is deprecated and the functionality to stop screen recording will be no longer supported.
49427
49522
  * @param {String} recordingSessionId Screen recording session ID
49428
49523
  * @param {Object} opts Optional parameters
49429
49524
  * @param {Object} opts.body
49525
+ * @deprecated
49430
49526
  */
49431
49527
  patchRecordingsScreensession(recordingSessionId, opts) {
49432
49528
  opts = opts || {};
@@ -50089,7 +50185,7 @@ class ResponseManagementApi {
50089
50185
  /**
50090
50186
  * ResponseManagement service.
50091
50187
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
50092
- * @version 199.0.0
50188
+ * @version 201.0.0
50093
50189
  */
50094
50190
 
50095
50191
  /**
@@ -50599,7 +50695,7 @@ class RoutingApi {
50599
50695
  /**
50600
50696
  * Routing service.
50601
50697
  * @module purecloud-platform-client-v2/api/RoutingApi
50602
- * @version 199.0.0
50698
+ * @version 201.0.0
50603
50699
  */
50604
50700
 
50605
50701
  /**
@@ -50639,6 +50735,26 @@ class RoutingApi {
50639
50735
  );
50640
50736
  }
50641
50737
 
50738
+ /**
50739
+ * Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.
50740
+ *
50741
+ */
50742
+ deleteRoutingDirectroutingbackupSettingsMe() {
50743
+
50744
+ return this.apiClient.callApi(
50745
+ '/api/v2/routing/directroutingbackup/settings/me',
50746
+ 'DELETE',
50747
+ { },
50748
+ { },
50749
+ { },
50750
+ { },
50751
+ null,
50752
+ ['PureCloud OAuth'],
50753
+ ['application/json'],
50754
+ ['application/json']
50755
+ );
50756
+ }
50757
+
50642
50758
  /**
50643
50759
  * Delete a domain
50644
50760
  *
@@ -51009,6 +51125,31 @@ class RoutingApi {
51009
51125
  );
51010
51126
  }
51011
51127
 
51128
+ /**
51129
+ * Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.
51130
+ *
51131
+ * @param {String} userId User ID
51132
+ */
51133
+ deleteRoutingUserDirectroutingbackupSettings(userId) {
51134
+ // verify the required parameter 'userId' is set
51135
+ if (userId === undefined || userId === null) {
51136
+ throw 'Missing the required parameter "userId" when calling deleteRoutingUserDirectroutingbackupSettings';
51137
+ }
51138
+
51139
+ return this.apiClient.callApi(
51140
+ '/api/v2/routing/users/{userId}/directroutingbackup/settings',
51141
+ 'DELETE',
51142
+ { 'userId': userId },
51143
+ { },
51144
+ { },
51145
+ { },
51146
+ null,
51147
+ ['PureCloud OAuth'],
51148
+ ['application/json'],
51149
+ ['application/json']
51150
+ );
51151
+ }
51152
+
51012
51153
  /**
51013
51154
  * Delete the user's max utilization settings and revert to the organization-wide default.
51014
51155
  *
@@ -51320,6 +51461,26 @@ class RoutingApi {
51320
51461
  );
51321
51462
  }
51322
51463
 
51464
+ /**
51465
+ * Get the user's Direct Routing Backup settings.
51466
+ *
51467
+ */
51468
+ getRoutingDirectroutingbackupSettingsMe() {
51469
+
51470
+ return this.apiClient.callApi(
51471
+ '/api/v2/routing/directroutingbackup/settings/me',
51472
+ 'GET',
51473
+ { },
51474
+ { },
51475
+ { },
51476
+ { },
51477
+ null,
51478
+ ['PureCloud OAuth'],
51479
+ ['application/json'],
51480
+ ['application/json']
51481
+ );
51482
+ }
51483
+
51323
51484
  /**
51324
51485
  * Get domain
51325
51486
  *
@@ -52530,6 +52691,31 @@ class RoutingApi {
52530
52691
  );
52531
52692
  }
52532
52693
 
52694
+ /**
52695
+ * Get the user's Direct Routing Backup settings.
52696
+ *
52697
+ * @param {String} userId User ID
52698
+ */
52699
+ getRoutingUserDirectroutingbackupSettings(userId) {
52700
+ // verify the required parameter 'userId' is set
52701
+ if (userId === undefined || userId === null) {
52702
+ throw 'Missing the required parameter "userId" when calling getRoutingUserDirectroutingbackupSettings';
52703
+ }
52704
+
52705
+ return this.apiClient.callApi(
52706
+ '/api/v2/routing/users/{userId}/directroutingbackup/settings',
52707
+ 'GET',
52708
+ { 'userId': userId },
52709
+ { },
52710
+ { },
52711
+ { },
52712
+ null,
52713
+ ['PureCloud OAuth'],
52714
+ ['application/json'],
52715
+ ['application/json']
52716
+ );
52717
+ }
52718
+
52533
52719
  /**
52534
52720
  * Get the user's max utilization settings. If not configured, the organization-wide default is returned.
52535
52721
  *
@@ -54187,6 +54373,31 @@ class RoutingApi {
54187
54373
  );
54188
54374
  }
54189
54375
 
54376
+ /**
54377
+ * Update the user's Direct Routing Backup settings.
54378
+ *
54379
+ * @param {Object} body directRoutingBackup
54380
+ */
54381
+ putRoutingDirectroutingbackupSettingsMe(body) {
54382
+ // verify the required parameter 'body' is set
54383
+ if (body === undefined || body === null) {
54384
+ throw 'Missing the required parameter "body" when calling putRoutingDirectroutingbackupSettingsMe';
54385
+ }
54386
+
54387
+ return this.apiClient.callApi(
54388
+ '/api/v2/routing/directroutingbackup/settings/me',
54389
+ 'PUT',
54390
+ { },
54391
+ { },
54392
+ { },
54393
+ { },
54394
+ body,
54395
+ ['PureCloud OAuth'],
54396
+ ['application/json'],
54397
+ ['application/json']
54398
+ );
54399
+ }
54400
+
54190
54401
  /**
54191
54402
  * Update a route
54192
54403
  *
@@ -54387,6 +54598,36 @@ class RoutingApi {
54387
54598
  );
54388
54599
  }
54389
54600
 
54601
+ /**
54602
+ * Update the user's Direct Routing Backup settings.
54603
+ *
54604
+ * @param {String} userId User ID
54605
+ * @param {Object} body directRoutingBackup
54606
+ */
54607
+ putRoutingUserDirectroutingbackupSettings(userId, body) {
54608
+ // verify the required parameter 'userId' is set
54609
+ if (userId === undefined || userId === null) {
54610
+ throw 'Missing the required parameter "userId" when calling putRoutingUserDirectroutingbackupSettings';
54611
+ }
54612
+ // verify the required parameter 'body' is set
54613
+ if (body === undefined || body === null) {
54614
+ throw 'Missing the required parameter "body" when calling putRoutingUserDirectroutingbackupSettings';
54615
+ }
54616
+
54617
+ return this.apiClient.callApi(
54618
+ '/api/v2/routing/users/{userId}/directroutingbackup/settings',
54619
+ 'PUT',
54620
+ { 'userId': userId },
54621
+ { },
54622
+ { },
54623
+ { },
54624
+ body,
54625
+ ['PureCloud OAuth'],
54626
+ ['application/json'],
54627
+ ['application/json']
54628
+ );
54629
+ }
54630
+
54390
54631
  /**
54391
54632
  * Update the user's max utilization settings. Include only those media types requiring custom configuration.
54392
54633
  *
@@ -54573,7 +54814,7 @@ class SCIMApi {
54573
54814
  /**
54574
54815
  * SCIM service.
54575
54816
  * @module purecloud-platform-client-v2/api/SCIMApi
54576
- * @version 199.0.0
54817
+ * @version 201.0.0
54577
54818
  */
54578
54819
 
54579
54820
  /**
@@ -55450,7 +55691,7 @@ class ScreenRecordingApi {
55450
55691
  /**
55451
55692
  * ScreenRecording service.
55452
55693
  * @module purecloud-platform-client-v2/api/ScreenRecordingApi
55453
- * @version 199.0.0
55694
+ * @version 201.0.0
55454
55695
  */
55455
55696
 
55456
55697
  /**
@@ -55495,7 +55736,7 @@ class ScriptsApi {
55495
55736
  /**
55496
55737
  * Scripts service.
55497
55738
  * @module purecloud-platform-client-v2/api/ScriptsApi
55498
- * @version 199.0.0
55739
+ * @version 201.0.0
55499
55740
  */
55500
55741
 
55501
55742
  /**
@@ -55939,7 +56180,7 @@ class SearchApi {
55939
56180
  /**
55940
56181
  * Search service.
55941
56182
  * @module purecloud-platform-client-v2/api/SearchApi
55942
- * @version 199.0.0
56183
+ * @version 201.0.0
55943
56184
  */
55944
56185
 
55945
56186
  /**
@@ -56628,7 +56869,7 @@ class SettingsApi {
56628
56869
  /**
56629
56870
  * Settings service.
56630
56871
  * @module purecloud-platform-client-v2/api/SettingsApi
56631
- * @version 199.0.0
56872
+ * @version 201.0.0
56632
56873
  */
56633
56874
 
56634
56875
  /**
@@ -56850,7 +57091,7 @@ class SpeechTextAnalyticsApi {
56850
57091
  /**
56851
57092
  * SpeechTextAnalytics service.
56852
57093
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
56853
- * @version 199.0.0
57094
+ * @version 201.0.0
56854
57095
  */
56855
57096
 
56856
57097
  /**
@@ -58128,7 +58369,7 @@ class StationsApi {
58128
58369
  /**
58129
58370
  * Stations service.
58130
58371
  * @module purecloud-platform-client-v2/api/StationsApi
58131
- * @version 199.0.0
58372
+ * @version 201.0.0
58132
58373
  */
58133
58374
 
58134
58375
  /**
@@ -58230,7 +58471,7 @@ class SuggestApi {
58230
58471
  /**
58231
58472
  * Suggest service.
58232
58473
  * @module purecloud-platform-client-v2/api/SuggestApi
58233
- * @version 199.0.0
58474
+ * @version 201.0.0
58234
58475
  */
58235
58476
 
58236
58477
  /**
@@ -58369,7 +58610,7 @@ class TaskManagementApi {
58369
58610
  /**
58370
58611
  * TaskManagement service.
58371
58612
  * @module purecloud-platform-client-v2/api/TaskManagementApi
58372
- * @version 199.0.0
58613
+ * @version 201.0.0
58373
58614
  */
58374
58615
 
58375
58616
  /**
@@ -59316,16 +59557,17 @@ class TaskManagementApi {
59316
59557
  * Update the attributes of a worktype
59317
59558
  *
59318
59559
  * @param {String} worktypeId Worktype id
59319
- * @param {Object} opts Optional parameters
59320
- * @param {Object} opts.body body
59560
+ * @param {Object} body Worktype
59321
59561
  */
59322
- patchTaskmanagementWorktype(worktypeId, opts) {
59323
- opts = opts || {};
59324
-
59562
+ patchTaskmanagementWorktype(worktypeId, body) {
59325
59563
  // verify the required parameter 'worktypeId' is set
59326
59564
  if (worktypeId === undefined || worktypeId === null) {
59327
59565
  throw 'Missing the required parameter "worktypeId" when calling patchTaskmanagementWorktype';
59328
59566
  }
59567
+ // verify the required parameter 'body' is set
59568
+ if (body === undefined || body === null) {
59569
+ throw 'Missing the required parameter "body" when calling patchTaskmanagementWorktype';
59570
+ }
59329
59571
 
59330
59572
  return this.apiClient.callApi(
59331
59573
  '/api/v2/taskmanagement/worktypes/{worktypeId}',
@@ -59334,7 +59576,7 @@ class TaskManagementApi {
59334
59576
  { },
59335
59577
  { },
59336
59578
  { },
59337
- opts['body'],
59579
+ body,
59338
59580
  ['PureCloud OAuth'],
59339
59581
  ['application/json'],
59340
59582
  ['application/json']
@@ -59346,12 +59588,9 @@ class TaskManagementApi {
59346
59588
  *
59347
59589
  * @param {String} worktypeId Worktype id
59348
59590
  * @param {String} statusId Status id
59349
- * @param {Object} opts Optional parameters
59350
- * @param {Object} opts.body body
59591
+ * @param {Object} body Status
59351
59592
  */
59352
- patchTaskmanagementWorktypeStatus(worktypeId, statusId, opts) {
59353
- opts = opts || {};
59354
-
59593
+ patchTaskmanagementWorktypeStatus(worktypeId, statusId, body) {
59355
59594
  // verify the required parameter 'worktypeId' is set
59356
59595
  if (worktypeId === undefined || worktypeId === null) {
59357
59596
  throw 'Missing the required parameter "worktypeId" when calling patchTaskmanagementWorktypeStatus';
@@ -59360,6 +59599,10 @@ class TaskManagementApi {
59360
59599
  if (statusId === undefined || statusId === null) {
59361
59600
  throw 'Missing the required parameter "statusId" when calling patchTaskmanagementWorktypeStatus';
59362
59601
  }
59602
+ // verify the required parameter 'body' is set
59603
+ if (body === undefined || body === null) {
59604
+ throw 'Missing the required parameter "body" when calling patchTaskmanagementWorktypeStatus';
59605
+ }
59363
59606
 
59364
59607
  return this.apiClient.callApi(
59365
59608
  '/api/v2/taskmanagement/worktypes/{worktypeId}/statuses/{statusId}',
@@ -59368,7 +59611,7 @@ class TaskManagementApi {
59368
59611
  { },
59369
59612
  { },
59370
59613
  { },
59371
- opts['body'],
59614
+ body,
59372
59615
  ['PureCloud OAuth'],
59373
59616
  ['application/json'],
59374
59617
  ['application/json']
@@ -59378,12 +59621,13 @@ class TaskManagementApi {
59378
59621
  /**
59379
59622
  * Create a workbin
59380
59623
  *
59381
- * @param {Object} opts Optional parameters
59382
- * @param {Object} opts.body body
59624
+ * @param {Object} body Workbin
59383
59625
  */
59384
- postTaskmanagementWorkbins(opts) {
59385
- opts = opts || {};
59386
-
59626
+ postTaskmanagementWorkbins(body) {
59627
+ // verify the required parameter 'body' is set
59628
+ if (body === undefined || body === null) {
59629
+ throw 'Missing the required parameter "body" when calling postTaskmanagementWorkbins';
59630
+ }
59387
59631
 
59388
59632
  return this.apiClient.callApi(
59389
59633
  '/api/v2/taskmanagement/workbins',
@@ -59392,7 +59636,7 @@ class TaskManagementApi {
59392
59636
  { },
59393
59637
  { },
59394
59638
  { },
59395
- opts['body'],
59639
+ body,
59396
59640
  ['PureCloud OAuth'],
59397
59641
  ['application/json'],
59398
59642
  ['application/json']
@@ -59608,16 +59852,17 @@ class TaskManagementApi {
59608
59852
  * Add a status to a worktype
59609
59853
  *
59610
59854
  * @param {String} worktypeId Worktype id
59611
- * @param {Object} opts Optional parameters
59612
- * @param {Object} opts.body body
59855
+ * @param {Object} body Status
59613
59856
  */
59614
- postTaskmanagementWorktypeStatuses(worktypeId, opts) {
59615
- opts = opts || {};
59616
-
59857
+ postTaskmanagementWorktypeStatuses(worktypeId, body) {
59617
59858
  // verify the required parameter 'worktypeId' is set
59618
59859
  if (worktypeId === undefined || worktypeId === null) {
59619
59860
  throw 'Missing the required parameter "worktypeId" when calling postTaskmanagementWorktypeStatuses';
59620
59861
  }
59862
+ // verify the required parameter 'body' is set
59863
+ if (body === undefined || body === null) {
59864
+ throw 'Missing the required parameter "body" when calling postTaskmanagementWorktypeStatuses';
59865
+ }
59621
59866
 
59622
59867
  return this.apiClient.callApi(
59623
59868
  '/api/v2/taskmanagement/worktypes/{worktypeId}/statuses',
@@ -59626,7 +59871,7 @@ class TaskManagementApi {
59626
59871
  { },
59627
59872
  { },
59628
59873
  { },
59629
- opts['body'],
59874
+ body,
59630
59875
  ['PureCloud OAuth'],
59631
59876
  ['application/json'],
59632
59877
  ['application/json']
@@ -59636,12 +59881,13 @@ class TaskManagementApi {
59636
59881
  /**
59637
59882
  * Create a worktype
59638
59883
  *
59639
- * @param {Object} opts Optional parameters
59640
- * @param {Object} opts.body body
59884
+ * @param {Object} body Worktype
59641
59885
  */
59642
- postTaskmanagementWorktypes(opts) {
59643
- opts = opts || {};
59644
-
59886
+ postTaskmanagementWorktypes(body) {
59887
+ // verify the required parameter 'body' is set
59888
+ if (body === undefined || body === null) {
59889
+ throw 'Missing the required parameter "body" when calling postTaskmanagementWorktypes';
59890
+ }
59645
59891
 
59646
59892
  return this.apiClient.callApi(
59647
59893
  '/api/v2/taskmanagement/worktypes',
@@ -59650,7 +59896,7 @@ class TaskManagementApi {
59650
59896
  { },
59651
59897
  { },
59652
59898
  { },
59653
- opts['body'],
59899
+ body,
59654
59900
  ['PureCloud OAuth'],
59655
59901
  ['application/json'],
59656
59902
  ['application/json']
@@ -59718,7 +59964,7 @@ class TeamsApi {
59718
59964
  /**
59719
59965
  * Teams service.
59720
59966
  * @module purecloud-platform-client-v2/api/TeamsApi
59721
- * @version 199.0.0
59967
+ * @version 201.0.0
59722
59968
  */
59723
59969
 
59724
59970
  /**
@@ -60019,7 +60265,7 @@ class TelephonyApi {
60019
60265
  /**
60020
60266
  * Telephony service.
60021
60267
  * @module purecloud-platform-client-v2/api/TelephonyApi
60022
- * @version 199.0.0
60268
+ * @version 201.0.0
60023
60269
  */
60024
60270
 
60025
60271
  /**
@@ -60201,7 +60447,7 @@ class TelephonyProvidersEdgeApi {
60201
60447
  /**
60202
60448
  * TelephonyProvidersEdge service.
60203
60449
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
60204
- * @version 199.0.0
60450
+ * @version 201.0.0
60205
60451
  */
60206
60452
 
60207
60453
  /**
@@ -63529,7 +63775,7 @@ class TextbotsApi {
63529
63775
  /**
63530
63776
  * Textbots service.
63531
63777
  * @module purecloud-platform-client-v2/api/TextbotsApi
63532
- * @version 199.0.0
63778
+ * @version 201.0.0
63533
63779
  */
63534
63780
 
63535
63781
  /**
@@ -63657,7 +63903,7 @@ class TokensApi {
63657
63903
  /**
63658
63904
  * Tokens service.
63659
63905
  * @module purecloud-platform-client-v2/api/TokensApi
63660
- * @version 199.0.0
63906
+ * @version 201.0.0
63661
63907
  */
63662
63908
 
63663
63909
  /**
@@ -63811,7 +64057,7 @@ class UploadsApi {
63811
64057
  /**
63812
64058
  * Uploads service.
63813
64059
  * @module purecloud-platform-client-v2/api/UploadsApi
63814
- * @version 199.0.0
64060
+ * @version 201.0.0
63815
64061
  */
63816
64062
 
63817
64063
  /**
@@ -64080,7 +64326,7 @@ class UsageApi {
64080
64326
  /**
64081
64327
  * Usage service.
64082
64328
  * @module purecloud-platform-client-v2/api/UsageApi
64083
- * @version 199.0.0
64329
+ * @version 201.0.0
64084
64330
  */
64085
64331
 
64086
64332
  /**
@@ -64295,7 +64541,7 @@ class UserRecordingsApi {
64295
64541
  /**
64296
64542
  * UserRecordings service.
64297
64543
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
64298
- * @version 199.0.0
64544
+ * @version 201.0.0
64299
64545
  */
64300
64546
 
64301
64547
  /**
@@ -64480,7 +64726,7 @@ class UsersApi {
64480
64726
  /**
64481
64727
  * Users service.
64482
64728
  * @module purecloud-platform-client-v2/api/UsersApi
64483
- * @version 199.0.0
64729
+ * @version 201.0.0
64484
64730
  */
64485
64731
 
64486
64732
  /**
@@ -64555,6 +64801,51 @@ class UsersApi {
64555
64801
  );
64556
64802
  }
64557
64803
 
64804
+ /**
64805
+ * Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.
64806
+ *
64807
+ */
64808
+ deleteRoutingDirectroutingbackupSettingsMe() {
64809
+
64810
+ return this.apiClient.callApi(
64811
+ '/api/v2/routing/directroutingbackup/settings/me',
64812
+ 'DELETE',
64813
+ { },
64814
+ { },
64815
+ { },
64816
+ { },
64817
+ null,
64818
+ ['PureCloud OAuth'],
64819
+ ['application/json'],
64820
+ ['application/json']
64821
+ );
64822
+ }
64823
+
64824
+ /**
64825
+ * Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.
64826
+ *
64827
+ * @param {String} userId User ID
64828
+ */
64829
+ deleteRoutingUserDirectroutingbackupSettings(userId) {
64830
+ // verify the required parameter 'userId' is set
64831
+ if (userId === undefined || userId === null) {
64832
+ throw 'Missing the required parameter "userId" when calling deleteRoutingUserDirectroutingbackupSettings';
64833
+ }
64834
+
64835
+ return this.apiClient.callApi(
64836
+ '/api/v2/routing/users/{userId}/directroutingbackup/settings',
64837
+ 'DELETE',
64838
+ { 'userId': userId },
64839
+ { },
64840
+ { },
64841
+ { },
64842
+ null,
64843
+ ['PureCloud OAuth'],
64844
+ ['application/json'],
64845
+ ['application/json']
64846
+ );
64847
+ }
64848
+
64558
64849
  /**
64559
64850
  * Delete the user's max utilization settings and revert to the organization-wide default.
64560
64851
  *
@@ -65082,6 +65373,51 @@ class UsersApi {
65082
65373
  );
65083
65374
  }
65084
65375
 
65376
+ /**
65377
+ * Get the user's Direct Routing Backup settings.
65378
+ *
65379
+ */
65380
+ getRoutingDirectroutingbackupSettingsMe() {
65381
+
65382
+ return this.apiClient.callApi(
65383
+ '/api/v2/routing/directroutingbackup/settings/me',
65384
+ 'GET',
65385
+ { },
65386
+ { },
65387
+ { },
65388
+ { },
65389
+ null,
65390
+ ['PureCloud OAuth'],
65391
+ ['application/json'],
65392
+ ['application/json']
65393
+ );
65394
+ }
65395
+
65396
+ /**
65397
+ * Get the user's Direct Routing Backup settings.
65398
+ *
65399
+ * @param {String} userId User ID
65400
+ */
65401
+ getRoutingUserDirectroutingbackupSettings(userId) {
65402
+ // verify the required parameter 'userId' is set
65403
+ if (userId === undefined || userId === null) {
65404
+ throw 'Missing the required parameter "userId" when calling getRoutingUserDirectroutingbackupSettings';
65405
+ }
65406
+
65407
+ return this.apiClient.callApi(
65408
+ '/api/v2/routing/users/{userId}/directroutingbackup/settings',
65409
+ 'GET',
65410
+ { 'userId': userId },
65411
+ { },
65412
+ { },
65413
+ { },
65414
+ null,
65415
+ ['PureCloud OAuth'],
65416
+ ['application/json'],
65417
+ ['application/json']
65418
+ );
65419
+ }
65420
+
65085
65421
  /**
65086
65422
  * Get the user's max utilization settings. If not configured, the organization-wide default is returned.
65087
65423
  *
@@ -65718,7 +66054,7 @@ class UsersApi {
65718
66054
  * @param {Number} opts.pageSize Page size (default to 25)
65719
66055
  * @param {Number} opts.pageNumber Page number (default to 1)
65720
66056
  * @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)
65721
- * @param {Array.<String>} opts.types Specifies the activity types.
66057
+ * @param {Array.<String>} opts.types Specifies the activity types. Informational, AssessedContent and Assessment are deprecated
65722
66058
  * @param {Array.<String>} opts.statuses Specifies the activity statuses to filter by
65723
66059
  * @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.
65724
66060
  */
@@ -65752,7 +66088,7 @@ class UsersApi {
65752
66088
  * @param {Number} opts.pageSize Page size (default to 25)
65753
66089
  * @param {Number} opts.pageNumber Page number (default to 1)
65754
66090
  * @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)
65755
- * @param {Array.<String>} opts.types Specifies the activity types.
66091
+ * @param {Array.<String>} opts.types Specifies the activity types. Informational, AssessedContent and Assessment are deprecated
65756
66092
  * @param {Array.<String>} opts.statuses Specifies the activity statuses to filter by
65757
66093
  * @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.
65758
66094
  */
@@ -65778,7 +66114,7 @@ class UsersApi {
65778
66114
  * Get a Development Activity
65779
66115
  * 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.
65780
66116
  * @param {String} activityId Specifies the activity ID, maps to either assignment or appointment ID
65781
- * @param {Object} type Specifies the activity type.
66117
+ * @param {Object} type Specifies the activity type. Informational, AssessedContent and Assessment are deprecated
65782
66118
  */
65783
66119
  getUsersDevelopmentActivity(activityId, type) {
65784
66120
  // verify the required parameter 'activityId' is set
@@ -66762,6 +67098,61 @@ class UsersApi {
66762
67098
  );
66763
67099
  }
66764
67100
 
67101
+ /**
67102
+ * Update the user's Direct Routing Backup settings.
67103
+ *
67104
+ * @param {Object} body directRoutingBackup
67105
+ */
67106
+ putRoutingDirectroutingbackupSettingsMe(body) {
67107
+ // verify the required parameter 'body' is set
67108
+ if (body === undefined || body === null) {
67109
+ throw 'Missing the required parameter "body" when calling putRoutingDirectroutingbackupSettingsMe';
67110
+ }
67111
+
67112
+ return this.apiClient.callApi(
67113
+ '/api/v2/routing/directroutingbackup/settings/me',
67114
+ 'PUT',
67115
+ { },
67116
+ { },
67117
+ { },
67118
+ { },
67119
+ body,
67120
+ ['PureCloud OAuth'],
67121
+ ['application/json'],
67122
+ ['application/json']
67123
+ );
67124
+ }
67125
+
67126
+ /**
67127
+ * Update the user's Direct Routing Backup settings.
67128
+ *
67129
+ * @param {String} userId User ID
67130
+ * @param {Object} body directRoutingBackup
67131
+ */
67132
+ putRoutingUserDirectroutingbackupSettings(userId, body) {
67133
+ // verify the required parameter 'userId' is set
67134
+ if (userId === undefined || userId === null) {
67135
+ throw 'Missing the required parameter "userId" when calling putRoutingUserDirectroutingbackupSettings';
67136
+ }
67137
+ // verify the required parameter 'body' is set
67138
+ if (body === undefined || body === null) {
67139
+ throw 'Missing the required parameter "body" when calling putRoutingUserDirectroutingbackupSettings';
67140
+ }
67141
+
67142
+ return this.apiClient.callApi(
67143
+ '/api/v2/routing/users/{userId}/directroutingbackup/settings',
67144
+ 'PUT',
67145
+ { 'userId': userId },
67146
+ { },
67147
+ { },
67148
+ { },
67149
+ body,
67150
+ ['PureCloud OAuth'],
67151
+ ['application/json'],
67152
+ ['application/json']
67153
+ );
67154
+ }
67155
+
66765
67156
  /**
66766
67157
  * Update the user's max utilization settings. Include only those media types requiring custom configuration.
66767
67158
  *
@@ -67138,7 +67529,7 @@ class UtilitiesApi {
67138
67529
  /**
67139
67530
  * Utilities service.
67140
67531
  * @module purecloud-platform-client-v2/api/UtilitiesApi
67141
- * @version 199.0.0
67532
+ * @version 201.0.0
67142
67533
  */
67143
67534
 
67144
67535
  /**
@@ -67249,7 +67640,7 @@ class VoicemailApi {
67249
67640
  /**
67250
67641
  * Voicemail service.
67251
67642
  * @module purecloud-platform-client-v2/api/VoicemailApi
67252
- * @version 199.0.0
67643
+ * @version 201.0.0
67253
67644
  */
67254
67645
 
67255
67646
  /**
@@ -67916,7 +68307,7 @@ class WebChatApi {
67916
68307
  /**
67917
68308
  * WebChat service.
67918
68309
  * @module purecloud-platform-client-v2/api/WebChatApi
67919
- * @version 199.0.0
68310
+ * @version 201.0.0
67920
68311
  */
67921
68312
 
67922
68313
  /**
@@ -68467,7 +68858,7 @@ class WebDeploymentsApi {
68467
68858
  /**
68468
68859
  * WebDeployments service.
68469
68860
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
68470
- * @version 199.0.0
68861
+ * @version 201.0.0
68471
68862
  */
68472
68863
 
68473
68864
  /**
@@ -68994,7 +69385,7 @@ class WebMessagingApi {
68994
69385
  /**
68995
69386
  * WebMessaging service.
68996
69387
  * @module purecloud-platform-client-v2/api/WebMessagingApi
68997
- * @version 199.0.0
69388
+ * @version 201.0.0
68998
69389
  */
68999
69390
 
69000
69391
  /**
@@ -69040,7 +69431,7 @@ class WidgetsApi {
69040
69431
  /**
69041
69432
  * Widgets service.
69042
69433
  * @module purecloud-platform-client-v2/api/WidgetsApi
69043
- * @version 199.0.0
69434
+ * @version 201.0.0
69044
69435
  */
69045
69436
 
69046
69437
  /**
@@ -69186,7 +69577,7 @@ class WorkforceManagementApi {
69186
69577
  /**
69187
69578
  * WorkforceManagement service.
69188
69579
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
69189
- * @version 199.0.0
69580
+ * @version 201.0.0
69190
69581
  */
69191
69582
 
69192
69583
  /**
@@ -69506,6 +69897,71 @@ class WorkforceManagementApi {
69506
69897
  );
69507
69898
  }
69508
69899
 
69900
+ /**
69901
+ * Delete a work plan bid
69902
+ *
69903
+ * @param {String} businessUnitId The ID of the business unit
69904
+ * @param {String} bidId The ID of the work plan bid
69905
+ */
69906
+ deleteWorkforcemanagementBusinessunitWorkplanbid(businessUnitId, bidId) {
69907
+ // verify the required parameter 'businessUnitId' is set
69908
+ if (businessUnitId === undefined || businessUnitId === null) {
69909
+ throw 'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitWorkplanbid';
69910
+ }
69911
+ // verify the required parameter 'bidId' is set
69912
+ if (bidId === undefined || bidId === null) {
69913
+ throw 'Missing the required parameter "bidId" when calling deleteWorkforcemanagementBusinessunitWorkplanbid';
69914
+ }
69915
+
69916
+ return this.apiClient.callApi(
69917
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}',
69918
+ 'DELETE',
69919
+ { 'businessUnitId': businessUnitId,'bidId': bidId },
69920
+ { },
69921
+ { },
69922
+ { },
69923
+ null,
69924
+ ['PureCloud OAuth'],
69925
+ ['application/json'],
69926
+ ['application/json']
69927
+ );
69928
+ }
69929
+
69930
+ /**
69931
+ * Delete a bid group by bid group Id
69932
+ *
69933
+ * @param {String} businessUnitId The ID of the business unit
69934
+ * @param {String} bidId The work plan bid id of the bid groups
69935
+ * @param {String} bidGroupId Work Plan Bid Group id
69936
+ */
69937
+ deleteWorkforcemanagementBusinessunitWorkplanbidGroup(businessUnitId, bidId, bidGroupId) {
69938
+ // verify the required parameter 'businessUnitId' is set
69939
+ if (businessUnitId === undefined || businessUnitId === null) {
69940
+ throw 'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitWorkplanbidGroup';
69941
+ }
69942
+ // verify the required parameter 'bidId' is set
69943
+ if (bidId === undefined || bidId === null) {
69944
+ throw 'Missing the required parameter "bidId" when calling deleteWorkforcemanagementBusinessunitWorkplanbidGroup';
69945
+ }
69946
+ // verify the required parameter 'bidGroupId' is set
69947
+ if (bidGroupId === undefined || bidGroupId === null) {
69948
+ throw 'Missing the required parameter "bidGroupId" when calling deleteWorkforcemanagementBusinessunitWorkplanbidGroup';
69949
+ }
69950
+
69951
+ return this.apiClient.callApi(
69952
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}',
69953
+ 'DELETE',
69954
+ { 'businessUnitId': businessUnitId,'bidId': bidId,'bidGroupId': bidGroupId },
69955
+ { },
69956
+ { },
69957
+ { },
69958
+ null,
69959
+ ['PureCloud OAuth'],
69960
+ ['application/json'],
69961
+ ['application/json']
69962
+ );
69963
+ }
69964
+
69509
69965
  /**
69510
69966
  * Disable generated calendar link for the current user
69511
69967
  *
@@ -69871,6 +70327,175 @@ class WorkforceManagementApi {
69871
70327
  );
69872
70328
  }
69873
70329
 
70330
+ /**
70331
+ * Query the status of an alternative shift offers operation. Only the user who started the operation can query the status
70332
+ * Job details are only retained if the initial request returned a 202 ACCEPTED response
70333
+ * @param {String} jobId The ID of the job
70334
+ */
70335
+ getWorkforcemanagementAlternativeshiftsOffersJob(jobId) {
70336
+ // verify the required parameter 'jobId' is set
70337
+ if (jobId === undefined || jobId === null) {
70338
+ throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementAlternativeshiftsOffersJob';
70339
+ }
70340
+
70341
+ return this.apiClient.callApi(
70342
+ '/api/v2/workforcemanagement/alternativeshifts/offers/jobs/{jobId}',
70343
+ 'GET',
70344
+ { 'jobId': jobId },
70345
+ { },
70346
+ { },
70347
+ { },
70348
+ null,
70349
+ ['PureCloud OAuth'],
70350
+ ['application/json'],
70351
+ ['application/json']
70352
+ );
70353
+ }
70354
+
70355
+ /**
70356
+ * Query the status of an alternative shift search offers operation. Only the user who started the operation can query the status
70357
+ * Job details are only retained if the initial request returned a 202 ACCEPTED response
70358
+ * @param {String} jobId The ID of the job
70359
+ */
70360
+ getWorkforcemanagementAlternativeshiftsOffersSearchJob(jobId) {
70361
+ // verify the required parameter 'jobId' is set
70362
+ if (jobId === undefined || jobId === null) {
70363
+ throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementAlternativeshiftsOffersSearchJob';
70364
+ }
70365
+
70366
+ return this.apiClient.callApi(
70367
+ '/api/v2/workforcemanagement/alternativeshifts/offers/search/jobs/{jobId}',
70368
+ 'GET',
70369
+ { 'jobId': jobId },
70370
+ { },
70371
+ { },
70372
+ { },
70373
+ null,
70374
+ ['PureCloud OAuth'],
70375
+ ['application/json'],
70376
+ ['application/json']
70377
+ );
70378
+ }
70379
+
70380
+ /**
70381
+ * Get alternative shifts settings from the current logged in agent’s business unit
70382
+ *
70383
+ */
70384
+ getWorkforcemanagementAlternativeshiftsSettings() {
70385
+
70386
+ return this.apiClient.callApi(
70387
+ '/api/v2/workforcemanagement/alternativeshifts/settings',
70388
+ 'GET',
70389
+ { },
70390
+ { },
70391
+ { },
70392
+ { },
70393
+ null,
70394
+ ['PureCloud OAuth'],
70395
+ ['application/json'],
70396
+ ['application/json']
70397
+ );
70398
+ }
70399
+
70400
+ /**
70401
+ * Get my alternative shift trade by trade ID
70402
+ *
70403
+ * @param {String} tradeId The ID of the alternative shift trade
70404
+ */
70405
+ getWorkforcemanagementAlternativeshiftsTrade(tradeId) {
70406
+ // verify the required parameter 'tradeId' is set
70407
+ if (tradeId === undefined || tradeId === null) {
70408
+ throw 'Missing the required parameter "tradeId" when calling getWorkforcemanagementAlternativeshiftsTrade';
70409
+ }
70410
+
70411
+ return this.apiClient.callApi(
70412
+ '/api/v2/workforcemanagement/alternativeshifts/trades/{tradeId}',
70413
+ 'GET',
70414
+ { 'tradeId': tradeId },
70415
+ { },
70416
+ { },
70417
+ { },
70418
+ null,
70419
+ ['PureCloud OAuth'],
70420
+ ['application/json'],
70421
+ ['application/json']
70422
+ );
70423
+ }
70424
+
70425
+ /**
70426
+ * Get a list of my alternative shifts trades
70427
+ *
70428
+ * @param {Object} opts Optional parameters
70429
+ * @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
70430
+ */
70431
+ getWorkforcemanagementAlternativeshiftsTrades(opts) {
70432
+ opts = opts || {};
70433
+
70434
+
70435
+ return this.apiClient.callApi(
70436
+ '/api/v2/workforcemanagement/alternativeshifts/trades',
70437
+ 'GET',
70438
+ { },
70439
+ { 'forceAsync': opts['forceAsync'] },
70440
+ { },
70441
+ { },
70442
+ null,
70443
+ ['PureCloud OAuth'],
70444
+ ['application/json'],
70445
+ ['application/json']
70446
+ );
70447
+ }
70448
+
70449
+ /**
70450
+ * Query the status of an alternative shift trades operation. Only the user who started the operation can query the status
70451
+ * Job details are only retained if the initial request returned a 202 ACCEPTED response
70452
+ * @param {String} jobId The ID of the job
70453
+ */
70454
+ getWorkforcemanagementAlternativeshiftsTradesJob(jobId) {
70455
+ // verify the required parameter 'jobId' is set
70456
+ if (jobId === undefined || jobId === null) {
70457
+ throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementAlternativeshiftsTradesJob';
70458
+ }
70459
+
70460
+ return this.apiClient.callApi(
70461
+ '/api/v2/workforcemanagement/alternativeshifts/trades/jobs/{jobId}',
70462
+ 'GET',
70463
+ { 'jobId': jobId },
70464
+ { },
70465
+ { },
70466
+ { },
70467
+ null,
70468
+ ['PureCloud OAuth'],
70469
+ ['application/json'],
70470
+ ['application/json']
70471
+ );
70472
+ }
70473
+
70474
+ /**
70475
+ * Query the status of an alternative shift trade state operation. Only the user who started the operation can query the status
70476
+ * Job details are only retained if the initial request returned a 202 ACCEPTED response
70477
+ * @param {String} jobId The ID of the job
70478
+ */
70479
+ getWorkforcemanagementAlternativeshiftsTradesStateJob(jobId) {
70480
+ // verify the required parameter 'jobId' is set
70481
+ if (jobId === undefined || jobId === null) {
70482
+ throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementAlternativeshiftsTradesStateJob';
70483
+ }
70484
+
70485
+ return this.apiClient.callApi(
70486
+ '/api/v2/workforcemanagement/alternativeshifts/trades/state/jobs/{jobId}',
70487
+ 'GET',
70488
+ { 'jobId': jobId },
70489
+ { },
70490
+ { },
70491
+ { },
70492
+ null,
70493
+ ['PureCloud OAuth'],
70494
+ ['application/json'],
70495
+ ['application/json']
70496
+ );
70497
+ }
70498
+
69874
70499
  /**
69875
70500
  * Get business unit
69876
70501
  * Expanding "settings" will retrieve all settings. All other expands will retrieve only the requested settings field(s).
@@ -70082,6 +70707,91 @@ class WorkforceManagementApi {
70082
70707
  );
70083
70708
  }
70084
70709
 
70710
+ /**
70711
+ * Get alternative shifts settings for a business unit
70712
+ *
70713
+ * @param {String} businessUnitId The ID of the business unit
70714
+ */
70715
+ getWorkforcemanagementBusinessunitAlternativeshiftsSettings(businessUnitId) {
70716
+ // verify the required parameter 'businessUnitId' is set
70717
+ if (businessUnitId === undefined || businessUnitId === null) {
70718
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitAlternativeshiftsSettings';
70719
+ }
70720
+
70721
+ return this.apiClient.callApi(
70722
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/settings',
70723
+ 'GET',
70724
+ { 'businessUnitId': businessUnitId },
70725
+ { },
70726
+ { },
70727
+ { },
70728
+ null,
70729
+ ['PureCloud OAuth'],
70730
+ ['application/json'],
70731
+ ['application/json']
70732
+ );
70733
+ }
70734
+
70735
+ /**
70736
+ * Get an alternative shifts trade in a business unit for a given trade ID
70737
+ *
70738
+ * @param {String} businessUnitId The ID of the business unit
70739
+ * @param {String} tradeId The ID of the alternative shift trade
70740
+ */
70741
+ getWorkforcemanagementBusinessunitAlternativeshiftsTrade(businessUnitId, tradeId) {
70742
+ // verify the required parameter 'businessUnitId' is set
70743
+ if (businessUnitId === undefined || businessUnitId === null) {
70744
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitAlternativeshiftsTrade';
70745
+ }
70746
+ // verify the required parameter 'tradeId' is set
70747
+ if (tradeId === undefined || tradeId === null) {
70748
+ throw 'Missing the required parameter "tradeId" when calling getWorkforcemanagementBusinessunitAlternativeshiftsTrade';
70749
+ }
70750
+
70751
+ return this.apiClient.callApi(
70752
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/trades/{tradeId}',
70753
+ 'GET',
70754
+ { 'businessUnitId': businessUnitId,'tradeId': tradeId },
70755
+ { },
70756
+ { },
70757
+ { },
70758
+ null,
70759
+ ['PureCloud OAuth'],
70760
+ ['application/json'],
70761
+ ['application/json']
70762
+ );
70763
+ }
70764
+
70765
+ /**
70766
+ * Query the status of an alternative shift search trade operation. Only the user who started the operation can query the status
70767
+ * Job details are only retained if the initial request returned a 202 ACCEPTED response
70768
+ * @param {String} businessUnitId The ID of the business unit
70769
+ * @param {String} jobId The ID of the job
70770
+ */
70771
+ getWorkforcemanagementBusinessunitAlternativeshiftsTradesSearchJob(businessUnitId, jobId) {
70772
+ // verify the required parameter 'businessUnitId' is set
70773
+ if (businessUnitId === undefined || businessUnitId === null) {
70774
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitAlternativeshiftsTradesSearchJob';
70775
+ }
70776
+ // verify the required parameter 'jobId' is set
70777
+ if (jobId === undefined || jobId === null) {
70778
+ throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementBusinessunitAlternativeshiftsTradesSearchJob';
70779
+ }
70780
+
70781
+ return this.apiClient.callApi(
70782
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/trades/search/jobs/{jobId}',
70783
+ 'GET',
70784
+ { 'businessUnitId': businessUnitId,'jobId': jobId },
70785
+ { },
70786
+ { },
70787
+ { },
70788
+ null,
70789
+ ['PureCloud OAuth'],
70790
+ ['application/json'],
70791
+ ['application/json']
70792
+ );
70793
+ }
70794
+
70085
70795
  /**
70086
70796
  * Get intraday planning groups for the given date
70087
70797
  *
@@ -71053,6 +71763,161 @@ class WorkforceManagementApi {
71053
71763
  );
71054
71764
  }
71055
71765
 
71766
+ /**
71767
+ * Get a work plan bid
71768
+ *
71769
+ * @param {String} businessUnitId The ID of the business unit
71770
+ * @param {String} bidId The id of the workplanbid
71771
+ */
71772
+ getWorkforcemanagementBusinessunitWorkplanbid(businessUnitId, bidId) {
71773
+ // verify the required parameter 'businessUnitId' is set
71774
+ if (businessUnitId === undefined || businessUnitId === null) {
71775
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWorkplanbid';
71776
+ }
71777
+ // verify the required parameter 'bidId' is set
71778
+ if (bidId === undefined || bidId === null) {
71779
+ throw 'Missing the required parameter "bidId" when calling getWorkforcemanagementBusinessunitWorkplanbid';
71780
+ }
71781
+
71782
+ return this.apiClient.callApi(
71783
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}',
71784
+ 'GET',
71785
+ { 'businessUnitId': businessUnitId,'bidId': bidId },
71786
+ { },
71787
+ { },
71788
+ { },
71789
+ null,
71790
+ ['PureCloud OAuth'],
71791
+ ['application/json'],
71792
+ ['application/json']
71793
+ );
71794
+ }
71795
+
71796
+ /**
71797
+ * Get a bid group by bid group Id
71798
+ *
71799
+ * @param {String} businessUnitId The ID of the business unit
71800
+ * @param {String} bidId The work plan bid id of the bid groups
71801
+ * @param {String} bidGroupId Work Plan Bid Group id
71802
+ */
71803
+ getWorkforcemanagementBusinessunitWorkplanbidGroup(businessUnitId, bidId, bidGroupId) {
71804
+ // verify the required parameter 'businessUnitId' is set
71805
+ if (businessUnitId === undefined || businessUnitId === null) {
71806
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWorkplanbidGroup';
71807
+ }
71808
+ // verify the required parameter 'bidId' is set
71809
+ if (bidId === undefined || bidId === null) {
71810
+ throw 'Missing the required parameter "bidId" when calling getWorkforcemanagementBusinessunitWorkplanbidGroup';
71811
+ }
71812
+ // verify the required parameter 'bidGroupId' is set
71813
+ if (bidGroupId === undefined || bidGroupId === null) {
71814
+ throw 'Missing the required parameter "bidGroupId" when calling getWorkforcemanagementBusinessunitWorkplanbidGroup';
71815
+ }
71816
+
71817
+ return this.apiClient.callApi(
71818
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}',
71819
+ 'GET',
71820
+ { 'businessUnitId': businessUnitId,'bidId': bidId,'bidGroupId': bidGroupId },
71821
+ { },
71822
+ { },
71823
+ { },
71824
+ null,
71825
+ ['PureCloud OAuth'],
71826
+ ['application/json'],
71827
+ ['application/json']
71828
+ );
71829
+ }
71830
+
71831
+ /**
71832
+ * Gets the work plan preferences of all the agents in the work plan bid group
71833
+ *
71834
+ * @param {String} businessUnitId The ID of the business unit
71835
+ * @param {String} bidId The work plan bid id of the bid groups
71836
+ * @param {String} bidGroupId The ID of the work plan bid group
71837
+ */
71838
+ getWorkforcemanagementBusinessunitWorkplanbidGroupPreferences(businessUnitId, bidId, bidGroupId) {
71839
+ // verify the required parameter 'businessUnitId' is set
71840
+ if (businessUnitId === undefined || businessUnitId === null) {
71841
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWorkplanbidGroupPreferences';
71842
+ }
71843
+ // verify the required parameter 'bidId' is set
71844
+ if (bidId === undefined || bidId === null) {
71845
+ throw 'Missing the required parameter "bidId" when calling getWorkforcemanagementBusinessunitWorkplanbidGroupPreferences';
71846
+ }
71847
+ // verify the required parameter 'bidGroupId' is set
71848
+ if (bidGroupId === undefined || bidGroupId === null) {
71849
+ throw 'Missing the required parameter "bidGroupId" when calling getWorkforcemanagementBusinessunitWorkplanbidGroupPreferences';
71850
+ }
71851
+
71852
+ return this.apiClient.callApi(
71853
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}/preferences',
71854
+ 'GET',
71855
+ { 'businessUnitId': businessUnitId,'bidId': bidId,'bidGroupId': bidGroupId },
71856
+ { },
71857
+ { },
71858
+ { },
71859
+ null,
71860
+ ['PureCloud OAuth'],
71861
+ ['application/json'],
71862
+ ['application/json']
71863
+ );
71864
+ }
71865
+
71866
+ /**
71867
+ * Get summary of bid groups that belong to a work plan bid
71868
+ *
71869
+ * @param {String} businessUnitId The ID of the business unit
71870
+ * @param {String} bidId The work plan bid id of the bid groups
71871
+ */
71872
+ getWorkforcemanagementBusinessunitWorkplanbidGroupsSummary(businessUnitId, bidId) {
71873
+ // verify the required parameter 'businessUnitId' is set
71874
+ if (businessUnitId === undefined || businessUnitId === null) {
71875
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWorkplanbidGroupsSummary';
71876
+ }
71877
+ // verify the required parameter 'bidId' is set
71878
+ if (bidId === undefined || bidId === null) {
71879
+ throw 'Missing the required parameter "bidId" when calling getWorkforcemanagementBusinessunitWorkplanbidGroupsSummary';
71880
+ }
71881
+
71882
+ return this.apiClient.callApi(
71883
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/summary',
71884
+ 'GET',
71885
+ { 'businessUnitId': businessUnitId,'bidId': bidId },
71886
+ { },
71887
+ { },
71888
+ { },
71889
+ null,
71890
+ ['PureCloud OAuth'],
71891
+ ['application/json'],
71892
+ ['application/json']
71893
+ );
71894
+ }
71895
+
71896
+ /**
71897
+ * Get list of work plan bids
71898
+ *
71899
+ * @param {String} businessUnitId The ID of the business unit
71900
+ */
71901
+ getWorkforcemanagementBusinessunitWorkplanbids(businessUnitId) {
71902
+ // verify the required parameter 'businessUnitId' is set
71903
+ if (businessUnitId === undefined || businessUnitId === null) {
71904
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWorkplanbids';
71905
+ }
71906
+
71907
+ return this.apiClient.callApi(
71908
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids',
71909
+ 'GET',
71910
+ { 'businessUnitId': businessUnitId },
71911
+ { },
71912
+ { },
71913
+ { },
71914
+ null,
71915
+ ['PureCloud OAuth'],
71916
+ ['application/json'],
71917
+ ['application/json']
71918
+ );
71919
+ }
71920
+
71056
71921
  /**
71057
71922
  * Get business units
71058
71923
  *
@@ -72147,6 +73012,101 @@ class WorkforceManagementApi {
72147
73012
  );
72148
73013
  }
72149
73014
 
73015
+ /**
73016
+ * Get work plan bid ranks for a user
73017
+ *
73018
+ * @param {String} userId The userId to whom the work plan bid ranks apply.
73019
+ */
73020
+ getWorkforcemanagementUserWorkplanbidranks(userId) {
73021
+ // verify the required parameter 'userId' is set
73022
+ if (userId === undefined || userId === null) {
73023
+ throw 'Missing the required parameter "userId" when calling getWorkforcemanagementUserWorkplanbidranks';
73024
+ }
73025
+
73026
+ return this.apiClient.callApi(
73027
+ '/api/v2/workforcemanagement/users/{userId}/workplanbidranks',
73028
+ 'GET',
73029
+ { 'userId': userId },
73030
+ { },
73031
+ { },
73032
+ { },
73033
+ null,
73034
+ ['PureCloud OAuth'],
73035
+ ['application/json'],
73036
+ ['application/json']
73037
+ );
73038
+ }
73039
+
73040
+ /**
73041
+ * Gets an agent's work plan bidding preference
73042
+ *
73043
+ * @param {String} bidId The ID of the work plan bid
73044
+ */
73045
+ getWorkforcemanagementWorkplanbidPreferences(bidId) {
73046
+ // verify the required parameter 'bidId' is set
73047
+ if (bidId === undefined || bidId === null) {
73048
+ throw 'Missing the required parameter "bidId" when calling getWorkforcemanagementWorkplanbidPreferences';
73049
+ }
73050
+
73051
+ return this.apiClient.callApi(
73052
+ '/api/v2/workforcemanagement/workplanbids/{bidId}/preferences',
73053
+ 'GET',
73054
+ { 'bidId': bidId },
73055
+ { },
73056
+ { },
73057
+ { },
73058
+ null,
73059
+ ['PureCloud OAuth'],
73060
+ ['application/json'],
73061
+ ['application/json']
73062
+ );
73063
+ }
73064
+
73065
+ /**
73066
+ * Gets an agent's work plans for a bid
73067
+ *
73068
+ * @param {String} bidId The ID of the work plan bid
73069
+ */
73070
+ getWorkforcemanagementWorkplanbidWorkplans(bidId) {
73071
+ // verify the required parameter 'bidId' is set
73072
+ if (bidId === undefined || bidId === null) {
73073
+ throw 'Missing the required parameter "bidId" when calling getWorkforcemanagementWorkplanbidWorkplans';
73074
+ }
73075
+
73076
+ return this.apiClient.callApi(
73077
+ '/api/v2/workforcemanagement/workplanbids/{bidId}/workplans',
73078
+ 'GET',
73079
+ { 'bidId': bidId },
73080
+ { },
73081
+ { },
73082
+ { },
73083
+ null,
73084
+ ['PureCloud OAuth'],
73085
+ ['application/json'],
73086
+ ['application/json']
73087
+ );
73088
+ }
73089
+
73090
+ /**
73091
+ * Gets the list of work plan bids that belong to an agent
73092
+ *
73093
+ */
73094
+ getWorkforcemanagementWorkplanbids() {
73095
+
73096
+ return this.apiClient.callApi(
73097
+ '/api/v2/workforcemanagement/workplanbids',
73098
+ 'GET',
73099
+ { },
73100
+ { },
73101
+ { },
73102
+ { },
73103
+ null,
73104
+ ['PureCloud OAuth'],
73105
+ ['application/json'],
73106
+ ['application/json']
73107
+ );
73108
+ }
73109
+
72150
73110
  /**
72151
73111
  * Update an adherence explanation
72152
73112
  *
@@ -72182,6 +73142,60 @@ class WorkforceManagementApi {
72182
73142
  );
72183
73143
  }
72184
73144
 
73145
+ /**
73146
+ * Update my alternative shifts trade by trade ID
73147
+ *
73148
+ * @param {String} tradeId The ID of the alternative shift trade
73149
+ * @param {Object} opts Optional parameters
73150
+ * @param {Object} opts.body body
73151
+ */
73152
+ patchWorkforcemanagementAlternativeshiftsTrade(tradeId, opts) {
73153
+ opts = opts || {};
73154
+
73155
+ // verify the required parameter 'tradeId' is set
73156
+ if (tradeId === undefined || tradeId === null) {
73157
+ throw 'Missing the required parameter "tradeId" when calling patchWorkforcemanagementAlternativeshiftsTrade';
73158
+ }
73159
+
73160
+ return this.apiClient.callApi(
73161
+ '/api/v2/workforcemanagement/alternativeshifts/trades/{tradeId}',
73162
+ 'PATCH',
73163
+ { 'tradeId': tradeId },
73164
+ { },
73165
+ { },
73166
+ { },
73167
+ opts['body'],
73168
+ ['PureCloud OAuth'],
73169
+ ['application/json'],
73170
+ ['application/json']
73171
+ );
73172
+ }
73173
+
73174
+ /**
73175
+ * Bulk update alternative shift trade states
73176
+ *
73177
+ * @param {Object} body The request body
73178
+ */
73179
+ patchWorkforcemanagementAlternativeshiftsTradesStateJobs(body) {
73180
+ // verify the required parameter 'body' is set
73181
+ if (body === undefined || body === null) {
73182
+ throw 'Missing the required parameter "body" when calling patchWorkforcemanagementAlternativeshiftsTradesStateJobs';
73183
+ }
73184
+
73185
+ return this.apiClient.callApi(
73186
+ '/api/v2/workforcemanagement/alternativeshifts/trades/state/jobs',
73187
+ 'PATCH',
73188
+ { },
73189
+ { },
73190
+ { },
73191
+ { },
73192
+ body,
73193
+ ['PureCloud OAuth'],
73194
+ ['application/json'],
73195
+ ['application/json']
73196
+ );
73197
+ }
73198
+
72185
73199
  /**
72186
73200
  * Update business unit
72187
73201
  *
@@ -72281,6 +73295,35 @@ class WorkforceManagementApi {
72281
73295
  );
72282
73296
  }
72283
73297
 
73298
+ /**
73299
+ * Update alternative shifts settings for a business unit
73300
+ *
73301
+ * @param {String} businessUnitId The ID of the business unit
73302
+ * @param {Object} opts Optional parameters
73303
+ * @param {Object} opts.body body
73304
+ */
73305
+ patchWorkforcemanagementBusinessunitAlternativeshiftsSettings(businessUnitId, opts) {
73306
+ opts = opts || {};
73307
+
73308
+ // verify the required parameter 'businessUnitId' is set
73309
+ if (businessUnitId === undefined || businessUnitId === null) {
73310
+ throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitAlternativeshiftsSettings';
73311
+ }
73312
+
73313
+ return this.apiClient.callApi(
73314
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/settings',
73315
+ 'PATCH',
73316
+ { 'businessUnitId': businessUnitId },
73317
+ { },
73318
+ { },
73319
+ { },
73320
+ opts['body'],
73321
+ ['PureCloud OAuth'],
73322
+ ['application/json'],
73323
+ ['application/json']
73324
+ );
73325
+ }
73326
+
72284
73327
  /**
72285
73328
  * Updates the planning group
72286
73329
  *
@@ -72451,6 +73494,119 @@ class WorkforceManagementApi {
72451
73494
  );
72452
73495
  }
72453
73496
 
73497
+ /**
73498
+ * Update work plan bid
73499
+ *
73500
+ * @param {String} businessUnitId The ID of the business unit
73501
+ * @param {String} bidId The id of the workplanbid
73502
+ * @param {Object} body The work plan bid to be updated
73503
+ */
73504
+ patchWorkforcemanagementBusinessunitWorkplanbid(businessUnitId, bidId, body) {
73505
+ // verify the required parameter 'businessUnitId' is set
73506
+ if (businessUnitId === undefined || businessUnitId === null) {
73507
+ throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitWorkplanbid';
73508
+ }
73509
+ // verify the required parameter 'bidId' is set
73510
+ if (bidId === undefined || bidId === null) {
73511
+ throw 'Missing the required parameter "bidId" when calling patchWorkforcemanagementBusinessunitWorkplanbid';
73512
+ }
73513
+ // verify the required parameter 'body' is set
73514
+ if (body === undefined || body === null) {
73515
+ throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitWorkplanbid';
73516
+ }
73517
+
73518
+ return this.apiClient.callApi(
73519
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}',
73520
+ 'PATCH',
73521
+ { 'businessUnitId': businessUnitId,'bidId': bidId },
73522
+ { },
73523
+ { },
73524
+ { },
73525
+ body,
73526
+ ['PureCloud OAuth'],
73527
+ ['application/json'],
73528
+ ['application/json']
73529
+ );
73530
+ }
73531
+
73532
+ /**
73533
+ * Update a bid group by bid group Id
73534
+ *
73535
+ * @param {String} businessUnitId The ID of the business unit
73536
+ * @param {String} bidId The work plan bid id of the bid groups
73537
+ * @param {String} bidGroupId Work Plan Bid Group id
73538
+ * @param {Object} opts Optional parameters
73539
+ * @param {Object} opts.body body
73540
+ */
73541
+ patchWorkforcemanagementBusinessunitWorkplanbidGroup(businessUnitId, bidId, bidGroupId, opts) {
73542
+ opts = opts || {};
73543
+
73544
+ // verify the required parameter 'businessUnitId' is set
73545
+ if (businessUnitId === undefined || businessUnitId === null) {
73546
+ throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroup';
73547
+ }
73548
+ // verify the required parameter 'bidId' is set
73549
+ if (bidId === undefined || bidId === null) {
73550
+ throw 'Missing the required parameter "bidId" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroup';
73551
+ }
73552
+ // verify the required parameter 'bidGroupId' is set
73553
+ if (bidGroupId === undefined || bidGroupId === null) {
73554
+ throw 'Missing the required parameter "bidGroupId" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroup';
73555
+ }
73556
+
73557
+ return this.apiClient.callApi(
73558
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}',
73559
+ 'PATCH',
73560
+ { 'businessUnitId': businessUnitId,'bidId': bidId,'bidGroupId': bidGroupId },
73561
+ { },
73562
+ { },
73563
+ { },
73564
+ opts['body'],
73565
+ ['PureCloud OAuth'],
73566
+ ['application/json'],
73567
+ ['application/json']
73568
+ );
73569
+ }
73570
+
73571
+ /**
73572
+ * Overrides the assigned work plan for the specified agents
73573
+ *
73574
+ * @param {String} businessUnitId The ID of the business unit
73575
+ * @param {String} bidId The work plan bid id of the bid groups
73576
+ * @param {String} bidGroupId The ID of the work plan bid group
73577
+ * @param {Object} opts Optional parameters
73578
+ * @param {Object} opts.body body
73579
+ */
73580
+ patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences(businessUnitId, bidId, bidGroupId, opts) {
73581
+ opts = opts || {};
73582
+
73583
+ // verify the required parameter 'businessUnitId' is set
73584
+ if (businessUnitId === undefined || businessUnitId === null) {
73585
+ throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences';
73586
+ }
73587
+ // verify the required parameter 'bidId' is set
73588
+ if (bidId === undefined || bidId === null) {
73589
+ throw 'Missing the required parameter "bidId" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences';
73590
+ }
73591
+ // verify the required parameter 'bidGroupId' is set
73592
+ if (bidGroupId === undefined || bidGroupId === null) {
73593
+ throw 'Missing the required parameter "bidGroupId" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences';
73594
+ }
73595
+
73596
+ return this.apiClient.callApi(
73597
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}/preferences',
73598
+ 'PATCH',
73599
+ { 'businessUnitId': businessUnitId,'bidId': bidId,'bidGroupId': bidGroupId },
73600
+ { },
73601
+ { },
73602
+ { },
73603
+ opts['body'],
73604
+ ['PureCloud OAuth'],
73605
+ ['application/json'],
73606
+ ['application/json']
73607
+ );
73608
+ }
73609
+
72454
73610
  /**
72455
73611
  * Update the requested management unit
72456
73612
  *
@@ -72793,6 +73949,89 @@ class WorkforceManagementApi {
72793
73949
  );
72794
73950
  }
72795
73951
 
73952
+ /**
73953
+ * Update work plan bid ranks for a user
73954
+ *
73955
+ * @param {String} userId The userId to whom the work plan bid ranks apply.
73956
+ * @param {Object} opts Optional parameters
73957
+ * @param {Object} opts.body body
73958
+ */
73959
+ patchWorkforcemanagementUserWorkplanbidranks(userId, opts) {
73960
+ opts = opts || {};
73961
+
73962
+ // verify the required parameter 'userId' is set
73963
+ if (userId === undefined || userId === null) {
73964
+ throw 'Missing the required parameter "userId" when calling patchWorkforcemanagementUserWorkplanbidranks';
73965
+ }
73966
+
73967
+ return this.apiClient.callApi(
73968
+ '/api/v2/workforcemanagement/users/{userId}/workplanbidranks',
73969
+ 'PATCH',
73970
+ { 'userId': userId },
73971
+ { },
73972
+ { },
73973
+ { },
73974
+ opts['body'],
73975
+ ['PureCloud OAuth'],
73976
+ ['application/json'],
73977
+ ['application/json']
73978
+ );
73979
+ }
73980
+
73981
+ /**
73982
+ * Update bulk work plan bid ranks on users. Max 50 users can be updated at a time.
73983
+ *
73984
+ * @param {Array.<Object>} body Users
73985
+ */
73986
+ patchWorkforcemanagementUsersWorkplanbidranksBulk(body) {
73987
+ // verify the required parameter 'body' is set
73988
+ if (body === undefined || body === null) {
73989
+ throw 'Missing the required parameter "body" when calling patchWorkforcemanagementUsersWorkplanbidranksBulk';
73990
+ }
73991
+
73992
+ return this.apiClient.callApi(
73993
+ '/api/v2/workforcemanagement/users/workplanbidranks/bulk',
73994
+ 'PATCH',
73995
+ { },
73996
+ { },
73997
+ { },
73998
+ { },
73999
+ body,
74000
+ ['PureCloud OAuth'],
74001
+ ['application/json'],
74002
+ ['application/json']
74003
+ );
74004
+ }
74005
+
74006
+ /**
74007
+ * Update an agent's work plan bidding preference
74008
+ *
74009
+ * @param {String} bidId The ID of the work plan bid
74010
+ * @param {Object} opts Optional parameters
74011
+ * @param {Object} opts.body body
74012
+ */
74013
+ patchWorkforcemanagementWorkplanbidPreferences(bidId, opts) {
74014
+ opts = opts || {};
74015
+
74016
+ // verify the required parameter 'bidId' is set
74017
+ if (bidId === undefined || bidId === null) {
74018
+ throw 'Missing the required parameter "bidId" when calling patchWorkforcemanagementWorkplanbidPreferences';
74019
+ }
74020
+
74021
+ return this.apiClient.callApi(
74022
+ '/api/v2/workforcemanagement/workplanbids/{bidId}/preferences',
74023
+ 'PATCH',
74024
+ { 'bidId': bidId },
74025
+ { },
74026
+ { },
74027
+ { },
74028
+ opts['body'],
74029
+ ['PureCloud OAuth'],
74030
+ ['application/json'],
74031
+ ['application/json']
74032
+ );
74033
+ }
74034
+
72796
74035
  /**
72797
74036
  * Submit an adherence explanation for the current user
72798
74037
  *
@@ -73059,6 +74298,81 @@ class WorkforceManagementApi {
73059
74298
  );
73060
74299
  }
73061
74300
 
74301
+ /**
74302
+ * Request a list of alternative shift offers for a given schedule
74303
+ *
74304
+ * @param {Object} body The request body
74305
+ */
74306
+ postWorkforcemanagementAlternativeshiftsOffersJobs(body) {
74307
+ // verify the required parameter 'body' is set
74308
+ if (body === undefined || body === null) {
74309
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementAlternativeshiftsOffersJobs';
74310
+ }
74311
+
74312
+ return this.apiClient.callApi(
74313
+ '/api/v2/workforcemanagement/alternativeshifts/offers/jobs',
74314
+ 'POST',
74315
+ { },
74316
+ { },
74317
+ { },
74318
+ { },
74319
+ body,
74320
+ ['PureCloud OAuth'],
74321
+ ['application/json'],
74322
+ ['application/json']
74323
+ );
74324
+ }
74325
+
74326
+ /**
74327
+ * Request a search of alternative shift offers for a given shift
74328
+ *
74329
+ * @param {Object} body The request body
74330
+ */
74331
+ postWorkforcemanagementAlternativeshiftsOffersSearchJobs(body) {
74332
+ // verify the required parameter 'body' is set
74333
+ if (body === undefined || body === null) {
74334
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementAlternativeshiftsOffersSearchJobs';
74335
+ }
74336
+
74337
+ return this.apiClient.callApi(
74338
+ '/api/v2/workforcemanagement/alternativeshifts/offers/search/jobs',
74339
+ 'POST',
74340
+ { },
74341
+ { },
74342
+ { },
74343
+ { },
74344
+ body,
74345
+ ['PureCloud OAuth'],
74346
+ ['application/json'],
74347
+ ['application/json']
74348
+ );
74349
+ }
74350
+
74351
+ /**
74352
+ * Create my alternative shift trade using an existing offer's jobId
74353
+ *
74354
+ * @param {Object} body The request body
74355
+ */
74356
+ postWorkforcemanagementAlternativeshiftsTrades(body) {
74357
+ // verify the required parameter 'body' is set
74358
+ if (body === undefined || body === null) {
74359
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementAlternativeshiftsTrades';
74360
+ }
74361
+
74362
+ return this.apiClient.callApi(
74363
+ '/api/v2/workforcemanagement/alternativeshifts/trades',
74364
+ 'POST',
74365
+ { },
74366
+ { },
74367
+ { },
74368
+ { },
74369
+ body,
74370
+ ['PureCloud OAuth'],
74371
+ ['application/json'],
74372
+ ['application/json']
74373
+ );
74374
+ }
74375
+
73062
74376
  /**
73063
74377
  * Create a new activity code
73064
74378
  *
@@ -73216,6 +74530,40 @@ class WorkforceManagementApi {
73216
74530
  );
73217
74531
  }
73218
74532
 
74533
+ /**
74534
+ * List alternative shifts trades for a given management unit or agent
74535
+ *
74536
+ * @param {String} businessUnitId The ID of the business unit
74537
+ * @param {Object} body The request body
74538
+ * @param {Object} opts Optional parameters
74539
+ * @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
74540
+ */
74541
+ postWorkforcemanagementBusinessunitAlternativeshiftsTradesSearch(businessUnitId, body, opts) {
74542
+ opts = opts || {};
74543
+
74544
+ // verify the required parameter 'businessUnitId' is set
74545
+ if (businessUnitId === undefined || businessUnitId === null) {
74546
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitAlternativeshiftsTradesSearch';
74547
+ }
74548
+ // verify the required parameter 'body' is set
74549
+ if (body === undefined || body === null) {
74550
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitAlternativeshiftsTradesSearch';
74551
+ }
74552
+
74553
+ return this.apiClient.callApi(
74554
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/trades/search',
74555
+ 'POST',
74556
+ { 'businessUnitId': businessUnitId },
74557
+ { 'forceAsync': opts['forceAsync'] },
74558
+ { },
74559
+ { },
74560
+ body,
74561
+ ['PureCloud OAuth'],
74562
+ ['application/json'],
74563
+ ['application/json']
74564
+ );
74565
+ }
74566
+
73219
74567
  /**
73220
74568
  * Get intraday data for the given date for the requested planningGroupIds
73221
74569
  *
@@ -74025,6 +75373,103 @@ class WorkforceManagementApi {
74025
75373
  );
74026
75374
  }
74027
75375
 
75376
+ /**
75377
+ * Copy a work plan bid
75378
+ *
75379
+ * @param {String} businessUnitId The ID of the business unit
75380
+ * @param {String} bidId The ID of the work plan bid to copy
75381
+ * @param {Object} opts Optional parameters
75382
+ * @param {Object} opts.body body
75383
+ */
75384
+ postWorkforcemanagementBusinessunitWorkplanbidCopy(businessUnitId, bidId, opts) {
75385
+ opts = opts || {};
75386
+
75387
+ // verify the required parameter 'businessUnitId' is set
75388
+ if (businessUnitId === undefined || businessUnitId === null) {
75389
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWorkplanbidCopy';
75390
+ }
75391
+ // verify the required parameter 'bidId' is set
75392
+ if (bidId === undefined || bidId === null) {
75393
+ throw 'Missing the required parameter "bidId" when calling postWorkforcemanagementBusinessunitWorkplanbidCopy';
75394
+ }
75395
+
75396
+ return this.apiClient.callApi(
75397
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/copy',
75398
+ 'POST',
75399
+ { 'businessUnitId': businessUnitId,'bidId': bidId },
75400
+ { },
75401
+ { },
75402
+ { },
75403
+ opts['body'],
75404
+ ['PureCloud OAuth'],
75405
+ ['application/json'],
75406
+ ['application/json']
75407
+ );
75408
+ }
75409
+
75410
+ /**
75411
+ * Add a bid group in a given work plan bid
75412
+ *
75413
+ * @param {String} businessUnitId The ID of the business unit
75414
+ * @param {String} bidId The work plan bid id of the bid groups
75415
+ * @param {Object} opts Optional parameters
75416
+ * @param {Object} opts.body body
75417
+ */
75418
+ postWorkforcemanagementBusinessunitWorkplanbidGroups(businessUnitId, bidId, opts) {
75419
+ opts = opts || {};
75420
+
75421
+ // verify the required parameter 'businessUnitId' is set
75422
+ if (businessUnitId === undefined || businessUnitId === null) {
75423
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWorkplanbidGroups';
75424
+ }
75425
+ // verify the required parameter 'bidId' is set
75426
+ if (bidId === undefined || bidId === null) {
75427
+ throw 'Missing the required parameter "bidId" when calling postWorkforcemanagementBusinessunitWorkplanbidGroups';
75428
+ }
75429
+
75430
+ return this.apiClient.callApi(
75431
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups',
75432
+ 'POST',
75433
+ { 'businessUnitId': businessUnitId,'bidId': bidId },
75434
+ { },
75435
+ { },
75436
+ { },
75437
+ opts['body'],
75438
+ ['PureCloud OAuth'],
75439
+ ['application/json'],
75440
+ ['application/json']
75441
+ );
75442
+ }
75443
+
75444
+ /**
75445
+ * Create a new work plan bid
75446
+ *
75447
+ * @param {String} businessUnitId The ID of the business unit
75448
+ * @param {Object} opts Optional parameters
75449
+ * @param {Object} opts.body The work plan bid to be created
75450
+ */
75451
+ postWorkforcemanagementBusinessunitWorkplanbids(businessUnitId, opts) {
75452
+ opts = opts || {};
75453
+
75454
+ // verify the required parameter 'businessUnitId' is set
75455
+ if (businessUnitId === undefined || businessUnitId === null) {
75456
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWorkplanbids';
75457
+ }
75458
+
75459
+ return this.apiClient.callApi(
75460
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids',
75461
+ 'POST',
75462
+ { 'businessUnitId': businessUnitId },
75463
+ { },
75464
+ { },
75465
+ { },
75466
+ opts['body'],
75467
+ ['PureCloud OAuth'],
75468
+ ['application/json'],
75469
+ ['application/json']
75470
+ );
75471
+ }
75472
+
74028
75473
  /**
74029
75474
  * Add a new business unit
74030
75475
  * It may take a minute or two for a new business unit to be available for api operations
@@ -75294,7 +76739,7 @@ class WorkforceManagementApi {
75294
76739
  * </pre>
75295
76740
  * </p>
75296
76741
  * @module purecloud-platform-client-v2/index
75297
- * @version 199.0.0
76742
+ * @version 201.0.0
75298
76743
  */
75299
76744
  class platformClient {
75300
76745
  constructor() {