UNPKG

fineract_sdk

Version:

Wrapper around fineract api.

208 lines (185 loc) 9.54 kB
/* 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'; /** * SelfSavingsProductsApi - axios parameter creator * @export */ export const SelfSavingsProductsApiAxiosParamCreator = function (configuration?: Configuration) { return { /** * * @param {number} [clientId] * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAll38: async (clientId?: number, options: any = {}): Promise<RequestArgs> => { const localVarPath = `/self/savingsproducts`; // 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) if (clientId !== undefined) { localVarQueryParameter['clientId'] = clientId; } 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} productId * @param {number} [clientId] * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveOne27: async (productId: number, clientId?: number, options: any = {}): Promise<RequestArgs> => { // verify required parameter 'productId' is not null or undefined assertParamExists('retrieveOne27', 'productId', productId) const localVarPath = `/self/savingsproducts/{productId}` .replace(`{${"productId"}}`, encodeURIComponent(String(productId))); // 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) if (clientId !== undefined) { localVarQueryParameter['clientId'] = clientId; } setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, } }; /** * SelfSavingsProductsApi - functional programming interface * @export */ export const SelfSavingsProductsApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = SelfSavingsProductsApiAxiosParamCreator(configuration) return { /** * * @param {number} [clientId] * @param {*} [options] Override http request option. * @throws {RequiredError} */ async retrieveAll38(clientId?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>> { const localVarAxiosArgs = await localVarAxiosParamCreator.retrieveAll38(clientId, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * * @param {number} productId * @param {number} [clientId] * @param {*} [options] Override http request option. * @throws {RequiredError} */ async retrieveOne27(productId: number, clientId?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>> { const localVarAxiosArgs = await localVarAxiosParamCreator.retrieveOne27(productId, clientId, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, } }; /** * SelfSavingsProductsApi - factory interface * @export */ export const SelfSavingsProductsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = SelfSavingsProductsApiFp(configuration) return { /** * * @param {number} [clientId] * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAll38(clientId?: number, options?: any): AxiosPromise<string> { return localVarFp.retrieveAll38(clientId, options).then((request) => request(axios, basePath)); }, /** * * @param {number} productId * @param {number} [clientId] * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveOne27(productId: number, clientId?: number, options?: any): AxiosPromise<string> { return localVarFp.retrieveOne27(productId, clientId, options).then((request) => request(axios, basePath)); }, }; }; /** * SelfSavingsProductsApi - object-oriented interface * @export * @class SelfSavingsProductsApi * @extends {BaseAPI} */ export class SelfSavingsProductsApi extends BaseAPI { /** * * @param {number} [clientId] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SelfSavingsProductsApi */ public retrieveAll38(clientId?: number, options?: any) { return SelfSavingsProductsApiFp(this.configuration).retrieveAll38(clientId, options).then((request) => request(this.axios, this.basePath)); } /** * * @param {number} productId * @param {number} [clientId] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SelfSavingsProductsApi */ public retrieveOne27(productId: number, clientId?: number, options?: any) { return SelfSavingsProductsApiFp(this.configuration).retrieveOne27(productId, clientId, options).then((request) => request(this.axios, this.basePath)); } }