@easyedu/js-lsm-api 1.64.0 → 1.65.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/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # @easyedu/js-lsm-api@1.64.0
1
+ # @easyedu/js-lsm-api@1.65.0
2
2
 
3
3
  A TypeScript SDK client for the sbzw93t49b.execute-api.us-east-2.amazonaws.com API.
4
4
 
@@ -70,6 +70,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
70
70
  *ChatApi* | [**postMessage**](docs/ChatApi.md#postmessage) | **POST** /chat/conversations/{conversationId}/messages | Send a message to a conversation
71
71
  *ContentApi* | [**commitScormSession**](docs/ContentApi.md#commitscormsession) | **POST** /scorm/sessions/{scormSessionId}/commit | Commit SCORM session data
72
72
  *ContentApi* | [**deleteContent**](docs/ContentApi.md#deletecontent) | **DELETE** /courses/{courseId}/modules/{moduleId}/contents/{contentId} | Delete content by id
73
+ *ContentApi* | [**deleteContentVersion**](docs/ContentApi.md#deletecontentversion) | **DELETE** /courses/{courseId}/modules/{moduleId}/contents/{contentId}/versions/{versionId} | Delete an inactive content version
73
74
  *ContentApi* | [**getContent**](docs/ContentApi.md#getcontent) | **GET** /courses/{courseId}/modules/{moduleId}/contents/{contentId} | get content
74
75
  *ContentApi* | [**getContentList**](docs/ContentApi.md#getcontentlist) | **GET** /courses/{courseId}/modules/{moduleId}/contents | get content list
75
76
  *ContentApi* | [**getContentSession**](docs/ContentApi.md#getcontentsession) | **GET** /courses/{courseId}/modules/{moduleId}/contents/{contentId}/session | get content session
@@ -94,6 +95,8 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
94
95
  *ContentApi* | [**terminateScormSession**](docs/ContentApi.md#terminatescormsession) | **POST** /scorm/sessions/{scormSessionId}/terminate | Terminate a SCORM session
95
96
  *ContentApi* | [**verifyScormManifest**](docs/ContentApi.md#verifyscormmanifest) | **POST** /scorm/tools/verify-manifest | Parse and verify a SCORM manifest
96
97
  *CourseApi* | [**deleteCourse**](docs/CourseApi.md#deletecourse) | **DELETE** /courses/{courseId} | Delete a course by id
98
+ *CourseApi* | [**deleteCourseEnrollment**](docs/CourseApi.md#deletecourseenrollment) | **DELETE** /courses/{courseId}/enrollments/{enrollmentId} | Remove a course enrollment
99
+ *CourseApi* | [**deleteCourseExport**](docs/CourseApi.md#deletecourseexport) | **DELETE** /courses/{courseId}/exports/{exportId} | Delete a course export
97
100
  *CourseApi* | [**deleteCourseImage**](docs/CourseApi.md#deletecourseimage) | **DELETE** /courses/{courseId}/image | Remove the course image
98
101
  *CourseApi* | [**getCourse**](docs/CourseApi.md#getcourse) | **GET** /courses/{courseId} | get course
99
102
  *CourseApi* | [**getCourseEnrollment**](docs/CourseApi.md#getcourseenrollment) | **GET** /courses/{courseId}/enrollments/{enrollmentId} | Get a specific course enrollment
@@ -158,6 +161,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
158
161
  *PortalApi* | [**postPortalFaviconUpload**](docs/PortalApi.md#postportalfaviconupload) | **POST** /portals/{portalId}/branding/favicon | Upload a favicon image for portal branding
159
162
  *PortalApi* | [**postPortalLogoUpload**](docs/PortalApi.md#postportallogoupload) | **POST** /portals/{portalId}/branding/logo | Upload a logo image for portal branding
160
163
  *PortalApi* | [**putPortalBranding**](docs/PortalApi.md#putportalbranding) | **PUT** /portals/{portalId} | Update portal branding (name, background color, text color)
164
+ *PortalApi* | [**removePortalUser**](docs/PortalApi.md#removeportaluser) | **DELETE** /portals/{portalId}/users/{userId} | Remove a user from a portal
161
165
  *PortalApi* | [**updateSelectedPortal**](docs/PortalApi.md#updateselectedportal) | **PUT** /portals/{portalId}/selected | Update the users current selected portal. Returns new JWT with updated roles.
162
166
  *PortalSublicenseApi* | [**putPortalSublicense**](docs/PortalSublicenseApi.md#putportalsublicense) | **PUT** /portals/{portalId}/sublicense | Manage seat limit and license window for a descendant portal
163
167
  *QuestionApi* | [**deleteQuestion**](docs/QuestionApi.md#deletequestion) | **DELETE** /questions/{questionId} | Delete a question by ID
@@ -509,7 +513,7 @@ and is automatically generated by the
509
513
  [OpenAPI Generator](https://openapi-generator.tech) project:
510
514
 
511
515
  - API version: `1.0.0`
512
- - Package version: `1.64.0`
516
+ - Package version: `1.65.0`
513
517
  - Generator version: `7.22.0`
514
518
  - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
515
519
 
@@ -40,6 +40,12 @@ export interface DeleteContentRequest {
40
40
  moduleId: string;
41
41
  courseId: string;
42
42
  }
43
+ export interface DeleteContentVersionRequest {
44
+ contentId: string;
45
+ moduleId: string;
46
+ courseId: string;
47
+ versionId: string;
48
+ }
43
49
  export interface GetContentRequest {
44
50
  contentId: string;
45
51
  moduleId: string;
@@ -187,6 +193,18 @@ export declare class ContentApi extends runtime.BaseAPI {
187
193
  * Delete content by id
188
194
  */
189
195
  deleteContent(requestParameters: DeleteContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
196
+ /**
197
+ * Creates request options for deleteContentVersion without sending the request
198
+ */
199
+ deleteContentVersionRequestOpts(requestParameters: DeleteContentVersionRequest): Promise<runtime.RequestOpts>;
200
+ /**
201
+ * Delete an inactive content version
202
+ */
203
+ deleteContentVersionRaw(requestParameters: DeleteContentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
204
+ /**
205
+ * Delete an inactive content version
206
+ */
207
+ deleteContentVersion(requestParameters: DeleteContentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
190
208
  /**
191
209
  * Creates request options for getContent without sending the request
192
210
  */
@@ -138,6 +138,56 @@ class ContentApi extends runtime.BaseAPI {
138
138
  yield this.deleteContentRaw(requestParameters, initOverrides);
139
139
  });
140
140
  }
141
+ /**
142
+ * Creates request options for deleteContentVersion without sending the request
143
+ */
144
+ deleteContentVersionRequestOpts(requestParameters) {
145
+ return __awaiter(this, void 0, void 0, function* () {
146
+ if (requestParameters['contentId'] == null) {
147
+ throw new runtime.RequiredError('contentId', 'Required parameter "contentId" was null or undefined when calling deleteContentVersion().');
148
+ }
149
+ if (requestParameters['moduleId'] == null) {
150
+ throw new runtime.RequiredError('moduleId', 'Required parameter "moduleId" was null or undefined when calling deleteContentVersion().');
151
+ }
152
+ if (requestParameters['courseId'] == null) {
153
+ throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling deleteContentVersion().');
154
+ }
155
+ if (requestParameters['versionId'] == null) {
156
+ throw new runtime.RequiredError('versionId', 'Required parameter "versionId" was null or undefined when calling deleteContentVersion().');
157
+ }
158
+ const queryParameters = {};
159
+ const headerParameters = {};
160
+ let urlPath = `/courses/{courseId}/modules/{moduleId}/contents/{contentId}/versions/{versionId}`;
161
+ urlPath = urlPath.replace('{contentId}', encodeURIComponent(String(requestParameters['contentId'])));
162
+ urlPath = urlPath.replace('{moduleId}', encodeURIComponent(String(requestParameters['moduleId'])));
163
+ urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
164
+ urlPath = urlPath.replace('{versionId}', encodeURIComponent(String(requestParameters['versionId'])));
165
+ return {
166
+ path: urlPath,
167
+ method: 'DELETE',
168
+ headers: headerParameters,
169
+ query: queryParameters,
170
+ };
171
+ });
172
+ }
173
+ /**
174
+ * Delete an inactive content version
175
+ */
176
+ deleteContentVersionRaw(requestParameters, initOverrides) {
177
+ return __awaiter(this, void 0, void 0, function* () {
178
+ const requestOptions = yield this.deleteContentVersionRequestOpts(requestParameters);
179
+ const response = yield this.request(requestOptions, initOverrides);
180
+ return new runtime.VoidApiResponse(response);
181
+ });
182
+ }
183
+ /**
184
+ * Delete an inactive content version
185
+ */
186
+ deleteContentVersion(requestParameters, initOverrides) {
187
+ return __awaiter(this, void 0, void 0, function* () {
188
+ yield this.deleteContentVersionRaw(requestParameters, initOverrides);
189
+ });
190
+ }
141
191
  /**
142
192
  * Creates request options for getContent without sending the request
143
193
  */
@@ -27,6 +27,14 @@ import { type PutCourseEnrollment } from '../models/PutCourseEnrollment';
27
27
  export interface DeleteCourseRequest {
28
28
  courseId: string;
29
29
  }
30
+ export interface DeleteCourseEnrollmentRequest {
31
+ courseId: string;
32
+ enrollmentId: string;
33
+ }
34
+ export interface DeleteCourseExportRequest {
35
+ courseId: string;
36
+ exportId: string;
37
+ }
30
38
  export interface DeleteCourseImageRequest {
31
39
  courseId: string;
32
40
  }
@@ -108,6 +116,30 @@ export declare class CourseApi extends runtime.BaseAPI {
108
116
  * Delete a course by id
109
117
  */
110
118
  deleteCourse(requestParameters: DeleteCourseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
119
+ /**
120
+ * Creates request options for deleteCourseEnrollment without sending the request
121
+ */
122
+ deleteCourseEnrollmentRequestOpts(requestParameters: DeleteCourseEnrollmentRequest): Promise<runtime.RequestOpts>;
123
+ /**
124
+ * Remove a course enrollment
125
+ */
126
+ deleteCourseEnrollmentRaw(requestParameters: DeleteCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
127
+ /**
128
+ * Remove a course enrollment
129
+ */
130
+ deleteCourseEnrollment(requestParameters: DeleteCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
131
+ /**
132
+ * Creates request options for deleteCourseExport without sending the request
133
+ */
134
+ deleteCourseExportRequestOpts(requestParameters: DeleteCourseExportRequest): Promise<runtime.RequestOpts>;
135
+ /**
136
+ * Delete a course export
137
+ */
138
+ deleteCourseExportRaw(requestParameters: DeleteCourseExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
139
+ /**
140
+ * Delete a course export
141
+ */
142
+ deleteCourseExport(requestParameters: DeleteCourseExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
111
143
  /**
112
144
  * Creates request options for deleteCourseImage without sending the request
113
145
  */
@@ -82,6 +82,90 @@ class CourseApi extends runtime.BaseAPI {
82
82
  yield this.deleteCourseRaw(requestParameters, initOverrides);
83
83
  });
84
84
  }
85
+ /**
86
+ * Creates request options for deleteCourseEnrollment without sending the request
87
+ */
88
+ deleteCourseEnrollmentRequestOpts(requestParameters) {
89
+ return __awaiter(this, void 0, void 0, function* () {
90
+ if (requestParameters['courseId'] == null) {
91
+ throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling deleteCourseEnrollment().');
92
+ }
93
+ if (requestParameters['enrollmentId'] == null) {
94
+ throw new runtime.RequiredError('enrollmentId', 'Required parameter "enrollmentId" was null or undefined when calling deleteCourseEnrollment().');
95
+ }
96
+ const queryParameters = {};
97
+ const headerParameters = {};
98
+ let urlPath = `/courses/{courseId}/enrollments/{enrollmentId}`;
99
+ urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
100
+ urlPath = urlPath.replace('{enrollmentId}', encodeURIComponent(String(requestParameters['enrollmentId'])));
101
+ return {
102
+ path: urlPath,
103
+ method: 'DELETE',
104
+ headers: headerParameters,
105
+ query: queryParameters,
106
+ };
107
+ });
108
+ }
109
+ /**
110
+ * Remove a course enrollment
111
+ */
112
+ deleteCourseEnrollmentRaw(requestParameters, initOverrides) {
113
+ return __awaiter(this, void 0, void 0, function* () {
114
+ const requestOptions = yield this.deleteCourseEnrollmentRequestOpts(requestParameters);
115
+ const response = yield this.request(requestOptions, initOverrides);
116
+ return new runtime.VoidApiResponse(response);
117
+ });
118
+ }
119
+ /**
120
+ * Remove a course enrollment
121
+ */
122
+ deleteCourseEnrollment(requestParameters, initOverrides) {
123
+ return __awaiter(this, void 0, void 0, function* () {
124
+ yield this.deleteCourseEnrollmentRaw(requestParameters, initOverrides);
125
+ });
126
+ }
127
+ /**
128
+ * Creates request options for deleteCourseExport without sending the request
129
+ */
130
+ deleteCourseExportRequestOpts(requestParameters) {
131
+ return __awaiter(this, void 0, void 0, function* () {
132
+ if (requestParameters['courseId'] == null) {
133
+ throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling deleteCourseExport().');
134
+ }
135
+ if (requestParameters['exportId'] == null) {
136
+ throw new runtime.RequiredError('exportId', 'Required parameter "exportId" was null or undefined when calling deleteCourseExport().');
137
+ }
138
+ const queryParameters = {};
139
+ const headerParameters = {};
140
+ let urlPath = `/courses/{courseId}/exports/{exportId}`;
141
+ urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
142
+ urlPath = urlPath.replace('{exportId}', encodeURIComponent(String(requestParameters['exportId'])));
143
+ return {
144
+ path: urlPath,
145
+ method: 'DELETE',
146
+ headers: headerParameters,
147
+ query: queryParameters,
148
+ };
149
+ });
150
+ }
151
+ /**
152
+ * Delete a course export
153
+ */
154
+ deleteCourseExportRaw(requestParameters, initOverrides) {
155
+ return __awaiter(this, void 0, void 0, function* () {
156
+ const requestOptions = yield this.deleteCourseExportRequestOpts(requestParameters);
157
+ const response = yield this.request(requestOptions, initOverrides);
158
+ return new runtime.VoidApiResponse(response);
159
+ });
160
+ }
161
+ /**
162
+ * Delete a course export
163
+ */
164
+ deleteCourseExport(requestParameters, initOverrides) {
165
+ return __awaiter(this, void 0, void 0, function* () {
166
+ yield this.deleteCourseExportRaw(requestParameters, initOverrides);
167
+ });
168
+ }
85
169
  /**
86
170
  * Creates request options for deleteCourseImage without sending the request
87
171
  */
@@ -56,6 +56,10 @@ export interface PutPortalBrandingRequest {
56
56
  portalId: string;
57
57
  putPortalBranding: PutPortalBranding;
58
58
  }
59
+ export interface RemovePortalUserRequest {
60
+ portalId: string;
61
+ userId: string;
62
+ }
59
63
  export interface UpdateSelectedPortalRequest {
60
64
  portalId: string;
61
65
  }
@@ -197,6 +201,18 @@ export declare class PortalApi extends runtime.BaseAPI {
197
201
  * Update portal branding (name, background color, text color)
198
202
  */
199
203
  putPortalBranding(requestParameters: PutPortalBrandingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortal>;
204
+ /**
205
+ * Creates request options for removePortalUser without sending the request
206
+ */
207
+ removePortalUserRequestOpts(requestParameters: RemovePortalUserRequest): Promise<runtime.RequestOpts>;
208
+ /**
209
+ * Remove a user from a portal
210
+ */
211
+ removePortalUserRaw(requestParameters: RemovePortalUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
212
+ /**
213
+ * Remove a user from a portal
214
+ */
215
+ removePortalUser(requestParameters: RemovePortalUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
200
216
  /**
201
217
  * Creates request options for updateSelectedPortal without sending the request
202
218
  */
@@ -528,6 +528,48 @@ class PortalApi extends runtime.BaseAPI {
528
528
  return yield response.value();
529
529
  });
530
530
  }
531
+ /**
532
+ * Creates request options for removePortalUser without sending the request
533
+ */
534
+ removePortalUserRequestOpts(requestParameters) {
535
+ return __awaiter(this, void 0, void 0, function* () {
536
+ if (requestParameters['portalId'] == null) {
537
+ throw new runtime.RequiredError('portalId', 'Required parameter "portalId" was null or undefined when calling removePortalUser().');
538
+ }
539
+ if (requestParameters['userId'] == null) {
540
+ throw new runtime.RequiredError('userId', 'Required parameter "userId" was null or undefined when calling removePortalUser().');
541
+ }
542
+ const queryParameters = {};
543
+ const headerParameters = {};
544
+ let urlPath = `/portals/{portalId}/users/{userId}`;
545
+ urlPath = urlPath.replace('{portalId}', encodeURIComponent(String(requestParameters['portalId'])));
546
+ urlPath = urlPath.replace('{userId}', encodeURIComponent(String(requestParameters['userId'])));
547
+ return {
548
+ path: urlPath,
549
+ method: 'DELETE',
550
+ headers: headerParameters,
551
+ query: queryParameters,
552
+ };
553
+ });
554
+ }
555
+ /**
556
+ * Remove a user from a portal
557
+ */
558
+ removePortalUserRaw(requestParameters, initOverrides) {
559
+ return __awaiter(this, void 0, void 0, function* () {
560
+ const requestOptions = yield this.removePortalUserRequestOpts(requestParameters);
561
+ const response = yield this.request(requestOptions, initOverrides);
562
+ return new runtime.VoidApiResponse(response);
563
+ });
564
+ }
565
+ /**
566
+ * Remove a user from a portal
567
+ */
568
+ removePortalUser(requestParameters, initOverrides) {
569
+ return __awaiter(this, void 0, void 0, function* () {
570
+ yield this.removePortalUserRaw(requestParameters, initOverrides);
571
+ });
572
+ }
531
573
  /**
532
574
  * Creates request options for updateSelectedPortal without sending the request
533
575
  */
@@ -40,6 +40,12 @@ export interface DeleteContentRequest {
40
40
  moduleId: string;
41
41
  courseId: string;
42
42
  }
43
+ export interface DeleteContentVersionRequest {
44
+ contentId: string;
45
+ moduleId: string;
46
+ courseId: string;
47
+ versionId: string;
48
+ }
43
49
  export interface GetContentRequest {
44
50
  contentId: string;
45
51
  moduleId: string;
@@ -187,6 +193,18 @@ export declare class ContentApi extends runtime.BaseAPI {
187
193
  * Delete content by id
188
194
  */
189
195
  deleteContent(requestParameters: DeleteContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
196
+ /**
197
+ * Creates request options for deleteContentVersion without sending the request
198
+ */
199
+ deleteContentVersionRequestOpts(requestParameters: DeleteContentVersionRequest): Promise<runtime.RequestOpts>;
200
+ /**
201
+ * Delete an inactive content version
202
+ */
203
+ deleteContentVersionRaw(requestParameters: DeleteContentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
204
+ /**
205
+ * Delete an inactive content version
206
+ */
207
+ deleteContentVersion(requestParameters: DeleteContentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
190
208
  /**
191
209
  * Creates request options for getContent without sending the request
192
210
  */
@@ -135,6 +135,56 @@ export class ContentApi extends runtime.BaseAPI {
135
135
  yield this.deleteContentRaw(requestParameters, initOverrides);
136
136
  });
137
137
  }
138
+ /**
139
+ * Creates request options for deleteContentVersion without sending the request
140
+ */
141
+ deleteContentVersionRequestOpts(requestParameters) {
142
+ return __awaiter(this, void 0, void 0, function* () {
143
+ if (requestParameters['contentId'] == null) {
144
+ throw new runtime.RequiredError('contentId', 'Required parameter "contentId" was null or undefined when calling deleteContentVersion().');
145
+ }
146
+ if (requestParameters['moduleId'] == null) {
147
+ throw new runtime.RequiredError('moduleId', 'Required parameter "moduleId" was null or undefined when calling deleteContentVersion().');
148
+ }
149
+ if (requestParameters['courseId'] == null) {
150
+ throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling deleteContentVersion().');
151
+ }
152
+ if (requestParameters['versionId'] == null) {
153
+ throw new runtime.RequiredError('versionId', 'Required parameter "versionId" was null or undefined when calling deleteContentVersion().');
154
+ }
155
+ const queryParameters = {};
156
+ const headerParameters = {};
157
+ let urlPath = `/courses/{courseId}/modules/{moduleId}/contents/{contentId}/versions/{versionId}`;
158
+ urlPath = urlPath.replace('{contentId}', encodeURIComponent(String(requestParameters['contentId'])));
159
+ urlPath = urlPath.replace('{moduleId}', encodeURIComponent(String(requestParameters['moduleId'])));
160
+ urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
161
+ urlPath = urlPath.replace('{versionId}', encodeURIComponent(String(requestParameters['versionId'])));
162
+ return {
163
+ path: urlPath,
164
+ method: 'DELETE',
165
+ headers: headerParameters,
166
+ query: queryParameters,
167
+ };
168
+ });
169
+ }
170
+ /**
171
+ * Delete an inactive content version
172
+ */
173
+ deleteContentVersionRaw(requestParameters, initOverrides) {
174
+ return __awaiter(this, void 0, void 0, function* () {
175
+ const requestOptions = yield this.deleteContentVersionRequestOpts(requestParameters);
176
+ const response = yield this.request(requestOptions, initOverrides);
177
+ return new runtime.VoidApiResponse(response);
178
+ });
179
+ }
180
+ /**
181
+ * Delete an inactive content version
182
+ */
183
+ deleteContentVersion(requestParameters, initOverrides) {
184
+ return __awaiter(this, void 0, void 0, function* () {
185
+ yield this.deleteContentVersionRaw(requestParameters, initOverrides);
186
+ });
187
+ }
138
188
  /**
139
189
  * Creates request options for getContent without sending the request
140
190
  */
@@ -27,6 +27,14 @@ import { type PutCourseEnrollment } from '../models/PutCourseEnrollment';
27
27
  export interface DeleteCourseRequest {
28
28
  courseId: string;
29
29
  }
30
+ export interface DeleteCourseEnrollmentRequest {
31
+ courseId: string;
32
+ enrollmentId: string;
33
+ }
34
+ export interface DeleteCourseExportRequest {
35
+ courseId: string;
36
+ exportId: string;
37
+ }
30
38
  export interface DeleteCourseImageRequest {
31
39
  courseId: string;
32
40
  }
@@ -108,6 +116,30 @@ export declare class CourseApi extends runtime.BaseAPI {
108
116
  * Delete a course by id
109
117
  */
110
118
  deleteCourse(requestParameters: DeleteCourseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
119
+ /**
120
+ * Creates request options for deleteCourseEnrollment without sending the request
121
+ */
122
+ deleteCourseEnrollmentRequestOpts(requestParameters: DeleteCourseEnrollmentRequest): Promise<runtime.RequestOpts>;
123
+ /**
124
+ * Remove a course enrollment
125
+ */
126
+ deleteCourseEnrollmentRaw(requestParameters: DeleteCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
127
+ /**
128
+ * Remove a course enrollment
129
+ */
130
+ deleteCourseEnrollment(requestParameters: DeleteCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
131
+ /**
132
+ * Creates request options for deleteCourseExport without sending the request
133
+ */
134
+ deleteCourseExportRequestOpts(requestParameters: DeleteCourseExportRequest): Promise<runtime.RequestOpts>;
135
+ /**
136
+ * Delete a course export
137
+ */
138
+ deleteCourseExportRaw(requestParameters: DeleteCourseExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
139
+ /**
140
+ * Delete a course export
141
+ */
142
+ deleteCourseExport(requestParameters: DeleteCourseExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
111
143
  /**
112
144
  * Creates request options for deleteCourseImage without sending the request
113
145
  */
@@ -79,6 +79,90 @@ export class CourseApi extends runtime.BaseAPI {
79
79
  yield this.deleteCourseRaw(requestParameters, initOverrides);
80
80
  });
81
81
  }
82
+ /**
83
+ * Creates request options for deleteCourseEnrollment without sending the request
84
+ */
85
+ deleteCourseEnrollmentRequestOpts(requestParameters) {
86
+ return __awaiter(this, void 0, void 0, function* () {
87
+ if (requestParameters['courseId'] == null) {
88
+ throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling deleteCourseEnrollment().');
89
+ }
90
+ if (requestParameters['enrollmentId'] == null) {
91
+ throw new runtime.RequiredError('enrollmentId', 'Required parameter "enrollmentId" was null or undefined when calling deleteCourseEnrollment().');
92
+ }
93
+ const queryParameters = {};
94
+ const headerParameters = {};
95
+ let urlPath = `/courses/{courseId}/enrollments/{enrollmentId}`;
96
+ urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
97
+ urlPath = urlPath.replace('{enrollmentId}', encodeURIComponent(String(requestParameters['enrollmentId'])));
98
+ return {
99
+ path: urlPath,
100
+ method: 'DELETE',
101
+ headers: headerParameters,
102
+ query: queryParameters,
103
+ };
104
+ });
105
+ }
106
+ /**
107
+ * Remove a course enrollment
108
+ */
109
+ deleteCourseEnrollmentRaw(requestParameters, initOverrides) {
110
+ return __awaiter(this, void 0, void 0, function* () {
111
+ const requestOptions = yield this.deleteCourseEnrollmentRequestOpts(requestParameters);
112
+ const response = yield this.request(requestOptions, initOverrides);
113
+ return new runtime.VoidApiResponse(response);
114
+ });
115
+ }
116
+ /**
117
+ * Remove a course enrollment
118
+ */
119
+ deleteCourseEnrollment(requestParameters, initOverrides) {
120
+ return __awaiter(this, void 0, void 0, function* () {
121
+ yield this.deleteCourseEnrollmentRaw(requestParameters, initOverrides);
122
+ });
123
+ }
124
+ /**
125
+ * Creates request options for deleteCourseExport without sending the request
126
+ */
127
+ deleteCourseExportRequestOpts(requestParameters) {
128
+ return __awaiter(this, void 0, void 0, function* () {
129
+ if (requestParameters['courseId'] == null) {
130
+ throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling deleteCourseExport().');
131
+ }
132
+ if (requestParameters['exportId'] == null) {
133
+ throw new runtime.RequiredError('exportId', 'Required parameter "exportId" was null or undefined when calling deleteCourseExport().');
134
+ }
135
+ const queryParameters = {};
136
+ const headerParameters = {};
137
+ let urlPath = `/courses/{courseId}/exports/{exportId}`;
138
+ urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
139
+ urlPath = urlPath.replace('{exportId}', encodeURIComponent(String(requestParameters['exportId'])));
140
+ return {
141
+ path: urlPath,
142
+ method: 'DELETE',
143
+ headers: headerParameters,
144
+ query: queryParameters,
145
+ };
146
+ });
147
+ }
148
+ /**
149
+ * Delete a course export
150
+ */
151
+ deleteCourseExportRaw(requestParameters, initOverrides) {
152
+ return __awaiter(this, void 0, void 0, function* () {
153
+ const requestOptions = yield this.deleteCourseExportRequestOpts(requestParameters);
154
+ const response = yield this.request(requestOptions, initOverrides);
155
+ return new runtime.VoidApiResponse(response);
156
+ });
157
+ }
158
+ /**
159
+ * Delete a course export
160
+ */
161
+ deleteCourseExport(requestParameters, initOverrides) {
162
+ return __awaiter(this, void 0, void 0, function* () {
163
+ yield this.deleteCourseExportRaw(requestParameters, initOverrides);
164
+ });
165
+ }
82
166
  /**
83
167
  * Creates request options for deleteCourseImage without sending the request
84
168
  */
@@ -56,6 +56,10 @@ export interface PutPortalBrandingRequest {
56
56
  portalId: string;
57
57
  putPortalBranding: PutPortalBranding;
58
58
  }
59
+ export interface RemovePortalUserRequest {
60
+ portalId: string;
61
+ userId: string;
62
+ }
59
63
  export interface UpdateSelectedPortalRequest {
60
64
  portalId: string;
61
65
  }
@@ -197,6 +201,18 @@ export declare class PortalApi extends runtime.BaseAPI {
197
201
  * Update portal branding (name, background color, text color)
198
202
  */
199
203
  putPortalBranding(requestParameters: PutPortalBrandingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortal>;
204
+ /**
205
+ * Creates request options for removePortalUser without sending the request
206
+ */
207
+ removePortalUserRequestOpts(requestParameters: RemovePortalUserRequest): Promise<runtime.RequestOpts>;
208
+ /**
209
+ * Remove a user from a portal
210
+ */
211
+ removePortalUserRaw(requestParameters: RemovePortalUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
212
+ /**
213
+ * Remove a user from a portal
214
+ */
215
+ removePortalUser(requestParameters: RemovePortalUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
200
216
  /**
201
217
  * Creates request options for updateSelectedPortal without sending the request
202
218
  */
@@ -525,6 +525,48 @@ export class PortalApi extends runtime.BaseAPI {
525
525
  return yield response.value();
526
526
  });
527
527
  }
528
+ /**
529
+ * Creates request options for removePortalUser without sending the request
530
+ */
531
+ removePortalUserRequestOpts(requestParameters) {
532
+ return __awaiter(this, void 0, void 0, function* () {
533
+ if (requestParameters['portalId'] == null) {
534
+ throw new runtime.RequiredError('portalId', 'Required parameter "portalId" was null or undefined when calling removePortalUser().');
535
+ }
536
+ if (requestParameters['userId'] == null) {
537
+ throw new runtime.RequiredError('userId', 'Required parameter "userId" was null or undefined when calling removePortalUser().');
538
+ }
539
+ const queryParameters = {};
540
+ const headerParameters = {};
541
+ let urlPath = `/portals/{portalId}/users/{userId}`;
542
+ urlPath = urlPath.replace('{portalId}', encodeURIComponent(String(requestParameters['portalId'])));
543
+ urlPath = urlPath.replace('{userId}', encodeURIComponent(String(requestParameters['userId'])));
544
+ return {
545
+ path: urlPath,
546
+ method: 'DELETE',
547
+ headers: headerParameters,
548
+ query: queryParameters,
549
+ };
550
+ });
551
+ }
552
+ /**
553
+ * Remove a user from a portal
554
+ */
555
+ removePortalUserRaw(requestParameters, initOverrides) {
556
+ return __awaiter(this, void 0, void 0, function* () {
557
+ const requestOptions = yield this.removePortalUserRequestOpts(requestParameters);
558
+ const response = yield this.request(requestOptions, initOverrides);
559
+ return new runtime.VoidApiResponse(response);
560
+ });
561
+ }
562
+ /**
563
+ * Remove a user from a portal
564
+ */
565
+ removePortalUser(requestParameters, initOverrides) {
566
+ return __awaiter(this, void 0, void 0, function* () {
567
+ yield this.removePortalUserRaw(requestParameters, initOverrides);
568
+ });
569
+ }
528
570
  /**
529
571
  * Creates request options for updateSelectedPortal without sending the request
530
572
  */
@@ -6,6 +6,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
6
6
  |------------- | ------------- | -------------|
7
7
  | [**commitScormSession**](ContentApi.md#commitscormsession) | **POST** /scorm/sessions/{scormSessionId}/commit | Commit SCORM session data |
8
8
  | [**deleteContent**](ContentApi.md#deletecontent) | **DELETE** /courses/{courseId}/modules/{moduleId}/contents/{contentId} | Delete content by id |
9
+ | [**deleteContentVersion**](ContentApi.md#deletecontentversion) | **DELETE** /courses/{courseId}/modules/{moduleId}/contents/{contentId}/versions/{versionId} | Delete an inactive content version |
9
10
  | [**getContent**](ContentApi.md#getcontent) | **GET** /courses/{courseId}/modules/{moduleId}/contents/{contentId} | get content |
10
11
  | [**getContentList**](ContentApi.md#getcontentlist) | **GET** /courses/{courseId}/modules/{moduleId}/contents | get content list |
11
12
  | [**getContentSession**](ContentApi.md#getcontentsession) | **GET** /courses/{courseId}/modules/{moduleId}/contents/{contentId}/session | get content session |
@@ -176,6 +177,84 @@ No authorization required
176
177
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
177
178
 
178
179
 
180
+ ## deleteContentVersion
181
+
182
+ > deleteContentVersion(contentId, moduleId, courseId, versionId)
183
+
184
+ Delete an inactive content version
185
+
186
+ ### Example
187
+
188
+ ```ts
189
+ import {
190
+ Configuration,
191
+ ContentApi,
192
+ } from '@easyedu/js-lsm-api';
193
+ import type { DeleteContentVersionRequest } from '@easyedu/js-lsm-api';
194
+
195
+ async function example() {
196
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
197
+ const api = new ContentApi();
198
+
199
+ const body = {
200
+ // string | The content\'s external_id
201
+ contentId: contentId_example,
202
+ // string
203
+ moduleId: moduleId_example,
204
+ // string
205
+ courseId: courseId_example,
206
+ // string | The version\'s external_id
207
+ versionId: versionId_example,
208
+ } satisfies DeleteContentVersionRequest;
209
+
210
+ try {
211
+ const data = await api.deleteContentVersion(body);
212
+ console.log(data);
213
+ } catch (error) {
214
+ console.error(error);
215
+ }
216
+ }
217
+
218
+ // Run the test
219
+ example().catch(console.error);
220
+ ```
221
+
222
+ ### Parameters
223
+
224
+
225
+ | Name | Type | Description | Notes |
226
+ |------------- | ------------- | ------------- | -------------|
227
+ | **contentId** | `string` | The content\&#39;s external_id | [Defaults to `undefined`] |
228
+ | **moduleId** | `string` | | [Defaults to `undefined`] |
229
+ | **courseId** | `string` | | [Defaults to `undefined`] |
230
+ | **versionId** | `string` | The version\&#39;s external_id | [Defaults to `undefined`] |
231
+
232
+ ### Return type
233
+
234
+ `void` (Empty response body)
235
+
236
+ ### Authorization
237
+
238
+ No authorization required
239
+
240
+ ### HTTP request headers
241
+
242
+ - **Content-Type**: Not defined
243
+ - **Accept**: Not defined
244
+
245
+
246
+ ### HTTP response details
247
+ | Status code | Description | Response headers |
248
+ |-------------|-------------|------------------|
249
+ | **204** | Version deleted successfully | - |
250
+ | **400** | Active versions cannot be deleted | - |
251
+ | **401** | Unauthorized | - |
252
+ | **403** | Forbidden - you do not have permission to delete this content version | - |
253
+ | **404** | Content or version not found | - |
254
+
255
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
256
+
257
+
179
258
  ## getContent
180
259
 
181
260
  > GetContent getContent(contentId, moduleId, courseId)
package/docs/CourseApi.md CHANGED
@@ -5,6 +5,8 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
5
5
  | Method | HTTP request | Description |
6
6
  |------------- | ------------- | -------------|
7
7
  | [**deleteCourse**](CourseApi.md#deletecourse) | **DELETE** /courses/{courseId} | Delete a course by id |
8
+ | [**deleteCourseEnrollment**](CourseApi.md#deletecourseenrollment) | **DELETE** /courses/{courseId}/enrollments/{enrollmentId} | Remove a course enrollment |
9
+ | [**deleteCourseExport**](CourseApi.md#deletecourseexport) | **DELETE** /courses/{courseId}/exports/{exportId} | Delete a course export |
8
10
  | [**deleteCourseImage**](CourseApi.md#deletecourseimage) | **DELETE** /courses/{courseId}/image | Remove the course image |
9
11
  | [**getCourse**](CourseApi.md#getcourse) | **GET** /courses/{courseId} | get course |
10
12
  | [**getCourseEnrollment**](CourseApi.md#getcourseenrollment) | **GET** /courses/{courseId}/enrollments/{enrollmentId} | Get a specific course enrollment |
@@ -92,6 +94,145 @@ No authorization required
92
94
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
93
95
 
94
96
 
97
+ ## deleteCourseEnrollment
98
+
99
+ > deleteCourseEnrollment(courseId, enrollmentId)
100
+
101
+ Remove a course enrollment
102
+
103
+ ### Example
104
+
105
+ ```ts
106
+ import {
107
+ Configuration,
108
+ CourseApi,
109
+ } from '@easyedu/js-lsm-api';
110
+ import type { DeleteCourseEnrollmentRequest } from '@easyedu/js-lsm-api';
111
+
112
+ async function example() {
113
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
114
+ const api = new CourseApi();
115
+
116
+ const body = {
117
+ // string
118
+ courseId: courseId_example,
119
+ // string
120
+ enrollmentId: enrollmentId_example,
121
+ } satisfies DeleteCourseEnrollmentRequest;
122
+
123
+ try {
124
+ const data = await api.deleteCourseEnrollment(body);
125
+ console.log(data);
126
+ } catch (error) {
127
+ console.error(error);
128
+ }
129
+ }
130
+
131
+ // Run the test
132
+ example().catch(console.error);
133
+ ```
134
+
135
+ ### Parameters
136
+
137
+
138
+ | Name | Type | Description | Notes |
139
+ |------------- | ------------- | ------------- | -------------|
140
+ | **courseId** | `string` | | [Defaults to `undefined`] |
141
+ | **enrollmentId** | `string` | | [Defaults to `undefined`] |
142
+
143
+ ### Return type
144
+
145
+ `void` (Empty response body)
146
+
147
+ ### Authorization
148
+
149
+ No authorization required
150
+
151
+ ### HTTP request headers
152
+
153
+ - **Content-Type**: Not defined
154
+ - **Accept**: Not defined
155
+
156
+
157
+ ### HTTP response details
158
+ | Status code | Description | Response headers |
159
+ |-------------|-------------|------------------|
160
+ | **204** | Enrollment removed successfully | - |
161
+ | **404** | Course or enrollment not found | - |
162
+
163
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
164
+
165
+
166
+ ## deleteCourseExport
167
+
168
+ > deleteCourseExport(courseId, exportId)
169
+
170
+ Delete a course export
171
+
172
+ ### Example
173
+
174
+ ```ts
175
+ import {
176
+ Configuration,
177
+ CourseApi,
178
+ } from '@easyedu/js-lsm-api';
179
+ import type { DeleteCourseExportRequest } from '@easyedu/js-lsm-api';
180
+
181
+ async function example() {
182
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
183
+ const api = new CourseApi();
184
+
185
+ const body = {
186
+ // string
187
+ courseId: courseId_example,
188
+ // string
189
+ exportId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
190
+ } satisfies DeleteCourseExportRequest;
191
+
192
+ try {
193
+ const data = await api.deleteCourseExport(body);
194
+ console.log(data);
195
+ } catch (error) {
196
+ console.error(error);
197
+ }
198
+ }
199
+
200
+ // Run the test
201
+ example().catch(console.error);
202
+ ```
203
+
204
+ ### Parameters
205
+
206
+
207
+ | Name | Type | Description | Notes |
208
+ |------------- | ------------- | ------------- | -------------|
209
+ | **courseId** | `string` | | [Defaults to `undefined`] |
210
+ | **exportId** | `string` | | [Defaults to `undefined`] |
211
+
212
+ ### Return type
213
+
214
+ `void` (Empty response body)
215
+
216
+ ### Authorization
217
+
218
+ No authorization required
219
+
220
+ ### HTTP request headers
221
+
222
+ - **Content-Type**: Not defined
223
+ - **Accept**: Not defined
224
+
225
+
226
+ ### HTTP response details
227
+ | Status code | Description | Response headers |
228
+ |-------------|-------------|------------------|
229
+ | **204** | Export deleted successfully | - |
230
+ | **401** | Unauthorized | - |
231
+ | **404** | Export or course not found | - |
232
+
233
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
234
+
235
+
95
236
  ## deleteCourseImage
96
237
 
97
238
  > deleteCourseImage(courseId)
package/docs/PortalApi.md CHANGED
@@ -15,6 +15,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
15
15
  | [**postPortalFaviconUpload**](PortalApi.md#postportalfaviconupload) | **POST** /portals/{portalId}/branding/favicon | Upload a favicon image for portal branding |
16
16
  | [**postPortalLogoUpload**](PortalApi.md#postportallogoupload) | **POST** /portals/{portalId}/branding/logo | Upload a logo image for portal branding |
17
17
  | [**putPortalBranding**](PortalApi.md#putportalbranding) | **PUT** /portals/{portalId} | Update portal branding (name, background color, text color) |
18
+ | [**removePortalUser**](PortalApi.md#removeportaluser) | **DELETE** /portals/{portalId}/users/{userId} | Remove a user from a portal |
18
19
  | [**updateSelectedPortal**](PortalApi.md#updateselectedportal) | **PUT** /portals/{portalId}/selected | Update the users current selected portal. Returns new JWT with updated roles. |
19
20
 
20
21
 
@@ -761,6 +762,76 @@ No authorization required
761
762
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
762
763
 
763
764
 
765
+ ## removePortalUser
766
+
767
+ > removePortalUser(portalId, userId)
768
+
769
+ Remove a user from a portal
770
+
771
+ ### Example
772
+
773
+ ```ts
774
+ import {
775
+ Configuration,
776
+ PortalApi,
777
+ } from '@easyedu/js-lsm-api';
778
+ import type { RemovePortalUserRequest } from '@easyedu/js-lsm-api';
779
+
780
+ async function example() {
781
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
782
+ const api = new PortalApi();
783
+
784
+ const body = {
785
+ // string
786
+ portalId: portalId_example,
787
+ // string
788
+ userId: userId_example,
789
+ } satisfies RemovePortalUserRequest;
790
+
791
+ try {
792
+ const data = await api.removePortalUser(body);
793
+ console.log(data);
794
+ } catch (error) {
795
+ console.error(error);
796
+ }
797
+ }
798
+
799
+ // Run the test
800
+ example().catch(console.error);
801
+ ```
802
+
803
+ ### Parameters
804
+
805
+
806
+ | Name | Type | Description | Notes |
807
+ |------------- | ------------- | ------------- | -------------|
808
+ | **portalId** | `string` | | [Defaults to `undefined`] |
809
+ | **userId** | `string` | | [Defaults to `undefined`] |
810
+
811
+ ### Return type
812
+
813
+ `void` (Empty response body)
814
+
815
+ ### Authorization
816
+
817
+ No authorization required
818
+
819
+ ### HTTP request headers
820
+
821
+ - **Content-Type**: Not defined
822
+ - **Accept**: Not defined
823
+
824
+
825
+ ### HTTP response details
826
+ | Status code | Description | Response headers |
827
+ |-------------|-------------|------------------|
828
+ | **204** | User removed from portal | - |
829
+ | **400** | Cannot remove the authenticated user from the selected portal | - |
830
+ | **404** | User or portal not found | - |
831
+
832
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
833
+
834
+
764
835
  ## updateSelectedPortal
765
836
 
766
837
  > UpdateSelectedPortalResponse updateSelectedPortal(portalId)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@easyedu/js-lsm-api",
3
- "version": "1.64.0",
3
+ "version": "1.65.0",
4
4
  "description": "OpenAPI client for @easyedu/js-lsm-api",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {
@@ -134,6 +134,13 @@ export interface DeleteContentRequest {
134
134
  courseId: string;
135
135
  }
136
136
 
137
+ export interface DeleteContentVersionRequest {
138
+ contentId: string;
139
+ moduleId: string;
140
+ courseId: string;
141
+ versionId: string;
142
+ }
143
+
137
144
  export interface GetContentRequest {
138
145
  contentId: string;
139
146
  moduleId: string;
@@ -385,6 +392,74 @@ export class ContentApi extends runtime.BaseAPI {
385
392
  await this.deleteContentRaw(requestParameters, initOverrides);
386
393
  }
387
394
 
395
+ /**
396
+ * Creates request options for deleteContentVersion without sending the request
397
+ */
398
+ async deleteContentVersionRequestOpts(requestParameters: DeleteContentVersionRequest): Promise<runtime.RequestOpts> {
399
+ if (requestParameters['contentId'] == null) {
400
+ throw new runtime.RequiredError(
401
+ 'contentId',
402
+ 'Required parameter "contentId" was null or undefined when calling deleteContentVersion().'
403
+ );
404
+ }
405
+
406
+ if (requestParameters['moduleId'] == null) {
407
+ throw new runtime.RequiredError(
408
+ 'moduleId',
409
+ 'Required parameter "moduleId" was null or undefined when calling deleteContentVersion().'
410
+ );
411
+ }
412
+
413
+ if (requestParameters['courseId'] == null) {
414
+ throw new runtime.RequiredError(
415
+ 'courseId',
416
+ 'Required parameter "courseId" was null or undefined when calling deleteContentVersion().'
417
+ );
418
+ }
419
+
420
+ if (requestParameters['versionId'] == null) {
421
+ throw new runtime.RequiredError(
422
+ 'versionId',
423
+ 'Required parameter "versionId" was null or undefined when calling deleteContentVersion().'
424
+ );
425
+ }
426
+
427
+ const queryParameters: any = {};
428
+
429
+ const headerParameters: runtime.HTTPHeaders = {};
430
+
431
+
432
+ let urlPath = `/courses/{courseId}/modules/{moduleId}/contents/{contentId}/versions/{versionId}`;
433
+ urlPath = urlPath.replace('{contentId}', encodeURIComponent(String(requestParameters['contentId'])));
434
+ urlPath = urlPath.replace('{moduleId}', encodeURIComponent(String(requestParameters['moduleId'])));
435
+ urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
436
+ urlPath = urlPath.replace('{versionId}', encodeURIComponent(String(requestParameters['versionId'])));
437
+
438
+ return {
439
+ path: urlPath,
440
+ method: 'DELETE',
441
+ headers: headerParameters,
442
+ query: queryParameters,
443
+ };
444
+ }
445
+
446
+ /**
447
+ * Delete an inactive content version
448
+ */
449
+ async deleteContentVersionRaw(requestParameters: DeleteContentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
450
+ const requestOptions = await this.deleteContentVersionRequestOpts(requestParameters);
451
+ const response = await this.request(requestOptions, initOverrides);
452
+
453
+ return new runtime.VoidApiResponse(response);
454
+ }
455
+
456
+ /**
457
+ * Delete an inactive content version
458
+ */
459
+ async deleteContentVersion(requestParameters: DeleteContentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
460
+ await this.deleteContentVersionRaw(requestParameters, initOverrides);
461
+ }
462
+
388
463
  /**
389
464
  * Creates request options for getContent without sending the request
390
465
  */
@@ -88,6 +88,16 @@ export interface DeleteCourseRequest {
88
88
  courseId: string;
89
89
  }
90
90
 
91
+ export interface DeleteCourseEnrollmentRequest {
92
+ courseId: string;
93
+ enrollmentId: string;
94
+ }
95
+
96
+ export interface DeleteCourseExportRequest {
97
+ courseId: string;
98
+ exportId: string;
99
+ }
100
+
91
101
  export interface DeleteCourseImageRequest {
92
102
  courseId: string;
93
103
  }
@@ -217,6 +227,110 @@ export class CourseApi extends runtime.BaseAPI {
217
227
  await this.deleteCourseRaw(requestParameters, initOverrides);
218
228
  }
219
229
 
230
+ /**
231
+ * Creates request options for deleteCourseEnrollment without sending the request
232
+ */
233
+ async deleteCourseEnrollmentRequestOpts(requestParameters: DeleteCourseEnrollmentRequest): Promise<runtime.RequestOpts> {
234
+ if (requestParameters['courseId'] == null) {
235
+ throw new runtime.RequiredError(
236
+ 'courseId',
237
+ 'Required parameter "courseId" was null or undefined when calling deleteCourseEnrollment().'
238
+ );
239
+ }
240
+
241
+ if (requestParameters['enrollmentId'] == null) {
242
+ throw new runtime.RequiredError(
243
+ 'enrollmentId',
244
+ 'Required parameter "enrollmentId" was null or undefined when calling deleteCourseEnrollment().'
245
+ );
246
+ }
247
+
248
+ const queryParameters: any = {};
249
+
250
+ const headerParameters: runtime.HTTPHeaders = {};
251
+
252
+
253
+ let urlPath = `/courses/{courseId}/enrollments/{enrollmentId}`;
254
+ urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
255
+ urlPath = urlPath.replace('{enrollmentId}', encodeURIComponent(String(requestParameters['enrollmentId'])));
256
+
257
+ return {
258
+ path: urlPath,
259
+ method: 'DELETE',
260
+ headers: headerParameters,
261
+ query: queryParameters,
262
+ };
263
+ }
264
+
265
+ /**
266
+ * Remove a course enrollment
267
+ */
268
+ async deleteCourseEnrollmentRaw(requestParameters: DeleteCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
269
+ const requestOptions = await this.deleteCourseEnrollmentRequestOpts(requestParameters);
270
+ const response = await this.request(requestOptions, initOverrides);
271
+
272
+ return new runtime.VoidApiResponse(response);
273
+ }
274
+
275
+ /**
276
+ * Remove a course enrollment
277
+ */
278
+ async deleteCourseEnrollment(requestParameters: DeleteCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
279
+ await this.deleteCourseEnrollmentRaw(requestParameters, initOverrides);
280
+ }
281
+
282
+ /**
283
+ * Creates request options for deleteCourseExport without sending the request
284
+ */
285
+ async deleteCourseExportRequestOpts(requestParameters: DeleteCourseExportRequest): Promise<runtime.RequestOpts> {
286
+ if (requestParameters['courseId'] == null) {
287
+ throw new runtime.RequiredError(
288
+ 'courseId',
289
+ 'Required parameter "courseId" was null or undefined when calling deleteCourseExport().'
290
+ );
291
+ }
292
+
293
+ if (requestParameters['exportId'] == null) {
294
+ throw new runtime.RequiredError(
295
+ 'exportId',
296
+ 'Required parameter "exportId" was null or undefined when calling deleteCourseExport().'
297
+ );
298
+ }
299
+
300
+ const queryParameters: any = {};
301
+
302
+ const headerParameters: runtime.HTTPHeaders = {};
303
+
304
+
305
+ let urlPath = `/courses/{courseId}/exports/{exportId}`;
306
+ urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
307
+ urlPath = urlPath.replace('{exportId}', encodeURIComponent(String(requestParameters['exportId'])));
308
+
309
+ return {
310
+ path: urlPath,
311
+ method: 'DELETE',
312
+ headers: headerParameters,
313
+ query: queryParameters,
314
+ };
315
+ }
316
+
317
+ /**
318
+ * Delete a course export
319
+ */
320
+ async deleteCourseExportRaw(requestParameters: DeleteCourseExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
321
+ const requestOptions = await this.deleteCourseExportRequestOpts(requestParameters);
322
+ const response = await this.request(requestOptions, initOverrides);
323
+
324
+ return new runtime.VoidApiResponse(response);
325
+ }
326
+
327
+ /**
328
+ * Delete a course export
329
+ */
330
+ async deleteCourseExport(requestParameters: DeleteCourseExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
331
+ await this.deleteCourseExportRaw(requestParameters, initOverrides);
332
+ }
333
+
220
334
  /**
221
335
  * Creates request options for deleteCourseImage without sending the request
222
336
  */
@@ -109,6 +109,11 @@ export interface PutPortalBrandingRequest {
109
109
  putPortalBranding: PutPortalBranding;
110
110
  }
111
111
 
112
+ export interface RemovePortalUserRequest {
113
+ portalId: string;
114
+ userId: string;
115
+ }
116
+
112
117
  export interface UpdateSelectedPortalRequest {
113
118
  portalId: string;
114
119
  }
@@ -694,6 +699,58 @@ export class PortalApi extends runtime.BaseAPI {
694
699
  return await response.value();
695
700
  }
696
701
 
702
+ /**
703
+ * Creates request options for removePortalUser without sending the request
704
+ */
705
+ async removePortalUserRequestOpts(requestParameters: RemovePortalUserRequest): Promise<runtime.RequestOpts> {
706
+ if (requestParameters['portalId'] == null) {
707
+ throw new runtime.RequiredError(
708
+ 'portalId',
709
+ 'Required parameter "portalId" was null or undefined when calling removePortalUser().'
710
+ );
711
+ }
712
+
713
+ if (requestParameters['userId'] == null) {
714
+ throw new runtime.RequiredError(
715
+ 'userId',
716
+ 'Required parameter "userId" was null or undefined when calling removePortalUser().'
717
+ );
718
+ }
719
+
720
+ const queryParameters: any = {};
721
+
722
+ const headerParameters: runtime.HTTPHeaders = {};
723
+
724
+
725
+ let urlPath = `/portals/{portalId}/users/{userId}`;
726
+ urlPath = urlPath.replace('{portalId}', encodeURIComponent(String(requestParameters['portalId'])));
727
+ urlPath = urlPath.replace('{userId}', encodeURIComponent(String(requestParameters['userId'])));
728
+
729
+ return {
730
+ path: urlPath,
731
+ method: 'DELETE',
732
+ headers: headerParameters,
733
+ query: queryParameters,
734
+ };
735
+ }
736
+
737
+ /**
738
+ * Remove a user from a portal
739
+ */
740
+ async removePortalUserRaw(requestParameters: RemovePortalUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
741
+ const requestOptions = await this.removePortalUserRequestOpts(requestParameters);
742
+ const response = await this.request(requestOptions, initOverrides);
743
+
744
+ return new runtime.VoidApiResponse(response);
745
+ }
746
+
747
+ /**
748
+ * Remove a user from a portal
749
+ */
750
+ async removePortalUser(requestParameters: RemovePortalUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
751
+ await this.removePortalUserRaw(requestParameters, initOverrides);
752
+ }
753
+
697
754
  /**
698
755
  * Creates request options for updateSelectedPortal without sending the request
699
756
  */