UNPKG

fineract_sdk

Version:

Wrapper around fineract api.

131 lines (130 loc) 8.53 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 { GetStandingInstructionRunHistoryResponse } from '../models'; /** * StandingInstructionsHistoryApi - axios parameter creator * @export */ export declare const StandingInstructionsHistoryApiAxiosParamCreator: (configuration?: Configuration) => { /** * The list capability of history can support pagination and sorting Example Requests : standinginstructionrunhistory standinginstructionrunhistory?orderBy=name&sortOrder=DESC standinginstructionrunhistory?offset=10&limit=50 * @summary Standing Instructions Logged History * @param {string} [sqlSearch] sqlSearch * @param {string} [externalId] externalId * @param {number} [offset] offset * @param {number} [limit] limit * @param {string} [orderBy] orderBy * @param {string} [sortOrder] sortOrder * @param {number} [transferType] transferType * @param {string} [clientName] clientName * @param {number} [clientId] clientId * @param {number} [fromAccountId] fromAccountId * @param {number} [fromAccountType] fromAccountType * @param {string} [locale] locale * @param {string} [dateFormat] dateFormat * @param {object} [fromDate] fromDate * @param {object} [toDate] toDate * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAll20: (sqlSearch?: string, externalId?: string, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, transferType?: number, clientName?: string, clientId?: number, fromAccountId?: number, fromAccountType?: number, locale?: string, dateFormat?: string, fromDate?: object, toDate?: object, options?: any) => Promise<RequestArgs>; }; /** * StandingInstructionsHistoryApi - functional programming interface * @export */ export declare const StandingInstructionsHistoryApiFp: (configuration?: Configuration) => { /** * The list capability of history can support pagination and sorting Example Requests : standinginstructionrunhistory standinginstructionrunhistory?orderBy=name&sortOrder=DESC standinginstructionrunhistory?offset=10&limit=50 * @summary Standing Instructions Logged History * @param {string} [sqlSearch] sqlSearch * @param {string} [externalId] externalId * @param {number} [offset] offset * @param {number} [limit] limit * @param {string} [orderBy] orderBy * @param {string} [sortOrder] sortOrder * @param {number} [transferType] transferType * @param {string} [clientName] clientName * @param {number} [clientId] clientId * @param {number} [fromAccountId] fromAccountId * @param {number} [fromAccountType] fromAccountType * @param {string} [locale] locale * @param {string} [dateFormat] dateFormat * @param {object} [fromDate] fromDate * @param {object} [toDate] toDate * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAll20(sqlSearch?: string, externalId?: string, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, transferType?: number, clientName?: string, clientId?: number, fromAccountId?: number, fromAccountType?: number, locale?: string, dateFormat?: string, fromDate?: object, toDate?: object, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStandingInstructionRunHistoryResponse>>; }; /** * StandingInstructionsHistoryApi - factory interface * @export */ export declare const StandingInstructionsHistoryApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * The list capability of history can support pagination and sorting Example Requests : standinginstructionrunhistory standinginstructionrunhistory?orderBy=name&sortOrder=DESC standinginstructionrunhistory?offset=10&limit=50 * @summary Standing Instructions Logged History * @param {string} [sqlSearch] sqlSearch * @param {string} [externalId] externalId * @param {number} [offset] offset * @param {number} [limit] limit * @param {string} [orderBy] orderBy * @param {string} [sortOrder] sortOrder * @param {number} [transferType] transferType * @param {string} [clientName] clientName * @param {number} [clientId] clientId * @param {number} [fromAccountId] fromAccountId * @param {number} [fromAccountType] fromAccountType * @param {string} [locale] locale * @param {string} [dateFormat] dateFormat * @param {object} [fromDate] fromDate * @param {object} [toDate] toDate * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAll20(sqlSearch?: string, externalId?: string, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, transferType?: number, clientName?: string, clientId?: number, fromAccountId?: number, fromAccountType?: number, locale?: string, dateFormat?: string, fromDate?: object, toDate?: object, options?: any): AxiosPromise<GetStandingInstructionRunHistoryResponse>; }; /** * StandingInstructionsHistoryApi - object-oriented interface * @export * @class StandingInstructionsHistoryApi * @extends {BaseAPI} */ export declare class StandingInstructionsHistoryApi extends BaseAPI { /** * The list capability of history can support pagination and sorting Example Requests : standinginstructionrunhistory standinginstructionrunhistory?orderBy=name&sortOrder=DESC standinginstructionrunhistory?offset=10&limit=50 * @summary Standing Instructions Logged History * @param {string} [sqlSearch] sqlSearch * @param {string} [externalId] externalId * @param {number} [offset] offset * @param {number} [limit] limit * @param {string} [orderBy] orderBy * @param {string} [sortOrder] sortOrder * @param {number} [transferType] transferType * @param {string} [clientName] clientName * @param {number} [clientId] clientId * @param {number} [fromAccountId] fromAccountId * @param {number} [fromAccountType] fromAccountType * @param {string} [locale] locale * @param {string} [dateFormat] dateFormat * @param {object} [fromDate] fromDate * @param {object} [toDate] toDate * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StandingInstructionsHistoryApi */ retrieveAll20(sqlSearch?: string, externalId?: string, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, transferType?: number, clientName?: string, clientId?: number, fromAccountId?: number, fromAccountType?: number, locale?: string, dateFormat?: string, fromDate?: object, toDate?: object, options?: any): Promise<import("axios").AxiosResponse<GetStandingInstructionRunHistoryResponse>>; }