@easyedu/js-lsm-api 1.26.0 → 1.28.0

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

@@ -0,0 +1,76 @@
+/**
+ * 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 type { GetContentVersionSandbox } from './GetContentVersionSandbox';
+import type { GetContentVersionScormData } from './GetContentVersionScormData';
+/**
+ * Details of a specific content version
+ * @export
+ * @interface GetContentVersion
+ */
+export interface GetContentVersion {
+    /**
+     * The external_id (UUID) for this version
+     * @type {string}
+     * @memberof GetContentVersion
+     */
+    id: string;
+    /**
+     * The content's external_id that this version belongs to
+     * @type {string}
+     * @memberof GetContentVersion
+     */
+    contentId: string;
+    /**
+     * Version number
+     * @type {number}
+     * @memberof GetContentVersion
+     */
+    version: number;
+    /**
+     * Whether this is the currently active version
+     * @type {boolean}
+     * @memberof GetContentVersion
+     */
+    isActive: boolean;
+    /**
+     * When this version was created
+     * @type {Date}
+     * @memberof GetContentVersion
+     */
+    createdAt: Date;
+    /**
+     * When this version was last updated
+     * @type {Date}
+     * @memberof GetContentVersion
+     */
+    updatedAt: Date;
+    /**
+     *
+     * @type {GetContentVersionSandbox}
+     * @memberof GetContentVersion
+     */
+    sandbox: GetContentVersionSandbox;
+    /**
+     *
+     * @type {GetContentVersionScormData}
+     * @memberof GetContentVersion
+     */
+    scormData?: GetContentVersionScormData | null;
+}
+/**
+ * Check if a given object implements the GetContentVersion interface.
+ */
+export declare function instanceOfGetContentVersion(value: object): value is GetContentVersion;
+export declare function GetContentVersionFromJSON(json: any): GetContentVersion;
+export declare function GetContentVersionFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetContentVersion;
+export declare function GetContentVersionToJSON(json: any): GetContentVersion;
+export declare function GetContentVersionToJSONTyped(value?: GetContentVersion | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetContentVersion.js

@@ -0,0 +1,71 @@
+/* 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 { GetContentVersionSandboxFromJSON, GetContentVersionSandboxToJSON, } from './GetContentVersionSandbox';
+import { GetContentVersionScormDataFromJSON, GetContentVersionScormDataToJSON, } from './GetContentVersionScormData';
+/**
+ * Check if a given object implements the GetContentVersion interface.
+ */
+export function instanceOfGetContentVersion(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('contentId' in value) || value['contentId'] === undefined)
+        return false;
+    if (!('version' in value) || value['version'] === undefined)
+        return false;
+    if (!('isActive' in value) || value['isActive'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined)
+        return false;
+    if (!('sandbox' in value) || value['sandbox'] === undefined)
+        return false;
+    return true;
+}
+export function GetContentVersionFromJSON(json) {
+    return GetContentVersionFromJSONTyped(json, false);
+}
+export function GetContentVersionFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'contentId': json['content_id'],
+        'version': json['version'],
+        'isActive': json['is_active'],
+        'createdAt': (new Date(json['created_at'])),
+        'updatedAt': (new Date(json['updated_at'])),
+        'sandbox': GetContentVersionSandboxFromJSON(json['sandbox']),
+        'scormData': json['scorm_data'] == null ? undefined : GetContentVersionScormDataFromJSON(json['scorm_data']),
+    };
+}
+export function GetContentVersionToJSON(json) {
+    return GetContentVersionToJSONTyped(json, false);
+}
+export function GetContentVersionToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'content_id': value['contentId'],
+        'version': value['version'],
+        'is_active': value['isActive'],
+        'created_at': ((value['createdAt']).toISOString()),
+        'updated_at': ((value['updatedAt']).toISOString()),
+        'sandbox': GetContentVersionSandboxToJSON(value['sandbox']),
+        'scorm_data': GetContentVersionScormDataToJSON(value['scormData']),
+    };
+}

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

@@ -0,0 +1,57 @@
+/**
+ * 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 type { GetContentVersionListItemsInner } from './GetContentVersionListItemsInner';
+/**
+ * A paginated list of content versions
+ * @export
+ * @interface GetContentVersionList
+ */
+export interface GetContentVersionList {
+    /**
+     * The current page number
+     * @type {number}
+     * @memberof GetContentVersionList
+     */
+    page: number;
+    /**
+     * The number of items per page
+     * @type {number}
+     * @memberof GetContentVersionList
+     */
+    pageSize: number;
+    /**
+     * The total number of pages
+     * @type {number}
+     * @memberof GetContentVersionList
+     */
+    totalPages: number;
+    /**
+     * The total number of versions
+     * @type {number}
+     * @memberof GetContentVersionList
+     */
+    totalItems: number;
+    /**
+     * List of content versions
+     * @type {Array<GetContentVersionListItemsInner>}
+     * @memberof GetContentVersionList
+     */
+    items: Array<GetContentVersionListItemsInner>;
+}
+/**
+ * Check if a given object implements the GetContentVersionList interface.
+ */
+export declare function instanceOfGetContentVersionList(value: object): value is GetContentVersionList;
+export declare function GetContentVersionListFromJSON(json: any): GetContentVersionList;
+export declare function GetContentVersionListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetContentVersionList;
+export declare function GetContentVersionListToJSON(json: any): GetContentVersionList;
+export declare function GetContentVersionListToJSONTyped(value?: GetContentVersionList | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetContentVersionList.js

@@ -0,0 +1,60 @@
+/* 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 { GetContentVersionListItemsInnerFromJSON, GetContentVersionListItemsInnerToJSON, } from './GetContentVersionListItemsInner';
+/**
+ * Check if a given object implements the GetContentVersionList interface.
+ */
+export function instanceOfGetContentVersionList(value) {
+    if (!('page' in value) || value['page'] === undefined)
+        return false;
+    if (!('pageSize' in value) || value['pageSize'] === undefined)
+        return false;
+    if (!('totalPages' in value) || value['totalPages'] === undefined)
+        return false;
+    if (!('totalItems' in value) || value['totalItems'] === undefined)
+        return false;
+    if (!('items' in value) || value['items'] === undefined)
+        return false;
+    return true;
+}
+export function GetContentVersionListFromJSON(json) {
+    return GetContentVersionListFromJSONTyped(json, false);
+}
+export function GetContentVersionListFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'page': json['page'],
+        'pageSize': json['page_size'],
+        'totalPages': json['total_pages'],
+        'totalItems': json['total_items'],
+        'items': (json['items'].map(GetContentVersionListItemsInnerFromJSON)),
+    };
+}
+export function GetContentVersionListToJSON(json) {
+    return GetContentVersionListToJSONTyped(json, false);
+}
+export function GetContentVersionListToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'page': value['page'],
+        'page_size': value['pageSize'],
+        'total_pages': value['totalPages'],
+        'total_items': value['totalItems'],
+        'items': (value['items'].map(GetContentVersionListItemsInnerToJSON)),
+    };
+}

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

@@ -0,0 +1,56 @@
+/**
+ * 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 GetContentVersionListItemsInner
+ */
+export interface GetContentVersionListItemsInner {
+    /**
+     * The external_id (UUID) for this version
+     * @type {string}
+     * @memberof GetContentVersionListItemsInner
+     */
+    id: string;
+    /**
+     * Version number
+     * @type {number}
+     * @memberof GetContentVersionListItemsInner
+     */
+    version: number;
+    /**
+     * Whether this is the currently active version
+     * @type {boolean}
+     * @memberof GetContentVersionListItemsInner
+     */
+    isActive: boolean;
+    /**
+     * When this version was created
+     * @type {Date}
+     * @memberof GetContentVersionListItemsInner
+     */
+    createdAt: Date;
+    /**
+     * When this version was last updated
+     * @type {Date}
+     * @memberof GetContentVersionListItemsInner
+     */
+    updatedAt: Date;
+}
+/**
+ * Check if a given object implements the GetContentVersionListItemsInner interface.
+ */
+export declare function instanceOfGetContentVersionListItemsInner(value: object): value is GetContentVersionListItemsInner;
+export declare function GetContentVersionListItemsInnerFromJSON(json: any): GetContentVersionListItemsInner;
+export declare function GetContentVersionListItemsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetContentVersionListItemsInner;
+export declare function GetContentVersionListItemsInnerToJSON(json: any): GetContentVersionListItemsInner;
+export declare function GetContentVersionListItemsInnerToJSONTyped(value?: GetContentVersionListItemsInner | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetContentVersionListItemsInner.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.
+ */
+/**
+ * Check if a given object implements the GetContentVersionListItemsInner interface.
+ */
+export function instanceOfGetContentVersionListItemsInner(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('version' in value) || value['version'] === undefined)
+        return false;
+    if (!('isActive' in value) || value['isActive'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined)
+        return false;
+    return true;
+}
+export function GetContentVersionListItemsInnerFromJSON(json) {
+    return GetContentVersionListItemsInnerFromJSONTyped(json, false);
+}
+export function GetContentVersionListItemsInnerFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'version': json['version'],
+        'isActive': json['is_active'],
+        'createdAt': (new Date(json['created_at'])),
+        'updatedAt': (new Date(json['updated_at'])),
+    };
+}
+export function GetContentVersionListItemsInnerToJSON(json) {
+    return GetContentVersionListItemsInnerToJSONTyped(json, false);
+}
+export function GetContentVersionListItemsInnerToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'version': value['version'],
+        'is_active': value['isActive'],
+        'created_at': ((value['createdAt']).toISOString()),
+        'updated_at': ((value['updatedAt']).toISOString()),
+    };
+}

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

@@ -0,0 +1,32 @@
+/**
+ * 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.
+ */
+/**
+ * Sandbox data for this version
+ * @export
+ * @interface GetContentVersionSandbox
+ */
+export interface GetContentVersionSandbox {
+    /**
+     * URL to launch the content in sandbox mode
+     * @type {string}
+     * @memberof GetContentVersionSandbox
+     */
+    launchUrl: string;
+}
+/**
+ * Check if a given object implements the GetContentVersionSandbox interface.
+ */
+export declare function instanceOfGetContentVersionSandbox(value: object): value is GetContentVersionSandbox;
+export declare function GetContentVersionSandboxFromJSON(json: any): GetContentVersionSandbox;
+export declare function GetContentVersionSandboxFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetContentVersionSandbox;
+export declare function GetContentVersionSandboxToJSON(json: any): GetContentVersionSandbox;
+export declare function GetContentVersionSandboxToJSONTyped(value?: GetContentVersionSandbox | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetContentVersionSandbox.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 GetContentVersionSandbox interface.
+ */
+export function instanceOfGetContentVersionSandbox(value) {
+    if (!('launchUrl' in value) || value['launchUrl'] === undefined)
+        return false;
+    return true;
+}
+export function GetContentVersionSandboxFromJSON(json) {
+    return GetContentVersionSandboxFromJSONTyped(json, false);
+}
+export function GetContentVersionSandboxFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'launchUrl': json['launch_url'],
+    };
+}
+export function GetContentVersionSandboxToJSON(json) {
+    return GetContentVersionSandboxToJSONTyped(json, false);
+}
+export function GetContentVersionSandboxToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'launch_url': value['launchUrl'],
+    };
+}

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

@@ -0,0 +1,32 @@
+/**
+ * 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.
+ */
+/**
+ * SCORM-specific data (only present for SCORM content type)
+ * @export
+ * @interface GetContentVersionScormData
+ */
+export interface GetContentVersionScormData {
+    /**
+     * The external_id (UUID) of the scorm_content record
+     * @type {string}
+     * @memberof GetContentVersionScormData
+     */
+    scormPackageId: string;
+}
+/**
+ * Check if a given object implements the GetContentVersionScormData interface.
+ */
+export declare function instanceOfGetContentVersionScormData(value: object): value is GetContentVersionScormData;
+export declare function GetContentVersionScormDataFromJSON(json: any): GetContentVersionScormData;
+export declare function GetContentVersionScormDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetContentVersionScormData;
+export declare function GetContentVersionScormDataToJSON(json: any): GetContentVersionScormData;
+export declare function GetContentVersionScormDataToJSONTyped(value?: GetContentVersionScormData | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetContentVersionScormData.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 GetContentVersionScormData interface.
+ */
+export function instanceOfGetContentVersionScormData(value) {
+    if (!('scormPackageId' in value) || value['scormPackageId'] === undefined)
+        return false;
+    return true;
+}
+export function GetContentVersionScormDataFromJSON(json) {
+    return GetContentVersionScormDataFromJSONTyped(json, false);
+}
+export function GetContentVersionScormDataFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'scormPackageId': json['scorm_package_id'],
+    };
+}
+export function GetContentVersionScormDataToJSON(json) {
+    return GetContentVersionScormDataToJSONTyped(json, false);
+}
+export function GetContentVersionScormDataToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'scorm_package_id': value['scormPackageId'],
+    };
+}

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

@@ -0,0 +1,39 @@
+/**
+ * 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 type { GetScormPackagePackageInfo } from './GetScormPackagePackageInfo';
+/**
+ * Details of a SCORM package
+ * @export
+ * @interface GetScormPackage
+ */
+export interface GetScormPackage {
+    /**
+     *
+     * @type {GetScormPackagePackageInfo}
+     * @memberof GetScormPackage
+     */
+    packageInfo: GetScormPackagePackageInfo;
+    /**
+     * Hierarchical table of contents from the SCORM manifest (flexible JSON structure)
+     * @type {object}
+     * @memberof GetScormPackage
+     */
+    tableOfContents: object;
+}
+/**
+ * Check if a given object implements the GetScormPackage interface.
+ */
+export declare function instanceOfGetScormPackage(value: object): value is GetScormPackage;
+export declare function GetScormPackageFromJSON(json: any): GetScormPackage;
+export declare function GetScormPackageFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetScormPackage;
+export declare function GetScormPackageToJSON(json: any): GetScormPackage;
+export declare function GetScormPackageToJSONTyped(value?: GetScormPackage | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetScormPackage.js

@@ -0,0 +1,48 @@
+/* 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 { GetScormPackagePackageInfoFromJSON, GetScormPackagePackageInfoToJSON, } from './GetScormPackagePackageInfo';
+/**
+ * Check if a given object implements the GetScormPackage interface.
+ */
+export function instanceOfGetScormPackage(value) {
+    if (!('packageInfo' in value) || value['packageInfo'] === undefined)
+        return false;
+    if (!('tableOfContents' in value) || value['tableOfContents'] === undefined)
+        return false;
+    return true;
+}
+export function GetScormPackageFromJSON(json) {
+    return GetScormPackageFromJSONTyped(json, false);
+}
+export function GetScormPackageFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'packageInfo': GetScormPackagePackageInfoFromJSON(json['package_info']),
+        'tableOfContents': json['table_of_contents'],
+    };
+}
+export function GetScormPackageToJSON(json) {
+    return GetScormPackageToJSONTyped(json, false);
+}
+export function GetScormPackageToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'package_info': GetScormPackagePackageInfoToJSON(value['packageInfo']),
+        'table_of_contents': value['tableOfContents'],
+    };
+}