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