@easyedu/js-lsm-api 1.83.0 → 1.85.0

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

@@ -0,0 +1,124 @@
+/**
+ * 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 { ResourceType } from './ResourceType';
+import type { ContentLaunchMode } from './ContentLaunchMode';
+/**
+ * A learner resource attempt pinned to an immutable course and Content Library version.
+ * @export
+ * @interface GetCourseVersionItemSession
+ */
+export interface GetCourseVersionItemSession {
+    /**
+     *
+     * @type {string}
+     * @memberof GetCourseVersionItemSession
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetCourseVersionItemSession
+     */
+    courseVersionId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetCourseVersionItemSession
+     */
+    itemId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetCourseVersionItemSession
+     */
+    contentLibraryItemId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetCourseVersionItemSession
+     */
+    contentLibraryVersionId: string;
+    /**
+     *
+     * @type {ResourceType}
+     * @memberof GetCourseVersionItemSession
+     */
+    resourceType: ResourceType;
+    /**
+     *
+     * @type {ContentLaunchMode}
+     * @memberof GetCourseVersionItemSession
+     */
+    launchMode: ContentLaunchMode;
+    /**
+     * Session-aware player URL, direct asset URL, or external link.
+     * @type {string}
+     * @memberof GetCourseVersionItemSession
+     */
+    launchUrl: string | null;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersionItemSession
+     */
+    attemptNumber: number;
+    /**
+     *
+     * @type {boolean}
+     * @memberof GetCourseVersionItemSession
+     */
+    isCurrent: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof GetCourseVersionItemSession
+     */
+    completionStatus: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetCourseVersionItemSession
+     */
+    gradeStatus: string;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersionItemSession
+     */
+    scoreRaw?: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersionItemSession
+     */
+    createdAt: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersionItemSession
+     */
+    updatedAt: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersionItemSession
+     */
+    completedAt?: number | null;
+}
+/**
+ * Check if a given object implements the GetCourseVersionItemSession interface.
+ */
+export declare function instanceOfGetCourseVersionItemSession(value: object): value is GetCourseVersionItemSession;
+export declare function GetCourseVersionItemSessionFromJSON(json: any): GetCourseVersionItemSession;
+export declare function GetCourseVersionItemSessionFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseVersionItemSession;
+export declare function GetCourseVersionItemSessionToJSON(json: any): GetCourseVersionItemSession;
+export declare function GetCourseVersionItemSessionToJSONTyped(value?: GetCourseVersionItemSession | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetCourseVersionItemSession.js

@@ -0,0 +1,101 @@
+/* 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 { ResourceTypeFromJSON, ResourceTypeToJSON, } from './ResourceType';
+import { ContentLaunchModeFromJSON, ContentLaunchModeToJSON, } from './ContentLaunchMode';
+/**
+ * Check if a given object implements the GetCourseVersionItemSession interface.
+ */
+export function instanceOfGetCourseVersionItemSession(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('courseVersionId' in value) || value['courseVersionId'] === undefined)
+        return false;
+    if (!('itemId' in value) || value['itemId'] === undefined)
+        return false;
+    if (!('contentLibraryItemId' in value) || value['contentLibraryItemId'] === undefined)
+        return false;
+    if (!('contentLibraryVersionId' in value) || value['contentLibraryVersionId'] === undefined)
+        return false;
+    if (!('resourceType' in value) || value['resourceType'] === undefined)
+        return false;
+    if (!('launchMode' in value) || value['launchMode'] === undefined)
+        return false;
+    if (!('launchUrl' in value) || value['launchUrl'] === undefined)
+        return false;
+    if (!('attemptNumber' in value) || value['attemptNumber'] === undefined)
+        return false;
+    if (!('isCurrent' in value) || value['isCurrent'] === undefined)
+        return false;
+    if (!('completionStatus' in value) || value['completionStatus'] === undefined)
+        return false;
+    if (!('gradeStatus' in value) || value['gradeStatus'] === 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 GetCourseVersionItemSessionFromJSON(json) {
+    return GetCourseVersionItemSessionFromJSONTyped(json, false);
+}
+export function GetCourseVersionItemSessionFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'courseVersionId': json['course_version_id'],
+        'itemId': json['item_id'],
+        'contentLibraryItemId': json['content_library_item_id'],
+        'contentLibraryVersionId': json['content_library_version_id'],
+        'resourceType': ResourceTypeFromJSON(json['resource_type']),
+        'launchMode': ContentLaunchModeFromJSON(json['launch_mode']),
+        'launchUrl': json['launch_url'],
+        'attemptNumber': json['attempt_number'],
+        'isCurrent': json['is_current'],
+        'completionStatus': json['completion_status'],
+        'gradeStatus': json['grade_status'],
+        'scoreRaw': json['score_raw'] == null ? undefined : json['score_raw'],
+        'createdAt': json['created_at'],
+        'updatedAt': json['updated_at'],
+        'completedAt': json['completed_at'] == null ? undefined : json['completed_at'],
+    };
+}
+export function GetCourseVersionItemSessionToJSON(json) {
+    return GetCourseVersionItemSessionToJSONTyped(json, false);
+}
+export function GetCourseVersionItemSessionToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'course_version_id': value['courseVersionId'],
+        'item_id': value['itemId'],
+        'content_library_item_id': value['contentLibraryItemId'],
+        'content_library_version_id': value['contentLibraryVersionId'],
+        'resource_type': ResourceTypeToJSON(value['resourceType']),
+        'launch_mode': ContentLaunchModeToJSON(value['launchMode']),
+        'launch_url': value['launchUrl'],
+        'attempt_number': value['attemptNumber'],
+        'is_current': value['isCurrent'],
+        'completion_status': value['completionStatus'],
+        'grade_status': value['gradeStatus'],
+        'score_raw': value['scoreRaw'],
+        'created_at': value['createdAt'],
+        'updated_at': value['updatedAt'],
+        'completed_at': value['completedAt'],
+    };
+}

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

@@ -0,0 +1,33 @@
+/**
+ * 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 { GetCourseVersion } from './GetCourseVersion';
+/**
+ *
+ * @export
+ * @interface GetCourseVersionList
+ */
+export interface GetCourseVersionList {
+    /**
+     *
+     * @type {Array<GetCourseVersion>}
+     * @memberof GetCourseVersionList
+     */
+    items: Array<GetCourseVersion>;
+}
+/**
+ * Check if a given object implements the GetCourseVersionList interface.
+ */
+export declare function instanceOfGetCourseVersionList(value: object): value is GetCourseVersionList;
+export declare function GetCourseVersionListFromJSON(json: any): GetCourseVersionList;
+export declare function GetCourseVersionListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseVersionList;
+export declare function GetCourseVersionListToJSON(json: any): GetCourseVersionList;
+export declare function GetCourseVersionListToJSONTyped(value?: GetCourseVersionList | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetCourseVersionList.js

@@ -0,0 +1,44 @@
+/* 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 { GetCourseVersionFromJSON, GetCourseVersionToJSON, } from './GetCourseVersion';
+/**
+ * Check if a given object implements the GetCourseVersionList interface.
+ */
+export function instanceOfGetCourseVersionList(value) {
+    if (!('items' in value) || value['items'] === undefined)
+        return false;
+    return true;
+}
+export function GetCourseVersionListFromJSON(json) {
+    return GetCourseVersionListFromJSONTyped(json, false);
+}
+export function GetCourseVersionListFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'items': (json['items'].map(GetCourseVersionFromJSON)),
+    };
+}
+export function GetCourseVersionListToJSON(json) {
+    return GetCourseVersionListToJSONTyped(json, false);
+}
+export function GetCourseVersionListToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'items': (value['items'].map(GetCourseVersionToJSON)),
+    };
+}

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

@@ -0,0 +1,64 @@
+/**
+ * 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 { GetCourseVersionItem } from './GetCourseVersionItem';
+import type { RichTextDocument } from './RichTextDocument';
+/**
+ *
+ * @export
+ * @interface GetCourseVersionModule
+ */
+export interface GetCourseVersionModule {
+    /**
+     *
+     * @type {string}
+     * @memberof GetCourseVersionModule
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetCourseVersionModule
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetCourseVersionModule
+     */
+    description: string;
+    /**
+     *
+     * @type {RichTextDocument}
+     * @memberof GetCourseVersionModule
+     */
+    descriptionRich: RichTextDocument;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersionModule
+     */
+    displayOrder: number;
+    /**
+     *
+     * @type {Array<GetCourseVersionItem>}
+     * @memberof GetCourseVersionModule
+     */
+    items: Array<GetCourseVersionItem>;
+}
+/**
+ * Check if a given object implements the GetCourseVersionModule interface.
+ */
+export declare function instanceOfGetCourseVersionModule(value: object): value is GetCourseVersionModule;
+export declare function GetCourseVersionModuleFromJSON(json: any): GetCourseVersionModule;
+export declare function GetCourseVersionModuleFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseVersionModule;
+export declare function GetCourseVersionModuleToJSON(json: any): GetCourseVersionModule;
+export declare function GetCourseVersionModuleToJSONTyped(value?: GetCourseVersionModule | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetCourseVersionModule.js

@@ -0,0 +1,65 @@
+/* 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 { GetCourseVersionItemFromJSON, GetCourseVersionItemToJSON, } from './GetCourseVersionItem';
+import { RichTextDocumentFromJSON, RichTextDocumentToJSON, } from './RichTextDocument';
+/**
+ * Check if a given object implements the GetCourseVersionModule interface.
+ */
+export function instanceOfGetCourseVersionModule(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;
+    if (!('descriptionRich' in value) || value['descriptionRich'] === undefined)
+        return false;
+    if (!('displayOrder' in value) || value['displayOrder'] === undefined)
+        return false;
+    if (!('items' in value) || value['items'] === undefined)
+        return false;
+    return true;
+}
+export function GetCourseVersionModuleFromJSON(json) {
+    return GetCourseVersionModuleFromJSONTyped(json, false);
+}
+export function GetCourseVersionModuleFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'description': json['description'],
+        'descriptionRich': RichTextDocumentFromJSON(json['description_rich']),
+        'displayOrder': json['display_order'],
+        'items': (json['items'].map(GetCourseVersionItemFromJSON)),
+    };
+}
+export function GetCourseVersionModuleToJSON(json) {
+    return GetCourseVersionModuleToJSONTyped(json, false);
+}
+export function GetCourseVersionModuleToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+        'description': value['description'],
+        'description_rich': RichTextDocumentToJSON(value['descriptionRich']),
+        'display_order': value['displayOrder'],
+        'items': (value['items'].map(GetCourseVersionItemToJSON)),
+    };
+}

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

@@ -0,0 +1,50 @@
+/**
+ * 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 GetEmailAssetUpload
+ */
+export interface GetEmailAssetUpload {
+    /**
+     *
+     * @type {string}
+     * @memberof GetEmailAssetUpload
+     */
+    assetId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetEmailAssetUpload
+     */
+    uploadUrl: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetEmailAssetUpload
+     */
+    publicUrl: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetEmailAssetUpload
+     */
+    status: string;
+}
+/**
+ * Check if a given object implements the GetEmailAssetUpload interface.
+ */
+export declare function instanceOfGetEmailAssetUpload(value: object): value is GetEmailAssetUpload;
+export declare function GetEmailAssetUploadFromJSON(json: any): GetEmailAssetUpload;
+export declare function GetEmailAssetUploadFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetEmailAssetUpload;
+export declare function GetEmailAssetUploadToJSON(json: any): GetEmailAssetUpload;
+export declare function GetEmailAssetUploadToJSONTyped(value?: GetEmailAssetUpload | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetEmailAssetUpload.js

@@ -0,0 +1,55 @@
+/* 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 GetEmailAssetUpload interface.
+ */
+export function instanceOfGetEmailAssetUpload(value) {
+    if (!('assetId' in value) || value['assetId'] === undefined)
+        return false;
+    if (!('uploadUrl' in value) || value['uploadUrl'] === undefined)
+        return false;
+    if (!('publicUrl' in value) || value['publicUrl'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    return true;
+}
+export function GetEmailAssetUploadFromJSON(json) {
+    return GetEmailAssetUploadFromJSONTyped(json, false);
+}
+export function GetEmailAssetUploadFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'assetId': json['asset_id'],
+        'uploadUrl': json['upload_url'],
+        'publicUrl': json['public_url'],
+        'status': json['status'],
+    };
+}
+export function GetEmailAssetUploadToJSON(json) {
+    return GetEmailAssetUploadToJSONTyped(json, false);
+}
+export function GetEmailAssetUploadToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'asset_id': value['assetId'],
+        'upload_url': value['uploadUrl'],
+        'public_url': value['publicUrl'],
+        'status': value['status'],
+    };
+}

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

@@ -0,0 +1,123 @@
+/**
+ * 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 GetEmailDelivery
+ */
+export interface GetEmailDelivery {
+    /**
+     *
+     * @type {string}
+     * @memberof GetEmailDelivery
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetEmailDelivery
+     */
+    templateKey: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetEmailDelivery
+     */
+    templateVersionId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof GetEmailDelivery
+     */
+    recipient: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof GetEmailDelivery
+     */
+    isTest: boolean;
+    /**
+     *
+     * @type {GetEmailDeliveryStatusEnum}
+     * @memberof GetEmailDelivery
+     */
+    status: GetEmailDeliveryStatusEnum;
+    /**
+     *
+     * @type {number}
+     * @memberof GetEmailDelivery
+     */
+    attempts: number;
+    /**
+     *
+     * @type {string}
+     * @memberof GetEmailDelivery
+     */
+    providerMessageId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof GetEmailDelivery
+     */
+    lastErrorCode?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof GetEmailDelivery
+     */
+    lastErrorMessage?: string | null;
+    /**
+     *
+     * @type {number}
+     * @memberof GetEmailDelivery
+     */
+    createdAt: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetEmailDelivery
+     */
+    acceptedAt?: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof GetEmailDelivery
+     */
+    deliveredAt?: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof GetEmailDelivery
+     */
+    failedAt?: number | null;
+}
+/**
+ * @export
+ */
+export declare const GetEmailDeliveryStatusEnum: {
+    readonly Queued: "queued";
+    readonly Processing: "processing";
+    readonly Accepted: "accepted";
+    readonly Delivered: "delivered";
+    readonly Deferred: "deferred";
+    readonly Failed: "failed";
+    readonly Complained: "complained";
+};
+export type GetEmailDeliveryStatusEnum = typeof GetEmailDeliveryStatusEnum[keyof typeof GetEmailDeliveryStatusEnum];
+/**
+ * Check if a given object implements the GetEmailDelivery interface.
+ */
+export declare function instanceOfGetEmailDelivery(value: object): value is GetEmailDelivery;
+export declare function GetEmailDeliveryFromJSON(json: any): GetEmailDelivery;
+export declare function GetEmailDeliveryFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetEmailDelivery;
+export declare function GetEmailDeliveryToJSON(json: any): GetEmailDelivery;
+export declare function GetEmailDeliveryToJSONTyped(value?: GetEmailDelivery | null, ignoreDiscriminator?: boolean): any;