@easyedu/js-lsm-api 1.110.0 → 1.112.0

package/src/apis/LearnerExperienceApi.ts

@@ -0,0 +1,465 @@
+/* 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 GetEffectiveLearnerExperience,
+    GetEffectiveLearnerExperienceFromJSON,
+    GetEffectiveLearnerExperienceToJSON,
+} from '../models/GetEffectiveLearnerExperience';
+import {
+    type GetLearnerDashboard,
+    GetLearnerDashboardFromJSON,
+    GetLearnerDashboardToJSON,
+} from '../models/GetLearnerDashboard';
+import {
+    type GetLearnerExperience,
+    GetLearnerExperienceFromJSON,
+    GetLearnerExperienceToJSON,
+} from '../models/GetLearnerExperience';
+import {
+    type GetLearnerExperiencePreview,
+    GetLearnerExperiencePreviewFromJSON,
+    GetLearnerExperiencePreviewToJSON,
+} from '../models/GetLearnerExperiencePreview';
+import {
+    type LearnerExperienceVersion,
+    LearnerExperienceVersionFromJSON,
+    LearnerExperienceVersionToJSON,
+} from '../models/LearnerExperienceVersion';
+import {
+    type PostLearnerExperiencePreview,
+    PostLearnerExperiencePreviewFromJSON,
+    PostLearnerExperiencePreviewToJSON,
+} from '../models/PostLearnerExperiencePreview';
+import {
+    type PutLearnerExperienceDraft,
+    PutLearnerExperienceDraftFromJSON,
+    PutLearnerExperienceDraftToJSON,
+} from '../models/PutLearnerExperienceDraft';
+
+export interface PostLearnerExperiencePreviewRequest {
+    postLearnerExperiencePreview: PostLearnerExperiencePreview;
+}
+
+export interface PostLearnerExperienceVersionRestoreRequest {
+    versionId: string;
+}
+
+export interface PutLearnerExperienceDraftRequest {
+    putLearnerExperienceDraft: PutLearnerExperienceDraft;
+}
+
+/**
+ * 
+ */
+export class LearnerExperienceApi extends runtime.BaseAPI {
+
+    /**
+     * Creates request options for deleteLearnerExperienceDraft without sending the request
+     */
+    async deleteLearnerExperienceDraftRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/learner-experience/draft`;
+
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Discard the selected portal\'s learner experience draft
+     */
+    async deleteLearnerExperienceDraftRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.deleteLearnerExperienceDraftRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Discard the selected portal\'s learner experience draft
+     */
+    async deleteLearnerExperienceDraft(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteLearnerExperienceDraftRaw(initOverrides);
+    }
+
+    /**
+     * Creates request options for getCurrentLearnerDashboard without sending the request
+     */
+    async getCurrentLearnerDashboardRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/users/current/dashboard`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Get the authenticated learner\'s resolved dashboard and personalized data
+     */
+    async getCurrentLearnerDashboardRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetLearnerDashboard>> {
+        const requestOptions = await this.getCurrentLearnerDashboardRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetLearnerDashboardFromJSON(jsonValue));
+    }
+
+    /**
+     * Get the authenticated learner\'s resolved dashboard and personalized data
+     */
+    async getCurrentLearnerDashboard(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetLearnerDashboard> {
+        const response = await this.getCurrentLearnerDashboardRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getEffectiveLearnerExperience without sending the request
+     */
+    async getEffectiveLearnerExperienceRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/learner-experience/effective`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Get the effective published learner experience for the authenticated user
+     */
+    async getEffectiveLearnerExperienceRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetEffectiveLearnerExperience>> {
+        const requestOptions = await this.getEffectiveLearnerExperienceRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetEffectiveLearnerExperienceFromJSON(jsonValue));
+    }
+
+    /**
+     * Get the effective published learner experience for the authenticated user
+     */
+    async getEffectiveLearnerExperience(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetEffectiveLearnerExperience> {
+        const response = await this.getEffectiveLearnerExperienceRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getLearnerExperience without sending the request
+     */
+    async getLearnerExperienceRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/learner-experience`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Get the selected portal\'s effective learner experience and local history
+     */
+    async getLearnerExperienceRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetLearnerExperience>> {
+        const requestOptions = await this.getLearnerExperienceRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetLearnerExperienceFromJSON(jsonValue));
+    }
+
+    /**
+     * Get the selected portal\'s effective learner experience and local history
+     */
+    async getLearnerExperience(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetLearnerExperience> {
+        const response = await this.getLearnerExperienceRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for postLearnerExperienceDraft without sending the request
+     */
+    async postLearnerExperienceDraftRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/learner-experience/draft`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Create a portal learner experience draft from the effective version
+     */
+    async postLearnerExperienceDraftRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LearnerExperienceVersion>> {
+        const requestOptions = await this.postLearnerExperienceDraftRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => LearnerExperienceVersionFromJSON(jsonValue));
+    }
+
+    /**
+     * Create a portal learner experience draft from the effective version
+     */
+    async postLearnerExperienceDraft(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LearnerExperienceVersion> {
+        const response = await this.postLearnerExperienceDraftRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for postLearnerExperienceInherit without sending the request
+     */
+    async postLearnerExperienceInheritRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/learner-experience/inherit`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Disable the local learner experience override and resume inheritance
+     */
+    async postLearnerExperienceInheritRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.postLearnerExperienceInheritRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Disable the local learner experience override and resume inheritance
+     */
+    async postLearnerExperienceInherit(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.postLearnerExperienceInheritRaw(initOverrides);
+    }
+
+    /**
+     * Creates request options for postLearnerExperiencePreview without sending the request
+     */
+    async postLearnerExperiencePreviewRequestOpts(requestParameters: PostLearnerExperiencePreviewRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['postLearnerExperiencePreview'] == null) {
+            throw new runtime.RequiredError(
+                'postLearnerExperiencePreview',
+                'Required parameter "postLearnerExperiencePreview" was null or undefined when calling postLearnerExperiencePreview().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/learner-experience/preview`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PostLearnerExperiencePreviewToJSON(requestParameters['postLearnerExperiencePreview']),
+        };
+    }
+
+    /**
+     * Validate and preview an unsaved learner experience document
+     */
+    async postLearnerExperiencePreviewRaw(requestParameters: PostLearnerExperiencePreviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetLearnerExperiencePreview>> {
+        const requestOptions = await this.postLearnerExperiencePreviewRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetLearnerExperiencePreviewFromJSON(jsonValue));
+    }
+
+    /**
+     * Validate and preview an unsaved learner experience document
+     */
+    async postLearnerExperiencePreview(requestParameters: PostLearnerExperiencePreviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetLearnerExperiencePreview> {
+        const response = await this.postLearnerExperiencePreviewRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for postLearnerExperiencePublish without sending the request
+     */
+    async postLearnerExperiencePublishRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/learner-experience/publish`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Publish the selected portal\'s learner experience draft
+     */
+    async postLearnerExperiencePublishRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LearnerExperienceVersion>> {
+        const requestOptions = await this.postLearnerExperiencePublishRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => LearnerExperienceVersionFromJSON(jsonValue));
+    }
+
+    /**
+     * Publish the selected portal\'s learner experience draft
+     */
+    async postLearnerExperiencePublish(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LearnerExperienceVersion> {
+        const response = await this.postLearnerExperiencePublishRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for postLearnerExperienceVersionRestore without sending the request
+     */
+    async postLearnerExperienceVersionRestoreRequestOpts(requestParameters: PostLearnerExperienceVersionRestoreRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['versionId'] == null) {
+            throw new runtime.RequiredError(
+                'versionId',
+                'Required parameter "versionId" was null or undefined when calling postLearnerExperienceVersionRestore().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/learner-experience/versions/{versionId}/restore`;
+        urlPath = urlPath.replace('{versionId}', encodeURIComponent(String(requestParameters['versionId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Create a new draft from a historical learner experience version
+     */
+    async postLearnerExperienceVersionRestoreRaw(requestParameters: PostLearnerExperienceVersionRestoreRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LearnerExperienceVersion>> {
+        const requestOptions = await this.postLearnerExperienceVersionRestoreRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => LearnerExperienceVersionFromJSON(jsonValue));
+    }
+
+    /**
+     * Create a new draft from a historical learner experience version
+     */
+    async postLearnerExperienceVersionRestore(requestParameters: PostLearnerExperienceVersionRestoreRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LearnerExperienceVersion> {
+        const response = await this.postLearnerExperienceVersionRestoreRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for putLearnerExperienceDraft without sending the request
+     */
+    async putLearnerExperienceDraftRequestOpts(requestParameters: PutLearnerExperienceDraftRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['putLearnerExperienceDraft'] == null) {
+            throw new runtime.RequiredError(
+                'putLearnerExperienceDraft',
+                'Required parameter "putLearnerExperienceDraft" was null or undefined when calling putLearnerExperienceDraft().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/learner-experience/draft`;
+
+        return {
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PutLearnerExperienceDraftToJSON(requestParameters['putLearnerExperienceDraft']),
+        };
+    }
+
+    /**
+     * Update the selected portal\'s learner experience draft
+     */
+    async putLearnerExperienceDraftRaw(requestParameters: PutLearnerExperienceDraftRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LearnerExperienceVersion>> {
+        const requestOptions = await this.putLearnerExperienceDraftRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => LearnerExperienceVersionFromJSON(jsonValue));
+    }
+
+    /**
+     * Update the selected portal\'s learner experience draft
+     */
+    async putLearnerExperienceDraft(requestParameters: PutLearnerExperienceDraftRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LearnerExperienceVersion> {
+        const response = await this.putLearnerExperienceDraftRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

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

@@ -11,11 +11,13 @@ export * from './CourseCatalogApi';
 export * from './CourseShareApi';
 export * from './DispatchApi';
 export * from './EmailTemplateApi';
+export * from './LearnerExperienceApi';
 export * from './OtherApi';
 export * from './PlayerApi';
 export * from './PortalApi';
 export * from './PortalSublicenseApi';
 export * from './QuestionApi';
+export * from './QuestionImportApi';
 export * from './ReportingApi';
 export * from './RichTextApi';
 export * from './RoleApi';