purecloud-platform-client-v2 138.0.1 → 140.0.1

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 (73) hide show
  1. package/README.md +2 -2
  2. package/dist/node/purecloud-platform-client-v2.js +537 -161
  3. package/dist/web-amd/purecloud-platform-client-v2.js +537 -162
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +537 -161
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +2631 -199
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +783 -224
  9. package/package.json +2 -1
  10. package/src/purecloud-platform-client-v2/ApiClient.js +18 -16
  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 +15 -15
  16. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  17. package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  19. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +271 -1
  21. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  22. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/GamificationApi.js +28 -27
  26. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +5 -5
  34. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/LearningApi.js +111 -1
  37. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  44. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/QualityApi.js +2 -2
  49. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  50. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/RoutingApi.js +16 -24
  52. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
  60. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/UsersApi.js +15 -15
  66. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  67. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -5,7 +5,7 @@ class RoutingApi {
5
5
  /**
6
6
  * Routing service.
7
7
  * @module purecloud-platform-client-v2/api/RoutingApi
8
- * @version 138.0.1
8
+ * @version 140.0.1
9
9
  */
10
10
 
11
11
  /**
@@ -318,12 +318,8 @@ class RoutingApi {
318
318
  * Delete a phone number provisioned for SMS.
319
319
  *
320
320
  * @param {String} addressId Address ID
321
- * @param {Object} opts Optional parameters
322
- * @param {Boolean} opts.async Delete a phone number for SMS in an asynchronous manner. If the async parameter value is true, this initiates the deletion of a provisioned phone number. (default to false)
323
321
  */
324
- deleteRoutingSmsPhonenumber(addressId, opts) {
325
- opts = opts || {};
326
-
322
+ deleteRoutingSmsPhonenumber(addressId) {
327
323
  // verify the required parameter 'addressId' is set
328
324
  if (addressId === undefined || addressId === null) {
329
325
  throw 'Missing the required parameter "addressId" when calling deleteRoutingSmsPhonenumber';
@@ -333,7 +329,7 @@ class RoutingApi {
333
329
  '/api/v2/routing/sms/phonenumbers/{addressId}',
334
330
  'DELETE',
335
331
  { 'addressId': addressId },
336
- { 'async': opts['async'] },
332
+ { },
337
333
  { },
338
334
  { },
339
335
  null,
@@ -504,7 +500,7 @@ class RoutingApi {
504
500
  * @param {Object} opts Optional parameters
505
501
  * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
506
502
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
507
- * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize, use CursorQueryParameters instead.
503
+ * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
508
504
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
509
505
  * @param {Array.<String>} opts.queueId Queue ID(s) to filter assessments by.
510
506
  */
@@ -815,7 +811,7 @@ class RoutingApi {
815
811
  * @param {Object} opts Optional parameters
816
812
  * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
817
813
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
818
- * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize, use CursorQueryParameters instead.
814
+ * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
819
815
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
820
816
  * @param {Array.<String>} opts.queueId Comma-separated list of queue Ids to filter by.
821
817
  */
@@ -838,16 +834,20 @@ class RoutingApi {
838
834
  }
839
835
 
840
836
  /**
841
- * Get a list of Key Performance Indicators available for the predictors.
837
+ * Get a list of Key Performance Indicators
842
838
  *
839
+ * @param {Object} opts Optional parameters
840
+ * @param {Object} opts.kpiGroup The Group of Key Performance Indicators to return
843
841
  */
844
- getRoutingPredictorsKeyperformanceindicators() {
842
+ getRoutingPredictorsKeyperformanceindicators(opts) {
843
+ opts = opts || {};
844
+
845
845
 
846
846
  return this.apiClient.callApi(
847
847
  '/api/v2/routing/predictors/keyperformanceindicators',
848
848
  'GET',
849
849
  { },
850
- { },
850
+ { 'kpiGroup': opts['kpiGroup'] },
851
851
  { },
852
852
  { },
853
853
  null,
@@ -2487,12 +2487,8 @@ class RoutingApi {
2487
2487
  * Provision a phone number for SMS
2488
2488
  *
2489
2489
  * @param {Object} body SmsPhoneNumber
2490
- * @param {Object} opts Optional parameters
2491
- * @param {Boolean} opts.async Provision a new phone number for SMS in an asynchronous manner. If the async parameter value is true, this initiates the provisioning of a new phone number. Check the phoneNumber's provisioningStatus for completion of this request. (default to false)
2492
2490
  */
2493
- postRoutingSmsPhonenumbers(body, opts) {
2494
- opts = opts || {};
2495
-
2491
+ postRoutingSmsPhonenumbers(body) {
2496
2492
  // verify the required parameter 'body' is set
2497
2493
  if (body === undefined || body === null) {
2498
2494
  throw 'Missing the required parameter "body" when calling postRoutingSmsPhonenumbers';
@@ -2502,7 +2498,7 @@ class RoutingApi {
2502
2498
  '/api/v2/routing/sms/phonenumbers',
2503
2499
  'POST',
2504
2500
  { },
2505
- { 'async': opts['async'] },
2501
+ { },
2506
2502
  { },
2507
2503
  { },
2508
2504
  body,
@@ -2747,12 +2743,8 @@ class RoutingApi {
2747
2743
  *
2748
2744
  * @param {String} addressId Address ID
2749
2745
  * @param {Object} body SmsPhoneNumber
2750
- * @param {Object} opts Optional parameters
2751
- * @param {Boolean} opts.async Update an existing phone number for SMS in an asynchronous manner. If the async parameter value is true, this initiates the update of a provisioned phone number. Check the phoneNumber's provisioningStatus for the progress of this request. (default to false)
2752
2746
  */
2753
- putRoutingSmsPhonenumber(addressId, body, opts) {
2754
- opts = opts || {};
2755
-
2747
+ putRoutingSmsPhonenumber(addressId, body) {
2756
2748
  // verify the required parameter 'addressId' is set
2757
2749
  if (addressId === undefined || addressId === null) {
2758
2750
  throw 'Missing the required parameter "addressId" when calling putRoutingSmsPhonenumber';
@@ -2766,7 +2758,7 @@ class RoutingApi {
2766
2758
  '/api/v2/routing/sms/phonenumbers/{addressId}',
2767
2759
  'PUT',
2768
2760
  { 'addressId': addressId },
2769
- { 'async': opts['async'] },
2761
+ { },
2770
2762
  { },
2771
2763
  { },
2772
2764
  body,
@@ -5,7 +5,7 @@ class SCIMApi {
5
5
  /**
6
6
  * SCIM service.
7
7
  * @module purecloud-platform-client-v2/api/SCIMApi
8
- * @version 138.0.1
8
+ * @version 140.0.1
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class ScriptsApi {
5
5
  /**
6
6
  * Scripts service.
7
7
  * @module purecloud-platform-client-v2/api/ScriptsApi
8
- * @version 138.0.1
8
+ * @version 140.0.1
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class SearchApi {
5
5
  /**
6
6
  * Search service.
7
7
  * @module purecloud-platform-client-v2/api/SearchApi
8
- * @version 138.0.1
8
+ * @version 140.0.1
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class SpeechTextAnalyticsApi {
5
5
  /**
6
6
  * SpeechTextAnalytics service.
7
7
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
8
- * @version 138.0.1
8
+ * @version 140.0.1
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class StationsApi {
5
5
  /**
6
6
  * Stations service.
7
7
  * @module purecloud-platform-client-v2/api/StationsApi
8
- * @version 138.0.1
8
+ * @version 140.0.1
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class SuggestApi {
5
5
  /**
6
6
  * Suggest service.
7
7
  * @module purecloud-platform-client-v2/api/SuggestApi
8
- * @version 138.0.1
8
+ * @version 140.0.1
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class TelephonyApi {
5
5
  /**
6
6
  * Telephony service.
7
7
  * @module purecloud-platform-client-v2/api/TelephonyApi
8
- * @version 138.0.1
8
+ * @version 140.0.1
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class TelephonyProvidersEdgeApi {
5
5
  /**
6
6
  * TelephonyProvidersEdge service.
7
7
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
8
- * @version 138.0.1
8
+ * @version 140.0.1
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class TextbotsApi {
5
5
  /**
6
6
  * Textbots service.
7
7
  * @module purecloud-platform-client-v2/api/TextbotsApi
8
- * @version 138.0.1
8
+ * @version 140.0.1
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class TokensApi {
5
5
  /**
6
6
  * Tokens service.
7
7
  * @module purecloud-platform-client-v2/api/TokensApi
8
- * @version 138.0.1
8
+ * @version 140.0.1
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class UploadsApi {
5
5
  /**
6
6
  * Uploads service.
7
7
  * @module purecloud-platform-client-v2/api/UploadsApi
8
- * @version 138.0.1
8
+ * @version 140.0.1
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class UsageApi {
5
5
  /**
6
6
  * Usage service.
7
7
  * @module purecloud-platform-client-v2/api/UsageApi
8
- * @version 138.0.1
8
+ * @version 140.0.1
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class UserRecordingsApi {
5
5
  /**
6
6
  * UserRecordings service.
7
7
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
8
- * @version 138.0.1
8
+ * @version 140.0.1
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class UsersApi {
5
5
  /**
6
6
  * Users service.
7
7
  * @module purecloud-platform-client-v2/api/UsersApi
8
- * @version 138.0.1
8
+ * @version 140.0.1
9
9
  */
10
10
 
11
11
  /**
@@ -825,18 +825,18 @@ class UsersApi {
825
825
  /**
826
826
  * Returns a listing of roles and permissions for a user.
827
827
  *
828
- * @param {String} userId User ID
828
+ * @param {String} subjectId User ID
829
829
  */
830
- getUserRoles(userId) {
831
- // verify the required parameter 'userId' is set
832
- if (userId === undefined || userId === null) {
833
- throw 'Missing the required parameter "userId" when calling getUserRoles';
830
+ getUserRoles(subjectId) {
831
+ // verify the required parameter 'subjectId' is set
832
+ if (subjectId === undefined || subjectId === null) {
833
+ throw 'Missing the required parameter "subjectId" when calling getUserRoles';
834
834
  }
835
835
 
836
836
  return this.apiClient.callApi(
837
- '/api/v2/users/{userId}/roles',
837
+ '/api/v2/users/{subjectId}/roles',
838
838
  'GET',
839
- { 'userId': userId },
839
+ { 'subjectId': subjectId },
840
840
  { },
841
841
  { },
842
842
  { },
@@ -2089,13 +2089,13 @@ class UsersApi {
2089
2089
  /**
2090
2090
  * Sets the user's roles
2091
2091
  *
2092
- * @param {String} userId User ID
2092
+ * @param {String} subjectId User ID
2093
2093
  * @param {Array.<String>} body List of roles
2094
2094
  */
2095
- putUserRoles(userId, body) {
2096
- // verify the required parameter 'userId' is set
2097
- if (userId === undefined || userId === null) {
2098
- throw 'Missing the required parameter "userId" when calling putUserRoles';
2095
+ putUserRoles(subjectId, body) {
2096
+ // verify the required parameter 'subjectId' is set
2097
+ if (subjectId === undefined || subjectId === null) {
2098
+ throw 'Missing the required parameter "subjectId" when calling putUserRoles';
2099
2099
  }
2100
2100
  // verify the required parameter 'body' is set
2101
2101
  if (body === undefined || body === null) {
@@ -2103,9 +2103,9 @@ class UsersApi {
2103
2103
  }
2104
2104
 
2105
2105
  return this.apiClient.callApi(
2106
- '/api/v2/users/{userId}/roles',
2106
+ '/api/v2/users/{subjectId}/roles',
2107
2107
  'PUT',
2108
- { 'userId': userId },
2108
+ { 'subjectId': subjectId },
2109
2109
  { },
2110
2110
  { },
2111
2111
  { },
@@ -5,7 +5,7 @@ class UtilitiesApi {
5
5
  /**
6
6
  * Utilities service.
7
7
  * @module purecloud-platform-client-v2/api/UtilitiesApi
8
- * @version 138.0.1
8
+ * @version 140.0.1
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class VoicemailApi {
5
5
  /**
6
6
  * Voicemail service.
7
7
  * @module purecloud-platform-client-v2/api/VoicemailApi
8
- * @version 138.0.1
8
+ * @version 140.0.1
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class WebChatApi {
5
5
  /**
6
6
  * WebChat service.
7
7
  * @module purecloud-platform-client-v2/api/WebChatApi
8
- * @version 138.0.1
8
+ * @version 140.0.1
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class WebDeploymentsApi {
5
5
  /**
6
6
  * WebDeployments service.
7
7
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
8
- * @version 138.0.1
8
+ * @version 140.0.1
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class WebMessagingApi {
5
5
  /**
6
6
  * WebMessaging service.
7
7
  * @module purecloud-platform-client-v2/api/WebMessagingApi
8
- * @version 138.0.1
8
+ * @version 140.0.1
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class WidgetsApi {
5
5
  /**
6
6
  * Widgets service.
7
7
  * @module purecloud-platform-client-v2/api/WidgetsApi
8
- * @version 138.0.1
8
+ * @version 140.0.1
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class WorkforceManagementApi {
5
5
  /**
6
6
  * WorkforceManagement service.
7
7
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
8
- * @version 138.0.1
8
+ * @version 140.0.1
9
9
  */
10
10
 
11
11
  /**
@@ -95,7 +95,7 @@ import WorkforceManagementApi from './api/WorkforceManagementApi.js';
95
95
  * </pre>
96
96
  * </p>
97
97
  * @module purecloud-platform-client-v2/index
98
- * @version 138.0.1
98
+ * @version 140.0.1
99
99
  */
100
100
  class platformClient {
101
101
  constructor() {