UNPKG

fineract_sdk

Version:

Wrapper around fineract api.

238 lines (237 loc) 12.9 kB
/** * 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 { DeleteProvisioningCriteriaResponse } from '../models'; import { GetProvisioningCriteriaCriteriaIdResponse } from '../models'; import { GetProvisioningCriteriaResponse } from '../models'; import { PostProvisioningCriteriaRequest } from '../models'; import { PostProvisioningCriteriaResponse } from '../models'; import { PutProvisioningCriteriaRequest } from '../models'; import { PutProvisioningCriteriaResponse } from '../models'; /** * ProvisioningCriteriaApi - axios parameter creator * @export */ export declare const ProvisioningCriteriaApiAxiosParamCreator: (configuration?: Configuration) => { /** * Creates a new Provisioning Criteria Mandatory Fields: criteriaName provisioningcriteria Optional Fields: loanProducts * @summary Create a new Provisioning Criteria * @param {PostProvisioningCriteriaRequest} postProvisioningCriteriaRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ createProvisioningCriteria: (postProvisioningCriteriaRequest: PostProvisioningCriteriaRequest, options?: any) => Promise<RequestArgs>; /** * Deletes Provisioning Criteria * @summary Deletes Provisioning Criteria * @param {number} criteriaId criteriaId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteProvisioningCriteria: (criteriaId: number, options?: any) => Promise<RequestArgs>; /** * Retrieves all created Provisioning Criterias * @summary Retrieves all created Provisioning Criterias * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAllProvisioningCriterias: (options?: any) => Promise<RequestArgs>; /** * Retrieves a Provisioning Criteria * @summary Retrieves a Provisioning Criteria * @param {number} criteriaId criteriaId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveProvisioningCriteria: (criteriaId: number, options?: any) => Promise<RequestArgs>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveTemplate3: (options?: any) => Promise<RequestArgs>; /** * Updates a new Provisioning Criteria Optional Fields criteriaName, loanProducts, provisioningcriteria * @summary Updates a new Provisioning Criteria * @param {number} criteriaId criteriaId * @param {PutProvisioningCriteriaRequest} putProvisioningCriteriaRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateProvisioningCriteria: (criteriaId: number, putProvisioningCriteriaRequest: PutProvisioningCriteriaRequest, options?: any) => Promise<RequestArgs>; }; /** * ProvisioningCriteriaApi - functional programming interface * @export */ export declare const ProvisioningCriteriaApiFp: (configuration?: Configuration) => { /** * Creates a new Provisioning Criteria Mandatory Fields: criteriaName provisioningcriteria Optional Fields: loanProducts * @summary Create a new Provisioning Criteria * @param {PostProvisioningCriteriaRequest} postProvisioningCriteriaRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ createProvisioningCriteria(postProvisioningCriteriaRequest: PostProvisioningCriteriaRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostProvisioningCriteriaResponse>>; /** * Deletes Provisioning Criteria * @summary Deletes Provisioning Criteria * @param {number} criteriaId criteriaId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteProvisioningCriteria(criteriaId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteProvisioningCriteriaResponse>>; /** * Retrieves all created Provisioning Criterias * @summary Retrieves all created Provisioning Criterias * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAllProvisioningCriterias(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GetProvisioningCriteriaResponse>>>; /** * Retrieves a Provisioning Criteria * @summary Retrieves a Provisioning Criteria * @param {number} criteriaId criteriaId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveProvisioningCriteria(criteriaId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetProvisioningCriteriaCriteriaIdResponse>>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveTemplate3(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * Updates a new Provisioning Criteria Optional Fields criteriaName, loanProducts, provisioningcriteria * @summary Updates a new Provisioning Criteria * @param {number} criteriaId criteriaId * @param {PutProvisioningCriteriaRequest} putProvisioningCriteriaRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateProvisioningCriteria(criteriaId: number, putProvisioningCriteriaRequest: PutProvisioningCriteriaRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutProvisioningCriteriaResponse>>; }; /** * ProvisioningCriteriaApi - factory interface * @export */ export declare const ProvisioningCriteriaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Creates a new Provisioning Criteria Mandatory Fields: criteriaName provisioningcriteria Optional Fields: loanProducts * @summary Create a new Provisioning Criteria * @param {PostProvisioningCriteriaRequest} postProvisioningCriteriaRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ createProvisioningCriteria(postProvisioningCriteriaRequest: PostProvisioningCriteriaRequest, options?: any): AxiosPromise<PostProvisioningCriteriaResponse>; /** * Deletes Provisioning Criteria * @summary Deletes Provisioning Criteria * @param {number} criteriaId criteriaId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteProvisioningCriteria(criteriaId: number, options?: any): AxiosPromise<DeleteProvisioningCriteriaResponse>; /** * Retrieves all created Provisioning Criterias * @summary Retrieves all created Provisioning Criterias * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAllProvisioningCriterias(options?: any): AxiosPromise<Array<GetProvisioningCriteriaResponse>>; /** * Retrieves a Provisioning Criteria * @summary Retrieves a Provisioning Criteria * @param {number} criteriaId criteriaId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveProvisioningCriteria(criteriaId: number, options?: any): AxiosPromise<GetProvisioningCriteriaCriteriaIdResponse>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveTemplate3(options?: any): AxiosPromise<string>; /** * Updates a new Provisioning Criteria Optional Fields criteriaName, loanProducts, provisioningcriteria * @summary Updates a new Provisioning Criteria * @param {number} criteriaId criteriaId * @param {PutProvisioningCriteriaRequest} putProvisioningCriteriaRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateProvisioningCriteria(criteriaId: number, putProvisioningCriteriaRequest: PutProvisioningCriteriaRequest, options?: any): AxiosPromise<PutProvisioningCriteriaResponse>; }; /** * ProvisioningCriteriaApi - object-oriented interface * @export * @class ProvisioningCriteriaApi * @extends {BaseAPI} */ export declare class ProvisioningCriteriaApi extends BaseAPI { /** * Creates a new Provisioning Criteria Mandatory Fields: criteriaName provisioningcriteria Optional Fields: loanProducts * @summary Create a new Provisioning Criteria * @param {PostProvisioningCriteriaRequest} postProvisioningCriteriaRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProvisioningCriteriaApi */ createProvisioningCriteria(postProvisioningCriteriaRequest: PostProvisioningCriteriaRequest, options?: any): Promise<import("axios").AxiosResponse<PostProvisioningCriteriaResponse>>; /** * Deletes Provisioning Criteria * @summary Deletes Provisioning Criteria * @param {number} criteriaId criteriaId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProvisioningCriteriaApi */ deleteProvisioningCriteria(criteriaId: number, options?: any): Promise<import("axios").AxiosResponse<DeleteProvisioningCriteriaResponse>>; /** * Retrieves all created Provisioning Criterias * @summary Retrieves all created Provisioning Criterias * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProvisioningCriteriaApi */ retrieveAllProvisioningCriterias(options?: any): Promise<import("axios").AxiosResponse<GetProvisioningCriteriaResponse[]>>; /** * Retrieves a Provisioning Criteria * @summary Retrieves a Provisioning Criteria * @param {number} criteriaId criteriaId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProvisioningCriteriaApi */ retrieveProvisioningCriteria(criteriaId: number, options?: any): Promise<import("axios").AxiosResponse<GetProvisioningCriteriaCriteriaIdResponse>>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProvisioningCriteriaApi */ retrieveTemplate3(options?: any): Promise<import("axios").AxiosResponse<string>>; /** * Updates a new Provisioning Criteria Optional Fields criteriaName, loanProducts, provisioningcriteria * @summary Updates a new Provisioning Criteria * @param {number} criteriaId criteriaId * @param {PutProvisioningCriteriaRequest} putProvisioningCriteriaRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProvisioningCriteriaApi */ updateProvisioningCriteria(criteriaId: number, putProvisioningCriteriaRequest: PutProvisioningCriteriaRequest, options?: any): Promise<import("axios").AxiosResponse<PutProvisioningCriteriaResponse>>; }