fineract_sdk
Version:
Wrapper around fineract api.
147 lines (146 loc) • 9.74 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 { GetSearchResponse } from '../models';
import { PostAdhocQuerySearchRequest } from '../models';
import { PostAdhocQuerySearchResponse } from '../models';
/**
* SearchAPIApi - axios parameter creator
* @export
*/
export declare const SearchAPIApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* AdHocQuery search has more search options, it is a POST request, it uses request body to send search parameters Mandatory fields:entities Optional fields:loanStatus, loanProducts, offices, loanDateOption, loanFromDate, loanToDate, includeOutStandingAmountPercentage, outStandingAmountPercentageCondition, minOutStandingAmountPercentage and maxOutStandingAmountPercentage OR outStandingAmountPercentage, includeOutstandingAmount, outstandingAmountCondition, minOutstandingAmount and maxOutstandingAmount OR outstandingAmount
* @summary Adhoc query search
* @param {PostAdhocQuerySearchRequest} postAdhocQuerySearchRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
advancedSearch: (postAdhocQuerySearchRequest: PostAdhocQuerySearchRequest, options?: any) => Promise<RequestArgs>;
/**
* Mandatory Fields search?query=000000001
* @summary Retrive Adhoc Search query template
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveAdHocSearchQueryTemplate: (options?: any) => Promise<RequestArgs>;
/**
* Example Requests: search?query=000000001 search?query=Petra&resource=clients,groups search?query=Petra&resource=clients,groups&exactMatch=true
* @summary Search Resources
* @param {string} [query] query
* @param {string} [resource] resource
* @param {boolean} [exactMatch] exactMatch
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
searchData: (query?: string, resource?: string, exactMatch?: boolean, options?: any) => Promise<RequestArgs>;
};
/**
* SearchAPIApi - functional programming interface
* @export
*/
export declare const SearchAPIApiFp: (configuration?: Configuration) => {
/**
* AdHocQuery search has more search options, it is a POST request, it uses request body to send search parameters Mandatory fields:entities Optional fields:loanStatus, loanProducts, offices, loanDateOption, loanFromDate, loanToDate, includeOutStandingAmountPercentage, outStandingAmountPercentageCondition, minOutStandingAmountPercentage and maxOutStandingAmountPercentage OR outStandingAmountPercentage, includeOutstandingAmount, outstandingAmountCondition, minOutstandingAmount and maxOutstandingAmount OR outstandingAmount
* @summary Adhoc query search
* @param {PostAdhocQuerySearchRequest} postAdhocQuerySearchRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
advancedSearch(postAdhocQuerySearchRequest: PostAdhocQuerySearchRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostAdhocQuerySearchResponse>>;
/**
* Mandatory Fields search?query=000000001
* @summary Retrive Adhoc Search query template
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveAdHocSearchQueryTemplate(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSearchResponse>>;
/**
* Example Requests: search?query=000000001 search?query=Petra&resource=clients,groups search?query=Petra&resource=clients,groups&exactMatch=true
* @summary Search Resources
* @param {string} [query] query
* @param {string} [resource] resource
* @param {boolean} [exactMatch] exactMatch
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
searchData(query?: string, resource?: string, exactMatch?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSearchResponse>>;
};
/**
* SearchAPIApi - factory interface
* @export
*/
export declare const SearchAPIApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* AdHocQuery search has more search options, it is a POST request, it uses request body to send search parameters Mandatory fields:entities Optional fields:loanStatus, loanProducts, offices, loanDateOption, loanFromDate, loanToDate, includeOutStandingAmountPercentage, outStandingAmountPercentageCondition, minOutStandingAmountPercentage and maxOutStandingAmountPercentage OR outStandingAmountPercentage, includeOutstandingAmount, outstandingAmountCondition, minOutstandingAmount and maxOutstandingAmount OR outstandingAmount
* @summary Adhoc query search
* @param {PostAdhocQuerySearchRequest} postAdhocQuerySearchRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
advancedSearch(postAdhocQuerySearchRequest: PostAdhocQuerySearchRequest, options?: any): AxiosPromise<PostAdhocQuerySearchResponse>;
/**
* Mandatory Fields search?query=000000001
* @summary Retrive Adhoc Search query template
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveAdHocSearchQueryTemplate(options?: any): AxiosPromise<GetSearchResponse>;
/**
* Example Requests: search?query=000000001 search?query=Petra&resource=clients,groups search?query=Petra&resource=clients,groups&exactMatch=true
* @summary Search Resources
* @param {string} [query] query
* @param {string} [resource] resource
* @param {boolean} [exactMatch] exactMatch
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
searchData(query?: string, resource?: string, exactMatch?: boolean, options?: any): AxiosPromise<GetSearchResponse>;
};
/**
* SearchAPIApi - object-oriented interface
* @export
* @class SearchAPIApi
* @extends {BaseAPI}
*/
export declare class SearchAPIApi extends BaseAPI {
/**
* AdHocQuery search has more search options, it is a POST request, it uses request body to send search parameters Mandatory fields:entities Optional fields:loanStatus, loanProducts, offices, loanDateOption, loanFromDate, loanToDate, includeOutStandingAmountPercentage, outStandingAmountPercentageCondition, minOutStandingAmountPercentage and maxOutStandingAmountPercentage OR outStandingAmountPercentage, includeOutstandingAmount, outstandingAmountCondition, minOutstandingAmount and maxOutstandingAmount OR outstandingAmount
* @summary Adhoc query search
* @param {PostAdhocQuerySearchRequest} postAdhocQuerySearchRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SearchAPIApi
*/
advancedSearch(postAdhocQuerySearchRequest: PostAdhocQuerySearchRequest, options?: any): Promise<import("axios").AxiosResponse<PostAdhocQuerySearchResponse>>;
/**
* Mandatory Fields search?query=000000001
* @summary Retrive Adhoc Search query template
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SearchAPIApi
*/
retrieveAdHocSearchQueryTemplate(options?: any): Promise<import("axios").AxiosResponse<GetSearchResponse>>;
/**
* Example Requests: search?query=000000001 search?query=Petra&resource=clients,groups search?query=Petra&resource=clients,groups&exactMatch=true
* @summary Search Resources
* @param {string} [query] query
* @param {string} [resource] resource
* @param {boolean} [exactMatch] exactMatch
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SearchAPIApi
*/
searchData(query?: string, resource?: string, exactMatch?: boolean, options?: any): Promise<import("axios").AxiosResponse<GetSearchResponse>>;
}