fineract_sdk
Version:
Wrapper around fineract api.
242 lines (241 loc) • 13.5 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 { DeleteHookResponse } from '../models';
import { GetHookResponse } from '../models';
import { GetHookTemplateResponse } from '../models';
import { PostHookRequest } from '../models';
import { PostHookResponse } from '../models';
import { PutHookRequest } from '../models';
import { PutHookResponse } from '../models';
/**
* HooksApi - axios parameter creator
* @export
*/
export declare const HooksApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* The following parameters can be passed for the creation of a hook :- name - string - Required. The name of the template that is being called. (See /hooks/template for the list of valid hook names.) isActive - boolean - Determines whether the hook is actually triggered. events - array - Determines what events the hook is triggered for. config - hash - Required. Key/value pairs to provide settings for this hook. These settings vary between the templates. templateId - Optional. The UGD template ID associated with the same entity (client or loan).
* @summary Create a Hook
* @param {PostHookRequest} postHookRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createHook: (postHookRequest: PostHookRequest, options?: any) => Promise<RequestArgs>;
/**
* Deletes a hook.
* @summary Delete a Hook
* @param {number} hookId hookId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteHook: (hookId: number, options?: any) => Promise<RequestArgs>;
/**
* Returns the details of a Hook. Example Requests: hooks/1
* @summary Retrieve a Hook
* @param {number} hookId hookId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveHook: (hookId: number, options?: any) => Promise<RequestArgs>;
/**
* Returns the list of hooks. Example Requests: hooks
* @summary Retrieve Hooks
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveHooks: (options?: any) => Promise<RequestArgs>;
/**
* This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed description Lists Example Request: hooks/template
* @summary Retrieve Hooks Template
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
template3: (options?: any) => Promise<RequestArgs>;
/**
* Updates the details of a hook.
* @summary Update a Hook
* @param {number} hookId hookId
* @param {PutHookRequest} putHookRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateHook: (hookId: number, putHookRequest: PutHookRequest, options?: any) => Promise<RequestArgs>;
};
/**
* HooksApi - functional programming interface
* @export
*/
export declare const HooksApiFp: (configuration?: Configuration) => {
/**
* The following parameters can be passed for the creation of a hook :- name - string - Required. The name of the template that is being called. (See /hooks/template for the list of valid hook names.) isActive - boolean - Determines whether the hook is actually triggered. events - array - Determines what events the hook is triggered for. config - hash - Required. Key/value pairs to provide settings for this hook. These settings vary between the templates. templateId - Optional. The UGD template ID associated with the same entity (client or loan).
* @summary Create a Hook
* @param {PostHookRequest} postHookRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createHook(postHookRequest: PostHookRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostHookResponse>>;
/**
* Deletes a hook.
* @summary Delete a Hook
* @param {number} hookId hookId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteHook(hookId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteHookResponse>>;
/**
* Returns the details of a Hook. Example Requests: hooks/1
* @summary Retrieve a Hook
* @param {number} hookId hookId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveHook(hookId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetHookResponse>>;
/**
* Returns the list of hooks. Example Requests: hooks
* @summary Retrieve Hooks
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveHooks(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GetHookResponse>>>;
/**
* This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed description Lists Example Request: hooks/template
* @summary Retrieve Hooks Template
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
template3(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetHookTemplateResponse>>;
/**
* Updates the details of a hook.
* @summary Update a Hook
* @param {number} hookId hookId
* @param {PutHookRequest} putHookRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateHook(hookId: number, putHookRequest: PutHookRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutHookResponse>>;
};
/**
* HooksApi - factory interface
* @export
*/
export declare const HooksApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* The following parameters can be passed for the creation of a hook :- name - string - Required. The name of the template that is being called. (See /hooks/template for the list of valid hook names.) isActive - boolean - Determines whether the hook is actually triggered. events - array - Determines what events the hook is triggered for. config - hash - Required. Key/value pairs to provide settings for this hook. These settings vary between the templates. templateId - Optional. The UGD template ID associated with the same entity (client or loan).
* @summary Create a Hook
* @param {PostHookRequest} postHookRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createHook(postHookRequest: PostHookRequest, options?: any): AxiosPromise<PostHookResponse>;
/**
* Deletes a hook.
* @summary Delete a Hook
* @param {number} hookId hookId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteHook(hookId: number, options?: any): AxiosPromise<DeleteHookResponse>;
/**
* Returns the details of a Hook. Example Requests: hooks/1
* @summary Retrieve a Hook
* @param {number} hookId hookId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveHook(hookId: number, options?: any): AxiosPromise<GetHookResponse>;
/**
* Returns the list of hooks. Example Requests: hooks
* @summary Retrieve Hooks
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveHooks(options?: any): AxiosPromise<Array<GetHookResponse>>;
/**
* This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed description Lists Example Request: hooks/template
* @summary Retrieve Hooks Template
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
template3(options?: any): AxiosPromise<GetHookTemplateResponse>;
/**
* Updates the details of a hook.
* @summary Update a Hook
* @param {number} hookId hookId
* @param {PutHookRequest} putHookRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateHook(hookId: number, putHookRequest: PutHookRequest, options?: any): AxiosPromise<PutHookResponse>;
};
/**
* HooksApi - object-oriented interface
* @export
* @class HooksApi
* @extends {BaseAPI}
*/
export declare class HooksApi extends BaseAPI {
/**
* The following parameters can be passed for the creation of a hook :- name - string - Required. The name of the template that is being called. (See /hooks/template for the list of valid hook names.) isActive - boolean - Determines whether the hook is actually triggered. events - array - Determines what events the hook is triggered for. config - hash - Required. Key/value pairs to provide settings for this hook. These settings vary between the templates. templateId - Optional. The UGD template ID associated with the same entity (client or loan).
* @summary Create a Hook
* @param {PostHookRequest} postHookRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof HooksApi
*/
createHook(postHookRequest: PostHookRequest, options?: any): Promise<import("axios").AxiosResponse<PostHookResponse>>;
/**
* Deletes a hook.
* @summary Delete a Hook
* @param {number} hookId hookId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof HooksApi
*/
deleteHook(hookId: number, options?: any): Promise<import("axios").AxiosResponse<DeleteHookResponse>>;
/**
* Returns the details of a Hook. Example Requests: hooks/1
* @summary Retrieve a Hook
* @param {number} hookId hookId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof HooksApi
*/
retrieveHook(hookId: number, options?: any): Promise<import("axios").AxiosResponse<GetHookResponse>>;
/**
* Returns the list of hooks. Example Requests: hooks
* @summary Retrieve Hooks
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof HooksApi
*/
retrieveHooks(options?: any): Promise<import("axios").AxiosResponse<GetHookResponse[]>>;
/**
* This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed description Lists Example Request: hooks/template
* @summary Retrieve Hooks Template
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof HooksApi
*/
template3(options?: any): Promise<import("axios").AxiosResponse<GetHookTemplateResponse>>;
/**
* Updates the details of a hook.
* @summary Update a Hook
* @param {number} hookId hookId
* @param {PutHookRequest} putHookRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof HooksApi
*/
updateHook(hookId: number, putHookRequest: PutHookRequest, options?: any): Promise<import("axios").AxiosResponse<PutHookResponse>>;
}