@easyedu/js-lsm-api 1.31.0 → 1.33.0

package/src/apis/RoleApi.ts

@@ -0,0 +1,576 @@
+/* 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 * as runtime from '../runtime';
+import type {
+  GetPermission,
+  GetRole,
+  GetUserRole,
+  PostRole,
+  PutRole,
+  PutRolePermissions,
+} from '../models/index';
+import {
+    GetPermissionFromJSON,
+    GetPermissionToJSON,
+    GetRoleFromJSON,
+    GetRoleToJSON,
+    GetUserRoleFromJSON,
+    GetUserRoleToJSON,
+    PostRoleFromJSON,
+    PostRoleToJSON,
+    PutRoleFromJSON,
+    PutRoleToJSON,
+    PutRolePermissionsFromJSON,
+    PutRolePermissionsToJSON,
+} from '../models/index';
+
+export interface AssignUserRoleRequest {
+    userId: string;
+    portalId: string;
+    roleId: string;
+}
+
+export interface CreateRoleRequest {
+    postRole: PostRole;
+}
+
+export interface DeleteRoleRequest {
+    roleId: string;
+}
+
+export interface GetRoleRequest {
+    roleId: string;
+}
+
+export interface GetUserRolesRequest {
+    userId: string;
+    portalId: string;
+}
+
+export interface UnassignUserRoleRequest {
+    userId: string;
+    portalId: string;
+    roleId: string;
+}
+
+export interface UpdateRoleRequest {
+    roleId: string;
+    putRole: PutRole;
+}
+
+export interface UpdateRolePermissionsRequest {
+    roleId: string;
+    putRolePermissions: PutRolePermissions;
+}
+
+/**
+ * 
+ */
+export class RoleApi extends runtime.BaseAPI {
+
+    /**
+     * Creates request options for assignUserRole without sending the request
+     */
+    async assignUserRoleRequestOpts(requestParameters: AssignUserRoleRequest): Promise<runtime.RequestOpts> {
+        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: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        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
+     */
+    async assignUserRoleRaw(requestParameters: AssignUserRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.assignUserRoleRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Assign a role to a user for a portal
+     */
+    async assignUserRole(requestParameters: AssignUserRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.assignUserRoleRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates request options for createRole without sending the request
+     */
+    async createRoleRequestOpts(requestParameters: CreateRoleRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['postRole'] == null) {
+            throw new runtime.RequiredError(
+                'postRole',
+                'Required parameter "postRole" was null or undefined when calling createRole().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        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
+     */
+    async createRoleRaw(requestParameters: CreateRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetRole>> {
+        const requestOptions = await this.createRoleRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetRoleFromJSON(jsonValue));
+    }
+
+    /**
+     * Create a custom role scoped to the current portal
+     */
+    async createRole(requestParameters: CreateRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetRole> {
+        const response = await this.createRoleRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for deleteRole without sending the request
+     */
+    async deleteRoleRequestOpts(requestParameters: DeleteRoleRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['roleId'] == null) {
+            throw new runtime.RequiredError(
+                'roleId',
+                'Required parameter "roleId" was null or undefined when calling deleteRole().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        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
+     */
+    async deleteRoleRaw(requestParameters: DeleteRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.deleteRoleRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Deactivate a custom role
+     */
+    async deleteRole(requestParameters: DeleteRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteRoleRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates request options for getPermissions without sending the request
+     */
+    async getPermissionsRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/roles/permissions`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * List all available permissions in the system
+     */
+    async getPermissionsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetPermission>>> {
+        const requestOptions = await this.getPermissionsRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(GetPermissionFromJSON));
+    }
+
+    /**
+     * List all available permissions in the system
+     */
+    async getPermissions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetPermission>> {
+        const response = await this.getPermissionsRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getRole without sending the request
+     */
+    async getRoleRequestOpts(requestParameters: GetRoleRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['roleId'] == null) {
+            throw new runtime.RequiredError(
+                'roleId',
+                'Required parameter "roleId" was null or undefined when calling getRole().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        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
+     */
+    async getRoleRaw(requestParameters: GetRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetRole>> {
+        const requestOptions = await this.getRoleRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetRoleFromJSON(jsonValue));
+    }
+
+    /**
+     * Get role details with permissions
+     */
+    async getRole(requestParameters: GetRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetRole> {
+        const response = await this.getRoleRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getRoles without sending the request
+     */
+    async getRolesRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/roles`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * List all roles available to the current portal
+     */
+    async getRolesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetRole>>> {
+        const requestOptions = await this.getRolesRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(GetRoleFromJSON));
+    }
+
+    /**
+     * List all roles available to the current portal
+     */
+    async getRoles(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetRole>> {
+        const response = await this.getRolesRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getUserRoles without sending the request
+     */
+    async getUserRolesRequestOpts(requestParameters: GetUserRolesRequest): Promise<runtime.RequestOpts> {
+        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: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        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
+     */
+    async getUserRolesRaw(requestParameters: GetUserRolesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetUserRole>>> {
+        const requestOptions = await this.getUserRolesRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(GetUserRoleFromJSON));
+    }
+
+    /**
+     * Get all active roles for a user in a portal
+     */
+    async getUserRoles(requestParameters: GetUserRolesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetUserRole>> {
+        const response = await this.getUserRolesRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for unassignUserRole without sending the request
+     */
+    async unassignUserRoleRequestOpts(requestParameters: UnassignUserRoleRequest): Promise<runtime.RequestOpts> {
+        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: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        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
+     */
+    async unassignUserRoleRaw(requestParameters: UnassignUserRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.unassignUserRoleRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Remove a role from a user for a portal
+     */
+    async unassignUserRole(requestParameters: UnassignUserRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.unassignUserRoleRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates request options for updateRole without sending the request
+     */
+    async updateRoleRequestOpts(requestParameters: UpdateRoleRequest): Promise<runtime.RequestOpts> {
+        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: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        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
+     */
+    async updateRoleRaw(requestParameters: UpdateRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetRole>> {
+        const requestOptions = await this.updateRoleRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetRoleFromJSON(jsonValue));
+    }
+
+    /**
+     * Update a custom role name and description
+     */
+    async updateRole(requestParameters: UpdateRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetRole> {
+        const response = await this.updateRoleRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for updateRolePermissions without sending the request
+     */
+    async updateRolePermissionsRequestOpts(requestParameters: UpdateRolePermissionsRequest): Promise<runtime.RequestOpts> {
+        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: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        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
+     */
+    async updateRolePermissionsRaw(requestParameters: UpdateRolePermissionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.updateRolePermissionsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Replace all permissions for a custom role
+     */
+    async updateRolePermissions(requestParameters: UpdateRolePermissionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.updateRolePermissionsRaw(requestParameters, initOverrides);
+    }
+
+}