fineract_sdk/dist/api/funds-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 { GetFundsResponse } from '../models';
import { PostFundsRequest } from '../models';
import { PostFundsResponse } from '../models';
import { PutFundsFundIdRequest } from '../models';
import { PutFundsFundIdResponse } from '../models';
/**
 * FundsApi - axios parameter creator
 * @export
 */
export declare const FundsApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Creates a Fund
     * @summary Create a Fund
     * @param {PostFundsRequest} postFundsRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createFund: (postFundsRequest: PostFundsRequest, options?: any) => Promise<RequestArgs>;
    /**
     * Returns the details of a Fund.  Example Requests:  funds/1
     * @summary Retrieve a Fund
     * @param {number} fundId fundId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retreiveFund: (fundId: number, options?: any) => Promise<RequestArgs>;
    /**
     * Returns the list of funds.  Example Requests:  funds
     * @summary Retrieve Funds
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveFunds: (options?: any) => Promise<RequestArgs>;
    /**
     * Updates the details of a fund.
     * @summary Update a Fund
     * @param {number} fundId fundId
     * @param {PutFundsFundIdRequest} putFundsFundIdRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateFund: (fundId: number, putFundsFundIdRequest: PutFundsFundIdRequest, options?: any) => Promise<RequestArgs>;
};
/**
 * FundsApi - functional programming interface
 * @export
 */
export declare const FundsApiFp: (configuration?: Configuration) => {
    /**
     * Creates a Fund
     * @summary Create a Fund
     * @param {PostFundsRequest} postFundsRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createFund(postFundsRequest: PostFundsRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostFundsResponse>>;
    /**
     * Returns the details of a Fund.  Example Requests:  funds/1
     * @summary Retrieve a Fund
     * @param {number} fundId fundId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retreiveFund(fundId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFundsResponse>>;
    /**
     * Returns the list of funds.  Example Requests:  funds
     * @summary Retrieve Funds
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveFunds(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GetFundsResponse>>>;
    /**
     * Updates the details of a fund.
     * @summary Update a Fund
     * @param {number} fundId fundId
     * @param {PutFundsFundIdRequest} putFundsFundIdRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateFund(fundId: number, putFundsFundIdRequest: PutFundsFundIdRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutFundsFundIdResponse>>;
};
/**
 * FundsApi - factory interface
 * @export
 */
export declare const FundsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * Creates a Fund
     * @summary Create a Fund
     * @param {PostFundsRequest} postFundsRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createFund(postFundsRequest: PostFundsRequest, options?: any): AxiosPromise<PostFundsResponse>;
    /**
     * Returns the details of a Fund.  Example Requests:  funds/1
     * @summary Retrieve a Fund
     * @param {number} fundId fundId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retreiveFund(fundId: number, options?: any): AxiosPromise<GetFundsResponse>;
    /**
     * Returns the list of funds.  Example Requests:  funds
     * @summary Retrieve Funds
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveFunds(options?: any): AxiosPromise<Array<GetFundsResponse>>;
    /**
     * Updates the details of a fund.
     * @summary Update a Fund
     * @param {number} fundId fundId
     * @param {PutFundsFundIdRequest} putFundsFundIdRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateFund(fundId: number, putFundsFundIdRequest: PutFundsFundIdRequest, options?: any): AxiosPromise<PutFundsFundIdResponse>;
};
/**
 * FundsApi - object-oriented interface
 * @export
 * @class FundsApi
 * @extends {BaseAPI}
 */
export declare class FundsApi extends BaseAPI {
    /**
     * Creates a Fund
     * @summary Create a Fund
     * @param {PostFundsRequest} postFundsRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof FundsApi
     */
    createFund(postFundsRequest: PostFundsRequest, options?: any): Promise<import("axios").AxiosResponse<PostFundsResponse>>;
    /**
     * Returns the details of a Fund.  Example Requests:  funds/1
     * @summary Retrieve a Fund
     * @param {number} fundId fundId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof FundsApi
     */
    retreiveFund(fundId: number, options?: any): Promise<import("axios").AxiosResponse<GetFundsResponse>>;
    /**
     * Returns the list of funds.  Example Requests:  funds
     * @summary Retrieve Funds
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof FundsApi
     */
    retrieveFunds(options?: any): Promise<import("axios").AxiosResponse<GetFundsResponse[]>>;
    /**
     * Updates the details of a fund.
     * @summary Update a Fund
     * @param {number} fundId fundId
     * @param {PutFundsFundIdRequest} putFundsFundIdRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof FundsApi
     */
    updateFund(fundId: number, putFundsFundIdRequest: PutFundsFundIdRequest, options?: any): Promise<import("axios").AxiosResponse<PutFundsFundIdResponse>>;
}