@easyedu/js-lsm-api 1.111.0 → 1.113.0

package/src/apis/QuestionImportApi.ts

@@ -0,0 +1,162 @@
+/* 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 * as runtime from '../runtime';
+import {
+    type PostQuestionImportCommit,
+    PostQuestionImportCommitFromJSON,
+    PostQuestionImportCommitToJSON,
+} from '../models/PostQuestionImportCommit';
+import {
+    type PostQuestionImportCommitResponse,
+    PostQuestionImportCommitResponseFromJSON,
+    PostQuestionImportCommitResponseToJSON,
+} from '../models/PostQuestionImportCommitResponse';
+import {
+    type PostQuestionImportParseResponse,
+    PostQuestionImportParseResponseFromJSON,
+    PostQuestionImportParseResponseToJSON,
+} from '../models/PostQuestionImportParseResponse';
+
+export interface PostQuestionImportCommitRequest {
+    postQuestionImportCommit: PostQuestionImportCommit;
+}
+
+export interface PostQuestionImportParseRequest {
+    file: Blob;
+    sourceLabel?: string;
+}
+
+/**
+ * 
+ */
+export class QuestionImportApi extends runtime.BaseAPI {
+
+    /**
+     * Creates request options for postQuestionImportCommit without sending the request
+     */
+    async postQuestionImportCommitRequestOpts(requestParameters: PostQuestionImportCommitRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['postQuestionImportCommit'] == null) {
+            throw new runtime.RequiredError(
+                'postQuestionImportCommit',
+                'Required parameter "postQuestionImportCommit" was null or undefined when calling postQuestionImportCommit().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/question-imports/commit`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PostQuestionImportCommitToJSON(requestParameters['postQuestionImportCommit']),
+        };
+    }
+
+    /**
+     * Validate and atomically create, version, or skip approved question drafts
+     */
+    async postQuestionImportCommitRaw(requestParameters: PostQuestionImportCommitRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostQuestionImportCommitResponse>> {
+        const requestOptions = await this.postQuestionImportCommitRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PostQuestionImportCommitResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Validate and atomically create, version, or skip approved question drafts
+     */
+    async postQuestionImportCommit(requestParameters: PostQuestionImportCommitRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostQuestionImportCommitResponse> {
+        const response = await this.postQuestionImportCommitRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for postQuestionImportParse without sending the request
+     */
+    async postQuestionImportParseRequestOpts(requestParameters: PostQuestionImportParseRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['file'] == null) {
+            throw new runtime.RequiredError(
+                'file',
+                'Required parameter "file" was null or undefined when calling postQuestionImportParse().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const consumes: runtime.Consume[] = [
+            { contentType: 'multipart/form-data' },
+        ];
+        // @ts-ignore: canConsumeForm may be unused
+        const canConsumeForm = runtime.canConsumeForm(consumes);
+
+        let formParams: { append(param: string, value: any): any };
+        let useForm = false;
+        // use FormData to transmit files using content-type "multipart/form-data"
+        useForm = canConsumeForm;
+        if (useForm) {
+            formParams = new FormData();
+        } else {
+            formParams = new URLSearchParams();
+        }
+
+        if (requestParameters['file'] != null) {
+            formParams.append('file', requestParameters['file'] as any);
+        }
+
+        if (requestParameters['sourceLabel'] != null) {
+            formParams.append('source_label', requestParameters['sourceLabel'] as any);
+        }
+
+
+        let urlPath = `/question-imports/parse`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: formParams,
+        };
+    }
+
+    /**
+     * Parse a question document into stateless review drafts
+     */
+    async postQuestionImportParseRaw(requestParameters: PostQuestionImportParseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostQuestionImportParseResponse>> {
+        const requestOptions = await this.postQuestionImportParseRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PostQuestionImportParseResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Parse a question document into stateless review drafts
+     */
+    async postQuestionImportParse(requestParameters: PostQuestionImportParseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostQuestionImportParseResponse> {
+        const response = await this.postQuestionImportParseRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/index.ts

@@ -17,6 +17,7 @@ export * from './PlayerApi';
 export * from './PortalApi';
 export * from './PortalSublicenseApi';
 export * from './QuestionApi';
+export * from './QuestionImportApi';
 export * from './ReportingApi';
 export * from './RichTextApi';
 export * from './RoleApi';

package/src/models/GetQuestion.ts

@@ -34,6 +34,13 @@ import {
     GetQuestionAnswerChoicesInnerToJSON,
     GetQuestionAnswerChoicesInnerToJSONTyped,
 } from './GetQuestionAnswerChoicesInner';
+import type { QuestionImportSourceSummary } from './QuestionImportSourceSummary';
+import {
+    QuestionImportSourceSummaryFromJSON,
+    QuestionImportSourceSummaryFromJSONTyped,
+    QuestionImportSourceSummaryToJSON,
+    QuestionImportSourceSummaryToJSONTyped,
+} from './QuestionImportSourceSummary';
 import type { GetQuestionQuizzesInner } from './GetQuestionQuizzesInner';
 import {
     GetQuestionQuizzesInnerFromJSON,
@@ -102,6 +109,18 @@ export interface GetQuestion {
      * @memberof GetQuestion
      */
     readonly versionNumber: number;
+    /**
+     * Whether this is the current editable version in the question history
+     * @type {boolean}
+     * @memberof GetQuestion
+     */
+    readonly isLatestVersion: boolean;
+    /**
+     * Optional note describing why this version was created
+     * @type {string}
+     * @memberof GetQuestion
+     */
+    versionCreatedReason?: string;
     /**
      * When the question was created
      * @type {Date}
@@ -132,6 +151,12 @@ export interface GetQuestion {
      * @memberof GetQuestion
      */
     readonly quizzes?: Array<GetQuestionQuizzesInner>;
+    /**
+     * 
+     * @type {QuestionImportSourceSummary}
+     * @memberof GetQuestion
+     */
+    importSource?: QuestionImportSourceSummary;
 }
 
 
@@ -157,6 +182,7 @@ export function instanceOfGetQuestion(value: object): value is GetQuestion {
     if (!('questionText' in value) || value['questionText'] === undefined) return false;
     if (!('questionType' in value) || value['questionType'] === undefined) return false;
     if (!('versionNumber' in value) || value['versionNumber'] === undefined) return false;
+    if (!('isLatestVersion' in value) || value['isLatestVersion'] === undefined) return false;
     if (!('createdDate' in value) || value['createdDate'] === undefined) return false;
     if (!('updatedDate' in value) || value['updatedDate'] === undefined) return false;
     return true;
@@ -181,11 +207,14 @@ export function GetQuestionFromJSONTyped(json: any, ignoreDiscriminator: boolean
         'tags': json['tags'] == null ? undefined : ((json['tags'] as Array<any>).map(ContentLibraryTagFromJSON)),
         'version': json['version'] == null ? undefined : json['version'],
         'versionNumber': json['version_number'],
+        'isLatestVersion': json['is_latest_version'],
+        'versionCreatedReason': json['version_created_reason'] == null ? undefined : json['version_created_reason'],
         'createdDate': (new Date(json['created_date'])),
         'updatedDate': (new Date(json['updated_date'])),
         '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'] as Array<any>).map(GetQuestionQuizzesInnerFromJSON)),
+        'importSource': json['import_source'] == null ? undefined : QuestionImportSourceSummaryFromJSON(json['import_source']),
     };
 }
 
@@ -193,7 +222,7 @@ export function GetQuestionToJSON(json: any): GetQuestion {
     return GetQuestionToJSONTyped(json, false);
 }
 
-export function GetQuestionToJSONTyped(value?: Omit<GetQuestion, 'id'|'version_number'|'created_date'|'updated_date'|'created_by'|'quiz_count'|'quizzes'> | null, ignoreDiscriminator: boolean = false): any {
+export function GetQuestionToJSONTyped(value?: Omit<GetQuestion, 'id'|'version_number'|'is_latest_version'|'created_date'|'updated_date'|'created_by'|'quiz_count'|'quizzes'> | null, ignoreDiscriminator: boolean = false): any {
     if (value == null) {
         return value;
     }
@@ -207,6 +236,8 @@ export function GetQuestionToJSONTyped(value?: Omit<GetQuestion, 'id'|'version_n
         'explanation': RichTextDocumentToJSON(value['explanation']),
         'tags': value['tags'] == null ? undefined : ((value['tags'] as Array<any>).map(ContentLibraryTagToJSON)),
         'version': value['version'],
+        'version_created_reason': value['versionCreatedReason'],
+        'import_source': QuestionImportSourceSummaryToJSON(value['importSource']),
     };
 }
 

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