purecloud-platform-client-v2 222.0.0 → 224.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.
- package/README.md +3 -3
- package/dist/node/purecloud-platform-client-v2.js +1863 -540
- package/dist/web-amd/purecloud-platform-client-v2.js +1863 -540
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +745 -410
- package/dist/web-cjs/purecloud-platform-client-v2.js +745 -410
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1681 -998
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AIStudioApi.js +387 -0
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +3 -2
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +4 -2
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BusinessRulesApi.js +52 -8
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +327 -16
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +89 -2
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +176 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +2 -3
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +31 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +71 -8
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +51 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +43 -2
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +31 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +524 -421
- package/src/purecloud-platform-client-v2/index.js +7 -1
package/package.json
CHANGED
|
@@ -0,0 +1,387 @@
|
|
|
1
|
+
import ApiClient from '../ApiClient.js';
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
class AIStudioApi {
|
|
5
|
+
/**
|
|
6
|
+
* AIStudio service.
|
|
7
|
+
* @module purecloud-platform-client-v2/api/AIStudioApi
|
|
8
|
+
* @version 224.0.0
|
|
9
|
+
*/
|
|
10
|
+
|
|
11
|
+
/**
|
|
12
|
+
* Constructs a new AIStudioApi.
|
|
13
|
+
* @alias module:purecloud-platform-client-v2/api/AIStudioApi
|
|
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
|
+
* Start the deletion of a guide.
|
|
25
|
+
*
|
|
26
|
+
* @param {String} guideId Guide ID
|
|
27
|
+
* deleteGuideJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
28
|
+
*/
|
|
29
|
+
deleteGuideJobs(guideId) {
|
|
30
|
+
// verify the required parameter 'guideId' is set
|
|
31
|
+
if (guideId === undefined || guideId === null) {
|
|
32
|
+
throw 'Missing the required parameter "guideId" when calling deleteGuideJobs';
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
return this.apiClient.callApi(
|
|
36
|
+
'/api/v2/guides/{guideId}/jobs',
|
|
37
|
+
'DELETE',
|
|
38
|
+
{ 'guideId': guideId },
|
|
39
|
+
{ },
|
|
40
|
+
{ },
|
|
41
|
+
{ },
|
|
42
|
+
null,
|
|
43
|
+
['PureCloud OAuth'],
|
|
44
|
+
['application/json'],
|
|
45
|
+
['application/json']
|
|
46
|
+
);
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
/**
|
|
50
|
+
* Get guide.
|
|
51
|
+
*
|
|
52
|
+
* @param {String} guideId Guide ID
|
|
53
|
+
* getGuide is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
54
|
+
*/
|
|
55
|
+
getGuide(guideId) {
|
|
56
|
+
// verify the required parameter 'guideId' is set
|
|
57
|
+
if (guideId === undefined || guideId === null) {
|
|
58
|
+
throw 'Missing the required parameter "guideId" when calling getGuide';
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
return this.apiClient.callApi(
|
|
62
|
+
'/api/v2/guides/{guideId}',
|
|
63
|
+
'GET',
|
|
64
|
+
{ 'guideId': guideId },
|
|
65
|
+
{ },
|
|
66
|
+
{ },
|
|
67
|
+
{ },
|
|
68
|
+
null,
|
|
69
|
+
['PureCloud OAuth'],
|
|
70
|
+
['application/json'],
|
|
71
|
+
['application/json']
|
|
72
|
+
);
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
/**
|
|
76
|
+
* Get the specified guide deletion job.
|
|
77
|
+
*
|
|
78
|
+
* @param {String} guideId Guide ID
|
|
79
|
+
* @param {String} jobId jobId
|
|
80
|
+
* getGuideJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
81
|
+
*/
|
|
82
|
+
getGuideJob(guideId, jobId) {
|
|
83
|
+
// verify the required parameter 'guideId' is set
|
|
84
|
+
if (guideId === undefined || guideId === null) {
|
|
85
|
+
throw 'Missing the required parameter "guideId" when calling getGuideJob';
|
|
86
|
+
}
|
|
87
|
+
// verify the required parameter 'jobId' is set
|
|
88
|
+
if (jobId === undefined || jobId === null) {
|
|
89
|
+
throw 'Missing the required parameter "jobId" when calling getGuideJob';
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
return this.apiClient.callApi(
|
|
93
|
+
'/api/v2/guides/{guideId}/jobs/{jobId}',
|
|
94
|
+
'GET',
|
|
95
|
+
{ 'guideId': guideId,'jobId': jobId },
|
|
96
|
+
{ },
|
|
97
|
+
{ },
|
|
98
|
+
{ },
|
|
99
|
+
null,
|
|
100
|
+
['PureCloud OAuth'],
|
|
101
|
+
['application/json'],
|
|
102
|
+
['application/json']
|
|
103
|
+
);
|
|
104
|
+
}
|
|
105
|
+
|
|
106
|
+
/**
|
|
107
|
+
* Get a guide version.
|
|
108
|
+
*
|
|
109
|
+
* @param {String} guideId Guide ID
|
|
110
|
+
* @param {String} versionId Version ID
|
|
111
|
+
* getGuideVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
112
|
+
*/
|
|
113
|
+
getGuideVersion(guideId, versionId) {
|
|
114
|
+
// verify the required parameter 'guideId' is set
|
|
115
|
+
if (guideId === undefined || guideId === null) {
|
|
116
|
+
throw 'Missing the required parameter "guideId" when calling getGuideVersion';
|
|
117
|
+
}
|
|
118
|
+
// verify the required parameter 'versionId' is set
|
|
119
|
+
if (versionId === undefined || versionId === null) {
|
|
120
|
+
throw 'Missing the required parameter "versionId" when calling getGuideVersion';
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
return this.apiClient.callApi(
|
|
124
|
+
'/api/v2/guides/{guideId}/versions/{versionId}',
|
|
125
|
+
'GET',
|
|
126
|
+
{ 'guideId': guideId,'versionId': versionId },
|
|
127
|
+
{ },
|
|
128
|
+
{ },
|
|
129
|
+
{ },
|
|
130
|
+
null,
|
|
131
|
+
['PureCloud OAuth'],
|
|
132
|
+
['application/json'],
|
|
133
|
+
['application/json']
|
|
134
|
+
);
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
/**
|
|
138
|
+
* Get the status of the publishing job for this guide version.
|
|
139
|
+
*
|
|
140
|
+
* @param {String} guideId Guide ID
|
|
141
|
+
* @param {String} versionId Version ID
|
|
142
|
+
* @param {String} jobId jobId
|
|
143
|
+
* getGuideVersionJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
144
|
+
*/
|
|
145
|
+
getGuideVersionJob(guideId, versionId, jobId) {
|
|
146
|
+
// verify the required parameter 'guideId' is set
|
|
147
|
+
if (guideId === undefined || guideId === null) {
|
|
148
|
+
throw 'Missing the required parameter "guideId" when calling getGuideVersionJob';
|
|
149
|
+
}
|
|
150
|
+
// verify the required parameter 'versionId' is set
|
|
151
|
+
if (versionId === undefined || versionId === null) {
|
|
152
|
+
throw 'Missing the required parameter "versionId" when calling getGuideVersionJob';
|
|
153
|
+
}
|
|
154
|
+
// verify the required parameter 'jobId' is set
|
|
155
|
+
if (jobId === undefined || jobId === null) {
|
|
156
|
+
throw 'Missing the required parameter "jobId" when calling getGuideVersionJob';
|
|
157
|
+
}
|
|
158
|
+
|
|
159
|
+
return this.apiClient.callApi(
|
|
160
|
+
'/api/v2/guides/{guideId}/versions/{versionId}/jobs/{jobId}',
|
|
161
|
+
'GET',
|
|
162
|
+
{ 'guideId': guideId,'versionId': versionId,'jobId': jobId },
|
|
163
|
+
{ },
|
|
164
|
+
{ },
|
|
165
|
+
{ },
|
|
166
|
+
null,
|
|
167
|
+
['PureCloud OAuth'],
|
|
168
|
+
['application/json'],
|
|
169
|
+
['application/json']
|
|
170
|
+
);
|
|
171
|
+
}
|
|
172
|
+
|
|
173
|
+
/**
|
|
174
|
+
* Get all guides.
|
|
175
|
+
*
|
|
176
|
+
* @param {Object} opts Optional parameters
|
|
177
|
+
* @param {String} opts.name Filter by matching name - case insensitive.
|
|
178
|
+
* @param {String} opts.nameContains Filter by name contains - case insensitive.
|
|
179
|
+
* @param {Object} opts.status Filter by status.
|
|
180
|
+
* @param {Object} opts.sortBy Sort by. Default value dateModified. (default to dateModified)
|
|
181
|
+
* @param {Object} opts.sortOrder Sort Order. Default value desc. (default to desc)
|
|
182
|
+
* @param {Number} opts.pageNumber Page number. (default to 1)
|
|
183
|
+
* @param {Number} opts.pageSize Page size. The maximum page size is 100. (default to 25)
|
|
184
|
+
* getGuides is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
185
|
+
*/
|
|
186
|
+
getGuides(opts) {
|
|
187
|
+
opts = opts || {};
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
return this.apiClient.callApi(
|
|
191
|
+
'/api/v2/guides',
|
|
192
|
+
'GET',
|
|
193
|
+
{ },
|
|
194
|
+
{ 'name': opts['name'],'nameContains': opts['nameContains'],'status': opts['status'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
195
|
+
{ },
|
|
196
|
+
{ },
|
|
197
|
+
null,
|
|
198
|
+
['PureCloud OAuth'],
|
|
199
|
+
['application/json'],
|
|
200
|
+
['application/json']
|
|
201
|
+
);
|
|
202
|
+
}
|
|
203
|
+
|
|
204
|
+
/**
|
|
205
|
+
* Get the status of the guide content generation job.
|
|
206
|
+
*
|
|
207
|
+
* @param {String} jobId jobId
|
|
208
|
+
* getGuidesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
209
|
+
*/
|
|
210
|
+
getGuidesJob(jobId) {
|
|
211
|
+
// verify the required parameter 'jobId' is set
|
|
212
|
+
if (jobId === undefined || jobId === null) {
|
|
213
|
+
throw 'Missing the required parameter "jobId" when calling getGuidesJob';
|
|
214
|
+
}
|
|
215
|
+
|
|
216
|
+
return this.apiClient.callApi(
|
|
217
|
+
'/api/v2/guides/jobs/{jobId}',
|
|
218
|
+
'GET',
|
|
219
|
+
{ 'jobId': jobId },
|
|
220
|
+
{ },
|
|
221
|
+
{ },
|
|
222
|
+
{ },
|
|
223
|
+
null,
|
|
224
|
+
['PureCloud OAuth'],
|
|
225
|
+
['application/json'],
|
|
226
|
+
['application/json']
|
|
227
|
+
);
|
|
228
|
+
}
|
|
229
|
+
|
|
230
|
+
/**
|
|
231
|
+
* Update a guide version.
|
|
232
|
+
*
|
|
233
|
+
* @param {String} guideId Guide ID
|
|
234
|
+
* @param {String} versionId Version ID
|
|
235
|
+
* @param {Object} body
|
|
236
|
+
* patchGuideVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
237
|
+
*/
|
|
238
|
+
patchGuideVersion(guideId, versionId, body) {
|
|
239
|
+
// verify the required parameter 'guideId' is set
|
|
240
|
+
if (guideId === undefined || guideId === null) {
|
|
241
|
+
throw 'Missing the required parameter "guideId" when calling patchGuideVersion';
|
|
242
|
+
}
|
|
243
|
+
// verify the required parameter 'versionId' is set
|
|
244
|
+
if (versionId === undefined || versionId === null) {
|
|
245
|
+
throw 'Missing the required parameter "versionId" when calling patchGuideVersion';
|
|
246
|
+
}
|
|
247
|
+
// verify the required parameter 'body' is set
|
|
248
|
+
if (body === undefined || body === null) {
|
|
249
|
+
throw 'Missing the required parameter "body" when calling patchGuideVersion';
|
|
250
|
+
}
|
|
251
|
+
|
|
252
|
+
return this.apiClient.callApi(
|
|
253
|
+
'/api/v2/guides/{guideId}/versions/{versionId}',
|
|
254
|
+
'PATCH',
|
|
255
|
+
{ 'guideId': guideId,'versionId': versionId },
|
|
256
|
+
{ },
|
|
257
|
+
{ },
|
|
258
|
+
{ },
|
|
259
|
+
body,
|
|
260
|
+
['PureCloud OAuth'],
|
|
261
|
+
['application/json'],
|
|
262
|
+
['application/json']
|
|
263
|
+
);
|
|
264
|
+
}
|
|
265
|
+
|
|
266
|
+
/**
|
|
267
|
+
* Start the publishing of a guide version.
|
|
268
|
+
*
|
|
269
|
+
* @param {String} guideId Guide ID
|
|
270
|
+
* @param {String} versionId Version ID
|
|
271
|
+
* @param {Object} body
|
|
272
|
+
* postGuideVersionJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
273
|
+
*/
|
|
274
|
+
postGuideVersionJobs(guideId, versionId, body) {
|
|
275
|
+
// verify the required parameter 'guideId' is set
|
|
276
|
+
if (guideId === undefined || guideId === null) {
|
|
277
|
+
throw 'Missing the required parameter "guideId" when calling postGuideVersionJobs';
|
|
278
|
+
}
|
|
279
|
+
// verify the required parameter 'versionId' is set
|
|
280
|
+
if (versionId === undefined || versionId === null) {
|
|
281
|
+
throw 'Missing the required parameter "versionId" when calling postGuideVersionJobs';
|
|
282
|
+
}
|
|
283
|
+
// verify the required parameter 'body' is set
|
|
284
|
+
if (body === undefined || body === null) {
|
|
285
|
+
throw 'Missing the required parameter "body" when calling postGuideVersionJobs';
|
|
286
|
+
}
|
|
287
|
+
|
|
288
|
+
return this.apiClient.callApi(
|
|
289
|
+
'/api/v2/guides/{guideId}/versions/{versionId}/jobs',
|
|
290
|
+
'POST',
|
|
291
|
+
{ 'guideId': guideId,'versionId': versionId },
|
|
292
|
+
{ },
|
|
293
|
+
{ },
|
|
294
|
+
{ },
|
|
295
|
+
body,
|
|
296
|
+
['PureCloud OAuth'],
|
|
297
|
+
['application/json'],
|
|
298
|
+
['application/json']
|
|
299
|
+
);
|
|
300
|
+
}
|
|
301
|
+
|
|
302
|
+
/**
|
|
303
|
+
* Create a guide version.
|
|
304
|
+
*
|
|
305
|
+
* @param {String} guideId Guide ID
|
|
306
|
+
* @param {Object} opts Optional parameters
|
|
307
|
+
* @param {Object} opts.body
|
|
308
|
+
* postGuideVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
309
|
+
*/
|
|
310
|
+
postGuideVersions(guideId, opts) {
|
|
311
|
+
opts = opts || {};
|
|
312
|
+
|
|
313
|
+
// verify the required parameter 'guideId' is set
|
|
314
|
+
if (guideId === undefined || guideId === null) {
|
|
315
|
+
throw 'Missing the required parameter "guideId" when calling postGuideVersions';
|
|
316
|
+
}
|
|
317
|
+
|
|
318
|
+
return this.apiClient.callApi(
|
|
319
|
+
'/api/v2/guides/{guideId}/versions',
|
|
320
|
+
'POST',
|
|
321
|
+
{ 'guideId': guideId },
|
|
322
|
+
{ },
|
|
323
|
+
{ },
|
|
324
|
+
{ },
|
|
325
|
+
opts['body'],
|
|
326
|
+
['PureCloud OAuth'],
|
|
327
|
+
['application/json'],
|
|
328
|
+
['application/json']
|
|
329
|
+
);
|
|
330
|
+
}
|
|
331
|
+
|
|
332
|
+
/**
|
|
333
|
+
* Create a guide.
|
|
334
|
+
*
|
|
335
|
+
* @param {Object} body
|
|
336
|
+
* postGuides is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
337
|
+
*/
|
|
338
|
+
postGuides(body) {
|
|
339
|
+
// verify the required parameter 'body' is set
|
|
340
|
+
if (body === undefined || body === null) {
|
|
341
|
+
throw 'Missing the required parameter "body" when calling postGuides';
|
|
342
|
+
}
|
|
343
|
+
|
|
344
|
+
return this.apiClient.callApi(
|
|
345
|
+
'/api/v2/guides',
|
|
346
|
+
'POST',
|
|
347
|
+
{ },
|
|
348
|
+
{ },
|
|
349
|
+
{ },
|
|
350
|
+
{ },
|
|
351
|
+
body,
|
|
352
|
+
['PureCloud OAuth'],
|
|
353
|
+
['application/json'],
|
|
354
|
+
['application/json']
|
|
355
|
+
);
|
|
356
|
+
}
|
|
357
|
+
|
|
358
|
+
/**
|
|
359
|
+
* Start a guide content generation job.
|
|
360
|
+
*
|
|
361
|
+
* @param {Object} body
|
|
362
|
+
* postGuidesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
363
|
+
*/
|
|
364
|
+
postGuidesJobs(body) {
|
|
365
|
+
// verify the required parameter 'body' is set
|
|
366
|
+
if (body === undefined || body === null) {
|
|
367
|
+
throw 'Missing the required parameter "body" when calling postGuidesJobs';
|
|
368
|
+
}
|
|
369
|
+
|
|
370
|
+
return this.apiClient.callApi(
|
|
371
|
+
'/api/v2/guides/jobs',
|
|
372
|
+
'POST',
|
|
373
|
+
{ },
|
|
374
|
+
{ },
|
|
375
|
+
{ },
|
|
376
|
+
{ },
|
|
377
|
+
body,
|
|
378
|
+
['PureCloud OAuth'],
|
|
379
|
+
['application/json'],
|
|
380
|
+
['application/json']
|
|
381
|
+
);
|
|
382
|
+
}
|
|
383
|
+
|
|
384
|
+
}
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
export default AIStudioApi;
|
|
@@ -5,7 +5,7 @@ class AgentAssistantsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* AgentAssistants service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 224.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -208,6 +208,7 @@ class AgentAssistantsApi {
|
|
|
208
208
|
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
209
209
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
210
210
|
* @param {String} opts.name Return the assistant by the given name.
|
|
211
|
+
* @param {Object} opts.expand Which fields, if any, to expand
|
|
211
212
|
*/
|
|
212
213
|
getAssistants(opts) {
|
|
213
214
|
opts = opts || {};
|
|
@@ -217,7 +218,7 @@ class AgentAssistantsApi {
|
|
|
217
218
|
'/api/v2/assistants',
|
|
218
219
|
'GET',
|
|
219
220
|
{ },
|
|
220
|
-
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'name': opts['name'] },
|
|
221
|
+
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'name': opts['name'],'expand': opts['expand'] },
|
|
221
222
|
{ },
|
|
222
223
|
{ },
|
|
223
224
|
null,
|
|
@@ -5,7 +5,7 @@ class AnalyticsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Analytics service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 224.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -1578,7 +1578,7 @@ class AnalyticsApi {
|
|
|
1578
1578
|
}
|
|
1579
1579
|
|
|
1580
1580
|
/**
|
|
1581
|
-
* Count agents by
|
|
1581
|
+
* Count agents by different groupings
|
|
1582
1582
|
*
|
|
1583
1583
|
* @param {Object} body query
|
|
1584
1584
|
*/
|
|
@@ -5,7 +5,7 @@ class ArchitectApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Architect service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 224.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -891,7 +891,7 @@ class ArchitectApi {
|
|
|
891
891
|
|
|
892
892
|
/**
|
|
893
893
|
* Get a pageable list of basic emergency group objects filterable by query parameters.
|
|
894
|
-
* This returns emergency groups consisting of name and division. If one or more IDs are specified, the search will fetch
|
|
894
|
+
* This returns emergency groups consisting of name and division. If one or more IDs are specified, the search will fetch emergency groups that match the given ID(s) and not use any additional supplied query parameters in the search.
|
|
895
895
|
* @param {Object} opts Optional parameters
|
|
896
896
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
897
897
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
@@ -3049,6 +3049,7 @@ class ArchitectApi {
|
|
|
3049
3049
|
*
|
|
3050
3050
|
* @param {String} promptId Prompt ID
|
|
3051
3051
|
* @param {String} languageCode Language
|
|
3052
|
+
* postArchitectPromptResourceUploads is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3052
3053
|
*/
|
|
3053
3054
|
postArchitectPromptResourceUploads(promptId, languageCode) {
|
|
3054
3055
|
// verify the required parameter 'promptId' is set
|
|
@@ -3209,6 +3210,7 @@ class ArchitectApi {
|
|
|
3209
3210
|
*
|
|
3210
3211
|
* @param {String} promptId Prompt ID
|
|
3211
3212
|
* @param {String} languageCode Language
|
|
3213
|
+
* postArchitectSystempromptResourceUploads is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3212
3214
|
*/
|
|
3213
3215
|
postArchitectSystempromptResourceUploads(promptId, languageCode) {
|
|
3214
3216
|
// verify the required parameter 'promptId' is set
|
|
@@ -5,7 +5,7 @@ class BusinessRulesApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* BusinessRules service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/BusinessRulesApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 224.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -278,7 +278,7 @@ class BusinessRulesApi {
|
|
|
278
278
|
* @param {String} tableId Table ID
|
|
279
279
|
* @param {Object} opts Optional parameters
|
|
280
280
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
281
|
-
* @param {String} opts.pageSize Number of entities to return. Maximum of
|
|
281
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 100.
|
|
282
282
|
* @param {Array.<String>} opts.divisionIds One or more comma separated divisions to filters decision tables by. If nothing is provided, the decision tables associated with the list of divisions that the user has access to will be returned.
|
|
283
283
|
* getBusinessrulesDecisiontableVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
284
284
|
*/
|
|
@@ -309,7 +309,7 @@ class BusinessRulesApi {
|
|
|
309
309
|
*
|
|
310
310
|
* @param {Object} opts Optional parameters
|
|
311
311
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
312
|
-
* @param {String} opts.pageSize Number of entities to return. Maximum of
|
|
312
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 100.
|
|
313
313
|
* @param {Array.<String>} opts.divisionIds One or more comma separated divisions to filters decision tables by. If nothing is provided, the decision tables associated with the list of divisions that the user has access to will be returned.
|
|
314
314
|
* getBusinessrulesDecisiontables is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
315
315
|
*/
|
|
@@ -335,11 +335,13 @@ class BusinessRulesApi {
|
|
|
335
335
|
* Search for decision tables.
|
|
336
336
|
*
|
|
337
337
|
* @param {Object} opts Optional parameters
|
|
338
|
-
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
339
338
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
340
|
-
* @param {String} opts.pageSize Number of entities to return. Maximum of
|
|
339
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 100.
|
|
341
340
|
* @param {String} opts.schemaId Search for decision tables that use the schema with this ID. Cannot be combined with name search. Search results will not be paginated if used.
|
|
342
341
|
* @param {String} opts.name Search for decision tables with a name that contains the given search string. Search is case insensitive and will match any table that contains this string in any part of the name. Cannot be combined with schema search. Search results will not be paginated if used.
|
|
342
|
+
* @param {Boolean} opts.withPublishedVersion Filters results to only decision tables that have at least one version in Published status
|
|
343
|
+
* @param {Array.<String>} opts.expand Fields to expand in response
|
|
344
|
+
* @param {Array.<String>} opts.ids Decision table IDs to search for
|
|
343
345
|
* getBusinessrulesDecisiontablesSearch is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
344
346
|
*/
|
|
345
347
|
getBusinessrulesDecisiontablesSearch(opts) {
|
|
@@ -350,7 +352,7 @@ class BusinessRulesApi {
|
|
|
350
352
|
'/api/v2/businessrules/decisiontables/search',
|
|
351
353
|
'GET',
|
|
352
354
|
{ },
|
|
353
|
-
{ '
|
|
355
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'schemaId': opts['schemaId'],'name': opts['name'],'withPublishedVersion': opts['withPublishedVersion'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'ids': this.apiClient.buildCollectionParam(opts['ids'], 'multi') },
|
|
354
356
|
{ },
|
|
355
357
|
{ },
|
|
356
358
|
null,
|
|
@@ -522,12 +524,13 @@ class BusinessRulesApi {
|
|
|
522
524
|
}
|
|
523
525
|
|
|
524
526
|
/**
|
|
525
|
-
*
|
|
527
|
+
* Partially update a decision table row. Will be deprecated, we should use PUT request.
|
|
526
528
|
*
|
|
527
529
|
* @param {String} tableId Table ID
|
|
528
530
|
* @param {Number} tableVersion Table Version
|
|
529
531
|
* @param {String} rowId Row ID
|
|
530
|
-
* @param {Object} body
|
|
532
|
+
* @param {Object} body Partially update decision table row request
|
|
533
|
+
* @deprecated
|
|
531
534
|
* patchBusinessrulesDecisiontableVersionRow is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
532
535
|
*/
|
|
533
536
|
patchBusinessrulesDecisiontableVersionRow(tableId, tableVersion, rowId, body) {
|
|
@@ -882,6 +885,47 @@ class BusinessRulesApi {
|
|
|
882
885
|
);
|
|
883
886
|
}
|
|
884
887
|
|
|
888
|
+
/**
|
|
889
|
+
* Full update a decision table row
|
|
890
|
+
*
|
|
891
|
+
* @param {String} tableId Table ID
|
|
892
|
+
* @param {Number} tableVersion Table Version
|
|
893
|
+
* @param {String} rowId Row ID
|
|
894
|
+
* @param {Object} body Full update decision table row request
|
|
895
|
+
* putBusinessrulesDecisiontableVersionRow is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
896
|
+
*/
|
|
897
|
+
putBusinessrulesDecisiontableVersionRow(tableId, tableVersion, rowId, body) {
|
|
898
|
+
// verify the required parameter 'tableId' is set
|
|
899
|
+
if (tableId === undefined || tableId === null) {
|
|
900
|
+
throw 'Missing the required parameter "tableId" when calling putBusinessrulesDecisiontableVersionRow';
|
|
901
|
+
}
|
|
902
|
+
// verify the required parameter 'tableVersion' is set
|
|
903
|
+
if (tableVersion === undefined || tableVersion === null) {
|
|
904
|
+
throw 'Missing the required parameter "tableVersion" when calling putBusinessrulesDecisiontableVersionRow';
|
|
905
|
+
}
|
|
906
|
+
// verify the required parameter 'rowId' is set
|
|
907
|
+
if (rowId === undefined || rowId === null) {
|
|
908
|
+
throw 'Missing the required parameter "rowId" when calling putBusinessrulesDecisiontableVersionRow';
|
|
909
|
+
}
|
|
910
|
+
// verify the required parameter 'body' is set
|
|
911
|
+
if (body === undefined || body === null) {
|
|
912
|
+
throw 'Missing the required parameter "body" when calling putBusinessrulesDecisiontableVersionRow';
|
|
913
|
+
}
|
|
914
|
+
|
|
915
|
+
return this.apiClient.callApi(
|
|
916
|
+
'/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/rows/{rowId}',
|
|
917
|
+
'PUT',
|
|
918
|
+
{ 'tableId': tableId,'tableVersion': tableVersion,'rowId': rowId },
|
|
919
|
+
{ },
|
|
920
|
+
{ },
|
|
921
|
+
{ },
|
|
922
|
+
body,
|
|
923
|
+
['PureCloud OAuth'],
|
|
924
|
+
['application/json'],
|
|
925
|
+
['application/json']
|
|
926
|
+
);
|
|
927
|
+
}
|
|
928
|
+
|
|
885
929
|
/**
|
|
886
930
|
* Update a schema
|
|
887
931
|
*
|