fineract_sdk/dist/src/api/code-values-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 { DeleteCodeValueDataResponse } from '../models';
import { GetCodeValuesDataResponse } from '../models';
import { PostCodeValueDataResponse } from '../models';
import { PostCodeValuesDataRequest } from '../models';
import { PutCodeValueDataResponse } from '../models';
import { PutCodeValuesDataRequest } from '../models';
/**
 * CodeValuesApi - axios parameter creator
 * @export
 */
export declare const CodeValuesApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *
     * @summary Create a Code description
     * @param {number} codeId codeId
     * @param {PostCodeValuesDataRequest} postCodeValuesDataRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createCodeValue: (codeId: number, postCodeValuesDataRequest: PostCodeValuesDataRequest, options?: any) => Promise<RequestArgs>;
    /**
     * Deletes a code description
     * @summary Delete a Code description
     * @param {number} codeId codeId
     * @param {number} codeValueId codeValueId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteCodeValue: (codeId: number, codeValueId: number, options?: any) => Promise<RequestArgs>;
    /**
     * Returns the list of Code Values for a given Code  Example Requests:  codes/1/codevalues
     * @summary List Code Values
     * @param {number} codeId codeId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveAllCodeValues: (codeId: number, options?: any) => Promise<RequestArgs>;
    /**
     * Returns the details of a Code Value  Example Requests:  codes/1/codevalues/1
     * @summary Retrieve a Code description
     * @param {number} codeValueId codeValueId
     * @param {number} codeId codeId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveCodeValue: (codeValueId: number, codeId: number, options?: any) => Promise<RequestArgs>;
    /**
     * Updates the details of a code description.
     * @summary Update a Code description
     * @param {number} codeId codeId
     * @param {number} codeValueId codeValueId
     * @param {PutCodeValuesDataRequest} putCodeValuesDataRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateCodeValue: (codeId: number, codeValueId: number, putCodeValuesDataRequest: PutCodeValuesDataRequest, options?: any) => Promise<RequestArgs>;
};
/**
 * CodeValuesApi - functional programming interface
 * @export
 */
export declare const CodeValuesApiFp: (configuration?: Configuration) => {
    /**
     *
     * @summary Create a Code description
     * @param {number} codeId codeId
     * @param {PostCodeValuesDataRequest} postCodeValuesDataRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createCodeValue(codeId: number, postCodeValuesDataRequest: PostCodeValuesDataRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostCodeValueDataResponse>>;
    /**
     * Deletes a code description
     * @summary Delete a Code description
     * @param {number} codeId codeId
     * @param {number} codeValueId codeValueId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteCodeValue(codeId: number, codeValueId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteCodeValueDataResponse>>;
    /**
     * Returns the list of Code Values for a given Code  Example Requests:  codes/1/codevalues
     * @summary List Code Values
     * @param {number} codeId codeId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveAllCodeValues(codeId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GetCodeValuesDataResponse>>>;
    /**
     * Returns the details of a Code Value  Example Requests:  codes/1/codevalues/1
     * @summary Retrieve a Code description
     * @param {number} codeValueId codeValueId
     * @param {number} codeId codeId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveCodeValue(codeValueId: number, codeId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCodeValuesDataResponse>>;
    /**
     * Updates the details of a code description.
     * @summary Update a Code description
     * @param {number} codeId codeId
     * @param {number} codeValueId codeValueId
     * @param {PutCodeValuesDataRequest} putCodeValuesDataRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateCodeValue(codeId: number, codeValueId: number, putCodeValuesDataRequest: PutCodeValuesDataRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutCodeValueDataResponse>>;
};
/**
 * CodeValuesApi - factory interface
 * @export
 */
export declare const CodeValuesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     *
     * @summary Create a Code description
     * @param {number} codeId codeId
     * @param {PostCodeValuesDataRequest} postCodeValuesDataRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createCodeValue(codeId: number, postCodeValuesDataRequest: PostCodeValuesDataRequest, options?: any): AxiosPromise<PostCodeValueDataResponse>;
    /**
     * Deletes a code description
     * @summary Delete a Code description
     * @param {number} codeId codeId
     * @param {number} codeValueId codeValueId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteCodeValue(codeId: number, codeValueId: number, options?: any): AxiosPromise<DeleteCodeValueDataResponse>;
    /**
     * Returns the list of Code Values for a given Code  Example Requests:  codes/1/codevalues
     * @summary List Code Values
     * @param {number} codeId codeId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveAllCodeValues(codeId: number, options?: any): AxiosPromise<Array<GetCodeValuesDataResponse>>;
    /**
     * Returns the details of a Code Value  Example Requests:  codes/1/codevalues/1
     * @summary Retrieve a Code description
     * @param {number} codeValueId codeValueId
     * @param {number} codeId codeId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveCodeValue(codeValueId: number, codeId: number, options?: any): AxiosPromise<GetCodeValuesDataResponse>;
    /**
     * Updates the details of a code description.
     * @summary Update a Code description
     * @param {number} codeId codeId
     * @param {number} codeValueId codeValueId
     * @param {PutCodeValuesDataRequest} putCodeValuesDataRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateCodeValue(codeId: number, codeValueId: number, putCodeValuesDataRequest: PutCodeValuesDataRequest, options?: any): AxiosPromise<PutCodeValueDataResponse>;
};
/**
 * CodeValuesApi - object-oriented interface
 * @export
 * @class CodeValuesApi
 * @extends {BaseAPI}
 */
export declare class CodeValuesApi extends BaseAPI {
    /**
     *
     * @summary Create a Code description
     * @param {number} codeId codeId
     * @param {PostCodeValuesDataRequest} postCodeValuesDataRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof CodeValuesApi
     */
    createCodeValue(codeId: number, postCodeValuesDataRequest: PostCodeValuesDataRequest, options?: any): Promise<import("axios").AxiosResponse<PostCodeValueDataResponse>>;
    /**
     * Deletes a code description
     * @summary Delete a Code description
     * @param {number} codeId codeId
     * @param {number} codeValueId codeValueId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof CodeValuesApi
     */
    deleteCodeValue(codeId: number, codeValueId: number, options?: any): Promise<import("axios").AxiosResponse<DeleteCodeValueDataResponse>>;
    /**
     * Returns the list of Code Values for a given Code  Example Requests:  codes/1/codevalues
     * @summary List Code Values
     * @param {number} codeId codeId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof CodeValuesApi
     */
    retrieveAllCodeValues(codeId: number, options?: any): Promise<import("axios").AxiosResponse<GetCodeValuesDataResponse[]>>;
    /**
     * Returns the details of a Code Value  Example Requests:  codes/1/codevalues/1
     * @summary Retrieve a Code description
     * @param {number} codeValueId codeValueId
     * @param {number} codeId codeId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof CodeValuesApi
     */
    retrieveCodeValue(codeValueId: number, codeId: number, options?: any): Promise<import("axios").AxiosResponse<GetCodeValuesDataResponse>>;
    /**
     * Updates the details of a code description.
     * @summary Update a Code description
     * @param {number} codeId codeId
     * @param {number} codeValueId codeValueId
     * @param {PutCodeValuesDataRequest} putCodeValuesDataRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof CodeValuesApi
     */
    updateCodeValue(codeId: number, codeValueId: number, putCodeValuesDataRequest: PutCodeValuesDataRequest, options?: any): Promise<import("axios").AxiosResponse<PutCodeValueDataResponse>>;
}