@easyedu/js-lsm-api 1.51.0 → 1.52.0

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

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

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

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

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

@@ -0,0 +1,52 @@
+"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.instanceOfPutPortalSublicense = instanceOfPutPortalSublicense;
+exports.PutPortalSublicenseFromJSON = PutPortalSublicenseFromJSON;
+exports.PutPortalSublicenseFromJSONTyped = PutPortalSublicenseFromJSONTyped;
+exports.PutPortalSublicenseToJSON = PutPortalSublicenseToJSON;
+exports.PutPortalSublicenseToJSONTyped = PutPortalSublicenseToJSONTyped;
+/**
+ * Check if a given object implements the PutPortalSublicense interface.
+ */
+function instanceOfPutPortalSublicense(value) {
+    return true;
+}
+function PutPortalSublicenseFromJSON(json) {
+    return PutPortalSublicenseFromJSONTyped(json, false);
+}
+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'],
+    };
+}
+function PutPortalSublicenseToJSON(json) {
+    return PutPortalSublicenseToJSONTyped(json, false);
+}
+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/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/models/index.js

@@ -19,6 +19,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./Certificate"), exports);
 __exportStar(require("./CertificateConfig"), exports);
 __exportStar(require("./CertificatePublic"), exports);
+__exportStar(require("./CourseCatalog"), exports);
+__exportStar(require("./CourseShare"), exports);
 __exportStar(require("./CriteriaBasedSelection"), exports);
 __exportStar(require("./CriteriaBasedSelectionCriteria"), exports);
 __exportStar(require("./CriteriaBasedSelectionDistribution"), exports);
@@ -174,6 +176,7 @@ __exportStar(require("./MultipleAnswer"), exports);
 __exportStar(require("./MultipleAnswer1"), exports);
 __exportStar(require("./NoAnswer"), exports);
 __exportStar(require("./Paginated"), exports);
+__exportStar(require("./PortalSublicense"), exports);
 __exportStar(require("./PostCertificate"), exports);
 __exportStar(require("./PostCertificateConfig"), exports);
 __exportStar(require("./PostContentQuiz"), exports);
@@ -185,6 +188,7 @@ __exportStar(require("./PostContentUpload"), exports);
 __exportStar(require("./PostConversation"), exports);
 __exportStar(require("./PostConversationResponse"), exports);
 __exportStar(require("./PostCourse"), exports);
+__exportStar(require("./PostCourseCatalog"), exports);
 __exportStar(require("./PostCourseEnrollment"), exports);
 __exportStar(require("./PostCourseExport"), exports);
 __exportStar(require("./PostLogin"), exports);
@@ -192,6 +196,10 @@ __exportStar(require("./PostManualQuestionSelection"), exports);
 __exportStar(require("./PostMessage"), exports);
 __exportStar(require("./PostMessageResponse"), exports);
 __exportStar(require("./PostModule"), exports);
+__exportStar(require("./PostOfferCatalog"), exports);
+__exportStar(require("./PostOfferCatalogResponse"), exports);
+__exportStar(require("./PostOfferCourse"), exports);
+__exportStar(require("./PostOfferCourseResponse"), exports);
 __exportStar(require("./PostPortal"), exports);
 __exportStar(require("./PostPortalInvite"), exports);
 __exportStar(require("./PostQuestion"), exports);
@@ -224,10 +232,12 @@ __exportStar(require("./PutContent"), exports);
 __exportStar(require("./PutContentReorder"), exports);
 __exportStar(require("./PutContentVersion"), exports);
 __exportStar(require("./PutCourse"), exports);
+__exportStar(require("./PutCourseCatalog"), exports);
 __exportStar(require("./PutCourseEnrollment"), exports);
 __exportStar(require("./PutModule"), exports);
 __exportStar(require("./PutModuleReorder"), exports);
 __exportStar(require("./PutPortalBranding"), exports);
+__exportStar(require("./PutPortalSublicense"), exports);
 __exportStar(require("./PutQuestion"), exports);
 __exportStar(require("./PutQuestionAnswerChoicesInner"), exports);
 __exportStar(require("./PutQuiz"), exports);

package/docs/CourseCatalog.md

@@ -0,0 +1,38 @@
+
+# CourseCatalog
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`description` | string
+
+## Example
+
+```typescript
+import type { CourseCatalog } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "description": null,
+} satisfies CourseCatalog
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as CourseCatalog
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+