fineract_sdk
Version:
Wrapper around fineract api.
212 lines (211 loc) • 9.98 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';
import { DeleteCodesResponse } from '../models';
import { GetCodesResponse } from '../models';
import { PostCodesRequest } from '../models';
import { PostCodesResponse } from '../models';
import { PutCodesRequest } from '../models';
import { PutCodesResponse } from '../models';
/**
* CodesApi - axios parameter creator
* @export
*/
export declare const CodesApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Creates a code. Codes created through api are always \'user defined\' and so system defined is marked as false.
* @summary Create a Code
* @param {PostCodesRequest} postCodesRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createCode: (postCodesRequest: PostCodesRequest, options?: any) => Promise<RequestArgs>;
/**
* Deletes a code if it is not system defined.
* @summary Delete a Code
* @param {number} codeId codeId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteCode: (codeId: number, options?: any) => Promise<RequestArgs>;
/**
* Returns the details of a Code. Example Requests: codes/1
* @summary Retrieve a Code
* @param {number} codeId codeId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveCode: (codeId: number, options?: any) => Promise<RequestArgs>;
/**
* Returns the list of codes. Example Requests: codes
* @summary Retrieve Codes
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveCodes: (options?: any) => Promise<RequestArgs>;
/**
* Updates the details of a code if it is not system defined.
* @summary Update a Code
* @param {number} codeId codeId
* @param {PutCodesRequest} putCodesRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateCode: (codeId: number, putCodesRequest: PutCodesRequest, options?: any) => Promise<RequestArgs>;
};
/**
* CodesApi - functional programming interface
* @export
*/
export declare const CodesApiFp: (configuration?: Configuration) => {
/**
* Creates a code. Codes created through api are always \'user defined\' and so system defined is marked as false.
* @summary Create a Code
* @param {PostCodesRequest} postCodesRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createCode(postCodesRequest: PostCodesRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostCodesResponse>>;
/**
* Deletes a code if it is not system defined.
* @summary Delete a Code
* @param {number} codeId codeId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteCode(codeId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteCodesResponse>>;
/**
* Returns the details of a Code. Example Requests: codes/1
* @summary Retrieve a Code
* @param {number} codeId codeId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveCode(codeId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCodesResponse>>;
/**
* Returns the list of codes. Example Requests: codes
* @summary Retrieve Codes
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveCodes(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GetCodesResponse>>>;
/**
* Updates the details of a code if it is not system defined.
* @summary Update a Code
* @param {number} codeId codeId
* @param {PutCodesRequest} putCodesRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateCode(codeId: number, putCodesRequest: PutCodesRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutCodesResponse>>;
};
/**
* CodesApi - factory interface
* @export
*/
export declare const CodesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Creates a code. Codes created through api are always \'user defined\' and so system defined is marked as false.
* @summary Create a Code
* @param {PostCodesRequest} postCodesRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createCode(postCodesRequest: PostCodesRequest, options?: any): AxiosPromise<PostCodesResponse>;
/**
* Deletes a code if it is not system defined.
* @summary Delete a Code
* @param {number} codeId codeId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteCode(codeId: number, options?: any): AxiosPromise<DeleteCodesResponse>;
/**
* Returns the details of a Code. Example Requests: codes/1
* @summary Retrieve a Code
* @param {number} codeId codeId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveCode(codeId: number, options?: any): AxiosPromise<GetCodesResponse>;
/**
* Returns the list of codes. Example Requests: codes
* @summary Retrieve Codes
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveCodes(options?: any): AxiosPromise<Array<GetCodesResponse>>;
/**
* Updates the details of a code if it is not system defined.
* @summary Update a Code
* @param {number} codeId codeId
* @param {PutCodesRequest} putCodesRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateCode(codeId: number, putCodesRequest: PutCodesRequest, options?: any): AxiosPromise<PutCodesResponse>;
};
/**
* CodesApi - object-oriented interface
* @export
* @class CodesApi
* @extends {BaseAPI}
*/
export declare class CodesApi extends BaseAPI {
/**
* Creates a code. Codes created through api are always \'user defined\' and so system defined is marked as false.
* @summary Create a Code
* @param {PostCodesRequest} postCodesRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CodesApi
*/
createCode(postCodesRequest: PostCodesRequest, options?: any): Promise<import("axios").AxiosResponse<PostCodesResponse>>;
/**
* Deletes a code if it is not system defined.
* @summary Delete a Code
* @param {number} codeId codeId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CodesApi
*/
deleteCode(codeId: number, options?: any): Promise<import("axios").AxiosResponse<DeleteCodesResponse>>;
/**
* Returns the details of a Code. Example Requests: codes/1
* @summary Retrieve a Code
* @param {number} codeId codeId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CodesApi
*/
retrieveCode(codeId: number, options?: any): Promise<import("axios").AxiosResponse<GetCodesResponse>>;
/**
* Returns the list of codes. Example Requests: codes
* @summary Retrieve Codes
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CodesApi
*/
retrieveCodes(options?: any): Promise<import("axios").AxiosResponse<GetCodesResponse[]>>;
/**
* Updates the details of a code if it is not system defined.
* @summary Update a Code
* @param {number} codeId codeId
* @param {PutCodesRequest} putCodesRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CodesApi
*/
updateCode(codeId: number, putCodesRequest: PutCodesRequest, options?: any): Promise<import("axios").AxiosResponse<PutCodesResponse>>;
}