purecloud-platform-client-v2 189.0.0 → 190.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 (85) hide show
  1. package/README.md +2 -2
  2. package/dist/node/purecloud-platform-client-v2.js +923 -109
  3. package/dist/web-amd/purecloud-platform-client-v2.js +923 -109
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +300 -112
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +385 -144
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +824 -453
  9. package/package.json +1 -1
  10. package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
  11. package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
  12. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
  13. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
  14. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
  16. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  17. package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/ChatApi.js +86 -20
  19. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  21. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +13 -8
  22. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/JourneyApi.js +207 -1
  38. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  44. package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  49. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  50. package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +2 -2
  52. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/RecordingApi.js +22 -1
  58. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/RoutingApi.js +8 -7
  60. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  67. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  76. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
  78. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  79. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  80. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  81. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  82. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  83. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  84. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +516 -1
  85. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -399,7 +399,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
399
399
 
400
400
  /**
401
401
  * @module purecloud-platform-client-v2/ApiClient
402
- * @version 189.0.0
402
+ * @version 190.0.0
403
403
  */
404
404
  class ApiClient {
405
405
  /**
@@ -1818,7 +1818,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
1818
1818
  /**
1819
1819
  * Alerting service.
1820
1820
  * @module purecloud-platform-client-v2/api/AlertingApi
1821
- * @version 189.0.0
1821
+ * @version 190.0.0
1822
1822
  */
1823
1823
 
1824
1824
  /**
@@ -2479,7 +2479,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2479
2479
  /**
2480
2480
  * Analytics service.
2481
2481
  * @module purecloud-platform-client-v2/api/AnalyticsApi
2482
- * @version 189.0.0
2482
+ * @version 190.0.0
2483
2483
  */
2484
2484
 
2485
2485
  /**
@@ -5092,7 +5092,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
5092
5092
  /**
5093
5093
  * Architect service.
5094
5094
  * @module purecloud-platform-client-v2/api/ArchitectApi
5095
- * @version 189.0.0
5095
+ * @version 190.0.0
5096
5096
  */
5097
5097
 
5098
5098
  /**
@@ -9238,7 +9238,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
9238
9238
  /**
9239
9239
  * Audit service.
9240
9240
  * @module purecloud-platform-client-v2/api/AuditApi
9241
- * @version 189.0.0
9241
+ * @version 190.0.0
9242
9242
  */
9243
9243
 
9244
9244
  /**
@@ -9409,7 +9409,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
9409
9409
  /**
9410
9410
  * Authorization service.
9411
9411
  * @module purecloud-platform-client-v2/api/AuthorizationApi
9412
- * @version 189.0.0
9412
+ * @version 190.0.0
9413
9413
  */
9414
9414
 
9415
9415
  /**
@@ -10639,7 +10639,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
10639
10639
  /**
10640
10640
  * Billing service.
10641
10641
  * @module purecloud-platform-client-v2/api/BillingApi
10642
- * @version 189.0.0
10642
+ * @version 190.0.0
10643
10643
  */
10644
10644
 
10645
10645
  /**
@@ -10719,7 +10719,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
10719
10719
  /**
10720
10720
  * CarrierServices service.
10721
10721
  * @module purecloud-platform-client-v2/api/CarrierServicesApi
10722
- * @version 189.0.0
10722
+ * @version 190.0.0
10723
10723
  */
10724
10724
 
10725
10725
  /**
@@ -10789,7 +10789,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
10789
10789
  /**
10790
10790
  * Chat service.
10791
10791
  * @module purecloud-platform-client-v2/api/ChatApi
10792
- * @version 189.0.0
10792
+ * @version 190.0.0
10793
10793
  */
10794
10794
 
10795
10795
  /**
@@ -10809,7 +10809,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
10809
10809
  *
10810
10810
  * @param {String} roomJid roomId
10811
10811
  * @param {String} messageId messageId
10812
- * deleteChatsRoomMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
10813
10812
  */
10814
10813
  deleteChatsRoomMessage(roomJid, messageId) {
10815
10814
  // verify the required parameter 'roomJid' is set
@@ -10840,7 +10839,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
10840
10839
  *
10841
10840
  * @param {String} roomJid roomJid
10842
10841
  * @param {String} userId userId
10843
- * deleteChatsRoomParticipant is a preview method and is subject to both breaking and non-breaking changes at any time without notice
10844
10842
  */
10845
10843
  deleteChatsRoomParticipant(roomJid, userId) {
10846
10844
  // verify the required parameter 'roomJid' is set
@@ -10871,7 +10869,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
10871
10869
  *
10872
10870
  * @param {String} roomJid roomJid
10873
10871
  * @param {String} pinnedMessageId pinnedMessageId
10874
- * deleteChatsRoomPinnedmessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
10875
10872
  */
10876
10873
  deleteChatsRoomPinnedmessage(roomJid, pinnedMessageId) {
10877
10874
  // verify the required parameter 'roomJid' is set
@@ -10902,7 +10899,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
10902
10899
  *
10903
10900
  * @param {String} userId userId
10904
10901
  * @param {String} messageId messageId
10905
- * deleteChatsUserMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
10906
10902
  */
10907
10903
  deleteChatsUserMessage(userId, messageId) {
10908
10904
  // verify the required parameter 'userId' is set
@@ -10932,7 +10928,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
10932
10928
  * Get a message
10933
10929
  *
10934
10930
  * @param {String} messageId messageId
10935
- * getChatsMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
10936
10931
  */
10937
10932
  getChatsMessage(messageId) {
10938
10933
  // verify the required parameter 'messageId' is set
@@ -10958,7 +10953,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
10958
10953
  * Get a room
10959
10954
  *
10960
10955
  * @param {String} roomJid roomJid
10961
- * getChatsRoom is a preview method and is subject to both breaking and non-breaking changes at any time without notice
10962
10956
  */
10963
10957
  getChatsRoom(roomJid) {
10964
10958
  // verify the required parameter 'roomJid' is set
@@ -10985,7 +10979,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
10985
10979
  *
10986
10980
  * @param {String} roomJid roomJid
10987
10981
  * @param {String} messageIds messageIds, comma separated
10988
- * getChatsRoomMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
10989
10982
  */
10990
10983
  getChatsRoomMessage(roomJid, messageIds) {
10991
10984
  // verify the required parameter 'roomJid' is set
@@ -11019,7 +11012,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
11019
11012
  * @param {String} opts.limit The maximum number of messages to retrieve
11020
11013
  * @param {String} opts.before The cutoff date for messages to retrieve
11021
11014
  * @param {String} opts.after The beginning date for messages to retrieve
11022
- * getChatsRoomMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
11023
11015
  */
11024
11016
  getChatsRoomMessages(roomJid, opts) {
11025
11017
  opts = opts || {};
@@ -11043,6 +11035,61 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
11043
11035
  );
11044
11036
  }
11045
11037
 
11038
+ /**
11039
+ * Get a room participant
11040
+ *
11041
+ * @param {String} roomJid roomJid
11042
+ * @param {String} participantJid participantJid
11043
+ */
11044
+ getChatsRoomParticipant(roomJid, participantJid) {
11045
+ // verify the required parameter 'roomJid' is set
11046
+ if (roomJid === undefined || roomJid === null) {
11047
+ throw 'Missing the required parameter "roomJid" when calling getChatsRoomParticipant';
11048
+ }
11049
+ // verify the required parameter 'participantJid' is set
11050
+ if (participantJid === undefined || participantJid === null) {
11051
+ throw 'Missing the required parameter "participantJid" when calling getChatsRoomParticipant';
11052
+ }
11053
+
11054
+ return this.apiClient.callApi(
11055
+ '/api/v2/chats/rooms/{roomJid}/participants/{participantJid}',
11056
+ 'GET',
11057
+ { 'roomJid': roomJid,'participantJid': participantJid },
11058
+ { },
11059
+ { },
11060
+ { },
11061
+ null,
11062
+ ['PureCloud OAuth'],
11063
+ ['application/json'],
11064
+ ['application/json']
11065
+ );
11066
+ }
11067
+
11068
+ /**
11069
+ * Get room participants in a room
11070
+ *
11071
+ * @param {String} roomJid roomJid
11072
+ */
11073
+ getChatsRoomParticipants(roomJid) {
11074
+ // verify the required parameter 'roomJid' is set
11075
+ if (roomJid === undefined || roomJid === null) {
11076
+ throw 'Missing the required parameter "roomJid" when calling getChatsRoomParticipants';
11077
+ }
11078
+
11079
+ return this.apiClient.callApi(
11080
+ '/api/v2/chats/rooms/{roomJid}/participants',
11081
+ 'GET',
11082
+ { 'roomJid': roomJid },
11083
+ { },
11084
+ { },
11085
+ { },
11086
+ null,
11087
+ ['PureCloud OAuth'],
11088
+ ['application/json'],
11089
+ ['application/json']
11090
+ );
11091
+ }
11092
+
11046
11093
  /**
11047
11094
  * Get Chat Settings.
11048
11095
  *
@@ -11071,7 +11118,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
11071
11118
  * @param {String} opts.limit The maximum number of messages to retrieve
11072
11119
  * @param {String} opts.before The cutoff date for messages to retrieve
11073
11120
  * @param {String} opts.after The beginning date for messages to retrieve
11074
- * getChatsThreadMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
11075
11121
  */
11076
11122
  getChatsThreadMessages(threadId, opts) {
11077
11123
  opts = opts || {};
@@ -11100,7 +11146,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
11100
11146
  *
11101
11147
  * @param {String} userId userId
11102
11148
  * @param {String} messageIds messageIds, comma separated
11103
- * getChatsUserMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
11104
11149
  */
11105
11150
  getChatsUserMessage(userId, messageIds) {
11106
11151
  // verify the required parameter 'userId' is set
@@ -11134,7 +11179,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
11134
11179
  * @param {String} opts.limit The maximum number of messages to retrieve
11135
11180
  * @param {String} opts.before The cutoff date for messages to retrieve
11136
11181
  * @param {String} opts.after The beginning date for messages to retrieve
11137
- * getChatsUserMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
11138
11182
  */
11139
11183
  getChatsUserMessages(userId, opts) {
11140
11184
  opts = opts || {};
@@ -11189,7 +11233,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
11189
11233
  *
11190
11234
  * @param {String} roomJid roomJid
11191
11235
  * @param {Object} body Room properties
11192
- * patchChatsRoom is a preview method and is subject to both breaking and non-breaking changes at any time without notice
11193
11236
  */
11194
11237
  patchChatsRoom(roomJid, body) {
11195
11238
  // verify the required parameter 'roomJid' is set
@@ -11221,7 +11264,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
11221
11264
  * @param {String} roomJid roomId
11222
11265
  * @param {String} messageId messageId
11223
11266
  * @param {Object} body messageBody
11224
- * patchChatsRoomMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
11225
11267
  */
11226
11268
  patchChatsRoomMessage(roomJid, messageId, body) {
11227
11269
  // verify the required parameter 'roomJid' is set
@@ -11282,7 +11324,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
11282
11324
  * @param {String} userId userId
11283
11325
  * @param {String} messageId messageId
11284
11326
  * @param {Object} body message body
11285
- * patchChatsUserMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
11286
11327
  */
11287
11328
  patchChatsUserMessage(userId, messageId, body) {
11288
11329
  // verify the required parameter 'userId' is set
@@ -11348,7 +11389,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
11348
11389
  *
11349
11390
  * @param {String} roomJid roomId
11350
11391
  * @param {Object} body messageBody
11351
- * postChatsRoomMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
11352
11392
  */
11353
11393
  postChatsRoomMessages(roomJid, body) {
11354
11394
  // verify the required parameter 'roomJid' is set
@@ -11379,7 +11419,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
11379
11419
  *
11380
11420
  * @param {String} roomJid roomJid
11381
11421
  * @param {String} userId userId
11382
- * postChatsRoomParticipant is a preview method and is subject to both breaking and non-breaking changes at any time without notice
11383
11422
  */
11384
11423
  postChatsRoomParticipant(roomJid, userId) {
11385
11424
  // verify the required parameter 'roomJid' is set
@@ -11410,7 +11449,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
11410
11449
  *
11411
11450
  * @param {String} roomJid roomJid
11412
11451
  * @param {Object} body Pinned Message Ids
11413
- * postChatsRoomPinnedmessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
11414
11452
  */
11415
11453
  postChatsRoomPinnedmessages(roomJid, body) {
11416
11454
  // verify the required parameter 'roomJid' is set
@@ -11440,7 +11478,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
11440
11478
  * Create an adhoc room
11441
11479
  *
11442
11480
  * @param {Object} body Room properties
11443
- * postChatsRooms is a preview method and is subject to both breaking and non-breaking changes at any time without notice
11444
11481
  */
11445
11482
  postChatsRooms(body) {
11446
11483
  // verify the required parameter 'body' is set
@@ -11467,7 +11504,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
11467
11504
  *
11468
11505
  * @param {String} userId userId
11469
11506
  * @param {Object} body message body
11470
- * postChatsUserMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
11471
11507
  */
11472
11508
  postChatsUserMessages(userId, body) {
11473
11509
  // verify the required parameter 'userId' is set
@@ -11493,6 +11529,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
11493
11529
  );
11494
11530
  }
11495
11531
 
11532
+ /**
11533
+ * Update reactions to a message
11534
+ *
11535
+ * @param {String} messageId messageId
11536
+ * @param {Object} body reactionUpdate
11537
+ */
11538
+ putChatsMessageReactions(messageId, body) {
11539
+ // verify the required parameter 'messageId' is set
11540
+ if (messageId === undefined || messageId === null) {
11541
+ throw 'Missing the required parameter "messageId" when calling putChatsMessageReactions';
11542
+ }
11543
+ // verify the required parameter 'body' is set
11544
+ if (body === undefined || body === null) {
11545
+ throw 'Missing the required parameter "body" when calling putChatsMessageReactions';
11546
+ }
11547
+
11548
+ return this.apiClient.callApi(
11549
+ '/api/v2/chats/messages/{messageId}/reactions',
11550
+ 'PUT',
11551
+ { 'messageId': messageId },
11552
+ { },
11553
+ { },
11554
+ { },
11555
+ body,
11556
+ ['PureCloud OAuth'],
11557
+ ['application/json'],
11558
+ ['application/json']
11559
+ );
11560
+ }
11561
+
11496
11562
  /**
11497
11563
  * Update Chat Settings.
11498
11564
  *
@@ -11524,7 +11590,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
11524
11590
  /**
11525
11591
  * Coaching service.
11526
11592
  * @module purecloud-platform-client-v2/api/CoachingApi
11527
- * @version 189.0.0
11593
+ * @version 190.0.0
11528
11594
  */
11529
11595
 
11530
11596
  /**
@@ -12101,7 +12167,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
12101
12167
  /**
12102
12168
  * ContentManagement service.
12103
12169
  * @module purecloud-platform-client-v2/api/ContentManagementApi
12104
- * @version 189.0.0
12170
+ * @version 190.0.0
12105
12171
  */
12106
12172
 
12107
12173
  /**
@@ -13183,7 +13249,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
13183
13249
  /**
13184
13250
  * Conversations service.
13185
13251
  * @module purecloud-platform-client-v2/api/ConversationsApi
13186
- * @version 189.0.0
13252
+ * @version 190.0.0
13187
13253
  */
13188
13254
 
13189
13255
  /**
@@ -13476,8 +13542,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
13476
13542
 
13477
13543
  /**
13478
13544
  * Delete a Twitter messaging integration
13479
- *
13545
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
13480
13546
  * @param {String} integrationId Integration ID
13547
+ * @deprecated
13481
13548
  */
13482
13549
  deleteConversationsMessagingIntegrationsTwitterIntegrationId(integrationId) {
13483
13550
  // verify the required parameter 'integrationId' is set
@@ -15552,14 +15619,15 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
15552
15619
  }
15553
15620
 
15554
15621
  /**
15555
- * Get a list of Twitter Integrations
15556
- *
15622
+ * Get a list of Twitter Integrations (Deprecated)
15623
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
15557
15624
  * @param {Object} opts Optional parameters
15558
15625
  * @param {Number} opts.pageSize Page size (default to 25)
15559
15626
  * @param {Number} opts.pageNumber Page number (default to 1)
15560
15627
  * @param {Object} opts.expand Expand instructions for the return value.
15561
15628
  * @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
15562
15629
  * @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
15630
+ * @deprecated
15563
15631
  */
15564
15632
  getConversationsMessagingIntegrationsTwitter(opts) {
15565
15633
  opts = opts || {};
@@ -15580,11 +15648,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
15580
15648
  }
15581
15649
 
15582
15650
  /**
15583
- * Get a Twitter messaging integration
15584
- *
15651
+ * Get a Twitter messaging integration (Deprecated)
15652
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
15585
15653
  * @param {String} integrationId Integration ID
15586
15654
  * @param {Object} opts Optional parameters
15587
15655
  * @param {Object} opts.expand Expand instructions for the return value.
15656
+ * @deprecated
15588
15657
  */
15589
15658
  getConversationsMessagingIntegrationsTwitterIntegrationId(integrationId, opts) {
15590
15659
  opts = opts || {};
@@ -17203,9 +17272,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
17203
17272
 
17204
17273
  /**
17205
17274
  * Update Twitter messaging integration
17206
- *
17275
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
17207
17276
  * @param {String} integrationId Integration ID
17208
17277
  * @param {Object} body TwitterIntegrationRequest
17278
+ * @deprecated
17209
17279
  */
17210
17280
  patchConversationsMessagingIntegrationsTwitterIntegrationId(integrationId, body) {
17211
17281
  // verify the required parameter 'integrationId' is set
@@ -19491,8 +19561,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
19491
19561
 
19492
19562
  /**
19493
19563
  * Create a Twitter Integration
19494
- *
19564
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
19495
19565
  * @param {Object} body TwitterIntegrationRequest
19566
+ * @deprecated
19496
19567
  */
19497
19568
  postConversationsMessagingIntegrationsTwitter(body) {
19498
19569
  // verify the required parameter 'body' is set
@@ -20355,7 +20426,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
20355
20426
  /**
20356
20427
  * DataExtensions service.
20357
20428
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
20358
- * @version 189.0.0
20429
+ * @version 190.0.0
20359
20430
  */
20360
20431
 
20361
20432
  /**
@@ -20441,7 +20512,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
20441
20512
  /**
20442
20513
  * Downloads service.
20443
20514
  * @module purecloud-platform-client-v2/api/DownloadsApi
20444
- * @version 189.0.0
20515
+ * @version 190.0.0
20445
20516
  */
20446
20517
 
20447
20518
  /**
@@ -20493,7 +20564,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
20493
20564
  /**
20494
20565
  * Emails service.
20495
20566
  * @module purecloud-platform-client-v2/api/EmailsApi
20496
- * @version 189.0.0
20567
+ * @version 190.0.0
20497
20568
  */
20498
20569
 
20499
20570
  /**
@@ -20558,7 +20629,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
20558
20629
  /**
20559
20630
  * Events service.
20560
20631
  * @module purecloud-platform-client-v2/api/EventsApi
20561
- * @version 189.0.0
20632
+ * @version 190.0.0
20562
20633
  */
20563
20634
 
20564
20635
  /**
@@ -20654,7 +20725,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
20654
20725
  /**
20655
20726
  * ExternalContacts service.
20656
20727
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
20657
- * @version 189.0.0
20728
+ * @version 190.0.0
20658
20729
  */
20659
20730
 
20660
20731
  /**
@@ -22612,7 +22683,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
22612
22683
  /**
22613
22684
  * Fax service.
22614
22685
  * @module purecloud-platform-client-v2/api/FaxApi
22615
- * @version 189.0.0
22686
+ * @version 190.0.0
22616
22687
  */
22617
22688
 
22618
22689
  /**
@@ -22783,7 +22854,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
22783
22854
  /**
22784
22855
  * Flows service.
22785
22856
  * @module purecloud-platform-client-v2/api/FlowsApi
22786
- * @version 189.0.0
22857
+ * @version 190.0.0
22787
22858
  */
22788
22859
 
22789
22860
  /**
@@ -22967,7 +23038,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
22967
23038
  /**
22968
23039
  * Gamification service.
22969
23040
  * @module purecloud-platform-client-v2/api/GamificationApi
22970
- * @version 189.0.0
23041
+ * @version 190.0.0
22971
23042
  */
22972
23043
 
22973
23044
  /**
@@ -25053,7 +25124,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25053
25124
  /**
25054
25125
  * GeneralDataProtectionRegulation service.
25055
25126
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
25056
- * @version 189.0.0
25127
+ * @version 190.0.0
25057
25128
  */
25058
25129
 
25059
25130
  /**
@@ -25183,7 +25254,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25183
25254
  /**
25184
25255
  * Geolocation service.
25185
25256
  * @module purecloud-platform-client-v2/api/GeolocationApi
25186
- * @version 189.0.0
25257
+ * @version 190.0.0
25187
25258
  */
25188
25259
 
25189
25260
  /**
@@ -25314,7 +25385,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25314
25385
  /**
25315
25386
  * Greetings service.
25316
25387
  * @module purecloud-platform-client-v2/api/GreetingsApi
25317
- * @version 189.0.0
25388
+ * @version 190.0.0
25318
25389
  */
25319
25390
 
25320
25391
  /**
@@ -25769,7 +25840,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25769
25840
  /**
25770
25841
  * Groups service.
25771
25842
  * @module purecloud-platform-client-v2/api/GroupsApi
25772
- * @version 189.0.0
25843
+ * @version 190.0.0
25773
25844
  */
25774
25845
 
25775
25846
  /**
@@ -26288,7 +26359,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26288
26359
  /**
26289
26360
  * IdentityProvider service.
26290
26361
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
26291
- * @version 189.0.0
26362
+ * @version 190.0.0
26292
26363
  */
26293
26364
 
26294
26365
  /**
@@ -27149,7 +27220,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
27149
27220
  /**
27150
27221
  * InfrastructureAsCode service.
27151
27222
  * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
27152
- * @version 189.0.0
27223
+ * @version 190.0.0
27153
27224
  */
27154
27225
 
27155
27226
  /**
@@ -27316,7 +27387,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
27316
27387
  /**
27317
27388
  * Integrations service.
27318
27389
  * @module purecloud-platform-client-v2/api/IntegrationsApi
27319
- * @version 189.0.0
27390
+ * @version 190.0.0
27320
27391
  */
27321
27392
 
27322
27393
  /**
@@ -29667,7 +29738,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
29667
29738
  /**
29668
29739
  * Journey service.
29669
29740
  * @module purecloud-platform-client-v2/api/JourneyApi
29670
- * @version 189.0.0
29741
+ * @version 190.0.0
29671
29742
  */
29672
29743
 
29673
29744
  /**
@@ -30517,6 +30588,109 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
30517
30588
  );
30518
30589
  }
30519
30590
 
30591
+ /**
30592
+ * Get the job for a journey view version.
30593
+ * used for long descriptions
30594
+ * @param {String} viewId Journey View Id
30595
+ * @param {String} journeyVersionId Journey View Version
30596
+ * @param {String} jobId JobId
30597
+ * getJourneyViewVersionJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
30598
+ */
30599
+ getJourneyViewVersionJob(viewId, journeyVersionId, jobId) {
30600
+ // verify the required parameter 'viewId' is set
30601
+ if (viewId === undefined || viewId === null) {
30602
+ throw 'Missing the required parameter "viewId" when calling getJourneyViewVersionJob';
30603
+ }
30604
+ // verify the required parameter 'journeyVersionId' is set
30605
+ if (journeyVersionId === undefined || journeyVersionId === null) {
30606
+ throw 'Missing the required parameter "journeyVersionId" when calling getJourneyViewVersionJob';
30607
+ }
30608
+ // verify the required parameter 'jobId' is set
30609
+ if (jobId === undefined || jobId === null) {
30610
+ throw 'Missing the required parameter "jobId" when calling getJourneyViewVersionJob';
30611
+ }
30612
+
30613
+ return this.apiClient.callApi(
30614
+ '/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId}',
30615
+ 'GET',
30616
+ { 'viewId': viewId,'journeyVersionId': journeyVersionId,'jobId': jobId },
30617
+ { },
30618
+ { },
30619
+ { },
30620
+ null,
30621
+ ['PureCloud OAuth'],
30622
+ ['application/json'],
30623
+ ['application/json']
30624
+ );
30625
+ }
30626
+
30627
+ /**
30628
+ * Get the result of a job for a journey view version.
30629
+ * used for long descriptions
30630
+ * @param {String} viewId JourneyViewResult id
30631
+ * @param {String} journeyViewVersion Journey View Version
30632
+ * @param {String} jobId Id of the executing job
30633
+ * getJourneyViewVersionJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
30634
+ */
30635
+ getJourneyViewVersionJobResults(viewId, journeyViewVersion, jobId) {
30636
+ // verify the required parameter 'viewId' is set
30637
+ if (viewId === undefined || viewId === null) {
30638
+ throw 'Missing the required parameter "viewId" when calling getJourneyViewVersionJobResults';
30639
+ }
30640
+ // verify the required parameter 'journeyViewVersion' is set
30641
+ if (journeyViewVersion === undefined || journeyViewVersion === null) {
30642
+ throw 'Missing the required parameter "journeyViewVersion" when calling getJourneyViewVersionJobResults';
30643
+ }
30644
+ // verify the required parameter 'jobId' is set
30645
+ if (jobId === undefined || jobId === null) {
30646
+ throw 'Missing the required parameter "jobId" when calling getJourneyViewVersionJobResults';
30647
+ }
30648
+
30649
+ return this.apiClient.callApi(
30650
+ '/api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/jobs/{jobId}/results',
30651
+ 'GET',
30652
+ { 'viewId': viewId,'journeyViewVersion': journeyViewVersion,'jobId': jobId },
30653
+ { },
30654
+ { },
30655
+ { },
30656
+ null,
30657
+ ['PureCloud OAuth'],
30658
+ ['application/json'],
30659
+ ['application/json']
30660
+ );
30661
+ }
30662
+
30663
+ /**
30664
+ * Get the latest job of a journey view version.
30665
+ * used for long descriptions
30666
+ * @param {String} viewId Journey View Id
30667
+ * @param {String} journeyVersionId Journey View Version
30668
+ * getJourneyViewVersionJobsLatest is a preview method and is subject to both breaking and non-breaking changes at any time without notice
30669
+ */
30670
+ getJourneyViewVersionJobsLatest(viewId, journeyVersionId) {
30671
+ // verify the required parameter 'viewId' is set
30672
+ if (viewId === undefined || viewId === null) {
30673
+ throw 'Missing the required parameter "viewId" when calling getJourneyViewVersionJobsLatest';
30674
+ }
30675
+ // verify the required parameter 'journeyVersionId' is set
30676
+ if (journeyVersionId === undefined || journeyVersionId === null) {
30677
+ throw 'Missing the required parameter "journeyVersionId" when calling getJourneyViewVersionJobsLatest';
30678
+ }
30679
+
30680
+ return this.apiClient.callApi(
30681
+ '/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/latest',
30682
+ 'GET',
30683
+ { 'viewId': viewId,'journeyVersionId': journeyVersionId },
30684
+ { },
30685
+ { },
30686
+ { },
30687
+ null,
30688
+ ['PureCloud OAuth'],
30689
+ ['application/json'],
30690
+ ['application/json']
30691
+ );
30692
+ }
30693
+
30520
30694
  /**
30521
30695
  * Get a list of Journey Views
30522
30696
  *
@@ -30538,6 +30712,53 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
30538
30712
  );
30539
30713
  }
30540
30714
 
30715
+ /**
30716
+ * Get an Event Definition
30717
+ *
30718
+ * @param {String} eventDefinitionId Event Definition ID
30719
+ * getJourneyViewsEventdefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
30720
+ */
30721
+ getJourneyViewsEventdefinition(eventDefinitionId) {
30722
+ // verify the required parameter 'eventDefinitionId' is set
30723
+ if (eventDefinitionId === undefined || eventDefinitionId === null) {
30724
+ throw 'Missing the required parameter "eventDefinitionId" when calling getJourneyViewsEventdefinition';
30725
+ }
30726
+
30727
+ return this.apiClient.callApi(
30728
+ '/api/v2/journey/views/eventdefinitions/{eventDefinitionId}',
30729
+ 'GET',
30730
+ { 'eventDefinitionId': eventDefinitionId },
30731
+ { },
30732
+ { },
30733
+ { },
30734
+ null,
30735
+ ['PureCloud OAuth'],
30736
+ ['application/json'],
30737
+ ['application/json']
30738
+ );
30739
+ }
30740
+
30741
+ /**
30742
+ * Get a list of Event Definitions
30743
+ *
30744
+ * getJourneyViewsEventdefinitions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
30745
+ */
30746
+ getJourneyViewsEventdefinitions() {
30747
+
30748
+ return this.apiClient.callApi(
30749
+ '/api/v2/journey/views/eventdefinitions',
30750
+ 'GET',
30751
+ { },
30752
+ { },
30753
+ { },
30754
+ { },
30755
+ null,
30756
+ ['PureCloud OAuth'],
30757
+ ['application/json'],
30758
+ ['application/json']
30759
+ );
30760
+ }
30761
+
30541
30762
  /**
30542
30763
  * Update single action map.
30543
30764
  *
@@ -30988,6 +31209,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
30988
31209
  );
30989
31210
  }
30990
31211
 
31212
+ /**
31213
+ * Submit a job request for a journey view version.
31214
+ * used for long descriptions
31215
+ * @param {String} viewId Journey View Id
31216
+ * @param {String} journeyVersionId Journey View Version
31217
+ * postJourneyViewVersionJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
31218
+ */
31219
+ postJourneyViewVersionJobs(viewId, journeyVersionId) {
31220
+ // verify the required parameter 'viewId' is set
31221
+ if (viewId === undefined || viewId === null) {
31222
+ throw 'Missing the required parameter "viewId" when calling postJourneyViewVersionJobs';
31223
+ }
31224
+ // verify the required parameter 'journeyVersionId' is set
31225
+ if (journeyVersionId === undefined || journeyVersionId === null) {
31226
+ throw 'Missing the required parameter "journeyVersionId" when calling postJourneyViewVersionJobs';
31227
+ }
31228
+
31229
+ return this.apiClient.callApi(
31230
+ '/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs',
31231
+ 'POST',
31232
+ { 'viewId': viewId,'journeyVersionId': journeyVersionId },
31233
+ { },
31234
+ { },
31235
+ { },
31236
+ null,
31237
+ ['PureCloud OAuth'],
31238
+ ['application/json'],
31239
+ ['application/json']
31240
+ );
31241
+ }
31242
+
30991
31243
  /**
30992
31244
  * Update a Journey View by ID
30993
31245
  * creates a new version
@@ -31045,13 +31297,38 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
31045
31297
  );
31046
31298
  }
31047
31299
 
31300
+ /**
31301
+ * Validate whether an encoding exist for a label/value combination.
31302
+ * True indicates a valid encoding
31303
+ * @param {Object} opts Optional parameters
31304
+ * @param {Array.<Object>} opts.body
31305
+ * postJourneyViewsEncodingsValidate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
31306
+ */
31307
+ postJourneyViewsEncodingsValidate(opts) {
31308
+ opts = opts || {};
31309
+
31310
+
31311
+ return this.apiClient.callApi(
31312
+ '/api/v2/journey/views/encodings/validate',
31313
+ 'POST',
31314
+ { },
31315
+ { },
31316
+ { },
31317
+ { },
31318
+ opts['body'],
31319
+ ['PureCloud OAuth'],
31320
+ ['application/json'],
31321
+ ['application/json']
31322
+ );
31323
+ }
31324
+
31048
31325
  }
31049
31326
 
31050
31327
  class KnowledgeApi {
31051
31328
  /**
31052
31329
  * Knowledge service.
31053
31330
  * @module purecloud-platform-client-v2/api/KnowledgeApi
31054
- * @version 189.0.0
31331
+ * @version 190.0.0
31055
31332
  */
31056
31333
 
31057
31334
  /**
@@ -34294,7 +34571,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
34294
34571
  /**
34295
34572
  * LanguageUnderstanding service.
34296
34573
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
34297
- * @version 189.0.0
34574
+ * @version 190.0.0
34298
34575
  */
34299
34576
 
34300
34577
  /**
@@ -35307,7 +35584,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
35307
35584
  /**
35308
35585
  * Languages service.
35309
35586
  * @module purecloud-platform-client-v2/api/LanguagesApi
35310
- * @version 189.0.0
35587
+ * @version 190.0.0
35311
35588
  */
35312
35589
 
35313
35590
  /**
@@ -35529,7 +35806,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
35529
35806
  /**
35530
35807
  * Learning service.
35531
35808
  * @module purecloud-platform-client-v2/api/LearningApi
35532
- * @version 189.0.0
35809
+ * @version 190.0.0
35533
35810
  */
35534
35811
 
35535
35812
  /**
@@ -36385,7 +36662,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
36385
36662
  /**
36386
36663
  * License service.
36387
36664
  * @module purecloud-platform-client-v2/api/LicenseApi
36388
- * @version 189.0.0
36665
+ * @version 190.0.0
36389
36666
  */
36390
36667
 
36391
36668
  /**
@@ -36623,7 +36900,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
36623
36900
  /**
36624
36901
  * Locations service.
36625
36902
  * @module purecloud-platform-client-v2/api/LocationsApi
36626
- * @version 189.0.0
36903
+ * @version 190.0.0
36627
36904
  */
36628
36905
 
36629
36906
  /**
@@ -36859,7 +37136,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
36859
37136
  /**
36860
37137
  * LogCapture service.
36861
37138
  * @module purecloud-platform-client-v2/api/LogCaptureApi
36862
- * @version 189.0.0
37139
+ * @version 190.0.0
36863
37140
  */
36864
37141
 
36865
37142
  /**
@@ -37059,7 +37336,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
37059
37336
  /**
37060
37337
  * Messaging service.
37061
37338
  * @module purecloud-platform-client-v2/api/MessagingApi
37062
- * @version 189.0.0
37339
+ * @version 190.0.0
37063
37340
  */
37064
37341
 
37065
37342
  /**
@@ -37418,7 +37695,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
37418
37695
  /**
37419
37696
  * MobileDevices service.
37420
37697
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
37421
- * @version 189.0.0
37698
+ * @version 190.0.0
37422
37699
  */
37423
37700
 
37424
37701
  /**
@@ -37569,7 +37846,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
37569
37846
  /**
37570
37847
  * Notifications service.
37571
37848
  * @module purecloud-platform-client-v2/api/NotificationsApi
37572
- * @version 189.0.0
37849
+ * @version 190.0.0
37573
37850
  */
37574
37851
 
37575
37852
  /**
@@ -37802,7 +38079,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
37802
38079
  /**
37803
38080
  * OAuth service.
37804
38081
  * @module purecloud-platform-client-v2/api/OAuthApi
37805
- * @version 189.0.0
38082
+ * @version 190.0.0
37806
38083
  */
37807
38084
 
37808
38085
  /**
@@ -38168,7 +38445,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
38168
38445
  /**
38169
38446
  * Objects service.
38170
38447
  * @module purecloud-platform-client-v2/api/ObjectsApi
38171
- * @version 189.0.0
38448
+ * @version 190.0.0
38172
38449
  */
38173
38450
 
38174
38451
  /**
@@ -38438,7 +38715,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
38438
38715
  /**
38439
38716
  * OperationalEvents service.
38440
38717
  * @module purecloud-platform-client-v2/api/OperationalEventsApi
38441
- * @version 189.0.0
38718
+ * @version 190.0.0
38442
38719
  */
38443
38720
 
38444
38721
  /**
@@ -38504,7 +38781,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
38504
38781
  /**
38505
38782
  * Organization service.
38506
38783
  * @module purecloud-platform-client-v2/api/OrganizationApi
38507
- * @version 189.0.0
38784
+ * @version 190.0.0
38508
38785
  */
38509
38786
 
38510
38787
  /**
@@ -38661,7 +38938,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
38661
38938
  }
38662
38939
 
38663
38940
  /**
38664
- * Get a link to the limit documentation
38941
+ * Get limit documentation
38665
38942
  *
38666
38943
  */
38667
38944
  getOrganizationsLimitsDocs() {
@@ -38959,7 +39236,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
38959
39236
  /**
38960
39237
  * OrganizationAuthorization service.
38961
39238
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
38962
- * @version 189.0.0
39239
+ * @version 190.0.0
38963
39240
  */
38964
39241
 
38965
39242
  /**
@@ -40306,7 +40583,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
40306
40583
  /**
40307
40584
  * Outbound service.
40308
40585
  * @module purecloud-platform-client-v2/api/OutboundApi
40309
- * @version 189.0.0
40586
+ * @version 190.0.0
40310
40587
  */
40311
40588
 
40312
40589
  /**
@@ -44547,7 +44824,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
44547
44824
  /**
44548
44825
  * Presence service.
44549
44826
  * @module purecloud-platform-client-v2/api/PresenceApi
44550
- * @version 189.0.0
44827
+ * @version 190.0.0
44551
44828
  */
44552
44829
 
44553
44830
  /**
@@ -45291,7 +45568,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
45291
45568
  /**
45292
45569
  * ProcessAutomation service.
45293
45570
  * @module purecloud-platform-client-v2/api/ProcessAutomationApi
45294
- * @version 189.0.0
45571
+ * @version 190.0.0
45295
45572
  */
45296
45573
 
45297
45574
  /**
@@ -45530,7 +45807,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
45530
45807
  /**
45531
45808
  * Quality service.
45532
45809
  * @module purecloud-platform-client-v2/api/QualityApi
45533
- * @version 189.0.0
45810
+ * @version 190.0.0
45534
45811
  */
45535
45812
 
45536
45813
  /**
@@ -47287,7 +47564,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
47287
47564
  /**
47288
47565
  * Recording service.
47289
47566
  * @module purecloud-platform-client-v2/api/RecordingApi
47290
- * @version 189.0.0
47567
+ * @version 190.0.0
47291
47568
  */
47292
47569
 
47293
47570
  /**
@@ -48196,6 +48473,27 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
48196
48473
  );
48197
48474
  }
48198
48475
 
48476
+ /**
48477
+ * Retrieves an object containing the total number of concurrent active screen recordings
48478
+ *
48479
+ * getRecordingsScreensessionsDetails is a preview method and is subject to both breaking and non-breaking changes at any time without notice
48480
+ */
48481
+ getRecordingsScreensessionsDetails() {
48482
+
48483
+ return this.apiClient.callApi(
48484
+ '/api/v2/recordings/screensessions/details',
48485
+ 'GET',
48486
+ { },
48487
+ { },
48488
+ { },
48489
+ { },
48490
+ null,
48491
+ ['PureCloud OAuth'],
48492
+ ['application/json'],
48493
+ ['application/json']
48494
+ );
48495
+ }
48496
+
48199
48497
  /**
48200
48498
  * Patch a media retention policy
48201
48499
  *
@@ -48924,7 +49222,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
48924
49222
  /**
48925
49223
  * ResponseManagement service.
48926
49224
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
48927
- * @version 189.0.0
49225
+ * @version 190.0.0
48928
49226
  */
48929
49227
 
48930
49228
  /**
@@ -49409,7 +49707,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
49409
49707
  /**
49410
49708
  * Routing service.
49411
49709
  * @module purecloud-platform-client-v2/api/RoutingApi
49412
- * @version 189.0.0
49710
+ * @version 190.0.0
49413
49711
  */
49414
49712
 
49415
49713
  /**
@@ -50857,11 +51155,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50857
51155
  * @param {Number} opts.pageNumber Page number (default to 1)
50858
51156
  * @param {Number} opts.pageSize Page size (default to 25)
50859
51157
  * @param {Object} opts.sortOrder Note: results are sorted by name. (default to asc)
50860
- * @param {String} opts.name Filter by queue name
50861
- * @param {Array.<String>} opts.id Filter by queue ID(s)
50862
- * @param {Array.<String>} opts.divisionId Filter by queue division ID(s)
50863
- * @param {Array.<String>} opts.peerId Filter by queue peer ID(s)
50864
- * @param {Boolean} opts.hasPeer Filter by queues associated with peer
51158
+ * @param {String} opts.name Include only queues with the given name (leading and trailing asterisks allowed)
51159
+ * @param {Array.<String>} opts.id Include only queues with the specified ID(s)
51160
+ * @param {Array.<String>} opts.divisionId Include only queues in the specified division ID(s)
51161
+ * @param {Array.<String>} opts.peerId Include only queues with the specified peer ID(s)
51162
+ * @param {String} opts.cannedResponseLibraryId Include only queues explicitly associated with the specified canned response library ID
51163
+ * @param {Boolean} opts.hasPeer Include only queues with a peer ID
50865
51164
  */
50866
51165
  getRoutingQueues(opts) {
50867
51166
  opts = opts || {};
@@ -50871,7 +51170,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50871
51170
  '/api/v2/routing/queues',
50872
51171
  'GET',
50873
51172
  { },
50874
- { 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'name': opts['name'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi'),'peerId': this.apiClient.buildCollectionParam(opts['peerId'], 'multi'),'hasPeer': opts['hasPeer'] },
51173
+ { 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'name': opts['name'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi'),'peerId': this.apiClient.buildCollectionParam(opts['peerId'], 'multi'),'cannedResponseLibraryId': opts['cannedResponseLibraryId'],'hasPeer': opts['hasPeer'] },
50875
51174
  { },
50876
51175
  { },
50877
51176
  null,
@@ -53362,7 +53661,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
53362
53661
  /**
53363
53662
  * SCIM service.
53364
53663
  * @module purecloud-platform-client-v2/api/SCIMApi
53365
- * @version 189.0.0
53664
+ * @version 190.0.0
53366
53665
  */
53367
53666
 
53368
53667
  /**
@@ -54239,7 +54538,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
54239
54538
  /**
54240
54539
  * ScreenRecording service.
54241
54540
  * @module purecloud-platform-client-v2/api/ScreenRecordingApi
54242
- * @version 189.0.0
54541
+ * @version 190.0.0
54243
54542
  */
54244
54543
 
54245
54544
  /**
@@ -54284,7 +54583,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
54284
54583
  /**
54285
54584
  * Scripts service.
54286
54585
  * @module purecloud-platform-client-v2/api/ScriptsApi
54287
- * @version 189.0.0
54586
+ * @version 190.0.0
54288
54587
  */
54289
54588
 
54290
54589
  /**
@@ -54728,7 +55027,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
54728
55027
  /**
54729
55028
  * Search service.
54730
55029
  * @module purecloud-platform-client-v2/api/SearchApi
54731
- * @version 189.0.0
55030
+ * @version 190.0.0
54732
55031
  */
54733
55032
 
54734
55033
  /**
@@ -55417,7 +55716,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
55417
55716
  /**
55418
55717
  * Settings service.
55419
55718
  * @module purecloud-platform-client-v2/api/SettingsApi
55420
- * @version 189.0.0
55719
+ * @version 190.0.0
55421
55720
  */
55422
55721
 
55423
55722
  /**
@@ -55529,7 +55828,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
55529
55828
  /**
55530
55829
  * SpeechTextAnalytics service.
55531
55830
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
55532
- * @version 189.0.0
55831
+ * @version 190.0.0
55533
55832
  */
55534
55833
 
55535
55834
  /**
@@ -56643,7 +56942,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
56643
56942
  /**
56644
56943
  * Stations service.
56645
56944
  * @module purecloud-platform-client-v2/api/StationsApi
56646
- * @version 189.0.0
56945
+ * @version 190.0.0
56647
56946
  */
56648
56947
 
56649
56948
  /**
@@ -56745,7 +57044,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
56745
57044
  /**
56746
57045
  * Suggest service.
56747
57046
  * @module purecloud-platform-client-v2/api/SuggestApi
56748
- * @version 189.0.0
57047
+ * @version 190.0.0
56749
57048
  */
56750
57049
 
56751
57050
  /**
@@ -56884,7 +57183,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
56884
57183
  /**
56885
57184
  * TaskManagement service.
56886
57185
  * @module purecloud-platform-client-v2/api/TaskManagementApi
56887
- * @version 189.0.0
57186
+ * @version 190.0.0
56888
57187
  */
56889
57188
 
56890
57189
  /**
@@ -58191,7 +58490,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58191
58490
  /**
58192
58491
  * Teams service.
58193
58492
  * @module purecloud-platform-client-v2/api/TeamsApi
58194
- * @version 189.0.0
58493
+ * @version 190.0.0
58195
58494
  */
58196
58495
 
58197
58496
  /**
@@ -58493,7 +58792,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58493
58792
  /**
58494
58793
  * Telephony service.
58495
58794
  * @module purecloud-platform-client-v2/api/TelephonyApi
58496
- * @version 189.0.0
58795
+ * @version 190.0.0
58497
58796
  */
58498
58797
 
58499
58798
  /**
@@ -58675,7 +58974,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58675
58974
  /**
58676
58975
  * TelephonyProvidersEdge service.
58677
58976
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
58678
- * @version 189.0.0
58977
+ * @version 190.0.0
58679
58978
  */
58680
58979
 
58681
58980
  /**
@@ -62024,7 +62323,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
62024
62323
  /**
62025
62324
  * Textbots service.
62026
62325
  * @module purecloud-platform-client-v2/api/TextbotsApi
62027
- * @version 189.0.0
62326
+ * @version 190.0.0
62028
62327
  */
62029
62328
 
62030
62329
  /**
@@ -62152,7 +62451,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
62152
62451
  /**
62153
62452
  * Tokens service.
62154
62453
  * @module purecloud-platform-client-v2/api/TokensApi
62155
- * @version 189.0.0
62454
+ * @version 190.0.0
62156
62455
  */
62157
62456
 
62158
62457
  /**
@@ -62306,7 +62605,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
62306
62605
  /**
62307
62606
  * Uploads service.
62308
62607
  * @module purecloud-platform-client-v2/api/UploadsApi
62309
- * @version 189.0.0
62608
+ * @version 190.0.0
62310
62609
  */
62311
62610
 
62312
62611
  /**
@@ -62575,7 +62874,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
62575
62874
  /**
62576
62875
  * Usage service.
62577
62876
  * @module purecloud-platform-client-v2/api/UsageApi
62578
- * @version 189.0.0
62877
+ * @version 190.0.0
62579
62878
  */
62580
62879
 
62581
62880
  /**
@@ -62785,7 +63084,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
62785
63084
  /**
62786
63085
  * UserRecordings service.
62787
63086
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
62788
- * @version 189.0.0
63087
+ * @version 190.0.0
62789
63088
  */
62790
63089
 
62791
63090
  /**
@@ -62970,7 +63269,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
62970
63269
  /**
62971
63270
  * Users service.
62972
63271
  * @module purecloud-platform-client-v2/api/UsersApi
62973
- * @version 189.0.0
63272
+ * @version 190.0.0
62974
63273
  */
62975
63274
 
62976
63275
  /**
@@ -65621,7 +65920,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
65621
65920
  /**
65622
65921
  * Utilities service.
65623
65922
  * @module purecloud-platform-client-v2/api/UtilitiesApi
65624
- * @version 189.0.0
65923
+ * @version 190.0.0
65625
65924
  */
65626
65925
 
65627
65926
  /**
@@ -65732,7 +66031,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
65732
66031
  /**
65733
66032
  * Voicemail service.
65734
66033
  * @module purecloud-platform-client-v2/api/VoicemailApi
65735
- * @version 189.0.0
66034
+ * @version 190.0.0
65736
66035
  */
65737
66036
 
65738
66037
  /**
@@ -66399,7 +66698,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
66399
66698
  /**
66400
66699
  * WebChat service.
66401
66700
  * @module purecloud-platform-client-v2/api/WebChatApi
66402
- * @version 189.0.0
66701
+ * @version 190.0.0
66403
66702
  */
66404
66703
 
66405
66704
  /**
@@ -66948,7 +67247,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
66948
67247
  /**
66949
67248
  * WebDeployments service.
66950
67249
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
66951
- * @version 189.0.0
67250
+ * @version 190.0.0
66952
67251
  */
66953
67252
 
66954
67253
  /**
@@ -67475,7 +67774,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
67475
67774
  /**
67476
67775
  * WebMessaging service.
67477
67776
  * @module purecloud-platform-client-v2/api/WebMessagingApi
67478
- * @version 189.0.0
67777
+ * @version 190.0.0
67479
67778
  */
67480
67779
 
67481
67780
  /**
@@ -67521,7 +67820,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
67521
67820
  /**
67522
67821
  * Widgets service.
67523
67822
  * @module purecloud-platform-client-v2/api/WidgetsApi
67524
- * @version 189.0.0
67823
+ * @version 190.0.0
67525
67824
  */
67526
67825
 
67527
67826
  /**
@@ -67667,7 +67966,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
67667
67966
  /**
67668
67967
  * WorkforceManagement service.
67669
67968
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
67670
- * @version 189.0.0
67969
+ * @version 190.0.0
67671
67970
  */
67672
67971
 
67673
67972
  /**
@@ -67827,6 +68126,96 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
67827
68126
  );
67828
68127
  }
67829
68128
 
68129
+ /**
68130
+ * Deletes a staffing group
68131
+ *
68132
+ * @param {String} businessUnitId The ID of the business unit
68133
+ * @param {String} staffingGroupId The ID of the staffing group to delete
68134
+ */
68135
+ deleteWorkforcemanagementBusinessunitStaffinggroup(businessUnitId, staffingGroupId) {
68136
+ // verify the required parameter 'businessUnitId' is set
68137
+ if (businessUnitId === undefined || businessUnitId === null) {
68138
+ throw 'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitStaffinggroup';
68139
+ }
68140
+ // verify the required parameter 'staffingGroupId' is set
68141
+ if (staffingGroupId === undefined || staffingGroupId === null) {
68142
+ throw 'Missing the required parameter "staffingGroupId" when calling deleteWorkforcemanagementBusinessunitStaffinggroup';
68143
+ }
68144
+
68145
+ return this.apiClient.callApi(
68146
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/{staffingGroupId}',
68147
+ 'DELETE',
68148
+ { 'businessUnitId': businessUnitId,'staffingGroupId': staffingGroupId },
68149
+ { },
68150
+ { },
68151
+ { },
68152
+ null,
68153
+ ['PureCloud OAuth'],
68154
+ ['application/json'],
68155
+ ['application/json']
68156
+ );
68157
+ }
68158
+
68159
+ /**
68160
+ * Deletes a time-off limit object
68161
+ *
68162
+ * @param {String} businessUnitId The ID of the business unit
68163
+ * @param {String} timeOffLimitId The ID of the time-off limit object to delete
68164
+ */
68165
+ deleteWorkforcemanagementBusinessunitTimeofflimit(businessUnitId, timeOffLimitId) {
68166
+ // verify the required parameter 'businessUnitId' is set
68167
+ if (businessUnitId === undefined || businessUnitId === null) {
68168
+ throw 'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitTimeofflimit';
68169
+ }
68170
+ // verify the required parameter 'timeOffLimitId' is set
68171
+ if (timeOffLimitId === undefined || timeOffLimitId === null) {
68172
+ throw 'Missing the required parameter "timeOffLimitId" when calling deleteWorkforcemanagementBusinessunitTimeofflimit';
68173
+ }
68174
+
68175
+ return this.apiClient.callApi(
68176
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}',
68177
+ 'DELETE',
68178
+ { 'businessUnitId': businessUnitId,'timeOffLimitId': timeOffLimitId },
68179
+ { },
68180
+ { },
68181
+ { },
68182
+ null,
68183
+ ['PureCloud OAuth'],
68184
+ ['application/json'],
68185
+ ['application/json']
68186
+ );
68187
+ }
68188
+
68189
+ /**
68190
+ * Deletes a time-off plan
68191
+ *
68192
+ * @param {String} businessUnitId The ID of the business unit
68193
+ * @param {String} timeOffPlanId The ID of the time-off plan to delete
68194
+ */
68195
+ deleteWorkforcemanagementBusinessunitTimeoffplan(businessUnitId, timeOffPlanId) {
68196
+ // verify the required parameter 'businessUnitId' is set
68197
+ if (businessUnitId === undefined || businessUnitId === null) {
68198
+ throw 'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitTimeoffplan';
68199
+ }
68200
+ // verify the required parameter 'timeOffPlanId' is set
68201
+ if (timeOffPlanId === undefined || timeOffPlanId === null) {
68202
+ throw 'Missing the required parameter "timeOffPlanId" when calling deleteWorkforcemanagementBusinessunitTimeoffplan';
68203
+ }
68204
+
68205
+ return this.apiClient.callApi(
68206
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans/{timeOffPlanId}',
68207
+ 'DELETE',
68208
+ { 'businessUnitId': businessUnitId,'timeOffPlanId': timeOffPlanId },
68209
+ { },
68210
+ { },
68211
+ { },
68212
+ null,
68213
+ ['PureCloud OAuth'],
68214
+ ['application/json'],
68215
+ ['application/json']
68216
+ );
68217
+ }
68218
+
67830
68219
  /**
67831
68220
  * Delete a schedule
67832
68221
  *
@@ -68649,6 +69038,184 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
68649
69038
  );
68650
69039
  }
68651
69040
 
69041
+ /**
69042
+ * Gets a staffing group
69043
+ *
69044
+ * @param {String} businessUnitId The ID of the business unit
69045
+ * @param {String} staffingGroupId The ID of the staffing group to fetch
69046
+ */
69047
+ getWorkforcemanagementBusinessunitStaffinggroup(businessUnitId, staffingGroupId) {
69048
+ // verify the required parameter 'businessUnitId' is set
69049
+ if (businessUnitId === undefined || businessUnitId === null) {
69050
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitStaffinggroup';
69051
+ }
69052
+ // verify the required parameter 'staffingGroupId' is set
69053
+ if (staffingGroupId === undefined || staffingGroupId === null) {
69054
+ throw 'Missing the required parameter "staffingGroupId" when calling getWorkforcemanagementBusinessunitStaffinggroup';
69055
+ }
69056
+
69057
+ return this.apiClient.callApi(
69058
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/{staffingGroupId}',
69059
+ 'GET',
69060
+ { 'businessUnitId': businessUnitId,'staffingGroupId': staffingGroupId },
69061
+ { },
69062
+ { },
69063
+ { },
69064
+ null,
69065
+ ['PureCloud OAuth'],
69066
+ ['application/json'],
69067
+ ['application/json']
69068
+ );
69069
+ }
69070
+
69071
+ /**
69072
+ * Gets a list of staffing groups
69073
+ *
69074
+ * @param {String} businessUnitId The ID of the business unit
69075
+ * @param {Object} opts Optional parameters
69076
+ * @param {String} opts.managementUnitId The ID of the management unit to get management unit specific staffing groups
69077
+ */
69078
+ getWorkforcemanagementBusinessunitStaffinggroups(businessUnitId, opts) {
69079
+ opts = opts || {};
69080
+
69081
+ // verify the required parameter 'businessUnitId' is set
69082
+ if (businessUnitId === undefined || businessUnitId === null) {
69083
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitStaffinggroups';
69084
+ }
69085
+
69086
+ return this.apiClient.callApi(
69087
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups',
69088
+ 'GET',
69089
+ { 'businessUnitId': businessUnitId },
69090
+ { 'managementUnitId': opts['managementUnitId'] },
69091
+ { },
69092
+ { },
69093
+ null,
69094
+ ['PureCloud OAuth'],
69095
+ ['application/json'],
69096
+ ['application/json']
69097
+ );
69098
+ }
69099
+
69100
+ /**
69101
+ * Gets a time-off limit object
69102
+ * Returns properties of time-off limit object, but not daily values
69103
+ * @param {String} businessUnitId The ID of the business unit
69104
+ * @param {String} timeOffLimitId The ID of the time-off limit to fetch
69105
+ */
69106
+ getWorkforcemanagementBusinessunitTimeofflimit(businessUnitId, timeOffLimitId) {
69107
+ // verify the required parameter 'businessUnitId' is set
69108
+ if (businessUnitId === undefined || businessUnitId === null) {
69109
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitTimeofflimit';
69110
+ }
69111
+ // verify the required parameter 'timeOffLimitId' is set
69112
+ if (timeOffLimitId === undefined || timeOffLimitId === null) {
69113
+ throw 'Missing the required parameter "timeOffLimitId" when calling getWorkforcemanagementBusinessunitTimeofflimit';
69114
+ }
69115
+
69116
+ return this.apiClient.callApi(
69117
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}',
69118
+ 'GET',
69119
+ { 'businessUnitId': businessUnitId,'timeOffLimitId': timeOffLimitId },
69120
+ { },
69121
+ { },
69122
+ { },
69123
+ null,
69124
+ ['PureCloud OAuth'],
69125
+ ['application/json'],
69126
+ ['application/json']
69127
+ );
69128
+ }
69129
+
69130
+ /**
69131
+ * Gets a list of time-off limit objects
69132
+ *
69133
+ * @param {String} businessUnitId The ID of the business unit
69134
+ * @param {Object} opts Optional parameters
69135
+ * @param {String} opts.managementUnitId The ID of the management unit to get management unit specific time-off limit objects
69136
+ */
69137
+ getWorkforcemanagementBusinessunitTimeofflimits(businessUnitId, opts) {
69138
+ opts = opts || {};
69139
+
69140
+ // verify the required parameter 'businessUnitId' is set
69141
+ if (businessUnitId === undefined || businessUnitId === null) {
69142
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitTimeofflimits';
69143
+ }
69144
+
69145
+ return this.apiClient.callApi(
69146
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits',
69147
+ 'GET',
69148
+ { 'businessUnitId': businessUnitId },
69149
+ { 'managementUnitId': opts['managementUnitId'] },
69150
+ { },
69151
+ { },
69152
+ null,
69153
+ ['PureCloud OAuth'],
69154
+ ['application/json'],
69155
+ ['application/json']
69156
+ );
69157
+ }
69158
+
69159
+ /**
69160
+ * Gets a time-off plan
69161
+ *
69162
+ * @param {String} businessUnitId The ID of the business unit
69163
+ * @param {String} timeOffPlanId The ID of the time-off plan to fetch
69164
+ */
69165
+ getWorkforcemanagementBusinessunitTimeoffplan(businessUnitId, timeOffPlanId) {
69166
+ // verify the required parameter 'businessUnitId' is set
69167
+ if (businessUnitId === undefined || businessUnitId === null) {
69168
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitTimeoffplan';
69169
+ }
69170
+ // verify the required parameter 'timeOffPlanId' is set
69171
+ if (timeOffPlanId === undefined || timeOffPlanId === null) {
69172
+ throw 'Missing the required parameter "timeOffPlanId" when calling getWorkforcemanagementBusinessunitTimeoffplan';
69173
+ }
69174
+
69175
+ return this.apiClient.callApi(
69176
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans/{timeOffPlanId}',
69177
+ 'GET',
69178
+ { 'businessUnitId': businessUnitId,'timeOffPlanId': timeOffPlanId },
69179
+ { },
69180
+ { },
69181
+ { },
69182
+ null,
69183
+ ['PureCloud OAuth'],
69184
+ ['application/json'],
69185
+ ['application/json']
69186
+ );
69187
+ }
69188
+
69189
+ /**
69190
+ * Gets a list of time-off plans
69191
+ *
69192
+ * @param {String} businessUnitId The ID of the business unit
69193
+ * @param {Object} opts Optional parameters
69194
+ * @param {String} opts.managementUnitId The ID of the management unit to get management unit specific staffing groups
69195
+ * @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
69196
+ */
69197
+ getWorkforcemanagementBusinessunitTimeoffplans(businessUnitId, opts) {
69198
+ opts = opts || {};
69199
+
69200
+ // verify the required parameter 'businessUnitId' is set
69201
+ if (businessUnitId === undefined || businessUnitId === null) {
69202
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitTimeoffplans';
69203
+ }
69204
+
69205
+ return this.apiClient.callApi(
69206
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans',
69207
+ 'GET',
69208
+ { 'businessUnitId': businessUnitId },
69209
+ { 'managementUnitId': opts['managementUnitId'],'forceDownloadService': opts['forceDownloadService'] },
69210
+ { },
69211
+ { },
69212
+ null,
69213
+ ['PureCloud OAuth'],
69214
+ ['application/json'],
69215
+ ['application/json']
69216
+ );
69217
+ }
69218
+
68652
69219
  /**
68653
69220
  * Get the metadata for the schedule, describing which management units and agents are in the scheduleSchedule data can then be loaded with the query route
68654
69221
  *
@@ -70461,6 +71028,74 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
70461
71028
  );
70462
71029
  }
70463
71030
 
71031
+ /**
71032
+ * Updates a staffing group
71033
+ *
71034
+ * @param {String} businessUnitId The ID of the business unit
71035
+ * @param {String} staffingGroupId The ID of the staffing group to update
71036
+ * @param {Object} opts Optional parameters
71037
+ * @param {Object} opts.body body
71038
+ */
71039
+ patchWorkforcemanagementBusinessunitStaffinggroup(businessUnitId, staffingGroupId, opts) {
71040
+ opts = opts || {};
71041
+
71042
+ // verify the required parameter 'businessUnitId' is set
71043
+ if (businessUnitId === undefined || businessUnitId === null) {
71044
+ throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitStaffinggroup';
71045
+ }
71046
+ // verify the required parameter 'staffingGroupId' is set
71047
+ if (staffingGroupId === undefined || staffingGroupId === null) {
71048
+ throw 'Missing the required parameter "staffingGroupId" when calling patchWorkforcemanagementBusinessunitStaffinggroup';
71049
+ }
71050
+
71051
+ return this.apiClient.callApi(
71052
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/{staffingGroupId}',
71053
+ 'PATCH',
71054
+ { 'businessUnitId': businessUnitId,'staffingGroupId': staffingGroupId },
71055
+ { },
71056
+ { },
71057
+ { },
71058
+ opts['body'],
71059
+ ['PureCloud OAuth'],
71060
+ ['application/json'],
71061
+ ['application/json']
71062
+ );
71063
+ }
71064
+
71065
+ /**
71066
+ * Updates a time-off plan
71067
+ *
71068
+ * @param {String} businessUnitId The ID of the business unit
71069
+ * @param {String} timeOffPlanId The ID of the time-off plan to update
71070
+ * @param {Object} opts Optional parameters
71071
+ * @param {Object} opts.body body
71072
+ */
71073
+ patchWorkforcemanagementBusinessunitTimeoffplan(businessUnitId, timeOffPlanId, opts) {
71074
+ opts = opts || {};
71075
+
71076
+ // verify the required parameter 'businessUnitId' is set
71077
+ if (businessUnitId === undefined || businessUnitId === null) {
71078
+ throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitTimeoffplan';
71079
+ }
71080
+ // verify the required parameter 'timeOffPlanId' is set
71081
+ if (timeOffPlanId === undefined || timeOffPlanId === null) {
71082
+ throw 'Missing the required parameter "timeOffPlanId" when calling patchWorkforcemanagementBusinessunitTimeoffplan';
71083
+ }
71084
+
71085
+ return this.apiClient.callApi(
71086
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans/{timeOffPlanId}',
71087
+ 'PATCH',
71088
+ { 'businessUnitId': businessUnitId,'timeOffPlanId': timeOffPlanId },
71089
+ { },
71090
+ { },
71091
+ { },
71092
+ opts['body'],
71093
+ ['PureCloud OAuth'],
71094
+ ['application/json'],
71095
+ ['application/json']
71096
+ );
71097
+ }
71098
+
70464
71099
  /**
70465
71100
  * Update the requested management unit
70466
71101
  *
@@ -71252,6 +71887,151 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
71252
71887
  );
71253
71888
  }
71254
71889
 
71890
+ /**
71891
+ * Creates a new staffing group
71892
+ *
71893
+ * @param {String} businessUnitId The ID of the business unit
71894
+ * @param {Object} opts Optional parameters
71895
+ * @param {Object} opts.body body
71896
+ */
71897
+ postWorkforcemanagementBusinessunitStaffinggroups(businessUnitId, opts) {
71898
+ opts = opts || {};
71899
+
71900
+ // verify the required parameter 'businessUnitId' is set
71901
+ if (businessUnitId === undefined || businessUnitId === null) {
71902
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitStaffinggroups';
71903
+ }
71904
+
71905
+ return this.apiClient.callApi(
71906
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups',
71907
+ 'POST',
71908
+ { 'businessUnitId': businessUnitId },
71909
+ { },
71910
+ { },
71911
+ { },
71912
+ opts['body'],
71913
+ ['PureCloud OAuth'],
71914
+ ['application/json'],
71915
+ ['application/json']
71916
+ );
71917
+ }
71918
+
71919
+ /**
71920
+ * Gets staffing group associations for a list of user IDs
71921
+ *
71922
+ * @param {String} businessUnitId The ID of the business unit
71923
+ * @param {Object} opts Optional parameters
71924
+ * @param {Object} opts.body body
71925
+ */
71926
+ postWorkforcemanagementBusinessunitStaffinggroupsQuery(businessUnitId, opts) {
71927
+ opts = opts || {};
71928
+
71929
+ // verify the required parameter 'businessUnitId' is set
71930
+ if (businessUnitId === undefined || businessUnitId === null) {
71931
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitStaffinggroupsQuery';
71932
+ }
71933
+
71934
+ return this.apiClient.callApi(
71935
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/query',
71936
+ 'POST',
71937
+ { 'businessUnitId': businessUnitId },
71938
+ { },
71939
+ { },
71940
+ { },
71941
+ opts['body'],
71942
+ ['PureCloud OAuth'],
71943
+ ['application/json'],
71944
+ ['application/json']
71945
+ );
71946
+ }
71947
+
71948
+ /**
71949
+ * Creates a new time-off limit object
71950
+ *
71951
+ * @param {String} businessUnitId The ID of the business unit
71952
+ * @param {Object} opts Optional parameters
71953
+ * @param {Object} opts.body body
71954
+ */
71955
+ postWorkforcemanagementBusinessunitTimeofflimits(businessUnitId, opts) {
71956
+ opts = opts || {};
71957
+
71958
+ // verify the required parameter 'businessUnitId' is set
71959
+ if (businessUnitId === undefined || businessUnitId === null) {
71960
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitTimeofflimits';
71961
+ }
71962
+
71963
+ return this.apiClient.callApi(
71964
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits',
71965
+ 'POST',
71966
+ { 'businessUnitId': businessUnitId },
71967
+ { },
71968
+ { },
71969
+ { },
71970
+ opts['body'],
71971
+ ['PureCloud OAuth'],
71972
+ ['application/json'],
71973
+ ['application/json']
71974
+ );
71975
+ }
71976
+
71977
+ /**
71978
+ * Retrieves time-off limit related values based on a given set of filters.
71979
+ *
71980
+ * @param {String} businessUnitId The ID of the business unit
71981
+ * @param {Object} opts Optional parameters
71982
+ * @param {Object} opts.body body
71983
+ */
71984
+ postWorkforcemanagementBusinessunitTimeofflimitsValuesQuery(businessUnitId, opts) {
71985
+ opts = opts || {};
71986
+
71987
+ // verify the required parameter 'businessUnitId' is set
71988
+ if (businessUnitId === undefined || businessUnitId === null) {
71989
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitTimeofflimitsValuesQuery';
71990
+ }
71991
+
71992
+ return this.apiClient.callApi(
71993
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/values/query',
71994
+ 'POST',
71995
+ { 'businessUnitId': businessUnitId },
71996
+ { },
71997
+ { },
71998
+ { },
71999
+ opts['body'],
72000
+ ['PureCloud OAuth'],
72001
+ ['application/json'],
72002
+ ['application/json']
72003
+ );
72004
+ }
72005
+
72006
+ /**
72007
+ * Creates a new time-off plan
72008
+ *
72009
+ * @param {String} businessUnitId The ID of the business unit
72010
+ * @param {Object} opts Optional parameters
72011
+ * @param {Object} opts.body body
72012
+ */
72013
+ postWorkforcemanagementBusinessunitTimeoffplans(businessUnitId, opts) {
72014
+ opts = opts || {};
72015
+
72016
+ // verify the required parameter 'businessUnitId' is set
72017
+ if (businessUnitId === undefined || businessUnitId === null) {
72018
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitTimeoffplans';
72019
+ }
72020
+
72021
+ return this.apiClient.callApi(
72022
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans',
72023
+ 'POST',
72024
+ { 'businessUnitId': businessUnitId },
72025
+ { },
72026
+ { },
72027
+ { },
72028
+ opts['body'],
72029
+ ['PureCloud OAuth'],
72030
+ ['application/json'],
72031
+ ['application/json']
72032
+ );
72033
+ }
72034
+
71255
72035
  /**
71256
72036
  * Loads agent schedule data from the schedule. Used in combination with the metadata route
71257
72037
  *
@@ -72998,6 +73778,40 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
72998
73778
  );
72999
73779
  }
73000
73780
 
73781
+ /**
73782
+ * Sets daily values for a date range of time-off limit object
73783
+ * Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time-off limit API
73784
+ * @param {String} businessUnitId The ID of the business unit
73785
+ * @param {String} timeOffLimitId The ID of the time-off limit object to set values for
73786
+ * @param {Object} opts Optional parameters
73787
+ * @param {Object} opts.body body
73788
+ */
73789
+ putWorkforcemanagementBusinessunitTimeofflimitValues(businessUnitId, timeOffLimitId, opts) {
73790
+ opts = opts || {};
73791
+
73792
+ // verify the required parameter 'businessUnitId' is set
73793
+ if (businessUnitId === undefined || businessUnitId === null) {
73794
+ throw 'Missing the required parameter "businessUnitId" when calling putWorkforcemanagementBusinessunitTimeofflimitValues';
73795
+ }
73796
+ // verify the required parameter 'timeOffLimitId' is set
73797
+ if (timeOffLimitId === undefined || timeOffLimitId === null) {
73798
+ throw 'Missing the required parameter "timeOffLimitId" when calling putWorkforcemanagementBusinessunitTimeofflimitValues';
73799
+ }
73800
+
73801
+ return this.apiClient.callApi(
73802
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}/values',
73803
+ 'PUT',
73804
+ { 'businessUnitId': businessUnitId,'timeOffLimitId': timeOffLimitId },
73805
+ { },
73806
+ { },
73807
+ { },
73808
+ opts['body'],
73809
+ ['PureCloud OAuth'],
73810
+ ['application/json'],
73811
+ ['application/json']
73812
+ );
73813
+ }
73814
+
73001
73815
  /**
73002
73816
  * Sets daily values for a date range of time off limit object
73003
73817
  * Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API
@@ -73063,7 +73877,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
73063
73877
  * </pre>
73064
73878
  * </p>
73065
73879
  * @module purecloud-platform-client-v2/index
73066
- * @version 189.0.0
73880
+ * @version 190.0.0
73067
73881
  */
73068
73882
  class platformClient {
73069
73883
  constructor() {