purecloud-platform-client-v2 167.0.0 → 168.1.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 (79) hide show
  1. package/README.md +2 -2
  2. package/dist/node/purecloud-platform-client-v2.js +336 -126
  3. package/dist/web-amd/purecloud-platform-client-v2.js +336 -126
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +336 -126
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +336 -126
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +212 -12
  9. package/package.json +1 -1
  10. package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
  11. package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
  12. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
  13. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
  14. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
  16. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  17. package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +75 -0
  18. package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
  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 +32 -1
  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/EventsApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +2 -2
  26. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +69 -4
  35. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  44. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  49. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  50. package/src/purecloud-platform-client-v2/api/OutboundApi.js +26 -1
  51. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/QualityApi.js +2 -2
  54. package/src/purecloud-platform-client-v2/api/RecordingApi.js +2 -2
  55. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +3 -2
  56. package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  60. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -46
  62. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  67. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  76. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  78. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +64 -6
  79. package/src/purecloud-platform-client-v2/index.js +7 -1
@@ -5,7 +5,7 @@ class StationsApi {
5
5
  /**
6
6
  * Stations service.
7
7
  * @module purecloud-platform-client-v2/api/StationsApi
8
- * @version 167.0.0
8
+ * @version 168.1.0
9
9
  */
10
10
 
11
11
  /**
@@ -101,51 +101,6 @@ class StationsApi {
101
101
  );
102
102
  }
103
103
 
104
- /**
105
- * Get an organization's StationSettings
106
- * This route is deprecated as the FreeSeatingConfiguration feature it references has been removed
107
- */
108
- getStationsSettings() {
109
-
110
- return this.apiClient.callApi(
111
- '/api/v2/stations/settings',
112
- 'GET',
113
- { },
114
- { },
115
- { },
116
- { },
117
- null,
118
- ['PureCloud OAuth'],
119
- ['application/json'],
120
- ['application/json']
121
- );
122
- }
123
-
124
- /**
125
- * Patch an organization's StationSettings
126
- * This route is deprecated as the FreeSeatingConfiguration feature it references has been removed
127
- * @param {Object} body Station settings
128
- */
129
- patchStationsSettings(body) {
130
- // verify the required parameter 'body' is set
131
- if (body === undefined || body === null) {
132
- throw 'Missing the required parameter "body" when calling patchStationsSettings';
133
- }
134
-
135
- return this.apiClient.callApi(
136
- '/api/v2/stations/settings',
137
- 'PATCH',
138
- { },
139
- { },
140
- { },
141
- { },
142
- body,
143
- ['PureCloud OAuth'],
144
- ['application/json'],
145
- ['application/json']
146
- );
147
- }
148
-
149
104
  }
150
105
 
151
106
 
@@ -5,7 +5,7 @@ class SuggestApi {
5
5
  /**
6
6
  * Suggest service.
7
7
  * @module purecloud-platform-client-v2/api/SuggestApi
8
- * @version 167.0.0
8
+ * @version 168.1.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 167.0.0
8
+ * @version 168.1.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 167.0.0
8
+ * @version 168.1.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 167.0.0
8
+ * @version 168.1.0
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 167.0.0
8
+ * @version 168.1.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 167.0.0
8
+ * @version 168.1.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 167.0.0
8
+ * @version 168.1.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 167.0.0
8
+ * @version 168.1.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 167.0.0
8
+ * @version 168.1.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 167.0.0
8
+ * @version 168.1.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 167.0.0
8
+ * @version 168.1.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 167.0.0
8
+ * @version 168.1.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 167.0.0
8
+ * @version 168.1.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 167.0.0
8
+ * @version 168.1.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 167.0.0
8
+ * @version 168.1.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 167.0.0
8
+ * @version 168.1.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 167.0.0
8
+ * @version 168.1.0
9
9
  */
10
10
 
11
11
  /**
@@ -630,7 +630,7 @@ class WorkforceManagementApi {
630
630
  * Expanding "settings" will retrieve all settings. All other expands will retrieve only the requested settings field(s).
631
631
  * @param {String} businessUnitId The ID of the business unit, or 'mine' for the business unit of the logged-in user.
632
632
  * @param {Object} opts Optional parameters
633
- * @param {Array.<String>} opts.expand
633
+ * @param {Array.<String>} opts.expand Include to access additional data on the business unit
634
634
  */
635
635
  getWorkforcemanagementBusinessunit(businessUnitId, opts) {
636
636
  opts = opts || {};
@@ -1169,7 +1169,7 @@ class WorkforceManagementApi {
1169
1169
  * @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
1170
1170
  * @param {String} forecastId The ID of the forecast
1171
1171
  * @param {Object} opts Optional parameters
1172
- * @param {Array.<String>} opts.expand
1172
+ * @param {Array.<String>} opts.expand Include to access additional data on the forecast
1173
1173
  */
1174
1174
  getWorkforcemanagementBusinessunitWeekShorttermforecast(businessUnitId, weekDateId, forecastId, opts) {
1175
1175
  opts = opts || {};
@@ -2158,7 +2158,7 @@ class WorkforceManagementApi {
2158
2158
  * "expand=details" is deprecated
2159
2159
  * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
2160
2160
  * @param {Object} opts Optional parameters
2161
- * @param {Array.<String>} opts.expand
2161
+ * @param {Array.<String>} opts.expand Include to access additional data on the work plans
2162
2162
  */
2163
2163
  getWorkforcemanagementManagementunitWorkplans(managementUnitId, opts) {
2164
2164
  opts = opts || {};
@@ -3666,7 +3666,7 @@ class WorkforceManagementApi {
3666
3666
  *
3667
3667
  * @param {String} businessUnitId The ID of the business unit to which the forecast belongs
3668
3668
  * @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
3669
- * @param {Object} body
3669
+ * @param {Object} body body
3670
3670
  * @param {Object} opts Optional parameters
3671
3671
  * @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
3672
3672
  */
@@ -3705,7 +3705,7 @@ class WorkforceManagementApi {
3705
3705
  * Call after uploading the forecast data to the url supplied by the /import/uploadurl route
3706
3706
  * @param {String} businessUnitId The ID of the business unit to which the forecast belongs
3707
3707
  * @param {String} weekDateId First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
3708
- * @param {Object} body
3708
+ * @param {Object} body body
3709
3709
  */
3710
3710
  postWorkforcemanagementBusinessunitWeekShorttermforecastsImport(businessUnitId, weekDateId, body) {
3711
3711
  // verify the required parameter 'businessUnitId' is set
@@ -4636,6 +4636,64 @@ class WorkforceManagementApi {
4636
4636
  );
4637
4637
  }
4638
4638
 
4639
+ /**
4640
+ * Request a teams historical adherence report
4641
+ * The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true
4642
+ * @param {String} teamId The ID of the team
4643
+ * @param {Object} opts Optional parameters
4644
+ * @param {Object} opts.body body
4645
+ */
4646
+ postWorkforcemanagementTeamAdherenceHistorical(teamId, opts) {
4647
+ opts = opts || {};
4648
+
4649
+ // verify the required parameter 'teamId' is set
4650
+ if (teamId === undefined || teamId === null) {
4651
+ throw 'Missing the required parameter "teamId" when calling postWorkforcemanagementTeamAdherenceHistorical';
4652
+ }
4653
+
4654
+ return this.apiClient.callApi(
4655
+ '/api/v2/workforcemanagement/teams/{teamId}/adherence/historical',
4656
+ 'POST',
4657
+ { 'teamId': teamId },
4658
+ { },
4659
+ { },
4660
+ { },
4661
+ opts['body'],
4662
+ ['PureCloud OAuth'],
4663
+ ['application/json'],
4664
+ ['application/json']
4665
+ );
4666
+ }
4667
+
4668
+ /**
4669
+ * Request a historical shrinkage report
4670
+ * The maximum supported range for historical shrinkage queries is up to 32 days
4671
+ * @param {String} teamId The ID of the team
4672
+ * @param {Object} opts Optional parameters
4673
+ * @param {Object} opts.body body
4674
+ */
4675
+ postWorkforcemanagementTeamShrinkageJobs(teamId, opts) {
4676
+ opts = opts || {};
4677
+
4678
+ // verify the required parameter 'teamId' is set
4679
+ if (teamId === undefined || teamId === null) {
4680
+ throw 'Missing the required parameter "teamId" when calling postWorkforcemanagementTeamShrinkageJobs';
4681
+ }
4682
+
4683
+ return this.apiClient.callApi(
4684
+ '/api/v2/workforcemanagement/teams/{teamId}/shrinkage/jobs',
4685
+ 'POST',
4686
+ { 'teamId': teamId },
4687
+ { },
4688
+ { },
4689
+ { },
4690
+ opts['body'],
4691
+ ['PureCloud OAuth'],
4692
+ ['application/json'],
4693
+ ['application/json']
4694
+ );
4695
+ }
4696
+
4639
4697
  /**
4640
4698
  * Queries available time off for the current user
4641
4699
  *
@@ -7,6 +7,7 @@ import ArchitectApi from './api/ArchitectApi.js';
7
7
  import AuditApi from './api/AuditApi.js';
8
8
  import AuthorizationApi from './api/AuthorizationApi.js';
9
9
  import BillingApi from './api/BillingApi.js';
10
+ import CarrierServicesApi from './api/CarrierServicesApi.js';
10
11
  import ChatApi from './api/ChatApi.js';
11
12
  import CoachingApi from './api/CoachingApi.js';
12
13
  import ContentManagementApi from './api/ContentManagementApi.js';
@@ -100,7 +101,7 @@ import WorkforceManagementApi from './api/WorkforceManagementApi.js';
100
101
  * </pre>
101
102
  * </p>
102
103
  * @module purecloud-platform-client-v2/index
103
- * @version 167.0.0
104
+ * @version 168.1.0
104
105
  */
105
106
  class platformClient {
106
107
  constructor() {
@@ -144,6 +145,11 @@ class platformClient {
144
145
  * @property {module:purecloud-platform-client-v2/api/BillingApi}
145
146
  */
146
147
  this.BillingApi = BillingApi;
148
+ /**
149
+ * The CarrierServicesApi service constructor.
150
+ * @property {module:purecloud-platform-client-v2/api/CarrierServicesApi}
151
+ */
152
+ this.CarrierServicesApi = CarrierServicesApi;
147
153
  /**
148
154
  * The ChatApi service constructor.
149
155
  * @property {module:purecloud-platform-client-v2/api/ChatApi}