fineract_sdk
Version:
Wrapper around fineract api.
163 lines (162 loc) • 9.2 kB
TypeScript
/**
* 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 { GetClientsClientIdTransactionsResponse } from '../models';
import { GetClientsClientIdTransactionsTransactionIdResponse } from '../models';
import { PostClientsClientIdTransactionsTransactionIdResponse } from '../models';
/**
* ClientTransactionApi - axios parameter creator
* @export
*/
export declare const ClientTransactionApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* The list capability of client transaction can support pagination. Example Requests: clients/189/transactions 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}
*/
retrieveAllClientTransactions: (clientId: number, offset?: number, limit?: number, options?: any) => Promise<RequestArgs>;
/**
* Example Requests: clients/1/transactions/1 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}
*/
retrieveClientTransaction: (clientId: number, transactionId: number, options?: any) => Promise<RequestArgs>;
/**
* Undoes a Client Transaction
* @summary Undo a Client Transaction
* @param {number} clientId clientId
* @param {number} transactionId transactionId
* @param {string} [command] command
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
undoClientTransaction: (clientId: number, transactionId: number, command?: string, options?: any) => Promise<RequestArgs>;
};
/**
* ClientTransactionApi - functional programming interface
* @export
*/
export declare const ClientTransactionApiFp: (configuration?: Configuration) => {
/**
* The list capability of client transaction can support pagination. Example Requests: clients/189/transactions 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}
*/
retrieveAllClientTransactions(clientId: number, offset?: number, limit?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetClientsClientIdTransactionsResponse>>;
/**
* Example Requests: clients/1/transactions/1 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}
*/
retrieveClientTransaction(clientId: number, transactionId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetClientsClientIdTransactionsTransactionIdResponse>>;
/**
* Undoes a Client Transaction
* @summary Undo a Client Transaction
* @param {number} clientId clientId
* @param {number} transactionId transactionId
* @param {string} [command] command
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
undoClientTransaction(clientId: number, transactionId: number, command?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostClientsClientIdTransactionsTransactionIdResponse>>;
};
/**
* ClientTransactionApi - factory interface
* @export
*/
export declare const ClientTransactionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* The list capability of client transaction can support pagination. Example Requests: clients/189/transactions 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}
*/
retrieveAllClientTransactions(clientId: number, offset?: number, limit?: number, options?: any): AxiosPromise<GetClientsClientIdTransactionsResponse>;
/**
* Example Requests: clients/1/transactions/1 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}
*/
retrieveClientTransaction(clientId: number, transactionId: number, options?: any): AxiosPromise<GetClientsClientIdTransactionsTransactionIdResponse>;
/**
* Undoes a Client Transaction
* @summary Undo a Client Transaction
* @param {number} clientId clientId
* @param {number} transactionId transactionId
* @param {string} [command] command
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
undoClientTransaction(clientId: number, transactionId: number, command?: string, options?: any): AxiosPromise<PostClientsClientIdTransactionsTransactionIdResponse>;
};
/**
* ClientTransactionApi - object-oriented interface
* @export
* @class ClientTransactionApi
* @extends {BaseAPI}
*/
export declare class ClientTransactionApi extends BaseAPI {
/**
* The list capability of client transaction can support pagination. Example Requests: clients/189/transactions 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 ClientTransactionApi
*/
retrieveAllClientTransactions(clientId: number, offset?: number, limit?: number, options?: any): Promise<import("axios").AxiosResponse<GetClientsClientIdTransactionsResponse>>;
/**
* Example Requests: clients/1/transactions/1 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 ClientTransactionApi
*/
retrieveClientTransaction(clientId: number, transactionId: number, options?: any): Promise<import("axios").AxiosResponse<GetClientsClientIdTransactionsTransactionIdResponse>>;
/**
* Undoes a Client Transaction
* @summary Undo a Client Transaction
* @param {number} clientId clientId
* @param {number} transactionId transactionId
* @param {string} [command] command
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ClientTransactionApi
*/
undoClientTransaction(clientId: number, transactionId: number, command?: string, options?: any): Promise<import("axios").AxiosResponse<PostClientsClientIdTransactionsTransactionIdResponse>>;
}