purecloud-platform-client-v2 141.0.0 → 143.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 (74) hide show
  1. package/README.md +2 -2
  2. package/dist/node/purecloud-platform-client-v2.js +453 -65
  3. package/dist/web-amd/purecloud-platform-client-v2.js +453 -65
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +453 -65
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +453 -65
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +435 -201
  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/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/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 +154 -1
  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 +1 -1
  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 +1 -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 +1 -1
  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 +1 -1
  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 +26 -1
  55. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +3 -2
  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/TeamsApi.js +184 -0
  59. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  60. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
  67. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +26 -1
  74. package/src/purecloud-platform-client-v2/index.js +7 -1
@@ -5,7 +5,7 @@ class SpeechTextAnalyticsApi {
5
5
  /**
6
6
  * SpeechTextAnalytics service.
7
7
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
8
- * @version 141.0.0
8
+ * @version 143.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -230,6 +230,7 @@ class SpeechTextAnalyticsApi {
230
230
  * @param {Object} opts Optional parameters
231
231
  * @param {String} opts.nextPage The key for listing the next page
232
232
  * @param {Number} opts.pageSize The page size for the listing (default to 20)
233
+ * @param {Object} opts.state Program state. Defaults to Latest
233
234
  */
234
235
  getSpeechandtextanalyticsPrograms(opts) {
235
236
  opts = opts || {};
@@ -239,7 +240,7 @@ class SpeechTextAnalyticsApi {
239
240
  '/api/v2/speechandtextanalytics/programs',
240
241
  'GET',
241
242
  { },
242
- { 'nextPage': opts['nextPage'],'pageSize': opts['pageSize'] },
243
+ { 'nextPage': opts['nextPage'],'pageSize': opts['pageSize'],'state': opts['state'] },
243
244
  { },
244
245
  { },
245
246
  null,
@@ -5,7 +5,7 @@ class StationsApi {
5
5
  /**
6
6
  * Stations service.
7
7
  * @module purecloud-platform-client-v2/api/StationsApi
8
- * @version 141.0.0
8
+ * @version 143.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 141.0.0
8
+ * @version 143.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -0,0 +1,184 @@
1
+ import ApiClient from '../ApiClient.js';
2
+
3
+
4
+ class TeamsApi {
5
+ /**
6
+ * Teams service.
7
+ * @module purecloud-platform-client-v2/api/TeamsApi
8
+ * @version 143.0.0
9
+ */
10
+
11
+ /**
12
+ * Constructs a new TeamsApi.
13
+ * @alias module:purecloud-platform-client-v2/api/TeamsApi
14
+ * @class
15
+ * @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
16
+ * default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
17
+ */
18
+ constructor(apiClient) {
19
+ this.apiClient = apiClient || ApiClient.instance;
20
+ }
21
+
22
+
23
+ /**
24
+ * Delete team
25
+ *
26
+ * @param {String} teamId Team ID
27
+ */
28
+ deleteTeam(teamId) {
29
+ // verify the required parameter 'teamId' is set
30
+ if (teamId === undefined || teamId === null) {
31
+ throw 'Missing the required parameter "teamId" when calling deleteTeam';
32
+ }
33
+
34
+ return this.apiClient.callApi(
35
+ '/api/v2/teams/{teamId}',
36
+ 'DELETE',
37
+ { 'teamId': teamId },
38
+ { },
39
+ { },
40
+ { },
41
+ null,
42
+ ['PureCloud OAuth'],
43
+ ['application/json'],
44
+ ['application/json']
45
+ );
46
+ }
47
+
48
+ /**
49
+ * Get team
50
+ *
51
+ * @param {String} teamId Team ID
52
+ */
53
+ getTeam(teamId) {
54
+ // verify the required parameter 'teamId' is set
55
+ if (teamId === undefined || teamId === null) {
56
+ throw 'Missing the required parameter "teamId" when calling getTeam';
57
+ }
58
+
59
+ return this.apiClient.callApi(
60
+ '/api/v2/teams/{teamId}',
61
+ 'GET',
62
+ { 'teamId': teamId },
63
+ { },
64
+ { },
65
+ { },
66
+ null,
67
+ ['PureCloud OAuth'],
68
+ ['application/json'],
69
+ ['application/json']
70
+ );
71
+ }
72
+
73
+ /**
74
+ * Get Team listing
75
+ *
76
+ * @param {Object} opts Optional parameters
77
+ * @param {Number} opts.pageSize Page size (default to 25)
78
+ * @param {String} opts.name Return only teams whose names start with this value (case-insensitive matching)
79
+ * @param {String} opts.after The cursor that points to the next item in the complete list of teams
80
+ * @param {String} opts.before The cursor that points to the previous item in the complete list of teams
81
+ * @param {Object} opts.expand Expand the name on each user
82
+ */
83
+ getTeams(opts) {
84
+ opts = opts || {};
85
+
86
+
87
+ return this.apiClient.callApi(
88
+ '/api/v2/teams',
89
+ 'GET',
90
+ { },
91
+ { 'pageSize': opts['pageSize'],'name': opts['name'],'after': opts['after'],'before': opts['before'],'expand': opts['expand'] },
92
+ { },
93
+ { },
94
+ null,
95
+ ['PureCloud OAuth'],
96
+ ['application/json'],
97
+ ['application/json']
98
+ );
99
+ }
100
+
101
+ /**
102
+ * Update team
103
+ *
104
+ * @param {String} teamId Team ID
105
+ * @param {Object} body Team
106
+ */
107
+ patchTeam(teamId, body) {
108
+ // verify the required parameter 'teamId' is set
109
+ if (teamId === undefined || teamId === null) {
110
+ throw 'Missing the required parameter "teamId" when calling patchTeam';
111
+ }
112
+ // verify the required parameter 'body' is set
113
+ if (body === undefined || body === null) {
114
+ throw 'Missing the required parameter "body" when calling patchTeam';
115
+ }
116
+
117
+ return this.apiClient.callApi(
118
+ '/api/v2/teams/{teamId}',
119
+ 'PATCH',
120
+ { 'teamId': teamId },
121
+ { },
122
+ { },
123
+ { },
124
+ body,
125
+ ['PureCloud OAuth'],
126
+ ['application/json'],
127
+ ['application/json']
128
+ );
129
+ }
130
+
131
+ /**
132
+ * Create a team
133
+ *
134
+ * @param {Object} body Team
135
+ */
136
+ postTeams(body) {
137
+ // verify the required parameter 'body' is set
138
+ if (body === undefined || body === null) {
139
+ throw 'Missing the required parameter "body" when calling postTeams';
140
+ }
141
+
142
+ return this.apiClient.callApi(
143
+ '/api/v2/teams',
144
+ 'POST',
145
+ { },
146
+ { },
147
+ { },
148
+ { },
149
+ body,
150
+ ['PureCloud OAuth'],
151
+ ['application/json'],
152
+ ['application/json']
153
+ );
154
+ }
155
+
156
+ /**
157
+ * Search resources.
158
+ *
159
+ * @param {Object} body Search request options
160
+ */
161
+ postTeamsSearch(body) {
162
+ // verify the required parameter 'body' is set
163
+ if (body === undefined || body === null) {
164
+ throw 'Missing the required parameter "body" when calling postTeamsSearch';
165
+ }
166
+
167
+ return this.apiClient.callApi(
168
+ '/api/v2/teams/search',
169
+ 'POST',
170
+ { },
171
+ { },
172
+ { },
173
+ { },
174
+ body,
175
+ ['PureCloud OAuth'],
176
+ ['application/json'],
177
+ ['application/json']
178
+ );
179
+ }
180
+
181
+ }
182
+
183
+
184
+ export default TeamsApi;
@@ -5,7 +5,7 @@ class TelephonyApi {
5
5
  /**
6
6
  * Telephony service.
7
7
  * @module purecloud-platform-client-v2/api/TelephonyApi
8
- * @version 141.0.0
8
+ * @version 143.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 141.0.0
8
+ * @version 143.0.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 141.0.0
8
+ * @version 143.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 141.0.0
8
+ * @version 143.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 141.0.0
8
+ * @version 143.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 141.0.0
8
+ * @version 143.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 141.0.0
8
+ * @version 143.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 141.0.0
8
+ * @version 143.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 141.0.0
8
+ * @version 143.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 141.0.0
8
+ * @version 143.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 141.0.0
8
+ * @version 143.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 141.0.0
8
+ * @version 143.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 141.0.0
8
+ * @version 143.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 141.0.0
8
+ * @version 143.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 141.0.0
8
+ * @version 143.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -425,6 +425,31 @@ class WorkforceManagementApi {
425
425
  );
426
426
  }
427
427
 
428
+ /**
429
+ * Query the status of a historical adherence request operation. Only the user who started the operation can query the status
430
+ * Job details are only retained if the initial request returned a 202 ACCEPTED response
431
+ * @param {String} jobId jobId
432
+ */
433
+ getWorkforcemanagementAdherenceHistoricalJob(jobId) {
434
+ // verify the required parameter 'jobId' is set
435
+ if (jobId === undefined || jobId === null) {
436
+ throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementAdherenceHistoricalJob';
437
+ }
438
+
439
+ return this.apiClient.callApi(
440
+ '/api/v2/workforcemanagement/adherence/historical/jobs/{jobId}',
441
+ 'GET',
442
+ { 'jobId': jobId },
443
+ { },
444
+ { },
445
+ { },
446
+ null,
447
+ ['PureCloud OAuth'],
448
+ ['application/json'],
449
+ ['application/json']
450
+ );
451
+ }
452
+
428
453
  /**
429
454
  * Get status of the modeling job
430
455
  *
@@ -48,6 +48,7 @@ import SearchApi from './api/SearchApi.js';
48
48
  import SpeechTextAnalyticsApi from './api/SpeechTextAnalyticsApi.js';
49
49
  import StationsApi from './api/StationsApi.js';
50
50
  import SuggestApi from './api/SuggestApi.js';
51
+ import TeamsApi from './api/TeamsApi.js';
51
52
  import TelephonyApi from './api/TelephonyApi.js';
52
53
  import TelephonyProvidersEdgeApi from './api/TelephonyProvidersEdgeApi.js';
53
54
  import TextbotsApi from './api/TextbotsApi.js';
@@ -95,7 +96,7 @@ import WorkforceManagementApi from './api/WorkforceManagementApi.js';
95
96
  * </pre>
96
97
  * </p>
97
98
  * @module purecloud-platform-client-v2/index
98
- * @version 141.0.0
99
+ * @version 143.0.0
99
100
  */
100
101
  class platformClient {
101
102
  constructor() {
@@ -344,6 +345,11 @@ class platformClient {
344
345
  * @property {module:purecloud-platform-client-v2/api/SuggestApi}
345
346
  */
346
347
  this.SuggestApi = SuggestApi;
348
+ /**
349
+ * The TeamsApi service constructor.
350
+ * @property {module:purecloud-platform-client-v2/api/TeamsApi}
351
+ */
352
+ this.TeamsApi = TeamsApi;
347
353
  /**
348
354
  * The TelephonyApi service constructor.
349
355
  * @property {module:purecloud-platform-client-v2/api/TelephonyApi}