fineract_sdk

/** * 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 { GetStandingInstructionsResponse } from '../models'; import { GetStandingInstructionsStandingInstructionIdResponse } from '../models'; import { GetStandingInstructionsTemplateResponse } from '../models'; import { PostStandingInstructionsRequest } from '../models'; import { PostStandingInstructionsResponse } from '../models'; import { PutStandingInstructionsStandingInstructionIdRequest } from '../models'; import { PutStandingInstructionsStandingInstructionIdResponse } from '../models'; /** * StandingInstructionsApi - axios parameter creator * @export */ export declare const StandingInstructionsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Ability to create new instruction for transfer of monetary funds from one account to another * @summary Create new Standing Instruction * @param {PostStandingInstructionsRequest} postStandingInstructionsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ create5: (postStandingInstructionsRequest: PostStandingInstructionsRequest, options?: any) => Promise<RequestArgs>; /** * Example Requests: standinginstructions * @summary List Standing Instructions * @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 {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAll19: (sqlSearch?: string, externalId?: string, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, transferType?: number, clientName?: string, clientId?: number, fromAccountId?: number, fromAccountType?: number, options?: any) => Promise<RequestArgs>; /** * Example Requests : standinginstructions/1 * @summary Retrieve Standing Instruction * @param {number} standingInstructionId standingInstructionId * @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 {*} [options] Override http request option. * @throws {RequiredError} */ retrieveOne10: (standingInstructionId: number, sqlSearch?: string, externalId?: string, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, 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 Value Lists Example Requests: standinginstructions/template?fromAccountType=2&fromOfficeId=1 standinginstructions/template?fromAccountType=2&fromOfficeId=1&fromClientId=1&transferType=1 standinginstructions/template?fromClientId=1&fromAccountType=2&fromAccountId=1&transferType=1 * @summary Retrieve Standing Instruction Template * @param {number} [fromOfficeId] fromOfficeId * @param {number} [fromClientId] fromClientId * @param {number} [fromAccountId] fromAccountId * @param {number} [fromAccountType] fromAccountType * @param {number} [toOfficeId] toOfficeId * @param {number} [toClientId] toClientId * @param {number} [toAccountId] toAccountId * @param {number} [toAccountType] toAccountType * @param {number} [transferType] transferType * @param {*} [options] Override http request option. * @throws {RequiredError} */ template6: (fromOfficeId?: number, fromClientId?: number, fromAccountId?: number, fromAccountType?: number, toOfficeId?: number, toClientId?: number, toAccountId?: number, toAccountType?: number, transferType?: number, options?: any) => Promise<RequestArgs>; /** * Ability to modify existing instruction for transfer of monetary funds from one account to another. PUT https://DomainName/api/v1/standinginstructions/1?command=update Ability to modify existing instruction for transfer of monetary funds from one account to another. PUT https://DomainName/api/v1/standinginstructions/1?command=delete * @summary Update Standing Instruction | Delete Standing Instruction * @param {number} standingInstructionId standingInstructionId * @param {string} [command] command * @param {PutStandingInstructionsStandingInstructionIdRequest} [putStandingInstructionsStandingInstructionIdRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ update9: (standingInstructionId: number, command?: string, putStandingInstructionsStandingInstructionIdRequest?: PutStandingInstructionsStandingInstructionIdRequest, options?: any) => Promise<RequestArgs>; }; /** * StandingInstructionsApi - functional programming interface * @export */ export declare const StandingInstructionsApiFp: (configuration?: Configuration) => { /** * Ability to create new instruction for transfer of monetary funds from one account to another * @summary Create new Standing Instruction * @param {PostStandingInstructionsRequest} postStandingInstructionsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ create5(postStandingInstructionsRequest: PostStandingInstructionsRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostStandingInstructionsResponse>>; /** * Example Requests: standinginstructions * @summary List Standing Instructions * @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 {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAll19(sqlSearch?: string, externalId?: string, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, transferType?: number, clientName?: string, clientId?: number, fromAccountId?: number, fromAccountType?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStandingInstructionsResponse>>; /** * Example Requests : standinginstructions/1 * @summary Retrieve Standing Instruction * @param {number} standingInstructionId standingInstructionId * @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 {*} [options] Override http request option. * @throws {RequiredError} */ retrieveOne10(standingInstructionId: number, sqlSearch?: string, externalId?: string, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStandingInstructionsStandingInstructionIdResponse>>; /** * 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 Value Lists Example Requests: standinginstructions/template?fromAccountType=2&fromOfficeId=1 standinginstructions/template?fromAccountType=2&fromOfficeId=1&fromClientId=1&transferType=1 standinginstructions/template?fromClientId=1&fromAccountType=2&fromAccountId=1&transferType=1 * @summary Retrieve Standing Instruction Template * @param {number} [fromOfficeId] fromOfficeId * @param {number} [fromClientId] fromClientId * @param {number} [fromAccountId] fromAccountId * @param {number} [fromAccountType] fromAccountType * @param {number} [toOfficeId] toOfficeId * @param {number} [toClientId] toClientId * @param {number} [toAccountId] toAccountId * @param {number} [toAccountType] toAccountType * @param {number} [transferType] transferType * @param {*} [options] Override http request option. * @throws {RequiredError} */ template6(fromOfficeId?: number, fromClientId?: number, fromAccountId?: number, fromAccountType?: number, toOfficeId?: number, toClientId?: number, toAccountId?: number, toAccountType?: number, transferType?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStandingInstructionsTemplateResponse>>; /** * Ability to modify existing instruction for transfer of monetary funds from one account to another. PUT https://DomainName/api/v1/standinginstructions/1?command=update Ability to modify existing instruction for transfer of monetary funds from one account to another. PUT https://DomainName/api/v1/standinginstructions/1?command=delete * @summary Update Standing Instruction | Delete Standing Instruction * @param {number} standingInstructionId standingInstructionId * @param {string} [command] command * @param {PutStandingInstructionsStandingInstructionIdRequest} [putStandingInstructionsStandingInstructionIdRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ update9(standingInstructionId: number, command?: string, putStandingInstructionsStandingInstructionIdRequest?: PutStandingInstructionsStandingInstructionIdRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutStandingInstructionsStandingInstructionIdResponse>>; }; /** * StandingInstructionsApi - factory interface * @export */ export declare const StandingInstructionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Ability to create new instruction for transfer of monetary funds from one account to another * @summary Create new Standing Instruction * @param {PostStandingInstructionsRequest} postStandingInstructionsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ create5(postStandingInstructionsRequest: PostStandingInstructionsRequest, options?: any): AxiosPromise<PostStandingInstructionsResponse>; /** * Example Requests: standinginstructions * @summary List Standing Instructions * @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 {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAll19(sqlSearch?: string, externalId?: string, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, transferType?: number, clientName?: string, clientId?: number, fromAccountId?: number, fromAccountType?: number, options?: any): AxiosPromise<GetStandingInstructionsResponse>; /** * Example Requests : standinginstructions/1 * @summary Retrieve Standing Instruction * @param {number} standingInstructionId standingInstructionId * @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 {*} [options] Override http request option. * @throws {RequiredError} */ retrieveOne10(standingInstructionId: number, sqlSearch?: string, externalId?: string, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, options?: any): AxiosPromise<GetStandingInstructionsStandingInstructionIdResponse>; /** * 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 Value Lists Example Requests: standinginstructions/template?fromAccountType=2&fromOfficeId=1 standinginstructions/template?fromAccountType=2&fromOfficeId=1&fromClientId=1&transferType=1 standinginstructions/template?fromClientId=1&fromAccountType=2&fromAccountId=1&transferType=1 * @summary Retrieve Standing Instruction Template * @param {number} [fromOfficeId] fromOfficeId * @param {number} [fromClientId] fromClientId * @param {number} [fromAccountId] fromAccountId * @param {number} [fromAccountType] fromAccountType * @param {number} [toOfficeId] toOfficeId * @param {number} [toClientId] toClientId * @param {number} [toAccountId] toAccountId * @param {number} [toAccountType] toAccountType * @param {number} [transferType] transferType * @param {*} [options] Override http request option. * @throws {RequiredError} */ template6(fromOfficeId?: number, fromClientId?: number, fromAccountId?: number, fromAccountType?: number, toOfficeId?: number, toClientId?: number, toAccountId?: number, toAccountType?: number, transferType?: number, options?: any): AxiosPromise<GetStandingInstructionsTemplateResponse>; /** * Ability to modify existing instruction for transfer of monetary funds from one account to another. PUT https://DomainName/api/v1/standinginstructions/1?command=update Ability to modify existing instruction for transfer of monetary funds from one account to another. PUT https://DomainName/api/v1/standinginstructions/1?command=delete * @summary Update Standing Instruction | Delete Standing Instruction * @param {number} standingInstructionId standingInstructionId * @param {string} [command] command * @param {PutStandingInstructionsStandingInstructionIdRequest} [putStandingInstructionsStandingInstructionIdRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ update9(standingInstructionId: number, command?: string, putStandingInstructionsStandingInstructionIdRequest?: PutStandingInstructionsStandingInstructionIdRequest, options?: any): AxiosPromise<PutStandingInstructionsStandingInstructionIdResponse>; }; /** * StandingInstructionsApi - object-oriented interface * @export * @class StandingInstructionsApi * @extends {BaseAPI} */ export declare class StandingInstructionsApi extends BaseAPI { /** * Ability to create new instruction for transfer of monetary funds from one account to another * @summary Create new Standing Instruction * @param {PostStandingInstructionsRequest} postStandingInstructionsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StandingInstructionsApi */ create5(postStandingInstructionsRequest: PostStandingInstructionsRequest, options?: any): Promise<import("axios").AxiosResponse<PostStandingInstructionsResponse>>; /** * Example Requests: standinginstructions * @summary List Standing Instructions * @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 {*} [options] Override http request option. * @throws {RequiredError} * @memberof StandingInstructionsApi */ retrieveAll19(sqlSearch?: string, externalId?: string, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, transferType?: number, clientName?: string, clientId?: number, fromAccountId?: number, fromAccountType?: number, options?: any): Promise<import("axios").AxiosResponse<GetStandingInstructionsResponse>>; /** * Example Requests : standinginstructions/1 * @summary Retrieve Standing Instruction * @param {number} standingInstructionId standingInstructionId * @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 {*} [options] Override http request option. * @throws {RequiredError} * @memberof StandingInstructionsApi */ retrieveOne10(standingInstructionId: number, sqlSearch?: string, externalId?: string, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, options?: any): Promise<import("axios").AxiosResponse<GetStandingInstructionsStandingInstructionIdResponse>>; /** * 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 Value Lists Example Requests: standinginstructions/template?fromAccountType=2&fromOfficeId=1 standinginstructions/template?fromAccountType=2&fromOfficeId=1&fromClientId=1&transferType=1 standinginstructions/template?fromClientId=1&fromAccountType=2&fromAccountId=1&transferType=1 * @summary Retrieve Standing Instruction Template * @param {number} [fromOfficeId] fromOfficeId * @param {number} [fromClientId] fromClientId * @param {number} [fromAccountId] fromAccountId * @param {number} [fromAccountType] fromAccountType * @param {number} [toOfficeId] toOfficeId * @param {number} [toClientId] toClientId * @param {number} [toAccountId] toAccountId * @param {number} [toAccountType] toAccountType * @param {number} [transferType] transferType * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StandingInstructionsApi */ template6(fromOfficeId?: number, fromClientId?: number, fromAccountId?: number, fromAccountType?: number, toOfficeId?: number, toClientId?: number, toAccountId?: number, toAccountType?: number, transferType?: number, options?: any): Promise<import("axios").AxiosResponse<GetStandingInstructionsTemplateResponse>>; /** * Ability to modify existing instruction for transfer of monetary funds from one account to another. PUT https://DomainName/api/v1/standinginstructions/1?command=update Ability to modify existing instruction for transfer of monetary funds from one account to another. PUT https://DomainName/api/v1/standinginstructions/1?command=delete * @summary Update Standing Instruction | Delete Standing Instruction * @param {number} standingInstructionId standingInstructionId * @param {string} [command] command * @param {PutStandingInstructionsStandingInstructionIdRequest} [putStandingInstructionsStandingInstructionIdRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StandingInstructionsApi */ update9(standingInstructionId: number, command?: string, putStandingInstructionsStandingInstructionIdRequest?: PutStandingInstructionsStandingInstructionIdRequest, options?: any): Promise<import("axios").AxiosResponse<PutStandingInstructionsStandingInstructionIdResponse>>; }