@easyedu/js-lsm-api 1.63.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/.openapi-generator/FILES +4 -0
- package/README.md +13 -2
- package/dist/apis/ContentApi.d.ts +37 -0
- package/dist/apis/ContentApi.js +98 -0
- package/dist/apis/CourseApi.d.ts +49 -0
- package/dist/apis/CourseApi.js +124 -0
- package/dist/apis/ModuleApi.d.ts +18 -0
- package/dist/apis/ModuleApi.js +44 -0
- package/dist/apis/PortalApi.d.ts +16 -0
- package/dist/apis/PortalApi.js +42 -0
- package/dist/apis/UserApi.d.ts +32 -0
- package/dist/apis/UserApi.js +82 -0
- package/dist/esm/apis/ContentApi.d.ts +37 -0
- package/dist/esm/apis/ContentApi.js +98 -0
- package/dist/esm/apis/CourseApi.d.ts +49 -0
- package/dist/esm/apis/CourseApi.js +124 -0
- package/dist/esm/apis/ModuleApi.d.ts +18 -0
- package/dist/esm/apis/ModuleApi.js +44 -0
- package/dist/esm/apis/PortalApi.d.ts +16 -0
- package/dist/esm/apis/PortalApi.js +42 -0
- package/dist/esm/apis/UserApi.d.ts +32 -0
- package/dist/esm/apis/UserApi.js +82 -0
- package/dist/esm/models/PostSignupRequest.d.ts +68 -0
- package/dist/esm/models/PostSignupRequest.js +67 -0
- package/dist/esm/models/PostSignupRequestResponse.d.ts +32 -0
- package/dist/esm/models/PostSignupRequestResponse.js +43 -0
- package/dist/esm/models/index.d.ts +2 -0
- package/dist/esm/models/index.js +2 -0
- package/dist/models/PostSignupRequest.d.ts +68 -0
- package/dist/models/PostSignupRequest.js +74 -0
- package/dist/models/PostSignupRequestResponse.d.ts +32 -0
- package/dist/models/PostSignupRequestResponse.js +50 -0
- package/dist/models/index.d.ts +2 -0
- package/dist/models/index.js +2 -0
- package/docs/ContentApi.md +155 -0
- package/docs/CourseApi.md +211 -0
- package/docs/ModuleApi.md +73 -0
- package/docs/PortalApi.md +71 -0
- package/docs/PostSignupRequest.md +46 -0
- package/docs/PostSignupRequestResponse.md +34 -0
- package/docs/UserApi.md +134 -0
- package/package.json +1 -1
- package/src/apis/ContentApi.ts +143 -0
- package/src/apis/CourseApi.ts +164 -0
- package/src/apis/ModuleApi.ts +59 -0
- package/src/apis/PortalApi.ts +57 -0
- package/src/apis/UserApi.ts +112 -0
- package/src/models/PostSignupRequest.ts +120 -0
- package/src/models/PostSignupRequestResponse.ts +66 -0
- package/src/models/index.ts +2 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -226,6 +226,8 @@ docs/PostResetPassword.md
|
|
|
226
226
|
docs/PostRevokeCertificate.md
|
|
227
227
|
docs/PostRole.md
|
|
228
228
|
docs/PostSendResetPassword.md
|
|
229
|
+
docs/PostSignupRequest.md
|
|
230
|
+
docs/PostSignupRequestResponse.md
|
|
229
231
|
docs/PostSupportTicket.md
|
|
230
232
|
docs/PostSupportTicketComment.md
|
|
231
233
|
docs/PostVerifyManifest.md
|
|
@@ -512,6 +514,8 @@ src/models/PostResetPassword.ts
|
|
|
512
514
|
src/models/PostRevokeCertificate.ts
|
|
513
515
|
src/models/PostRole.ts
|
|
514
516
|
src/models/PostSendResetPassword.ts
|
|
517
|
+
src/models/PostSignupRequest.ts
|
|
518
|
+
src/models/PostSignupRequestResponse.ts
|
|
515
519
|
src/models/PostSupportTicket.ts
|
|
516
520
|
src/models/PostSupportTicketComment.ts
|
|
517
521
|
src/models/PostVerifyManifest.ts
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# @easyedu/js-lsm-api@1.
|
|
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
|
|
|
@@ -69,6 +69,8 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
69
69
|
*ChatApi* | [**postConversation**](docs/ChatApi.md#postconversation) | **POST** /chat/conversations | Create a new conversation
|
|
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
|
+
*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
|
|
72
74
|
*ContentApi* | [**getContent**](docs/ContentApi.md#getcontent) | **GET** /courses/{courseId}/modules/{moduleId}/contents/{contentId} | get content
|
|
73
75
|
*ContentApi* | [**getContentList**](docs/ContentApi.md#getcontentlist) | **GET** /courses/{courseId}/modules/{moduleId}/contents | get content list
|
|
74
76
|
*ContentApi* | [**getContentSession**](docs/ContentApi.md#getcontentsession) | **GET** /courses/{courseId}/modules/{moduleId}/contents/{contentId}/session | get content session
|
|
@@ -92,6 +94,9 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
92
94
|
*ContentApi* | [**setScormValue**](docs/ContentApi.md#setscormvalue) | **POST** /scorm/sessions/{scormSessionId}/set-value | Set a SCORM CMI data element value
|
|
93
95
|
*ContentApi* | [**terminateScormSession**](docs/ContentApi.md#terminatescormsession) | **POST** /scorm/sessions/{scormSessionId}/terminate | Terminate a SCORM session
|
|
94
96
|
*ContentApi* | [**verifyScormManifest**](docs/ContentApi.md#verifyscormmanifest) | **POST** /scorm/tools/verify-manifest | Parse and verify a SCORM manifest
|
|
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
|
|
95
100
|
*CourseApi* | [**deleteCourseImage**](docs/CourseApi.md#deletecourseimage) | **DELETE** /courses/{courseId}/image | Remove the course image
|
|
96
101
|
*CourseApi* | [**getCourse**](docs/CourseApi.md#getcourse) | **GET** /courses/{courseId} | get course
|
|
97
102
|
*CourseApi* | [**getCourseEnrollment**](docs/CourseApi.md#getcourseenrollment) | **GET** /courses/{courseId}/enrollments/{enrollmentId} | Get a specific course enrollment
|
|
@@ -126,6 +131,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
126
131
|
*CourseShareApi* | [**putDeclineShare**](docs/CourseShareApi.md#putdeclineshare) | **PUT** /course-shares/{shareId}/decline | Decline an offer
|
|
127
132
|
*DispatchApi* | [**getDispatchRollup**](docs/DispatchApi.md#getdispatchrollup) | **GET** /dispatch/sessions/{dispatchPackageId}/rollup | Get dispatch package rollup data
|
|
128
133
|
*DispatchApi* | [**postDispatchLaunch**](docs/DispatchApi.md#postdispatchlaunch) | **POST** /dispatch/launch | Launch a dispatch package
|
|
134
|
+
*ModuleApi* | [**deleteModule**](docs/ModuleApi.md#deletemodule) | **DELETE** /courses/{courseId}/modules/{moduleId} | Delete a module by id
|
|
129
135
|
*ModuleApi* | [**getModule**](docs/ModuleApi.md#getmodule) | **GET** /courses/{courseId}/modules/{moduleId} | get a course module
|
|
130
136
|
*ModuleApi* | [**getModuleList**](docs/ModuleApi.md#getmodulelist) | **GET** /courses/{courseId}/modules | get module list
|
|
131
137
|
*ModuleApi* | [**postModule**](docs/ModuleApi.md#postmodule) | **POST** /courses/{courseId}/modules | Post a new module
|
|
@@ -155,6 +161,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
155
161
|
*PortalApi* | [**postPortalFaviconUpload**](docs/PortalApi.md#postportalfaviconupload) | **POST** /portals/{portalId}/branding/favicon | Upload a favicon image for portal branding
|
|
156
162
|
*PortalApi* | [**postPortalLogoUpload**](docs/PortalApi.md#postportallogoupload) | **POST** /portals/{portalId}/branding/logo | Upload a logo image for portal branding
|
|
157
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
|
|
158
165
|
*PortalApi* | [**updateSelectedPortal**](docs/PortalApi.md#updateselectedportal) | **PUT** /portals/{portalId}/selected | Update the users current selected portal. Returns new JWT with updated roles.
|
|
159
166
|
*PortalSublicenseApi* | [**putPortalSublicense**](docs/PortalSublicenseApi.md#putportalsublicense) | **PUT** /portals/{portalId}/sublicense | Manage seat limit and license window for a descendant portal
|
|
160
167
|
*QuestionApi* | [**deleteQuestion**](docs/QuestionApi.md#deletequestion) | **DELETE** /questions/{questionId} | Delete a question by ID
|
|
@@ -222,10 +229,12 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
222
229
|
*UserApi* | [**getUser**](docs/UserApi.md#getuser) | **GET** /users/{userId} | Get a user by id
|
|
223
230
|
*UserApi* | [**postLogin**](docs/UserApi.md#postlogin) | **POST** /auth/login | Post a new login
|
|
224
231
|
*UserApi* | [**postLogout**](docs/UserApi.md#postlogout) | **POST** /auth/logout | Logout a user
|
|
232
|
+
*UserApi* | [**postSignupRequest**](docs/UserApi.md#postsignuprequest) | **POST** /auth/signup-request | Request a new organization signup
|
|
225
233
|
*UserApi* | [**postUserAvatarUpload**](docs/UserApi.md#postuseravatarupload) | **POST** /users/{userId}/avatar | Upload a profile photo for the current user
|
|
226
234
|
*UserApi* | [**putUser**](docs/UserApi.md#putuser) | **PUT** /users/{userId} | Update a user by id
|
|
227
235
|
*UserApi* | [**resetPassword**](docs/UserApi.md#resetpassword) | **POST** /auth/reset-password | Reset a users password
|
|
228
236
|
*UserApi* | [**sendResetPassword**](docs/UserApi.md#sendresetpassword) | **POST** /auth/send-reset-password | Send a reset password email
|
|
237
|
+
*UserApi* | [**verifySignupRequest**](docs/UserApi.md#verifysignuprequest) | **GET** /auth/signup/verify | Verify a signup request and provision the portal
|
|
229
238
|
|
|
230
239
|
|
|
231
240
|
### Models
|
|
@@ -442,6 +451,8 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
442
451
|
- [PostRevokeCertificate](docs/PostRevokeCertificate.md)
|
|
443
452
|
- [PostRole](docs/PostRole.md)
|
|
444
453
|
- [PostSendResetPassword](docs/PostSendResetPassword.md)
|
|
454
|
+
- [PostSignupRequest](docs/PostSignupRequest.md)
|
|
455
|
+
- [PostSignupRequestResponse](docs/PostSignupRequestResponse.md)
|
|
445
456
|
- [PostSupportTicket](docs/PostSupportTicket.md)
|
|
446
457
|
- [PostSupportTicketComment](docs/PostSupportTicketComment.md)
|
|
447
458
|
- [PostVerifyManifest](docs/PostVerifyManifest.md)
|
|
@@ -502,7 +513,7 @@ and is automatically generated by the
|
|
|
502
513
|
[OpenAPI Generator](https://openapi-generator.tech) project:
|
|
503
514
|
|
|
504
515
|
- API version: `1.0.0`
|
|
505
|
-
- Package version: `1.
|
|
516
|
+
- Package version: `1.65.0`
|
|
506
517
|
- Generator version: `7.22.0`
|
|
507
518
|
- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
|
|
508
519
|
|
|
@@ -35,6 +35,17 @@ import { type ScormSetValueResponse } from '../models/ScormSetValueResponse';
|
|
|
35
35
|
export interface CommitScormSessionRequest {
|
|
36
36
|
scormSessionId: string;
|
|
37
37
|
}
|
|
38
|
+
export interface DeleteContentRequest {
|
|
39
|
+
contentId: string;
|
|
40
|
+
moduleId: string;
|
|
41
|
+
courseId: string;
|
|
42
|
+
}
|
|
43
|
+
export interface DeleteContentVersionRequest {
|
|
44
|
+
contentId: string;
|
|
45
|
+
moduleId: string;
|
|
46
|
+
courseId: string;
|
|
47
|
+
versionId: string;
|
|
48
|
+
}
|
|
38
49
|
export interface GetContentRequest {
|
|
39
50
|
contentId: string;
|
|
40
51
|
moduleId: string;
|
|
@@ -168,6 +179,32 @@ export declare class ContentApi extends runtime.BaseAPI {
|
|
|
168
179
|
* Commit SCORM session data
|
|
169
180
|
*/
|
|
170
181
|
commitScormSession(requestParameters: CommitScormSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
182
|
+
/**
|
|
183
|
+
* Creates request options for deleteContent without sending the request
|
|
184
|
+
*/
|
|
185
|
+
deleteContentRequestOpts(requestParameters: DeleteContentRequest): Promise<runtime.RequestOpts>;
|
|
186
|
+
/**
|
|
187
|
+
* Soft-deletes the content item.
|
|
188
|
+
* Delete content by id
|
|
189
|
+
*/
|
|
190
|
+
deleteContentRaw(requestParameters: DeleteContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
191
|
+
/**
|
|
192
|
+
* Soft-deletes the content item.
|
|
193
|
+
* Delete content by id
|
|
194
|
+
*/
|
|
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>;
|
|
171
208
|
/**
|
|
172
209
|
* Creates request options for getContent without sending the request
|
|
173
210
|
*/
|
package/dist/apis/ContentApi.js
CHANGED
|
@@ -90,6 +90,104 @@ class ContentApi extends runtime.BaseAPI {
|
|
|
90
90
|
yield this.commitScormSessionRaw(requestParameters, initOverrides);
|
|
91
91
|
});
|
|
92
92
|
}
|
|
93
|
+
/**
|
|
94
|
+
* Creates request options for deleteContent without sending the request
|
|
95
|
+
*/
|
|
96
|
+
deleteContentRequestOpts(requestParameters) {
|
|
97
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
98
|
+
if (requestParameters['contentId'] == null) {
|
|
99
|
+
throw new runtime.RequiredError('contentId', 'Required parameter "contentId" was null or undefined when calling deleteContent().');
|
|
100
|
+
}
|
|
101
|
+
if (requestParameters['moduleId'] == null) {
|
|
102
|
+
throw new runtime.RequiredError('moduleId', 'Required parameter "moduleId" was null or undefined when calling deleteContent().');
|
|
103
|
+
}
|
|
104
|
+
if (requestParameters['courseId'] == null) {
|
|
105
|
+
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling deleteContent().');
|
|
106
|
+
}
|
|
107
|
+
const queryParameters = {};
|
|
108
|
+
const headerParameters = {};
|
|
109
|
+
let urlPath = `/courses/{courseId}/modules/{moduleId}/contents/{contentId}`;
|
|
110
|
+
urlPath = urlPath.replace('{contentId}', encodeURIComponent(String(requestParameters['contentId'])));
|
|
111
|
+
urlPath = urlPath.replace('{moduleId}', encodeURIComponent(String(requestParameters['moduleId'])));
|
|
112
|
+
urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
|
|
113
|
+
return {
|
|
114
|
+
path: urlPath,
|
|
115
|
+
method: 'DELETE',
|
|
116
|
+
headers: headerParameters,
|
|
117
|
+
query: queryParameters,
|
|
118
|
+
};
|
|
119
|
+
});
|
|
120
|
+
}
|
|
121
|
+
/**
|
|
122
|
+
* Soft-deletes the content item.
|
|
123
|
+
* Delete content by id
|
|
124
|
+
*/
|
|
125
|
+
deleteContentRaw(requestParameters, initOverrides) {
|
|
126
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
127
|
+
const requestOptions = yield this.deleteContentRequestOpts(requestParameters);
|
|
128
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
129
|
+
return new runtime.VoidApiResponse(response);
|
|
130
|
+
});
|
|
131
|
+
}
|
|
132
|
+
/**
|
|
133
|
+
* Soft-deletes the content item.
|
|
134
|
+
* Delete content by id
|
|
135
|
+
*/
|
|
136
|
+
deleteContent(requestParameters, initOverrides) {
|
|
137
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
138
|
+
yield this.deleteContentRaw(requestParameters, initOverrides);
|
|
139
|
+
});
|
|
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
|
+
}
|
|
93
191
|
/**
|
|
94
192
|
* Creates request options for getContent without sending the request
|
|
95
193
|
*/
|
package/dist/apis/CourseApi.d.ts
CHANGED
|
@@ -24,6 +24,17 @@ import { type PostCourseExport } from '../models/PostCourseExport';
|
|
|
24
24
|
import { type PostDuplicate } from '../models/PostDuplicate';
|
|
25
25
|
import { type PutCourse } from '../models/PutCourse';
|
|
26
26
|
import { type PutCourseEnrollment } from '../models/PutCourseEnrollment';
|
|
27
|
+
export interface DeleteCourseRequest {
|
|
28
|
+
courseId: string;
|
|
29
|
+
}
|
|
30
|
+
export interface DeleteCourseEnrollmentRequest {
|
|
31
|
+
courseId: string;
|
|
32
|
+
enrollmentId: string;
|
|
33
|
+
}
|
|
34
|
+
export interface DeleteCourseExportRequest {
|
|
35
|
+
courseId: string;
|
|
36
|
+
exportId: string;
|
|
37
|
+
}
|
|
27
38
|
export interface DeleteCourseImageRequest {
|
|
28
39
|
courseId: string;
|
|
29
40
|
}
|
|
@@ -91,6 +102,44 @@ export interface PutCourseEnrollmentRequest {
|
|
|
91
102
|
*
|
|
92
103
|
*/
|
|
93
104
|
export declare class CourseApi extends runtime.BaseAPI {
|
|
105
|
+
/**
|
|
106
|
+
* Creates request options for deleteCourse without sending the request
|
|
107
|
+
*/
|
|
108
|
+
deleteCourseRequestOpts(requestParameters: DeleteCourseRequest): Promise<runtime.RequestOpts>;
|
|
109
|
+
/**
|
|
110
|
+
* Soft-deletes the course and its modules/content.
|
|
111
|
+
* Delete a course by id
|
|
112
|
+
*/
|
|
113
|
+
deleteCourseRaw(requestParameters: DeleteCourseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
114
|
+
/**
|
|
115
|
+
* Soft-deletes the course and its modules/content.
|
|
116
|
+
* Delete a course by id
|
|
117
|
+
*/
|
|
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>;
|
|
94
143
|
/**
|
|
95
144
|
* Creates request options for deleteCourseImage without sending the request
|
|
96
145
|
*/
|
package/dist/apis/CourseApi.js
CHANGED
|
@@ -42,6 +42,130 @@ const PutCourseEnrollment_1 = require("../models/PutCourseEnrollment");
|
|
|
42
42
|
*
|
|
43
43
|
*/
|
|
44
44
|
class CourseApi extends runtime.BaseAPI {
|
|
45
|
+
/**
|
|
46
|
+
* Creates request options for deleteCourse without sending the request
|
|
47
|
+
*/
|
|
48
|
+
deleteCourseRequestOpts(requestParameters) {
|
|
49
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
50
|
+
if (requestParameters['courseId'] == null) {
|
|
51
|
+
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling deleteCourse().');
|
|
52
|
+
}
|
|
53
|
+
const queryParameters = {};
|
|
54
|
+
const headerParameters = {};
|
|
55
|
+
let urlPath = `/courses/{courseId}`;
|
|
56
|
+
urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
|
|
57
|
+
return {
|
|
58
|
+
path: urlPath,
|
|
59
|
+
method: 'DELETE',
|
|
60
|
+
headers: headerParameters,
|
|
61
|
+
query: queryParameters,
|
|
62
|
+
};
|
|
63
|
+
});
|
|
64
|
+
}
|
|
65
|
+
/**
|
|
66
|
+
* Soft-deletes the course and its modules/content.
|
|
67
|
+
* Delete a course by id
|
|
68
|
+
*/
|
|
69
|
+
deleteCourseRaw(requestParameters, initOverrides) {
|
|
70
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
71
|
+
const requestOptions = yield this.deleteCourseRequestOpts(requestParameters);
|
|
72
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
73
|
+
return new runtime.VoidApiResponse(response);
|
|
74
|
+
});
|
|
75
|
+
}
|
|
76
|
+
/**
|
|
77
|
+
* Soft-deletes the course and its modules/content.
|
|
78
|
+
* Delete a course by id
|
|
79
|
+
*/
|
|
80
|
+
deleteCourse(requestParameters, initOverrides) {
|
|
81
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
82
|
+
yield this.deleteCourseRaw(requestParameters, initOverrides);
|
|
83
|
+
});
|
|
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
|
+
}
|
|
45
169
|
/**
|
|
46
170
|
* Creates request options for deleteCourseImage without sending the request
|
|
47
171
|
*/
|
package/dist/apis/ModuleApi.d.ts
CHANGED
|
@@ -16,6 +16,10 @@ import { type PostDuplicate1 } from '../models/PostDuplicate1';
|
|
|
16
16
|
import { type PostModule } from '../models/PostModule';
|
|
17
17
|
import { type PutModule } from '../models/PutModule';
|
|
18
18
|
import { type PutModuleReorder } from '../models/PutModuleReorder';
|
|
19
|
+
export interface DeleteModuleRequest {
|
|
20
|
+
moduleId: string;
|
|
21
|
+
courseId: string;
|
|
22
|
+
}
|
|
19
23
|
export interface GetModuleRequest {
|
|
20
24
|
moduleId: string;
|
|
21
25
|
courseId: string;
|
|
@@ -45,6 +49,20 @@ export interface PutModuleReorderRequest {
|
|
|
45
49
|
*
|
|
46
50
|
*/
|
|
47
51
|
export declare class ModuleApi extends runtime.BaseAPI {
|
|
52
|
+
/**
|
|
53
|
+
* Creates request options for deleteModule without sending the request
|
|
54
|
+
*/
|
|
55
|
+
deleteModuleRequestOpts(requestParameters: DeleteModuleRequest): Promise<runtime.RequestOpts>;
|
|
56
|
+
/**
|
|
57
|
+
* Soft-deletes the module and its content.
|
|
58
|
+
* Delete a module by id
|
|
59
|
+
*/
|
|
60
|
+
deleteModuleRaw(requestParameters: DeleteModuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
61
|
+
/**
|
|
62
|
+
* Soft-deletes the module and its content.
|
|
63
|
+
* Delete a module by id
|
|
64
|
+
*/
|
|
65
|
+
deleteModule(requestParameters: DeleteModuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
48
66
|
/**
|
|
49
67
|
* Creates request options for getModule without sending the request
|
|
50
68
|
*/
|
package/dist/apis/ModuleApi.js
CHANGED
|
@@ -34,6 +34,50 @@ const PutModuleReorder_1 = require("../models/PutModuleReorder");
|
|
|
34
34
|
*
|
|
35
35
|
*/
|
|
36
36
|
class ModuleApi extends runtime.BaseAPI {
|
|
37
|
+
/**
|
|
38
|
+
* Creates request options for deleteModule without sending the request
|
|
39
|
+
*/
|
|
40
|
+
deleteModuleRequestOpts(requestParameters) {
|
|
41
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
42
|
+
if (requestParameters['moduleId'] == null) {
|
|
43
|
+
throw new runtime.RequiredError('moduleId', 'Required parameter "moduleId" was null or undefined when calling deleteModule().');
|
|
44
|
+
}
|
|
45
|
+
if (requestParameters['courseId'] == null) {
|
|
46
|
+
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling deleteModule().');
|
|
47
|
+
}
|
|
48
|
+
const queryParameters = {};
|
|
49
|
+
const headerParameters = {};
|
|
50
|
+
let urlPath = `/courses/{courseId}/modules/{moduleId}`;
|
|
51
|
+
urlPath = urlPath.replace('{moduleId}', encodeURIComponent(String(requestParameters['moduleId'])));
|
|
52
|
+
urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
|
|
53
|
+
return {
|
|
54
|
+
path: urlPath,
|
|
55
|
+
method: 'DELETE',
|
|
56
|
+
headers: headerParameters,
|
|
57
|
+
query: queryParameters,
|
|
58
|
+
};
|
|
59
|
+
});
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
* Soft-deletes the module and its content.
|
|
63
|
+
* Delete a module by id
|
|
64
|
+
*/
|
|
65
|
+
deleteModuleRaw(requestParameters, initOverrides) {
|
|
66
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
67
|
+
const requestOptions = yield this.deleteModuleRequestOpts(requestParameters);
|
|
68
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
69
|
+
return new runtime.VoidApiResponse(response);
|
|
70
|
+
});
|
|
71
|
+
}
|
|
72
|
+
/**
|
|
73
|
+
* Soft-deletes the module and its content.
|
|
74
|
+
* Delete a module by id
|
|
75
|
+
*/
|
|
76
|
+
deleteModule(requestParameters, initOverrides) {
|
|
77
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
78
|
+
yield this.deleteModuleRaw(requestParameters, initOverrides);
|
|
79
|
+
});
|
|
80
|
+
}
|
|
37
81
|
/**
|
|
38
82
|
* Creates request options for getModule without sending the request
|
|
39
83
|
*/
|
package/dist/apis/PortalApi.d.ts
CHANGED
|
@@ -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
|
*/
|
package/dist/apis/PortalApi.js
CHANGED
|
@@ -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
|
*/
|