@easyedu/js-lsm-api 1.110.0 → 1.112.0

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/GetQuestion.d.ts

@@ -12,6 +12,7 @@
 import type { RichTextDocument } from './RichTextDocument';
 import type { ContentLibraryTag } from './ContentLibraryTag';
 import type { GetQuestionAnswerChoicesInner } from './GetQuestionAnswerChoicesInner';
+import type { QuestionImportSourceSummary } from './QuestionImportSourceSummary';
 import type { GetQuestionQuizzesInner } from './GetQuestionQuizzesInner';
 /**
  *
@@ -103,6 +104,12 @@ export interface GetQuestion {
      * @memberof GetQuestion
      */
     readonly quizzes?: Array<GetQuestionQuizzesInner>;
+    /**
+     *
+     * @type {QuestionImportSourceSummary}
+     * @memberof GetQuestion
+     */
+    importSource?: QuestionImportSourceSummary;
 }
 /**
  * @export

package/dist/esm/models/GetQuestion.js

@@ -14,6 +14,7 @@
 import { RichTextDocumentFromJSON, RichTextDocumentToJSON, } from './RichTextDocument';
 import { ContentLibraryTagFromJSON, ContentLibraryTagToJSON, } from './ContentLibraryTag';
 import { GetQuestionAnswerChoicesInnerFromJSON, GetQuestionAnswerChoicesInnerToJSON, } from './GetQuestionAnswerChoicesInner';
+import { QuestionImportSourceSummaryFromJSON, QuestionImportSourceSummaryToJSON, } from './QuestionImportSourceSummary';
 import { GetQuestionQuizzesInnerFromJSON, } from './GetQuestionQuizzesInner';
 /**
  * @export
@@ -66,6 +67,7 @@ export function GetQuestionFromJSONTyped(json, ignoreDiscriminator) {
         'createdBy': json['created_by'] == null ? undefined : json['created_by'],
         'quizCount': json['quiz_count'] == null ? undefined : json['quiz_count'],
         'quizzes': json['quizzes'] == null ? undefined : (json['quizzes'].map(GetQuestionQuizzesInnerFromJSON)),
+        'importSource': json['import_source'] == null ? undefined : QuestionImportSourceSummaryFromJSON(json['import_source']),
     };
 }
 export function GetQuestionToJSON(json) {
@@ -83,5 +85,6 @@ export function GetQuestionToJSONTyped(value, ignoreDiscriminator = false) {
         'explanation': RichTextDocumentToJSON(value['explanation']),
         'tags': value['tags'] == null ? undefined : (value['tags'].map(ContentLibraryTagToJSON)),
         'version': value['version'],
+        'import_source': QuestionImportSourceSummaryToJSON(value['importSource']),
     };
 }

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/PostQuestionImportCommit.d.ts

@@ -0,0 +1,58 @@
+/**
+ * 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 { PostQuestionImportCommitItem } from './PostQuestionImportCommitItem';
+import type { QuestionImportPreviewImage } from './QuestionImportPreviewImage';
+/**
+ *
+ * @export
+ * @interface PostQuestionImportCommit
+ */
+export interface PostQuestionImportCommit {
+    /**
+     *
+     * @type {string}
+     * @memberof PostQuestionImportCommit
+     */
+    importToken: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PostQuestionImportCommit
+     */
+    sourceLabel: string;
+    /**
+     * Tags applied to every created question in addition to per-question tags
+     * @type {Array<string>}
+     * @memberof PostQuestionImportCommit
+     */
+    tags?: Array<string>;
+    /**
+     *
+     * @type {Array<PostQuestionImportCommitItem>}
+     * @memberof PostQuestionImportCommit
+     */
+    questions: Array<PostQuestionImportCommitItem>;
+    /**
+     *
+     * @type {Array<QuestionImportPreviewImage>}
+     * @memberof PostQuestionImportCommit
+     */
+    images: Array<QuestionImportPreviewImage>;
+}
+/**
+ * Check if a given object implements the PostQuestionImportCommit interface.
+ */
+export declare function instanceOfPostQuestionImportCommit(value: object): value is PostQuestionImportCommit;
+export declare function PostQuestionImportCommitFromJSON(json: any): PostQuestionImportCommit;
+export declare function PostQuestionImportCommitFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostQuestionImportCommit;
+export declare function PostQuestionImportCommitToJSON(json: any): PostQuestionImportCommit;
+export declare function PostQuestionImportCommitToJSONTyped(value?: PostQuestionImportCommit | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PostQuestionImportCommit.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.
+ */
+import { PostQuestionImportCommitItemFromJSON, PostQuestionImportCommitItemToJSON, } from './PostQuestionImportCommitItem';
+import { QuestionImportPreviewImageFromJSON, QuestionImportPreviewImageToJSON, } from './QuestionImportPreviewImage';
+/**
+ * Check if a given object implements the PostQuestionImportCommit interface.
+ */
+export function instanceOfPostQuestionImportCommit(value) {
+    if (!('importToken' in value) || value['importToken'] === undefined)
+        return false;
+    if (!('sourceLabel' in value) || value['sourceLabel'] === undefined)
+        return false;
+    if (!('questions' in value) || value['questions'] === undefined)
+        return false;
+    if (!('images' in value) || value['images'] === undefined)
+        return false;
+    return true;
+}
+export function PostQuestionImportCommitFromJSON(json) {
+    return PostQuestionImportCommitFromJSONTyped(json, false);
+}
+export function PostQuestionImportCommitFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'importToken': json['import_token'],
+        'sourceLabel': json['source_label'],
+        'tags': json['tags'] == null ? undefined : json['tags'],
+        'questions': (json['questions'].map(PostQuestionImportCommitItemFromJSON)),
+        'images': (json['images'].map(QuestionImportPreviewImageFromJSON)),
+    };
+}
+export function PostQuestionImportCommitToJSON(json) {
+    return PostQuestionImportCommitToJSONTyped(json, false);
+}
+export function PostQuestionImportCommitToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'import_token': value['importToken'],
+        'source_label': value['sourceLabel'],
+        'tags': value['tags'],
+        'questions': (value['questions'].map(PostQuestionImportCommitItemToJSON)),
+        'images': (value['images'].map(QuestionImportPreviewImageToJSON)),
+    };
+}

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

@@ -0,0 +1,72 @@
+/**
+ * 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 { PostQuestion } from './PostQuestion';
+/**
+ *
+ * @export
+ * @interface PostQuestionImportCommitItem
+ */
+export interface PostQuestionImportCommitItem {
+    /**
+     *
+     * @type {string}
+     * @memberof PostQuestionImportCommitItem
+     */
+    draftId: string;
+    /**
+     * Create a separate question, create a new version of the matched question, or skip the draft
+     * @type {PostQuestionImportCommitItemActionEnum}
+     * @memberof PostQuestionImportCommitItem
+     */
+    action: PostQuestionImportCommitItemActionEnum;
+    /**
+     * Matched question to version; required only when action is create_version and must match the signed parse result
+     * @type {string}
+     * @memberof PostQuestionImportCommitItem
+     */
+    targetQuestionId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PostQuestionImportCommitItem
+     */
+    sourceKey?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PostQuestionImportCommitItem
+     */
+    sourceLocation?: string | null;
+    /**
+     *
+     * @type {PostQuestion}
+     * @memberof PostQuestionImportCommitItem
+     */
+    question: PostQuestion;
+}
+/**
+ * @export
+ */
+export declare const PostQuestionImportCommitItemActionEnum: {
+    readonly Create: "create";
+    readonly CreateVersion: "create_version";
+    readonly Skip: "skip";
+};
+export type PostQuestionImportCommitItemActionEnum = typeof PostQuestionImportCommitItemActionEnum[keyof typeof PostQuestionImportCommitItemActionEnum];
+/**
+ * Check if a given object implements the PostQuestionImportCommitItem interface.
+ */
+export declare function instanceOfPostQuestionImportCommitItem(value: object): value is PostQuestionImportCommitItem;
+export declare function PostQuestionImportCommitItemFromJSON(json: any): PostQuestionImportCommitItem;
+export declare function PostQuestionImportCommitItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostQuestionImportCommitItem;
+export declare function PostQuestionImportCommitItemToJSON(json: any): PostQuestionImportCommitItem;
+export declare function PostQuestionImportCommitItemToJSONTyped(value?: PostQuestionImportCommitItem | null, ignoreDiscriminator?: boolean): any;