purecloud-platform-client-v2 249.0.0 → 250.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 (97) hide show
  1. package/README.md +34 -3
  2. package/dist/node/purecloud-platform-client-v2.js +20042 -5569
  3. package/dist/web-amd/purecloud-platform-client-v2.js +20042 -5569
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +11159 -5369
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +11159 -5369
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +10600 -2242
  9. package/package.json +1 -1
  10. package/src/purecloud-platform-client-v2/ApiClient.js +26 -2
  11. package/src/purecloud-platform-client-v2/api/AIStudioApi.js +136 -40
  12. package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +130 -39
  13. package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +18 -6
  14. package/src/purecloud-platform-client-v2/api/AgentUIApi.js +29 -9
  15. package/src/purecloud-platform-client-v2/api/AlertingApi.js +86 -26
  16. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +917 -224
  17. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +754 -226
  18. package/src/purecloud-platform-client-v2/api/AssistantCopilotVariationsApi.js +36 -11
  19. package/src/purecloud-platform-client-v2/api/AuditApi.js +38 -12
  20. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +302 -91
  21. package/src/purecloud-platform-client-v2/api/BackgroundAssistantApi.js +7 -3
  22. package/src/purecloud-platform-client-v2/api/BillingApi.js +41 -13
  23. package/src/purecloud-platform-client-v2/api/BusinessRulesApi.js +180 -53
  24. package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +11 -4
  25. package/src/purecloud-platform-client-v2/api/CaseManagementApi.js +187 -56
  26. package/src/purecloud-platform-client-v2/api/ChatApi.js +223 -65
  27. package/src/purecloud-platform-client-v2/api/CoachingApi.js +124 -37
  28. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +165 -51
  29. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1992 -578
  30. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +22 -7
  31. package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +39 -12
  32. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +4 -2
  33. package/src/purecloud-platform-client-v2/api/EmailsApi.js +28 -9
  34. package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +35 -11
  35. package/src/purecloud-platform-client-v2/api/EventsApi.js +22 -7
  36. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +700 -206
  37. package/src/purecloud-platform-client-v2/api/FaxApi.js +49 -15
  38. package/src/purecloud-platform-client-v2/api/FlowsApi.js +42 -13
  39. package/src/purecloud-platform-client-v2/api/GamificationApi.js +419 -125
  40. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +21 -7
  41. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +29 -9
  42. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +106 -32
  43. package/src/purecloud-platform-client-v2/api/GroupsApi.js +103 -31
  44. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +267 -77
  45. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +20 -7
  46. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +461 -139
  47. package/src/purecloud-platform-client-v2/api/IntentsApi.js +93 -28
  48. package/src/purecloud-platform-client-v2/api/JourneyApi.js +872 -120
  49. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +618 -185
  50. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +221 -66
  51. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +53 -16
  52. package/src/purecloud-platform-client-v2/api/LearningApi.js +199 -60
  53. package/src/purecloud-platform-client-v2/api/LicenseApi.js +51 -16
  54. package/src/purecloud-platform-client-v2/api/LocationsApi.js +45 -14
  55. package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +34 -11
  56. package/src/purecloud-platform-client-v2/api/MessagingApi.js +84 -25
  57. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +28 -9
  58. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +41 -13
  59. package/src/purecloud-platform-client-v2/api/OAuthApi.js +72 -22
  60. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +58 -18
  61. package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +21 -7
  62. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +122 -36
  63. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +297 -87
  64. package/src/purecloud-platform-client-v2/api/OutboundApi.js +1066 -312
  65. package/src/purecloud-platform-client-v2/api/PresenceApi.js +162 -48
  66. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +41 -13
  67. package/src/purecloud-platform-client-v2/api/QualityApi.js +409 -121
  68. package/src/purecloud-platform-client-v2/api/RecordingApi.js +351 -108
  69. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +113 -34
  70. package/src/purecloud-platform-client-v2/api/RoutingApi.js +964 -284
  71. package/src/purecloud-platform-client-v2/api/SCIMApi.js +123 -39
  72. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +50 -17
  73. package/src/purecloud-platform-client-v2/api/SearchApi.js +147 -44
  74. package/src/purecloud-platform-client-v2/api/SettingsApi.js +87 -26
  75. package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +208 -67
  76. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +389 -114
  77. package/src/purecloud-platform-client-v2/api/StationsApi.js +18 -6
  78. package/src/purecloud-platform-client-v2/api/SuggestApi.js +13 -5
  79. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +473 -138
  80. package/src/purecloud-platform-client-v2/api/TeamsApi.js +55 -17
  81. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +80 -24
  82. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +751 -220
  83. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +25 -8
  84. package/src/purecloud-platform-client-v2/api/TokensApi.js +35 -11
  85. package/src/purecloud-platform-client-v2/api/UploadsApi.js +78 -23
  86. package/src/purecloud-platform-client-v2/api/UsageApi.js +62 -19
  87. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +27 -9
  88. package/src/purecloud-platform-client-v2/api/UsersApi.js +717 -228
  89. package/src/purecloud-platform-client-v2/api/UsersRulesApi.js +52 -16
  90. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +25 -8
  91. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +154 -46
  92. package/src/purecloud-platform-client-v2/api/WebChatApi.js +126 -37
  93. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +120 -36
  94. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +25 -8
  95. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +36 -11
  96. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +2475 -577
  97. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -5,7 +5,7 @@ class FaxApi {
5
5
  /**
6
6
  * Fax service.
7
7
  * @module purecloud-platform-client-v2/api/FaxApi
8
- * @version 249.0.0
8
+ * @version 250.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -24,8 +24,12 @@ class FaxApi {
24
24
  * Delete a fax document.
25
25
  *
26
26
  * @param {String} documentId Document ID
27
+ * @param {Object} opts Optional parameters
28
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
27
29
  */
28
- deleteFaxDocument(documentId) {
30
+ deleteFaxDocument(documentId, opts) {
31
+ opts = opts || {};
32
+
29
33
  // verify the required parameter 'documentId' is set
30
34
  if (documentId === undefined || documentId === null || documentId === '') {
31
35
  throw 'Missing the required parameter "documentId" when calling deleteFaxDocument';
@@ -41,7 +45,8 @@ class FaxApi {
41
45
  null,
42
46
  ['PureCloud OAuth'],
43
47
  ['application/json'],
44
- ['application/json']
48
+ ['application/json'],
49
+ opts['customHeaders']
45
50
  );
46
51
  }
47
52
 
@@ -49,8 +54,12 @@ class FaxApi {
49
54
  * Get a document.
50
55
  *
51
56
  * @param {String} documentId Document ID
57
+ * @param {Object} opts Optional parameters
58
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
52
59
  */
53
- getFaxDocument(documentId) {
60
+ getFaxDocument(documentId, opts) {
61
+ opts = opts || {};
62
+
54
63
  // verify the required parameter 'documentId' is set
55
64
  if (documentId === undefined || documentId === null || documentId === '') {
56
65
  throw 'Missing the required parameter "documentId" when calling getFaxDocument';
@@ -66,7 +75,8 @@ class FaxApi {
66
75
  null,
67
76
  ['PureCloud OAuth'],
68
77
  ['application/json'],
69
- ['application/json']
78
+ ['application/json'],
79
+ opts['customHeaders']
70
80
  );
71
81
  }
72
82
 
@@ -74,8 +84,12 @@ class FaxApi {
74
84
  * Download a fax document.
75
85
  *
76
86
  * @param {String} documentId Document ID
87
+ * @param {Object} opts Optional parameters
88
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
77
89
  */
78
- getFaxDocumentContent(documentId) {
90
+ getFaxDocumentContent(documentId, opts) {
91
+ opts = opts || {};
92
+
79
93
  // verify the required parameter 'documentId' is set
80
94
  if (documentId === undefined || documentId === null || documentId === '') {
81
95
  throw 'Missing the required parameter "documentId" when calling getFaxDocumentContent';
@@ -91,7 +105,8 @@ class FaxApi {
91
105
  null,
92
106
  ['PureCloud OAuth'],
93
107
  ['application/json'],
94
- ['application/json']
108
+ ['application/json'],
109
+ opts['customHeaders']
95
110
  );
96
111
  }
97
112
 
@@ -101,6 +116,7 @@ class FaxApi {
101
116
  * @param {Object} opts Optional parameters
102
117
  * @param {Number} opts.pageSize Page size (default to 25)
103
118
  * @param {Number} opts.pageNumber Page number (default to 1)
119
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
104
120
  */
105
121
  getFaxDocuments(opts) {
106
122
  opts = opts || {};
@@ -116,15 +132,20 @@ class FaxApi {
116
132
  null,
117
133
  ['PureCloud OAuth'],
118
134
  ['application/json'],
119
- ['application/json']
135
+ ['application/json'],
136
+ opts['customHeaders']
120
137
  );
121
138
  }
122
139
 
123
140
  /**
124
141
  * Get organization config for given organization
125
142
  *
143
+ * @param {Object} opts Optional parameters
144
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
126
145
  */
127
- getFaxSettings() {
146
+ getFaxSettings(opts) {
147
+ opts = opts || {};
148
+
128
149
 
129
150
  return this.apiClient.callApi(
130
151
  '/api/v2/fax/settings',
@@ -136,15 +157,20 @@ class FaxApi {
136
157
  null,
137
158
  ['PureCloud OAuth'],
138
159
  ['application/json'],
139
- ['application/json']
160
+ ['application/json'],
161
+ opts['customHeaders']
140
162
  );
141
163
  }
142
164
 
143
165
  /**
144
166
  * Get fax summary
145
167
  *
168
+ * @param {Object} opts Optional parameters
169
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
146
170
  */
147
- getFaxSummary() {
171
+ getFaxSummary(opts) {
172
+ opts = opts || {};
173
+
148
174
 
149
175
  return this.apiClient.callApi(
150
176
  '/api/v2/fax/summary',
@@ -156,7 +182,8 @@ class FaxApi {
156
182
  null,
157
183
  ['PureCloud OAuth'],
158
184
  ['application/json'],
159
- ['application/json']
185
+ ['application/json'],
186
+ opts['customHeaders']
160
187
  );
161
188
  }
162
189
 
@@ -165,8 +192,12 @@ class FaxApi {
165
192
  *
166
193
  * @param {String} documentId Document ID
167
194
  * @param {Object} body Document
195
+ * @param {Object} opts Optional parameters
196
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
168
197
  */
169
- putFaxDocument(documentId, body) {
198
+ putFaxDocument(documentId, body, opts) {
199
+ opts = opts || {};
200
+
170
201
  // verify the required parameter 'documentId' is set
171
202
  if (documentId === undefined || documentId === null || documentId === '') {
172
203
  throw 'Missing the required parameter "documentId" when calling putFaxDocument';
@@ -186,7 +217,8 @@ class FaxApi {
186
217
  body,
187
218
  ['PureCloud OAuth'],
188
219
  ['application/json'],
189
- ['application/json']
220
+ ['application/json'],
221
+ opts['customHeaders']
190
222
  );
191
223
  }
192
224
 
@@ -195,6 +227,7 @@ class FaxApi {
195
227
  *
196
228
  * @param {Object} opts Optional parameters
197
229
  * @param {Object} opts.body
230
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
198
231
  */
199
232
  putFaxSettings(opts) {
200
233
  opts = opts || {};
@@ -210,7 +243,8 @@ class FaxApi {
210
243
  opts['body'],
211
244
  ['PureCloud OAuth'],
212
245
  ['application/json'],
213
- ['application/json']
246
+ ['application/json'],
247
+ opts['customHeaders']
214
248
  );
215
249
  }
216
250
 
@@ -5,7 +5,7 @@ class FlowsApi {
5
5
  /**
6
6
  * Flows service.
7
7
  * @module purecloud-platform-client-v2/api/FlowsApi
8
- * @version 249.0.0
8
+ * @version 250.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -24,9 +24,13 @@ class FlowsApi {
24
24
  * Delete/cancel an async request for flow aggregates
25
25
  *
26
26
  * @param {String} jobId jobId
27
+ * @param {Object} opts Optional parameters
28
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
27
29
  * deleteAnalyticsFlowsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
28
30
  */
29
- deleteAnalyticsFlowsAggregatesJob(jobId) {
31
+ deleteAnalyticsFlowsAggregatesJob(jobId, opts) {
32
+ opts = opts || {};
33
+
30
34
  // verify the required parameter 'jobId' is set
31
35
  if (jobId === undefined || jobId === null || jobId === '') {
32
36
  throw 'Missing the required parameter "jobId" when calling deleteAnalyticsFlowsAggregatesJob';
@@ -42,7 +46,8 @@ class FlowsApi {
42
46
  null,
43
47
  ['PureCloud OAuth'],
44
48
  ['application/json'],
45
- ['application/json']
49
+ ['application/json'],
50
+ opts['customHeaders']
46
51
  );
47
52
  }
48
53
 
@@ -50,9 +55,13 @@ class FlowsApi {
50
55
  * Get status for async query for Flow aggregates
51
56
  *
52
57
  * @param {String} jobId jobId
58
+ * @param {Object} opts Optional parameters
59
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
53
60
  * getAnalyticsFlowsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
54
61
  */
55
- getAnalyticsFlowsAggregatesJob(jobId) {
62
+ getAnalyticsFlowsAggregatesJob(jobId, opts) {
63
+ opts = opts || {};
64
+
56
65
  // verify the required parameter 'jobId' is set
57
66
  if (jobId === undefined || jobId === null || jobId === '') {
58
67
  throw 'Missing the required parameter "jobId" when calling getAnalyticsFlowsAggregatesJob';
@@ -68,7 +77,8 @@ class FlowsApi {
68
77
  null,
69
78
  ['PureCloud OAuth'],
70
79
  ['application/json'],
71
- ['application/json']
80
+ ['application/json'],
81
+ opts['customHeaders']
72
82
  );
73
83
  }
74
84
 
@@ -78,6 +88,7 @@ class FlowsApi {
78
88
  * @param {String} jobId jobId
79
89
  * @param {Object} opts Optional parameters
80
90
  * @param {String} opts.cursor Cursor token to retrieve next page
91
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
81
92
  * getAnalyticsFlowsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
82
93
  */
83
94
  getAnalyticsFlowsAggregatesJobResults(jobId, opts) {
@@ -98,7 +109,8 @@ class FlowsApi {
98
109
  null,
99
110
  ['PureCloud OAuth'],
100
111
  ['application/json'],
101
- ['application/json']
112
+ ['application/json'],
113
+ opts['customHeaders']
102
114
  );
103
115
  }
104
116
 
@@ -109,6 +121,7 @@ class FlowsApi {
109
121
  * @param {Object} opts Optional parameters
110
122
  * @param {Number} opts.pageSize The desired page size
111
123
  * @param {Number} opts.pageNumber The desired page number
124
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
112
125
  */
113
126
  postAnalyticsFlowsActivityQuery(body, opts) {
114
127
  opts = opts || {};
@@ -128,7 +141,8 @@ class FlowsApi {
128
141
  body,
129
142
  ['PureCloud OAuth'],
130
143
  ['application/json'],
131
- ['application/json']
144
+ ['application/json'],
145
+ opts['customHeaders']
132
146
  );
133
147
  }
134
148
 
@@ -136,9 +150,13 @@ class FlowsApi {
136
150
  * Query for flow aggregates asynchronously
137
151
  *
138
152
  * @param {Object} body query
153
+ * @param {Object} opts Optional parameters
154
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
139
155
  * postAnalyticsFlowsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
140
156
  */
141
- postAnalyticsFlowsAggregatesJobs(body) {
157
+ postAnalyticsFlowsAggregatesJobs(body, opts) {
158
+ opts = opts || {};
159
+
142
160
  // verify the required parameter 'body' is set
143
161
  if (body === undefined || body === null) {
144
162
  throw 'Missing the required parameter "body" when calling postAnalyticsFlowsAggregatesJobs';
@@ -154,7 +172,8 @@ class FlowsApi {
154
172
  body,
155
173
  ['PureCloud OAuth'],
156
174
  ['application/json'],
157
- ['application/json']
175
+ ['application/json'],
176
+ opts['customHeaders']
158
177
  );
159
178
  }
160
179
 
@@ -162,8 +181,12 @@ class FlowsApi {
162
181
  * Query for flow aggregates
163
182
  *
164
183
  * @param {Object} body query
184
+ * @param {Object} opts Optional parameters
185
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
165
186
  */
166
- postAnalyticsFlowsAggregatesQuery(body) {
187
+ postAnalyticsFlowsAggregatesQuery(body, opts) {
188
+ opts = opts || {};
189
+
167
190
  // verify the required parameter 'body' is set
168
191
  if (body === undefined || body === null) {
169
192
  throw 'Missing the required parameter "body" when calling postAnalyticsFlowsAggregatesQuery';
@@ -179,7 +202,8 @@ class FlowsApi {
179
202
  body,
180
203
  ['PureCloud OAuth'],
181
204
  ['application/json'],
182
- ['application/json']
205
+ ['application/json'],
206
+ opts['customHeaders']
183
207
  );
184
208
  }
185
209
 
@@ -187,8 +211,12 @@ class FlowsApi {
187
211
  * Query for flow observations
188
212
  *
189
213
  * @param {Object} body query
214
+ * @param {Object} opts Optional parameters
215
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
190
216
  */
191
- postAnalyticsFlowsObservationsQuery(body) {
217
+ postAnalyticsFlowsObservationsQuery(body, opts) {
218
+ opts = opts || {};
219
+
192
220
  // verify the required parameter 'body' is set
193
221
  if (body === undefined || body === null) {
194
222
  throw 'Missing the required parameter "body" when calling postAnalyticsFlowsObservationsQuery';
@@ -204,7 +232,8 @@ class FlowsApi {
204
232
  body,
205
233
  ['PureCloud OAuth'],
206
234
  ['application/json'],
207
- ['application/json']
235
+ ['application/json'],
236
+ opts['customHeaders']
208
237
  );
209
238
  }
210
239