fineract_sdk
Version:
Wrapper around fineract api.
216 lines (215 loc) • 13.9 kB
TypeScript
/**
* 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';
import { PostMakerCheckersResponse } from '../models';
/**
* MakerCheckerOr4EyeFunctionalityApi - axios parameter creator
* @export
*/
export declare const MakerCheckerOr4EyeFunctionalityApiAxiosParamCreator: (configuration?: Configuration) => {
/**
*
* @summary Approve Maker Checker Entry | Reject Maker Checker Entry
* @param {number} auditId auditId
* @param {string} [command] command
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
approveMakerCheckerEntry: (auditId: number, command?: string, options?: any) => Promise<RequestArgs>;
/**
*
* @summary Delete Maker Checker Entry
* @param {number} auditId auditId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteMakerCheckerEntry: (auditId: number, options?: any) => Promise<RequestArgs>;
/**
* This is a convenience resource. It can be useful when building a Checker Inbox UI. \"appUsers\" are data scoped to the office/branch the requestor is associated with. \"actionNames\" and \"entityNames\" returned are those that the requestor has Checker approval permissions for. Example Requests: makercheckers/searchtemplate makercheckers/searchtemplate?fields=entityNames
* @summary Maker Checker Search Template
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveAuditSearchTemplate1: (options?: any) => Promise<RequestArgs>;
/**
* Get a list of entries that can be checked by the requestor that match the criteria supplied. Example Requests: makercheckers makercheckers?fields=madeOnDate,maker,processingResult makercheckers?makerDateTimeFrom=2013-03-25 08:00:00&makerDateTimeTo=2013-04-04 18:00:00 makercheckers?officeId=1 makercheckers?officeId=1&includeJson=true
* @summary List Maker Checker Entries
* @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} [officeId] officeId
* @param {number} [groupId] groupId
* @param {number} [clientId] clientId
* @param {number} [loanid] loanid
* @param {number} [savingsAccountId] savingsAccountId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveCommands: (actionName?: string, entityName?: string, resourceId?: number, makerId?: number, makerDateTimeFrom?: string, makerDateTimeTo?: string, officeId?: number, groupId?: number, clientId?: number, loanid?: number, savingsAccountId?: number, options?: any) => Promise<RequestArgs>;
};
/**
* MakerCheckerOr4EyeFunctionalityApi - functional programming interface
* @export
*/
export declare const MakerCheckerOr4EyeFunctionalityApiFp: (configuration?: Configuration) => {
/**
*
* @summary Approve Maker Checker Entry | Reject Maker Checker Entry
* @param {number} auditId auditId
* @param {string} [command] command
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
approveMakerCheckerEntry(auditId: number, command?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostMakerCheckersResponse>>;
/**
*
* @summary Delete Maker Checker Entry
* @param {number} auditId auditId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteMakerCheckerEntry(auditId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostMakerCheckersResponse>>;
/**
* This is a convenience resource. It can be useful when building a Checker Inbox UI. \"appUsers\" are data scoped to the office/branch the requestor is associated with. \"actionNames\" and \"entityNames\" returned are those that the requestor has Checker approval permissions for. Example Requests: makercheckers/searchtemplate makercheckers/searchtemplate?fields=entityNames
* @summary Maker Checker Search Template
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveAuditSearchTemplate1(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMakerCheckersSearchTemplateResponse>>;
/**
* Get a list of entries that can be checked by the requestor that match the criteria supplied. Example Requests: makercheckers makercheckers?fields=madeOnDate,maker,processingResult makercheckers?makerDateTimeFrom=2013-03-25 08:00:00&makerDateTimeTo=2013-04-04 18:00:00 makercheckers?officeId=1 makercheckers?officeId=1&includeJson=true
* @summary List Maker Checker Entries
* @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} [officeId] officeId
* @param {number} [groupId] groupId
* @param {number} [clientId] clientId
* @param {number} [loanid] loanid
* @param {number} [savingsAccountId] savingsAccountId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveCommands(actionName?: string, entityName?: string, resourceId?: number, makerId?: number, makerDateTimeFrom?: string, makerDateTimeTo?: string, officeId?: number, groupId?: number, clientId?: number, loanid?: number, savingsAccountId?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GetMakerCheckerResponse>>>;
};
/**
* MakerCheckerOr4EyeFunctionalityApi - factory interface
* @export
*/
export declare const MakerCheckerOr4EyeFunctionalityApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
*
* @summary Approve Maker Checker Entry | Reject Maker Checker Entry
* @param {number} auditId auditId
* @param {string} [command] command
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
approveMakerCheckerEntry(auditId: number, command?: string, options?: any): AxiosPromise<PostMakerCheckersResponse>;
/**
*
* @summary Delete Maker Checker Entry
* @param {number} auditId auditId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteMakerCheckerEntry(auditId: number, options?: any): AxiosPromise<PostMakerCheckersResponse>;
/**
* This is a convenience resource. It can be useful when building a Checker Inbox UI. \"appUsers\" are data scoped to the office/branch the requestor is associated with. \"actionNames\" and \"entityNames\" returned are those that the requestor has Checker approval permissions for. Example Requests: makercheckers/searchtemplate makercheckers/searchtemplate?fields=entityNames
* @summary Maker Checker Search Template
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveAuditSearchTemplate1(options?: any): AxiosPromise<GetMakerCheckersSearchTemplateResponse>;
/**
* Get a list of entries that can be checked by the requestor that match the criteria supplied. Example Requests: makercheckers makercheckers?fields=madeOnDate,maker,processingResult makercheckers?makerDateTimeFrom=2013-03-25 08:00:00&makerDateTimeTo=2013-04-04 18:00:00 makercheckers?officeId=1 makercheckers?officeId=1&includeJson=true
* @summary List Maker Checker Entries
* @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} [officeId] officeId
* @param {number} [groupId] groupId
* @param {number} [clientId] clientId
* @param {number} [loanid] loanid
* @param {number} [savingsAccountId] savingsAccountId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveCommands(actionName?: string, entityName?: string, resourceId?: number, makerId?: number, makerDateTimeFrom?: string, makerDateTimeTo?: string, officeId?: number, groupId?: number, clientId?: number, loanid?: number, savingsAccountId?: number, options?: any): AxiosPromise<Array<GetMakerCheckerResponse>>;
};
/**
* MakerCheckerOr4EyeFunctionalityApi - object-oriented interface
* @export
* @class MakerCheckerOr4EyeFunctionalityApi
* @extends {BaseAPI}
*/
export declare class MakerCheckerOr4EyeFunctionalityApi extends BaseAPI {
/**
*
* @summary Approve Maker Checker Entry | Reject Maker Checker Entry
* @param {number} auditId auditId
* @param {string} [command] command
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof MakerCheckerOr4EyeFunctionalityApi
*/
approveMakerCheckerEntry(auditId: number, command?: string, options?: any): Promise<import("axios").AxiosResponse<PostMakerCheckersResponse>>;
/**
*
* @summary Delete Maker Checker Entry
* @param {number} auditId auditId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof MakerCheckerOr4EyeFunctionalityApi
*/
deleteMakerCheckerEntry(auditId: number, options?: any): Promise<import("axios").AxiosResponse<PostMakerCheckersResponse>>;
/**
* This is a convenience resource. It can be useful when building a Checker Inbox UI. \"appUsers\" are data scoped to the office/branch the requestor is associated with. \"actionNames\" and \"entityNames\" returned are those that the requestor has Checker approval permissions for. Example Requests: makercheckers/searchtemplate makercheckers/searchtemplate?fields=entityNames
* @summary Maker Checker Search Template
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof MakerCheckerOr4EyeFunctionalityApi
*/
retrieveAuditSearchTemplate1(options?: any): Promise<import("axios").AxiosResponse<GetMakerCheckersSearchTemplateResponse>>;
/**
* Get a list of entries that can be checked by the requestor that match the criteria supplied. Example Requests: makercheckers makercheckers?fields=madeOnDate,maker,processingResult makercheckers?makerDateTimeFrom=2013-03-25 08:00:00&makerDateTimeTo=2013-04-04 18:00:00 makercheckers?officeId=1 makercheckers?officeId=1&includeJson=true
* @summary List Maker Checker Entries
* @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} [officeId] officeId
* @param {number} [groupId] groupId
* @param {number} [clientId] clientId
* @param {number} [loanid] loanid
* @param {number} [savingsAccountId] savingsAccountId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof MakerCheckerOr4EyeFunctionalityApi
*/
retrieveCommands(actionName?: string, entityName?: string, resourceId?: number, makerId?: number, makerDateTimeFrom?: string, makerDateTimeTo?: string, officeId?: number, groupId?: number, clientId?: number, loanid?: number, savingsAccountId?: number, options?: any): Promise<import("axios").AxiosResponse<GetMakerCheckerResponse[]>>;
}