fineract_sdk
Version:
Wrapper around fineract api.
220 lines (198 loc) • 12.1 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 { ExternalServicesPropertiesData } from '../models';
// @ts-ignore
import { PutExternalServiceRequest } from '../models';
/**
* ExternalServicesApi - axios parameter creator
* @export
*/
export const ExternalServicesApiAxiosParamCreator = function (configuration?: Configuration) {
return {
/**
* Returns a external Service configurations based on the Service Name. Service Names supported are S3 and SMTP. Example Requests: externalservice/SMTP
* @summary Retrieve External Services Configuration
* @param {string} servicename servicename
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveOne2: async (servicename: string, options: any = {}): Promise<RequestArgs> => {
// verify required parameter 'servicename' is not null or undefined
assertParamExists('retrieveOne2', 'servicename', servicename)
const localVarPath = `/externalservice/{servicename}`
.replace(`{${"servicename"}}`, encodeURIComponent(String(servicename)));
// 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,
};
},
/**
* Updates the external Service Configuration for a Service Name. Example: externalservice/S3
* @summary Update External Service
* @param {string} servicename servicename
* @param {PutExternalServiceRequest} putExternalServiceRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateExternalServiceProperties: async (servicename: string, putExternalServiceRequest: PutExternalServiceRequest, options: any = {}): Promise<RequestArgs> => {
// verify required parameter 'servicename' is not null or undefined
assertParamExists('updateExternalServiceProperties', 'servicename', servicename)
// verify required parameter 'putExternalServiceRequest' is not null or undefined
assertParamExists('updateExternalServiceProperties', 'putExternalServiceRequest', putExternalServiceRequest)
const localVarPath = `/externalservice/{servicename}`
.replace(`{${"servicename"}}`, encodeURIComponent(String(servicename)));
// 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(putExternalServiceRequest, localVarRequestOptions, configuration)
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
}
};
/**
* ExternalServicesApi - functional programming interface
* @export
*/
export const ExternalServicesApiFp = function(configuration?: Configuration) {
const localVarAxiosParamCreator = ExternalServicesApiAxiosParamCreator(configuration)
return {
/**
* Returns a external Service configurations based on the Service Name. Service Names supported are S3 and SMTP. Example Requests: externalservice/SMTP
* @summary Retrieve External Services Configuration
* @param {string} servicename servicename
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async retrieveOne2(servicename: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExternalServicesPropertiesData>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.retrieveOne2(servicename, options);
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
},
/**
* Updates the external Service Configuration for a Service Name. Example: externalservice/S3
* @summary Update External Service
* @param {string} servicename servicename
* @param {PutExternalServiceRequest} putExternalServiceRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async updateExternalServiceProperties(servicename: string, putExternalServiceRequest: PutExternalServiceRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.updateExternalServiceProperties(servicename, putExternalServiceRequest, options);
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
},
}
};
/**
* ExternalServicesApi - factory interface
* @export
*/
export const ExternalServicesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
const localVarFp = ExternalServicesApiFp(configuration)
return {
/**
* Returns a external Service configurations based on the Service Name. Service Names supported are S3 and SMTP. Example Requests: externalservice/SMTP
* @summary Retrieve External Services Configuration
* @param {string} servicename servicename
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveOne2(servicename: string, options?: any): AxiosPromise<ExternalServicesPropertiesData> {
return localVarFp.retrieveOne2(servicename, options).then((request) => request(axios, basePath));
},
/**
* Updates the external Service Configuration for a Service Name. Example: externalservice/S3
* @summary Update External Service
* @param {string} servicename servicename
* @param {PutExternalServiceRequest} putExternalServiceRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateExternalServiceProperties(servicename: string, putExternalServiceRequest: PutExternalServiceRequest, options?: any): AxiosPromise<void> {
return localVarFp.updateExternalServiceProperties(servicename, putExternalServiceRequest, options).then((request) => request(axios, basePath));
},
};
};
/**
* ExternalServicesApi - object-oriented interface
* @export
* @class ExternalServicesApi
* @extends {BaseAPI}
*/
export class ExternalServicesApi extends BaseAPI {
/**
* Returns a external Service configurations based on the Service Name. Service Names supported are S3 and SMTP. Example Requests: externalservice/SMTP
* @summary Retrieve External Services Configuration
* @param {string} servicename servicename
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ExternalServicesApi
*/
public retrieveOne2(servicename: string, options?: any) {
return ExternalServicesApiFp(this.configuration).retrieveOne2(servicename, options).then((request) => request(this.axios, this.basePath));
}
/**
* Updates the external Service Configuration for a Service Name. Example: externalservice/S3
* @summary Update External Service
* @param {string} servicename servicename
* @param {PutExternalServiceRequest} putExternalServiceRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ExternalServicesApi
*/
public updateExternalServiceProperties(servicename: string, putExternalServiceRequest: PutExternalServiceRequest, options?: any) {
return ExternalServicesApiFp(this.configuration).updateExternalServiceProperties(servicename, putExternalServiceRequest, options).then((request) => request(this.axios, this.basePath));
}
}