@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
package/.openapi-generator/FILES
CHANGED
|
@@ -32,10 +32,17 @@ src/models/GetContentInstructorBasicReportingPerformance.ts
|
|
|
32
32
|
src/models/GetContentList.ts
|
|
33
33
|
src/models/GetContentSession.ts
|
|
34
34
|
src/models/GetContentUpload.ts
|
|
35
|
+
src/models/GetContentVersion.ts
|
|
36
|
+
src/models/GetContentVersionList.ts
|
|
37
|
+
src/models/GetContentVersionListItemsInner.ts
|
|
38
|
+
src/models/GetContentVersionSandbox.ts
|
|
39
|
+
src/models/GetContentVersionScormData.ts
|
|
35
40
|
src/models/GetCourse.ts
|
|
36
41
|
src/models/GetCourseEnrollment.ts
|
|
37
42
|
src/models/GetCourseEnrollmentList.ts
|
|
38
43
|
src/models/GetCourseEnrollmentListItem.ts
|
|
44
|
+
src/models/GetCourseExport.ts
|
|
45
|
+
src/models/GetCourseExportList.ts
|
|
39
46
|
src/models/GetCourseList.ts
|
|
40
47
|
src/models/GetCourseReportingBasic.ts
|
|
41
48
|
src/models/GetCourseStudentReporting.ts
|
|
@@ -112,6 +119,8 @@ src/models/GetQuizResultsQuestionsInnerStudentAnswer.ts
|
|
|
112
119
|
src/models/GetQuizResultsScore.ts
|
|
113
120
|
src/models/GetQuizResultsTiming.ts
|
|
114
121
|
src/models/GetQuizStatistics.ts
|
|
122
|
+
src/models/GetScormPackage.ts
|
|
123
|
+
src/models/GetScormPackagePackageInfo.ts
|
|
115
124
|
src/models/GetUser.ts
|
|
116
125
|
src/models/GetUserQuizAttempts.ts
|
|
117
126
|
src/models/GetUserQuizAttemptsAllOfAttempts.ts
|
|
@@ -135,6 +144,7 @@ src/models/PostContentSession.ts
|
|
|
135
144
|
src/models/PostContentUpload.ts
|
|
136
145
|
src/models/PostCourse.ts
|
|
137
146
|
src/models/PostCourseEnrollment.ts
|
|
147
|
+
src/models/PostCourseExport.ts
|
|
138
148
|
src/models/PostLogin.ts
|
|
139
149
|
src/models/PostManualQuestionSelection.ts
|
|
140
150
|
src/models/PostModule.ts
|
|
@@ -159,6 +169,7 @@ src/models/PostQuizSettings.ts
|
|
|
159
169
|
src/models/PostResetPassword.ts
|
|
160
170
|
src/models/PostSendResetPassword.ts
|
|
161
171
|
src/models/PutContent.ts
|
|
172
|
+
src/models/PutContentVersion.ts
|
|
162
173
|
src/models/PutCourse.ts
|
|
163
174
|
src/models/PutCourseEnrollment.ts
|
|
164
175
|
src/models/PutModule.ts
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @easyedu/js-lsm-api@1.
|
|
1
|
+
## @easyedu/js-lsm-api@1.27.0
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @easyedu/js-lsm-api@1.
|
|
39
|
+
npm install @easyedu/js-lsm-api@1.27.0 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import type { GetContent, GetContentList, GetContentSession, GetContentUpload, PostContentQuiz, PostContentSession, PostContentUpload, PutContent } from '../models/index';
|
|
13
|
+
import type { GetContent, GetContentList, GetContentSession, GetContentUpload, GetContentVersion, GetContentVersionList, GetScormPackage, PostContentQuiz, PostContentSession, PostContentUpload, PutContent, PutContentVersion } from '../models/index';
|
|
14
14
|
export interface GetContentRequest {
|
|
15
15
|
contentId: string;
|
|
16
16
|
moduleId: string;
|
|
@@ -25,6 +25,22 @@ export interface GetContentSessionRequest {
|
|
|
25
25
|
moduleId: string;
|
|
26
26
|
courseId: string;
|
|
27
27
|
}
|
|
28
|
+
export interface GetContentVersionRequest {
|
|
29
|
+
contentId: string;
|
|
30
|
+
moduleId: string;
|
|
31
|
+
courseId: string;
|
|
32
|
+
versionId: string;
|
|
33
|
+
}
|
|
34
|
+
export interface GetContentVersionListRequest {
|
|
35
|
+
contentId: string;
|
|
36
|
+
moduleId: string;
|
|
37
|
+
courseId: string;
|
|
38
|
+
page?: number;
|
|
39
|
+
pageSize?: number;
|
|
40
|
+
}
|
|
41
|
+
export interface GetScormPackageRequest {
|
|
42
|
+
packageId: string;
|
|
43
|
+
}
|
|
28
44
|
export interface PostContentProcessRequest {
|
|
29
45
|
moduleId: string;
|
|
30
46
|
courseId: string;
|
|
@@ -51,6 +67,13 @@ export interface PutContentRequest {
|
|
|
51
67
|
courseId: string;
|
|
52
68
|
putContent: PutContent;
|
|
53
69
|
}
|
|
70
|
+
export interface PutContentVersionRequest {
|
|
71
|
+
contentId: string;
|
|
72
|
+
moduleId: string;
|
|
73
|
+
courseId: string;
|
|
74
|
+
versionId: string;
|
|
75
|
+
putContentVersion: PutContentVersion;
|
|
76
|
+
}
|
|
54
77
|
/**
|
|
55
78
|
*
|
|
56
79
|
*/
|
|
@@ -79,6 +102,36 @@ export declare class ContentApi extends runtime.BaseAPI {
|
|
|
79
102
|
* get content session
|
|
80
103
|
*/
|
|
81
104
|
getContentSession(requestParameters: GetContentSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentSession>;
|
|
105
|
+
/**
|
|
106
|
+
* 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.
|
|
107
|
+
* Get details of a specific content version
|
|
108
|
+
*/
|
|
109
|
+
getContentVersionRaw(requestParameters: GetContentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContentVersion>>;
|
|
110
|
+
/**
|
|
111
|
+
* 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.
|
|
112
|
+
* Get details of a specific content version
|
|
113
|
+
*/
|
|
114
|
+
getContentVersion(requestParameters: GetContentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentVersion>;
|
|
115
|
+
/**
|
|
116
|
+
* Returns a paginated list of all versions for the specified content. Returns an empty array if the content has no versions.
|
|
117
|
+
* Get all versions of a content
|
|
118
|
+
*/
|
|
119
|
+
getContentVersionListRaw(requestParameters: GetContentVersionListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContentVersionList>>;
|
|
120
|
+
/**
|
|
121
|
+
* Returns a paginated list of all versions for the specified content. Returns an empty array if the content has no versions.
|
|
122
|
+
* Get all versions of a content
|
|
123
|
+
*/
|
|
124
|
+
getContentVersionList(requestParameters: GetContentVersionListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentVersionList>;
|
|
125
|
+
/**
|
|
126
|
+
* Returns package information and table of contents for a SCORM package
|
|
127
|
+
* Get details of a SCORM package
|
|
128
|
+
*/
|
|
129
|
+
getScormPackageRaw(requestParameters: GetScormPackageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetScormPackage>>;
|
|
130
|
+
/**
|
|
131
|
+
* Returns package information and table of contents for a SCORM package
|
|
132
|
+
* Get details of a SCORM package
|
|
133
|
+
*/
|
|
134
|
+
getScormPackage(requestParameters: GetScormPackageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetScormPackage>;
|
|
82
135
|
/**
|
|
83
136
|
* Post a new content process
|
|
84
137
|
*/
|
|
@@ -121,4 +174,14 @@ export declare class ContentApi extends runtime.BaseAPI {
|
|
|
121
174
|
* Update content by id
|
|
122
175
|
*/
|
|
123
176
|
putContent(requestParameters: PutContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContent>;
|
|
177
|
+
/**
|
|
178
|
+
* 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.
|
|
179
|
+
* Update a content version
|
|
180
|
+
*/
|
|
181
|
+
putContentVersionRaw(requestParameters: PutContentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContentVersion>>;
|
|
182
|
+
/**
|
|
183
|
+
* 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.
|
|
184
|
+
* Update a content version
|
|
185
|
+
*/
|
|
186
|
+
putContentVersion(requestParameters: PutContentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentVersion>;
|
|
124
187
|
}
|
package/dist/apis/ContentApi.js
CHANGED
|
@@ -128,6 +128,117 @@ class ContentApi extends runtime.BaseAPI {
|
|
|
128
128
|
return yield response.value();
|
|
129
129
|
});
|
|
130
130
|
}
|
|
131
|
+
/**
|
|
132
|
+
* 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.
|
|
133
|
+
* Get details of a specific content version
|
|
134
|
+
*/
|
|
135
|
+
getContentVersionRaw(requestParameters, initOverrides) {
|
|
136
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
137
|
+
if (requestParameters['contentId'] == null) {
|
|
138
|
+
throw new runtime.RequiredError('contentId', 'Required parameter "contentId" was null or undefined when calling getContentVersion().');
|
|
139
|
+
}
|
|
140
|
+
if (requestParameters['moduleId'] == null) {
|
|
141
|
+
throw new runtime.RequiredError('moduleId', 'Required parameter "moduleId" was null or undefined when calling getContentVersion().');
|
|
142
|
+
}
|
|
143
|
+
if (requestParameters['courseId'] == null) {
|
|
144
|
+
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getContentVersion().');
|
|
145
|
+
}
|
|
146
|
+
if (requestParameters['versionId'] == null) {
|
|
147
|
+
throw new runtime.RequiredError('versionId', 'Required parameter "versionId" was null or undefined when calling getContentVersion().');
|
|
148
|
+
}
|
|
149
|
+
const queryParameters = {};
|
|
150
|
+
const headerParameters = {};
|
|
151
|
+
const response = yield this.request({
|
|
152
|
+
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']))),
|
|
153
|
+
method: 'GET',
|
|
154
|
+
headers: headerParameters,
|
|
155
|
+
query: queryParameters,
|
|
156
|
+
}, initOverrides);
|
|
157
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GetContentVersionFromJSON)(jsonValue));
|
|
158
|
+
});
|
|
159
|
+
}
|
|
160
|
+
/**
|
|
161
|
+
* 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.
|
|
162
|
+
* Get details of a specific content version
|
|
163
|
+
*/
|
|
164
|
+
getContentVersion(requestParameters, initOverrides) {
|
|
165
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
166
|
+
const response = yield this.getContentVersionRaw(requestParameters, initOverrides);
|
|
167
|
+
return yield response.value();
|
|
168
|
+
});
|
|
169
|
+
}
|
|
170
|
+
/**
|
|
171
|
+
* Returns a paginated list of all versions for the specified content. Returns an empty array if the content has no versions.
|
|
172
|
+
* Get all versions of a content
|
|
173
|
+
*/
|
|
174
|
+
getContentVersionListRaw(requestParameters, initOverrides) {
|
|
175
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
176
|
+
if (requestParameters['contentId'] == null) {
|
|
177
|
+
throw new runtime.RequiredError('contentId', 'Required parameter "contentId" was null or undefined when calling getContentVersionList().');
|
|
178
|
+
}
|
|
179
|
+
if (requestParameters['moduleId'] == null) {
|
|
180
|
+
throw new runtime.RequiredError('moduleId', 'Required parameter "moduleId" was null or undefined when calling getContentVersionList().');
|
|
181
|
+
}
|
|
182
|
+
if (requestParameters['courseId'] == null) {
|
|
183
|
+
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getContentVersionList().');
|
|
184
|
+
}
|
|
185
|
+
const queryParameters = {};
|
|
186
|
+
if (requestParameters['page'] != null) {
|
|
187
|
+
queryParameters['page'] = requestParameters['page'];
|
|
188
|
+
}
|
|
189
|
+
if (requestParameters['pageSize'] != null) {
|
|
190
|
+
queryParameters['page_size'] = requestParameters['pageSize'];
|
|
191
|
+
}
|
|
192
|
+
const headerParameters = {};
|
|
193
|
+
const response = yield this.request({
|
|
194
|
+
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']))),
|
|
195
|
+
method: 'GET',
|
|
196
|
+
headers: headerParameters,
|
|
197
|
+
query: queryParameters,
|
|
198
|
+
}, initOverrides);
|
|
199
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GetContentVersionListFromJSON)(jsonValue));
|
|
200
|
+
});
|
|
201
|
+
}
|
|
202
|
+
/**
|
|
203
|
+
* Returns a paginated list of all versions for the specified content. Returns an empty array if the content has no versions.
|
|
204
|
+
* Get all versions of a content
|
|
205
|
+
*/
|
|
206
|
+
getContentVersionList(requestParameters, initOverrides) {
|
|
207
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
208
|
+
const response = yield this.getContentVersionListRaw(requestParameters, initOverrides);
|
|
209
|
+
return yield response.value();
|
|
210
|
+
});
|
|
211
|
+
}
|
|
212
|
+
/**
|
|
213
|
+
* Returns package information and table of contents for a SCORM package
|
|
214
|
+
* Get details of a SCORM package
|
|
215
|
+
*/
|
|
216
|
+
getScormPackageRaw(requestParameters, initOverrides) {
|
|
217
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
218
|
+
if (requestParameters['packageId'] == null) {
|
|
219
|
+
throw new runtime.RequiredError('packageId', 'Required parameter "packageId" was null or undefined when calling getScormPackage().');
|
|
220
|
+
}
|
|
221
|
+
const queryParameters = {};
|
|
222
|
+
const headerParameters = {};
|
|
223
|
+
const response = yield this.request({
|
|
224
|
+
path: `/scorm/packages/{packageId}`.replace(`{${"packageId"}}`, encodeURIComponent(String(requestParameters['packageId']))),
|
|
225
|
+
method: 'GET',
|
|
226
|
+
headers: headerParameters,
|
|
227
|
+
query: queryParameters,
|
|
228
|
+
}, initOverrides);
|
|
229
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GetScormPackageFromJSON)(jsonValue));
|
|
230
|
+
});
|
|
231
|
+
}
|
|
232
|
+
/**
|
|
233
|
+
* Returns package information and table of contents for a SCORM package
|
|
234
|
+
* Get details of a SCORM package
|
|
235
|
+
*/
|
|
236
|
+
getScormPackage(requestParameters, initOverrides) {
|
|
237
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
238
|
+
const response = yield this.getScormPackageRaw(requestParameters, initOverrides);
|
|
239
|
+
return yield response.value();
|
|
240
|
+
});
|
|
241
|
+
}
|
|
131
242
|
/**
|
|
132
243
|
* Post a new content process
|
|
133
244
|
*/
|
|
@@ -309,5 +420,49 @@ class ContentApi extends runtime.BaseAPI {
|
|
|
309
420
|
return yield response.value();
|
|
310
421
|
});
|
|
311
422
|
}
|
|
423
|
+
/**
|
|
424
|
+
* 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.
|
|
425
|
+
* Update a content version
|
|
426
|
+
*/
|
|
427
|
+
putContentVersionRaw(requestParameters, initOverrides) {
|
|
428
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
429
|
+
if (requestParameters['contentId'] == null) {
|
|
430
|
+
throw new runtime.RequiredError('contentId', 'Required parameter "contentId" was null or undefined when calling putContentVersion().');
|
|
431
|
+
}
|
|
432
|
+
if (requestParameters['moduleId'] == null) {
|
|
433
|
+
throw new runtime.RequiredError('moduleId', 'Required parameter "moduleId" was null or undefined when calling putContentVersion().');
|
|
434
|
+
}
|
|
435
|
+
if (requestParameters['courseId'] == null) {
|
|
436
|
+
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling putContentVersion().');
|
|
437
|
+
}
|
|
438
|
+
if (requestParameters['versionId'] == null) {
|
|
439
|
+
throw new runtime.RequiredError('versionId', 'Required parameter "versionId" was null or undefined when calling putContentVersion().');
|
|
440
|
+
}
|
|
441
|
+
if (requestParameters['putContentVersion'] == null) {
|
|
442
|
+
throw new runtime.RequiredError('putContentVersion', 'Required parameter "putContentVersion" was null or undefined when calling putContentVersion().');
|
|
443
|
+
}
|
|
444
|
+
const queryParameters = {};
|
|
445
|
+
const headerParameters = {};
|
|
446
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
447
|
+
const response = yield this.request({
|
|
448
|
+
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']))),
|
|
449
|
+
method: 'PUT',
|
|
450
|
+
headers: headerParameters,
|
|
451
|
+
query: queryParameters,
|
|
452
|
+
body: (0, index_1.PutContentVersionToJSON)(requestParameters['putContentVersion']),
|
|
453
|
+
}, initOverrides);
|
|
454
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GetContentVersionFromJSON)(jsonValue));
|
|
455
|
+
});
|
|
456
|
+
}
|
|
457
|
+
/**
|
|
458
|
+
* 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.
|
|
459
|
+
* Update a content version
|
|
460
|
+
*/
|
|
461
|
+
putContentVersion(requestParameters, initOverrides) {
|
|
462
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
463
|
+
const response = yield this.putContentVersionRaw(requestParameters, initOverrides);
|
|
464
|
+
return yield response.value();
|
|
465
|
+
});
|
|
466
|
+
}
|
|
312
467
|
}
|
|
313
468
|
exports.ContentApi = ContentApi;
|
package/dist/apis/CourseApi.d.ts
CHANGED
|
@@ -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
|
*/
|
package/dist/apis/CourseApi.js
CHANGED
|
@@ -125,6 +125,71 @@ class CourseApi extends runtime.BaseAPI {
|
|
|
125
125
|
return yield response.value();
|
|
126
126
|
});
|
|
127
127
|
}
|
|
128
|
+
/**
|
|
129
|
+
* Get details of a specific SCORM export
|
|
130
|
+
*/
|
|
131
|
+
getCourseExportRaw(requestParameters, initOverrides) {
|
|
132
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
133
|
+
if (requestParameters['courseId'] == null) {
|
|
134
|
+
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getCourseExport().');
|
|
135
|
+
}
|
|
136
|
+
if (requestParameters['exportId'] == null) {
|
|
137
|
+
throw new runtime.RequiredError('exportId', 'Required parameter "exportId" was null or undefined when calling getCourseExport().');
|
|
138
|
+
}
|
|
139
|
+
const queryParameters = {};
|
|
140
|
+
const headerParameters = {};
|
|
141
|
+
const response = yield this.request({
|
|
142
|
+
path: `/courses/{courseId}/exports/{exportId}`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))).replace(`{${"exportId"}}`, encodeURIComponent(String(requestParameters['exportId']))),
|
|
143
|
+
method: 'GET',
|
|
144
|
+
headers: headerParameters,
|
|
145
|
+
query: queryParameters,
|
|
146
|
+
}, initOverrides);
|
|
147
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GetCourseExportFromJSON)(jsonValue));
|
|
148
|
+
});
|
|
149
|
+
}
|
|
150
|
+
/**
|
|
151
|
+
* Get details of a specific SCORM export
|
|
152
|
+
*/
|
|
153
|
+
getCourseExport(requestParameters, initOverrides) {
|
|
154
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
155
|
+
const response = yield this.getCourseExportRaw(requestParameters, initOverrides);
|
|
156
|
+
return yield response.value();
|
|
157
|
+
});
|
|
158
|
+
}
|
|
159
|
+
/**
|
|
160
|
+
* List all SCORM exports for a course
|
|
161
|
+
*/
|
|
162
|
+
getCourseExportsRaw(requestParameters, initOverrides) {
|
|
163
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
164
|
+
if (requestParameters['courseId'] == null) {
|
|
165
|
+
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getCourseExports().');
|
|
166
|
+
}
|
|
167
|
+
const queryParameters = {};
|
|
168
|
+
if (requestParameters['page'] != null) {
|
|
169
|
+
queryParameters['page'] = requestParameters['page'];
|
|
170
|
+
}
|
|
171
|
+
if (requestParameters['pageSize'] != null) {
|
|
172
|
+
queryParameters['page_size'] = requestParameters['pageSize'];
|
|
173
|
+
}
|
|
174
|
+
const headerParameters = {};
|
|
175
|
+
const response = yield this.request({
|
|
176
|
+
path: `/courses/{courseId}/exports`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))),
|
|
177
|
+
method: 'GET',
|
|
178
|
+
headers: headerParameters,
|
|
179
|
+
query: queryParameters,
|
|
180
|
+
}, initOverrides);
|
|
181
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GetCourseExportListFromJSON)(jsonValue));
|
|
182
|
+
});
|
|
183
|
+
}
|
|
184
|
+
/**
|
|
185
|
+
* List all SCORM exports for a course
|
|
186
|
+
*/
|
|
187
|
+
getCourseExports(requestParameters, initOverrides) {
|
|
188
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
189
|
+
const response = yield this.getCourseExportsRaw(requestParameters, initOverrides);
|
|
190
|
+
return yield response.value();
|
|
191
|
+
});
|
|
192
|
+
}
|
|
128
193
|
/**
|
|
129
194
|
* get course list
|
|
130
195
|
*/
|
|
@@ -244,6 +309,41 @@ class CourseApi extends runtime.BaseAPI {
|
|
|
244
309
|
return yield response.value();
|
|
245
310
|
});
|
|
246
311
|
}
|
|
312
|
+
/**
|
|
313
|
+
* 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
|
|
314
|
+
* Create a new SCORM export for a course
|
|
315
|
+
*/
|
|
316
|
+
postCourseExportRaw(requestParameters, initOverrides) {
|
|
317
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
318
|
+
if (requestParameters['courseId'] == null) {
|
|
319
|
+
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling postCourseExport().');
|
|
320
|
+
}
|
|
321
|
+
if (requestParameters['postCourseExport'] == null) {
|
|
322
|
+
throw new runtime.RequiredError('postCourseExport', 'Required parameter "postCourseExport" was null or undefined when calling postCourseExport().');
|
|
323
|
+
}
|
|
324
|
+
const queryParameters = {};
|
|
325
|
+
const headerParameters = {};
|
|
326
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
327
|
+
const response = yield this.request({
|
|
328
|
+
path: `/courses/{courseId}/exports`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))),
|
|
329
|
+
method: 'POST',
|
|
330
|
+
headers: headerParameters,
|
|
331
|
+
query: queryParameters,
|
|
332
|
+
body: (0, index_1.PostCourseExportToJSON)(requestParameters['postCourseExport']),
|
|
333
|
+
}, initOverrides);
|
|
334
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GetCourseExportFromJSON)(jsonValue));
|
|
335
|
+
});
|
|
336
|
+
}
|
|
337
|
+
/**
|
|
338
|
+
* 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
|
|
339
|
+
* Create a new SCORM export for a course
|
|
340
|
+
*/
|
|
341
|
+
postCourseExport(requestParameters, initOverrides) {
|
|
342
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
343
|
+
const response = yield this.postCourseExportRaw(requestParameters, initOverrides);
|
|
344
|
+
return yield response.value();
|
|
345
|
+
});
|
|
346
|
+
}
|
|
247
347
|
/**
|
|
248
348
|
* Update a course by id
|
|
249
349
|
*/
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import type { GetContent, GetContentList, GetContentSession, GetContentUpload, PostContentQuiz, PostContentSession, PostContentUpload, PutContent } from '../models/index';
|
|
13
|
+
import type { GetContent, GetContentList, GetContentSession, GetContentUpload, GetContentVersion, GetContentVersionList, GetScormPackage, PostContentQuiz, PostContentSession, PostContentUpload, PutContent, PutContentVersion } from '../models/index';
|
|
14
14
|
export interface GetContentRequest {
|
|
15
15
|
contentId: string;
|
|
16
16
|
moduleId: string;
|
|
@@ -25,6 +25,22 @@ export interface GetContentSessionRequest {
|
|
|
25
25
|
moduleId: string;
|
|
26
26
|
courseId: string;
|
|
27
27
|
}
|
|
28
|
+
export interface GetContentVersionRequest {
|
|
29
|
+
contentId: string;
|
|
30
|
+
moduleId: string;
|
|
31
|
+
courseId: string;
|
|
32
|
+
versionId: string;
|
|
33
|
+
}
|
|
34
|
+
export interface GetContentVersionListRequest {
|
|
35
|
+
contentId: string;
|
|
36
|
+
moduleId: string;
|
|
37
|
+
courseId: string;
|
|
38
|
+
page?: number;
|
|
39
|
+
pageSize?: number;
|
|
40
|
+
}
|
|
41
|
+
export interface GetScormPackageRequest {
|
|
42
|
+
packageId: string;
|
|
43
|
+
}
|
|
28
44
|
export interface PostContentProcessRequest {
|
|
29
45
|
moduleId: string;
|
|
30
46
|
courseId: string;
|
|
@@ -51,6 +67,13 @@ export interface PutContentRequest {
|
|
|
51
67
|
courseId: string;
|
|
52
68
|
putContent: PutContent;
|
|
53
69
|
}
|
|
70
|
+
export interface PutContentVersionRequest {
|
|
71
|
+
contentId: string;
|
|
72
|
+
moduleId: string;
|
|
73
|
+
courseId: string;
|
|
74
|
+
versionId: string;
|
|
75
|
+
putContentVersion: PutContentVersion;
|
|
76
|
+
}
|
|
54
77
|
/**
|
|
55
78
|
*
|
|
56
79
|
*/
|
|
@@ -79,6 +102,36 @@ export declare class ContentApi extends runtime.BaseAPI {
|
|
|
79
102
|
* get content session
|
|
80
103
|
*/
|
|
81
104
|
getContentSession(requestParameters: GetContentSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentSession>;
|
|
105
|
+
/**
|
|
106
|
+
* 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.
|
|
107
|
+
* Get details of a specific content version
|
|
108
|
+
*/
|
|
109
|
+
getContentVersionRaw(requestParameters: GetContentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContentVersion>>;
|
|
110
|
+
/**
|
|
111
|
+
* 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.
|
|
112
|
+
* Get details of a specific content version
|
|
113
|
+
*/
|
|
114
|
+
getContentVersion(requestParameters: GetContentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentVersion>;
|
|
115
|
+
/**
|
|
116
|
+
* Returns a paginated list of all versions for the specified content. Returns an empty array if the content has no versions.
|
|
117
|
+
* Get all versions of a content
|
|
118
|
+
*/
|
|
119
|
+
getContentVersionListRaw(requestParameters: GetContentVersionListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContentVersionList>>;
|
|
120
|
+
/**
|
|
121
|
+
* Returns a paginated list of all versions for the specified content. Returns an empty array if the content has no versions.
|
|
122
|
+
* Get all versions of a content
|
|
123
|
+
*/
|
|
124
|
+
getContentVersionList(requestParameters: GetContentVersionListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentVersionList>;
|
|
125
|
+
/**
|
|
126
|
+
* Returns package information and table of contents for a SCORM package
|
|
127
|
+
* Get details of a SCORM package
|
|
128
|
+
*/
|
|
129
|
+
getScormPackageRaw(requestParameters: GetScormPackageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetScormPackage>>;
|
|
130
|
+
/**
|
|
131
|
+
* Returns package information and table of contents for a SCORM package
|
|
132
|
+
* Get details of a SCORM package
|
|
133
|
+
*/
|
|
134
|
+
getScormPackage(requestParameters: GetScormPackageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetScormPackage>;
|
|
82
135
|
/**
|
|
83
136
|
* Post a new content process
|
|
84
137
|
*/
|
|
@@ -121,4 +174,14 @@ export declare class ContentApi extends runtime.BaseAPI {
|
|
|
121
174
|
* Update content by id
|
|
122
175
|
*/
|
|
123
176
|
putContent(requestParameters: PutContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContent>;
|
|
177
|
+
/**
|
|
178
|
+
* 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.
|
|
179
|
+
* Update a content version
|
|
180
|
+
*/
|
|
181
|
+
putContentVersionRaw(requestParameters: PutContentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContentVersion>>;
|
|
182
|
+
/**
|
|
183
|
+
* 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.
|
|
184
|
+
* Update a content version
|
|
185
|
+
*/
|
|
186
|
+
putContentVersion(requestParameters: PutContentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentVersion>;
|
|
124
187
|
}
|