@easyedu/js-lsm-api 1.51.0 → 1.52.0

package/dist/esm/models/PostOfferCourse.js

@@ -0,0 +1,59 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const PostOfferCourseAllowedModeEnum = {
+    Mirror: 'mirror',
+    Clone: 'clone',
+    Either: 'either'
+};
+/**
+ * Check if a given object implements the PostOfferCourse interface.
+ */
+export function instanceOfPostOfferCourse(value) {
+    if (!('targetPortalId' in value) || value['targetPortalId'] === undefined)
+        return false;
+    if (!('allowedMode' in value) || value['allowedMode'] === undefined)
+        return false;
+    return true;
+}
+export function PostOfferCourseFromJSON(json) {
+    return PostOfferCourseFromJSONTyped(json, false);
+}
+export function PostOfferCourseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'targetPortalId': json['target_portal_id'],
+        'allowedMode': json['allowed_mode'],
+        'allowResharing': json['allow_resharing'] == null ? undefined : json['allow_resharing'],
+        'seatLimit': json['seat_limit'] == null ? undefined : json['seat_limit'],
+    };
+}
+export function PostOfferCourseToJSON(json) {
+    return PostOfferCourseToJSONTyped(json, false);
+}
+export function PostOfferCourseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'target_portal_id': value['targetPortalId'],
+        'allowed_mode': value['allowedMode'],
+        'allow_resharing': value['allowResharing'],
+        'seat_limit': value['seatLimit'],
+    };
+}

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

@@ -0,0 +1,49 @@
+/**
+ * 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 PostOfferCourseResponse
+ */
+export interface PostOfferCourseResponse {
+    /**
+     * External ID of the new course_share row
+     * @type {string}
+     * @memberof PostOfferCourseResponse
+     */
+    id: string;
+    /**
+     *
+     * @type {PostOfferCourseResponseStateEnum}
+     * @memberof PostOfferCourseResponse
+     */
+    state: PostOfferCourseResponseStateEnum;
+}
+/**
+ * @export
+ */
+export declare const PostOfferCourseResponseStateEnum: {
+    readonly Offered: "Offered";
+    readonly AcceptedMirror: "AcceptedMirror";
+    readonly AcceptedClone: "AcceptedClone";
+    readonly Declined: "Declined";
+    readonly Revoked: "Revoked";
+};
+export type PostOfferCourseResponseStateEnum = typeof PostOfferCourseResponseStateEnum[keyof typeof PostOfferCourseResponseStateEnum];
+/**
+ * Check if a given object implements the PostOfferCourseResponse interface.
+ */
+export declare function instanceOfPostOfferCourseResponse(value: object): value is PostOfferCourseResponse;
+export declare function PostOfferCourseResponseFromJSON(json: any): PostOfferCourseResponse;
+export declare function PostOfferCourseResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostOfferCourseResponse;
+export declare function PostOfferCourseResponseToJSON(json: any): PostOfferCourseResponse;
+export declare function PostOfferCourseResponseToJSONTyped(value?: PostOfferCourseResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PostOfferCourseResponse.js

@@ -0,0 +1,57 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const PostOfferCourseResponseStateEnum = {
+    Offered: 'Offered',
+    AcceptedMirror: 'AcceptedMirror',
+    AcceptedClone: 'AcceptedClone',
+    Declined: 'Declined',
+    Revoked: 'Revoked'
+};
+/**
+ * Check if a given object implements the PostOfferCourseResponse interface.
+ */
+export function instanceOfPostOfferCourseResponse(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('state' in value) || value['state'] === undefined)
+        return false;
+    return true;
+}
+export function PostOfferCourseResponseFromJSON(json) {
+    return PostOfferCourseResponseFromJSONTyped(json, false);
+}
+export function PostOfferCourseResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'state': json['state'],
+    };
+}
+export function PostOfferCourseResponseToJSON(json) {
+    return PostOfferCourseResponseToJSONTyped(json, false);
+}
+export function PostOfferCourseResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'state': value['state'],
+    };
+}

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

@@ -0,0 +1,38 @@
+/**
+ * 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 PutCourseCatalog
+ */
+export interface PutCourseCatalog {
+    /**
+     *
+     * @type {string}
+     * @memberof PutCourseCatalog
+     */
+    name?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PutCourseCatalog
+     */
+    description?: string;
+}
+/**
+ * Check if a given object implements the PutCourseCatalog interface.
+ */
+export declare function instanceOfPutCourseCatalog(value: object): value is PutCourseCatalog;
+export declare function PutCourseCatalogFromJSON(json: any): PutCourseCatalog;
+export declare function PutCourseCatalogFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutCourseCatalog;
+export declare function PutCourseCatalogToJSON(json: any): PutCourseCatalog;
+export declare function PutCourseCatalogToJSONTyped(value?: PutCourseCatalog | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PutCourseCatalog.js

@@ -0,0 +1,43 @@
+/* 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 PutCourseCatalog interface.
+ */
+export function instanceOfPutCourseCatalog(value) {
+    return true;
+}
+export function PutCourseCatalogFromJSON(json) {
+    return PutCourseCatalogFromJSONTyped(json, false);
+}
+export function PutCourseCatalogFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'name': json['name'] == null ? undefined : json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
+    };
+}
+export function PutCourseCatalogToJSON(json) {
+    return PutCourseCatalogToJSONTyped(json, false);
+}
+export function PutCourseCatalogToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+        'description': value['description'],
+    };
+}

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

@@ -0,0 +1,46 @@
+/**
+ * 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.
+ */
+/**
+ * All fields are optional. Omit a field to leave it unchanged. Send `null` to
+ * clear it (unlimited seats / no license window).
+ *
+ * @export
+ * @interface PutPortalSublicense
+ */
+export interface PutPortalSublicense {
+    /**
+     * Maximum active enrollments. null = unlimited.
+     * @type {number}
+     * @memberof PutPortalSublicense
+     */
+    seatLimit?: number | null;
+    /**
+     * Unix epoch seconds when the license becomes active. null = no start gate.
+     * @type {number}
+     * @memberof PutPortalSublicense
+     */
+    licenseStartAt?: number | null;
+    /**
+     * Unix epoch seconds when the license expires. null = never expires.
+     * @type {number}
+     * @memberof PutPortalSublicense
+     */
+    licenseEndAt?: number | null;
+}
+/**
+ * Check if a given object implements the PutPortalSublicense interface.
+ */
+export declare function instanceOfPutPortalSublicense(value: object): value is PutPortalSublicense;
+export declare function PutPortalSublicenseFromJSON(json: any): PutPortalSublicense;
+export declare function PutPortalSublicenseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutPortalSublicense;
+export declare function PutPortalSublicenseToJSON(json: any): PutPortalSublicense;
+export declare function PutPortalSublicenseToJSONTyped(value?: PutPortalSublicense | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PutPortalSublicense.js

@@ -0,0 +1,45 @@
+/* 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 PutPortalSublicense interface.
+ */
+export function instanceOfPutPortalSublicense(value) {
+    return true;
+}
+export function PutPortalSublicenseFromJSON(json) {
+    return PutPortalSublicenseFromJSONTyped(json, false);
+}
+export function PutPortalSublicenseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'seatLimit': json['seat_limit'] == null ? undefined : json['seat_limit'],
+        'licenseStartAt': json['license_start_at'] == null ? undefined : json['license_start_at'],
+        'licenseEndAt': json['license_end_at'] == null ? undefined : json['license_end_at'],
+    };
+}
+export function PutPortalSublicenseToJSON(json) {
+    return PutPortalSublicenseToJSONTyped(json, false);
+}
+export function PutPortalSublicenseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'seat_limit': value['seatLimit'],
+        'license_start_at': value['licenseStartAt'],
+        'license_end_at': value['licenseEndAt'],
+    };
+}

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

@@ -1,6 +1,8 @@
 export * from './Certificate';
 export * from './CertificateConfig';
 export * from './CertificatePublic';
+export * from './CourseCatalog';
+export * from './CourseShare';
 export * from './CriteriaBasedSelection';
 export * from './CriteriaBasedSelectionCriteria';
 export * from './CriteriaBasedSelectionDistribution';
@@ -156,6 +158,7 @@ export * from './MultipleAnswer';
 export * from './MultipleAnswer1';
 export * from './NoAnswer';
 export * from './Paginated';
+export * from './PortalSublicense';
 export * from './PostCertificate';
 export * from './PostCertificateConfig';
 export * from './PostContentQuiz';
@@ -167,6 +170,7 @@ export * from './PostContentUpload';
 export * from './PostConversation';
 export * from './PostConversationResponse';
 export * from './PostCourse';
+export * from './PostCourseCatalog';
 export * from './PostCourseEnrollment';
 export * from './PostCourseExport';
 export * from './PostLogin';
@@ -174,6 +178,10 @@ export * from './PostManualQuestionSelection';
 export * from './PostMessage';
 export * from './PostMessageResponse';
 export * from './PostModule';
+export * from './PostOfferCatalog';
+export * from './PostOfferCatalogResponse';
+export * from './PostOfferCourse';
+export * from './PostOfferCourseResponse';
 export * from './PostPortal';
 export * from './PostPortalInvite';
 export * from './PostQuestion';
@@ -206,10 +214,12 @@ export * from './PutContent';
 export * from './PutContentReorder';
 export * from './PutContentVersion';
 export * from './PutCourse';
+export * from './PutCourseCatalog';
 export * from './PutCourseEnrollment';
 export * from './PutModule';
 export * from './PutModuleReorder';
 export * from './PutPortalBranding';
+export * from './PutPortalSublicense';
 export * from './PutQuestion';
 export * from './PutQuestionAnswerChoicesInner';
 export * from './PutQuiz';

package/dist/esm/models/index.js

@@ -3,6 +3,8 @@
 export * from './Certificate';
 export * from './CertificateConfig';
 export * from './CertificatePublic';
+export * from './CourseCatalog';
+export * from './CourseShare';
 export * from './CriteriaBasedSelection';
 export * from './CriteriaBasedSelectionCriteria';
 export * from './CriteriaBasedSelectionDistribution';
@@ -158,6 +160,7 @@ export * from './MultipleAnswer';
 export * from './MultipleAnswer1';
 export * from './NoAnswer';
 export * from './Paginated';
+export * from './PortalSublicense';
 export * from './PostCertificate';
 export * from './PostCertificateConfig';
 export * from './PostContentQuiz';
@@ -169,6 +172,7 @@ export * from './PostContentUpload';
 export * from './PostConversation';
 export * from './PostConversationResponse';
 export * from './PostCourse';
+export * from './PostCourseCatalog';
 export * from './PostCourseEnrollment';
 export * from './PostCourseExport';
 export * from './PostLogin';
@@ -176,6 +180,10 @@ export * from './PostManualQuestionSelection';
 export * from './PostMessage';
 export * from './PostMessageResponse';
 export * from './PostModule';
+export * from './PostOfferCatalog';
+export * from './PostOfferCatalogResponse';
+export * from './PostOfferCourse';
+export * from './PostOfferCourseResponse';
 export * from './PostPortal';
 export * from './PostPortalInvite';
 export * from './PostQuestion';
@@ -208,10 +216,12 @@ export * from './PutContent';
 export * from './PutContentReorder';
 export * from './PutContentVersion';
 export * from './PutCourse';
+export * from './PutCourseCatalog';
 export * from './PutCourseEnrollment';
 export * from './PutModule';
 export * from './PutModuleReorder';
 export * from './PutPortalBranding';
+export * from './PutPortalSublicense';
 export * from './PutQuestion';
 export * from './PutQuestionAnswerChoicesInner';
 export * from './PutQuiz';

package/dist/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/models/CourseCatalog.js

@@ -0,0 +1,58 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfCourseCatalog = instanceOfCourseCatalog;
+exports.CourseCatalogFromJSON = CourseCatalogFromJSON;
+exports.CourseCatalogFromJSONTyped = CourseCatalogFromJSONTyped;
+exports.CourseCatalogToJSON = CourseCatalogToJSON;
+exports.CourseCatalogToJSONTyped = CourseCatalogToJSONTyped;
+/**
+ * Check if a given object implements the CourseCatalog interface.
+ */
+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;
+}
+function CourseCatalogFromJSON(json) {
+    return CourseCatalogFromJSONTyped(json, false);
+}
+function CourseCatalogFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'description': json['description'],
+    };
+}
+function CourseCatalogToJSON(json) {
+    return CourseCatalogToJSONTyped(json, false);
+}
+function CourseCatalogToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+        'description': value['description'],
+    };
+}

package/dist/models/CourseShare.d.ts

@@ -0,0 +1,88 @@
+/**
+ * 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 CourseShare
+ */
+export interface CourseShare {
+    /**
+     * External ID (UUID) of the share
+     * @type {string}
+     * @memberof CourseShare
+     */
+    id: string;
+    /**
+     * Internal ID of the offering portal
+     * @type {number}
+     * @memberof CourseShare
+     */
+    sourcePortalId: number;
+    /**
+     * Internal ID of the receiving portal
+     * @type {number}
+     * @memberof CourseShare
+     */
+    targetPortalId: number;
+    /**
+     * Internal ID of the offered course
+     * @type {number}
+     * @memberof CourseShare
+     */
+    courseId: number;
+    /**
+     *
+     * @type {CourseShareAllowedModeEnum}
+     * @memberof CourseShare
+     */
+    allowedMode: CourseShareAllowedModeEnum;
+    /**
+     *
+     * @type {CourseShareStateEnum}
+     * @memberof CourseShare
+     */
+    state: CourseShareStateEnum;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CourseShare
+     */
+    allowResharing: boolean;
+}
+/**
+ * @export
+ */
+export declare const CourseShareAllowedModeEnum: {
+    readonly Mirror: "Mirror";
+    readonly Clone: "Clone";
+    readonly Either: "Either";
+};
+export type CourseShareAllowedModeEnum = typeof CourseShareAllowedModeEnum[keyof typeof CourseShareAllowedModeEnum];
+/**
+ * @export
+ */
+export declare const CourseShareStateEnum: {
+    readonly Offered: "Offered";
+    readonly AcceptedMirror: "AcceptedMirror";
+    readonly AcceptedClone: "AcceptedClone";
+    readonly Declined: "Declined";
+    readonly Revoked: "Revoked";
+};
+export type CourseShareStateEnum = typeof CourseShareStateEnum[keyof typeof CourseShareStateEnum];
+/**
+ * Check if a given object implements the CourseShare interface.
+ */
+export declare function instanceOfCourseShare(value: object): value is CourseShare;
+export declare function CourseShareFromJSON(json: any): CourseShare;
+export declare function CourseShareFromJSONTyped(json: any, ignoreDiscriminator: boolean): CourseShare;
+export declare function CourseShareToJSON(json: any): CourseShare;
+export declare function CourseShareToJSONTyped(value?: CourseShare | null, ignoreDiscriminator?: boolean): any;