@easyedu/js-lsm-api 1.34.0 → 1.36.0

package/docs/UserApi.md

@@ -5,6 +5,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
 | [**getAuthCheck**](UserApi.md#getauthcheck) | **GET** /auth/check | Check if a user is logged in |
+| [**getCurrentUserPermissions**](UserApi.md#getcurrentuserpermissions) | **GET** /users/current/permissions | Get the current user\'s permissions |
 | [**getUser**](UserApi.md#getuser) | **GET** /users/{userId} | Get a user by id |
 | [**postLogin**](UserApi.md#postlogin) | **POST** /auth/login | Post a new login |
 | [**postLogout**](UserApi.md#postlogout) | **POST** /auth/logout | Logout a user |
@@ -72,6 +73,66 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## getCurrentUserPermissions
+
+> Array<string> getCurrentUserPermissions()
+
+Get the current user\'s permissions
+
+Returns an array of permission key strings for the authenticated user\'s current portal
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UserApi,
+} from '@easyedu/js-lsm-api';
+import type { GetCurrentUserPermissionsRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new UserApi();
+
+  try {
+    const data = await api.getCurrentUserPermissions();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+**Array<string>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | List of permission keys |  -  |
+| **401** | Unauthorized |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## getUser
 
 > GetUser getUser(userId)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easyedu/js-lsm-api",
-  "version": "1.34.0",
+  "version": "1.36.0",
   "description": "OpenAPI client for @easyedu/js-lsm-api",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/QuizApi.ts

@@ -36,6 +36,7 @@ import type {
   PostQuizQuestions,
   PutQuiz,
   PutQuizAnswer,
+  PutQuizAnswerGrade,
 } from '../models/index';
 import {
     GetManualQuestionSelectionItemFromJSON,
@@ -80,6 +81,8 @@ import {
     PutQuizToJSON,
     PutQuizAnswerFromJSON,
     PutQuizAnswerToJSON,
+    PutQuizAnswerGradeFromJSON,
+    PutQuizAnswerGradeToJSON,
 } from '../models/index';
 
 export interface AddQuizCriteriaQuestionSelectionRequest {
@@ -183,6 +186,12 @@ export interface GetUserQuizAttemptsRequest {
     status?: GetUserQuizAttemptsStatusEnum;
 }
 
+export interface GradeQuizAnswerRequest {
+    attemptId: string;
+    questionId: string;
+    putQuizAnswerGrade: PutQuizAnswerGrade;
+}
+
 export interface RemoveQuizQuestionRequest {
     quizId: string;
     questionId: string;
@@ -1202,6 +1211,70 @@ export class QuizApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for gradeQuizAnswer without sending the request
+     */
+    async gradeQuizAnswerRequestOpts(requestParameters: GradeQuizAnswerRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['attemptId'] == null) {
+            throw new runtime.RequiredError(
+                'attemptId',
+                'Required parameter "attemptId" was null or undefined when calling gradeQuizAnswer().'
+            );
+        }
+
+        if (requestParameters['questionId'] == null) {
+            throw new runtime.RequiredError(
+                'questionId',
+                'Required parameter "questionId" was null or undefined when calling gradeQuizAnswer().'
+            );
+        }
+
+        if (requestParameters['putQuizAnswerGrade'] == null) {
+            throw new runtime.RequiredError(
+                'putQuizAnswerGrade',
+                'Required parameter "putQuizAnswerGrade" was null or undefined when calling gradeQuizAnswer().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/quiz-attempts/{attemptId}/answers/{questionId}/grade`;
+        urlPath = urlPath.replace(`{${"attemptId"}}`, encodeURIComponent(String(requestParameters['attemptId'])));
+        urlPath = urlPath.replace(`{${"questionId"}}`, encodeURIComponent(String(requestParameters['questionId'])));
+
+        return {
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PutQuizAnswerGradeToJSON(requestParameters['putQuizAnswerGrade']),
+        };
+    }
+
+    /**
+     * Allows an instructor to grade an essay or override the score for any question type.
+     * Grade or override score for a question answer
+     */
+    async gradeQuizAnswerRaw(requestParameters: GradeQuizAnswerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.gradeQuizAnswerRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Allows an instructor to grade an essay or override the score for any question type.
+     * Grade or override score for a question answer
+     */
+    async gradeQuizAnswer(requestParameters: GradeQuizAnswerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.gradeQuizAnswerRaw(requestParameters, initOverrides);
+    }
+
     /**
      * Creates request options for removeQuizQuestion without sending the request
      */

package/src/apis/UserApi.ts

@@ -99,6 +99,45 @@ export class UserApi extends runtime.BaseAPI {
         await this.getAuthCheckRaw(initOverrides);
     }
 
+    /**
+     * Creates request options for getCurrentUserPermissions without sending the request
+     */
+    async getCurrentUserPermissionsRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/users/current/permissions`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Returns an array of permission key strings for the authenticated user\'s current portal
+     * Get the current user\'s permissions
+     */
+    async getCurrentUserPermissionsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<string>>> {
+        const requestOptions = await this.getCurrentUserPermissionsRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse<any>(response);
+    }
+
+    /**
+     * Returns an array of permission key strings for the authenticated user\'s current portal
+     * Get the current user\'s permissions
+     */
+    async getCurrentUserPermissions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<string>> {
+        const response = await this.getCurrentUserPermissionsRaw(initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for getUser without sending the request
      */

package/src/models/CriteriaBasedSelectionCriteria.ts

@@ -68,7 +68,10 @@ export type CriteriaBasedSelectionCriteriaDifficultyLevelsEnum = typeof Criteria
 export const CriteriaBasedSelectionCriteriaQuestionTypesEnum = {
     SingleAnswer: 'single_answer',
     MultipleAnswer: 'multiple_answer',
-    FillInBlank: 'fill_in_blank'
+    FillInBlank: 'fill_in_blank',
+    ShortAnswer: 'short_answer',
+    Matching: 'matching',
+    Essay: 'essay'
 } as const;
 export type CriteriaBasedSelectionCriteriaQuestionTypesEnum = typeof CriteriaBasedSelectionCriteriaQuestionTypesEnum[keyof typeof CriteriaBasedSelectionCriteriaQuestionTypesEnum];
 

package/src/models/Essay.ts

@@ -0,0 +1,85 @@
+/* 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 Essay
+ */
+export interface Essay {
+    /**
+     * 
+     * @type {EssayTypeEnum}
+     * @memberof Essay
+     */
+    type: EssayTypeEnum;
+    /**
+     * Essay response text
+     * @type {string}
+     * @memberof Essay
+     */
+    textAnswer: string;
+}
+
+
+/**
+ * @export
+ */
+export const EssayTypeEnum = {
+    Essay: 'essay'
+} as const;
+export type EssayTypeEnum = typeof EssayTypeEnum[keyof typeof EssayTypeEnum];
+
+
+/**
+ * Check if a given object implements the Essay interface.
+ */
+export function instanceOfEssay(value: object): value is Essay {
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('textAnswer' in value) || value['textAnswer'] === undefined) return false;
+    return true;
+}
+
+export function EssayFromJSON(json: any): Essay {
+    return EssayFromJSONTyped(json, false);
+}
+
+export function EssayFromJSONTyped(json: any, ignoreDiscriminator: boolean): Essay {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'type': json['type'],
+        'textAnswer': json['text_answer'],
+    };
+}
+
+export function EssayToJSON(json: any): Essay {
+    return EssayToJSONTyped(json, false);
+}
+
+export function EssayToJSONTyped(value?: Essay | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'type': value['type'],
+        'text_answer': value['textAnswer'],
+    };
+}
+

package/src/models/Essay1.ts

@@ -0,0 +1,85 @@
+/* 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 Essay1
+ */
+export interface Essay1 {
+    /**
+     * 
+     * @type {Essay1TypeEnum}
+     * @memberof Essay1
+     */
+    type: Essay1TypeEnum;
+    /**
+     * Essay response text
+     * @type {string}
+     * @memberof Essay1
+     */
+    textAnswer: string;
+}
+
+
+/**
+ * @export
+ */
+export const Essay1TypeEnum = {
+    Essay: 'essay'
+} as const;
+export type Essay1TypeEnum = typeof Essay1TypeEnum[keyof typeof Essay1TypeEnum];
+
+
+/**
+ * Check if a given object implements the Essay1 interface.
+ */
+export function instanceOfEssay1(value: object): value is Essay1 {
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('textAnswer' in value) || value['textAnswer'] === undefined) return false;
+    return true;
+}
+
+export function Essay1FromJSON(json: any): Essay1 {
+    return Essay1FromJSONTyped(json, false);
+}
+
+export function Essay1FromJSONTyped(json: any, ignoreDiscriminator: boolean): Essay1 {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'type': json['type'],
+        'textAnswer': json['text_answer'],
+    };
+}
+
+export function Essay1ToJSON(json: any): Essay1 {
+    return Essay1ToJSONTyped(json, false);
+}
+
+export function Essay1ToJSONTyped(value?: Essay1 | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'type': value['type'],
+        'text_answer': value['textAnswer'],
+    };
+}
+

package/src/models/GetQuestion.ts

@@ -40,7 +40,7 @@ export interface GetQuestion {
      */
     questionText: string;
     /**
-     * Type of question: single answer (True/False, multiple choice), multiple answer, or fill in the blank
+     * Type of question
      * @type {GetQuestionQuestionTypeEnum}
      * @memberof GetQuestion
      */
@@ -126,7 +126,10 @@ export interface GetQuestion {
 export const GetQuestionQuestionTypeEnum = {
     SingleAnswer: 'single_answer',
     MultipleAnswer: 'multiple_answer',
-    FillInBlank: 'fill_in_blank'
+    FillInBlank: 'fill_in_blank',
+    ShortAnswer: 'short_answer',
+    Matching: 'matching',
+    Essay: 'essay'
 } as const;
 export type GetQuestionQuestionTypeEnum = typeof GetQuestionQuestionTypeEnum[keyof typeof GetQuestionQuestionTypeEnum];
 

package/src/models/GetQuestionListFilters.ts

@@ -76,7 +76,10 @@ export interface GetQuestionListFilters {
 export const GetQuestionListFiltersQuestionTypeEnum = {
     SingleAnswer: 'single_answer',
     MultipleAnswer: 'multiple_answer',
-    FillInBlank: 'fill_in_blank'
+    FillInBlank: 'fill_in_blank',
+    ShortAnswer: 'short_answer',
+    Matching: 'matching',
+    Essay: 'essay'
 } as const;
 export type GetQuestionListFiltersQuestionTypeEnum = typeof GetQuestionListFiltersQuestionTypeEnum[keyof typeof GetQuestionListFiltersQuestionTypeEnum];
 

package/src/models/GetQuizAttemptAnalyticsPerformanceBreakdownByQuestionTypeInner.ts

@@ -64,7 +64,10 @@ export interface GetQuizAttemptAnalyticsPerformanceBreakdownByQuestionTypeInner
 export const GetQuizAttemptAnalyticsPerformanceBreakdownByQuestionTypeInnerQuestionTypeEnum = {
     SingleAnswer: 'single_answer',
     MultipleAnswer: 'multiple_answer',
-    FillInBlank: 'fill_in_blank'
+    FillInBlank: 'fill_in_blank',
+    ShortAnswer: 'short_answer',
+    Matching: 'matching',
+    Essay: 'essay'
 } as const;
 export type GetQuizAttemptAnalyticsPerformanceBreakdownByQuestionTypeInnerQuestionTypeEnum = typeof GetQuizAttemptAnalyticsPerformanceBreakdownByQuestionTypeInnerQuestionTypeEnum[keyof typeof GetQuizAttemptAnalyticsPerformanceBreakdownByQuestionTypeInnerQuestionTypeEnum];
 

package/src/models/GetQuizAttemptAnalyticsQuestionAnalysisInner.ts

@@ -121,7 +121,10 @@ export interface GetQuizAttemptAnalyticsQuestionAnalysisInner {
 export const GetQuizAttemptAnalyticsQuestionAnalysisInnerQuestionTypeEnum = {
     SingleAnswer: 'single_answer',
     MultipleAnswer: 'multiple_answer',
-    FillInBlank: 'fill_in_blank'
+    FillInBlank: 'fill_in_blank',
+    ShortAnswer: 'short_answer',
+    Matching: 'matching',
+    Essay: 'essay'
 } as const;
 export type GetQuizAttemptAnalyticsQuestionAnalysisInnerQuestionTypeEnum = typeof GetQuizAttemptAnalyticsQuestionAnalysisInnerQuestionTypeEnum[keyof typeof GetQuizAttemptAnalyticsQuestionAnalysisInnerQuestionTypeEnum];
 

package/src/models/GetQuizAttemptQuestionsInner.ts

@@ -103,7 +103,10 @@ export interface GetQuizAttemptQuestionsInner {
 export const GetQuizAttemptQuestionsInnerQuestionTypeEnum = {
     SingleAnswer: 'single_answer',
     MultipleAnswer: 'multiple_answer',
-    FillInBlank: 'fill_in_blank'
+    FillInBlank: 'fill_in_blank',
+    ShortAnswer: 'short_answer',
+    Matching: 'matching',
+    Essay: 'essay'
 } as const;
 export type GetQuizAttemptQuestionsInnerQuestionTypeEnum = typeof GetQuizAttemptQuestionsInnerQuestionTypeEnum[keyof typeof GetQuizAttemptQuestionsInnerQuestionTypeEnum];
 

package/src/models/GetQuizCriteriaItem.ts

@@ -116,7 +116,10 @@ export type GetQuizCriteriaItemDifficultyLevelEnum = typeof GetQuizCriteriaItemD
 export const GetQuizCriteriaItemQuestionTypeEnum = {
     SingleAnswer: 'single_answer',
     MultipleAnswer: 'multiple_answer',
-    FillInBlank: 'fill_in_blank'
+    FillInBlank: 'fill_in_blank',
+    ShortAnswer: 'short_answer',
+    Matching: 'matching',
+    Essay: 'essay'
 } as const;
 export type GetQuizCriteriaItemQuestionTypeEnum = typeof GetQuizCriteriaItemQuestionTypeEnum[keyof typeof GetQuizCriteriaItemQuestionTypeEnum];
 

package/src/models/GetQuizCriteriaListItemsInner.ts

@@ -116,7 +116,10 @@ export type GetQuizCriteriaListItemsInnerDifficultyLevelEnum = typeof GetQuizCri
 export const GetQuizCriteriaListItemsInnerQuestionTypeEnum = {
     SingleAnswer: 'single_answer',
     MultipleAnswer: 'multiple_answer',
-    FillInBlank: 'fill_in_blank'
+    FillInBlank: 'fill_in_blank',
+    ShortAnswer: 'short_answer',
+    Matching: 'matching',
+    Essay: 'essay'
 } as const;
 export type GetQuizCriteriaListItemsInnerQuestionTypeEnum = typeof GetQuizCriteriaListItemsInnerQuestionTypeEnum[keyof typeof GetQuizCriteriaListItemsInnerQuestionTypeEnum];
 

package/src/models/GetQuizQuestionsItemsInnerQuestionDetails.ts

@@ -96,7 +96,10 @@ export interface GetQuizQuestionsItemsInnerQuestionDetails {
 export const GetQuizQuestionsItemsInnerQuestionDetailsQuestionTypeEnum = {
     SingleAnswer: 'single_answer',
     MultipleAnswer: 'multiple_answer',
-    FillInBlank: 'fill_in_blank'
+    FillInBlank: 'fill_in_blank',
+    ShortAnswer: 'short_answer',
+    Matching: 'matching',
+    Essay: 'essay'
 } as const;
 export type GetQuizQuestionsItemsInnerQuestionDetailsQuestionTypeEnum = typeof GetQuizQuestionsItemsInnerQuestionDetailsQuestionTypeEnum[keyof typeof GetQuizQuestionsItemsInnerQuestionDetailsQuestionTypeEnum];
 

package/src/models/GetQuizResultsQuestionsInner.ts

@@ -97,7 +97,10 @@ export interface GetQuizResultsQuestionsInner {
 export const GetQuizResultsQuestionsInnerQuestionTypeEnum = {
     SingleAnswer: 'single_answer',
     MultipleAnswer: 'multiple_answer',
-    FillInBlank: 'fill_in_blank'
+    FillInBlank: 'fill_in_blank',
+    ShortAnswer: 'short_answer',
+    Matching: 'matching',
+    Essay: 'essay'
 } as const;
 export type GetQuizResultsQuestionsInnerQuestionTypeEnum = typeof GetQuizResultsQuestionsInnerQuestionTypeEnum[keyof typeof GetQuizResultsQuestionsInnerQuestionTypeEnum];
 

package/src/models/Matching.ts

@@ -0,0 +1,93 @@
+/* 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 { MatchingPairsInner } from './MatchingPairsInner';
+import {
+    MatchingPairsInnerFromJSON,
+    MatchingPairsInnerFromJSONTyped,
+    MatchingPairsInnerToJSON,
+    MatchingPairsInnerToJSONTyped,
+} from './MatchingPairsInner';
+
+/**
+ * 
+ * @export
+ * @interface Matching
+ */
+export interface Matching {
+    /**
+     * 
+     * @type {MatchingTypeEnum}
+     * @memberof Matching
+     */
+    type: MatchingTypeEnum;
+    /**
+     * User's matching pair selections
+     * @type {Array<MatchingPairsInner>}
+     * @memberof Matching
+     */
+    pairs: Array<MatchingPairsInner>;
+}
+
+
+/**
+ * @export
+ */
+export const MatchingTypeEnum = {
+    Matching: 'matching'
+} as const;
+export type MatchingTypeEnum = typeof MatchingTypeEnum[keyof typeof MatchingTypeEnum];
+
+
+/**
+ * Check if a given object implements the Matching interface.
+ */
+export function instanceOfMatching(value: object): value is Matching {
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('pairs' in value) || value['pairs'] === undefined) return false;
+    return true;
+}
+
+export function MatchingFromJSON(json: any): Matching {
+    return MatchingFromJSONTyped(json, false);
+}
+
+export function MatchingFromJSONTyped(json: any, ignoreDiscriminator: boolean): Matching {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'type': json['type'],
+        'pairs': ((json['pairs'] as Array<any>).map(MatchingPairsInnerFromJSON)),
+    };
+}
+
+export function MatchingToJSON(json: any): Matching {
+    return MatchingToJSONTyped(json, false);
+}
+
+export function MatchingToJSONTyped(value?: Matching | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'type': value['type'],
+        'pairs': ((value['pairs'] as Array<any>).map(MatchingPairsInnerToJSON)),
+    };
+}
+