@easyedu/js-lsm-api 1.7.0 → 1.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (48) hide show
  1. package/.openapi-generator/FILES +3 -0
  2. package/README.md +2 -2
  3. package/dist/apis/CourseApi.d.ts +21 -8
  4. package/dist/apis/CourseApi.js +46 -10
  5. package/dist/apis/PortalApi.d.ts +24 -1
  6. package/dist/apis/PortalApi.js +46 -1
  7. package/dist/esm/apis/CourseApi.d.ts +21 -8
  8. package/dist/esm/apis/CourseApi.js +47 -11
  9. package/dist/esm/apis/PortalApi.d.ts +24 -1
  10. package/dist/esm/apis/PortalApi.js +46 -1
  11. package/dist/esm/models/GetCourseEnrollment.d.ts +9 -5
  12. package/dist/esm/models/GetCourseEnrollment.js +5 -3
  13. package/dist/esm/models/GetPortalUser.d.ts +71 -0
  14. package/dist/esm/models/GetPortalUser.js +71 -0
  15. package/dist/esm/models/GetPortalUserList.d.ts +57 -0
  16. package/dist/esm/models/GetPortalUserList.js +60 -0
  17. package/dist/esm/models/PostContentSession.d.ts +6 -0
  18. package/dist/esm/models/PostContentSession.js +2 -0
  19. package/dist/esm/models/PostCourseEnrollment.d.ts +13 -7
  20. package/dist/esm/models/PostCourseEnrollment.js +4 -4
  21. package/dist/esm/models/PutCourseEnrollment.d.ts +53 -0
  22. package/dist/esm/models/PutCourseEnrollment.js +53 -0
  23. package/dist/esm/models/index.d.ts +3 -0
  24. package/dist/esm/models/index.js +3 -0
  25. package/dist/models/GetCourseEnrollment.d.ts +9 -5
  26. package/dist/models/GetCourseEnrollment.js +5 -3
  27. package/dist/models/GetPortalUser.d.ts +71 -0
  28. package/dist/models/GetPortalUser.js +79 -0
  29. package/dist/models/GetPortalUserList.d.ts +57 -0
  30. package/dist/models/GetPortalUserList.js +67 -0
  31. package/dist/models/PostContentSession.d.ts +6 -0
  32. package/dist/models/PostContentSession.js +2 -0
  33. package/dist/models/PostCourseEnrollment.d.ts +13 -7
  34. package/dist/models/PostCourseEnrollment.js +4 -4
  35. package/dist/models/PutCourseEnrollment.d.ts +53 -0
  36. package/dist/models/PutCourseEnrollment.js +61 -0
  37. package/dist/models/index.d.ts +3 -0
  38. package/dist/models/index.js +3 -0
  39. package/package.json +1 -1
  40. package/src/apis/CourseApi.ts +70 -11
  41. package/src/apis/PortalApi.ts +65 -0
  42. package/src/models/GetCourseEnrollment.ts +12 -5
  43. package/src/models/GetPortalUser.ts +123 -0
  44. package/src/models/GetPortalUserList.ts +110 -0
  45. package/src/models/PostContentSession.ts +8 -0
  46. package/src/models/PostCourseEnrollment.ts +17 -10
  47. package/src/models/PutCourseEnrollment.ts +93 -0
  48. package/src/models/index.ts +3 -0
@@ -31,6 +31,8 @@ src/models/GetModule.ts
31
31
  src/models/GetModuleList.ts
32
32
  src/models/GetPortal.ts
33
33
  src/models/GetPortalList.ts
34
+ src/models/GetPortalUser.ts
35
+ src/models/GetPortalUserList.ts
34
36
  src/models/GetQuestion.ts
35
37
  src/models/GetQuestionAnswerChoicesInner.ts
36
38
  src/models/GetQuestionList.ts
@@ -125,6 +127,7 @@ src/models/PostResetPassword.ts
125
127
  src/models/PostSendResetPassword.ts
126
128
  src/models/PutContent.ts
127
129
  src/models/PutCourse.ts
130
+ src/models/PutCourseEnrollment.ts
128
131
  src/models/PutModule.ts
129
132
  src/models/PutPortalBranding.ts
130
133
  src/models/PutQuestion.ts
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @easyedu/js-lsm-api@1.7.0
1
+ ## @easyedu/js-lsm-api@1.9.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.7.0 --save
39
+ npm install @easyedu/js-lsm-api@1.9.0 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -10,11 +10,11 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import type { GetCourse, GetCourseEnrollment, GetCourseEnrollmentList, GetCourseList, PostCourse, PostCourseEnrollment, PutCourse } from '../models/index';
13
+ import type { GetCourse, GetCourseEnrollment, GetCourseEnrollmentList, GetCourseList, PostCourse, PostCourseEnrollment, PutCourse, PutCourseEnrollment } from '../models/index';
14
14
  export interface GetCourseRequest {
15
15
  courseId: string;
16
16
  }
17
- export interface GetCourseEnrollmentRequest {
17
+ export interface GetCourseEnrollmentsRequest {
18
18
  courseId: string;
19
19
  }
20
20
  export interface PostCourseRequest {
@@ -28,6 +28,11 @@ export interface PutCourseRequest {
28
28
  courseId: string;
29
29
  putCourse: Omit<PutCourse, 'id'>;
30
30
  }
31
+ export interface PutCourseEnrollmentRequest {
32
+ courseId: string;
33
+ enrollmentId: string;
34
+ putCourseEnrollment: PutCourseEnrollment;
35
+ }
31
36
  /**
32
37
  *
33
38
  */
@@ -41,13 +46,13 @@ export declare class CourseApi extends runtime.BaseAPI {
41
46
  */
42
47
  getCourse(requestParameters: GetCourseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourse>;
43
48
  /**
44
- * get course enrollment
49
+ * Get course enrollments
45
50
  */
46
- getCourseEnrollmentRaw(requestParameters: GetCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseEnrollmentList>>;
51
+ getCourseEnrollmentsRaw(requestParameters: GetCourseEnrollmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseEnrollmentList>>;
47
52
  /**
48
- * get course enrollment
53
+ * Get course enrollments
49
54
  */
50
- getCourseEnrollment(requestParameters: GetCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseEnrollmentList>;
55
+ getCourseEnrollments(requestParameters: GetCourseEnrollmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseEnrollmentList>;
51
56
  /**
52
57
  * get course list
53
58
  */
@@ -65,11 +70,11 @@ export declare class CourseApi extends runtime.BaseAPI {
65
70
  */
66
71
  postCourse(requestParameters: PostCourseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourse>;
67
72
  /**
68
- * Post a new course enrollment
73
+ * Create a new course enrollment
69
74
  */
70
75
  postCourseEnrollmentRaw(requestParameters: PostCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseEnrollment>>;
71
76
  /**
72
- * Post a new course enrollment
77
+ * Create a new course enrollment
73
78
  */
74
79
  postCourseEnrollment(requestParameters: PostCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseEnrollment>;
75
80
  /**
@@ -80,4 +85,12 @@ export declare class CourseApi extends runtime.BaseAPI {
80
85
  * Update a course by id
81
86
  */
82
87
  putCourse(requestParameters: PutCourseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourse>;
88
+ /**
89
+ * Update a course enrollment
90
+ */
91
+ putCourseEnrollmentRaw(requestParameters: PutCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseEnrollment>>;
92
+ /**
93
+ * Update a course enrollment
94
+ */
95
+ putCourseEnrollment(requestParameters: PutCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseEnrollment>;
83
96
  }
@@ -58,17 +58,17 @@ class CourseApi extends runtime.BaseAPI {
58
58
  });
59
59
  }
60
60
  /**
61
- * get course enrollment
61
+ * Get course enrollments
62
62
  */
63
- getCourseEnrollmentRaw(requestParameters, initOverrides) {
63
+ getCourseEnrollmentsRaw(requestParameters, initOverrides) {
64
64
  return __awaiter(this, void 0, void 0, function* () {
65
65
  if (requestParameters['courseId'] == null) {
66
- throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getCourseEnrollment().');
66
+ throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getCourseEnrollments().');
67
67
  }
68
68
  const queryParameters = {};
69
69
  const headerParameters = {};
70
70
  const response = yield this.request({
71
- path: `/courses/{courseId}/enroll`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))),
71
+ path: `/courses/{courseId}/enrollments`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))),
72
72
  method: 'GET',
73
73
  headers: headerParameters,
74
74
  query: queryParameters,
@@ -77,11 +77,11 @@ class CourseApi extends runtime.BaseAPI {
77
77
  });
78
78
  }
79
79
  /**
80
- * get course enrollment
80
+ * Get course enrollments
81
81
  */
82
- getCourseEnrollment(requestParameters, initOverrides) {
82
+ getCourseEnrollments(requestParameters, initOverrides) {
83
83
  return __awaiter(this, void 0, void 0, function* () {
84
- const response = yield this.getCourseEnrollmentRaw(requestParameters, initOverrides);
84
+ const response = yield this.getCourseEnrollmentsRaw(requestParameters, initOverrides);
85
85
  return yield response.value();
86
86
  });
87
87
  }
@@ -141,7 +141,7 @@ class CourseApi extends runtime.BaseAPI {
141
141
  });
142
142
  }
143
143
  /**
144
- * Post a new course enrollment
144
+ * Create a new course enrollment
145
145
  */
146
146
  postCourseEnrollmentRaw(requestParameters, initOverrides) {
147
147
  return __awaiter(this, void 0, void 0, function* () {
@@ -155,7 +155,7 @@ class CourseApi extends runtime.BaseAPI {
155
155
  const headerParameters = {};
156
156
  headerParameters['Content-Type'] = 'application/json';
157
157
  const response = yield this.request({
158
- path: `/courses/{courseId}/enroll`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))),
158
+ path: `/courses/{courseId}/enrollments`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))),
159
159
  method: 'POST',
160
160
  headers: headerParameters,
161
161
  query: queryParameters,
@@ -165,7 +165,7 @@ class CourseApi extends runtime.BaseAPI {
165
165
  });
166
166
  }
167
167
  /**
168
- * Post a new course enrollment
168
+ * Create a new course enrollment
169
169
  */
170
170
  postCourseEnrollment(requestParameters, initOverrides) {
171
171
  return __awaiter(this, void 0, void 0, function* () {
@@ -206,5 +206,41 @@ class CourseApi extends runtime.BaseAPI {
206
206
  return yield response.value();
207
207
  });
208
208
  }
209
+ /**
210
+ * Update a course enrollment
211
+ */
212
+ putCourseEnrollmentRaw(requestParameters, initOverrides) {
213
+ return __awaiter(this, void 0, void 0, function* () {
214
+ if (requestParameters['courseId'] == null) {
215
+ throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling putCourseEnrollment().');
216
+ }
217
+ if (requestParameters['enrollmentId'] == null) {
218
+ throw new runtime.RequiredError('enrollmentId', 'Required parameter "enrollmentId" was null or undefined when calling putCourseEnrollment().');
219
+ }
220
+ if (requestParameters['putCourseEnrollment'] == null) {
221
+ throw new runtime.RequiredError('putCourseEnrollment', 'Required parameter "putCourseEnrollment" was null or undefined when calling putCourseEnrollment().');
222
+ }
223
+ const queryParameters = {};
224
+ const headerParameters = {};
225
+ headerParameters['Content-Type'] = 'application/json';
226
+ const response = yield this.request({
227
+ path: `/courses/{courseId}/enrollments/{enrollmentId}`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))).replace(`{${"enrollmentId"}}`, encodeURIComponent(String(requestParameters['enrollmentId']))),
228
+ method: 'PUT',
229
+ headers: headerParameters,
230
+ query: queryParameters,
231
+ body: (0, index_1.PutCourseEnrollmentToJSON)(requestParameters['putCourseEnrollment']),
232
+ }, initOverrides);
233
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GetCourseEnrollmentFromJSON)(jsonValue));
234
+ });
235
+ }
236
+ /**
237
+ * Update a course enrollment
238
+ */
239
+ putCourseEnrollment(requestParameters, initOverrides) {
240
+ return __awaiter(this, void 0, void 0, function* () {
241
+ const response = yield this.putCourseEnrollmentRaw(requestParameters, initOverrides);
242
+ return yield response.value();
243
+ });
244
+ }
209
245
  }
210
246
  exports.CourseApi = CourseApi;
@@ -10,10 +10,16 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import type { GetPortal, GetPortalList, PostPortal, PostPortalInvite, PutPortalBranding } from '../models/index';
13
+ import type { GetPortal, GetPortalList, GetPortalUserList, PostPortal, PostPortalInvite, PutPortalBranding } from '../models/index';
14
14
  export interface GetPortalByIdRequest {
15
15
  portalId: string;
16
16
  }
17
+ export interface GetPortalUsersRequest {
18
+ portalId: string;
19
+ roles?: Array<GetPortalUsersRolesEnum>;
20
+ page?: number;
21
+ pageSize?: number;
22
+ }
17
23
  export interface InviteUserToPortalRequest {
18
24
  portalId: string;
19
25
  postPortalInvite: PostPortalInvite;
@@ -49,6 +55,14 @@ export declare class PortalApi extends runtime.BaseAPI {
49
55
  * Get all portals a user has access to
50
56
  */
51
57
  getPortalList(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortalList>;
58
+ /**
59
+ * Get all users for a portal with optional role filtering
60
+ */
61
+ getPortalUsersRaw(requestParameters: GetPortalUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortalUserList>>;
62
+ /**
63
+ * Get all users for a portal with optional role filtering
64
+ */
65
+ getPortalUsers(requestParameters: GetPortalUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortalUserList>;
52
66
  /**
53
67
  * Invite a new user to a portal
54
68
  */
@@ -82,3 +96,12 @@ export declare class PortalApi extends runtime.BaseAPI {
82
96
  */
83
97
  updateSelectedPortal(requestParameters: UpdateSelectedPortalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
84
98
  }
99
+ /**
100
+ * @export
101
+ */
102
+ export declare const GetPortalUsersRolesEnum: {
103
+ readonly Admin: "Admin";
104
+ readonly Instructor: "Instructor";
105
+ readonly Learner: "Learner";
106
+ };
107
+ export type GetPortalUsersRolesEnum = typeof GetPortalUsersRolesEnum[keyof typeof GetPortalUsersRolesEnum];
@@ -22,7 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
22
22
  });
23
23
  };
24
24
  Object.defineProperty(exports, "__esModule", { value: true });
25
- exports.PortalApi = void 0;
25
+ exports.GetPortalUsersRolesEnum = exports.PortalApi = void 0;
26
26
  const runtime = require("../runtime");
27
27
  const index_1 = require("../models/index");
28
28
  /**
@@ -82,6 +82,43 @@ class PortalApi extends runtime.BaseAPI {
82
82
  return yield response.value();
83
83
  });
84
84
  }
85
+ /**
86
+ * Get all users for a portal with optional role filtering
87
+ */
88
+ getPortalUsersRaw(requestParameters, initOverrides) {
89
+ return __awaiter(this, void 0, void 0, function* () {
90
+ if (requestParameters['portalId'] == null) {
91
+ throw new runtime.RequiredError('portalId', 'Required parameter "portalId" was null or undefined when calling getPortalUsers().');
92
+ }
93
+ const queryParameters = {};
94
+ if (requestParameters['roles'] != null) {
95
+ queryParameters['roles'] = requestParameters['roles'];
96
+ }
97
+ if (requestParameters['page'] != null) {
98
+ queryParameters['page'] = requestParameters['page'];
99
+ }
100
+ if (requestParameters['pageSize'] != null) {
101
+ queryParameters['page_size'] = requestParameters['pageSize'];
102
+ }
103
+ const headerParameters = {};
104
+ const response = yield this.request({
105
+ path: `/portals/{portalId}/users`.replace(`{${"portalId"}}`, encodeURIComponent(String(requestParameters['portalId']))),
106
+ method: 'GET',
107
+ headers: headerParameters,
108
+ query: queryParameters,
109
+ }, initOverrides);
110
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GetPortalUserListFromJSON)(jsonValue));
111
+ });
112
+ }
113
+ /**
114
+ * Get all users for a portal with optional role filtering
115
+ */
116
+ getPortalUsers(requestParameters, initOverrides) {
117
+ return __awaiter(this, void 0, void 0, function* () {
118
+ const response = yield this.getPortalUsersRaw(requestParameters, initOverrides);
119
+ return yield response.value();
120
+ });
121
+ }
85
122
  /**
86
123
  * Invite a new user to a portal
87
124
  */
@@ -209,3 +246,11 @@ class PortalApi extends runtime.BaseAPI {
209
246
  }
210
247
  }
211
248
  exports.PortalApi = PortalApi;
249
+ /**
250
+ * @export
251
+ */
252
+ exports.GetPortalUsersRolesEnum = {
253
+ Admin: 'Admin',
254
+ Instructor: 'Instructor',
255
+ Learner: 'Learner'
256
+ };
@@ -10,11 +10,11 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import type { GetCourse, GetCourseEnrollment, GetCourseEnrollmentList, GetCourseList, PostCourse, PostCourseEnrollment, PutCourse } from '../models/index';
13
+ import type { GetCourse, GetCourseEnrollment, GetCourseEnrollmentList, GetCourseList, PostCourse, PostCourseEnrollment, PutCourse, PutCourseEnrollment } from '../models/index';
14
14
  export interface GetCourseRequest {
15
15
  courseId: string;
16
16
  }
17
- export interface GetCourseEnrollmentRequest {
17
+ export interface GetCourseEnrollmentsRequest {
18
18
  courseId: string;
19
19
  }
20
20
  export interface PostCourseRequest {
@@ -28,6 +28,11 @@ export interface PutCourseRequest {
28
28
  courseId: string;
29
29
  putCourse: Omit<PutCourse, 'id'>;
30
30
  }
31
+ export interface PutCourseEnrollmentRequest {
32
+ courseId: string;
33
+ enrollmentId: string;
34
+ putCourseEnrollment: PutCourseEnrollment;
35
+ }
31
36
  /**
32
37
  *
33
38
  */
@@ -41,13 +46,13 @@ export declare class CourseApi extends runtime.BaseAPI {
41
46
  */
42
47
  getCourse(requestParameters: GetCourseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourse>;
43
48
  /**
44
- * get course enrollment
49
+ * Get course enrollments
45
50
  */
46
- getCourseEnrollmentRaw(requestParameters: GetCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseEnrollmentList>>;
51
+ getCourseEnrollmentsRaw(requestParameters: GetCourseEnrollmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseEnrollmentList>>;
47
52
  /**
48
- * get course enrollment
53
+ * Get course enrollments
49
54
  */
50
- getCourseEnrollment(requestParameters: GetCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseEnrollmentList>;
55
+ getCourseEnrollments(requestParameters: GetCourseEnrollmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseEnrollmentList>;
51
56
  /**
52
57
  * get course list
53
58
  */
@@ -65,11 +70,11 @@ export declare class CourseApi extends runtime.BaseAPI {
65
70
  */
66
71
  postCourse(requestParameters: PostCourseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourse>;
67
72
  /**
68
- * Post a new course enrollment
73
+ * Create a new course enrollment
69
74
  */
70
75
  postCourseEnrollmentRaw(requestParameters: PostCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseEnrollment>>;
71
76
  /**
72
- * Post a new course enrollment
77
+ * Create a new course enrollment
73
78
  */
74
79
  postCourseEnrollment(requestParameters: PostCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseEnrollment>;
75
80
  /**
@@ -80,4 +85,12 @@ export declare class CourseApi extends runtime.BaseAPI {
80
85
  * Update a course by id
81
86
  */
82
87
  putCourse(requestParameters: PutCourseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourse>;
88
+ /**
89
+ * Update a course enrollment
90
+ */
91
+ putCourseEnrollmentRaw(requestParameters: PutCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseEnrollment>>;
92
+ /**
93
+ * Update a course enrollment
94
+ */
95
+ putCourseEnrollment(requestParameters: PutCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseEnrollment>;
83
96
  }
@@ -21,7 +21,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
21
21
  });
22
22
  };
23
23
  import * as runtime from '../runtime';
24
- import { GetCourseFromJSON, GetCourseEnrollmentFromJSON, GetCourseEnrollmentListFromJSON, GetCourseListFromJSON, PostCourseToJSON, PostCourseEnrollmentToJSON, PutCourseToJSON, } from '../models/index';
24
+ import { GetCourseFromJSON, GetCourseEnrollmentFromJSON, GetCourseEnrollmentListFromJSON, GetCourseListFromJSON, PostCourseToJSON, PostCourseEnrollmentToJSON, PutCourseToJSON, PutCourseEnrollmentToJSON, } from '../models/index';
25
25
  /**
26
26
  *
27
27
  */
@@ -55,17 +55,17 @@ export class CourseApi extends runtime.BaseAPI {
55
55
  });
56
56
  }
57
57
  /**
58
- * get course enrollment
58
+ * Get course enrollments
59
59
  */
60
- getCourseEnrollmentRaw(requestParameters, initOverrides) {
60
+ getCourseEnrollmentsRaw(requestParameters, initOverrides) {
61
61
  return __awaiter(this, void 0, void 0, function* () {
62
62
  if (requestParameters['courseId'] == null) {
63
- throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getCourseEnrollment().');
63
+ throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getCourseEnrollments().');
64
64
  }
65
65
  const queryParameters = {};
66
66
  const headerParameters = {};
67
67
  const response = yield this.request({
68
- path: `/courses/{courseId}/enroll`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))),
68
+ path: `/courses/{courseId}/enrollments`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))),
69
69
  method: 'GET',
70
70
  headers: headerParameters,
71
71
  query: queryParameters,
@@ -74,11 +74,11 @@ export class CourseApi extends runtime.BaseAPI {
74
74
  });
75
75
  }
76
76
  /**
77
- * get course enrollment
77
+ * Get course enrollments
78
78
  */
79
- getCourseEnrollment(requestParameters, initOverrides) {
79
+ getCourseEnrollments(requestParameters, initOverrides) {
80
80
  return __awaiter(this, void 0, void 0, function* () {
81
- const response = yield this.getCourseEnrollmentRaw(requestParameters, initOverrides);
81
+ const response = yield this.getCourseEnrollmentsRaw(requestParameters, initOverrides);
82
82
  return yield response.value();
83
83
  });
84
84
  }
@@ -138,7 +138,7 @@ export class CourseApi extends runtime.BaseAPI {
138
138
  });
139
139
  }
140
140
  /**
141
- * Post a new course enrollment
141
+ * Create a new course enrollment
142
142
  */
143
143
  postCourseEnrollmentRaw(requestParameters, initOverrides) {
144
144
  return __awaiter(this, void 0, void 0, function* () {
@@ -152,7 +152,7 @@ export class CourseApi extends runtime.BaseAPI {
152
152
  const headerParameters = {};
153
153
  headerParameters['Content-Type'] = 'application/json';
154
154
  const response = yield this.request({
155
- path: `/courses/{courseId}/enroll`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))),
155
+ path: `/courses/{courseId}/enrollments`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))),
156
156
  method: 'POST',
157
157
  headers: headerParameters,
158
158
  query: queryParameters,
@@ -162,7 +162,7 @@ export class CourseApi extends runtime.BaseAPI {
162
162
  });
163
163
  }
164
164
  /**
165
- * Post a new course enrollment
165
+ * Create a new course enrollment
166
166
  */
167
167
  postCourseEnrollment(requestParameters, initOverrides) {
168
168
  return __awaiter(this, void 0, void 0, function* () {
@@ -203,4 +203,40 @@ export class CourseApi extends runtime.BaseAPI {
203
203
  return yield response.value();
204
204
  });
205
205
  }
206
+ /**
207
+ * Update a course enrollment
208
+ */
209
+ putCourseEnrollmentRaw(requestParameters, initOverrides) {
210
+ return __awaiter(this, void 0, void 0, function* () {
211
+ if (requestParameters['courseId'] == null) {
212
+ throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling putCourseEnrollment().');
213
+ }
214
+ if (requestParameters['enrollmentId'] == null) {
215
+ throw new runtime.RequiredError('enrollmentId', 'Required parameter "enrollmentId" was null or undefined when calling putCourseEnrollment().');
216
+ }
217
+ if (requestParameters['putCourseEnrollment'] == null) {
218
+ throw new runtime.RequiredError('putCourseEnrollment', 'Required parameter "putCourseEnrollment" was null or undefined when calling putCourseEnrollment().');
219
+ }
220
+ const queryParameters = {};
221
+ const headerParameters = {};
222
+ headerParameters['Content-Type'] = 'application/json';
223
+ const response = yield this.request({
224
+ path: `/courses/{courseId}/enrollments/{enrollmentId}`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))).replace(`{${"enrollmentId"}}`, encodeURIComponent(String(requestParameters['enrollmentId']))),
225
+ method: 'PUT',
226
+ headers: headerParameters,
227
+ query: queryParameters,
228
+ body: PutCourseEnrollmentToJSON(requestParameters['putCourseEnrollment']),
229
+ }, initOverrides);
230
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetCourseEnrollmentFromJSON(jsonValue));
231
+ });
232
+ }
233
+ /**
234
+ * Update a course enrollment
235
+ */
236
+ putCourseEnrollment(requestParameters, initOverrides) {
237
+ return __awaiter(this, void 0, void 0, function* () {
238
+ const response = yield this.putCourseEnrollmentRaw(requestParameters, initOverrides);
239
+ return yield response.value();
240
+ });
241
+ }
206
242
  }
@@ -10,10 +10,16 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import type { GetPortal, GetPortalList, PostPortal, PostPortalInvite, PutPortalBranding } from '../models/index';
13
+ import type { GetPortal, GetPortalList, GetPortalUserList, PostPortal, PostPortalInvite, PutPortalBranding } from '../models/index';
14
14
  export interface GetPortalByIdRequest {
15
15
  portalId: string;
16
16
  }
17
+ export interface GetPortalUsersRequest {
18
+ portalId: string;
19
+ roles?: Array<GetPortalUsersRolesEnum>;
20
+ page?: number;
21
+ pageSize?: number;
22
+ }
17
23
  export interface InviteUserToPortalRequest {
18
24
  portalId: string;
19
25
  postPortalInvite: PostPortalInvite;
@@ -49,6 +55,14 @@ export declare class PortalApi extends runtime.BaseAPI {
49
55
  * Get all portals a user has access to
50
56
  */
51
57
  getPortalList(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortalList>;
58
+ /**
59
+ * Get all users for a portal with optional role filtering
60
+ */
61
+ getPortalUsersRaw(requestParameters: GetPortalUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortalUserList>>;
62
+ /**
63
+ * Get all users for a portal with optional role filtering
64
+ */
65
+ getPortalUsers(requestParameters: GetPortalUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortalUserList>;
52
66
  /**
53
67
  * Invite a new user to a portal
54
68
  */
@@ -82,3 +96,12 @@ export declare class PortalApi extends runtime.BaseAPI {
82
96
  */
83
97
  updateSelectedPortal(requestParameters: UpdateSelectedPortalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
84
98
  }
99
+ /**
100
+ * @export
101
+ */
102
+ export declare const GetPortalUsersRolesEnum: {
103
+ readonly Admin: "Admin";
104
+ readonly Instructor: "Instructor";
105
+ readonly Learner: "Learner";
106
+ };
107
+ export type GetPortalUsersRolesEnum = typeof GetPortalUsersRolesEnum[keyof typeof GetPortalUsersRolesEnum];
@@ -21,7 +21,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
21
21
  });
22
22
  };
23
23
  import * as runtime from '../runtime';
24
- import { GetPortalFromJSON, GetPortalListFromJSON, PostPortalToJSON, PostPortalInviteToJSON, PutPortalBrandingToJSON, } from '../models/index';
24
+ import { GetPortalFromJSON, GetPortalListFromJSON, GetPortalUserListFromJSON, PostPortalToJSON, PostPortalInviteToJSON, PutPortalBrandingToJSON, } from '../models/index';
25
25
  /**
26
26
  *
27
27
  */
@@ -79,6 +79,43 @@ export class PortalApi extends runtime.BaseAPI {
79
79
  return yield response.value();
80
80
  });
81
81
  }
82
+ /**
83
+ * Get all users for a portal with optional role filtering
84
+ */
85
+ getPortalUsersRaw(requestParameters, initOverrides) {
86
+ return __awaiter(this, void 0, void 0, function* () {
87
+ if (requestParameters['portalId'] == null) {
88
+ throw new runtime.RequiredError('portalId', 'Required parameter "portalId" was null or undefined when calling getPortalUsers().');
89
+ }
90
+ const queryParameters = {};
91
+ if (requestParameters['roles'] != null) {
92
+ queryParameters['roles'] = requestParameters['roles'];
93
+ }
94
+ if (requestParameters['page'] != null) {
95
+ queryParameters['page'] = requestParameters['page'];
96
+ }
97
+ if (requestParameters['pageSize'] != null) {
98
+ queryParameters['page_size'] = requestParameters['pageSize'];
99
+ }
100
+ const headerParameters = {};
101
+ const response = yield this.request({
102
+ path: `/portals/{portalId}/users`.replace(`{${"portalId"}}`, encodeURIComponent(String(requestParameters['portalId']))),
103
+ method: 'GET',
104
+ headers: headerParameters,
105
+ query: queryParameters,
106
+ }, initOverrides);
107
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetPortalUserListFromJSON(jsonValue));
108
+ });
109
+ }
110
+ /**
111
+ * Get all users for a portal with optional role filtering
112
+ */
113
+ getPortalUsers(requestParameters, initOverrides) {
114
+ return __awaiter(this, void 0, void 0, function* () {
115
+ const response = yield this.getPortalUsersRaw(requestParameters, initOverrides);
116
+ return yield response.value();
117
+ });
118
+ }
82
119
  /**
83
120
  * Invite a new user to a portal
84
121
  */
@@ -205,3 +242,11 @@ export class PortalApi extends runtime.BaseAPI {
205
242
  });
206
243
  }
207
244
  }
245
+ /**
246
+ * @export
247
+ */
248
+ export const GetPortalUsersRolesEnum = {
249
+ Admin: 'Admin',
250
+ Instructor: 'Instructor',
251
+ Learner: 'Learner'
252
+ };
@@ -16,13 +16,19 @@
16
16
  */
17
17
  export interface GetCourseEnrollment {
18
18
  /**
19
- * The ID of the course
19
+ * The external ID of the enrollment
20
+ * @type {string}
21
+ * @memberof GetCourseEnrollment
22
+ */
23
+ id: string;
24
+ /**
25
+ * The external ID of the course
20
26
  * @type {string}
21
27
  * @memberof GetCourseEnrollment
22
28
  */
23
29
  courseId: string;
24
30
  /**
25
- * The ID of the enrolled user
31
+ * The external ID of the enrolled user
26
32
  * @type {string}
27
33
  * @memberof GetCourseEnrollment
28
34
  */
@@ -63,10 +69,8 @@ export interface GetCourseEnrollment {
63
69
  */
64
70
  export declare const GetCourseEnrollmentStatusEnum: {
65
71
  readonly Enrolled: "Enrolled";
66
- readonly Dropped: "Dropped";
67
72
  readonly Completed: "Completed";
68
- readonly Waitlisted: "Waitlisted";
69
- readonly Unknown: "Unknown";
73
+ readonly Removed: "Removed";
70
74
  };
71
75
  export type GetCourseEnrollmentStatusEnum = typeof GetCourseEnrollmentStatusEnum[keyof typeof GetCourseEnrollmentStatusEnum];
72
76
  /**