purecloud-platform-client-v2 166.0.0 → 167.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 (78) hide show
  1. package/README.md +2 -2
  2. package/dist/node/purecloud-platform-client-v2.js +543 -153
  3. package/dist/web-amd/purecloud-platform-client-v2.js +543 -153
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +543 -153
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +543 -153
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +514 -208
  9. package/package.json +7 -7
  10. package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
  11. package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
  12. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
  13. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
  14. package/src/purecloud-platform-client-v2/api/AuditApi.js +3 -3
  15. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
  16. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  17. package/src/purecloud-platform-client-v2/api/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 +1 -1
  21. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  22. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/GamificationApi.js +470 -1
  28. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  44. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  49. package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
  50. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/RoutingApi.js +3 -2
  56. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  60. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -81
  65. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  67. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  76. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +2 -2
  78. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -5,7 +5,7 @@ class OAuthApi {
5
5
  /**
6
6
  * OAuth service.
7
7
  * @module purecloud-platform-client-v2/api/OAuthApi
8
- * @version 166.0.0
8
+ * @version 167.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class ObjectsApi {
5
5
  /**
6
6
  * Objects service.
7
7
  * @module purecloud-platform-client-v2/api/ObjectsApi
8
- * @version 166.0.0
8
+ * @version 167.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class OrganizationApi {
5
5
  /**
6
6
  * Organization service.
7
7
  * @module purecloud-platform-client-v2/api/OrganizationApi
8
- * @version 166.0.0
8
+ * @version 167.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class OrganizationAuthorizationApi {
5
5
  /**
6
6
  * OrganizationAuthorization service.
7
7
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
8
- * @version 166.0.0
8
+ * @version 167.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class OutboundApi {
5
5
  /**
6
6
  * Outbound service.
7
7
  * @module purecloud-platform-client-v2/api/OutboundApi
8
- * @version 166.0.0
8
+ * @version 167.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class PresenceApi {
5
5
  /**
6
6
  * Presence service.
7
7
  * @module purecloud-platform-client-v2/api/PresenceApi
8
- * @version 166.0.0
8
+ * @version 167.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class ProcessAutomationApi {
5
5
  /**
6
6
  * ProcessAutomation service.
7
7
  * @module purecloud-platform-client-v2/api/ProcessAutomationApi
8
- * @version 166.0.0
8
+ * @version 167.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class QualityApi {
5
5
  /**
6
6
  * Quality service.
7
7
  * @module purecloud-platform-client-v2/api/QualityApi
8
- * @version 166.0.0
8
+ * @version 167.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class RecordingApi {
5
5
  /**
6
6
  * Recording service.
7
7
  * @module purecloud-platform-client-v2/api/RecordingApi
8
- * @version 166.0.0
8
+ * @version 167.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class ResponseManagementApi {
5
5
  /**
6
6
  * ResponseManagement service.
7
7
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
8
- * @version 166.0.0
8
+ * @version 167.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class RoutingApi {
5
5
  /**
6
6
  * Routing service.
7
7
  * @module purecloud-platform-client-v2/api/RoutingApi
8
- * @version 166.0.0
8
+ * @version 167.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -1115,6 +1115,7 @@ class RoutingApi {
1115
1115
  *
1116
1116
  * @param {Object} opts Optional parameters
1117
1117
  * @param {Object} opts.kpiGroup The Group of Key Performance Indicators to return
1118
+ * @param {Array.<String>} opts.expand Parameter to request additional data to return in KPI payload
1118
1119
  */
1119
1120
  getRoutingPredictorsKeyperformanceindicators(opts) {
1120
1121
  opts = opts || {};
@@ -1124,7 +1125,7 @@ class RoutingApi {
1124
1125
  '/api/v2/routing/predictors/keyperformanceindicators',
1125
1126
  'GET',
1126
1127
  { },
1127
- { 'kpiGroup': opts['kpiGroup'] },
1128
+ { 'kpiGroup': opts['kpiGroup'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
1128
1129
  { },
1129
1130
  { },
1130
1131
  null,
@@ -5,7 +5,7 @@ class SCIMApi {
5
5
  /**
6
6
  * SCIM service.
7
7
  * @module purecloud-platform-client-v2/api/SCIMApi
8
- * @version 166.0.0
8
+ * @version 167.0.0
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 166.0.0
8
+ * @version 167.0.0
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 166.0.0
8
+ * @version 167.0.0
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 166.0.0
8
+ * @version 167.0.0
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 166.0.0
8
+ * @version 167.0.0
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 166.0.0
8
+ * @version 167.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class TeamsApi {
5
5
  /**
6
6
  * Teams service.
7
7
  * @module purecloud-platform-client-v2/api/TeamsApi
8
- * @version 166.0.0
8
+ * @version 167.0.0
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 166.0.0
8
+ * @version 167.0.0
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 166.0.0
8
+ * @version 167.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -200,31 +200,6 @@ class TelephonyProvidersEdgeApi {
200
200
  );
201
201
  }
202
202
 
203
- /**
204
- * Delete Outbound Route
205
- * This route is deprecated, use /telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId} instead.
206
- * @param {String} outboundRouteId Outbound route ID
207
- */
208
- deleteTelephonyProvidersEdgesOutboundroute(outboundRouteId) {
209
- // verify the required parameter 'outboundRouteId' is set
210
- if (outboundRouteId === undefined || outboundRouteId === null) {
211
- throw 'Missing the required parameter "outboundRouteId" when calling deleteTelephonyProvidersEdgesOutboundroute';
212
- }
213
-
214
- return this.apiClient.callApi(
215
- '/api/v2/telephony/providers/edges/outboundroutes/{outboundRouteId}',
216
- 'DELETE',
217
- { 'outboundRouteId': outboundRouteId },
218
- { },
219
- { },
220
- { },
221
- null,
222
- ['PureCloud OAuth'],
223
- ['application/json'],
224
- ['application/json']
225
- );
226
- }
227
-
228
203
  /**
229
204
  * Delete a Phone by ID
230
205
  *
@@ -2639,31 +2614,6 @@ class TelephonyProvidersEdgeApi {
2639
2614
  );
2640
2615
  }
2641
2616
 
2642
- /**
2643
- * Create outbound rule
2644
- * This route is deprecated, use /telephony/providers/edges/sites/{siteId}/outboundroutes instead.
2645
- * @param {Object} body OutboundRoute
2646
- */
2647
- postTelephonyProvidersEdgesOutboundroutes(body) {
2648
- // verify the required parameter 'body' is set
2649
- if (body === undefined || body === null) {
2650
- throw 'Missing the required parameter "body" when calling postTelephonyProvidersEdgesOutboundroutes';
2651
- }
2652
-
2653
- return this.apiClient.callApi(
2654
- '/api/v2/telephony/providers/edges/outboundroutes',
2655
- 'POST',
2656
- { },
2657
- { },
2658
- { },
2659
- { },
2660
- body,
2661
- ['PureCloud OAuth'],
2662
- ['application/json'],
2663
- ['application/json']
2664
- );
2665
- }
2666
-
2667
2617
  /**
2668
2618
  * Reboot a Phone
2669
2619
  *
@@ -3064,36 +3014,6 @@ class TelephonyProvidersEdgeApi {
3064
3014
  );
3065
3015
  }
3066
3016
 
3067
- /**
3068
- * Update outbound route
3069
- * This route is deprecated, use /telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId} instead.
3070
- * @param {String} outboundRouteId Outbound route ID
3071
- * @param {Object} body OutboundRoute
3072
- */
3073
- putTelephonyProvidersEdgesOutboundroute(outboundRouteId, body) {
3074
- // verify the required parameter 'outboundRouteId' is set
3075
- if (outboundRouteId === undefined || outboundRouteId === null) {
3076
- throw 'Missing the required parameter "outboundRouteId" when calling putTelephonyProvidersEdgesOutboundroute';
3077
- }
3078
- // verify the required parameter 'body' is set
3079
- if (body === undefined || body === null) {
3080
- throw 'Missing the required parameter "body" when calling putTelephonyProvidersEdgesOutboundroute';
3081
- }
3082
-
3083
- return this.apiClient.callApi(
3084
- '/api/v2/telephony/providers/edges/outboundroutes/{outboundRouteId}',
3085
- 'PUT',
3086
- { 'outboundRouteId': outboundRouteId },
3087
- { },
3088
- { },
3089
- { },
3090
- body,
3091
- ['PureCloud OAuth'],
3092
- ['application/json'],
3093
- ['application/json']
3094
- );
3095
- }
3096
-
3097
3017
  /**
3098
3018
  * Update a Phone by ID
3099
3019
  *
@@ -5,7 +5,7 @@ class TextbotsApi {
5
5
  /**
6
6
  * Textbots service.
7
7
  * @module purecloud-platform-client-v2/api/TextbotsApi
8
- * @version 166.0.0
8
+ * @version 167.0.0
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 166.0.0
8
+ * @version 167.0.0
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 166.0.0
8
+ * @version 167.0.0
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 166.0.0
8
+ * @version 167.0.0
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 166.0.0
8
+ * @version 167.0.0
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 166.0.0
8
+ * @version 167.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class UtilitiesApi {
5
5
  /**
6
6
  * Utilities service.
7
7
  * @module purecloud-platform-client-v2/api/UtilitiesApi
8
- * @version 166.0.0
8
+ * @version 167.0.0
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 166.0.0
8
+ * @version 167.0.0
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 166.0.0
8
+ * @version 167.0.0
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 166.0.0
8
+ * @version 167.0.0
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 166.0.0
8
+ * @version 167.0.0
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 166.0.0
8
+ * @version 167.0.0
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 166.0.0
8
+ * @version 167.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -2928,7 +2928,7 @@ class WorkforceManagementApi {
2928
2928
  }
2929
2929
 
2930
2930
  /**
2931
- * Request a historical adherence report for users across management units
2931
+ * Deprecated. Use bulk routes instead (/adherence/historical/bulk)
2932
2932
  *
2933
2933
  * @param {Object} opts Optional parameters
2934
2934
  * @param {Object} opts.body body
@@ -100,7 +100,7 @@ import WorkforceManagementApi from './api/WorkforceManagementApi.js';
100
100
  * </pre>
101
101
  * </p>
102
102
  * @module purecloud-platform-client-v2/index
103
- * @version 166.0.0
103
+ * @version 167.0.0
104
104
  */
105
105
  class platformClient {
106
106
  constructor() {