@easyedu/js-lsm-api 1.32.0 → 1.33.0

package/dist/esm/apis/RoleApi.js

@@ -0,0 +1,438 @@
+/* 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());
+    });
+};
+import * as runtime from '../runtime';
+import { GetPermissionFromJSON, GetRoleFromJSON, GetUserRoleFromJSON, PostRoleToJSON, PutRoleToJSON, PutRolePermissionsToJSON, } from '../models/index';
+/**
+ *
+ */
+export class RoleApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for assignUserRole without sending the request
+     */
+    assignUserRoleRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['userId'] == null) {
+                throw new runtime.RequiredError('userId', 'Required parameter "userId" was null or undefined when calling assignUserRole().');
+            }
+            if (requestParameters['portalId'] == null) {
+                throw new runtime.RequiredError('portalId', 'Required parameter "portalId" was null or undefined when calling assignUserRole().');
+            }
+            if (requestParameters['roleId'] == null) {
+                throw new runtime.RequiredError('roleId', 'Required parameter "roleId" was null or undefined when calling assignUserRole().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/roles/users/{userId}/portals/{portalId}/roles/{roleId}`;
+            urlPath = urlPath.replace(`{${"userId"}}`, encodeURIComponent(String(requestParameters['userId'])));
+            urlPath = urlPath.replace(`{${"portalId"}}`, encodeURIComponent(String(requestParameters['portalId'])));
+            urlPath = urlPath.replace(`{${"roleId"}}`, encodeURIComponent(String(requestParameters['roleId'])));
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Assign a role to a user for a portal
+     */
+    assignUserRoleRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.assignUserRoleRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Assign a role to a user for a portal
+     */
+    assignUserRole(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.assignUserRoleRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Creates request options for createRole without sending the request
+     */
+    createRoleRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['postRole'] == null) {
+                throw new runtime.RequiredError('postRole', 'Required parameter "postRole" was null or undefined when calling createRole().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            let urlPath = `/roles`;
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: PostRoleToJSON(requestParameters['postRole']),
+            };
+        });
+    }
+    /**
+     * Create a custom role scoped to the current portal
+     */
+    createRoleRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.createRoleRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => GetRoleFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Create a custom role scoped to the current portal
+     */
+    createRole(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createRoleRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for deleteRole without sending the request
+     */
+    deleteRoleRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['roleId'] == null) {
+                throw new runtime.RequiredError('roleId', 'Required parameter "roleId" was null or undefined when calling deleteRole().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/roles/{roleId}`;
+            urlPath = urlPath.replace(`{${"roleId"}}`, encodeURIComponent(String(requestParameters['roleId'])));
+            return {
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Deactivate a custom role
+     */
+    deleteRoleRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.deleteRoleRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Deactivate a custom role
+     */
+    deleteRole(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.deleteRoleRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Creates request options for getPermissions without sending the request
+     */
+    getPermissionsRequestOpts() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/roles/permissions`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * List all available permissions in the system
+     */
+    getPermissionsRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getPermissionsRequestOpts();
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(GetPermissionFromJSON));
+        });
+    }
+    /**
+     * List all available permissions in the system
+     */
+    getPermissions(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getPermissionsRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getRole without sending the request
+     */
+    getRoleRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['roleId'] == null) {
+                throw new runtime.RequiredError('roleId', 'Required parameter "roleId" was null or undefined when calling getRole().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/roles/{roleId}`;
+            urlPath = urlPath.replace(`{${"roleId"}}`, encodeURIComponent(String(requestParameters['roleId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Get role details with permissions
+     */
+    getRoleRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getRoleRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => GetRoleFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Get role details with permissions
+     */
+    getRole(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getRoleRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getRoles without sending the request
+     */
+    getRolesRequestOpts() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/roles`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * List all roles available to the current portal
+     */
+    getRolesRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getRolesRequestOpts();
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(GetRoleFromJSON));
+        });
+    }
+    /**
+     * List all roles available to the current portal
+     */
+    getRoles(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getRolesRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getUserRoles without sending the request
+     */
+    getUserRolesRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['userId'] == null) {
+                throw new runtime.RequiredError('userId', 'Required parameter "userId" was null or undefined when calling getUserRoles().');
+            }
+            if (requestParameters['portalId'] == null) {
+                throw new runtime.RequiredError('portalId', 'Required parameter "portalId" was null or undefined when calling getUserRoles().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/roles/users/{userId}/portals/{portalId}`;
+            urlPath = urlPath.replace(`{${"userId"}}`, encodeURIComponent(String(requestParameters['userId'])));
+            urlPath = urlPath.replace(`{${"portalId"}}`, encodeURIComponent(String(requestParameters['portalId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Get all active roles for a user in a portal
+     */
+    getUserRolesRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getUserRolesRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(GetUserRoleFromJSON));
+        });
+    }
+    /**
+     * Get all active roles for a user in a portal
+     */
+    getUserRoles(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getUserRolesRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for unassignUserRole without sending the request
+     */
+    unassignUserRoleRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['userId'] == null) {
+                throw new runtime.RequiredError('userId', 'Required parameter "userId" was null or undefined when calling unassignUserRole().');
+            }
+            if (requestParameters['portalId'] == null) {
+                throw new runtime.RequiredError('portalId', 'Required parameter "portalId" was null or undefined when calling unassignUserRole().');
+            }
+            if (requestParameters['roleId'] == null) {
+                throw new runtime.RequiredError('roleId', 'Required parameter "roleId" was null or undefined when calling unassignUserRole().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/roles/users/{userId}/portals/{portalId}/roles/{roleId}`;
+            urlPath = urlPath.replace(`{${"userId"}}`, encodeURIComponent(String(requestParameters['userId'])));
+            urlPath = urlPath.replace(`{${"portalId"}}`, encodeURIComponent(String(requestParameters['portalId'])));
+            urlPath = urlPath.replace(`{${"roleId"}}`, encodeURIComponent(String(requestParameters['roleId'])));
+            return {
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Remove a role from a user for a portal
+     */
+    unassignUserRoleRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.unassignUserRoleRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Remove a role from a user for a portal
+     */
+    unassignUserRole(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.unassignUserRoleRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Creates request options for updateRole without sending the request
+     */
+    updateRoleRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['roleId'] == null) {
+                throw new runtime.RequiredError('roleId', 'Required parameter "roleId" was null or undefined when calling updateRole().');
+            }
+            if (requestParameters['putRole'] == null) {
+                throw new runtime.RequiredError('putRole', 'Required parameter "putRole" was null or undefined when calling updateRole().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            let urlPath = `/roles/{roleId}`;
+            urlPath = urlPath.replace(`{${"roleId"}}`, encodeURIComponent(String(requestParameters['roleId'])));
+            return {
+                path: urlPath,
+                method: 'PUT',
+                headers: headerParameters,
+                query: queryParameters,
+                body: PutRoleToJSON(requestParameters['putRole']),
+            };
+        });
+    }
+    /**
+     * Update a custom role name and description
+     */
+    updateRoleRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.updateRoleRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => GetRoleFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Update a custom role name and description
+     */
+    updateRole(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.updateRoleRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for updateRolePermissions without sending the request
+     */
+    updateRolePermissionsRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['roleId'] == null) {
+                throw new runtime.RequiredError('roleId', 'Required parameter "roleId" was null or undefined when calling updateRolePermissions().');
+            }
+            if (requestParameters['putRolePermissions'] == null) {
+                throw new runtime.RequiredError('putRolePermissions', 'Required parameter "putRolePermissions" was null or undefined when calling updateRolePermissions().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            let urlPath = `/roles/{roleId}/permissions`;
+            urlPath = urlPath.replace(`{${"roleId"}}`, encodeURIComponent(String(requestParameters['roleId'])));
+            return {
+                path: urlPath,
+                method: 'PUT',
+                headers: headerParameters,
+                query: queryParameters,
+                body: PutRolePermissionsToJSON(requestParameters['putRolePermissions']),
+            };
+        });
+    }
+    /**
+     * Replace all permissions for a custom role
+     */
+    updateRolePermissionsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.updateRolePermissionsRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Replace all permissions for a custom role
+     */
+    updateRolePermissions(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.updateRolePermissionsRaw(requestParameters, initOverrides);
+        });
+    }
+}

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

@@ -31,6 +31,10 @@ export interface SendResetPasswordRequest {
  *
  */
 export declare class UserApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for getAuthCheck without sending the request
+     */
+    getAuthCheckRequestOpts(): Promise<runtime.RequestOpts>;
     /**
      * Check if a user is logged in
      */
@@ -39,6 +43,10 @@ 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 getUser without sending the request
+     */
+    getUserRequestOpts(requestParameters: GetUserRequest): Promise<runtime.RequestOpts>;
     /**
      * Get a user by id
      */
@@ -47,6 +55,10 @@ export declare class UserApi extends runtime.BaseAPI {
      * Get a user by id
      */
     getUser(requestParameters: GetUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetUser>;
+    /**
+     * Creates request options for postLogin without sending the request
+     */
+    postLoginRequestOpts(requestParameters: PostLoginRequest): Promise<runtime.RequestOpts>;
     /**
      * Post a new login
      */
@@ -55,6 +67,10 @@ export declare class UserApi extends runtime.BaseAPI {
      * Post a new login
      */
     postLogin(requestParameters: PostLoginRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LoginRes>;
+    /**
+     * Creates request options for postLogout without sending the request
+     */
+    postLogoutRequestOpts(): Promise<runtime.RequestOpts>;
     /**
      * Logout a user
      */
@@ -63,6 +79,10 @@ export declare class UserApi extends runtime.BaseAPI {
      * Logout a user
      */
     postLogout(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for putUser without sending the request
+     */
+    putUserRequestOpts(requestParameters: PutUserRequest): Promise<runtime.RequestOpts>;
     /**
      * Update a user by id
      */
@@ -71,6 +91,10 @@ export declare class UserApi extends runtime.BaseAPI {
      * Update a user by id
      */
     putUser(requestParameters: PutUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetUser>;
+    /**
+     * Creates request options for resetPassword without sending the request
+     */
+    resetPasswordRequestOpts(requestParameters: ResetPasswordRequest): Promise<runtime.RequestOpts>;
     /**
      * Reset a users password
      */
@@ -79,6 +103,10 @@ export declare class UserApi extends runtime.BaseAPI {
      * Reset a users password
      */
     resetPassword(requestParameters: ResetPasswordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for sendResetPassword without sending the request
+     */
+    sendResetPasswordRequestOpts(requestParameters: SendResetPasswordRequest): Promise<runtime.RequestOpts>;
     /**
      * Send a reset password email
      */