@easyedu/js-lsm-api 1.51.0 → 1.53.0

package/dist/esm/apis/CourseCatalogApi.js

@@ -0,0 +1,348 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as runtime from '../runtime';
+import { CourseCatalogFromJSON, GetCourseFromJSON, PostCourseCatalogToJSON, PutCourseCatalogToJSON, } from '../models/index';
+/**
+ *
+ */
+export class CourseCatalogApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for addCourseToCatalog without sending the request
+     */
+    addCourseToCatalogRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['catalogId'] == null) {
+                throw new runtime.RequiredError('catalogId', 'Required parameter "catalogId" was null or undefined when calling addCourseToCatalog().');
+            }
+            if (requestParameters['courseId'] == null) {
+                throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling addCourseToCatalog().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/catalogs/{catalogId}/courses/{courseId}`;
+            urlPath = urlPath.replace(`{${"catalogId"}}`, encodeURIComponent(String(requestParameters['catalogId'])));
+            urlPath = urlPath.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId'])));
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Add a course to a catalog
+     */
+    addCourseToCatalogRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.addCourseToCatalogRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Add a course to a catalog
+     */
+    addCourseToCatalog(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.addCourseToCatalogRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Creates request options for deleteCourseCatalog without sending the request
+     */
+    deleteCourseCatalogRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['catalogId'] == null) {
+                throw new runtime.RequiredError('catalogId', 'Required parameter "catalogId" was null or undefined when calling deleteCourseCatalog().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/catalogs/{catalogId}`;
+            urlPath = urlPath.replace(`{${"catalogId"}}`, encodeURIComponent(String(requestParameters['catalogId'])));
+            return {
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Delete a catalog
+     */
+    deleteCourseCatalogRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.deleteCourseCatalogRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Delete a catalog
+     */
+    deleteCourseCatalog(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.deleteCourseCatalogRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Creates request options for getCatalogCourses without sending the request
+     */
+    getCatalogCoursesRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['catalogId'] == null) {
+                throw new runtime.RequiredError('catalogId', 'Required parameter "catalogId" was null or undefined when calling getCatalogCourses().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/catalogs/{catalogId}/courses`;
+            urlPath = urlPath.replace(`{${"catalogId"}}`, encodeURIComponent(String(requestParameters['catalogId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * List the courses in a catalog
+     */
+    getCatalogCoursesRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getCatalogCoursesRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(GetCourseFromJSON));
+        });
+    }
+    /**
+     * List the courses in a catalog
+     */
+    getCatalogCourses(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getCatalogCoursesRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getCourseCatalog without sending the request
+     */
+    getCourseCatalogRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['catalogId'] == null) {
+                throw new runtime.RequiredError('catalogId', 'Required parameter "catalogId" was null or undefined when calling getCourseCatalog().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/catalogs/{catalogId}`;
+            urlPath = urlPath.replace(`{${"catalogId"}}`, encodeURIComponent(String(requestParameters['catalogId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Get a catalog
+     */
+    getCourseCatalogRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getCourseCatalogRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => CourseCatalogFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Get a catalog
+     */
+    getCourseCatalog(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getCourseCatalogRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getCourseCatalogs without sending the request
+     */
+    getCourseCatalogsRequestOpts() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/catalogs`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * List catalogs in the current portal
+     */
+    getCourseCatalogsRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getCourseCatalogsRequestOpts();
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(CourseCatalogFromJSON));
+        });
+    }
+    /**
+     * List catalogs in the current portal
+     */
+    getCourseCatalogs(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getCourseCatalogsRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for postCourseCatalog without sending the request
+     */
+    postCourseCatalogRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['postCourseCatalog'] == null) {
+                throw new runtime.RequiredError('postCourseCatalog', 'Required parameter "postCourseCatalog" was null or undefined when calling postCourseCatalog().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            let urlPath = `/catalogs`;
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: PostCourseCatalogToJSON(requestParameters['postCourseCatalog']),
+            };
+        });
+    }
+    /**
+     * Create a course catalog
+     */
+    postCourseCatalogRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.postCourseCatalogRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => CourseCatalogFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Create a course catalog
+     */
+    postCourseCatalog(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.postCourseCatalogRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for putCourseCatalog without sending the request
+     */
+    putCourseCatalogRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['catalogId'] == null) {
+                throw new runtime.RequiredError('catalogId', 'Required parameter "catalogId" was null or undefined when calling putCourseCatalog().');
+            }
+            if (requestParameters['putCourseCatalog'] == null) {
+                throw new runtime.RequiredError('putCourseCatalog', 'Required parameter "putCourseCatalog" was null or undefined when calling putCourseCatalog().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            let urlPath = `/catalogs/{catalogId}`;
+            urlPath = urlPath.replace(`{${"catalogId"}}`, encodeURIComponent(String(requestParameters['catalogId'])));
+            return {
+                path: urlPath,
+                method: 'PUT',
+                headers: headerParameters,
+                query: queryParameters,
+                body: PutCourseCatalogToJSON(requestParameters['putCourseCatalog']),
+            };
+        });
+    }
+    /**
+     * Update a catalog
+     */
+    putCourseCatalogRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.putCourseCatalogRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => CourseCatalogFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Update a catalog
+     */
+    putCourseCatalog(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.putCourseCatalogRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for removeCourseFromCatalog without sending the request
+     */
+    removeCourseFromCatalogRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['catalogId'] == null) {
+                throw new runtime.RequiredError('catalogId', 'Required parameter "catalogId" was null or undefined when calling removeCourseFromCatalog().');
+            }
+            if (requestParameters['courseId'] == null) {
+                throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling removeCourseFromCatalog().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/catalogs/{catalogId}/courses/{courseId}`;
+            urlPath = urlPath.replace(`{${"catalogId"}}`, encodeURIComponent(String(requestParameters['catalogId'])));
+            urlPath = urlPath.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId'])));
+            return {
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Remove a course from a catalog
+     */
+    removeCourseFromCatalogRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.removeCourseFromCatalogRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Remove a course from a catalog
+     */
+    removeCourseFromCatalog(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.removeCourseFromCatalogRaw(requestParameters, initOverrides);
+        });
+    }
+}

package/dist/esm/apis/CourseShareApi.d.ts

@@ -0,0 +1,153 @@
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { CourseShare, PostOfferCatalog, PostOfferCatalogResponse, PostOfferCourse, PostOfferCourseResponse } from '../models/index';
+export interface DeleteCourseShareRequest {
+    shareId: string;
+}
+export interface PostOfferCatalogRequest {
+    catalogId: string;
+    postOfferCatalog: PostOfferCatalog;
+}
+export interface PostOfferCourseRequest {
+    courseId: string;
+    postOfferCourse: PostOfferCourse;
+}
+export interface PostUnrevokeShareRequest {
+    shareId: string;
+}
+export interface PutAcceptCloneRequest {
+    shareId: string;
+}
+export interface PutAcceptMirrorRequest {
+    shareId: string;
+}
+export interface PutDeclineShareRequest {
+    shareId: string;
+}
+/**
+ *
+ */
+export declare class CourseShareApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for deleteCourseShare without sending the request
+     */
+    deleteCourseShareRequestOpts(requestParameters: DeleteCourseShareRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Cascades to any downstream re-shares and archives enrollments in the target portal. Use `POST /course-shares/{shareId}/unrevoke` to restore.
+     * Revoke a share
+     */
+    deleteCourseShareRaw(requestParameters: DeleteCourseShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Cascades to any downstream re-shares and archives enrollments in the target portal. Use `POST /course-shares/{shareId}/unrevoke` to restore.
+     * Revoke a share
+     */
+    deleteCourseShare(requestParameters: DeleteCourseShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getCourseSharesOfferedByMe without sending the request
+     */
+    getCourseSharesOfferedByMeRequestOpts(): Promise<runtime.RequestOpts>;
+    /**
+     * List shares the current portal has offered out
+     */
+    getCourseSharesOfferedByMeRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CourseShare>>>;
+    /**
+     * List shares the current portal has offered out
+     */
+    getCourseSharesOfferedByMe(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CourseShare>>;
+    /**
+     * Creates request options for getCourseSharesOfferedToMe without sending the request
+     */
+    getCourseSharesOfferedToMeRequestOpts(): Promise<runtime.RequestOpts>;
+    /**
+     * List shares offered to the current portal
+     */
+    getCourseSharesOfferedToMeRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CourseShare>>>;
+    /**
+     * List shares offered to the current portal
+     */
+    getCourseSharesOfferedToMe(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CourseShare>>;
+    /**
+     * Creates request options for postOfferCatalog without sending the request
+     */
+    postOfferCatalogRequestOpts(requestParameters: PostOfferCatalogRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Fans out one `course_share` per catalog member. Duplicates are silently skipped. The catalog link is preserved on each generated share via `origin_catalog_id`.
+     * Offer every course in a catalog to a descendant portal
+     */
+    postOfferCatalogRaw(requestParameters: PostOfferCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostOfferCatalogResponse>>;
+    /**
+     * Fans out one `course_share` per catalog member. Duplicates are silently skipped. The catalog link is preserved on each generated share via `origin_catalog_id`.
+     * Offer every course in a catalog to a descendant portal
+     */
+    postOfferCatalog(requestParameters: PostOfferCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostOfferCatalogResponse>;
+    /**
+     * Creates request options for postOfferCourse without sending the request
+     */
+    postOfferCourseRequestOpts(requestParameters: PostOfferCourseRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Offer a single course to a descendant portal
+     */
+    postOfferCourseRaw(requestParameters: PostOfferCourseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostOfferCourseResponse>>;
+    /**
+     * Offer a single course to a descendant portal
+     */
+    postOfferCourse(requestParameters: PostOfferCourseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostOfferCourseResponse>;
+    /**
+     * Creates request options for postUnrevokeShare without sending the request
+     */
+    postUnrevokeShareRequestOpts(requestParameters: PostUnrevokeShareRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Restore a previously revoked share
+     */
+    postUnrevokeShareRaw(requestParameters: PostUnrevokeShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Restore a previously revoked share
+     */
+    postUnrevokeShare(requestParameters: PostUnrevokeShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for putAcceptClone without sending the request
+     */
+    putAcceptCloneRequestOpts(requestParameters: PutAcceptCloneRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Accept an offer as a clone (deep copy into your portal)
+     */
+    putAcceptCloneRaw(requestParameters: PutAcceptCloneRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Accept an offer as a clone (deep copy into your portal)
+     */
+    putAcceptClone(requestParameters: PutAcceptCloneRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for putAcceptMirror without sending the request
+     */
+    putAcceptMirrorRequestOpts(requestParameters: PutAcceptMirrorRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Accept an offer as a mirror (no copy, live link to source)
+     */
+    putAcceptMirrorRaw(requestParameters: PutAcceptMirrorRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Accept an offer as a mirror (no copy, live link to source)
+     */
+    putAcceptMirror(requestParameters: PutAcceptMirrorRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for putDeclineShare without sending the request
+     */
+    putDeclineShareRequestOpts(requestParameters: PutDeclineShareRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Decline an offer
+     */
+    putDeclineShareRaw(requestParameters: PutDeclineShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Decline an offer
+     */
+    putDeclineShare(requestParameters: PutDeclineShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}