@easyedu/js-lsm-api 1.24.0 → 1.26.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.
@@ -36,6 +36,8 @@ src/models/GetCourse.ts
36
36
  src/models/GetCourseEnrollment.ts
37
37
  src/models/GetCourseEnrollmentList.ts
38
38
  src/models/GetCourseEnrollmentListItem.ts
39
+ src/models/GetCourseExport.ts
40
+ src/models/GetCourseExportList.ts
39
41
  src/models/GetCourseList.ts
40
42
  src/models/GetCourseReportingBasic.ts
41
43
  src/models/GetCourseStudentReporting.ts
@@ -135,6 +137,7 @@ src/models/PostContentSession.ts
135
137
  src/models/PostContentUpload.ts
136
138
  src/models/PostCourse.ts
137
139
  src/models/PostCourseEnrollment.ts
140
+ src/models/PostCourseExport.ts
138
141
  src/models/PostLogin.ts
139
142
  src/models/PostManualQuestionSelection.ts
140
143
  src/models/PostModule.ts
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @easyedu/js-lsm-api@1.24.0
1
+ ## @easyedu/js-lsm-api@1.26.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.24.0 --save
39
+ npm install @easyedu/js-lsm-api@1.26.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 { 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
  */
@@ -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
  */
@@ -58,11 +58,11 @@ export interface GetPortalStudentReportingRequest {
58
58
  */
59
59
  export declare class ReportingApi extends runtime.BaseAPI {
60
60
  /**
61
- * Get detailed grade information for a specific student and content
61
+ * Get detailed grade information for a specific student and content (can use \'current\' for studentId)
62
62
  */
63
63
  getContentGradeDetailRaw(requestParameters: GetContentGradeDetailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContentGradeDetail>>;
64
64
  /**
65
- * Get detailed grade information for a specific student and content
65
+ * Get detailed grade information for a specific student and content (can use \'current\' for studentId)
66
66
  */
67
67
  getContentGradeDetail(requestParameters: GetContentGradeDetailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentGradeDetail>;
68
68
  /**
@@ -90,11 +90,11 @@ export declare class ReportingApi extends runtime.BaseAPI {
90
90
  */
91
91
  getCourseInstructorReportingBasic(requestParameters: GetCourseInstructorReportingBasicRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseReportingBasic>;
92
92
  /**
93
- * Get student-specific reporting for a course
93
+ * Get student-specific reporting for a course (can use \'current\' for studentId)
94
94
  */
95
95
  getCourseStudentReportingRaw(requestParameters: GetCourseStudentReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseStudentReporting>>;
96
96
  /**
97
- * Get student-specific reporting for a course
97
+ * Get student-specific reporting for a course (can use \'current\' for studentId)
98
98
  */
99
99
  getCourseStudentReporting(requestParameters: GetCourseStudentReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseStudentReporting>;
100
100
  /**
@@ -106,27 +106,27 @@ export declare class ReportingApi extends runtime.BaseAPI {
106
106
  */
107
107
  getModuleInstructorBasicReporting(requestParameters: GetModuleInstructorBasicReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetModuleInstructorBasicReporting>;
108
108
  /**
109
- * Get student-specific reporting for a module
109
+ * Get student-specific reporting for a module (can use \'current\' for studentId)
110
110
  */
111
111
  getModuleStudentReportingRaw(requestParameters: GetModuleStudentReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetModuleStudentReporting>>;
112
112
  /**
113
- * Get student-specific reporting for a module
113
+ * Get student-specific reporting for a module (can use \'current\' for studentId)
114
114
  */
115
115
  getModuleStudentReporting(requestParameters: GetModuleStudentReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetModuleStudentReporting>;
116
116
  /**
117
- * Get basic reporting for a portal
117
+ * Get basic reporting for a portal (can use \'current\' for portalId)
118
118
  */
119
119
  getPortalBasicReportingRaw(requestParameters: GetPortalBasicReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortalBasicReporting>>;
120
120
  /**
121
- * Get basic reporting for a portal
121
+ * Get basic reporting for a portal (can use \'current\' for portalId)
122
122
  */
123
123
  getPortalBasicReporting(requestParameters: GetPortalBasicReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortalBasicReporting>;
124
124
  /**
125
- * Get student reporting for a portal
125
+ * Get student reporting for a portal (can use \'current\' for portalId and studentId)
126
126
  */
127
127
  getPortalStudentReportingRaw(requestParameters: GetPortalStudentReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortalStudentReporting>>;
128
128
  /**
129
- * Get student reporting for a portal
129
+ * Get student reporting for a portal (can use \'current\' for portalId and studentId)
130
130
  */
131
131
  getPortalStudentReporting(requestParameters: GetPortalStudentReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortalStudentReporting>;
132
132
  }
@@ -30,7 +30,7 @@ const index_1 = require("../models/index");
30
30
  */
31
31
  class ReportingApi extends runtime.BaseAPI {
32
32
  /**
33
- * Get detailed grade information for a specific student and content
33
+ * Get detailed grade information for a specific student and content (can use \'current\' for studentId)
34
34
  */
35
35
  getContentGradeDetailRaw(requestParameters, initOverrides) {
36
36
  return __awaiter(this, void 0, void 0, function* () {
@@ -58,7 +58,7 @@ class ReportingApi extends runtime.BaseAPI {
58
58
  });
59
59
  }
60
60
  /**
61
- * Get detailed grade information for a specific student and content
61
+ * Get detailed grade information for a specific student and content (can use \'current\' for studentId)
62
62
  */
63
63
  getContentGradeDetail(requestParameters, initOverrides) {
64
64
  return __awaiter(this, void 0, void 0, function* () {
@@ -172,7 +172,7 @@ class ReportingApi extends runtime.BaseAPI {
172
172
  });
173
173
  }
174
174
  /**
175
- * Get student-specific reporting for a course
175
+ * Get student-specific reporting for a course (can use \'current\' for studentId)
176
176
  */
177
177
  getCourseStudentReportingRaw(requestParameters, initOverrides) {
178
178
  return __awaiter(this, void 0, void 0, function* () {
@@ -194,7 +194,7 @@ class ReportingApi extends runtime.BaseAPI {
194
194
  });
195
195
  }
196
196
  /**
197
- * Get student-specific reporting for a course
197
+ * Get student-specific reporting for a course (can use \'current\' for studentId)
198
198
  */
199
199
  getCourseStudentReporting(requestParameters, initOverrides) {
200
200
  return __awaiter(this, void 0, void 0, function* () {
@@ -234,7 +234,7 @@ class ReportingApi extends runtime.BaseAPI {
234
234
  });
235
235
  }
236
236
  /**
237
- * Get student-specific reporting for a module
237
+ * Get student-specific reporting for a module (can use \'current\' for studentId)
238
238
  */
239
239
  getModuleStudentReportingRaw(requestParameters, initOverrides) {
240
240
  return __awaiter(this, void 0, void 0, function* () {
@@ -259,7 +259,7 @@ class ReportingApi extends runtime.BaseAPI {
259
259
  });
260
260
  }
261
261
  /**
262
- * Get student-specific reporting for a module
262
+ * Get student-specific reporting for a module (can use \'current\' for studentId)
263
263
  */
264
264
  getModuleStudentReporting(requestParameters, initOverrides) {
265
265
  return __awaiter(this, void 0, void 0, function* () {
@@ -268,7 +268,7 @@ class ReportingApi extends runtime.BaseAPI {
268
268
  });
269
269
  }
270
270
  /**
271
- * Get basic reporting for a portal
271
+ * Get basic reporting for a portal (can use \'current\' for portalId)
272
272
  */
273
273
  getPortalBasicReportingRaw(requestParameters, initOverrides) {
274
274
  return __awaiter(this, void 0, void 0, function* () {
@@ -287,7 +287,7 @@ class ReportingApi extends runtime.BaseAPI {
287
287
  });
288
288
  }
289
289
  /**
290
- * Get basic reporting for a portal
290
+ * Get basic reporting for a portal (can use \'current\' for portalId)
291
291
  */
292
292
  getPortalBasicReporting(requestParameters, initOverrides) {
293
293
  return __awaiter(this, void 0, void 0, function* () {
@@ -296,7 +296,7 @@ class ReportingApi extends runtime.BaseAPI {
296
296
  });
297
297
  }
298
298
  /**
299
- * Get student reporting for a portal
299
+ * Get student reporting for a portal (can use \'current\' for portalId and studentId)
300
300
  */
301
301
  getPortalStudentReportingRaw(requestParameters, initOverrides) {
302
302
  return __awaiter(this, void 0, void 0, function* () {
@@ -318,7 +318,7 @@ class ReportingApi extends runtime.BaseAPI {
318
318
  });
319
319
  }
320
320
  /**
321
- * Get student reporting for a portal
321
+ * Get student reporting for a portal (can use \'current\' for portalId and studentId)
322
322
  */
323
323
  getPortalStudentReporting(requestParameters, initOverrides) {
324
324
  return __awaiter(this, void 0, void 0, function* () {
@@ -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
  */
@@ -58,11 +58,11 @@ export interface GetPortalStudentReportingRequest {
58
58
  */
59
59
  export declare class ReportingApi extends runtime.BaseAPI {
60
60
  /**
61
- * Get detailed grade information for a specific student and content
61
+ * Get detailed grade information for a specific student and content (can use \'current\' for studentId)
62
62
  */
63
63
  getContentGradeDetailRaw(requestParameters: GetContentGradeDetailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContentGradeDetail>>;
64
64
  /**
65
- * Get detailed grade information for a specific student and content
65
+ * Get detailed grade information for a specific student and content (can use \'current\' for studentId)
66
66
  */
67
67
  getContentGradeDetail(requestParameters: GetContentGradeDetailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentGradeDetail>;
68
68
  /**
@@ -90,11 +90,11 @@ export declare class ReportingApi extends runtime.BaseAPI {
90
90
  */
91
91
  getCourseInstructorReportingBasic(requestParameters: GetCourseInstructorReportingBasicRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseReportingBasic>;
92
92
  /**
93
- * Get student-specific reporting for a course
93
+ * Get student-specific reporting for a course (can use \'current\' for studentId)
94
94
  */
95
95
  getCourseStudentReportingRaw(requestParameters: GetCourseStudentReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseStudentReporting>>;
96
96
  /**
97
- * Get student-specific reporting for a course
97
+ * Get student-specific reporting for a course (can use \'current\' for studentId)
98
98
  */
99
99
  getCourseStudentReporting(requestParameters: GetCourseStudentReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseStudentReporting>;
100
100
  /**
@@ -106,27 +106,27 @@ export declare class ReportingApi extends runtime.BaseAPI {
106
106
  */
107
107
  getModuleInstructorBasicReporting(requestParameters: GetModuleInstructorBasicReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetModuleInstructorBasicReporting>;
108
108
  /**
109
- * Get student-specific reporting for a module
109
+ * Get student-specific reporting for a module (can use \'current\' for studentId)
110
110
  */
111
111
  getModuleStudentReportingRaw(requestParameters: GetModuleStudentReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetModuleStudentReporting>>;
112
112
  /**
113
- * Get student-specific reporting for a module
113
+ * Get student-specific reporting for a module (can use \'current\' for studentId)
114
114
  */
115
115
  getModuleStudentReporting(requestParameters: GetModuleStudentReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetModuleStudentReporting>;
116
116
  /**
117
- * Get basic reporting for a portal
117
+ * Get basic reporting for a portal (can use \'current\' for portalId)
118
118
  */
119
119
  getPortalBasicReportingRaw(requestParameters: GetPortalBasicReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortalBasicReporting>>;
120
120
  /**
121
- * Get basic reporting for a portal
121
+ * Get basic reporting for a portal (can use \'current\' for portalId)
122
122
  */
123
123
  getPortalBasicReporting(requestParameters: GetPortalBasicReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortalBasicReporting>;
124
124
  /**
125
- * Get student reporting for a portal
125
+ * Get student reporting for a portal (can use \'current\' for portalId and studentId)
126
126
  */
127
127
  getPortalStudentReportingRaw(requestParameters: GetPortalStudentReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortalStudentReporting>>;
128
128
  /**
129
- * Get student reporting for a portal
129
+ * Get student reporting for a portal (can use \'current\' for portalId and studentId)
130
130
  */
131
131
  getPortalStudentReporting(requestParameters: GetPortalStudentReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortalStudentReporting>;
132
132
  }