@easyedu/js-lsm-api 1.65.0 → 1.67.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 +2 -2
- package/README.md +9 -3
- package/dist/apis/ContentApi.d.ts +18 -0
- package/dist/apis/ContentApi.js +51 -0
- package/dist/apis/CourseApi.d.ts +16 -0
- package/dist/apis/CourseApi.js +43 -0
- package/dist/apis/PortalApi.d.ts +58 -0
- package/dist/apis/PortalApi.js +152 -0
- package/dist/apis/SupportTicketApi.d.ts +2 -3
- package/dist/apis/SupportTicketApi.js +1 -2
- package/dist/esm/apis/ContentApi.d.ts +18 -0
- package/dist/esm/apis/ContentApi.js +51 -0
- package/dist/esm/apis/CourseApi.d.ts +16 -0
- package/dist/esm/apis/CourseApi.js +43 -0
- package/dist/esm/apis/PortalApi.d.ts +58 -0
- package/dist/esm/apis/PortalApi.js +152 -0
- package/dist/esm/apis/SupportTicketApi.d.ts +2 -3
- package/dist/esm/apis/SupportTicketApi.js +1 -2
- package/dist/esm/models/ContentLaunchMode.d.ts +26 -0
- package/dist/esm/models/ContentLaunchMode.js +44 -0
- package/dist/esm/models/GetContent.d.ts +7 -0
- package/dist/esm/models/GetContent.js +5 -0
- package/dist/esm/models/GetCourse.d.ts +27 -0
- package/dist/esm/models/GetCourse.js +20 -0
- package/dist/esm/models/GetCourseEnrollment.d.ts +29 -1
- package/dist/esm/models/GetCourseEnrollment.js +23 -1
- package/dist/esm/models/GetCourseEnrollmentListItem.d.ts +28 -1
- package/dist/esm/models/GetCourseEnrollmentListItem.js +23 -1
- package/dist/esm/models/GetPortal.d.ts +2 -2
- package/dist/esm/models/GetPortalFaviconUpload.d.ts +1 -1
- package/dist/esm/models/GetPortalLogoUpload.d.ts +1 -1
- package/dist/esm/models/GetPublicPortalBranding.d.ts +2 -2
- package/dist/esm/models/PostContentSession.d.ts +7 -0
- package/dist/esm/models/PostContentSession.js +5 -0
- package/dist/esm/models/PostCourse.d.ts +29 -0
- package/dist/esm/models/PostCourse.js +14 -0
- package/dist/esm/models/PostCourseEnrollment.d.ts +18 -1
- package/dist/esm/models/PostCourseEnrollment.js +10 -3
- package/dist/esm/models/PutContent.d.ts +7 -0
- package/dist/esm/models/PutContent.js +3 -0
- package/dist/esm/models/PutCourse.d.ts +27 -0
- package/dist/esm/models/PutCourse.js +14 -0
- package/dist/esm/models/PutCourseEnrollment.d.ts +8 -1
- package/dist/esm/models/PutCourseEnrollment.js +4 -1
- package/dist/esm/models/index.d.ts +1 -1
- package/dist/esm/models/index.js +1 -1
- package/dist/models/ContentLaunchMode.d.ts +26 -0
- package/dist/models/ContentLaunchMode.js +52 -0
- package/dist/models/GetContent.d.ts +7 -0
- package/dist/models/GetContent.js +5 -0
- package/dist/models/GetCourse.d.ts +27 -0
- package/dist/models/GetCourse.js +21 -0
- package/dist/models/GetCourseEnrollment.d.ts +29 -1
- package/dist/models/GetCourseEnrollment.js +24 -2
- package/dist/models/GetCourseEnrollmentListItem.d.ts +28 -1
- package/dist/models/GetCourseEnrollmentListItem.js +24 -2
- package/dist/models/GetPortal.d.ts +2 -2
- package/dist/models/GetPortalFaviconUpload.d.ts +1 -1
- package/dist/models/GetPortalLogoUpload.d.ts +1 -1
- package/dist/models/GetPublicPortalBranding.d.ts +2 -2
- package/dist/models/PostContentSession.d.ts +7 -0
- package/dist/models/PostContentSession.js +5 -0
- package/dist/models/PostCourse.d.ts +29 -0
- package/dist/models/PostCourse.js +15 -0
- package/dist/models/PostCourseEnrollment.d.ts +18 -1
- package/dist/models/PostCourseEnrollment.js +11 -4
- package/dist/models/PutContent.d.ts +7 -0
- package/dist/models/PutContent.js +3 -0
- package/dist/models/PutCourse.d.ts +27 -0
- package/dist/models/PutCourse.js +15 -0
- package/dist/models/PutCourseEnrollment.d.ts +8 -1
- package/dist/models/PutCourseEnrollment.js +4 -1
- package/dist/models/index.d.ts +1 -1
- package/dist/models/index.js +1 -1
- package/docs/ContentApi.md +79 -0
- package/docs/{DownloadSupportTicketAttachment200Response.md → ContentLaunchMode.md} +5 -6
- package/docs/CourseApi.md +72 -0
- package/docs/GetContent.md +2 -0
- package/docs/GetCourse.md +6 -0
- package/docs/GetCourseEnrollment.md +4 -0
- package/docs/GetCourseEnrollmentListItem.md +4 -0
- package/docs/PortalApi.md +258 -0
- package/docs/PostContentSession.md +2 -0
- package/docs/PostCourse.md +6 -0
- package/docs/PostCourseEnrollment.md +2 -0
- package/docs/PutContent.md +2 -0
- package/docs/PutCourse.md +6 -0
- package/docs/PutCourseEnrollment.md +2 -0
- package/docs/SupportTicketApi.md +4 -4
- package/package.json +1 -1
- package/src/apis/ContentApi.ts +77 -0
- package/src/apis/CourseApi.ts +58 -0
- package/src/apis/PortalApi.ts +176 -0
- package/src/apis/SupportTicketApi.ts +3 -8
- package/src/models/ContentLaunchMode.ts +54 -0
- package/src/models/GetContent.ts +16 -0
- package/src/models/GetCourse.ts +39 -0
- package/src/models/GetCourseEnrollment.ts +37 -2
- package/src/models/GetCourseEnrollmentListItem.ts +36 -2
- package/src/models/GetPortal.ts +2 -2
- package/src/models/GetPortalFaviconUpload.ts +1 -1
- package/src/models/GetPortalLogoUpload.ts +1 -1
- package/src/models/GetPublicPortalBranding.ts +2 -2
- package/src/models/PostContentSession.ts +19 -0
- package/src/models/PostCourse.ts +38 -0
- package/src/models/PostCourseEnrollment.ts +22 -3
- package/src/models/PutContent.ts +18 -0
- package/src/models/PutCourse.ts +36 -0
- package/src/models/PutCourseEnrollment.ts +11 -2
- package/src/models/index.ts +1 -1
- package/dist/esm/models/DownloadSupportTicketAttachment200Response.d.ts +0 -32
- package/dist/esm/models/DownloadSupportTicketAttachment200Response.js +0 -43
- package/dist/models/DownloadSupportTicketAttachment200Response.d.ts +0 -32
- package/dist/models/DownloadSupportTicketAttachment200Response.js +0 -50
- package/src/models/DownloadSupportTicketAttachment200Response.ts +0 -66
|
@@ -38,6 +38,10 @@ export interface DeleteCourseExportRequest {
|
|
|
38
38
|
export interface DeleteCourseImageRequest {
|
|
39
39
|
courseId: string;
|
|
40
40
|
}
|
|
41
|
+
export interface DownloadCourseExportRequest {
|
|
42
|
+
courseId: string;
|
|
43
|
+
exportId: string;
|
|
44
|
+
}
|
|
41
45
|
export interface GetCourseRequest {
|
|
42
46
|
courseId: string;
|
|
43
47
|
}
|
|
@@ -152,6 +156,18 @@ export declare class CourseApi extends runtime.BaseAPI {
|
|
|
152
156
|
* Remove the course image
|
|
153
157
|
*/
|
|
154
158
|
deleteCourseImage(requestParameters: DeleteCourseImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
159
|
+
/**
|
|
160
|
+
* Creates request options for downloadCourseExport without sending the request
|
|
161
|
+
*/
|
|
162
|
+
downloadCourseExportRequestOpts(requestParameters: DownloadCourseExportRequest): Promise<runtime.RequestOpts>;
|
|
163
|
+
/**
|
|
164
|
+
* Download a completed course export
|
|
165
|
+
*/
|
|
166
|
+
downloadCourseExportRaw(requestParameters: DownloadCourseExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
|
|
167
|
+
/**
|
|
168
|
+
* Download a completed course export
|
|
169
|
+
*/
|
|
170
|
+
downloadCourseExport(requestParameters: DownloadCourseExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
|
|
155
171
|
/**
|
|
156
172
|
* Creates request options for getCourse without sending the request
|
|
157
173
|
*/
|
|
@@ -201,6 +201,49 @@ export class CourseApi extends runtime.BaseAPI {
|
|
|
201
201
|
yield this.deleteCourseImageRaw(requestParameters, initOverrides);
|
|
202
202
|
});
|
|
203
203
|
}
|
|
204
|
+
/**
|
|
205
|
+
* Creates request options for downloadCourseExport without sending the request
|
|
206
|
+
*/
|
|
207
|
+
downloadCourseExportRequestOpts(requestParameters) {
|
|
208
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
209
|
+
if (requestParameters['courseId'] == null) {
|
|
210
|
+
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling downloadCourseExport().');
|
|
211
|
+
}
|
|
212
|
+
if (requestParameters['exportId'] == null) {
|
|
213
|
+
throw new runtime.RequiredError('exportId', 'Required parameter "exportId" was null or undefined when calling downloadCourseExport().');
|
|
214
|
+
}
|
|
215
|
+
const queryParameters = {};
|
|
216
|
+
const headerParameters = {};
|
|
217
|
+
let urlPath = `/courses/{courseId}/exports/{exportId}/download`;
|
|
218
|
+
urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
|
|
219
|
+
urlPath = urlPath.replace('{exportId}', encodeURIComponent(String(requestParameters['exportId'])));
|
|
220
|
+
return {
|
|
221
|
+
path: urlPath,
|
|
222
|
+
method: 'GET',
|
|
223
|
+
headers: headerParameters,
|
|
224
|
+
query: queryParameters,
|
|
225
|
+
};
|
|
226
|
+
});
|
|
227
|
+
}
|
|
228
|
+
/**
|
|
229
|
+
* Download a completed course export
|
|
230
|
+
*/
|
|
231
|
+
downloadCourseExportRaw(requestParameters, initOverrides) {
|
|
232
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
233
|
+
const requestOptions = yield this.downloadCourseExportRequestOpts(requestParameters);
|
|
234
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
235
|
+
return new runtime.BlobApiResponse(response);
|
|
236
|
+
});
|
|
237
|
+
}
|
|
238
|
+
/**
|
|
239
|
+
* Download a completed course export
|
|
240
|
+
*/
|
|
241
|
+
downloadCourseExport(requestParameters, initOverrides) {
|
|
242
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
243
|
+
const response = yield this.downloadCourseExportRaw(requestParameters, initOverrides);
|
|
244
|
+
return yield response.value();
|
|
245
|
+
});
|
|
246
|
+
}
|
|
204
247
|
/**
|
|
205
248
|
* Creates request options for getCourse without sending the request
|
|
206
249
|
*/
|
|
@@ -29,6 +29,12 @@ export interface DeletePortalLogoRequest {
|
|
|
29
29
|
export interface GetPortalByIdRequest {
|
|
30
30
|
portalId: string;
|
|
31
31
|
}
|
|
32
|
+
export interface GetPortalFaviconAssetRequest {
|
|
33
|
+
portalId: string;
|
|
34
|
+
}
|
|
35
|
+
export interface GetPortalLogoAssetRequest {
|
|
36
|
+
portalId: string;
|
|
37
|
+
}
|
|
32
38
|
export interface GetPortalUsersRequest {
|
|
33
39
|
portalId: string;
|
|
34
40
|
type?: GetPortalUsersTypeEnum;
|
|
@@ -103,6 +109,18 @@ export declare class PortalApi extends runtime.BaseAPI {
|
|
|
103
109
|
* Get a portal by id (can use \'current\' to get the current users selected portal)
|
|
104
110
|
*/
|
|
105
111
|
getPortalById(requestParameters: GetPortalByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortal>;
|
|
112
|
+
/**
|
|
113
|
+
* Creates request options for getPortalFaviconAsset without sending the request
|
|
114
|
+
*/
|
|
115
|
+
getPortalFaviconAssetRequestOpts(requestParameters: GetPortalFaviconAssetRequest): Promise<runtime.RequestOpts>;
|
|
116
|
+
/**
|
|
117
|
+
* Stream the configured portal favicon
|
|
118
|
+
*/
|
|
119
|
+
getPortalFaviconAssetRaw(requestParameters: GetPortalFaviconAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
|
|
120
|
+
/**
|
|
121
|
+
* Stream the configured portal favicon
|
|
122
|
+
*/
|
|
123
|
+
getPortalFaviconAsset(requestParameters: GetPortalFaviconAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
|
|
106
124
|
/**
|
|
107
125
|
* Creates request options for getPortalList without sending the request
|
|
108
126
|
*/
|
|
@@ -115,6 +133,18 @@ export declare class PortalApi extends runtime.BaseAPI {
|
|
|
115
133
|
* Get all portals a user has access to
|
|
116
134
|
*/
|
|
117
135
|
getPortalList(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortalList>;
|
|
136
|
+
/**
|
|
137
|
+
* Creates request options for getPortalLogoAsset without sending the request
|
|
138
|
+
*/
|
|
139
|
+
getPortalLogoAssetRequestOpts(requestParameters: GetPortalLogoAssetRequest): Promise<runtime.RequestOpts>;
|
|
140
|
+
/**
|
|
141
|
+
* Stream the configured portal logo
|
|
142
|
+
*/
|
|
143
|
+
getPortalLogoAssetRaw(requestParameters: GetPortalLogoAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
|
|
144
|
+
/**
|
|
145
|
+
* Stream the configured portal logo
|
|
146
|
+
*/
|
|
147
|
+
getPortalLogoAsset(requestParameters: GetPortalLogoAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
|
|
118
148
|
/**
|
|
119
149
|
* Creates request options for getPortalUsers without sending the request
|
|
120
150
|
*/
|
|
@@ -141,6 +171,34 @@ export declare class PortalApi extends runtime.BaseAPI {
|
|
|
141
171
|
* Public portal branding resolved from the request host
|
|
142
172
|
*/
|
|
143
173
|
getPublicPortalBranding(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPublicPortalBranding>;
|
|
174
|
+
/**
|
|
175
|
+
* Creates request options for getPublicPortalFaviconAsset without sending the request
|
|
176
|
+
*/
|
|
177
|
+
getPublicPortalFaviconAssetRequestOpts(): Promise<runtime.RequestOpts>;
|
|
178
|
+
/**
|
|
179
|
+
* Resolves the browser Origin/Referer/Host to a portal and streams its configured favicon.
|
|
180
|
+
* Public portal favicon resolved from the request host
|
|
181
|
+
*/
|
|
182
|
+
getPublicPortalFaviconAssetRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
|
|
183
|
+
/**
|
|
184
|
+
* Resolves the browser Origin/Referer/Host to a portal and streams its configured favicon.
|
|
185
|
+
* Public portal favicon resolved from the request host
|
|
186
|
+
*/
|
|
187
|
+
getPublicPortalFaviconAsset(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
|
|
188
|
+
/**
|
|
189
|
+
* Creates request options for getPublicPortalLogoAsset without sending the request
|
|
190
|
+
*/
|
|
191
|
+
getPublicPortalLogoAssetRequestOpts(): Promise<runtime.RequestOpts>;
|
|
192
|
+
/**
|
|
193
|
+
* Resolves the browser Origin/Referer/Host to a portal and streams its configured logo.
|
|
194
|
+
* Public portal logo resolved from the request host
|
|
195
|
+
*/
|
|
196
|
+
getPublicPortalLogoAssetRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
|
|
197
|
+
/**
|
|
198
|
+
* Resolves the browser Origin/Referer/Host to a portal and streams its configured logo.
|
|
199
|
+
* Public portal logo resolved from the request host
|
|
200
|
+
*/
|
|
201
|
+
getPublicPortalLogoAsset(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
|
|
144
202
|
/**
|
|
145
203
|
* Creates request options for inviteUserToPortal without sending the request
|
|
146
204
|
*/
|
|
@@ -150,6 +150,45 @@ export class PortalApi extends runtime.BaseAPI {
|
|
|
150
150
|
return yield response.value();
|
|
151
151
|
});
|
|
152
152
|
}
|
|
153
|
+
/**
|
|
154
|
+
* Creates request options for getPortalFaviconAsset without sending the request
|
|
155
|
+
*/
|
|
156
|
+
getPortalFaviconAssetRequestOpts(requestParameters) {
|
|
157
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
158
|
+
if (requestParameters['portalId'] == null) {
|
|
159
|
+
throw new runtime.RequiredError('portalId', 'Required parameter "portalId" was null or undefined when calling getPortalFaviconAsset().');
|
|
160
|
+
}
|
|
161
|
+
const queryParameters = {};
|
|
162
|
+
const headerParameters = {};
|
|
163
|
+
let urlPath = `/portals/{portalId}/branding/favicon`;
|
|
164
|
+
urlPath = urlPath.replace('{portalId}', encodeURIComponent(String(requestParameters['portalId'])));
|
|
165
|
+
return {
|
|
166
|
+
path: urlPath,
|
|
167
|
+
method: 'GET',
|
|
168
|
+
headers: headerParameters,
|
|
169
|
+
query: queryParameters,
|
|
170
|
+
};
|
|
171
|
+
});
|
|
172
|
+
}
|
|
173
|
+
/**
|
|
174
|
+
* Stream the configured portal favicon
|
|
175
|
+
*/
|
|
176
|
+
getPortalFaviconAssetRaw(requestParameters, initOverrides) {
|
|
177
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
178
|
+
const requestOptions = yield this.getPortalFaviconAssetRequestOpts(requestParameters);
|
|
179
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
180
|
+
return new runtime.BlobApiResponse(response);
|
|
181
|
+
});
|
|
182
|
+
}
|
|
183
|
+
/**
|
|
184
|
+
* Stream the configured portal favicon
|
|
185
|
+
*/
|
|
186
|
+
getPortalFaviconAsset(requestParameters, initOverrides) {
|
|
187
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
188
|
+
const response = yield this.getPortalFaviconAssetRaw(requestParameters, initOverrides);
|
|
189
|
+
return yield response.value();
|
|
190
|
+
});
|
|
191
|
+
}
|
|
153
192
|
/**
|
|
154
193
|
* Creates request options for getPortalList without sending the request
|
|
155
194
|
*/
|
|
@@ -185,6 +224,45 @@ export class PortalApi extends runtime.BaseAPI {
|
|
|
185
224
|
return yield response.value();
|
|
186
225
|
});
|
|
187
226
|
}
|
|
227
|
+
/**
|
|
228
|
+
* Creates request options for getPortalLogoAsset without sending the request
|
|
229
|
+
*/
|
|
230
|
+
getPortalLogoAssetRequestOpts(requestParameters) {
|
|
231
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
232
|
+
if (requestParameters['portalId'] == null) {
|
|
233
|
+
throw new runtime.RequiredError('portalId', 'Required parameter "portalId" was null or undefined when calling getPortalLogoAsset().');
|
|
234
|
+
}
|
|
235
|
+
const queryParameters = {};
|
|
236
|
+
const headerParameters = {};
|
|
237
|
+
let urlPath = `/portals/{portalId}/branding/logo`;
|
|
238
|
+
urlPath = urlPath.replace('{portalId}', encodeURIComponent(String(requestParameters['portalId'])));
|
|
239
|
+
return {
|
|
240
|
+
path: urlPath,
|
|
241
|
+
method: 'GET',
|
|
242
|
+
headers: headerParameters,
|
|
243
|
+
query: queryParameters,
|
|
244
|
+
};
|
|
245
|
+
});
|
|
246
|
+
}
|
|
247
|
+
/**
|
|
248
|
+
* Stream the configured portal logo
|
|
249
|
+
*/
|
|
250
|
+
getPortalLogoAssetRaw(requestParameters, initOverrides) {
|
|
251
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
252
|
+
const requestOptions = yield this.getPortalLogoAssetRequestOpts(requestParameters);
|
|
253
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
254
|
+
return new runtime.BlobApiResponse(response);
|
|
255
|
+
});
|
|
256
|
+
}
|
|
257
|
+
/**
|
|
258
|
+
* Stream the configured portal logo
|
|
259
|
+
*/
|
|
260
|
+
getPortalLogoAsset(requestParameters, initOverrides) {
|
|
261
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
262
|
+
const response = yield this.getPortalLogoAssetRaw(requestParameters, initOverrides);
|
|
263
|
+
return yield response.value();
|
|
264
|
+
});
|
|
265
|
+
}
|
|
188
266
|
/**
|
|
189
267
|
* Creates request options for getPortalUsers without sending the request
|
|
190
268
|
*/
|
|
@@ -276,6 +354,80 @@ export class PortalApi extends runtime.BaseAPI {
|
|
|
276
354
|
return yield response.value();
|
|
277
355
|
});
|
|
278
356
|
}
|
|
357
|
+
/**
|
|
358
|
+
* Creates request options for getPublicPortalFaviconAsset without sending the request
|
|
359
|
+
*/
|
|
360
|
+
getPublicPortalFaviconAssetRequestOpts() {
|
|
361
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
362
|
+
const queryParameters = {};
|
|
363
|
+
const headerParameters = {};
|
|
364
|
+
let urlPath = `/public/portal/branding/favicon`;
|
|
365
|
+
return {
|
|
366
|
+
path: urlPath,
|
|
367
|
+
method: 'GET',
|
|
368
|
+
headers: headerParameters,
|
|
369
|
+
query: queryParameters,
|
|
370
|
+
};
|
|
371
|
+
});
|
|
372
|
+
}
|
|
373
|
+
/**
|
|
374
|
+
* Resolves the browser Origin/Referer/Host to a portal and streams its configured favicon.
|
|
375
|
+
* Public portal favicon resolved from the request host
|
|
376
|
+
*/
|
|
377
|
+
getPublicPortalFaviconAssetRaw(initOverrides) {
|
|
378
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
379
|
+
const requestOptions = yield this.getPublicPortalFaviconAssetRequestOpts();
|
|
380
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
381
|
+
return new runtime.BlobApiResponse(response);
|
|
382
|
+
});
|
|
383
|
+
}
|
|
384
|
+
/**
|
|
385
|
+
* Resolves the browser Origin/Referer/Host to a portal and streams its configured favicon.
|
|
386
|
+
* Public portal favicon resolved from the request host
|
|
387
|
+
*/
|
|
388
|
+
getPublicPortalFaviconAsset(initOverrides) {
|
|
389
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
390
|
+
const response = yield this.getPublicPortalFaviconAssetRaw(initOverrides);
|
|
391
|
+
return yield response.value();
|
|
392
|
+
});
|
|
393
|
+
}
|
|
394
|
+
/**
|
|
395
|
+
* Creates request options for getPublicPortalLogoAsset without sending the request
|
|
396
|
+
*/
|
|
397
|
+
getPublicPortalLogoAssetRequestOpts() {
|
|
398
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
399
|
+
const queryParameters = {};
|
|
400
|
+
const headerParameters = {};
|
|
401
|
+
let urlPath = `/public/portal/branding/logo`;
|
|
402
|
+
return {
|
|
403
|
+
path: urlPath,
|
|
404
|
+
method: 'GET',
|
|
405
|
+
headers: headerParameters,
|
|
406
|
+
query: queryParameters,
|
|
407
|
+
};
|
|
408
|
+
});
|
|
409
|
+
}
|
|
410
|
+
/**
|
|
411
|
+
* Resolves the browser Origin/Referer/Host to a portal and streams its configured logo.
|
|
412
|
+
* Public portal logo resolved from the request host
|
|
413
|
+
*/
|
|
414
|
+
getPublicPortalLogoAssetRaw(initOverrides) {
|
|
415
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
416
|
+
const requestOptions = yield this.getPublicPortalLogoAssetRequestOpts();
|
|
417
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
418
|
+
return new runtime.BlobApiResponse(response);
|
|
419
|
+
});
|
|
420
|
+
}
|
|
421
|
+
/**
|
|
422
|
+
* Resolves the browser Origin/Referer/Host to a portal and streams its configured logo.
|
|
423
|
+
* Public portal logo resolved from the request host
|
|
424
|
+
*/
|
|
425
|
+
getPublicPortalLogoAsset(initOverrides) {
|
|
426
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
427
|
+
const response = yield this.getPublicPortalLogoAssetRaw(initOverrides);
|
|
428
|
+
return yield response.value();
|
|
429
|
+
});
|
|
430
|
+
}
|
|
279
431
|
/**
|
|
280
432
|
* Creates request options for inviteUserToPortal without sending the request
|
|
281
433
|
*/
|
|
@@ -10,7 +10,6 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import { type DownloadSupportTicketAttachment200Response } from '../models/DownloadSupportTicketAttachment200Response';
|
|
14
13
|
import { type GetSupportTicket } from '../models/GetSupportTicket';
|
|
15
14
|
import { type GetSupportTicketAttachment } from '../models/GetSupportTicketAttachment';
|
|
16
15
|
import { type GetSupportTicketComment } from '../models/GetSupportTicketComment';
|
|
@@ -76,11 +75,11 @@ export declare class SupportTicketApi extends runtime.BaseAPI {
|
|
|
76
75
|
/**
|
|
77
76
|
* Download a ticket attachment
|
|
78
77
|
*/
|
|
79
|
-
downloadSupportTicketAttachmentRaw(requestParameters: DownloadSupportTicketAttachmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<
|
|
78
|
+
downloadSupportTicketAttachmentRaw(requestParameters: DownloadSupportTicketAttachmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
|
|
80
79
|
/**
|
|
81
80
|
* Download a ticket attachment
|
|
82
81
|
*/
|
|
83
|
-
downloadSupportTicketAttachment(requestParameters: DownloadSupportTicketAttachmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<
|
|
82
|
+
downloadSupportTicketAttachment(requestParameters: DownloadSupportTicketAttachmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
|
|
84
83
|
/**
|
|
85
84
|
* Creates request options for getSupportTicket without sending the request
|
|
86
85
|
*/
|
|
@@ -21,7 +21,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
21
21
|
});
|
|
22
22
|
};
|
|
23
23
|
import * as runtime from '../runtime';
|
|
24
|
-
import { DownloadSupportTicketAttachment200ResponseFromJSON, } from '../models/DownloadSupportTicketAttachment200Response';
|
|
25
24
|
import { GetSupportTicketFromJSON, } from '../models/GetSupportTicket';
|
|
26
25
|
import { GetSupportTicketAttachmentFromJSON, } from '../models/GetSupportTicketAttachment';
|
|
27
26
|
import { GetSupportTicketCommentFromJSON, } from '../models/GetSupportTicketComment';
|
|
@@ -102,7 +101,7 @@ export class SupportTicketApi extends runtime.BaseAPI {
|
|
|
102
101
|
return __awaiter(this, void 0, void 0, function* () {
|
|
103
102
|
const requestOptions = yield this.downloadSupportTicketAttachmentRequestOpts(requestParameters);
|
|
104
103
|
const response = yield this.request(requestOptions, initOverrides);
|
|
105
|
-
return new runtime.
|
|
104
|
+
return new runtime.BlobApiResponse(response);
|
|
106
105
|
});
|
|
107
106
|
}
|
|
108
107
|
/**
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* LMS API
|
|
3
|
+
* LMS API
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* How the learner player should present the launched content.
|
|
14
|
+
* @export
|
|
15
|
+
*/
|
|
16
|
+
export declare const ContentLaunchMode: {
|
|
17
|
+
readonly Embedded: "embedded";
|
|
18
|
+
readonly Fullscreen: "fullscreen";
|
|
19
|
+
readonly NewWindow: "new_window";
|
|
20
|
+
};
|
|
21
|
+
export type ContentLaunchMode = typeof ContentLaunchMode[keyof typeof ContentLaunchMode];
|
|
22
|
+
export declare function instanceOfContentLaunchMode(value: any): boolean;
|
|
23
|
+
export declare function ContentLaunchModeFromJSON(json: any): ContentLaunchMode;
|
|
24
|
+
export declare function ContentLaunchModeFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContentLaunchMode;
|
|
25
|
+
export declare function ContentLaunchModeToJSON(value?: ContentLaunchMode | null): any;
|
|
26
|
+
export declare function ContentLaunchModeToJSONTyped(value: any, ignoreDiscriminator: boolean): ContentLaunchMode;
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* LMS API
|
|
5
|
+
* LMS API
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
/**
|
|
15
|
+
* How the learner player should present the launched content.
|
|
16
|
+
* @export
|
|
17
|
+
*/
|
|
18
|
+
export const ContentLaunchMode = {
|
|
19
|
+
Embedded: 'embedded',
|
|
20
|
+
Fullscreen: 'fullscreen',
|
|
21
|
+
NewWindow: 'new_window'
|
|
22
|
+
};
|
|
23
|
+
export function instanceOfContentLaunchMode(value) {
|
|
24
|
+
for (const key in ContentLaunchMode) {
|
|
25
|
+
if (Object.prototype.hasOwnProperty.call(ContentLaunchMode, key)) {
|
|
26
|
+
if (ContentLaunchMode[key] === value) {
|
|
27
|
+
return true;
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
}
|
|
31
|
+
return false;
|
|
32
|
+
}
|
|
33
|
+
export function ContentLaunchModeFromJSON(json) {
|
|
34
|
+
return ContentLaunchModeFromJSONTyped(json, false);
|
|
35
|
+
}
|
|
36
|
+
export function ContentLaunchModeFromJSONTyped(json, ignoreDiscriminator) {
|
|
37
|
+
return json;
|
|
38
|
+
}
|
|
39
|
+
export function ContentLaunchModeToJSON(value) {
|
|
40
|
+
return value;
|
|
41
|
+
}
|
|
42
|
+
export function ContentLaunchModeToJSONTyped(value, ignoreDiscriminator) {
|
|
43
|
+
return value;
|
|
44
|
+
}
|
|
@@ -10,6 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import type { GetContentContentData } from './GetContentContentData';
|
|
13
|
+
import type { ContentLaunchMode } from './ContentLaunchMode';
|
|
13
14
|
/**
|
|
14
15
|
*
|
|
15
16
|
* @export
|
|
@@ -46,6 +47,12 @@ export interface GetContent {
|
|
|
46
47
|
* @memberof GetContent
|
|
47
48
|
*/
|
|
48
49
|
contentType: GetContentContentTypeEnum;
|
|
50
|
+
/**
|
|
51
|
+
*
|
|
52
|
+
* @type {ContentLaunchMode}
|
|
53
|
+
* @memberof GetContent
|
|
54
|
+
*/
|
|
55
|
+
launchMode: ContentLaunchMode;
|
|
49
56
|
/**
|
|
50
57
|
*
|
|
51
58
|
* @type {GetContentContentData}
|
|
@@ -12,6 +12,7 @@
|
|
|
12
12
|
* Do not edit the class manually.
|
|
13
13
|
*/
|
|
14
14
|
import { GetContentContentDataFromJSON, GetContentContentDataToJSON, } from './GetContentContentData';
|
|
15
|
+
import { ContentLaunchModeFromJSON, ContentLaunchModeToJSON, } from './ContentLaunchMode';
|
|
15
16
|
/**
|
|
16
17
|
* @export
|
|
17
18
|
*/
|
|
@@ -36,6 +37,8 @@ export function instanceOfGetContent(value) {
|
|
|
36
37
|
return false;
|
|
37
38
|
if (!('contentType' in value) || value['contentType'] === undefined)
|
|
38
39
|
return false;
|
|
40
|
+
if (!('launchMode' in value) || value['launchMode'] === undefined)
|
|
41
|
+
return false;
|
|
39
42
|
if (!('contentData' in value) || value['contentData'] === undefined)
|
|
40
43
|
return false;
|
|
41
44
|
if (!('published' in value) || value['published'] === undefined)
|
|
@@ -55,6 +58,7 @@ export function GetContentFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
55
58
|
'name': json['name'],
|
|
56
59
|
'description': json['description'] == null ? undefined : json['description'],
|
|
57
60
|
'contentType': json['content_type'],
|
|
61
|
+
'launchMode': ContentLaunchModeFromJSON(json['launch_mode']),
|
|
58
62
|
'contentData': GetContentContentDataFromJSON(json['content_data']),
|
|
59
63
|
'order': json['order'] == null ? undefined : json['order'],
|
|
60
64
|
'published': json['published'],
|
|
@@ -77,6 +81,7 @@ export function GetContentToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
77
81
|
'name': value['name'],
|
|
78
82
|
'description': value['description'],
|
|
79
83
|
'content_type': value['contentType'],
|
|
84
|
+
'launch_mode': ContentLaunchModeToJSON(value['launchMode']),
|
|
80
85
|
'content_data': GetContentContentDataToJSON(value['contentData']),
|
|
81
86
|
'order': value['order'],
|
|
82
87
|
'published': value['published'],
|
|
@@ -51,7 +51,34 @@ export interface GetCourse {
|
|
|
51
51
|
* @memberof GetCourse
|
|
52
52
|
*/
|
|
53
53
|
createdAt: number;
|
|
54
|
+
/**
|
|
55
|
+
* Course-level learner access policy.
|
|
56
|
+
* @type {GetCourseAccessPolicyTypeEnum}
|
|
57
|
+
* @memberof GetCourse
|
|
58
|
+
*/
|
|
59
|
+
accessPolicyType: GetCourseAccessPolicyTypeEnum;
|
|
60
|
+
/**
|
|
61
|
+
* Number of access days from enrollment start when access_policy_type is duration_days.
|
|
62
|
+
* @type {number}
|
|
63
|
+
* @memberof GetCourse
|
|
64
|
+
*/
|
|
65
|
+
accessDurationDays: number | null;
|
|
66
|
+
/**
|
|
67
|
+
* Fixed Unix timestamp when access expires when access_policy_type is fixed_end_date.
|
|
68
|
+
* @type {number}
|
|
69
|
+
* @memberof GetCourse
|
|
70
|
+
*/
|
|
71
|
+
accessFixedEndAt: number | null;
|
|
54
72
|
}
|
|
73
|
+
/**
|
|
74
|
+
* @export
|
|
75
|
+
*/
|
|
76
|
+
export declare const GetCourseAccessPolicyTypeEnum: {
|
|
77
|
+
readonly DurationDays: "duration_days";
|
|
78
|
+
readonly FixedEndDate: "fixed_end_date";
|
|
79
|
+
readonly NeverExpires: "never_expires";
|
|
80
|
+
};
|
|
81
|
+
export type GetCourseAccessPolicyTypeEnum = typeof GetCourseAccessPolicyTypeEnum[keyof typeof GetCourseAccessPolicyTypeEnum];
|
|
55
82
|
/**
|
|
56
83
|
* Check if a given object implements the GetCourse interface.
|
|
57
84
|
*/
|
|
@@ -11,6 +11,14 @@
|
|
|
11
11
|
* https://openapi-generator.tech
|
|
12
12
|
* Do not edit the class manually.
|
|
13
13
|
*/
|
|
14
|
+
/**
|
|
15
|
+
* @export
|
|
16
|
+
*/
|
|
17
|
+
export const GetCourseAccessPolicyTypeEnum = {
|
|
18
|
+
DurationDays: 'duration_days',
|
|
19
|
+
FixedEndDate: 'fixed_end_date',
|
|
20
|
+
NeverExpires: 'never_expires'
|
|
21
|
+
};
|
|
14
22
|
/**
|
|
15
23
|
* Check if a given object implements the GetCourse interface.
|
|
16
24
|
*/
|
|
@@ -27,6 +35,12 @@ export function instanceOfGetCourse(value) {
|
|
|
27
35
|
return false;
|
|
28
36
|
if (!('createdAt' in value) || value['createdAt'] === undefined)
|
|
29
37
|
return false;
|
|
38
|
+
if (!('accessPolicyType' in value) || value['accessPolicyType'] === undefined)
|
|
39
|
+
return false;
|
|
40
|
+
if (!('accessDurationDays' in value) || value['accessDurationDays'] === undefined)
|
|
41
|
+
return false;
|
|
42
|
+
if (!('accessFixedEndAt' in value) || value['accessFixedEndAt'] === undefined)
|
|
43
|
+
return false;
|
|
30
44
|
return true;
|
|
31
45
|
}
|
|
32
46
|
export function GetCourseFromJSON(json) {
|
|
@@ -43,6 +57,9 @@ export function GetCourseFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
43
57
|
'imageUrl': json['image_url'],
|
|
44
58
|
'published': json['published'],
|
|
45
59
|
'createdAt': json['created_at'],
|
|
60
|
+
'accessPolicyType': json['access_policy_type'],
|
|
61
|
+
'accessDurationDays': json['access_duration_days'],
|
|
62
|
+
'accessFixedEndAt': json['access_fixed_end_at'],
|
|
46
63
|
};
|
|
47
64
|
}
|
|
48
65
|
export function GetCourseToJSON(json) {
|
|
@@ -58,5 +75,8 @@ export function GetCourseToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
58
75
|
'image_url': value['imageUrl'],
|
|
59
76
|
'published': value['published'],
|
|
60
77
|
'created_at': value['createdAt'],
|
|
78
|
+
'access_policy_type': value['accessPolicyType'],
|
|
79
|
+
'access_duration_days': value['accessDurationDays'],
|
|
80
|
+
'access_fixed_end_at': value['accessFixedEndAt'],
|
|
61
81
|
};
|
|
62
82
|
}
|
|
@@ -44,7 +44,7 @@ export interface GetCourseEnrollment {
|
|
|
44
44
|
* @type {number}
|
|
45
45
|
* @memberof GetCourseEnrollment
|
|
46
46
|
*/
|
|
47
|
-
enrollmentDateEnd: number;
|
|
47
|
+
enrollmentDateEnd: number | null;
|
|
48
48
|
/**
|
|
49
49
|
* Optional notes about the enrollment
|
|
50
50
|
* @type {string}
|
|
@@ -61,11 +61,24 @@ export interface GetCourseEnrollment {
|
|
|
61
61
|
* - Withdrawn: learner pulled out before completion
|
|
62
62
|
* - Removed: admin-removed enrollment
|
|
63
63
|
* - Archived: historical / read-only (e.g. course share revoked)
|
|
64
|
+
* - Suspended: access temporarily disabled by an admin
|
|
64
65
|
*
|
|
65
66
|
* @type {GetCourseEnrollmentStatusEnum}
|
|
66
67
|
* @memberof GetCourseEnrollment
|
|
67
68
|
*/
|
|
68
69
|
status: GetCourseEnrollmentStatusEnum;
|
|
70
|
+
/**
|
|
71
|
+
* Derived learner access state for UI indicators and access decisions.
|
|
72
|
+
* @type {GetCourseEnrollmentAccessStateEnum}
|
|
73
|
+
* @memberof GetCourseEnrollment
|
|
74
|
+
*/
|
|
75
|
+
accessState: GetCourseEnrollmentAccessStateEnum;
|
|
76
|
+
/**
|
|
77
|
+
* Whole days until access expiry; null for never-expiring or already inactive enrollments.
|
|
78
|
+
* @type {number}
|
|
79
|
+
* @memberof GetCourseEnrollment
|
|
80
|
+
*/
|
|
81
|
+
daysUntilExpiry: number | null;
|
|
69
82
|
/**
|
|
70
83
|
* The role/type of the user in this enrollment
|
|
71
84
|
* @type {GetCourseEnrollmentUserTypeEnum}
|
|
@@ -91,8 +104,23 @@ export declare const GetCourseEnrollmentStatusEnum: {
|
|
|
91
104
|
readonly Withdrawn: "Withdrawn";
|
|
92
105
|
readonly Removed: "Removed";
|
|
93
106
|
readonly Archived: "Archived";
|
|
107
|
+
readonly Suspended: "Suspended";
|
|
94
108
|
};
|
|
95
109
|
export type GetCourseEnrollmentStatusEnum = typeof GetCourseEnrollmentStatusEnum[keyof typeof GetCourseEnrollmentStatusEnum];
|
|
110
|
+
/**
|
|
111
|
+
* @export
|
|
112
|
+
*/
|
|
113
|
+
export declare const GetCourseEnrollmentAccessStateEnum: {
|
|
114
|
+
readonly Active: "active";
|
|
115
|
+
readonly CompletedReview: "completed_review";
|
|
116
|
+
readonly Expired: "expired";
|
|
117
|
+
readonly Suspended: "suspended";
|
|
118
|
+
readonly Failed: "failed";
|
|
119
|
+
readonly Withdrawn: "withdrawn";
|
|
120
|
+
readonly Removed: "removed";
|
|
121
|
+
readonly Archived: "archived";
|
|
122
|
+
};
|
|
123
|
+
export type GetCourseEnrollmentAccessStateEnum = typeof GetCourseEnrollmentAccessStateEnum[keyof typeof GetCourseEnrollmentAccessStateEnum];
|
|
96
124
|
/**
|
|
97
125
|
* @export
|
|
98
126
|
*/
|