UNPKG

ch-api-client-typescript2

Version:
639 lines 23.1 kB
/** * 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 { MarketingType } from '../models'; import { MediaModel } from '../models'; import { MediaType } from '../models'; import { MediasModel } from '../models'; import { SpecialtiesModel } from '../models'; import { SpecialtiesSimpleModel } from '../models'; import { SpecialtyModel } from '../models'; /** * SpecialtiesApi - axios parameter creator * @export */ export declare const SpecialtiesApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Get all Specialties. * @param {string} [id] * @param {string} [name] * @param {string} [description] * @param {string} [specialtyTypeId] * @param {MarketingType} [marketingType] * @param {string} [hospitalId] * @param {Date} [created] * @param {string} [languageCode] * @param {Array<string>} [ids] * @param {boolean} [returnDefaultValue] * @param {number} [page] * @param {number} [limit] * @param {Date} [lastRetrieved] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiV2SpecialtiesGet: (id?: string, name?: string, description?: string, specialtyTypeId?: string, marketingType?: MarketingType, hospitalId?: string, created?: Date, languageCode?: string, ids?: Array<string>, returnDefaultValue?: boolean, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Get all Specialties Simple. * @param {string} [id] * @param {string} [name] * @param {string} [description] * @param {string} [specialtyTypeId] * @param {MarketingType} [marketingType] * @param {string} [hospitalId] * @param {Date} [created] * @param {string} [languageCode] * @param {Array<string>} [ids] * @param {boolean} [returnDefaultValue] * @param {number} [page] * @param {number} [limit] * @param {Date} [lastRetrieved] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiV2SpecialtiesSimpleGet: (id?: string, name?: string, description?: string, specialtyTypeId?: string, marketingType?: MarketingType, hospitalId?: string, created?: Date, languageCode?: string, ids?: Array<string>, returnDefaultValue?: boolean, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Get specialty by slug * @param {string} slug * @param {string} [languageCode] * @param {boolean} [returnDefaultValue] * @param {string} [previewSecret] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiV2SpecialtiesSlugGet: (slug: string, languageCode?: string, returnDefaultValue?: boolean, previewSecret?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Get specialty by id * @param {string} specialtyId * @param {string} [languageCode] * @param {boolean} [returnDefaultValue] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiV2SpecialtiesSpecialtyIdGet: (specialtyId: string, languageCode?: string, returnDefaultValue?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Get all SpecialtyMedias. * @param {string} specialtyId * @param {string} [id] * @param {MediaType} [mediaType] * @param {number} [page] * @param {number} [limit] * @param {Date} [lastRetrieved] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiV2SpecialtiesSpecialtyIdMediasGet: (specialtyId: string, id?: string, mediaType?: MediaType, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Get SpecialtyMedia. * @param {string} specialtyId * @param {string} mediaId * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiV2SpecialtiesSpecialtyIdMediasMediaIdGet: (specialtyId: string, mediaId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>; }; /** * SpecialtiesApi - functional programming interface * @export */ export declare const SpecialtiesApiFp: (configuration?: Configuration) => { /** * * @summary Get all Specialties. * @param {string} [id] * @param {string} [name] * @param {string} [description] * @param {string} [specialtyTypeId] * @param {MarketingType} [marketingType] * @param {string} [hospitalId] * @param {Date} [created] * @param {string} [languageCode] * @param {Array<string>} [ids] * @param {boolean} [returnDefaultValue] * @param {number} [page] * @param {number} [limit] * @param {Date} [lastRetrieved] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiV2SpecialtiesGet(id?: string, name?: string, description?: string, specialtyTypeId?: string, marketingType?: MarketingType, hospitalId?: string, created?: Date, languageCode?: string, ids?: Array<string>, returnDefaultValue?: boolean, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SpecialtiesModel>>; /** * * @summary Get all Specialties Simple. * @param {string} [id] * @param {string} [name] * @param {string} [description] * @param {string} [specialtyTypeId] * @param {MarketingType} [marketingType] * @param {string} [hospitalId] * @param {Date} [created] * @param {string} [languageCode] * @param {Array<string>} [ids] * @param {boolean} [returnDefaultValue] * @param {number} [page] * @param {number} [limit] * @param {Date} [lastRetrieved] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiV2SpecialtiesSimpleGet(id?: string, name?: string, description?: string, specialtyTypeId?: string, marketingType?: MarketingType, hospitalId?: string, created?: Date, languageCode?: string, ids?: Array<string>, returnDefaultValue?: boolean, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SpecialtiesSimpleModel>>; /** * * @summary Get specialty by slug * @param {string} slug * @param {string} [languageCode] * @param {boolean} [returnDefaultValue] * @param {string} [previewSecret] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiV2SpecialtiesSlugGet(slug: string, languageCode?: string, returnDefaultValue?: boolean, previewSecret?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SpecialtyModel>>; /** * * @summary Get specialty by id * @param {string} specialtyId * @param {string} [languageCode] * @param {boolean} [returnDefaultValue] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiV2SpecialtiesSpecialtyIdGet(specialtyId: string, languageCode?: string, returnDefaultValue?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SpecialtyModel>>; /** * * @summary Get all SpecialtyMedias. * @param {string} specialtyId * @param {string} [id] * @param {MediaType} [mediaType] * @param {number} [page] * @param {number} [limit] * @param {Date} [lastRetrieved] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiV2SpecialtiesSpecialtyIdMediasGet(specialtyId: string, id?: string, mediaType?: MediaType, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MediasModel>>; /** * * @summary Get SpecialtyMedia. * @param {string} specialtyId * @param {string} mediaId * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiV2SpecialtiesSpecialtyIdMediasMediaIdGet(specialtyId: string, mediaId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MediaModel>>; }; /** * SpecialtiesApi - factory interface * @export */ export declare const SpecialtiesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Get all Specialties. * @param {string} [id] * @param {string} [name] * @param {string} [description] * @param {string} [specialtyTypeId] * @param {MarketingType} [marketingType] * @param {string} [hospitalId] * @param {Date} [created] * @param {string} [languageCode] * @param {Array<string>} [ids] * @param {boolean} [returnDefaultValue] * @param {number} [page] * @param {number} [limit] * @param {Date} [lastRetrieved] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiV2SpecialtiesGet(id?: string, name?: string, description?: string, specialtyTypeId?: string, marketingType?: MarketingType, hospitalId?: string, created?: Date, languageCode?: string, ids?: Array<string>, returnDefaultValue?: boolean, page?: number, limit?: number, lastRetrieved?: Date, options?: any): AxiosPromise<SpecialtiesModel>; /** * * @summary Get all Specialties Simple. * @param {string} [id] * @param {string} [name] * @param {string} [description] * @param {string} [specialtyTypeId] * @param {MarketingType} [marketingType] * @param {string} [hospitalId] * @param {Date} [created] * @param {string} [languageCode] * @param {Array<string>} [ids] * @param {boolean} [returnDefaultValue] * @param {number} [page] * @param {number} [limit] * @param {Date} [lastRetrieved] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiV2SpecialtiesSimpleGet(id?: string, name?: string, description?: string, specialtyTypeId?: string, marketingType?: MarketingType, hospitalId?: string, created?: Date, languageCode?: string, ids?: Array<string>, returnDefaultValue?: boolean, page?: number, limit?: number, lastRetrieved?: Date, options?: any): AxiosPromise<SpecialtiesSimpleModel>; /** * * @summary Get specialty by slug * @param {string} slug * @param {string} [languageCode] * @param {boolean} [returnDefaultValue] * @param {string} [previewSecret] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiV2SpecialtiesSlugGet(slug: string, languageCode?: string, returnDefaultValue?: boolean, previewSecret?: string, options?: any): AxiosPromise<SpecialtyModel>; /** * * @summary Get specialty by id * @param {string} specialtyId * @param {string} [languageCode] * @param {boolean} [returnDefaultValue] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiV2SpecialtiesSpecialtyIdGet(specialtyId: string, languageCode?: string, returnDefaultValue?: boolean, options?: any): AxiosPromise<SpecialtyModel>; /** * * @summary Get all SpecialtyMedias. * @param {string} specialtyId * @param {string} [id] * @param {MediaType} [mediaType] * @param {number} [page] * @param {number} [limit] * @param {Date} [lastRetrieved] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiV2SpecialtiesSpecialtyIdMediasGet(specialtyId: string, id?: string, mediaType?: MediaType, page?: number, limit?: number, lastRetrieved?: Date, options?: any): AxiosPromise<MediasModel>; /** * * @summary Get SpecialtyMedia. * @param {string} specialtyId * @param {string} mediaId * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiV2SpecialtiesSpecialtyIdMediasMediaIdGet(specialtyId: string, mediaId: string, options?: any): AxiosPromise<MediaModel>; }; /** * Request parameters for apiV2SpecialtiesGet operation in SpecialtiesApi. * @export * @interface SpecialtiesApiApiV2SpecialtiesGetRequest */ export interface SpecialtiesApiApiV2SpecialtiesGetRequest { /** * * @type {string} * @memberof SpecialtiesApiApiV2SpecialtiesGet */ readonly id?: string; /** * * @type {string} * @memberof SpecialtiesApiApiV2SpecialtiesGet */ readonly name?: string; /** * * @type {string} * @memberof SpecialtiesApiApiV2SpecialtiesGet */ readonly description?: string; /** * * @type {string} * @memberof SpecialtiesApiApiV2SpecialtiesGet */ readonly specialtyTypeId?: string; /** * * @type {MarketingType} * @memberof SpecialtiesApiApiV2SpecialtiesGet */ readonly marketingType?: MarketingType; /** * * @type {string} * @memberof SpecialtiesApiApiV2SpecialtiesGet */ readonly hospitalId?: string; /** * * @type {Date} * @memberof SpecialtiesApiApiV2SpecialtiesGet */ readonly created?: Date; /** * * @type {string} * @memberof SpecialtiesApiApiV2SpecialtiesGet */ readonly languageCode?: string; /** * * @type {Array<string>} * @memberof SpecialtiesApiApiV2SpecialtiesGet */ readonly ids?: Array<string>; /** * * @type {boolean} * @memberof SpecialtiesApiApiV2SpecialtiesGet */ readonly returnDefaultValue?: boolean; /** * * @type {number} * @memberof SpecialtiesApiApiV2SpecialtiesGet */ readonly page?: number; /** * * @type {number} * @memberof SpecialtiesApiApiV2SpecialtiesGet */ readonly limit?: number; /** * * @type {Date} * @memberof SpecialtiesApiApiV2SpecialtiesGet */ readonly lastRetrieved?: Date; } /** * Request parameters for apiV2SpecialtiesSimpleGet operation in SpecialtiesApi. * @export * @interface SpecialtiesApiApiV2SpecialtiesSimpleGetRequest */ export interface SpecialtiesApiApiV2SpecialtiesSimpleGetRequest { /** * * @type {string} * @memberof SpecialtiesApiApiV2SpecialtiesSimpleGet */ readonly id?: string; /** * * @type {string} * @memberof SpecialtiesApiApiV2SpecialtiesSimpleGet */ readonly name?: string; /** * * @type {string} * @memberof SpecialtiesApiApiV2SpecialtiesSimpleGet */ readonly description?: string; /** * * @type {string} * @memberof SpecialtiesApiApiV2SpecialtiesSimpleGet */ readonly specialtyTypeId?: string; /** * * @type {MarketingType} * @memberof SpecialtiesApiApiV2SpecialtiesSimpleGet */ readonly marketingType?: MarketingType; /** * * @type {string} * @memberof SpecialtiesApiApiV2SpecialtiesSimpleGet */ readonly hospitalId?: string; /** * * @type {Date} * @memberof SpecialtiesApiApiV2SpecialtiesSimpleGet */ readonly created?: Date; /** * * @type {string} * @memberof SpecialtiesApiApiV2SpecialtiesSimpleGet */ readonly languageCode?: string; /** * * @type {Array<string>} * @memberof SpecialtiesApiApiV2SpecialtiesSimpleGet */ readonly ids?: Array<string>; /** * * @type {boolean} * @memberof SpecialtiesApiApiV2SpecialtiesSimpleGet */ readonly returnDefaultValue?: boolean; /** * * @type {number} * @memberof SpecialtiesApiApiV2SpecialtiesSimpleGet */ readonly page?: number; /** * * @type {number} * @memberof SpecialtiesApiApiV2SpecialtiesSimpleGet */ readonly limit?: number; /** * * @type {Date} * @memberof SpecialtiesApiApiV2SpecialtiesSimpleGet */ readonly lastRetrieved?: Date; } /** * Request parameters for apiV2SpecialtiesSlugGet operation in SpecialtiesApi. * @export * @interface SpecialtiesApiApiV2SpecialtiesSlugGetRequest */ export interface SpecialtiesApiApiV2SpecialtiesSlugGetRequest { /** * * @type {string} * @memberof SpecialtiesApiApiV2SpecialtiesSlugGet */ readonly slug: string; /** * * @type {string} * @memberof SpecialtiesApiApiV2SpecialtiesSlugGet */ readonly languageCode?: string; /** * * @type {boolean} * @memberof SpecialtiesApiApiV2SpecialtiesSlugGet */ readonly returnDefaultValue?: boolean; /** * * @type {string} * @memberof SpecialtiesApiApiV2SpecialtiesSlugGet */ readonly previewSecret?: string; } /** * Request parameters for apiV2SpecialtiesSpecialtyIdGet operation in SpecialtiesApi. * @export * @interface SpecialtiesApiApiV2SpecialtiesSpecialtyIdGetRequest */ export interface SpecialtiesApiApiV2SpecialtiesSpecialtyIdGetRequest { /** * * @type {string} * @memberof SpecialtiesApiApiV2SpecialtiesSpecialtyIdGet */ readonly specialtyId: string; /** * * @type {string} * @memberof SpecialtiesApiApiV2SpecialtiesSpecialtyIdGet */ readonly languageCode?: string; /** * * @type {boolean} * @memberof SpecialtiesApiApiV2SpecialtiesSpecialtyIdGet */ readonly returnDefaultValue?: boolean; } /** * Request parameters for apiV2SpecialtiesSpecialtyIdMediasGet operation in SpecialtiesApi. * @export * @interface SpecialtiesApiApiV2SpecialtiesSpecialtyIdMediasGetRequest */ export interface SpecialtiesApiApiV2SpecialtiesSpecialtyIdMediasGetRequest { /** * * @type {string} * @memberof SpecialtiesApiApiV2SpecialtiesSpecialtyIdMediasGet */ readonly specialtyId: string; /** * * @type {string} * @memberof SpecialtiesApiApiV2SpecialtiesSpecialtyIdMediasGet */ readonly id?: string; /** * * @type {MediaType} * @memberof SpecialtiesApiApiV2SpecialtiesSpecialtyIdMediasGet */ readonly mediaType?: MediaType; /** * * @type {number} * @memberof SpecialtiesApiApiV2SpecialtiesSpecialtyIdMediasGet */ readonly page?: number; /** * * @type {number} * @memberof SpecialtiesApiApiV2SpecialtiesSpecialtyIdMediasGet */ readonly limit?: number; /** * * @type {Date} * @memberof SpecialtiesApiApiV2SpecialtiesSpecialtyIdMediasGet */ readonly lastRetrieved?: Date; } /** * Request parameters for apiV2SpecialtiesSpecialtyIdMediasMediaIdGet operation in SpecialtiesApi. * @export * @interface SpecialtiesApiApiV2SpecialtiesSpecialtyIdMediasMediaIdGetRequest */ export interface SpecialtiesApiApiV2SpecialtiesSpecialtyIdMediasMediaIdGetRequest { /** * * @type {string} * @memberof SpecialtiesApiApiV2SpecialtiesSpecialtyIdMediasMediaIdGet */ readonly specialtyId: string; /** * * @type {string} * @memberof SpecialtiesApiApiV2SpecialtiesSpecialtyIdMediasMediaIdGet */ readonly mediaId: string; } /** * SpecialtiesApi - object-oriented interface * @export * @class SpecialtiesApi * @extends {BaseAPI} */ export declare class SpecialtiesApi extends BaseAPI { /** * * @summary Get all Specialties. * @param {SpecialtiesApiApiV2SpecialtiesGetRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SpecialtiesApi */ apiV2SpecialtiesGet(requestParameters?: SpecialtiesApiApiV2SpecialtiesGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SpecialtiesModel, any>>; /** * * @summary Get all Specialties Simple. * @param {SpecialtiesApiApiV2SpecialtiesSimpleGetRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SpecialtiesApi */ apiV2SpecialtiesSimpleGet(requestParameters?: SpecialtiesApiApiV2SpecialtiesSimpleGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SpecialtiesSimpleModel, any>>; /** * * @summary Get specialty by slug * @param {SpecialtiesApiApiV2SpecialtiesSlugGetRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SpecialtiesApi */ apiV2SpecialtiesSlugGet(requestParameters: SpecialtiesApiApiV2SpecialtiesSlugGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SpecialtyModel, any>>; /** * * @summary Get specialty by id * @param {SpecialtiesApiApiV2SpecialtiesSpecialtyIdGetRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SpecialtiesApi */ apiV2SpecialtiesSpecialtyIdGet(requestParameters: SpecialtiesApiApiV2SpecialtiesSpecialtyIdGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SpecialtyModel, any>>; /** * * @summary Get all SpecialtyMedias. * @param {SpecialtiesApiApiV2SpecialtiesSpecialtyIdMediasGetRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SpecialtiesApi */ apiV2SpecialtiesSpecialtyIdMediasGet(requestParameters: SpecialtiesApiApiV2SpecialtiesSpecialtyIdMediasGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<MediasModel, any>>; /** * * @summary Get SpecialtyMedia. * @param {SpecialtiesApiApiV2SpecialtiesSpecialtyIdMediasMediaIdGetRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SpecialtiesApi */ apiV2SpecialtiesSpecialtyIdMediasMediaIdGet(requestParameters: SpecialtiesApiApiV2SpecialtiesSpecialtyIdMediasMediaIdGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<MediaModel, any>>; } //# sourceMappingURL=specialties-api.d.ts.map