purecloud-platform-client-v2 190.0.0 → 192.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 +654 -173
  3. package/dist/web-amd/purecloud-platform-client-v2.js +654 -173
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +419 -288
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +467 -323
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +846 -290
  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 +162 -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 +13 -5
  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 +127 -39
  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 +50 -16
  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 +45 -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 +3 -2
  37. package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +22 -1
  40. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -2
  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 +1 -1
  52. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/OutboundApi.js +4 -3
  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 +3 -3
  57. package/src/purecloud-platform-client-v2/api/RecordingApi.js +3 -2
  58. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +26 -1
  59. package/src/purecloud-platform-client-v2/api/RoutingApi.js +27 -1
  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 +2 -2
  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 +79 -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 -22
  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 +11 -6
  76. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/UsersApi.js +13 -5
  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 +5 -3
  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 +1 -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 190.0.0
402
+ * @version 192.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 190.0.0
1821
+ * @version 192.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 190.0.0
2482
+ * @version 192.0.0
2483
2483
  */
2484
2484
 
2485
2485
  /**
@@ -3229,6 +3229,59 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
3229
3229
  );
3230
3230
  }
3231
3231
 
3232
+ /**
3233
+ * Get dashboards summary for a user
3234
+ *
3235
+ * @param {String} userId User ID
3236
+ */
3237
+ getAnalyticsReportingDashboardsUser(userId) {
3238
+ // verify the required parameter 'userId' is set
3239
+ if (userId === undefined || userId === null) {
3240
+ throw 'Missing the required parameter "userId" when calling getAnalyticsReportingDashboardsUser';
3241
+ }
3242
+
3243
+ return this.apiClient.callApi(
3244
+ '/api/v2/analytics/reporting/dashboards/users/{userId}',
3245
+ 'GET',
3246
+ { 'userId': userId },
3247
+ { },
3248
+ { },
3249
+ { },
3250
+ null,
3251
+ ['PureCloud OAuth'],
3252
+ ['application/json'],
3253
+ ['application/json']
3254
+ );
3255
+ }
3256
+
3257
+ /**
3258
+ * Get dashboards summary for users in a org
3259
+ *
3260
+ * @param {Object} opts Optional parameters
3261
+ * @param {String} opts.sortBy (default to asc)
3262
+ * @param {Number} opts.pageNumber (default to 1)
3263
+ * @param {Number} opts.pageSize (default to 25)
3264
+ * @param {Array.<String>} opts.id A list of user IDs to fetch by bulk
3265
+ * @param {Object} opts.state Only list users of this state
3266
+ */
3267
+ getAnalyticsReportingDashboardsUsers(opts) {
3268
+ opts = opts || {};
3269
+
3270
+
3271
+ return this.apiClient.callApi(
3272
+ '/api/v2/analytics/reporting/dashboards/users',
3273
+ 'GET',
3274
+ { },
3275
+ { 'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'state': opts['state'] },
3276
+ { },
3277
+ { },
3278
+ null,
3279
+ ['PureCloud OAuth'],
3280
+ ['application/json'],
3281
+ ['application/json']
3282
+ );
3283
+ }
3284
+
3232
3285
  /**
3233
3286
  * Get all view export requests for a user
3234
3287
  *
@@ -3504,6 +3557,39 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
3504
3557
  );
3505
3558
  }
3506
3559
 
3560
+ /**
3561
+ * Get list of dashboards for an user
3562
+ *
3563
+ * @param {String} userId User ID
3564
+ * @param {Object} opts Optional parameters
3565
+ * @param {String} opts.sortBy (default to asc)
3566
+ * @param {Number} opts.pageNumber (default to 1)
3567
+ * @param {Number} opts.pageSize (default to 50)
3568
+ * @param {Boolean} opts.publicOnly If true, retrieve only public dashboards
3569
+ * @param {Boolean} opts.favoriteOnly If true, retrieve only favorite dashboards
3570
+ */
3571
+ getAnalyticsReportingSettingsUserDashboards(userId, opts) {
3572
+ opts = opts || {};
3573
+
3574
+ // verify the required parameter 'userId' is set
3575
+ if (userId === undefined || userId === null) {
3576
+ throw 'Missing the required parameter "userId" when calling getAnalyticsReportingSettingsUserDashboards';
3577
+ }
3578
+
3579
+ return this.apiClient.callApi(
3580
+ '/api/v2/analytics/reporting/settings/users/{userId}/dashboards',
3581
+ 'GET',
3582
+ { 'userId': userId },
3583
+ { 'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'publicOnly': opts['publicOnly'],'favoriteOnly': opts['favoriteOnly'] },
3584
+ { },
3585
+ { },
3586
+ null,
3587
+ ['PureCloud OAuth'],
3588
+ ['application/json'],
3589
+ ['application/json']
3590
+ );
3591
+ }
3592
+
3507
3593
  /**
3508
3594
  * Get a list of report time periods.
3509
3595
  *
@@ -4554,6 +4640,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
4554
4640
  );
4555
4641
  }
4556
4642
 
4643
+ /**
4644
+ * Bulk delete dashboards owned by other user(s)
4645
+ *
4646
+ * @param {Array.<String>} body List of userIds
4647
+ */
4648
+ postAnalyticsReportingDashboardsUsersBulkRemove(body) {
4649
+ // verify the required parameter 'body' is set
4650
+ if (body === undefined || body === null) {
4651
+ throw 'Missing the required parameter "body" when calling postAnalyticsReportingDashboardsUsersBulkRemove';
4652
+ }
4653
+
4654
+ return this.apiClient.callApi(
4655
+ '/api/v2/analytics/reporting/dashboards/users/bulk/remove',
4656
+ 'POST',
4657
+ { },
4658
+ { },
4659
+ { },
4660
+ { },
4661
+ body,
4662
+ ['PureCloud OAuth'],
4663
+ ['application/json'],
4664
+ ['application/json']
4665
+ );
4666
+ }
4667
+
4557
4668
  /**
4558
4669
  * Generate a view export request
4559
4670
  * This API creates a reporting export but the desired way to export analytics data is to use the analytics query APIs instead
@@ -4631,6 +4742,56 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
4631
4742
  );
4632
4743
  }
4633
4744
 
4745
+ /**
4746
+ * Bulk remove dashboard configurations
4747
+ *
4748
+ * @param {Object} body
4749
+ */
4750
+ postAnalyticsReportingSettingsDashboardsBulkRemove(body) {
4751
+ // verify the required parameter 'body' is set
4752
+ if (body === undefined || body === null) {
4753
+ throw 'Missing the required parameter "body" when calling postAnalyticsReportingSettingsDashboardsBulkRemove';
4754
+ }
4755
+
4756
+ return this.apiClient.callApi(
4757
+ '/api/v2/analytics/reporting/settings/dashboards/bulk/remove',
4758
+ 'POST',
4759
+ { },
4760
+ { },
4761
+ { },
4762
+ { },
4763
+ body,
4764
+ ['PureCloud OAuth'],
4765
+ ['application/json'],
4766
+ ['application/json']
4767
+ );
4768
+ }
4769
+
4770
+ /**
4771
+ * Query dashboard configurations
4772
+ *
4773
+ * @param {Object} body
4774
+ */
4775
+ postAnalyticsReportingSettingsDashboardsQuery(body) {
4776
+ // verify the required parameter 'body' is set
4777
+ if (body === undefined || body === null) {
4778
+ throw 'Missing the required parameter "body" when calling postAnalyticsReportingSettingsDashboardsQuery';
4779
+ }
4780
+
4781
+ return this.apiClient.callApi(
4782
+ '/api/v2/analytics/reporting/settings/dashboards/query',
4783
+ 'POST',
4784
+ { },
4785
+ { },
4786
+ { },
4787
+ { },
4788
+ body,
4789
+ ['PureCloud OAuth'],
4790
+ ['application/json'],
4791
+ ['application/json']
4792
+ );
4793
+ }
4794
+
4634
4795
  /**
4635
4796
  * Query for resolution aggregates asynchronously
4636
4797
  *
@@ -5092,7 +5253,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
5092
5253
  /**
5093
5254
  * Architect service.
5094
5255
  * @module purecloud-platform-client-v2/api/ArchitectApi
5095
- * @version 190.0.0
5256
+ * @version 192.0.0
5096
5257
  */
5097
5258
 
5098
5259
  /**
@@ -9238,7 +9399,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
9238
9399
  /**
9239
9400
  * Audit service.
9240
9401
  * @module purecloud-platform-client-v2/api/AuditApi
9241
- * @version 190.0.0
9402
+ * @version 192.0.0
9242
9403
  */
9243
9404
 
9244
9405
  /**
@@ -9409,7 +9570,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
9409
9570
  /**
9410
9571
  * Authorization service.
9411
9572
  * @module purecloud-platform-client-v2/api/AuthorizationApi
9412
- * @version 190.0.0
9573
+ * @version 192.0.0
9413
9574
  */
9414
9575
 
9415
9576
  /**
@@ -9969,8 +10130,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
9969
10130
  * Returns a listing of roles and permissions for a user.
9970
10131
  *
9971
10132
  * @param {String} subjectId Subject ID (user or group)
10133
+ * @param {Object} opts Optional parameters
10134
+ * @param {Object} opts.includeDuplicates Include multiple entries with the same role and division but different subjects (default to false)
9972
10135
  */
9973
- getAuthorizationSubject(subjectId) {
10136
+ getAuthorizationSubject(subjectId, opts) {
10137
+ opts = opts || {};
10138
+
9974
10139
  // verify the required parameter 'subjectId' is set
9975
10140
  if (subjectId === undefined || subjectId === null) {
9976
10141
  throw 'Missing the required parameter "subjectId" when calling getAuthorizationSubject';
@@ -9980,7 +10145,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
9980
10145
  '/api/v2/authorization/subjects/{subjectId}',
9981
10146
  'GET',
9982
10147
  { 'subjectId': subjectId },
9983
- { },
10148
+ { 'includeDuplicates': opts['includeDuplicates'] },
9984
10149
  { },
9985
10150
  { },
9986
10151
  null,
@@ -9993,14 +10158,18 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
9993
10158
  /**
9994
10159
  * Returns a listing of roles and permissions for the currently authenticated user.
9995
10160
  *
10161
+ * @param {Object} opts Optional parameters
10162
+ * @param {Object} opts.includeDuplicates Include multiple entries with the same role and division but different subjects (default to false)
9996
10163
  */
9997
- getAuthorizationSubjectsMe() {
10164
+ getAuthorizationSubjectsMe(opts) {
10165
+ opts = opts || {};
10166
+
9998
10167
 
9999
10168
  return this.apiClient.callApi(
10000
10169
  '/api/v2/authorization/subjects/me',
10001
10170
  'GET',
10002
10171
  { },
10003
- { },
10172
+ { 'includeDuplicates': opts['includeDuplicates'] },
10004
10173
  { },
10005
10174
  { },
10006
10175
  null,
@@ -10639,7 +10808,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
10639
10808
  /**
10640
10809
  * Billing service.
10641
10810
  * @module purecloud-platform-client-v2/api/BillingApi
10642
- * @version 190.0.0
10811
+ * @version 192.0.0
10643
10812
  */
10644
10813
 
10645
10814
  /**
@@ -10719,7 +10888,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
10719
10888
  /**
10720
10889
  * CarrierServices service.
10721
10890
  * @module purecloud-platform-client-v2/api/CarrierServicesApi
10722
- * @version 190.0.0
10891
+ * @version 192.0.0
10723
10892
  */
10724
10893
 
10725
10894
  /**
@@ -10789,7 +10958,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
10789
10958
  /**
10790
10959
  * Chat service.
10791
10960
  * @module purecloud-platform-client-v2/api/ChatApi
10792
- * @version 190.0.0
10961
+ * @version 192.0.0
10793
10962
  */
10794
10963
 
10795
10964
  /**
@@ -10835,25 +11004,25 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
10835
11004
  }
10836
11005
 
10837
11006
  /**
10838
- * Remove a user from a room.
11007
+ * Remove a pinned message from a room
10839
11008
  *
10840
11009
  * @param {String} roomJid roomJid
10841
- * @param {String} userId userId
11010
+ * @param {String} pinnedMessageId pinnedMessageId
10842
11011
  */
10843
- deleteChatsRoomParticipant(roomJid, userId) {
11012
+ deleteChatsRoomMessagesPin(roomJid, pinnedMessageId) {
10844
11013
  // verify the required parameter 'roomJid' is set
10845
11014
  if (roomJid === undefined || roomJid === null) {
10846
- throw 'Missing the required parameter "roomJid" when calling deleteChatsRoomParticipant';
11015
+ throw 'Missing the required parameter "roomJid" when calling deleteChatsRoomMessagesPin';
10847
11016
  }
10848
- // verify the required parameter 'userId' is set
10849
- if (userId === undefined || userId === null) {
10850
- throw 'Missing the required parameter "userId" when calling deleteChatsRoomParticipant';
11017
+ // verify the required parameter 'pinnedMessageId' is set
11018
+ if (pinnedMessageId === undefined || pinnedMessageId === null) {
11019
+ throw 'Missing the required parameter "pinnedMessageId" when calling deleteChatsRoomMessagesPin';
10851
11020
  }
10852
11021
 
10853
11022
  return this.apiClient.callApi(
10854
- '/api/v2/chats/rooms/{roomJid}/participants/{userId}',
11023
+ '/api/v2/chats/rooms/{roomJid}/messages/pins/{pinnedMessageId}',
10855
11024
  'DELETE',
10856
- { 'roomJid': roomJid,'userId': userId },
11025
+ { 'roomJid': roomJid,'pinnedMessageId': pinnedMessageId },
10857
11026
  { },
10858
11027
  { },
10859
11028
  { },
@@ -10865,25 +11034,25 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
10865
11034
  }
10866
11035
 
10867
11036
  /**
10868
- * Remove a pinned message from a room
11037
+ * Remove a user from a room.
10869
11038
  *
10870
11039
  * @param {String} roomJid roomJid
10871
- * @param {String} pinnedMessageId pinnedMessageId
11040
+ * @param {String} userId userId
10872
11041
  */
10873
- deleteChatsRoomPinnedmessage(roomJid, pinnedMessageId) {
11042
+ deleteChatsRoomParticipant(roomJid, userId) {
10874
11043
  // verify the required parameter 'roomJid' is set
10875
11044
  if (roomJid === undefined || roomJid === null) {
10876
- throw 'Missing the required parameter "roomJid" when calling deleteChatsRoomPinnedmessage';
11045
+ throw 'Missing the required parameter "roomJid" when calling deleteChatsRoomParticipant';
10877
11046
  }
10878
- // verify the required parameter 'pinnedMessageId' is set
10879
- if (pinnedMessageId === undefined || pinnedMessageId === null) {
10880
- throw 'Missing the required parameter "pinnedMessageId" when calling deleteChatsRoomPinnedmessage';
11047
+ // verify the required parameter 'userId' is set
11048
+ if (userId === undefined || userId === null) {
11049
+ throw 'Missing the required parameter "userId" when calling deleteChatsRoomParticipant';
10881
11050
  }
10882
11051
 
10883
11052
  return this.apiClient.callApi(
10884
- '/api/v2/chats/rooms/{roomJid}/pinnedmessages/{pinnedMessageId}',
11053
+ '/api/v2/chats/rooms/{roomJid}/participants/{userId}',
10885
11054
  'DELETE',
10886
- { 'roomJid': roomJid,'pinnedMessageId': pinnedMessageId },
11055
+ { 'roomJid': roomJid,'userId': userId },
10887
11056
  { },
10888
11057
  { },
10889
11058
  { },
@@ -10924,6 +11093,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
10924
11093
  );
10925
11094
  }
10926
11095
 
11096
+ /**
11097
+ * Remove a pinned message from a 1on1
11098
+ *
11099
+ * @param {String} userId userId
11100
+ * @param {String} pinnedMessageId pinnedMessageId
11101
+ * deleteChatsUserMessagesPin is a preview method and is subject to both breaking and non-breaking changes at any time without notice
11102
+ */
11103
+ deleteChatsUserMessagesPin(userId, pinnedMessageId) {
11104
+ // verify the required parameter 'userId' is set
11105
+ if (userId === undefined || userId === null) {
11106
+ throw 'Missing the required parameter "userId" when calling deleteChatsUserMessagesPin';
11107
+ }
11108
+ // verify the required parameter 'pinnedMessageId' is set
11109
+ if (pinnedMessageId === undefined || pinnedMessageId === null) {
11110
+ throw 'Missing the required parameter "pinnedMessageId" when calling deleteChatsUserMessagesPin';
11111
+ }
11112
+
11113
+ return this.apiClient.callApi(
11114
+ '/api/v2/chats/users/{userId}/messages/pins/{pinnedMessageId}',
11115
+ 'DELETE',
11116
+ { 'userId': userId,'pinnedMessageId': pinnedMessageId },
11117
+ { },
11118
+ { },
11119
+ { },
11120
+ null,
11121
+ ['PureCloud OAuth'],
11122
+ ['application/json'],
11123
+ ['application/json']
11124
+ );
11125
+ }
11126
+
10927
11127
  /**
10928
11128
  * Get a message
10929
11129
  *
@@ -11141,6 +11341,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
11141
11341
  );
11142
11342
  }
11143
11343
 
11344
+ /**
11345
+ * Get information for a 1on1
11346
+ *
11347
+ * @param {String} userId userId
11348
+ * getChatsUser is a preview method and is subject to both breaking and non-breaking changes at any time without notice
11349
+ */
11350
+ getChatsUser(userId) {
11351
+ // verify the required parameter 'userId' is set
11352
+ if (userId === undefined || userId === null) {
11353
+ throw 'Missing the required parameter "userId" when calling getChatsUser';
11354
+ }
11355
+
11356
+ return this.apiClient.callApi(
11357
+ '/api/v2/chats/users/{userId}',
11358
+ 'GET',
11359
+ { 'userId': userId },
11360
+ { },
11361
+ { },
11362
+ { },
11363
+ null,
11364
+ ['PureCloud OAuth'],
11365
+ ['application/json'],
11366
+ ['application/json']
11367
+ );
11368
+ }
11369
+
11144
11370
  /**
11145
11371
  * Get messages by id(s) from a 1on1
11146
11372
  *
@@ -11415,29 +11641,29 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
11415
11641
  }
11416
11642
 
11417
11643
  /**
11418
- * Join a room
11644
+ * Add pinned messages for a room, up to a maximum of 5 pinned messages
11419
11645
  *
11420
11646
  * @param {String} roomJid roomJid
11421
- * @param {String} userId userId
11647
+ * @param {Object} body Pinned Message Ids
11422
11648
  */
11423
- postChatsRoomParticipant(roomJid, userId) {
11649
+ postChatsRoomMessagesPins(roomJid, body) {
11424
11650
  // verify the required parameter 'roomJid' is set
11425
11651
  if (roomJid === undefined || roomJid === null) {
11426
- throw 'Missing the required parameter "roomJid" when calling postChatsRoomParticipant';
11652
+ throw 'Missing the required parameter "roomJid" when calling postChatsRoomMessagesPins';
11427
11653
  }
11428
- // verify the required parameter 'userId' is set
11429
- if (userId === undefined || userId === null) {
11430
- throw 'Missing the required parameter "userId" when calling postChatsRoomParticipant';
11654
+ // verify the required parameter 'body' is set
11655
+ if (body === undefined || body === null) {
11656
+ throw 'Missing the required parameter "body" when calling postChatsRoomMessagesPins';
11431
11657
  }
11432
11658
 
11433
11659
  return this.apiClient.callApi(
11434
- '/api/v2/chats/rooms/{roomJid}/participants/{userId}',
11660
+ '/api/v2/chats/rooms/{roomJid}/messages/pins',
11435
11661
  'POST',
11436
- { 'roomJid': roomJid,'userId': userId },
11662
+ { 'roomJid': roomJid },
11437
11663
  { },
11438
11664
  { },
11439
11665
  { },
11440
- null,
11666
+ body,
11441
11667
  ['PureCloud OAuth'],
11442
11668
  ['application/json'],
11443
11669
  ['application/json']
@@ -11445,29 +11671,29 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
11445
11671
  }
11446
11672
 
11447
11673
  /**
11448
- * Add pinned messages for a room, up to a maximum of 5 pinned messages
11674
+ * Join a room
11449
11675
  *
11450
11676
  * @param {String} roomJid roomJid
11451
- * @param {Object} body Pinned Message Ids
11677
+ * @param {String} userId userId
11452
11678
  */
11453
- postChatsRoomPinnedmessages(roomJid, body) {
11679
+ postChatsRoomParticipant(roomJid, userId) {
11454
11680
  // verify the required parameter 'roomJid' is set
11455
11681
  if (roomJid === undefined || roomJid === null) {
11456
- throw 'Missing the required parameter "roomJid" when calling postChatsRoomPinnedmessages';
11682
+ throw 'Missing the required parameter "roomJid" when calling postChatsRoomParticipant';
11457
11683
  }
11458
- // verify the required parameter 'body' is set
11459
- if (body === undefined || body === null) {
11460
- throw 'Missing the required parameter "body" when calling postChatsRoomPinnedmessages';
11684
+ // verify the required parameter 'userId' is set
11685
+ if (userId === undefined || userId === null) {
11686
+ throw 'Missing the required parameter "userId" when calling postChatsRoomParticipant';
11461
11687
  }
11462
11688
 
11463
11689
  return this.apiClient.callApi(
11464
- '/api/v2/chats/rooms/{roomJid}/pinnedmessages',
11690
+ '/api/v2/chats/rooms/{roomJid}/participants/{userId}',
11465
11691
  'POST',
11466
- { 'roomJid': roomJid },
11692
+ { 'roomJid': roomJid,'userId': userId },
11467
11693
  { },
11468
11694
  { },
11469
11695
  { },
11470
- body,
11696
+ null,
11471
11697
  ['PureCloud OAuth'],
11472
11698
  ['application/json'],
11473
11699
  ['application/json']
@@ -11529,6 +11755,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
11529
11755
  );
11530
11756
  }
11531
11757
 
11758
+ /**
11759
+ * Add pinned messages for a 1on1, up to a maximum of 5 pinned messages
11760
+ *
11761
+ * @param {String} userId userId
11762
+ * @param {Object} body Pinned Message Ids
11763
+ * postChatsUserMessagesPins is a preview method and is subject to both breaking and non-breaking changes at any time without notice
11764
+ */
11765
+ postChatsUserMessagesPins(userId, body) {
11766
+ // verify the required parameter 'userId' is set
11767
+ if (userId === undefined || userId === null) {
11768
+ throw 'Missing the required parameter "userId" when calling postChatsUserMessagesPins';
11769
+ }
11770
+ // verify the required parameter 'body' is set
11771
+ if (body === undefined || body === null) {
11772
+ throw 'Missing the required parameter "body" when calling postChatsUserMessagesPins';
11773
+ }
11774
+
11775
+ return this.apiClient.callApi(
11776
+ '/api/v2/chats/users/{userId}/messages/pins',
11777
+ 'POST',
11778
+ { 'userId': userId },
11779
+ { },
11780
+ { },
11781
+ { },
11782
+ body,
11783
+ ['PureCloud OAuth'],
11784
+ ['application/json'],
11785
+ ['application/json']
11786
+ );
11787
+ }
11788
+
11532
11789
  /**
11533
11790
  * Update reactions to a message
11534
11791
  *
@@ -11590,7 +11847,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
11590
11847
  /**
11591
11848
  * Coaching service.
11592
11849
  * @module purecloud-platform-client-v2/api/CoachingApi
11593
- * @version 190.0.0
11850
+ * @version 192.0.0
11594
11851
  */
11595
11852
 
11596
11853
  /**
@@ -12167,7 +12424,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
12167
12424
  /**
12168
12425
  * ContentManagement service.
12169
12426
  * @module purecloud-platform-client-v2/api/ContentManagementApi
12170
- * @version 190.0.0
12427
+ * @version 192.0.0
12171
12428
  */
12172
12429
 
12173
12430
  /**
@@ -13249,7 +13506,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
13249
13506
  /**
13250
13507
  * Conversations service.
13251
13508
  * @module purecloud-platform-client-v2/api/ConversationsApi
13252
- * @version 190.0.0
13509
+ * @version 192.0.0
13253
13510
  */
13254
13511
 
13255
13512
  /**
@@ -14624,12 +14881,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
14624
14881
 
14625
14882
  /**
14626
14883
  * Get the wrap-up for this conversation communication.
14627
- *
14884
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
14628
14885
  * @param {String} conversationId conversationId
14629
14886
  * @param {String} participantId participantId
14630
14887
  * @param {String} communicationId communicationId
14631
14888
  * @param {Object} opts Optional parameters
14632
14889
  * @param {Boolean} opts.provisional Indicates if the wrap-up code is provisional. (default to false)
14890
+ * @deprecated
14633
14891
  */
14634
14892
  getConversationsCobrowsesessionParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
14635
14893
  opts = opts || {};
@@ -14663,11 +14921,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
14663
14921
 
14664
14922
  /**
14665
14923
  * Get the wrap-up for this conversation participant.
14666
- *
14924
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
14667
14925
  * @param {String} conversationId conversationId
14668
14926
  * @param {String} participantId participantId
14669
14927
  * @param {Object} opts Optional parameters
14670
14928
  * @param {Boolean} opts.provisional Indicates if the wrap-up code is provisional. (default to false)
14929
+ * @deprecated
14671
14930
  */
14672
14931
  getConversationsCobrowsesessionParticipantWrapup(conversationId, participantId, opts) {
14673
14932
  opts = opts || {};
@@ -14697,9 +14956,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
14697
14956
 
14698
14957
  /**
14699
14958
  * Get list of wrapup codes for this conversation participant
14700
- *
14959
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
14701
14960
  * @param {String} conversationId conversationId
14702
14961
  * @param {String} participantId participantId
14962
+ * @deprecated
14703
14963
  */
14704
14964
  getConversationsCobrowsesessionParticipantWrapupcodes(conversationId, participantId) {
14705
14965
  // verify the required parameter 'conversationId' is set
@@ -15360,6 +15620,26 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
15360
15620
  );
15361
15621
  }
15362
15622
 
15623
+ /**
15624
+ * Get a list of Facebook Permissions
15625
+ *
15626
+ */
15627
+ getConversationsMessagingFacebookPermissions() {
15628
+
15629
+ return this.apiClient.callApi(
15630
+ '/api/v2/conversations/messaging/facebook/permissions',
15631
+ 'GET',
15632
+ { },
15633
+ { },
15634
+ { },
15635
+ { },
15636
+ null,
15637
+ ['PureCloud OAuth'],
15638
+ ['application/json'],
15639
+ ['application/json']
15640
+ );
15641
+ }
15642
+
15363
15643
  /**
15364
15644
  * Get a list of Integrations
15365
15645
  *
@@ -15805,12 +16085,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
15805
16085
  }
15806
16086
 
15807
16087
  /**
15808
- * Get a list of Messaging Stickers
15809
- *
16088
+ * Get a list of Messaging Stickers (Deprecated)
16089
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-line-third-party-messaging-channel/
15810
16090
  * @param {Object} messengerType Messenger Type
15811
16091
  * @param {Object} opts Optional parameters
15812
16092
  * @param {Number} opts.pageSize Page size (default to 25)
15813
16093
  * @param {Number} opts.pageNumber Page number (default to 1)
16094
+ * @deprecated
15814
16095
  */
15815
16096
  getConversationsMessagingSticker(messengerType, opts) {
15816
16097
  opts = opts || {};
@@ -15926,12 +16207,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
15926
16207
 
15927
16208
  /**
15928
16209
  * Get the wrap-up for this conversation communication.
15929
- *
16210
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
15930
16211
  * @param {String} conversationId conversationId
15931
16212
  * @param {String} participantId participantId
15932
16213
  * @param {String} communicationId communicationId
15933
16214
  * @param {Object} opts Optional parameters
15934
16215
  * @param {Boolean} opts.provisional Indicates if the wrap-up code is provisional. (default to false)
16216
+ * @deprecated
15935
16217
  */
15936
16218
  getConversationsScreenshareParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
15937
16219
  opts = opts || {};
@@ -16735,9 +17017,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
16735
17017
 
16736
17018
  /**
16737
17019
  * Update a conversation by disconnecting all of the participants
16738
- *
17020
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
16739
17021
  * @param {String} conversationId conversationId
16740
17022
  * @param {Object} body Conversation
17023
+ * @deprecated
16741
17024
  */
16742
17025
  patchConversationsCobrowsesession(conversationId, body) {
16743
17026
  // verify the required parameter 'conversationId' is set
@@ -16765,11 +17048,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
16765
17048
 
16766
17049
  /**
16767
17050
  * Update conversation participant
16768
- *
17051
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
16769
17052
  * @param {String} conversationId conversationId
16770
17053
  * @param {String} participantId participantId
16771
17054
  * @param {Object} opts Optional parameters
16772
17055
  * @param {Object} opts.body
17056
+ * @deprecated
16773
17057
  */
16774
17058
  patchConversationsCobrowsesessionParticipant(conversationId, participantId, opts) {
16775
17059
  opts = opts || {};
@@ -16799,11 +17083,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
16799
17083
 
16800
17084
  /**
16801
17085
  * Update the attributes on a conversation participant.
16802
- *
17086
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
16803
17087
  * @param {String} conversationId conversationId
16804
17088
  * @param {String} participantId participantId
16805
17089
  * @param {Object} opts Optional parameters
16806
17090
  * @param {Object} opts.body
17091
+ * @deprecated
16807
17092
  */
16808
17093
  patchConversationsCobrowsesessionParticipantAttributes(conversationId, participantId, opts) {
16809
17094
  opts = opts || {};
@@ -16833,11 +17118,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
16833
17118
 
16834
17119
  /**
16835
17120
  * Update conversation participant's communication by disconnecting it.
16836
- *
17121
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
16837
17122
  * @param {String} conversationId conversationId
16838
17123
  * @param {String} participantId participantId
16839
17124
  * @param {String} communicationId communicationId
16840
17125
  * @param {Object} body Participant
17126
+ * @deprecated
16841
17127
  */
16842
17128
  patchConversationsCobrowsesessionParticipantCommunication(conversationId, participantId, communicationId, body) {
16843
17129
  // verify the required parameter 'conversationId' is set
@@ -18695,12 +18981,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
18695
18981
 
18696
18982
  /**
18697
18983
  * Apply wrap-up for this conversation communication
18698
- *
18984
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
18699
18985
  * @param {String} conversationId conversationId
18700
18986
  * @param {String} participantId participantId
18701
18987
  * @param {String} communicationId communicationId
18702
18988
  * @param {Object} opts Optional parameters
18703
18989
  * @param {Object} opts.body Wrap-up
18990
+ * @deprecated
18704
18991
  */
18705
18992
  postConversationsCobrowsesessionParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
18706
18993
  opts = opts || {};
@@ -18734,11 +19021,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
18734
19021
 
18735
19022
  /**
18736
19023
  * Replace this participant with the specified user and/or address
18737
- *
19024
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
18738
19025
  * @param {String} conversationId conversationId
18739
19026
  * @param {String} participantId participantId
18740
19027
  * @param {Object} opts Optional parameters
18741
19028
  * @param {Object} opts.body
19029
+ * @deprecated
18742
19030
  */
18743
19031
  postConversationsCobrowsesessionParticipantReplace(conversationId, participantId, opts) {
18744
19032
  opts = opts || {};
@@ -19435,8 +19723,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
19435
19723
 
19436
19724
  /**
19437
19725
  * Send an inbound Open Message
19438
- * Send an inbound message to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.
19726
+ * [This API is deprecated. Instead, use 1. POST /api/v2/conversations/messages/{integrationId}/inbound/open/event, if you want to send an inbound Open Event Message 2. POST /api/v2/conversations/messages/{integrationId}/inbound/open/message, if you want to send an inbound Open Message 3. POST /api/v2/conversations/messages/{integrationId}/inbound/open/receipt, to send an inbound Open Receipt Message] In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.
19439
19727
  * @param {Object} body NormalizedMessage
19728
+ * @deprecated
19440
19729
  */
19441
19730
  postConversationsMessagesInboundOpen(body) {
19442
19731
  // verify the required parameter 'body' is set
@@ -19713,12 +20002,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
19713
20002
 
19714
20003
  /**
19715
20004
  * Apply wrap-up for this conversation communication
19716
- *
20005
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
19717
20006
  * @param {String} conversationId conversationId
19718
20007
  * @param {String} participantId participantId
19719
20008
  * @param {String} communicationId communicationId
19720
20009
  * @param {Object} opts Optional parameters
19721
20010
  * @param {Object} opts.body Wrap-up
20011
+ * @deprecated
19722
20012
  */
19723
20013
  postConversationsScreenshareParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
19724
20014
  opts = opts || {};
@@ -20332,9 +20622,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
20332
20622
 
20333
20623
  /**
20334
20624
  * Update a conversation by setting its recording state
20335
- *
20625
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
20336
20626
  * @param {String} conversationId conversationId
20337
20627
  * @param {Object} body SetRecordingState
20628
+ * @deprecated
20338
20629
  */
20339
20630
  putConversationsScreenshareRecordingstate(conversationId, body) {
20340
20631
  // verify the required parameter 'conversationId' is set
@@ -20426,7 +20717,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
20426
20717
  /**
20427
20718
  * DataExtensions service.
20428
20719
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
20429
- * @version 190.0.0
20720
+ * @version 192.0.0
20430
20721
  */
20431
20722
 
20432
20723
  /**
@@ -20512,7 +20803,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
20512
20803
  /**
20513
20804
  * Downloads service.
20514
20805
  * @module purecloud-platform-client-v2/api/DownloadsApi
20515
- * @version 190.0.0
20806
+ * @version 192.0.0
20516
20807
  */
20517
20808
 
20518
20809
  /**
@@ -20564,7 +20855,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
20564
20855
  /**
20565
20856
  * Emails service.
20566
20857
  * @module purecloud-platform-client-v2/api/EmailsApi
20567
- * @version 190.0.0
20858
+ * @version 192.0.0
20568
20859
  */
20569
20860
 
20570
20861
  /**
@@ -20629,7 +20920,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
20629
20920
  /**
20630
20921
  * Events service.
20631
20922
  * @module purecloud-platform-client-v2/api/EventsApi
20632
- * @version 190.0.0
20923
+ * @version 192.0.0
20633
20924
  */
20634
20925
 
20635
20926
  /**
@@ -20725,7 +21016,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
20725
21016
  /**
20726
21017
  * ExternalContacts service.
20727
21018
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
20728
- * @version 190.0.0
21019
+ * @version 192.0.0
20729
21020
  */
20730
21021
 
20731
21022
  /**
@@ -22683,7 +22974,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
22683
22974
  /**
22684
22975
  * Fax service.
22685
22976
  * @module purecloud-platform-client-v2/api/FaxApi
22686
- * @version 190.0.0
22977
+ * @version 192.0.0
22687
22978
  */
22688
22979
 
22689
22980
  /**
@@ -22798,6 +23089,26 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
22798
23089
  );
22799
23090
  }
22800
23091
 
23092
+ /**
23093
+ * Get organization config for given organization
23094
+ *
23095
+ */
23096
+ getFaxSettings() {
23097
+
23098
+ return this.apiClient.callApi(
23099
+ '/api/v2/fax/settings',
23100
+ 'GET',
23101
+ { },
23102
+ { },
23103
+ { },
23104
+ { },
23105
+ null,
23106
+ ['PureCloud OAuth'],
23107
+ ['application/json'],
23108
+ ['application/json']
23109
+ );
23110
+ }
23111
+
22801
23112
  /**
22802
23113
  * Get fax summary
22803
23114
  *
@@ -22848,13 +23159,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
22848
23159
  );
22849
23160
  }
22850
23161
 
23162
+ /**
23163
+ * Update/write organization config for given organization
23164
+ *
23165
+ * @param {Object} opts Optional parameters
23166
+ * @param {Object} opts.body
23167
+ */
23168
+ putFaxSettings(opts) {
23169
+ opts = opts || {};
23170
+
23171
+
23172
+ return this.apiClient.callApi(
23173
+ '/api/v2/fax/settings',
23174
+ 'PUT',
23175
+ { },
23176
+ { },
23177
+ { },
23178
+ { },
23179
+ opts['body'],
23180
+ ['PureCloud OAuth'],
23181
+ ['application/json'],
23182
+ ['application/json']
23183
+ );
23184
+ }
23185
+
22851
23186
  }
22852
23187
 
22853
23188
  class FlowsApi {
22854
23189
  /**
22855
23190
  * Flows service.
22856
23191
  * @module purecloud-platform-client-v2/api/FlowsApi
22857
- * @version 190.0.0
23192
+ * @version 192.0.0
22858
23193
  */
22859
23194
 
22860
23195
  /**
@@ -23038,7 +23373,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
23038
23373
  /**
23039
23374
  * Gamification service.
23040
23375
  * @module purecloud-platform-client-v2/api/GamificationApi
23041
- * @version 190.0.0
23376
+ * @version 192.0.0
23042
23377
  */
23043
23378
 
23044
23379
  /**
@@ -25124,7 +25459,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25124
25459
  /**
25125
25460
  * GeneralDataProtectionRegulation service.
25126
25461
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
25127
- * @version 190.0.0
25462
+ * @version 192.0.0
25128
25463
  */
25129
25464
 
25130
25465
  /**
@@ -25254,7 +25589,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25254
25589
  /**
25255
25590
  * Geolocation service.
25256
25591
  * @module purecloud-platform-client-v2/api/GeolocationApi
25257
- * @version 190.0.0
25592
+ * @version 192.0.0
25258
25593
  */
25259
25594
 
25260
25595
  /**
@@ -25385,7 +25720,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25385
25720
  /**
25386
25721
  * Greetings service.
25387
25722
  * @module purecloud-platform-client-v2/api/GreetingsApi
25388
- * @version 190.0.0
25723
+ * @version 192.0.0
25389
25724
  */
25390
25725
 
25391
25726
  /**
@@ -25840,7 +26175,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25840
26175
  /**
25841
26176
  * Groups service.
25842
26177
  * @module purecloud-platform-client-v2/api/GroupsApi
25843
- * @version 190.0.0
26178
+ * @version 192.0.0
25844
26179
  */
25845
26180
 
25846
26181
  /**
@@ -26359,7 +26694,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26359
26694
  /**
26360
26695
  * IdentityProvider service.
26361
26696
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
26362
- * @version 190.0.0
26697
+ * @version 192.0.0
26363
26698
  */
26364
26699
 
26365
26700
  /**
@@ -27220,7 +27555,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
27220
27555
  /**
27221
27556
  * InfrastructureAsCode service.
27222
27557
  * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
27223
- * @version 190.0.0
27558
+ * @version 192.0.0
27224
27559
  */
27225
27560
 
27226
27561
  /**
@@ -27387,7 +27722,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
27387
27722
  /**
27388
27723
  * Integrations service.
27389
27724
  * @module purecloud-platform-client-v2/api/IntegrationsApi
27390
- * @version 190.0.0
27725
+ * @version 192.0.0
27391
27726
  */
27392
27727
 
27393
27728
  /**
@@ -28146,7 +28481,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
28146
28481
 
28147
28482
  /**
28148
28483
  * UC integration client application configuration.
28149
- * This endpoint returns basic UI configuration data for all Unified Communications integrations client applications enabled for the current organization.
28484
+ * Deprecated: Please use GET /integrations/unifiedcommunications/clientapps instead. This endpoint returns basic UI configuration data for all Unified Communications integrations client applications enabled for the current organization.
28150
28485
  * @param {Object} opts Optional parameters
28151
28486
  * @param {Number} opts.pageSize The total page size requested (default to 25)
28152
28487
  * @param {Number} opts.pageNumber The page number requested (default to 1)
@@ -28154,6 +28489,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
28154
28489
  * @param {Array.<String>} opts.expand variable name requested by expand list
28155
28490
  * @param {String} opts.nextPage next page token
28156
28491
  * @param {String} opts.previousPage Previous page token
28492
+ * @deprecated
28157
28493
  */
28158
28494
  getIntegrationsClientappsUnifiedcommunications(opts) {
28159
28495
  opts = opts || {};
@@ -29738,7 +30074,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
29738
30074
  /**
29739
30075
  * Journey service.
29740
30076
  * @module purecloud-platform-client-v2/api/JourneyApi
29741
- * @version 190.0.0
30077
+ * @version 192.0.0
29742
30078
  */
29743
30079
 
29744
30080
  /**
@@ -31328,7 +31664,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
31328
31664
  /**
31329
31665
  * Knowledge service.
31330
31666
  * @module purecloud-platform-client-v2/api/KnowledgeApi
31331
- * @version 190.0.0
31667
+ * @version 192.0.0
31332
31668
  */
31333
31669
 
31334
31670
  /**
@@ -34571,7 +34907,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
34571
34907
  /**
34572
34908
  * LanguageUnderstanding service.
34573
34909
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
34574
- * @version 190.0.0
34910
+ * @version 192.0.0
34575
34911
  */
34576
34912
 
34577
34913
  /**
@@ -35211,6 +35547,27 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
35211
35547
  );
35212
35548
  }
35213
35549
 
35550
+ /**
35551
+ * Get Organization Configuration
35552
+ *
35553
+ * getLanguageunderstandingSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
35554
+ */
35555
+ getLanguageunderstandingSettings() {
35556
+
35557
+ return this.apiClient.callApi(
35558
+ '/api/v2/languageunderstanding/settings',
35559
+ 'GET',
35560
+ { },
35561
+ { },
35562
+ { },
35563
+ { },
35564
+ null,
35565
+ ['PureCloud OAuth'],
35566
+ ['application/json'],
35567
+ ['application/json']
35568
+ );
35569
+ }
35570
+
35214
35571
  /**
35215
35572
  * Update an NLU Domain.
35216
35573
  *
@@ -35584,7 +35941,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
35584
35941
  /**
35585
35942
  * Languages service.
35586
35943
  * @module purecloud-platform-client-v2/api/LanguagesApi
35587
- * @version 190.0.0
35944
+ * @version 192.0.0
35588
35945
  */
35589
35946
 
35590
35947
  /**
@@ -35806,7 +36163,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
35806
36163
  /**
35807
36164
  * Learning service.
35808
36165
  * @module purecloud-platform-client-v2/api/LearningApi
35809
- * @version 190.0.0
36166
+ * @version 192.0.0
35810
36167
  */
35811
36168
 
35812
36169
  /**
@@ -36250,7 +36607,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
36250
36607
  * @param {String} moduleId Key identifier for the module
36251
36608
  * @param {String} userId Key identifier for the user
36252
36609
  * @param {Object} body The learning request for updating the assignment
36253
- * patchLearningModuleUserAssignments is a preview method and is subject to both breaking and non-breaking changes at any time without notice
36254
36610
  */
36255
36611
  patchLearningModuleUserAssignments(moduleId, userId, body) {
36256
36612
  // verify the required parameter 'moduleId' is set
@@ -36662,7 +37018,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
36662
37018
  /**
36663
37019
  * License service.
36664
37020
  * @module purecloud-platform-client-v2/api/LicenseApi
36665
- * @version 190.0.0
37021
+ * @version 192.0.0
36666
37022
  */
36667
37023
 
36668
37024
  /**
@@ -36900,7 +37256,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
36900
37256
  /**
36901
37257
  * Locations service.
36902
37258
  * @module purecloud-platform-client-v2/api/LocationsApi
36903
- * @version 190.0.0
37259
+ * @version 192.0.0
36904
37260
  */
36905
37261
 
36906
37262
  /**
@@ -37136,7 +37492,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
37136
37492
  /**
37137
37493
  * LogCapture service.
37138
37494
  * @module purecloud-platform-client-v2/api/LogCaptureApi
37139
- * @version 190.0.0
37495
+ * @version 192.0.0
37140
37496
  */
37141
37497
 
37142
37498
  /**
@@ -37336,7 +37692,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
37336
37692
  /**
37337
37693
  * Messaging service.
37338
37694
  * @module purecloud-platform-client-v2/api/MessagingApi
37339
- * @version 190.0.0
37695
+ * @version 192.0.0
37340
37696
  */
37341
37697
 
37342
37698
  /**
@@ -37695,7 +38051,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
37695
38051
  /**
37696
38052
  * MobileDevices service.
37697
38053
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
37698
- * @version 190.0.0
38054
+ * @version 192.0.0
37699
38055
  */
37700
38056
 
37701
38057
  /**
@@ -37846,7 +38202,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
37846
38202
  /**
37847
38203
  * Notifications service.
37848
38204
  * @module purecloud-platform-client-v2/api/NotificationsApi
37849
- * @version 190.0.0
38205
+ * @version 192.0.0
37850
38206
  */
37851
38207
 
37852
38208
  /**
@@ -38079,7 +38435,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
38079
38435
  /**
38080
38436
  * OAuth service.
38081
38437
  * @module purecloud-platform-client-v2/api/OAuthApi
38082
- * @version 190.0.0
38438
+ * @version 192.0.0
38083
38439
  */
38084
38440
 
38085
38441
  /**
@@ -38445,7 +38801,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
38445
38801
  /**
38446
38802
  * Objects service.
38447
38803
  * @module purecloud-platform-client-v2/api/ObjectsApi
38448
- * @version 190.0.0
38804
+ * @version 192.0.0
38449
38805
  */
38450
38806
 
38451
38807
  /**
@@ -38715,7 +39071,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
38715
39071
  /**
38716
39072
  * OperationalEvents service.
38717
39073
  * @module purecloud-platform-client-v2/api/OperationalEventsApi
38718
- * @version 190.0.0
39074
+ * @version 192.0.0
38719
39075
  */
38720
39076
 
38721
39077
  /**
@@ -38781,7 +39137,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
38781
39137
  /**
38782
39138
  * Organization service.
38783
39139
  * @module purecloud-platform-client-v2/api/OrganizationApi
38784
- * @version 190.0.0
39140
+ * @version 192.0.0
38785
39141
  */
38786
39142
 
38787
39143
  /**
@@ -39236,7 +39592,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39236
39592
  /**
39237
39593
  * OrganizationAuthorization service.
39238
39594
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
39239
- * @version 190.0.0
39595
+ * @version 192.0.0
39240
39596
  */
39241
39597
 
39242
39598
  /**
@@ -40583,7 +40939,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
40583
40939
  /**
40584
40940
  * Outbound service.
40585
40941
  * @module purecloud-platform-client-v2/api/OutboundApi
40586
- * @version 190.0.0
40942
+ * @version 192.0.0
40587
40943
  */
40588
40944
 
40589
40945
  /**
@@ -43306,8 +43662,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
43306
43662
  }
43307
43663
 
43308
43664
  /**
43309
- * Retrieves audits for dialer.
43310
- *
43665
+ * Retrieves audits for dialer. (Deprecated)
43666
+ * This endpoint is deprecated as a result of this functionality being moved to the Audit Service. Please use "/api/v2/audits/query" instead.
43311
43667
  * @param {Object} body AuditSearch
43312
43668
  * @param {Object} opts Optional parameters
43313
43669
  * @param {Number} opts.pageSize Page size (default to 25)
@@ -43315,6 +43671,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
43315
43671
  * @param {String} opts.sortBy Sort by (default to entity.name)
43316
43672
  * @param {String} opts.sortOrder Sort order (default to ascending)
43317
43673
  * @param {Boolean} opts.facetsOnly Facets only (default to false)
43674
+ * @deprecated
43318
43675
  */
43319
43676
  postOutboundAudits(body, opts) {
43320
43677
  opts = opts || {};
@@ -44824,7 +45181,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
44824
45181
  /**
44825
45182
  * Presence service.
44826
45183
  * @module purecloud-platform-client-v2/api/PresenceApi
44827
- * @version 190.0.0
45184
+ * @version 192.0.0
44828
45185
  */
44829
45186
 
44830
45187
  /**
@@ -45568,7 +45925,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
45568
45925
  /**
45569
45926
  * ProcessAutomation service.
45570
45927
  * @module purecloud-platform-client-v2/api/ProcessAutomationApi
45571
- * @version 190.0.0
45928
+ * @version 192.0.0
45572
45929
  */
45573
45930
 
45574
45931
  /**
@@ -45807,7 +46164,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
45807
46164
  /**
45808
46165
  * Quality service.
45809
46166
  * @module purecloud-platform-client-v2/api/QualityApi
45810
- * @version 190.0.0
46167
+ * @version 192.0.0
45811
46168
  */
45812
46169
 
45813
46170
  /**
@@ -46143,7 +46500,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
46143
46500
 
46144
46501
  /**
46145
46502
  * Get the list of calibrations
46146
- *
46503
+ * NOTE: The count for total and pageCount might not be accurate when querying for a large number of calibrations. nextUri, if present, will indicate that there are more calibrations to fetch.
46147
46504
  * @param {String} calibratorId user id of calibrator
46148
46505
  * @param {Object} opts Optional parameters
46149
46506
  * @param {Number} opts.pageSize The total page size requested (default to 25)
@@ -46295,7 +46652,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
46295
46652
 
46296
46653
  /**
46297
46654
  * Queries Evaluations and returns a paged list
46298
- * Query params must include one of conversationId, evaluatorUserId, agentUserId or assigneeUserId. When querying by agentUserId (and not conversationId or evaluatorUserId), the results are sorted by release date. Evaluations set to Never Release are omitted in this case. When querying by evaluatorUserId or conversationId (including when combined with agentUserId), the results are sorted by assigned date.
46655
+ * Query params must include one of conversationId, evaluatorUserId, agentUserId or assigneeUserId. When querying by agentUserId (and not conversationId or evaluatorUserId), the results are sorted by release date. Evaluations set to Never Release are omitted in this case. When querying by evaluatorUserId or conversationId (including when combined with agentUserId), the results are sorted by assigned date. NOTE: The count for total and pageCount might not be accurate when querying for a large number of evaluations. nextUri, if present, will indicate that there are more evaluations to fetch.
46299
46656
  * @param {Object} opts Optional parameters
46300
46657
  * @param {Number} opts.pageSize The total page size requested (default to 25)
46301
46658
  * @param {Number} opts.pageNumber The page number requested (default to 1)
@@ -47564,7 +47921,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
47564
47921
  /**
47565
47922
  * Recording service.
47566
47923
  * @module purecloud-platform-client-v2/api/RecordingApi
47567
- * @version 190.0.0
47924
+ * @version 192.0.0
47568
47925
  */
47569
47926
 
47570
47927
  /**
@@ -48450,10 +48807,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
48450
48807
 
48451
48808
  /**
48452
48809
  * Retrieves a paged listing of screen recording sessions
48453
- *
48810
+ * Coming soon: This API is deprecated and will be replaced by /api/v2/recordings/screensessions/details
48454
48811
  * @param {Object} opts Optional parameters
48455
48812
  * @param {Number} opts.pageSize Page size (default to 25)
48456
48813
  * @param {Number} opts.pageNumber Page number (default to 1)
48814
+ * @deprecated
48457
48815
  */
48458
48816
  getRecordingsScreensessions(opts) {
48459
48817
  opts = opts || {};
@@ -49222,7 +49580,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
49222
49580
  /**
49223
49581
  * ResponseManagement service.
49224
49582
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
49225
- * @version 190.0.0
49583
+ * @version 192.0.0
49226
49584
  */
49227
49585
 
49228
49586
  /**
@@ -49499,6 +49857,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
49499
49857
  );
49500
49858
  }
49501
49859
 
49860
+ /**
49861
+ * Get response libraries.
49862
+ *
49863
+ * @param {Object} body LibraryIDs (max allowed 50)
49864
+ */
49865
+ postResponsemanagementLibrariesBulk(body) {
49866
+ // verify the required parameter 'body' is set
49867
+ if (body === undefined || body === null) {
49868
+ throw 'Missing the required parameter "body" when calling postResponsemanagementLibrariesBulk';
49869
+ }
49870
+
49871
+ return this.apiClient.callApi(
49872
+ '/api/v2/responsemanagement/libraries/bulk',
49873
+ 'POST',
49874
+ { },
49875
+ { },
49876
+ { },
49877
+ { },
49878
+ body,
49879
+ ['PureCloud OAuth'],
49880
+ ['application/json'],
49881
+ ['application/json']
49882
+ );
49883
+ }
49884
+
49502
49885
  /**
49503
49886
  * Search response assets
49504
49887
  *
@@ -49707,7 +50090,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
49707
50090
  /**
49708
50091
  * Routing service.
49709
50092
  * @module purecloud-platform-client-v2/api/RoutingApi
49710
- * @version 190.0.0
50093
+ * @version 192.0.0
49711
50094
  */
49712
50095
 
49713
50096
  /**
@@ -53112,6 +53495,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
53112
53495
  );
53113
53496
  }
53114
53497
 
53498
+ /**
53499
+ * Provision an alphanumeric number for SMS
53500
+ *
53501
+ * @param {Object} body SmsPhoneNumber
53502
+ * postRoutingSmsPhonenumbersAlphanumeric is a preview method and is subject to both breaking and non-breaking changes at any time without notice
53503
+ */
53504
+ postRoutingSmsPhonenumbersAlphanumeric(body) {
53505
+ // verify the required parameter 'body' is set
53506
+ if (body === undefined || body === null) {
53507
+ throw 'Missing the required parameter "body" when calling postRoutingSmsPhonenumbersAlphanumeric';
53508
+ }
53509
+
53510
+ return this.apiClient.callApi(
53511
+ '/api/v2/routing/sms/phonenumbers/alphanumeric',
53512
+ 'POST',
53513
+ { },
53514
+ { },
53515
+ { },
53516
+ { },
53517
+ body,
53518
+ ['PureCloud OAuth'],
53519
+ ['application/json'],
53520
+ ['application/json']
53521
+ );
53522
+ }
53523
+
53115
53524
  /**
53116
53525
  * Imports a phone number for SMS
53117
53526
  *
@@ -53661,7 +54070,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
53661
54070
  /**
53662
54071
  * SCIM service.
53663
54072
  * @module purecloud-platform-client-v2/api/SCIMApi
53664
- * @version 190.0.0
54073
+ * @version 192.0.0
53665
54074
  */
53666
54075
 
53667
54076
  /**
@@ -54538,7 +54947,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
54538
54947
  /**
54539
54948
  * ScreenRecording service.
54540
54949
  * @module purecloud-platform-client-v2/api/ScreenRecordingApi
54541
- * @version 190.0.0
54950
+ * @version 192.0.0
54542
54951
  */
54543
54952
 
54544
54953
  /**
@@ -54583,7 +54992,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
54583
54992
  /**
54584
54993
  * Scripts service.
54585
54994
  * @module purecloud-platform-client-v2/api/ScriptsApi
54586
- * @version 190.0.0
54995
+ * @version 192.0.0
54587
54996
  */
54588
54997
 
54589
54998
  /**
@@ -55027,7 +55436,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
55027
55436
  /**
55028
55437
  * Search service.
55029
55438
  * @module purecloud-platform-client-v2/api/SearchApi
55030
- * @version 190.0.0
55439
+ * @version 192.0.0
55031
55440
  */
55032
55441
 
55033
55442
  /**
@@ -55716,7 +56125,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
55716
56125
  /**
55717
56126
  * Settings service.
55718
56127
  * @module purecloud-platform-client-v2/api/SettingsApi
55719
- * @version 190.0.0
56128
+ * @version 192.0.0
55720
56129
  */
55721
56130
 
55722
56131
  /**
@@ -55828,7 +56237,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
55828
56237
  /**
55829
56238
  * SpeechTextAnalytics service.
55830
56239
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
55831
- * @version 190.0.0
56240
+ * @version 192.0.0
55832
56241
  */
55833
56242
 
55834
56243
  /**
@@ -56418,7 +56827,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
56418
56827
  *
56419
56828
  * @param {Object} opts Optional parameters
56420
56829
  * @param {String} opts.nextPage The key for listing the next page
56421
- * @param {Number} opts.pageSize The page size for the listing (default to 20)
56830
+ * @param {Number} opts.pageSize The page size for the listing. The max that will be returned is 500. (default to 20)
56422
56831
  * @param {Object} opts.state Topic state. Defaults to latest
56423
56832
  * @param {String} opts.name Case insensitive partial name to filter by
56424
56833
  * @param {Array.<String>} opts.ids Comma separated Topic IDs to filter by. Cannot be used with other filters. Maximum of 50 IDs allowed.
@@ -56942,7 +57351,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
56942
57351
  /**
56943
57352
  * Stations service.
56944
57353
  * @module purecloud-platform-client-v2/api/StationsApi
56945
- * @version 190.0.0
57354
+ * @version 192.0.0
56946
57355
  */
56947
57356
 
56948
57357
  /**
@@ -57044,7 +57453,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
57044
57453
  /**
57045
57454
  * Suggest service.
57046
57455
  * @module purecloud-platform-client-v2/api/SuggestApi
57047
- * @version 190.0.0
57456
+ * @version 192.0.0
57048
57457
  */
57049
57458
 
57050
57459
  /**
@@ -57183,7 +57592,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
57183
57592
  /**
57184
57593
  * TaskManagement service.
57185
57594
  * @module purecloud-platform-client-v2/api/TaskManagementApi
57186
- * @version 190.0.0
57595
+ * @version 192.0.0
57187
57596
  */
57188
57597
 
57189
57598
  /**
@@ -57650,6 +58059,58 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
57650
58059
  );
57651
58060
  }
57652
58061
 
58062
+ /**
58063
+ * Get the workitem query job associated with the job id.
58064
+ *
58065
+ * @param {String} jobId jobId
58066
+ * getTaskmanagementWorkitemsQueryJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
58067
+ */
58068
+ getTaskmanagementWorkitemsQueryJob(jobId) {
58069
+ // verify the required parameter 'jobId' is set
58070
+ if (jobId === undefined || jobId === null) {
58071
+ throw 'Missing the required parameter "jobId" when calling getTaskmanagementWorkitemsQueryJob';
58072
+ }
58073
+
58074
+ return this.apiClient.callApi(
58075
+ '/api/v2/taskmanagement/workitems/query/jobs/{jobId}',
58076
+ 'GET',
58077
+ { 'jobId': jobId },
58078
+ { },
58079
+ { },
58080
+ { },
58081
+ null,
58082
+ ['PureCloud OAuth'],
58083
+ ['application/json'],
58084
+ ['application/json']
58085
+ );
58086
+ }
58087
+
58088
+ /**
58089
+ * Get results from for workitem query job
58090
+ *
58091
+ * @param {String} jobId jobId
58092
+ * getTaskmanagementWorkitemsQueryJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
58093
+ */
58094
+ getTaskmanagementWorkitemsQueryJobResults(jobId) {
58095
+ // verify the required parameter 'jobId' is set
58096
+ if (jobId === undefined || jobId === null) {
58097
+ throw 'Missing the required parameter "jobId" when calling getTaskmanagementWorkitemsQueryJobResults';
58098
+ }
58099
+
58100
+ return this.apiClient.callApi(
58101
+ '/api/v2/taskmanagement/workitems/query/jobs/{jobId}/results',
58102
+ 'GET',
58103
+ { 'jobId': jobId },
58104
+ { },
58105
+ { },
58106
+ { },
58107
+ null,
58108
+ ['PureCloud OAuth'],
58109
+ ['application/json'],
58110
+ ['application/json']
58111
+ );
58112
+ }
58113
+
57653
58114
  /**
57654
58115
  * Get a schema
57655
58116
  *
@@ -58346,6 +58807,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58346
58807
  );
58347
58808
  }
58348
58809
 
58810
+ /**
58811
+ * Create a workitem query job
58812
+ *
58813
+ * @param {Object} body WorkitemQueryJobCreate
58814
+ * postTaskmanagementWorkitemsQueryJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
58815
+ */
58816
+ postTaskmanagementWorkitemsQueryJobs(body) {
58817
+ // verify the required parameter 'body' is set
58818
+ if (body === undefined || body === null) {
58819
+ throw 'Missing the required parameter "body" when calling postTaskmanagementWorkitemsQueryJobs';
58820
+ }
58821
+
58822
+ return this.apiClient.callApi(
58823
+ '/api/v2/taskmanagement/workitems/query/jobs',
58824
+ 'POST',
58825
+ { },
58826
+ { },
58827
+ { },
58828
+ { },
58829
+ body,
58830
+ ['PureCloud OAuth'],
58831
+ ['application/json'],
58832
+ ['application/json']
58833
+ );
58834
+ }
58835
+
58349
58836
  /**
58350
58837
  * Create a schema
58351
58838
  *
@@ -58490,7 +58977,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58490
58977
  /**
58491
58978
  * Teams service.
58492
58979
  * @module purecloud-platform-client-v2/api/TeamsApi
58493
- * @version 190.0.0
58980
+ * @version 192.0.0
58494
58981
  */
58495
58982
 
58496
58983
  /**
@@ -58792,7 +59279,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58792
59279
  /**
58793
59280
  * Telephony service.
58794
59281
  * @module purecloud-platform-client-v2/api/TelephonyApi
58795
- * @version 190.0.0
59282
+ * @version 192.0.0
58796
59283
  */
58797
59284
 
58798
59285
  /**
@@ -58974,7 +59461,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58974
59461
  /**
58975
59462
  * TelephonyProvidersEdge service.
58976
59463
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
58977
- * @version 190.0.0
59464
+ * @version 192.0.0
58978
59465
  */
58979
59466
 
58980
59467
  /**
@@ -59741,27 +60228,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
59741
60228
  );
59742
60229
  }
59743
60230
 
59744
- /**
59745
- * Get the list of available languages. For never released keyword spotting feature. Deprecated, do not use.
59746
- *
59747
- * @deprecated
59748
- */
59749
- getTelephonyProvidersEdgesAvailablelanguages() {
59750
-
59751
- return this.apiClient.callApi(
59752
- '/api/v2/telephony/providers/edges/availablelanguages',
59753
- 'GET',
59754
- { },
59755
- { },
59756
- { },
59757
- { },
59758
- null,
59759
- ['PureCloud OAuth'],
59760
- ['application/json'],
59761
- ['application/json']
59762
- );
59763
- }
59764
-
59765
60231
  /**
59766
60232
  * Get the list of certificate authorities.
59767
60233
  *
@@ -62323,7 +62789,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
62323
62789
  /**
62324
62790
  * Textbots service.
62325
62791
  * @module purecloud-platform-client-v2/api/TextbotsApi
62326
- * @version 190.0.0
62792
+ * @version 192.0.0
62327
62793
  */
62328
62794
 
62329
62795
  /**
@@ -62451,7 +62917,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
62451
62917
  /**
62452
62918
  * Tokens service.
62453
62919
  * @module purecloud-platform-client-v2/api/TokensApi
62454
- * @version 190.0.0
62920
+ * @version 192.0.0
62455
62921
  */
62456
62922
 
62457
62923
  /**
@@ -62605,7 +63071,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
62605
63071
  /**
62606
63072
  * Uploads service.
62607
63073
  * @module purecloud-platform-client-v2/api/UploadsApi
62608
- * @version 190.0.0
63074
+ * @version 192.0.0
62609
63075
  */
62610
63076
 
62611
63077
  /**
@@ -62874,7 +63340,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
62874
63340
  /**
62875
63341
  * Usage service.
62876
63342
  * @module purecloud-platform-client-v2/api/UsageApi
62877
- * @version 190.0.0
63343
+ * @version 192.0.0
62878
63344
  */
62879
63345
 
62880
63346
  /**
@@ -62974,11 +63440,16 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
62974
63440
  }
62975
63441
 
62976
63442
  /**
62977
- * Get the results of a usage search
63443
+ * Get the results of a usage search. Number of records to be returned is limited to 20,000 results.
62978
63444
  *
62979
63445
  * @param {String} executionId ID of the search execution
63446
+ * @param {Object} opts Optional parameters
63447
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned
63448
+ * @param {Number} opts.pageSize The max number of entities to be returned per request. Maximum page size of 1000
62980
63449
  */
62981
- getUsageSimplesearchExecutionIdResults(executionId) {
63450
+ getUsageSimplesearchExecutionIdResults(executionId, opts) {
63451
+ opts = opts || {};
63452
+
62982
63453
  // verify the required parameter 'executionId' is set
62983
63454
  if (executionId === undefined || executionId === null) {
62984
63455
  throw 'Missing the required parameter "executionId" when calling getUsageSimplesearchExecutionIdResults';
@@ -62988,7 +63459,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
62988
63459
  '/api/v2/usage/simplesearch/{executionId}/results',
62989
63460
  'GET',
62990
63461
  { 'executionId': executionId },
62991
- { },
63462
+ { 'after': opts['after'],'pageSize': opts['pageSize'] },
62992
63463
  { },
62993
63464
  { },
62994
63465
  null,
@@ -63054,8 +63525,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
63054
63525
  }
63055
63526
 
63056
63527
  /**
63057
- * Search organization API Usage -
63058
- * After calling this method, you will then need to poll for the query results based on the returned execution Id
63528
+ * Search organization API Usage
63529
+ * After calling this method, you will then need to poll for the query results based on the returned execution Id. The number of records is limited to 20,000 results
63059
63530
  * @param {Object} body SimpleSearch
63060
63531
  */
63061
63532
  postUsageSimplesearch(body) {
@@ -63084,7 +63555,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
63084
63555
  /**
63085
63556
  * UserRecordings service.
63086
63557
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
63087
- * @version 190.0.0
63558
+ * @version 192.0.0
63088
63559
  */
63089
63560
 
63090
63561
  /**
@@ -63269,7 +63740,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
63269
63740
  /**
63270
63741
  * Users service.
63271
63742
  * @module purecloud-platform-client-v2/api/UsersApi
63272
- * @version 190.0.0
63743
+ * @version 192.0.0
63273
63744
  */
63274
63745
 
63275
63746
  /**
@@ -63765,8 +64236,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
63765
64236
  * Returns a listing of roles and permissions for a user.
63766
64237
  *
63767
64238
  * @param {String} subjectId Subject ID (user or group)
64239
+ * @param {Object} opts Optional parameters
64240
+ * @param {Object} opts.includeDuplicates Include multiple entries with the same role and division but different subjects (default to false)
63768
64241
  */
63769
- getAuthorizationSubject(subjectId) {
64242
+ getAuthorizationSubject(subjectId, opts) {
64243
+ opts = opts || {};
64244
+
63770
64245
  // verify the required parameter 'subjectId' is set
63771
64246
  if (subjectId === undefined || subjectId === null) {
63772
64247
  throw 'Missing the required parameter "subjectId" when calling getAuthorizationSubject';
@@ -63776,7 +64251,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
63776
64251
  '/api/v2/authorization/subjects/{subjectId}',
63777
64252
  'GET',
63778
64253
  { 'subjectId': subjectId },
63779
- { },
64254
+ { 'includeDuplicates': opts['includeDuplicates'] },
63780
64255
  { },
63781
64256
  { },
63782
64257
  null,
@@ -63789,14 +64264,18 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
63789
64264
  /**
63790
64265
  * Returns a listing of roles and permissions for the currently authenticated user.
63791
64266
  *
64267
+ * @param {Object} opts Optional parameters
64268
+ * @param {Object} opts.includeDuplicates Include multiple entries with the same role and division but different subjects (default to false)
63792
64269
  */
63793
- getAuthorizationSubjectsMe() {
64270
+ getAuthorizationSubjectsMe(opts) {
64271
+ opts = opts || {};
64272
+
63794
64273
 
63795
64274
  return this.apiClient.callApi(
63796
64275
  '/api/v2/authorization/subjects/me',
63797
64276
  'GET',
63798
64277
  { },
63799
- { },
64278
+ { 'includeDuplicates': opts['includeDuplicates'] },
63800
64279
  { },
63801
64280
  { },
63802
64281
  null,
@@ -65920,7 +66399,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
65920
66399
  /**
65921
66400
  * Utilities service.
65922
66401
  * @module purecloud-platform-client-v2/api/UtilitiesApi
65923
- * @version 190.0.0
66402
+ * @version 192.0.0
65924
66403
  */
65925
66404
 
65926
66405
  /**
@@ -66031,7 +66510,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
66031
66510
  /**
66032
66511
  * Voicemail service.
66033
66512
  * @module purecloud-platform-client-v2/api/VoicemailApi
66034
- * @version 190.0.0
66513
+ * @version 192.0.0
66035
66514
  */
66036
66515
 
66037
66516
  /**
@@ -66698,7 +67177,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
66698
67177
  /**
66699
67178
  * WebChat service.
66700
67179
  * @module purecloud-platform-client-v2/api/WebChatApi
66701
- * @version 190.0.0
67180
+ * @version 192.0.0
66702
67181
  */
66703
67182
 
66704
67183
  /**
@@ -66838,9 +67317,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
66838
67317
 
66839
67318
  /**
66840
67319
  * Get a media request in the conversation
66841
- *
67320
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
66842
67321
  * @param {String} conversationId conversationId
66843
67322
  * @param {String} mediaRequestId mediaRequestId
67323
+ * @deprecated
66844
67324
  */
66845
67325
  getWebchatGuestConversationMediarequest(conversationId, mediaRequestId) {
66846
67326
  // verify the required parameter 'conversationId' is set
@@ -67036,10 +67516,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
67036
67516
 
67037
67517
  /**
67038
67518
  * Update a media request in the conversation, setting the state to ACCEPTED/DECLINED/ERRORED
67039
- *
67519
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
67040
67520
  * @param {String} conversationId conversationId
67041
67521
  * @param {String} mediaRequestId mediaRequestId
67042
67522
  * @param {Object} body Request
67523
+ * @deprecated
67043
67524
  */
67044
67525
  patchWebchatGuestConversationMediarequest(conversationId, mediaRequestId, body) {
67045
67526
  // verify the required parameter 'conversationId' is set
@@ -67247,7 +67728,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
67247
67728
  /**
67248
67729
  * WebDeployments service.
67249
67730
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
67250
- * @version 190.0.0
67731
+ * @version 192.0.0
67251
67732
  */
67252
67733
 
67253
67734
  /**
@@ -67774,7 +68255,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
67774
68255
  /**
67775
68256
  * WebMessaging service.
67776
68257
  * @module purecloud-platform-client-v2/api/WebMessagingApi
67777
- * @version 190.0.0
68258
+ * @version 192.0.0
67778
68259
  */
67779
68260
 
67780
68261
  /**
@@ -67820,7 +68301,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
67820
68301
  /**
67821
68302
  * Widgets service.
67822
68303
  * @module purecloud-platform-client-v2/api/WidgetsApi
67823
- * @version 190.0.0
68304
+ * @version 192.0.0
67824
68305
  */
67825
68306
 
67826
68307
  /**
@@ -67966,7 +68447,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
67966
68447
  /**
67967
68448
  * WorkforceManagement service.
67968
68449
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
67969
- * @version 190.0.0
68450
+ * @version 192.0.0
67970
68451
  */
67971
68452
 
67972
68453
  /**
@@ -73877,7 +74358,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
73877
74358
  * </pre>
73878
74359
  * </p>
73879
74360
  * @module purecloud-platform-client-v2/index
73880
- * @version 190.0.0
74361
+ * @version 192.0.0
73881
74362
  */
73882
74363
  class platformClient {
73883
74364
  constructor() {