@easyedu/js-lsm-api 1.28.0 → 1.29.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (58) hide show
  1. package/.openapi-generator/FILES +9 -0
  2. package/README.md +2 -2
  3. package/dist/apis/ContentApi.d.ts +71 -1
  4. package/dist/apis/ContentApi.js +158 -1
  5. package/dist/esm/apis/ContentApi.d.ts +71 -1
  6. package/dist/esm/apis/ContentApi.js +158 -1
  7. package/dist/esm/models/GetContentSessionDetail.d.ts +103 -0
  8. package/dist/esm/models/GetContentSessionDetail.js +96 -0
  9. package/dist/esm/models/GetContentSessionDetailScormSessionData.d.ts +32 -0
  10. package/dist/esm/models/GetContentSessionDetailScormSessionData.js +43 -0
  11. package/dist/esm/models/GetContentSessionDetailUserData.d.ts +38 -0
  12. package/dist/esm/models/GetContentSessionDetailUserData.js +47 -0
  13. package/dist/esm/models/GetContentSessionList.d.ts +57 -0
  14. package/dist/esm/models/GetContentSessionList.js +60 -0
  15. package/dist/esm/models/GetContentSessionListItem.d.ts +64 -0
  16. package/dist/esm/models/GetContentSessionListItem.js +65 -0
  17. package/dist/esm/models/GetScormApiLogItem.d.ts +73 -0
  18. package/dist/esm/models/GetScormApiLogItem.js +73 -0
  19. package/dist/esm/models/GetScormApiLogs.d.ts +57 -0
  20. package/dist/esm/models/GetScormApiLogs.js +60 -0
  21. package/dist/esm/models/GetScormSessionData.d.ts +59 -0
  22. package/dist/esm/models/GetScormSessionData.js +60 -0
  23. package/dist/esm/models/GetScormSessionDataActivity.d.ts +38 -0
  24. package/dist/esm/models/GetScormSessionDataActivity.js +47 -0
  25. package/dist/esm/models/index.d.ts +9 -0
  26. package/dist/esm/models/index.js +9 -0
  27. package/dist/models/GetContentSessionDetail.d.ts +103 -0
  28. package/dist/models/GetContentSessionDetail.js +104 -0
  29. package/dist/models/GetContentSessionDetailScormSessionData.d.ts +32 -0
  30. package/dist/models/GetContentSessionDetailScormSessionData.js +50 -0
  31. package/dist/models/GetContentSessionDetailUserData.d.ts +38 -0
  32. package/dist/models/GetContentSessionDetailUserData.js +54 -0
  33. package/dist/models/GetContentSessionList.d.ts +57 -0
  34. package/dist/models/GetContentSessionList.js +67 -0
  35. package/dist/models/GetContentSessionListItem.d.ts +64 -0
  36. package/dist/models/GetContentSessionListItem.js +72 -0
  37. package/dist/models/GetScormApiLogItem.d.ts +73 -0
  38. package/dist/models/GetScormApiLogItem.js +81 -0
  39. package/dist/models/GetScormApiLogs.d.ts +57 -0
  40. package/dist/models/GetScormApiLogs.js +67 -0
  41. package/dist/models/GetScormSessionData.d.ts +59 -0
  42. package/dist/models/GetScormSessionData.js +67 -0
  43. package/dist/models/GetScormSessionDataActivity.d.ts +38 -0
  44. package/dist/models/GetScormSessionDataActivity.js +54 -0
  45. package/dist/models/index.d.ts +9 -0
  46. package/dist/models/index.js +9 -0
  47. package/package.json +1 -1
  48. package/src/apis/ContentApi.ts +242 -0
  49. package/src/models/GetContentSessionDetail.ts +178 -0
  50. package/src/models/GetContentSessionDetailScormSessionData.ts +66 -0
  51. package/src/models/GetContentSessionDetailUserData.ts +75 -0
  52. package/src/models/GetContentSessionList.ts +110 -0
  53. package/src/models/GetContentSessionListItem.ts +126 -0
  54. package/src/models/GetScormApiLogItem.ts +125 -0
  55. package/src/models/GetScormApiLogs.ts +110 -0
  56. package/src/models/GetScormSessionData.ts +110 -0
  57. package/src/models/GetScormSessionDataActivity.ts +75 -0
  58. package/src/models/index.ts +9 -0
@@ -31,6 +31,11 @@ src/models/GetContentInstructorBasicReportingEngagement.ts
31
31
  src/models/GetContentInstructorBasicReportingPerformance.ts
32
32
  src/models/GetContentList.ts
33
33
  src/models/GetContentSession.ts
34
+ src/models/GetContentSessionDetail.ts
35
+ src/models/GetContentSessionDetailScormSessionData.ts
36
+ src/models/GetContentSessionDetailUserData.ts
37
+ src/models/GetContentSessionList.ts
38
+ src/models/GetContentSessionListItem.ts
34
39
  src/models/GetContentUpload.ts
35
40
  src/models/GetContentVersion.ts
36
41
  src/models/GetContentVersionList.ts
@@ -119,8 +124,12 @@ src/models/GetQuizResultsQuestionsInnerStudentAnswer.ts
119
124
  src/models/GetQuizResultsScore.ts
120
125
  src/models/GetQuizResultsTiming.ts
121
126
  src/models/GetQuizStatistics.ts
127
+ src/models/GetScormApiLogItem.ts
128
+ src/models/GetScormApiLogs.ts
122
129
  src/models/GetScormPackage.ts
123
130
  src/models/GetScormPackagePackageInfo.ts
131
+ src/models/GetScormSessionData.ts
132
+ src/models/GetScormSessionDataActivity.ts
124
133
  src/models/GetUser.ts
125
134
  src/models/GetUserQuizAttempts.ts
126
135
  src/models/GetUserQuizAttemptsAllOfAttempts.ts
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @easyedu/js-lsm-api@1.28.0
1
+ ## @easyedu/js-lsm-api@1.29.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.28.0 --save
39
+ npm install @easyedu/js-lsm-api@1.29.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, GetContentVersion, GetContentVersionList, GetScormPackage, PostContentQuiz, PostContentSession, PostContentUpload, PutContent, PutContentVersion } from '../models/index';
13
+ import type { GetContent, GetContentList, GetContentSession, GetContentSessionDetail, GetContentSessionList, GetContentUpload, GetContentVersion, GetContentVersionList, GetScormApiLogs, GetScormPackage, GetScormSessionData, PostContentQuiz, PostContentSession, PostContentUpload, PutContent, PutContentVersion } from '../models/index';
14
14
  export interface GetContentRequest {
15
15
  contentId: string;
16
16
  moduleId: string;
@@ -25,6 +25,12 @@ export interface GetContentSessionRequest {
25
25
  moduleId: string;
26
26
  courseId: string;
27
27
  }
28
+ export interface GetContentSessionDetailRequest {
29
+ contentId: string;
30
+ moduleId: string;
31
+ courseId: string;
32
+ sessionId: string;
33
+ }
28
34
  export interface GetContentVersionRequest {
29
35
  contentId: string;
30
36
  moduleId: string;
@@ -38,9 +44,25 @@ export interface GetContentVersionListRequest {
38
44
  page?: number;
39
45
  pageSize?: number;
40
46
  }
47
+ export interface GetScormApiLogsRequest {
48
+ sessionId: string;
49
+ page?: number;
50
+ pageSize?: number;
51
+ }
41
52
  export interface GetScormPackageRequest {
42
53
  packageId: string;
43
54
  }
55
+ export interface GetScormSessionDataRequest {
56
+ scormSessionId: string;
57
+ }
58
+ export interface ListContentSessionsRequest {
59
+ contentId: string;
60
+ moduleId: string;
61
+ courseId: string;
62
+ sessionType?: ListContentSessionsSessionTypeEnum;
63
+ page?: number;
64
+ pageSize?: number;
65
+ }
44
66
  export interface PostContentProcessRequest {
45
67
  moduleId: string;
46
68
  courseId: string;
@@ -102,6 +124,16 @@ export declare class ContentApi extends runtime.BaseAPI {
102
124
  * get content session
103
125
  */
104
126
  getContentSession(requestParameters: GetContentSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentSession>;
127
+ /**
128
+ * Get detailed information about a specific content session
129
+ * Get content session details (instructor only)
130
+ */
131
+ getContentSessionDetailRaw(requestParameters: GetContentSessionDetailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContentSessionDetail>>;
132
+ /**
133
+ * Get detailed information about a specific content session
134
+ * Get content session details (instructor only)
135
+ */
136
+ getContentSessionDetail(requestParameters: GetContentSessionDetailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentSessionDetail>;
105
137
  /**
106
138
  * 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
139
  * Get details of a specific content version
@@ -122,6 +154,16 @@ export declare class ContentApi extends runtime.BaseAPI {
122
154
  * Get all versions of a content
123
155
  */
124
156
  getContentVersionList(requestParameters: GetContentVersionListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentVersionList>;
157
+ /**
158
+ * Get a paginated history of all SCORM API calls made during this session for debugging and troubleshooting
159
+ * Get SCORM API call logs (instructor only)
160
+ */
161
+ getScormApiLogsRaw(requestParameters: GetScormApiLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetScormApiLogs>>;
162
+ /**
163
+ * Get a paginated history of all SCORM API calls made during this session for debugging and troubleshooting
164
+ * Get SCORM API call logs (instructor only)
165
+ */
166
+ getScormApiLogs(requestParameters: GetScormApiLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetScormApiLogs>;
125
167
  /**
126
168
  * Returns package information and table of contents for a SCORM package
127
169
  * Get details of a SCORM package
@@ -132,6 +174,26 @@ export declare class ContentApi extends runtime.BaseAPI {
132
174
  * Get details of a SCORM package
133
175
  */
134
176
  getScormPackage(requestParameters: GetScormPackageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetScormPackage>;
177
+ /**
178
+ * Get detailed SCORM session data including CMI data dump for debugging
179
+ * Get SCORM session data (instructor only)
180
+ */
181
+ getScormSessionDataRaw(requestParameters: GetScormSessionDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetScormSessionData>>;
182
+ /**
183
+ * Get detailed SCORM session data including CMI data dump for debugging
184
+ * Get SCORM session data (instructor only)
185
+ */
186
+ getScormSessionData(requestParameters: GetScormSessionDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetScormSessionData>;
187
+ /**
188
+ * Get a paginated list of all content sessions for a specific content item
189
+ * List content sessions (instructor only)
190
+ */
191
+ listContentSessionsRaw(requestParameters: ListContentSessionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContentSessionList>>;
192
+ /**
193
+ * Get a paginated list of all content sessions for a specific content item
194
+ * List content sessions (instructor only)
195
+ */
196
+ listContentSessions(requestParameters: ListContentSessionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentSessionList>;
135
197
  /**
136
198
  * Post a new content process
137
199
  */
@@ -185,3 +247,11 @@ export declare class ContentApi extends runtime.BaseAPI {
185
247
  */
186
248
  putContentVersion(requestParameters: PutContentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentVersion>;
187
249
  }
250
+ /**
251
+ * @export
252
+ */
253
+ export declare const ListContentSessionsSessionTypeEnum: {
254
+ readonly Sandbox: "SANDBOX";
255
+ readonly Live: "LIVE";
256
+ };
257
+ export type ListContentSessionsSessionTypeEnum = typeof ListContentSessionsSessionTypeEnum[keyof typeof ListContentSessionsSessionTypeEnum];
@@ -22,7 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
22
22
  });
23
23
  };
24
24
  Object.defineProperty(exports, "__esModule", { value: true });
25
- exports.ContentApi = void 0;
25
+ exports.ListContentSessionsSessionTypeEnum = exports.ContentApi = void 0;
26
26
  const runtime = require("../runtime");
27
27
  const index_1 = require("../models/index");
28
28
  /**
@@ -128,6 +128,45 @@ class ContentApi extends runtime.BaseAPI {
128
128
  return yield response.value();
129
129
  });
130
130
  }
131
+ /**
132
+ * Get detailed information about a specific content session
133
+ * Get content session details (instructor only)
134
+ */
135
+ getContentSessionDetailRaw(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 getContentSessionDetail().');
139
+ }
140
+ if (requestParameters['moduleId'] == null) {
141
+ throw new runtime.RequiredError('moduleId', 'Required parameter "moduleId" was null or undefined when calling getContentSessionDetail().');
142
+ }
143
+ if (requestParameters['courseId'] == null) {
144
+ throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getContentSessionDetail().');
145
+ }
146
+ if (requestParameters['sessionId'] == null) {
147
+ throw new runtime.RequiredError('sessionId', 'Required parameter "sessionId" was null or undefined when calling getContentSessionDetail().');
148
+ }
149
+ const queryParameters = {};
150
+ const headerParameters = {};
151
+ const response = yield this.request({
152
+ path: `/courses/{courseId}/modules/{moduleId}/contents/{contentId}/sessions/{sessionId}`.replace(`{${"contentId"}}`, encodeURIComponent(String(requestParameters['contentId']))).replace(`{${"moduleId"}}`, encodeURIComponent(String(requestParameters['moduleId']))).replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))).replace(`{${"sessionId"}}`, encodeURIComponent(String(requestParameters['sessionId']))),
153
+ method: 'GET',
154
+ headers: headerParameters,
155
+ query: queryParameters,
156
+ }, initOverrides);
157
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GetContentSessionDetailFromJSON)(jsonValue));
158
+ });
159
+ }
160
+ /**
161
+ * Get detailed information about a specific content session
162
+ * Get content session details (instructor only)
163
+ */
164
+ getContentSessionDetail(requestParameters, initOverrides) {
165
+ return __awaiter(this, void 0, void 0, function* () {
166
+ const response = yield this.getContentSessionDetailRaw(requestParameters, initOverrides);
167
+ return yield response.value();
168
+ });
169
+ }
131
170
  /**
132
171
  * 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
172
  * Get details of a specific content version
@@ -209,6 +248,42 @@ class ContentApi extends runtime.BaseAPI {
209
248
  return yield response.value();
210
249
  });
211
250
  }
251
+ /**
252
+ * Get a paginated history of all SCORM API calls made during this session for debugging and troubleshooting
253
+ * Get SCORM API call logs (instructor only)
254
+ */
255
+ getScormApiLogsRaw(requestParameters, initOverrides) {
256
+ return __awaiter(this, void 0, void 0, function* () {
257
+ if (requestParameters['sessionId'] == null) {
258
+ throw new runtime.RequiredError('sessionId', 'Required parameter "sessionId" was null or undefined when calling getScormApiLogs().');
259
+ }
260
+ const queryParameters = {};
261
+ if (requestParameters['page'] != null) {
262
+ queryParameters['page'] = requestParameters['page'];
263
+ }
264
+ if (requestParameters['pageSize'] != null) {
265
+ queryParameters['pageSize'] = requestParameters['pageSize'];
266
+ }
267
+ const headerParameters = {};
268
+ const response = yield this.request({
269
+ path: `/scorm/sessions/{sessionId}/api-logs`.replace(`{${"sessionId"}}`, encodeURIComponent(String(requestParameters['sessionId']))),
270
+ method: 'GET',
271
+ headers: headerParameters,
272
+ query: queryParameters,
273
+ }, initOverrides);
274
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GetScormApiLogsFromJSON)(jsonValue));
275
+ });
276
+ }
277
+ /**
278
+ * Get a paginated history of all SCORM API calls made during this session for debugging and troubleshooting
279
+ * Get SCORM API call logs (instructor only)
280
+ */
281
+ getScormApiLogs(requestParameters, initOverrides) {
282
+ return __awaiter(this, void 0, void 0, function* () {
283
+ const response = yield this.getScormApiLogsRaw(requestParameters, initOverrides);
284
+ return yield response.value();
285
+ });
286
+ }
212
287
  /**
213
288
  * Returns package information and table of contents for a SCORM package
214
289
  * Get details of a SCORM package
@@ -239,6 +314,81 @@ class ContentApi extends runtime.BaseAPI {
239
314
  return yield response.value();
240
315
  });
241
316
  }
317
+ /**
318
+ * Get detailed SCORM session data including CMI data dump for debugging
319
+ * Get SCORM session data (instructor only)
320
+ */
321
+ getScormSessionDataRaw(requestParameters, initOverrides) {
322
+ return __awaiter(this, void 0, void 0, function* () {
323
+ if (requestParameters['scormSessionId'] == null) {
324
+ throw new runtime.RequiredError('scormSessionId', 'Required parameter "scormSessionId" was null or undefined when calling getScormSessionData().');
325
+ }
326
+ const queryParameters = {};
327
+ const headerParameters = {};
328
+ const response = yield this.request({
329
+ path: `/scorm/sessions/{scormSessionId}/session-data`.replace(`{${"scormSessionId"}}`, encodeURIComponent(String(requestParameters['scormSessionId']))),
330
+ method: 'GET',
331
+ headers: headerParameters,
332
+ query: queryParameters,
333
+ }, initOverrides);
334
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GetScormSessionDataFromJSON)(jsonValue));
335
+ });
336
+ }
337
+ /**
338
+ * Get detailed SCORM session data including CMI data dump for debugging
339
+ * Get SCORM session data (instructor only)
340
+ */
341
+ getScormSessionData(requestParameters, initOverrides) {
342
+ return __awaiter(this, void 0, void 0, function* () {
343
+ const response = yield this.getScormSessionDataRaw(requestParameters, initOverrides);
344
+ return yield response.value();
345
+ });
346
+ }
347
+ /**
348
+ * Get a paginated list of all content sessions for a specific content item
349
+ * List content sessions (instructor only)
350
+ */
351
+ listContentSessionsRaw(requestParameters, initOverrides) {
352
+ return __awaiter(this, void 0, void 0, function* () {
353
+ if (requestParameters['contentId'] == null) {
354
+ throw new runtime.RequiredError('contentId', 'Required parameter "contentId" was null or undefined when calling listContentSessions().');
355
+ }
356
+ if (requestParameters['moduleId'] == null) {
357
+ throw new runtime.RequiredError('moduleId', 'Required parameter "moduleId" was null or undefined when calling listContentSessions().');
358
+ }
359
+ if (requestParameters['courseId'] == null) {
360
+ throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling listContentSessions().');
361
+ }
362
+ const queryParameters = {};
363
+ if (requestParameters['sessionType'] != null) {
364
+ queryParameters['sessionType'] = requestParameters['sessionType'];
365
+ }
366
+ if (requestParameters['page'] != null) {
367
+ queryParameters['page'] = requestParameters['page'];
368
+ }
369
+ if (requestParameters['pageSize'] != null) {
370
+ queryParameters['pageSize'] = requestParameters['pageSize'];
371
+ }
372
+ const headerParameters = {};
373
+ const response = yield this.request({
374
+ path: `/courses/{courseId}/modules/{moduleId}/contents/{contentId}/sessions`.replace(`{${"contentId"}}`, encodeURIComponent(String(requestParameters['contentId']))).replace(`{${"moduleId"}}`, encodeURIComponent(String(requestParameters['moduleId']))).replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))),
375
+ method: 'GET',
376
+ headers: headerParameters,
377
+ query: queryParameters,
378
+ }, initOverrides);
379
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GetContentSessionListFromJSON)(jsonValue));
380
+ });
381
+ }
382
+ /**
383
+ * Get a paginated list of all content sessions for a specific content item
384
+ * List content sessions (instructor only)
385
+ */
386
+ listContentSessions(requestParameters, initOverrides) {
387
+ return __awaiter(this, void 0, void 0, function* () {
388
+ const response = yield this.listContentSessionsRaw(requestParameters, initOverrides);
389
+ return yield response.value();
390
+ });
391
+ }
242
392
  /**
243
393
  * Post a new content process
244
394
  */
@@ -466,3 +616,10 @@ class ContentApi extends runtime.BaseAPI {
466
616
  }
467
617
  }
468
618
  exports.ContentApi = ContentApi;
619
+ /**
620
+ * @export
621
+ */
622
+ exports.ListContentSessionsSessionTypeEnum = {
623
+ Sandbox: 'SANDBOX',
624
+ Live: 'LIVE'
625
+ };
@@ -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, GetContentVersion, GetContentVersionList, GetScormPackage, PostContentQuiz, PostContentSession, PostContentUpload, PutContent, PutContentVersion } from '../models/index';
13
+ import type { GetContent, GetContentList, GetContentSession, GetContentSessionDetail, GetContentSessionList, GetContentUpload, GetContentVersion, GetContentVersionList, GetScormApiLogs, GetScormPackage, GetScormSessionData, PostContentQuiz, PostContentSession, PostContentUpload, PutContent, PutContentVersion } from '../models/index';
14
14
  export interface GetContentRequest {
15
15
  contentId: string;
16
16
  moduleId: string;
@@ -25,6 +25,12 @@ export interface GetContentSessionRequest {
25
25
  moduleId: string;
26
26
  courseId: string;
27
27
  }
28
+ export interface GetContentSessionDetailRequest {
29
+ contentId: string;
30
+ moduleId: string;
31
+ courseId: string;
32
+ sessionId: string;
33
+ }
28
34
  export interface GetContentVersionRequest {
29
35
  contentId: string;
30
36
  moduleId: string;
@@ -38,9 +44,25 @@ export interface GetContentVersionListRequest {
38
44
  page?: number;
39
45
  pageSize?: number;
40
46
  }
47
+ export interface GetScormApiLogsRequest {
48
+ sessionId: string;
49
+ page?: number;
50
+ pageSize?: number;
51
+ }
41
52
  export interface GetScormPackageRequest {
42
53
  packageId: string;
43
54
  }
55
+ export interface GetScormSessionDataRequest {
56
+ scormSessionId: string;
57
+ }
58
+ export interface ListContentSessionsRequest {
59
+ contentId: string;
60
+ moduleId: string;
61
+ courseId: string;
62
+ sessionType?: ListContentSessionsSessionTypeEnum;
63
+ page?: number;
64
+ pageSize?: number;
65
+ }
44
66
  export interface PostContentProcessRequest {
45
67
  moduleId: string;
46
68
  courseId: string;
@@ -102,6 +124,16 @@ export declare class ContentApi extends runtime.BaseAPI {
102
124
  * get content session
103
125
  */
104
126
  getContentSession(requestParameters: GetContentSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentSession>;
127
+ /**
128
+ * Get detailed information about a specific content session
129
+ * Get content session details (instructor only)
130
+ */
131
+ getContentSessionDetailRaw(requestParameters: GetContentSessionDetailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContentSessionDetail>>;
132
+ /**
133
+ * Get detailed information about a specific content session
134
+ * Get content session details (instructor only)
135
+ */
136
+ getContentSessionDetail(requestParameters: GetContentSessionDetailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentSessionDetail>;
105
137
  /**
106
138
  * 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
139
  * Get details of a specific content version
@@ -122,6 +154,16 @@ export declare class ContentApi extends runtime.BaseAPI {
122
154
  * Get all versions of a content
123
155
  */
124
156
  getContentVersionList(requestParameters: GetContentVersionListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentVersionList>;
157
+ /**
158
+ * Get a paginated history of all SCORM API calls made during this session for debugging and troubleshooting
159
+ * Get SCORM API call logs (instructor only)
160
+ */
161
+ getScormApiLogsRaw(requestParameters: GetScormApiLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetScormApiLogs>>;
162
+ /**
163
+ * Get a paginated history of all SCORM API calls made during this session for debugging and troubleshooting
164
+ * Get SCORM API call logs (instructor only)
165
+ */
166
+ getScormApiLogs(requestParameters: GetScormApiLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetScormApiLogs>;
125
167
  /**
126
168
  * Returns package information and table of contents for a SCORM package
127
169
  * Get details of a SCORM package
@@ -132,6 +174,26 @@ export declare class ContentApi extends runtime.BaseAPI {
132
174
  * Get details of a SCORM package
133
175
  */
134
176
  getScormPackage(requestParameters: GetScormPackageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetScormPackage>;
177
+ /**
178
+ * Get detailed SCORM session data including CMI data dump for debugging
179
+ * Get SCORM session data (instructor only)
180
+ */
181
+ getScormSessionDataRaw(requestParameters: GetScormSessionDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetScormSessionData>>;
182
+ /**
183
+ * Get detailed SCORM session data including CMI data dump for debugging
184
+ * Get SCORM session data (instructor only)
185
+ */
186
+ getScormSessionData(requestParameters: GetScormSessionDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetScormSessionData>;
187
+ /**
188
+ * Get a paginated list of all content sessions for a specific content item
189
+ * List content sessions (instructor only)
190
+ */
191
+ listContentSessionsRaw(requestParameters: ListContentSessionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContentSessionList>>;
192
+ /**
193
+ * Get a paginated list of all content sessions for a specific content item
194
+ * List content sessions (instructor only)
195
+ */
196
+ listContentSessions(requestParameters: ListContentSessionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentSessionList>;
135
197
  /**
136
198
  * Post a new content process
137
199
  */
@@ -185,3 +247,11 @@ export declare class ContentApi extends runtime.BaseAPI {
185
247
  */
186
248
  putContentVersion(requestParameters: PutContentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentVersion>;
187
249
  }
250
+ /**
251
+ * @export
252
+ */
253
+ export declare const ListContentSessionsSessionTypeEnum: {
254
+ readonly Sandbox: "SANDBOX";
255
+ readonly Live: "LIVE";
256
+ };
257
+ export type ListContentSessionsSessionTypeEnum = typeof ListContentSessionsSessionTypeEnum[keyof typeof ListContentSessionsSessionTypeEnum];
@@ -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, GetContentVersionFromJSON, GetContentVersionListFromJSON, GetScormPackageFromJSON, PostContentQuizToJSON, PostContentSessionFromJSON, PostContentUploadToJSON, PutContentToJSON, PutContentVersionToJSON, } from '../models/index';
24
+ import { GetContentFromJSON, GetContentListFromJSON, GetContentSessionFromJSON, GetContentSessionDetailFromJSON, GetContentSessionListFromJSON, GetContentUploadFromJSON, GetContentVersionFromJSON, GetContentVersionListFromJSON, GetScormApiLogsFromJSON, GetScormPackageFromJSON, GetScormSessionDataFromJSON, PostContentQuizToJSON, PostContentSessionFromJSON, PostContentUploadToJSON, PutContentToJSON, PutContentVersionToJSON, } from '../models/index';
25
25
  /**
26
26
  *
27
27
  */
@@ -125,6 +125,45 @@ export class ContentApi extends runtime.BaseAPI {
125
125
  return yield response.value();
126
126
  });
127
127
  }
128
+ /**
129
+ * Get detailed information about a specific content session
130
+ * Get content session details (instructor only)
131
+ */
132
+ getContentSessionDetailRaw(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 getContentSessionDetail().');
136
+ }
137
+ if (requestParameters['moduleId'] == null) {
138
+ throw new runtime.RequiredError('moduleId', 'Required parameter "moduleId" was null or undefined when calling getContentSessionDetail().');
139
+ }
140
+ if (requestParameters['courseId'] == null) {
141
+ throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getContentSessionDetail().');
142
+ }
143
+ if (requestParameters['sessionId'] == null) {
144
+ throw new runtime.RequiredError('sessionId', 'Required parameter "sessionId" was null or undefined when calling getContentSessionDetail().');
145
+ }
146
+ const queryParameters = {};
147
+ const headerParameters = {};
148
+ const response = yield this.request({
149
+ path: `/courses/{courseId}/modules/{moduleId}/contents/{contentId}/sessions/{sessionId}`.replace(`{${"contentId"}}`, encodeURIComponent(String(requestParameters['contentId']))).replace(`{${"moduleId"}}`, encodeURIComponent(String(requestParameters['moduleId']))).replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))).replace(`{${"sessionId"}}`, encodeURIComponent(String(requestParameters['sessionId']))),
150
+ method: 'GET',
151
+ headers: headerParameters,
152
+ query: queryParameters,
153
+ }, initOverrides);
154
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetContentSessionDetailFromJSON(jsonValue));
155
+ });
156
+ }
157
+ /**
158
+ * Get detailed information about a specific content session
159
+ * Get content session details (instructor only)
160
+ */
161
+ getContentSessionDetail(requestParameters, initOverrides) {
162
+ return __awaiter(this, void 0, void 0, function* () {
163
+ const response = yield this.getContentSessionDetailRaw(requestParameters, initOverrides);
164
+ return yield response.value();
165
+ });
166
+ }
128
167
  /**
129
168
  * 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
169
  * Get details of a specific content version
@@ -206,6 +245,42 @@ export class ContentApi extends runtime.BaseAPI {
206
245
  return yield response.value();
207
246
  });
208
247
  }
248
+ /**
249
+ * Get a paginated history of all SCORM API calls made during this session for debugging and troubleshooting
250
+ * Get SCORM API call logs (instructor only)
251
+ */
252
+ getScormApiLogsRaw(requestParameters, initOverrides) {
253
+ return __awaiter(this, void 0, void 0, function* () {
254
+ if (requestParameters['sessionId'] == null) {
255
+ throw new runtime.RequiredError('sessionId', 'Required parameter "sessionId" was null or undefined when calling getScormApiLogs().');
256
+ }
257
+ const queryParameters = {};
258
+ if (requestParameters['page'] != null) {
259
+ queryParameters['page'] = requestParameters['page'];
260
+ }
261
+ if (requestParameters['pageSize'] != null) {
262
+ queryParameters['pageSize'] = requestParameters['pageSize'];
263
+ }
264
+ const headerParameters = {};
265
+ const response = yield this.request({
266
+ path: `/scorm/sessions/{sessionId}/api-logs`.replace(`{${"sessionId"}}`, encodeURIComponent(String(requestParameters['sessionId']))),
267
+ method: 'GET',
268
+ headers: headerParameters,
269
+ query: queryParameters,
270
+ }, initOverrides);
271
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetScormApiLogsFromJSON(jsonValue));
272
+ });
273
+ }
274
+ /**
275
+ * Get a paginated history of all SCORM API calls made during this session for debugging and troubleshooting
276
+ * Get SCORM API call logs (instructor only)
277
+ */
278
+ getScormApiLogs(requestParameters, initOverrides) {
279
+ return __awaiter(this, void 0, void 0, function* () {
280
+ const response = yield this.getScormApiLogsRaw(requestParameters, initOverrides);
281
+ return yield response.value();
282
+ });
283
+ }
209
284
  /**
210
285
  * Returns package information and table of contents for a SCORM package
211
286
  * Get details of a SCORM package
@@ -236,6 +311,81 @@ export class ContentApi extends runtime.BaseAPI {
236
311
  return yield response.value();
237
312
  });
238
313
  }
314
+ /**
315
+ * Get detailed SCORM session data including CMI data dump for debugging
316
+ * Get SCORM session data (instructor only)
317
+ */
318
+ getScormSessionDataRaw(requestParameters, initOverrides) {
319
+ return __awaiter(this, void 0, void 0, function* () {
320
+ if (requestParameters['scormSessionId'] == null) {
321
+ throw new runtime.RequiredError('scormSessionId', 'Required parameter "scormSessionId" was null or undefined when calling getScormSessionData().');
322
+ }
323
+ const queryParameters = {};
324
+ const headerParameters = {};
325
+ const response = yield this.request({
326
+ path: `/scorm/sessions/{scormSessionId}/session-data`.replace(`{${"scormSessionId"}}`, encodeURIComponent(String(requestParameters['scormSessionId']))),
327
+ method: 'GET',
328
+ headers: headerParameters,
329
+ query: queryParameters,
330
+ }, initOverrides);
331
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetScormSessionDataFromJSON(jsonValue));
332
+ });
333
+ }
334
+ /**
335
+ * Get detailed SCORM session data including CMI data dump for debugging
336
+ * Get SCORM session data (instructor only)
337
+ */
338
+ getScormSessionData(requestParameters, initOverrides) {
339
+ return __awaiter(this, void 0, void 0, function* () {
340
+ const response = yield this.getScormSessionDataRaw(requestParameters, initOverrides);
341
+ return yield response.value();
342
+ });
343
+ }
344
+ /**
345
+ * Get a paginated list of all content sessions for a specific content item
346
+ * List content sessions (instructor only)
347
+ */
348
+ listContentSessionsRaw(requestParameters, initOverrides) {
349
+ return __awaiter(this, void 0, void 0, function* () {
350
+ if (requestParameters['contentId'] == null) {
351
+ throw new runtime.RequiredError('contentId', 'Required parameter "contentId" was null or undefined when calling listContentSessions().');
352
+ }
353
+ if (requestParameters['moduleId'] == null) {
354
+ throw new runtime.RequiredError('moduleId', 'Required parameter "moduleId" was null or undefined when calling listContentSessions().');
355
+ }
356
+ if (requestParameters['courseId'] == null) {
357
+ throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling listContentSessions().');
358
+ }
359
+ const queryParameters = {};
360
+ if (requestParameters['sessionType'] != null) {
361
+ queryParameters['sessionType'] = requestParameters['sessionType'];
362
+ }
363
+ if (requestParameters['page'] != null) {
364
+ queryParameters['page'] = requestParameters['page'];
365
+ }
366
+ if (requestParameters['pageSize'] != null) {
367
+ queryParameters['pageSize'] = requestParameters['pageSize'];
368
+ }
369
+ const headerParameters = {};
370
+ const response = yield this.request({
371
+ path: `/courses/{courseId}/modules/{moduleId}/contents/{contentId}/sessions`.replace(`{${"contentId"}}`, encodeURIComponent(String(requestParameters['contentId']))).replace(`{${"moduleId"}}`, encodeURIComponent(String(requestParameters['moduleId']))).replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))),
372
+ method: 'GET',
373
+ headers: headerParameters,
374
+ query: queryParameters,
375
+ }, initOverrides);
376
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetContentSessionListFromJSON(jsonValue));
377
+ });
378
+ }
379
+ /**
380
+ * Get a paginated list of all content sessions for a specific content item
381
+ * List content sessions (instructor only)
382
+ */
383
+ listContentSessions(requestParameters, initOverrides) {
384
+ return __awaiter(this, void 0, void 0, function* () {
385
+ const response = yield this.listContentSessionsRaw(requestParameters, initOverrides);
386
+ return yield response.value();
387
+ });
388
+ }
239
389
  /**
240
390
  * Post a new content process
241
391
  */
@@ -462,3 +612,10 @@ export class ContentApi extends runtime.BaseAPI {
462
612
  });
463
613
  }
464
614
  }
615
+ /**
616
+ * @export
617
+ */
618
+ export const ListContentSessionsSessionTypeEnum = {
619
+ Sandbox: 'SANDBOX',
620
+ Live: 'LIVE'
621
+ };