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 { FormDataBodyPart } from '../models'; import { GetSelfClientsClientIdAccountsResponse } from '../models'; import { GetSelfClientsClientIdChargesChargeIdResponse } from '../models'; import { GetSelfClientsClientIdChargesResponse } from '../models'; import { GetSelfClientsClientIdResponse } from '../models'; import { GetSelfClientsClientIdTransactionsResponse } from '../models'; import { GetSelfClientsClientIdTransactionsTransactionIdResponse } from '../models'; import { GetSelfClientsResponse } from '../models'; /** * SelfClientApi - axios parameter creator * @export */ export declare const SelfClientApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @param {number} clientId * @param {number} [contentLength] * @param {FormDataBodyPart} [file] * @param {*} [options] Override http request option. * @throws {RequiredError} */ addNewClientImage2: (clientId: number, contentLength?: number, file?: any, options?: any) => Promise<RequestArgs>; /** * * @param {number} clientId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteClientImage1: (clientId: number, options?: any) => Promise<RequestArgs>; /** * The list capability of clients can support pagination and sorting. Example Requests: self/clients self/clients?fields=displayName,officeName self/clients?offset=10&limit=50 self/clients?orderBy=displayName&sortOrder=DESC * @summary List Clients associated to the user * @param {string} [displayName] displayName * @param {string} [firstName] firstName * @param {string} [lastName] lastName * @param {number} [offset] offset * @param {string} [status] status * @param {number} [limit] limit * @param {string} [orderBy] orderBy * @param {string} [sortOrder] sortOrder * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAll36: (displayName?: string, firstName?: string, lastName?: string, offset?: number, status?: string, limit?: number, orderBy?: string, sortOrder?: string, options?: any) => Promise<RequestArgs>; /** * The list capability of client charges supports pagination. Example Requests: self/clients/1/charges self/clients/1/charges?offset=0&limit=5 * @summary List Client Charges * @param {number} clientId clientId * @param {string} [chargeStatus] chargeStatus * @param {boolean} [pendingPayment] pendingPayment * @param {number} [limit] limit * @param {number} [offset] offset * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAllClientCharges1: (clientId: number, chargeStatus?: string, pendingPayment?: boolean, limit?: number, offset?: number, options?: any) => Promise<RequestArgs>; /** * The list capability of client transaction can support pagination. Example Requests: self/clients/189/transactions self/clients/189/transactions?offset=10&limit=50 * @summary List Client Transactions * @param {number} clientId clientId * @param {number} [offset] offset * @param {number} [limit] limit * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAllClientTransactions1: (clientId: number, offset?: number, limit?: number, options?: any) => Promise<RequestArgs>; /** * An example of how a loan portfolio summary can be provided. This is requested in a specific use case of the community application. It is quite reasonable to add resources like this to simplify User Interface development. Example Requests: self/clients/1/accounts self/clients/1/accounts?fields=loanAccounts,savingsAccounts * @summary Retrieve client accounts overview * @param {number} clientId clientId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAssociatedAccounts1: (clientId: number, options?: any) => Promise<RequestArgs>; /** * Retrieves a Client Charge Example Requests: self/clients/1/charges/1 self/clients/1/charges/1?fields=name,id * @summary Retrieve a Client Charge * @param {number} clientId clientId * @param {number} chargeId chargeId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveClientCharge1: (clientId: number, chargeId: number, options?: any) => Promise<RequestArgs>; /** * Retrieves a Client TransactionExample Requests: self/clients/1/transactions/1 self/clients/1/transactions/1?fields=id,officeName * @summary Retrieve a Client Transaction * @param {number} clientId clientId * @param {number} transactionId transactionId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveClientTransaction1: (clientId: number, transactionId: number, options?: any) => Promise<RequestArgs>; /** * Optional arguments are identical to those of Get Image associated with an Entity (Binary file) Example Requests: self/clients/1/images * @summary Retrieve Client Image * @param {number} clientId clientId * @param {number} [maxWidth] * @param {number} [maxHeight] * @param {string} [output] * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveImage1: (clientId: number, maxWidth?: number, maxHeight?: number, output?: string, options?: any) => Promise<RequestArgs>; /** * * @param {number} clientId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveObligeeDetails1: (clientId: number, options?: any) => Promise<RequestArgs>; /** * Retrieves a Client Example Requests: self/clients/1 self/clients/1?fields=id,displayName,officeName * @summary Retrieve a Client * @param {number} clientId clientId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveOne26: (clientId: number, options?: any) => Promise<RequestArgs>; }; /** * SelfClientApi - functional programming interface * @export */ export declare const SelfClientApiFp: (configuration?: Configuration) => { /** * * @param {number} clientId * @param {number} [contentLength] * @param {FormDataBodyPart} [file] * @param {*} [options] Override http request option. * @throws {RequiredError} */ addNewClientImage2(clientId: number, contentLength?: number, file?: any, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * * @param {number} clientId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteClientImage1(clientId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * The list capability of clients can support pagination and sorting. Example Requests: self/clients self/clients?fields=displayName,officeName self/clients?offset=10&limit=50 self/clients?orderBy=displayName&sortOrder=DESC * @summary List Clients associated to the user * @param {string} [displayName] displayName * @param {string} [firstName] firstName * @param {string} [lastName] lastName * @param {number} [offset] offset * @param {string} [status] status * @param {number} [limit] limit * @param {string} [orderBy] orderBy * @param {string} [sortOrder] sortOrder * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAll36(displayName?: string, firstName?: string, lastName?: string, offset?: number, status?: string, limit?: number, orderBy?: string, sortOrder?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSelfClientsResponse>>; /** * The list capability of client charges supports pagination. Example Requests: self/clients/1/charges self/clients/1/charges?offset=0&limit=5 * @summary List Client Charges * @param {number} clientId clientId * @param {string} [chargeStatus] chargeStatus * @param {boolean} [pendingPayment] pendingPayment * @param {number} [limit] limit * @param {number} [offset] offset * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAllClientCharges1(clientId: number, chargeStatus?: string, pendingPayment?: boolean, limit?: number, offset?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSelfClientsClientIdChargesResponse>>; /** * The list capability of client transaction can support pagination. Example Requests: self/clients/189/transactions self/clients/189/transactions?offset=10&limit=50 * @summary List Client Transactions * @param {number} clientId clientId * @param {number} [offset] offset * @param {number} [limit] limit * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAllClientTransactions1(clientId: number, offset?: number, limit?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSelfClientsClientIdTransactionsResponse>>; /** * An example of how a loan portfolio summary can be provided. This is requested in a specific use case of the community application. It is quite reasonable to add resources like this to simplify User Interface development. Example Requests: self/clients/1/accounts self/clients/1/accounts?fields=loanAccounts,savingsAccounts * @summary Retrieve client accounts overview * @param {number} clientId clientId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAssociatedAccounts1(clientId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSelfClientsClientIdAccountsResponse>>; /** * Retrieves a Client Charge Example Requests: self/clients/1/charges/1 self/clients/1/charges/1?fields=name,id * @summary Retrieve a Client Charge * @param {number} clientId clientId * @param {number} chargeId chargeId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveClientCharge1(clientId: number, chargeId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSelfClientsClientIdChargesChargeIdResponse>>; /** * Retrieves a Client TransactionExample Requests: self/clients/1/transactions/1 self/clients/1/transactions/1?fields=id,officeName * @summary Retrieve a Client Transaction * @param {number} clientId clientId * @param {number} transactionId transactionId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveClientTransaction1(clientId: number, transactionId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSelfClientsClientIdTransactionsTransactionIdResponse>>; /** * Optional arguments are identical to those of Get Image associated with an Entity (Binary file) Example Requests: self/clients/1/images * @summary Retrieve Client Image * @param {number} clientId clientId * @param {number} [maxWidth] * @param {number} [maxHeight] * @param {string} [output] * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveImage1(clientId: number, maxWidth?: number, maxHeight?: number, output?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>; /** * * @param {number} clientId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveObligeeDetails1(clientId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * Retrieves a Client Example Requests: self/clients/1 self/clients/1?fields=id,displayName,officeName * @summary Retrieve a Client * @param {number} clientId clientId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveOne26(clientId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSelfClientsClientIdResponse>>; }; /** * SelfClientApi - factory interface * @export */ export declare const SelfClientApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @param {number} clientId * @param {number} [contentLength] * @param {FormDataBodyPart} [file] * @param {*} [options] Override http request option. * @throws {RequiredError} */ addNewClientImage2(clientId: number, contentLength?: number, file?: any, options?: any): AxiosPromise<string>; /** * * @param {number} clientId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteClientImage1(clientId: number, options?: any): AxiosPromise<string>; /** * The list capability of clients can support pagination and sorting. Example Requests: self/clients self/clients?fields=displayName,officeName self/clients?offset=10&limit=50 self/clients?orderBy=displayName&sortOrder=DESC * @summary List Clients associated to the user * @param {string} [displayName] displayName * @param {string} [firstName] firstName * @param {string} [lastName] lastName * @param {number} [offset] offset * @param {string} [status] status * @param {number} [limit] limit * @param {string} [orderBy] orderBy * @param {string} [sortOrder] sortOrder * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAll36(displayName?: string, firstName?: string, lastName?: string, offset?: number, status?: string, limit?: number, orderBy?: string, sortOrder?: string, options?: any): AxiosPromise<GetSelfClientsResponse>; /** * The list capability of client charges supports pagination. Example Requests: self/clients/1/charges self/clients/1/charges?offset=0&limit=5 * @summary List Client Charges * @param {number} clientId clientId * @param {string} [chargeStatus] chargeStatus * @param {boolean} [pendingPayment] pendingPayment * @param {number} [limit] limit * @param {number} [offset] offset * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAllClientCharges1(clientId: number, chargeStatus?: string, pendingPayment?: boolean, limit?: number, offset?: number, options?: any): AxiosPromise<GetSelfClientsClientIdChargesResponse>; /** * The list capability of client transaction can support pagination. Example Requests: self/clients/189/transactions self/clients/189/transactions?offset=10&limit=50 * @summary List Client Transactions * @param {number} clientId clientId * @param {number} [offset] offset * @param {number} [limit] limit * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAllClientTransactions1(clientId: number, offset?: number, limit?: number, options?: any): AxiosPromise<GetSelfClientsClientIdTransactionsResponse>; /** * An example of how a loan portfolio summary can be provided. This is requested in a specific use case of the community application. It is quite reasonable to add resources like this to simplify User Interface development. Example Requests: self/clients/1/accounts self/clients/1/accounts?fields=loanAccounts,savingsAccounts * @summary Retrieve client accounts overview * @param {number} clientId clientId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAssociatedAccounts1(clientId: number, options?: any): AxiosPromise<GetSelfClientsClientIdAccountsResponse>; /** * Retrieves a Client Charge Example Requests: self/clients/1/charges/1 self/clients/1/charges/1?fields=name,id * @summary Retrieve a Client Charge * @param {number} clientId clientId * @param {number} chargeId chargeId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveClientCharge1(clientId: number, chargeId: number, options?: any): AxiosPromise<GetSelfClientsClientIdChargesChargeIdResponse>; /** * Retrieves a Client TransactionExample Requests: self/clients/1/transactions/1 self/clients/1/transactions/1?fields=id,officeName * @summary Retrieve a Client Transaction * @param {number} clientId clientId * @param {number} transactionId transactionId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveClientTransaction1(clientId: number, transactionId: number, options?: any): AxiosPromise<GetSelfClientsClientIdTransactionsTransactionIdResponse>; /** * Optional arguments are identical to those of Get Image associated with an Entity (Binary file) Example Requests: self/clients/1/images * @summary Retrieve Client Image * @param {number} clientId clientId * @param {number} [maxWidth] * @param {number} [maxHeight] * @param {string} [output] * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveImage1(clientId: number, maxWidth?: number, maxHeight?: number, output?: string, options?: any): AxiosPromise<void>; /** * * @param {number} clientId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveObligeeDetails1(clientId: number, options?: any): AxiosPromise<string>; /** * Retrieves a Client Example Requests: self/clients/1 self/clients/1?fields=id,displayName,officeName * @summary Retrieve a Client * @param {number} clientId clientId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveOne26(clientId: number, options?: any): AxiosPromise<GetSelfClientsClientIdResponse>; }; /** * SelfClientApi - object-oriented interface * @export * @class SelfClientApi * @extends {BaseAPI} */ export declare class SelfClientApi extends BaseAPI { /** * * @param {number} clientId * @param {number} [contentLength] * @param {FormDataBodyPart} [file] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SelfClientApi */ addNewClientImage2(clientId: number, contentLength?: number, file?: FormDataBodyPart, options?: any): Promise<import("axios").AxiosResponse<string>>; /** * * @param {number} clientId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SelfClientApi */ deleteClientImage1(clientId: number, options?: any): Promise<import("axios").AxiosResponse<string>>; /** * The list capability of clients can support pagination and sorting. Example Requests: self/clients self/clients?fields=displayName,officeName self/clients?offset=10&limit=50 self/clients?orderBy=displayName&sortOrder=DESC * @summary List Clients associated to the user * @param {string} [displayName] displayName * @param {string} [firstName] firstName * @param {string} [lastName] lastName * @param {number} [offset] offset * @param {string} [status] status * @param {number} [limit] limit * @param {string} [orderBy] orderBy * @param {string} [sortOrder] sortOrder * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SelfClientApi */ retrieveAll36(displayName?: string, firstName?: string, lastName?: string, offset?: number, status?: string, limit?: number, orderBy?: string, sortOrder?: string, options?: any): Promise<import("axios").AxiosResponse<GetSelfClientsResponse>>; /** * The list capability of client charges supports pagination. Example Requests: self/clients/1/charges self/clients/1/charges?offset=0&limit=5 * @summary List Client Charges * @param {number} clientId clientId * @param {string} [chargeStatus] chargeStatus * @param {boolean} [pendingPayment] pendingPayment * @param {number} [limit] limit * @param {number} [offset] offset * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SelfClientApi */ retrieveAllClientCharges1(clientId: number, chargeStatus?: string, pendingPayment?: boolean, limit?: number, offset?: number, options?: any): Promise<import("axios").AxiosResponse<GetSelfClientsClientIdChargesResponse>>; /** * The list capability of client transaction can support pagination. Example Requests: self/clients/189/transactions self/clients/189/transactions?offset=10&limit=50 * @summary List Client Transactions * @param {number} clientId clientId * @param {number} [offset] offset * @param {number} [limit] limit * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SelfClientApi */ retrieveAllClientTransactions1(clientId: number, offset?: number, limit?: number, options?: any): Promise<import("axios").AxiosResponse<GetSelfClientsClientIdTransactionsResponse>>; /** * An example of how a loan portfolio summary can be provided. This is requested in a specific use case of the community application. It is quite reasonable to add resources like this to simplify User Interface development. Example Requests: self/clients/1/accounts self/clients/1/accounts?fields=loanAccounts,savingsAccounts * @summary Retrieve client accounts overview * @param {number} clientId clientId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SelfClientApi */ retrieveAssociatedAccounts1(clientId: number, options?: any): Promise<import("axios").AxiosResponse<GetSelfClientsClientIdAccountsResponse>>; /** * Retrieves a Client Charge Example Requests: self/clients/1/charges/1 self/clients/1/charges/1?fields=name,id * @summary Retrieve a Client Charge * @param {number} clientId clientId * @param {number} chargeId chargeId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SelfClientApi */ retrieveClientCharge1(clientId: number, chargeId: number, options?: any): Promise<import("axios").AxiosResponse<GetSelfClientsClientIdChargesChargeIdResponse>>; /** * Retrieves a Client TransactionExample Requests: self/clients/1/transactions/1 self/clients/1/transactions/1?fields=id,officeName * @summary Retrieve a Client Transaction * @param {number} clientId clientId * @param {number} transactionId transactionId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SelfClientApi */ retrieveClientTransaction1(clientId: number, transactionId: number, options?: any): Promise<import("axios").AxiosResponse<GetSelfClientsClientIdTransactionsTransactionIdResponse>>; /** * Optional arguments are identical to those of Get Image associated with an Entity (Binary file) Example Requests: self/clients/1/images * @summary Retrieve Client Image * @param {number} clientId clientId * @param {number} [maxWidth] * @param {number} [maxHeight] * @param {string} [output] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SelfClientApi */ retrieveImage1(clientId: number, maxWidth?: number, maxHeight?: number, output?: string, options?: any): Promise<import("axios").AxiosResponse<void>>; /** * * @param {number} clientId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SelfClientApi */ retrieveObligeeDetails1(clientId: number, options?: any): Promise<import("axios").AxiosResponse<string>>; /** * Retrieves a Client Example Requests: self/clients/1 self/clients/1?fields=id,displayName,officeName * @summary Retrieve a Client * @param {number} clientId clientId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SelfClientApi */ retrieveOne26(clientId: number, options?: any): Promise<import("axios").AxiosResponse<GetSelfClientsClientIdResponse>>; }