@easyedu/js-lsm-api 1.50.0 → 1.52.0

package/src/apis/CourseShareApi.ts

@@ -0,0 +1,480 @@
+/* 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.
+ */
+
+
+import * as runtime from '../runtime';
+import type {
+  CourseShare,
+  PostOfferCatalog,
+  PostOfferCatalogResponse,
+  PostOfferCourse,
+  PostOfferCourseResponse,
+} from '../models/index';
+import {
+    CourseShareFromJSON,
+    CourseShareToJSON,
+    PostOfferCatalogFromJSON,
+    PostOfferCatalogToJSON,
+    PostOfferCatalogResponseFromJSON,
+    PostOfferCatalogResponseToJSON,
+    PostOfferCourseFromJSON,
+    PostOfferCourseToJSON,
+    PostOfferCourseResponseFromJSON,
+    PostOfferCourseResponseToJSON,
+} 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 class CourseShareApi extends runtime.BaseAPI {
+
+    /**
+     * Creates request options for deleteCourseShare without sending the request
+     */
+    async deleteCourseShareRequestOpts(requestParameters: DeleteCourseShareRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['shareId'] == null) {
+            throw new runtime.RequiredError(
+                'shareId',
+                'Required parameter "shareId" was null or undefined when calling deleteCourseShare().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        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
+     */
+    async deleteCourseShareRaw(requestParameters: DeleteCourseShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.deleteCourseShareRequestOpts(requestParameters);
+        const response = await 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
+     */
+    async deleteCourseShare(requestParameters: DeleteCourseShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteCourseShareRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates request options for getCourseSharesOfferedByMe without sending the request
+     */
+    async getCourseSharesOfferedByMeRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/course-shares/offered-by-me`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * List shares the current portal has offered out
+     */
+    async getCourseSharesOfferedByMeRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CourseShare>>> {
+        const requestOptions = await this.getCourseSharesOfferedByMeRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(CourseShareFromJSON));
+    }
+
+    /**
+     * List shares the current portal has offered out
+     */
+    async getCourseSharesOfferedByMe(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CourseShare>> {
+        const response = await this.getCourseSharesOfferedByMeRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getCourseSharesOfferedToMe without sending the request
+     */
+    async getCourseSharesOfferedToMeRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/course-shares/offered-to-me`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * List shares offered to the current portal
+     */
+    async getCourseSharesOfferedToMeRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CourseShare>>> {
+        const requestOptions = await this.getCourseSharesOfferedToMeRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(CourseShareFromJSON));
+    }
+
+    /**
+     * List shares offered to the current portal
+     */
+    async getCourseSharesOfferedToMe(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CourseShare>> {
+        const response = await this.getCourseSharesOfferedToMeRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for postOfferCatalog without sending the request
+     */
+    async postOfferCatalogRequestOpts(requestParameters: PostOfferCatalogRequest): Promise<runtime.RequestOpts> {
+        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: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        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
+     */
+    async postOfferCatalogRaw(requestParameters: PostOfferCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostOfferCatalogResponse>> {
+        const requestOptions = await this.postOfferCatalogRequestOpts(requestParameters);
+        const response = await 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
+     */
+    async postOfferCatalog(requestParameters: PostOfferCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostOfferCatalogResponse> {
+        const response = await this.postOfferCatalogRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for postOfferCourse without sending the request
+     */
+    async postOfferCourseRequestOpts(requestParameters: PostOfferCourseRequest): Promise<runtime.RequestOpts> {
+        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: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        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
+     */
+    async postOfferCourseRaw(requestParameters: PostOfferCourseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostOfferCourseResponse>> {
+        const requestOptions = await this.postOfferCourseRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PostOfferCourseResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Offer a single course to a descendant portal
+     */
+    async postOfferCourse(requestParameters: PostOfferCourseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostOfferCourseResponse> {
+        const response = await this.postOfferCourseRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for postUnrevokeShare without sending the request
+     */
+    async postUnrevokeShareRequestOpts(requestParameters: PostUnrevokeShareRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['shareId'] == null) {
+            throw new runtime.RequiredError(
+                'shareId',
+                'Required parameter "shareId" was null or undefined when calling postUnrevokeShare().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        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
+     */
+    async postUnrevokeShareRaw(requestParameters: PostUnrevokeShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.postUnrevokeShareRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Restore a previously revoked share
+     */
+    async postUnrevokeShare(requestParameters: PostUnrevokeShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.postUnrevokeShareRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates request options for putAcceptClone without sending the request
+     */
+    async putAcceptCloneRequestOpts(requestParameters: PutAcceptCloneRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['shareId'] == null) {
+            throw new runtime.RequiredError(
+                'shareId',
+                'Required parameter "shareId" was null or undefined when calling putAcceptClone().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        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)
+     */
+    async putAcceptCloneRaw(requestParameters: PutAcceptCloneRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.putAcceptCloneRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Accept an offer as a clone (deep copy into your portal)
+     */
+    async putAcceptClone(requestParameters: PutAcceptCloneRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.putAcceptCloneRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates request options for putAcceptMirror without sending the request
+     */
+    async putAcceptMirrorRequestOpts(requestParameters: PutAcceptMirrorRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['shareId'] == null) {
+            throw new runtime.RequiredError(
+                'shareId',
+                'Required parameter "shareId" was null or undefined when calling putAcceptMirror().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        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)
+     */
+    async putAcceptMirrorRaw(requestParameters: PutAcceptMirrorRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.putAcceptMirrorRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Accept an offer as a mirror (no copy, live link to source)
+     */
+    async putAcceptMirror(requestParameters: PutAcceptMirrorRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.putAcceptMirrorRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates request options for putDeclineShare without sending the request
+     */
+    async putDeclineShareRequestOpts(requestParameters: PutDeclineShareRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['shareId'] == null) {
+            throw new runtime.RequiredError(
+                'shareId',
+                'Required parameter "shareId" was null or undefined when calling putDeclineShare().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        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
+     */
+    async putDeclineShareRaw(requestParameters: PutDeclineShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.putDeclineShareRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Decline an offer
+     */
+    async putDeclineShare(requestParameters: PutDeclineShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.putDeclineShareRaw(requestParameters, initOverrides);
+    }
+
+}

package/src/apis/PortalSublicenseApi.ts

@@ -0,0 +1,95 @@
+/* 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.
+ */
+
+
+import * as runtime from '../runtime';
+import type {
+  PortalSublicense,
+  PutPortalSublicense,
+} from '../models/index';
+import {
+    PortalSublicenseFromJSON,
+    PortalSublicenseToJSON,
+    PutPortalSublicenseFromJSON,
+    PutPortalSublicenseToJSON,
+} from '../models/index';
+
+export interface PutPortalSublicenseRequest {
+    portalId: string;
+    putPortalSublicense: PutPortalSublicense;
+}
+
+/**
+ * 
+ */
+export class PortalSublicenseApi extends runtime.BaseAPI {
+
+    /**
+     * Creates request options for putPortalSublicense without sending the request
+     */
+    async putPortalSublicenseRequestOpts(requestParameters: PutPortalSublicenseRequest): Promise<runtime.RequestOpts> {
+        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: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        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
+     */
+    async putPortalSublicenseRaw(requestParameters: PutPortalSublicenseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PortalSublicense>> {
+        const requestOptions = await this.putPortalSublicenseRequestOpts(requestParameters);
+        const response = await 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
+     */
+    async putPortalSublicense(requestParameters: PutPortalSublicenseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PortalSublicense> {
+        const response = await this.putPortalSublicenseRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/index.ts

@@ -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/src/models/CourseCatalog.ts

@@ -0,0 +1,84 @@
+/* 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.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @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 function instanceOfCourseCatalog(value: object): value is CourseCatalog {
+    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: any): CourseCatalog {
+    return CourseCatalogFromJSONTyped(json, false);
+}
+
+export function CourseCatalogFromJSONTyped(json: any, ignoreDiscriminator: boolean): CourseCatalog {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'name': json['name'],
+        'description': json['description'],
+    };
+}
+
+export function CourseCatalogToJSON(json: any): CourseCatalog {
+    return CourseCatalogToJSONTyped(json, false);
+}
+
+export function CourseCatalogToJSONTyped(value?: CourseCatalog | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'name': value['name'],
+        'description': value['description'],
+    };
+}
+