fineract_sdk
Version:
Wrapper around fineract api.
250 lines (249 loc) • 10.9 kB
TypeScript
/**
* 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';
/**
* SelfDividendApi - axios parameter creator
* @export
*/
export declare const SelfDividendApiAxiosParamCreator: (configuration?: Configuration) => {
/**
*
* @param {number} productId
* @param {string} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createDividendDetail: (productId: number, body?: string, options?: any) => Promise<RequestArgs>;
/**
*
* @param {number} productId
* @param {number} dividendId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteDividendDetail: (productId: number, dividendId: number, options?: any) => Promise<RequestArgs>;
/**
*
* @param {number} productId
* @param {number} [offset]
* @param {number} [limit]
* @param {string} [orderBy]
* @param {string} [sortOrder]
* @param {number} [status]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveAll39: (productId: number, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, status?: number, options?: any) => Promise<RequestArgs>;
/**
*
* @param {number} dividendId
* @param {number} productId
* @param {number} [offset]
* @param {number} [limit]
* @param {string} [orderBy]
* @param {string} [sortOrder]
* @param {string} [accountNo]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveDividendDetails: (dividendId: number, productId: number, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, accountNo?: string, options?: any) => Promise<RequestArgs>;
/**
*
* @param {number} productId
* @param {number} dividendId
* @param {string} [command]
* @param {string} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateDividendDetail: (productId: number, dividendId: number, command?: string, body?: string, options?: any) => Promise<RequestArgs>;
};
/**
* SelfDividendApi - functional programming interface
* @export
*/
export declare const SelfDividendApiFp: (configuration?: Configuration) => {
/**
*
* @param {number} productId
* @param {string} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createDividendDetail(productId: number, body?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
/**
*
* @param {number} productId
* @param {number} dividendId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteDividendDetail(productId: number, dividendId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
/**
*
* @param {number} productId
* @param {number} [offset]
* @param {number} [limit]
* @param {string} [orderBy]
* @param {string} [sortOrder]
* @param {number} [status]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveAll39(productId: number, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, status?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
/**
*
* @param {number} dividendId
* @param {number} productId
* @param {number} [offset]
* @param {number} [limit]
* @param {string} [orderBy]
* @param {string} [sortOrder]
* @param {string} [accountNo]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveDividendDetails(dividendId: number, productId: number, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, accountNo?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
/**
*
* @param {number} productId
* @param {number} dividendId
* @param {string} [command]
* @param {string} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateDividendDetail(productId: number, dividendId: number, command?: string, body?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
};
/**
* SelfDividendApi - factory interface
* @export
*/
export declare const SelfDividendApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
*
* @param {number} productId
* @param {string} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createDividendDetail(productId: number, body?: string, options?: any): AxiosPromise<string>;
/**
*
* @param {number} productId
* @param {number} dividendId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteDividendDetail(productId: number, dividendId: number, options?: any): AxiosPromise<string>;
/**
*
* @param {number} productId
* @param {number} [offset]
* @param {number} [limit]
* @param {string} [orderBy]
* @param {string} [sortOrder]
* @param {number} [status]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveAll39(productId: number, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, status?: number, options?: any): AxiosPromise<string>;
/**
*
* @param {number} dividendId
* @param {number} productId
* @param {number} [offset]
* @param {number} [limit]
* @param {string} [orderBy]
* @param {string} [sortOrder]
* @param {string} [accountNo]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveDividendDetails(dividendId: number, productId: number, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, accountNo?: string, options?: any): AxiosPromise<string>;
/**
*
* @param {number} productId
* @param {number} dividendId
* @param {string} [command]
* @param {string} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateDividendDetail(productId: number, dividendId: number, command?: string, body?: string, options?: any): AxiosPromise<string>;
};
/**
* SelfDividendApi - object-oriented interface
* @export
* @class SelfDividendApi
* @extends {BaseAPI}
*/
export declare class SelfDividendApi extends BaseAPI {
/**
*
* @param {number} productId
* @param {string} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SelfDividendApi
*/
createDividendDetail(productId: number, body?: string, options?: any): Promise<import("axios").AxiosResponse<string>>;
/**
*
* @param {number} productId
* @param {number} dividendId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SelfDividendApi
*/
deleteDividendDetail(productId: number, dividendId: number, options?: any): Promise<import("axios").AxiosResponse<string>>;
/**
*
* @param {number} productId
* @param {number} [offset]
* @param {number} [limit]
* @param {string} [orderBy]
* @param {string} [sortOrder]
* @param {number} [status]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SelfDividendApi
*/
retrieveAll39(productId: number, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, status?: number, options?: any): Promise<import("axios").AxiosResponse<string>>;
/**
*
* @param {number} dividendId
* @param {number} productId
* @param {number} [offset]
* @param {number} [limit]
* @param {string} [orderBy]
* @param {string} [sortOrder]
* @param {string} [accountNo]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SelfDividendApi
*/
retrieveDividendDetails(dividendId: number, productId: number, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, accountNo?: string, options?: any): Promise<import("axios").AxiosResponse<string>>;
/**
*
* @param {number} productId
* @param {number} dividendId
* @param {string} [command]
* @param {string} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SelfDividendApi
*/
updateDividendDetail(productId: number, dividendId: number, command?: string, body?: string, options?: any): Promise<import("axios").AxiosResponse<string>>;
}