@easyedu/js-lsm-api 1.109.0 → 1.111.0

package/dist/apis/LearnerExperienceApi.js

@@ -0,0 +1,401 @@
+"use strict";
+/* 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.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LearnerExperienceApi = void 0;
+const runtime = require("../runtime");
+const GetEffectiveLearnerExperience_1 = require("../models/GetEffectiveLearnerExperience");
+const GetLearnerDashboard_1 = require("../models/GetLearnerDashboard");
+const GetLearnerExperience_1 = require("../models/GetLearnerExperience");
+const GetLearnerExperiencePreview_1 = require("../models/GetLearnerExperiencePreview");
+const LearnerExperienceVersion_1 = require("../models/LearnerExperienceVersion");
+const PostLearnerExperiencePreview_1 = require("../models/PostLearnerExperiencePreview");
+const PutLearnerExperienceDraft_1 = require("../models/PutLearnerExperienceDraft");
+/**
+ *
+ */
+class LearnerExperienceApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for deleteLearnerExperienceDraft without sending the request
+     */
+    deleteLearnerExperienceDraftRequestOpts() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/learner-experience/draft`;
+            return {
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Discard the selected portal\'s learner experience draft
+     */
+    deleteLearnerExperienceDraftRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.deleteLearnerExperienceDraftRequestOpts();
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Discard the selected portal\'s learner experience draft
+     */
+    deleteLearnerExperienceDraft(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.deleteLearnerExperienceDraftRaw(initOverrides);
+        });
+    }
+    /**
+     * Creates request options for getCurrentLearnerDashboard without sending the request
+     */
+    getCurrentLearnerDashboardRequestOpts() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/users/current/dashboard`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Get the authenticated learner\'s resolved dashboard and personalized data
+     */
+    getCurrentLearnerDashboardRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getCurrentLearnerDashboardRequestOpts();
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetLearnerDashboard_1.GetLearnerDashboardFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Get the authenticated learner\'s resolved dashboard and personalized data
+     */
+    getCurrentLearnerDashboard(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getCurrentLearnerDashboardRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getEffectiveLearnerExperience without sending the request
+     */
+    getEffectiveLearnerExperienceRequestOpts() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/learner-experience/effective`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Get the effective published learner experience for the authenticated user
+     */
+    getEffectiveLearnerExperienceRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getEffectiveLearnerExperienceRequestOpts();
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetEffectiveLearnerExperience_1.GetEffectiveLearnerExperienceFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Get the effective published learner experience for the authenticated user
+     */
+    getEffectiveLearnerExperience(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getEffectiveLearnerExperienceRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getLearnerExperience without sending the request
+     */
+    getLearnerExperienceRequestOpts() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/learner-experience`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Get the selected portal\'s effective learner experience and local history
+     */
+    getLearnerExperienceRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getLearnerExperienceRequestOpts();
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetLearnerExperience_1.GetLearnerExperienceFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Get the selected portal\'s effective learner experience and local history
+     */
+    getLearnerExperience(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getLearnerExperienceRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for postLearnerExperienceDraft without sending the request
+     */
+    postLearnerExperienceDraftRequestOpts() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/learner-experience/draft`;
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Create a portal learner experience draft from the effective version
+     */
+    postLearnerExperienceDraftRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.postLearnerExperienceDraftRequestOpts();
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, LearnerExperienceVersion_1.LearnerExperienceVersionFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Create a portal learner experience draft from the effective version
+     */
+    postLearnerExperienceDraft(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.postLearnerExperienceDraftRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for postLearnerExperienceInherit without sending the request
+     */
+    postLearnerExperienceInheritRequestOpts() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/learner-experience/inherit`;
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Disable the local learner experience override and resume inheritance
+     */
+    postLearnerExperienceInheritRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.postLearnerExperienceInheritRequestOpts();
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Disable the local learner experience override and resume inheritance
+     */
+    postLearnerExperienceInherit(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.postLearnerExperienceInheritRaw(initOverrides);
+        });
+    }
+    /**
+     * Creates request options for postLearnerExperiencePreview without sending the request
+     */
+    postLearnerExperiencePreviewRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['postLearnerExperiencePreview'] == null) {
+                throw new runtime.RequiredError('postLearnerExperiencePreview', 'Required parameter "postLearnerExperiencePreview" was null or undefined when calling postLearnerExperiencePreview().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            let urlPath = `/learner-experience/preview`;
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, PostLearnerExperiencePreview_1.PostLearnerExperiencePreviewToJSON)(requestParameters['postLearnerExperiencePreview']),
+            };
+        });
+    }
+    /**
+     * Validate and preview an unsaved learner experience document
+     */
+    postLearnerExperiencePreviewRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.postLearnerExperiencePreviewRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetLearnerExperiencePreview_1.GetLearnerExperiencePreviewFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Validate and preview an unsaved learner experience document
+     */
+    postLearnerExperiencePreview(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.postLearnerExperiencePreviewRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for postLearnerExperiencePublish without sending the request
+     */
+    postLearnerExperiencePublishRequestOpts() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/learner-experience/publish`;
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Publish the selected portal\'s learner experience draft
+     */
+    postLearnerExperiencePublishRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.postLearnerExperiencePublishRequestOpts();
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, LearnerExperienceVersion_1.LearnerExperienceVersionFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Publish the selected portal\'s learner experience draft
+     */
+    postLearnerExperiencePublish(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.postLearnerExperiencePublishRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for postLearnerExperienceVersionRestore without sending the request
+     */
+    postLearnerExperienceVersionRestoreRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['versionId'] == null) {
+                throw new runtime.RequiredError('versionId', 'Required parameter "versionId" was null or undefined when calling postLearnerExperienceVersionRestore().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            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
+     */
+    postLearnerExperienceVersionRestoreRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.postLearnerExperienceVersionRestoreRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, LearnerExperienceVersion_1.LearnerExperienceVersionFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Create a new draft from a historical learner experience version
+     */
+    postLearnerExperienceVersionRestore(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.postLearnerExperienceVersionRestoreRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for putLearnerExperienceDraft without sending the request
+     */
+    putLearnerExperienceDraftRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['putLearnerExperienceDraft'] == null) {
+                throw new runtime.RequiredError('putLearnerExperienceDraft', 'Required parameter "putLearnerExperienceDraft" was null or undefined when calling putLearnerExperienceDraft().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            let urlPath = `/learner-experience/draft`;
+            return {
+                path: urlPath,
+                method: 'PUT',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, PutLearnerExperienceDraft_1.PutLearnerExperienceDraftToJSON)(requestParameters['putLearnerExperienceDraft']),
+            };
+        });
+    }
+    /**
+     * Update the selected portal\'s learner experience draft
+     */
+    putLearnerExperienceDraftRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.putLearnerExperienceDraftRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, LearnerExperienceVersion_1.LearnerExperienceVersionFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Update the selected portal\'s learner experience draft
+     */
+    putLearnerExperienceDraft(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.putLearnerExperienceDraftRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+exports.LearnerExperienceApi = LearnerExperienceApi;

package/dist/apis/QuestionApi.d.ts

@@ -24,8 +24,7 @@ export interface GetQuestionListRequest {
     page?: number;
     pageSize?: number;
     questionType?: GetQuestionListQuestionTypeEnum;
-    difficultyLevel?: GetQuestionListDifficultyLevelEnum;
-    tags?: Array<string>;
+    tagId?: string;
     search?: string;
 }
 export interface PostQuestionRequest {
@@ -109,12 +108,3 @@ export declare const GetQuestionListQuestionTypeEnum: {
     readonly FillInBlank: "fill_in_blank";
 };
 export type GetQuestionListQuestionTypeEnum = typeof GetQuestionListQuestionTypeEnum[keyof typeof GetQuestionListQuestionTypeEnum];
-/**
- * @export
- */
-export declare const GetQuestionListDifficultyLevelEnum: {
-    readonly Beginner: "beginner";
-    readonly Intermediate: "intermediate";
-    readonly Advanced: "advanced";
-};
-export type GetQuestionListDifficultyLevelEnum = typeof GetQuestionListDifficultyLevelEnum[keyof typeof GetQuestionListDifficultyLevelEnum];

package/dist/apis/QuestionApi.js

@@ -22,7 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GetQuestionListDifficultyLevelEnum = exports.GetQuestionListQuestionTypeEnum = exports.QuestionApi = void 0;
+exports.GetQuestionListQuestionTypeEnum = exports.QuestionApi = void 0;
 const runtime = require("../runtime");
 const GetQuestion_1 = require("../models/GetQuestion");
 const GetQuestionList_1 = require("../models/GetQuestionList");
@@ -124,11 +124,8 @@ class QuestionApi extends runtime.BaseAPI {
             if (requestParameters['questionType'] != null) {
                 queryParameters['question_type'] = requestParameters['questionType'];
             }
-            if (requestParameters['difficultyLevel'] != null) {
-                queryParameters['difficulty_level'] = requestParameters['difficultyLevel'];
-            }
-            if (requestParameters['tags'] != null) {
-                queryParameters['tags'] = requestParameters['tags'];
+            if (requestParameters['tagId'] != null) {
+                queryParameters['tag_id'] = requestParameters['tagId'];
             }
             if (requestParameters['search'] != null) {
                 queryParameters['search'] = requestParameters['search'];
@@ -256,11 +253,3 @@ exports.GetQuestionListQuestionTypeEnum = {
     MultipleAnswer: 'multiple_answer',
     FillInBlank: 'fill_in_blank'
 };
-/**
- * @export
- */
-exports.GetQuestionListDifficultyLevelEnum = {
-    Beginner: 'beginner',
-    Intermediate: 'intermediate',
-    Advanced: 'advanced'
-};

package/dist/apis/index.d.ts

@@ -9,6 +9,7 @@ export * from './CourseCatalogApi';
 export * from './CourseShareApi';
 export * from './DispatchApi';
 export * from './EmailTemplateApi';
+export * from './LearnerExperienceApi';
 export * from './OtherApi';
 export * from './PlayerApi';
 export * from './PortalApi';

package/dist/apis/index.js

@@ -27,6 +27,7 @@ __exportStar(require("./CourseCatalogApi"), exports);
 __exportStar(require("./CourseShareApi"), exports);
 __exportStar(require("./DispatchApi"), exports);
 __exportStar(require("./EmailTemplateApi"), exports);
+__exportStar(require("./LearnerExperienceApi"), exports);
 __exportStar(require("./OtherApi"), exports);
 __exportStar(require("./PlayerApi"), exports);
 __exportStar(require("./PortalApi"), exports);

package/dist/esm/apis/ContentLibraryApi.d.ts

@@ -154,11 +154,11 @@ export declare class ContentLibraryApi extends runtime.BaseAPI {
      */
     deleteContentLibraryTagRequestOpts(requestParameters: DeleteContentLibraryTagRequest): Promise<runtime.RequestOpts>;
     /**
-     * Delete an archived, unused Content Library tag
+     * Delete a Content Library tag and remove it from associated content
      */
     deleteContentLibraryTagRaw(requestParameters: DeleteContentLibraryTagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Delete an archived, unused Content Library tag
+     * Delete a Content Library tag and remove it from associated content
      */
     deleteContentLibraryTag(requestParameters: DeleteContentLibraryTagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
@@ -202,11 +202,11 @@ export declare class ContentLibraryApi extends runtime.BaseAPI {
      */
     getContentLibraryTagItemListRequestOpts(requestParameters: GetContentLibraryTagItemListRequest): Promise<runtime.RequestOpts>;
     /**
-     * List resources and quizzes associated with a tag
+     * List resources, quizzes, and questions associated with a tag
      */
     getContentLibraryTagItemListRaw(requestParameters: GetContentLibraryTagItemListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContentLibraryTagItemList>>;
     /**
-     * List resources and quizzes associated with a tag
+     * List resources, quizzes, and questions associated with a tag
      */
     getContentLibraryTagItemList(requestParameters: GetContentLibraryTagItemListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentLibraryTagItemList>;
     /**
@@ -468,6 +468,7 @@ export declare class ContentLibraryApi extends runtime.BaseAPI {
 export declare const GetContentLibraryTagItemListKindEnum: {
     readonly Resource: "resource";
     readonly Quiz: "quiz";
+    readonly Question: "question";
 };
 export type GetContentLibraryTagItemListKindEnum = typeof GetContentLibraryTagItemListKindEnum[keyof typeof GetContentLibraryTagItemListKindEnum];
 /**

package/dist/esm/apis/ContentLibraryApi.js

@@ -65,7 +65,7 @@ export class ContentLibraryApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Delete an archived, unused Content Library tag
+     * Delete a Content Library tag and remove it from associated content
      */
     deleteContentLibraryTagRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -75,7 +75,7 @@ export class ContentLibraryApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Delete an archived, unused Content Library tag
+     * Delete a Content Library tag and remove it from associated content
      */
     deleteContentLibraryTag(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -252,7 +252,7 @@ export class ContentLibraryApi extends runtime.BaseAPI {
         });
     }
     /**
-     * List resources and quizzes associated with a tag
+     * List resources, quizzes, and questions associated with a tag
      */
     getContentLibraryTagItemListRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -262,7 +262,7 @@ export class ContentLibraryApi extends runtime.BaseAPI {
         });
     }
     /**
-     * List resources and quizzes associated with a tag
+     * List resources, quizzes, and questions associated with a tag
      */
     getContentLibraryTagItemList(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -1192,7 +1192,8 @@ export class ContentLibraryApi extends runtime.BaseAPI {
  */
 export const GetContentLibraryTagItemListKindEnum = {
     Resource: 'resource',
-    Quiz: 'quiz'
+    Quiz: 'quiz',
+    Question: 'question'
 };
 /**
  * @export