fineract_sdk/dist/src/api/holidays-api.d.ts

Wrapper around fineract api.

/**
 * 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 { DeleteHolidaysHolidayIdResponse } from '../models';
import { GetHolidaysResponse } from '../models';
import { PostHolidaysHolidayIdResponse } from '../models';
import { PostHolidaysRequest } from '../models';
import { PostHolidaysResponse } from '../models';
import { PutHolidaysHolidayIdRequest } from '../models';
import { PutHolidaysHolidayIdResponse } from '../models';
/**
 * HolidaysApi - axios parameter creator
 * @export
 */
export declare const HolidaysApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Mandatory Fields: name, description, fromDate, toDate, repaymentsRescheduledTo, offices
     * @summary Create a Holiday
     * @param {PostHolidaysRequest} postHolidaysRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createNewHoliday: (postHolidaysRequest: PostHolidaysRequest, options?: any) => Promise<RequestArgs>;
    /**
     * This API allows to delete a holiday. This is a soft delete the deleted holiday status is marked as deleted.
     * @summary Delete a Holiday
     * @param {number} holidayId holidayId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    delete7: (holidayId: number, options?: any) => Promise<RequestArgs>;
    /**
     * Always Holidays are created in pending state. This API allows to activate a holiday.  Only the active holidays are considered for rescheduling the loan repayment.
     * @summary Activate a Holiday
     * @param {number} holidayId holidayId
     * @param {object} body
     * @param {string} [command] command
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    handleCommands1: (holidayId: number, body: object, command?: string, options?: any) => Promise<RequestArgs>;
    /**
     * Example Requests:  holidays?officeId=1
     * @summary List Holidays
     * @param {number} [officeId] officeId
     * @param {object} [fromDate] fromDate
     * @param {object} [toDate] toDate
     * @param {string} [locale] locale
     * @param {string} [dateFormat] dateFormat
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveAllHolidays: (officeId?: number, fromDate?: object, toDate?: object, locale?: string, dateFormat?: string, options?: any) => Promise<RequestArgs>;
    /**
     * Example Requests:  holidays/1
     * @summary Retrieve a Holiday
     * @param {number} holidayId holidayId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveOne7: (holidayId: number, options?: any) => Promise<RequestArgs>;
    /**
     *
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveRepaymentScheduleUpdationTyeOptions: (options?: any) => Promise<RequestArgs>;
    /**
     * If a holiday is in pending state (created and not activated) then all fields are allowed to modify. Once holidays become active only name and descriptions are allowed to modify.
     * @summary Update a Holiday
     * @param {number} holidayId holidayId
     * @param {PutHolidaysHolidayIdRequest} putHolidaysHolidayIdRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    update6: (holidayId: number, putHolidaysHolidayIdRequest: PutHolidaysHolidayIdRequest, options?: any) => Promise<RequestArgs>;
};
/**
 * HolidaysApi - functional programming interface
 * @export
 */
export declare const HolidaysApiFp: (configuration?: Configuration) => {
    /**
     * Mandatory Fields: name, description, fromDate, toDate, repaymentsRescheduledTo, offices
     * @summary Create a Holiday
     * @param {PostHolidaysRequest} postHolidaysRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createNewHoliday(postHolidaysRequest: PostHolidaysRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostHolidaysResponse>>;
    /**
     * This API allows to delete a holiday. This is a soft delete the deleted holiday status is marked as deleted.
     * @summary Delete a Holiday
     * @param {number} holidayId holidayId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    delete7(holidayId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteHolidaysHolidayIdResponse>>;
    /**
     * Always Holidays are created in pending state. This API allows to activate a holiday.  Only the active holidays are considered for rescheduling the loan repayment.
     * @summary Activate a Holiday
     * @param {number} holidayId holidayId
     * @param {object} body
     * @param {string} [command] command
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    handleCommands1(holidayId: number, body: object, command?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostHolidaysHolidayIdResponse>>;
    /**
     * Example Requests:  holidays?officeId=1
     * @summary List Holidays
     * @param {number} [officeId] officeId
     * @param {object} [fromDate] fromDate
     * @param {object} [toDate] toDate
     * @param {string} [locale] locale
     * @param {string} [dateFormat] dateFormat
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveAllHolidays(officeId?: number, fromDate?: object, toDate?: object, locale?: string, dateFormat?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GetHolidaysResponse>>>;
    /**
     * Example Requests:  holidays/1
     * @summary Retrieve a Holiday
     * @param {number} holidayId holidayId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveOne7(holidayId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetHolidaysResponse>>;
    /**
     *
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveRepaymentScheduleUpdationTyeOptions(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
    /**
     * If a holiday is in pending state (created and not activated) then all fields are allowed to modify. Once holidays become active only name and descriptions are allowed to modify.
     * @summary Update a Holiday
     * @param {number} holidayId holidayId
     * @param {PutHolidaysHolidayIdRequest} putHolidaysHolidayIdRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    update6(holidayId: number, putHolidaysHolidayIdRequest: PutHolidaysHolidayIdRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutHolidaysHolidayIdResponse>>;
};
/**
 * HolidaysApi - factory interface
 * @export
 */
export declare const HolidaysApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * Mandatory Fields: name, description, fromDate, toDate, repaymentsRescheduledTo, offices
     * @summary Create a Holiday
     * @param {PostHolidaysRequest} postHolidaysRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createNewHoliday(postHolidaysRequest: PostHolidaysRequest, options?: any): AxiosPromise<PostHolidaysResponse>;
    /**
     * This API allows to delete a holiday. This is a soft delete the deleted holiday status is marked as deleted.
     * @summary Delete a Holiday
     * @param {number} holidayId holidayId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    delete7(holidayId: number, options?: any): AxiosPromise<DeleteHolidaysHolidayIdResponse>;
    /**
     * Always Holidays are created in pending state. This API allows to activate a holiday.  Only the active holidays are considered for rescheduling the loan repayment.
     * @summary Activate a Holiday
     * @param {number} holidayId holidayId
     * @param {object} body
     * @param {string} [command] command
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    handleCommands1(holidayId: number, body: object, command?: string, options?: any): AxiosPromise<PostHolidaysHolidayIdResponse>;
    /**
     * Example Requests:  holidays?officeId=1
     * @summary List Holidays
     * @param {number} [officeId] officeId
     * @param {object} [fromDate] fromDate
     * @param {object} [toDate] toDate
     * @param {string} [locale] locale
     * @param {string} [dateFormat] dateFormat
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveAllHolidays(officeId?: number, fromDate?: object, toDate?: object, locale?: string, dateFormat?: string, options?: any): AxiosPromise<Array<GetHolidaysResponse>>;
    /**
     * Example Requests:  holidays/1
     * @summary Retrieve a Holiday
     * @param {number} holidayId holidayId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveOne7(holidayId: number, options?: any): AxiosPromise<GetHolidaysResponse>;
    /**
     *
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveRepaymentScheduleUpdationTyeOptions(options?: any): AxiosPromise<string>;
    /**
     * If a holiday is in pending state (created and not activated) then all fields are allowed to modify. Once holidays become active only name and descriptions are allowed to modify.
     * @summary Update a Holiday
     * @param {number} holidayId holidayId
     * @param {PutHolidaysHolidayIdRequest} putHolidaysHolidayIdRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    update6(holidayId: number, putHolidaysHolidayIdRequest: PutHolidaysHolidayIdRequest, options?: any): AxiosPromise<PutHolidaysHolidayIdResponse>;
};
/**
 * HolidaysApi - object-oriented interface
 * @export
 * @class HolidaysApi
 * @extends {BaseAPI}
 */
export declare class HolidaysApi extends BaseAPI {
    /**
     * Mandatory Fields: name, description, fromDate, toDate, repaymentsRescheduledTo, offices
     * @summary Create a Holiday
     * @param {PostHolidaysRequest} postHolidaysRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof HolidaysApi
     */
    createNewHoliday(postHolidaysRequest: PostHolidaysRequest, options?: any): Promise<import("axios").AxiosResponse<PostHolidaysResponse>>;
    /**
     * This API allows to delete a holiday. This is a soft delete the deleted holiday status is marked as deleted.
     * @summary Delete a Holiday
     * @param {number} holidayId holidayId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof HolidaysApi
     */
    delete7(holidayId: number, options?: any): Promise<import("axios").AxiosResponse<DeleteHolidaysHolidayIdResponse>>;
    /**
     * Always Holidays are created in pending state. This API allows to activate a holiday.  Only the active holidays are considered for rescheduling the loan repayment.
     * @summary Activate a Holiday
     * @param {number} holidayId holidayId
     * @param {object} body
     * @param {string} [command] command
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof HolidaysApi
     */
    handleCommands1(holidayId: number, body: object, command?: string, options?: any): Promise<import("axios").AxiosResponse<PostHolidaysHolidayIdResponse>>;
    /**
     * Example Requests:  holidays?officeId=1
     * @summary List Holidays
     * @param {number} [officeId] officeId
     * @param {object} [fromDate] fromDate
     * @param {object} [toDate] toDate
     * @param {string} [locale] locale
     * @param {string} [dateFormat] dateFormat
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof HolidaysApi
     */
    retrieveAllHolidays(officeId?: number, fromDate?: object, toDate?: object, locale?: string, dateFormat?: string, options?: any): Promise<import("axios").AxiosResponse<GetHolidaysResponse[]>>;
    /**
     * Example Requests:  holidays/1
     * @summary Retrieve a Holiday
     * @param {number} holidayId holidayId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof HolidaysApi
     */
    retrieveOne7(holidayId: number, options?: any): Promise<import("axios").AxiosResponse<GetHolidaysResponse>>;
    /**
     *
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof HolidaysApi
     */
    retrieveRepaymentScheduleUpdationTyeOptions(options?: any): Promise<import("axios").AxiosResponse<string>>;
    /**
     * If a holiday is in pending state (created and not activated) then all fields are allowed to modify. Once holidays become active only name and descriptions are allowed to modify.
     * @summary Update a Holiday
     * @param {number} holidayId holidayId
     * @param {PutHolidaysHolidayIdRequest} putHolidaysHolidayIdRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof HolidaysApi
     */
    update6(holidayId: number, putHolidaysHolidayIdRequest: PutHolidaysHolidayIdRequest, options?: any): Promise<import("axios").AxiosResponse<PutHolidaysHolidayIdResponse>>;
}