@easyedu/js-lsm-api 1.25.0 → 1.27.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 +11 -0
- package/README.md +2 -2
- package/dist/apis/ContentApi.d.ts +64 -1
- package/dist/apis/ContentApi.js +155 -0
- package/dist/apis/CourseApi.d.ts +40 -1
- package/dist/apis/CourseApi.js +100 -0
- package/dist/esm/apis/ContentApi.d.ts +64 -1
- package/dist/esm/apis/ContentApi.js +156 -1
- package/dist/esm/apis/CourseApi.d.ts +40 -1
- package/dist/esm/apis/CourseApi.js +101 -1
- package/dist/esm/models/GetContentVersion.d.ts +76 -0
- package/dist/esm/models/GetContentVersion.js +71 -0
- package/dist/esm/models/GetContentVersionList.d.ts +57 -0
- package/dist/esm/models/GetContentVersionList.js +60 -0
- package/dist/esm/models/GetContentVersionListItemsInner.d.ts +56 -0
- package/dist/esm/models/GetContentVersionListItemsInner.js +59 -0
- package/dist/esm/models/GetContentVersionSandbox.d.ts +32 -0
- package/dist/esm/models/GetContentVersionSandbox.js +43 -0
- package/dist/esm/models/GetContentVersionScormData.d.ts +32 -0
- package/dist/esm/models/GetContentVersionScormData.js +43 -0
- package/dist/esm/models/GetCourseExport.d.ts +93 -0
- package/dist/esm/models/GetCourseExport.js +82 -0
- package/dist/esm/models/GetCourseExportList.d.ts +57 -0
- package/dist/esm/models/GetCourseExportList.js +60 -0
- package/dist/esm/models/GetScormPackage.d.ts +39 -0
- package/dist/esm/models/GetScormPackage.js +48 -0
- package/dist/esm/models/GetScormPackagePackageInfo.d.ts +104 -0
- package/dist/esm/models/GetScormPackagePackageInfo.js +81 -0
- package/dist/esm/models/PostCourseExport.d.ts +41 -0
- package/dist/esm/models/PostCourseExport.js +51 -0
- package/dist/esm/models/PutContentVersion.d.ts +32 -0
- package/dist/esm/models/PutContentVersion.js +43 -0
- package/dist/esm/models/index.d.ts +11 -0
- package/dist/esm/models/index.js +11 -0
- package/dist/models/GetContentVersion.d.ts +76 -0
- package/dist/models/GetContentVersion.js +78 -0
- package/dist/models/GetContentVersionList.d.ts +57 -0
- package/dist/models/GetContentVersionList.js +67 -0
- package/dist/models/GetContentVersionListItemsInner.d.ts +56 -0
- package/dist/models/GetContentVersionListItemsInner.js +66 -0
- package/dist/models/GetContentVersionSandbox.d.ts +32 -0
- package/dist/models/GetContentVersionSandbox.js +50 -0
- package/dist/models/GetContentVersionScormData.d.ts +32 -0
- package/dist/models/GetContentVersionScormData.js +50 -0
- package/dist/models/GetCourseExport.d.ts +93 -0
- package/dist/models/GetCourseExport.js +90 -0
- package/dist/models/GetCourseExportList.d.ts +57 -0
- package/dist/models/GetCourseExportList.js +67 -0
- package/dist/models/GetScormPackage.d.ts +39 -0
- package/dist/models/GetScormPackage.js +55 -0
- package/dist/models/GetScormPackagePackageInfo.d.ts +104 -0
- package/dist/models/GetScormPackagePackageInfo.js +88 -0
- package/dist/models/PostCourseExport.d.ts +41 -0
- package/dist/models/PostCourseExport.js +59 -0
- package/dist/models/PutContentVersion.d.ts +32 -0
- package/dist/models/PutContentVersion.js +50 -0
- package/dist/models/index.d.ts +11 -0
- package/dist/models/index.js +11 -0
- package/package.json +1 -1
- package/src/apis/ContentApi.ts +253 -0
- package/src/apis/CourseApi.ts +151 -0
- package/src/models/GetContentVersion.ts +143 -0
- package/src/models/GetContentVersionList.ts +110 -0
- package/src/models/GetContentVersionListItemsInner.ts +102 -0
- package/src/models/GetContentVersionSandbox.ts +66 -0
- package/src/models/GetContentVersionScormData.ts +66 -0
- package/src/models/GetCourseExport.ts +149 -0
- package/src/models/GetCourseExportList.ts +110 -0
- package/src/models/GetScormPackage.ts +83 -0
- package/src/models/GetScormPackagePackageInfo.ts +169 -0
- package/src/models/PostCourseExport.ts +78 -0
- package/src/models/PutContentVersion.ts +66 -0
- package/src/models/index.ts +11 -0
|
@@ -21,7 +21,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
21
21
|
});
|
|
22
22
|
};
|
|
23
23
|
import * as runtime from '../runtime';
|
|
24
|
-
import { GetContentFromJSON, GetContentListFromJSON, GetContentSessionFromJSON, GetContentUploadFromJSON, PostContentQuizToJSON, PostContentSessionFromJSON, PostContentUploadToJSON, PutContentToJSON, } from '../models/index';
|
|
24
|
+
import { GetContentFromJSON, GetContentListFromJSON, GetContentSessionFromJSON, GetContentUploadFromJSON, GetContentVersionFromJSON, GetContentVersionListFromJSON, GetScormPackageFromJSON, PostContentQuizToJSON, PostContentSessionFromJSON, PostContentUploadToJSON, PutContentToJSON, PutContentVersionToJSON, } from '../models/index';
|
|
25
25
|
/**
|
|
26
26
|
*
|
|
27
27
|
*/
|
|
@@ -125,6 +125,117 @@ export class ContentApi extends runtime.BaseAPI {
|
|
|
125
125
|
return yield response.value();
|
|
126
126
|
});
|
|
127
127
|
}
|
|
128
|
+
/**
|
|
129
|
+
* Returns detailed information about a specific version of the content, including sandbox launch URL and SCORM-specific data (package info and table of contents) if applicable.
|
|
130
|
+
* Get details of a specific content version
|
|
131
|
+
*/
|
|
132
|
+
getContentVersionRaw(requestParameters, initOverrides) {
|
|
133
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
134
|
+
if (requestParameters['contentId'] == null) {
|
|
135
|
+
throw new runtime.RequiredError('contentId', 'Required parameter "contentId" was null or undefined when calling getContentVersion().');
|
|
136
|
+
}
|
|
137
|
+
if (requestParameters['moduleId'] == null) {
|
|
138
|
+
throw new runtime.RequiredError('moduleId', 'Required parameter "moduleId" was null or undefined when calling getContentVersion().');
|
|
139
|
+
}
|
|
140
|
+
if (requestParameters['courseId'] == null) {
|
|
141
|
+
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getContentVersion().');
|
|
142
|
+
}
|
|
143
|
+
if (requestParameters['versionId'] == null) {
|
|
144
|
+
throw new runtime.RequiredError('versionId', 'Required parameter "versionId" was null or undefined when calling getContentVersion().');
|
|
145
|
+
}
|
|
146
|
+
const queryParameters = {};
|
|
147
|
+
const headerParameters = {};
|
|
148
|
+
const response = yield this.request({
|
|
149
|
+
path: `/courses/{courseId}/modules/{moduleId}/contents/{contentId}/versions/{versionId}`.replace(`{${"contentId"}}`, encodeURIComponent(String(requestParameters['contentId']))).replace(`{${"moduleId"}}`, encodeURIComponent(String(requestParameters['moduleId']))).replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))).replace(`{${"versionId"}}`, encodeURIComponent(String(requestParameters['versionId']))),
|
|
150
|
+
method: 'GET',
|
|
151
|
+
headers: headerParameters,
|
|
152
|
+
query: queryParameters,
|
|
153
|
+
}, initOverrides);
|
|
154
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetContentVersionFromJSON(jsonValue));
|
|
155
|
+
});
|
|
156
|
+
}
|
|
157
|
+
/**
|
|
158
|
+
* Returns detailed information about a specific version of the content, including sandbox launch URL and SCORM-specific data (package info and table of contents) if applicable.
|
|
159
|
+
* Get details of a specific content version
|
|
160
|
+
*/
|
|
161
|
+
getContentVersion(requestParameters, initOverrides) {
|
|
162
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
163
|
+
const response = yield this.getContentVersionRaw(requestParameters, initOverrides);
|
|
164
|
+
return yield response.value();
|
|
165
|
+
});
|
|
166
|
+
}
|
|
167
|
+
/**
|
|
168
|
+
* Returns a paginated list of all versions for the specified content. Returns an empty array if the content has no versions.
|
|
169
|
+
* Get all versions of a content
|
|
170
|
+
*/
|
|
171
|
+
getContentVersionListRaw(requestParameters, initOverrides) {
|
|
172
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
173
|
+
if (requestParameters['contentId'] == null) {
|
|
174
|
+
throw new runtime.RequiredError('contentId', 'Required parameter "contentId" was null or undefined when calling getContentVersionList().');
|
|
175
|
+
}
|
|
176
|
+
if (requestParameters['moduleId'] == null) {
|
|
177
|
+
throw new runtime.RequiredError('moduleId', 'Required parameter "moduleId" was null or undefined when calling getContentVersionList().');
|
|
178
|
+
}
|
|
179
|
+
if (requestParameters['courseId'] == null) {
|
|
180
|
+
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getContentVersionList().');
|
|
181
|
+
}
|
|
182
|
+
const queryParameters = {};
|
|
183
|
+
if (requestParameters['page'] != null) {
|
|
184
|
+
queryParameters['page'] = requestParameters['page'];
|
|
185
|
+
}
|
|
186
|
+
if (requestParameters['pageSize'] != null) {
|
|
187
|
+
queryParameters['page_size'] = requestParameters['pageSize'];
|
|
188
|
+
}
|
|
189
|
+
const headerParameters = {};
|
|
190
|
+
const response = yield this.request({
|
|
191
|
+
path: `/courses/{courseId}/modules/{moduleId}/contents/{contentId}/versions`.replace(`{${"contentId"}}`, encodeURIComponent(String(requestParameters['contentId']))).replace(`{${"moduleId"}}`, encodeURIComponent(String(requestParameters['moduleId']))).replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))),
|
|
192
|
+
method: 'GET',
|
|
193
|
+
headers: headerParameters,
|
|
194
|
+
query: queryParameters,
|
|
195
|
+
}, initOverrides);
|
|
196
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetContentVersionListFromJSON(jsonValue));
|
|
197
|
+
});
|
|
198
|
+
}
|
|
199
|
+
/**
|
|
200
|
+
* Returns a paginated list of all versions for the specified content. Returns an empty array if the content has no versions.
|
|
201
|
+
* Get all versions of a content
|
|
202
|
+
*/
|
|
203
|
+
getContentVersionList(requestParameters, initOverrides) {
|
|
204
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
205
|
+
const response = yield this.getContentVersionListRaw(requestParameters, initOverrides);
|
|
206
|
+
return yield response.value();
|
|
207
|
+
});
|
|
208
|
+
}
|
|
209
|
+
/**
|
|
210
|
+
* Returns package information and table of contents for a SCORM package
|
|
211
|
+
* Get details of a SCORM package
|
|
212
|
+
*/
|
|
213
|
+
getScormPackageRaw(requestParameters, initOverrides) {
|
|
214
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
215
|
+
if (requestParameters['packageId'] == null) {
|
|
216
|
+
throw new runtime.RequiredError('packageId', 'Required parameter "packageId" was null or undefined when calling getScormPackage().');
|
|
217
|
+
}
|
|
218
|
+
const queryParameters = {};
|
|
219
|
+
const headerParameters = {};
|
|
220
|
+
const response = yield this.request({
|
|
221
|
+
path: `/scorm/packages/{packageId}`.replace(`{${"packageId"}}`, encodeURIComponent(String(requestParameters['packageId']))),
|
|
222
|
+
method: 'GET',
|
|
223
|
+
headers: headerParameters,
|
|
224
|
+
query: queryParameters,
|
|
225
|
+
}, initOverrides);
|
|
226
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetScormPackageFromJSON(jsonValue));
|
|
227
|
+
});
|
|
228
|
+
}
|
|
229
|
+
/**
|
|
230
|
+
* Returns package information and table of contents for a SCORM package
|
|
231
|
+
* Get details of a SCORM package
|
|
232
|
+
*/
|
|
233
|
+
getScormPackage(requestParameters, initOverrides) {
|
|
234
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
235
|
+
const response = yield this.getScormPackageRaw(requestParameters, initOverrides);
|
|
236
|
+
return yield response.value();
|
|
237
|
+
});
|
|
238
|
+
}
|
|
128
239
|
/**
|
|
129
240
|
* Post a new content process
|
|
130
241
|
*/
|
|
@@ -306,4 +417,48 @@ export class ContentApi extends runtime.BaseAPI {
|
|
|
306
417
|
return yield response.value();
|
|
307
418
|
});
|
|
308
419
|
}
|
|
420
|
+
/**
|
|
421
|
+
* Activates this version by setting is_active to true. Automatically deactivates all other versions of the same content. Only setting is_active to true is allowed.
|
|
422
|
+
* Update a content version
|
|
423
|
+
*/
|
|
424
|
+
putContentVersionRaw(requestParameters, initOverrides) {
|
|
425
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
426
|
+
if (requestParameters['contentId'] == null) {
|
|
427
|
+
throw new runtime.RequiredError('contentId', 'Required parameter "contentId" was null or undefined when calling putContentVersion().');
|
|
428
|
+
}
|
|
429
|
+
if (requestParameters['moduleId'] == null) {
|
|
430
|
+
throw new runtime.RequiredError('moduleId', 'Required parameter "moduleId" was null or undefined when calling putContentVersion().');
|
|
431
|
+
}
|
|
432
|
+
if (requestParameters['courseId'] == null) {
|
|
433
|
+
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling putContentVersion().');
|
|
434
|
+
}
|
|
435
|
+
if (requestParameters['versionId'] == null) {
|
|
436
|
+
throw new runtime.RequiredError('versionId', 'Required parameter "versionId" was null or undefined when calling putContentVersion().');
|
|
437
|
+
}
|
|
438
|
+
if (requestParameters['putContentVersion'] == null) {
|
|
439
|
+
throw new runtime.RequiredError('putContentVersion', 'Required parameter "putContentVersion" was null or undefined when calling putContentVersion().');
|
|
440
|
+
}
|
|
441
|
+
const queryParameters = {};
|
|
442
|
+
const headerParameters = {};
|
|
443
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
444
|
+
const response = yield this.request({
|
|
445
|
+
path: `/courses/{courseId}/modules/{moduleId}/contents/{contentId}/versions/{versionId}`.replace(`{${"contentId"}}`, encodeURIComponent(String(requestParameters['contentId']))).replace(`{${"moduleId"}}`, encodeURIComponent(String(requestParameters['moduleId']))).replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))).replace(`{${"versionId"}}`, encodeURIComponent(String(requestParameters['versionId']))),
|
|
446
|
+
method: 'PUT',
|
|
447
|
+
headers: headerParameters,
|
|
448
|
+
query: queryParameters,
|
|
449
|
+
body: PutContentVersionToJSON(requestParameters['putContentVersion']),
|
|
450
|
+
}, initOverrides);
|
|
451
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetContentVersionFromJSON(jsonValue));
|
|
452
|
+
});
|
|
453
|
+
}
|
|
454
|
+
/**
|
|
455
|
+
* Activates this version by setting is_active to true. Automatically deactivates all other versions of the same content. Only setting is_active to true is allowed.
|
|
456
|
+
* Update a content version
|
|
457
|
+
*/
|
|
458
|
+
putContentVersion(requestParameters, initOverrides) {
|
|
459
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
460
|
+
const response = yield this.putContentVersionRaw(requestParameters, initOverrides);
|
|
461
|
+
return yield response.value();
|
|
462
|
+
});
|
|
463
|
+
}
|
|
309
464
|
}
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import type { GetCourse, GetCourseEnrollment, GetCourseEnrollmentList, GetCourseList, GetCourseReportingBasic, PostCourse, PostCourseEnrollment, PutCourse, PutCourseEnrollment } from '../models/index';
|
|
13
|
+
import type { GetCourse, GetCourseEnrollment, GetCourseEnrollmentList, GetCourseExport, GetCourseExportList, GetCourseList, GetCourseReportingBasic, PostCourse, PostCourseEnrollment, PostCourseExport, PutCourse, PutCourseEnrollment } from '../models/index';
|
|
14
14
|
export interface GetCourseRequest {
|
|
15
15
|
courseId: string;
|
|
16
16
|
}
|
|
@@ -24,6 +24,15 @@ export interface GetCourseEnrollmentsRequest {
|
|
|
24
24
|
page?: number;
|
|
25
25
|
pageSize?: number;
|
|
26
26
|
}
|
|
27
|
+
export interface GetCourseExportRequest {
|
|
28
|
+
courseId: string;
|
|
29
|
+
exportId: string;
|
|
30
|
+
}
|
|
31
|
+
export interface GetCourseExportsRequest {
|
|
32
|
+
courseId: string;
|
|
33
|
+
page?: number;
|
|
34
|
+
pageSize?: number;
|
|
35
|
+
}
|
|
27
36
|
export interface GetCourseListRequest {
|
|
28
37
|
enrolled?: boolean;
|
|
29
38
|
}
|
|
@@ -37,6 +46,10 @@ export interface PostCourseEnrollmentRequest {
|
|
|
37
46
|
courseId: string;
|
|
38
47
|
postCourseEnrollment: PostCourseEnrollment;
|
|
39
48
|
}
|
|
49
|
+
export interface PostCourseExportRequest {
|
|
50
|
+
courseId: string;
|
|
51
|
+
postCourseExport: PostCourseExport;
|
|
52
|
+
}
|
|
40
53
|
export interface PutCourseRequest {
|
|
41
54
|
courseId: string;
|
|
42
55
|
putCourse: Omit<PutCourse, 'id'>;
|
|
@@ -74,6 +87,22 @@ export declare class CourseApi extends runtime.BaseAPI {
|
|
|
74
87
|
* Get course enrollments
|
|
75
88
|
*/
|
|
76
89
|
getCourseEnrollments(requestParameters: GetCourseEnrollmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseEnrollmentList>;
|
|
90
|
+
/**
|
|
91
|
+
* Get details of a specific SCORM export
|
|
92
|
+
*/
|
|
93
|
+
getCourseExportRaw(requestParameters: GetCourseExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseExport>>;
|
|
94
|
+
/**
|
|
95
|
+
* Get details of a specific SCORM export
|
|
96
|
+
*/
|
|
97
|
+
getCourseExport(requestParameters: GetCourseExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseExport>;
|
|
98
|
+
/**
|
|
99
|
+
* List all SCORM exports for a course
|
|
100
|
+
*/
|
|
101
|
+
getCourseExportsRaw(requestParameters: GetCourseExportsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseExportList>>;
|
|
102
|
+
/**
|
|
103
|
+
* List all SCORM exports for a course
|
|
104
|
+
*/
|
|
105
|
+
getCourseExports(requestParameters: GetCourseExportsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseExportList>;
|
|
77
106
|
/**
|
|
78
107
|
* get course list
|
|
79
108
|
*/
|
|
@@ -106,6 +135,16 @@ export declare class CourseApi extends runtime.BaseAPI {
|
|
|
106
135
|
* Create a new course enrollment
|
|
107
136
|
*/
|
|
108
137
|
postCourseEnrollment(requestParameters: PostCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseEnrollment>;
|
|
138
|
+
/**
|
|
139
|
+
* Enqueues a job to generate a SCORM export package for the course. Returns immediately with PENDING status. **NOTES:** - This endpoint enqueues a background job to generate the SCORM package - Actual SCORM package generation is not yet implemented (TODO) - Export metadata should be persisted to a database table (TODO) - Poll GET /courses/{courseId}/exports/{exportId} to check status - Download URL will be available when status becomes COMPLETED
|
|
140
|
+
* Create a new SCORM export for a course
|
|
141
|
+
*/
|
|
142
|
+
postCourseExportRaw(requestParameters: PostCourseExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseExport>>;
|
|
143
|
+
/**
|
|
144
|
+
* Enqueues a job to generate a SCORM export package for the course. Returns immediately with PENDING status. **NOTES:** - This endpoint enqueues a background job to generate the SCORM package - Actual SCORM package generation is not yet implemented (TODO) - Export metadata should be persisted to a database table (TODO) - Poll GET /courses/{courseId}/exports/{exportId} to check status - Download URL will be available when status becomes COMPLETED
|
|
145
|
+
* Create a new SCORM export for a course
|
|
146
|
+
*/
|
|
147
|
+
postCourseExport(requestParameters: PostCourseExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseExport>;
|
|
109
148
|
/**
|
|
110
149
|
* Update a course by id
|
|
111
150
|
*/
|
|
@@ -21,7 +21,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
21
21
|
});
|
|
22
22
|
};
|
|
23
23
|
import * as runtime from '../runtime';
|
|
24
|
-
import { GetCourseFromJSON, GetCourseEnrollmentFromJSON, GetCourseEnrollmentListFromJSON, GetCourseListFromJSON, GetCourseReportingBasicFromJSON, PostCourseToJSON, PostCourseEnrollmentToJSON, PutCourseToJSON, PutCourseEnrollmentToJSON, } from '../models/index';
|
|
24
|
+
import { GetCourseFromJSON, GetCourseEnrollmentFromJSON, GetCourseEnrollmentListFromJSON, GetCourseExportFromJSON, GetCourseExportListFromJSON, GetCourseListFromJSON, GetCourseReportingBasicFromJSON, PostCourseToJSON, PostCourseEnrollmentToJSON, PostCourseExportToJSON, PutCourseToJSON, PutCourseEnrollmentToJSON, } from '../models/index';
|
|
25
25
|
/**
|
|
26
26
|
*
|
|
27
27
|
*/
|
|
@@ -122,6 +122,71 @@ export class CourseApi extends runtime.BaseAPI {
|
|
|
122
122
|
return yield response.value();
|
|
123
123
|
});
|
|
124
124
|
}
|
|
125
|
+
/**
|
|
126
|
+
* Get details of a specific SCORM export
|
|
127
|
+
*/
|
|
128
|
+
getCourseExportRaw(requestParameters, initOverrides) {
|
|
129
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
130
|
+
if (requestParameters['courseId'] == null) {
|
|
131
|
+
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getCourseExport().');
|
|
132
|
+
}
|
|
133
|
+
if (requestParameters['exportId'] == null) {
|
|
134
|
+
throw new runtime.RequiredError('exportId', 'Required parameter "exportId" was null or undefined when calling getCourseExport().');
|
|
135
|
+
}
|
|
136
|
+
const queryParameters = {};
|
|
137
|
+
const headerParameters = {};
|
|
138
|
+
const response = yield this.request({
|
|
139
|
+
path: `/courses/{courseId}/exports/{exportId}`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))).replace(`{${"exportId"}}`, encodeURIComponent(String(requestParameters['exportId']))),
|
|
140
|
+
method: 'GET',
|
|
141
|
+
headers: headerParameters,
|
|
142
|
+
query: queryParameters,
|
|
143
|
+
}, initOverrides);
|
|
144
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetCourseExportFromJSON(jsonValue));
|
|
145
|
+
});
|
|
146
|
+
}
|
|
147
|
+
/**
|
|
148
|
+
* Get details of a specific SCORM export
|
|
149
|
+
*/
|
|
150
|
+
getCourseExport(requestParameters, initOverrides) {
|
|
151
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
152
|
+
const response = yield this.getCourseExportRaw(requestParameters, initOverrides);
|
|
153
|
+
return yield response.value();
|
|
154
|
+
});
|
|
155
|
+
}
|
|
156
|
+
/**
|
|
157
|
+
* List all SCORM exports for a course
|
|
158
|
+
*/
|
|
159
|
+
getCourseExportsRaw(requestParameters, initOverrides) {
|
|
160
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
161
|
+
if (requestParameters['courseId'] == null) {
|
|
162
|
+
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getCourseExports().');
|
|
163
|
+
}
|
|
164
|
+
const queryParameters = {};
|
|
165
|
+
if (requestParameters['page'] != null) {
|
|
166
|
+
queryParameters['page'] = requestParameters['page'];
|
|
167
|
+
}
|
|
168
|
+
if (requestParameters['pageSize'] != null) {
|
|
169
|
+
queryParameters['page_size'] = requestParameters['pageSize'];
|
|
170
|
+
}
|
|
171
|
+
const headerParameters = {};
|
|
172
|
+
const response = yield this.request({
|
|
173
|
+
path: `/courses/{courseId}/exports`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))),
|
|
174
|
+
method: 'GET',
|
|
175
|
+
headers: headerParameters,
|
|
176
|
+
query: queryParameters,
|
|
177
|
+
}, initOverrides);
|
|
178
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetCourseExportListFromJSON(jsonValue));
|
|
179
|
+
});
|
|
180
|
+
}
|
|
181
|
+
/**
|
|
182
|
+
* List all SCORM exports for a course
|
|
183
|
+
*/
|
|
184
|
+
getCourseExports(requestParameters, initOverrides) {
|
|
185
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
186
|
+
const response = yield this.getCourseExportsRaw(requestParameters, initOverrides);
|
|
187
|
+
return yield response.value();
|
|
188
|
+
});
|
|
189
|
+
}
|
|
125
190
|
/**
|
|
126
191
|
* get course list
|
|
127
192
|
*/
|
|
@@ -241,6 +306,41 @@ export class CourseApi extends runtime.BaseAPI {
|
|
|
241
306
|
return yield response.value();
|
|
242
307
|
});
|
|
243
308
|
}
|
|
309
|
+
/**
|
|
310
|
+
* Enqueues a job to generate a SCORM export package for the course. Returns immediately with PENDING status. **NOTES:** - This endpoint enqueues a background job to generate the SCORM package - Actual SCORM package generation is not yet implemented (TODO) - Export metadata should be persisted to a database table (TODO) - Poll GET /courses/{courseId}/exports/{exportId} to check status - Download URL will be available when status becomes COMPLETED
|
|
311
|
+
* Create a new SCORM export for a course
|
|
312
|
+
*/
|
|
313
|
+
postCourseExportRaw(requestParameters, initOverrides) {
|
|
314
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
315
|
+
if (requestParameters['courseId'] == null) {
|
|
316
|
+
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling postCourseExport().');
|
|
317
|
+
}
|
|
318
|
+
if (requestParameters['postCourseExport'] == null) {
|
|
319
|
+
throw new runtime.RequiredError('postCourseExport', 'Required parameter "postCourseExport" was null or undefined when calling postCourseExport().');
|
|
320
|
+
}
|
|
321
|
+
const queryParameters = {};
|
|
322
|
+
const headerParameters = {};
|
|
323
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
324
|
+
const response = yield this.request({
|
|
325
|
+
path: `/courses/{courseId}/exports`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))),
|
|
326
|
+
method: 'POST',
|
|
327
|
+
headers: headerParameters,
|
|
328
|
+
query: queryParameters,
|
|
329
|
+
body: PostCourseExportToJSON(requestParameters['postCourseExport']),
|
|
330
|
+
}, initOverrides);
|
|
331
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetCourseExportFromJSON(jsonValue));
|
|
332
|
+
});
|
|
333
|
+
}
|
|
334
|
+
/**
|
|
335
|
+
* Enqueues a job to generate a SCORM export package for the course. Returns immediately with PENDING status. **NOTES:** - This endpoint enqueues a background job to generate the SCORM package - Actual SCORM package generation is not yet implemented (TODO) - Export metadata should be persisted to a database table (TODO) - Poll GET /courses/{courseId}/exports/{exportId} to check status - Download URL will be available when status becomes COMPLETED
|
|
336
|
+
* Create a new SCORM export for a course
|
|
337
|
+
*/
|
|
338
|
+
postCourseExport(requestParameters, initOverrides) {
|
|
339
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
340
|
+
const response = yield this.postCourseExportRaw(requestParameters, initOverrides);
|
|
341
|
+
return yield response.value();
|
|
342
|
+
});
|
|
343
|
+
}
|
|
244
344
|
/**
|
|
245
345
|
* Update a course by id
|
|
246
346
|
*/
|
|
@@ -0,0 +1,76 @@
|
|
|
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 { GetContentVersionSandbox } from './GetContentVersionSandbox';
|
|
13
|
+
import type { GetContentVersionScormData } from './GetContentVersionScormData';
|
|
14
|
+
/**
|
|
15
|
+
* Details of a specific content version
|
|
16
|
+
* @export
|
|
17
|
+
* @interface GetContentVersion
|
|
18
|
+
*/
|
|
19
|
+
export interface GetContentVersion {
|
|
20
|
+
/**
|
|
21
|
+
* The external_id (UUID) for this version
|
|
22
|
+
* @type {string}
|
|
23
|
+
* @memberof GetContentVersion
|
|
24
|
+
*/
|
|
25
|
+
id: string;
|
|
26
|
+
/**
|
|
27
|
+
* The content's external_id that this version belongs to
|
|
28
|
+
* @type {string}
|
|
29
|
+
* @memberof GetContentVersion
|
|
30
|
+
*/
|
|
31
|
+
contentId: string;
|
|
32
|
+
/**
|
|
33
|
+
* Version number
|
|
34
|
+
* @type {number}
|
|
35
|
+
* @memberof GetContentVersion
|
|
36
|
+
*/
|
|
37
|
+
version: number;
|
|
38
|
+
/**
|
|
39
|
+
* Whether this is the currently active version
|
|
40
|
+
* @type {boolean}
|
|
41
|
+
* @memberof GetContentVersion
|
|
42
|
+
*/
|
|
43
|
+
isActive: boolean;
|
|
44
|
+
/**
|
|
45
|
+
* When this version was created
|
|
46
|
+
* @type {Date}
|
|
47
|
+
* @memberof GetContentVersion
|
|
48
|
+
*/
|
|
49
|
+
createdAt: Date;
|
|
50
|
+
/**
|
|
51
|
+
* When this version was last updated
|
|
52
|
+
* @type {Date}
|
|
53
|
+
* @memberof GetContentVersion
|
|
54
|
+
*/
|
|
55
|
+
updatedAt: Date;
|
|
56
|
+
/**
|
|
57
|
+
*
|
|
58
|
+
* @type {GetContentVersionSandbox}
|
|
59
|
+
* @memberof GetContentVersion
|
|
60
|
+
*/
|
|
61
|
+
sandbox: GetContentVersionSandbox;
|
|
62
|
+
/**
|
|
63
|
+
*
|
|
64
|
+
* @type {GetContentVersionScormData}
|
|
65
|
+
* @memberof GetContentVersion
|
|
66
|
+
*/
|
|
67
|
+
scormData?: GetContentVersionScormData | null;
|
|
68
|
+
}
|
|
69
|
+
/**
|
|
70
|
+
* Check if a given object implements the GetContentVersion interface.
|
|
71
|
+
*/
|
|
72
|
+
export declare function instanceOfGetContentVersion(value: object): value is GetContentVersion;
|
|
73
|
+
export declare function GetContentVersionFromJSON(json: any): GetContentVersion;
|
|
74
|
+
export declare function GetContentVersionFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetContentVersion;
|
|
75
|
+
export declare function GetContentVersionToJSON(json: any): GetContentVersion;
|
|
76
|
+
export declare function GetContentVersionToJSONTyped(value?: GetContentVersion | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,71 @@
|
|
|
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 { GetContentVersionSandboxFromJSON, GetContentVersionSandboxToJSON, } from './GetContentVersionSandbox';
|
|
15
|
+
import { GetContentVersionScormDataFromJSON, GetContentVersionScormDataToJSON, } from './GetContentVersionScormData';
|
|
16
|
+
/**
|
|
17
|
+
* Check if a given object implements the GetContentVersion interface.
|
|
18
|
+
*/
|
|
19
|
+
export function instanceOfGetContentVersion(value) {
|
|
20
|
+
if (!('id' in value) || value['id'] === undefined)
|
|
21
|
+
return false;
|
|
22
|
+
if (!('contentId' in value) || value['contentId'] === undefined)
|
|
23
|
+
return false;
|
|
24
|
+
if (!('version' in value) || value['version'] === undefined)
|
|
25
|
+
return false;
|
|
26
|
+
if (!('isActive' in value) || value['isActive'] === undefined)
|
|
27
|
+
return false;
|
|
28
|
+
if (!('createdAt' in value) || value['createdAt'] === undefined)
|
|
29
|
+
return false;
|
|
30
|
+
if (!('updatedAt' in value) || value['updatedAt'] === undefined)
|
|
31
|
+
return false;
|
|
32
|
+
if (!('sandbox' in value) || value['sandbox'] === undefined)
|
|
33
|
+
return false;
|
|
34
|
+
return true;
|
|
35
|
+
}
|
|
36
|
+
export function GetContentVersionFromJSON(json) {
|
|
37
|
+
return GetContentVersionFromJSONTyped(json, false);
|
|
38
|
+
}
|
|
39
|
+
export function GetContentVersionFromJSONTyped(json, ignoreDiscriminator) {
|
|
40
|
+
if (json == null) {
|
|
41
|
+
return json;
|
|
42
|
+
}
|
|
43
|
+
return {
|
|
44
|
+
'id': json['id'],
|
|
45
|
+
'contentId': json['content_id'],
|
|
46
|
+
'version': json['version'],
|
|
47
|
+
'isActive': json['is_active'],
|
|
48
|
+
'createdAt': (new Date(json['created_at'])),
|
|
49
|
+
'updatedAt': (new Date(json['updated_at'])),
|
|
50
|
+
'sandbox': GetContentVersionSandboxFromJSON(json['sandbox']),
|
|
51
|
+
'scormData': json['scorm_data'] == null ? undefined : GetContentVersionScormDataFromJSON(json['scorm_data']),
|
|
52
|
+
};
|
|
53
|
+
}
|
|
54
|
+
export function GetContentVersionToJSON(json) {
|
|
55
|
+
return GetContentVersionToJSONTyped(json, false);
|
|
56
|
+
}
|
|
57
|
+
export function GetContentVersionToJSONTyped(value, ignoreDiscriminator = false) {
|
|
58
|
+
if (value == null) {
|
|
59
|
+
return value;
|
|
60
|
+
}
|
|
61
|
+
return {
|
|
62
|
+
'id': value['id'],
|
|
63
|
+
'content_id': value['contentId'],
|
|
64
|
+
'version': value['version'],
|
|
65
|
+
'is_active': value['isActive'],
|
|
66
|
+
'created_at': ((value['createdAt']).toISOString()),
|
|
67
|
+
'updated_at': ((value['updatedAt']).toISOString()),
|
|
68
|
+
'sandbox': GetContentVersionSandboxToJSON(value['sandbox']),
|
|
69
|
+
'scorm_data': GetContentVersionScormDataToJSON(value['scormData']),
|
|
70
|
+
};
|
|
71
|
+
}
|
|
@@ -0,0 +1,57 @@
|
|
|
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 { GetContentVersionListItemsInner } from './GetContentVersionListItemsInner';
|
|
13
|
+
/**
|
|
14
|
+
* A paginated list of content versions
|
|
15
|
+
* @export
|
|
16
|
+
* @interface GetContentVersionList
|
|
17
|
+
*/
|
|
18
|
+
export interface GetContentVersionList {
|
|
19
|
+
/**
|
|
20
|
+
* The current page number
|
|
21
|
+
* @type {number}
|
|
22
|
+
* @memberof GetContentVersionList
|
|
23
|
+
*/
|
|
24
|
+
page: number;
|
|
25
|
+
/**
|
|
26
|
+
* The number of items per page
|
|
27
|
+
* @type {number}
|
|
28
|
+
* @memberof GetContentVersionList
|
|
29
|
+
*/
|
|
30
|
+
pageSize: number;
|
|
31
|
+
/**
|
|
32
|
+
* The total number of pages
|
|
33
|
+
* @type {number}
|
|
34
|
+
* @memberof GetContentVersionList
|
|
35
|
+
*/
|
|
36
|
+
totalPages: number;
|
|
37
|
+
/**
|
|
38
|
+
* The total number of versions
|
|
39
|
+
* @type {number}
|
|
40
|
+
* @memberof GetContentVersionList
|
|
41
|
+
*/
|
|
42
|
+
totalItems: number;
|
|
43
|
+
/**
|
|
44
|
+
* List of content versions
|
|
45
|
+
* @type {Array<GetContentVersionListItemsInner>}
|
|
46
|
+
* @memberof GetContentVersionList
|
|
47
|
+
*/
|
|
48
|
+
items: Array<GetContentVersionListItemsInner>;
|
|
49
|
+
}
|
|
50
|
+
/**
|
|
51
|
+
* Check if a given object implements the GetContentVersionList interface.
|
|
52
|
+
*/
|
|
53
|
+
export declare function instanceOfGetContentVersionList(value: object): value is GetContentVersionList;
|
|
54
|
+
export declare function GetContentVersionListFromJSON(json: any): GetContentVersionList;
|
|
55
|
+
export declare function GetContentVersionListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetContentVersionList;
|
|
56
|
+
export declare function GetContentVersionListToJSON(json: any): GetContentVersionList;
|
|
57
|
+
export declare function GetContentVersionListToJSONTyped(value?: GetContentVersionList | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,60 @@
|
|
|
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 { GetContentVersionListItemsInnerFromJSON, GetContentVersionListItemsInnerToJSON, } from './GetContentVersionListItemsInner';
|
|
15
|
+
/**
|
|
16
|
+
* Check if a given object implements the GetContentVersionList interface.
|
|
17
|
+
*/
|
|
18
|
+
export function instanceOfGetContentVersionList(value) {
|
|
19
|
+
if (!('page' in value) || value['page'] === undefined)
|
|
20
|
+
return false;
|
|
21
|
+
if (!('pageSize' in value) || value['pageSize'] === undefined)
|
|
22
|
+
return false;
|
|
23
|
+
if (!('totalPages' in value) || value['totalPages'] === undefined)
|
|
24
|
+
return false;
|
|
25
|
+
if (!('totalItems' in value) || value['totalItems'] === undefined)
|
|
26
|
+
return false;
|
|
27
|
+
if (!('items' in value) || value['items'] === undefined)
|
|
28
|
+
return false;
|
|
29
|
+
return true;
|
|
30
|
+
}
|
|
31
|
+
export function GetContentVersionListFromJSON(json) {
|
|
32
|
+
return GetContentVersionListFromJSONTyped(json, false);
|
|
33
|
+
}
|
|
34
|
+
export function GetContentVersionListFromJSONTyped(json, ignoreDiscriminator) {
|
|
35
|
+
if (json == null) {
|
|
36
|
+
return json;
|
|
37
|
+
}
|
|
38
|
+
return {
|
|
39
|
+
'page': json['page'],
|
|
40
|
+
'pageSize': json['page_size'],
|
|
41
|
+
'totalPages': json['total_pages'],
|
|
42
|
+
'totalItems': json['total_items'],
|
|
43
|
+
'items': (json['items'].map(GetContentVersionListItemsInnerFromJSON)),
|
|
44
|
+
};
|
|
45
|
+
}
|
|
46
|
+
export function GetContentVersionListToJSON(json) {
|
|
47
|
+
return GetContentVersionListToJSONTyped(json, false);
|
|
48
|
+
}
|
|
49
|
+
export function GetContentVersionListToJSONTyped(value, ignoreDiscriminator = false) {
|
|
50
|
+
if (value == null) {
|
|
51
|
+
return value;
|
|
52
|
+
}
|
|
53
|
+
return {
|
|
54
|
+
'page': value['page'],
|
|
55
|
+
'page_size': value['pageSize'],
|
|
56
|
+
'total_pages': value['totalPages'],
|
|
57
|
+
'total_items': value['totalItems'],
|
|
58
|
+
'items': (value['items'].map(GetContentVersionListItemsInnerToJSON)),
|
|
59
|
+
};
|
|
60
|
+
}
|