fineract_sdk
Version:
Wrapper around fineract api.
147 lines (146 loc) • 8.68 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 { GetGlobalConfigurationsResponse } from '../models';
import { PutGlobalConfigurationsRequest } from '../models';
import { PutGlobalConfigurationsResponse } from '../models';
/**
* GlobalConfigurationApi - axios parameter creator
* @export
*/
export declare const GlobalConfigurationApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Returns the list global enable/disable configurations. Example Requests: configurations Returns the list global enable/disable survey configurations. Example Requests: configurations/survey
* @summary Retrieve Global Configuration | Retrieve Global Configuration for surveys
* @param {boolean} [survey] survey
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveConfiguration: (survey?: boolean, options?: any) => Promise<RequestArgs>;
/**
* Returns a global enable/disable configurations. Example Requests: configurations/1
* @summary Retrieve Global Configuration
* @param {number} configId configId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveOne3: (configId: number, options?: any) => Promise<RequestArgs>;
/**
* Updates an enable/disable global configuration item.
* @summary Update Global Configuration
* @param {number} configId configId
* @param {PutGlobalConfigurationsRequest} putGlobalConfigurationsRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateConfiguration1: (configId: number, putGlobalConfigurationsRequest: PutGlobalConfigurationsRequest, options?: any) => Promise<RequestArgs>;
};
/**
* GlobalConfigurationApi - functional programming interface
* @export
*/
export declare const GlobalConfigurationApiFp: (configuration?: Configuration) => {
/**
* Returns the list global enable/disable configurations. Example Requests: configurations Returns the list global enable/disable survey configurations. Example Requests: configurations/survey
* @summary Retrieve Global Configuration | Retrieve Global Configuration for surveys
* @param {boolean} [survey] survey
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveConfiguration(survey?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GetGlobalConfigurationsResponse>>>;
/**
* Returns a global enable/disable configurations. Example Requests: configurations/1
* @summary Retrieve Global Configuration
* @param {number} configId configId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveOne3(configId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetGlobalConfigurationsResponse>>;
/**
* Updates an enable/disable global configuration item.
* @summary Update Global Configuration
* @param {number} configId configId
* @param {PutGlobalConfigurationsRequest} putGlobalConfigurationsRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateConfiguration1(configId: number, putGlobalConfigurationsRequest: PutGlobalConfigurationsRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutGlobalConfigurationsResponse>>;
};
/**
* GlobalConfigurationApi - factory interface
* @export
*/
export declare const GlobalConfigurationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Returns the list global enable/disable configurations. Example Requests: configurations Returns the list global enable/disable survey configurations. Example Requests: configurations/survey
* @summary Retrieve Global Configuration | Retrieve Global Configuration for surveys
* @param {boolean} [survey] survey
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveConfiguration(survey?: boolean, options?: any): AxiosPromise<Array<GetGlobalConfigurationsResponse>>;
/**
* Returns a global enable/disable configurations. Example Requests: configurations/1
* @summary Retrieve Global Configuration
* @param {number} configId configId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveOne3(configId: number, options?: any): AxiosPromise<GetGlobalConfigurationsResponse>;
/**
* Updates an enable/disable global configuration item.
* @summary Update Global Configuration
* @param {number} configId configId
* @param {PutGlobalConfigurationsRequest} putGlobalConfigurationsRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateConfiguration1(configId: number, putGlobalConfigurationsRequest: PutGlobalConfigurationsRequest, options?: any): AxiosPromise<PutGlobalConfigurationsResponse>;
};
/**
* GlobalConfigurationApi - object-oriented interface
* @export
* @class GlobalConfigurationApi
* @extends {BaseAPI}
*/
export declare class GlobalConfigurationApi extends BaseAPI {
/**
* Returns the list global enable/disable configurations. Example Requests: configurations Returns the list global enable/disable survey configurations. Example Requests: configurations/survey
* @summary Retrieve Global Configuration | Retrieve Global Configuration for surveys
* @param {boolean} [survey] survey
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof GlobalConfigurationApi
*/
retrieveConfiguration(survey?: boolean, options?: any): Promise<import("axios").AxiosResponse<GetGlobalConfigurationsResponse[]>>;
/**
* Returns a global enable/disable configurations. Example Requests: configurations/1
* @summary Retrieve Global Configuration
* @param {number} configId configId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof GlobalConfigurationApi
*/
retrieveOne3(configId: number, options?: any): Promise<import("axios").AxiosResponse<GetGlobalConfigurationsResponse>>;
/**
* Updates an enable/disable global configuration item.
* @summary Update Global Configuration
* @param {number} configId configId
* @param {PutGlobalConfigurationsRequest} putGlobalConfigurationsRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof GlobalConfigurationApi
*/
updateConfiguration1(configId: number, putGlobalConfigurationsRequest: PutGlobalConfigurationsRequest, options?: any): Promise<import("axios").AxiosResponse<PutGlobalConfigurationsResponse>>;
}