fineract_sdk/dist/src/api/roles-api.d.ts

Wrapper around fineract api.

/**
 * Apache Fineract
 * Apache Fineract is a secure, multi-tenanted microfinance platform  The goal of the Apache Fineract API is to empower developers to build apps on top of the Apache Fineract Platform<br>The [reference app](https://cui.fineract.dev) (username: mifos, password: password) works on the same demo tenant as the interactive links in this documentation  - The API is organized around [REST](https://en.wikipedia.org/wiki/Representational_state_transfer) - Find out more about Apache Fineract [here](/fineract-provider/api-docs/apiLive.htm#top) - You can [Try The API From Your Browser](/fineract-provider/api-docs/apiLive.htm#interact) - The Generic Options are available [here](/fineract-provider/api-docs/apiLive.htm#genopts) - Find out more about [Updating Dates and Numbers](/fineract-provider/api-docs/apiLive.htm#dates_and_numbers) - For the Authentication and the Basic of HTTP and HTTPS refer [here](/fineract-provider/api-docs/apiLive.htm#authentication_overview) - Check about ERROR codes [here](/fineract-provider/api-docs/apiLive.htm#errors)  Please refer to the [old documentation](/fineract-provider/api-docs/apiLive.htm) for any documentation queries
 *
 * The version of the OpenAPI document: 1.5.0-66-gffae7d4-dirty
 * Contact: dev@fineract.apache.org
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import { AxiosPromise, AxiosInstance } from 'axios';
import { Configuration } from '../configuration';
import { RequestArgs, BaseAPI } from '../base';
import { DeleteRolesRoleIdResponse } from '../models';
import { GetRolesResponse } from '../models';
import { GetRolesRoleIdPermissionsResponse } from '../models';
import { GetRolesRoleIdResponse } from '../models';
import { PostRolesRequest } from '../models';
import { PostRolesResponse } from '../models';
import { PostRolesRoleIdResponse } from '../models';
import { PutRolesRoleIdPermissionsRequest } from '../models';
import { PutRolesRoleIdPermissionsResponse } from '../models';
import { PutRolesRoleIdRequest } from '../models';
import { PutRolesRoleIdResponse } from '../models';
/**
 * RolesApi - axios parameter creator
 * @export
 */
export declare const RolesApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Description : Enable role in case role is disabled. | Disable the role in case role is not associated with any users.      Example Request:   https://DomainName/api/v1/roles/{roleId}?command=enable      https://DomainName/api/v1/roles/{roleId}?command=disable
     * @summary Enable Role | Disable Role
     * @param {number} roleId roleId
     * @param {string} [command] command
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    actionsOnRoles: (roleId: number, command?: string, options?: any) => Promise<RequestArgs>;
    /**
     * Mandatory Fields name, description
     * @summary Create a New Role
     * @param {PostRolesRequest} postRolesRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createRole: (postRolesRequest: PostRolesRequest, options?: any) => Promise<RequestArgs>;
    /**
     * Description : Delete the role in case role is not associated with any users.
     * @summary Delete a Role
     * @param {number} roleId roleId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteRole: (roleId: number, options?: any) => Promise<RequestArgs>;
    /**
     * Example Requests:  roles   roles?fields=name
     * @summary List Roles
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveAllRoles: (options?: any) => Promise<RequestArgs>;
    /**
     * Example Requests:  roles/1   roles/1?fields=name
     * @summary Retrieve a Role
     * @param {number} roleId roleId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveRole: (roleId: number, options?: any) => Promise<RequestArgs>;
    /**
     * Example Requests:  roles/1/permissions
     * @summary Retrieve a Role\'s Permissions
     * @param {number} roleId roleId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveRolePermissions: (roleId: number, options?: any) => Promise<RequestArgs>;
    /**
     *
     * @summary Update a Role
     * @param {number} roleId roleId
     * @param {PutRolesRoleIdRequest} putRolesRoleIdRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateRole: (roleId: number, putRolesRoleIdRequest: PutRolesRoleIdRequest, options?: any) => Promise<RequestArgs>;
    /**
     *
     * @summary Update a Role\'s Permissions
     * @param {number} roleId roleId
     * @param {PutRolesRoleIdPermissionsRequest} putRolesRoleIdPermissionsRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateRolePermissions: (roleId: number, putRolesRoleIdPermissionsRequest: PutRolesRoleIdPermissionsRequest, options?: any) => Promise<RequestArgs>;
};
/**
 * RolesApi - functional programming interface
 * @export
 */
export declare const RolesApiFp: (configuration?: Configuration) => {
    /**
     * Description : Enable role in case role is disabled. | Disable the role in case role is not associated with any users.      Example Request:   https://DomainName/api/v1/roles/{roleId}?command=enable      https://DomainName/api/v1/roles/{roleId}?command=disable
     * @summary Enable Role | Disable Role
     * @param {number} roleId roleId
     * @param {string} [command] command
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    actionsOnRoles(roleId: number, command?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostRolesRoleIdResponse>>;
    /**
     * Mandatory Fields name, description
     * @summary Create a New Role
     * @param {PostRolesRequest} postRolesRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createRole(postRolesRequest: PostRolesRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostRolesResponse>>;
    /**
     * Description : Delete the role in case role is not associated with any users.
     * @summary Delete a Role
     * @param {number} roleId roleId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteRole(roleId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteRolesRoleIdResponse>>;
    /**
     * Example Requests:  roles   roles?fields=name
     * @summary List Roles
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveAllRoles(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GetRolesResponse>>>;
    /**
     * Example Requests:  roles/1   roles/1?fields=name
     * @summary Retrieve a Role
     * @param {number} roleId roleId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveRole(roleId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetRolesRoleIdResponse>>;
    /**
     * Example Requests:  roles/1/permissions
     * @summary Retrieve a Role\'s Permissions
     * @param {number} roleId roleId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveRolePermissions(roleId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetRolesRoleIdPermissionsResponse>>;
    /**
     *
     * @summary Update a Role
     * @param {number} roleId roleId
     * @param {PutRolesRoleIdRequest} putRolesRoleIdRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateRole(roleId: number, putRolesRoleIdRequest: PutRolesRoleIdRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutRolesRoleIdResponse>>;
    /**
     *
     * @summary Update a Role\'s Permissions
     * @param {number} roleId roleId
     * @param {PutRolesRoleIdPermissionsRequest} putRolesRoleIdPermissionsRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateRolePermissions(roleId: number, putRolesRoleIdPermissionsRequest: PutRolesRoleIdPermissionsRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutRolesRoleIdPermissionsResponse>>;
};
/**
 * RolesApi - factory interface
 * @export
 */
export declare const RolesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * Description : Enable role in case role is disabled. | Disable the role in case role is not associated with any users.      Example Request:   https://DomainName/api/v1/roles/{roleId}?command=enable      https://DomainName/api/v1/roles/{roleId}?command=disable
     * @summary Enable Role | Disable Role
     * @param {number} roleId roleId
     * @param {string} [command] command
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    actionsOnRoles(roleId: number, command?: string, options?: any): AxiosPromise<PostRolesRoleIdResponse>;
    /**
     * Mandatory Fields name, description
     * @summary Create a New Role
     * @param {PostRolesRequest} postRolesRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createRole(postRolesRequest: PostRolesRequest, options?: any): AxiosPromise<PostRolesResponse>;
    /**
     * Description : Delete the role in case role is not associated with any users.
     * @summary Delete a Role
     * @param {number} roleId roleId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteRole(roleId: number, options?: any): AxiosPromise<DeleteRolesRoleIdResponse>;
    /**
     * Example Requests:  roles   roles?fields=name
     * @summary List Roles
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveAllRoles(options?: any): AxiosPromise<Array<GetRolesResponse>>;
    /**
     * Example Requests:  roles/1   roles/1?fields=name
     * @summary Retrieve a Role
     * @param {number} roleId roleId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveRole(roleId: number, options?: any): AxiosPromise<GetRolesRoleIdResponse>;
    /**
     * Example Requests:  roles/1/permissions
     * @summary Retrieve a Role\'s Permissions
     * @param {number} roleId roleId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveRolePermissions(roleId: number, options?: any): AxiosPromise<GetRolesRoleIdPermissionsResponse>;
    /**
     *
     * @summary Update a Role
     * @param {number} roleId roleId
     * @param {PutRolesRoleIdRequest} putRolesRoleIdRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateRole(roleId: number, putRolesRoleIdRequest: PutRolesRoleIdRequest, options?: any): AxiosPromise<PutRolesRoleIdResponse>;
    /**
     *
     * @summary Update a Role\'s Permissions
     * @param {number} roleId roleId
     * @param {PutRolesRoleIdPermissionsRequest} putRolesRoleIdPermissionsRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateRolePermissions(roleId: number, putRolesRoleIdPermissionsRequest: PutRolesRoleIdPermissionsRequest, options?: any): AxiosPromise<PutRolesRoleIdPermissionsResponse>;
};
/**
 * RolesApi - object-oriented interface
 * @export
 * @class RolesApi
 * @extends {BaseAPI}
 */
export declare class RolesApi extends BaseAPI {
    /**
     * Description : Enable role in case role is disabled. | Disable the role in case role is not associated with any users.      Example Request:   https://DomainName/api/v1/roles/{roleId}?command=enable      https://DomainName/api/v1/roles/{roleId}?command=disable
     * @summary Enable Role | Disable Role
     * @param {number} roleId roleId
     * @param {string} [command] command
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof RolesApi
     */
    actionsOnRoles(roleId: number, command?: string, options?: any): Promise<import("axios").AxiosResponse<PostRolesRoleIdResponse>>;
    /**
     * Mandatory Fields name, description
     * @summary Create a New Role
     * @param {PostRolesRequest} postRolesRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof RolesApi
     */
    createRole(postRolesRequest: PostRolesRequest, options?: any): Promise<import("axios").AxiosResponse<PostRolesResponse>>;
    /**
     * Description : Delete the role in case role is not associated with any users.
     * @summary Delete a Role
     * @param {number} roleId roleId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof RolesApi
     */
    deleteRole(roleId: number, options?: any): Promise<import("axios").AxiosResponse<DeleteRolesRoleIdResponse>>;
    /**
     * Example Requests:  roles   roles?fields=name
     * @summary List Roles
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof RolesApi
     */
    retrieveAllRoles(options?: any): Promise<import("axios").AxiosResponse<GetRolesResponse[]>>;
    /**
     * Example Requests:  roles/1   roles/1?fields=name
     * @summary Retrieve a Role
     * @param {number} roleId roleId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof RolesApi
     */
    retrieveRole(roleId: number, options?: any): Promise<import("axios").AxiosResponse<GetRolesRoleIdResponse>>;
    /**
     * Example Requests:  roles/1/permissions
     * @summary Retrieve a Role\'s Permissions
     * @param {number} roleId roleId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof RolesApi
     */
    retrieveRolePermissions(roleId: number, options?: any): Promise<import("axios").AxiosResponse<GetRolesRoleIdPermissionsResponse>>;
    /**
     *
     * @summary Update a Role
     * @param {number} roleId roleId
     * @param {PutRolesRoleIdRequest} putRolesRoleIdRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof RolesApi
     */
    updateRole(roleId: number, putRolesRoleIdRequest: PutRolesRoleIdRequest, options?: any): Promise<import("axios").AxiosResponse<PutRolesRoleIdResponse>>;
    /**
     *
     * @summary Update a Role\'s Permissions
     * @param {number} roleId roleId
     * @param {PutRolesRoleIdPermissionsRequest} putRolesRoleIdPermissionsRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof RolesApi
     */
    updateRolePermissions(roleId: number, putRolesRoleIdPermissionsRequest: PutRolesRoleIdPermissionsRequest, options?: any): Promise<import("axios").AxiosResponse<PutRolesRoleIdPermissionsResponse>>;
}