fineract_sdk
Version:
Wrapper around fineract api.
113 lines (112 loc) • 6.66 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 { ExternalServicesPropertiesData } from '../models';
import { PutExternalServiceRequest } from '../models';
/**
* ExternalServicesApi - axios parameter creator
* @export
*/
export declare const ExternalServicesApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* 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) => Promise<RequestArgs>;
/**
* 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) => Promise<RequestArgs>;
};
/**
* ExternalServicesApi - functional programming interface
* @export
*/
export declare const ExternalServicesApiFp: (configuration?: Configuration) => {
/**
* 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): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExternalServicesPropertiesData>>;
/**
* 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): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
};
/**
* ExternalServicesApi - factory interface
* @export
*/
export declare const ExternalServicesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* 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>;
/**
* 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>;
};
/**
* ExternalServicesApi - object-oriented interface
* @export
* @class ExternalServicesApi
* @extends {BaseAPI}
*/
export declare 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
*/
retrieveOne2(servicename: string, options?: any): Promise<import("axios").AxiosResponse<ExternalServicesPropertiesData>>;
/**
* 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
*/
updateExternalServiceProperties(servicename: string, putExternalServiceRequest: PutExternalServiceRequest, options?: any): Promise<import("axios").AxiosResponse<void>>;
}