fineract_sdk/dist/api/client-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 { DeleteClientsClientIdChargesChargeIdResponse } from '../models';
import { GetClientsChargesPageItems } from '../models';
import { GetClientsClientIdChargesResponse } from '../models';
import { PostClientsClientIdChargesChargeIdRequest } from '../models';
import { PostClientsClientIdChargesChargeIdResponse } from '../models';
import { PostClientsClientIdChargesRequest } from '../models';
import { PostClientsClientIdChargesResponse } from '../models';
/**
 * ClientChargesApi - axios parameter creator
 * @export
 */
export declare const ClientChargesApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *  This API associates a Client charge with an implicit Client account Mandatory Fields :  chargeId and dueDate   Optional Fields :  amount
     * @summary Add Client Charge
     * @param {number} clientId clientId
     * @param {PostClientsClientIdChargesRequest} postClientsClientIdChargesRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    applyClientCharge: (clientId: number, postClientsClientIdChargesRequest: PostClientsClientIdChargesRequest, options?: any) => Promise<RequestArgs>;
    /**
     * Deletes a Client Charge on which no transactions have taken place (either payments or waivers).
     * @summary Delete a Client Charge
     * @param {number} clientId clientId
     * @param {number} chargeId chargeId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteClientCharge: (clientId: number, chargeId: number, options?: any) => Promise<RequestArgs>;
    /**
     * Pay a Client Charge:  Mandatory Fields:transactionDate and amount \"Pay either a part of or the entire due amount for a charge.(command=paycharge)  Waive a Client Charge:   This API provides the facility of waiving off the remaining amount on a client charge (command=waive)  Showing request/response for \'Pay a Client Charge\'
     * @summary Pay a Client Charge | Waive a Client Charge
     * @param {number} clientId clientId
     * @param {number} chargeId chargeId
     * @param {PostClientsClientIdChargesChargeIdRequest} postClientsClientIdChargesChargeIdRequest
     * @param {string} [command] command
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    payOrWaiveClientCharge: (clientId: number, chargeId: number, postClientsClientIdChargesChargeIdRequest: PostClientsClientIdChargesChargeIdRequest, command?: string, options?: any) => Promise<RequestArgs>;
    /**
     * The list capability of client charges supports pagination.Example Requests: clients/1/charges  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}
     */
    retrieveAllClientCharges: (clientId: number, chargeStatus?: string, pendingPayment?: boolean, limit?: number, offset?: number, options?: any) => Promise<RequestArgs>;
    /**
     * Example Requests: clients/1/charges/1   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}
     */
    retrieveClientCharge: (clientId: number, chargeId: number, options?: any) => Promise<RequestArgs>;
    /**
     *
     * @param {number} clientId clientId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveTemplate4: (clientId: number, options?: any) => Promise<RequestArgs>;
};
/**
 * ClientChargesApi - functional programming interface
 * @export
 */
export declare const ClientChargesApiFp: (configuration?: Configuration) => {
    /**
     *  This API associates a Client charge with an implicit Client account Mandatory Fields :  chargeId and dueDate   Optional Fields :  amount
     * @summary Add Client Charge
     * @param {number} clientId clientId
     * @param {PostClientsClientIdChargesRequest} postClientsClientIdChargesRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    applyClientCharge(clientId: number, postClientsClientIdChargesRequest: PostClientsClientIdChargesRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostClientsClientIdChargesResponse>>;
    /**
     * Deletes a Client Charge on which no transactions have taken place (either payments or waivers).
     * @summary Delete a Client Charge
     * @param {number} clientId clientId
     * @param {number} chargeId chargeId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteClientCharge(clientId: number, chargeId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteClientsClientIdChargesChargeIdResponse>>;
    /**
     * Pay a Client Charge:  Mandatory Fields:transactionDate and amount \"Pay either a part of or the entire due amount for a charge.(command=paycharge)  Waive a Client Charge:   This API provides the facility of waiving off the remaining amount on a client charge (command=waive)  Showing request/response for \'Pay a Client Charge\'
     * @summary Pay a Client Charge | Waive a Client Charge
     * @param {number} clientId clientId
     * @param {number} chargeId chargeId
     * @param {PostClientsClientIdChargesChargeIdRequest} postClientsClientIdChargesChargeIdRequest
     * @param {string} [command] command
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    payOrWaiveClientCharge(clientId: number, chargeId: number, postClientsClientIdChargesChargeIdRequest: PostClientsClientIdChargesChargeIdRequest, command?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostClientsClientIdChargesChargeIdResponse>>;
    /**
     * The list capability of client charges supports pagination.Example Requests: clients/1/charges  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}
     */
    retrieveAllClientCharges(clientId: number, chargeStatus?: string, pendingPayment?: boolean, limit?: number, offset?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetClientsClientIdChargesResponse>>;
    /**
     * Example Requests: clients/1/charges/1   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}
     */
    retrieveClientCharge(clientId: number, chargeId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetClientsChargesPageItems>>;
    /**
     *
     * @param {number} clientId clientId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveTemplate4(clientId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
};
/**
 * ClientChargesApi - factory interface
 * @export
 */
export declare const ClientChargesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     *  This API associates a Client charge with an implicit Client account Mandatory Fields :  chargeId and dueDate   Optional Fields :  amount
     * @summary Add Client Charge
     * @param {number} clientId clientId
     * @param {PostClientsClientIdChargesRequest} postClientsClientIdChargesRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    applyClientCharge(clientId: number, postClientsClientIdChargesRequest: PostClientsClientIdChargesRequest, options?: any): AxiosPromise<PostClientsClientIdChargesResponse>;
    /**
     * Deletes a Client Charge on which no transactions have taken place (either payments or waivers).
     * @summary Delete a Client Charge
     * @param {number} clientId clientId
     * @param {number} chargeId chargeId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteClientCharge(clientId: number, chargeId: number, options?: any): AxiosPromise<DeleteClientsClientIdChargesChargeIdResponse>;
    /**
     * Pay a Client Charge:  Mandatory Fields:transactionDate and amount \"Pay either a part of or the entire due amount for a charge.(command=paycharge)  Waive a Client Charge:   This API provides the facility of waiving off the remaining amount on a client charge (command=waive)  Showing request/response for \'Pay a Client Charge\'
     * @summary Pay a Client Charge | Waive a Client Charge
     * @param {number} clientId clientId
     * @param {number} chargeId chargeId
     * @param {PostClientsClientIdChargesChargeIdRequest} postClientsClientIdChargesChargeIdRequest
     * @param {string} [command] command
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    payOrWaiveClientCharge(clientId: number, chargeId: number, postClientsClientIdChargesChargeIdRequest: PostClientsClientIdChargesChargeIdRequest, command?: string, options?: any): AxiosPromise<PostClientsClientIdChargesChargeIdResponse>;
    /**
     * The list capability of client charges supports pagination.Example Requests: clients/1/charges  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}
     */
    retrieveAllClientCharges(clientId: number, chargeStatus?: string, pendingPayment?: boolean, limit?: number, offset?: number, options?: any): AxiosPromise<GetClientsClientIdChargesResponse>;
    /**
     * Example Requests: clients/1/charges/1   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}
     */
    retrieveClientCharge(clientId: number, chargeId: number, options?: any): AxiosPromise<GetClientsChargesPageItems>;
    /**
     *
     * @param {number} clientId clientId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveTemplate4(clientId: number, options?: any): AxiosPromise<string>;
};
/**
 * ClientChargesApi - object-oriented interface
 * @export
 * @class ClientChargesApi
 * @extends {BaseAPI}
 */
export declare class ClientChargesApi extends BaseAPI {
    /**
     *  This API associates a Client charge with an implicit Client account Mandatory Fields :  chargeId and dueDate   Optional Fields :  amount
     * @summary Add Client Charge
     * @param {number} clientId clientId
     * @param {PostClientsClientIdChargesRequest} postClientsClientIdChargesRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ClientChargesApi
     */
    applyClientCharge(clientId: number, postClientsClientIdChargesRequest: PostClientsClientIdChargesRequest, options?: any): Promise<import("axios").AxiosResponse<PostClientsClientIdChargesResponse>>;
    /**
     * Deletes a Client Charge on which no transactions have taken place (either payments or waivers).
     * @summary Delete a Client Charge
     * @param {number} clientId clientId
     * @param {number} chargeId chargeId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ClientChargesApi
     */
    deleteClientCharge(clientId: number, chargeId: number, options?: any): Promise<import("axios").AxiosResponse<DeleteClientsClientIdChargesChargeIdResponse>>;
    /**
     * Pay a Client Charge:  Mandatory Fields:transactionDate and amount \"Pay either a part of or the entire due amount for a charge.(command=paycharge)  Waive a Client Charge:   This API provides the facility of waiving off the remaining amount on a client charge (command=waive)  Showing request/response for \'Pay a Client Charge\'
     * @summary Pay a Client Charge | Waive a Client Charge
     * @param {number} clientId clientId
     * @param {number} chargeId chargeId
     * @param {PostClientsClientIdChargesChargeIdRequest} postClientsClientIdChargesChargeIdRequest
     * @param {string} [command] command
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ClientChargesApi
     */
    payOrWaiveClientCharge(clientId: number, chargeId: number, postClientsClientIdChargesChargeIdRequest: PostClientsClientIdChargesChargeIdRequest, command?: string, options?: any): Promise<import("axios").AxiosResponse<PostClientsClientIdChargesChargeIdResponse>>;
    /**
     * The list capability of client charges supports pagination.Example Requests: clients/1/charges  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 ClientChargesApi
     */
    retrieveAllClientCharges(clientId: number, chargeStatus?: string, pendingPayment?: boolean, limit?: number, offset?: number, options?: any): Promise<import("axios").AxiosResponse<GetClientsClientIdChargesResponse>>;
    /**
     * Example Requests: clients/1/charges/1   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 ClientChargesApi
     */
    retrieveClientCharge(clientId: number, chargeId: number, options?: any): Promise<import("axios").AxiosResponse<GetClientsChargesPageItems>>;
    /**
     *
     * @param {number} clientId clientId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ClientChargesApi
     */
    retrieveTemplate4(clientId: number, options?: any): Promise<import("axios").AxiosResponse<string>>;
}