fineract_sdk
Version:
Wrapper around fineract api.
211 lines (210 loc) • 9.12 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 { SurveyData } from '../models';
/**
* SpmSurveysApi - axios parameter creator
* @export
*/
export declare const SpmSurveysApiAxiosParamCreator: (configuration?: Configuration) => {
/**
*
* @summary Deactivate Survey
* @param {number} id
* @param {string} [command]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
activateOrDeactivateSurvey: (id: number, command?: string, options?: any) => Promise<RequestArgs>;
/**
* Adds a new survey to collect client related data. Mandatory Fields countryCode, key, name, questions, responses, sequenceNo, text, description
* @summary Create a Survey
* @param {SurveyData} [surveyData] Create survey
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createSurvey: (surveyData?: SurveyData, options?: any) => Promise<RequestArgs>;
/**
*
* @param {number} id
* @param {SurveyData} [surveyData]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
editSurvey: (id: number, surveyData?: SurveyData, options?: any) => Promise<RequestArgs>;
/**
*
* @summary List all Surveys
* @param {boolean} [isActive]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
fetchAllSurveys1: (isActive?: boolean, options?: any) => Promise<RequestArgs>;
/**
*
* @summary Retrieve a Survey
* @param {number} id Enter id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
findSurvey: (id: number, options?: any) => Promise<RequestArgs>;
};
/**
* SpmSurveysApi - functional programming interface
* @export
*/
export declare const SpmSurveysApiFp: (configuration?: Configuration) => {
/**
*
* @summary Deactivate Survey
* @param {number} id
* @param {string} [command]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
activateOrDeactivateSurvey(id: number, command?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
/**
* Adds a new survey to collect client related data. Mandatory Fields countryCode, key, name, questions, responses, sequenceNo, text, description
* @summary Create a Survey
* @param {SurveyData} [surveyData] Create survey
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createSurvey(surveyData?: SurveyData, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
/**
*
* @param {number} id
* @param {SurveyData} [surveyData]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
editSurvey(id: number, surveyData?: SurveyData, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
/**
*
* @summary List all Surveys
* @param {boolean} [isActive]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
fetchAllSurveys1(isActive?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SurveyData>>>;
/**
*
* @summary Retrieve a Survey
* @param {number} id Enter id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
findSurvey(id: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SurveyData>>;
};
/**
* SpmSurveysApi - factory interface
* @export
*/
export declare const SpmSurveysApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
*
* @summary Deactivate Survey
* @param {number} id
* @param {string} [command]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
activateOrDeactivateSurvey(id: number, command?: string, options?: any): AxiosPromise<void>;
/**
* Adds a new survey to collect client related data. Mandatory Fields countryCode, key, name, questions, responses, sequenceNo, text, description
* @summary Create a Survey
* @param {SurveyData} [surveyData] Create survey
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createSurvey(surveyData?: SurveyData, options?: any): AxiosPromise<void>;
/**
*
* @param {number} id
* @param {SurveyData} [surveyData]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
editSurvey(id: number, surveyData?: SurveyData, options?: any): AxiosPromise<string>;
/**
*
* @summary List all Surveys
* @param {boolean} [isActive]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
fetchAllSurveys1(isActive?: boolean, options?: any): AxiosPromise<Array<SurveyData>>;
/**
*
* @summary Retrieve a Survey
* @param {number} id Enter id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
findSurvey(id: number, options?: any): AxiosPromise<SurveyData>;
};
/**
* SpmSurveysApi - object-oriented interface
* @export
* @class SpmSurveysApi
* @extends {BaseAPI}
*/
export declare class SpmSurveysApi extends BaseAPI {
/**
*
* @summary Deactivate Survey
* @param {number} id
* @param {string} [command]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SpmSurveysApi
*/
activateOrDeactivateSurvey(id: number, command?: string, options?: any): Promise<import("axios").AxiosResponse<void>>;
/**
* Adds a new survey to collect client related data. Mandatory Fields countryCode, key, name, questions, responses, sequenceNo, text, description
* @summary Create a Survey
* @param {SurveyData} [surveyData] Create survey
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SpmSurveysApi
*/
createSurvey(surveyData?: SurveyData, options?: any): Promise<import("axios").AxiosResponse<void>>;
/**
*
* @param {number} id
* @param {SurveyData} [surveyData]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SpmSurveysApi
*/
editSurvey(id: number, surveyData?: SurveyData, options?: any): Promise<import("axios").AxiosResponse<string>>;
/**
*
* @summary List all Surveys
* @param {boolean} [isActive]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SpmSurveysApi
*/
fetchAllSurveys1(isActive?: boolean, options?: any): Promise<import("axios").AxiosResponse<SurveyData[]>>;
/**
*
* @summary Retrieve a Survey
* @param {number} id Enter id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SpmSurveysApi
*/
findSurvey(id: number, options?: any): Promise<import("axios").AxiosResponse<SurveyData>>;
}