fineract_sdk
Version:
Wrapper around fineract api.
291 lines (290 loc) • 14.1 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 { GetSurveyResponse } from '../models';
import { PostSurveySurveyNameApptableIdRequest } from '../models';
import { PostSurveySurveyNameApptableIdResponse } from '../models';
/**
* SurveyApi - axios parameter creator
* @export
*/
export declare const SurveyApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Insert and entry in a survey table (full fill the survey). Refer Link for sample Body: [ https://demo.fineract.dev/fineract-provider/api-docs/apiLive.htm#survey_create ]
* @summary Create an entry in the survey table
* @param {string} surveyName surveyName
* @param {number} apptableId apptableId
* @param {PostSurveySurveyNameApptableIdRequest} postSurveySurveyNameApptableIdRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createDatatableEntry1: (surveyName: string, apptableId: number, postSurveySurveyNameApptableIdRequest: PostSurveySurveyNameApptableIdRequest, options?: any) => Promise<RequestArgs>;
/**
*
* @param {string} surveyName
* @param {number} clientId
* @param {number} fulfilledId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteDatatableEntries2: (surveyName: string, clientId: number, fulfilledId: number, options?: any) => Promise<RequestArgs>;
/**
*
* @param {string} surveyName
* @param {number} clientId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getClientSurveyOverview: (surveyName: string, clientId: number, options?: any) => Promise<RequestArgs>;
/**
*
* @param {string} surveyName
* @param {number} clientId
* @param {number} entryId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSurveyEntry: (surveyName: string, clientId: number, entryId: number, options?: any) => Promise<RequestArgs>;
/**
*
* @param {string} surveyName
* @param {string} apptable
* @param {string} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
register: (surveyName: string, apptable: string, body?: string, options?: any) => Promise<RequestArgs>;
/**
* Lists a registered survey table details and the Apache Fineract Core application table they are registered to.
* @summary Retrieve survey
* @param {string} surveyName surveyName
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveSurvey: (surveyName: string, options?: any) => Promise<RequestArgs>;
/**
* Retrieve surveys. This allows to retrieve the list of survey tables registered .
* @summary Retrieve surveys
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveSurveys: (options?: any) => Promise<RequestArgs>;
};
/**
* SurveyApi - functional programming interface
* @export
*/
export declare const SurveyApiFp: (configuration?: Configuration) => {
/**
* Insert and entry in a survey table (full fill the survey). Refer Link for sample Body: [ https://demo.fineract.dev/fineract-provider/api-docs/apiLive.htm#survey_create ]
* @summary Create an entry in the survey table
* @param {string} surveyName surveyName
* @param {number} apptableId apptableId
* @param {PostSurveySurveyNameApptableIdRequest} postSurveySurveyNameApptableIdRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createDatatableEntry1(surveyName: string, apptableId: number, postSurveySurveyNameApptableIdRequest: PostSurveySurveyNameApptableIdRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostSurveySurveyNameApptableIdResponse>>;
/**
*
* @param {string} surveyName
* @param {number} clientId
* @param {number} fulfilledId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteDatatableEntries2(surveyName: string, clientId: number, fulfilledId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
/**
*
* @param {string} surveyName
* @param {number} clientId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getClientSurveyOverview(surveyName: string, clientId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
/**
*
* @param {string} surveyName
* @param {number} clientId
* @param {number} entryId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSurveyEntry(surveyName: string, clientId: number, entryId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
/**
*
* @param {string} surveyName
* @param {string} apptable
* @param {string} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
register(surveyName: string, apptable: string, body?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
/**
* Lists a registered survey table details and the Apache Fineract Core application table they are registered to.
* @summary Retrieve survey
* @param {string} surveyName surveyName
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveSurvey(surveyName: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSurveyResponse>>;
/**
* Retrieve surveys. This allows to retrieve the list of survey tables registered .
* @summary Retrieve surveys
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveSurveys(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GetSurveyResponse>>>;
};
/**
* SurveyApi - factory interface
* @export
*/
export declare const SurveyApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Insert and entry in a survey table (full fill the survey). Refer Link for sample Body: [ https://demo.fineract.dev/fineract-provider/api-docs/apiLive.htm#survey_create ]
* @summary Create an entry in the survey table
* @param {string} surveyName surveyName
* @param {number} apptableId apptableId
* @param {PostSurveySurveyNameApptableIdRequest} postSurveySurveyNameApptableIdRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createDatatableEntry1(surveyName: string, apptableId: number, postSurveySurveyNameApptableIdRequest: PostSurveySurveyNameApptableIdRequest, options?: any): AxiosPromise<PostSurveySurveyNameApptableIdResponse>;
/**
*
* @param {string} surveyName
* @param {number} clientId
* @param {number} fulfilledId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteDatatableEntries2(surveyName: string, clientId: number, fulfilledId: number, options?: any): AxiosPromise<string>;
/**
*
* @param {string} surveyName
* @param {number} clientId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getClientSurveyOverview(surveyName: string, clientId: number, options?: any): AxiosPromise<string>;
/**
*
* @param {string} surveyName
* @param {number} clientId
* @param {number} entryId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSurveyEntry(surveyName: string, clientId: number, entryId: number, options?: any): AxiosPromise<string>;
/**
*
* @param {string} surveyName
* @param {string} apptable
* @param {string} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
register(surveyName: string, apptable: string, body?: string, options?: any): AxiosPromise<string>;
/**
* Lists a registered survey table details and the Apache Fineract Core application table they are registered to.
* @summary Retrieve survey
* @param {string} surveyName surveyName
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveSurvey(surveyName: string, options?: any): AxiosPromise<GetSurveyResponse>;
/**
* Retrieve surveys. This allows to retrieve the list of survey tables registered .
* @summary Retrieve surveys
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveSurveys(options?: any): AxiosPromise<Array<GetSurveyResponse>>;
};
/**
* SurveyApi - object-oriented interface
* @export
* @class SurveyApi
* @extends {BaseAPI}
*/
export declare class SurveyApi extends BaseAPI {
/**
* Insert and entry in a survey table (full fill the survey). Refer Link for sample Body: [ https://demo.fineract.dev/fineract-provider/api-docs/apiLive.htm#survey_create ]
* @summary Create an entry in the survey table
* @param {string} surveyName surveyName
* @param {number} apptableId apptableId
* @param {PostSurveySurveyNameApptableIdRequest} postSurveySurveyNameApptableIdRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SurveyApi
*/
createDatatableEntry1(surveyName: string, apptableId: number, postSurveySurveyNameApptableIdRequest: PostSurveySurveyNameApptableIdRequest, options?: any): Promise<import("axios").AxiosResponse<PostSurveySurveyNameApptableIdResponse>>;
/**
*
* @param {string} surveyName
* @param {number} clientId
* @param {number} fulfilledId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SurveyApi
*/
deleteDatatableEntries2(surveyName: string, clientId: number, fulfilledId: number, options?: any): Promise<import("axios").AxiosResponse<string>>;
/**
*
* @param {string} surveyName
* @param {number} clientId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SurveyApi
*/
getClientSurveyOverview(surveyName: string, clientId: number, options?: any): Promise<import("axios").AxiosResponse<string>>;
/**
*
* @param {string} surveyName
* @param {number} clientId
* @param {number} entryId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SurveyApi
*/
getSurveyEntry(surveyName: string, clientId: number, entryId: number, options?: any): Promise<import("axios").AxiosResponse<string>>;
/**
*
* @param {string} surveyName
* @param {string} apptable
* @param {string} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SurveyApi
*/
register(surveyName: string, apptable: string, body?: string, options?: any): Promise<import("axios").AxiosResponse<string>>;
/**
* Lists a registered survey table details and the Apache Fineract Core application table they are registered to.
* @summary Retrieve survey
* @param {string} surveyName surveyName
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SurveyApi
*/
retrieveSurvey(surveyName: string, options?: any): Promise<import("axios").AxiosResponse<GetSurveyResponse>>;
/**
* Retrieve surveys. This allows to retrieve the list of survey tables registered .
* @summary Retrieve surveys
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SurveyApi
*/
retrieveSurveys(options?: any): Promise<import("axios").AxiosResponse<GetSurveyResponse[]>>;
}