fineract_sdk
Version:
Wrapper around fineract api.
208 lines (186 loc) • 9.83 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';
// @ts-ignore
import { ScorecardData } from '../models';
/**
* SelfScoreCardApi - axios parameter creator
* @export
*/
export const SelfScoreCardApiAxiosParamCreator = function (configuration?: Configuration) {
return {
/**
*
* @param {number} surveyId
* @param {ScorecardData} [scorecardData]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createScorecard: async (surveyId: number, scorecardData?: ScorecardData, options: any = {}): Promise<RequestArgs> => {
// verify required parameter 'surveyId' is not null or undefined
assertParamExists('createScorecard', 'surveyId', surveyId)
const localVarPath = `/self/surveys/scorecards/{surveyId}`
.replace(`{${"surveyId"}}`, encodeURIComponent(String(surveyId)));
// 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: 'POST', ...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(scorecardData, localVarRequestOptions, configuration)
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
*
* @param {number} clientId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
findByClient: async (clientId: number, options: any = {}): Promise<RequestArgs> => {
// verify required parameter 'clientId' is not null or undefined
assertParamExists('findByClient', 'clientId', clientId)
const localVarPath = `/self/surveys/scorecards/clients/{clientId}`
.replace(`{${"clientId"}}`, encodeURIComponent(String(clientId)));
// 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,
};
},
}
};
/**
* SelfScoreCardApi - functional programming interface
* @export
*/
export const SelfScoreCardApiFp = function(configuration?: Configuration) {
const localVarAxiosParamCreator = SelfScoreCardApiAxiosParamCreator(configuration)
return {
/**
*
* @param {number} surveyId
* @param {ScorecardData} [scorecardData]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async createScorecard(surveyId: number, scorecardData?: ScorecardData, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.createScorecard(surveyId, scorecardData, options);
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
},
/**
*
* @param {number} clientId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async findByClient(clientId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ScorecardData>>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.findByClient(clientId, options);
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
},
}
};
/**
* SelfScoreCardApi - factory interface
* @export
*/
export const SelfScoreCardApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
const localVarFp = SelfScoreCardApiFp(configuration)
return {
/**
*
* @param {number} surveyId
* @param {ScorecardData} [scorecardData]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createScorecard(surveyId: number, scorecardData?: ScorecardData, options?: any): AxiosPromise<void> {
return localVarFp.createScorecard(surveyId, scorecardData, options).then((request) => request(axios, basePath));
},
/**
*
* @param {number} clientId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
findByClient(clientId: number, options?: any): AxiosPromise<Array<ScorecardData>> {
return localVarFp.findByClient(clientId, options).then((request) => request(axios, basePath));
},
};
};
/**
* SelfScoreCardApi - object-oriented interface
* @export
* @class SelfScoreCardApi
* @extends {BaseAPI}
*/
export class SelfScoreCardApi extends BaseAPI {
/**
*
* @param {number} surveyId
* @param {ScorecardData} [scorecardData]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SelfScoreCardApi
*/
public createScorecard(surveyId: number, scorecardData?: ScorecardData, options?: any) {
return SelfScoreCardApiFp(this.configuration).createScorecard(surveyId, scorecardData, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @param {number} clientId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SelfScoreCardApi
*/
public findByClient(clientId: number, options?: any) {
return SelfScoreCardApiFp(this.configuration).findByClient(clientId, options).then((request) => request(this.axios, this.basePath));
}
}