ch-api-client-typescript2/lib/api/about-us-api.d.ts

Openapi generated typescript-axios client for CloudHospital

/**
 * CloudHospital Api
 * CloudHospital application with Swagger, Swashbuckle, and API versioning.
 *
 * The version of the OpenAPI document: 2
 * Contact: developer@icloudhospital.com
 *
 * 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, AxiosRequestConfig } from 'axios';
import { Configuration } from '../configuration';
import { RequestArgs, BaseAPI } from '../base';
import { AboutUsPageModel } from '../models';
import { AboutUsPagesModel } from '../models';
/**
 * AboutUsApi - axios parameter creator
 * @export
 */
export declare const AboutUsApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *
     * @summary Get all AboutUsList.
     * @param {string} [hospitalId]
     * @param {string} [hospitalName]
     * @param {string} [hospitalSlug]
     * @param {string} [name]
     * @param {string} [languageCode]
     * @param {boolean} [returnDefaultValue]
     * @param {boolean} [confirmed]
     * @param {number} [page]
     * @param {number} [limit]
     * @param {Date} [lastRetrieved]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2AboutusGet: (hospitalId?: string, hospitalName?: string, hospitalSlug?: string, name?: string, languageCode?: string, returnDefaultValue?: boolean, confirmed?: boolean, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get AboutUs.
     * @param {string} hospitalId
     * @param {string} [languageCode]
     * @param {boolean} [returnDefaultValue]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2AboutusHospitalIdGet: (hospitalId: string, languageCode?: string, returnDefaultValue?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary
     * @param {string} slug
     * @param {string} [languageCode]
     * @param {boolean} [returnDefaultValue]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2AboutusSlugGet: (slug: string, languageCode?: string, returnDefaultValue?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * AboutUsApi - functional programming interface
 * @export
 */
export declare const AboutUsApiFp: (configuration?: Configuration) => {
    /**
     *
     * @summary Get all AboutUsList.
     * @param {string} [hospitalId]
     * @param {string} [hospitalName]
     * @param {string} [hospitalSlug]
     * @param {string} [name]
     * @param {string} [languageCode]
     * @param {boolean} [returnDefaultValue]
     * @param {boolean} [confirmed]
     * @param {number} [page]
     * @param {number} [limit]
     * @param {Date} [lastRetrieved]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2AboutusGet(hospitalId?: string, hospitalName?: string, hospitalSlug?: string, name?: string, languageCode?: string, returnDefaultValue?: boolean, confirmed?: boolean, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AboutUsPagesModel>>;
    /**
     *
     * @summary Get AboutUs.
     * @param {string} hospitalId
     * @param {string} [languageCode]
     * @param {boolean} [returnDefaultValue]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2AboutusHospitalIdGet(hospitalId: string, languageCode?: string, returnDefaultValue?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AboutUsPageModel>>;
    /**
     *
     * @summary
     * @param {string} slug
     * @param {string} [languageCode]
     * @param {boolean} [returnDefaultValue]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2AboutusSlugGet(slug: string, languageCode?: string, returnDefaultValue?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AboutUsPageModel>>;
};
/**
 * AboutUsApi - factory interface
 * @export
 */
export declare const AboutUsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     *
     * @summary Get all AboutUsList.
     * @param {string} [hospitalId]
     * @param {string} [hospitalName]
     * @param {string} [hospitalSlug]
     * @param {string} [name]
     * @param {string} [languageCode]
     * @param {boolean} [returnDefaultValue]
     * @param {boolean} [confirmed]
     * @param {number} [page]
     * @param {number} [limit]
     * @param {Date} [lastRetrieved]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2AboutusGet(hospitalId?: string, hospitalName?: string, hospitalSlug?: string, name?: string, languageCode?: string, returnDefaultValue?: boolean, confirmed?: boolean, page?: number, limit?: number, lastRetrieved?: Date, options?: any): AxiosPromise<AboutUsPagesModel>;
    /**
     *
     * @summary Get AboutUs.
     * @param {string} hospitalId
     * @param {string} [languageCode]
     * @param {boolean} [returnDefaultValue]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2AboutusHospitalIdGet(hospitalId: string, languageCode?: string, returnDefaultValue?: boolean, options?: any): AxiosPromise<AboutUsPageModel>;
    /**
     *
     * @summary
     * @param {string} slug
     * @param {string} [languageCode]
     * @param {boolean} [returnDefaultValue]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2AboutusSlugGet(slug: string, languageCode?: string, returnDefaultValue?: boolean, options?: any): AxiosPromise<AboutUsPageModel>;
};
/**
 * Request parameters for apiV2AboutusGet operation in AboutUsApi.
 * @export
 * @interface AboutUsApiApiV2AboutusGetRequest
 */
export interface AboutUsApiApiV2AboutusGetRequest {
    /**
     *
     * @type {string}
     * @memberof AboutUsApiApiV2AboutusGet
     */
    readonly hospitalId?: string;
    /**
     *
     * @type {string}
     * @memberof AboutUsApiApiV2AboutusGet
     */
    readonly hospitalName?: string;
    /**
     *
     * @type {string}
     * @memberof AboutUsApiApiV2AboutusGet
     */
    readonly hospitalSlug?: string;
    /**
     *
     * @type {string}
     * @memberof AboutUsApiApiV2AboutusGet
     */
    readonly name?: string;
    /**
     *
     * @type {string}
     * @memberof AboutUsApiApiV2AboutusGet
     */
    readonly languageCode?: string;
    /**
     *
     * @type {boolean}
     * @memberof AboutUsApiApiV2AboutusGet
     */
    readonly returnDefaultValue?: boolean;
    /**
     *
     * @type {boolean}
     * @memberof AboutUsApiApiV2AboutusGet
     */
    readonly confirmed?: boolean;
    /**
     *
     * @type {number}
     * @memberof AboutUsApiApiV2AboutusGet
     */
    readonly page?: number;
    /**
     *
     * @type {number}
     * @memberof AboutUsApiApiV2AboutusGet
     */
    readonly limit?: number;
    /**
     *
     * @type {Date}
     * @memberof AboutUsApiApiV2AboutusGet
     */
    readonly lastRetrieved?: Date;
}
/**
 * Request parameters for apiV2AboutusHospitalIdGet operation in AboutUsApi.
 * @export
 * @interface AboutUsApiApiV2AboutusHospitalIdGetRequest
 */
export interface AboutUsApiApiV2AboutusHospitalIdGetRequest {
    /**
     *
     * @type {string}
     * @memberof AboutUsApiApiV2AboutusHospitalIdGet
     */
    readonly hospitalId: string;
    /**
     *
     * @type {string}
     * @memberof AboutUsApiApiV2AboutusHospitalIdGet
     */
    readonly languageCode?: string;
    /**
     *
     * @type {boolean}
     * @memberof AboutUsApiApiV2AboutusHospitalIdGet
     */
    readonly returnDefaultValue?: boolean;
}
/**
 * Request parameters for apiV2AboutusSlugGet operation in AboutUsApi.
 * @export
 * @interface AboutUsApiApiV2AboutusSlugGetRequest
 */
export interface AboutUsApiApiV2AboutusSlugGetRequest {
    /**
     *
     * @type {string}
     * @memberof AboutUsApiApiV2AboutusSlugGet
     */
    readonly slug: string;
    /**
     *
     * @type {string}
     * @memberof AboutUsApiApiV2AboutusSlugGet
     */
    readonly languageCode?: string;
    /**
     *
     * @type {boolean}
     * @memberof AboutUsApiApiV2AboutusSlugGet
     */
    readonly returnDefaultValue?: boolean;
}
/**
 * AboutUsApi - object-oriented interface
 * @export
 * @class AboutUsApi
 * @extends {BaseAPI}
 */
export declare class AboutUsApi extends BaseAPI {
    /**
     *
     * @summary Get all AboutUsList.
     * @param {AboutUsApiApiV2AboutusGetRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AboutUsApi
     */
    apiV2AboutusGet(requestParameters?: AboutUsApiApiV2AboutusGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AboutUsPagesModel, any>>;
    /**
     *
     * @summary Get AboutUs.
     * @param {AboutUsApiApiV2AboutusHospitalIdGetRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AboutUsApi
     */
    apiV2AboutusHospitalIdGet(requestParameters: AboutUsApiApiV2AboutusHospitalIdGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AboutUsPageModel, any>>;
    /**
     *
     * @summary
     * @param {AboutUsApiApiV2AboutusSlugGetRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AboutUsApi
     */
    apiV2AboutusSlugGet(requestParameters: AboutUsApiApiV2AboutusSlugGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AboutUsPageModel, any>>;
}
//# sourceMappingURL=about-us-api.d.ts.map