ch-api-client-typescript2/lib/api/faqs-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 { FaqModel } from '../models';
import { FaqTagModel } from '../models';
import { FaqTagsModel } from '../models';
import { FaqsModel } from '../models';
import { MediaModel } from '../models';
import { MediaType } from '../models';
import { MediasModel } from '../models';
/**
 * FaqsApi - axios parameter creator
 * @export
 */
export declare const FaqsApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *
     * @summary Get faq.
     * @param {string} faqId
     * @param {string} [languageCode]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2FaqsFaqIdGet: (faqId: string, languageCode?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get all FaqMedias.
     * @param {string} faqId
     * @param {string} [id]
     * @param {MediaType} [mediaType]
     * @param {number} [page]
     * @param {number} [limit]
     * @param {Date} [lastRetrieved]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2FaqsFaqIdMediasGet: (faqId: string, id?: string, mediaType?: MediaType, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get FaqMedia.
     * @param {string} faqId
     * @param {string} mediaId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2FaqsFaqIdMediasMediaIdGet: (faqId: string, mediaId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary GetAll FaqTags.
     * @param {string} faqId
     * @param {string} [tagId]
     * @param {number} [page]
     * @param {number} [limit]
     * @param {Date} [lastRetrieved]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2FaqsFaqIdTagsGet: (faqId: string, tagId?: string, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get FaqTag.
     * @param {string} faqId
     * @param {string} tagId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2FaqsFaqIdTagsTagIdGet: (faqId: string, tagId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get all Faqs.
     * @param {string} [id]
     * @param {string} [name]
     * @param {string} [slug]
     * @param {string} [categoryId]
     * @param {string} [hospitalId]
     * @param {string} [hospitalName]
     * @param {string} [languageCode]
     * @param {boolean} [showHidden]
     * @param {boolean} [returnDefaultValue]
     * @param {number} [page]
     * @param {number} [limit]
     * @param {Date} [lastRetrieved]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2FaqsGet: (id?: string, name?: string, slug?: string, categoryId?: string, hospitalId?: string, hospitalName?: string, languageCode?: string, showHidden?: boolean, returnDefaultValue?: boolean, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get faq by slug.
     * @param {string} slug
     * @param {string} [languageCode]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2FaqsSlugGet: (slug: string, languageCode?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * FaqsApi - functional programming interface
 * @export
 */
export declare const FaqsApiFp: (configuration?: Configuration) => {
    /**
     *
     * @summary Get faq.
     * @param {string} faqId
     * @param {string} [languageCode]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2FaqsFaqIdGet(faqId: string, languageCode?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FaqModel>>;
    /**
     *
     * @summary Get all FaqMedias.
     * @param {string} faqId
     * @param {string} [id]
     * @param {MediaType} [mediaType]
     * @param {number} [page]
     * @param {number} [limit]
     * @param {Date} [lastRetrieved]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2FaqsFaqIdMediasGet(faqId: string, id?: string, mediaType?: MediaType, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MediasModel>>;
    /**
     *
     * @summary Get FaqMedia.
     * @param {string} faqId
     * @param {string} mediaId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2FaqsFaqIdMediasMediaIdGet(faqId: string, mediaId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MediaModel>>;
    /**
     *
     * @summary GetAll FaqTags.
     * @param {string} faqId
     * @param {string} [tagId]
     * @param {number} [page]
     * @param {number} [limit]
     * @param {Date} [lastRetrieved]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2FaqsFaqIdTagsGet(faqId: string, tagId?: string, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FaqTagsModel>>;
    /**
     *
     * @summary Get FaqTag.
     * @param {string} faqId
     * @param {string} tagId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2FaqsFaqIdTagsTagIdGet(faqId: string, tagId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FaqTagModel>>;
    /**
     *
     * @summary Get all Faqs.
     * @param {string} [id]
     * @param {string} [name]
     * @param {string} [slug]
     * @param {string} [categoryId]
     * @param {string} [hospitalId]
     * @param {string} [hospitalName]
     * @param {string} [languageCode]
     * @param {boolean} [showHidden]
     * @param {boolean} [returnDefaultValue]
     * @param {number} [page]
     * @param {number} [limit]
     * @param {Date} [lastRetrieved]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2FaqsGet(id?: string, name?: string, slug?: string, categoryId?: string, hospitalId?: string, hospitalName?: string, languageCode?: string, showHidden?: boolean, returnDefaultValue?: boolean, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FaqsModel>>;
    /**
     *
     * @summary Get faq by slug.
     * @param {string} slug
     * @param {string} [languageCode]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2FaqsSlugGet(slug: string, languageCode?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FaqModel>>;
};
/**
 * FaqsApi - factory interface
 * @export
 */
export declare const FaqsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     *
     * @summary Get faq.
     * @param {string} faqId
     * @param {string} [languageCode]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2FaqsFaqIdGet(faqId: string, languageCode?: string, options?: any): AxiosPromise<FaqModel>;
    /**
     *
     * @summary Get all FaqMedias.
     * @param {string} faqId
     * @param {string} [id]
     * @param {MediaType} [mediaType]
     * @param {number} [page]
     * @param {number} [limit]
     * @param {Date} [lastRetrieved]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2FaqsFaqIdMediasGet(faqId: string, id?: string, mediaType?: MediaType, page?: number, limit?: number, lastRetrieved?: Date, options?: any): AxiosPromise<MediasModel>;
    /**
     *
     * @summary Get FaqMedia.
     * @param {string} faqId
     * @param {string} mediaId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2FaqsFaqIdMediasMediaIdGet(faqId: string, mediaId: string, options?: any): AxiosPromise<MediaModel>;
    /**
     *
     * @summary GetAll FaqTags.
     * @param {string} faqId
     * @param {string} [tagId]
     * @param {number} [page]
     * @param {number} [limit]
     * @param {Date} [lastRetrieved]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2FaqsFaqIdTagsGet(faqId: string, tagId?: string, page?: number, limit?: number, lastRetrieved?: Date, options?: any): AxiosPromise<FaqTagsModel>;
    /**
     *
     * @summary Get FaqTag.
     * @param {string} faqId
     * @param {string} tagId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2FaqsFaqIdTagsTagIdGet(faqId: string, tagId: string, options?: any): AxiosPromise<FaqTagModel>;
    /**
     *
     * @summary Get all Faqs.
     * @param {string} [id]
     * @param {string} [name]
     * @param {string} [slug]
     * @param {string} [categoryId]
     * @param {string} [hospitalId]
     * @param {string} [hospitalName]
     * @param {string} [languageCode]
     * @param {boolean} [showHidden]
     * @param {boolean} [returnDefaultValue]
     * @param {number} [page]
     * @param {number} [limit]
     * @param {Date} [lastRetrieved]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2FaqsGet(id?: string, name?: string, slug?: string, categoryId?: string, hospitalId?: string, hospitalName?: string, languageCode?: string, showHidden?: boolean, returnDefaultValue?: boolean, page?: number, limit?: number, lastRetrieved?: Date, options?: any): AxiosPromise<FaqsModel>;
    /**
     *
     * @summary Get faq by slug.
     * @param {string} slug
     * @param {string} [languageCode]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2FaqsSlugGet(slug: string, languageCode?: string, options?: any): AxiosPromise<FaqModel>;
};
/**
 * Request parameters for apiV2FaqsFaqIdGet operation in FaqsApi.
 * @export
 * @interface FaqsApiApiV2FaqsFaqIdGetRequest
 */
export interface FaqsApiApiV2FaqsFaqIdGetRequest {
    /**
     *
     * @type {string}
     * @memberof FaqsApiApiV2FaqsFaqIdGet
     */
    readonly faqId: string;
    /**
     *
     * @type {string}
     * @memberof FaqsApiApiV2FaqsFaqIdGet
     */
    readonly languageCode?: string;
}
/**
 * Request parameters for apiV2FaqsFaqIdMediasGet operation in FaqsApi.
 * @export
 * @interface FaqsApiApiV2FaqsFaqIdMediasGetRequest
 */
export interface FaqsApiApiV2FaqsFaqIdMediasGetRequest {
    /**
     *
     * @type {string}
     * @memberof FaqsApiApiV2FaqsFaqIdMediasGet
     */
    readonly faqId: string;
    /**
     *
     * @type {string}
     * @memberof FaqsApiApiV2FaqsFaqIdMediasGet
     */
    readonly id?: string;
    /**
     *
     * @type {MediaType}
     * @memberof FaqsApiApiV2FaqsFaqIdMediasGet
     */
    readonly mediaType?: MediaType;
    /**
     *
     * @type {number}
     * @memberof FaqsApiApiV2FaqsFaqIdMediasGet
     */
    readonly page?: number;
    /**
     *
     * @type {number}
     * @memberof FaqsApiApiV2FaqsFaqIdMediasGet
     */
    readonly limit?: number;
    /**
     *
     * @type {Date}
     * @memberof FaqsApiApiV2FaqsFaqIdMediasGet
     */
    readonly lastRetrieved?: Date;
}
/**
 * Request parameters for apiV2FaqsFaqIdMediasMediaIdGet operation in FaqsApi.
 * @export
 * @interface FaqsApiApiV2FaqsFaqIdMediasMediaIdGetRequest
 */
export interface FaqsApiApiV2FaqsFaqIdMediasMediaIdGetRequest {
    /**
     *
     * @type {string}
     * @memberof FaqsApiApiV2FaqsFaqIdMediasMediaIdGet
     */
    readonly faqId: string;
    /**
     *
     * @type {string}
     * @memberof FaqsApiApiV2FaqsFaqIdMediasMediaIdGet
     */
    readonly mediaId: string;
}
/**
 * Request parameters for apiV2FaqsFaqIdTagsGet operation in FaqsApi.
 * @export
 * @interface FaqsApiApiV2FaqsFaqIdTagsGetRequest
 */
export interface FaqsApiApiV2FaqsFaqIdTagsGetRequest {
    /**
     *
     * @type {string}
     * @memberof FaqsApiApiV2FaqsFaqIdTagsGet
     */
    readonly faqId: string;
    /**
     *
     * @type {string}
     * @memberof FaqsApiApiV2FaqsFaqIdTagsGet
     */
    readonly tagId?: string;
    /**
     *
     * @type {number}
     * @memberof FaqsApiApiV2FaqsFaqIdTagsGet
     */
    readonly page?: number;
    /**
     *
     * @type {number}
     * @memberof FaqsApiApiV2FaqsFaqIdTagsGet
     */
    readonly limit?: number;
    /**
     *
     * @type {Date}
     * @memberof FaqsApiApiV2FaqsFaqIdTagsGet
     */
    readonly lastRetrieved?: Date;
}
/**
 * Request parameters for apiV2FaqsFaqIdTagsTagIdGet operation in FaqsApi.
 * @export
 * @interface FaqsApiApiV2FaqsFaqIdTagsTagIdGetRequest
 */
export interface FaqsApiApiV2FaqsFaqIdTagsTagIdGetRequest {
    /**
     *
     * @type {string}
     * @memberof FaqsApiApiV2FaqsFaqIdTagsTagIdGet
     */
    readonly faqId: string;
    /**
     *
     * @type {string}
     * @memberof FaqsApiApiV2FaqsFaqIdTagsTagIdGet
     */
    readonly tagId: string;
}
/**
 * Request parameters for apiV2FaqsGet operation in FaqsApi.
 * @export
 * @interface FaqsApiApiV2FaqsGetRequest
 */
export interface FaqsApiApiV2FaqsGetRequest {
    /**
     *
     * @type {string}
     * @memberof FaqsApiApiV2FaqsGet
     */
    readonly id?: string;
    /**
     *
     * @type {string}
     * @memberof FaqsApiApiV2FaqsGet
     */
    readonly name?: string;
    /**
     *
     * @type {string}
     * @memberof FaqsApiApiV2FaqsGet
     */
    readonly slug?: string;
    /**
     *
     * @type {string}
     * @memberof FaqsApiApiV2FaqsGet
     */
    readonly categoryId?: string;
    /**
     *
     * @type {string}
     * @memberof FaqsApiApiV2FaqsGet
     */
    readonly hospitalId?: string;
    /**
     *
     * @type {string}
     * @memberof FaqsApiApiV2FaqsGet
     */
    readonly hospitalName?: string;
    /**
     *
     * @type {string}
     * @memberof FaqsApiApiV2FaqsGet
     */
    readonly languageCode?: string;
    /**
     *
     * @type {boolean}
     * @memberof FaqsApiApiV2FaqsGet
     */
    readonly showHidden?: boolean;
    /**
     *
     * @type {boolean}
     * @memberof FaqsApiApiV2FaqsGet
     */
    readonly returnDefaultValue?: boolean;
    /**
     *
     * @type {number}
     * @memberof FaqsApiApiV2FaqsGet
     */
    readonly page?: number;
    /**
     *
     * @type {number}
     * @memberof FaqsApiApiV2FaqsGet
     */
    readonly limit?: number;
    /**
     *
     * @type {Date}
     * @memberof FaqsApiApiV2FaqsGet
     */
    readonly lastRetrieved?: Date;
}
/**
 * Request parameters for apiV2FaqsSlugGet operation in FaqsApi.
 * @export
 * @interface FaqsApiApiV2FaqsSlugGetRequest
 */
export interface FaqsApiApiV2FaqsSlugGetRequest {
    /**
     *
     * @type {string}
     * @memberof FaqsApiApiV2FaqsSlugGet
     */
    readonly slug: string;
    /**
     *
     * @type {string}
     * @memberof FaqsApiApiV2FaqsSlugGet
     */
    readonly languageCode?: string;
}
/**
 * FaqsApi - object-oriented interface
 * @export
 * @class FaqsApi
 * @extends {BaseAPI}
 */
export declare class FaqsApi extends BaseAPI {
    /**
     *
     * @summary Get faq.
     * @param {FaqsApiApiV2FaqsFaqIdGetRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof FaqsApi
     */
    apiV2FaqsFaqIdGet(requestParameters: FaqsApiApiV2FaqsFaqIdGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FaqModel, any>>;
    /**
     *
     * @summary Get all FaqMedias.
     * @param {FaqsApiApiV2FaqsFaqIdMediasGetRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof FaqsApi
     */
    apiV2FaqsFaqIdMediasGet(requestParameters: FaqsApiApiV2FaqsFaqIdMediasGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<MediasModel, any>>;
    /**
     *
     * @summary Get FaqMedia.
     * @param {FaqsApiApiV2FaqsFaqIdMediasMediaIdGetRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof FaqsApi
     */
    apiV2FaqsFaqIdMediasMediaIdGet(requestParameters: FaqsApiApiV2FaqsFaqIdMediasMediaIdGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<MediaModel, any>>;
    /**
     *
     * @summary GetAll FaqTags.
     * @param {FaqsApiApiV2FaqsFaqIdTagsGetRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof FaqsApi
     */
    apiV2FaqsFaqIdTagsGet(requestParameters: FaqsApiApiV2FaqsFaqIdTagsGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FaqTagsModel, any>>;
    /**
     *
     * @summary Get FaqTag.
     * @param {FaqsApiApiV2FaqsFaqIdTagsTagIdGetRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof FaqsApi
     */
    apiV2FaqsFaqIdTagsTagIdGet(requestParameters: FaqsApiApiV2FaqsFaqIdTagsTagIdGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FaqTagModel, any>>;
    /**
     *
     * @summary Get all Faqs.
     * @param {FaqsApiApiV2FaqsGetRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof FaqsApi
     */
    apiV2FaqsGet(requestParameters?: FaqsApiApiV2FaqsGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FaqsModel, any>>;
    /**
     *
     * @summary Get faq by slug.
     * @param {FaqsApiApiV2FaqsSlugGetRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof FaqsApi
     */
    apiV2FaqsSlugGet(requestParameters: FaqsApiApiV2FaqsSlugGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FaqModel, any>>;
}
//# sourceMappingURL=faqs-api.d.ts.map