fineract_sdk/dist/api/offices-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 { FormDataContentDisposition } from '../models';
import { GetOfficesResponse } from '../models';
import { GetOfficesTemplateResponse } from '../models';
import { PostOfficesRequest } from '../models';
import { PostOfficesResponse } from '../models';
import { PutOfficesOfficeIdRequest } from '../models';
import { PutOfficesOfficeIdResponse } from '../models';
/**
 * OfficesApi - axios parameter creator
 * @export
 */
export declare const OfficesApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Mandatory Fields name, openingDate, parentId
     * @summary Create an Office
     * @param {PostOfficesRequest} postOfficesRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createOffice: (postOfficesRequest: PostOfficesRequest, options?: any) => Promise<RequestArgs>;
    /**
     *
     * @param {string} [dateFormat]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getOfficeTemplate: (dateFormat?: string, options?: any) => Promise<RequestArgs>;
    /**
     *
     * @param {FormDataContentDisposition} [file]
     * @param {string} [locale]
     * @param {string} [dateFormat]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    postOfficeTemplate: (file?: any, locale?: string, dateFormat?: string, options?: any) => Promise<RequestArgs>;
    /**
     * Example Requests:  offices/1   offices/1?template=true   offices/1?fields=id,name,parentName
     * @summary Retrieve an Office
     * @param {number} officeId officeId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retreiveOffice: (officeId: number, 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:  offices/template
     * @summary Retrieve Office Details Template
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveOfficeTemplate: (options?: any) => Promise<RequestArgs>;
    /**
     * Example Requests:  offices   offices?fields=id,name,openingDate
     * @summary List Offices
     * @param {boolean} [includeAllOffices] includeAllOffices
     * @param {string} [orderBy] orderBy
     * @param {string} [sortOrder] sortOrder
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveOffices: (includeAllOffices?: boolean, orderBy?: string, sortOrder?: string, options?: any) => Promise<RequestArgs>;
    /**
     *
     * @summary Update Office
     * @param {number} officeId officeId
     * @param {PutOfficesOfficeIdRequest} putOfficesOfficeIdRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateOffice: (officeId: number, putOfficesOfficeIdRequest: PutOfficesOfficeIdRequest, options?: any) => Promise<RequestArgs>;
};
/**
 * OfficesApi - functional programming interface
 * @export
 */
export declare const OfficesApiFp: (configuration?: Configuration) => {
    /**
     * Mandatory Fields name, openingDate, parentId
     * @summary Create an Office
     * @param {PostOfficesRequest} postOfficesRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createOffice(postOfficesRequest: PostOfficesRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostOfficesResponse>>;
    /**
     *
     * @param {string} [dateFormat]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getOfficeTemplate(dateFormat?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     *
     * @param {FormDataContentDisposition} [file]
     * @param {string} [locale]
     * @param {string} [dateFormat]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    postOfficeTemplate(file?: any, locale?: string, dateFormat?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
    /**
     * Example Requests:  offices/1   offices/1?template=true   offices/1?fields=id,name,parentName
     * @summary Retrieve an Office
     * @param {number} officeId officeId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retreiveOffice(officeId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOfficesResponse>>;
    /**
     * 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:  offices/template
     * @summary Retrieve Office Details Template
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveOfficeTemplate(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOfficesTemplateResponse>>;
    /**
     * Example Requests:  offices   offices?fields=id,name,openingDate
     * @summary List Offices
     * @param {boolean} [includeAllOffices] includeAllOffices
     * @param {string} [orderBy] orderBy
     * @param {string} [sortOrder] sortOrder
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveOffices(includeAllOffices?: boolean, orderBy?: string, sortOrder?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GetOfficesResponse>>>;
    /**
     *
     * @summary Update Office
     * @param {number} officeId officeId
     * @param {PutOfficesOfficeIdRequest} putOfficesOfficeIdRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateOffice(officeId: number, putOfficesOfficeIdRequest: PutOfficesOfficeIdRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutOfficesOfficeIdResponse>>;
};
/**
 * OfficesApi - factory interface
 * @export
 */
export declare const OfficesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * Mandatory Fields name, openingDate, parentId
     * @summary Create an Office
     * @param {PostOfficesRequest} postOfficesRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createOffice(postOfficesRequest: PostOfficesRequest, options?: any): AxiosPromise<PostOfficesResponse>;
    /**
     *
     * @param {string} [dateFormat]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getOfficeTemplate(dateFormat?: string, options?: any): AxiosPromise<void>;
    /**
     *
     * @param {FormDataContentDisposition} [file]
     * @param {string} [locale]
     * @param {string} [dateFormat]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    postOfficeTemplate(file?: any, locale?: string, dateFormat?: string, options?: any): AxiosPromise<string>;
    /**
     * Example Requests:  offices/1   offices/1?template=true   offices/1?fields=id,name,parentName
     * @summary Retrieve an Office
     * @param {number} officeId officeId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retreiveOffice(officeId: number, options?: any): AxiosPromise<GetOfficesResponse>;
    /**
     * 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:  offices/template
     * @summary Retrieve Office Details Template
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveOfficeTemplate(options?: any): AxiosPromise<GetOfficesTemplateResponse>;
    /**
     * Example Requests:  offices   offices?fields=id,name,openingDate
     * @summary List Offices
     * @param {boolean} [includeAllOffices] includeAllOffices
     * @param {string} [orderBy] orderBy
     * @param {string} [sortOrder] sortOrder
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveOffices(includeAllOffices?: boolean, orderBy?: string, sortOrder?: string, options?: any): AxiosPromise<Array<GetOfficesResponse>>;
    /**
     *
     * @summary Update Office
     * @param {number} officeId officeId
     * @param {PutOfficesOfficeIdRequest} putOfficesOfficeIdRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateOffice(officeId: number, putOfficesOfficeIdRequest: PutOfficesOfficeIdRequest, options?: any): AxiosPromise<PutOfficesOfficeIdResponse>;
};
/**
 * OfficesApi - object-oriented interface
 * @export
 * @class OfficesApi
 * @extends {BaseAPI}
 */
export declare class OfficesApi extends BaseAPI {
    /**
     * Mandatory Fields name, openingDate, parentId
     * @summary Create an Office
     * @param {PostOfficesRequest} postOfficesRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof OfficesApi
     */
    createOffice(postOfficesRequest: PostOfficesRequest, options?: any): Promise<import("axios").AxiosResponse<PostOfficesResponse>>;
    /**
     *
     * @param {string} [dateFormat]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof OfficesApi
     */
    getOfficeTemplate(dateFormat?: string, options?: any): Promise<import("axios").AxiosResponse<void>>;
    /**
     *
     * @param {FormDataContentDisposition} [file]
     * @param {string} [locale]
     * @param {string} [dateFormat]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof OfficesApi
     */
    postOfficeTemplate(file?: FormDataContentDisposition, locale?: string, dateFormat?: string, options?: any): Promise<import("axios").AxiosResponse<string>>;
    /**
     * Example Requests:  offices/1   offices/1?template=true   offices/1?fields=id,name,parentName
     * @summary Retrieve an Office
     * @param {number} officeId officeId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof OfficesApi
     */
    retreiveOffice(officeId: number, options?: any): Promise<import("axios").AxiosResponse<GetOfficesResponse>>;
    /**
     * 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:  offices/template
     * @summary Retrieve Office Details Template
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof OfficesApi
     */
    retrieveOfficeTemplate(options?: any): Promise<import("axios").AxiosResponse<GetOfficesTemplateResponse>>;
    /**
     * Example Requests:  offices   offices?fields=id,name,openingDate
     * @summary List Offices
     * @param {boolean} [includeAllOffices] includeAllOffices
     * @param {string} [orderBy] orderBy
     * @param {string} [sortOrder] sortOrder
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof OfficesApi
     */
    retrieveOffices(includeAllOffices?: boolean, orderBy?: string, sortOrder?: string, options?: any): Promise<import("axios").AxiosResponse<GetOfficesResponse[]>>;
    /**
     *
     * @summary Update Office
     * @param {number} officeId officeId
     * @param {PutOfficesOfficeIdRequest} putOfficesOfficeIdRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof OfficesApi
     */
    updateOffice(officeId: number, putOfficesOfficeIdRequest: PutOfficesOfficeIdRequest, options?: any): Promise<import("axios").AxiosResponse<PutOfficesOfficeIdResponse>>;
}