@easyedu/js-lsm-api 1.32.0 → 1.33.0

package/dist/models/PutRole.js

@@ -0,0 +1,52 @@
+"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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfPutRole = instanceOfPutRole;
+exports.PutRoleFromJSON = PutRoleFromJSON;
+exports.PutRoleFromJSONTyped = PutRoleFromJSONTyped;
+exports.PutRoleToJSON = PutRoleToJSON;
+exports.PutRoleToJSONTyped = PutRoleToJSONTyped;
+/**
+ * Check if a given object implements the PutRole interface.
+ */
+function instanceOfPutRole(value) {
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    return true;
+}
+function PutRoleFromJSON(json) {
+    return PutRoleFromJSONTyped(json, false);
+}
+function PutRoleFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'name': json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
+    };
+}
+function PutRoleToJSON(json) {
+    return PutRoleToJSONTyped(json, false);
+}
+function PutRoleToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+        'description': value['description'],
+    };
+}

package/dist/models/PutRolePermissions.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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.
+ */
+/**
+ * Request body for replacing all permissions on a role
+ * @export
+ * @interface PutRolePermissions
+ */
+export interface PutRolePermissions {
+    /**
+     * List of permission keys to assign (e.g. ["course:create", "module:update"])
+     * @type {Array<string>}
+     * @memberof PutRolePermissions
+     */
+    permissionKeys: Array<string>;
+}
+/**
+ * Check if a given object implements the PutRolePermissions interface.
+ */
+export declare function instanceOfPutRolePermissions(value: object): value is PutRolePermissions;
+export declare function PutRolePermissionsFromJSON(json: any): PutRolePermissions;
+export declare function PutRolePermissionsFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutRolePermissions;
+export declare function PutRolePermissionsToJSON(json: any): PutRolePermissions;
+export declare function PutRolePermissionsToJSONTyped(value?: PutRolePermissions | null, ignoreDiscriminator?: boolean): any;

package/dist/models/PutRolePermissions.js

@@ -0,0 +1,50 @@
+"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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfPutRolePermissions = instanceOfPutRolePermissions;
+exports.PutRolePermissionsFromJSON = PutRolePermissionsFromJSON;
+exports.PutRolePermissionsFromJSONTyped = PutRolePermissionsFromJSONTyped;
+exports.PutRolePermissionsToJSON = PutRolePermissionsToJSON;
+exports.PutRolePermissionsToJSONTyped = PutRolePermissionsToJSONTyped;
+/**
+ * Check if a given object implements the PutRolePermissions interface.
+ */
+function instanceOfPutRolePermissions(value) {
+    if (!('permissionKeys' in value) || value['permissionKeys'] === undefined)
+        return false;
+    return true;
+}
+function PutRolePermissionsFromJSON(json) {
+    return PutRolePermissionsFromJSONTyped(json, false);
+}
+function PutRolePermissionsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'permissionKeys': json['permission_keys'],
+    };
+}
+function PutRolePermissionsToJSON(json) {
+    return PutRolePermissionsToJSONTyped(json, false);
+}
+function PutRolePermissionsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'permission_keys': value['permissionKeys'],
+    };
+}

package/dist/models/QuizContent.d.ts

@@ -19,7 +19,7 @@ import type { QuizContentSettings } from './QuizContentSettings';
 export interface QuizContent {
     /**
      * Type of quiz
-     * @type {string}
+     * @type {QuizContentQuizTypeEnum}
      * @memberof QuizContent
      */
     quizType: QuizContentQuizTypeEnum;

package/dist/models/SingleAnswer.d.ts

@@ -17,7 +17,7 @@
 export interface SingleAnswer {
     /**
      *
-     * @type {string}
+     * @type {SingleAnswerTypeEnum}
      * @memberof SingleAnswer
      */
     type: SingleAnswerTypeEnum;

package/dist/models/index.d.ts

@@ -50,6 +50,7 @@ export * from './GetModuleList';
 export * from './GetModuleStudentReporting';
 export * from './GetModuleStudentReportingAccess';
 export * from './GetModuleStudentReportingProgress';
+export * from './GetPermission';
 export * from './GetPortal';
 export * from './GetPortalBasicReporting';
 export * from './GetPortalBasicReportingCertificates';
@@ -109,6 +110,7 @@ export * from './GetQuizResultsQuestionsInnerStudentAnswer';
 export * from './GetQuizResultsScore';
 export * from './GetQuizResultsTiming';
 export * from './GetQuizStatistics';
+export * from './GetRole';
 export * from './GetScormApiLogItem';
 export * from './GetScormApiLogs';
 export * from './GetScormPackage';
@@ -120,6 +122,7 @@ export * from './GetUserQuizAttempts';
 export * from './GetUserQuizAttemptsAllOfAttempts';
 export * from './GetUserQuizAttemptsAllOfFilters';
 export * from './GetUserQuizAttemptsAllOfSummary';
+export * from './GetUserRole';
 export * from './LoginRes';
 export * from './LoginResAuthData';
 export * from './LoginResUserData';
@@ -161,6 +164,7 @@ export * from './PostQuizQuestions';
 export * from './PostQuizQuestionsQuestionsInner';
 export * from './PostQuizSettings';
 export * from './PostResetPassword';
+export * from './PostRole';
 export * from './PostSendResetPassword';
 export * from './PostVerifyManifest';
 export * from './PostVerifyManifestItemsInner';
@@ -177,6 +181,8 @@ export * from './PutQuiz';
 export * from './PutQuizAnswer';
 export * from './PutQuizAnswerAnswer';
 export * from './PutQuizSettings';
+export * from './PutRole';
+export * from './PutRolePermissions';
 export * from './PutUser';
 export * from './QuizContent';
 export * from './QuizContentAssignment';

package/dist/models/index.js

@@ -68,6 +68,7 @@ __exportStar(require("./GetModuleList"), exports);
 __exportStar(require("./GetModuleStudentReporting"), exports);
 __exportStar(require("./GetModuleStudentReportingAccess"), exports);
 __exportStar(require("./GetModuleStudentReportingProgress"), exports);
+__exportStar(require("./GetPermission"), exports);
 __exportStar(require("./GetPortal"), exports);
 __exportStar(require("./GetPortalBasicReporting"), exports);
 __exportStar(require("./GetPortalBasicReportingCertificates"), exports);
@@ -127,6 +128,7 @@ __exportStar(require("./GetQuizResultsQuestionsInnerStudentAnswer"), exports);
 __exportStar(require("./GetQuizResultsScore"), exports);
 __exportStar(require("./GetQuizResultsTiming"), exports);
 __exportStar(require("./GetQuizStatistics"), exports);
+__exportStar(require("./GetRole"), exports);
 __exportStar(require("./GetScormApiLogItem"), exports);
 __exportStar(require("./GetScormApiLogs"), exports);
 __exportStar(require("./GetScormPackage"), exports);
@@ -138,6 +140,7 @@ __exportStar(require("./GetUserQuizAttempts"), exports);
 __exportStar(require("./GetUserQuizAttemptsAllOfAttempts"), exports);
 __exportStar(require("./GetUserQuizAttemptsAllOfFilters"), exports);
 __exportStar(require("./GetUserQuizAttemptsAllOfSummary"), exports);
+__exportStar(require("./GetUserRole"), exports);
 __exportStar(require("./LoginRes"), exports);
 __exportStar(require("./LoginResAuthData"), exports);
 __exportStar(require("./LoginResUserData"), exports);
@@ -179,6 +182,7 @@ __exportStar(require("./PostQuizQuestions"), exports);
 __exportStar(require("./PostQuizQuestionsQuestionsInner"), exports);
 __exportStar(require("./PostQuizSettings"), exports);
 __exportStar(require("./PostResetPassword"), exports);
+__exportStar(require("./PostRole"), exports);
 __exportStar(require("./PostSendResetPassword"), exports);
 __exportStar(require("./PostVerifyManifest"), exports);
 __exportStar(require("./PostVerifyManifestItemsInner"), exports);
@@ -195,6 +199,8 @@ __exportStar(require("./PutQuiz"), exports);
 __exportStar(require("./PutQuizAnswer"), exports);
 __exportStar(require("./PutQuizAnswerAnswer"), exports);
 __exportStar(require("./PutQuizSettings"), exports);
+__exportStar(require("./PutRole"), exports);
+__exportStar(require("./PutRolePermissions"), exports);
 __exportStar(require("./PutUser"), exports);
 __exportStar(require("./QuizContent"), exports);
 __exportStar(require("./QuizContentAssignment"), exports);

package/dist/runtime.js

@@ -232,6 +232,11 @@ class ResponseError extends Error {
         super(msg);
         this.response = response;
         this.name = "ResponseError";
+        // restore prototype chain
+        const actualProto = new.target.prototype;
+        if (Object.setPrototypeOf) {
+            Object.setPrototypeOf(this, actualProto);
+        }
     }
 }
 exports.ResponseError = ResponseError;
@@ -240,6 +245,11 @@ class FetchError extends Error {
         super(msg);
         this.cause = cause;
         this.name = "FetchError";
+        // restore prototype chain
+        const actualProto = new.target.prototype;
+        if (Object.setPrototypeOf) {
+            Object.setPrototypeOf(this, actualProto);
+        }
     }
 }
 exports.FetchError = FetchError;
@@ -248,6 +258,11 @@ class RequiredError extends Error {
         super(msg);
         this.field = field;
         this.name = "RequiredError";
+        // restore prototype chain
+        const actualProto = new.target.prototype;
+        if (Object.setPrototypeOf) {
+            Object.setPrototypeOf(this, actualProto);
+        }
     }
 }
 exports.RequiredError = RequiredError;

package/docs/GetPermission.md

@@ -0,0 +1,41 @@
+
+# GetPermission
+
+A permission that can be assigned to roles
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`key` | string
+`description` | string
+`domain` | string
+
+## Example
+
+```typescript
+import type { GetPermission } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "key": null,
+  "description": null,
+  "domain": null,
+} satisfies GetPermission
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GetPermission
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/GetPortal.md

@@ -14,6 +14,7 @@ Name | Type
 `headerTextColor` | string
 `selectedUserRole` | string
 `baseUserRole` | string
+`baseType` | string
 
 ## Example
 
@@ -30,6 +31,7 @@ const example = {
   "headerTextColor": null,
   "selectedUserRole": null,
   "baseUserRole": null,
+  "baseType": null,
 } satisfies GetPortal
 
 console.log(example)

package/docs/GetRole.md

@@ -0,0 +1,49 @@
+
+# GetRole
+
+A role with its assigned permissions
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`description` | string
+`baseType` | string
+`portalId` | string
+`isSystem` | boolean
+`isActive` | boolean
+`permissions` | [Array<GetPermission>](GetPermission.md)
+
+## Example
+
+```typescript
+import type { GetRole } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "description": null,
+  "baseType": null,
+  "portalId": null,
+  "isSystem": null,
+  "isActive": null,
+  "permissions": null,
+} satisfies GetRole
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GetRole
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/GetUserRole.md

@@ -0,0 +1,41 @@
+
+# GetUserRole
+
+A role assigned to a user in a portal
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`baseType` | string
+`isSystem` | boolean
+
+## Example
+
+```typescript
+import type { GetUserRole } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "baseType": null,
+  "isSystem": null,
+} satisfies GetUserRole
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GetUserRole
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/PortalApi.md

@@ -10,7 +10,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**inviteUserToPortal**](PortalApi.md#inviteusertoportal) | **POST** /portals/{portalId}/invite | Invite a new user to a portal |
 | [**postPortal**](PortalApi.md#postportal) | **POST** /portals | Create a new portal as a child of the current selected portal |
 | [**putPortalBranding**](PortalApi.md#putportalbranding) | **PUT** /portals/{portalId} | Update portal branding (name, background color, text color) |
-| [**updateSelectedPortal**](PortalApi.md#updateselectedportal) | **PUT** /portals/{portalId}/selected | Update the users current selected portal |
+| [**updateSelectedPortal**](PortalApi.md#updateselectedportal) | **PUT** /portals/{portalId}/selected | Update the users current selected portal. Returns new JWT with updated roles. |
 
 
 
@@ -425,9 +425,9 @@ No authorization required
 
 ## updateSelectedPortal
 
-> updateSelectedPortal(portalId, selectedUserRole)
+> updateSelectedPortal(portalId)
 
-Update the users current selected portal
+Update the users current selected portal. Returns new JWT with updated roles.
 
 ### Example
 
@@ -445,8 +445,6 @@ async function example() {
   const body = {
     // string
     portalId: portalId_example,
-    // string (optional)
-    selectedUserRole: selectedUserRole_example,
   } satisfies UpdateSelectedPortalRequest;
 
   try {
@@ -467,7 +465,6 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **portalId** | `string` |  | [Defaults to `undefined`] |
-| **selectedUserRole** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 

package/docs/PostRole.md

@@ -0,0 +1,39 @@
+
+# PostRole
+
+Request body for creating a new custom role
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`description` | string
+`baseType` | string
+
+## Example
+
+```typescript
+import type { PostRole } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "description": null,
+  "baseType": null,
+} satisfies PostRole
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PostRole
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/PutRole.md

@@ -0,0 +1,37 @@
+
+# PutRole
+
+Request body for updating a custom role
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`description` | string
+
+## Example
+
+```typescript
+import type { PutRole } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "description": null,
+} satisfies PutRole
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PutRole
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/PutRolePermissions.md

@@ -0,0 +1,35 @@
+
+# PutRolePermissions
+
+Request body for replacing all permissions on a role
+
+## Properties
+
+Name | Type
+------------ | -------------
+`permissionKeys` | Array<string>
+
+## Example
+
+```typescript
+import type { PutRolePermissions } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "permissionKeys": null,
+} satisfies PutRolePermissions
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PutRolePermissions
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+