UNPKG

fineract_sdk

Version:

Wrapper around fineract api.

75 lines (74 loc) 4.14 kB
/** * 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 { GetRunReportResponse } from '../models'; /** * SelfRunReportApi - axios parameter creator * @export */ export declare const SelfRunReportApiAxiosParamCreator: (configuration?: Configuration) => { /** * Example Requests: self/runreports/Client%20Details?R_officeId=1 self/runreports/Client%20Details?R_officeId=1&exportCSV=true * @summary Running A Report * @param {string} reportName reportName * @param {*} [options] Override http request option. * @throws {RequiredError} */ runReport1: (reportName: string, options?: any) => Promise<RequestArgs>; }; /** * SelfRunReportApi - functional programming interface * @export */ export declare const SelfRunReportApiFp: (configuration?: Configuration) => { /** * Example Requests: self/runreports/Client%20Details?R_officeId=1 self/runreports/Client%20Details?R_officeId=1&exportCSV=true * @summary Running A Report * @param {string} reportName reportName * @param {*} [options] Override http request option. * @throws {RequiredError} */ runReport1(reportName: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetRunReportResponse>>; }; /** * SelfRunReportApi - factory interface * @export */ export declare const SelfRunReportApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Example Requests: self/runreports/Client%20Details?R_officeId=1 self/runreports/Client%20Details?R_officeId=1&exportCSV=true * @summary Running A Report * @param {string} reportName reportName * @param {*} [options] Override http request option. * @throws {RequiredError} */ runReport1(reportName: string, options?: any): AxiosPromise<GetRunReportResponse>; }; /** * SelfRunReportApi - object-oriented interface * @export * @class SelfRunReportApi * @extends {BaseAPI} */ export declare class SelfRunReportApi extends BaseAPI { /** * Example Requests: self/runreports/Client%20Details?R_officeId=1 self/runreports/Client%20Details?R_officeId=1&exportCSV=true * @summary Running A Report * @param {string} reportName reportName * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SelfRunReportApi */ runReport1(reportName: string, options?: any): Promise<import("axios").AxiosResponse<GetRunReportResponse>>; }