@easyedu/js-lsm-api 1.110.0 → 1.112.0

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'],
+    };
+}
+

package/src/models/PostQuestionImportCommit.ts

@@ -0,0 +1,116 @@
+/* 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 { PostQuestionImportCommitItem } from './PostQuestionImportCommitItem';
+import {
+    PostQuestionImportCommitItemFromJSON,
+    PostQuestionImportCommitItemFromJSONTyped,
+    PostQuestionImportCommitItemToJSON,
+    PostQuestionImportCommitItemToJSONTyped,
+} from './PostQuestionImportCommitItem';
+import type { QuestionImportPreviewImage } from './QuestionImportPreviewImage';
+import {
+    QuestionImportPreviewImageFromJSON,
+    QuestionImportPreviewImageFromJSONTyped,
+    QuestionImportPreviewImageToJSON,
+    QuestionImportPreviewImageToJSONTyped,
+} 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 function instanceOfPostQuestionImportCommit(value: object): value is PostQuestionImportCommit {
+    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: any): PostQuestionImportCommit {
+    return PostQuestionImportCommitFromJSONTyped(json, false);
+}
+
+export function PostQuestionImportCommitFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostQuestionImportCommit {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'importToken': json['import_token'],
+        'sourceLabel': json['source_label'],
+        'tags': json['tags'] == null ? undefined : json['tags'],
+        'questions': ((json['questions'] as Array<any>).map(PostQuestionImportCommitItemFromJSON)),
+        'images': ((json['images'] as Array<any>).map(QuestionImportPreviewImageFromJSON)),
+    };
+}
+
+export function PostQuestionImportCommitToJSON(json: any): PostQuestionImportCommit {
+    return PostQuestionImportCommitToJSONTyped(json, false);
+}
+
+export function PostQuestionImportCommitToJSONTyped(value?: PostQuestionImportCommit | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'import_token': value['importToken'],
+        'source_label': value['sourceLabel'],
+        'tags': value['tags'],
+        'questions': ((value['questions'] as Array<any>).map(PostQuestionImportCommitItemToJSON)),
+        'images': ((value['images'] as Array<any>).map(QuestionImportPreviewImageToJSON)),
+    };
+}
+

package/src/models/PostQuestionImportCommitItem.ts

@@ -0,0 +1,128 @@
+/* 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 { PostQuestion } from './PostQuestion';
+import {
+    PostQuestionFromJSON,
+    PostQuestionFromJSONTyped,
+    PostQuestionToJSON,
+    PostQuestionToJSONTyped,
+} 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 const PostQuestionImportCommitItemActionEnum = {
+    Create: 'create',
+    CreateVersion: 'create_version',
+    Skip: 'skip'
+} as const;
+export type PostQuestionImportCommitItemActionEnum = typeof PostQuestionImportCommitItemActionEnum[keyof typeof PostQuestionImportCommitItemActionEnum];
+
+
+/**
+ * Check if a given object implements the PostQuestionImportCommitItem interface.
+ */
+export function instanceOfPostQuestionImportCommitItem(value: object): value is PostQuestionImportCommitItem {
+    if (!('draftId' in value) || value['draftId'] === undefined) return false;
+    if (!('action' in value) || value['action'] === undefined) return false;
+    if (!('question' in value) || value['question'] === undefined) return false;
+    return true;
+}
+
+export function PostQuestionImportCommitItemFromJSON(json: any): PostQuestionImportCommitItem {
+    return PostQuestionImportCommitItemFromJSONTyped(json, false);
+}
+
+export function PostQuestionImportCommitItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostQuestionImportCommitItem {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'draftId': json['draft_id'],
+        'action': json['action'],
+        'targetQuestionId': json['target_question_id'] == null ? undefined : json['target_question_id'],
+        'sourceKey': json['source_key'] == null ? undefined : json['source_key'],
+        'sourceLocation': json['source_location'] == null ? undefined : json['source_location'],
+        'question': PostQuestionFromJSON(json['question']),
+    };
+}
+
+export function PostQuestionImportCommitItemToJSON(json: any): PostQuestionImportCommitItem {
+    return PostQuestionImportCommitItemToJSONTyped(json, false);
+}
+
+export function PostQuestionImportCommitItemToJSONTyped(value?: PostQuestionImportCommitItem | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'draft_id': value['draftId'],
+        'action': value['action'],
+        'target_question_id': value['targetQuestionId'],
+        'source_key': value['sourceKey'],
+        'source_location': value['sourceLocation'],
+        'question': PostQuestionToJSON(value['question']),
+    };
+}
+

package/src/models/PostQuestionImportCommitResponse.ts

@@ -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 { mapValues } from '../runtime';
+import type { QuestionImportCommitResult } from './QuestionImportCommitResult';
+import {
+    QuestionImportCommitResultFromJSON,
+    QuestionImportCommitResultFromJSONTyped,
+    QuestionImportCommitResultToJSON,
+    QuestionImportCommitResultToJSONTyped,
+} from './QuestionImportCommitResult';
+
+/**
+ * 
+ * @export
+ * @interface PostQuestionImportCommitResponse
+ */
+export interface PostQuestionImportCommitResponse {
+    /**
+     * 
+     * @type {number}
+     * @memberof PostQuestionImportCommitResponse
+     */
+    createdCount: number;
+    /**
+     * Number of created rows that are new versions of existing questions
+     * @type {number}
+     * @memberof PostQuestionImportCommitResponse
+     */
+    versionedCount: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof PostQuestionImportCommitResponse
+     */
+    skippedCount: number;
+    /**
+     * 
+     * @type {Array<QuestionImportCommitResult>}
+     * @memberof PostQuestionImportCommitResponse
+     */
+    items: Array<QuestionImportCommitResult>;
+}
+
+/**
+ * Check if a given object implements the PostQuestionImportCommitResponse interface.
+ */
+export function instanceOfPostQuestionImportCommitResponse(value: object): value is PostQuestionImportCommitResponse {
+    if (!('createdCount' in value) || value['createdCount'] === undefined) return false;
+    if (!('versionedCount' in value) || value['versionedCount'] === undefined) return false;
+    if (!('skippedCount' in value) || value['skippedCount'] === undefined) return false;
+    if (!('items' in value) || value['items'] === undefined) return false;
+    return true;
+}
+
+export function PostQuestionImportCommitResponseFromJSON(json: any): PostQuestionImportCommitResponse {
+    return PostQuestionImportCommitResponseFromJSONTyped(json, false);
+}
+
+export function PostQuestionImportCommitResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostQuestionImportCommitResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'createdCount': json['created_count'],
+        'versionedCount': json['versioned_count'],
+        'skippedCount': json['skipped_count'],
+        'items': ((json['items'] as Array<any>).map(QuestionImportCommitResultFromJSON)),
+    };
+}
+
+export function PostQuestionImportCommitResponseToJSON(json: any): PostQuestionImportCommitResponse {
+    return PostQuestionImportCommitResponseToJSONTyped(json, false);
+}
+
+export function PostQuestionImportCommitResponseToJSONTyped(value?: PostQuestionImportCommitResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'created_count': value['createdCount'],
+        'versioned_count': value['versionedCount'],
+        'skipped_count': value['skippedCount'],
+        'items': ((value['items'] as Array<any>).map(QuestionImportCommitResultToJSON)),
+    };
+}
+

package/src/models/PostQuestionImportParseResponse.ts

@@ -0,0 +1,142 @@
+/* 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 { QuestionImportDraft } from './QuestionImportDraft';
+import {
+    QuestionImportDraftFromJSON,
+    QuestionImportDraftFromJSONTyped,
+    QuestionImportDraftToJSON,
+    QuestionImportDraftToJSONTyped,
+} from './QuestionImportDraft';
+import type { QuestionImportSource } from './QuestionImportSource';
+import {
+    QuestionImportSourceFromJSON,
+    QuestionImportSourceFromJSONTyped,
+    QuestionImportSourceToJSON,
+    QuestionImportSourceToJSONTyped,
+} from './QuestionImportSource';
+import type { QuestionImportPreviewImage } from './QuestionImportPreviewImage';
+import {
+    QuestionImportPreviewImageFromJSON,
+    QuestionImportPreviewImageFromJSONTyped,
+    QuestionImportPreviewImageToJSON,
+    QuestionImportPreviewImageToJSONTyped,
+} from './QuestionImportPreviewImage';
+
+/**
+ * 
+ * @export
+ * @interface PostQuestionImportParseResponse
+ */
+export interface PostQuestionImportParseResponse {
+    /**
+     * 
+     * @type {string}
+     * @memberof PostQuestionImportParseResponse
+     */
+    importToken: string;
+    /**
+     * 
+     * @type {Date}
+     * @memberof PostQuestionImportParseResponse
+     */
+    expiresAt: Date;
+    /**
+     * 
+     * @type {QuestionImportSource}
+     * @memberof PostQuestionImportParseResponse
+     */
+    source: QuestionImportSource;
+    /**
+     * 
+     * @type {Array<QuestionImportDraft>}
+     * @memberof PostQuestionImportParseResponse
+     */
+    questions: Array<QuestionImportDraft>;
+    /**
+     * 
+     * @type {Array<QuestionImportPreviewImage>}
+     * @memberof PostQuestionImportParseResponse
+     */
+    images: Array<QuestionImportPreviewImage>;
+    /**
+     * Parser adapter and strategy used for the uploaded document
+     * @type {string}
+     * @memberof PostQuestionImportParseResponse
+     */
+    parser: string;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof PostQuestionImportParseResponse
+     */
+    warnings: Array<string>;
+}
+
+/**
+ * Check if a given object implements the PostQuestionImportParseResponse interface.
+ */
+export function instanceOfPostQuestionImportParseResponse(value: object): value is PostQuestionImportParseResponse {
+    if (!('importToken' in value) || value['importToken'] === undefined) return false;
+    if (!('expiresAt' in value) || value['expiresAt'] === undefined) return false;
+    if (!('source' in value) || value['source'] === undefined) return false;
+    if (!('questions' in value) || value['questions'] === undefined) return false;
+    if (!('images' in value) || value['images'] === undefined) return false;
+    if (!('parser' in value) || value['parser'] === undefined) return false;
+    if (!('warnings' in value) || value['warnings'] === undefined) return false;
+    return true;
+}
+
+export function PostQuestionImportParseResponseFromJSON(json: any): PostQuestionImportParseResponse {
+    return PostQuestionImportParseResponseFromJSONTyped(json, false);
+}
+
+export function PostQuestionImportParseResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostQuestionImportParseResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'importToken': json['import_token'],
+        'expiresAt': (new Date(json['expires_at'])),
+        'source': QuestionImportSourceFromJSON(json['source']),
+        'questions': ((json['questions'] as Array<any>).map(QuestionImportDraftFromJSON)),
+        'images': ((json['images'] as Array<any>).map(QuestionImportPreviewImageFromJSON)),
+        'parser': json['parser'],
+        'warnings': json['warnings'],
+    };
+}
+
+export function PostQuestionImportParseResponseToJSON(json: any): PostQuestionImportParseResponse {
+    return PostQuestionImportParseResponseToJSONTyped(json, false);
+}
+
+export function PostQuestionImportParseResponseToJSONTyped(value?: PostQuestionImportParseResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'import_token': value['importToken'],
+        'expires_at': value['expiresAt'].toISOString(),
+        'source': QuestionImportSourceToJSON(value['source']),
+        'questions': ((value['questions'] as Array<any>).map(QuestionImportDraftToJSON)),
+        'images': ((value['images'] as Array<any>).map(QuestionImportPreviewImageToJSON)),
+        'parser': value['parser'],
+        'warnings': value['warnings'],
+    };
+}
+