@easyedu/js-lsm-api 1.51.0 → 1.53.0

package/dist/esm/apis/CourseShareApi.js

@@ -0,0 +1,381 @@
+/* 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 { CourseShareFromJSON, PostOfferCatalogToJSON, PostOfferCatalogResponseFromJSON, PostOfferCourseToJSON, PostOfferCourseResponseFromJSON, } from '../models/index';
+/**
+ *
+ */
+export class CourseShareApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for deleteCourseShare without sending the request
+     */
+    deleteCourseShareRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['shareId'] == null) {
+                throw new runtime.RequiredError('shareId', 'Required parameter "shareId" was null or undefined when calling deleteCourseShare().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/course-shares/{shareId}`;
+            urlPath = urlPath.replace(`{${"shareId"}}`, encodeURIComponent(String(requestParameters['shareId'])));
+            return {
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * 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, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.deleteCourseShareRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * 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, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.deleteCourseShareRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Creates request options for getCourseSharesOfferedByMe without sending the request
+     */
+    getCourseSharesOfferedByMeRequestOpts() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/course-shares/offered-by-me`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * List shares the current portal has offered out
+     */
+    getCourseSharesOfferedByMeRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getCourseSharesOfferedByMeRequestOpts();
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(CourseShareFromJSON));
+        });
+    }
+    /**
+     * List shares the current portal has offered out
+     */
+    getCourseSharesOfferedByMe(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getCourseSharesOfferedByMeRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getCourseSharesOfferedToMe without sending the request
+     */
+    getCourseSharesOfferedToMeRequestOpts() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/course-shares/offered-to-me`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * List shares offered to the current portal
+     */
+    getCourseSharesOfferedToMeRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getCourseSharesOfferedToMeRequestOpts();
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(CourseShareFromJSON));
+        });
+    }
+    /**
+     * List shares offered to the current portal
+     */
+    getCourseSharesOfferedToMe(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getCourseSharesOfferedToMeRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for postOfferCatalog without sending the request
+     */
+    postOfferCatalogRequestOpts(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 postOfferCatalog().');
+            }
+            if (requestParameters['postOfferCatalog'] == null) {
+                throw new runtime.RequiredError('postOfferCatalog', 'Required parameter "postOfferCatalog" was null or undefined when calling postOfferCatalog().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            let urlPath = `/catalogs/{catalogId}/shares`;
+            urlPath = urlPath.replace(`{${"catalogId"}}`, encodeURIComponent(String(requestParameters['catalogId'])));
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: PostOfferCatalogToJSON(requestParameters['postOfferCatalog']),
+            };
+        });
+    }
+    /**
+     * 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, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.postOfferCatalogRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => PostOfferCatalogResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * 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, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.postOfferCatalogRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for postOfferCourse without sending the request
+     */
+    postOfferCourseRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['courseId'] == null) {
+                throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling postOfferCourse().');
+            }
+            if (requestParameters['postOfferCourse'] == null) {
+                throw new runtime.RequiredError('postOfferCourse', 'Required parameter "postOfferCourse" was null or undefined when calling postOfferCourse().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            let urlPath = `/courses/{courseId}/shares`;
+            urlPath = urlPath.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId'])));
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: PostOfferCourseToJSON(requestParameters['postOfferCourse']),
+            };
+        });
+    }
+    /**
+     * Offer a single course to a descendant portal
+     */
+    postOfferCourseRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.postOfferCourseRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => PostOfferCourseResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Offer a single course to a descendant portal
+     */
+    postOfferCourse(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.postOfferCourseRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for postUnrevokeShare without sending the request
+     */
+    postUnrevokeShareRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['shareId'] == null) {
+                throw new runtime.RequiredError('shareId', 'Required parameter "shareId" was null or undefined when calling postUnrevokeShare().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/course-shares/{shareId}/unrevoke`;
+            urlPath = urlPath.replace(`{${"shareId"}}`, encodeURIComponent(String(requestParameters['shareId'])));
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Restore a previously revoked share
+     */
+    postUnrevokeShareRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.postUnrevokeShareRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Restore a previously revoked share
+     */
+    postUnrevokeShare(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.postUnrevokeShareRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Creates request options for putAcceptClone without sending the request
+     */
+    putAcceptCloneRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['shareId'] == null) {
+                throw new runtime.RequiredError('shareId', 'Required parameter "shareId" was null or undefined when calling putAcceptClone().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/course-shares/{shareId}/accept-clone`;
+            urlPath = urlPath.replace(`{${"shareId"}}`, encodeURIComponent(String(requestParameters['shareId'])));
+            return {
+                path: urlPath,
+                method: 'PUT',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Accept an offer as a clone (deep copy into your portal)
+     */
+    putAcceptCloneRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.putAcceptCloneRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Accept an offer as a clone (deep copy into your portal)
+     */
+    putAcceptClone(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.putAcceptCloneRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Creates request options for putAcceptMirror without sending the request
+     */
+    putAcceptMirrorRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['shareId'] == null) {
+                throw new runtime.RequiredError('shareId', 'Required parameter "shareId" was null or undefined when calling putAcceptMirror().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/course-shares/{shareId}/accept-mirror`;
+            urlPath = urlPath.replace(`{${"shareId"}}`, encodeURIComponent(String(requestParameters['shareId'])));
+            return {
+                path: urlPath,
+                method: 'PUT',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Accept an offer as a mirror (no copy, live link to source)
+     */
+    putAcceptMirrorRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.putAcceptMirrorRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Accept an offer as a mirror (no copy, live link to source)
+     */
+    putAcceptMirror(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.putAcceptMirrorRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Creates request options for putDeclineShare without sending the request
+     */
+    putDeclineShareRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['shareId'] == null) {
+                throw new runtime.RequiredError('shareId', 'Required parameter "shareId" was null or undefined when calling putDeclineShare().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/course-shares/{shareId}/decline`;
+            urlPath = urlPath.replace(`{${"shareId"}}`, encodeURIComponent(String(requestParameters['shareId'])));
+            return {
+                path: urlPath,
+                method: 'PUT',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Decline an offer
+     */
+    putDeclineShareRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.putDeclineShareRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Decline an offer
+     */
+    putDeclineShare(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.putDeclineShareRaw(requestParameters, initOverrides);
+        });
+    }
+}

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

@@ -0,0 +1,36 @@
+/**
+ * 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 { PortalSublicense, PutPortalSublicense } from '../models/index';
+export interface PutPortalSublicenseRequest {
+    portalId: string;
+    putPortalSublicense: PutPortalSublicense;
+}
+/**
+ *
+ */
+export declare class PortalSublicenseApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for putPortalSublicense without sending the request
+     */
+    putPortalSublicenseRequestOpts(requestParameters: PutPortalSublicenseRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Must be called by a parent portal against one of its descendants. Field semantics: omit to leave unchanged, send `null` to clear.
+     * Manage seat limit and license window for a descendant portal
+     */
+    putPortalSublicenseRaw(requestParameters: PutPortalSublicenseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PortalSublicense>>;
+    /**
+     * Must be called by a parent portal against one of its descendants. Field semantics: omit to leave unchanged, send `null` to clear.
+     * Manage seat limit and license window for a descendant portal
+     */
+    putPortalSublicense(requestParameters: PutPortalSublicenseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PortalSublicense>;
+}

package/dist/esm/apis/PortalSublicenseApi.js

@@ -0,0 +1,75 @@
+/* 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 { PortalSublicenseFromJSON, PutPortalSublicenseToJSON, } from '../models/index';
+/**
+ *
+ */
+export class PortalSublicenseApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for putPortalSublicense without sending the request
+     */
+    putPortalSublicenseRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['portalId'] == null) {
+                throw new runtime.RequiredError('portalId', 'Required parameter "portalId" was null or undefined when calling putPortalSublicense().');
+            }
+            if (requestParameters['putPortalSublicense'] == null) {
+                throw new runtime.RequiredError('putPortalSublicense', 'Required parameter "putPortalSublicense" was null or undefined when calling putPortalSublicense().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            let urlPath = `/portals/{portalId}/sublicense`;
+            urlPath = urlPath.replace(`{${"portalId"}}`, encodeURIComponent(String(requestParameters['portalId'])));
+            return {
+                path: urlPath,
+                method: 'PUT',
+                headers: headerParameters,
+                query: queryParameters,
+                body: PutPortalSublicenseToJSON(requestParameters['putPortalSublicense']),
+            };
+        });
+    }
+    /**
+     * Must be called by a parent portal against one of its descendants. Field semantics: omit to leave unchanged, send `null` to clear.
+     * Manage seat limit and license window for a descendant portal
+     */
+    putPortalSublicenseRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.putPortalSublicenseRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => PortalSublicenseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Must be called by a parent portal against one of its descendants. Field semantics: omit to leave unchanged, send `null` to clear.
+     * Manage seat limit and license window for a descendant portal
+     */
+    putPortalSublicense(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.putPortalSublicenseRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}

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

@@ -2,9 +2,12 @@ export * from './CertificateApi';
 export * from './ChatApi';
 export * from './ContentApi';
 export * from './CourseApi';
+export * from './CourseCatalogApi';
+export * from './CourseShareApi';
 export * from './ModuleApi';
 export * from './OtherApi';
 export * from './PortalApi';
+export * from './PortalSublicenseApi';
 export * from './QuestionApi';
 export * from './QuizApi';
 export * from './ReportingApi';

package/dist/esm/apis/index.js

@@ -4,9 +4,12 @@ export * from './CertificateApi';
 export * from './ChatApi';
 export * from './ContentApi';
 export * from './CourseApi';
+export * from './CourseCatalogApi';
+export * from './CourseShareApi';
 export * from './ModuleApi';
 export * from './OtherApi';
 export * from './PortalApi';
+export * from './PortalSublicenseApi';
 export * from './QuestionApi';
 export * from './QuizApi';
 export * from './ReportingApi';

package/dist/esm/models/CourseCatalog.d.ts

@@ -0,0 +1,44 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface CourseCatalog
+ */
+export interface CourseCatalog {
+    /**
+     * External ID (UUID) of the catalog
+     * @type {string}
+     * @memberof CourseCatalog
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CourseCatalog
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CourseCatalog
+     */
+    description: string;
+}
+/**
+ * Check if a given object implements the CourseCatalog interface.
+ */
+export declare function instanceOfCourseCatalog(value: object): value is CourseCatalog;
+export declare function CourseCatalogFromJSON(json: any): CourseCatalog;
+export declare function CourseCatalogFromJSONTyped(json: any, ignoreDiscriminator: boolean): CourseCatalog;
+export declare function CourseCatalogToJSON(json: any): CourseCatalog;
+export declare function CourseCatalogToJSONTyped(value?: CourseCatalog | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CourseCatalog.js

@@ -0,0 +1,51 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the CourseCatalog interface.
+ */
+export function instanceOfCourseCatalog(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('description' in value) || value['description'] === undefined)
+        return false;
+    return true;
+}
+export function CourseCatalogFromJSON(json) {
+    return CourseCatalogFromJSONTyped(json, false);
+}
+export function CourseCatalogFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'description': json['description'],
+    };
+}
+export function CourseCatalogToJSON(json) {
+    return CourseCatalogToJSONTyped(json, false);
+}
+export function CourseCatalogToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+        'description': value['description'],
+    };
+}