fineract_sdk
Version:
Wrapper around fineract api.
206 lines (205 loc) • 17.3 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 { GetRecurringDepositAccountsRecurringDepositAccountIdTransactionsTemplateResponse } from '../models';
import { GetRecurringDepositAccountsRecurringDepositAccountIdTransactionsTransactionIdResponse } from '../models';
import { PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest } from '../models';
import { PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsResponse } from '../models';
import { PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsTransactionIdResponse } from '../models';
/**
* RecurringDepositAccountTransactionsApi - axios parameter creator
* @export
*/
export declare const RecurringDepositAccountTransactionsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Adjust Transaction: This command modifies the given transaction. Undo transaction: This command reverses the given transaction. Showing request/response for \'Adjust Transaction\'
* @summary Adjust Transaction | Undo transaction
* @param {number} recurringDepositAccountId recurringDepositAccountId
* @param {number} transactionId transactionId
* @param {PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest} postRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest
* @param {string} [command] command
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
handleTransactionCommands: (recurringDepositAccountId: number, transactionId: number, postRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest: PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest, command?: string, options?: any) => Promise<RequestArgs>;
/**
* Retrieves Recurring Deposit Account Transaction Example Requests: recurringdepositaccounts/1/transactions/1
* @summary Retrieve Recurring Deposit Account Transaction
* @param {number} recurringDepositAccountId recurringDepositAccountId
* @param {number} transactionId transactionId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveOne20: (recurringDepositAccountId: number, transactionId: number, 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: recurringdepositaccounts/1/transactions/template?command=deposit recurringdepositaccounts/1/transactions/template?command=withdrawal
* @summary Retrieve Recurring Deposit Account Transaction Template
* @param {number} recurringDepositAccountId recurringDepositAccountId
* @param {string} [command] command
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveTemplate15: (recurringDepositAccountId: number, command?: string, options?: any) => Promise<RequestArgs>;
/**
* Deposit Transaction: Used for a deposit transaction Withdrawal Transaction: Used for a Withdrawal Transaction Showing request/response for Deposit Transaction
* @summary Deposit Transaction | Withdrawal Transaction
* @param {number} recurringDepositAccountId recurringDepositAccountId
* @param {PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest} postRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest
* @param {string} [command] command
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
transaction1: (recurringDepositAccountId: number, postRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest: PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest, command?: string, options?: any) => Promise<RequestArgs>;
};
/**
* RecurringDepositAccountTransactionsApi - functional programming interface
* @export
*/
export declare const RecurringDepositAccountTransactionsApiFp: (configuration?: Configuration) => {
/**
* Adjust Transaction: This command modifies the given transaction. Undo transaction: This command reverses the given transaction. Showing request/response for \'Adjust Transaction\'
* @summary Adjust Transaction | Undo transaction
* @param {number} recurringDepositAccountId recurringDepositAccountId
* @param {number} transactionId transactionId
* @param {PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest} postRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest
* @param {string} [command] command
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
handleTransactionCommands(recurringDepositAccountId: number, transactionId: number, postRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest: PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest, command?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsTransactionIdResponse>>;
/**
* Retrieves Recurring Deposit Account Transaction Example Requests: recurringdepositaccounts/1/transactions/1
* @summary Retrieve Recurring Deposit Account Transaction
* @param {number} recurringDepositAccountId recurringDepositAccountId
* @param {number} transactionId transactionId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveOne20(recurringDepositAccountId: number, transactionId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetRecurringDepositAccountsRecurringDepositAccountIdTransactionsTransactionIdResponse>>;
/**
* 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: recurringdepositaccounts/1/transactions/template?command=deposit recurringdepositaccounts/1/transactions/template?command=withdrawal
* @summary Retrieve Recurring Deposit Account Transaction Template
* @param {number} recurringDepositAccountId recurringDepositAccountId
* @param {string} [command] command
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveTemplate15(recurringDepositAccountId: number, command?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetRecurringDepositAccountsRecurringDepositAccountIdTransactionsTemplateResponse>>;
/**
* Deposit Transaction: Used for a deposit transaction Withdrawal Transaction: Used for a Withdrawal Transaction Showing request/response for Deposit Transaction
* @summary Deposit Transaction | Withdrawal Transaction
* @param {number} recurringDepositAccountId recurringDepositAccountId
* @param {PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest} postRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest
* @param {string} [command] command
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
transaction1(recurringDepositAccountId: number, postRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest: PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest, command?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsResponse>>;
};
/**
* RecurringDepositAccountTransactionsApi - factory interface
* @export
*/
export declare const RecurringDepositAccountTransactionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Adjust Transaction: This command modifies the given transaction. Undo transaction: This command reverses the given transaction. Showing request/response for \'Adjust Transaction\'
* @summary Adjust Transaction | Undo transaction
* @param {number} recurringDepositAccountId recurringDepositAccountId
* @param {number} transactionId transactionId
* @param {PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest} postRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest
* @param {string} [command] command
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
handleTransactionCommands(recurringDepositAccountId: number, transactionId: number, postRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest: PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest, command?: string, options?: any): AxiosPromise<PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsTransactionIdResponse>;
/**
* Retrieves Recurring Deposit Account Transaction Example Requests: recurringdepositaccounts/1/transactions/1
* @summary Retrieve Recurring Deposit Account Transaction
* @param {number} recurringDepositAccountId recurringDepositAccountId
* @param {number} transactionId transactionId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveOne20(recurringDepositAccountId: number, transactionId: number, options?: any): AxiosPromise<GetRecurringDepositAccountsRecurringDepositAccountIdTransactionsTransactionIdResponse>;
/**
* 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: recurringdepositaccounts/1/transactions/template?command=deposit recurringdepositaccounts/1/transactions/template?command=withdrawal
* @summary Retrieve Recurring Deposit Account Transaction Template
* @param {number} recurringDepositAccountId recurringDepositAccountId
* @param {string} [command] command
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveTemplate15(recurringDepositAccountId: number, command?: string, options?: any): AxiosPromise<GetRecurringDepositAccountsRecurringDepositAccountIdTransactionsTemplateResponse>;
/**
* Deposit Transaction: Used for a deposit transaction Withdrawal Transaction: Used for a Withdrawal Transaction Showing request/response for Deposit Transaction
* @summary Deposit Transaction | Withdrawal Transaction
* @param {number} recurringDepositAccountId recurringDepositAccountId
* @param {PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest} postRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest
* @param {string} [command] command
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
transaction1(recurringDepositAccountId: number, postRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest: PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest, command?: string, options?: any): AxiosPromise<PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsResponse>;
};
/**
* RecurringDepositAccountTransactionsApi - object-oriented interface
* @export
* @class RecurringDepositAccountTransactionsApi
* @extends {BaseAPI}
*/
export declare class RecurringDepositAccountTransactionsApi extends BaseAPI {
/**
* Adjust Transaction: This command modifies the given transaction. Undo transaction: This command reverses the given transaction. Showing request/response for \'Adjust Transaction\'
* @summary Adjust Transaction | Undo transaction
* @param {number} recurringDepositAccountId recurringDepositAccountId
* @param {number} transactionId transactionId
* @param {PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest} postRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest
* @param {string} [command] command
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof RecurringDepositAccountTransactionsApi
*/
handleTransactionCommands(recurringDepositAccountId: number, transactionId: number, postRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest: PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest, command?: string, options?: any): Promise<import("axios").AxiosResponse<PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsTransactionIdResponse>>;
/**
* Retrieves Recurring Deposit Account Transaction Example Requests: recurringdepositaccounts/1/transactions/1
* @summary Retrieve Recurring Deposit Account Transaction
* @param {number} recurringDepositAccountId recurringDepositAccountId
* @param {number} transactionId transactionId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof RecurringDepositAccountTransactionsApi
*/
retrieveOne20(recurringDepositAccountId: number, transactionId: number, options?: any): Promise<import("axios").AxiosResponse<GetRecurringDepositAccountsRecurringDepositAccountIdTransactionsTransactionIdResponse>>;
/**
* 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: recurringdepositaccounts/1/transactions/template?command=deposit recurringdepositaccounts/1/transactions/template?command=withdrawal
* @summary Retrieve Recurring Deposit Account Transaction Template
* @param {number} recurringDepositAccountId recurringDepositAccountId
* @param {string} [command] command
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof RecurringDepositAccountTransactionsApi
*/
retrieveTemplate15(recurringDepositAccountId: number, command?: string, options?: any): Promise<import("axios").AxiosResponse<GetRecurringDepositAccountsRecurringDepositAccountIdTransactionsTemplateResponse>>;
/**
* Deposit Transaction: Used for a deposit transaction Withdrawal Transaction: Used for a Withdrawal Transaction Showing request/response for Deposit Transaction
* @summary Deposit Transaction | Withdrawal Transaction
* @param {number} recurringDepositAccountId recurringDepositAccountId
* @param {PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest} postRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest
* @param {string} [command] command
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof RecurringDepositAccountTransactionsApi
*/
transaction1(recurringDepositAccountId: number, postRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest: PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest, command?: string, options?: any): Promise<import("axios").AxiosResponse<PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsResponse>>;
}