@easyedu/js-lsm-api 1.99.0 → 1.100.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 +12 -0
- package/README.md +13 -2
- package/dist/apis/ContentLibraryQuizApi.d.ts +17 -0
- package/dist/apis/ContentLibraryQuizApi.js +45 -0
- package/dist/apis/CourseApi.d.ts +60 -0
- package/dist/apis/CourseApi.js +167 -0
- package/dist/apis/PlayerApi.d.ts +17 -0
- package/dist/apis/PlayerApi.js +45 -0
- package/dist/esm/apis/ContentLibraryQuizApi.d.ts +17 -0
- package/dist/esm/apis/ContentLibraryQuizApi.js +45 -0
- package/dist/esm/apis/CourseApi.d.ts +60 -0
- package/dist/esm/apis/CourseApi.js +167 -0
- package/dist/esm/apis/PlayerApi.d.ts +17 -0
- package/dist/esm/apis/PlayerApi.js +45 -0
- package/dist/esm/models/GetAttemptAllowance.d.ts +80 -0
- package/dist/esm/models/GetAttemptAllowance.js +75 -0
- package/dist/esm/models/PostClearSessions.d.ts +32 -0
- package/dist/esm/models/PostClearSessions.js +43 -0
- package/dist/esm/models/PostClearSessionsResponse.d.ts +44 -0
- package/dist/esm/models/PostClearSessionsResponse.js +51 -0
- package/dist/esm/models/PutAttemptAllowance.d.ts +38 -0
- package/dist/esm/models/PutAttemptAllowance.js +47 -0
- package/dist/esm/models/PutLibraryQuizSessionOverride.d.ts +57 -0
- package/dist/esm/models/PutLibraryQuizSessionOverride.js +55 -0
- package/dist/esm/models/PutResourceSessionOverride.d.ts +69 -0
- package/dist/esm/models/PutResourceSessionOverride.js +66 -0
- package/dist/esm/models/index.d.ts +6 -0
- package/dist/esm/models/index.js +6 -0
- package/dist/models/GetAttemptAllowance.d.ts +80 -0
- package/dist/models/GetAttemptAllowance.js +82 -0
- package/dist/models/PostClearSessions.d.ts +32 -0
- package/dist/models/PostClearSessions.js +50 -0
- package/dist/models/PostClearSessionsResponse.d.ts +44 -0
- package/dist/models/PostClearSessionsResponse.js +58 -0
- package/dist/models/PutAttemptAllowance.d.ts +38 -0
- package/dist/models/PutAttemptAllowance.js +54 -0
- package/dist/models/PutLibraryQuizSessionOverride.d.ts +57 -0
- package/dist/models/PutLibraryQuizSessionOverride.js +63 -0
- package/dist/models/PutResourceSessionOverride.d.ts +69 -0
- package/dist/models/PutResourceSessionOverride.js +74 -0
- package/dist/models/index.d.ts +6 -0
- package/dist/models/index.js +6 -0
- package/docs/ContentLibraryQuizApi.md +71 -0
- package/docs/CourseApi.md +236 -0
- package/docs/GetAttemptAllowance.md +51 -0
- package/docs/PlayerApi.md +71 -0
- package/docs/PostClearSessions.md +34 -0
- package/docs/PostClearSessionsResponse.md +38 -0
- package/docs/PutAttemptAllowance.md +36 -0
- package/docs/PutLibraryQuizSessionOverride.md +41 -0
- package/docs/PutResourceSessionOverride.md +41 -0
- package/package.json +1 -1
- package/src/apis/ContentLibraryQuizApi.ts +65 -0
- package/src/apis/CourseApi.ts +270 -0
- package/src/apis/PlayerApi.ts +65 -0
- package/src/models/GetAttemptAllowance.ts +138 -0
- package/src/models/PostClearSessions.ts +66 -0
- package/src/models/PostClearSessionsResponse.ts +84 -0
- package/src/models/PutAttemptAllowance.ts +75 -0
- package/src/models/PutLibraryQuizSessionOverride.ts +100 -0
- package/src/models/PutResourceSessionOverride.ts +113 -0
- package/src/models/index.ts +6 -0
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
|
|
2
|
+
# PostClearSessionsResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`resourceSessionsDeleted` | number
|
|
10
|
+
`quizSessionsDeleted` | number
|
|
11
|
+
`totalSessionsDeleted` | number
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type { PostClearSessionsResponse } from '@easyedu/js-lsm-api'
|
|
17
|
+
|
|
18
|
+
// TODO: Update the object below with actual values
|
|
19
|
+
const example = {
|
|
20
|
+
"resourceSessionsDeleted": null,
|
|
21
|
+
"quizSessionsDeleted": null,
|
|
22
|
+
"totalSessionsDeleted": null,
|
|
23
|
+
} satisfies PostClearSessionsResponse
|
|
24
|
+
|
|
25
|
+
console.log(example)
|
|
26
|
+
|
|
27
|
+
// Convert the instance to a JSON string
|
|
28
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
29
|
+
console.log(exampleJSON)
|
|
30
|
+
|
|
31
|
+
// Parse the JSON string back to an object
|
|
32
|
+
const exampleParsed = JSON.parse(exampleJSON) as PostClearSessionsResponse
|
|
33
|
+
console.log(exampleParsed)
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
37
|
+
|
|
38
|
+
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
|
|
2
|
+
# PutAttemptAllowance
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`additionalAttempts` | number
|
|
10
|
+
`reason` | string
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { PutAttemptAllowance } from '@easyedu/js-lsm-api'
|
|
16
|
+
|
|
17
|
+
// TODO: Update the object below with actual values
|
|
18
|
+
const example = {
|
|
19
|
+
"additionalAttempts": null,
|
|
20
|
+
"reason": null,
|
|
21
|
+
} satisfies PutAttemptAllowance
|
|
22
|
+
|
|
23
|
+
console.log(example)
|
|
24
|
+
|
|
25
|
+
// Convert the instance to a JSON string
|
|
26
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
27
|
+
console.log(exampleJSON)
|
|
28
|
+
|
|
29
|
+
// Parse the JSON string back to an object
|
|
30
|
+
const exampleParsed = JSON.parse(exampleJSON) as PutAttemptAllowance
|
|
31
|
+
console.log(exampleParsed)
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
35
|
+
|
|
36
|
+
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
|
|
2
|
+
# PutLibraryQuizSessionOverride
|
|
3
|
+
|
|
4
|
+
Instructor-entered progress values for an existing live quiz session.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`status` | string
|
|
11
|
+
`scorePercentage` | number
|
|
12
|
+
`passed` | boolean
|
|
13
|
+
`reason` | string
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import type { PutLibraryQuizSessionOverride } from '@easyedu/js-lsm-api'
|
|
19
|
+
|
|
20
|
+
// TODO: Update the object below with actual values
|
|
21
|
+
const example = {
|
|
22
|
+
"status": null,
|
|
23
|
+
"scorePercentage": null,
|
|
24
|
+
"passed": null,
|
|
25
|
+
"reason": null,
|
|
26
|
+
} satisfies PutLibraryQuizSessionOverride
|
|
27
|
+
|
|
28
|
+
console.log(example)
|
|
29
|
+
|
|
30
|
+
// Convert the instance to a JSON string
|
|
31
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
32
|
+
console.log(exampleJSON)
|
|
33
|
+
|
|
34
|
+
// Parse the JSON string back to an object
|
|
35
|
+
const exampleParsed = JSON.parse(exampleJSON) as PutLibraryQuizSessionOverride
|
|
36
|
+
console.log(exampleParsed)
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
40
|
+
|
|
41
|
+
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
|
|
2
|
+
# PutResourceSessionOverride
|
|
3
|
+
|
|
4
|
+
Instructor-entered progress values for an existing live resource session.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`completionStatus` | string
|
|
11
|
+
`gradeStatus` | string
|
|
12
|
+
`scoreRaw` | number
|
|
13
|
+
`reason` | string
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import type { PutResourceSessionOverride } from '@easyedu/js-lsm-api'
|
|
19
|
+
|
|
20
|
+
// TODO: Update the object below with actual values
|
|
21
|
+
const example = {
|
|
22
|
+
"completionStatus": null,
|
|
23
|
+
"gradeStatus": null,
|
|
24
|
+
"scoreRaw": null,
|
|
25
|
+
"reason": null,
|
|
26
|
+
} satisfies PutResourceSessionOverride
|
|
27
|
+
|
|
28
|
+
console.log(example)
|
|
29
|
+
|
|
30
|
+
// Convert the instance to a JSON string
|
|
31
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
32
|
+
console.log(exampleJSON)
|
|
33
|
+
|
|
34
|
+
// Parse the JSON string back to an object
|
|
35
|
+
const exampleParsed = JSON.parse(exampleJSON) as PutResourceSessionOverride
|
|
36
|
+
console.log(exampleParsed)
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
40
|
+
|
|
41
|
+
|
package/package.json
CHANGED
|
@@ -113,6 +113,11 @@ import {
|
|
|
113
113
|
PutLibraryQuizSessionGradeFromJSON,
|
|
114
114
|
PutLibraryQuizSessionGradeToJSON,
|
|
115
115
|
} from '../models/PutLibraryQuizSessionGrade';
|
|
116
|
+
import {
|
|
117
|
+
type PutLibraryQuizSessionOverride,
|
|
118
|
+
PutLibraryQuizSessionOverrideFromJSON,
|
|
119
|
+
PutLibraryQuizSessionOverrideToJSON,
|
|
120
|
+
} from '../models/PutLibraryQuizSessionOverride';
|
|
116
121
|
import {
|
|
117
122
|
type PutLibraryQuizVersion,
|
|
118
123
|
PutLibraryQuizVersionFromJSON,
|
|
@@ -262,6 +267,11 @@ export interface PutLibraryQuizSessionGradeRequest {
|
|
|
262
267
|
putLibraryQuizSessionGrade: PutLibraryQuizSessionGrade;
|
|
263
268
|
}
|
|
264
269
|
|
|
270
|
+
export interface PutLibraryQuizSessionOverrideRequest {
|
|
271
|
+
sessionId: string;
|
|
272
|
+
putLibraryQuizSessionOverride: PutLibraryQuizSessionOverride;
|
|
273
|
+
}
|
|
274
|
+
|
|
265
275
|
export interface PutLibraryQuizVersionRequest {
|
|
266
276
|
quizId: string;
|
|
267
277
|
versionId: string;
|
|
@@ -1632,6 +1642,61 @@ export class ContentLibraryQuizApi extends runtime.BaseAPI {
|
|
|
1632
1642
|
return await response.value();
|
|
1633
1643
|
}
|
|
1634
1644
|
|
|
1645
|
+
/**
|
|
1646
|
+
* Creates request options for putLibraryQuizSessionOverride without sending the request
|
|
1647
|
+
*/
|
|
1648
|
+
async putLibraryQuizSessionOverrideRequestOpts(requestParameters: PutLibraryQuizSessionOverrideRequest): Promise<runtime.RequestOpts> {
|
|
1649
|
+
if (requestParameters['sessionId'] == null) {
|
|
1650
|
+
throw new runtime.RequiredError(
|
|
1651
|
+
'sessionId',
|
|
1652
|
+
'Required parameter "sessionId" was null or undefined when calling putLibraryQuizSessionOverride().'
|
|
1653
|
+
);
|
|
1654
|
+
}
|
|
1655
|
+
|
|
1656
|
+
if (requestParameters['putLibraryQuizSessionOverride'] == null) {
|
|
1657
|
+
throw new runtime.RequiredError(
|
|
1658
|
+
'putLibraryQuizSessionOverride',
|
|
1659
|
+
'Required parameter "putLibraryQuizSessionOverride" was null or undefined when calling putLibraryQuizSessionOverride().'
|
|
1660
|
+
);
|
|
1661
|
+
}
|
|
1662
|
+
|
|
1663
|
+
const queryParameters: any = {};
|
|
1664
|
+
|
|
1665
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1666
|
+
|
|
1667
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
1668
|
+
|
|
1669
|
+
|
|
1670
|
+
let urlPath = `/quiz/sessions/{sessionId}/override`;
|
|
1671
|
+
urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
|
|
1672
|
+
|
|
1673
|
+
return {
|
|
1674
|
+
path: urlPath,
|
|
1675
|
+
method: 'PUT',
|
|
1676
|
+
headers: headerParameters,
|
|
1677
|
+
query: queryParameters,
|
|
1678
|
+
body: PutLibraryQuizSessionOverrideToJSON(requestParameters['putLibraryQuizSessionOverride']),
|
|
1679
|
+
};
|
|
1680
|
+
}
|
|
1681
|
+
|
|
1682
|
+
/**
|
|
1683
|
+
* Override a learner\'s live quiz-session progress
|
|
1684
|
+
*/
|
|
1685
|
+
async putLibraryQuizSessionOverrideRaw(requestParameters: PutLibraryQuizSessionOverrideRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetLibraryQuizSession>> {
|
|
1686
|
+
const requestOptions = await this.putLibraryQuizSessionOverrideRequestOpts(requestParameters);
|
|
1687
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
1688
|
+
|
|
1689
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetLibraryQuizSessionFromJSON(jsonValue));
|
|
1690
|
+
}
|
|
1691
|
+
|
|
1692
|
+
/**
|
|
1693
|
+
* Override a learner\'s live quiz-session progress
|
|
1694
|
+
*/
|
|
1695
|
+
async putLibraryQuizSessionOverride(requestParameters: PutLibraryQuizSessionOverrideRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetLibraryQuizSession> {
|
|
1696
|
+
const response = await this.putLibraryQuizSessionOverrideRaw(requestParameters, initOverrides);
|
|
1697
|
+
return await response.value();
|
|
1698
|
+
}
|
|
1699
|
+
|
|
1635
1700
|
/**
|
|
1636
1701
|
* Creates request options for putLibraryQuizVersion without sending the request
|
|
1637
1702
|
*/
|
package/src/apis/CourseApi.ts
CHANGED
|
@@ -13,6 +13,11 @@
|
|
|
13
13
|
*/
|
|
14
14
|
|
|
15
15
|
import * as runtime from '../runtime';
|
|
16
|
+
import {
|
|
17
|
+
type GetAttemptAllowance,
|
|
18
|
+
GetAttemptAllowanceFromJSON,
|
|
19
|
+
GetAttemptAllowanceToJSON,
|
|
20
|
+
} from '../models/GetAttemptAllowance';
|
|
16
21
|
import {
|
|
17
22
|
type GetCourse,
|
|
18
23
|
GetCourseFromJSON,
|
|
@@ -78,6 +83,16 @@ import {
|
|
|
78
83
|
GetCourseVersionSectionFromJSON,
|
|
79
84
|
GetCourseVersionSectionToJSON,
|
|
80
85
|
} from '../models/GetCourseVersionSection';
|
|
86
|
+
import {
|
|
87
|
+
type PostClearSessions,
|
|
88
|
+
PostClearSessionsFromJSON,
|
|
89
|
+
PostClearSessionsToJSON,
|
|
90
|
+
} from '../models/PostClearSessions';
|
|
91
|
+
import {
|
|
92
|
+
type PostClearSessionsResponse,
|
|
93
|
+
PostClearSessionsResponseFromJSON,
|
|
94
|
+
PostClearSessionsResponseToJSON,
|
|
95
|
+
} from '../models/PostClearSessionsResponse';
|
|
81
96
|
import {
|
|
82
97
|
type PostCourse,
|
|
83
98
|
PostCourseFromJSON,
|
|
@@ -133,6 +148,11 @@ import {
|
|
|
133
148
|
PostDuplicateFromJSON,
|
|
134
149
|
PostDuplicateToJSON,
|
|
135
150
|
} from '../models/PostDuplicate';
|
|
151
|
+
import {
|
|
152
|
+
type PutAttemptAllowance,
|
|
153
|
+
PutAttemptAllowanceFromJSON,
|
|
154
|
+
PutAttemptAllowanceToJSON,
|
|
155
|
+
} from '../models/PutAttemptAllowance';
|
|
136
156
|
import {
|
|
137
157
|
type PutCourse,
|
|
138
158
|
PutCourseFromJSON,
|
|
@@ -226,6 +246,13 @@ export interface GetCourseExportsRequest {
|
|
|
226
246
|
pageSize?: number;
|
|
227
247
|
}
|
|
228
248
|
|
|
249
|
+
export interface GetCourseItemLearnerAttemptAllowanceRequest {
|
|
250
|
+
courseId: string;
|
|
251
|
+
courseVersionId: string;
|
|
252
|
+
itemId: string;
|
|
253
|
+
userId: string;
|
|
254
|
+
}
|
|
255
|
+
|
|
229
256
|
export interface GetCourseListRequest {
|
|
230
257
|
page?: number;
|
|
231
258
|
pageSize?: number;
|
|
@@ -282,6 +309,14 @@ export interface PostCourseImageUploadRequest {
|
|
|
282
309
|
file: Blob;
|
|
283
310
|
}
|
|
284
311
|
|
|
312
|
+
export interface PostCourseItemLearnerSessionsClearRequest {
|
|
313
|
+
courseId: string;
|
|
314
|
+
courseVersionId: string;
|
|
315
|
+
itemId: string;
|
|
316
|
+
userId: string;
|
|
317
|
+
postClearSessions: PostClearSessions;
|
|
318
|
+
}
|
|
319
|
+
|
|
285
320
|
export interface PostCourseResumeRequest {
|
|
286
321
|
courseId: string;
|
|
287
322
|
}
|
|
@@ -327,6 +362,14 @@ export interface PutCourseEnrollmentRequest {
|
|
|
327
362
|
putCourseEnrollment: PutCourseEnrollment;
|
|
328
363
|
}
|
|
329
364
|
|
|
365
|
+
export interface PutCourseItemLearnerAttemptAllowanceRequest {
|
|
366
|
+
courseId: string;
|
|
367
|
+
courseVersionId: string;
|
|
368
|
+
itemId: string;
|
|
369
|
+
userId: string;
|
|
370
|
+
putAttemptAllowance: PutAttemptAllowance;
|
|
371
|
+
}
|
|
372
|
+
|
|
330
373
|
export interface PutCourseVersionItemRequest {
|
|
331
374
|
courseId: string;
|
|
332
375
|
sectionId: string;
|
|
@@ -1023,6 +1066,75 @@ export class CourseApi extends runtime.BaseAPI {
|
|
|
1023
1066
|
return await response.value();
|
|
1024
1067
|
}
|
|
1025
1068
|
|
|
1069
|
+
/**
|
|
1070
|
+
* Creates request options for getCourseItemLearnerAttemptAllowance without sending the request
|
|
1071
|
+
*/
|
|
1072
|
+
async getCourseItemLearnerAttemptAllowanceRequestOpts(requestParameters: GetCourseItemLearnerAttemptAllowanceRequest): Promise<runtime.RequestOpts> {
|
|
1073
|
+
if (requestParameters['courseId'] == null) {
|
|
1074
|
+
throw new runtime.RequiredError(
|
|
1075
|
+
'courseId',
|
|
1076
|
+
'Required parameter "courseId" was null or undefined when calling getCourseItemLearnerAttemptAllowance().'
|
|
1077
|
+
);
|
|
1078
|
+
}
|
|
1079
|
+
|
|
1080
|
+
if (requestParameters['courseVersionId'] == null) {
|
|
1081
|
+
throw new runtime.RequiredError(
|
|
1082
|
+
'courseVersionId',
|
|
1083
|
+
'Required parameter "courseVersionId" was null or undefined when calling getCourseItemLearnerAttemptAllowance().'
|
|
1084
|
+
);
|
|
1085
|
+
}
|
|
1086
|
+
|
|
1087
|
+
if (requestParameters['itemId'] == null) {
|
|
1088
|
+
throw new runtime.RequiredError(
|
|
1089
|
+
'itemId',
|
|
1090
|
+
'Required parameter "itemId" was null or undefined when calling getCourseItemLearnerAttemptAllowance().'
|
|
1091
|
+
);
|
|
1092
|
+
}
|
|
1093
|
+
|
|
1094
|
+
if (requestParameters['userId'] == null) {
|
|
1095
|
+
throw new runtime.RequiredError(
|
|
1096
|
+
'userId',
|
|
1097
|
+
'Required parameter "userId" was null or undefined when calling getCourseItemLearnerAttemptAllowance().'
|
|
1098
|
+
);
|
|
1099
|
+
}
|
|
1100
|
+
|
|
1101
|
+
const queryParameters: any = {};
|
|
1102
|
+
|
|
1103
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1104
|
+
|
|
1105
|
+
|
|
1106
|
+
let urlPath = `/courses/{courseId}/versions/{courseVersionId}/items/{itemId}/learners/{userId}/attempt-allowance`;
|
|
1107
|
+
urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
|
|
1108
|
+
urlPath = urlPath.replace('{courseVersionId}', encodeURIComponent(String(requestParameters['courseVersionId'])));
|
|
1109
|
+
urlPath = urlPath.replace('{itemId}', encodeURIComponent(String(requestParameters['itemId'])));
|
|
1110
|
+
urlPath = urlPath.replace('{userId}', encodeURIComponent(String(requestParameters['userId'])));
|
|
1111
|
+
|
|
1112
|
+
return {
|
|
1113
|
+
path: urlPath,
|
|
1114
|
+
method: 'GET',
|
|
1115
|
+
headers: headerParameters,
|
|
1116
|
+
query: queryParameters,
|
|
1117
|
+
};
|
|
1118
|
+
}
|
|
1119
|
+
|
|
1120
|
+
/**
|
|
1121
|
+
* Get a learner\'s effective attempt limit for a course item
|
|
1122
|
+
*/
|
|
1123
|
+
async getCourseItemLearnerAttemptAllowanceRaw(requestParameters: GetCourseItemLearnerAttemptAllowanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetAttemptAllowance>> {
|
|
1124
|
+
const requestOptions = await this.getCourseItemLearnerAttemptAllowanceRequestOpts(requestParameters);
|
|
1125
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
1126
|
+
|
|
1127
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetAttemptAllowanceFromJSON(jsonValue));
|
|
1128
|
+
}
|
|
1129
|
+
|
|
1130
|
+
/**
|
|
1131
|
+
* Get a learner\'s effective attempt limit for a course item
|
|
1132
|
+
*/
|
|
1133
|
+
async getCourseItemLearnerAttemptAllowance(requestParameters: GetCourseItemLearnerAttemptAllowanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetAttemptAllowance> {
|
|
1134
|
+
const response = await this.getCourseItemLearnerAttemptAllowanceRaw(requestParameters, initOverrides);
|
|
1135
|
+
return await response.value();
|
|
1136
|
+
}
|
|
1137
|
+
|
|
1026
1138
|
/**
|
|
1027
1139
|
* Creates request options for getCourseList without sending the request
|
|
1028
1140
|
*/
|
|
@@ -1614,6 +1726,85 @@ export class CourseApi extends runtime.BaseAPI {
|
|
|
1614
1726
|
return await response.value();
|
|
1615
1727
|
}
|
|
1616
1728
|
|
|
1729
|
+
/**
|
|
1730
|
+
* Creates request options for postCourseItemLearnerSessionsClear without sending the request
|
|
1731
|
+
*/
|
|
1732
|
+
async postCourseItemLearnerSessionsClearRequestOpts(requestParameters: PostCourseItemLearnerSessionsClearRequest): Promise<runtime.RequestOpts> {
|
|
1733
|
+
if (requestParameters['courseId'] == null) {
|
|
1734
|
+
throw new runtime.RequiredError(
|
|
1735
|
+
'courseId',
|
|
1736
|
+
'Required parameter "courseId" was null or undefined when calling postCourseItemLearnerSessionsClear().'
|
|
1737
|
+
);
|
|
1738
|
+
}
|
|
1739
|
+
|
|
1740
|
+
if (requestParameters['courseVersionId'] == null) {
|
|
1741
|
+
throw new runtime.RequiredError(
|
|
1742
|
+
'courseVersionId',
|
|
1743
|
+
'Required parameter "courseVersionId" was null or undefined when calling postCourseItemLearnerSessionsClear().'
|
|
1744
|
+
);
|
|
1745
|
+
}
|
|
1746
|
+
|
|
1747
|
+
if (requestParameters['itemId'] == null) {
|
|
1748
|
+
throw new runtime.RequiredError(
|
|
1749
|
+
'itemId',
|
|
1750
|
+
'Required parameter "itemId" was null or undefined when calling postCourseItemLearnerSessionsClear().'
|
|
1751
|
+
);
|
|
1752
|
+
}
|
|
1753
|
+
|
|
1754
|
+
if (requestParameters['userId'] == null) {
|
|
1755
|
+
throw new runtime.RequiredError(
|
|
1756
|
+
'userId',
|
|
1757
|
+
'Required parameter "userId" was null or undefined when calling postCourseItemLearnerSessionsClear().'
|
|
1758
|
+
);
|
|
1759
|
+
}
|
|
1760
|
+
|
|
1761
|
+
if (requestParameters['postClearSessions'] == null) {
|
|
1762
|
+
throw new runtime.RequiredError(
|
|
1763
|
+
'postClearSessions',
|
|
1764
|
+
'Required parameter "postClearSessions" was null or undefined when calling postCourseItemLearnerSessionsClear().'
|
|
1765
|
+
);
|
|
1766
|
+
}
|
|
1767
|
+
|
|
1768
|
+
const queryParameters: any = {};
|
|
1769
|
+
|
|
1770
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1771
|
+
|
|
1772
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
1773
|
+
|
|
1774
|
+
|
|
1775
|
+
let urlPath = `/courses/{courseId}/versions/{courseVersionId}/items/{itemId}/learners/{userId}/sessions/clear`;
|
|
1776
|
+
urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
|
|
1777
|
+
urlPath = urlPath.replace('{courseVersionId}', encodeURIComponent(String(requestParameters['courseVersionId'])));
|
|
1778
|
+
urlPath = urlPath.replace('{itemId}', encodeURIComponent(String(requestParameters['itemId'])));
|
|
1779
|
+
urlPath = urlPath.replace('{userId}', encodeURIComponent(String(requestParameters['userId'])));
|
|
1780
|
+
|
|
1781
|
+
return {
|
|
1782
|
+
path: urlPath,
|
|
1783
|
+
method: 'POST',
|
|
1784
|
+
headers: headerParameters,
|
|
1785
|
+
query: queryParameters,
|
|
1786
|
+
body: PostClearSessionsToJSON(requestParameters['postClearSessions']),
|
|
1787
|
+
};
|
|
1788
|
+
}
|
|
1789
|
+
|
|
1790
|
+
/**
|
|
1791
|
+
* Clear all live sessions for a learner and course item
|
|
1792
|
+
*/
|
|
1793
|
+
async postCourseItemLearnerSessionsClearRaw(requestParameters: PostCourseItemLearnerSessionsClearRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostClearSessionsResponse>> {
|
|
1794
|
+
const requestOptions = await this.postCourseItemLearnerSessionsClearRequestOpts(requestParameters);
|
|
1795
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
1796
|
+
|
|
1797
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => PostClearSessionsResponseFromJSON(jsonValue));
|
|
1798
|
+
}
|
|
1799
|
+
|
|
1800
|
+
/**
|
|
1801
|
+
* Clear all live sessions for a learner and course item
|
|
1802
|
+
*/
|
|
1803
|
+
async postCourseItemLearnerSessionsClear(requestParameters: PostCourseItemLearnerSessionsClearRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostClearSessionsResponse> {
|
|
1804
|
+
const response = await this.postCourseItemLearnerSessionsClearRaw(requestParameters, initOverrides);
|
|
1805
|
+
return await response.value();
|
|
1806
|
+
}
|
|
1807
|
+
|
|
1617
1808
|
/**
|
|
1618
1809
|
* Creates request options for postCourseResume without sending the request
|
|
1619
1810
|
*/
|
|
@@ -2080,6 +2271,85 @@ export class CourseApi extends runtime.BaseAPI {
|
|
|
2080
2271
|
return await response.value();
|
|
2081
2272
|
}
|
|
2082
2273
|
|
|
2274
|
+
/**
|
|
2275
|
+
* Creates request options for putCourseItemLearnerAttemptAllowance without sending the request
|
|
2276
|
+
*/
|
|
2277
|
+
async putCourseItemLearnerAttemptAllowanceRequestOpts(requestParameters: PutCourseItemLearnerAttemptAllowanceRequest): Promise<runtime.RequestOpts> {
|
|
2278
|
+
if (requestParameters['courseId'] == null) {
|
|
2279
|
+
throw new runtime.RequiredError(
|
|
2280
|
+
'courseId',
|
|
2281
|
+
'Required parameter "courseId" was null or undefined when calling putCourseItemLearnerAttemptAllowance().'
|
|
2282
|
+
);
|
|
2283
|
+
}
|
|
2284
|
+
|
|
2285
|
+
if (requestParameters['courseVersionId'] == null) {
|
|
2286
|
+
throw new runtime.RequiredError(
|
|
2287
|
+
'courseVersionId',
|
|
2288
|
+
'Required parameter "courseVersionId" was null or undefined when calling putCourseItemLearnerAttemptAllowance().'
|
|
2289
|
+
);
|
|
2290
|
+
}
|
|
2291
|
+
|
|
2292
|
+
if (requestParameters['itemId'] == null) {
|
|
2293
|
+
throw new runtime.RequiredError(
|
|
2294
|
+
'itemId',
|
|
2295
|
+
'Required parameter "itemId" was null or undefined when calling putCourseItemLearnerAttemptAllowance().'
|
|
2296
|
+
);
|
|
2297
|
+
}
|
|
2298
|
+
|
|
2299
|
+
if (requestParameters['userId'] == null) {
|
|
2300
|
+
throw new runtime.RequiredError(
|
|
2301
|
+
'userId',
|
|
2302
|
+
'Required parameter "userId" was null or undefined when calling putCourseItemLearnerAttemptAllowance().'
|
|
2303
|
+
);
|
|
2304
|
+
}
|
|
2305
|
+
|
|
2306
|
+
if (requestParameters['putAttemptAllowance'] == null) {
|
|
2307
|
+
throw new runtime.RequiredError(
|
|
2308
|
+
'putAttemptAllowance',
|
|
2309
|
+
'Required parameter "putAttemptAllowance" was null or undefined when calling putCourseItemLearnerAttemptAllowance().'
|
|
2310
|
+
);
|
|
2311
|
+
}
|
|
2312
|
+
|
|
2313
|
+
const queryParameters: any = {};
|
|
2314
|
+
|
|
2315
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
2316
|
+
|
|
2317
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
2318
|
+
|
|
2319
|
+
|
|
2320
|
+
let urlPath = `/courses/{courseId}/versions/{courseVersionId}/items/{itemId}/learners/{userId}/attempt-allowance`;
|
|
2321
|
+
urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
|
|
2322
|
+
urlPath = urlPath.replace('{courseVersionId}', encodeURIComponent(String(requestParameters['courseVersionId'])));
|
|
2323
|
+
urlPath = urlPath.replace('{itemId}', encodeURIComponent(String(requestParameters['itemId'])));
|
|
2324
|
+
urlPath = urlPath.replace('{userId}', encodeURIComponent(String(requestParameters['userId'])));
|
|
2325
|
+
|
|
2326
|
+
return {
|
|
2327
|
+
path: urlPath,
|
|
2328
|
+
method: 'PUT',
|
|
2329
|
+
headers: headerParameters,
|
|
2330
|
+
query: queryParameters,
|
|
2331
|
+
body: PutAttemptAllowanceToJSON(requestParameters['putAttemptAllowance']),
|
|
2332
|
+
};
|
|
2333
|
+
}
|
|
2334
|
+
|
|
2335
|
+
/**
|
|
2336
|
+
* Set extra attempts for a learner on a course item
|
|
2337
|
+
*/
|
|
2338
|
+
async putCourseItemLearnerAttemptAllowanceRaw(requestParameters: PutCourseItemLearnerAttemptAllowanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetAttemptAllowance>> {
|
|
2339
|
+
const requestOptions = await this.putCourseItemLearnerAttemptAllowanceRequestOpts(requestParameters);
|
|
2340
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
2341
|
+
|
|
2342
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetAttemptAllowanceFromJSON(jsonValue));
|
|
2343
|
+
}
|
|
2344
|
+
|
|
2345
|
+
/**
|
|
2346
|
+
* Set extra attempts for a learner on a course item
|
|
2347
|
+
*/
|
|
2348
|
+
async putCourseItemLearnerAttemptAllowance(requestParameters: PutCourseItemLearnerAttemptAllowanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetAttemptAllowance> {
|
|
2349
|
+
const response = await this.putCourseItemLearnerAttemptAllowanceRaw(requestParameters, initOverrides);
|
|
2350
|
+
return await response.value();
|
|
2351
|
+
}
|
|
2352
|
+
|
|
2083
2353
|
/**
|
|
2084
2354
|
* Creates request options for putCourseVersionItem without sending the request
|
|
2085
2355
|
*/
|
package/src/apis/PlayerApi.ts
CHANGED
|
@@ -58,6 +58,11 @@ import {
|
|
|
58
58
|
PostResourceSessionActivityEventFromJSON,
|
|
59
59
|
PostResourceSessionActivityEventToJSON,
|
|
60
60
|
} from '../models/PostResourceSessionActivityEvent';
|
|
61
|
+
import {
|
|
62
|
+
type PutResourceSessionOverride,
|
|
63
|
+
PutResourceSessionOverrideFromJSON,
|
|
64
|
+
PutResourceSessionOverrideToJSON,
|
|
65
|
+
} from '../models/PutResourceSessionOverride';
|
|
61
66
|
import {
|
|
62
67
|
type ResourceSessionEnvironment,
|
|
63
68
|
ResourceSessionEnvironmentFromJSON,
|
|
@@ -183,6 +188,11 @@ export interface PostResourceSessionCompleteRequest {
|
|
|
183
188
|
sessionId: string;
|
|
184
189
|
}
|
|
185
190
|
|
|
191
|
+
export interface PutResourceSessionOverrideRequest {
|
|
192
|
+
sessionId: string;
|
|
193
|
+
putResourceSessionOverride: PutResourceSessionOverride;
|
|
194
|
+
}
|
|
195
|
+
|
|
186
196
|
export interface SetResourceScormValueRequest {
|
|
187
197
|
sessionId: string;
|
|
188
198
|
scormSetValueRequest: ScormSetValueRequest;
|
|
@@ -1090,6 +1100,61 @@ export class PlayerApi extends runtime.BaseAPI {
|
|
|
1090
1100
|
return await response.value();
|
|
1091
1101
|
}
|
|
1092
1102
|
|
|
1103
|
+
/**
|
|
1104
|
+
* Creates request options for putResourceSessionOverride without sending the request
|
|
1105
|
+
*/
|
|
1106
|
+
async putResourceSessionOverrideRequestOpts(requestParameters: PutResourceSessionOverrideRequest): Promise<runtime.RequestOpts> {
|
|
1107
|
+
if (requestParameters['sessionId'] == null) {
|
|
1108
|
+
throw new runtime.RequiredError(
|
|
1109
|
+
'sessionId',
|
|
1110
|
+
'Required parameter "sessionId" was null or undefined when calling putResourceSessionOverride().'
|
|
1111
|
+
);
|
|
1112
|
+
}
|
|
1113
|
+
|
|
1114
|
+
if (requestParameters['putResourceSessionOverride'] == null) {
|
|
1115
|
+
throw new runtime.RequiredError(
|
|
1116
|
+
'putResourceSessionOverride',
|
|
1117
|
+
'Required parameter "putResourceSessionOverride" was null or undefined when calling putResourceSessionOverride().'
|
|
1118
|
+
);
|
|
1119
|
+
}
|
|
1120
|
+
|
|
1121
|
+
const queryParameters: any = {};
|
|
1122
|
+
|
|
1123
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1124
|
+
|
|
1125
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
1126
|
+
|
|
1127
|
+
|
|
1128
|
+
let urlPath = `/resource/sessions/{sessionId}/override`;
|
|
1129
|
+
urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
|
|
1130
|
+
|
|
1131
|
+
return {
|
|
1132
|
+
path: urlPath,
|
|
1133
|
+
method: 'PUT',
|
|
1134
|
+
headers: headerParameters,
|
|
1135
|
+
query: queryParameters,
|
|
1136
|
+
body: PutResourceSessionOverrideToJSON(requestParameters['putResourceSessionOverride']),
|
|
1137
|
+
};
|
|
1138
|
+
}
|
|
1139
|
+
|
|
1140
|
+
/**
|
|
1141
|
+
* Override a learner\'s live resource-session progress
|
|
1142
|
+
*/
|
|
1143
|
+
async putResourceSessionOverrideRaw(requestParameters: PutResourceSessionOverrideRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceSession>> {
|
|
1144
|
+
const requestOptions = await this.putResourceSessionOverrideRequestOpts(requestParameters);
|
|
1145
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
1146
|
+
|
|
1147
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetResourceSessionFromJSON(jsonValue));
|
|
1148
|
+
}
|
|
1149
|
+
|
|
1150
|
+
/**
|
|
1151
|
+
* Override a learner\'s live resource-session progress
|
|
1152
|
+
*/
|
|
1153
|
+
async putResourceSessionOverride(requestParameters: PutResourceSessionOverrideRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSession> {
|
|
1154
|
+
const response = await this.putResourceSessionOverrideRaw(requestParameters, initOverrides);
|
|
1155
|
+
return await response.value();
|
|
1156
|
+
}
|
|
1157
|
+
|
|
1093
1158
|
/**
|
|
1094
1159
|
* Creates request options for setResourceScormValue without sending the request
|
|
1095
1160
|
*/
|