@easyedu/js-lsm-api 1.33.0 → 1.35.0

package/README.md

@@ -1,4 +1,4 @@
-# @easyedu/js-lsm-api@1.33.0
+# @easyedu/js-lsm-api@1.35.0
 
 A TypeScript SDK client for the sbzw93t49b.execute-api.us-east-2.amazonaws.com API.
 
@@ -146,6 +146,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 *RoleApi* | [**updateRole**](docs/RoleApi.md#updaterole) | **PUT** /roles/{roleId} | Update a custom role name and description
 *RoleApi* | [**updateRolePermissions**](docs/RoleApi.md#updaterolepermissions) | **PUT** /roles/{roleId}/permissions | Replace all permissions for a custom role
 *UserApi* | [**getAuthCheck**](docs/UserApi.md#getauthcheck) | **GET** /auth/check | Check if a user is logged in
+*UserApi* | [**getCurrentUserPermissions**](docs/UserApi.md#getcurrentuserpermissions) | **GET** /users/current/permissions | Get the current user\'s permissions
 *UserApi* | [**getUser**](docs/UserApi.md#getuser) | **GET** /users/{userId} | Get a user by id
 *UserApi* | [**postLogin**](docs/UserApi.md#postlogin) | **POST** /auth/login | Post a new login
 *UserApi* | [**postLogout**](docs/UserApi.md#postlogout) | **POST** /auth/logout | Logout a user
@@ -369,7 +370,7 @@ and is automatically generated by the
 [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: `1.0.0`
-- Package version: `1.33.0`
+- Package version: `1.35.0`
 - Generator version: `7.21.0`
 - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
 

package/dist/apis/UserApi.d.ts

@@ -43,6 +43,20 @@ export declare class UserApi extends runtime.BaseAPI {
      * Check if a user is logged in
      */
     getAuthCheck(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getCurrentUserPermissions without sending the request
+     */
+    getCurrentUserPermissionsRequestOpts(): Promise<runtime.RequestOpts>;
+    /**
+     * Returns an array of permission key strings for the authenticated user\'s current portal
+     * Get the current user\'s permissions
+     */
+    getCurrentUserPermissionsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<string>>>;
+    /**
+     * Returns an array of permission key strings for the authenticated user\'s current portal
+     * Get the current user\'s permissions
+     */
+    getCurrentUserPermissions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<string>>;
     /**
      * Creates request options for getUser without sending the request
      */

package/dist/apis/UserApi.js

@@ -63,6 +63,43 @@ class UserApi extends runtime.BaseAPI {
             yield this.getAuthCheckRaw(initOverrides);
         });
     }
+    /**
+     * Creates request options for getCurrentUserPermissions without sending the request
+     */
+    getCurrentUserPermissionsRequestOpts() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            const headerParameters = {};
+            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
+     */
+    getCurrentUserPermissionsRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getCurrentUserPermissionsRequestOpts();
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response);
+        });
+    }
+    /**
+     * Returns an array of permission key strings for the authenticated user\'s current portal
+     * Get the current user\'s permissions
+     */
+    getCurrentUserPermissions(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getCurrentUserPermissionsRaw(initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Creates request options for getUser without sending the request
      */

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

@@ -43,6 +43,20 @@ export declare class UserApi extends runtime.BaseAPI {
      * Check if a user is logged in
      */
     getAuthCheck(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getCurrentUserPermissions without sending the request
+     */
+    getCurrentUserPermissionsRequestOpts(): Promise<runtime.RequestOpts>;
+    /**
+     * Returns an array of permission key strings for the authenticated user\'s current portal
+     * Get the current user\'s permissions
+     */
+    getCurrentUserPermissionsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<string>>>;
+    /**
+     * Returns an array of permission key strings for the authenticated user\'s current portal
+     * Get the current user\'s permissions
+     */
+    getCurrentUserPermissions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<string>>;
     /**
      * Creates request options for getUser without sending the request
      */

package/dist/esm/apis/UserApi.js

@@ -60,6 +60,43 @@ export class UserApi extends runtime.BaseAPI {
             yield this.getAuthCheckRaw(initOverrides);
         });
     }
+    /**
+     * Creates request options for getCurrentUserPermissions without sending the request
+     */
+    getCurrentUserPermissionsRequestOpts() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            const headerParameters = {};
+            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
+     */
+    getCurrentUserPermissionsRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getCurrentUserPermissionsRequestOpts();
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response);
+        });
+    }
+    /**
+     * Returns an array of permission key strings for the authenticated user\'s current portal
+     * Get the current user\'s permissions
+     */
+    getCurrentUserPermissions(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getCurrentUserPermissionsRaw(initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Creates request options for getUser without sending the request
      */

package/dist/esm/models/GetPortal.d.ts

@@ -51,18 +51,6 @@ export interface GetPortal {
      * @memberof GetPortal
      */
     headerTextColor: string;
-    /**
-     * The user's current active role (mapped from base_type for backwards compatibility)
-     * @type {GetPortalSelectedUserRoleEnum}
-     * @memberof GetPortal
-     */
-    selectedUserRole?: GetPortalSelectedUserRoleEnum;
-    /**
-     * The user's base role (mapped from base_type for backwards compatibility)
-     * @type {GetPortalBaseUserRoleEnum}
-     * @memberof GetPortal
-     */
-    baseUserRole?: GetPortalBaseUserRoleEnum;
     /**
      * The user's highest-privilege role base type for this portal
      * @type {GetPortalBaseTypeEnum}
@@ -70,24 +58,6 @@ export interface GetPortal {
      */
     baseType?: GetPortalBaseTypeEnum;
 }
-/**
- * @export
- */
-export declare const GetPortalSelectedUserRoleEnum: {
-    readonly Admin: "Admin";
-    readonly Instructor: "Instructor";
-    readonly Learner: "Learner";
-};
-export type GetPortalSelectedUserRoleEnum = typeof GetPortalSelectedUserRoleEnum[keyof typeof GetPortalSelectedUserRoleEnum];
-/**
- * @export
- */
-export declare const GetPortalBaseUserRoleEnum: {
-    readonly Admin: "Admin";
-    readonly Instructor: "Instructor";
-    readonly Learner: "Learner";
-};
-export type GetPortalBaseUserRoleEnum = typeof GetPortalBaseUserRoleEnum[keyof typeof GetPortalBaseUserRoleEnum];
 /**
  * @export
  */

package/dist/esm/models/GetPortal.js

@@ -11,22 +11,6 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-/**
- * @export
- */
-export const GetPortalSelectedUserRoleEnum = {
-    Admin: 'Admin',
-    Instructor: 'Instructor',
-    Learner: 'Learner'
-};
-/**
- * @export
- */
-export const GetPortalBaseUserRoleEnum = {
-    Admin: 'Admin',
-    Instructor: 'Instructor',
-    Learner: 'Learner'
-};
 /**
  * @export
  */
@@ -69,8 +53,6 @@ export function GetPortalFromJSONTyped(json, ignoreDiscriminator) {
         'logoUrl': json['logo_url'],
         'headerBackgroundColor': json['header_background_color'],
         'headerTextColor': json['header_text_color'],
-        'selectedUserRole': json['selected_user_role'] == null ? undefined : json['selected_user_role'],
-        'baseUserRole': json['base_user_role'] == null ? undefined : json['base_user_role'],
         'baseType': json['base_type'] == null ? undefined : json['base_type'],
     };
 }
@@ -88,8 +70,6 @@ export function GetPortalToJSONTyped(value, ignoreDiscriminator = false) {
         'logo_url': value['logoUrl'],
         'header_background_color': value['headerBackgroundColor'],
         'header_text_color': value['headerTextColor'],
-        'selected_user_role': value['selectedUserRole'],
-        'base_user_role': value['baseUserRole'],
         'base_type': value['baseType'],
     };
 }

package/dist/models/GetPortal.d.ts

@@ -51,18 +51,6 @@ export interface GetPortal {
      * @memberof GetPortal
      */
     headerTextColor: string;
-    /**
-     * The user's current active role (mapped from base_type for backwards compatibility)
-     * @type {GetPortalSelectedUserRoleEnum}
-     * @memberof GetPortal
-     */
-    selectedUserRole?: GetPortalSelectedUserRoleEnum;
-    /**
-     * The user's base role (mapped from base_type for backwards compatibility)
-     * @type {GetPortalBaseUserRoleEnum}
-     * @memberof GetPortal
-     */
-    baseUserRole?: GetPortalBaseUserRoleEnum;
     /**
      * The user's highest-privilege role base type for this portal
      * @type {GetPortalBaseTypeEnum}
@@ -70,24 +58,6 @@ export interface GetPortal {
      */
     baseType?: GetPortalBaseTypeEnum;
 }
-/**
- * @export
- */
-export declare const GetPortalSelectedUserRoleEnum: {
-    readonly Admin: "Admin";
-    readonly Instructor: "Instructor";
-    readonly Learner: "Learner";
-};
-export type GetPortalSelectedUserRoleEnum = typeof GetPortalSelectedUserRoleEnum[keyof typeof GetPortalSelectedUserRoleEnum];
-/**
- * @export
- */
-export declare const GetPortalBaseUserRoleEnum: {
-    readonly Admin: "Admin";
-    readonly Instructor: "Instructor";
-    readonly Learner: "Learner";
-};
-export type GetPortalBaseUserRoleEnum = typeof GetPortalBaseUserRoleEnum[keyof typeof GetPortalBaseUserRoleEnum];
 /**
  * @export
  */

package/dist/models/GetPortal.js

@@ -13,28 +13,12 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GetPortalBaseTypeEnum = exports.GetPortalBaseUserRoleEnum = exports.GetPortalSelectedUserRoleEnum = void 0;
+exports.GetPortalBaseTypeEnum = void 0;
 exports.instanceOfGetPortal = instanceOfGetPortal;
 exports.GetPortalFromJSON = GetPortalFromJSON;
 exports.GetPortalFromJSONTyped = GetPortalFromJSONTyped;
 exports.GetPortalToJSON = GetPortalToJSON;
 exports.GetPortalToJSONTyped = GetPortalToJSONTyped;
-/**
- * @export
- */
-exports.GetPortalSelectedUserRoleEnum = {
-    Admin: 'Admin',
-    Instructor: 'Instructor',
-    Learner: 'Learner'
-};
-/**
- * @export
- */
-exports.GetPortalBaseUserRoleEnum = {
-    Admin: 'Admin',
-    Instructor: 'Instructor',
-    Learner: 'Learner'
-};
 /**
  * @export
  */
@@ -77,8 +61,6 @@ function GetPortalFromJSONTyped(json, ignoreDiscriminator) {
         'logoUrl': json['logo_url'],
         'headerBackgroundColor': json['header_background_color'],
         'headerTextColor': json['header_text_color'],
-        'selectedUserRole': json['selected_user_role'] == null ? undefined : json['selected_user_role'],
-        'baseUserRole': json['base_user_role'] == null ? undefined : json['base_user_role'],
         'baseType': json['base_type'] == null ? undefined : json['base_type'],
     };
 }
@@ -96,8 +78,6 @@ function GetPortalToJSONTyped(value, ignoreDiscriminator = false) {
         'logo_url': value['logoUrl'],
         'header_background_color': value['headerBackgroundColor'],
         'header_text_color': value['headerTextColor'],
-        'selected_user_role': value['selectedUserRole'],
-        'base_user_role': value['baseUserRole'],
         'base_type': value['baseType'],
     };
 }

package/docs/GetPortal.md

@@ -12,8 +12,6 @@ Name | Type
 `logoUrl` | string
 `headerBackgroundColor` | string
 `headerTextColor` | string
-`selectedUserRole` | string
-`baseUserRole` | string
 `baseType` | string
 
 ## Example
@@ -29,8 +27,6 @@ const example = {
   "logoUrl": null,
   "headerBackgroundColor": null,
   "headerTextColor": null,
-  "selectedUserRole": null,
-  "baseUserRole": null,
   "baseType": null,
 } satisfies GetPortal
 

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.33.0",
+  "version": "1.35.0",
   "description": "OpenAPI client for @easyedu/js-lsm-api",
   "author": "OpenAPI-Generator",
   "repository": {

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/GetPortal.ts

@@ -55,18 +55,6 @@ export interface GetPortal {
      * @memberof GetPortal
      */
     headerTextColor: string;
-    /**
-     * The user's current active role (mapped from base_type for backwards compatibility)
-     * @type {GetPortalSelectedUserRoleEnum}
-     * @memberof GetPortal
-     */
-    selectedUserRole?: GetPortalSelectedUserRoleEnum;
-    /**
-     * The user's base role (mapped from base_type for backwards compatibility)
-     * @type {GetPortalBaseUserRoleEnum}
-     * @memberof GetPortal
-     */
-    baseUserRole?: GetPortalBaseUserRoleEnum;
     /**
      * The user's highest-privilege role base type for this portal
      * @type {GetPortalBaseTypeEnum}
@@ -76,26 +64,6 @@ export interface GetPortal {
 }
 
 
-/**
- * @export
- */
-export const GetPortalSelectedUserRoleEnum = {
-    Admin: 'Admin',
-    Instructor: 'Instructor',
-    Learner: 'Learner'
-} as const;
-export type GetPortalSelectedUserRoleEnum = typeof GetPortalSelectedUserRoleEnum[keyof typeof GetPortalSelectedUserRoleEnum];
-
-/**
- * @export
- */
-export const GetPortalBaseUserRoleEnum = {
-    Admin: 'Admin',
-    Instructor: 'Instructor',
-    Learner: 'Learner'
-} as const;
-export type GetPortalBaseUserRoleEnum = typeof GetPortalBaseUserRoleEnum[keyof typeof GetPortalBaseUserRoleEnum];
-
 /**
  * @export
  */
@@ -139,8 +107,6 @@ export function GetPortalFromJSONTyped(json: any, ignoreDiscriminator: boolean):
         'logoUrl': json['logo_url'],
         'headerBackgroundColor': json['header_background_color'],
         'headerTextColor': json['header_text_color'],
-        'selectedUserRole': json['selected_user_role'] == null ? undefined : json['selected_user_role'],
-        'baseUserRole': json['base_user_role'] == null ? undefined : json['base_user_role'],
         'baseType': json['base_type'] == null ? undefined : json['base_type'],
     };
 }
@@ -162,8 +128,6 @@ export function GetPortalToJSONTyped(value?: GetPortal | null, ignoreDiscriminat
         'logo_url': value['logoUrl'],
         'header_background_color': value['headerBackgroundColor'],
         'header_text_color': value['headerTextColor'],
-        'selected_user_role': value['selectedUserRole'],
-        'base_user_role': value['baseUserRole'],
         'base_type': value['baseType'],
     };
 }