@easyedu/js-lsm-api 1.110.0 → 1.111.0

package/dist/esm/models/GetLearnerDashboardCourseList.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 { GetUserCourseListItemFromJSON, GetUserCourseListItemToJSON, } from './GetUserCourseListItem';
+/**
+ * Check if a given object implements the GetLearnerDashboardCourseList interface.
+ */
+export function instanceOfGetLearnerDashboardCourseList(value) {
+    if (!('blockId' in value) || value['blockId'] === undefined)
+        return false;
+    if (!('items' in value) || value['items'] === undefined)
+        return false;
+    return true;
+}
+export function GetLearnerDashboardCourseListFromJSON(json) {
+    return GetLearnerDashboardCourseListFromJSONTyped(json, false);
+}
+export function GetLearnerDashboardCourseListFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'blockId': json['block_id'],
+        'items': (json['items'].map(GetUserCourseListItemFromJSON)),
+    };
+}
+export function GetLearnerDashboardCourseListToJSON(json) {
+    return GetLearnerDashboardCourseListToJSONTyped(json, false);
+}
+export function GetLearnerDashboardCourseListToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'block_id': value['blockId'],
+        'items': (value['items'].map(GetUserCourseListItemToJSON)),
+    };
+}

package/dist/esm/models/GetLearnerDashboardSummary.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 GetLearnerDashboardSummary
+ */
+export interface GetLearnerDashboardSummary {
+    /**
+     *
+     * @type {number}
+     * @memberof GetLearnerDashboardSummary
+     */
+    enrolledCourses: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetLearnerDashboardSummary
+     */
+    notStartedCourses: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetLearnerDashboardSummary
+     */
+    inProgressCourses: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetLearnerDashboardSummary
+     */
+    completedCourses: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetLearnerDashboardSummary
+     */
+    certificatesEarned: number;
+}
+/**
+ * Check if a given object implements the GetLearnerDashboardSummary interface.
+ */
+export declare function instanceOfGetLearnerDashboardSummary(value: object): value is GetLearnerDashboardSummary;
+export declare function GetLearnerDashboardSummaryFromJSON(json: any): GetLearnerDashboardSummary;
+export declare function GetLearnerDashboardSummaryFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetLearnerDashboardSummary;
+export declare function GetLearnerDashboardSummaryToJSON(json: any): GetLearnerDashboardSummary;
+export declare function GetLearnerDashboardSummaryToJSONTyped(value?: GetLearnerDashboardSummary | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetLearnerDashboardSummary.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 GetLearnerDashboardSummary interface.
+ */
+export function instanceOfGetLearnerDashboardSummary(value) {
+    if (!('enrolledCourses' in value) || value['enrolledCourses'] === undefined)
+        return false;
+    if (!('notStartedCourses' in value) || value['notStartedCourses'] === undefined)
+        return false;
+    if (!('inProgressCourses' in value) || value['inProgressCourses'] === undefined)
+        return false;
+    if (!('completedCourses' in value) || value['completedCourses'] === undefined)
+        return false;
+    if (!('certificatesEarned' in value) || value['certificatesEarned'] === undefined)
+        return false;
+    return true;
+}
+export function GetLearnerDashboardSummaryFromJSON(json) {
+    return GetLearnerDashboardSummaryFromJSONTyped(json, false);
+}
+export function GetLearnerDashboardSummaryFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'enrolledCourses': json['enrolled_courses'],
+        'notStartedCourses': json['not_started_courses'],
+        'inProgressCourses': json['in_progress_courses'],
+        'completedCourses': json['completed_courses'],
+        'certificatesEarned': json['certificates_earned'],
+    };
+}
+export function GetLearnerDashboardSummaryToJSON(json) {
+    return GetLearnerDashboardSummaryToJSONTyped(json, false);
+}
+export function GetLearnerDashboardSummaryToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'enrolled_courses': value['enrolledCourses'],
+        'not_started_courses': value['notStartedCourses'],
+        'in_progress_courses': value['inProgressCourses'],
+        'completed_courses': value['completedCourses'],
+        'certificates_earned': value['certificatesEarned'],
+    };
+}

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

@@ -0,0 +1,67 @@
+/**
+ * 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 { LearnerExperienceVersion } from './LearnerExperienceVersion';
+/**
+ *
+ * @export
+ * @interface GetLearnerExperience
+ */
+export interface GetLearnerExperience {
+    /**
+     *
+     * @type {GetLearnerExperienceEffectiveSourceEnum}
+     * @memberof GetLearnerExperience
+     */
+    effectiveSource: GetLearnerExperienceEffectiveSourceEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof GetLearnerExperience
+     */
+    effectiveSourcePortalId?: string | null;
+    /**
+     *
+     * @type {LearnerExperienceVersion}
+     * @memberof GetLearnerExperience
+     */
+    effectiveVersion: LearnerExperienceVersion;
+    /**
+     *
+     * @type {LearnerExperienceVersion}
+     * @memberof GetLearnerExperience
+     */
+    draftVersion?: LearnerExperienceVersion | null;
+    /**
+     *
+     * @type {Array<LearnerExperienceVersion>}
+     * @memberof GetLearnerExperience
+     */
+    versions: Array<LearnerExperienceVersion>;
+}
+/**
+ * @export
+ */
+export declare const GetLearnerExperienceEffectiveSourceEnum: {
+    readonly Portal: "portal";
+    readonly Ancestor: "ancestor";
+    readonly Platform: "platform";
+    readonly System: "system";
+};
+export type GetLearnerExperienceEffectiveSourceEnum = typeof GetLearnerExperienceEffectiveSourceEnum[keyof typeof GetLearnerExperienceEffectiveSourceEnum];
+/**
+ * Check if a given object implements the GetLearnerExperience interface.
+ */
+export declare function instanceOfGetLearnerExperience(value: object): value is GetLearnerExperience;
+export declare function GetLearnerExperienceFromJSON(json: any): GetLearnerExperience;
+export declare function GetLearnerExperienceFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetLearnerExperience;
+export declare function GetLearnerExperienceToJSON(json: any): GetLearnerExperience;
+export declare function GetLearnerExperienceToJSONTyped(value?: GetLearnerExperience | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetLearnerExperience.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 { LearnerExperienceVersionFromJSON, LearnerExperienceVersionToJSON, } from './LearnerExperienceVersion';
+/**
+ * @export
+ */
+export const GetLearnerExperienceEffectiveSourceEnum = {
+    Portal: 'portal',
+    Ancestor: 'ancestor',
+    Platform: 'platform',
+    System: 'system'
+};
+/**
+ * Check if a given object implements the GetLearnerExperience interface.
+ */
+export function instanceOfGetLearnerExperience(value) {
+    if (!('effectiveSource' in value) || value['effectiveSource'] === undefined)
+        return false;
+    if (!('effectiveVersion' in value) || value['effectiveVersion'] === undefined)
+        return false;
+    if (!('versions' in value) || value['versions'] === undefined)
+        return false;
+    return true;
+}
+export function GetLearnerExperienceFromJSON(json) {
+    return GetLearnerExperienceFromJSONTyped(json, false);
+}
+export function GetLearnerExperienceFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'effectiveSource': json['effective_source'],
+        'effectiveSourcePortalId': json['effective_source_portal_id'] == null ? undefined : json['effective_source_portal_id'],
+        'effectiveVersion': LearnerExperienceVersionFromJSON(json['effective_version']),
+        'draftVersion': json['draft_version'] == null ? undefined : LearnerExperienceVersionFromJSON(json['draft_version']),
+        'versions': (json['versions'].map(LearnerExperienceVersionFromJSON)),
+    };
+}
+export function GetLearnerExperienceToJSON(json) {
+    return GetLearnerExperienceToJSONTyped(json, false);
+}
+export function GetLearnerExperienceToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'effective_source': value['effectiveSource'],
+        'effective_source_portal_id': value['effectiveSourcePortalId'],
+        'effective_version': LearnerExperienceVersionToJSON(value['effectiveVersion']),
+        'draft_version': LearnerExperienceVersionToJSON(value['draftVersion']),
+        'versions': (value['versions'].map(LearnerExperienceVersionToJSON)),
+    };
+}

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

@@ -0,0 +1,40 @@
+/**
+ * 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 GetLearnerExperiencePreview
+ */
+export interface GetLearnerExperiencePreview {
+    /**
+     *
+     * @type {{ [key: string]: any; }}
+     * @memberof GetLearnerExperiencePreview
+     */
+    designDocument: {
+        [key: string]: any;
+    };
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof GetLearnerExperiencePreview
+     */
+    assetIds: Array<string>;
+}
+/**
+ * Check if a given object implements the GetLearnerExperiencePreview interface.
+ */
+export declare function instanceOfGetLearnerExperiencePreview(value: object): value is GetLearnerExperiencePreview;
+export declare function GetLearnerExperiencePreviewFromJSON(json: any): GetLearnerExperiencePreview;
+export declare function GetLearnerExperiencePreviewFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetLearnerExperiencePreview;
+export declare function GetLearnerExperiencePreviewToJSON(json: any): GetLearnerExperiencePreview;
+export declare function GetLearnerExperiencePreviewToJSONTyped(value?: GetLearnerExperiencePreview | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetLearnerExperiencePreview.js

@@ -0,0 +1,47 @@
+/* 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 GetLearnerExperiencePreview interface.
+ */
+export function instanceOfGetLearnerExperiencePreview(value) {
+    if (!('designDocument' in value) || value['designDocument'] === undefined)
+        return false;
+    if (!('assetIds' in value) || value['assetIds'] === undefined)
+        return false;
+    return true;
+}
+export function GetLearnerExperiencePreviewFromJSON(json) {
+    return GetLearnerExperiencePreviewFromJSONTyped(json, false);
+}
+export function GetLearnerExperiencePreviewFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'designDocument': json['design_document'],
+        'assetIds': json['asset_ids'],
+    };
+}
+export function GetLearnerExperiencePreviewToJSON(json) {
+    return GetLearnerExperiencePreviewToJSONTyped(json, false);
+}
+export function GetLearnerExperiencePreviewToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'design_document': value['designDocument'],
+        'asset_ids': value['assetIds'],
+    };
+}

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

@@ -0,0 +1,86 @@
+/**
+ * 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 LearnerExperienceVersion
+ */
+export interface LearnerExperienceVersion {
+    /**
+     *
+     * @type {string}
+     * @memberof LearnerExperienceVersion
+     */
+    id: string;
+    /**
+     *
+     * @type {number}
+     * @memberof LearnerExperienceVersion
+     */
+    versionNumber: number;
+    /**
+     *
+     * @type {LearnerExperienceVersionStatusEnum}
+     * @memberof LearnerExperienceVersion
+     */
+    status: LearnerExperienceVersionStatusEnum;
+    /**
+     * Validated learner-experience-v1 shell and dashboard document.
+     * @type {{ [key: string]: any; }}
+     * @memberof LearnerExperienceVersion
+     */
+    designDocument: {
+        [key: string]: any;
+    };
+    /**
+     *
+     * @type {string}
+     * @memberof LearnerExperienceVersion
+     */
+    changeNotes?: string | null;
+    /**
+     *
+     * @type {number}
+     * @memberof LearnerExperienceVersion
+     */
+    createdAt: number;
+    /**
+     *
+     * @type {number}
+     * @memberof LearnerExperienceVersion
+     */
+    updatedAt: number;
+    /**
+     *
+     * @type {number}
+     * @memberof LearnerExperienceVersion
+     */
+    publishedAt?: number | null;
+}
+/**
+ * @export
+ */
+export declare const LearnerExperienceVersionStatusEnum: {
+    readonly Draft: "draft";
+    readonly Published: "published";
+    readonly Archived: "archived";
+    readonly System: "system";
+};
+export type LearnerExperienceVersionStatusEnum = typeof LearnerExperienceVersionStatusEnum[keyof typeof LearnerExperienceVersionStatusEnum];
+/**
+ * Check if a given object implements the LearnerExperienceVersion interface.
+ */
+export declare function instanceOfLearnerExperienceVersion(value: object): value is LearnerExperienceVersion;
+export declare function LearnerExperienceVersionFromJSON(json: any): LearnerExperienceVersion;
+export declare function LearnerExperienceVersionFromJSONTyped(json: any, ignoreDiscriminator: boolean): LearnerExperienceVersion;
+export declare function LearnerExperienceVersionToJSON(json: any): LearnerExperienceVersion;
+export declare function LearnerExperienceVersionToJSONTyped(value?: LearnerExperienceVersion | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/LearnerExperienceVersion.js

@@ -0,0 +1,76 @@
+/* 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 LearnerExperienceVersionStatusEnum = {
+    Draft: 'draft',
+    Published: 'published',
+    Archived: 'archived',
+    System: 'system'
+};
+/**
+ * Check if a given object implements the LearnerExperienceVersion interface.
+ */
+export function instanceOfLearnerExperienceVersion(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('versionNumber' in value) || value['versionNumber'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (!('designDocument' in value) || value['designDocument'] === 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 LearnerExperienceVersionFromJSON(json) {
+    return LearnerExperienceVersionFromJSONTyped(json, false);
+}
+export function LearnerExperienceVersionFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'versionNumber': json['version_number'],
+        'status': json['status'],
+        'designDocument': json['design_document'],
+        'changeNotes': json['change_notes'] == null ? undefined : json['change_notes'],
+        'createdAt': json['created_at'],
+        'updatedAt': json['updated_at'],
+        'publishedAt': json['published_at'] == null ? undefined : json['published_at'],
+    };
+}
+export function LearnerExperienceVersionToJSON(json) {
+    return LearnerExperienceVersionToJSONTyped(json, false);
+}
+export function LearnerExperienceVersionToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'version_number': value['versionNumber'],
+        'status': value['status'],
+        'design_document': value['designDocument'],
+        'change_notes': value['changeNotes'],
+        'created_at': value['createdAt'],
+        'updated_at': value['updatedAt'],
+        'published_at': value['publishedAt'],
+    };
+}

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

@@ -0,0 +1,40 @@
+/**
+ * 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 PostLearnerExperiencePreview
+ */
+export interface PostLearnerExperiencePreview {
+    /**
+     *
+     * @type {{ [key: string]: any; }}
+     * @memberof PostLearnerExperiencePreview
+     */
+    designDocument: {
+        [key: string]: any;
+    };
+    /**
+     *
+     * @type {string}
+     * @memberof PostLearnerExperiencePreview
+     */
+    changeNotes?: string | null;
+}
+/**
+ * Check if a given object implements the PostLearnerExperiencePreview interface.
+ */
+export declare function instanceOfPostLearnerExperiencePreview(value: object): value is PostLearnerExperiencePreview;
+export declare function PostLearnerExperiencePreviewFromJSON(json: any): PostLearnerExperiencePreview;
+export declare function PostLearnerExperiencePreviewFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostLearnerExperiencePreview;
+export declare function PostLearnerExperiencePreviewToJSON(json: any): PostLearnerExperiencePreview;
+export declare function PostLearnerExperiencePreviewToJSONTyped(value?: PostLearnerExperiencePreview | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PostLearnerExperiencePreview.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 PostLearnerExperiencePreview interface.
+ */
+export function instanceOfPostLearnerExperiencePreview(value) {
+    if (!('designDocument' in value) || value['designDocument'] === undefined)
+        return false;
+    return true;
+}
+export function PostLearnerExperiencePreviewFromJSON(json) {
+    return PostLearnerExperiencePreviewFromJSONTyped(json, false);
+}
+export function PostLearnerExperiencePreviewFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'designDocument': json['design_document'],
+        'changeNotes': json['change_notes'] == null ? undefined : json['change_notes'],
+    };
+}
+export function PostLearnerExperiencePreviewToJSON(json) {
+    return PostLearnerExperiencePreviewToJSONTyped(json, false);
+}
+export function PostLearnerExperiencePreviewToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'design_document': value['designDocument'],
+        'change_notes': value['changeNotes'],
+    };
+}

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

@@ -0,0 +1,40 @@
+/**
+ * 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 PutLearnerExperienceDraft
+ */
+export interface PutLearnerExperienceDraft {
+    /**
+     *
+     * @type {{ [key: string]: any; }}
+     * @memberof PutLearnerExperienceDraft
+     */
+    designDocument: {
+        [key: string]: any;
+    };
+    /**
+     *
+     * @type {string}
+     * @memberof PutLearnerExperienceDraft
+     */
+    changeNotes?: string | null;
+}
+/**
+ * Check if a given object implements the PutLearnerExperienceDraft interface.
+ */
+export declare function instanceOfPutLearnerExperienceDraft(value: object): value is PutLearnerExperienceDraft;
+export declare function PutLearnerExperienceDraftFromJSON(json: any): PutLearnerExperienceDraft;
+export declare function PutLearnerExperienceDraftFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutLearnerExperienceDraft;
+export declare function PutLearnerExperienceDraftToJSON(json: any): PutLearnerExperienceDraft;
+export declare function PutLearnerExperienceDraftToJSONTyped(value?: PutLearnerExperienceDraft | null, ignoreDiscriminator?: boolean): any;