fineract_sdk
Version:
Wrapper around fineract api.
213 lines (212 loc) • 10.9 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 { DeletePaymentTypesPaymentTypeIdResponse } from '../models';
import { GetPaymentTypesPaymentTypeIdResponse } from '../models';
import { GetPaymentTypesResponse } from '../models';
import { PostPaymentTypesRequest } from '../models';
import { PostPaymentTypesResponse } from '../models';
import { PutPaymentTypesPaymentTypeIdRequest } from '../models';
import { PutPaymentTypesPaymentTypeIdResponse } from '../models';
/**
* PaymentTypeApi - axios parameter creator
* @export
*/
export declare const PaymentTypeApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Creates a new Payment type Mandatory Fields: name Optional Fields: Description, isCashPayment,Position
* @summary Create a Payment Type
* @param {PostPaymentTypesRequest} postPaymentTypesRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createPaymentType: (postPaymentTypesRequest: PostPaymentTypesRequest, options?: any) => Promise<RequestArgs>;
/**
* Deletes payment type
* @summary Delete a Payment Type
* @param {number} paymentTypeId paymentTypeId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteCode1: (paymentTypeId: number, options?: any) => Promise<RequestArgs>;
/**
* Retrieve list of payment types
* @summary Retrieve all Payment Types
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getAllPaymentTypes: (options?: any) => Promise<RequestArgs>;
/**
* Retrieves a payment type
* @summary Retrieve a Payment Type
* @param {number} paymentTypeId paymentTypeId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveOnePaymentType: (paymentTypeId: number, options?: any) => Promise<RequestArgs>;
/**
* Updates a Payment Type
* @summary Update a Payment Type
* @param {number} paymentTypeId paymentTypeId
* @param {PutPaymentTypesPaymentTypeIdRequest} putPaymentTypesPaymentTypeIdRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updatePaymentType: (paymentTypeId: number, putPaymentTypesPaymentTypeIdRequest: PutPaymentTypesPaymentTypeIdRequest, options?: any) => Promise<RequestArgs>;
};
/**
* PaymentTypeApi - functional programming interface
* @export
*/
export declare const PaymentTypeApiFp: (configuration?: Configuration) => {
/**
* Creates a new Payment type Mandatory Fields: name Optional Fields: Description, isCashPayment,Position
* @summary Create a Payment Type
* @param {PostPaymentTypesRequest} postPaymentTypesRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createPaymentType(postPaymentTypesRequest: PostPaymentTypesRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostPaymentTypesResponse>>;
/**
* Deletes payment type
* @summary Delete a Payment Type
* @param {number} paymentTypeId paymentTypeId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteCode1(paymentTypeId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeletePaymentTypesPaymentTypeIdResponse>>;
/**
* Retrieve list of payment types
* @summary Retrieve all Payment Types
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getAllPaymentTypes(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GetPaymentTypesResponse>>>;
/**
* Retrieves a payment type
* @summary Retrieve a Payment Type
* @param {number} paymentTypeId paymentTypeId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveOnePaymentType(paymentTypeId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPaymentTypesPaymentTypeIdResponse>>;
/**
* Updates a Payment Type
* @summary Update a Payment Type
* @param {number} paymentTypeId paymentTypeId
* @param {PutPaymentTypesPaymentTypeIdRequest} putPaymentTypesPaymentTypeIdRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updatePaymentType(paymentTypeId: number, putPaymentTypesPaymentTypeIdRequest: PutPaymentTypesPaymentTypeIdRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutPaymentTypesPaymentTypeIdResponse>>;
};
/**
* PaymentTypeApi - factory interface
* @export
*/
export declare const PaymentTypeApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Creates a new Payment type Mandatory Fields: name Optional Fields: Description, isCashPayment,Position
* @summary Create a Payment Type
* @param {PostPaymentTypesRequest} postPaymentTypesRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createPaymentType(postPaymentTypesRequest: PostPaymentTypesRequest, options?: any): AxiosPromise<PostPaymentTypesResponse>;
/**
* Deletes payment type
* @summary Delete a Payment Type
* @param {number} paymentTypeId paymentTypeId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteCode1(paymentTypeId: number, options?: any): AxiosPromise<DeletePaymentTypesPaymentTypeIdResponse>;
/**
* Retrieve list of payment types
* @summary Retrieve all Payment Types
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getAllPaymentTypes(options?: any): AxiosPromise<Array<GetPaymentTypesResponse>>;
/**
* Retrieves a payment type
* @summary Retrieve a Payment Type
* @param {number} paymentTypeId paymentTypeId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveOnePaymentType(paymentTypeId: number, options?: any): AxiosPromise<GetPaymentTypesPaymentTypeIdResponse>;
/**
* Updates a Payment Type
* @summary Update a Payment Type
* @param {number} paymentTypeId paymentTypeId
* @param {PutPaymentTypesPaymentTypeIdRequest} putPaymentTypesPaymentTypeIdRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updatePaymentType(paymentTypeId: number, putPaymentTypesPaymentTypeIdRequest: PutPaymentTypesPaymentTypeIdRequest, options?: any): AxiosPromise<PutPaymentTypesPaymentTypeIdResponse>;
};
/**
* PaymentTypeApi - object-oriented interface
* @export
* @class PaymentTypeApi
* @extends {BaseAPI}
*/
export declare class PaymentTypeApi extends BaseAPI {
/**
* Creates a new Payment type Mandatory Fields: name Optional Fields: Description, isCashPayment,Position
* @summary Create a Payment Type
* @param {PostPaymentTypesRequest} postPaymentTypesRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof PaymentTypeApi
*/
createPaymentType(postPaymentTypesRequest: PostPaymentTypesRequest, options?: any): Promise<import("axios").AxiosResponse<PostPaymentTypesResponse>>;
/**
* Deletes payment type
* @summary Delete a Payment Type
* @param {number} paymentTypeId paymentTypeId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof PaymentTypeApi
*/
deleteCode1(paymentTypeId: number, options?: any): Promise<import("axios").AxiosResponse<DeletePaymentTypesPaymentTypeIdResponse>>;
/**
* Retrieve list of payment types
* @summary Retrieve all Payment Types
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof PaymentTypeApi
*/
getAllPaymentTypes(options?: any): Promise<import("axios").AxiosResponse<GetPaymentTypesResponse[]>>;
/**
* Retrieves a payment type
* @summary Retrieve a Payment Type
* @param {number} paymentTypeId paymentTypeId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof PaymentTypeApi
*/
retrieveOnePaymentType(paymentTypeId: number, options?: any): Promise<import("axios").AxiosResponse<GetPaymentTypesPaymentTypeIdResponse>>;
/**
* Updates a Payment Type
* @summary Update a Payment Type
* @param {number} paymentTypeId paymentTypeId
* @param {PutPaymentTypesPaymentTypeIdRequest} putPaymentTypesPaymentTypeIdRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof PaymentTypeApi
*/
updatePaymentType(paymentTypeId: number, putPaymentTypesPaymentTypeIdRequest: PutPaymentTypesPaymentTypeIdRequest, options?: any): Promise<import("axios").AxiosResponse<PutPaymentTypesPaymentTypeIdResponse>>;
}