fineract_sdk/dist/src/api/users-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 { DeleteUsersUserIdResponse } from '../models';
import { FormDataContentDisposition } from '../models';
import { GetUsersResponse } from '../models';
import { GetUsersTemplateResponse } from '../models';
import { GetUsersUserIdResponse } from '../models';
import { PostUsersRequest } from '../models';
import { PostUsersResponse } from '../models';
import { PutUsersUserIdRequest } from '../models';
import { PutUsersUserIdResponse } from '../models';
/**
 * UsersApi - axios parameter creator
 * @export
 */
export declare const UsersApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Adds new application user.  Note: Password information is not required (or processed). Password details at present are auto-generated and then sent to the email account given (which is why it can take a few seconds to complete).  Mandatory Fields:  username, firstname, lastname, email, officeId, roles, sendPasswordToEmail  Optional Fields:  staffId,passwordNeverExpires,isSelfServiceUser,clients
     * @summary Create a User
     * @param {PostUsersRequest} postUsersRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    create15: (postUsersRequest: PostUsersRequest, options?: any) => Promise<RequestArgs>;
    /**
     * Removes the user and the associated roles and permissions.
     * @summary Delete a User
     * @param {number} userId userId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    delete21: (userId: number, options?: any) => Promise<RequestArgs>;
    /**
     *
     * @param {number} [officeId]
     * @param {number} [staffId]
     * @param {string} [dateFormat]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getUserTemplate: (officeId?: number, staffId?: number, dateFormat?: string, options?: any) => Promise<RequestArgs>;
    /**
     *
     * @param {FormDataContentDisposition} [file]
     * @param {string} [locale]
     * @param {string} [dateFormat]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    postUsersTemplate: (file?: any, locale?: string, dateFormat?: string, options?: any) => Promise<RequestArgs>;
    /**
     * Example Requests:  users   users?fields=id,username,email,officeName
     * @summary Retrieve list of users
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveAll41: (options?: any) => Promise<RequestArgs>;
    /**
     * Example Requests:  users/1   users/1?template=true   users/1?fields=username,officeName
     * @summary Retrieve a User
     * @param {number} userId userId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveOne29: (userId: number, options?: any) => Promise<RequestArgs>;
    /**
     * This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of:  Field Defaults Allowed description Lists Example Request:  users/template
     * @summary Retrieve User Details Template
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    template22: (options?: any) => Promise<RequestArgs>;
    /**
     * When updating a password you must provide the repeatPassword parameter also.
     * @summary Update a User
     * @param {number} userId userId
     * @param {PutUsersUserIdRequest} putUsersUserIdRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    update24: (userId: number, putUsersUserIdRequest: PutUsersUserIdRequest, options?: any) => Promise<RequestArgs>;
};
/**
 * UsersApi - functional programming interface
 * @export
 */
export declare const UsersApiFp: (configuration?: Configuration) => {
    /**
     * Adds new application user.  Note: Password information is not required (or processed). Password details at present are auto-generated and then sent to the email account given (which is why it can take a few seconds to complete).  Mandatory Fields:  username, firstname, lastname, email, officeId, roles, sendPasswordToEmail  Optional Fields:  staffId,passwordNeverExpires,isSelfServiceUser,clients
     * @summary Create a User
     * @param {PostUsersRequest} postUsersRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    create15(postUsersRequest: PostUsersRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostUsersResponse>>;
    /**
     * Removes the user and the associated roles and permissions.
     * @summary Delete a User
     * @param {number} userId userId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    delete21(userId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteUsersUserIdResponse>>;
    /**
     *
     * @param {number} [officeId]
     * @param {number} [staffId]
     * @param {string} [dateFormat]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getUserTemplate(officeId?: number, staffId?: number, dateFormat?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     *
     * @param {FormDataContentDisposition} [file]
     * @param {string} [locale]
     * @param {string} [dateFormat]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    postUsersTemplate(file?: any, locale?: string, dateFormat?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
    /**
     * Example Requests:  users   users?fields=id,username,email,officeName
     * @summary Retrieve list of users
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveAll41(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GetUsersResponse>>>;
    /**
     * Example Requests:  users/1   users/1?template=true   users/1?fields=username,officeName
     * @summary Retrieve a User
     * @param {number} userId userId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveOne29(userId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetUsersUserIdResponse>>;
    /**
     * This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of:  Field Defaults Allowed description Lists Example Request:  users/template
     * @summary Retrieve User Details Template
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    template22(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetUsersTemplateResponse>>;
    /**
     * When updating a password you must provide the repeatPassword parameter also.
     * @summary Update a User
     * @param {number} userId userId
     * @param {PutUsersUserIdRequest} putUsersUserIdRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    update24(userId: number, putUsersUserIdRequest: PutUsersUserIdRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutUsersUserIdResponse>>;
};
/**
 * UsersApi - factory interface
 * @export
 */
export declare const UsersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * Adds new application user.  Note: Password information is not required (or processed). Password details at present are auto-generated and then sent to the email account given (which is why it can take a few seconds to complete).  Mandatory Fields:  username, firstname, lastname, email, officeId, roles, sendPasswordToEmail  Optional Fields:  staffId,passwordNeverExpires,isSelfServiceUser,clients
     * @summary Create a User
     * @param {PostUsersRequest} postUsersRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    create15(postUsersRequest: PostUsersRequest, options?: any): AxiosPromise<PostUsersResponse>;
    /**
     * Removes the user and the associated roles and permissions.
     * @summary Delete a User
     * @param {number} userId userId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    delete21(userId: number, options?: any): AxiosPromise<DeleteUsersUserIdResponse>;
    /**
     *
     * @param {number} [officeId]
     * @param {number} [staffId]
     * @param {string} [dateFormat]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getUserTemplate(officeId?: number, staffId?: number, dateFormat?: string, options?: any): AxiosPromise<void>;
    /**
     *
     * @param {FormDataContentDisposition} [file]
     * @param {string} [locale]
     * @param {string} [dateFormat]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    postUsersTemplate(file?: any, locale?: string, dateFormat?: string, options?: any): AxiosPromise<string>;
    /**
     * Example Requests:  users   users?fields=id,username,email,officeName
     * @summary Retrieve list of users
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveAll41(options?: any): AxiosPromise<Array<GetUsersResponse>>;
    /**
     * Example Requests:  users/1   users/1?template=true   users/1?fields=username,officeName
     * @summary Retrieve a User
     * @param {number} userId userId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveOne29(userId: number, options?: any): AxiosPromise<GetUsersUserIdResponse>;
    /**
     * This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of:  Field Defaults Allowed description Lists Example Request:  users/template
     * @summary Retrieve User Details Template
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    template22(options?: any): AxiosPromise<GetUsersTemplateResponse>;
    /**
     * When updating a password you must provide the repeatPassword parameter also.
     * @summary Update a User
     * @param {number} userId userId
     * @param {PutUsersUserIdRequest} putUsersUserIdRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    update24(userId: number, putUsersUserIdRequest: PutUsersUserIdRequest, options?: any): AxiosPromise<PutUsersUserIdResponse>;
};
/**
 * UsersApi - object-oriented interface
 * @export
 * @class UsersApi
 * @extends {BaseAPI}
 */
export declare class UsersApi extends BaseAPI {
    /**
     * Adds new application user.  Note: Password information is not required (or processed). Password details at present are auto-generated and then sent to the email account given (which is why it can take a few seconds to complete).  Mandatory Fields:  username, firstname, lastname, email, officeId, roles, sendPasswordToEmail  Optional Fields:  staffId,passwordNeverExpires,isSelfServiceUser,clients
     * @summary Create a User
     * @param {PostUsersRequest} postUsersRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof UsersApi
     */
    create15(postUsersRequest: PostUsersRequest, options?: any): Promise<import("axios").AxiosResponse<PostUsersResponse>>;
    /**
     * Removes the user and the associated roles and permissions.
     * @summary Delete a User
     * @param {number} userId userId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof UsersApi
     */
    delete21(userId: number, options?: any): Promise<import("axios").AxiosResponse<DeleteUsersUserIdResponse>>;
    /**
     *
     * @param {number} [officeId]
     * @param {number} [staffId]
     * @param {string} [dateFormat]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof UsersApi
     */
    getUserTemplate(officeId?: number, staffId?: number, dateFormat?: string, options?: any): Promise<import("axios").AxiosResponse<void>>;
    /**
     *
     * @param {FormDataContentDisposition} [file]
     * @param {string} [locale]
     * @param {string} [dateFormat]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof UsersApi
     */
    postUsersTemplate(file?: FormDataContentDisposition, locale?: string, dateFormat?: string, options?: any): Promise<import("axios").AxiosResponse<string>>;
    /**
     * Example Requests:  users   users?fields=id,username,email,officeName
     * @summary Retrieve list of users
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof UsersApi
     */
    retrieveAll41(options?: any): Promise<import("axios").AxiosResponse<GetUsersResponse[]>>;
    /**
     * Example Requests:  users/1   users/1?template=true   users/1?fields=username,officeName
     * @summary Retrieve a User
     * @param {number} userId userId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof UsersApi
     */
    retrieveOne29(userId: number, options?: any): Promise<import("axios").AxiosResponse<GetUsersUserIdResponse>>;
    /**
     * This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of:  Field Defaults Allowed description Lists Example Request:  users/template
     * @summary Retrieve User Details Template
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof UsersApi
     */
    template22(options?: any): Promise<import("axios").AxiosResponse<GetUsersTemplateResponse>>;
    /**
     * When updating a password you must provide the repeatPassword parameter also.
     * @summary Update a User
     * @param {number} userId userId
     * @param {PutUsersUserIdRequest} putUsersUserIdRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof UsersApi
     */
    update24(userId: number, putUsersUserIdRequest: PutUsersUserIdRequest, options?: any): Promise<import("axios").AxiosResponse<PutUsersUserIdResponse>>;
}