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 { GetMakerCheckerResponse } from '../models'; import { GetMakerCheckersSearchTemplateResponse } from '../models'; /** * AuditsApi - axios parameter creator * @export */ export declare const AuditsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Get a 200 list of audits that match the criteria supplied and sorted by audit id in descending order, and are within the requestors\' data scope. Also it supports pagination and sorting Example Requests: audits audits?fields=madeOnDate,maker,processingResult audits?makerDateTimeFrom=2013-03-25 08:00:00&makerDateTimeTo=2013-04-04 18:00:00 audits?officeId=1 audits?officeId=1&includeJson=true * @summary List Audits * @param {string} [actionName] actionName * @param {string} [entityName] entityName * @param {number} [resourceId] resourceId * @param {number} [makerId] makerId * @param {string} [makerDateTimeFrom] makerDateTimeFrom * @param {string} [makerDateTimeTo] makerDateTimeTo * @param {number} [checkerId] checkerId * @param {string} [checkerDateTimeFrom] checkerDateTimeFrom * @param {string} [checkerDateTimeTo] checkerDateTimeTo * @param {number} [processingResult] processingResult * @param {number} [officeId] officeId * @param {number} [groupId] groupId * @param {number} [clientId] clientId * @param {number} [loanid] loanid * @param {number} [savingsAccountId] savingsAccountId * @param {boolean} [paged] paged * @param {number} [offset] offset * @param {number} [limit] limit * @param {string} [orderBy] orderBy * @param {string} [sortOrder] sortOrder * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAuditEntries: (actionName?: string, entityName?: string, resourceId?: number, makerId?: number, makerDateTimeFrom?: string, makerDateTimeTo?: string, checkerId?: number, checkerDateTimeFrom?: string, checkerDateTimeTo?: string, processingResult?: number, officeId?: number, groupId?: number, clientId?: number, loanid?: number, savingsAccountId?: number, paged?: boolean, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, options?: any) => Promise<RequestArgs>; /** * Example Requests: audits/20 audits/20?fields=madeOnDate,maker,processingResult * @summary Retrieve an Audit Entry * @param {number} auditId auditId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAuditEntry: (auditId: number, options?: any) => Promise<RequestArgs>; /** * This is a convenience resource. It can be useful when building an Audit Search UI. \"appUsers\" are data scoped to the office/branch the requestor is associated with. Example Requests: audits/searchtemplate audits/searchtemplate?fields=actionNames * @summary Audit Search Template * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAuditSearchTemplate: (options?: any) => Promise<RequestArgs>; }; /** * AuditsApi - functional programming interface * @export */ export declare const AuditsApiFp: (configuration?: Configuration) => { /** * Get a 200 list of audits that match the criteria supplied and sorted by audit id in descending order, and are within the requestors\' data scope. Also it supports pagination and sorting Example Requests: audits audits?fields=madeOnDate,maker,processingResult audits?makerDateTimeFrom=2013-03-25 08:00:00&makerDateTimeTo=2013-04-04 18:00:00 audits?officeId=1 audits?officeId=1&includeJson=true * @summary List Audits * @param {string} [actionName] actionName * @param {string} [entityName] entityName * @param {number} [resourceId] resourceId * @param {number} [makerId] makerId * @param {string} [makerDateTimeFrom] makerDateTimeFrom * @param {string} [makerDateTimeTo] makerDateTimeTo * @param {number} [checkerId] checkerId * @param {string} [checkerDateTimeFrom] checkerDateTimeFrom * @param {string} [checkerDateTimeTo] checkerDateTimeTo * @param {number} [processingResult] processingResult * @param {number} [officeId] officeId * @param {number} [groupId] groupId * @param {number} [clientId] clientId * @param {number} [loanid] loanid * @param {number} [savingsAccountId] savingsAccountId * @param {boolean} [paged] paged * @param {number} [offset] offset * @param {number} [limit] limit * @param {string} [orderBy] orderBy * @param {string} [sortOrder] sortOrder * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAuditEntries(actionName?: string, entityName?: string, resourceId?: number, makerId?: number, makerDateTimeFrom?: string, makerDateTimeTo?: string, checkerId?: number, checkerDateTimeFrom?: string, checkerDateTimeTo?: string, processingResult?: number, officeId?: number, groupId?: number, clientId?: number, loanid?: number, savingsAccountId?: number, paged?: boolean, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GetMakerCheckerResponse>>>; /** * Example Requests: audits/20 audits/20?fields=madeOnDate,maker,processingResult * @summary Retrieve an Audit Entry * @param {number} auditId auditId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAuditEntry(auditId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMakerCheckerResponse>>; /** * This is a convenience resource. It can be useful when building an Audit Search UI. \"appUsers\" are data scoped to the office/branch the requestor is associated with. Example Requests: audits/searchtemplate audits/searchtemplate?fields=actionNames * @summary Audit Search Template * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAuditSearchTemplate(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMakerCheckersSearchTemplateResponse>>; }; /** * AuditsApi - factory interface * @export */ export declare const AuditsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Get a 200 list of audits that match the criteria supplied and sorted by audit id in descending order, and are within the requestors\' data scope. Also it supports pagination and sorting Example Requests: audits audits?fields=madeOnDate,maker,processingResult audits?makerDateTimeFrom=2013-03-25 08:00:00&makerDateTimeTo=2013-04-04 18:00:00 audits?officeId=1 audits?officeId=1&includeJson=true * @summary List Audits * @param {string} [actionName] actionName * @param {string} [entityName] entityName * @param {number} [resourceId] resourceId * @param {number} [makerId] makerId * @param {string} [makerDateTimeFrom] makerDateTimeFrom * @param {string} [makerDateTimeTo] makerDateTimeTo * @param {number} [checkerId] checkerId * @param {string} [checkerDateTimeFrom] checkerDateTimeFrom * @param {string} [checkerDateTimeTo] checkerDateTimeTo * @param {number} [processingResult] processingResult * @param {number} [officeId] officeId * @param {number} [groupId] groupId * @param {number} [clientId] clientId * @param {number} [loanid] loanid * @param {number} [savingsAccountId] savingsAccountId * @param {boolean} [paged] paged * @param {number} [offset] offset * @param {number} [limit] limit * @param {string} [orderBy] orderBy * @param {string} [sortOrder] sortOrder * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAuditEntries(actionName?: string, entityName?: string, resourceId?: number, makerId?: number, makerDateTimeFrom?: string, makerDateTimeTo?: string, checkerId?: number, checkerDateTimeFrom?: string, checkerDateTimeTo?: string, processingResult?: number, officeId?: number, groupId?: number, clientId?: number, loanid?: number, savingsAccountId?: number, paged?: boolean, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, options?: any): AxiosPromise<Array<GetMakerCheckerResponse>>; /** * Example Requests: audits/20 audits/20?fields=madeOnDate,maker,processingResult * @summary Retrieve an Audit Entry * @param {number} auditId auditId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAuditEntry(auditId: number, options?: any): AxiosPromise<GetMakerCheckerResponse>; /** * This is a convenience resource. It can be useful when building an Audit Search UI. \"appUsers\" are data scoped to the office/branch the requestor is associated with. Example Requests: audits/searchtemplate audits/searchtemplate?fields=actionNames * @summary Audit Search Template * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAuditSearchTemplate(options?: any): AxiosPromise<GetMakerCheckersSearchTemplateResponse>; }; /** * AuditsApi - object-oriented interface * @export * @class AuditsApi * @extends {BaseAPI} */ export declare class AuditsApi extends BaseAPI { /** * Get a 200 list of audits that match the criteria supplied and sorted by audit id in descending order, and are within the requestors\' data scope. Also it supports pagination and sorting Example Requests: audits audits?fields=madeOnDate,maker,processingResult audits?makerDateTimeFrom=2013-03-25 08:00:00&makerDateTimeTo=2013-04-04 18:00:00 audits?officeId=1 audits?officeId=1&includeJson=true * @summary List Audits * @param {string} [actionName] actionName * @param {string} [entityName] entityName * @param {number} [resourceId] resourceId * @param {number} [makerId] makerId * @param {string} [makerDateTimeFrom] makerDateTimeFrom * @param {string} [makerDateTimeTo] makerDateTimeTo * @param {number} [checkerId] checkerId * @param {string} [checkerDateTimeFrom] checkerDateTimeFrom * @param {string} [checkerDateTimeTo] checkerDateTimeTo * @param {number} [processingResult] processingResult * @param {number} [officeId] officeId * @param {number} [groupId] groupId * @param {number} [clientId] clientId * @param {number} [loanid] loanid * @param {number} [savingsAccountId] savingsAccountId * @param {boolean} [paged] paged * @param {number} [offset] offset * @param {number} [limit] limit * @param {string} [orderBy] orderBy * @param {string} [sortOrder] sortOrder * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuditsApi */ retrieveAuditEntries(actionName?: string, entityName?: string, resourceId?: number, makerId?: number, makerDateTimeFrom?: string, makerDateTimeTo?: string, checkerId?: number, checkerDateTimeFrom?: string, checkerDateTimeTo?: string, processingResult?: number, officeId?: number, groupId?: number, clientId?: number, loanid?: number, savingsAccountId?: number, paged?: boolean, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, options?: any): Promise<import("axios").AxiosResponse<GetMakerCheckerResponse[]>>; /** * Example Requests: audits/20 audits/20?fields=madeOnDate,maker,processingResult * @summary Retrieve an Audit Entry * @param {number} auditId auditId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuditsApi */ retrieveAuditEntry(auditId: number, options?: any): Promise<import("axios").AxiosResponse<GetMakerCheckerResponse>>; /** * This is a convenience resource. It can be useful when building an Audit Search UI. \"appUsers\" are data scoped to the office/branch the requestor is associated with. Example Requests: audits/searchtemplate audits/searchtemplate?fields=actionNames * @summary Audit Search Template * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuditsApi */ retrieveAuditSearchTemplate(options?: any): Promise<import("axios").AxiosResponse<GetMakerCheckersSearchTemplateResponse>>; }