fineract_sdk/dist/api/entity-data-table-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 { DeleteEntityDatatableChecksTemplateResponse } from '../models';
import { GetEntityDatatableChecksResponse } from '../models';
import { GetEntityDatatableChecksTemplateResponse } from '../models';
import { PostEntityDatatableChecksTemplateRequest } from '../models';
import { PostEntityDatatableChecksTemplateResponse } from '../models';
/**
 * EntityDataTableApi - axios parameter creator
 * @export
 */
export declare const EntityDataTableApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Mandatory Fields :  entity, status, datatableName  Non-Mandatory Fields :  productId
     * @summary Create Entity-Datatable Checks
     * @param {PostEntityDatatableChecksTemplateRequest} postEntityDatatableChecksTemplateRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createEntityDatatableCheck: (postEntityDatatableChecksTemplateRequest: PostEntityDatatableChecksTemplateRequest, options?: any) => Promise<RequestArgs>;
    /**
     * Deletes an existing Entity-Datatable Check
     * @summary Delete Entity-Datatable Checks
     * @param {number} entityDatatableCheckId entityDatatableCheckId
     * @param {string} [body]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteDatatable1: (entityDatatableCheckId: number, body?: string, options?: any) => Promise<RequestArgs>;
    /**
     * This is a convenience resource useful for building maintenance user interface screens for Entity-Datatable Checks applications. The template data returned consists of:  Allowed description Lists Example Request:  entityDatatableChecks/template
     * @summary Retrieve Entity-Datatable Checks Template
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getTemplate: (options?: any) => Promise<RequestArgs>;
    /**
     * The list capability of Entity-Datatable Checks can support pagination.  OPTIONAL ARGUMENTS offset Integer optional, defaults to 0 Indicates the result from which pagination startslimit Integer optional, defaults to 200 Restricts the size of results returned. To override the default and return all entries you must explicitly pass a non-positive integer value for limit e.g. limit=0, or limit=-1 Example Request:  entityDatatableChecks?offset=0&limit=15
     * @summary List Entity-Datatable Checks
     * @param {number} [status] status
     * @param {string} [entity] entity
     * @param {number} [productId] productId
     * @param {number} [offset] offset
     * @param {number} [limit] limit
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveAll6: (status?: number, entity?: string, productId?: number, offset?: number, limit?: number, options?: any) => Promise<RequestArgs>;
};
/**
 * EntityDataTableApi - functional programming interface
 * @export
 */
export declare const EntityDataTableApiFp: (configuration?: Configuration) => {
    /**
     * Mandatory Fields :  entity, status, datatableName  Non-Mandatory Fields :  productId
     * @summary Create Entity-Datatable Checks
     * @param {PostEntityDatatableChecksTemplateRequest} postEntityDatatableChecksTemplateRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createEntityDatatableCheck(postEntityDatatableChecksTemplateRequest: PostEntityDatatableChecksTemplateRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostEntityDatatableChecksTemplateResponse>>;
    /**
     * Deletes an existing Entity-Datatable Check
     * @summary Delete Entity-Datatable Checks
     * @param {number} entityDatatableCheckId entityDatatableCheckId
     * @param {string} [body]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteDatatable1(entityDatatableCheckId: number, body?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteEntityDatatableChecksTemplateResponse>>;
    /**
     * This is a convenience resource useful for building maintenance user interface screens for Entity-Datatable Checks applications. The template data returned consists of:  Allowed description Lists Example Request:  entityDatatableChecks/template
     * @summary Retrieve Entity-Datatable Checks Template
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getTemplate(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEntityDatatableChecksTemplateResponse>>;
    /**
     * The list capability of Entity-Datatable Checks can support pagination.  OPTIONAL ARGUMENTS offset Integer optional, defaults to 0 Indicates the result from which pagination startslimit Integer optional, defaults to 200 Restricts the size of results returned. To override the default and return all entries you must explicitly pass a non-positive integer value for limit e.g. limit=0, or limit=-1 Example Request:  entityDatatableChecks?offset=0&limit=15
     * @summary List Entity-Datatable Checks
     * @param {number} [status] status
     * @param {string} [entity] entity
     * @param {number} [productId] productId
     * @param {number} [offset] offset
     * @param {number} [limit] limit
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveAll6(status?: number, entity?: string, productId?: number, offset?: number, limit?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GetEntityDatatableChecksResponse>>>;
};
/**
 * EntityDataTableApi - factory interface
 * @export
 */
export declare const EntityDataTableApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * Mandatory Fields :  entity, status, datatableName  Non-Mandatory Fields :  productId
     * @summary Create Entity-Datatable Checks
     * @param {PostEntityDatatableChecksTemplateRequest} postEntityDatatableChecksTemplateRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createEntityDatatableCheck(postEntityDatatableChecksTemplateRequest: PostEntityDatatableChecksTemplateRequest, options?: any): AxiosPromise<PostEntityDatatableChecksTemplateResponse>;
    /**
     * Deletes an existing Entity-Datatable Check
     * @summary Delete Entity-Datatable Checks
     * @param {number} entityDatatableCheckId entityDatatableCheckId
     * @param {string} [body]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteDatatable1(entityDatatableCheckId: number, body?: string, options?: any): AxiosPromise<DeleteEntityDatatableChecksTemplateResponse>;
    /**
     * This is a convenience resource useful for building maintenance user interface screens for Entity-Datatable Checks applications. The template data returned consists of:  Allowed description Lists Example Request:  entityDatatableChecks/template
     * @summary Retrieve Entity-Datatable Checks Template
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getTemplate(options?: any): AxiosPromise<GetEntityDatatableChecksTemplateResponse>;
    /**
     * The list capability of Entity-Datatable Checks can support pagination.  OPTIONAL ARGUMENTS offset Integer optional, defaults to 0 Indicates the result from which pagination startslimit Integer optional, defaults to 200 Restricts the size of results returned. To override the default and return all entries you must explicitly pass a non-positive integer value for limit e.g. limit=0, or limit=-1 Example Request:  entityDatatableChecks?offset=0&limit=15
     * @summary List Entity-Datatable Checks
     * @param {number} [status] status
     * @param {string} [entity] entity
     * @param {number} [productId] productId
     * @param {number} [offset] offset
     * @param {number} [limit] limit
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveAll6(status?: number, entity?: string, productId?: number, offset?: number, limit?: number, options?: any): AxiosPromise<Array<GetEntityDatatableChecksResponse>>;
};
/**
 * EntityDataTableApi - object-oriented interface
 * @export
 * @class EntityDataTableApi
 * @extends {BaseAPI}
 */
export declare class EntityDataTableApi extends BaseAPI {
    /**
     * Mandatory Fields :  entity, status, datatableName  Non-Mandatory Fields :  productId
     * @summary Create Entity-Datatable Checks
     * @param {PostEntityDatatableChecksTemplateRequest} postEntityDatatableChecksTemplateRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof EntityDataTableApi
     */
    createEntityDatatableCheck(postEntityDatatableChecksTemplateRequest: PostEntityDatatableChecksTemplateRequest, options?: any): Promise<import("axios").AxiosResponse<PostEntityDatatableChecksTemplateResponse>>;
    /**
     * Deletes an existing Entity-Datatable Check
     * @summary Delete Entity-Datatable Checks
     * @param {number} entityDatatableCheckId entityDatatableCheckId
     * @param {string} [body]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof EntityDataTableApi
     */
    deleteDatatable1(entityDatatableCheckId: number, body?: string, options?: any): Promise<import("axios").AxiosResponse<DeleteEntityDatatableChecksTemplateResponse>>;
    /**
     * This is a convenience resource useful for building maintenance user interface screens for Entity-Datatable Checks applications. The template data returned consists of:  Allowed description Lists Example Request:  entityDatatableChecks/template
     * @summary Retrieve Entity-Datatable Checks Template
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof EntityDataTableApi
     */
    getTemplate(options?: any): Promise<import("axios").AxiosResponse<GetEntityDatatableChecksTemplateResponse>>;
    /**
     * The list capability of Entity-Datatable Checks can support pagination.  OPTIONAL ARGUMENTS offset Integer optional, defaults to 0 Indicates the result from which pagination startslimit Integer optional, defaults to 200 Restricts the size of results returned. To override the default and return all entries you must explicitly pass a non-positive integer value for limit e.g. limit=0, or limit=-1 Example Request:  entityDatatableChecks?offset=0&limit=15
     * @summary List Entity-Datatable Checks
     * @param {number} [status] status
     * @param {string} [entity] entity
     * @param {number} [productId] productId
     * @param {number} [offset] offset
     * @param {number} [limit] limit
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof EntityDataTableApi
     */
    retrieveAll6(status?: number, entity?: string, productId?: number, offset?: number, limit?: number, options?: any): Promise<import("axios").AxiosResponse<GetEntityDatatableChecksResponse[]>>;
}