fineract_sdk
Version:
Wrapper around fineract api.
290 lines (260 loc) • 13.6 kB
text/typescript
/* tslint:disable */
/* eslint-disable */
/**
* 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 globalAxios, { AxiosPromise, AxiosInstance } from 'axios';
import { Configuration } from '../configuration';
// Some imports not used depending on template conditions
// @ts-ignore
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
// @ts-ignore
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
/**
* LikelihoodApi - axios parameter creator
* @export
*/
export const LikelihoodApiAxiosParamCreator = function (configuration?: Configuration) {
return {
/**
*
* @param {number} likelihoodId
* @param {string} ppiName
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieve: async (likelihoodId: number, ppiName: string, options: any = {}): Promise<RequestArgs> => {
// verify required parameter 'likelihoodId' is not null or undefined
assertParamExists('retrieve', 'likelihoodId', likelihoodId)
// verify required parameter 'ppiName' is not null or undefined
assertParamExists('retrieve', 'ppiName', ppiName)
const localVarPath = `/likelihood/{ppiName}/{likelihoodId}`
.replace(`{${"likelihoodId"}}`, encodeURIComponent(String(likelihoodId)))
.replace(`{${"ppiName"}}`, encodeURIComponent(String(ppiName)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication basicAuth required
// http basic authentication required
setBasicAuthToObject(localVarRequestOptions, configuration)
// authentication tenantid required
await setApiKeyToObject(localVarHeaderParameter, "fineract-platform-tenantid", configuration)
setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
*
* @param {string} ppiName
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveAll11: async (ppiName: string, options: any = {}): Promise<RequestArgs> => {
// verify required parameter 'ppiName' is not null or undefined
assertParamExists('retrieveAll11', 'ppiName', ppiName)
const localVarPath = `/likelihood/{ppiName}`
.replace(`{${"ppiName"}}`, encodeURIComponent(String(ppiName)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication basicAuth required
// http basic authentication required
setBasicAuthToObject(localVarRequestOptions, configuration)
// authentication tenantid required
await setApiKeyToObject(localVarHeaderParameter, "fineract-platform-tenantid", configuration)
setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
*
* @param {number} likelihoodId
* @param {string} ppiName
* @param {string} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
update4: async (likelihoodId: number, ppiName: string, body?: string, options: any = {}): Promise<RequestArgs> => {
// verify required parameter 'likelihoodId' is not null or undefined
assertParamExists('update4', 'likelihoodId', likelihoodId)
// verify required parameter 'ppiName' is not null or undefined
assertParamExists('update4', 'ppiName', ppiName)
const localVarPath = `/likelihood/{ppiName}/{likelihoodId}`
.replace(`{${"likelihoodId"}}`, encodeURIComponent(String(likelihoodId)))
.replace(`{${"ppiName"}}`, encodeURIComponent(String(ppiName)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication basicAuth required
// http basic authentication required
setBasicAuthToObject(localVarRequestOptions, configuration)
// authentication tenantid required
await setApiKeyToObject(localVarHeaderParameter, "fineract-platform-tenantid", configuration)
localVarHeaderParameter['Content-Type'] = 'application/json';
setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration)
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
}
};
/**
* LikelihoodApi - functional programming interface
* @export
*/
export const LikelihoodApiFp = function(configuration?: Configuration) {
const localVarAxiosParamCreator = LikelihoodApiAxiosParamCreator(configuration)
return {
/**
*
* @param {number} likelihoodId
* @param {string} ppiName
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async retrieve(likelihoodId: number, ppiName: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.retrieve(likelihoodId, ppiName, options);
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
},
/**
*
* @param {string} ppiName
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async retrieveAll11(ppiName: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.retrieveAll11(ppiName, options);
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
},
/**
*
* @param {number} likelihoodId
* @param {string} ppiName
* @param {string} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async update4(likelihoodId: number, ppiName: string, body?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.update4(likelihoodId, ppiName, body, options);
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
},
}
};
/**
* LikelihoodApi - factory interface
* @export
*/
export const LikelihoodApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
const localVarFp = LikelihoodApiFp(configuration)
return {
/**
*
* @param {number} likelihoodId
* @param {string} ppiName
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieve(likelihoodId: number, ppiName: string, options?: any): AxiosPromise<string> {
return localVarFp.retrieve(likelihoodId, ppiName, options).then((request) => request(axios, basePath));
},
/**
*
* @param {string} ppiName
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveAll11(ppiName: string, options?: any): AxiosPromise<string> {
return localVarFp.retrieveAll11(ppiName, options).then((request) => request(axios, basePath));
},
/**
*
* @param {number} likelihoodId
* @param {string} ppiName
* @param {string} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
update4(likelihoodId: number, ppiName: string, body?: string, options?: any): AxiosPromise<string> {
return localVarFp.update4(likelihoodId, ppiName, body, options).then((request) => request(axios, basePath));
},
};
};
/**
* LikelihoodApi - object-oriented interface
* @export
* @class LikelihoodApi
* @extends {BaseAPI}
*/
export class LikelihoodApi extends BaseAPI {
/**
*
* @param {number} likelihoodId
* @param {string} ppiName
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof LikelihoodApi
*/
public retrieve(likelihoodId: number, ppiName: string, options?: any) {
return LikelihoodApiFp(this.configuration).retrieve(likelihoodId, ppiName, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @param {string} ppiName
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof LikelihoodApi
*/
public retrieveAll11(ppiName: string, options?: any) {
return LikelihoodApiFp(this.configuration).retrieveAll11(ppiName, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @param {number} likelihoodId
* @param {string} ppiName
* @param {string} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof LikelihoodApi
*/
public update4(likelihoodId: number, ppiName: string, body?: string, options?: any) {
return LikelihoodApiFp(this.configuration).update4(likelihoodId, ppiName, body, options).then((request) => request(this.axios, this.basePath));
}
}