@easyedu/js-lsm-api 1.110.0 → 1.111.0

package/src/models/GetLearnerDashboard.ts

@@ -0,0 +1,106 @@
+/* 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 { mapValues } from '../runtime';
+import type { GetLearnerDashboardCourseList } from './GetLearnerDashboardCourseList';
+import {
+    GetLearnerDashboardCourseListFromJSON,
+    GetLearnerDashboardCourseListFromJSONTyped,
+    GetLearnerDashboardCourseListToJSON,
+    GetLearnerDashboardCourseListToJSONTyped,
+} from './GetLearnerDashboardCourseList';
+import type { GetEffectiveLearnerExperience } from './GetEffectiveLearnerExperience';
+import {
+    GetEffectiveLearnerExperienceFromJSON,
+    GetEffectiveLearnerExperienceFromJSONTyped,
+    GetEffectiveLearnerExperienceToJSON,
+    GetEffectiveLearnerExperienceToJSONTyped,
+} from './GetEffectiveLearnerExperience';
+import type { GetLearnerDashboardSummary } from './GetLearnerDashboardSummary';
+import {
+    GetLearnerDashboardSummaryFromJSON,
+    GetLearnerDashboardSummaryFromJSONTyped,
+    GetLearnerDashboardSummaryToJSON,
+    GetLearnerDashboardSummaryToJSONTyped,
+} from './GetLearnerDashboardSummary';
+
+/**
+ * 
+ * @export
+ * @interface GetLearnerDashboard
+ */
+export interface GetLearnerDashboard {
+    /**
+     * 
+     * @type {GetEffectiveLearnerExperience}
+     * @memberof GetLearnerDashboard
+     */
+    experience: GetEffectiveLearnerExperience;
+    /**
+     * 
+     * @type {GetLearnerDashboardSummary}
+     * @memberof GetLearnerDashboard
+     */
+    summary: GetLearnerDashboardSummary;
+    /**
+     * 
+     * @type {Array<GetLearnerDashboardCourseList>}
+     * @memberof GetLearnerDashboard
+     */
+    courseLists: Array<GetLearnerDashboardCourseList>;
+}
+
+/**
+ * Check if a given object implements the GetLearnerDashboard interface.
+ */
+export function instanceOfGetLearnerDashboard(value: object): value is GetLearnerDashboard {
+    if (!('experience' in value) || value['experience'] === undefined) return false;
+    if (!('summary' in value) || value['summary'] === undefined) return false;
+    if (!('courseLists' in value) || value['courseLists'] === undefined) return false;
+    return true;
+}
+
+export function GetLearnerDashboardFromJSON(json: any): GetLearnerDashboard {
+    return GetLearnerDashboardFromJSONTyped(json, false);
+}
+
+export function GetLearnerDashboardFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetLearnerDashboard {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'experience': GetEffectiveLearnerExperienceFromJSON(json['experience']),
+        'summary': GetLearnerDashboardSummaryFromJSON(json['summary']),
+        'courseLists': ((json['course_lists'] as Array<any>).map(GetLearnerDashboardCourseListFromJSON)),
+    };
+}
+
+export function GetLearnerDashboardToJSON(json: any): GetLearnerDashboard {
+    return GetLearnerDashboardToJSONTyped(json, false);
+}
+
+export function GetLearnerDashboardToJSONTyped(value?: GetLearnerDashboard | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'experience': GetEffectiveLearnerExperienceToJSON(value['experience']),
+        'summary': GetLearnerDashboardSummaryToJSON(value['summary']),
+        'course_lists': ((value['courseLists'] as Array<any>).map(GetLearnerDashboardCourseListToJSON)),
+    };
+}
+

package/src/models/GetLearnerDashboardCourseList.ts

@@ -0,0 +1,83 @@
+/* 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 { mapValues } from '../runtime';
+import type { GetUserCourseListItem } from './GetUserCourseListItem';
+import {
+    GetUserCourseListItemFromJSON,
+    GetUserCourseListItemFromJSONTyped,
+    GetUserCourseListItemToJSON,
+    GetUserCourseListItemToJSONTyped,
+} from './GetUserCourseListItem';
+
+/**
+ * 
+ * @export
+ * @interface GetLearnerDashboardCourseList
+ */
+export interface GetLearnerDashboardCourseList {
+    /**
+     * 
+     * @type {string}
+     * @memberof GetLearnerDashboardCourseList
+     */
+    blockId: string;
+    /**
+     * 
+     * @type {Array<GetUserCourseListItem>}
+     * @memberof GetLearnerDashboardCourseList
+     */
+    items: Array<GetUserCourseListItem>;
+}
+
+/**
+ * Check if a given object implements the GetLearnerDashboardCourseList interface.
+ */
+export function instanceOfGetLearnerDashboardCourseList(value: object): value is GetLearnerDashboardCourseList {
+    if (!('blockId' in value) || value['blockId'] === undefined) return false;
+    if (!('items' in value) || value['items'] === undefined) return false;
+    return true;
+}
+
+export function GetLearnerDashboardCourseListFromJSON(json: any): GetLearnerDashboardCourseList {
+    return GetLearnerDashboardCourseListFromJSONTyped(json, false);
+}
+
+export function GetLearnerDashboardCourseListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetLearnerDashboardCourseList {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'blockId': json['block_id'],
+        'items': ((json['items'] as Array<any>).map(GetUserCourseListItemFromJSON)),
+    };
+}
+
+export function GetLearnerDashboardCourseListToJSON(json: any): GetLearnerDashboardCourseList {
+    return GetLearnerDashboardCourseListToJSONTyped(json, false);
+}
+
+export function GetLearnerDashboardCourseListToJSONTyped(value?: GetLearnerDashboardCourseList | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'block_id': value['blockId'],
+        'items': ((value['items'] as Array<any>).map(GetUserCourseListItemToJSON)),
+    };
+}
+

package/src/models/GetLearnerDashboardSummary.ts

@@ -0,0 +1,102 @@
+/* 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 { mapValues } from '../runtime';
+/**
+ * 
+ * @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 function instanceOfGetLearnerDashboardSummary(value: object): value is GetLearnerDashboardSummary {
+    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: any): GetLearnerDashboardSummary {
+    return GetLearnerDashboardSummaryFromJSONTyped(json, false);
+}
+
+export function GetLearnerDashboardSummaryFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetLearnerDashboardSummary {
+    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: any): GetLearnerDashboardSummary {
+    return GetLearnerDashboardSummaryToJSONTyped(json, false);
+}
+
+export function GetLearnerDashboardSummaryToJSONTyped(value?: GetLearnerDashboardSummary | null, ignoreDiscriminator: boolean = false): any {
+    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/src/models/GetLearnerExperience.ts

@@ -0,0 +1,121 @@
+/* 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 { mapValues } from '../runtime';
+import type { LearnerExperienceVersion } from './LearnerExperienceVersion';
+import {
+    LearnerExperienceVersionFromJSON,
+    LearnerExperienceVersionFromJSONTyped,
+    LearnerExperienceVersionToJSON,
+    LearnerExperienceVersionToJSONTyped,
+} 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 const GetLearnerExperienceEffectiveSourceEnum = {
+    Portal: 'portal',
+    Ancestor: 'ancestor',
+    Platform: 'platform',
+    System: 'system'
+} as const;
+export type GetLearnerExperienceEffectiveSourceEnum = typeof GetLearnerExperienceEffectiveSourceEnum[keyof typeof GetLearnerExperienceEffectiveSourceEnum];
+
+
+/**
+ * Check if a given object implements the GetLearnerExperience interface.
+ */
+export function instanceOfGetLearnerExperience(value: object): value is GetLearnerExperience {
+    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: any): GetLearnerExperience {
+    return GetLearnerExperienceFromJSONTyped(json, false);
+}
+
+export function GetLearnerExperienceFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetLearnerExperience {
+    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'] as Array<any>).map(LearnerExperienceVersionFromJSON)),
+    };
+}
+
+export function GetLearnerExperienceToJSON(json: any): GetLearnerExperience {
+    return GetLearnerExperienceToJSONTyped(json, false);
+}
+
+export function GetLearnerExperienceToJSONTyped(value?: GetLearnerExperience | null, ignoreDiscriminator: boolean = false): any {
+    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'] as Array<any>).map(LearnerExperienceVersionToJSON)),
+    };
+}
+

package/src/models/GetLearnerExperiencePreview.ts

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

package/src/models/LearnerExperienceVersion.ts

@@ -0,0 +1,140 @@
+/* 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 { mapValues } from '../runtime';
+/**
+ * 
+ * @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 const LearnerExperienceVersionStatusEnum = {
+    Draft: 'draft',
+    Published: 'published',
+    Archived: 'archived',
+    System: 'system'
+} as const;
+export type LearnerExperienceVersionStatusEnum = typeof LearnerExperienceVersionStatusEnum[keyof typeof LearnerExperienceVersionStatusEnum];
+
+
+/**
+ * Check if a given object implements the LearnerExperienceVersion interface.
+ */
+export function instanceOfLearnerExperienceVersion(value: object): value is LearnerExperienceVersion {
+    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: any): LearnerExperienceVersion {
+    return LearnerExperienceVersionFromJSONTyped(json, false);
+}
+
+export function LearnerExperienceVersionFromJSONTyped(json: any, ignoreDiscriminator: boolean): LearnerExperienceVersion {
+    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: any): LearnerExperienceVersion {
+    return LearnerExperienceVersionToJSONTyped(json, false);
+}
+
+export function LearnerExperienceVersionToJSONTyped(value?: LearnerExperienceVersion | null, ignoreDiscriminator: boolean = false): any {
+    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/src/models/PostLearnerExperiencePreview.ts

@@ -0,0 +1,74 @@
+/* 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 { mapValues } from '../runtime';
+/**
+ * 
+ * @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 function instanceOfPostLearnerExperiencePreview(value: object): value is PostLearnerExperiencePreview {
+    if (!('designDocument' in value) || value['designDocument'] === undefined) return false;
+    return true;
+}
+
+export function PostLearnerExperiencePreviewFromJSON(json: any): PostLearnerExperiencePreview {
+    return PostLearnerExperiencePreviewFromJSONTyped(json, false);
+}
+
+export function PostLearnerExperiencePreviewFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostLearnerExperiencePreview {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'designDocument': json['design_document'],
+        'changeNotes': json['change_notes'] == null ? undefined : json['change_notes'],
+    };
+}
+
+export function PostLearnerExperiencePreviewToJSON(json: any): PostLearnerExperiencePreview {
+    return PostLearnerExperiencePreviewToJSONTyped(json, false);
+}
+
+export function PostLearnerExperiencePreviewToJSONTyped(value?: PostLearnerExperiencePreview | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'design_document': value['designDocument'],
+        'change_notes': value['changeNotes'],
+    };
+}
+