fineract_sdk/dist/src/api/charges-api.d.ts

Wrapper around fineract api.

/**
 * 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 { DeleteChargesChargeIdResponse } from '../models';
import { GetChargesResponse } from '../models';
import { GetChargesTemplateResponse } from '../models';
import { PostChargesRequest } from '../models';
import { PostChargesResponse } from '../models';
import { PutChargesChargeIdRequest } from '../models';
import { PutChargesChargeIdResponse } from '../models';
/**
 * ChargesApi - axios parameter creator
 * @export
 */
export declare const ChargesApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Define a new charge that can later be associated with loans and savings through their respective product definitions or directly on each account instance.
     * @summary Create/Define a Charge
     * @param {PostChargesRequest} postChargesRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createCharge: (postChargesRequest: PostChargesRequest, options?: any) => Promise<RequestArgs>;
    /**
     * Deletes a Charge.
     * @summary Delete a Charge
     * @param {number} chargeId chargeId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteCharge: (chargeId: number, options?: any) => Promise<RequestArgs>;
    /**
     * Returns the list of defined charges.  Example Requests:  charges
     * @summary Retrieve Charges
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveAllCharges: (options?: any) => Promise<RequestArgs>;
    /**
     * Returns the details of a defined Charge.  Example Requests:  charges/1
     * @summary Retrieve a Charge
     * @param {number} chargeId chargeId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveCharge: (chargeId: 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 description Lists Example Request:  charges/template
     * @summary Retrieve Charge Template
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveNewChargeDetails: (options?: any) => Promise<RequestArgs>;
    /**
     * Updates the details of a Charge.
     * @summary Update a Charge
     * @param {number} chargeId chargeId
     * @param {PutChargesChargeIdRequest} putChargesChargeIdRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateCharge: (chargeId: number, putChargesChargeIdRequest: PutChargesChargeIdRequest, options?: any) => Promise<RequestArgs>;
};
/**
 * ChargesApi - functional programming interface
 * @export
 */
export declare const ChargesApiFp: (configuration?: Configuration) => {
    /**
     * Define a new charge that can later be associated with loans and savings through their respective product definitions or directly on each account instance.
     * @summary Create/Define a Charge
     * @param {PostChargesRequest} postChargesRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createCharge(postChargesRequest: PostChargesRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostChargesResponse>>;
    /**
     * Deletes a Charge.
     * @summary Delete a Charge
     * @param {number} chargeId chargeId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteCharge(chargeId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteChargesChargeIdResponse>>;
    /**
     * Returns the list of defined charges.  Example Requests:  charges
     * @summary Retrieve Charges
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveAllCharges(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GetChargesResponse>>>;
    /**
     * Returns the details of a defined Charge.  Example Requests:  charges/1
     * @summary Retrieve a Charge
     * @param {number} chargeId chargeId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveCharge(chargeId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetChargesResponse>>;
    /**
     * 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 description Lists Example Request:  charges/template
     * @summary Retrieve Charge Template
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveNewChargeDetails(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetChargesTemplateResponse>>;
    /**
     * Updates the details of a Charge.
     * @summary Update a Charge
     * @param {number} chargeId chargeId
     * @param {PutChargesChargeIdRequest} putChargesChargeIdRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateCharge(chargeId: number, putChargesChargeIdRequest: PutChargesChargeIdRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutChargesChargeIdResponse>>;
};
/**
 * ChargesApi - factory interface
 * @export
 */
export declare const ChargesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * Define a new charge that can later be associated with loans and savings through their respective product definitions or directly on each account instance.
     * @summary Create/Define a Charge
     * @param {PostChargesRequest} postChargesRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createCharge(postChargesRequest: PostChargesRequest, options?: any): AxiosPromise<PostChargesResponse>;
    /**
     * Deletes a Charge.
     * @summary Delete a Charge
     * @param {number} chargeId chargeId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteCharge(chargeId: number, options?: any): AxiosPromise<DeleteChargesChargeIdResponse>;
    /**
     * Returns the list of defined charges.  Example Requests:  charges
     * @summary Retrieve Charges
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveAllCharges(options?: any): AxiosPromise<Array<GetChargesResponse>>;
    /**
     * Returns the details of a defined Charge.  Example Requests:  charges/1
     * @summary Retrieve a Charge
     * @param {number} chargeId chargeId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveCharge(chargeId: number, options?: any): AxiosPromise<GetChargesResponse>;
    /**
     * 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 description Lists Example Request:  charges/template
     * @summary Retrieve Charge Template
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveNewChargeDetails(options?: any): AxiosPromise<GetChargesTemplateResponse>;
    /**
     * Updates the details of a Charge.
     * @summary Update a Charge
     * @param {number} chargeId chargeId
     * @param {PutChargesChargeIdRequest} putChargesChargeIdRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateCharge(chargeId: number, putChargesChargeIdRequest: PutChargesChargeIdRequest, options?: any): AxiosPromise<PutChargesChargeIdResponse>;
};
/**
 * ChargesApi - object-oriented interface
 * @export
 * @class ChargesApi
 * @extends {BaseAPI}
 */
export declare class ChargesApi extends BaseAPI {
    /**
     * Define a new charge that can later be associated with loans and savings through their respective product definitions or directly on each account instance.
     * @summary Create/Define a Charge
     * @param {PostChargesRequest} postChargesRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ChargesApi
     */
    createCharge(postChargesRequest: PostChargesRequest, options?: any): Promise<import("axios").AxiosResponse<PostChargesResponse>>;
    /**
     * Deletes a Charge.
     * @summary Delete a Charge
     * @param {number} chargeId chargeId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ChargesApi
     */
    deleteCharge(chargeId: number, options?: any): Promise<import("axios").AxiosResponse<DeleteChargesChargeIdResponse>>;
    /**
     * Returns the list of defined charges.  Example Requests:  charges
     * @summary Retrieve Charges
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ChargesApi
     */
    retrieveAllCharges(options?: any): Promise<import("axios").AxiosResponse<GetChargesResponse[]>>;
    /**
     * Returns the details of a defined Charge.  Example Requests:  charges/1
     * @summary Retrieve a Charge
     * @param {number} chargeId chargeId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ChargesApi
     */
    retrieveCharge(chargeId: number, options?: any): Promise<import("axios").AxiosResponse<GetChargesResponse>>;
    /**
     * 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 description Lists Example Request:  charges/template
     * @summary Retrieve Charge Template
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ChargesApi
     */
    retrieveNewChargeDetails(options?: any): Promise<import("axios").AxiosResponse<GetChargesTemplateResponse>>;
    /**
     * Updates the details of a Charge.
     * @summary Update a Charge
     * @param {number} chargeId chargeId
     * @param {PutChargesChargeIdRequest} putChargesChargeIdRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ChargesApi
     */
    updateCharge(chargeId: number, putChargesChargeIdRequest: PutChargesChargeIdRequest, options?: any): Promise<import("axios").AxiosResponse<PutChargesChargeIdResponse>>;
}