purecloud-platform-client-v2 136.1.0 → 137.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 (73) hide show
  1. package/README.md +2 -2
  2. package/dist/node/purecloud-platform-client-v2.js +9544 -9538
  3. package/dist/web-amd/purecloud-platform-client-v2.js +9544 -9538
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +9544 -9538
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +9544 -9538
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +5262 -74
  9. package/package.json +1 -1
  10. package/src/purecloud-platform-client-v2/ApiClient.js +14 -5
  11. package/src/purecloud-platform-client-v2/api/AlertingApi.js +56 -56
  12. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +231 -231
  13. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +534 -534
  14. package/src/purecloud-platform-client-v2/api/AuditApi.js +31 -31
  15. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +212 -212
  16. package/src/purecloud-platform-client-v2/api/BillingApi.js +12 -12
  17. package/src/purecloud-platform-client-v2/api/ChatApi.js +16 -16
  18. package/src/purecloud-platform-client-v2/api/CoachingApi.js +96 -96
  19. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +192 -192
  20. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +808 -808
  21. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +17 -17
  22. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +337 -337
  23. package/src/purecloud-platform-client-v2/api/FaxApi.js +31 -31
  24. package/src/purecloud-platform-client-v2/api/FlowsApi.js +11 -11
  25. package/src/purecloud-platform-client-v2/api/GamificationApi.js +246 -246
  26. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +21 -21
  27. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +26 -26
  28. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +88 -88
  29. package/src/purecloud-platform-client-v2/api/GroupsApi.js +72 -72
  30. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +171 -171
  31. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +311 -311
  32. package/src/purecloud-platform-client-v2/api/JourneyApi.js +146 -146
  33. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +131 -131
  34. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +151 -151
  35. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +51 -51
  36. package/src/purecloud-platform-client-v2/api/LearningApi.js +107 -107
  37. package/src/purecloud-platform-client-v2/api/LicenseApi.js +49 -49
  38. package/src/purecloud-platform-client-v2/api/LocationsApi.js +41 -41
  39. package/src/purecloud-platform-client-v2/api/MessagingApi.js +26 -26
  40. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +26 -26
  41. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +43 -43
  42. package/src/purecloud-platform-client-v2/api/OAuthApi.js +67 -67
  43. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +50 -50
  44. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +81 -81
  45. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +162 -162
  46. package/src/purecloud-platform-client-v2/api/OutboundApi.js +608 -608
  47. package/src/purecloud-platform-client-v2/api/PresenceApi.js +64 -64
  48. package/src/purecloud-platform-client-v2/api/QualityApi.js +285 -285
  49. package/src/purecloud-platform-client-v2/api/RecordingApi.js +302 -302
  50. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +86 -86
  51. package/src/purecloud-platform-client-v2/api/RoutingApi.js +536 -536
  52. package/src/purecloud-platform-client-v2/api/SCIMApi.js +195 -195
  53. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +66 -66
  54. package/src/purecloud-platform-client-v2/api/SearchApi.js +96 -96
  55. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +194 -194
  56. package/src/purecloud-platform-client-v2/api/StationsApi.js +28 -28
  57. package/src/purecloud-platform-client-v2/api/SuggestApi.js +21 -21
  58. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +16 -16
  59. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +657 -657
  60. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +23 -23
  61. package/src/purecloud-platform-client-v2/api/TokensApi.js +21 -21
  62. package/src/purecloud-platform-client-v2/api/UploadsApi.js +26 -26
  63. package/src/purecloud-platform-client-v2/api/UsageApi.js +11 -11
  64. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +31 -31
  65. package/src/purecloud-platform-client-v2/api/UsersApi.js +413 -413
  66. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +21 -21
  67. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +140 -140
  68. package/src/purecloud-platform-client-v2/api/WebChatApi.js +97 -97
  69. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +66 -66
  70. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +6 -6
  71. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +26 -26
  72. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +765 -765
  73. package/src/purecloud-platform-client-v2/index.js +145 -149
@@ -5,7 +5,7 @@ class LicenseApi {
5
5
  /**
6
6
  * License service.
7
7
  * @module purecloud-platform-client-v2/api/LicenseApi
8
- * @version 136.1.0
8
+ * @version 137.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -34,13 +34,13 @@ class LicenseApi {
34
34
  return this.apiClient.callApi(
35
35
  '/api/v2/license/definitions/{licenseId}',
36
36
  'GET',
37
- { 'licenseId': licenseId },
38
- { },
39
- { },
40
- { },
37
+ { 'licenseId': licenseId },
38
+ { },
39
+ { },
40
+ { },
41
41
  null,
42
42
  ['PureCloud OAuth'],
43
- ['application/json'],
43
+ ['application/json'],
44
44
  ['application/json']
45
45
  );
46
46
  }
@@ -54,13 +54,13 @@ class LicenseApi {
54
54
  return this.apiClient.callApi(
55
55
  '/api/v2/license/definitions',
56
56
  'GET',
57
- { },
58
- { },
59
- { },
60
- { },
57
+ { },
58
+ { },
59
+ { },
60
+ { },
61
61
  null,
62
62
  ['PureCloud OAuth'],
63
- ['application/json'],
63
+ ['application/json'],
64
64
  ['application/json']
65
65
  );
66
66
  }
@@ -79,13 +79,13 @@ class LicenseApi {
79
79
  return this.apiClient.callApi(
80
80
  '/api/v2/license/toggles/{featureName}',
81
81
  'GET',
82
- { 'featureName': featureName },
83
- { },
84
- { },
85
- { },
82
+ { 'featureName': featureName },
83
+ { },
84
+ { },
85
+ { },
86
86
  null,
87
87
  ['PureCloud OAuth'],
88
- ['application/json'],
88
+ ['application/json'],
89
89
  ['application/json']
90
90
  );
91
91
  }
@@ -104,13 +104,13 @@ class LicenseApi {
104
104
  return this.apiClient.callApi(
105
105
  '/api/v2/license/users/{userId}',
106
106
  'GET',
107
- { 'userId': userId },
108
- { },
109
- { },
110
- { },
107
+ { 'userId': userId },
108
+ { },
109
+ { },
110
+ { },
111
111
  null,
112
112
  ['PureCloud OAuth'],
113
- ['application/json'],
113
+ ['application/json'],
114
114
  ['application/json']
115
115
  );
116
116
  }
@@ -129,13 +129,13 @@ class LicenseApi {
129
129
  return this.apiClient.callApi(
130
130
  '/api/v2/license/users',
131
131
  'GET',
132
- { },
133
- { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
134
- { },
135
- { },
132
+ { },
133
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
134
+ { },
135
+ { },
136
136
  null,
137
137
  ['PureCloud OAuth'],
138
- ['application/json'],
138
+ ['application/json'],
139
139
  ['application/json']
140
140
  );
141
141
  }
@@ -144,7 +144,7 @@ class LicenseApi {
144
144
  * Get a list of licenses inferred based on a list of roleIds
145
145
  *
146
146
  * @param {Object} opts Optional parameters
147
- * @param {Array.<Object>} opts.body The roleIds to use while inferring licenses
147
+ * @param {Array.<String>} opts.body The roleIds to use while inferring licenses
148
148
  */
149
149
  postLicenseInfer(opts) {
150
150
  opts = opts || {};
@@ -153,19 +153,19 @@ class LicenseApi {
153
153
  return this.apiClient.callApi(
154
154
  '/api/v2/license/infer',
155
155
  'POST',
156
- { },
157
- { },
158
- { },
159
- { },
156
+ { },
157
+ { },
158
+ { },
159
+ { },
160
160
  opts['body'],
161
161
  ['PureCloud OAuth'],
162
- ['application/json'],
162
+ ['application/json'],
163
163
  ['application/json']
164
164
  );
165
165
  }
166
166
 
167
167
  /**
168
- * Update the organization&#39;s license assignments in a batch.
168
+ * Update the organization's license assignments in a batch.
169
169
  *
170
170
  * @param {Object} opts Optional parameters
171
171
  * @param {Object} opts.body The license assignments to update.
@@ -177,13 +177,13 @@ class LicenseApi {
177
177
  return this.apiClient.callApi(
178
178
  '/api/v2/license/organization',
179
179
  'POST',
180
- { },
181
- { },
182
- { },
183
- { },
180
+ { },
181
+ { },
182
+ { },
183
+ { },
184
184
  opts['body'],
185
185
  ['PureCloud OAuth'],
186
- ['application/json'],
186
+ ['application/json'],
187
187
  ['application/json']
188
188
  );
189
189
  }
@@ -202,13 +202,13 @@ class LicenseApi {
202
202
  return this.apiClient.callApi(
203
203
  '/api/v2/license/toggles/{featureName}',
204
204
  'POST',
205
- { 'featureName': featureName },
206
- { },
207
- { },
208
- { },
205
+ { 'featureName': featureName },
206
+ { },
207
+ { },
208
+ { },
209
209
  null,
210
210
  ['PureCloud OAuth'],
211
- ['application/json'],
211
+ ['application/json'],
212
212
  ['application/json']
213
213
  );
214
214
  }
@@ -217,7 +217,7 @@ class LicenseApi {
217
217
  * Fetch user licenses in a batch.
218
218
  *
219
219
  * @param {Object} opts Optional parameters
220
- * @param {Array.<Object>} opts.body The user IDs to fetch.
220
+ * @param {Array.<String>} opts.body The user IDs to fetch.
221
221
  */
222
222
  postLicenseUsers(opts) {
223
223
  opts = opts || {};
@@ -226,13 +226,13 @@ class LicenseApi {
226
226
  return this.apiClient.callApi(
227
227
  '/api/v2/license/users',
228
228
  'POST',
229
- { },
230
- { },
231
- { },
232
- { },
229
+ { },
230
+ { },
231
+ { },
232
+ { },
233
233
  opts['body'],
234
234
  ['PureCloud OAuth'],
235
- ['application/json'],
235
+ ['application/json'],
236
236
  ['application/json']
237
237
  );
238
238
  }
@@ -5,7 +5,7 @@ class LocationsApi {
5
5
  /**
6
6
  * Locations service.
7
7
  * @module purecloud-platform-client-v2/api/LocationsApi
8
- * @version 136.1.0
8
+ * @version 137.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -34,13 +34,13 @@ class LocationsApi {
34
34
  return this.apiClient.callApi(
35
35
  '/api/v2/locations/{locationId}',
36
36
  'DELETE',
37
- { 'locationId': locationId },
38
- { },
39
- { },
40
- { },
37
+ { 'locationId': locationId },
38
+ { },
39
+ { },
40
+ { },
41
41
  null,
42
42
  ['PureCloud OAuth'],
43
- ['application/json'],
43
+ ['application/json'],
44
44
  ['application/json']
45
45
  );
46
46
  }
@@ -63,13 +63,13 @@ class LocationsApi {
63
63
  return this.apiClient.callApi(
64
64
  '/api/v2/locations/{locationId}',
65
65
  'GET',
66
- { 'locationId': locationId },
67
- { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
68
- { },
69
- { },
66
+ { 'locationId': locationId },
67
+ { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
68
+ { },
69
+ { },
70
70
  null,
71
71
  ['PureCloud OAuth'],
72
- ['application/json'],
72
+ ['application/json'],
73
73
  ['application/json']
74
74
  );
75
75
  }
@@ -88,13 +88,13 @@ class LocationsApi {
88
88
  return this.apiClient.callApi(
89
89
  '/api/v2/locations/{locationId}/sublocations',
90
90
  'GET',
91
- { 'locationId': locationId },
92
- { },
93
- { },
94
- { },
91
+ { 'locationId': locationId },
92
+ { },
93
+ { },
94
+ { },
95
95
  null,
96
96
  ['PureCloud OAuth'],
97
- ['application/json'],
97
+ ['application/json'],
98
98
  ['application/json']
99
99
  );
100
100
  }
@@ -115,13 +115,13 @@ class LocationsApi {
115
115
  return this.apiClient.callApi(
116
116
  '/api/v2/locations',
117
117
  'GET',
118
- { },
119
- { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'sortOrder': opts['sortOrder'] },
120
- { },
121
- { },
118
+ { },
119
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'sortOrder': opts['sortOrder'] },
120
+ { },
121
+ { },
122
122
  null,
123
123
  ['PureCloud OAuth'],
124
- ['application/json'],
124
+ ['application/json'],
125
125
  ['application/json']
126
126
  );
127
127
  }
@@ -144,13 +144,13 @@ class LocationsApi {
144
144
  return this.apiClient.callApi(
145
145
  '/api/v2/locations/search',
146
146
  'GET',
147
- { },
148
- { 'q64': q64,'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
149
- { },
150
- { },
147
+ { },
148
+ { 'q64': q64,'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
149
+ { },
150
+ { },
151
151
  null,
152
152
  ['PureCloud OAuth'],
153
- ['application/json'],
153
+ ['application/json'],
154
154
  ['application/json']
155
155
  );
156
156
  }
@@ -174,13 +174,13 @@ class LocationsApi {
174
174
  return this.apiClient.callApi(
175
175
  '/api/v2/locations/{locationId}',
176
176
  'PATCH',
177
- { 'locationId': locationId },
178
- { },
179
- { },
180
- { },
177
+ { 'locationId': locationId },
178
+ { },
179
+ { },
180
+ { },
181
181
  body,
182
182
  ['PureCloud OAuth'],
183
- ['application/json'],
183
+ ['application/json'],
184
184
  ['application/json']
185
185
  );
186
186
  }
@@ -199,13 +199,13 @@ class LocationsApi {
199
199
  return this.apiClient.callApi(
200
200
  '/api/v2/locations',
201
201
  'POST',
202
- { },
203
- { },
204
- { },
205
- { },
202
+ { },
203
+ { },
204
+ { },
205
+ { },
206
206
  body,
207
207
  ['PureCloud OAuth'],
208
- ['application/json'],
208
+ ['application/json'],
209
209
  ['application/json']
210
210
  );
211
211
  }
@@ -224,13 +224,13 @@ class LocationsApi {
224
224
  return this.apiClient.callApi(
225
225
  '/api/v2/locations/search',
226
226
  'POST',
227
- { },
228
- { },
229
- { },
230
- { },
227
+ { },
228
+ { },
229
+ { },
230
+ { },
231
231
  body,
232
232
  ['PureCloud OAuth'],
233
- ['application/json'],
233
+ ['application/json'],
234
234
  ['application/json']
235
235
  );
236
236
  }
@@ -5,7 +5,7 @@ class MessagingApi {
5
5
  /**
6
6
  * Messaging service.
7
7
  * @module purecloud-platform-client-v2/api/MessagingApi
8
- * @version 136.1.0
8
+ * @version 137.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -34,13 +34,13 @@ class MessagingApi {
34
34
  return this.apiClient.callApi(
35
35
  '/api/v2/messaging/supportedcontent/{supportedContentId}',
36
36
  'DELETE',
37
- { 'supportedContentId': supportedContentId },
38
- { },
39
- { },
40
- { },
37
+ { 'supportedContentId': supportedContentId },
38
+ { },
39
+ { },
40
+ { },
41
41
  null,
42
42
  ['PureCloud OAuth'],
43
- ['application/json'],
43
+ ['application/json'],
44
44
  ['application/json']
45
45
  );
46
46
  }
@@ -59,13 +59,13 @@ class MessagingApi {
59
59
  return this.apiClient.callApi(
60
60
  '/api/v2/messaging/supportedcontent',
61
61
  'GET',
62
- { },
63
- { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
64
- { },
65
- { },
62
+ { },
63
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
64
+ { },
65
+ { },
66
66
  null,
67
67
  ['PureCloud OAuth'],
68
- ['application/json'],
68
+ ['application/json'],
69
69
  ['application/json']
70
70
  );
71
71
  }
@@ -84,13 +84,13 @@ class MessagingApi {
84
84
  return this.apiClient.callApi(
85
85
  '/api/v2/messaging/supportedcontent/{supportedContentId}',
86
86
  'GET',
87
- { 'supportedContentId': supportedContentId },
88
- { },
89
- { },
90
- { },
87
+ { 'supportedContentId': supportedContentId },
88
+ { },
89
+ { },
90
+ { },
91
91
  null,
92
92
  ['PureCloud OAuth'],
93
- ['application/json'],
93
+ ['application/json'],
94
94
  ['application/json']
95
95
  );
96
96
  }
@@ -114,13 +114,13 @@ class MessagingApi {
114
114
  return this.apiClient.callApi(
115
115
  '/api/v2/messaging/supportedcontent/{supportedContentId}',
116
116
  'PATCH',
117
- { 'supportedContentId': supportedContentId },
118
- { },
119
- { },
120
- { },
117
+ { 'supportedContentId': supportedContentId },
118
+ { },
119
+ { },
120
+ { },
121
121
  body,
122
122
  ['PureCloud OAuth'],
123
- ['application/json'],
123
+ ['application/json'],
124
124
  ['application/json']
125
125
  );
126
126
  }
@@ -139,13 +139,13 @@ class MessagingApi {
139
139
  return this.apiClient.callApi(
140
140
  '/api/v2/messaging/supportedcontent',
141
141
  'POST',
142
- { },
143
- { },
144
- { },
145
- { },
142
+ { },
143
+ { },
144
+ { },
145
+ { },
146
146
  body,
147
147
  ['PureCloud OAuth'],
148
- ['application/json'],
148
+ ['application/json'],
149
149
  ['application/json']
150
150
  );
151
151
  }
@@ -5,7 +5,7 @@ class MobileDevicesApi {
5
5
  /**
6
6
  * MobileDevices service.
7
7
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
8
- * @version 136.1.0
8
+ * @version 137.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -34,13 +34,13 @@ class MobileDevicesApi {
34
34
  return this.apiClient.callApi(
35
35
  '/api/v2/mobiledevices/{deviceId}',
36
36
  'DELETE',
37
- { 'deviceId': deviceId },
38
- { },
39
- { },
40
- { },
37
+ { 'deviceId': deviceId },
38
+ { },
39
+ { },
40
+ { },
41
41
  null,
42
42
  ['PureCloud OAuth'],
43
- ['application/json'],
43
+ ['application/json'],
44
44
  ['application/json']
45
45
  );
46
46
  }
@@ -59,13 +59,13 @@ class MobileDevicesApi {
59
59
  return this.apiClient.callApi(
60
60
  '/api/v2/mobiledevices/{deviceId}',
61
61
  'GET',
62
- { 'deviceId': deviceId },
63
- { },
64
- { },
65
- { },
62
+ { 'deviceId': deviceId },
63
+ { },
64
+ { },
65
+ { },
66
66
  null,
67
67
  ['PureCloud OAuth'],
68
- ['application/json'],
68
+ ['application/json'],
69
69
  ['application/json']
70
70
  );
71
71
  }
@@ -85,13 +85,13 @@ class MobileDevicesApi {
85
85
  return this.apiClient.callApi(
86
86
  '/api/v2/mobiledevices',
87
87
  'GET',
88
- { },
89
- { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'] },
90
- { },
91
- { },
88
+ { },
89
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'] },
90
+ { },
91
+ { },
92
92
  null,
93
93
  ['PureCloud OAuth'],
94
- ['application/json'],
94
+ ['application/json'],
95
95
  ['application/json']
96
96
  );
97
97
  }
@@ -110,13 +110,13 @@ class MobileDevicesApi {
110
110
  return this.apiClient.callApi(
111
111
  '/api/v2/mobiledevices',
112
112
  'POST',
113
- { },
114
- { },
115
- { },
116
- { },
113
+ { },
114
+ { },
115
+ { },
116
+ { },
117
117
  body,
118
118
  ['PureCloud OAuth'],
119
- ['application/json'],
119
+ ['application/json'],
120
120
  ['application/json']
121
121
  );
122
122
  }
@@ -139,13 +139,13 @@ class MobileDevicesApi {
139
139
  return this.apiClient.callApi(
140
140
  '/api/v2/mobiledevices/{deviceId}',
141
141
  'PUT',
142
- { 'deviceId': deviceId },
143
- { },
144
- { },
145
- { },
142
+ { 'deviceId': deviceId },
143
+ { },
144
+ { },
145
+ { },
146
146
  opts['body'],
147
147
  ['PureCloud OAuth'],
148
- ['application/json'],
148
+ ['application/json'],
149
149
  ['application/json']
150
150
  );
151
151
  }