UNPKG

fineract_sdk

Version:

Wrapper around fineract api.

136 lines (135 loc) 7.09 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 { GetWorkingDaysResponse } from '../models'; import { GetWorkingDaysTemplateResponse } from '../models'; import { PutWorkingDaysRequest } from '../models'; import { PutWorkingDaysResponse } from '../models'; /** * WorkingDaysApi - axios parameter creator * @export */ export declare const WorkingDaysApiAxiosParamCreator: (configuration?: Configuration) => { /** * Example Requests: workingdays * @summary List Working days * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAll17: (options?: any) => Promise<RequestArgs>; /** * This is a convenience resource. It can be useful when building maintenance user interface screens for working days. Example Request: workingdays/template * @summary Working Days Template * @param {*} [options] Override http request option. * @throws {RequiredError} */ template4: (options?: any) => Promise<RequestArgs>; /** * Mandatory Fields recurrence,repaymentRescheduleType,extendTermForDailyRepayments,locale * @summary Update a Working Day * @param {PutWorkingDaysRequest} putWorkingDaysRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ update8: (putWorkingDaysRequest: PutWorkingDaysRequest, options?: any) => Promise<RequestArgs>; }; /** * WorkingDaysApi - functional programming interface * @export */ export declare const WorkingDaysApiFp: (configuration?: Configuration) => { /** * Example Requests: workingdays * @summary List Working days * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAll17(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GetWorkingDaysResponse>>>; /** * This is a convenience resource. It can be useful when building maintenance user interface screens for working days. Example Request: workingdays/template * @summary Working Days Template * @param {*} [options] Override http request option. * @throws {RequiredError} */ template4(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetWorkingDaysTemplateResponse>>; /** * Mandatory Fields recurrence,repaymentRescheduleType,extendTermForDailyRepayments,locale * @summary Update a Working Day * @param {PutWorkingDaysRequest} putWorkingDaysRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ update8(putWorkingDaysRequest: PutWorkingDaysRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutWorkingDaysResponse>>; }; /** * WorkingDaysApi - factory interface * @export */ export declare const WorkingDaysApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Example Requests: workingdays * @summary List Working days * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAll17(options?: any): AxiosPromise<Array<GetWorkingDaysResponse>>; /** * This is a convenience resource. It can be useful when building maintenance user interface screens for working days. Example Request: workingdays/template * @summary Working Days Template * @param {*} [options] Override http request option. * @throws {RequiredError} */ template4(options?: any): AxiosPromise<GetWorkingDaysTemplateResponse>; /** * Mandatory Fields recurrence,repaymentRescheduleType,extendTermForDailyRepayments,locale * @summary Update a Working Day * @param {PutWorkingDaysRequest} putWorkingDaysRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ update8(putWorkingDaysRequest: PutWorkingDaysRequest, options?: any): AxiosPromise<PutWorkingDaysResponse>; }; /** * WorkingDaysApi - object-oriented interface * @export * @class WorkingDaysApi * @extends {BaseAPI} */ export declare class WorkingDaysApi extends BaseAPI { /** * Example Requests: workingdays * @summary List Working days * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WorkingDaysApi */ retrieveAll17(options?: any): Promise<import("axios").AxiosResponse<GetWorkingDaysResponse[]>>; /** * This is a convenience resource. It can be useful when building maintenance user interface screens for working days. Example Request: workingdays/template * @summary Working Days Template * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WorkingDaysApi */ template4(options?: any): Promise<import("axios").AxiosResponse<GetWorkingDaysTemplateResponse>>; /** * Mandatory Fields recurrence,repaymentRescheduleType,extendTermForDailyRepayments,locale * @summary Update a Working Day * @param {PutWorkingDaysRequest} putWorkingDaysRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WorkingDaysApi */ update8(putWorkingDaysRequest: PutWorkingDaysRequest, options?: any): Promise<import("axios").AxiosResponse<PutWorkingDaysResponse>>; }