fineract_sdk
Version:
Wrapper around fineract api.
240 lines (239 loc) • 12.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 { LoanProductProvisioningEntryData } from '../models';
import { PostProvisioningEntriesRequest } from '../models';
import { PostProvisioningEntriesResponse } from '../models';
import { ProvisioningEntryData } from '../models';
import { PutProvisioningEntriesRequest } from '../models';
import { PutProvisioningEntriesResponse } from '../models';
/**
* ProvisioningEntriesApi - axios parameter creator
* @export
*/
export declare const ProvisioningEntriesApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Creates a new Provisioning Entries Mandatory Fields date dateFormat locale Optional Fields createjournalentries
* @summary Create new Provisioning Entries
* @param {PostProvisioningEntriesRequest} [postProvisioningEntriesRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createProvisioningEntries: (postProvisioningEntriesRequest?: PostProvisioningEntriesRequest, options?: any) => Promise<RequestArgs>;
/**
* Recreates Provisioning Entry | createjournalentry.
* @summary Recreates Provisioning Entry
* @param {number} entryId entryId
* @param {string} [command] command=createjournalentry command=recreateprovisioningentry
* @param {PutProvisioningEntriesRequest} [putProvisioningEntriesRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
modifyProvisioningEntry: (entryId: number, command?: string, putProvisioningEntriesRequest?: PutProvisioningEntriesRequest, options?: any) => Promise<RequestArgs>;
/**
*
* @summary List all Provisioning Entries
* @param {number} [offset] offset
* @param {number} [limit] limit
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveAllProvisioningEntries: (offset?: number, limit?: number, options?: any) => Promise<RequestArgs>;
/**
*
* @param {number} [entryId]
* @param {number} [offset]
* @param {number} [limit]
* @param {number} [officeId]
* @param {number} [productId]
* @param {number} [categoryId]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveProviioningEntries: (entryId?: number, offset?: number, limit?: number, officeId?: number, productId?: number, categoryId?: number, options?: any) => Promise<RequestArgs>;
/**
* Returns the details of a generated Provisioning Entry.
* @summary Retrieves a Provisioning Entry
* @param {number} entryId entryId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveProvisioningEntry: (entryId: number, options?: any) => Promise<RequestArgs>;
};
/**
* ProvisioningEntriesApi - functional programming interface
* @export
*/
export declare const ProvisioningEntriesApiFp: (configuration?: Configuration) => {
/**
* Creates a new Provisioning Entries Mandatory Fields date dateFormat locale Optional Fields createjournalentries
* @summary Create new Provisioning Entries
* @param {PostProvisioningEntriesRequest} [postProvisioningEntriesRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createProvisioningEntries(postProvisioningEntriesRequest?: PostProvisioningEntriesRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostProvisioningEntriesResponse>>;
/**
* Recreates Provisioning Entry | createjournalentry.
* @summary Recreates Provisioning Entry
* @param {number} entryId entryId
* @param {string} [command] command=createjournalentry command=recreateprovisioningentry
* @param {PutProvisioningEntriesRequest} [putProvisioningEntriesRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
modifyProvisioningEntry(entryId: number, command?: string, putProvisioningEntriesRequest?: PutProvisioningEntriesRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutProvisioningEntriesResponse>>;
/**
*
* @summary List all Provisioning Entries
* @param {number} [offset] offset
* @param {number} [limit] limit
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveAllProvisioningEntries(offset?: number, limit?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ProvisioningEntryData>>>;
/**
*
* @param {number} [entryId]
* @param {number} [offset]
* @param {number} [limit]
* @param {number} [officeId]
* @param {number} [productId]
* @param {number} [categoryId]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveProviioningEntries(entryId?: number, offset?: number, limit?: number, officeId?: number, productId?: number, categoryId?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LoanProductProvisioningEntryData>>;
/**
* Returns the details of a generated Provisioning Entry.
* @summary Retrieves a Provisioning Entry
* @param {number} entryId entryId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveProvisioningEntry(entryId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProvisioningEntryData>>;
};
/**
* ProvisioningEntriesApi - factory interface
* @export
*/
export declare const ProvisioningEntriesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Creates a new Provisioning Entries Mandatory Fields date dateFormat locale Optional Fields createjournalentries
* @summary Create new Provisioning Entries
* @param {PostProvisioningEntriesRequest} [postProvisioningEntriesRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createProvisioningEntries(postProvisioningEntriesRequest?: PostProvisioningEntriesRequest, options?: any): AxiosPromise<PostProvisioningEntriesResponse>;
/**
* Recreates Provisioning Entry | createjournalentry.
* @summary Recreates Provisioning Entry
* @param {number} entryId entryId
* @param {string} [command] command=createjournalentry command=recreateprovisioningentry
* @param {PutProvisioningEntriesRequest} [putProvisioningEntriesRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
modifyProvisioningEntry(entryId: number, command?: string, putProvisioningEntriesRequest?: PutProvisioningEntriesRequest, options?: any): AxiosPromise<PutProvisioningEntriesResponse>;
/**
*
* @summary List all Provisioning Entries
* @param {number} [offset] offset
* @param {number} [limit] limit
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveAllProvisioningEntries(offset?: number, limit?: number, options?: any): AxiosPromise<Array<ProvisioningEntryData>>;
/**
*
* @param {number} [entryId]
* @param {number} [offset]
* @param {number} [limit]
* @param {number} [officeId]
* @param {number} [productId]
* @param {number} [categoryId]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveProviioningEntries(entryId?: number, offset?: number, limit?: number, officeId?: number, productId?: number, categoryId?: number, options?: any): AxiosPromise<LoanProductProvisioningEntryData>;
/**
* Returns the details of a generated Provisioning Entry.
* @summary Retrieves a Provisioning Entry
* @param {number} entryId entryId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveProvisioningEntry(entryId: number, options?: any): AxiosPromise<ProvisioningEntryData>;
};
/**
* ProvisioningEntriesApi - object-oriented interface
* @export
* @class ProvisioningEntriesApi
* @extends {BaseAPI}
*/
export declare class ProvisioningEntriesApi extends BaseAPI {
/**
* Creates a new Provisioning Entries Mandatory Fields date dateFormat locale Optional Fields createjournalentries
* @summary Create new Provisioning Entries
* @param {PostProvisioningEntriesRequest} [postProvisioningEntriesRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ProvisioningEntriesApi
*/
createProvisioningEntries(postProvisioningEntriesRequest?: PostProvisioningEntriesRequest, options?: any): Promise<import("axios").AxiosResponse<PostProvisioningEntriesResponse>>;
/**
* Recreates Provisioning Entry | createjournalentry.
* @summary Recreates Provisioning Entry
* @param {number} entryId entryId
* @param {string} [command] command=createjournalentry command=recreateprovisioningentry
* @param {PutProvisioningEntriesRequest} [putProvisioningEntriesRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ProvisioningEntriesApi
*/
modifyProvisioningEntry(entryId: number, command?: string, putProvisioningEntriesRequest?: PutProvisioningEntriesRequest, options?: any): Promise<import("axios").AxiosResponse<PutProvisioningEntriesResponse>>;
/**
*
* @summary List all Provisioning Entries
* @param {number} [offset] offset
* @param {number} [limit] limit
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ProvisioningEntriesApi
*/
retrieveAllProvisioningEntries(offset?: number, limit?: number, options?: any): Promise<import("axios").AxiosResponse<ProvisioningEntryData[]>>;
/**
*
* @param {number} [entryId]
* @param {number} [offset]
* @param {number} [limit]
* @param {number} [officeId]
* @param {number} [productId]
* @param {number} [categoryId]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ProvisioningEntriesApi
*/
retrieveProviioningEntries(entryId?: number, offset?: number, limit?: number, officeId?: number, productId?: number, categoryId?: number, options?: any): Promise<import("axios").AxiosResponse<LoanProductProvisioningEntryData>>;
/**
* Returns the details of a generated Provisioning Entry.
* @summary Retrieves a Provisioning Entry
* @param {number} entryId entryId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ProvisioningEntriesApi
*/
retrieveProvisioningEntry(entryId: number, options?: any): Promise<import("axios").AxiosResponse<ProvisioningEntryData>>;
}