purecloud-platform-client-v2 200.0.0 → 202.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 +1349 -125
  3. package/dist/web-amd/purecloud-platform-client-v2.js +1349 -125
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +432 -133
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +548 -165
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +1121 -241
  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 +1 -1
  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 +1 -1
  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 +56 -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 +2 -2
  60. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -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 +32 -2
  79. package/src/purecloud-platform-client-v2/api/UsersApi.js +4 -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 -33
  87. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -402,7 +402,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
402
402
 
403
403
  /**
404
404
  * @module purecloud-platform-client-v2/ApiClient
405
- * @version 200.0.0
405
+ * @version 202.0.0
406
406
  */
407
407
  class ApiClient {
408
408
  /**
@@ -1824,7 +1824,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
1824
1824
  /**
1825
1825
  * AgentUI service.
1826
1826
  * @module purecloud-platform-client-v2/api/AgentUIApi
1827
- * @version 200.0.0
1827
+ * @version 202.0.0
1828
1828
  */
1829
1829
 
1830
1830
  /**
@@ -1955,7 +1955,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
1955
1955
  /**
1956
1956
  * Alerting service.
1957
1957
  * @module purecloud-platform-client-v2/api/AlertingApi
1958
- * @version 200.0.0
1958
+ * @version 202.0.0
1959
1959
  */
1960
1960
 
1961
1961
  /**
@@ -2616,7 +2616,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2616
2616
  /**
2617
2617
  * Analytics service.
2618
2618
  * @module purecloud-platform-client-v2/api/AnalyticsApi
2619
- * @version 200.0.0
2619
+ * @version 202.0.0
2620
2620
  */
2621
2621
 
2622
2622
  /**
@@ -4677,8 +4677,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
4677
4677
  }
4678
4678
 
4679
4679
  /**
4680
- * Query for limits rate limit aggregates. Data populated when limits are exceeded or are close to being exceeded. Not a source of truth for limits hit but a best effort estimate.
4681
- * The max property can be used to determine estimated rate limit value hit.
4680
+ * Query for limits rate limit aggregates. Data populated when limits reach 90% of the maximum. Not a source of truth for limits hit but a best effort estimate.
4681
+ * The max property can be used to determine estimated rate limit value hit. See https://developer.genesys.cloud/organization/organization/limits#available-limits for limits that are trackable (Operational Events Enabled).
4682
4682
  * @param {Object} body query
4683
4683
  */
4684
4684
  postAnalyticsRatelimitsAggregatesQuery(body) {
@@ -5228,7 +5228,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
5228
5228
  /**
5229
5229
  * Architect service.
5230
5230
  * @module purecloud-platform-client-v2/api/ArchitectApi
5231
- * @version 200.0.0
5231
+ * @version 202.0.0
5232
5232
  */
5233
5233
 
5234
5234
  /**
@@ -9374,7 +9374,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
9374
9374
  /**
9375
9375
  * Audit service.
9376
9376
  * @module purecloud-platform-client-v2/api/AuditApi
9377
- * @version 200.0.0
9377
+ * @version 202.0.0
9378
9378
  */
9379
9379
 
9380
9380
  /**
@@ -9575,7 +9575,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
9575
9575
  /**
9576
9576
  * Authorization service.
9577
9577
  * @module purecloud-platform-client-v2/api/AuthorizationApi
9578
- * @version 200.0.0
9578
+ * @version 202.0.0
9579
9579
  */
9580
9580
 
9581
9581
  /**
@@ -10813,7 +10813,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
10813
10813
  /**
10814
10814
  * Billing service.
10815
10815
  * @module purecloud-platform-client-v2/api/BillingApi
10816
- * @version 200.0.0
10816
+ * @version 202.0.0
10817
10817
  */
10818
10818
 
10819
10819
  /**
@@ -10893,7 +10893,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
10893
10893
  /**
10894
10894
  * CarrierServices service.
10895
10895
  * @module purecloud-platform-client-v2/api/CarrierServicesApi
10896
- * @version 200.0.0
10896
+ * @version 202.0.0
10897
10897
  */
10898
10898
 
10899
10899
  /**
@@ -10963,7 +10963,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
10963
10963
  /**
10964
10964
  * Chat service.
10965
10965
  * @module purecloud-platform-client-v2/api/ChatApi
10966
- * @version 200.0.0
10966
+ * @version 202.0.0
10967
10967
  */
10968
10968
 
10969
10969
  /**
@@ -11899,7 +11899,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
11899
11899
  /**
11900
11900
  * Coaching service.
11901
11901
  * @module purecloud-platform-client-v2/api/CoachingApi
11902
- * @version 200.0.0
11902
+ * @version 202.0.0
11903
11903
  */
11904
11904
 
11905
11905
  /**
@@ -12476,7 +12476,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
12476
12476
  /**
12477
12477
  * ContentManagement service.
12478
12478
  * @module purecloud-platform-client-v2/api/ContentManagementApi
12479
- * @version 200.0.0
12479
+ * @version 202.0.0
12480
12480
  */
12481
12481
 
12482
12482
  /**
@@ -13558,7 +13558,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
13558
13558
  /**
13559
13559
  * Conversations service.
13560
13560
  * @module purecloud-platform-client-v2/api/ConversationsApi
13561
- * @version 200.0.0
13561
+ * @version 202.0.0
13562
13562
  */
13563
13563
 
13564
13564
  /**
@@ -20671,7 +20671,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
20671
20671
  /**
20672
20672
  * DataExtensions service.
20673
20673
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
20674
- * @version 200.0.0
20674
+ * @version 202.0.0
20675
20675
  */
20676
20676
 
20677
20677
  /**
@@ -20757,7 +20757,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
20757
20757
  /**
20758
20758
  * Downloads service.
20759
20759
  * @module purecloud-platform-client-v2/api/DownloadsApi
20760
- * @version 200.0.0
20760
+ * @version 202.0.0
20761
20761
  */
20762
20762
 
20763
20763
  /**
@@ -20809,7 +20809,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
20809
20809
  /**
20810
20810
  * Emails service.
20811
20811
  * @module purecloud-platform-client-v2/api/EmailsApi
20812
- * @version 200.0.0
20812
+ * @version 202.0.0
20813
20813
  */
20814
20814
 
20815
20815
  /**
@@ -20874,7 +20874,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
20874
20874
  /**
20875
20875
  * EmployeeEngagement service.
20876
20876
  * @module purecloud-platform-client-v2/api/EmployeeEngagementApi
20877
- * @version 200.0.0
20877
+ * @version 202.0.0
20878
20878
  */
20879
20879
 
20880
20880
  /**
@@ -21025,7 +21025,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
21025
21025
  /**
21026
21026
  * Events service.
21027
21027
  * @module purecloud-platform-client-v2/api/EventsApi
21028
- * @version 200.0.0
21028
+ * @version 202.0.0
21029
21029
  */
21030
21030
 
21031
21031
  /**
@@ -21121,7 +21121,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
21121
21121
  /**
21122
21122
  * ExternalContacts service.
21123
21123
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
21124
- * @version 200.0.0
21124
+ * @version 202.0.0
21125
21125
  */
21126
21126
 
21127
21127
  /**
@@ -23083,7 +23083,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
23083
23083
  /**
23084
23084
  * Fax service.
23085
23085
  * @module purecloud-platform-client-v2/api/FaxApi
23086
- * @version 200.0.0
23086
+ * @version 202.0.0
23087
23087
  */
23088
23088
 
23089
23089
  /**
@@ -23298,7 +23298,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
23298
23298
  /**
23299
23299
  * Flows service.
23300
23300
  * @module purecloud-platform-client-v2/api/FlowsApi
23301
- * @version 200.0.0
23301
+ * @version 202.0.0
23302
23302
  */
23303
23303
 
23304
23304
  /**
@@ -23481,7 +23481,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
23481
23481
  /**
23482
23482
  * Gamification service.
23483
23483
  * @module purecloud-platform-client-v2/api/GamificationApi
23484
- * @version 200.0.0
23484
+ * @version 202.0.0
23485
23485
  */
23486
23486
 
23487
23487
  /**
@@ -25567,7 +25567,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25567
25567
  /**
25568
25568
  * GeneralDataProtectionRegulation service.
25569
25569
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
25570
- * @version 200.0.0
25570
+ * @version 202.0.0
25571
25571
  */
25572
25572
 
25573
25573
  /**
@@ -25697,7 +25697,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25697
25697
  /**
25698
25698
  * Geolocation service.
25699
25699
  * @module purecloud-platform-client-v2/api/GeolocationApi
25700
- * @version 200.0.0
25700
+ * @version 202.0.0
25701
25701
  */
25702
25702
 
25703
25703
  /**
@@ -25828,7 +25828,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25828
25828
  /**
25829
25829
  * Greetings service.
25830
25830
  * @module purecloud-platform-client-v2/api/GreetingsApi
25831
- * @version 200.0.0
25831
+ * @version 202.0.0
25832
25832
  */
25833
25833
 
25834
25834
  /**
@@ -26283,7 +26283,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26283
26283
  /**
26284
26284
  * Groups service.
26285
26285
  * @module purecloud-platform-client-v2/api/GroupsApi
26286
- * @version 200.0.0
26286
+ * @version 202.0.0
26287
26287
  */
26288
26288
 
26289
26289
  /**
@@ -26802,7 +26802,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26802
26802
  /**
26803
26803
  * IdentityProvider service.
26804
26804
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
26805
- * @version 200.0.0
26805
+ * @version 202.0.0
26806
26806
  */
26807
26807
 
26808
26808
  /**
@@ -27663,7 +27663,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
27663
27663
  /**
27664
27664
  * InfrastructureAsCode service.
27665
27665
  * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
27666
- * @version 200.0.0
27666
+ * @version 202.0.0
27667
27667
  */
27668
27668
 
27669
27669
  /**
@@ -27830,7 +27830,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
27830
27830
  /**
27831
27831
  * Integrations service.
27832
27832
  * @module purecloud-platform-client-v2/api/IntegrationsApi
27833
- * @version 200.0.0
27833
+ * @version 202.0.0
27834
27834
  */
27835
27835
 
27836
27836
  /**
@@ -28379,6 +28379,26 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
28379
28379
  );
28380
28380
  }
28381
28381
 
28382
+ /**
28383
+ * Retrieves basic info about trusted root CA certificates
28384
+ *
28385
+ */
28386
+ getIntegrationsActionsCertificatesTruststore() {
28387
+
28388
+ return this.apiClient.callApi(
28389
+ '/api/v2/integrations/actions/certificates/truststore',
28390
+ 'GET',
28391
+ { },
28392
+ { },
28393
+ { },
28394
+ { },
28395
+ null,
28396
+ ['PureCloud OAuth'],
28397
+ ['application/json'],
28398
+ ['application/json']
28399
+ );
28400
+ }
28401
+
28382
28402
  /**
28383
28403
  * Retrieves all action drafts associated with the filters passed in via query param.
28384
28404
  *
@@ -30182,7 +30202,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
30182
30202
  /**
30183
30203
  * Journey service.
30184
30204
  * @module purecloud-platform-client-v2/api/JourneyApi
30185
- * @version 200.0.0
30205
+ * @version 202.0.0
30186
30206
  */
30187
30207
 
30188
30208
  /**
@@ -31835,7 +31855,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
31835
31855
  /**
31836
31856
  * Knowledge service.
31837
31857
  * @module purecloud-platform-client-v2/api/KnowledgeApi
31838
- * @version 200.0.0
31858
+ * @version 202.0.0
31839
31859
  */
31840
31860
 
31841
31861
  /**
@@ -35079,7 +35099,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
35079
35099
  /**
35080
35100
  * LanguageUnderstanding service.
35081
35101
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
35082
- * @version 200.0.0
35102
+ * @version 202.0.0
35083
35103
  */
35084
35104
 
35085
35105
  /**
@@ -36113,7 +36133,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
36113
36133
  /**
36114
36134
  * Languages service.
36115
36135
  * @module purecloud-platform-client-v2/api/LanguagesApi
36116
- * @version 200.0.0
36136
+ * @version 202.0.0
36117
36137
  */
36118
36138
 
36119
36139
  /**
@@ -36335,7 +36355,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
36335
36355
  /**
36336
36356
  * Learning service.
36337
36357
  * @module purecloud-platform-client-v2/api/LearningApi
36338
- * @version 200.0.0
36358
+ * @version 202.0.0
36339
36359
  */
36340
36360
 
36341
36361
  /**
@@ -36481,7 +36501,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
36481
36501
  * @param {Object} opts.sortOrder Specifies result set sort order; if not specified, default sort order is descending (Desc) (default to Desc)
36482
36502
  * @param {Object} opts.sortBy Specifies which field to sort the results by, default sort is by recommendedCompletionDate
36483
36503
  * @param {Array.<String>} opts.userId Specifies the list of user IDs to be queried, up to 100 user IDs.
36484
- * @param {Array.<String>} opts.types Specifies the module types to filter by
36504
+ * @param {Array.<String>} opts.types Specifies the module types to filter by. Informational, AssessedContent and Assessment are deprecated
36485
36505
  * @param {Array.<String>} opts.states Specifies the assignment states to filter by
36486
36506
  * @param {Array.<String>} opts.expand Specifies the expand option for returning additional information
36487
36507
  */
@@ -36518,7 +36538,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
36518
36538
  * @param {Number} opts.maxPercentageScore The maximum assessment score for an assignment (completed with assessment) to be included in the results (inclusive)
36519
36539
  * @param {Object} opts.sortOrder Specifies result set sort order; if not specified, default sort order is descending (Desc) (default to Desc)
36520
36540
  * @param {Object} opts.sortBy Specifies which field to sort the results by, default sort is by recommendedCompletionDate
36521
- * @param {Array.<String>} opts.types Specifies the module types to filter by
36541
+ * @param {Array.<String>} opts.types Specifies the module types to filter by. Informational, AssessedContent and Assessment are deprecated
36522
36542
  * @param {Array.<String>} opts.states Specifies the assignment states to filter by
36523
36543
  * @param {Array.<String>} opts.expand Specifies the expand option for returning additional information
36524
36544
  */
@@ -36688,7 +36708,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
36688
36708
  *
36689
36709
  * @param {Object} opts Optional parameters
36690
36710
  * @param {Boolean} opts.isArchived Archive status (default to false)
36691
- * @param {Array.<String>} opts.types Specifies the module types.
36711
+ * @param {Array.<String>} opts.types Specifies the module types. Informational, AssessedContent and Assessment are deprecated
36692
36712
  * @param {Number} opts.pageSize Page size (default to 25)
36693
36713
  * @param {Number} opts.pageNumber Page number (default to 1)
36694
36714
  * @param {Object} opts.sortOrder Sort order (default to ascending)
@@ -37364,7 +37384,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
37364
37384
  /**
37365
37385
  * License service.
37366
37386
  * @module purecloud-platform-client-v2/api/LicenseApi
37367
- * @version 200.0.0
37387
+ * @version 202.0.0
37368
37388
  */
37369
37389
 
37370
37390
  /**
@@ -37602,7 +37622,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
37602
37622
  /**
37603
37623
  * Locations service.
37604
37624
  * @module purecloud-platform-client-v2/api/LocationsApi
37605
- * @version 200.0.0
37625
+ * @version 202.0.0
37606
37626
  */
37607
37627
 
37608
37628
  /**
@@ -37838,7 +37858,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
37838
37858
  /**
37839
37859
  * LogCapture service.
37840
37860
  * @module purecloud-platform-client-v2/api/LogCaptureApi
37841
- * @version 200.0.0
37861
+ * @version 202.0.0
37842
37862
  */
37843
37863
 
37844
37864
  /**
@@ -38038,7 +38058,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
38038
38058
  /**
38039
38059
  * Messaging service.
38040
38060
  * @module purecloud-platform-client-v2/api/MessagingApi
38041
- * @version 200.0.0
38061
+ * @version 202.0.0
38042
38062
  */
38043
38063
 
38044
38064
  /**
@@ -38397,7 +38417,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
38397
38417
  /**
38398
38418
  * MobileDevices service.
38399
38419
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
38400
- * @version 200.0.0
38420
+ * @version 202.0.0
38401
38421
  */
38402
38422
 
38403
38423
  /**
@@ -38548,7 +38568,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
38548
38568
  /**
38549
38569
  * Notifications service.
38550
38570
  * @module purecloud-platform-client-v2/api/NotificationsApi
38551
- * @version 200.0.0
38571
+ * @version 202.0.0
38552
38572
  */
38553
38573
 
38554
38574
  /**
@@ -38781,7 +38801,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
38781
38801
  /**
38782
38802
  * OAuth service.
38783
38803
  * @module purecloud-platform-client-v2/api/OAuthApi
38784
- * @version 200.0.0
38804
+ * @version 202.0.0
38785
38805
  */
38786
38806
 
38787
38807
  /**
@@ -39147,7 +39167,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39147
39167
  /**
39148
39168
  * Objects service.
39149
39169
  * @module purecloud-platform-client-v2/api/ObjectsApi
39150
- * @version 200.0.0
39170
+ * @version 202.0.0
39151
39171
  */
39152
39172
 
39153
39173
  /**
@@ -39417,7 +39437,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39417
39437
  /**
39418
39438
  * OperationalEvents service.
39419
39439
  * @module purecloud-platform-client-v2/api/OperationalEventsApi
39420
- * @version 200.0.0
39440
+ * @version 202.0.0
39421
39441
  */
39422
39442
 
39423
39443
  /**
@@ -39483,7 +39503,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39483
39503
  /**
39484
39504
  * Organization service.
39485
39505
  * @module purecloud-platform-client-v2/api/OrganizationApi
39486
- * @version 200.0.0
39506
+ * @version 202.0.0
39487
39507
  */
39488
39508
 
39489
39509
  /**
@@ -39704,6 +39724,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39704
39724
  );
39705
39725
  }
39706
39726
 
39727
+ /**
39728
+ * Get estimated limit counts for a namespace. This is not a source of truth for limit values but a record of estimates to facilitate limit threshold tracking.
39729
+ * See https://developer.genesys.cloud/organization/organization/limits#available-limits for limits that are trackable (Operational Events Enabled).
39730
+ * @param {String} namespaceName The namespace to get
39731
+ * @param {Object} opts Optional parameters
39732
+ * @param {String} opts.cursor Cursor provided when retrieving the last page
39733
+ * @param {String} opts.entityId entity id of the count
39734
+ * @param {String} opts.userId userid of the count
39735
+ */
39736
+ getOrganizationsLimitsNamespaceCounts(namespaceName, opts) {
39737
+ opts = opts || {};
39738
+
39739
+ // verify the required parameter 'namespaceName' is set
39740
+ if (namespaceName === undefined || namespaceName === null) {
39741
+ throw 'Missing the required parameter "namespaceName" when calling getOrganizationsLimitsNamespaceCounts';
39742
+ }
39743
+
39744
+ return this.apiClient.callApi(
39745
+ '/api/v2/organizations/limits/namespaces/{namespaceName}/counts',
39746
+ 'GET',
39747
+ { 'namespaceName': namespaceName },
39748
+ { 'cursor': opts['cursor'],'entityId': opts['entityId'],'userId': opts['userId'] },
39749
+ { },
39750
+ { },
39751
+ null,
39752
+ ['PureCloud OAuth'],
39753
+ ['application/json'],
39754
+ ['application/json']
39755
+ );
39756
+ }
39757
+
39707
39758
  /**
39708
39759
  * Get the default limits in a namespace for an organization
39709
39760
  *
@@ -39729,6 +39780,42 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39729
39780
  );
39730
39781
  }
39731
39782
 
39783
+ /**
39784
+ * Get estimated limit counts for a namespace and limit name. This is not a source of truth for limit values but a record of estimates to facilitate limit threshold tracking.
39785
+ * See https://developer.genesys.cloud/organization/organization/limits#available-limits for limits that are trackable (Operational Events Enabled).
39786
+ * @param {String} namespaceName The namespace to get
39787
+ * @param {String} limitName The limit to get
39788
+ * @param {Object} opts Optional parameters
39789
+ * @param {String} opts.entityId entity id of the count
39790
+ * @param {String} opts.userId userid of the count
39791
+ * @param {String} opts.cursor Cursor provided when retrieving the last page
39792
+ */
39793
+ getOrganizationsLimitsNamespaceLimitCounts(namespaceName, limitName, opts) {
39794
+ opts = opts || {};
39795
+
39796
+ // verify the required parameter 'namespaceName' is set
39797
+ if (namespaceName === undefined || namespaceName === null) {
39798
+ throw 'Missing the required parameter "namespaceName" when calling getOrganizationsLimitsNamespaceLimitCounts';
39799
+ }
39800
+ // verify the required parameter 'limitName' is set
39801
+ if (limitName === undefined || limitName === null) {
39802
+ throw 'Missing the required parameter "limitName" when calling getOrganizationsLimitsNamespaceLimitCounts';
39803
+ }
39804
+
39805
+ return this.apiClient.callApi(
39806
+ '/api/v2/organizations/limits/namespaces/{namespaceName}/limits/{limitName}/counts',
39807
+ 'GET',
39808
+ { 'namespaceName': namespaceName,'limitName': limitName },
39809
+ { 'entityId': opts['entityId'],'userId': opts['userId'],'cursor': opts['cursor'] },
39810
+ { },
39811
+ { },
39812
+ null,
39813
+ ['PureCloud OAuth'],
39814
+ ['application/json'],
39815
+ ['application/json']
39816
+ );
39817
+ }
39818
+
39732
39819
  /**
39733
39820
  * Get the available limit namespaces
39734
39821
  *
@@ -39958,7 +40045,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39958
40045
  /**
39959
40046
  * OrganizationAuthorization service.
39960
40047
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
39961
- * @version 200.0.0
40048
+ * @version 202.0.0
39962
40049
  */
39963
40050
 
39964
40051
  /**
@@ -41305,7 +41392,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
41305
41392
  /**
41306
41393
  * Outbound service.
41307
41394
  * @module purecloud-platform-client-v2/api/OutboundApi
41308
- * @version 200.0.0
41395
+ * @version 202.0.0
41309
41396
  */
41310
41397
 
41311
41398
  /**
@@ -42707,6 +42794,61 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
42707
42794
  );
42708
42795
  }
42709
42796
 
42797
+ /**
42798
+ * Get bulk operation job.
42799
+ *
42800
+ * @param {String} contactListId Contact List ID
42801
+ * @param {String} jobId Job ID
42802
+ */
42803
+ getOutboundContactlistContactsBulkJob(contactListId, jobId) {
42804
+ // verify the required parameter 'contactListId' is set
42805
+ if (contactListId === undefined || contactListId === null) {
42806
+ throw 'Missing the required parameter "contactListId" when calling getOutboundContactlistContactsBulkJob';
42807
+ }
42808
+ // verify the required parameter 'jobId' is set
42809
+ if (jobId === undefined || jobId === null) {
42810
+ throw 'Missing the required parameter "jobId" when calling getOutboundContactlistContactsBulkJob';
42811
+ }
42812
+
42813
+ return this.apiClient.callApi(
42814
+ '/api/v2/outbound/contactlists/{contactListId}/contacts/bulk/jobs/{jobId}',
42815
+ 'GET',
42816
+ { 'contactListId': contactListId,'jobId': jobId },
42817
+ { },
42818
+ { },
42819
+ { },
42820
+ null,
42821
+ ['PureCloud OAuth'],
42822
+ ['application/json'],
42823
+ ['application/json']
42824
+ );
42825
+ }
42826
+
42827
+ /**
42828
+ * Get 10 most recent bulk operation jobs associated with contact list.
42829
+ *
42830
+ * @param {String} contactListId Contact List ID
42831
+ */
42832
+ getOutboundContactlistContactsBulkJobs(contactListId) {
42833
+ // verify the required parameter 'contactListId' is set
42834
+ if (contactListId === undefined || contactListId === null) {
42835
+ throw 'Missing the required parameter "contactListId" when calling getOutboundContactlistContactsBulkJobs';
42836
+ }
42837
+
42838
+ return this.apiClient.callApi(
42839
+ '/api/v2/outbound/contactlists/{contactListId}/contacts/bulk/jobs',
42840
+ 'GET',
42841
+ { 'contactListId': contactListId },
42842
+ { },
42843
+ { },
42844
+ { },
42845
+ null,
42846
+ ['PureCloud OAuth'],
42847
+ ['application/json'],
42848
+ ['application/json']
42849
+ );
42850
+ }
42851
+
42710
42852
  /**
42711
42853
  * Get the URI of a contact list export.
42712
42854
  *
@@ -45667,7 +45809,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
45667
45809
  /**
45668
45810
  * Presence service.
45669
45811
  * @module purecloud-platform-client-v2/api/PresenceApi
45670
- * @version 200.0.0
45812
+ * @version 202.0.0
45671
45813
  */
45672
45814
 
45673
45815
  /**
@@ -46411,7 +46553,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
46411
46553
  /**
46412
46554
  * ProcessAutomation service.
46413
46555
  * @module purecloud-platform-client-v2/api/ProcessAutomationApi
46414
- * @version 200.0.0
46556
+ * @version 202.0.0
46415
46557
  */
46416
46558
 
46417
46559
  /**
@@ -46650,7 +46792,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
46650
46792
  /**
46651
46793
  * Quality service.
46652
46794
  * @module purecloud-platform-client-v2/api/QualityApi
46653
- * @version 200.0.0
46795
+ * @version 202.0.0
46654
46796
  */
46655
46797
 
46656
46798
  /**
@@ -48436,7 +48578,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
48436
48578
  /**
48437
48579
  * Recording service.
48438
48580
  * @module purecloud-platform-client-v2/api/RecordingApi
48439
- * @version 200.0.0
48581
+ * @version 202.0.0
48440
48582
  */
48441
48583
 
48442
48584
  /**
@@ -48921,7 +49063,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
48921
49063
  }
48922
49064
 
48923
49065
  /**
48924
- * Get the status and results for a batch request job, only the user that submitted the job may retrieve results
49066
+ * Get the status and results for a batch request job, only the user that submitted the job may retrieve results. Each result may contain either a URL to a recording or an error; additionally, a recording could be associated with multiple results.
48925
49067
  *
48926
49068
  * @param {String} jobId jobId
48927
49069
  */
@@ -50095,7 +50237,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50095
50237
  /**
50096
50238
  * ResponseManagement service.
50097
50239
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
50098
- * @version 200.0.0
50240
+ * @version 202.0.0
50099
50241
  */
50100
50242
 
50101
50243
  /**
@@ -50605,7 +50747,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50605
50747
  /**
50606
50748
  * Routing service.
50607
50749
  * @module purecloud-platform-client-v2/api/RoutingApi
50608
- * @version 200.0.0
50750
+ * @version 202.0.0
50609
50751
  */
50610
50752
 
50611
50753
  /**
@@ -54724,7 +54866,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
54724
54866
  /**
54725
54867
  * SCIM service.
54726
54868
  * @module purecloud-platform-client-v2/api/SCIMApi
54727
- * @version 200.0.0
54869
+ * @version 202.0.0
54728
54870
  */
54729
54871
 
54730
54872
  /**
@@ -55601,7 +55743,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
55601
55743
  /**
55602
55744
  * ScreenRecording service.
55603
55745
  * @module purecloud-platform-client-v2/api/ScreenRecordingApi
55604
- * @version 200.0.0
55746
+ * @version 202.0.0
55605
55747
  */
55606
55748
 
55607
55749
  /**
@@ -55646,7 +55788,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
55646
55788
  /**
55647
55789
  * Scripts service.
55648
55790
  * @module purecloud-platform-client-v2/api/ScriptsApi
55649
- * @version 200.0.0
55791
+ * @version 202.0.0
55650
55792
  */
55651
55793
 
55652
55794
  /**
@@ -56090,7 +56232,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
56090
56232
  /**
56091
56233
  * Search service.
56092
56234
  * @module purecloud-platform-client-v2/api/SearchApi
56093
- * @version 200.0.0
56235
+ * @version 202.0.0
56094
56236
  */
56095
56237
 
56096
56238
  /**
@@ -56779,7 +56921,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
56779
56921
  /**
56780
56922
  * Settings service.
56781
56923
  * @module purecloud-platform-client-v2/api/SettingsApi
56782
- * @version 200.0.0
56924
+ * @version 202.0.0
56783
56925
  */
56784
56926
 
56785
56927
  /**
@@ -57001,7 +57143,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
57001
57143
  /**
57002
57144
  * SpeechTextAnalytics service.
57003
57145
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
57004
- * @version 200.0.0
57146
+ * @version 202.0.0
57005
57147
  */
57006
57148
 
57007
57149
  /**
@@ -58279,7 +58421,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58279
58421
  /**
58280
58422
  * Stations service.
58281
58423
  * @module purecloud-platform-client-v2/api/StationsApi
58282
- * @version 200.0.0
58424
+ * @version 202.0.0
58283
58425
  */
58284
58426
 
58285
58427
  /**
@@ -58381,7 +58523,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58381
58523
  /**
58382
58524
  * Suggest service.
58383
58525
  * @module purecloud-platform-client-v2/api/SuggestApi
58384
- * @version 200.0.0
58526
+ * @version 202.0.0
58385
58527
  */
58386
58528
 
58387
58529
  /**
@@ -58520,7 +58662,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58520
58662
  /**
58521
58663
  * TaskManagement service.
58522
58664
  * @module purecloud-platform-client-v2/api/TaskManagementApi
58523
- * @version 200.0.0
58665
+ * @version 202.0.0
58524
58666
  */
58525
58667
 
58526
58668
  /**
@@ -59467,16 +59609,17 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
59467
59609
  * Update the attributes of a worktype
59468
59610
  *
59469
59611
  * @param {String} worktypeId Worktype id
59470
- * @param {Object} opts Optional parameters
59471
- * @param {Object} opts.body body
59612
+ * @param {Object} body Worktype
59472
59613
  */
59473
- patchTaskmanagementWorktype(worktypeId, opts) {
59474
- opts = opts || {};
59475
-
59614
+ patchTaskmanagementWorktype(worktypeId, body) {
59476
59615
  // verify the required parameter 'worktypeId' is set
59477
59616
  if (worktypeId === undefined || worktypeId === null) {
59478
59617
  throw 'Missing the required parameter "worktypeId" when calling patchTaskmanagementWorktype';
59479
59618
  }
59619
+ // verify the required parameter 'body' is set
59620
+ if (body === undefined || body === null) {
59621
+ throw 'Missing the required parameter "body" when calling patchTaskmanagementWorktype';
59622
+ }
59480
59623
 
59481
59624
  return this.apiClient.callApi(
59482
59625
  '/api/v2/taskmanagement/worktypes/{worktypeId}',
@@ -59485,7 +59628,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
59485
59628
  { },
59486
59629
  { },
59487
59630
  { },
59488
- opts['body'],
59631
+ body,
59489
59632
  ['PureCloud OAuth'],
59490
59633
  ['application/json'],
59491
59634
  ['application/json']
@@ -59497,12 +59640,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
59497
59640
  *
59498
59641
  * @param {String} worktypeId Worktype id
59499
59642
  * @param {String} statusId Status id
59500
- * @param {Object} opts Optional parameters
59501
- * @param {Object} opts.body body
59643
+ * @param {Object} body Status
59502
59644
  */
59503
- patchTaskmanagementWorktypeStatus(worktypeId, statusId, opts) {
59504
- opts = opts || {};
59505
-
59645
+ patchTaskmanagementWorktypeStatus(worktypeId, statusId, body) {
59506
59646
  // verify the required parameter 'worktypeId' is set
59507
59647
  if (worktypeId === undefined || worktypeId === null) {
59508
59648
  throw 'Missing the required parameter "worktypeId" when calling patchTaskmanagementWorktypeStatus';
@@ -59511,6 +59651,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
59511
59651
  if (statusId === undefined || statusId === null) {
59512
59652
  throw 'Missing the required parameter "statusId" when calling patchTaskmanagementWorktypeStatus';
59513
59653
  }
59654
+ // verify the required parameter 'body' is set
59655
+ if (body === undefined || body === null) {
59656
+ throw 'Missing the required parameter "body" when calling patchTaskmanagementWorktypeStatus';
59657
+ }
59514
59658
 
59515
59659
  return this.apiClient.callApi(
59516
59660
  '/api/v2/taskmanagement/worktypes/{worktypeId}/statuses/{statusId}',
@@ -59519,7 +59663,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
59519
59663
  { },
59520
59664
  { },
59521
59665
  { },
59522
- opts['body'],
59666
+ body,
59523
59667
  ['PureCloud OAuth'],
59524
59668
  ['application/json'],
59525
59669
  ['application/json']
@@ -59529,12 +59673,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
59529
59673
  /**
59530
59674
  * Create a workbin
59531
59675
  *
59532
- * @param {Object} opts Optional parameters
59533
- * @param {Object} opts.body body
59676
+ * @param {Object} body Workbin
59534
59677
  */
59535
- postTaskmanagementWorkbins(opts) {
59536
- opts = opts || {};
59537
-
59678
+ postTaskmanagementWorkbins(body) {
59679
+ // verify the required parameter 'body' is set
59680
+ if (body === undefined || body === null) {
59681
+ throw 'Missing the required parameter "body" when calling postTaskmanagementWorkbins';
59682
+ }
59538
59683
 
59539
59684
  return this.apiClient.callApi(
59540
59685
  '/api/v2/taskmanagement/workbins',
@@ -59543,7 +59688,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
59543
59688
  { },
59544
59689
  { },
59545
59690
  { },
59546
- opts['body'],
59691
+ body,
59547
59692
  ['PureCloud OAuth'],
59548
59693
  ['application/json'],
59549
59694
  ['application/json']
@@ -59759,16 +59904,17 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
59759
59904
  * Add a status to a worktype
59760
59905
  *
59761
59906
  * @param {String} worktypeId Worktype id
59762
- * @param {Object} opts Optional parameters
59763
- * @param {Object} opts.body body
59907
+ * @param {Object} body Status
59764
59908
  */
59765
- postTaskmanagementWorktypeStatuses(worktypeId, opts) {
59766
- opts = opts || {};
59767
-
59909
+ postTaskmanagementWorktypeStatuses(worktypeId, body) {
59768
59910
  // verify the required parameter 'worktypeId' is set
59769
59911
  if (worktypeId === undefined || worktypeId === null) {
59770
59912
  throw 'Missing the required parameter "worktypeId" when calling postTaskmanagementWorktypeStatuses';
59771
59913
  }
59914
+ // verify the required parameter 'body' is set
59915
+ if (body === undefined || body === null) {
59916
+ throw 'Missing the required parameter "body" when calling postTaskmanagementWorktypeStatuses';
59917
+ }
59772
59918
 
59773
59919
  return this.apiClient.callApi(
59774
59920
  '/api/v2/taskmanagement/worktypes/{worktypeId}/statuses',
@@ -59777,7 +59923,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
59777
59923
  { },
59778
59924
  { },
59779
59925
  { },
59780
- opts['body'],
59926
+ body,
59781
59927
  ['PureCloud OAuth'],
59782
59928
  ['application/json'],
59783
59929
  ['application/json']
@@ -59787,12 +59933,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
59787
59933
  /**
59788
59934
  * Create a worktype
59789
59935
  *
59790
- * @param {Object} opts Optional parameters
59791
- * @param {Object} opts.body body
59936
+ * @param {Object} body Worktype
59792
59937
  */
59793
- postTaskmanagementWorktypes(opts) {
59794
- opts = opts || {};
59795
-
59938
+ postTaskmanagementWorktypes(body) {
59939
+ // verify the required parameter 'body' is set
59940
+ if (body === undefined || body === null) {
59941
+ throw 'Missing the required parameter "body" when calling postTaskmanagementWorktypes';
59942
+ }
59796
59943
 
59797
59944
  return this.apiClient.callApi(
59798
59945
  '/api/v2/taskmanagement/worktypes',
@@ -59801,7 +59948,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
59801
59948
  { },
59802
59949
  { },
59803
59950
  { },
59804
- opts['body'],
59951
+ body,
59805
59952
  ['PureCloud OAuth'],
59806
59953
  ['application/json'],
59807
59954
  ['application/json']
@@ -59869,7 +60016,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
59869
60016
  /**
59870
60017
  * Teams service.
59871
60018
  * @module purecloud-platform-client-v2/api/TeamsApi
59872
- * @version 200.0.0
60019
+ * @version 202.0.0
59873
60020
  */
59874
60021
 
59875
60022
  /**
@@ -60170,7 +60317,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
60170
60317
  /**
60171
60318
  * Telephony service.
60172
60319
  * @module purecloud-platform-client-v2/api/TelephonyApi
60173
- * @version 200.0.0
60320
+ * @version 202.0.0
60174
60321
  */
60175
60322
 
60176
60323
  /**
@@ -60352,7 +60499,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
60352
60499
  /**
60353
60500
  * TelephonyProvidersEdge service.
60354
60501
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
60355
- * @version 200.0.0
60502
+ * @version 202.0.0
60356
60503
  */
60357
60504
 
60358
60505
  /**
@@ -63680,7 +63827,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
63680
63827
  /**
63681
63828
  * Textbots service.
63682
63829
  * @module purecloud-platform-client-v2/api/TextbotsApi
63683
- * @version 200.0.0
63830
+ * @version 202.0.0
63684
63831
  */
63685
63832
 
63686
63833
  /**
@@ -63808,7 +63955,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
63808
63955
  /**
63809
63956
  * Tokens service.
63810
63957
  * @module purecloud-platform-client-v2/api/TokensApi
63811
- * @version 200.0.0
63958
+ * @version 202.0.0
63812
63959
  */
63813
63960
 
63814
63961
  /**
@@ -63962,7 +64109,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
63962
64109
  /**
63963
64110
  * Uploads service.
63964
64111
  * @module purecloud-platform-client-v2/api/UploadsApi
63965
- * @version 200.0.0
64112
+ * @version 202.0.0
63966
64113
  */
63967
64114
 
63968
64115
  /**
@@ -64231,7 +64378,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
64231
64378
  /**
64232
64379
  * Usage service.
64233
64380
  * @module purecloud-platform-client-v2/api/UsageApi
64234
- * @version 200.0.0
64381
+ * @version 202.0.0
64235
64382
  */
64236
64383
 
64237
64384
  /**
@@ -64446,7 +64593,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
64446
64593
  /**
64447
64594
  * UserRecordings service.
64448
64595
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
64449
- * @version 200.0.0
64596
+ * @version 202.0.0
64450
64597
  */
64451
64598
 
64452
64599
  /**
@@ -64517,11 +64664,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
64517
64664
 
64518
64665
  /**
64519
64666
  * Download a user recording.
64520
- *
64667
+ * API should migrate to use GET api/v2/userrecordings/{recordingId}/transcoding
64521
64668
  * @param {String} recordingId User Recording ID
64522
64669
  * @param {Object} opts Optional parameters
64523
64670
  * @param {Object} opts.formatId The desired media format. (default to WEBM)
64524
64671
  * @param {Boolean} opts.async When set to true, api will return 202 response until the recording is ready for download
64672
+ * @deprecated
64525
64673
  */
64526
64674
  getUserrecordingMedia(recordingId, opts) {
64527
64675
  opts = opts || {};
@@ -64545,6 +64693,35 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
64545
64693
  );
64546
64694
  }
64547
64695
 
64696
+ /**
64697
+ * Download a user recording.
64698
+ *
64699
+ * @param {String} recordingId User Recording ID
64700
+ * @param {Object} opts Optional parameters
64701
+ * @param {Object} opts.formatId The desired media format. (default to WEBM)
64702
+ */
64703
+ getUserrecordingTranscoding(recordingId, opts) {
64704
+ opts = opts || {};
64705
+
64706
+ // verify the required parameter 'recordingId' is set
64707
+ if (recordingId === undefined || recordingId === null) {
64708
+ throw 'Missing the required parameter "recordingId" when calling getUserrecordingTranscoding';
64709
+ }
64710
+
64711
+ return this.apiClient.callApi(
64712
+ '/api/v2/userrecordings/{recordingId}/transcoding',
64713
+ 'GET',
64714
+ { 'recordingId': recordingId },
64715
+ { 'formatId': opts['formatId'] },
64716
+ { },
64717
+ { },
64718
+ null,
64719
+ ['PureCloud OAuth'],
64720
+ ['application/json'],
64721
+ ['application/json']
64722
+ );
64723
+ }
64724
+
64548
64725
  /**
64549
64726
  * Get a list of user recordings.
64550
64727
  *
@@ -64631,7 +64808,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
64631
64808
  /**
64632
64809
  * Users service.
64633
64810
  * @module purecloud-platform-client-v2/api/UsersApi
64634
- * @version 200.0.0
64811
+ * @version 202.0.0
64635
64812
  */
64636
64813
 
64637
64814
  /**
@@ -65959,7 +66136,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
65959
66136
  * @param {Number} opts.pageSize Page size (default to 25)
65960
66137
  * @param {Number} opts.pageNumber Page number (default to 1)
65961
66138
  * @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)
65962
- * @param {Array.<String>} opts.types Specifies the activity types.
66139
+ * @param {Array.<String>} opts.types Specifies the activity types. Informational, AssessedContent and Assessment are deprecated
65963
66140
  * @param {Array.<String>} opts.statuses Specifies the activity statuses to filter by
65964
66141
  * @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.
65965
66142
  */
@@ -65993,7 +66170,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
65993
66170
  * @param {Number} opts.pageSize Page size (default to 25)
65994
66171
  * @param {Number} opts.pageNumber Page number (default to 1)
65995
66172
  * @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)
65996
- * @param {Array.<String>} opts.types Specifies the activity types.
66173
+ * @param {Array.<String>} opts.types Specifies the activity types. Informational, AssessedContent and Assessment are deprecated
65997
66174
  * @param {Array.<String>} opts.statuses Specifies the activity statuses to filter by
65998
66175
  * @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.
65999
66176
  */
@@ -66019,7 +66196,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
66019
66196
  * Get a Development Activity
66020
66197
  * 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.
66021
66198
  * @param {String} activityId Specifies the activity ID, maps to either assignment or appointment ID
66022
- * @param {Object} type Specifies the activity type.
66199
+ * @param {Object} type Specifies the activity type. Informational, AssessedContent and Assessment are deprecated
66023
66200
  */
66024
66201
  getUsersDevelopmentActivity(activityId, type) {
66025
66202
  // verify the required parameter 'activityId' is set
@@ -67434,7 +67611,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
67434
67611
  /**
67435
67612
  * Utilities service.
67436
67613
  * @module purecloud-platform-client-v2/api/UtilitiesApi
67437
- * @version 200.0.0
67614
+ * @version 202.0.0
67438
67615
  */
67439
67616
 
67440
67617
  /**
@@ -67545,7 +67722,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
67545
67722
  /**
67546
67723
  * Voicemail service.
67547
67724
  * @module purecloud-platform-client-v2/api/VoicemailApi
67548
- * @version 200.0.0
67725
+ * @version 202.0.0
67549
67726
  */
67550
67727
 
67551
67728
  /**
@@ -68212,7 +68389,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
68212
68389
  /**
68213
68390
  * WebChat service.
68214
68391
  * @module purecloud-platform-client-v2/api/WebChatApi
68215
- * @version 200.0.0
68392
+ * @version 202.0.0
68216
68393
  */
68217
68394
 
68218
68395
  /**
@@ -68763,7 +68940,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
68763
68940
  /**
68764
68941
  * WebDeployments service.
68765
68942
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
68766
- * @version 200.0.0
68943
+ * @version 202.0.0
68767
68944
  */
68768
68945
 
68769
68946
  /**
@@ -69290,7 +69467,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
69290
69467
  /**
69291
69468
  * WebMessaging service.
69292
69469
  * @module purecloud-platform-client-v2/api/WebMessagingApi
69293
- * @version 200.0.0
69470
+ * @version 202.0.0
69294
69471
  */
69295
69472
 
69296
69473
  /**
@@ -69336,7 +69513,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
69336
69513
  /**
69337
69514
  * Widgets service.
69338
69515
  * @module purecloud-platform-client-v2/api/WidgetsApi
69339
- * @version 200.0.0
69516
+ * @version 202.0.0
69340
69517
  */
69341
69518
 
69342
69519
  /**
@@ -69482,7 +69659,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
69482
69659
  /**
69483
69660
  * WorkforceManagement service.
69484
69661
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
69485
- * @version 200.0.0
69662
+ * @version 202.0.0
69486
69663
  */
69487
69664
 
69488
69665
  /**
@@ -69802,6 +69979,71 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
69802
69979
  );
69803
69980
  }
69804
69981
 
69982
+ /**
69983
+ * Delete a work plan bid
69984
+ *
69985
+ * @param {String} businessUnitId The ID of the business unit
69986
+ * @param {String} bidId The ID of the work plan bid
69987
+ */
69988
+ deleteWorkforcemanagementBusinessunitWorkplanbid(businessUnitId, bidId) {
69989
+ // verify the required parameter 'businessUnitId' is set
69990
+ if (businessUnitId === undefined || businessUnitId === null) {
69991
+ throw 'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitWorkplanbid';
69992
+ }
69993
+ // verify the required parameter 'bidId' is set
69994
+ if (bidId === undefined || bidId === null) {
69995
+ throw 'Missing the required parameter "bidId" when calling deleteWorkforcemanagementBusinessunitWorkplanbid';
69996
+ }
69997
+
69998
+ return this.apiClient.callApi(
69999
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}',
70000
+ 'DELETE',
70001
+ { 'businessUnitId': businessUnitId,'bidId': bidId },
70002
+ { },
70003
+ { },
70004
+ { },
70005
+ null,
70006
+ ['PureCloud OAuth'],
70007
+ ['application/json'],
70008
+ ['application/json']
70009
+ );
70010
+ }
70011
+
70012
+ /**
70013
+ * Delete a bid group by bid group Id
70014
+ *
70015
+ * @param {String} businessUnitId The ID of the business unit
70016
+ * @param {String} bidId The work plan bid id of the bid groups
70017
+ * @param {String} bidGroupId Work Plan Bid Group id
70018
+ */
70019
+ deleteWorkforcemanagementBusinessunitWorkplanbidGroup(businessUnitId, bidId, bidGroupId) {
70020
+ // verify the required parameter 'businessUnitId' is set
70021
+ if (businessUnitId === undefined || businessUnitId === null) {
70022
+ throw 'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitWorkplanbidGroup';
70023
+ }
70024
+ // verify the required parameter 'bidId' is set
70025
+ if (bidId === undefined || bidId === null) {
70026
+ throw 'Missing the required parameter "bidId" when calling deleteWorkforcemanagementBusinessunitWorkplanbidGroup';
70027
+ }
70028
+ // verify the required parameter 'bidGroupId' is set
70029
+ if (bidGroupId === undefined || bidGroupId === null) {
70030
+ throw 'Missing the required parameter "bidGroupId" when calling deleteWorkforcemanagementBusinessunitWorkplanbidGroup';
70031
+ }
70032
+
70033
+ return this.apiClient.callApi(
70034
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}',
70035
+ 'DELETE',
70036
+ { 'businessUnitId': businessUnitId,'bidId': bidId,'bidGroupId': bidGroupId },
70037
+ { },
70038
+ { },
70039
+ { },
70040
+ null,
70041
+ ['PureCloud OAuth'],
70042
+ ['application/json'],
70043
+ ['application/json']
70044
+ );
70045
+ }
70046
+
69805
70047
  /**
69806
70048
  * Disable generated calendar link for the current user
69807
70049
  *
@@ -70167,6 +70409,175 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
70167
70409
  );
70168
70410
  }
70169
70411
 
70412
+ /**
70413
+ * Query the status of an alternative shift offers operation. Only the user who started the operation can query the status
70414
+ * Job details are only retained if the initial request returned a 202 ACCEPTED response
70415
+ * @param {String} jobId The ID of the job
70416
+ */
70417
+ getWorkforcemanagementAlternativeshiftsOffersJob(jobId) {
70418
+ // verify the required parameter 'jobId' is set
70419
+ if (jobId === undefined || jobId === null) {
70420
+ throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementAlternativeshiftsOffersJob';
70421
+ }
70422
+
70423
+ return this.apiClient.callApi(
70424
+ '/api/v2/workforcemanagement/alternativeshifts/offers/jobs/{jobId}',
70425
+ 'GET',
70426
+ { 'jobId': jobId },
70427
+ { },
70428
+ { },
70429
+ { },
70430
+ null,
70431
+ ['PureCloud OAuth'],
70432
+ ['application/json'],
70433
+ ['application/json']
70434
+ );
70435
+ }
70436
+
70437
+ /**
70438
+ * Query the status of an alternative shift search offers operation. Only the user who started the operation can query the status
70439
+ * Job details are only retained if the initial request returned a 202 ACCEPTED response
70440
+ * @param {String} jobId The ID of the job
70441
+ */
70442
+ getWorkforcemanagementAlternativeshiftsOffersSearchJob(jobId) {
70443
+ // verify the required parameter 'jobId' is set
70444
+ if (jobId === undefined || jobId === null) {
70445
+ throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementAlternativeshiftsOffersSearchJob';
70446
+ }
70447
+
70448
+ return this.apiClient.callApi(
70449
+ '/api/v2/workforcemanagement/alternativeshifts/offers/search/jobs/{jobId}',
70450
+ 'GET',
70451
+ { 'jobId': jobId },
70452
+ { },
70453
+ { },
70454
+ { },
70455
+ null,
70456
+ ['PureCloud OAuth'],
70457
+ ['application/json'],
70458
+ ['application/json']
70459
+ );
70460
+ }
70461
+
70462
+ /**
70463
+ * Get alternative shifts settings from the current logged in agent’s business unit
70464
+ *
70465
+ */
70466
+ getWorkforcemanagementAlternativeshiftsSettings() {
70467
+
70468
+ return this.apiClient.callApi(
70469
+ '/api/v2/workforcemanagement/alternativeshifts/settings',
70470
+ 'GET',
70471
+ { },
70472
+ { },
70473
+ { },
70474
+ { },
70475
+ null,
70476
+ ['PureCloud OAuth'],
70477
+ ['application/json'],
70478
+ ['application/json']
70479
+ );
70480
+ }
70481
+
70482
+ /**
70483
+ * Get my alternative shift trade by trade ID
70484
+ *
70485
+ * @param {String} tradeId The ID of the alternative shift trade
70486
+ */
70487
+ getWorkforcemanagementAlternativeshiftsTrade(tradeId) {
70488
+ // verify the required parameter 'tradeId' is set
70489
+ if (tradeId === undefined || tradeId === null) {
70490
+ throw 'Missing the required parameter "tradeId" when calling getWorkforcemanagementAlternativeshiftsTrade';
70491
+ }
70492
+
70493
+ return this.apiClient.callApi(
70494
+ '/api/v2/workforcemanagement/alternativeshifts/trades/{tradeId}',
70495
+ 'GET',
70496
+ { 'tradeId': tradeId },
70497
+ { },
70498
+ { },
70499
+ { },
70500
+ null,
70501
+ ['PureCloud OAuth'],
70502
+ ['application/json'],
70503
+ ['application/json']
70504
+ );
70505
+ }
70506
+
70507
+ /**
70508
+ * Get a list of my alternative shifts trades
70509
+ *
70510
+ * @param {Object} opts Optional parameters
70511
+ * @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
70512
+ */
70513
+ getWorkforcemanagementAlternativeshiftsTrades(opts) {
70514
+ opts = opts || {};
70515
+
70516
+
70517
+ return this.apiClient.callApi(
70518
+ '/api/v2/workforcemanagement/alternativeshifts/trades',
70519
+ 'GET',
70520
+ { },
70521
+ { 'forceAsync': opts['forceAsync'] },
70522
+ { },
70523
+ { },
70524
+ null,
70525
+ ['PureCloud OAuth'],
70526
+ ['application/json'],
70527
+ ['application/json']
70528
+ );
70529
+ }
70530
+
70531
+ /**
70532
+ * Query the status of an alternative shift trades operation. Only the user who started the operation can query the status
70533
+ * Job details are only retained if the initial request returned a 202 ACCEPTED response
70534
+ * @param {String} jobId The ID of the job
70535
+ */
70536
+ getWorkforcemanagementAlternativeshiftsTradesJob(jobId) {
70537
+ // verify the required parameter 'jobId' is set
70538
+ if (jobId === undefined || jobId === null) {
70539
+ throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementAlternativeshiftsTradesJob';
70540
+ }
70541
+
70542
+ return this.apiClient.callApi(
70543
+ '/api/v2/workforcemanagement/alternativeshifts/trades/jobs/{jobId}',
70544
+ 'GET',
70545
+ { 'jobId': jobId },
70546
+ { },
70547
+ { },
70548
+ { },
70549
+ null,
70550
+ ['PureCloud OAuth'],
70551
+ ['application/json'],
70552
+ ['application/json']
70553
+ );
70554
+ }
70555
+
70556
+ /**
70557
+ * Query the status of an alternative shift trade state operation. Only the user who started the operation can query the status
70558
+ * Job details are only retained if the initial request returned a 202 ACCEPTED response
70559
+ * @param {String} jobId The ID of the job
70560
+ */
70561
+ getWorkforcemanagementAlternativeshiftsTradesStateJob(jobId) {
70562
+ // verify the required parameter 'jobId' is set
70563
+ if (jobId === undefined || jobId === null) {
70564
+ throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementAlternativeshiftsTradesStateJob';
70565
+ }
70566
+
70567
+ return this.apiClient.callApi(
70568
+ '/api/v2/workforcemanagement/alternativeshifts/trades/state/jobs/{jobId}',
70569
+ 'GET',
70570
+ { 'jobId': jobId },
70571
+ { },
70572
+ { },
70573
+ { },
70574
+ null,
70575
+ ['PureCloud OAuth'],
70576
+ ['application/json'],
70577
+ ['application/json']
70578
+ );
70579
+ }
70580
+
70170
70581
  /**
70171
70582
  * Get business unit
70172
70583
  * Expanding "settings" will retrieve all settings. All other expands will retrieve only the requested settings field(s).
@@ -70260,7 +70671,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
70260
70671
  *
70261
70672
  * @param {String} businessUnitId The ID of the business unit
70262
70673
  * @param {String} activityPlanId The ID of the activity plan to fetch
70263
- * getWorkforcemanagementBusinessunitActivityplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
70264
70674
  */
70265
70675
  getWorkforcemanagementBusinessunitActivityplan(businessUnitId, activityPlanId) {
70266
70676
  // verify the required parameter 'businessUnitId' is set
@@ -70292,7 +70702,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
70292
70702
  * @param {String} businessUnitId The ID of the business unit
70293
70703
  * @param {String} activityPlanId The ID of the activity plan associated with the run job
70294
70704
  * @param {String} jobId The ID of the activity plan run job
70295
- * getWorkforcemanagementBusinessunitActivityplanRunsJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
70296
70705
  */
70297
70706
  getWorkforcemanagementBusinessunitActivityplanRunsJob(businessUnitId, activityPlanId, jobId) {
70298
70707
  // verify the required parameter 'businessUnitId' is set
@@ -70328,7 +70737,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
70328
70737
  * @param {String} businessUnitId The ID of the business unit
70329
70738
  * @param {Object} opts Optional parameters
70330
70739
  * @param {Object} opts.state Optionally filter by activity plan state
70331
- * getWorkforcemanagementBusinessunitActivityplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
70332
70740
  */
70333
70741
  getWorkforcemanagementBusinessunitActivityplans(businessUnitId, opts) {
70334
70742
  opts = opts || {};
@@ -70356,7 +70764,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
70356
70764
  * Gets the latest job for all activity plans in the business unit
70357
70765
  *
70358
70766
  * @param {String} businessUnitId The ID of the business unit
70359
- * getWorkforcemanagementBusinessunitActivityplansJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
70360
70767
  */
70361
70768
  getWorkforcemanagementBusinessunitActivityplansJobs(businessUnitId) {
70362
70769
  // verify the required parameter 'businessUnitId' is set
@@ -70378,6 +70785,91 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
70378
70785
  );
70379
70786
  }
70380
70787
 
70788
+ /**
70789
+ * Get alternative shifts settings for a business unit
70790
+ *
70791
+ * @param {String} businessUnitId The ID of the business unit
70792
+ */
70793
+ getWorkforcemanagementBusinessunitAlternativeshiftsSettings(businessUnitId) {
70794
+ // verify the required parameter 'businessUnitId' is set
70795
+ if (businessUnitId === undefined || businessUnitId === null) {
70796
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitAlternativeshiftsSettings';
70797
+ }
70798
+
70799
+ return this.apiClient.callApi(
70800
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/settings',
70801
+ 'GET',
70802
+ { 'businessUnitId': businessUnitId },
70803
+ { },
70804
+ { },
70805
+ { },
70806
+ null,
70807
+ ['PureCloud OAuth'],
70808
+ ['application/json'],
70809
+ ['application/json']
70810
+ );
70811
+ }
70812
+
70813
+ /**
70814
+ * Get an alternative shifts trade in a business unit for a given trade ID
70815
+ *
70816
+ * @param {String} businessUnitId The ID of the business unit
70817
+ * @param {String} tradeId The ID of the alternative shift trade
70818
+ */
70819
+ getWorkforcemanagementBusinessunitAlternativeshiftsTrade(businessUnitId, tradeId) {
70820
+ // verify the required parameter 'businessUnitId' is set
70821
+ if (businessUnitId === undefined || businessUnitId === null) {
70822
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitAlternativeshiftsTrade';
70823
+ }
70824
+ // verify the required parameter 'tradeId' is set
70825
+ if (tradeId === undefined || tradeId === null) {
70826
+ throw 'Missing the required parameter "tradeId" when calling getWorkforcemanagementBusinessunitAlternativeshiftsTrade';
70827
+ }
70828
+
70829
+ return this.apiClient.callApi(
70830
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/trades/{tradeId}',
70831
+ 'GET',
70832
+ { 'businessUnitId': businessUnitId,'tradeId': tradeId },
70833
+ { },
70834
+ { },
70835
+ { },
70836
+ null,
70837
+ ['PureCloud OAuth'],
70838
+ ['application/json'],
70839
+ ['application/json']
70840
+ );
70841
+ }
70842
+
70843
+ /**
70844
+ * Query the status of an alternative shift search trade operation. Only the user who started the operation can query the status
70845
+ * Job details are only retained if the initial request returned a 202 ACCEPTED response
70846
+ * @param {String} businessUnitId The ID of the business unit
70847
+ * @param {String} jobId The ID of the job
70848
+ */
70849
+ getWorkforcemanagementBusinessunitAlternativeshiftsTradesSearchJob(businessUnitId, jobId) {
70850
+ // verify the required parameter 'businessUnitId' is set
70851
+ if (businessUnitId === undefined || businessUnitId === null) {
70852
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitAlternativeshiftsTradesSearchJob';
70853
+ }
70854
+ // verify the required parameter 'jobId' is set
70855
+ if (jobId === undefined || jobId === null) {
70856
+ throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementBusinessunitAlternativeshiftsTradesSearchJob';
70857
+ }
70858
+
70859
+ return this.apiClient.callApi(
70860
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/trades/search/jobs/{jobId}',
70861
+ 'GET',
70862
+ { 'businessUnitId': businessUnitId,'jobId': jobId },
70863
+ { },
70864
+ { },
70865
+ { },
70866
+ null,
70867
+ ['PureCloud OAuth'],
70868
+ ['application/json'],
70869
+ ['application/json']
70870
+ );
70871
+ }
70872
+
70381
70873
  /**
70382
70874
  * Get intraday planning groups for the given date
70383
70875
  *
@@ -71349,6 +71841,161 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
71349
71841
  );
71350
71842
  }
71351
71843
 
71844
+ /**
71845
+ * Get a work plan bid
71846
+ *
71847
+ * @param {String} businessUnitId The ID of the business unit
71848
+ * @param {String} bidId The id of the workplanbid
71849
+ */
71850
+ getWorkforcemanagementBusinessunitWorkplanbid(businessUnitId, bidId) {
71851
+ // verify the required parameter 'businessUnitId' is set
71852
+ if (businessUnitId === undefined || businessUnitId === null) {
71853
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWorkplanbid';
71854
+ }
71855
+ // verify the required parameter 'bidId' is set
71856
+ if (bidId === undefined || bidId === null) {
71857
+ throw 'Missing the required parameter "bidId" when calling getWorkforcemanagementBusinessunitWorkplanbid';
71858
+ }
71859
+
71860
+ return this.apiClient.callApi(
71861
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}',
71862
+ 'GET',
71863
+ { 'businessUnitId': businessUnitId,'bidId': bidId },
71864
+ { },
71865
+ { },
71866
+ { },
71867
+ null,
71868
+ ['PureCloud OAuth'],
71869
+ ['application/json'],
71870
+ ['application/json']
71871
+ );
71872
+ }
71873
+
71874
+ /**
71875
+ * Get a bid group by bid group Id
71876
+ *
71877
+ * @param {String} businessUnitId The ID of the business unit
71878
+ * @param {String} bidId The work plan bid id of the bid groups
71879
+ * @param {String} bidGroupId Work Plan Bid Group id
71880
+ */
71881
+ getWorkforcemanagementBusinessunitWorkplanbidGroup(businessUnitId, bidId, bidGroupId) {
71882
+ // verify the required parameter 'businessUnitId' is set
71883
+ if (businessUnitId === undefined || businessUnitId === null) {
71884
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWorkplanbidGroup';
71885
+ }
71886
+ // verify the required parameter 'bidId' is set
71887
+ if (bidId === undefined || bidId === null) {
71888
+ throw 'Missing the required parameter "bidId" when calling getWorkforcemanagementBusinessunitWorkplanbidGroup';
71889
+ }
71890
+ // verify the required parameter 'bidGroupId' is set
71891
+ if (bidGroupId === undefined || bidGroupId === null) {
71892
+ throw 'Missing the required parameter "bidGroupId" when calling getWorkforcemanagementBusinessunitWorkplanbidGroup';
71893
+ }
71894
+
71895
+ return this.apiClient.callApi(
71896
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}',
71897
+ 'GET',
71898
+ { 'businessUnitId': businessUnitId,'bidId': bidId,'bidGroupId': bidGroupId },
71899
+ { },
71900
+ { },
71901
+ { },
71902
+ null,
71903
+ ['PureCloud OAuth'],
71904
+ ['application/json'],
71905
+ ['application/json']
71906
+ );
71907
+ }
71908
+
71909
+ /**
71910
+ * Gets the work plan preferences of all the agents in the work plan bid group
71911
+ *
71912
+ * @param {String} businessUnitId The ID of the business unit
71913
+ * @param {String} bidId The work plan bid id of the bid groups
71914
+ * @param {String} bidGroupId The ID of the work plan bid group
71915
+ */
71916
+ getWorkforcemanagementBusinessunitWorkplanbidGroupPreferences(businessUnitId, bidId, bidGroupId) {
71917
+ // verify the required parameter 'businessUnitId' is set
71918
+ if (businessUnitId === undefined || businessUnitId === null) {
71919
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWorkplanbidGroupPreferences';
71920
+ }
71921
+ // verify the required parameter 'bidId' is set
71922
+ if (bidId === undefined || bidId === null) {
71923
+ throw 'Missing the required parameter "bidId" when calling getWorkforcemanagementBusinessunitWorkplanbidGroupPreferences';
71924
+ }
71925
+ // verify the required parameter 'bidGroupId' is set
71926
+ if (bidGroupId === undefined || bidGroupId === null) {
71927
+ throw 'Missing the required parameter "bidGroupId" when calling getWorkforcemanagementBusinessunitWorkplanbidGroupPreferences';
71928
+ }
71929
+
71930
+ return this.apiClient.callApi(
71931
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}/preferences',
71932
+ 'GET',
71933
+ { 'businessUnitId': businessUnitId,'bidId': bidId,'bidGroupId': bidGroupId },
71934
+ { },
71935
+ { },
71936
+ { },
71937
+ null,
71938
+ ['PureCloud OAuth'],
71939
+ ['application/json'],
71940
+ ['application/json']
71941
+ );
71942
+ }
71943
+
71944
+ /**
71945
+ * Get summary of bid groups that belong to a work plan bid
71946
+ *
71947
+ * @param {String} businessUnitId The ID of the business unit
71948
+ * @param {String} bidId The work plan bid id of the bid groups
71949
+ */
71950
+ getWorkforcemanagementBusinessunitWorkplanbidGroupsSummary(businessUnitId, bidId) {
71951
+ // verify the required parameter 'businessUnitId' is set
71952
+ if (businessUnitId === undefined || businessUnitId === null) {
71953
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWorkplanbidGroupsSummary';
71954
+ }
71955
+ // verify the required parameter 'bidId' is set
71956
+ if (bidId === undefined || bidId === null) {
71957
+ throw 'Missing the required parameter "bidId" when calling getWorkforcemanagementBusinessunitWorkplanbidGroupsSummary';
71958
+ }
71959
+
71960
+ return this.apiClient.callApi(
71961
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/summary',
71962
+ 'GET',
71963
+ { 'businessUnitId': businessUnitId,'bidId': bidId },
71964
+ { },
71965
+ { },
71966
+ { },
71967
+ null,
71968
+ ['PureCloud OAuth'],
71969
+ ['application/json'],
71970
+ ['application/json']
71971
+ );
71972
+ }
71973
+
71974
+ /**
71975
+ * Get list of work plan bids
71976
+ *
71977
+ * @param {String} businessUnitId The ID of the business unit
71978
+ */
71979
+ getWorkforcemanagementBusinessunitWorkplanbids(businessUnitId) {
71980
+ // verify the required parameter 'businessUnitId' is set
71981
+ if (businessUnitId === undefined || businessUnitId === null) {
71982
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWorkplanbids';
71983
+ }
71984
+
71985
+ return this.apiClient.callApi(
71986
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids',
71987
+ 'GET',
71988
+ { 'businessUnitId': businessUnitId },
71989
+ { },
71990
+ { },
71991
+ { },
71992
+ null,
71993
+ ['PureCloud OAuth'],
71994
+ ['application/json'],
71995
+ ['application/json']
71996
+ );
71997
+ }
71998
+
71352
71999
  /**
71353
72000
  * Get business units
71354
72001
  *
@@ -72443,6 +73090,101 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
72443
73090
  );
72444
73091
  }
72445
73092
 
73093
+ /**
73094
+ * Get work plan bid ranks for a user
73095
+ *
73096
+ * @param {String} userId The userId to whom the work plan bid ranks apply.
73097
+ */
73098
+ getWorkforcemanagementUserWorkplanbidranks(userId) {
73099
+ // verify the required parameter 'userId' is set
73100
+ if (userId === undefined || userId === null) {
73101
+ throw 'Missing the required parameter "userId" when calling getWorkforcemanagementUserWorkplanbidranks';
73102
+ }
73103
+
73104
+ return this.apiClient.callApi(
73105
+ '/api/v2/workforcemanagement/users/{userId}/workplanbidranks',
73106
+ 'GET',
73107
+ { 'userId': userId },
73108
+ { },
73109
+ { },
73110
+ { },
73111
+ null,
73112
+ ['PureCloud OAuth'],
73113
+ ['application/json'],
73114
+ ['application/json']
73115
+ );
73116
+ }
73117
+
73118
+ /**
73119
+ * Gets an agent's work plan bidding preference
73120
+ *
73121
+ * @param {String} bidId The ID of the work plan bid
73122
+ */
73123
+ getWorkforcemanagementWorkplanbidPreferences(bidId) {
73124
+ // verify the required parameter 'bidId' is set
73125
+ if (bidId === undefined || bidId === null) {
73126
+ throw 'Missing the required parameter "bidId" when calling getWorkforcemanagementWorkplanbidPreferences';
73127
+ }
73128
+
73129
+ return this.apiClient.callApi(
73130
+ '/api/v2/workforcemanagement/workplanbids/{bidId}/preferences',
73131
+ 'GET',
73132
+ { 'bidId': bidId },
73133
+ { },
73134
+ { },
73135
+ { },
73136
+ null,
73137
+ ['PureCloud OAuth'],
73138
+ ['application/json'],
73139
+ ['application/json']
73140
+ );
73141
+ }
73142
+
73143
+ /**
73144
+ * Gets an agent's work plans for a bid
73145
+ *
73146
+ * @param {String} bidId The ID of the work plan bid
73147
+ */
73148
+ getWorkforcemanagementWorkplanbidWorkplans(bidId) {
73149
+ // verify the required parameter 'bidId' is set
73150
+ if (bidId === undefined || bidId === null) {
73151
+ throw 'Missing the required parameter "bidId" when calling getWorkforcemanagementWorkplanbidWorkplans';
73152
+ }
73153
+
73154
+ return this.apiClient.callApi(
73155
+ '/api/v2/workforcemanagement/workplanbids/{bidId}/workplans',
73156
+ 'GET',
73157
+ { 'bidId': bidId },
73158
+ { },
73159
+ { },
73160
+ { },
73161
+ null,
73162
+ ['PureCloud OAuth'],
73163
+ ['application/json'],
73164
+ ['application/json']
73165
+ );
73166
+ }
73167
+
73168
+ /**
73169
+ * Gets the list of work plan bids that belong to an agent
73170
+ *
73171
+ */
73172
+ getWorkforcemanagementWorkplanbids() {
73173
+
73174
+ return this.apiClient.callApi(
73175
+ '/api/v2/workforcemanagement/workplanbids',
73176
+ 'GET',
73177
+ { },
73178
+ { },
73179
+ { },
73180
+ { },
73181
+ null,
73182
+ ['PureCloud OAuth'],
73183
+ ['application/json'],
73184
+ ['application/json']
73185
+ );
73186
+ }
73187
+
72446
73188
  /**
72447
73189
  * Update an adherence explanation
72448
73190
  *
@@ -72478,6 +73220,60 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
72478
73220
  );
72479
73221
  }
72480
73222
 
73223
+ /**
73224
+ * Update my alternative shifts trade by trade ID
73225
+ *
73226
+ * @param {String} tradeId The ID of the alternative shift trade
73227
+ * @param {Object} opts Optional parameters
73228
+ * @param {Object} opts.body body
73229
+ */
73230
+ patchWorkforcemanagementAlternativeshiftsTrade(tradeId, opts) {
73231
+ opts = opts || {};
73232
+
73233
+ // verify the required parameter 'tradeId' is set
73234
+ if (tradeId === undefined || tradeId === null) {
73235
+ throw 'Missing the required parameter "tradeId" when calling patchWorkforcemanagementAlternativeshiftsTrade';
73236
+ }
73237
+
73238
+ return this.apiClient.callApi(
73239
+ '/api/v2/workforcemanagement/alternativeshifts/trades/{tradeId}',
73240
+ 'PATCH',
73241
+ { 'tradeId': tradeId },
73242
+ { },
73243
+ { },
73244
+ { },
73245
+ opts['body'],
73246
+ ['PureCloud OAuth'],
73247
+ ['application/json'],
73248
+ ['application/json']
73249
+ );
73250
+ }
73251
+
73252
+ /**
73253
+ * Bulk update alternative shift trade states
73254
+ *
73255
+ * @param {Object} body The request body
73256
+ */
73257
+ patchWorkforcemanagementAlternativeshiftsTradesStateJobs(body) {
73258
+ // verify the required parameter 'body' is set
73259
+ if (body === undefined || body === null) {
73260
+ throw 'Missing the required parameter "body" when calling patchWorkforcemanagementAlternativeshiftsTradesStateJobs';
73261
+ }
73262
+
73263
+ return this.apiClient.callApi(
73264
+ '/api/v2/workforcemanagement/alternativeshifts/trades/state/jobs',
73265
+ 'PATCH',
73266
+ { },
73267
+ { },
73268
+ { },
73269
+ { },
73270
+ body,
73271
+ ['PureCloud OAuth'],
73272
+ ['application/json'],
73273
+ ['application/json']
73274
+ );
73275
+ }
73276
+
72481
73277
  /**
72482
73278
  * Update business unit
72483
73279
  *
@@ -72547,7 +73343,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
72547
73343
  * @param {String} businessUnitId The ID of the business unit
72548
73344
  * @param {String} activityPlanId The ID of the activity plan to update
72549
73345
  * @param {Object} body body
72550
- * patchWorkforcemanagementBusinessunitActivityplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
72551
73346
  */
72552
73347
  patchWorkforcemanagementBusinessunitActivityplan(businessUnitId, activityPlanId, body) {
72553
73348
  // verify the required parameter 'businessUnitId' is set
@@ -72577,6 +73372,35 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
72577
73372
  );
72578
73373
  }
72579
73374
 
73375
+ /**
73376
+ * Update alternative shifts settings for a business unit
73377
+ *
73378
+ * @param {String} businessUnitId The ID of the business unit
73379
+ * @param {Object} opts Optional parameters
73380
+ * @param {Object} opts.body body
73381
+ */
73382
+ patchWorkforcemanagementBusinessunitAlternativeshiftsSettings(businessUnitId, opts) {
73383
+ opts = opts || {};
73384
+
73385
+ // verify the required parameter 'businessUnitId' is set
73386
+ if (businessUnitId === undefined || businessUnitId === null) {
73387
+ throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitAlternativeshiftsSettings';
73388
+ }
73389
+
73390
+ return this.apiClient.callApi(
73391
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/settings',
73392
+ 'PATCH',
73393
+ { 'businessUnitId': businessUnitId },
73394
+ { },
73395
+ { },
73396
+ { },
73397
+ opts['body'],
73398
+ ['PureCloud OAuth'],
73399
+ ['application/json'],
73400
+ ['application/json']
73401
+ );
73402
+ }
73403
+
72580
73404
  /**
72581
73405
  * Updates the planning group
72582
73406
  *
@@ -72747,6 +73571,119 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
72747
73571
  );
72748
73572
  }
72749
73573
 
73574
+ /**
73575
+ * Update work plan bid
73576
+ *
73577
+ * @param {String} businessUnitId The ID of the business unit
73578
+ * @param {String} bidId The id of the workplanbid
73579
+ * @param {Object} body The work plan bid to be updated
73580
+ */
73581
+ patchWorkforcemanagementBusinessunitWorkplanbid(businessUnitId, bidId, body) {
73582
+ // verify the required parameter 'businessUnitId' is set
73583
+ if (businessUnitId === undefined || businessUnitId === null) {
73584
+ throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitWorkplanbid';
73585
+ }
73586
+ // verify the required parameter 'bidId' is set
73587
+ if (bidId === undefined || bidId === null) {
73588
+ throw 'Missing the required parameter "bidId" when calling patchWorkforcemanagementBusinessunitWorkplanbid';
73589
+ }
73590
+ // verify the required parameter 'body' is set
73591
+ if (body === undefined || body === null) {
73592
+ throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitWorkplanbid';
73593
+ }
73594
+
73595
+ return this.apiClient.callApi(
73596
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}',
73597
+ 'PATCH',
73598
+ { 'businessUnitId': businessUnitId,'bidId': bidId },
73599
+ { },
73600
+ { },
73601
+ { },
73602
+ body,
73603
+ ['PureCloud OAuth'],
73604
+ ['application/json'],
73605
+ ['application/json']
73606
+ );
73607
+ }
73608
+
73609
+ /**
73610
+ * Update a bid group by bid group Id
73611
+ *
73612
+ * @param {String} businessUnitId The ID of the business unit
73613
+ * @param {String} bidId The work plan bid id of the bid groups
73614
+ * @param {String} bidGroupId Work Plan Bid Group id
73615
+ * @param {Object} opts Optional parameters
73616
+ * @param {Object} opts.body body
73617
+ */
73618
+ patchWorkforcemanagementBusinessunitWorkplanbidGroup(businessUnitId, bidId, bidGroupId, opts) {
73619
+ opts = opts || {};
73620
+
73621
+ // verify the required parameter 'businessUnitId' is set
73622
+ if (businessUnitId === undefined || businessUnitId === null) {
73623
+ throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroup';
73624
+ }
73625
+ // verify the required parameter 'bidId' is set
73626
+ if (bidId === undefined || bidId === null) {
73627
+ throw 'Missing the required parameter "bidId" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroup';
73628
+ }
73629
+ // verify the required parameter 'bidGroupId' is set
73630
+ if (bidGroupId === undefined || bidGroupId === null) {
73631
+ throw 'Missing the required parameter "bidGroupId" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroup';
73632
+ }
73633
+
73634
+ return this.apiClient.callApi(
73635
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}',
73636
+ 'PATCH',
73637
+ { 'businessUnitId': businessUnitId,'bidId': bidId,'bidGroupId': bidGroupId },
73638
+ { },
73639
+ { },
73640
+ { },
73641
+ opts['body'],
73642
+ ['PureCloud OAuth'],
73643
+ ['application/json'],
73644
+ ['application/json']
73645
+ );
73646
+ }
73647
+
73648
+ /**
73649
+ * Overrides the assigned work plan for the specified agents
73650
+ *
73651
+ * @param {String} businessUnitId The ID of the business unit
73652
+ * @param {String} bidId The work plan bid id of the bid groups
73653
+ * @param {String} bidGroupId The ID of the work plan bid group
73654
+ * @param {Object} opts Optional parameters
73655
+ * @param {Object} opts.body body
73656
+ */
73657
+ patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences(businessUnitId, bidId, bidGroupId, opts) {
73658
+ opts = opts || {};
73659
+
73660
+ // verify the required parameter 'businessUnitId' is set
73661
+ if (businessUnitId === undefined || businessUnitId === null) {
73662
+ throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences';
73663
+ }
73664
+ // verify the required parameter 'bidId' is set
73665
+ if (bidId === undefined || bidId === null) {
73666
+ throw 'Missing the required parameter "bidId" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences';
73667
+ }
73668
+ // verify the required parameter 'bidGroupId' is set
73669
+ if (bidGroupId === undefined || bidGroupId === null) {
73670
+ throw 'Missing the required parameter "bidGroupId" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences';
73671
+ }
73672
+
73673
+ return this.apiClient.callApi(
73674
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}/preferences',
73675
+ 'PATCH',
73676
+ { 'businessUnitId': businessUnitId,'bidId': bidId,'bidGroupId': bidGroupId },
73677
+ { },
73678
+ { },
73679
+ { },
73680
+ opts['body'],
73681
+ ['PureCloud OAuth'],
73682
+ ['application/json'],
73683
+ ['application/json']
73684
+ );
73685
+ }
73686
+
72750
73687
  /**
72751
73688
  * Update the requested management unit
72752
73689
  *
@@ -73089,6 +74026,89 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
73089
74026
  );
73090
74027
  }
73091
74028
 
74029
+ /**
74030
+ * Update work plan bid ranks for a user
74031
+ *
74032
+ * @param {String} userId The userId to whom the work plan bid ranks apply.
74033
+ * @param {Object} opts Optional parameters
74034
+ * @param {Object} opts.body body
74035
+ */
74036
+ patchWorkforcemanagementUserWorkplanbidranks(userId, opts) {
74037
+ opts = opts || {};
74038
+
74039
+ // verify the required parameter 'userId' is set
74040
+ if (userId === undefined || userId === null) {
74041
+ throw 'Missing the required parameter "userId" when calling patchWorkforcemanagementUserWorkplanbidranks';
74042
+ }
74043
+
74044
+ return this.apiClient.callApi(
74045
+ '/api/v2/workforcemanagement/users/{userId}/workplanbidranks',
74046
+ 'PATCH',
74047
+ { 'userId': userId },
74048
+ { },
74049
+ { },
74050
+ { },
74051
+ opts['body'],
74052
+ ['PureCloud OAuth'],
74053
+ ['application/json'],
74054
+ ['application/json']
74055
+ );
74056
+ }
74057
+
74058
+ /**
74059
+ * Update bulk work plan bid ranks on users. Max 50 users can be updated at a time.
74060
+ *
74061
+ * @param {Array.<Object>} body Users
74062
+ */
74063
+ patchWorkforcemanagementUsersWorkplanbidranksBulk(body) {
74064
+ // verify the required parameter 'body' is set
74065
+ if (body === undefined || body === null) {
74066
+ throw 'Missing the required parameter "body" when calling patchWorkforcemanagementUsersWorkplanbidranksBulk';
74067
+ }
74068
+
74069
+ return this.apiClient.callApi(
74070
+ '/api/v2/workforcemanagement/users/workplanbidranks/bulk',
74071
+ 'PATCH',
74072
+ { },
74073
+ { },
74074
+ { },
74075
+ { },
74076
+ body,
74077
+ ['PureCloud OAuth'],
74078
+ ['application/json'],
74079
+ ['application/json']
74080
+ );
74081
+ }
74082
+
74083
+ /**
74084
+ * Update an agent's work plan bidding preference
74085
+ *
74086
+ * @param {String} bidId The ID of the work plan bid
74087
+ * @param {Object} opts Optional parameters
74088
+ * @param {Object} opts.body body
74089
+ */
74090
+ patchWorkforcemanagementWorkplanbidPreferences(bidId, opts) {
74091
+ opts = opts || {};
74092
+
74093
+ // verify the required parameter 'bidId' is set
74094
+ if (bidId === undefined || bidId === null) {
74095
+ throw 'Missing the required parameter "bidId" when calling patchWorkforcemanagementWorkplanbidPreferences';
74096
+ }
74097
+
74098
+ return this.apiClient.callApi(
74099
+ '/api/v2/workforcemanagement/workplanbids/{bidId}/preferences',
74100
+ 'PATCH',
74101
+ { 'bidId': bidId },
74102
+ { },
74103
+ { },
74104
+ { },
74105
+ opts['body'],
74106
+ ['PureCloud OAuth'],
74107
+ ['application/json'],
74108
+ ['application/json']
74109
+ );
74110
+ }
74111
+
73092
74112
  /**
73093
74113
  * Submit an adherence explanation for the current user
73094
74114
  *
@@ -73355,6 +74375,81 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
73355
74375
  );
73356
74376
  }
73357
74377
 
74378
+ /**
74379
+ * Request a list of alternative shift offers for a given schedule
74380
+ *
74381
+ * @param {Object} body The request body
74382
+ */
74383
+ postWorkforcemanagementAlternativeshiftsOffersJobs(body) {
74384
+ // verify the required parameter 'body' is set
74385
+ if (body === undefined || body === null) {
74386
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementAlternativeshiftsOffersJobs';
74387
+ }
74388
+
74389
+ return this.apiClient.callApi(
74390
+ '/api/v2/workforcemanagement/alternativeshifts/offers/jobs',
74391
+ 'POST',
74392
+ { },
74393
+ { },
74394
+ { },
74395
+ { },
74396
+ body,
74397
+ ['PureCloud OAuth'],
74398
+ ['application/json'],
74399
+ ['application/json']
74400
+ );
74401
+ }
74402
+
74403
+ /**
74404
+ * Request a search of alternative shift offers for a given shift
74405
+ *
74406
+ * @param {Object} body The request body
74407
+ */
74408
+ postWorkforcemanagementAlternativeshiftsOffersSearchJobs(body) {
74409
+ // verify the required parameter 'body' is set
74410
+ if (body === undefined || body === null) {
74411
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementAlternativeshiftsOffersSearchJobs';
74412
+ }
74413
+
74414
+ return this.apiClient.callApi(
74415
+ '/api/v2/workforcemanagement/alternativeshifts/offers/search/jobs',
74416
+ 'POST',
74417
+ { },
74418
+ { },
74419
+ { },
74420
+ { },
74421
+ body,
74422
+ ['PureCloud OAuth'],
74423
+ ['application/json'],
74424
+ ['application/json']
74425
+ );
74426
+ }
74427
+
74428
+ /**
74429
+ * Create my alternative shift trade using an existing offer's jobId
74430
+ *
74431
+ * @param {Object} body The request body
74432
+ */
74433
+ postWorkforcemanagementAlternativeshiftsTrades(body) {
74434
+ // verify the required parameter 'body' is set
74435
+ if (body === undefined || body === null) {
74436
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementAlternativeshiftsTrades';
74437
+ }
74438
+
74439
+ return this.apiClient.callApi(
74440
+ '/api/v2/workforcemanagement/alternativeshifts/trades',
74441
+ 'POST',
74442
+ { },
74443
+ { },
74444
+ { },
74445
+ { },
74446
+ body,
74447
+ ['PureCloud OAuth'],
74448
+ ['application/json'],
74449
+ ['application/json']
74450
+ );
74451
+ }
74452
+
73358
74453
  /**
73359
74454
  * Create a new activity code
73360
74455
  *
@@ -73389,7 +74484,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
73389
74484
  * Triggers a job running the activity plan. The activity plan cannot be updated until the job completes
73390
74485
  * @param {String} businessUnitId The ID of the business unit
73391
74486
  * @param {String} activityPlanId The ID of the activity plan to run
73392
- * postWorkforcemanagementBusinessunitActivityplanRunsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
73393
74487
  */
73394
74488
  postWorkforcemanagementBusinessunitActivityplanRunsJobs(businessUnitId, activityPlanId) {
73395
74489
  // verify the required parameter 'businessUnitId' is set
@@ -73420,7 +74514,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
73420
74514
  *
73421
74515
  * @param {String} businessUnitId The ID of the business unit
73422
74516
  * @param {Object} body body
73423
- * postWorkforcemanagementBusinessunitActivityplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
73424
74517
  */
73425
74518
  postWorkforcemanagementBusinessunitActivityplans(businessUnitId, body) {
73426
74519
  // verify the required parameter 'businessUnitId' is set
@@ -73512,6 +74605,40 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
73512
74605
  );
73513
74606
  }
73514
74607
 
74608
+ /**
74609
+ * List alternative shifts trades for a given management unit or agent
74610
+ *
74611
+ * @param {String} businessUnitId The ID of the business unit
74612
+ * @param {Object} body The request body
74613
+ * @param {Object} opts Optional parameters
74614
+ * @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
74615
+ */
74616
+ postWorkforcemanagementBusinessunitAlternativeshiftsTradesSearch(businessUnitId, body, opts) {
74617
+ opts = opts || {};
74618
+
74619
+ // verify the required parameter 'businessUnitId' is set
74620
+ if (businessUnitId === undefined || businessUnitId === null) {
74621
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitAlternativeshiftsTradesSearch';
74622
+ }
74623
+ // verify the required parameter 'body' is set
74624
+ if (body === undefined || body === null) {
74625
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitAlternativeshiftsTradesSearch';
74626
+ }
74627
+
74628
+ return this.apiClient.callApi(
74629
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/trades/search',
74630
+ 'POST',
74631
+ { 'businessUnitId': businessUnitId },
74632
+ { 'forceAsync': opts['forceAsync'] },
74633
+ { },
74634
+ { },
74635
+ body,
74636
+ ['PureCloud OAuth'],
74637
+ ['application/json'],
74638
+ ['application/json']
74639
+ );
74640
+ }
74641
+
73515
74642
  /**
73516
74643
  * Get intraday data for the given date for the requested planningGroupIds
73517
74644
  *
@@ -74321,6 +75448,103 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
74321
75448
  );
74322
75449
  }
74323
75450
 
75451
+ /**
75452
+ * Copy a work plan bid
75453
+ *
75454
+ * @param {String} businessUnitId The ID of the business unit
75455
+ * @param {String} bidId The ID of the work plan bid to copy
75456
+ * @param {Object} opts Optional parameters
75457
+ * @param {Object} opts.body body
75458
+ */
75459
+ postWorkforcemanagementBusinessunitWorkplanbidCopy(businessUnitId, bidId, opts) {
75460
+ opts = opts || {};
75461
+
75462
+ // verify the required parameter 'businessUnitId' is set
75463
+ if (businessUnitId === undefined || businessUnitId === null) {
75464
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWorkplanbidCopy';
75465
+ }
75466
+ // verify the required parameter 'bidId' is set
75467
+ if (bidId === undefined || bidId === null) {
75468
+ throw 'Missing the required parameter "bidId" when calling postWorkforcemanagementBusinessunitWorkplanbidCopy';
75469
+ }
75470
+
75471
+ return this.apiClient.callApi(
75472
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/copy',
75473
+ 'POST',
75474
+ { 'businessUnitId': businessUnitId,'bidId': bidId },
75475
+ { },
75476
+ { },
75477
+ { },
75478
+ opts['body'],
75479
+ ['PureCloud OAuth'],
75480
+ ['application/json'],
75481
+ ['application/json']
75482
+ );
75483
+ }
75484
+
75485
+ /**
75486
+ * Add a bid group in a given work plan bid
75487
+ *
75488
+ * @param {String} businessUnitId The ID of the business unit
75489
+ * @param {String} bidId The work plan bid id of the bid groups
75490
+ * @param {Object} opts Optional parameters
75491
+ * @param {Object} opts.body body
75492
+ */
75493
+ postWorkforcemanagementBusinessunitWorkplanbidGroups(businessUnitId, bidId, opts) {
75494
+ opts = opts || {};
75495
+
75496
+ // verify the required parameter 'businessUnitId' is set
75497
+ if (businessUnitId === undefined || businessUnitId === null) {
75498
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWorkplanbidGroups';
75499
+ }
75500
+ // verify the required parameter 'bidId' is set
75501
+ if (bidId === undefined || bidId === null) {
75502
+ throw 'Missing the required parameter "bidId" when calling postWorkforcemanagementBusinessunitWorkplanbidGroups';
75503
+ }
75504
+
75505
+ return this.apiClient.callApi(
75506
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups',
75507
+ 'POST',
75508
+ { 'businessUnitId': businessUnitId,'bidId': bidId },
75509
+ { },
75510
+ { },
75511
+ { },
75512
+ opts['body'],
75513
+ ['PureCloud OAuth'],
75514
+ ['application/json'],
75515
+ ['application/json']
75516
+ );
75517
+ }
75518
+
75519
+ /**
75520
+ * Create a new work plan bid
75521
+ *
75522
+ * @param {String} businessUnitId The ID of the business unit
75523
+ * @param {Object} opts Optional parameters
75524
+ * @param {Object} opts.body The work plan bid to be created
75525
+ */
75526
+ postWorkforcemanagementBusinessunitWorkplanbids(businessUnitId, opts) {
75527
+ opts = opts || {};
75528
+
75529
+ // verify the required parameter 'businessUnitId' is set
75530
+ if (businessUnitId === undefined || businessUnitId === null) {
75531
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWorkplanbids';
75532
+ }
75533
+
75534
+ return this.apiClient.callApi(
75535
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids',
75536
+ 'POST',
75537
+ { 'businessUnitId': businessUnitId },
75538
+ { },
75539
+ { },
75540
+ { },
75541
+ opts['body'],
75542
+ ['PureCloud OAuth'],
75543
+ ['application/json'],
75544
+ ['application/json']
75545
+ );
75546
+ }
75547
+
74324
75548
  /**
74325
75549
  * Add a new business unit
74326
75550
  * It may take a minute or two for a new business unit to be available for api operations
@@ -75590,7 +76814,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
75590
76814
  * </pre>
75591
76815
  * </p>
75592
76816
  * @module purecloud-platform-client-v2/index
75593
- * @version 200.0.0
76817
+ * @version 202.0.0
75594
76818
  */
75595
76819
  class platformClient {
75596
76820
  constructor() {