@easyedu/js-lsm-api 1.9.0 → 1.10.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 +1 -0
- package/README.md +2 -2
- package/dist/apis/CourseApi.d.ts +17 -2
- package/dist/apis/CourseApi.js +38 -4
- package/dist/apis/PortalApi.d.ts +1 -0
- package/dist/apis/PortalApi.js +3 -0
- package/dist/esm/apis/CourseApi.d.ts +17 -2
- package/dist/esm/apis/CourseApi.js +38 -4
- package/dist/esm/apis/PortalApi.d.ts +1 -0
- package/dist/esm/apis/PortalApi.js +3 -0
- package/dist/esm/models/GetCourseEnrollmentList.d.ts +3 -3
- package/dist/esm/models/GetCourseEnrollmentList.js +3 -3
- package/dist/esm/models/GetCourseEnrollmentListItem.d.ts +89 -0
- package/dist/esm/models/GetCourseEnrollmentListItem.js +83 -0
- package/dist/esm/models/index.d.ts +1 -0
- package/dist/esm/models/index.js +1 -0
- package/dist/models/GetCourseEnrollmentList.d.ts +3 -3
- package/dist/models/GetCourseEnrollmentList.js +3 -3
- package/dist/models/GetCourseEnrollmentListItem.d.ts +89 -0
- package/dist/models/GetCourseEnrollmentListItem.js +91 -0
- package/dist/models/index.d.ts +1 -0
- package/dist/models/index.js +1 -0
- package/package.json +1 -1
- package/src/apis/CourseApi.ts +56 -3
- package/src/apis/PortalApi.ts +5 -0
- package/src/models/GetCourseEnrollmentList.ts +10 -10
- package/src/models/GetCourseEnrollmentListItem.ts +150 -0
- package/src/models/index.ts +1 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -26,6 +26,7 @@ src/models/GetContentUpload.ts
|
|
|
26
26
|
src/models/GetCourse.ts
|
|
27
27
|
src/models/GetCourseEnrollment.ts
|
|
28
28
|
src/models/GetCourseEnrollmentList.ts
|
|
29
|
+
src/models/GetCourseEnrollmentListItem.ts
|
|
29
30
|
src/models/GetCourseList.ts
|
|
30
31
|
src/models/GetModule.ts
|
|
31
32
|
src/models/GetModuleList.ts
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @easyedu/js-lsm-api@1.
|
|
1
|
+
## @easyedu/js-lsm-api@1.10.0
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @easyedu/js-lsm-api@1.
|
|
39
|
+
npm install @easyedu/js-lsm-api@1.10.0 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
package/dist/apis/CourseApi.d.ts
CHANGED
|
@@ -14,9 +14,16 @@ import type { GetCourse, GetCourseEnrollment, GetCourseEnrollmentList, GetCourse
|
|
|
14
14
|
export interface GetCourseRequest {
|
|
15
15
|
courseId: string;
|
|
16
16
|
}
|
|
17
|
+
export interface GetCourseEnrollmentRequest {
|
|
18
|
+
courseId: string;
|
|
19
|
+
enrollmentId: string;
|
|
20
|
+
}
|
|
17
21
|
export interface GetCourseEnrollmentsRequest {
|
|
18
22
|
courseId: string;
|
|
19
23
|
}
|
|
24
|
+
export interface GetCourseListRequest {
|
|
25
|
+
enrolled?: boolean;
|
|
26
|
+
}
|
|
20
27
|
export interface PostCourseRequest {
|
|
21
28
|
postCourse: PostCourse;
|
|
22
29
|
}
|
|
@@ -45,6 +52,14 @@ export declare class CourseApi extends runtime.BaseAPI {
|
|
|
45
52
|
* get course
|
|
46
53
|
*/
|
|
47
54
|
getCourse(requestParameters: GetCourseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourse>;
|
|
55
|
+
/**
|
|
56
|
+
* Get a specific course enrollment
|
|
57
|
+
*/
|
|
58
|
+
getCourseEnrollmentRaw(requestParameters: GetCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseEnrollment>>;
|
|
59
|
+
/**
|
|
60
|
+
* Get a specific course enrollment
|
|
61
|
+
*/
|
|
62
|
+
getCourseEnrollment(requestParameters: GetCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseEnrollment>;
|
|
48
63
|
/**
|
|
49
64
|
* Get course enrollments
|
|
50
65
|
*/
|
|
@@ -56,11 +71,11 @@ export declare class CourseApi extends runtime.BaseAPI {
|
|
|
56
71
|
/**
|
|
57
72
|
* get course list
|
|
58
73
|
*/
|
|
59
|
-
getCourseListRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseList>>;
|
|
74
|
+
getCourseListRaw(requestParameters: GetCourseListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseList>>;
|
|
60
75
|
/**
|
|
61
76
|
* get course list
|
|
62
77
|
*/
|
|
63
|
-
getCourseList(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseList>;
|
|
78
|
+
getCourseList(requestParameters?: GetCourseListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseList>;
|
|
64
79
|
/**
|
|
65
80
|
* Post a new course
|
|
66
81
|
*/
|
package/dist/apis/CourseApi.js
CHANGED
|
@@ -57,6 +57,37 @@ class CourseApi extends runtime.BaseAPI {
|
|
|
57
57
|
return yield response.value();
|
|
58
58
|
});
|
|
59
59
|
}
|
|
60
|
+
/**
|
|
61
|
+
* Get a specific course enrollment
|
|
62
|
+
*/
|
|
63
|
+
getCourseEnrollmentRaw(requestParameters, initOverrides) {
|
|
64
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
65
|
+
if (requestParameters['courseId'] == null) {
|
|
66
|
+
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getCourseEnrollment().');
|
|
67
|
+
}
|
|
68
|
+
if (requestParameters['enrollmentId'] == null) {
|
|
69
|
+
throw new runtime.RequiredError('enrollmentId', 'Required parameter "enrollmentId" was null or undefined when calling getCourseEnrollment().');
|
|
70
|
+
}
|
|
71
|
+
const queryParameters = {};
|
|
72
|
+
const headerParameters = {};
|
|
73
|
+
const response = yield this.request({
|
|
74
|
+
path: `/courses/{courseId}/enrollments/{enrollmentId}`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))).replace(`{${"enrollmentId"}}`, encodeURIComponent(String(requestParameters['enrollmentId']))),
|
|
75
|
+
method: 'GET',
|
|
76
|
+
headers: headerParameters,
|
|
77
|
+
query: queryParameters,
|
|
78
|
+
}, initOverrides);
|
|
79
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GetCourseEnrollmentFromJSON)(jsonValue));
|
|
80
|
+
});
|
|
81
|
+
}
|
|
82
|
+
/**
|
|
83
|
+
* Get a specific course enrollment
|
|
84
|
+
*/
|
|
85
|
+
getCourseEnrollment(requestParameters, initOverrides) {
|
|
86
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
87
|
+
const response = yield this.getCourseEnrollmentRaw(requestParameters, initOverrides);
|
|
88
|
+
return yield response.value();
|
|
89
|
+
});
|
|
90
|
+
}
|
|
60
91
|
/**
|
|
61
92
|
* Get course enrollments
|
|
62
93
|
*/
|
|
@@ -88,9 +119,12 @@ class CourseApi extends runtime.BaseAPI {
|
|
|
88
119
|
/**
|
|
89
120
|
* get course list
|
|
90
121
|
*/
|
|
91
|
-
getCourseListRaw(initOverrides) {
|
|
122
|
+
getCourseListRaw(requestParameters, initOverrides) {
|
|
92
123
|
return __awaiter(this, void 0, void 0, function* () {
|
|
93
124
|
const queryParameters = {};
|
|
125
|
+
if (requestParameters['enrolled'] != null) {
|
|
126
|
+
queryParameters['enrolled'] = requestParameters['enrolled'];
|
|
127
|
+
}
|
|
94
128
|
const headerParameters = {};
|
|
95
129
|
const response = yield this.request({
|
|
96
130
|
path: `/courses`,
|
|
@@ -104,9 +138,9 @@ class CourseApi extends runtime.BaseAPI {
|
|
|
104
138
|
/**
|
|
105
139
|
* get course list
|
|
106
140
|
*/
|
|
107
|
-
getCourseList(
|
|
108
|
-
return __awaiter(this,
|
|
109
|
-
const response = yield this.getCourseListRaw(initOverrides);
|
|
141
|
+
getCourseList() {
|
|
142
|
+
return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
|
|
143
|
+
const response = yield this.getCourseListRaw(requestParameters, initOverrides);
|
|
110
144
|
return yield response.value();
|
|
111
145
|
});
|
|
112
146
|
}
|
package/dist/apis/PortalApi.d.ts
CHANGED
package/dist/apis/PortalApi.js
CHANGED
|
@@ -94,6 +94,9 @@ class PortalApi extends runtime.BaseAPI {
|
|
|
94
94
|
if (requestParameters['roles'] != null) {
|
|
95
95
|
queryParameters['roles'] = requestParameters['roles'];
|
|
96
96
|
}
|
|
97
|
+
if (requestParameters['search'] != null) {
|
|
98
|
+
queryParameters['search'] = requestParameters['search'];
|
|
99
|
+
}
|
|
97
100
|
if (requestParameters['page'] != null) {
|
|
98
101
|
queryParameters['page'] = requestParameters['page'];
|
|
99
102
|
}
|
|
@@ -14,9 +14,16 @@ import type { GetCourse, GetCourseEnrollment, GetCourseEnrollmentList, GetCourse
|
|
|
14
14
|
export interface GetCourseRequest {
|
|
15
15
|
courseId: string;
|
|
16
16
|
}
|
|
17
|
+
export interface GetCourseEnrollmentRequest {
|
|
18
|
+
courseId: string;
|
|
19
|
+
enrollmentId: string;
|
|
20
|
+
}
|
|
17
21
|
export interface GetCourseEnrollmentsRequest {
|
|
18
22
|
courseId: string;
|
|
19
23
|
}
|
|
24
|
+
export interface GetCourseListRequest {
|
|
25
|
+
enrolled?: boolean;
|
|
26
|
+
}
|
|
20
27
|
export interface PostCourseRequest {
|
|
21
28
|
postCourse: PostCourse;
|
|
22
29
|
}
|
|
@@ -45,6 +52,14 @@ export declare class CourseApi extends runtime.BaseAPI {
|
|
|
45
52
|
* get course
|
|
46
53
|
*/
|
|
47
54
|
getCourse(requestParameters: GetCourseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourse>;
|
|
55
|
+
/**
|
|
56
|
+
* Get a specific course enrollment
|
|
57
|
+
*/
|
|
58
|
+
getCourseEnrollmentRaw(requestParameters: GetCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseEnrollment>>;
|
|
59
|
+
/**
|
|
60
|
+
* Get a specific course enrollment
|
|
61
|
+
*/
|
|
62
|
+
getCourseEnrollment(requestParameters: GetCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseEnrollment>;
|
|
48
63
|
/**
|
|
49
64
|
* Get course enrollments
|
|
50
65
|
*/
|
|
@@ -56,11 +71,11 @@ export declare class CourseApi extends runtime.BaseAPI {
|
|
|
56
71
|
/**
|
|
57
72
|
* get course list
|
|
58
73
|
*/
|
|
59
|
-
getCourseListRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseList>>;
|
|
74
|
+
getCourseListRaw(requestParameters: GetCourseListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseList>>;
|
|
60
75
|
/**
|
|
61
76
|
* get course list
|
|
62
77
|
*/
|
|
63
|
-
getCourseList(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseList>;
|
|
78
|
+
getCourseList(requestParameters?: GetCourseListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseList>;
|
|
64
79
|
/**
|
|
65
80
|
* Post a new course
|
|
66
81
|
*/
|
|
@@ -54,6 +54,37 @@ export class CourseApi extends runtime.BaseAPI {
|
|
|
54
54
|
return yield response.value();
|
|
55
55
|
});
|
|
56
56
|
}
|
|
57
|
+
/**
|
|
58
|
+
* Get a specific course enrollment
|
|
59
|
+
*/
|
|
60
|
+
getCourseEnrollmentRaw(requestParameters, initOverrides) {
|
|
61
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
62
|
+
if (requestParameters['courseId'] == null) {
|
|
63
|
+
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getCourseEnrollment().');
|
|
64
|
+
}
|
|
65
|
+
if (requestParameters['enrollmentId'] == null) {
|
|
66
|
+
throw new runtime.RequiredError('enrollmentId', 'Required parameter "enrollmentId" was null or undefined when calling getCourseEnrollment().');
|
|
67
|
+
}
|
|
68
|
+
const queryParameters = {};
|
|
69
|
+
const headerParameters = {};
|
|
70
|
+
const response = yield this.request({
|
|
71
|
+
path: `/courses/{courseId}/enrollments/{enrollmentId}`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))).replace(`{${"enrollmentId"}}`, encodeURIComponent(String(requestParameters['enrollmentId']))),
|
|
72
|
+
method: 'GET',
|
|
73
|
+
headers: headerParameters,
|
|
74
|
+
query: queryParameters,
|
|
75
|
+
}, initOverrides);
|
|
76
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetCourseEnrollmentFromJSON(jsonValue));
|
|
77
|
+
});
|
|
78
|
+
}
|
|
79
|
+
/**
|
|
80
|
+
* Get a specific course enrollment
|
|
81
|
+
*/
|
|
82
|
+
getCourseEnrollment(requestParameters, initOverrides) {
|
|
83
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
84
|
+
const response = yield this.getCourseEnrollmentRaw(requestParameters, initOverrides);
|
|
85
|
+
return yield response.value();
|
|
86
|
+
});
|
|
87
|
+
}
|
|
57
88
|
/**
|
|
58
89
|
* Get course enrollments
|
|
59
90
|
*/
|
|
@@ -85,9 +116,12 @@ export class CourseApi extends runtime.BaseAPI {
|
|
|
85
116
|
/**
|
|
86
117
|
* get course list
|
|
87
118
|
*/
|
|
88
|
-
getCourseListRaw(initOverrides) {
|
|
119
|
+
getCourseListRaw(requestParameters, initOverrides) {
|
|
89
120
|
return __awaiter(this, void 0, void 0, function* () {
|
|
90
121
|
const queryParameters = {};
|
|
122
|
+
if (requestParameters['enrolled'] != null) {
|
|
123
|
+
queryParameters['enrolled'] = requestParameters['enrolled'];
|
|
124
|
+
}
|
|
91
125
|
const headerParameters = {};
|
|
92
126
|
const response = yield this.request({
|
|
93
127
|
path: `/courses`,
|
|
@@ -101,9 +135,9 @@ export class CourseApi extends runtime.BaseAPI {
|
|
|
101
135
|
/**
|
|
102
136
|
* get course list
|
|
103
137
|
*/
|
|
104
|
-
getCourseList(
|
|
105
|
-
return __awaiter(this,
|
|
106
|
-
const response = yield this.getCourseListRaw(initOverrides);
|
|
138
|
+
getCourseList() {
|
|
139
|
+
return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
|
|
140
|
+
const response = yield this.getCourseListRaw(requestParameters, initOverrides);
|
|
107
141
|
return yield response.value();
|
|
108
142
|
});
|
|
109
143
|
}
|
|
@@ -91,6 +91,9 @@ export class PortalApi extends runtime.BaseAPI {
|
|
|
91
91
|
if (requestParameters['roles'] != null) {
|
|
92
92
|
queryParameters['roles'] = requestParameters['roles'];
|
|
93
93
|
}
|
|
94
|
+
if (requestParameters['search'] != null) {
|
|
95
|
+
queryParameters['search'] = requestParameters['search'];
|
|
96
|
+
}
|
|
94
97
|
if (requestParameters['page'] != null) {
|
|
95
98
|
queryParameters['page'] = requestParameters['page'];
|
|
96
99
|
}
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import type {
|
|
12
|
+
import type { GetCourseEnrollmentListItem } from './GetCourseEnrollmentListItem';
|
|
13
13
|
/**
|
|
14
14
|
* A list of course enrollments with pagination information
|
|
15
15
|
* @export
|
|
@@ -42,10 +42,10 @@ export interface GetCourseEnrollmentList {
|
|
|
42
42
|
totalItems: number;
|
|
43
43
|
/**
|
|
44
44
|
*
|
|
45
|
-
* @type {Array<
|
|
45
|
+
* @type {Array<GetCourseEnrollmentListItem>}
|
|
46
46
|
* @memberof GetCourseEnrollmentList
|
|
47
47
|
*/
|
|
48
|
-
items: Array<
|
|
48
|
+
items: Array<GetCourseEnrollmentListItem>;
|
|
49
49
|
}
|
|
50
50
|
/**
|
|
51
51
|
* Check if a given object implements the GetCourseEnrollmentList interface.
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
* https://openapi-generator.tech
|
|
12
12
|
* Do not edit the class manually.
|
|
13
13
|
*/
|
|
14
|
-
import {
|
|
14
|
+
import { GetCourseEnrollmentListItemFromJSON, GetCourseEnrollmentListItemToJSON, } from './GetCourseEnrollmentListItem';
|
|
15
15
|
/**
|
|
16
16
|
* Check if a given object implements the GetCourseEnrollmentList interface.
|
|
17
17
|
*/
|
|
@@ -40,7 +40,7 @@ export function GetCourseEnrollmentListFromJSONTyped(json, ignoreDiscriminator)
|
|
|
40
40
|
'pageSize': json['pageSize'],
|
|
41
41
|
'totalPages': json['totalPages'],
|
|
42
42
|
'totalItems': json['totalItems'],
|
|
43
|
-
'items': (json['items'].map(
|
|
43
|
+
'items': (json['items'].map(GetCourseEnrollmentListItemFromJSON)),
|
|
44
44
|
};
|
|
45
45
|
}
|
|
46
46
|
export function GetCourseEnrollmentListToJSON(json) {
|
|
@@ -55,6 +55,6 @@ export function GetCourseEnrollmentListToJSONTyped(value, ignoreDiscriminator =
|
|
|
55
55
|
'pageSize': value['pageSize'],
|
|
56
56
|
'totalPages': value['totalPages'],
|
|
57
57
|
'totalItems': value['totalItems'],
|
|
58
|
-
'items': (value['items'].map(
|
|
58
|
+
'items': (value['items'].map(GetCourseEnrollmentListItemToJSON)),
|
|
59
59
|
};
|
|
60
60
|
}
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* LMS API
|
|
3
|
+
* LMS API
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* A course enrollment in a list view
|
|
14
|
+
* @export
|
|
15
|
+
* @interface GetCourseEnrollmentListItem
|
|
16
|
+
*/
|
|
17
|
+
export interface GetCourseEnrollmentListItem {
|
|
18
|
+
/**
|
|
19
|
+
* The external ID of the enrollment
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof GetCourseEnrollmentListItem
|
|
22
|
+
*/
|
|
23
|
+
id: string;
|
|
24
|
+
/**
|
|
25
|
+
* The external ID of the course
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof GetCourseEnrollmentListItem
|
|
28
|
+
*/
|
|
29
|
+
courseId: string;
|
|
30
|
+
/**
|
|
31
|
+
* The external ID of the enrolled user
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof GetCourseEnrollmentListItem
|
|
34
|
+
*/
|
|
35
|
+
userId: string;
|
|
36
|
+
/**
|
|
37
|
+
* The first name of the enrolled user
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof GetCourseEnrollmentListItem
|
|
40
|
+
*/
|
|
41
|
+
firstName: string;
|
|
42
|
+
/**
|
|
43
|
+
* The last name of the enrolled user
|
|
44
|
+
* @type {string}
|
|
45
|
+
* @memberof GetCourseEnrollmentListItem
|
|
46
|
+
*/
|
|
47
|
+
lastName: string;
|
|
48
|
+
/**
|
|
49
|
+
* Start date of the enrollment (Unix timestamp)
|
|
50
|
+
* @type {number}
|
|
51
|
+
* @memberof GetCourseEnrollmentListItem
|
|
52
|
+
*/
|
|
53
|
+
enrollmentDateStart: number;
|
|
54
|
+
/**
|
|
55
|
+
* End date of the enrollment (Unix timestamp)
|
|
56
|
+
* @type {number}
|
|
57
|
+
* @memberof GetCourseEnrollmentListItem
|
|
58
|
+
*/
|
|
59
|
+
enrollmentDateEnd: number;
|
|
60
|
+
/**
|
|
61
|
+
* Current status of the enrollment
|
|
62
|
+
* @type {string}
|
|
63
|
+
* @memberof GetCourseEnrollmentListItem
|
|
64
|
+
*/
|
|
65
|
+
status: GetCourseEnrollmentListItemStatusEnum;
|
|
66
|
+
/**
|
|
67
|
+
* Date the course was completed (Unix timestamp)
|
|
68
|
+
* @type {number}
|
|
69
|
+
* @memberof GetCourseEnrollmentListItem
|
|
70
|
+
*/
|
|
71
|
+
completionDate: number | null;
|
|
72
|
+
}
|
|
73
|
+
/**
|
|
74
|
+
* @export
|
|
75
|
+
*/
|
|
76
|
+
export declare const GetCourseEnrollmentListItemStatusEnum: {
|
|
77
|
+
readonly Enrolled: "Enrolled";
|
|
78
|
+
readonly Completed: "Completed";
|
|
79
|
+
readonly Removed: "Removed";
|
|
80
|
+
};
|
|
81
|
+
export type GetCourseEnrollmentListItemStatusEnum = typeof GetCourseEnrollmentListItemStatusEnum[keyof typeof GetCourseEnrollmentListItemStatusEnum];
|
|
82
|
+
/**
|
|
83
|
+
* Check if a given object implements the GetCourseEnrollmentListItem interface.
|
|
84
|
+
*/
|
|
85
|
+
export declare function instanceOfGetCourseEnrollmentListItem(value: object): value is GetCourseEnrollmentListItem;
|
|
86
|
+
export declare function GetCourseEnrollmentListItemFromJSON(json: any): GetCourseEnrollmentListItem;
|
|
87
|
+
export declare function GetCourseEnrollmentListItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseEnrollmentListItem;
|
|
88
|
+
export declare function GetCourseEnrollmentListItemToJSON(json: any): GetCourseEnrollmentListItem;
|
|
89
|
+
export declare function GetCourseEnrollmentListItemToJSONTyped(value?: GetCourseEnrollmentListItem | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* LMS API
|
|
5
|
+
* LMS API
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
/**
|
|
15
|
+
* @export
|
|
16
|
+
*/
|
|
17
|
+
export const GetCourseEnrollmentListItemStatusEnum = {
|
|
18
|
+
Enrolled: 'Enrolled',
|
|
19
|
+
Completed: 'Completed',
|
|
20
|
+
Removed: 'Removed'
|
|
21
|
+
};
|
|
22
|
+
/**
|
|
23
|
+
* Check if a given object implements the GetCourseEnrollmentListItem interface.
|
|
24
|
+
*/
|
|
25
|
+
export function instanceOfGetCourseEnrollmentListItem(value) {
|
|
26
|
+
if (!('id' in value) || value['id'] === undefined)
|
|
27
|
+
return false;
|
|
28
|
+
if (!('courseId' in value) || value['courseId'] === undefined)
|
|
29
|
+
return false;
|
|
30
|
+
if (!('userId' in value) || value['userId'] === undefined)
|
|
31
|
+
return false;
|
|
32
|
+
if (!('firstName' in value) || value['firstName'] === undefined)
|
|
33
|
+
return false;
|
|
34
|
+
if (!('lastName' in value) || value['lastName'] === undefined)
|
|
35
|
+
return false;
|
|
36
|
+
if (!('enrollmentDateStart' in value) || value['enrollmentDateStart'] === undefined)
|
|
37
|
+
return false;
|
|
38
|
+
if (!('enrollmentDateEnd' in value) || value['enrollmentDateEnd'] === undefined)
|
|
39
|
+
return false;
|
|
40
|
+
if (!('status' in value) || value['status'] === undefined)
|
|
41
|
+
return false;
|
|
42
|
+
if (!('completionDate' in value) || value['completionDate'] === undefined)
|
|
43
|
+
return false;
|
|
44
|
+
return true;
|
|
45
|
+
}
|
|
46
|
+
export function GetCourseEnrollmentListItemFromJSON(json) {
|
|
47
|
+
return GetCourseEnrollmentListItemFromJSONTyped(json, false);
|
|
48
|
+
}
|
|
49
|
+
export function GetCourseEnrollmentListItemFromJSONTyped(json, ignoreDiscriminator) {
|
|
50
|
+
if (json == null) {
|
|
51
|
+
return json;
|
|
52
|
+
}
|
|
53
|
+
return {
|
|
54
|
+
'id': json['id'],
|
|
55
|
+
'courseId': json['course_id'],
|
|
56
|
+
'userId': json['user_id'],
|
|
57
|
+
'firstName': json['first_name'],
|
|
58
|
+
'lastName': json['last_name'],
|
|
59
|
+
'enrollmentDateStart': json['enrollment_date_start'],
|
|
60
|
+
'enrollmentDateEnd': json['enrollment_date_end'],
|
|
61
|
+
'status': json['status'],
|
|
62
|
+
'completionDate': json['completion_date'],
|
|
63
|
+
};
|
|
64
|
+
}
|
|
65
|
+
export function GetCourseEnrollmentListItemToJSON(json) {
|
|
66
|
+
return GetCourseEnrollmentListItemToJSONTyped(json, false);
|
|
67
|
+
}
|
|
68
|
+
export function GetCourseEnrollmentListItemToJSONTyped(value, ignoreDiscriminator = false) {
|
|
69
|
+
if (value == null) {
|
|
70
|
+
return value;
|
|
71
|
+
}
|
|
72
|
+
return {
|
|
73
|
+
'id': value['id'],
|
|
74
|
+
'course_id': value['courseId'],
|
|
75
|
+
'user_id': value['userId'],
|
|
76
|
+
'first_name': value['firstName'],
|
|
77
|
+
'last_name': value['lastName'],
|
|
78
|
+
'enrollment_date_start': value['enrollmentDateStart'],
|
|
79
|
+
'enrollment_date_end': value['enrollmentDateEnd'],
|
|
80
|
+
'status': value['status'],
|
|
81
|
+
'completion_date': value['completionDate'],
|
|
82
|
+
};
|
|
83
|
+
}
|
|
@@ -11,6 +11,7 @@ export * from './GetContentUpload';
|
|
|
11
11
|
export * from './GetCourse';
|
|
12
12
|
export * from './GetCourseEnrollment';
|
|
13
13
|
export * from './GetCourseEnrollmentList';
|
|
14
|
+
export * from './GetCourseEnrollmentListItem';
|
|
14
15
|
export * from './GetCourseList';
|
|
15
16
|
export * from './GetModule';
|
|
16
17
|
export * from './GetModuleList';
|
package/dist/esm/models/index.js
CHANGED
|
@@ -13,6 +13,7 @@ export * from './GetContentUpload';
|
|
|
13
13
|
export * from './GetCourse';
|
|
14
14
|
export * from './GetCourseEnrollment';
|
|
15
15
|
export * from './GetCourseEnrollmentList';
|
|
16
|
+
export * from './GetCourseEnrollmentListItem';
|
|
16
17
|
export * from './GetCourseList';
|
|
17
18
|
export * from './GetModule';
|
|
18
19
|
export * from './GetModuleList';
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import type {
|
|
12
|
+
import type { GetCourseEnrollmentListItem } from './GetCourseEnrollmentListItem';
|
|
13
13
|
/**
|
|
14
14
|
* A list of course enrollments with pagination information
|
|
15
15
|
* @export
|
|
@@ -42,10 +42,10 @@ export interface GetCourseEnrollmentList {
|
|
|
42
42
|
totalItems: number;
|
|
43
43
|
/**
|
|
44
44
|
*
|
|
45
|
-
* @type {Array<
|
|
45
|
+
* @type {Array<GetCourseEnrollmentListItem>}
|
|
46
46
|
* @memberof GetCourseEnrollmentList
|
|
47
47
|
*/
|
|
48
|
-
items: Array<
|
|
48
|
+
items: Array<GetCourseEnrollmentListItem>;
|
|
49
49
|
}
|
|
50
50
|
/**
|
|
51
51
|
* Check if a given object implements the GetCourseEnrollmentList interface.
|
|
@@ -18,7 +18,7 @@ exports.GetCourseEnrollmentListFromJSON = GetCourseEnrollmentListFromJSON;
|
|
|
18
18
|
exports.GetCourseEnrollmentListFromJSONTyped = GetCourseEnrollmentListFromJSONTyped;
|
|
19
19
|
exports.GetCourseEnrollmentListToJSON = GetCourseEnrollmentListToJSON;
|
|
20
20
|
exports.GetCourseEnrollmentListToJSONTyped = GetCourseEnrollmentListToJSONTyped;
|
|
21
|
-
const
|
|
21
|
+
const GetCourseEnrollmentListItem_1 = require("./GetCourseEnrollmentListItem");
|
|
22
22
|
/**
|
|
23
23
|
* Check if a given object implements the GetCourseEnrollmentList interface.
|
|
24
24
|
*/
|
|
@@ -47,7 +47,7 @@ function GetCourseEnrollmentListFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
47
47
|
'pageSize': json['pageSize'],
|
|
48
48
|
'totalPages': json['totalPages'],
|
|
49
49
|
'totalItems': json['totalItems'],
|
|
50
|
-
'items': (json['items'].map(
|
|
50
|
+
'items': (json['items'].map(GetCourseEnrollmentListItem_1.GetCourseEnrollmentListItemFromJSON)),
|
|
51
51
|
};
|
|
52
52
|
}
|
|
53
53
|
function GetCourseEnrollmentListToJSON(json) {
|
|
@@ -62,6 +62,6 @@ function GetCourseEnrollmentListToJSONTyped(value, ignoreDiscriminator = false)
|
|
|
62
62
|
'pageSize': value['pageSize'],
|
|
63
63
|
'totalPages': value['totalPages'],
|
|
64
64
|
'totalItems': value['totalItems'],
|
|
65
|
-
'items': (value['items'].map(
|
|
65
|
+
'items': (value['items'].map(GetCourseEnrollmentListItem_1.GetCourseEnrollmentListItemToJSON)),
|
|
66
66
|
};
|
|
67
67
|
}
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* LMS API
|
|
3
|
+
* LMS API
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* A course enrollment in a list view
|
|
14
|
+
* @export
|
|
15
|
+
* @interface GetCourseEnrollmentListItem
|
|
16
|
+
*/
|
|
17
|
+
export interface GetCourseEnrollmentListItem {
|
|
18
|
+
/**
|
|
19
|
+
* The external ID of the enrollment
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof GetCourseEnrollmentListItem
|
|
22
|
+
*/
|
|
23
|
+
id: string;
|
|
24
|
+
/**
|
|
25
|
+
* The external ID of the course
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof GetCourseEnrollmentListItem
|
|
28
|
+
*/
|
|
29
|
+
courseId: string;
|
|
30
|
+
/**
|
|
31
|
+
* The external ID of the enrolled user
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof GetCourseEnrollmentListItem
|
|
34
|
+
*/
|
|
35
|
+
userId: string;
|
|
36
|
+
/**
|
|
37
|
+
* The first name of the enrolled user
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof GetCourseEnrollmentListItem
|
|
40
|
+
*/
|
|
41
|
+
firstName: string;
|
|
42
|
+
/**
|
|
43
|
+
* The last name of the enrolled user
|
|
44
|
+
* @type {string}
|
|
45
|
+
* @memberof GetCourseEnrollmentListItem
|
|
46
|
+
*/
|
|
47
|
+
lastName: string;
|
|
48
|
+
/**
|
|
49
|
+
* Start date of the enrollment (Unix timestamp)
|
|
50
|
+
* @type {number}
|
|
51
|
+
* @memberof GetCourseEnrollmentListItem
|
|
52
|
+
*/
|
|
53
|
+
enrollmentDateStart: number;
|
|
54
|
+
/**
|
|
55
|
+
* End date of the enrollment (Unix timestamp)
|
|
56
|
+
* @type {number}
|
|
57
|
+
* @memberof GetCourseEnrollmentListItem
|
|
58
|
+
*/
|
|
59
|
+
enrollmentDateEnd: number;
|
|
60
|
+
/**
|
|
61
|
+
* Current status of the enrollment
|
|
62
|
+
* @type {string}
|
|
63
|
+
* @memberof GetCourseEnrollmentListItem
|
|
64
|
+
*/
|
|
65
|
+
status: GetCourseEnrollmentListItemStatusEnum;
|
|
66
|
+
/**
|
|
67
|
+
* Date the course was completed (Unix timestamp)
|
|
68
|
+
* @type {number}
|
|
69
|
+
* @memberof GetCourseEnrollmentListItem
|
|
70
|
+
*/
|
|
71
|
+
completionDate: number | null;
|
|
72
|
+
}
|
|
73
|
+
/**
|
|
74
|
+
* @export
|
|
75
|
+
*/
|
|
76
|
+
export declare const GetCourseEnrollmentListItemStatusEnum: {
|
|
77
|
+
readonly Enrolled: "Enrolled";
|
|
78
|
+
readonly Completed: "Completed";
|
|
79
|
+
readonly Removed: "Removed";
|
|
80
|
+
};
|
|
81
|
+
export type GetCourseEnrollmentListItemStatusEnum = typeof GetCourseEnrollmentListItemStatusEnum[keyof typeof GetCourseEnrollmentListItemStatusEnum];
|
|
82
|
+
/**
|
|
83
|
+
* Check if a given object implements the GetCourseEnrollmentListItem interface.
|
|
84
|
+
*/
|
|
85
|
+
export declare function instanceOfGetCourseEnrollmentListItem(value: object): value is GetCourseEnrollmentListItem;
|
|
86
|
+
export declare function GetCourseEnrollmentListItemFromJSON(json: any): GetCourseEnrollmentListItem;
|
|
87
|
+
export declare function GetCourseEnrollmentListItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseEnrollmentListItem;
|
|
88
|
+
export declare function GetCourseEnrollmentListItemToJSON(json: any): GetCourseEnrollmentListItem;
|
|
89
|
+
export declare function GetCourseEnrollmentListItemToJSONTyped(value?: GetCourseEnrollmentListItem | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* LMS API
|
|
6
|
+
* LMS API
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.GetCourseEnrollmentListItemStatusEnum = void 0;
|
|
17
|
+
exports.instanceOfGetCourseEnrollmentListItem = instanceOfGetCourseEnrollmentListItem;
|
|
18
|
+
exports.GetCourseEnrollmentListItemFromJSON = GetCourseEnrollmentListItemFromJSON;
|
|
19
|
+
exports.GetCourseEnrollmentListItemFromJSONTyped = GetCourseEnrollmentListItemFromJSONTyped;
|
|
20
|
+
exports.GetCourseEnrollmentListItemToJSON = GetCourseEnrollmentListItemToJSON;
|
|
21
|
+
exports.GetCourseEnrollmentListItemToJSONTyped = GetCourseEnrollmentListItemToJSONTyped;
|
|
22
|
+
/**
|
|
23
|
+
* @export
|
|
24
|
+
*/
|
|
25
|
+
exports.GetCourseEnrollmentListItemStatusEnum = {
|
|
26
|
+
Enrolled: 'Enrolled',
|
|
27
|
+
Completed: 'Completed',
|
|
28
|
+
Removed: 'Removed'
|
|
29
|
+
};
|
|
30
|
+
/**
|
|
31
|
+
* Check if a given object implements the GetCourseEnrollmentListItem interface.
|
|
32
|
+
*/
|
|
33
|
+
function instanceOfGetCourseEnrollmentListItem(value) {
|
|
34
|
+
if (!('id' in value) || value['id'] === undefined)
|
|
35
|
+
return false;
|
|
36
|
+
if (!('courseId' in value) || value['courseId'] === undefined)
|
|
37
|
+
return false;
|
|
38
|
+
if (!('userId' in value) || value['userId'] === undefined)
|
|
39
|
+
return false;
|
|
40
|
+
if (!('firstName' in value) || value['firstName'] === undefined)
|
|
41
|
+
return false;
|
|
42
|
+
if (!('lastName' in value) || value['lastName'] === undefined)
|
|
43
|
+
return false;
|
|
44
|
+
if (!('enrollmentDateStart' in value) || value['enrollmentDateStart'] === undefined)
|
|
45
|
+
return false;
|
|
46
|
+
if (!('enrollmentDateEnd' in value) || value['enrollmentDateEnd'] === undefined)
|
|
47
|
+
return false;
|
|
48
|
+
if (!('status' in value) || value['status'] === undefined)
|
|
49
|
+
return false;
|
|
50
|
+
if (!('completionDate' in value) || value['completionDate'] === undefined)
|
|
51
|
+
return false;
|
|
52
|
+
return true;
|
|
53
|
+
}
|
|
54
|
+
function GetCourseEnrollmentListItemFromJSON(json) {
|
|
55
|
+
return GetCourseEnrollmentListItemFromJSONTyped(json, false);
|
|
56
|
+
}
|
|
57
|
+
function GetCourseEnrollmentListItemFromJSONTyped(json, ignoreDiscriminator) {
|
|
58
|
+
if (json == null) {
|
|
59
|
+
return json;
|
|
60
|
+
}
|
|
61
|
+
return {
|
|
62
|
+
'id': json['id'],
|
|
63
|
+
'courseId': json['course_id'],
|
|
64
|
+
'userId': json['user_id'],
|
|
65
|
+
'firstName': json['first_name'],
|
|
66
|
+
'lastName': json['last_name'],
|
|
67
|
+
'enrollmentDateStart': json['enrollment_date_start'],
|
|
68
|
+
'enrollmentDateEnd': json['enrollment_date_end'],
|
|
69
|
+
'status': json['status'],
|
|
70
|
+
'completionDate': json['completion_date'],
|
|
71
|
+
};
|
|
72
|
+
}
|
|
73
|
+
function GetCourseEnrollmentListItemToJSON(json) {
|
|
74
|
+
return GetCourseEnrollmentListItemToJSONTyped(json, false);
|
|
75
|
+
}
|
|
76
|
+
function GetCourseEnrollmentListItemToJSONTyped(value, ignoreDiscriminator = false) {
|
|
77
|
+
if (value == null) {
|
|
78
|
+
return value;
|
|
79
|
+
}
|
|
80
|
+
return {
|
|
81
|
+
'id': value['id'],
|
|
82
|
+
'course_id': value['courseId'],
|
|
83
|
+
'user_id': value['userId'],
|
|
84
|
+
'first_name': value['firstName'],
|
|
85
|
+
'last_name': value['lastName'],
|
|
86
|
+
'enrollment_date_start': value['enrollmentDateStart'],
|
|
87
|
+
'enrollment_date_end': value['enrollmentDateEnd'],
|
|
88
|
+
'status': value['status'],
|
|
89
|
+
'completion_date': value['completionDate'],
|
|
90
|
+
};
|
|
91
|
+
}
|
package/dist/models/index.d.ts
CHANGED
|
@@ -11,6 +11,7 @@ export * from './GetContentUpload';
|
|
|
11
11
|
export * from './GetCourse';
|
|
12
12
|
export * from './GetCourseEnrollment';
|
|
13
13
|
export * from './GetCourseEnrollmentList';
|
|
14
|
+
export * from './GetCourseEnrollmentListItem';
|
|
14
15
|
export * from './GetCourseList';
|
|
15
16
|
export * from './GetModule';
|
|
16
17
|
export * from './GetModuleList';
|
package/dist/models/index.js
CHANGED
|
@@ -29,6 +29,7 @@ __exportStar(require("./GetContentUpload"), exports);
|
|
|
29
29
|
__exportStar(require("./GetCourse"), exports);
|
|
30
30
|
__exportStar(require("./GetCourseEnrollment"), exports);
|
|
31
31
|
__exportStar(require("./GetCourseEnrollmentList"), exports);
|
|
32
|
+
__exportStar(require("./GetCourseEnrollmentListItem"), exports);
|
|
32
33
|
__exportStar(require("./GetCourseList"), exports);
|
|
33
34
|
__exportStar(require("./GetModule"), exports);
|
|
34
35
|
__exportStar(require("./GetModuleList"), exports);
|
package/package.json
CHANGED
package/src/apis/CourseApi.ts
CHANGED
|
@@ -47,10 +47,19 @@ export interface GetCourseRequest {
|
|
|
47
47
|
courseId: string;
|
|
48
48
|
}
|
|
49
49
|
|
|
50
|
+
export interface GetCourseEnrollmentRequest {
|
|
51
|
+
courseId: string;
|
|
52
|
+
enrollmentId: string;
|
|
53
|
+
}
|
|
54
|
+
|
|
50
55
|
export interface GetCourseEnrollmentsRequest {
|
|
51
56
|
courseId: string;
|
|
52
57
|
}
|
|
53
58
|
|
|
59
|
+
export interface GetCourseListRequest {
|
|
60
|
+
enrolled?: boolean;
|
|
61
|
+
}
|
|
62
|
+
|
|
54
63
|
export interface PostCourseRequest {
|
|
55
64
|
postCourse: PostCourse;
|
|
56
65
|
}
|
|
@@ -109,6 +118,46 @@ export class CourseApi extends runtime.BaseAPI {
|
|
|
109
118
|
return await response.value();
|
|
110
119
|
}
|
|
111
120
|
|
|
121
|
+
/**
|
|
122
|
+
* Get a specific course enrollment
|
|
123
|
+
*/
|
|
124
|
+
async getCourseEnrollmentRaw(requestParameters: GetCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseEnrollment>> {
|
|
125
|
+
if (requestParameters['courseId'] == null) {
|
|
126
|
+
throw new runtime.RequiredError(
|
|
127
|
+
'courseId',
|
|
128
|
+
'Required parameter "courseId" was null or undefined when calling getCourseEnrollment().'
|
|
129
|
+
);
|
|
130
|
+
}
|
|
131
|
+
|
|
132
|
+
if (requestParameters['enrollmentId'] == null) {
|
|
133
|
+
throw new runtime.RequiredError(
|
|
134
|
+
'enrollmentId',
|
|
135
|
+
'Required parameter "enrollmentId" was null or undefined when calling getCourseEnrollment().'
|
|
136
|
+
);
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
const queryParameters: any = {};
|
|
140
|
+
|
|
141
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
142
|
+
|
|
143
|
+
const response = await this.request({
|
|
144
|
+
path: `/courses/{courseId}/enrollments/{enrollmentId}`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))).replace(`{${"enrollmentId"}}`, encodeURIComponent(String(requestParameters['enrollmentId']))),
|
|
145
|
+
method: 'GET',
|
|
146
|
+
headers: headerParameters,
|
|
147
|
+
query: queryParameters,
|
|
148
|
+
}, initOverrides);
|
|
149
|
+
|
|
150
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetCourseEnrollmentFromJSON(jsonValue));
|
|
151
|
+
}
|
|
152
|
+
|
|
153
|
+
/**
|
|
154
|
+
* Get a specific course enrollment
|
|
155
|
+
*/
|
|
156
|
+
async getCourseEnrollment(requestParameters: GetCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseEnrollment> {
|
|
157
|
+
const response = await this.getCourseEnrollmentRaw(requestParameters, initOverrides);
|
|
158
|
+
return await response.value();
|
|
159
|
+
}
|
|
160
|
+
|
|
112
161
|
/**
|
|
113
162
|
* Get course enrollments
|
|
114
163
|
*/
|
|
@@ -145,9 +194,13 @@ export class CourseApi extends runtime.BaseAPI {
|
|
|
145
194
|
/**
|
|
146
195
|
* get course list
|
|
147
196
|
*/
|
|
148
|
-
async getCourseListRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseList>> {
|
|
197
|
+
async getCourseListRaw(requestParameters: GetCourseListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseList>> {
|
|
149
198
|
const queryParameters: any = {};
|
|
150
199
|
|
|
200
|
+
if (requestParameters['enrolled'] != null) {
|
|
201
|
+
queryParameters['enrolled'] = requestParameters['enrolled'];
|
|
202
|
+
}
|
|
203
|
+
|
|
151
204
|
const headerParameters: runtime.HTTPHeaders = {};
|
|
152
205
|
|
|
153
206
|
const response = await this.request({
|
|
@@ -163,8 +216,8 @@ export class CourseApi extends runtime.BaseAPI {
|
|
|
163
216
|
/**
|
|
164
217
|
* get course list
|
|
165
218
|
*/
|
|
166
|
-
async getCourseList(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseList> {
|
|
167
|
-
const response = await this.getCourseListRaw(initOverrides);
|
|
219
|
+
async getCourseList(requestParameters: GetCourseListRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseList> {
|
|
220
|
+
const response = await this.getCourseListRaw(requestParameters, initOverrides);
|
|
168
221
|
return await response.value();
|
|
169
222
|
}
|
|
170
223
|
|
package/src/apis/PortalApi.ts
CHANGED
|
@@ -44,6 +44,7 @@ export interface GetPortalByIdRequest {
|
|
|
44
44
|
export interface GetPortalUsersRequest {
|
|
45
45
|
portalId: string;
|
|
46
46
|
roles?: Array<GetPortalUsersRolesEnum>;
|
|
47
|
+
search?: string;
|
|
47
48
|
page?: number;
|
|
48
49
|
pageSize?: number;
|
|
49
50
|
}
|
|
@@ -148,6 +149,10 @@ export class PortalApi extends runtime.BaseAPI {
|
|
|
148
149
|
queryParameters['roles'] = requestParameters['roles'];
|
|
149
150
|
}
|
|
150
151
|
|
|
152
|
+
if (requestParameters['search'] != null) {
|
|
153
|
+
queryParameters['search'] = requestParameters['search'];
|
|
154
|
+
}
|
|
155
|
+
|
|
151
156
|
if (requestParameters['page'] != null) {
|
|
152
157
|
queryParameters['page'] = requestParameters['page'];
|
|
153
158
|
}
|
|
@@ -13,13 +13,13 @@
|
|
|
13
13
|
*/
|
|
14
14
|
|
|
15
15
|
import { mapValues } from '../runtime';
|
|
16
|
-
import type {
|
|
16
|
+
import type { GetCourseEnrollmentListItem } from './GetCourseEnrollmentListItem';
|
|
17
17
|
import {
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
} from './
|
|
18
|
+
GetCourseEnrollmentListItemFromJSON,
|
|
19
|
+
GetCourseEnrollmentListItemFromJSONTyped,
|
|
20
|
+
GetCourseEnrollmentListItemToJSON,
|
|
21
|
+
GetCourseEnrollmentListItemToJSONTyped,
|
|
22
|
+
} from './GetCourseEnrollmentListItem';
|
|
23
23
|
|
|
24
24
|
/**
|
|
25
25
|
* A list of course enrollments with pagination information
|
|
@@ -53,10 +53,10 @@ export interface GetCourseEnrollmentList {
|
|
|
53
53
|
totalItems: number;
|
|
54
54
|
/**
|
|
55
55
|
*
|
|
56
|
-
* @type {Array<
|
|
56
|
+
* @type {Array<GetCourseEnrollmentListItem>}
|
|
57
57
|
* @memberof GetCourseEnrollmentList
|
|
58
58
|
*/
|
|
59
|
-
items: Array<
|
|
59
|
+
items: Array<GetCourseEnrollmentListItem>;
|
|
60
60
|
}
|
|
61
61
|
|
|
62
62
|
/**
|
|
@@ -85,7 +85,7 @@ export function GetCourseEnrollmentListFromJSONTyped(json: any, ignoreDiscrimina
|
|
|
85
85
|
'pageSize': json['pageSize'],
|
|
86
86
|
'totalPages': json['totalPages'],
|
|
87
87
|
'totalItems': json['totalItems'],
|
|
88
|
-
'items': ((json['items'] as Array<any>).map(
|
|
88
|
+
'items': ((json['items'] as Array<any>).map(GetCourseEnrollmentListItemFromJSON)),
|
|
89
89
|
};
|
|
90
90
|
}
|
|
91
91
|
|
|
@@ -104,7 +104,7 @@ export function GetCourseEnrollmentListToJSONTyped(value?: GetCourseEnrollmentLi
|
|
|
104
104
|
'pageSize': value['pageSize'],
|
|
105
105
|
'totalPages': value['totalPages'],
|
|
106
106
|
'totalItems': value['totalItems'],
|
|
107
|
-
'items': ((value['items'] as Array<any>).map(
|
|
107
|
+
'items': ((value['items'] as Array<any>).map(GetCourseEnrollmentListItemToJSON)),
|
|
108
108
|
};
|
|
109
109
|
}
|
|
110
110
|
|
|
@@ -0,0 +1,150 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* LMS API
|
|
5
|
+
* LMS API
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import { mapValues } from '../runtime';
|
|
16
|
+
/**
|
|
17
|
+
* A course enrollment in a list view
|
|
18
|
+
* @export
|
|
19
|
+
* @interface GetCourseEnrollmentListItem
|
|
20
|
+
*/
|
|
21
|
+
export interface GetCourseEnrollmentListItem {
|
|
22
|
+
/**
|
|
23
|
+
* The external ID of the enrollment
|
|
24
|
+
* @type {string}
|
|
25
|
+
* @memberof GetCourseEnrollmentListItem
|
|
26
|
+
*/
|
|
27
|
+
id: string;
|
|
28
|
+
/**
|
|
29
|
+
* The external ID of the course
|
|
30
|
+
* @type {string}
|
|
31
|
+
* @memberof GetCourseEnrollmentListItem
|
|
32
|
+
*/
|
|
33
|
+
courseId: string;
|
|
34
|
+
/**
|
|
35
|
+
* The external ID of the enrolled user
|
|
36
|
+
* @type {string}
|
|
37
|
+
* @memberof GetCourseEnrollmentListItem
|
|
38
|
+
*/
|
|
39
|
+
userId: string;
|
|
40
|
+
/**
|
|
41
|
+
* The first name of the enrolled user
|
|
42
|
+
* @type {string}
|
|
43
|
+
* @memberof GetCourseEnrollmentListItem
|
|
44
|
+
*/
|
|
45
|
+
firstName: string;
|
|
46
|
+
/**
|
|
47
|
+
* The last name of the enrolled user
|
|
48
|
+
* @type {string}
|
|
49
|
+
* @memberof GetCourseEnrollmentListItem
|
|
50
|
+
*/
|
|
51
|
+
lastName: string;
|
|
52
|
+
/**
|
|
53
|
+
* Start date of the enrollment (Unix timestamp)
|
|
54
|
+
* @type {number}
|
|
55
|
+
* @memberof GetCourseEnrollmentListItem
|
|
56
|
+
*/
|
|
57
|
+
enrollmentDateStart: number;
|
|
58
|
+
/**
|
|
59
|
+
* End date of the enrollment (Unix timestamp)
|
|
60
|
+
* @type {number}
|
|
61
|
+
* @memberof GetCourseEnrollmentListItem
|
|
62
|
+
*/
|
|
63
|
+
enrollmentDateEnd: number;
|
|
64
|
+
/**
|
|
65
|
+
* Current status of the enrollment
|
|
66
|
+
* @type {string}
|
|
67
|
+
* @memberof GetCourseEnrollmentListItem
|
|
68
|
+
*/
|
|
69
|
+
status: GetCourseEnrollmentListItemStatusEnum;
|
|
70
|
+
/**
|
|
71
|
+
* Date the course was completed (Unix timestamp)
|
|
72
|
+
* @type {number}
|
|
73
|
+
* @memberof GetCourseEnrollmentListItem
|
|
74
|
+
*/
|
|
75
|
+
completionDate: number | null;
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
/**
|
|
80
|
+
* @export
|
|
81
|
+
*/
|
|
82
|
+
export const GetCourseEnrollmentListItemStatusEnum = {
|
|
83
|
+
Enrolled: 'Enrolled',
|
|
84
|
+
Completed: 'Completed',
|
|
85
|
+
Removed: 'Removed'
|
|
86
|
+
} as const;
|
|
87
|
+
export type GetCourseEnrollmentListItemStatusEnum = typeof GetCourseEnrollmentListItemStatusEnum[keyof typeof GetCourseEnrollmentListItemStatusEnum];
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
/**
|
|
91
|
+
* Check if a given object implements the GetCourseEnrollmentListItem interface.
|
|
92
|
+
*/
|
|
93
|
+
export function instanceOfGetCourseEnrollmentListItem(value: object): value is GetCourseEnrollmentListItem {
|
|
94
|
+
if (!('id' in value) || value['id'] === undefined) return false;
|
|
95
|
+
if (!('courseId' in value) || value['courseId'] === undefined) return false;
|
|
96
|
+
if (!('userId' in value) || value['userId'] === undefined) return false;
|
|
97
|
+
if (!('firstName' in value) || value['firstName'] === undefined) return false;
|
|
98
|
+
if (!('lastName' in value) || value['lastName'] === undefined) return false;
|
|
99
|
+
if (!('enrollmentDateStart' in value) || value['enrollmentDateStart'] === undefined) return false;
|
|
100
|
+
if (!('enrollmentDateEnd' in value) || value['enrollmentDateEnd'] === undefined) return false;
|
|
101
|
+
if (!('status' in value) || value['status'] === undefined) return false;
|
|
102
|
+
if (!('completionDate' in value) || value['completionDate'] === undefined) return false;
|
|
103
|
+
return true;
|
|
104
|
+
}
|
|
105
|
+
|
|
106
|
+
export function GetCourseEnrollmentListItemFromJSON(json: any): GetCourseEnrollmentListItem {
|
|
107
|
+
return GetCourseEnrollmentListItemFromJSONTyped(json, false);
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
export function GetCourseEnrollmentListItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseEnrollmentListItem {
|
|
111
|
+
if (json == null) {
|
|
112
|
+
return json;
|
|
113
|
+
}
|
|
114
|
+
return {
|
|
115
|
+
|
|
116
|
+
'id': json['id'],
|
|
117
|
+
'courseId': json['course_id'],
|
|
118
|
+
'userId': json['user_id'],
|
|
119
|
+
'firstName': json['first_name'],
|
|
120
|
+
'lastName': json['last_name'],
|
|
121
|
+
'enrollmentDateStart': json['enrollment_date_start'],
|
|
122
|
+
'enrollmentDateEnd': json['enrollment_date_end'],
|
|
123
|
+
'status': json['status'],
|
|
124
|
+
'completionDate': json['completion_date'],
|
|
125
|
+
};
|
|
126
|
+
}
|
|
127
|
+
|
|
128
|
+
export function GetCourseEnrollmentListItemToJSON(json: any): GetCourseEnrollmentListItem {
|
|
129
|
+
return GetCourseEnrollmentListItemToJSONTyped(json, false);
|
|
130
|
+
}
|
|
131
|
+
|
|
132
|
+
export function GetCourseEnrollmentListItemToJSONTyped(value?: GetCourseEnrollmentListItem | null, ignoreDiscriminator: boolean = false): any {
|
|
133
|
+
if (value == null) {
|
|
134
|
+
return value;
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
return {
|
|
138
|
+
|
|
139
|
+
'id': value['id'],
|
|
140
|
+
'course_id': value['courseId'],
|
|
141
|
+
'user_id': value['userId'],
|
|
142
|
+
'first_name': value['firstName'],
|
|
143
|
+
'last_name': value['lastName'],
|
|
144
|
+
'enrollment_date_start': value['enrollmentDateStart'],
|
|
145
|
+
'enrollment_date_end': value['enrollmentDateEnd'],
|
|
146
|
+
'status': value['status'],
|
|
147
|
+
'completion_date': value['completionDate'],
|
|
148
|
+
};
|
|
149
|
+
}
|
|
150
|
+
|
package/src/models/index.ts
CHANGED
|
@@ -13,6 +13,7 @@ export * from './GetContentUpload';
|
|
|
13
13
|
export * from './GetCourse';
|
|
14
14
|
export * from './GetCourseEnrollment';
|
|
15
15
|
export * from './GetCourseEnrollmentList';
|
|
16
|
+
export * from './GetCourseEnrollmentListItem';
|
|
16
17
|
export * from './GetCourseList';
|
|
17
18
|
export * from './GetModule';
|
|
18
19
|
export * from './GetModuleList';
|