@easyedu/js-lsm-api 1.79.0 → 1.80.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 +9 -2
- package/dist/apis/UserApi.d.ts +42 -0
- package/dist/apis/UserApi.js +79 -1
- package/dist/esm/apis/UserApi.d.ts +42 -0
- package/dist/esm/apis/UserApi.js +78 -0
- package/dist/esm/models/GetUserCourseList.d.ts +57 -0
- package/dist/esm/models/GetUserCourseList.js +60 -0
- package/dist/esm/models/GetUserCourseListItem.d.ts +54 -0
- package/dist/esm/models/GetUserCourseListItem.js +59 -0
- package/dist/esm/models/GetUserCourseListItemCertificate.d.ts +74 -0
- package/dist/esm/models/GetUserCourseListItemCertificate.js +75 -0
- package/dist/esm/models/GetUserCourseListItemCourse.d.ts +89 -0
- package/dist/esm/models/GetUserCourseListItemCourse.js +82 -0
- package/dist/esm/models/GetUserCourseListItemEnrollment.d.ts +111 -0
- package/dist/esm/models/GetUserCourseListItemEnrollment.js +105 -0
- package/dist/esm/models/GetUserCourseListItemProgress.d.ts +44 -0
- package/dist/esm/models/GetUserCourseListItemProgress.js +51 -0
- package/dist/esm/models/index.d.ts +6 -0
- package/dist/esm/models/index.js +6 -0
- package/dist/models/GetUserCourseList.d.ts +57 -0
- package/dist/models/GetUserCourseList.js +67 -0
- package/dist/models/GetUserCourseListItem.d.ts +54 -0
- package/dist/models/GetUserCourseListItem.js +66 -0
- package/dist/models/GetUserCourseListItemCertificate.d.ts +74 -0
- package/dist/models/GetUserCourseListItemCertificate.js +83 -0
- package/dist/models/GetUserCourseListItemCourse.d.ts +89 -0
- package/dist/models/GetUserCourseListItemCourse.js +90 -0
- package/dist/models/GetUserCourseListItemEnrollment.d.ts +111 -0
- package/dist/models/GetUserCourseListItemEnrollment.js +113 -0
- package/dist/models/GetUserCourseListItemProgress.d.ts +44 -0
- package/dist/models/GetUserCourseListItemProgress.js +58 -0
- package/dist/models/index.d.ts +6 -0
- package/dist/models/index.js +6 -0
- package/docs/GetUserCourseList.md +43 -0
- package/docs/GetUserCourseListItem.md +41 -0
- package/docs/GetUserCourseListItemCertificate.md +43 -0
- package/docs/GetUserCourseListItemCourse.md +51 -0
- package/docs/GetUserCourseListItemEnrollment.md +49 -0
- package/docs/GetUserCourseListItemProgress.md +39 -0
- package/docs/UserApi.md +90 -0
- package/package.json +1 -1
- package/src/apis/UserApi.ts +108 -0
- package/src/models/GetUserCourseList.ts +110 -0
- package/src/models/GetUserCourseListItem.ts +122 -0
- package/src/models/GetUserCourseListItemCertificate.ts +124 -0
- package/src/models/GetUserCourseListItemCourse.ts +149 -0
- package/src/models/GetUserCourseListItemEnrollment.ts +171 -0
- package/src/models/GetUserCourseListItemProgress.ts +84 -0
- package/src/models/index.ts +6 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -164,6 +164,12 @@ docs/GetSystemBillingList.md
|
|
|
164
164
|
docs/GetSystemMetrics.md
|
|
165
165
|
docs/GetUser.md
|
|
166
166
|
docs/GetUserAvatarUpload.md
|
|
167
|
+
docs/GetUserCourseList.md
|
|
168
|
+
docs/GetUserCourseListItem.md
|
|
169
|
+
docs/GetUserCourseListItemCertificate.md
|
|
170
|
+
docs/GetUserCourseListItemCourse.md
|
|
171
|
+
docs/GetUserCourseListItemEnrollment.md
|
|
172
|
+
docs/GetUserCourseListItemProgress.md
|
|
167
173
|
docs/GetUserQuizAttempts.md
|
|
168
174
|
docs/GetUserQuizAttemptsAllOfAttempts.md
|
|
169
175
|
docs/GetUserQuizAttemptsAllOfFilters.md
|
|
@@ -481,6 +487,12 @@ src/models/GetSystemBillingList.ts
|
|
|
481
487
|
src/models/GetSystemMetrics.ts
|
|
482
488
|
src/models/GetUser.ts
|
|
483
489
|
src/models/GetUserAvatarUpload.ts
|
|
490
|
+
src/models/GetUserCourseList.ts
|
|
491
|
+
src/models/GetUserCourseListItem.ts
|
|
492
|
+
src/models/GetUserCourseListItemCertificate.ts
|
|
493
|
+
src/models/GetUserCourseListItemCourse.ts
|
|
494
|
+
src/models/GetUserCourseListItemEnrollment.ts
|
|
495
|
+
src/models/GetUserCourseListItemProgress.ts
|
|
484
496
|
src/models/GetUserQuizAttempts.ts
|
|
485
497
|
src/models/GetUserQuizAttemptsAllOfAttempts.ts
|
|
486
498
|
src/models/GetUserQuizAttemptsAllOfFilters.ts
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# @easyedu/js-lsm-api@1.
|
|
1
|
+
# @easyedu/js-lsm-api@1.80.0
|
|
2
2
|
|
|
3
3
|
A TypeScript SDK client for the sbzw93t49b.execute-api.us-east-2.amazonaws.com API.
|
|
4
4
|
|
|
@@ -245,6 +245,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
245
245
|
*UserApi* | [**getAuthCheck**](docs/UserApi.md#getauthcheck) | **GET** /auth/check | Check if a user is logged in
|
|
246
246
|
*UserApi* | [**getCurrentUserPermissions**](docs/UserApi.md#getcurrentuserpermissions) | **GET** /users/current/permissions | Get the current user\'s permissions
|
|
247
247
|
*UserApi* | [**getUser**](docs/UserApi.md#getuser) | **GET** /users/{userId} | Get a user by id
|
|
248
|
+
*UserApi* | [**getUserCourses**](docs/UserApi.md#getusercourses) | **GET** /users/{userId}/courses | Get enrolled courses for a user
|
|
248
249
|
*UserApi* | [**getUserEnrollments**](docs/UserApi.md#getuserenrollments) | **GET** /users/{userId}/enrollments | Get user enrollments
|
|
249
250
|
*UserApi* | [**postLogin**](docs/UserApi.md#postlogin) | **POST** /auth/login | Post a new login
|
|
250
251
|
*UserApi* | [**postLogout**](docs/UserApi.md#postlogout) | **POST** /auth/logout | Logout a user
|
|
@@ -413,6 +414,12 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
413
414
|
- [GetSystemMetrics](docs/GetSystemMetrics.md)
|
|
414
415
|
- [GetUser](docs/GetUser.md)
|
|
415
416
|
- [GetUserAvatarUpload](docs/GetUserAvatarUpload.md)
|
|
417
|
+
- [GetUserCourseList](docs/GetUserCourseList.md)
|
|
418
|
+
- [GetUserCourseListItem](docs/GetUserCourseListItem.md)
|
|
419
|
+
- [GetUserCourseListItemCertificate](docs/GetUserCourseListItemCertificate.md)
|
|
420
|
+
- [GetUserCourseListItemCourse](docs/GetUserCourseListItemCourse.md)
|
|
421
|
+
- [GetUserCourseListItemEnrollment](docs/GetUserCourseListItemEnrollment.md)
|
|
422
|
+
- [GetUserCourseListItemProgress](docs/GetUserCourseListItemProgress.md)
|
|
416
423
|
- [GetUserQuizAttempts](docs/GetUserQuizAttempts.md)
|
|
417
424
|
- [GetUserQuizAttemptsAllOfAttempts](docs/GetUserQuizAttemptsAllOfAttempts.md)
|
|
418
425
|
- [GetUserQuizAttemptsAllOfFilters](docs/GetUserQuizAttemptsAllOfFilters.md)
|
|
@@ -554,7 +561,7 @@ and is automatically generated by the
|
|
|
554
561
|
[OpenAPI Generator](https://openapi-generator.tech) project:
|
|
555
562
|
|
|
556
563
|
- API version: `1.0.0`
|
|
557
|
-
- Package version: `1.
|
|
564
|
+
- Package version: `1.80.0`
|
|
558
565
|
- Generator version: `7.22.0`
|
|
559
566
|
- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
|
|
560
567
|
|
package/dist/apis/UserApi.d.ts
CHANGED
|
@@ -13,6 +13,7 @@ import * as runtime from '../runtime';
|
|
|
13
13
|
import { type GetCourseEnrollmentList } from '../models/GetCourseEnrollmentList';
|
|
14
14
|
import { type GetUser } from '../models/GetUser';
|
|
15
15
|
import { type GetUserAvatarUpload } from '../models/GetUserAvatarUpload';
|
|
16
|
+
import { type GetUserCourseList } from '../models/GetUserCourseList';
|
|
16
17
|
import { type LoginRes } from '../models/LoginRes';
|
|
17
18
|
import { type PostLogin } from '../models/PostLogin';
|
|
18
19
|
import { type PostResetPassword } from '../models/PostResetPassword';
|
|
@@ -26,6 +27,16 @@ export interface DeleteUserAvatarRequest {
|
|
|
26
27
|
export interface GetUserRequest {
|
|
27
28
|
userId: string;
|
|
28
29
|
}
|
|
30
|
+
export interface GetUserCoursesRequest {
|
|
31
|
+
userId: string;
|
|
32
|
+
page?: number;
|
|
33
|
+
pageSize?: number;
|
|
34
|
+
search?: string;
|
|
35
|
+
recentActivitySince?: number;
|
|
36
|
+
enrollmentStatus?: string;
|
|
37
|
+
orderBy?: GetUserCoursesOrderByEnum;
|
|
38
|
+
orderDirection?: GetUserCoursesOrderDirectionEnum;
|
|
39
|
+
}
|
|
29
40
|
export interface GetUserEnrollmentsRequest {
|
|
30
41
|
userId: string;
|
|
31
42
|
type?: GetUserEnrollmentsTypeEnum;
|
|
@@ -110,6 +121,18 @@ export declare class UserApi extends runtime.BaseAPI {
|
|
|
110
121
|
* Get a user by id
|
|
111
122
|
*/
|
|
112
123
|
getUser(requestParameters: GetUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetUser>;
|
|
124
|
+
/**
|
|
125
|
+
* Creates request options for getUserCourses without sending the request
|
|
126
|
+
*/
|
|
127
|
+
getUserCoursesRequestOpts(requestParameters: GetUserCoursesRequest): Promise<runtime.RequestOpts>;
|
|
128
|
+
/**
|
|
129
|
+
* Get enrolled courses for a user
|
|
130
|
+
*/
|
|
131
|
+
getUserCoursesRaw(requestParameters: GetUserCoursesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetUserCourseList>>;
|
|
132
|
+
/**
|
|
133
|
+
* Get enrolled courses for a user
|
|
134
|
+
*/
|
|
135
|
+
getUserCourses(requestParameters: GetUserCoursesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetUserCourseList>;
|
|
113
136
|
/**
|
|
114
137
|
* Creates request options for getUserEnrollments without sending the request
|
|
115
138
|
*/
|
|
@@ -219,6 +242,25 @@ export declare class UserApi extends runtime.BaseAPI {
|
|
|
219
242
|
*/
|
|
220
243
|
verifySignupRequest(requestParameters: VerifySignupRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
221
244
|
}
|
|
245
|
+
/**
|
|
246
|
+
* @export
|
|
247
|
+
*/
|
|
248
|
+
export declare const GetUserCoursesOrderByEnum: {
|
|
249
|
+
readonly Name: "name";
|
|
250
|
+
readonly CreatedAt: "created_at";
|
|
251
|
+
readonly EnrollmentDateStart: "enrollment_date_start";
|
|
252
|
+
readonly EnrollmentStatus: "enrollment_status";
|
|
253
|
+
readonly CompletionPercentage: "completion_percentage";
|
|
254
|
+
};
|
|
255
|
+
export type GetUserCoursesOrderByEnum = typeof GetUserCoursesOrderByEnum[keyof typeof GetUserCoursesOrderByEnum];
|
|
256
|
+
/**
|
|
257
|
+
* @export
|
|
258
|
+
*/
|
|
259
|
+
export declare const GetUserCoursesOrderDirectionEnum: {
|
|
260
|
+
readonly Asc: "asc";
|
|
261
|
+
readonly Desc: "desc";
|
|
262
|
+
};
|
|
263
|
+
export type GetUserCoursesOrderDirectionEnum = typeof GetUserCoursesOrderDirectionEnum[keyof typeof GetUserCoursesOrderDirectionEnum];
|
|
222
264
|
/**
|
|
223
265
|
* @export
|
|
224
266
|
*/
|
package/dist/apis/UserApi.js
CHANGED
|
@@ -22,11 +22,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
22
22
|
});
|
|
23
23
|
};
|
|
24
24
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
-
exports.GetUserEnrollmentsTypeEnum = exports.UserApi = void 0;
|
|
25
|
+
exports.GetUserEnrollmentsTypeEnum = exports.GetUserCoursesOrderDirectionEnum = exports.GetUserCoursesOrderByEnum = exports.UserApi = void 0;
|
|
26
26
|
const runtime = require("../runtime");
|
|
27
27
|
const GetCourseEnrollmentList_1 = require("../models/GetCourseEnrollmentList");
|
|
28
28
|
const GetUser_1 = require("../models/GetUser");
|
|
29
29
|
const GetUserAvatarUpload_1 = require("../models/GetUserAvatarUpload");
|
|
30
|
+
const GetUserCourseList_1 = require("../models/GetUserCourseList");
|
|
30
31
|
const LoginRes_1 = require("../models/LoginRes");
|
|
31
32
|
const PostLogin_1 = require("../models/PostLogin");
|
|
32
33
|
const PostResetPassword_1 = require("../models/PostResetPassword");
|
|
@@ -186,6 +187,66 @@ class UserApi extends runtime.BaseAPI {
|
|
|
186
187
|
return yield response.value();
|
|
187
188
|
});
|
|
188
189
|
}
|
|
190
|
+
/**
|
|
191
|
+
* Creates request options for getUserCourses without sending the request
|
|
192
|
+
*/
|
|
193
|
+
getUserCoursesRequestOpts(requestParameters) {
|
|
194
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
195
|
+
if (requestParameters['userId'] == null) {
|
|
196
|
+
throw new runtime.RequiredError('userId', 'Required parameter "userId" was null or undefined when calling getUserCourses().');
|
|
197
|
+
}
|
|
198
|
+
const queryParameters = {};
|
|
199
|
+
if (requestParameters['page'] != null) {
|
|
200
|
+
queryParameters['page'] = requestParameters['page'];
|
|
201
|
+
}
|
|
202
|
+
if (requestParameters['pageSize'] != null) {
|
|
203
|
+
queryParameters['pageSize'] = requestParameters['pageSize'];
|
|
204
|
+
}
|
|
205
|
+
if (requestParameters['search'] != null) {
|
|
206
|
+
queryParameters['search'] = requestParameters['search'];
|
|
207
|
+
}
|
|
208
|
+
if (requestParameters['recentActivitySince'] != null) {
|
|
209
|
+
queryParameters['recentActivitySince'] = requestParameters['recentActivitySince'];
|
|
210
|
+
}
|
|
211
|
+
if (requestParameters['enrollmentStatus'] != null) {
|
|
212
|
+
queryParameters['enrollmentStatus'] = requestParameters['enrollmentStatus'];
|
|
213
|
+
}
|
|
214
|
+
if (requestParameters['orderBy'] != null) {
|
|
215
|
+
queryParameters['orderBy'] = requestParameters['orderBy'];
|
|
216
|
+
}
|
|
217
|
+
if (requestParameters['orderDirection'] != null) {
|
|
218
|
+
queryParameters['orderDirection'] = requestParameters['orderDirection'];
|
|
219
|
+
}
|
|
220
|
+
const headerParameters = {};
|
|
221
|
+
let urlPath = `/users/{userId}/courses`;
|
|
222
|
+
urlPath = urlPath.replace('{userId}', encodeURIComponent(String(requestParameters['userId'])));
|
|
223
|
+
return {
|
|
224
|
+
path: urlPath,
|
|
225
|
+
method: 'GET',
|
|
226
|
+
headers: headerParameters,
|
|
227
|
+
query: queryParameters,
|
|
228
|
+
};
|
|
229
|
+
});
|
|
230
|
+
}
|
|
231
|
+
/**
|
|
232
|
+
* Get enrolled courses for a user
|
|
233
|
+
*/
|
|
234
|
+
getUserCoursesRaw(requestParameters, initOverrides) {
|
|
235
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
236
|
+
const requestOptions = yield this.getUserCoursesRequestOpts(requestParameters);
|
|
237
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
238
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetUserCourseList_1.GetUserCourseListFromJSON)(jsonValue));
|
|
239
|
+
});
|
|
240
|
+
}
|
|
241
|
+
/**
|
|
242
|
+
* Get enrolled courses for a user
|
|
243
|
+
*/
|
|
244
|
+
getUserCourses(requestParameters, initOverrides) {
|
|
245
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
246
|
+
const response = yield this.getUserCoursesRaw(requestParameters, initOverrides);
|
|
247
|
+
return yield response.value();
|
|
248
|
+
});
|
|
249
|
+
}
|
|
189
250
|
/**
|
|
190
251
|
* Creates request options for getUserEnrollments without sending the request
|
|
191
252
|
*/
|
|
@@ -576,6 +637,23 @@ class UserApi extends runtime.BaseAPI {
|
|
|
576
637
|
}
|
|
577
638
|
}
|
|
578
639
|
exports.UserApi = UserApi;
|
|
640
|
+
/**
|
|
641
|
+
* @export
|
|
642
|
+
*/
|
|
643
|
+
exports.GetUserCoursesOrderByEnum = {
|
|
644
|
+
Name: 'name',
|
|
645
|
+
CreatedAt: 'created_at',
|
|
646
|
+
EnrollmentDateStart: 'enrollment_date_start',
|
|
647
|
+
EnrollmentStatus: 'enrollment_status',
|
|
648
|
+
CompletionPercentage: 'completion_percentage'
|
|
649
|
+
};
|
|
650
|
+
/**
|
|
651
|
+
* @export
|
|
652
|
+
*/
|
|
653
|
+
exports.GetUserCoursesOrderDirectionEnum = {
|
|
654
|
+
Asc: 'asc',
|
|
655
|
+
Desc: 'desc'
|
|
656
|
+
};
|
|
579
657
|
/**
|
|
580
658
|
* @export
|
|
581
659
|
*/
|
|
@@ -13,6 +13,7 @@ import * as runtime from '../runtime';
|
|
|
13
13
|
import { type GetCourseEnrollmentList } from '../models/GetCourseEnrollmentList';
|
|
14
14
|
import { type GetUser } from '../models/GetUser';
|
|
15
15
|
import { type GetUserAvatarUpload } from '../models/GetUserAvatarUpload';
|
|
16
|
+
import { type GetUserCourseList } from '../models/GetUserCourseList';
|
|
16
17
|
import { type LoginRes } from '../models/LoginRes';
|
|
17
18
|
import { type PostLogin } from '../models/PostLogin';
|
|
18
19
|
import { type PostResetPassword } from '../models/PostResetPassword';
|
|
@@ -26,6 +27,16 @@ export interface DeleteUserAvatarRequest {
|
|
|
26
27
|
export interface GetUserRequest {
|
|
27
28
|
userId: string;
|
|
28
29
|
}
|
|
30
|
+
export interface GetUserCoursesRequest {
|
|
31
|
+
userId: string;
|
|
32
|
+
page?: number;
|
|
33
|
+
pageSize?: number;
|
|
34
|
+
search?: string;
|
|
35
|
+
recentActivitySince?: number;
|
|
36
|
+
enrollmentStatus?: string;
|
|
37
|
+
orderBy?: GetUserCoursesOrderByEnum;
|
|
38
|
+
orderDirection?: GetUserCoursesOrderDirectionEnum;
|
|
39
|
+
}
|
|
29
40
|
export interface GetUserEnrollmentsRequest {
|
|
30
41
|
userId: string;
|
|
31
42
|
type?: GetUserEnrollmentsTypeEnum;
|
|
@@ -110,6 +121,18 @@ export declare class UserApi extends runtime.BaseAPI {
|
|
|
110
121
|
* Get a user by id
|
|
111
122
|
*/
|
|
112
123
|
getUser(requestParameters: GetUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetUser>;
|
|
124
|
+
/**
|
|
125
|
+
* Creates request options for getUserCourses without sending the request
|
|
126
|
+
*/
|
|
127
|
+
getUserCoursesRequestOpts(requestParameters: GetUserCoursesRequest): Promise<runtime.RequestOpts>;
|
|
128
|
+
/**
|
|
129
|
+
* Get enrolled courses for a user
|
|
130
|
+
*/
|
|
131
|
+
getUserCoursesRaw(requestParameters: GetUserCoursesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetUserCourseList>>;
|
|
132
|
+
/**
|
|
133
|
+
* Get enrolled courses for a user
|
|
134
|
+
*/
|
|
135
|
+
getUserCourses(requestParameters: GetUserCoursesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetUserCourseList>;
|
|
113
136
|
/**
|
|
114
137
|
* Creates request options for getUserEnrollments without sending the request
|
|
115
138
|
*/
|
|
@@ -219,6 +242,25 @@ export declare class UserApi extends runtime.BaseAPI {
|
|
|
219
242
|
*/
|
|
220
243
|
verifySignupRequest(requestParameters: VerifySignupRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
221
244
|
}
|
|
245
|
+
/**
|
|
246
|
+
* @export
|
|
247
|
+
*/
|
|
248
|
+
export declare const GetUserCoursesOrderByEnum: {
|
|
249
|
+
readonly Name: "name";
|
|
250
|
+
readonly CreatedAt: "created_at";
|
|
251
|
+
readonly EnrollmentDateStart: "enrollment_date_start";
|
|
252
|
+
readonly EnrollmentStatus: "enrollment_status";
|
|
253
|
+
readonly CompletionPercentage: "completion_percentage";
|
|
254
|
+
};
|
|
255
|
+
export type GetUserCoursesOrderByEnum = typeof GetUserCoursesOrderByEnum[keyof typeof GetUserCoursesOrderByEnum];
|
|
256
|
+
/**
|
|
257
|
+
* @export
|
|
258
|
+
*/
|
|
259
|
+
export declare const GetUserCoursesOrderDirectionEnum: {
|
|
260
|
+
readonly Asc: "asc";
|
|
261
|
+
readonly Desc: "desc";
|
|
262
|
+
};
|
|
263
|
+
export type GetUserCoursesOrderDirectionEnum = typeof GetUserCoursesOrderDirectionEnum[keyof typeof GetUserCoursesOrderDirectionEnum];
|
|
222
264
|
/**
|
|
223
265
|
* @export
|
|
224
266
|
*/
|
package/dist/esm/apis/UserApi.js
CHANGED
|
@@ -24,6 +24,7 @@ import * as runtime from '../runtime';
|
|
|
24
24
|
import { GetCourseEnrollmentListFromJSON, } from '../models/GetCourseEnrollmentList';
|
|
25
25
|
import { GetUserFromJSON, } from '../models/GetUser';
|
|
26
26
|
import { GetUserAvatarUploadFromJSON, } from '../models/GetUserAvatarUpload';
|
|
27
|
+
import { GetUserCourseListFromJSON, } from '../models/GetUserCourseList';
|
|
27
28
|
import { LoginResFromJSON, } from '../models/LoginRes';
|
|
28
29
|
import { PostLoginToJSON, } from '../models/PostLogin';
|
|
29
30
|
import { PostResetPasswordToJSON, } from '../models/PostResetPassword';
|
|
@@ -183,6 +184,66 @@ export class UserApi extends runtime.BaseAPI {
|
|
|
183
184
|
return yield response.value();
|
|
184
185
|
});
|
|
185
186
|
}
|
|
187
|
+
/**
|
|
188
|
+
* Creates request options for getUserCourses without sending the request
|
|
189
|
+
*/
|
|
190
|
+
getUserCoursesRequestOpts(requestParameters) {
|
|
191
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
192
|
+
if (requestParameters['userId'] == null) {
|
|
193
|
+
throw new runtime.RequiredError('userId', 'Required parameter "userId" was null or undefined when calling getUserCourses().');
|
|
194
|
+
}
|
|
195
|
+
const queryParameters = {};
|
|
196
|
+
if (requestParameters['page'] != null) {
|
|
197
|
+
queryParameters['page'] = requestParameters['page'];
|
|
198
|
+
}
|
|
199
|
+
if (requestParameters['pageSize'] != null) {
|
|
200
|
+
queryParameters['pageSize'] = requestParameters['pageSize'];
|
|
201
|
+
}
|
|
202
|
+
if (requestParameters['search'] != null) {
|
|
203
|
+
queryParameters['search'] = requestParameters['search'];
|
|
204
|
+
}
|
|
205
|
+
if (requestParameters['recentActivitySince'] != null) {
|
|
206
|
+
queryParameters['recentActivitySince'] = requestParameters['recentActivitySince'];
|
|
207
|
+
}
|
|
208
|
+
if (requestParameters['enrollmentStatus'] != null) {
|
|
209
|
+
queryParameters['enrollmentStatus'] = requestParameters['enrollmentStatus'];
|
|
210
|
+
}
|
|
211
|
+
if (requestParameters['orderBy'] != null) {
|
|
212
|
+
queryParameters['orderBy'] = requestParameters['orderBy'];
|
|
213
|
+
}
|
|
214
|
+
if (requestParameters['orderDirection'] != null) {
|
|
215
|
+
queryParameters['orderDirection'] = requestParameters['orderDirection'];
|
|
216
|
+
}
|
|
217
|
+
const headerParameters = {};
|
|
218
|
+
let urlPath = `/users/{userId}/courses`;
|
|
219
|
+
urlPath = urlPath.replace('{userId}', encodeURIComponent(String(requestParameters['userId'])));
|
|
220
|
+
return {
|
|
221
|
+
path: urlPath,
|
|
222
|
+
method: 'GET',
|
|
223
|
+
headers: headerParameters,
|
|
224
|
+
query: queryParameters,
|
|
225
|
+
};
|
|
226
|
+
});
|
|
227
|
+
}
|
|
228
|
+
/**
|
|
229
|
+
* Get enrolled courses for a user
|
|
230
|
+
*/
|
|
231
|
+
getUserCoursesRaw(requestParameters, initOverrides) {
|
|
232
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
233
|
+
const requestOptions = yield this.getUserCoursesRequestOpts(requestParameters);
|
|
234
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
235
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetUserCourseListFromJSON(jsonValue));
|
|
236
|
+
});
|
|
237
|
+
}
|
|
238
|
+
/**
|
|
239
|
+
* Get enrolled courses for a user
|
|
240
|
+
*/
|
|
241
|
+
getUserCourses(requestParameters, initOverrides) {
|
|
242
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
243
|
+
const response = yield this.getUserCoursesRaw(requestParameters, initOverrides);
|
|
244
|
+
return yield response.value();
|
|
245
|
+
});
|
|
246
|
+
}
|
|
186
247
|
/**
|
|
187
248
|
* Creates request options for getUserEnrollments without sending the request
|
|
188
249
|
*/
|
|
@@ -572,6 +633,23 @@ export class UserApi extends runtime.BaseAPI {
|
|
|
572
633
|
});
|
|
573
634
|
}
|
|
574
635
|
}
|
|
636
|
+
/**
|
|
637
|
+
* @export
|
|
638
|
+
*/
|
|
639
|
+
export const GetUserCoursesOrderByEnum = {
|
|
640
|
+
Name: 'name',
|
|
641
|
+
CreatedAt: 'created_at',
|
|
642
|
+
EnrollmentDateStart: 'enrollment_date_start',
|
|
643
|
+
EnrollmentStatus: 'enrollment_status',
|
|
644
|
+
CompletionPercentage: 'completion_percentage'
|
|
645
|
+
};
|
|
646
|
+
/**
|
|
647
|
+
* @export
|
|
648
|
+
*/
|
|
649
|
+
export const GetUserCoursesOrderDirectionEnum = {
|
|
650
|
+
Asc: 'asc',
|
|
651
|
+
Desc: 'desc'
|
|
652
|
+
};
|
|
575
653
|
/**
|
|
576
654
|
* @export
|
|
577
655
|
*/
|
|
@@ -0,0 +1,57 @@
|
|
|
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
|
+
import type { GetUserCourseListItem } from './GetUserCourseListItem';
|
|
13
|
+
/**
|
|
14
|
+
* A paginated list of courses the target user is enrolled in.
|
|
15
|
+
* @export
|
|
16
|
+
* @interface GetUserCourseList
|
|
17
|
+
*/
|
|
18
|
+
export interface GetUserCourseList {
|
|
19
|
+
/**
|
|
20
|
+
* The current page number
|
|
21
|
+
* @type {number}
|
|
22
|
+
* @memberof GetUserCourseList
|
|
23
|
+
*/
|
|
24
|
+
page: number;
|
|
25
|
+
/**
|
|
26
|
+
* The number of items returned on this page
|
|
27
|
+
* @type {number}
|
|
28
|
+
* @memberof GetUserCourseList
|
|
29
|
+
*/
|
|
30
|
+
pageSize: number;
|
|
31
|
+
/**
|
|
32
|
+
* The total number of pages
|
|
33
|
+
* @type {number}
|
|
34
|
+
* @memberof GetUserCourseList
|
|
35
|
+
*/
|
|
36
|
+
totalPages: number;
|
|
37
|
+
/**
|
|
38
|
+
* The total number of courses after selecting one enrollment per course
|
|
39
|
+
* @type {number}
|
|
40
|
+
* @memberof GetUserCourseList
|
|
41
|
+
*/
|
|
42
|
+
totalItems: number;
|
|
43
|
+
/**
|
|
44
|
+
*
|
|
45
|
+
* @type {Array<GetUserCourseListItem>}
|
|
46
|
+
* @memberof GetUserCourseList
|
|
47
|
+
*/
|
|
48
|
+
items: Array<GetUserCourseListItem>;
|
|
49
|
+
}
|
|
50
|
+
/**
|
|
51
|
+
* Check if a given object implements the GetUserCourseList interface.
|
|
52
|
+
*/
|
|
53
|
+
export declare function instanceOfGetUserCourseList(value: object): value is GetUserCourseList;
|
|
54
|
+
export declare function GetUserCourseListFromJSON(json: any): GetUserCourseList;
|
|
55
|
+
export declare function GetUserCourseListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetUserCourseList;
|
|
56
|
+
export declare function GetUserCourseListToJSON(json: any): GetUserCourseList;
|
|
57
|
+
export declare function GetUserCourseListToJSONTyped(value?: GetUserCourseList | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,60 @@
|
|
|
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
|
+
import { GetUserCourseListItemFromJSON, GetUserCourseListItemToJSON, } from './GetUserCourseListItem';
|
|
15
|
+
/**
|
|
16
|
+
* Check if a given object implements the GetUserCourseList interface.
|
|
17
|
+
*/
|
|
18
|
+
export function instanceOfGetUserCourseList(value) {
|
|
19
|
+
if (!('page' in value) || value['page'] === undefined)
|
|
20
|
+
return false;
|
|
21
|
+
if (!('pageSize' in value) || value['pageSize'] === undefined)
|
|
22
|
+
return false;
|
|
23
|
+
if (!('totalPages' in value) || value['totalPages'] === undefined)
|
|
24
|
+
return false;
|
|
25
|
+
if (!('totalItems' in value) || value['totalItems'] === undefined)
|
|
26
|
+
return false;
|
|
27
|
+
if (!('items' in value) || value['items'] === undefined)
|
|
28
|
+
return false;
|
|
29
|
+
return true;
|
|
30
|
+
}
|
|
31
|
+
export function GetUserCourseListFromJSON(json) {
|
|
32
|
+
return GetUserCourseListFromJSONTyped(json, false);
|
|
33
|
+
}
|
|
34
|
+
export function GetUserCourseListFromJSONTyped(json, ignoreDiscriminator) {
|
|
35
|
+
if (json == null) {
|
|
36
|
+
return json;
|
|
37
|
+
}
|
|
38
|
+
return {
|
|
39
|
+
'page': json['page'],
|
|
40
|
+
'pageSize': json['pageSize'],
|
|
41
|
+
'totalPages': json['totalPages'],
|
|
42
|
+
'totalItems': json['totalItems'],
|
|
43
|
+
'items': (json['items'].map(GetUserCourseListItemFromJSON)),
|
|
44
|
+
};
|
|
45
|
+
}
|
|
46
|
+
export function GetUserCourseListToJSON(json) {
|
|
47
|
+
return GetUserCourseListToJSONTyped(json, false);
|
|
48
|
+
}
|
|
49
|
+
export function GetUserCourseListToJSONTyped(value, ignoreDiscriminator = false) {
|
|
50
|
+
if (value == null) {
|
|
51
|
+
return value;
|
|
52
|
+
}
|
|
53
|
+
return {
|
|
54
|
+
'page': value['page'],
|
|
55
|
+
'pageSize': value['pageSize'],
|
|
56
|
+
'totalPages': value['totalPages'],
|
|
57
|
+
'totalItems': value['totalItems'],
|
|
58
|
+
'items': (value['items'].map(GetUserCourseListItemToJSON)),
|
|
59
|
+
};
|
|
60
|
+
}
|
|
@@ -0,0 +1,54 @@
|
|
|
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
|
+
import type { GetUserCourseListItemCourse } from './GetUserCourseListItemCourse';
|
|
13
|
+
import type { GetUserCourseListItemEnrollment } from './GetUserCourseListItemEnrollment';
|
|
14
|
+
import type { GetUserCourseListItemCertificate } from './GetUserCourseListItemCertificate';
|
|
15
|
+
import type { GetUserCourseListItemProgress } from './GetUserCourseListItemProgress';
|
|
16
|
+
/**
|
|
17
|
+
* A course the target user is enrolled in, grouped by course and selected enrollment.
|
|
18
|
+
* @export
|
|
19
|
+
* @interface GetUserCourseListItem
|
|
20
|
+
*/
|
|
21
|
+
export interface GetUserCourseListItem {
|
|
22
|
+
/**
|
|
23
|
+
*
|
|
24
|
+
* @type {GetUserCourseListItemCourse}
|
|
25
|
+
* @memberof GetUserCourseListItem
|
|
26
|
+
*/
|
|
27
|
+
course: GetUserCourseListItemCourse;
|
|
28
|
+
/**
|
|
29
|
+
*
|
|
30
|
+
* @type {GetUserCourseListItemEnrollment}
|
|
31
|
+
* @memberof GetUserCourseListItem
|
|
32
|
+
*/
|
|
33
|
+
enrollment: GetUserCourseListItemEnrollment;
|
|
34
|
+
/**
|
|
35
|
+
*
|
|
36
|
+
* @type {GetUserCourseListItemProgress}
|
|
37
|
+
* @memberof GetUserCourseListItem
|
|
38
|
+
*/
|
|
39
|
+
progress: GetUserCourseListItemProgress;
|
|
40
|
+
/**
|
|
41
|
+
*
|
|
42
|
+
* @type {GetUserCourseListItemCertificate}
|
|
43
|
+
* @memberof GetUserCourseListItem
|
|
44
|
+
*/
|
|
45
|
+
certificate: GetUserCourseListItemCertificate | null;
|
|
46
|
+
}
|
|
47
|
+
/**
|
|
48
|
+
* Check if a given object implements the GetUserCourseListItem interface.
|
|
49
|
+
*/
|
|
50
|
+
export declare function instanceOfGetUserCourseListItem(value: object): value is GetUserCourseListItem;
|
|
51
|
+
export declare function GetUserCourseListItemFromJSON(json: any): GetUserCourseListItem;
|
|
52
|
+
export declare function GetUserCourseListItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetUserCourseListItem;
|
|
53
|
+
export declare function GetUserCourseListItemToJSON(json: any): GetUserCourseListItem;
|
|
54
|
+
export declare function GetUserCourseListItemToJSONTyped(value?: GetUserCourseListItem | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,59 @@
|
|
|
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
|
+
import { GetUserCourseListItemCourseFromJSON, GetUserCourseListItemCourseToJSON, } from './GetUserCourseListItemCourse';
|
|
15
|
+
import { GetUserCourseListItemEnrollmentFromJSON, GetUserCourseListItemEnrollmentToJSON, } from './GetUserCourseListItemEnrollment';
|
|
16
|
+
import { GetUserCourseListItemCertificateFromJSON, GetUserCourseListItemCertificateToJSON, } from './GetUserCourseListItemCertificate';
|
|
17
|
+
import { GetUserCourseListItemProgressFromJSON, GetUserCourseListItemProgressToJSON, } from './GetUserCourseListItemProgress';
|
|
18
|
+
/**
|
|
19
|
+
* Check if a given object implements the GetUserCourseListItem interface.
|
|
20
|
+
*/
|
|
21
|
+
export function instanceOfGetUserCourseListItem(value) {
|
|
22
|
+
if (!('course' in value) || value['course'] === undefined)
|
|
23
|
+
return false;
|
|
24
|
+
if (!('enrollment' in value) || value['enrollment'] === undefined)
|
|
25
|
+
return false;
|
|
26
|
+
if (!('progress' in value) || value['progress'] === undefined)
|
|
27
|
+
return false;
|
|
28
|
+
if (!('certificate' in value) || value['certificate'] === undefined)
|
|
29
|
+
return false;
|
|
30
|
+
return true;
|
|
31
|
+
}
|
|
32
|
+
export function GetUserCourseListItemFromJSON(json) {
|
|
33
|
+
return GetUserCourseListItemFromJSONTyped(json, false);
|
|
34
|
+
}
|
|
35
|
+
export function GetUserCourseListItemFromJSONTyped(json, ignoreDiscriminator) {
|
|
36
|
+
if (json == null) {
|
|
37
|
+
return json;
|
|
38
|
+
}
|
|
39
|
+
return {
|
|
40
|
+
'course': GetUserCourseListItemCourseFromJSON(json['course']),
|
|
41
|
+
'enrollment': GetUserCourseListItemEnrollmentFromJSON(json['enrollment']),
|
|
42
|
+
'progress': GetUserCourseListItemProgressFromJSON(json['progress']),
|
|
43
|
+
'certificate': GetUserCourseListItemCertificateFromJSON(json['certificate']),
|
|
44
|
+
};
|
|
45
|
+
}
|
|
46
|
+
export function GetUserCourseListItemToJSON(json) {
|
|
47
|
+
return GetUserCourseListItemToJSONTyped(json, false);
|
|
48
|
+
}
|
|
49
|
+
export function GetUserCourseListItemToJSONTyped(value, ignoreDiscriminator = false) {
|
|
50
|
+
if (value == null) {
|
|
51
|
+
return value;
|
|
52
|
+
}
|
|
53
|
+
return {
|
|
54
|
+
'course': GetUserCourseListItemCourseToJSON(value['course']),
|
|
55
|
+
'enrollment': GetUserCourseListItemEnrollmentToJSON(value['enrollment']),
|
|
56
|
+
'progress': GetUserCourseListItemProgressToJSON(value['progress']),
|
|
57
|
+
'certificate': GetUserCourseListItemCertificateToJSON(value['certificate']),
|
|
58
|
+
};
|
|
59
|
+
}
|