fineract_sdk/dist/src/api/staff-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 { CreateStaffResponse } from '../models';
import { FormDataContentDisposition } from '../models';
import { PostStaffRequest } from '../models';
import { PutStaffRequest } from '../models';
import { RetrieveOneResponse } from '../models';
import { UpdateStaffResponse } from '../models';
/**
 * StaffApi - axios parameter creator
 * @export
 */
export declare const StaffApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Creates a staff member.  Mandatory Fields:  officeId, firstname, lastname  Optional Fields:  isLoanOfficer, isActive
     * @summary Create a staff member
     * @param {PostStaffRequest} postStaffRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    create3: (postStaffRequest: PostStaffRequest, options?: any) => Promise<RequestArgs>;
    /**
     *
     * @param {number} [officeId]
     * @param {string} [dateFormat]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getTemplate1: (officeId?: number, dateFormat?: string, options?: any) => Promise<RequestArgs>;
    /**
     *
     * @param {FormDataContentDisposition} [file]
     * @param {string} [locale]
     * @param {string} [dateFormat]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    postTemplate: (file?: any, locale?: string, dateFormat?: string, options?: any) => Promise<RequestArgs>;
    /**
     * Returns the list of staff members.  Example Requests:  staff     Retrieve a Staff by status  Returns the details of a Staff based on status.  By default it Returns all the ACTIVE Staff.  If status=INACTIVE, then it returns all INACTIVE Staff.  and for status=ALL, it Returns both ACTIVE and INACTIVE Staff.  Example Requests:  staff?status=active
     * @summary Retrieve Staff
     * @param {number} [officeId] officeId
     * @param {boolean} [staffInOfficeHierarchy] staffInOfficeHierarchy
     * @param {boolean} [loanOfficersOnly] loanOfficersOnly
     * @param {string} [status] status
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveAll16: (officeId?: number, staffInOfficeHierarchy?: boolean, loanOfficersOnly?: boolean, status?: string, options?: any) => Promise<RequestArgs>;
    /**
     * Returns the details of a Staff Member.  Example Requests:  staff/1
     * @summary Retrieve a Staff Member
     * @param {number} staffId staffId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveOne8: (staffId: number, options?: any) => Promise<RequestArgs>;
    /**
     * Updates the details of a staff member.
     * @summary Update a Staff Member
     * @param {number} staffId staffId
     * @param {PutStaffRequest} putStaffRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    update7: (staffId: number, putStaffRequest: PutStaffRequest, options?: any) => Promise<RequestArgs>;
};
/**
 * StaffApi - functional programming interface
 * @export
 */
export declare const StaffApiFp: (configuration?: Configuration) => {
    /**
     * Creates a staff member.  Mandatory Fields:  officeId, firstname, lastname  Optional Fields:  isLoanOfficer, isActive
     * @summary Create a staff member
     * @param {PostStaffRequest} postStaffRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    create3(postStaffRequest: PostStaffRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateStaffResponse>>;
    /**
     *
     * @param {number} [officeId]
     * @param {string} [dateFormat]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getTemplate1(officeId?: number, 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}
     */
    postTemplate(file?: any, locale?: string, dateFormat?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
    /**
     * Returns the list of staff members.  Example Requests:  staff     Retrieve a Staff by status  Returns the details of a Staff based on status.  By default it Returns all the ACTIVE Staff.  If status=INACTIVE, then it returns all INACTIVE Staff.  and for status=ALL, it Returns both ACTIVE and INACTIVE Staff.  Example Requests:  staff?status=active
     * @summary Retrieve Staff
     * @param {number} [officeId] officeId
     * @param {boolean} [staffInOfficeHierarchy] staffInOfficeHierarchy
     * @param {boolean} [loanOfficersOnly] loanOfficersOnly
     * @param {string} [status] status
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveAll16(officeId?: number, staffInOfficeHierarchy?: boolean, loanOfficersOnly?: boolean, status?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RetrieveOneResponse>>>;
    /**
     * Returns the details of a Staff Member.  Example Requests:  staff/1
     * @summary Retrieve a Staff Member
     * @param {number} staffId staffId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveOne8(staffId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RetrieveOneResponse>>;
    /**
     * Updates the details of a staff member.
     * @summary Update a Staff Member
     * @param {number} staffId staffId
     * @param {PutStaffRequest} putStaffRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    update7(staffId: number, putStaffRequest: PutStaffRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateStaffResponse>>;
};
/**
 * StaffApi - factory interface
 * @export
 */
export declare const StaffApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * Creates a staff member.  Mandatory Fields:  officeId, firstname, lastname  Optional Fields:  isLoanOfficer, isActive
     * @summary Create a staff member
     * @param {PostStaffRequest} postStaffRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    create3(postStaffRequest: PostStaffRequest, options?: any): AxiosPromise<CreateStaffResponse>;
    /**
     *
     * @param {number} [officeId]
     * @param {string} [dateFormat]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getTemplate1(officeId?: number, dateFormat?: string, options?: any): AxiosPromise<void>;
    /**
     *
     * @param {FormDataContentDisposition} [file]
     * @param {string} [locale]
     * @param {string} [dateFormat]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    postTemplate(file?: any, locale?: string, dateFormat?: string, options?: any): AxiosPromise<string>;
    /**
     * Returns the list of staff members.  Example Requests:  staff     Retrieve a Staff by status  Returns the details of a Staff based on status.  By default it Returns all the ACTIVE Staff.  If status=INACTIVE, then it returns all INACTIVE Staff.  and for status=ALL, it Returns both ACTIVE and INACTIVE Staff.  Example Requests:  staff?status=active
     * @summary Retrieve Staff
     * @param {number} [officeId] officeId
     * @param {boolean} [staffInOfficeHierarchy] staffInOfficeHierarchy
     * @param {boolean} [loanOfficersOnly] loanOfficersOnly
     * @param {string} [status] status
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveAll16(officeId?: number, staffInOfficeHierarchy?: boolean, loanOfficersOnly?: boolean, status?: string, options?: any): AxiosPromise<Array<RetrieveOneResponse>>;
    /**
     * Returns the details of a Staff Member.  Example Requests:  staff/1
     * @summary Retrieve a Staff Member
     * @param {number} staffId staffId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveOne8(staffId: number, options?: any): AxiosPromise<RetrieveOneResponse>;
    /**
     * Updates the details of a staff member.
     * @summary Update a Staff Member
     * @param {number} staffId staffId
     * @param {PutStaffRequest} putStaffRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    update7(staffId: number, putStaffRequest: PutStaffRequest, options?: any): AxiosPromise<UpdateStaffResponse>;
};
/**
 * StaffApi - object-oriented interface
 * @export
 * @class StaffApi
 * @extends {BaseAPI}
 */
export declare class StaffApi extends BaseAPI {
    /**
     * Creates a staff member.  Mandatory Fields:  officeId, firstname, lastname  Optional Fields:  isLoanOfficer, isActive
     * @summary Create a staff member
     * @param {PostStaffRequest} postStaffRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof StaffApi
     */
    create3(postStaffRequest: PostStaffRequest, options?: any): Promise<import("axios").AxiosResponse<CreateStaffResponse>>;
    /**
     *
     * @param {number} [officeId]
     * @param {string} [dateFormat]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof StaffApi
     */
    getTemplate1(officeId?: number, 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 StaffApi
     */
    postTemplate(file?: FormDataContentDisposition, locale?: string, dateFormat?: string, options?: any): Promise<import("axios").AxiosResponse<string>>;
    /**
     * Returns the list of staff members.  Example Requests:  staff     Retrieve a Staff by status  Returns the details of a Staff based on status.  By default it Returns all the ACTIVE Staff.  If status=INACTIVE, then it returns all INACTIVE Staff.  and for status=ALL, it Returns both ACTIVE and INACTIVE Staff.  Example Requests:  staff?status=active
     * @summary Retrieve Staff
     * @param {number} [officeId] officeId
     * @param {boolean} [staffInOfficeHierarchy] staffInOfficeHierarchy
     * @param {boolean} [loanOfficersOnly] loanOfficersOnly
     * @param {string} [status] status
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof StaffApi
     */
    retrieveAll16(officeId?: number, staffInOfficeHierarchy?: boolean, loanOfficersOnly?: boolean, status?: string, options?: any): Promise<import("axios").AxiosResponse<RetrieveOneResponse[]>>;
    /**
     * Returns the details of a Staff Member.  Example Requests:  staff/1
     * @summary Retrieve a Staff Member
     * @param {number} staffId staffId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof StaffApi
     */
    retrieveOne8(staffId: number, options?: any): Promise<import("axios").AxiosResponse<RetrieveOneResponse>>;
    /**
     * Updates the details of a staff member.
     * @summary Update a Staff Member
     * @param {number} staffId staffId
     * @param {PutStaffRequest} putStaffRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof StaffApi
     */
    update7(staffId: number, putStaffRequest: PutStaffRequest, options?: any): Promise<import("axios").AxiosResponse<UpdateStaffResponse>>;
}