fineract_sdk

/** * 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 { DeleteEntityTypeEntityIdDocumentsResponse } from '../models'; import { FormDataBodyPart } from '../models'; import { GetEntityTypeEntityIdDocumentsResponse } from '../models'; import { PostEntityTypeEntityIdDocumentsResponse } from '../models'; import { PutEntityTypeEntityIdDocumentsResponse } from '../models'; /** * DocumentsApi - axios parameter creator * @export */ export declare const DocumentsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Note: A document is created using a Multi-part form upload Body Parts name : Name or summary of the document description : Description of the document file : The file to be uploaded Mandatory Fields : file and description * @summary Create a Document * @param {string} entityType entityType * @param {number} entityId entityId * @param {number} [contentLength] Content-Length * @param {FormDataBodyPart} [file] * @param {string} [name] name * @param {string} [description] description * @param {*} [options] Override http request option. * @throws {RequiredError} */ createDocument: (entityType: string, entityId: number, contentLength?: number, file?: any, name?: string, description?: string, options?: any) => Promise<RequestArgs>; /** * * @summary Remove a Document * @param {string} entityType entityType * @param {number} entityId entityId * @param {number} documentId documentId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteDocument: (entityType: string, entityId: number, documentId: number, options?: any) => Promise<RequestArgs>; /** * Request used to download the file associated with the document Example Requests: clients/1/documents/1/attachment loans/1/documents/1/attachment * @summary Retrieve Binary File associated with Document * @param {string} entityType entityType * @param {number} entityId entityId * @param {number} documentId documentId * @param {*} [options] Override http request option. * @throws {RequiredError} */ downloadFile: (entityType: string, entityId: number, documentId: number, options?: any) => Promise<RequestArgs>; /** * Example Requests: clients/1/documents/1 loans/1/documents/1 client_identifiers/1/documents/1?fields=name,description * @summary Retrieve a Document * @param {string} entityType entityType * @param {number} entityId entityId * @param {number} documentId documentId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDocument: (entityType: string, entityId: number, documentId: number, options?: any) => Promise<RequestArgs>; /** * Example Requests: clients/1/documents client_identifiers/1/documents loans/1/documents?fields=name,description * @summary List documents * @param {string} entityType entityType * @param {number} entityId entityId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAllDocuments: (entityType: string, entityId: number, options?: any) => Promise<RequestArgs>; /** * Note: A document is updated using a Multi-part form upload Body Parts name Name or summary of the document description Description of the document file The file to be uploaded * @summary Update a Document * @param {string} entityType entityType * @param {number} entityId entityId * @param {number} documentId documentId * @param {number} [contentLength] Content-Length * @param {FormDataBodyPart} [file] * @param {string} [name] name * @param {string} [description] description * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateDocument: (entityType: string, entityId: number, documentId: number, contentLength?: number, file?: any, name?: string, description?: string, options?: any) => Promise<RequestArgs>; }; /** * DocumentsApi - functional programming interface * @export */ export declare const DocumentsApiFp: (configuration?: Configuration) => { /** * Note: A document is created using a Multi-part form upload Body Parts name : Name or summary of the document description : Description of the document file : The file to be uploaded Mandatory Fields : file and description * @summary Create a Document * @param {string} entityType entityType * @param {number} entityId entityId * @param {number} [contentLength] Content-Length * @param {FormDataBodyPart} [file] * @param {string} [name] name * @param {string} [description] description * @param {*} [options] Override http request option. * @throws {RequiredError} */ createDocument(entityType: string, entityId: number, contentLength?: number, file?: any, name?: string, description?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostEntityTypeEntityIdDocumentsResponse>>; /** * * @summary Remove a Document * @param {string} entityType entityType * @param {number} entityId entityId * @param {number} documentId documentId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteDocument(entityType: string, entityId: number, documentId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteEntityTypeEntityIdDocumentsResponse>>; /** * Request used to download the file associated with the document Example Requests: clients/1/documents/1/attachment loans/1/documents/1/attachment * @summary Retrieve Binary File associated with Document * @param {string} entityType entityType * @param {number} entityId entityId * @param {number} documentId documentId * @param {*} [options] Override http request option. * @throws {RequiredError} */ downloadFile(entityType: string, entityId: number, documentId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>; /** * Example Requests: clients/1/documents/1 loans/1/documents/1 client_identifiers/1/documents/1?fields=name,description * @summary Retrieve a Document * @param {string} entityType entityType * @param {number} entityId entityId * @param {number} documentId documentId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDocument(entityType: string, entityId: number, documentId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEntityTypeEntityIdDocumentsResponse>>; /** * Example Requests: clients/1/documents client_identifiers/1/documents loans/1/documents?fields=name,description * @summary List documents * @param {string} entityType entityType * @param {number} entityId entityId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAllDocuments(entityType: string, entityId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GetEntityTypeEntityIdDocumentsResponse>>>; /** * Note: A document is updated using a Multi-part form upload Body Parts name Name or summary of the document description Description of the document file The file to be uploaded * @summary Update a Document * @param {string} entityType entityType * @param {number} entityId entityId * @param {number} documentId documentId * @param {number} [contentLength] Content-Length * @param {FormDataBodyPart} [file] * @param {string} [name] name * @param {string} [description] description * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateDocument(entityType: string, entityId: number, documentId: number, contentLength?: number, file?: any, name?: string, description?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutEntityTypeEntityIdDocumentsResponse>>; }; /** * DocumentsApi - factory interface * @export */ export declare const DocumentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Note: A document is created using a Multi-part form upload Body Parts name : Name or summary of the document description : Description of the document file : The file to be uploaded Mandatory Fields : file and description * @summary Create a Document * @param {string} entityType entityType * @param {number} entityId entityId * @param {number} [contentLength] Content-Length * @param {FormDataBodyPart} [file] * @param {string} [name] name * @param {string} [description] description * @param {*} [options] Override http request option. * @throws {RequiredError} */ createDocument(entityType: string, entityId: number, contentLength?: number, file?: any, name?: string, description?: string, options?: any): AxiosPromise<PostEntityTypeEntityIdDocumentsResponse>; /** * * @summary Remove a Document * @param {string} entityType entityType * @param {number} entityId entityId * @param {number} documentId documentId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteDocument(entityType: string, entityId: number, documentId: number, options?: any): AxiosPromise<DeleteEntityTypeEntityIdDocumentsResponse>; /** * Request used to download the file associated with the document Example Requests: clients/1/documents/1/attachment loans/1/documents/1/attachment * @summary Retrieve Binary File associated with Document * @param {string} entityType entityType * @param {number} entityId entityId * @param {number} documentId documentId * @param {*} [options] Override http request option. * @throws {RequiredError} */ downloadFile(entityType: string, entityId: number, documentId: number, options?: any): AxiosPromise<void>; /** * Example Requests: clients/1/documents/1 loans/1/documents/1 client_identifiers/1/documents/1?fields=name,description * @summary Retrieve a Document * @param {string} entityType entityType * @param {number} entityId entityId * @param {number} documentId documentId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDocument(entityType: string, entityId: number, documentId: number, options?: any): AxiosPromise<GetEntityTypeEntityIdDocumentsResponse>; /** * Example Requests: clients/1/documents client_identifiers/1/documents loans/1/documents?fields=name,description * @summary List documents * @param {string} entityType entityType * @param {number} entityId entityId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAllDocuments(entityType: string, entityId: number, options?: any): AxiosPromise<Array<GetEntityTypeEntityIdDocumentsResponse>>; /** * Note: A document is updated using a Multi-part form upload Body Parts name Name or summary of the document description Description of the document file The file to be uploaded * @summary Update a Document * @param {string} entityType entityType * @param {number} entityId entityId * @param {number} documentId documentId * @param {number} [contentLength] Content-Length * @param {FormDataBodyPart} [file] * @param {string} [name] name * @param {string} [description] description * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateDocument(entityType: string, entityId: number, documentId: number, contentLength?: number, file?: any, name?: string, description?: string, options?: any): AxiosPromise<PutEntityTypeEntityIdDocumentsResponse>; }; /** * DocumentsApi - object-oriented interface * @export * @class DocumentsApi * @extends {BaseAPI} */ export declare class DocumentsApi extends BaseAPI { /** * Note: A document is created using a Multi-part form upload Body Parts name : Name or summary of the document description : Description of the document file : The file to be uploaded Mandatory Fields : file and description * @summary Create a Document * @param {string} entityType entityType * @param {number} entityId entityId * @param {number} [contentLength] Content-Length * @param {FormDataBodyPart} [file] * @param {string} [name] name * @param {string} [description] description * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DocumentsApi */ createDocument(entityType: string, entityId: number, contentLength?: number, file?: FormDataBodyPart, name?: string, description?: string, options?: any): Promise<import("axios").AxiosResponse<PostEntityTypeEntityIdDocumentsResponse>>; /** * * @summary Remove a Document * @param {string} entityType entityType * @param {number} entityId entityId * @param {number} documentId documentId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DocumentsApi */ deleteDocument(entityType: string, entityId: number, documentId: number, options?: any): Promise<import("axios").AxiosResponse<DeleteEntityTypeEntityIdDocumentsResponse>>; /** * Request used to download the file associated with the document Example Requests: clients/1/documents/1/attachment loans/1/documents/1/attachment * @summary Retrieve Binary File associated with Document * @param {string} entityType entityType * @param {number} entityId entityId * @param {number} documentId documentId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DocumentsApi */ downloadFile(entityType: string, entityId: number, documentId: number, options?: any): Promise<import("axios").AxiosResponse<void>>; /** * Example Requests: clients/1/documents/1 loans/1/documents/1 client_identifiers/1/documents/1?fields=name,description * @summary Retrieve a Document * @param {string} entityType entityType * @param {number} entityId entityId * @param {number} documentId documentId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DocumentsApi */ getDocument(entityType: string, entityId: number, documentId: number, options?: any): Promise<import("axios").AxiosResponse<GetEntityTypeEntityIdDocumentsResponse>>; /** * Example Requests: clients/1/documents client_identifiers/1/documents loans/1/documents?fields=name,description * @summary List documents * @param {string} entityType entityType * @param {number} entityId entityId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DocumentsApi */ retrieveAllDocuments(entityType: string, entityId: number, options?: any): Promise<import("axios").AxiosResponse<GetEntityTypeEntityIdDocumentsResponse[]>>; /** * Note: A document is updated using a Multi-part form upload Body Parts name Name or summary of the document description Description of the document file The file to be uploaded * @summary Update a Document * @param {string} entityType entityType * @param {number} entityId entityId * @param {number} documentId documentId * @param {number} [contentLength] Content-Length * @param {FormDataBodyPart} [file] * @param {string} [name] name * @param {string} [description] description * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DocumentsApi */ updateDocument(entityType: string, entityId: number, documentId: number, contentLength?: number, file?: FormDataBodyPart, name?: string, description?: string, options?: any): Promise<import("axios").AxiosResponse<PutEntityTypeEntityIdDocumentsResponse>>; }