@easyedu/js-lsm-api 1.110.0 → 1.111.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/.openapi-generator/FILES +20 -0
- package/README.md +21 -2
- package/dist/apis/LearnerExperienceApi.d.ts +153 -0
- package/dist/apis/LearnerExperienceApi.js +401 -0
- package/dist/apis/index.d.ts +1 -0
- package/dist/apis/index.js +1 -0
- package/dist/esm/apis/LearnerExperienceApi.d.ts +153 -0
- package/dist/esm/apis/LearnerExperienceApi.js +397 -0
- package/dist/esm/apis/index.d.ts +1 -0
- package/dist/esm/apis/index.js +1 -0
- package/dist/esm/models/GetEffectiveLearnerExperience.d.ts +62 -0
- package/dist/esm/models/GetEffectiveLearnerExperience.js +62 -0
- package/dist/esm/models/GetLearnerDashboard.d.ts +47 -0
- package/dist/esm/models/GetLearnerDashboard.js +54 -0
- package/dist/esm/models/GetLearnerDashboardCourseList.d.ts +39 -0
- package/dist/esm/models/GetLearnerDashboardCourseList.js +48 -0
- package/dist/esm/models/GetLearnerDashboardSummary.d.ts +56 -0
- package/dist/esm/models/GetLearnerDashboardSummary.js +59 -0
- package/dist/esm/models/GetLearnerExperience.d.ts +67 -0
- package/dist/esm/models/GetLearnerExperience.js +65 -0
- package/dist/esm/models/GetLearnerExperiencePreview.d.ts +40 -0
- package/dist/esm/models/GetLearnerExperiencePreview.js +47 -0
- package/dist/esm/models/LearnerExperienceVersion.d.ts +86 -0
- package/dist/esm/models/LearnerExperienceVersion.js +76 -0
- package/dist/esm/models/PostLearnerExperiencePreview.d.ts +40 -0
- package/dist/esm/models/PostLearnerExperiencePreview.js +45 -0
- package/dist/esm/models/PutLearnerExperienceDraft.d.ts +40 -0
- package/dist/esm/models/PutLearnerExperienceDraft.js +45 -0
- package/dist/esm/models/index.d.ts +9 -0
- package/dist/esm/models/index.js +9 -0
- package/dist/models/GetEffectiveLearnerExperience.d.ts +62 -0
- package/dist/models/GetEffectiveLearnerExperience.js +70 -0
- package/dist/models/GetLearnerDashboard.d.ts +47 -0
- package/dist/models/GetLearnerDashboard.js +61 -0
- package/dist/models/GetLearnerDashboardCourseList.d.ts +39 -0
- package/dist/models/GetLearnerDashboardCourseList.js +55 -0
- package/dist/models/GetLearnerDashboardSummary.d.ts +56 -0
- package/dist/models/GetLearnerDashboardSummary.js +66 -0
- package/dist/models/GetLearnerExperience.d.ts +67 -0
- package/dist/models/GetLearnerExperience.js +73 -0
- package/dist/models/GetLearnerExperiencePreview.d.ts +40 -0
- package/dist/models/GetLearnerExperiencePreview.js +54 -0
- package/dist/models/LearnerExperienceVersion.d.ts +86 -0
- package/dist/models/LearnerExperienceVersion.js +84 -0
- package/dist/models/PostLearnerExperiencePreview.d.ts +40 -0
- package/dist/models/PostLearnerExperiencePreview.js +52 -0
- package/dist/models/PutLearnerExperienceDraft.d.ts +40 -0
- package/dist/models/PutLearnerExperienceDraft.js +52 -0
- package/dist/models/index.d.ts +9 -0
- package/dist/models/index.js +9 -0
- package/docs/GetEffectiveLearnerExperience.md +40 -0
- package/docs/GetLearnerDashboard.md +38 -0
- package/docs/GetLearnerDashboardCourseList.md +36 -0
- package/docs/GetLearnerDashboardSummary.md +42 -0
- package/docs/GetLearnerExperience.md +42 -0
- package/docs/GetLearnerExperiencePreview.md +36 -0
- package/docs/LearnerExperienceApi.md +622 -0
- package/docs/LearnerExperienceVersion.md +48 -0
- package/docs/PostLearnerExperiencePreview.md +36 -0
- package/docs/PutLearnerExperienceDraft.md +36 -0
- package/package.json +1 -1
- package/src/apis/LearnerExperienceApi.ts +465 -0
- package/src/apis/index.ts +1 -0
- package/src/models/GetEffectiveLearnerExperience.ts +105 -0
- package/src/models/GetLearnerDashboard.ts +106 -0
- package/src/models/GetLearnerDashboardCourseList.ts +83 -0
- package/src/models/GetLearnerDashboardSummary.ts +102 -0
- package/src/models/GetLearnerExperience.ts +121 -0
- package/src/models/GetLearnerExperiencePreview.ts +75 -0
- package/src/models/LearnerExperienceVersion.ts +140 -0
- package/src/models/PostLearnerExperiencePreview.ts +74 -0
- package/src/models/PutLearnerExperienceDraft.ts +74 -0
- package/src/models/index.ts +9 -0
|
@@ -0,0 +1,397 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* LMS API
|
|
5
|
+
* LMS API
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
15
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
16
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
17
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
18
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
19
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
20
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
21
|
+
});
|
|
22
|
+
};
|
|
23
|
+
import * as runtime from '../runtime';
|
|
24
|
+
import { GetEffectiveLearnerExperienceFromJSON, } from '../models/GetEffectiveLearnerExperience';
|
|
25
|
+
import { GetLearnerDashboardFromJSON, } from '../models/GetLearnerDashboard';
|
|
26
|
+
import { GetLearnerExperienceFromJSON, } from '../models/GetLearnerExperience';
|
|
27
|
+
import { GetLearnerExperiencePreviewFromJSON, } from '../models/GetLearnerExperiencePreview';
|
|
28
|
+
import { LearnerExperienceVersionFromJSON, } from '../models/LearnerExperienceVersion';
|
|
29
|
+
import { PostLearnerExperiencePreviewToJSON, } from '../models/PostLearnerExperiencePreview';
|
|
30
|
+
import { PutLearnerExperienceDraftToJSON, } from '../models/PutLearnerExperienceDraft';
|
|
31
|
+
/**
|
|
32
|
+
*
|
|
33
|
+
*/
|
|
34
|
+
export class LearnerExperienceApi extends runtime.BaseAPI {
|
|
35
|
+
/**
|
|
36
|
+
* Creates request options for deleteLearnerExperienceDraft without sending the request
|
|
37
|
+
*/
|
|
38
|
+
deleteLearnerExperienceDraftRequestOpts() {
|
|
39
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
40
|
+
const queryParameters = {};
|
|
41
|
+
const headerParameters = {};
|
|
42
|
+
let urlPath = `/learner-experience/draft`;
|
|
43
|
+
return {
|
|
44
|
+
path: urlPath,
|
|
45
|
+
method: 'DELETE',
|
|
46
|
+
headers: headerParameters,
|
|
47
|
+
query: queryParameters,
|
|
48
|
+
};
|
|
49
|
+
});
|
|
50
|
+
}
|
|
51
|
+
/**
|
|
52
|
+
* Discard the selected portal\'s learner experience draft
|
|
53
|
+
*/
|
|
54
|
+
deleteLearnerExperienceDraftRaw(initOverrides) {
|
|
55
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
56
|
+
const requestOptions = yield this.deleteLearnerExperienceDraftRequestOpts();
|
|
57
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
58
|
+
return new runtime.VoidApiResponse(response);
|
|
59
|
+
});
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
* Discard the selected portal\'s learner experience draft
|
|
63
|
+
*/
|
|
64
|
+
deleteLearnerExperienceDraft(initOverrides) {
|
|
65
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
66
|
+
yield this.deleteLearnerExperienceDraftRaw(initOverrides);
|
|
67
|
+
});
|
|
68
|
+
}
|
|
69
|
+
/**
|
|
70
|
+
* Creates request options for getCurrentLearnerDashboard without sending the request
|
|
71
|
+
*/
|
|
72
|
+
getCurrentLearnerDashboardRequestOpts() {
|
|
73
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
74
|
+
const queryParameters = {};
|
|
75
|
+
const headerParameters = {};
|
|
76
|
+
let urlPath = `/users/current/dashboard`;
|
|
77
|
+
return {
|
|
78
|
+
path: urlPath,
|
|
79
|
+
method: 'GET',
|
|
80
|
+
headers: headerParameters,
|
|
81
|
+
query: queryParameters,
|
|
82
|
+
};
|
|
83
|
+
});
|
|
84
|
+
}
|
|
85
|
+
/**
|
|
86
|
+
* Get the authenticated learner\'s resolved dashboard and personalized data
|
|
87
|
+
*/
|
|
88
|
+
getCurrentLearnerDashboardRaw(initOverrides) {
|
|
89
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
90
|
+
const requestOptions = yield this.getCurrentLearnerDashboardRequestOpts();
|
|
91
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
92
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetLearnerDashboardFromJSON(jsonValue));
|
|
93
|
+
});
|
|
94
|
+
}
|
|
95
|
+
/**
|
|
96
|
+
* Get the authenticated learner\'s resolved dashboard and personalized data
|
|
97
|
+
*/
|
|
98
|
+
getCurrentLearnerDashboard(initOverrides) {
|
|
99
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
100
|
+
const response = yield this.getCurrentLearnerDashboardRaw(initOverrides);
|
|
101
|
+
return yield response.value();
|
|
102
|
+
});
|
|
103
|
+
}
|
|
104
|
+
/**
|
|
105
|
+
* Creates request options for getEffectiveLearnerExperience without sending the request
|
|
106
|
+
*/
|
|
107
|
+
getEffectiveLearnerExperienceRequestOpts() {
|
|
108
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
109
|
+
const queryParameters = {};
|
|
110
|
+
const headerParameters = {};
|
|
111
|
+
let urlPath = `/learner-experience/effective`;
|
|
112
|
+
return {
|
|
113
|
+
path: urlPath,
|
|
114
|
+
method: 'GET',
|
|
115
|
+
headers: headerParameters,
|
|
116
|
+
query: queryParameters,
|
|
117
|
+
};
|
|
118
|
+
});
|
|
119
|
+
}
|
|
120
|
+
/**
|
|
121
|
+
* Get the effective published learner experience for the authenticated user
|
|
122
|
+
*/
|
|
123
|
+
getEffectiveLearnerExperienceRaw(initOverrides) {
|
|
124
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
125
|
+
const requestOptions = yield this.getEffectiveLearnerExperienceRequestOpts();
|
|
126
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
127
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetEffectiveLearnerExperienceFromJSON(jsonValue));
|
|
128
|
+
});
|
|
129
|
+
}
|
|
130
|
+
/**
|
|
131
|
+
* Get the effective published learner experience for the authenticated user
|
|
132
|
+
*/
|
|
133
|
+
getEffectiveLearnerExperience(initOverrides) {
|
|
134
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
135
|
+
const response = yield this.getEffectiveLearnerExperienceRaw(initOverrides);
|
|
136
|
+
return yield response.value();
|
|
137
|
+
});
|
|
138
|
+
}
|
|
139
|
+
/**
|
|
140
|
+
* Creates request options for getLearnerExperience without sending the request
|
|
141
|
+
*/
|
|
142
|
+
getLearnerExperienceRequestOpts() {
|
|
143
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
144
|
+
const queryParameters = {};
|
|
145
|
+
const headerParameters = {};
|
|
146
|
+
let urlPath = `/learner-experience`;
|
|
147
|
+
return {
|
|
148
|
+
path: urlPath,
|
|
149
|
+
method: 'GET',
|
|
150
|
+
headers: headerParameters,
|
|
151
|
+
query: queryParameters,
|
|
152
|
+
};
|
|
153
|
+
});
|
|
154
|
+
}
|
|
155
|
+
/**
|
|
156
|
+
* Get the selected portal\'s effective learner experience and local history
|
|
157
|
+
*/
|
|
158
|
+
getLearnerExperienceRaw(initOverrides) {
|
|
159
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
160
|
+
const requestOptions = yield this.getLearnerExperienceRequestOpts();
|
|
161
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
162
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetLearnerExperienceFromJSON(jsonValue));
|
|
163
|
+
});
|
|
164
|
+
}
|
|
165
|
+
/**
|
|
166
|
+
* Get the selected portal\'s effective learner experience and local history
|
|
167
|
+
*/
|
|
168
|
+
getLearnerExperience(initOverrides) {
|
|
169
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
170
|
+
const response = yield this.getLearnerExperienceRaw(initOverrides);
|
|
171
|
+
return yield response.value();
|
|
172
|
+
});
|
|
173
|
+
}
|
|
174
|
+
/**
|
|
175
|
+
* Creates request options for postLearnerExperienceDraft without sending the request
|
|
176
|
+
*/
|
|
177
|
+
postLearnerExperienceDraftRequestOpts() {
|
|
178
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
179
|
+
const queryParameters = {};
|
|
180
|
+
const headerParameters = {};
|
|
181
|
+
let urlPath = `/learner-experience/draft`;
|
|
182
|
+
return {
|
|
183
|
+
path: urlPath,
|
|
184
|
+
method: 'POST',
|
|
185
|
+
headers: headerParameters,
|
|
186
|
+
query: queryParameters,
|
|
187
|
+
};
|
|
188
|
+
});
|
|
189
|
+
}
|
|
190
|
+
/**
|
|
191
|
+
* Create a portal learner experience draft from the effective version
|
|
192
|
+
*/
|
|
193
|
+
postLearnerExperienceDraftRaw(initOverrides) {
|
|
194
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
195
|
+
const requestOptions = yield this.postLearnerExperienceDraftRequestOpts();
|
|
196
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
197
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => LearnerExperienceVersionFromJSON(jsonValue));
|
|
198
|
+
});
|
|
199
|
+
}
|
|
200
|
+
/**
|
|
201
|
+
* Create a portal learner experience draft from the effective version
|
|
202
|
+
*/
|
|
203
|
+
postLearnerExperienceDraft(initOverrides) {
|
|
204
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
205
|
+
const response = yield this.postLearnerExperienceDraftRaw(initOverrides);
|
|
206
|
+
return yield response.value();
|
|
207
|
+
});
|
|
208
|
+
}
|
|
209
|
+
/**
|
|
210
|
+
* Creates request options for postLearnerExperienceInherit without sending the request
|
|
211
|
+
*/
|
|
212
|
+
postLearnerExperienceInheritRequestOpts() {
|
|
213
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
214
|
+
const queryParameters = {};
|
|
215
|
+
const headerParameters = {};
|
|
216
|
+
let urlPath = `/learner-experience/inherit`;
|
|
217
|
+
return {
|
|
218
|
+
path: urlPath,
|
|
219
|
+
method: 'POST',
|
|
220
|
+
headers: headerParameters,
|
|
221
|
+
query: queryParameters,
|
|
222
|
+
};
|
|
223
|
+
});
|
|
224
|
+
}
|
|
225
|
+
/**
|
|
226
|
+
* Disable the local learner experience override and resume inheritance
|
|
227
|
+
*/
|
|
228
|
+
postLearnerExperienceInheritRaw(initOverrides) {
|
|
229
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
230
|
+
const requestOptions = yield this.postLearnerExperienceInheritRequestOpts();
|
|
231
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
232
|
+
return new runtime.VoidApiResponse(response);
|
|
233
|
+
});
|
|
234
|
+
}
|
|
235
|
+
/**
|
|
236
|
+
* Disable the local learner experience override and resume inheritance
|
|
237
|
+
*/
|
|
238
|
+
postLearnerExperienceInherit(initOverrides) {
|
|
239
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
240
|
+
yield this.postLearnerExperienceInheritRaw(initOverrides);
|
|
241
|
+
});
|
|
242
|
+
}
|
|
243
|
+
/**
|
|
244
|
+
* Creates request options for postLearnerExperiencePreview without sending the request
|
|
245
|
+
*/
|
|
246
|
+
postLearnerExperiencePreviewRequestOpts(requestParameters) {
|
|
247
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
248
|
+
if (requestParameters['postLearnerExperiencePreview'] == null) {
|
|
249
|
+
throw new runtime.RequiredError('postLearnerExperiencePreview', 'Required parameter "postLearnerExperiencePreview" was null or undefined when calling postLearnerExperiencePreview().');
|
|
250
|
+
}
|
|
251
|
+
const queryParameters = {};
|
|
252
|
+
const headerParameters = {};
|
|
253
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
254
|
+
let urlPath = `/learner-experience/preview`;
|
|
255
|
+
return {
|
|
256
|
+
path: urlPath,
|
|
257
|
+
method: 'POST',
|
|
258
|
+
headers: headerParameters,
|
|
259
|
+
query: queryParameters,
|
|
260
|
+
body: PostLearnerExperiencePreviewToJSON(requestParameters['postLearnerExperiencePreview']),
|
|
261
|
+
};
|
|
262
|
+
});
|
|
263
|
+
}
|
|
264
|
+
/**
|
|
265
|
+
* Validate and preview an unsaved learner experience document
|
|
266
|
+
*/
|
|
267
|
+
postLearnerExperiencePreviewRaw(requestParameters, initOverrides) {
|
|
268
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
269
|
+
const requestOptions = yield this.postLearnerExperiencePreviewRequestOpts(requestParameters);
|
|
270
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
271
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetLearnerExperiencePreviewFromJSON(jsonValue));
|
|
272
|
+
});
|
|
273
|
+
}
|
|
274
|
+
/**
|
|
275
|
+
* Validate and preview an unsaved learner experience document
|
|
276
|
+
*/
|
|
277
|
+
postLearnerExperiencePreview(requestParameters, initOverrides) {
|
|
278
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
279
|
+
const response = yield this.postLearnerExperiencePreviewRaw(requestParameters, initOverrides);
|
|
280
|
+
return yield response.value();
|
|
281
|
+
});
|
|
282
|
+
}
|
|
283
|
+
/**
|
|
284
|
+
* Creates request options for postLearnerExperiencePublish without sending the request
|
|
285
|
+
*/
|
|
286
|
+
postLearnerExperiencePublishRequestOpts() {
|
|
287
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
288
|
+
const queryParameters = {};
|
|
289
|
+
const headerParameters = {};
|
|
290
|
+
let urlPath = `/learner-experience/publish`;
|
|
291
|
+
return {
|
|
292
|
+
path: urlPath,
|
|
293
|
+
method: 'POST',
|
|
294
|
+
headers: headerParameters,
|
|
295
|
+
query: queryParameters,
|
|
296
|
+
};
|
|
297
|
+
});
|
|
298
|
+
}
|
|
299
|
+
/**
|
|
300
|
+
* Publish the selected portal\'s learner experience draft
|
|
301
|
+
*/
|
|
302
|
+
postLearnerExperiencePublishRaw(initOverrides) {
|
|
303
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
304
|
+
const requestOptions = yield this.postLearnerExperiencePublishRequestOpts();
|
|
305
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
306
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => LearnerExperienceVersionFromJSON(jsonValue));
|
|
307
|
+
});
|
|
308
|
+
}
|
|
309
|
+
/**
|
|
310
|
+
* Publish the selected portal\'s learner experience draft
|
|
311
|
+
*/
|
|
312
|
+
postLearnerExperiencePublish(initOverrides) {
|
|
313
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
314
|
+
const response = yield this.postLearnerExperiencePublishRaw(initOverrides);
|
|
315
|
+
return yield response.value();
|
|
316
|
+
});
|
|
317
|
+
}
|
|
318
|
+
/**
|
|
319
|
+
* Creates request options for postLearnerExperienceVersionRestore without sending the request
|
|
320
|
+
*/
|
|
321
|
+
postLearnerExperienceVersionRestoreRequestOpts(requestParameters) {
|
|
322
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
323
|
+
if (requestParameters['versionId'] == null) {
|
|
324
|
+
throw new runtime.RequiredError('versionId', 'Required parameter "versionId" was null or undefined when calling postLearnerExperienceVersionRestore().');
|
|
325
|
+
}
|
|
326
|
+
const queryParameters = {};
|
|
327
|
+
const headerParameters = {};
|
|
328
|
+
let urlPath = `/learner-experience/versions/{versionId}/restore`;
|
|
329
|
+
urlPath = urlPath.replace('{versionId}', encodeURIComponent(String(requestParameters['versionId'])));
|
|
330
|
+
return {
|
|
331
|
+
path: urlPath,
|
|
332
|
+
method: 'POST',
|
|
333
|
+
headers: headerParameters,
|
|
334
|
+
query: queryParameters,
|
|
335
|
+
};
|
|
336
|
+
});
|
|
337
|
+
}
|
|
338
|
+
/**
|
|
339
|
+
* Create a new draft from a historical learner experience version
|
|
340
|
+
*/
|
|
341
|
+
postLearnerExperienceVersionRestoreRaw(requestParameters, initOverrides) {
|
|
342
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
343
|
+
const requestOptions = yield this.postLearnerExperienceVersionRestoreRequestOpts(requestParameters);
|
|
344
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
345
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => LearnerExperienceVersionFromJSON(jsonValue));
|
|
346
|
+
});
|
|
347
|
+
}
|
|
348
|
+
/**
|
|
349
|
+
* Create a new draft from a historical learner experience version
|
|
350
|
+
*/
|
|
351
|
+
postLearnerExperienceVersionRestore(requestParameters, initOverrides) {
|
|
352
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
353
|
+
const response = yield this.postLearnerExperienceVersionRestoreRaw(requestParameters, initOverrides);
|
|
354
|
+
return yield response.value();
|
|
355
|
+
});
|
|
356
|
+
}
|
|
357
|
+
/**
|
|
358
|
+
* Creates request options for putLearnerExperienceDraft without sending the request
|
|
359
|
+
*/
|
|
360
|
+
putLearnerExperienceDraftRequestOpts(requestParameters) {
|
|
361
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
362
|
+
if (requestParameters['putLearnerExperienceDraft'] == null) {
|
|
363
|
+
throw new runtime.RequiredError('putLearnerExperienceDraft', 'Required parameter "putLearnerExperienceDraft" was null or undefined when calling putLearnerExperienceDraft().');
|
|
364
|
+
}
|
|
365
|
+
const queryParameters = {};
|
|
366
|
+
const headerParameters = {};
|
|
367
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
368
|
+
let urlPath = `/learner-experience/draft`;
|
|
369
|
+
return {
|
|
370
|
+
path: urlPath,
|
|
371
|
+
method: 'PUT',
|
|
372
|
+
headers: headerParameters,
|
|
373
|
+
query: queryParameters,
|
|
374
|
+
body: PutLearnerExperienceDraftToJSON(requestParameters['putLearnerExperienceDraft']),
|
|
375
|
+
};
|
|
376
|
+
});
|
|
377
|
+
}
|
|
378
|
+
/**
|
|
379
|
+
* Update the selected portal\'s learner experience draft
|
|
380
|
+
*/
|
|
381
|
+
putLearnerExperienceDraftRaw(requestParameters, initOverrides) {
|
|
382
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
383
|
+
const requestOptions = yield this.putLearnerExperienceDraftRequestOpts(requestParameters);
|
|
384
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
385
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => LearnerExperienceVersionFromJSON(jsonValue));
|
|
386
|
+
});
|
|
387
|
+
}
|
|
388
|
+
/**
|
|
389
|
+
* Update the selected portal\'s learner experience draft
|
|
390
|
+
*/
|
|
391
|
+
putLearnerExperienceDraft(requestParameters, initOverrides) {
|
|
392
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
393
|
+
const response = yield this.putLearnerExperienceDraftRaw(requestParameters, initOverrides);
|
|
394
|
+
return yield response.value();
|
|
395
|
+
});
|
|
396
|
+
}
|
|
397
|
+
}
|
package/dist/esm/apis/index.d.ts
CHANGED
|
@@ -9,6 +9,7 @@ export * from './CourseCatalogApi';
|
|
|
9
9
|
export * from './CourseShareApi';
|
|
10
10
|
export * from './DispatchApi';
|
|
11
11
|
export * from './EmailTemplateApi';
|
|
12
|
+
export * from './LearnerExperienceApi';
|
|
12
13
|
export * from './OtherApi';
|
|
13
14
|
export * from './PlayerApi';
|
|
14
15
|
export * from './PortalApi';
|
package/dist/esm/apis/index.js
CHANGED
|
@@ -11,6 +11,7 @@ export * from './CourseCatalogApi';
|
|
|
11
11
|
export * from './CourseShareApi';
|
|
12
12
|
export * from './DispatchApi';
|
|
13
13
|
export * from './EmailTemplateApi';
|
|
14
|
+
export * from './LearnerExperienceApi';
|
|
14
15
|
export * from './OtherApi';
|
|
15
16
|
export * from './PlayerApi';
|
|
16
17
|
export * from './PortalApi';
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* LMS API
|
|
3
|
+
* LMS API
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface GetEffectiveLearnerExperience
|
|
16
|
+
*/
|
|
17
|
+
export interface GetEffectiveLearnerExperience {
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @type {GetEffectiveLearnerExperienceEffectiveSourceEnum}
|
|
21
|
+
* @memberof GetEffectiveLearnerExperience
|
|
22
|
+
*/
|
|
23
|
+
effectiveSource: GetEffectiveLearnerExperienceEffectiveSourceEnum;
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof GetEffectiveLearnerExperience
|
|
28
|
+
*/
|
|
29
|
+
effectiveSourcePortalId?: string | null;
|
|
30
|
+
/**
|
|
31
|
+
*
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof GetEffectiveLearnerExperience
|
|
34
|
+
*/
|
|
35
|
+
versionId: string;
|
|
36
|
+
/**
|
|
37
|
+
*
|
|
38
|
+
* @type {{ [key: string]: any; }}
|
|
39
|
+
* @memberof GetEffectiveLearnerExperience
|
|
40
|
+
*/
|
|
41
|
+
designDocument: {
|
|
42
|
+
[key: string]: any;
|
|
43
|
+
};
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
* @export
|
|
47
|
+
*/
|
|
48
|
+
export declare const GetEffectiveLearnerExperienceEffectiveSourceEnum: {
|
|
49
|
+
readonly Portal: "portal";
|
|
50
|
+
readonly Ancestor: "ancestor";
|
|
51
|
+
readonly Platform: "platform";
|
|
52
|
+
readonly System: "system";
|
|
53
|
+
};
|
|
54
|
+
export type GetEffectiveLearnerExperienceEffectiveSourceEnum = typeof GetEffectiveLearnerExperienceEffectiveSourceEnum[keyof typeof GetEffectiveLearnerExperienceEffectiveSourceEnum];
|
|
55
|
+
/**
|
|
56
|
+
* Check if a given object implements the GetEffectiveLearnerExperience interface.
|
|
57
|
+
*/
|
|
58
|
+
export declare function instanceOfGetEffectiveLearnerExperience(value: object): value is GetEffectiveLearnerExperience;
|
|
59
|
+
export declare function GetEffectiveLearnerExperienceFromJSON(json: any): GetEffectiveLearnerExperience;
|
|
60
|
+
export declare function GetEffectiveLearnerExperienceFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetEffectiveLearnerExperience;
|
|
61
|
+
export declare function GetEffectiveLearnerExperienceToJSON(json: any): GetEffectiveLearnerExperience;
|
|
62
|
+
export declare function GetEffectiveLearnerExperienceToJSONTyped(value?: GetEffectiveLearnerExperience | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* LMS API
|
|
5
|
+
* LMS API
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
/**
|
|
15
|
+
* @export
|
|
16
|
+
*/
|
|
17
|
+
export const GetEffectiveLearnerExperienceEffectiveSourceEnum = {
|
|
18
|
+
Portal: 'portal',
|
|
19
|
+
Ancestor: 'ancestor',
|
|
20
|
+
Platform: 'platform',
|
|
21
|
+
System: 'system'
|
|
22
|
+
};
|
|
23
|
+
/**
|
|
24
|
+
* Check if a given object implements the GetEffectiveLearnerExperience interface.
|
|
25
|
+
*/
|
|
26
|
+
export function instanceOfGetEffectiveLearnerExperience(value) {
|
|
27
|
+
if (!('effectiveSource' in value) || value['effectiveSource'] === undefined)
|
|
28
|
+
return false;
|
|
29
|
+
if (!('versionId' in value) || value['versionId'] === undefined)
|
|
30
|
+
return false;
|
|
31
|
+
if (!('designDocument' in value) || value['designDocument'] === undefined)
|
|
32
|
+
return false;
|
|
33
|
+
return true;
|
|
34
|
+
}
|
|
35
|
+
export function GetEffectiveLearnerExperienceFromJSON(json) {
|
|
36
|
+
return GetEffectiveLearnerExperienceFromJSONTyped(json, false);
|
|
37
|
+
}
|
|
38
|
+
export function GetEffectiveLearnerExperienceFromJSONTyped(json, ignoreDiscriminator) {
|
|
39
|
+
if (json == null) {
|
|
40
|
+
return json;
|
|
41
|
+
}
|
|
42
|
+
return {
|
|
43
|
+
'effectiveSource': json['effective_source'],
|
|
44
|
+
'effectiveSourcePortalId': json['effective_source_portal_id'] == null ? undefined : json['effective_source_portal_id'],
|
|
45
|
+
'versionId': json['version_id'],
|
|
46
|
+
'designDocument': json['design_document'],
|
|
47
|
+
};
|
|
48
|
+
}
|
|
49
|
+
export function GetEffectiveLearnerExperienceToJSON(json) {
|
|
50
|
+
return GetEffectiveLearnerExperienceToJSONTyped(json, false);
|
|
51
|
+
}
|
|
52
|
+
export function GetEffectiveLearnerExperienceToJSONTyped(value, ignoreDiscriminator = false) {
|
|
53
|
+
if (value == null) {
|
|
54
|
+
return value;
|
|
55
|
+
}
|
|
56
|
+
return {
|
|
57
|
+
'effective_source': value['effectiveSource'],
|
|
58
|
+
'effective_source_portal_id': value['effectiveSourcePortalId'],
|
|
59
|
+
'version_id': value['versionId'],
|
|
60
|
+
'design_document': value['designDocument'],
|
|
61
|
+
};
|
|
62
|
+
}
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* LMS API
|
|
3
|
+
* LMS API
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { GetLearnerDashboardCourseList } from './GetLearnerDashboardCourseList';
|
|
13
|
+
import type { GetEffectiveLearnerExperience } from './GetEffectiveLearnerExperience';
|
|
14
|
+
import type { GetLearnerDashboardSummary } from './GetLearnerDashboardSummary';
|
|
15
|
+
/**
|
|
16
|
+
*
|
|
17
|
+
* @export
|
|
18
|
+
* @interface GetLearnerDashboard
|
|
19
|
+
*/
|
|
20
|
+
export interface GetLearnerDashboard {
|
|
21
|
+
/**
|
|
22
|
+
*
|
|
23
|
+
* @type {GetEffectiveLearnerExperience}
|
|
24
|
+
* @memberof GetLearnerDashboard
|
|
25
|
+
*/
|
|
26
|
+
experience: GetEffectiveLearnerExperience;
|
|
27
|
+
/**
|
|
28
|
+
*
|
|
29
|
+
* @type {GetLearnerDashboardSummary}
|
|
30
|
+
* @memberof GetLearnerDashboard
|
|
31
|
+
*/
|
|
32
|
+
summary: GetLearnerDashboardSummary;
|
|
33
|
+
/**
|
|
34
|
+
*
|
|
35
|
+
* @type {Array<GetLearnerDashboardCourseList>}
|
|
36
|
+
* @memberof GetLearnerDashboard
|
|
37
|
+
*/
|
|
38
|
+
courseLists: Array<GetLearnerDashboardCourseList>;
|
|
39
|
+
}
|
|
40
|
+
/**
|
|
41
|
+
* Check if a given object implements the GetLearnerDashboard interface.
|
|
42
|
+
*/
|
|
43
|
+
export declare function instanceOfGetLearnerDashboard(value: object): value is GetLearnerDashboard;
|
|
44
|
+
export declare function GetLearnerDashboardFromJSON(json: any): GetLearnerDashboard;
|
|
45
|
+
export declare function GetLearnerDashboardFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetLearnerDashboard;
|
|
46
|
+
export declare function GetLearnerDashboardToJSON(json: any): GetLearnerDashboard;
|
|
47
|
+
export declare function GetLearnerDashboardToJSONTyped(value?: GetLearnerDashboard | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* LMS API
|
|
5
|
+
* LMS API
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
import { GetLearnerDashboardCourseListFromJSON, GetLearnerDashboardCourseListToJSON, } from './GetLearnerDashboardCourseList';
|
|
15
|
+
import { GetEffectiveLearnerExperienceFromJSON, GetEffectiveLearnerExperienceToJSON, } from './GetEffectiveLearnerExperience';
|
|
16
|
+
import { GetLearnerDashboardSummaryFromJSON, GetLearnerDashboardSummaryToJSON, } from './GetLearnerDashboardSummary';
|
|
17
|
+
/**
|
|
18
|
+
* Check if a given object implements the GetLearnerDashboard interface.
|
|
19
|
+
*/
|
|
20
|
+
export function instanceOfGetLearnerDashboard(value) {
|
|
21
|
+
if (!('experience' in value) || value['experience'] === undefined)
|
|
22
|
+
return false;
|
|
23
|
+
if (!('summary' in value) || value['summary'] === undefined)
|
|
24
|
+
return false;
|
|
25
|
+
if (!('courseLists' in value) || value['courseLists'] === undefined)
|
|
26
|
+
return false;
|
|
27
|
+
return true;
|
|
28
|
+
}
|
|
29
|
+
export function GetLearnerDashboardFromJSON(json) {
|
|
30
|
+
return GetLearnerDashboardFromJSONTyped(json, false);
|
|
31
|
+
}
|
|
32
|
+
export function GetLearnerDashboardFromJSONTyped(json, ignoreDiscriminator) {
|
|
33
|
+
if (json == null) {
|
|
34
|
+
return json;
|
|
35
|
+
}
|
|
36
|
+
return {
|
|
37
|
+
'experience': GetEffectiveLearnerExperienceFromJSON(json['experience']),
|
|
38
|
+
'summary': GetLearnerDashboardSummaryFromJSON(json['summary']),
|
|
39
|
+
'courseLists': (json['course_lists'].map(GetLearnerDashboardCourseListFromJSON)),
|
|
40
|
+
};
|
|
41
|
+
}
|
|
42
|
+
export function GetLearnerDashboardToJSON(json) {
|
|
43
|
+
return GetLearnerDashboardToJSONTyped(json, false);
|
|
44
|
+
}
|
|
45
|
+
export function GetLearnerDashboardToJSONTyped(value, ignoreDiscriminator = false) {
|
|
46
|
+
if (value == null) {
|
|
47
|
+
return value;
|
|
48
|
+
}
|
|
49
|
+
return {
|
|
50
|
+
'experience': GetEffectiveLearnerExperienceToJSON(value['experience']),
|
|
51
|
+
'summary': GetLearnerDashboardSummaryToJSON(value['summary']),
|
|
52
|
+
'course_lists': (value['courseLists'].map(GetLearnerDashboardCourseListToJSON)),
|
|
53
|
+
};
|
|
54
|
+
}
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* LMS API
|
|
3
|
+
* LMS API
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { GetUserCourseListItem } from './GetUserCourseListItem';
|
|
13
|
+
/**
|
|
14
|
+
*
|
|
15
|
+
* @export
|
|
16
|
+
* @interface GetLearnerDashboardCourseList
|
|
17
|
+
*/
|
|
18
|
+
export interface GetLearnerDashboardCourseList {
|
|
19
|
+
/**
|
|
20
|
+
*
|
|
21
|
+
* @type {string}
|
|
22
|
+
* @memberof GetLearnerDashboardCourseList
|
|
23
|
+
*/
|
|
24
|
+
blockId: string;
|
|
25
|
+
/**
|
|
26
|
+
*
|
|
27
|
+
* @type {Array<GetUserCourseListItem>}
|
|
28
|
+
* @memberof GetLearnerDashboardCourseList
|
|
29
|
+
*/
|
|
30
|
+
items: Array<GetUserCourseListItem>;
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* Check if a given object implements the GetLearnerDashboardCourseList interface.
|
|
34
|
+
*/
|
|
35
|
+
export declare function instanceOfGetLearnerDashboardCourseList(value: object): value is GetLearnerDashboardCourseList;
|
|
36
|
+
export declare function GetLearnerDashboardCourseListFromJSON(json: any): GetLearnerDashboardCourseList;
|
|
37
|
+
export declare function GetLearnerDashboardCourseListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetLearnerDashboardCourseList;
|
|
38
|
+
export declare function GetLearnerDashboardCourseListToJSON(json: any): GetLearnerDashboardCourseList;
|
|
39
|
+
export declare function GetLearnerDashboardCourseListToJSONTyped(value?: GetLearnerDashboardCourseList | null, ignoreDiscriminator?: boolean): any;
|