fineract_sdk
Version:
Wrapper around fineract api.
229 lines (228 loc) • 10.7 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 { GetJobsJobIDJobRunHistoryResponse } from '../models';
import { GetJobsResponse } from '../models';
import { PutJobsJobIDRequest } from '../models';
/**
* MIFOSXBATCHJOBSApi - axios parameter creator
* @export
*/
export declare const MIFOSXBATCHJOBSApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Manually Execute Specific Job.
* @summary Run a Job
* @param {number} jobId jobId
* @param {string} [command] command
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
executeJob: (jobId: number, command?: string, options?: any) => Promise<RequestArgs>;
/**
* Returns the list of jobs. Example Requests: jobs
* @summary Retrieve Scheduler Jobs
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveAll8: (options?: any) => Promise<RequestArgs>;
/**
* Example Requests: jobs/5/runhistory?offset=0&limit=200
* @summary Retrieve Job Run History
* @param {number} jobId jobId
* @param {number} [offset] offset
* @param {number} [limit] limit
* @param {string} [orderBy] orderBy
* @param {string} [sortOrder] sortOrder
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveHistory: (jobId: number, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, options?: any) => Promise<RequestArgs>;
/**
* Returns the details of a Job. Example Requests: jobs/5
* @summary Retrieve a Job
* @param {number} jobId jobId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveOne5: (jobId: number, options?: any) => Promise<RequestArgs>;
/**
* Updates the details of a job.
* @summary Update a Job
* @param {number} jobId jobId
* @param {PutJobsJobIDRequest} putJobsJobIDRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateJobDetail: (jobId: number, putJobsJobIDRequest: PutJobsJobIDRequest, options?: any) => Promise<RequestArgs>;
};
/**
* MIFOSXBATCHJOBSApi - functional programming interface
* @export
*/
export declare const MIFOSXBATCHJOBSApiFp: (configuration?: Configuration) => {
/**
* Manually Execute Specific Job.
* @summary Run a Job
* @param {number} jobId jobId
* @param {string} [command] command
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
executeJob(jobId: number, command?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
/**
* Returns the list of jobs. Example Requests: jobs
* @summary Retrieve Scheduler Jobs
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveAll8(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GetJobsResponse>>>;
/**
* Example Requests: jobs/5/runhistory?offset=0&limit=200
* @summary Retrieve Job Run History
* @param {number} jobId jobId
* @param {number} [offset] offset
* @param {number} [limit] limit
* @param {string} [orderBy] orderBy
* @param {string} [sortOrder] sortOrder
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveHistory(jobId: number, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetJobsJobIDJobRunHistoryResponse>>;
/**
* Returns the details of a Job. Example Requests: jobs/5
* @summary Retrieve a Job
* @param {number} jobId jobId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveOne5(jobId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetJobsResponse>>;
/**
* Updates the details of a job.
* @summary Update a Job
* @param {number} jobId jobId
* @param {PutJobsJobIDRequest} putJobsJobIDRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateJobDetail(jobId: number, putJobsJobIDRequest: PutJobsJobIDRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
};
/**
* MIFOSXBATCHJOBSApi - factory interface
* @export
*/
export declare const MIFOSXBATCHJOBSApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Manually Execute Specific Job.
* @summary Run a Job
* @param {number} jobId jobId
* @param {string} [command] command
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
executeJob(jobId: number, command?: string, options?: any): AxiosPromise<void>;
/**
* Returns the list of jobs. Example Requests: jobs
* @summary Retrieve Scheduler Jobs
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveAll8(options?: any): AxiosPromise<Array<GetJobsResponse>>;
/**
* Example Requests: jobs/5/runhistory?offset=0&limit=200
* @summary Retrieve Job Run History
* @param {number} jobId jobId
* @param {number} [offset] offset
* @param {number} [limit] limit
* @param {string} [orderBy] orderBy
* @param {string} [sortOrder] sortOrder
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveHistory(jobId: number, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, options?: any): AxiosPromise<GetJobsJobIDJobRunHistoryResponse>;
/**
* Returns the details of a Job. Example Requests: jobs/5
* @summary Retrieve a Job
* @param {number} jobId jobId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveOne5(jobId: number, options?: any): AxiosPromise<GetJobsResponse>;
/**
* Updates the details of a job.
* @summary Update a Job
* @param {number} jobId jobId
* @param {PutJobsJobIDRequest} putJobsJobIDRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateJobDetail(jobId: number, putJobsJobIDRequest: PutJobsJobIDRequest, options?: any): AxiosPromise<void>;
};
/**
* MIFOSXBATCHJOBSApi - object-oriented interface
* @export
* @class MIFOSXBATCHJOBSApi
* @extends {BaseAPI}
*/
export declare class MIFOSXBATCHJOBSApi extends BaseAPI {
/**
* Manually Execute Specific Job.
* @summary Run a Job
* @param {number} jobId jobId
* @param {string} [command] command
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof MIFOSXBATCHJOBSApi
*/
executeJob(jobId: number, command?: string, options?: any): Promise<import("axios").AxiosResponse<void>>;
/**
* Returns the list of jobs. Example Requests: jobs
* @summary Retrieve Scheduler Jobs
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof MIFOSXBATCHJOBSApi
*/
retrieveAll8(options?: any): Promise<import("axios").AxiosResponse<GetJobsResponse[]>>;
/**
* Example Requests: jobs/5/runhistory?offset=0&limit=200
* @summary Retrieve Job Run History
* @param {number} jobId jobId
* @param {number} [offset] offset
* @param {number} [limit] limit
* @param {string} [orderBy] orderBy
* @param {string} [sortOrder] sortOrder
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof MIFOSXBATCHJOBSApi
*/
retrieveHistory(jobId: number, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, options?: any): Promise<import("axios").AxiosResponse<GetJobsJobIDJobRunHistoryResponse>>;
/**
* Returns the details of a Job. Example Requests: jobs/5
* @summary Retrieve a Job
* @param {number} jobId jobId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof MIFOSXBATCHJOBSApi
*/
retrieveOne5(jobId: number, options?: any): Promise<import("axios").AxiosResponse<GetJobsResponse>>;
/**
* Updates the details of a job.
* @summary Update a Job
* @param {number} jobId jobId
* @param {PutJobsJobIDRequest} putJobsJobIDRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof MIFOSXBATCHJOBSApi
*/
updateJobDetail(jobId: number, putJobsJobIDRequest: PutJobsJobIDRequest, options?: any): Promise<import("axios").AxiosResponse<void>>;
}