purecloud-platform-client-v2 247.1.0 → 249.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 +2057 -116
- package/dist/web-amd/purecloud-platform-client-v2.js +2057 -116
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +626 -121
- package/dist/web-cjs/purecloud-platform-client-v2.js +626 -121
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1404 -337
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AIStudioApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AssistantCopilotVariationsApi.js +1 -1
- 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/BackgroundAssistantApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BusinessRulesApi.js +6 -6
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CaseManagementApi.js +1100 -0
- 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 +18 -14
- 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 +31 -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 +1 -1
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/IntentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +501 -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 +26 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
- 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 +37 -2
- 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 +57 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +5 -5
- package/src/purecloud-platform-client-v2/api/SCIMApi.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 +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -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 +2 -3
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +46 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/UsersRulesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- 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 +152 -5
- package/src/purecloud-platform-client-v2/index.js +7 -1
|
@@ -0,0 +1,1100 @@
|
|
|
1
|
+
import ApiClient from '../ApiClient.js';
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
class CaseManagementApi {
|
|
5
|
+
/**
|
|
6
|
+
* CaseManagement service.
|
|
7
|
+
* @module purecloud-platform-client-v2/api/CaseManagementApi
|
|
8
|
+
* @version 249.0.0
|
|
9
|
+
*/
|
|
10
|
+
|
|
11
|
+
/**
|
|
12
|
+
* Constructs a new CaseManagementApi.
|
|
13
|
+
* @alias module:purecloud-platform-client-v2/api/CaseManagementApi
|
|
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 a Case.
|
|
25
|
+
*
|
|
26
|
+
* @param {String} caseId Case ID
|
|
27
|
+
* deleteCasemanagementCase is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
28
|
+
*/
|
|
29
|
+
deleteCasemanagementCase(caseId) {
|
|
30
|
+
// verify the required parameter 'caseId' is set
|
|
31
|
+
if (caseId === undefined || caseId === null || caseId === '') {
|
|
32
|
+
throw 'Missing the required parameter "caseId" when calling deleteCasemanagementCase';
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
return this.apiClient.callApi(
|
|
36
|
+
'/api/v2/casemanagement/cases/{caseId}',
|
|
37
|
+
'DELETE',
|
|
38
|
+
{ 'caseId': caseId },
|
|
39
|
+
{ },
|
|
40
|
+
{ },
|
|
41
|
+
{ },
|
|
42
|
+
null,
|
|
43
|
+
['PureCloud OAuth'],
|
|
44
|
+
['application/json'],
|
|
45
|
+
['application/json']
|
|
46
|
+
);
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
/**
|
|
50
|
+
* Delete a Caseplan.
|
|
51
|
+
*
|
|
52
|
+
* @param {String} caseplanId Caseplan ID
|
|
53
|
+
* deleteCasemanagementCaseplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
54
|
+
*/
|
|
55
|
+
deleteCasemanagementCaseplan(caseplanId) {
|
|
56
|
+
// verify the required parameter 'caseplanId' is set
|
|
57
|
+
if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
|
|
58
|
+
throw 'Missing the required parameter "caseplanId" when calling deleteCasemanagementCaseplan';
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
return this.apiClient.callApi(
|
|
62
|
+
'/api/v2/casemanagement/caseplans/{caseplanId}',
|
|
63
|
+
'DELETE',
|
|
64
|
+
{ 'caseplanId': caseplanId },
|
|
65
|
+
{ },
|
|
66
|
+
{ },
|
|
67
|
+
{ },
|
|
68
|
+
null,
|
|
69
|
+
['PureCloud OAuth'],
|
|
70
|
+
['application/json'],
|
|
71
|
+
['application/json']
|
|
72
|
+
);
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
/**
|
|
76
|
+
* Get a Case.
|
|
77
|
+
*
|
|
78
|
+
* @param {String} caseId Case ID
|
|
79
|
+
* @param {Object} opts Optional parameters
|
|
80
|
+
* @param {Object} opts.expands Which fields to expand.
|
|
81
|
+
* getCasemanagementCase is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
82
|
+
*/
|
|
83
|
+
getCasemanagementCase(caseId, opts) {
|
|
84
|
+
opts = opts || {};
|
|
85
|
+
|
|
86
|
+
// verify the required parameter 'caseId' is set
|
|
87
|
+
if (caseId === undefined || caseId === null || caseId === '') {
|
|
88
|
+
throw 'Missing the required parameter "caseId" when calling getCasemanagementCase';
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
return this.apiClient.callApi(
|
|
92
|
+
'/api/v2/casemanagement/cases/{caseId}',
|
|
93
|
+
'GET',
|
|
94
|
+
{ 'caseId': caseId },
|
|
95
|
+
{ 'expands': opts['expands'] },
|
|
96
|
+
{ },
|
|
97
|
+
{ },
|
|
98
|
+
null,
|
|
99
|
+
['PureCloud OAuth'],
|
|
100
|
+
['application/json'],
|
|
101
|
+
['application/json']
|
|
102
|
+
);
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
/**
|
|
106
|
+
* Get a Case Association.
|
|
107
|
+
*
|
|
108
|
+
* @param {String} caseId Case ID
|
|
109
|
+
* @param {String} associationId Case Association ID
|
|
110
|
+
* getCasemanagementCaseAssociation is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
111
|
+
*/
|
|
112
|
+
getCasemanagementCaseAssociation(caseId, associationId) {
|
|
113
|
+
// verify the required parameter 'caseId' is set
|
|
114
|
+
if (caseId === undefined || caseId === null || caseId === '') {
|
|
115
|
+
throw 'Missing the required parameter "caseId" when calling getCasemanagementCaseAssociation';
|
|
116
|
+
}
|
|
117
|
+
// verify the required parameter 'associationId' is set
|
|
118
|
+
if (associationId === undefined || associationId === null || associationId === '') {
|
|
119
|
+
throw 'Missing the required parameter "associationId" when calling getCasemanagementCaseAssociation';
|
|
120
|
+
}
|
|
121
|
+
|
|
122
|
+
return this.apiClient.callApi(
|
|
123
|
+
'/api/v2/casemanagement/cases/{caseId}/associations/{associationId}',
|
|
124
|
+
'GET',
|
|
125
|
+
{ 'caseId': caseId,'associationId': associationId },
|
|
126
|
+
{ },
|
|
127
|
+
{ },
|
|
128
|
+
{ },
|
|
129
|
+
null,
|
|
130
|
+
['PureCloud OAuth'],
|
|
131
|
+
['application/json'],
|
|
132
|
+
['application/json']
|
|
133
|
+
);
|
|
134
|
+
}
|
|
135
|
+
|
|
136
|
+
/**
|
|
137
|
+
* Get a list of case associations for a provided case.
|
|
138
|
+
*
|
|
139
|
+
* @param {String} caseId Case ID.
|
|
140
|
+
* @param {Object} opts Optional parameters
|
|
141
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
142
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
143
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
144
|
+
* getCasemanagementCaseAssociations is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
145
|
+
*/
|
|
146
|
+
getCasemanagementCaseAssociations(caseId, opts) {
|
|
147
|
+
opts = opts || {};
|
|
148
|
+
|
|
149
|
+
// verify the required parameter 'caseId' is set
|
|
150
|
+
if (caseId === undefined || caseId === null || caseId === '') {
|
|
151
|
+
throw 'Missing the required parameter "caseId" when calling getCasemanagementCaseAssociations';
|
|
152
|
+
}
|
|
153
|
+
|
|
154
|
+
return this.apiClient.callApi(
|
|
155
|
+
'/api/v2/casemanagement/cases/{caseId}/associations',
|
|
156
|
+
'GET',
|
|
157
|
+
{ 'caseId': caseId },
|
|
158
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
159
|
+
{ },
|
|
160
|
+
{ },
|
|
161
|
+
null,
|
|
162
|
+
['PureCloud OAuth'],
|
|
163
|
+
['application/json'],
|
|
164
|
+
['application/json']
|
|
165
|
+
);
|
|
166
|
+
}
|
|
167
|
+
|
|
168
|
+
/**
|
|
169
|
+
* Get a Stage.
|
|
170
|
+
*
|
|
171
|
+
* @param {String} caseId Case ID
|
|
172
|
+
* @param {String} stageId Stage ID
|
|
173
|
+
* getCasemanagementCaseStage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
174
|
+
*/
|
|
175
|
+
getCasemanagementCaseStage(caseId, stageId) {
|
|
176
|
+
// verify the required parameter 'caseId' is set
|
|
177
|
+
if (caseId === undefined || caseId === null || caseId === '') {
|
|
178
|
+
throw 'Missing the required parameter "caseId" when calling getCasemanagementCaseStage';
|
|
179
|
+
}
|
|
180
|
+
// verify the required parameter 'stageId' is set
|
|
181
|
+
if (stageId === undefined || stageId === null || stageId === '') {
|
|
182
|
+
throw 'Missing the required parameter "stageId" when calling getCasemanagementCaseStage';
|
|
183
|
+
}
|
|
184
|
+
|
|
185
|
+
return this.apiClient.callApi(
|
|
186
|
+
'/api/v2/casemanagement/cases/{caseId}/stages/{stageId}',
|
|
187
|
+
'GET',
|
|
188
|
+
{ 'caseId': caseId,'stageId': stageId },
|
|
189
|
+
{ },
|
|
190
|
+
{ },
|
|
191
|
+
{ },
|
|
192
|
+
null,
|
|
193
|
+
['PureCloud OAuth'],
|
|
194
|
+
['application/json'],
|
|
195
|
+
['application/json']
|
|
196
|
+
);
|
|
197
|
+
}
|
|
198
|
+
|
|
199
|
+
/**
|
|
200
|
+
* Get a Step.
|
|
201
|
+
*
|
|
202
|
+
* @param {String} caseId Case ID
|
|
203
|
+
* @param {String} stageId Stage ID
|
|
204
|
+
* @param {String} stepId Step ID
|
|
205
|
+
* getCasemanagementCaseStageStep is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
206
|
+
*/
|
|
207
|
+
getCasemanagementCaseStageStep(caseId, stageId, stepId) {
|
|
208
|
+
// verify the required parameter 'caseId' is set
|
|
209
|
+
if (caseId === undefined || caseId === null || caseId === '') {
|
|
210
|
+
throw 'Missing the required parameter "caseId" when calling getCasemanagementCaseStageStep';
|
|
211
|
+
}
|
|
212
|
+
// verify the required parameter 'stageId' is set
|
|
213
|
+
if (stageId === undefined || stageId === null || stageId === '') {
|
|
214
|
+
throw 'Missing the required parameter "stageId" when calling getCasemanagementCaseStageStep';
|
|
215
|
+
}
|
|
216
|
+
// verify the required parameter 'stepId' is set
|
|
217
|
+
if (stepId === undefined || stepId === null || stepId === '') {
|
|
218
|
+
throw 'Missing the required parameter "stepId" when calling getCasemanagementCaseStageStep';
|
|
219
|
+
}
|
|
220
|
+
|
|
221
|
+
return this.apiClient.callApi(
|
|
222
|
+
'/api/v2/casemanagement/cases/{caseId}/stages/{stageId}/steps/{stepId}',
|
|
223
|
+
'GET',
|
|
224
|
+
{ 'caseId': caseId,'stageId': stageId,'stepId': stepId },
|
|
225
|
+
{ },
|
|
226
|
+
{ },
|
|
227
|
+
{ },
|
|
228
|
+
null,
|
|
229
|
+
['PureCloud OAuth'],
|
|
230
|
+
['application/json'],
|
|
231
|
+
['application/json']
|
|
232
|
+
);
|
|
233
|
+
}
|
|
234
|
+
|
|
235
|
+
/**
|
|
236
|
+
* Get a list of Steps.
|
|
237
|
+
*
|
|
238
|
+
* @param {String} caseId Case ID
|
|
239
|
+
* @param {String} stageId Stage ID
|
|
240
|
+
* @param {Object} opts Optional parameters
|
|
241
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
242
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
243
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
244
|
+
* getCasemanagementCaseStageSteps is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
245
|
+
*/
|
|
246
|
+
getCasemanagementCaseStageSteps(caseId, stageId, opts) {
|
|
247
|
+
opts = opts || {};
|
|
248
|
+
|
|
249
|
+
// verify the required parameter 'caseId' is set
|
|
250
|
+
if (caseId === undefined || caseId === null || caseId === '') {
|
|
251
|
+
throw 'Missing the required parameter "caseId" when calling getCasemanagementCaseStageSteps';
|
|
252
|
+
}
|
|
253
|
+
// verify the required parameter 'stageId' is set
|
|
254
|
+
if (stageId === undefined || stageId === null || stageId === '') {
|
|
255
|
+
throw 'Missing the required parameter "stageId" when calling getCasemanagementCaseStageSteps';
|
|
256
|
+
}
|
|
257
|
+
|
|
258
|
+
return this.apiClient.callApi(
|
|
259
|
+
'/api/v2/casemanagement/cases/{caseId}/stages/{stageId}/steps',
|
|
260
|
+
'GET',
|
|
261
|
+
{ 'caseId': caseId,'stageId': stageId },
|
|
262
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
263
|
+
{ },
|
|
264
|
+
{ },
|
|
265
|
+
null,
|
|
266
|
+
['PureCloud OAuth'],
|
|
267
|
+
['application/json'],
|
|
268
|
+
['application/json']
|
|
269
|
+
);
|
|
270
|
+
}
|
|
271
|
+
|
|
272
|
+
/**
|
|
273
|
+
* Get a list of Stages.
|
|
274
|
+
*
|
|
275
|
+
* @param {String} caseId Case ID
|
|
276
|
+
* @param {Object} opts Optional parameters
|
|
277
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
278
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
279
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
280
|
+
* getCasemanagementCaseStages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
281
|
+
*/
|
|
282
|
+
getCasemanagementCaseStages(caseId, opts) {
|
|
283
|
+
opts = opts || {};
|
|
284
|
+
|
|
285
|
+
// verify the required parameter 'caseId' is set
|
|
286
|
+
if (caseId === undefined || caseId === null || caseId === '') {
|
|
287
|
+
throw 'Missing the required parameter "caseId" when calling getCasemanagementCaseStages';
|
|
288
|
+
}
|
|
289
|
+
|
|
290
|
+
return this.apiClient.callApi(
|
|
291
|
+
'/api/v2/casemanagement/cases/{caseId}/stages',
|
|
292
|
+
'GET',
|
|
293
|
+
{ 'caseId': caseId },
|
|
294
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
295
|
+
{ },
|
|
296
|
+
{ },
|
|
297
|
+
null,
|
|
298
|
+
['PureCloud OAuth'],
|
|
299
|
+
['application/json'],
|
|
300
|
+
['application/json']
|
|
301
|
+
);
|
|
302
|
+
}
|
|
303
|
+
|
|
304
|
+
/**
|
|
305
|
+
* Get a Terminate Job for a Case.
|
|
306
|
+
*
|
|
307
|
+
* @param {String} caseId Case ID
|
|
308
|
+
* @param {String} jobId Job ID
|
|
309
|
+
* getCasemanagementCaseTerminateJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
310
|
+
*/
|
|
311
|
+
getCasemanagementCaseTerminateJob(caseId, jobId) {
|
|
312
|
+
// verify the required parameter 'caseId' is set
|
|
313
|
+
if (caseId === undefined || caseId === null || caseId === '') {
|
|
314
|
+
throw 'Missing the required parameter "caseId" when calling getCasemanagementCaseTerminateJob';
|
|
315
|
+
}
|
|
316
|
+
// verify the required parameter 'jobId' is set
|
|
317
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
318
|
+
throw 'Missing the required parameter "jobId" when calling getCasemanagementCaseTerminateJob';
|
|
319
|
+
}
|
|
320
|
+
|
|
321
|
+
return this.apiClient.callApi(
|
|
322
|
+
'/api/v2/casemanagement/cases/{caseId}/terminate/jobs/{jobId}',
|
|
323
|
+
'GET',
|
|
324
|
+
{ 'caseId': caseId,'jobId': jobId },
|
|
325
|
+
{ },
|
|
326
|
+
{ },
|
|
327
|
+
{ },
|
|
328
|
+
null,
|
|
329
|
+
['PureCloud OAuth'],
|
|
330
|
+
['application/json'],
|
|
331
|
+
['application/json']
|
|
332
|
+
);
|
|
333
|
+
}
|
|
334
|
+
|
|
335
|
+
/**
|
|
336
|
+
* Get a Caseplan.
|
|
337
|
+
*
|
|
338
|
+
* @param {String} caseplanId Caseplan ID
|
|
339
|
+
* getCasemanagementCaseplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
340
|
+
*/
|
|
341
|
+
getCasemanagementCaseplan(caseplanId) {
|
|
342
|
+
// verify the required parameter 'caseplanId' is set
|
|
343
|
+
if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
|
|
344
|
+
throw 'Missing the required parameter "caseplanId" when calling getCasemanagementCaseplan';
|
|
345
|
+
}
|
|
346
|
+
|
|
347
|
+
return this.apiClient.callApi(
|
|
348
|
+
'/api/v2/casemanagement/caseplans/{caseplanId}',
|
|
349
|
+
'GET',
|
|
350
|
+
{ 'caseplanId': caseplanId },
|
|
351
|
+
{ },
|
|
352
|
+
{ },
|
|
353
|
+
{ },
|
|
354
|
+
null,
|
|
355
|
+
['PureCloud OAuth'],
|
|
356
|
+
['application/json'],
|
|
357
|
+
['application/json']
|
|
358
|
+
);
|
|
359
|
+
}
|
|
360
|
+
|
|
361
|
+
/**
|
|
362
|
+
* Get a Caseplan version.
|
|
363
|
+
*
|
|
364
|
+
* @param {String} caseplanId Caseplan ID
|
|
365
|
+
* @param {String} versionId Version of the caseplan
|
|
366
|
+
* getCasemanagementCaseplanVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
367
|
+
*/
|
|
368
|
+
getCasemanagementCaseplanVersion(caseplanId, versionId) {
|
|
369
|
+
// verify the required parameter 'caseplanId' is set
|
|
370
|
+
if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
|
|
371
|
+
throw 'Missing the required parameter "caseplanId" when calling getCasemanagementCaseplanVersion';
|
|
372
|
+
}
|
|
373
|
+
// verify the required parameter 'versionId' is set
|
|
374
|
+
if (versionId === undefined || versionId === null || versionId === '') {
|
|
375
|
+
throw 'Missing the required parameter "versionId" when calling getCasemanagementCaseplanVersion';
|
|
376
|
+
}
|
|
377
|
+
|
|
378
|
+
return this.apiClient.callApi(
|
|
379
|
+
'/api/v2/casemanagement/caseplans/{caseplanId}/versions/{versionId}',
|
|
380
|
+
'GET',
|
|
381
|
+
{ 'caseplanId': caseplanId,'versionId': versionId },
|
|
382
|
+
{ },
|
|
383
|
+
{ },
|
|
384
|
+
{ },
|
|
385
|
+
null,
|
|
386
|
+
['PureCloud OAuth'],
|
|
387
|
+
['application/json'],
|
|
388
|
+
['application/json']
|
|
389
|
+
);
|
|
390
|
+
}
|
|
391
|
+
|
|
392
|
+
/**
|
|
393
|
+
* Get the dataSchemas for a caseplan version.
|
|
394
|
+
*
|
|
395
|
+
* @param {String} caseplanId Caseplan ID
|
|
396
|
+
* @param {String} versionId Version of the caseplan
|
|
397
|
+
* getCasemanagementCaseplanVersionDataschemas is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
398
|
+
*/
|
|
399
|
+
getCasemanagementCaseplanVersionDataschemas(caseplanId, versionId) {
|
|
400
|
+
// verify the required parameter 'caseplanId' is set
|
|
401
|
+
if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
|
|
402
|
+
throw 'Missing the required parameter "caseplanId" when calling getCasemanagementCaseplanVersionDataschemas';
|
|
403
|
+
}
|
|
404
|
+
// verify the required parameter 'versionId' is set
|
|
405
|
+
if (versionId === undefined || versionId === null || versionId === '') {
|
|
406
|
+
throw 'Missing the required parameter "versionId" when calling getCasemanagementCaseplanVersionDataschemas';
|
|
407
|
+
}
|
|
408
|
+
|
|
409
|
+
return this.apiClient.callApi(
|
|
410
|
+
'/api/v2/casemanagement/caseplans/{caseplanId}/versions/{versionId}/dataschemas',
|
|
411
|
+
'GET',
|
|
412
|
+
{ 'caseplanId': caseplanId,'versionId': versionId },
|
|
413
|
+
{ },
|
|
414
|
+
{ },
|
|
415
|
+
{ },
|
|
416
|
+
null,
|
|
417
|
+
['PureCloud OAuth'],
|
|
418
|
+
['application/json'],
|
|
419
|
+
['application/json']
|
|
420
|
+
);
|
|
421
|
+
}
|
|
422
|
+
|
|
423
|
+
/**
|
|
424
|
+
* Get the intake settings for a Caseplan version.
|
|
425
|
+
*
|
|
426
|
+
* @param {String} caseplanId Caseplan ID
|
|
427
|
+
* @param {String} versionId Version of the caseplan
|
|
428
|
+
* getCasemanagementCaseplanVersionIntakesettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
429
|
+
*/
|
|
430
|
+
getCasemanagementCaseplanVersionIntakesettings(caseplanId, versionId) {
|
|
431
|
+
// verify the required parameter 'caseplanId' is set
|
|
432
|
+
if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
|
|
433
|
+
throw 'Missing the required parameter "caseplanId" when calling getCasemanagementCaseplanVersionIntakesettings';
|
|
434
|
+
}
|
|
435
|
+
// verify the required parameter 'versionId' is set
|
|
436
|
+
if (versionId === undefined || versionId === null || versionId === '') {
|
|
437
|
+
throw 'Missing the required parameter "versionId" when calling getCasemanagementCaseplanVersionIntakesettings';
|
|
438
|
+
}
|
|
439
|
+
|
|
440
|
+
return this.apiClient.callApi(
|
|
441
|
+
'/api/v2/casemanagement/caseplans/{caseplanId}/versions/{versionId}/intakesettings',
|
|
442
|
+
'GET',
|
|
443
|
+
{ 'caseplanId': caseplanId,'versionId': versionId },
|
|
444
|
+
{ },
|
|
445
|
+
{ },
|
|
446
|
+
{ },
|
|
447
|
+
null,
|
|
448
|
+
['PureCloud OAuth'],
|
|
449
|
+
['application/json'],
|
|
450
|
+
['application/json']
|
|
451
|
+
);
|
|
452
|
+
}
|
|
453
|
+
|
|
454
|
+
/**
|
|
455
|
+
* Get a Stageplan.
|
|
456
|
+
*
|
|
457
|
+
* @param {String} caseplanId Caseplan ID
|
|
458
|
+
* @param {String} versionId Version ID
|
|
459
|
+
* @param {String} stageplanId Stageplan ID
|
|
460
|
+
* @param {Object} opts Optional parameters
|
|
461
|
+
* @param {Array.<String>} opts.expands Which fields to expand.
|
|
462
|
+
* getCasemanagementCaseplanVersionStageplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
463
|
+
*/
|
|
464
|
+
getCasemanagementCaseplanVersionStageplan(caseplanId, versionId, stageplanId, opts) {
|
|
465
|
+
opts = opts || {};
|
|
466
|
+
|
|
467
|
+
// verify the required parameter 'caseplanId' is set
|
|
468
|
+
if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
|
|
469
|
+
throw 'Missing the required parameter "caseplanId" when calling getCasemanagementCaseplanVersionStageplan';
|
|
470
|
+
}
|
|
471
|
+
// verify the required parameter 'versionId' is set
|
|
472
|
+
if (versionId === undefined || versionId === null || versionId === '') {
|
|
473
|
+
throw 'Missing the required parameter "versionId" when calling getCasemanagementCaseplanVersionStageplan';
|
|
474
|
+
}
|
|
475
|
+
// verify the required parameter 'stageplanId' is set
|
|
476
|
+
if (stageplanId === undefined || stageplanId === null || stageplanId === '') {
|
|
477
|
+
throw 'Missing the required parameter "stageplanId" when calling getCasemanagementCaseplanVersionStageplan';
|
|
478
|
+
}
|
|
479
|
+
|
|
480
|
+
return this.apiClient.callApi(
|
|
481
|
+
'/api/v2/casemanagement/caseplans/{caseplanId}/versions/{versionId}/stageplans/{stageplanId}',
|
|
482
|
+
'GET',
|
|
483
|
+
{ 'caseplanId': caseplanId,'versionId': versionId,'stageplanId': stageplanId },
|
|
484
|
+
{ 'expands': this.apiClient.buildCollectionParam(opts['expands'], 'multi') },
|
|
485
|
+
{ },
|
|
486
|
+
{ },
|
|
487
|
+
null,
|
|
488
|
+
['PureCloud OAuth'],
|
|
489
|
+
['application/json'],
|
|
490
|
+
['application/json']
|
|
491
|
+
);
|
|
492
|
+
}
|
|
493
|
+
|
|
494
|
+
/**
|
|
495
|
+
* Get a Stepplan.
|
|
496
|
+
*
|
|
497
|
+
* @param {String} caseplanId Caseplan ID
|
|
498
|
+
* @param {String} versionId Version ID
|
|
499
|
+
* @param {String} stageplanId Stageplan ID
|
|
500
|
+
* @param {String} stepplanId Stepplan ID
|
|
501
|
+
* @param {Object} opts Optional parameters
|
|
502
|
+
* @param {Array.<String>} opts.expands Which fields to expand.
|
|
503
|
+
* getCasemanagementCaseplanVersionStageplanStepplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
504
|
+
*/
|
|
505
|
+
getCasemanagementCaseplanVersionStageplanStepplan(caseplanId, versionId, stageplanId, stepplanId, opts) {
|
|
506
|
+
opts = opts || {};
|
|
507
|
+
|
|
508
|
+
// verify the required parameter 'caseplanId' is set
|
|
509
|
+
if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
|
|
510
|
+
throw 'Missing the required parameter "caseplanId" when calling getCasemanagementCaseplanVersionStageplanStepplan';
|
|
511
|
+
}
|
|
512
|
+
// verify the required parameter 'versionId' is set
|
|
513
|
+
if (versionId === undefined || versionId === null || versionId === '') {
|
|
514
|
+
throw 'Missing the required parameter "versionId" when calling getCasemanagementCaseplanVersionStageplanStepplan';
|
|
515
|
+
}
|
|
516
|
+
// verify the required parameter 'stageplanId' is set
|
|
517
|
+
if (stageplanId === undefined || stageplanId === null || stageplanId === '') {
|
|
518
|
+
throw 'Missing the required parameter "stageplanId" when calling getCasemanagementCaseplanVersionStageplanStepplan';
|
|
519
|
+
}
|
|
520
|
+
// verify the required parameter 'stepplanId' is set
|
|
521
|
+
if (stepplanId === undefined || stepplanId === null || stepplanId === '') {
|
|
522
|
+
throw 'Missing the required parameter "stepplanId" when calling getCasemanagementCaseplanVersionStageplanStepplan';
|
|
523
|
+
}
|
|
524
|
+
|
|
525
|
+
return this.apiClient.callApi(
|
|
526
|
+
'/api/v2/casemanagement/caseplans/{caseplanId}/versions/{versionId}/stageplans/{stageplanId}/stepplans/{stepplanId}',
|
|
527
|
+
'GET',
|
|
528
|
+
{ 'caseplanId': caseplanId,'versionId': versionId,'stageplanId': stageplanId,'stepplanId': stepplanId },
|
|
529
|
+
{ 'expands': this.apiClient.buildCollectionParam(opts['expands'], 'multi') },
|
|
530
|
+
{ },
|
|
531
|
+
{ },
|
|
532
|
+
null,
|
|
533
|
+
['PureCloud OAuth'],
|
|
534
|
+
['application/json'],
|
|
535
|
+
['application/json']
|
|
536
|
+
);
|
|
537
|
+
}
|
|
538
|
+
|
|
539
|
+
/**
|
|
540
|
+
* Get a list of Stepplans.
|
|
541
|
+
*
|
|
542
|
+
* @param {String} caseplanId Caseplan ID
|
|
543
|
+
* @param {String} versionId Version ID
|
|
544
|
+
* @param {String} stageplanId Stageplan ID
|
|
545
|
+
* @param {Object} opts Optional parameters
|
|
546
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
547
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
548
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
549
|
+
* @param {Array.<String>} opts.expands Which fields to expand.
|
|
550
|
+
* getCasemanagementCaseplanVersionStageplanStepplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
551
|
+
*/
|
|
552
|
+
getCasemanagementCaseplanVersionStageplanStepplans(caseplanId, versionId, stageplanId, opts) {
|
|
553
|
+
opts = opts || {};
|
|
554
|
+
|
|
555
|
+
// verify the required parameter 'caseplanId' is set
|
|
556
|
+
if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
|
|
557
|
+
throw 'Missing the required parameter "caseplanId" when calling getCasemanagementCaseplanVersionStageplanStepplans';
|
|
558
|
+
}
|
|
559
|
+
// verify the required parameter 'versionId' is set
|
|
560
|
+
if (versionId === undefined || versionId === null || versionId === '') {
|
|
561
|
+
throw 'Missing the required parameter "versionId" when calling getCasemanagementCaseplanVersionStageplanStepplans';
|
|
562
|
+
}
|
|
563
|
+
// verify the required parameter 'stageplanId' is set
|
|
564
|
+
if (stageplanId === undefined || stageplanId === null || stageplanId === '') {
|
|
565
|
+
throw 'Missing the required parameter "stageplanId" when calling getCasemanagementCaseplanVersionStageplanStepplans';
|
|
566
|
+
}
|
|
567
|
+
|
|
568
|
+
return this.apiClient.callApi(
|
|
569
|
+
'/api/v2/casemanagement/caseplans/{caseplanId}/versions/{versionId}/stageplans/{stageplanId}/stepplans',
|
|
570
|
+
'GET',
|
|
571
|
+
{ 'caseplanId': caseplanId,'versionId': versionId,'stageplanId': stageplanId },
|
|
572
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'expands': this.apiClient.buildCollectionParam(opts['expands'], 'multi') },
|
|
573
|
+
{ },
|
|
574
|
+
{ },
|
|
575
|
+
null,
|
|
576
|
+
['PureCloud OAuth'],
|
|
577
|
+
['application/json'],
|
|
578
|
+
['application/json']
|
|
579
|
+
);
|
|
580
|
+
}
|
|
581
|
+
|
|
582
|
+
/**
|
|
583
|
+
* Get a list of Stageplans.
|
|
584
|
+
*
|
|
585
|
+
* @param {String} caseplanId Caseplan ID
|
|
586
|
+
* @param {String} versionId Version ID
|
|
587
|
+
* @param {Object} opts Optional parameters
|
|
588
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
589
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
590
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
591
|
+
* @param {Array.<String>} opts.expands Which fields to expand.
|
|
592
|
+
* getCasemanagementCaseplanVersionStageplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
593
|
+
*/
|
|
594
|
+
getCasemanagementCaseplanVersionStageplans(caseplanId, versionId, opts) {
|
|
595
|
+
opts = opts || {};
|
|
596
|
+
|
|
597
|
+
// verify the required parameter 'caseplanId' is set
|
|
598
|
+
if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
|
|
599
|
+
throw 'Missing the required parameter "caseplanId" when calling getCasemanagementCaseplanVersionStageplans';
|
|
600
|
+
}
|
|
601
|
+
// verify the required parameter 'versionId' is set
|
|
602
|
+
if (versionId === undefined || versionId === null || versionId === '') {
|
|
603
|
+
throw 'Missing the required parameter "versionId" when calling getCasemanagementCaseplanVersionStageplans';
|
|
604
|
+
}
|
|
605
|
+
|
|
606
|
+
return this.apiClient.callApi(
|
|
607
|
+
'/api/v2/casemanagement/caseplans/{caseplanId}/versions/{versionId}/stageplans',
|
|
608
|
+
'GET',
|
|
609
|
+
{ 'caseplanId': caseplanId,'versionId': versionId },
|
|
610
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'expands': this.apiClient.buildCollectionParam(opts['expands'], 'multi') },
|
|
611
|
+
{ },
|
|
612
|
+
{ },
|
|
613
|
+
null,
|
|
614
|
+
['PureCloud OAuth'],
|
|
615
|
+
['application/json'],
|
|
616
|
+
['application/json']
|
|
617
|
+
);
|
|
618
|
+
}
|
|
619
|
+
|
|
620
|
+
/**
|
|
621
|
+
* Get a list of Caseplans.
|
|
622
|
+
*
|
|
623
|
+
* @param {Object} opts Optional parameters
|
|
624
|
+
* @param {String} opts.after The cursor that points to the end of the set of caseplans that has been returned.
|
|
625
|
+
* @param {Number} opts.pageSize Number of caseplans to return. Maximum of 200.
|
|
626
|
+
* @param {String} opts.customerIntentId Filter by Customer Intent.
|
|
627
|
+
* @param {String} opts.divisionIds Filter by Divisions.
|
|
628
|
+
* getCasemanagementCaseplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
629
|
+
*/
|
|
630
|
+
getCasemanagementCaseplans(opts) {
|
|
631
|
+
opts = opts || {};
|
|
632
|
+
|
|
633
|
+
|
|
634
|
+
return this.apiClient.callApi(
|
|
635
|
+
'/api/v2/casemanagement/caseplans',
|
|
636
|
+
'GET',
|
|
637
|
+
{ },
|
|
638
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'customerIntentId': opts['customerIntentId'],'divisionIds': opts['divisionIds'] },
|
|
639
|
+
{ },
|
|
640
|
+
{ },
|
|
641
|
+
null,
|
|
642
|
+
['PureCloud OAuth'],
|
|
643
|
+
['application/json'],
|
|
644
|
+
['application/json']
|
|
645
|
+
);
|
|
646
|
+
}
|
|
647
|
+
|
|
648
|
+
/**
|
|
649
|
+
* Get a list of cases for provided external contact id.
|
|
650
|
+
*
|
|
651
|
+
* @param {String} externalContactId External Contact ID
|
|
652
|
+
* @param {Object} opts Optional parameters
|
|
653
|
+
* @param {String} opts.after The cursor that points to the end of the set of cases that has been returned.
|
|
654
|
+
* @param {Number} opts.pageSize Number of cases to return. Maximum of 200.
|
|
655
|
+
* @param {String} opts.divisionIds Filter by Divisions
|
|
656
|
+
* @param {Array.<String>} opts.expands Which fields to expand.
|
|
657
|
+
* getCasemanagementCasesExternalcontact is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
658
|
+
*/
|
|
659
|
+
getCasemanagementCasesExternalcontact(externalContactId, opts) {
|
|
660
|
+
opts = opts || {};
|
|
661
|
+
|
|
662
|
+
// verify the required parameter 'externalContactId' is set
|
|
663
|
+
if (externalContactId === undefined || externalContactId === null || externalContactId === '') {
|
|
664
|
+
throw 'Missing the required parameter "externalContactId" when calling getCasemanagementCasesExternalcontact';
|
|
665
|
+
}
|
|
666
|
+
|
|
667
|
+
return this.apiClient.callApi(
|
|
668
|
+
'/api/v2/casemanagement/cases/externalcontacts/{externalContactId}',
|
|
669
|
+
'GET',
|
|
670
|
+
{ 'externalContactId': externalContactId },
|
|
671
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'divisionIds': opts['divisionIds'],'expands': this.apiClient.buildCollectionParam(opts['expands'], 'multi') },
|
|
672
|
+
{ },
|
|
673
|
+
{ },
|
|
674
|
+
null,
|
|
675
|
+
['PureCloud OAuth'],
|
|
676
|
+
['application/json'],
|
|
677
|
+
['application/json']
|
|
678
|
+
);
|
|
679
|
+
}
|
|
680
|
+
|
|
681
|
+
/**
|
|
682
|
+
* Get a Case by reference.
|
|
683
|
+
*
|
|
684
|
+
* @param {String} referenceId Reference
|
|
685
|
+
* @param {Object} opts Optional parameters
|
|
686
|
+
* @param {Object} opts.expands Which fields to expand.
|
|
687
|
+
* getCasemanagementCasesReference is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
688
|
+
*/
|
|
689
|
+
getCasemanagementCasesReference(referenceId, opts) {
|
|
690
|
+
opts = opts || {};
|
|
691
|
+
|
|
692
|
+
// verify the required parameter 'referenceId' is set
|
|
693
|
+
if (referenceId === undefined || referenceId === null || referenceId === '') {
|
|
694
|
+
throw 'Missing the required parameter "referenceId" when calling getCasemanagementCasesReference';
|
|
695
|
+
}
|
|
696
|
+
|
|
697
|
+
return this.apiClient.callApi(
|
|
698
|
+
'/api/v2/casemanagement/cases/references/{referenceId}',
|
|
699
|
+
'GET',
|
|
700
|
+
{ 'referenceId': referenceId },
|
|
701
|
+
{ 'expands': opts['expands'] },
|
|
702
|
+
{ },
|
|
703
|
+
{ },
|
|
704
|
+
null,
|
|
705
|
+
['PureCloud OAuth'],
|
|
706
|
+
['application/json'],
|
|
707
|
+
['application/json']
|
|
708
|
+
);
|
|
709
|
+
}
|
|
710
|
+
|
|
711
|
+
/**
|
|
712
|
+
* Update date due of a Case.
|
|
713
|
+
*
|
|
714
|
+
* @param {String} caseId Case ID
|
|
715
|
+
* @param {Object} body Date due
|
|
716
|
+
* patchCasemanagementCaseDatedue is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
717
|
+
*/
|
|
718
|
+
patchCasemanagementCaseDatedue(caseId, body) {
|
|
719
|
+
// verify the required parameter 'caseId' is set
|
|
720
|
+
if (caseId === undefined || caseId === null || caseId === '') {
|
|
721
|
+
throw 'Missing the required parameter "caseId" when calling patchCasemanagementCaseDatedue';
|
|
722
|
+
}
|
|
723
|
+
// verify the required parameter 'body' is set
|
|
724
|
+
if (body === undefined || body === null) {
|
|
725
|
+
throw 'Missing the required parameter "body" when calling patchCasemanagementCaseDatedue';
|
|
726
|
+
}
|
|
727
|
+
|
|
728
|
+
return this.apiClient.callApi(
|
|
729
|
+
'/api/v2/casemanagement/cases/{caseId}/datedue',
|
|
730
|
+
'PATCH',
|
|
731
|
+
{ 'caseId': caseId },
|
|
732
|
+
{ },
|
|
733
|
+
{ },
|
|
734
|
+
{ },
|
|
735
|
+
body,
|
|
736
|
+
['PureCloud OAuth'],
|
|
737
|
+
['application/json'],
|
|
738
|
+
['application/json']
|
|
739
|
+
);
|
|
740
|
+
}
|
|
741
|
+
|
|
742
|
+
/**
|
|
743
|
+
* Update priority of a Case.
|
|
744
|
+
*
|
|
745
|
+
* @param {String} caseId Case ID
|
|
746
|
+
* @param {Object} body Priority
|
|
747
|
+
* patchCasemanagementCasePriority is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
748
|
+
*/
|
|
749
|
+
patchCasemanagementCasePriority(caseId, body) {
|
|
750
|
+
// verify the required parameter 'caseId' is set
|
|
751
|
+
if (caseId === undefined || caseId === null || caseId === '') {
|
|
752
|
+
throw 'Missing the required parameter "caseId" when calling patchCasemanagementCasePriority';
|
|
753
|
+
}
|
|
754
|
+
// verify the required parameter 'body' is set
|
|
755
|
+
if (body === undefined || body === null) {
|
|
756
|
+
throw 'Missing the required parameter "body" when calling patchCasemanagementCasePriority';
|
|
757
|
+
}
|
|
758
|
+
|
|
759
|
+
return this.apiClient.callApi(
|
|
760
|
+
'/api/v2/casemanagement/cases/{caseId}/priority',
|
|
761
|
+
'PATCH',
|
|
762
|
+
{ 'caseId': caseId },
|
|
763
|
+
{ },
|
|
764
|
+
{ },
|
|
765
|
+
{ },
|
|
766
|
+
body,
|
|
767
|
+
['PureCloud OAuth'],
|
|
768
|
+
['application/json'],
|
|
769
|
+
['application/json']
|
|
770
|
+
);
|
|
771
|
+
}
|
|
772
|
+
|
|
773
|
+
/**
|
|
774
|
+
* Update summary of a Case.
|
|
775
|
+
*
|
|
776
|
+
* @param {String} caseId Case ID
|
|
777
|
+
* @param {Object} body Summary
|
|
778
|
+
* patchCasemanagementCaseSummary is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
779
|
+
*/
|
|
780
|
+
patchCasemanagementCaseSummary(caseId, body) {
|
|
781
|
+
// verify the required parameter 'caseId' is set
|
|
782
|
+
if (caseId === undefined || caseId === null || caseId === '') {
|
|
783
|
+
throw 'Missing the required parameter "caseId" when calling patchCasemanagementCaseSummary';
|
|
784
|
+
}
|
|
785
|
+
// verify the required parameter 'body' is set
|
|
786
|
+
if (body === undefined || body === null) {
|
|
787
|
+
throw 'Missing the required parameter "body" when calling patchCasemanagementCaseSummary';
|
|
788
|
+
}
|
|
789
|
+
|
|
790
|
+
return this.apiClient.callApi(
|
|
791
|
+
'/api/v2/casemanagement/cases/{caseId}/summary',
|
|
792
|
+
'PATCH',
|
|
793
|
+
{ 'caseId': caseId },
|
|
794
|
+
{ },
|
|
795
|
+
{ },
|
|
796
|
+
{ },
|
|
797
|
+
body,
|
|
798
|
+
['PureCloud OAuth'],
|
|
799
|
+
['application/json'],
|
|
800
|
+
['application/json']
|
|
801
|
+
);
|
|
802
|
+
}
|
|
803
|
+
|
|
804
|
+
/**
|
|
805
|
+
* Update the attributes of a Caseplan.
|
|
806
|
+
*
|
|
807
|
+
* @param {String} caseplanId Caseplan ID
|
|
808
|
+
* @param {Object} body Caseplan
|
|
809
|
+
* patchCasemanagementCaseplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
810
|
+
*/
|
|
811
|
+
patchCasemanagementCaseplan(caseplanId, body) {
|
|
812
|
+
// verify the required parameter 'caseplanId' is set
|
|
813
|
+
if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
|
|
814
|
+
throw 'Missing the required parameter "caseplanId" when calling patchCasemanagementCaseplan';
|
|
815
|
+
}
|
|
816
|
+
// verify the required parameter 'body' is set
|
|
817
|
+
if (body === undefined || body === null) {
|
|
818
|
+
throw 'Missing the required parameter "body" when calling patchCasemanagementCaseplan';
|
|
819
|
+
}
|
|
820
|
+
|
|
821
|
+
return this.apiClient.callApi(
|
|
822
|
+
'/api/v2/casemanagement/caseplans/{caseplanId}',
|
|
823
|
+
'PATCH',
|
|
824
|
+
{ 'caseplanId': caseplanId },
|
|
825
|
+
{ },
|
|
826
|
+
{ },
|
|
827
|
+
{ },
|
|
828
|
+
body,
|
|
829
|
+
['PureCloud OAuth'],
|
|
830
|
+
['application/json'],
|
|
831
|
+
['application/json']
|
|
832
|
+
);
|
|
833
|
+
}
|
|
834
|
+
|
|
835
|
+
/**
|
|
836
|
+
* Update the attributes of a Stageplan.
|
|
837
|
+
*
|
|
838
|
+
* @param {String} caseplanId Caseplan ID
|
|
839
|
+
* @param {String} stageplanId Stageplan ID
|
|
840
|
+
* @param {Object} body Stageplan
|
|
841
|
+
* patchCasemanagementCaseplanStageplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
842
|
+
*/
|
|
843
|
+
patchCasemanagementCaseplanStageplan(caseplanId, stageplanId, body) {
|
|
844
|
+
// verify the required parameter 'caseplanId' is set
|
|
845
|
+
if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
|
|
846
|
+
throw 'Missing the required parameter "caseplanId" when calling patchCasemanagementCaseplanStageplan';
|
|
847
|
+
}
|
|
848
|
+
// verify the required parameter 'stageplanId' is set
|
|
849
|
+
if (stageplanId === undefined || stageplanId === null || stageplanId === '') {
|
|
850
|
+
throw 'Missing the required parameter "stageplanId" when calling patchCasemanagementCaseplanStageplan';
|
|
851
|
+
}
|
|
852
|
+
// verify the required parameter 'body' is set
|
|
853
|
+
if (body === undefined || body === null) {
|
|
854
|
+
throw 'Missing the required parameter "body" when calling patchCasemanagementCaseplanStageplan';
|
|
855
|
+
}
|
|
856
|
+
|
|
857
|
+
return this.apiClient.callApi(
|
|
858
|
+
'/api/v2/casemanagement/caseplans/{caseplanId}/stageplans/{stageplanId}',
|
|
859
|
+
'PATCH',
|
|
860
|
+
{ 'caseplanId': caseplanId,'stageplanId': stageplanId },
|
|
861
|
+
{ },
|
|
862
|
+
{ },
|
|
863
|
+
{ },
|
|
864
|
+
body,
|
|
865
|
+
['PureCloud OAuth'],
|
|
866
|
+
['application/json'],
|
|
867
|
+
['application/json']
|
|
868
|
+
);
|
|
869
|
+
}
|
|
870
|
+
|
|
871
|
+
/**
|
|
872
|
+
* Update the attributes of a Stepplan.
|
|
873
|
+
*
|
|
874
|
+
* @param {String} caseplanId Caseplan ID
|
|
875
|
+
* @param {String} stageplanId Stageplan ID
|
|
876
|
+
* @param {String} stepplanId Stepplan ID
|
|
877
|
+
* @param {Object} body Stepplan
|
|
878
|
+
* patchCasemanagementCaseplanStageplanStepplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
879
|
+
*/
|
|
880
|
+
patchCasemanagementCaseplanStageplanStepplan(caseplanId, stageplanId, stepplanId, body) {
|
|
881
|
+
// verify the required parameter 'caseplanId' is set
|
|
882
|
+
if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
|
|
883
|
+
throw 'Missing the required parameter "caseplanId" when calling patchCasemanagementCaseplanStageplanStepplan';
|
|
884
|
+
}
|
|
885
|
+
// verify the required parameter 'stageplanId' is set
|
|
886
|
+
if (stageplanId === undefined || stageplanId === null || stageplanId === '') {
|
|
887
|
+
throw 'Missing the required parameter "stageplanId" when calling patchCasemanagementCaseplanStageplanStepplan';
|
|
888
|
+
}
|
|
889
|
+
// verify the required parameter 'stepplanId' is set
|
|
890
|
+
if (stepplanId === undefined || stepplanId === null || stepplanId === '') {
|
|
891
|
+
throw 'Missing the required parameter "stepplanId" when calling patchCasemanagementCaseplanStageplanStepplan';
|
|
892
|
+
}
|
|
893
|
+
// verify the required parameter 'body' is set
|
|
894
|
+
if (body === undefined || body === null) {
|
|
895
|
+
throw 'Missing the required parameter "body" when calling patchCasemanagementCaseplanStageplanStepplan';
|
|
896
|
+
}
|
|
897
|
+
|
|
898
|
+
return this.apiClient.callApi(
|
|
899
|
+
'/api/v2/casemanagement/caseplans/{caseplanId}/stageplans/{stageplanId}/stepplans/{stepplanId}',
|
|
900
|
+
'PATCH',
|
|
901
|
+
{ 'caseplanId': caseplanId,'stageplanId': stageplanId,'stepplanId': stepplanId },
|
|
902
|
+
{ },
|
|
903
|
+
{ },
|
|
904
|
+
{ },
|
|
905
|
+
body,
|
|
906
|
+
['PureCloud OAuth'],
|
|
907
|
+
['application/json'],
|
|
908
|
+
['application/json']
|
|
909
|
+
);
|
|
910
|
+
}
|
|
911
|
+
|
|
912
|
+
/**
|
|
913
|
+
* Create a case association.
|
|
914
|
+
*
|
|
915
|
+
* @param {String} caseId Case ID.
|
|
916
|
+
* @param {Object} opts Optional parameters
|
|
917
|
+
* @param {Object} opts.body Case Association
|
|
918
|
+
* postCasemanagementCaseAssociations is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
919
|
+
*/
|
|
920
|
+
postCasemanagementCaseAssociations(caseId, opts) {
|
|
921
|
+
opts = opts || {};
|
|
922
|
+
|
|
923
|
+
// verify the required parameter 'caseId' is set
|
|
924
|
+
if (caseId === undefined || caseId === null || caseId === '') {
|
|
925
|
+
throw 'Missing the required parameter "caseId" when calling postCasemanagementCaseAssociations';
|
|
926
|
+
}
|
|
927
|
+
|
|
928
|
+
return this.apiClient.callApi(
|
|
929
|
+
'/api/v2/casemanagement/cases/{caseId}/associations',
|
|
930
|
+
'POST',
|
|
931
|
+
{ 'caseId': caseId },
|
|
932
|
+
{ },
|
|
933
|
+
{ },
|
|
934
|
+
{ },
|
|
935
|
+
opts['body'],
|
|
936
|
+
['PureCloud OAuth'],
|
|
937
|
+
['application/json'],
|
|
938
|
+
['application/json']
|
|
939
|
+
);
|
|
940
|
+
}
|
|
941
|
+
|
|
942
|
+
/**
|
|
943
|
+
* Create a Terminate Job for a Case.
|
|
944
|
+
*
|
|
945
|
+
* @param {String} caseId Case ID
|
|
946
|
+
* postCasemanagementCaseTerminateJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
947
|
+
*/
|
|
948
|
+
postCasemanagementCaseTerminateJobs(caseId) {
|
|
949
|
+
// verify the required parameter 'caseId' is set
|
|
950
|
+
if (caseId === undefined || caseId === null || caseId === '') {
|
|
951
|
+
throw 'Missing the required parameter "caseId" when calling postCasemanagementCaseTerminateJobs';
|
|
952
|
+
}
|
|
953
|
+
|
|
954
|
+
return this.apiClient.callApi(
|
|
955
|
+
'/api/v2/casemanagement/cases/{caseId}/terminate/jobs',
|
|
956
|
+
'POST',
|
|
957
|
+
{ 'caseId': caseId },
|
|
958
|
+
{ },
|
|
959
|
+
{ },
|
|
960
|
+
{ },
|
|
961
|
+
null,
|
|
962
|
+
['PureCloud OAuth'],
|
|
963
|
+
['application/json'],
|
|
964
|
+
['application/json']
|
|
965
|
+
);
|
|
966
|
+
}
|
|
967
|
+
|
|
968
|
+
/**
|
|
969
|
+
* Publish Caseplan.
|
|
970
|
+
*
|
|
971
|
+
* @param {String} caseplanId Caseplan ID
|
|
972
|
+
* postCasemanagementCaseplanPublish is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
973
|
+
*/
|
|
974
|
+
postCasemanagementCaseplanPublish(caseplanId) {
|
|
975
|
+
// verify the required parameter 'caseplanId' is set
|
|
976
|
+
if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
|
|
977
|
+
throw 'Missing the required parameter "caseplanId" when calling postCasemanagementCaseplanPublish';
|
|
978
|
+
}
|
|
979
|
+
|
|
980
|
+
return this.apiClient.callApi(
|
|
981
|
+
'/api/v2/casemanagement/caseplans/{caseplanId}/publish',
|
|
982
|
+
'POST',
|
|
983
|
+
{ 'caseplanId': caseplanId },
|
|
984
|
+
{ },
|
|
985
|
+
{ },
|
|
986
|
+
{ },
|
|
987
|
+
null,
|
|
988
|
+
['PureCloud OAuth'],
|
|
989
|
+
['application/json'],
|
|
990
|
+
['application/json']
|
|
991
|
+
);
|
|
992
|
+
}
|
|
993
|
+
|
|
994
|
+
/**
|
|
995
|
+
* Create Caseplan version.
|
|
996
|
+
*
|
|
997
|
+
* @param {String} caseplanId Caseplan ID
|
|
998
|
+
* postCasemanagementCaseplanVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
999
|
+
*/
|
|
1000
|
+
postCasemanagementCaseplanVersions(caseplanId) {
|
|
1001
|
+
// verify the required parameter 'caseplanId' is set
|
|
1002
|
+
if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
|
|
1003
|
+
throw 'Missing the required parameter "caseplanId" when calling postCasemanagementCaseplanVersions';
|
|
1004
|
+
}
|
|
1005
|
+
|
|
1006
|
+
return this.apiClient.callApi(
|
|
1007
|
+
'/api/v2/casemanagement/caseplans/{caseplanId}/versions',
|
|
1008
|
+
'POST',
|
|
1009
|
+
{ 'caseplanId': caseplanId },
|
|
1010
|
+
{ },
|
|
1011
|
+
{ },
|
|
1012
|
+
{ },
|
|
1013
|
+
null,
|
|
1014
|
+
['PureCloud OAuth'],
|
|
1015
|
+
['application/json'],
|
|
1016
|
+
['application/json']
|
|
1017
|
+
);
|
|
1018
|
+
}
|
|
1019
|
+
|
|
1020
|
+
/**
|
|
1021
|
+
* Create a Caseplan.
|
|
1022
|
+
*
|
|
1023
|
+
* @param {Object} body Caseplan
|
|
1024
|
+
* postCasemanagementCaseplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1025
|
+
*/
|
|
1026
|
+
postCasemanagementCaseplans(body) {
|
|
1027
|
+
// verify the required parameter 'body' is set
|
|
1028
|
+
if (body === undefined || body === null) {
|
|
1029
|
+
throw 'Missing the required parameter "body" when calling postCasemanagementCaseplans';
|
|
1030
|
+
}
|
|
1031
|
+
|
|
1032
|
+
return this.apiClient.callApi(
|
|
1033
|
+
'/api/v2/casemanagement/caseplans',
|
|
1034
|
+
'POST',
|
|
1035
|
+
{ },
|
|
1036
|
+
{ },
|
|
1037
|
+
{ },
|
|
1038
|
+
{ },
|
|
1039
|
+
body,
|
|
1040
|
+
['PureCloud OAuth'],
|
|
1041
|
+
['application/json'],
|
|
1042
|
+
['application/json']
|
|
1043
|
+
);
|
|
1044
|
+
}
|
|
1045
|
+
|
|
1046
|
+
/**
|
|
1047
|
+
* Create a Case.
|
|
1048
|
+
*
|
|
1049
|
+
* @param {Object} body Case
|
|
1050
|
+
* postCasemanagementCases is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1051
|
+
*/
|
|
1052
|
+
postCasemanagementCases(body) {
|
|
1053
|
+
// verify the required parameter 'body' is set
|
|
1054
|
+
if (body === undefined || body === null) {
|
|
1055
|
+
throw 'Missing the required parameter "body" when calling postCasemanagementCases';
|
|
1056
|
+
}
|
|
1057
|
+
|
|
1058
|
+
return this.apiClient.callApi(
|
|
1059
|
+
'/api/v2/casemanagement/cases',
|
|
1060
|
+
'POST',
|
|
1061
|
+
{ },
|
|
1062
|
+
{ },
|
|
1063
|
+
{ },
|
|
1064
|
+
{ },
|
|
1065
|
+
body,
|
|
1066
|
+
['PureCloud OAuth'],
|
|
1067
|
+
['application/json'],
|
|
1068
|
+
['application/json']
|
|
1069
|
+
);
|
|
1070
|
+
}
|
|
1071
|
+
|
|
1072
|
+
/**
|
|
1073
|
+
* Query for case associations
|
|
1074
|
+
*
|
|
1075
|
+
* @param {Object} opts Optional parameters
|
|
1076
|
+
* @param {Object} opts.body Case Association
|
|
1077
|
+
* postCasemanagementCasesAssociationsQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1078
|
+
*/
|
|
1079
|
+
postCasemanagementCasesAssociationsQuery(opts) {
|
|
1080
|
+
opts = opts || {};
|
|
1081
|
+
|
|
1082
|
+
|
|
1083
|
+
return this.apiClient.callApi(
|
|
1084
|
+
'/api/v2/casemanagement/cases/associations/query',
|
|
1085
|
+
'POST',
|
|
1086
|
+
{ },
|
|
1087
|
+
{ },
|
|
1088
|
+
{ },
|
|
1089
|
+
{ },
|
|
1090
|
+
opts['body'],
|
|
1091
|
+
['PureCloud OAuth'],
|
|
1092
|
+
['application/json'],
|
|
1093
|
+
['application/json']
|
|
1094
|
+
);
|
|
1095
|
+
}
|
|
1096
|
+
|
|
1097
|
+
}
|
|
1098
|
+
|
|
1099
|
+
|
|
1100
|
+
export default CaseManagementApi;
|