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 { DeleteResourceTypeResourceIdNotesNoteIdResponse } from '../models'; import { GetResourceTypeResourceIdNotesNoteIdResponse } from '../models'; import { GetResourceTypeResourceIdNotesResponse } from '../models'; import { PostResourceTypeResourceIdNotesRequest } from '../models'; import { PostResourceTypeResourceIdNotesResponse } from '../models'; import { PutResourceTypeResourceIdNotesNoteIdRequest } from '../models'; import { PutResourceTypeResourceIdNotesNoteIdResponse } from '../models'; /** * NotesApi - axios parameter creator * @export */ export declare const NotesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Adds a new note to a supported resource. Example Requests: clients/1/notes groups/1/notes * @summary Add a Resource Note * @param {string} resourceType resourceType * @param {number} resourceId resourceId * @param {PostResourceTypeResourceIdNotesRequest} postResourceTypeResourceIdNotesRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ addNewNote: (resourceType: string, resourceId: number, postResourceTypeResourceIdNotesRequest: PostResourceTypeResourceIdNotesRequest, options?: any) => Promise<RequestArgs>; /** * Deletes a Resource Note * @summary Delete a Resource Note * @param {string} resourceType resourceType * @param {number} resourceId resourceId * @param {number} noteId noteId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteNote: (resourceType: string, resourceId: number, noteId: number, options?: any) => Promise<RequestArgs>; /** * Retrieves a Resource Note Example Requests: clients/1/notes/76 groups/1/notes/20 clients/1/notes/76?fields=note,createdOn,createdByUsername groups/1/notes/20?fields=note,createdOn,createdByUsername * @summary Retrieve a Resource Note * @param {string} resourceType resourceType * @param {number} resourceId resourceId * @param {number} noteId noteId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveNote: (resourceType: string, resourceId: number, noteId: number, options?: any) => Promise<RequestArgs>; /** * Retrieves a Resource\'s Notes Note: Notes are returned in descending createOn order. Example Requests: clients/2/notes groups/2/notes?fields=note,createdOn,createdByUsername * @summary Retrieve a Resource\'s description * @param {string} resourceType resourceType * @param {number} resourceId resourceId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveNotesByResource: (resourceType: string, resourceId: number, options?: any) => Promise<RequestArgs>; /** * Updates a Resource Note * @summary Update a Resource Note * @param {string} resourceType resourceType * @param {number} resourceId resourceId * @param {number} noteId noteId * @param {PutResourceTypeResourceIdNotesNoteIdRequest} putResourceTypeResourceIdNotesNoteIdRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateNote: (resourceType: string, resourceId: number, noteId: number, putResourceTypeResourceIdNotesNoteIdRequest: PutResourceTypeResourceIdNotesNoteIdRequest, options?: any) => Promise<RequestArgs>; }; /** * NotesApi - functional programming interface * @export */ export declare const NotesApiFp: (configuration?: Configuration) => { /** * Adds a new note to a supported resource. Example Requests: clients/1/notes groups/1/notes * @summary Add a Resource Note * @param {string} resourceType resourceType * @param {number} resourceId resourceId * @param {PostResourceTypeResourceIdNotesRequest} postResourceTypeResourceIdNotesRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ addNewNote(resourceType: string, resourceId: number, postResourceTypeResourceIdNotesRequest: PostResourceTypeResourceIdNotesRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostResourceTypeResourceIdNotesResponse>>; /** * Deletes a Resource Note * @summary Delete a Resource Note * @param {string} resourceType resourceType * @param {number} resourceId resourceId * @param {number} noteId noteId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteNote(resourceType: string, resourceId: number, noteId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResourceTypeResourceIdNotesNoteIdResponse>>; /** * Retrieves a Resource Note Example Requests: clients/1/notes/76 groups/1/notes/20 clients/1/notes/76?fields=note,createdOn,createdByUsername groups/1/notes/20?fields=note,createdOn,createdByUsername * @summary Retrieve a Resource Note * @param {string} resourceType resourceType * @param {number} resourceId resourceId * @param {number} noteId noteId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveNote(resourceType: string, resourceId: number, noteId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetResourceTypeResourceIdNotesNoteIdResponse>>; /** * Retrieves a Resource\'s Notes Note: Notes are returned in descending createOn order. Example Requests: clients/2/notes groups/2/notes?fields=note,createdOn,createdByUsername * @summary Retrieve a Resource\'s description * @param {string} resourceType resourceType * @param {number} resourceId resourceId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveNotesByResource(resourceType: string, resourceId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GetResourceTypeResourceIdNotesResponse>>>; /** * Updates a Resource Note * @summary Update a Resource Note * @param {string} resourceType resourceType * @param {number} resourceId resourceId * @param {number} noteId noteId * @param {PutResourceTypeResourceIdNotesNoteIdRequest} putResourceTypeResourceIdNotesNoteIdRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateNote(resourceType: string, resourceId: number, noteId: number, putResourceTypeResourceIdNotesNoteIdRequest: PutResourceTypeResourceIdNotesNoteIdRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutResourceTypeResourceIdNotesNoteIdResponse>>; }; /** * NotesApi - factory interface * @export */ export declare const NotesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Adds a new note to a supported resource. Example Requests: clients/1/notes groups/1/notes * @summary Add a Resource Note * @param {string} resourceType resourceType * @param {number} resourceId resourceId * @param {PostResourceTypeResourceIdNotesRequest} postResourceTypeResourceIdNotesRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ addNewNote(resourceType: string, resourceId: number, postResourceTypeResourceIdNotesRequest: PostResourceTypeResourceIdNotesRequest, options?: any): AxiosPromise<PostResourceTypeResourceIdNotesResponse>; /** * Deletes a Resource Note * @summary Delete a Resource Note * @param {string} resourceType resourceType * @param {number} resourceId resourceId * @param {number} noteId noteId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteNote(resourceType: string, resourceId: number, noteId: number, options?: any): AxiosPromise<DeleteResourceTypeResourceIdNotesNoteIdResponse>; /** * Retrieves a Resource Note Example Requests: clients/1/notes/76 groups/1/notes/20 clients/1/notes/76?fields=note,createdOn,createdByUsername groups/1/notes/20?fields=note,createdOn,createdByUsername * @summary Retrieve a Resource Note * @param {string} resourceType resourceType * @param {number} resourceId resourceId * @param {number} noteId noteId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveNote(resourceType: string, resourceId: number, noteId: number, options?: any): AxiosPromise<GetResourceTypeResourceIdNotesNoteIdResponse>; /** * Retrieves a Resource\'s Notes Note: Notes are returned in descending createOn order. Example Requests: clients/2/notes groups/2/notes?fields=note,createdOn,createdByUsername * @summary Retrieve a Resource\'s description * @param {string} resourceType resourceType * @param {number} resourceId resourceId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveNotesByResource(resourceType: string, resourceId: number, options?: any): AxiosPromise<Array<GetResourceTypeResourceIdNotesResponse>>; /** * Updates a Resource Note * @summary Update a Resource Note * @param {string} resourceType resourceType * @param {number} resourceId resourceId * @param {number} noteId noteId * @param {PutResourceTypeResourceIdNotesNoteIdRequest} putResourceTypeResourceIdNotesNoteIdRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateNote(resourceType: string, resourceId: number, noteId: number, putResourceTypeResourceIdNotesNoteIdRequest: PutResourceTypeResourceIdNotesNoteIdRequest, options?: any): AxiosPromise<PutResourceTypeResourceIdNotesNoteIdResponse>; }; /** * NotesApi - object-oriented interface * @export * @class NotesApi * @extends {BaseAPI} */ export declare class NotesApi extends BaseAPI { /** * Adds a new note to a supported resource. Example Requests: clients/1/notes groups/1/notes * @summary Add a Resource Note * @param {string} resourceType resourceType * @param {number} resourceId resourceId * @param {PostResourceTypeResourceIdNotesRequest} postResourceTypeResourceIdNotesRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NotesApi */ addNewNote(resourceType: string, resourceId: number, postResourceTypeResourceIdNotesRequest: PostResourceTypeResourceIdNotesRequest, options?: any): Promise<import("axios").AxiosResponse<PostResourceTypeResourceIdNotesResponse>>; /** * Deletes a Resource Note * @summary Delete a Resource Note * @param {string} resourceType resourceType * @param {number} resourceId resourceId * @param {number} noteId noteId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NotesApi */ deleteNote(resourceType: string, resourceId: number, noteId: number, options?: any): Promise<import("axios").AxiosResponse<DeleteResourceTypeResourceIdNotesNoteIdResponse>>; /** * Retrieves a Resource Note Example Requests: clients/1/notes/76 groups/1/notes/20 clients/1/notes/76?fields=note,createdOn,createdByUsername groups/1/notes/20?fields=note,createdOn,createdByUsername * @summary Retrieve a Resource Note * @param {string} resourceType resourceType * @param {number} resourceId resourceId * @param {number} noteId noteId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NotesApi */ retrieveNote(resourceType: string, resourceId: number, noteId: number, options?: any): Promise<import("axios").AxiosResponse<GetResourceTypeResourceIdNotesNoteIdResponse>>; /** * Retrieves a Resource\'s Notes Note: Notes are returned in descending createOn order. Example Requests: clients/2/notes groups/2/notes?fields=note,createdOn,createdByUsername * @summary Retrieve a Resource\'s description * @param {string} resourceType resourceType * @param {number} resourceId resourceId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NotesApi */ retrieveNotesByResource(resourceType: string, resourceId: number, options?: any): Promise<import("axios").AxiosResponse<GetResourceTypeResourceIdNotesResponse[]>>; /** * Updates a Resource Note * @summary Update a Resource Note * @param {string} resourceType resourceType * @param {number} resourceId resourceId * @param {number} noteId noteId * @param {PutResourceTypeResourceIdNotesNoteIdRequest} putResourceTypeResourceIdNotesNoteIdRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NotesApi */ updateNote(resourceType: string, resourceId: number, noteId: number, putResourceTypeResourceIdNotesNoteIdRequest: PutResourceTypeResourceIdNotesNoteIdRequest, options?: any): Promise<import("axios").AxiosResponse<PutResourceTypeResourceIdNotesNoteIdResponse>>; }