fineract_sdk
Version:
Wrapper around fineract api.
242 lines (241 loc) • 11.8 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 { DeleteReportsResponse } from '../models';
import { GetReportsResponse } from '../models';
import { GetReportsTemplateResponse } from '../models';
import { PostReportsResponse } from '../models';
import { PostRepostRequest } from '../models';
import { PutReportRequest } from '../models';
import { PutReportResponse } from '../models';
/**
* ReportsApi - axios parameter creator
* @export
*/
export declare const ReportsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
*
* @summary Create a Report
* @param {PostRepostRequest} postRepostRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createReport: (postRepostRequest: PostRepostRequest, options?: any) => Promise<RequestArgs>;
/**
* Only non-core reports can be deleted.
* @summary Delete a Report
* @param {number} id id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteReport: (id: number, options?: any) => Promise<RequestArgs>;
/**
* Example Requests: reports/1 reports/1?template=true
* @summary Retrieve a Report
* @param {number} id id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveReport: (id: number, options?: any) => Promise<RequestArgs>;
/**
* Lists all reports and their parameters. Example Request: reports
* @summary List Reports
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveReportList: (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 : reports/template
* @summary Retrieve Report Template
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveReportTemplate: (options?: any) => Promise<RequestArgs>;
/**
* Only the useReport description can be updated for core reports.
* @summary Update a Report
* @param {number} id id
* @param {PutReportRequest} putReportRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateReport: (id: number, putReportRequest: PutReportRequest, options?: any) => Promise<RequestArgs>;
};
/**
* ReportsApi - functional programming interface
* @export
*/
export declare const ReportsApiFp: (configuration?: Configuration) => {
/**
*
* @summary Create a Report
* @param {PostRepostRequest} postRepostRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createReport(postRepostRequest: PostRepostRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostReportsResponse>>;
/**
* Only non-core reports can be deleted.
* @summary Delete a Report
* @param {number} id id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteReport(id: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteReportsResponse>>;
/**
* Example Requests: reports/1 reports/1?template=true
* @summary Retrieve a Report
* @param {number} id id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveReport(id: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetReportsResponse>>;
/**
* Lists all reports and their parameters. Example Request: reports
* @summary List Reports
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveReportList(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GetReportsResponse>>>;
/**
* 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 : reports/template
* @summary Retrieve Report Template
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveReportTemplate(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetReportsTemplateResponse>>;
/**
* Only the useReport description can be updated for core reports.
* @summary Update a Report
* @param {number} id id
* @param {PutReportRequest} putReportRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateReport(id: number, putReportRequest: PutReportRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutReportResponse>>;
};
/**
* ReportsApi - factory interface
* @export
*/
export declare const ReportsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
*
* @summary Create a Report
* @param {PostRepostRequest} postRepostRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createReport(postRepostRequest: PostRepostRequest, options?: any): AxiosPromise<PostReportsResponse>;
/**
* Only non-core reports can be deleted.
* @summary Delete a Report
* @param {number} id id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteReport(id: number, options?: any): AxiosPromise<DeleteReportsResponse>;
/**
* Example Requests: reports/1 reports/1?template=true
* @summary Retrieve a Report
* @param {number} id id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveReport(id: number, options?: any): AxiosPromise<GetReportsResponse>;
/**
* Lists all reports and their parameters. Example Request: reports
* @summary List Reports
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveReportList(options?: any): AxiosPromise<Array<GetReportsResponse>>;
/**
* 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 : reports/template
* @summary Retrieve Report Template
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveReportTemplate(options?: any): AxiosPromise<GetReportsTemplateResponse>;
/**
* Only the useReport description can be updated for core reports.
* @summary Update a Report
* @param {number} id id
* @param {PutReportRequest} putReportRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateReport(id: number, putReportRequest: PutReportRequest, options?: any): AxiosPromise<PutReportResponse>;
};
/**
* ReportsApi - object-oriented interface
* @export
* @class ReportsApi
* @extends {BaseAPI}
*/
export declare class ReportsApi extends BaseAPI {
/**
*
* @summary Create a Report
* @param {PostRepostRequest} postRepostRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ReportsApi
*/
createReport(postRepostRequest: PostRepostRequest, options?: any): Promise<import("axios").AxiosResponse<PostReportsResponse>>;
/**
* Only non-core reports can be deleted.
* @summary Delete a Report
* @param {number} id id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ReportsApi
*/
deleteReport(id: number, options?: any): Promise<import("axios").AxiosResponse<DeleteReportsResponse>>;
/**
* Example Requests: reports/1 reports/1?template=true
* @summary Retrieve a Report
* @param {number} id id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ReportsApi
*/
retrieveReport(id: number, options?: any): Promise<import("axios").AxiosResponse<GetReportsResponse>>;
/**
* Lists all reports and their parameters. Example Request: reports
* @summary List Reports
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ReportsApi
*/
retrieveReportList(options?: any): Promise<import("axios").AxiosResponse<GetReportsResponse[]>>;
/**
* 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 : reports/template
* @summary Retrieve Report Template
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ReportsApi
*/
retrieveReportTemplate(options?: any): Promise<import("axios").AxiosResponse<GetReportsTemplateResponse>>;
/**
* Only the useReport description can be updated for core reports.
* @summary Update a Report
* @param {number} id id
* @param {PutReportRequest} putReportRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ReportsApi
*/
updateReport(id: number, putReportRequest: PutReportRequest, options?: any): Promise<import("axios").AxiosResponse<PutReportResponse>>;
}