ch-api-client-typescript2
Version:
Openapi generated typescript-axios client for CloudHospital
1,333 lines • 53.8 kB
TypeScript
/**
* 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 { DealModel } from '../models';
import { DealPackageModel } from '../models';
import { DealPackagesModel } from '../models';
import { DealServiceModel } from '../models';
import { DealServicesModel } from '../models';
import { DealsModel } from '../models';
import { DealsSimpleModel } from '../models';
import { FilterOperator } from '../models';
import { FormResultByHospitalSortingField } from '../models';
import { FormResultStatus } from '../models';
import { FormResultsModel } from '../models';
import { FormTemplateType } from '../models';
import { GetAppointmentTimetablesResponseModel } from '../models';
import { MarketingType } from '../models';
import { SortingDirection } from '../models';
/**
* DealsApi - axios parameter creator
* @export
*/
export declare const DealsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
*
* @summary Get formResults by dealId
* @param {string} dealId
* @param {FormResultByHospitalSortingField} [sortingField]
* @param {SortingDirection} [sortingDirection]
* @param {string} [languageCode]
* @param {Date} [startDate]
* @param {Date} [endDate]
* @param {FormTemplateType} [formTemplateType]
* @param {FormResultStatus} [status]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2DealsDealIdFormresultsGet: (dealId: string, sortingField?: FormResultByHospitalSortingField, sortingDirection?: SortingDirection, languageCode?: string, startDate?: Date, endDate?: Date, formTemplateType?: FormTemplateType, status?: FormResultStatus, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get deal.
* @param {string} dealId
* @param {string} [xCloudhospitalPlatform] Platform identifier from request header
* @param {string} [languageCode] Language code. Accepts either `en` (ISO 639-1 two-letter) or `en-US` (locale) format.
* @param {boolean} [returnDefaultValue]
* @param {string} [countryCode]
* @param {number} [hospitalFaqLimit] Number of hospital FAQ items to return (1-200, default 6).
* @param {number} [platformFaqLimit] Number of platform FAQ items to return (1-200, default 6).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2DealsDealIdGet: (dealId: string, xCloudhospitalPlatform?: string, languageCode?: string, returnDefaultValue?: boolean, countryCode?: string, hospitalFaqLimit?: number, platformFaqLimit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get all DealPackage.
* @param {string} dealId
* @param {string} [relatedDealPackageId]
* @param {string} [dealName]
* @param {string} [name]
* @param {string} [countryId]
* @param {string} [hospitalId]
* @param {string} [hospitalName]
* @param {string} [languageCode]
* @param {boolean} [appointmentChEnabled]
* @param {boolean} [appointmentSaasEnabled]
* @param {boolean} [showHidden]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2DealsDealIdPackagesGet: (dealId: string, relatedDealPackageId?: string, dealName?: string, name?: string, countryId?: string, hospitalId?: string, hospitalName?: string, languageCode?: string, appointmentChEnabled?: boolean, appointmentSaasEnabled?: boolean, showHidden?: boolean, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get DealPackageAppointmentTimetables
* @param {string} dealId
* @param {string} packageId
* @param {number} [year]
* @param {number} [month]
* @param {string} [timeZone]
* @param {boolean} [isExternal]
* @param {boolean} [isOnline]
* @param {string} [appointmentIdExcluded]
* @param {boolean} [excludeUnavailableTimeSlots]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2DealsDealIdPackagesPackageIdAppointmenttimetablesGet: (dealId: string, packageId: string, year?: number, month?: number, timeZone?: string, isExternal?: boolean, isOnline?: boolean, appointmentIdExcluded?: string, excludeUnavailableTimeSlots?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get DealPackage.
* @param {string} dealId
* @param {string} packageId
* @param {string} [languageCode] Language code. Accepts either `en` (ISO 639-1 two-letter) or `en-US` (locale) format.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2DealsDealIdPackagesPackageIdGet: (dealId: string, packageId: string, languageCode?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get all DealService.
* @param {string} dealId
* @param {string} [languageCode]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2DealsDealIdServicesGet: (dealId: string, languageCode?: string, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get DealService.
* @param {string} dealId
* @param {string} serviceId
* @param {string} [languageCode] Language code. Accepts either `en` (ISO 639-1 two-letter) or `en-US` (locale) format.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2DealsDealIdServicesServiceIdGet: (dealId: string, serviceId: string, languageCode?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get all deals.
* @param {string} [xCloudhospitalPlatform] Platform identifier from request header
* @param {string} [id]
* @param {string} [name]
* @param {MarketingType} [marketingType]
* @param {string} [countryId]
* @param {string} [hospitalId]
* @param {string} [hospitalName]
* @param {string} [specialtyId]
* @param {string} [specialtyName]
* @param {string} [specialtyTypeId]
* @param {string} [specialtyTypeName]
* @param {string} [serviceId]
* @param {string} [serviceName]
* @param {string} [exceptHospitalId]
* @param {string} [exceptDealId]
* @param {Array<string>} [ids]
* @param {number} [serviceDuration]
* @param {string} [languageCode]
* @param {boolean} [returnDefaultValue]
* @param {Array<string>} [tags]
* @param {FilterOperator} [tagFilterOperator]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2DealsGet: (xCloudhospitalPlatform?: string, id?: string, name?: string, marketingType?: MarketingType, countryId?: string, hospitalId?: string, hospitalName?: string, specialtyId?: string, specialtyName?: string, specialtyTypeId?: string, specialtyTypeName?: string, serviceId?: string, serviceName?: string, exceptHospitalId?: string, exceptDealId?: string, ids?: Array<string>, serviceDuration?: number, languageCode?: string, returnDefaultValue?: boolean, tags?: Array<string>, tagFilterOperator?: FilterOperator, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get all deals.
* @param {string} [xCloudhospitalPlatform]
* @param {string} [id]
* @param {string} [name]
* @param {MarketingType} [marketingType]
* @param {string} [countryId]
* @param {string} [hospitalId]
* @param {string} [hospitalName]
* @param {string} [specialtyId]
* @param {string} [specialtyName]
* @param {string} [specialtyTypeId]
* @param {string} [specialtyTypeName]
* @param {string} [serviceId]
* @param {string} [serviceName]
* @param {string} [exceptHospitalId]
* @param {string} [exceptDealId]
* @param {Array<string>} [ids]
* @param {number} [serviceDuration]
* @param {string} [languageCode]
* @param {boolean} [returnDefaultValue]
* @param {Array<string>} [tags]
* @param {FilterOperator} [tagFilterOperator]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2DealsSimpleGet: (xCloudhospitalPlatform?: string, id?: string, name?: string, marketingType?: MarketingType, countryId?: string, hospitalId?: string, hospitalName?: string, specialtyId?: string, specialtyName?: string, specialtyTypeId?: string, specialtyTypeName?: string, serviceId?: string, serviceName?: string, exceptHospitalId?: string, exceptDealId?: string, ids?: Array<string>, serviceDuration?: number, languageCode?: string, returnDefaultValue?: boolean, tags?: Array<string>, tagFilterOperator?: FilterOperator, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get deal by slug.
* @param {string} slug
* @param {string} [xCloudhospitalPlatform] Platform identifier from request header
* @param {string} [languageCode] Language code. Accepts either `en` (ISO 639-1 two-letter) or `en-US` (locale) format.
* @param {boolean} [returnDefaultValue]
* @param {string} [previewSecret]
* @param {string} [hospitalId]
* @param {string} [countryCode]
* @param {number} [hospitalFaqLimit] Number of hospital FAQ items to return (1-200, default 6).
* @param {number} [platformFaqLimit] Number of platform FAQ items to return (1-200, default 6).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2DealsSlugGet: (slug: string, xCloudhospitalPlatform?: string, languageCode?: string, returnDefaultValue?: boolean, previewSecret?: string, hospitalId?: string, countryCode?: string, hospitalFaqLimit?: number, platformFaqLimit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* DealsApi - functional programming interface
* @export
*/
export declare const DealsApiFp: (configuration?: Configuration) => {
/**
*
* @summary Get formResults by dealId
* @param {string} dealId
* @param {FormResultByHospitalSortingField} [sortingField]
* @param {SortingDirection} [sortingDirection]
* @param {string} [languageCode]
* @param {Date} [startDate]
* @param {Date} [endDate]
* @param {FormTemplateType} [formTemplateType]
* @param {FormResultStatus} [status]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2DealsDealIdFormresultsGet(dealId: string, sortingField?: FormResultByHospitalSortingField, sortingDirection?: SortingDirection, languageCode?: string, startDate?: Date, endDate?: Date, formTemplateType?: FormTemplateType, status?: FormResultStatus, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FormResultsModel>>;
/**
*
* @summary Get deal.
* @param {string} dealId
* @param {string} [xCloudhospitalPlatform] Platform identifier from request header
* @param {string} [languageCode] Language code. Accepts either `en` (ISO 639-1 two-letter) or `en-US` (locale) format.
* @param {boolean} [returnDefaultValue]
* @param {string} [countryCode]
* @param {number} [hospitalFaqLimit] Number of hospital FAQ items to return (1-200, default 6).
* @param {number} [platformFaqLimit] Number of platform FAQ items to return (1-200, default 6).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2DealsDealIdGet(dealId: string, xCloudhospitalPlatform?: string, languageCode?: string, returnDefaultValue?: boolean, countryCode?: string, hospitalFaqLimit?: number, platformFaqLimit?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DealModel>>;
/**
*
* @summary Get all DealPackage.
* @param {string} dealId
* @param {string} [relatedDealPackageId]
* @param {string} [dealName]
* @param {string} [name]
* @param {string} [countryId]
* @param {string} [hospitalId]
* @param {string} [hospitalName]
* @param {string} [languageCode]
* @param {boolean} [appointmentChEnabled]
* @param {boolean} [appointmentSaasEnabled]
* @param {boolean} [showHidden]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2DealsDealIdPackagesGet(dealId: string, relatedDealPackageId?: string, dealName?: string, name?: string, countryId?: string, hospitalId?: string, hospitalName?: string, languageCode?: string, appointmentChEnabled?: boolean, appointmentSaasEnabled?: boolean, showHidden?: boolean, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DealPackagesModel>>;
/**
*
* @summary Get DealPackageAppointmentTimetables
* @param {string} dealId
* @param {string} packageId
* @param {number} [year]
* @param {number} [month]
* @param {string} [timeZone]
* @param {boolean} [isExternal]
* @param {boolean} [isOnline]
* @param {string} [appointmentIdExcluded]
* @param {boolean} [excludeUnavailableTimeSlots]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2DealsDealIdPackagesPackageIdAppointmenttimetablesGet(dealId: string, packageId: string, year?: number, month?: number, timeZone?: string, isExternal?: boolean, isOnline?: boolean, appointmentIdExcluded?: string, excludeUnavailableTimeSlots?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAppointmentTimetablesResponseModel>>;
/**
*
* @summary Get DealPackage.
* @param {string} dealId
* @param {string} packageId
* @param {string} [languageCode] Language code. Accepts either `en` (ISO 639-1 two-letter) or `en-US` (locale) format.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2DealsDealIdPackagesPackageIdGet(dealId: string, packageId: string, languageCode?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DealPackageModel>>;
/**
*
* @summary Get all DealService.
* @param {string} dealId
* @param {string} [languageCode]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2DealsDealIdServicesGet(dealId: string, languageCode?: string, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DealServicesModel>>;
/**
*
* @summary Get DealService.
* @param {string} dealId
* @param {string} serviceId
* @param {string} [languageCode] Language code. Accepts either `en` (ISO 639-1 two-letter) or `en-US` (locale) format.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2DealsDealIdServicesServiceIdGet(dealId: string, serviceId: string, languageCode?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DealServiceModel>>;
/**
*
* @summary Get all deals.
* @param {string} [xCloudhospitalPlatform] Platform identifier from request header
* @param {string} [id]
* @param {string} [name]
* @param {MarketingType} [marketingType]
* @param {string} [countryId]
* @param {string} [hospitalId]
* @param {string} [hospitalName]
* @param {string} [specialtyId]
* @param {string} [specialtyName]
* @param {string} [specialtyTypeId]
* @param {string} [specialtyTypeName]
* @param {string} [serviceId]
* @param {string} [serviceName]
* @param {string} [exceptHospitalId]
* @param {string} [exceptDealId]
* @param {Array<string>} [ids]
* @param {number} [serviceDuration]
* @param {string} [languageCode]
* @param {boolean} [returnDefaultValue]
* @param {Array<string>} [tags]
* @param {FilterOperator} [tagFilterOperator]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2DealsGet(xCloudhospitalPlatform?: string, id?: string, name?: string, marketingType?: MarketingType, countryId?: string, hospitalId?: string, hospitalName?: string, specialtyId?: string, specialtyName?: string, specialtyTypeId?: string, specialtyTypeName?: string, serviceId?: string, serviceName?: string, exceptHospitalId?: string, exceptDealId?: string, ids?: Array<string>, serviceDuration?: number, languageCode?: string, returnDefaultValue?: boolean, tags?: Array<string>, tagFilterOperator?: FilterOperator, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DealsModel>>;
/**
*
* @summary Get all deals.
* @param {string} [xCloudhospitalPlatform]
* @param {string} [id]
* @param {string} [name]
* @param {MarketingType} [marketingType]
* @param {string} [countryId]
* @param {string} [hospitalId]
* @param {string} [hospitalName]
* @param {string} [specialtyId]
* @param {string} [specialtyName]
* @param {string} [specialtyTypeId]
* @param {string} [specialtyTypeName]
* @param {string} [serviceId]
* @param {string} [serviceName]
* @param {string} [exceptHospitalId]
* @param {string} [exceptDealId]
* @param {Array<string>} [ids]
* @param {number} [serviceDuration]
* @param {string} [languageCode]
* @param {boolean} [returnDefaultValue]
* @param {Array<string>} [tags]
* @param {FilterOperator} [tagFilterOperator]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2DealsSimpleGet(xCloudhospitalPlatform?: string, id?: string, name?: string, marketingType?: MarketingType, countryId?: string, hospitalId?: string, hospitalName?: string, specialtyId?: string, specialtyName?: string, specialtyTypeId?: string, specialtyTypeName?: string, serviceId?: string, serviceName?: string, exceptHospitalId?: string, exceptDealId?: string, ids?: Array<string>, serviceDuration?: number, languageCode?: string, returnDefaultValue?: boolean, tags?: Array<string>, tagFilterOperator?: FilterOperator, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DealsSimpleModel>>;
/**
*
* @summary Get deal by slug.
* @param {string} slug
* @param {string} [xCloudhospitalPlatform] Platform identifier from request header
* @param {string} [languageCode] Language code. Accepts either `en` (ISO 639-1 two-letter) or `en-US` (locale) format.
* @param {boolean} [returnDefaultValue]
* @param {string} [previewSecret]
* @param {string} [hospitalId]
* @param {string} [countryCode]
* @param {number} [hospitalFaqLimit] Number of hospital FAQ items to return (1-200, default 6).
* @param {number} [platformFaqLimit] Number of platform FAQ items to return (1-200, default 6).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2DealsSlugGet(slug: string, xCloudhospitalPlatform?: string, languageCode?: string, returnDefaultValue?: boolean, previewSecret?: string, hospitalId?: string, countryCode?: string, hospitalFaqLimit?: number, platformFaqLimit?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DealModel>>;
};
/**
* DealsApi - factory interface
* @export
*/
export declare const DealsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
*
* @summary Get formResults by dealId
* @param {string} dealId
* @param {FormResultByHospitalSortingField} [sortingField]
* @param {SortingDirection} [sortingDirection]
* @param {string} [languageCode]
* @param {Date} [startDate]
* @param {Date} [endDate]
* @param {FormTemplateType} [formTemplateType]
* @param {FormResultStatus} [status]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2DealsDealIdFormresultsGet(dealId: string, sortingField?: FormResultByHospitalSortingField, sortingDirection?: SortingDirection, languageCode?: string, startDate?: Date, endDate?: Date, formTemplateType?: FormTemplateType, status?: FormResultStatus, page?: number, limit?: number, lastRetrieved?: Date, options?: any): AxiosPromise<FormResultsModel>;
/**
*
* @summary Get deal.
* @param {string} dealId
* @param {string} [xCloudhospitalPlatform] Platform identifier from request header
* @param {string} [languageCode] Language code. Accepts either `en` (ISO 639-1 two-letter) or `en-US` (locale) format.
* @param {boolean} [returnDefaultValue]
* @param {string} [countryCode]
* @param {number} [hospitalFaqLimit] Number of hospital FAQ items to return (1-200, default 6).
* @param {number} [platformFaqLimit] Number of platform FAQ items to return (1-200, default 6).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2DealsDealIdGet(dealId: string, xCloudhospitalPlatform?: string, languageCode?: string, returnDefaultValue?: boolean, countryCode?: string, hospitalFaqLimit?: number, platformFaqLimit?: number, options?: any): AxiosPromise<DealModel>;
/**
*
* @summary Get all DealPackage.
* @param {string} dealId
* @param {string} [relatedDealPackageId]
* @param {string} [dealName]
* @param {string} [name]
* @param {string} [countryId]
* @param {string} [hospitalId]
* @param {string} [hospitalName]
* @param {string} [languageCode]
* @param {boolean} [appointmentChEnabled]
* @param {boolean} [appointmentSaasEnabled]
* @param {boolean} [showHidden]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2DealsDealIdPackagesGet(dealId: string, relatedDealPackageId?: string, dealName?: string, name?: string, countryId?: string, hospitalId?: string, hospitalName?: string, languageCode?: string, appointmentChEnabled?: boolean, appointmentSaasEnabled?: boolean, showHidden?: boolean, page?: number, limit?: number, lastRetrieved?: Date, options?: any): AxiosPromise<DealPackagesModel>;
/**
*
* @summary Get DealPackageAppointmentTimetables
* @param {string} dealId
* @param {string} packageId
* @param {number} [year]
* @param {number} [month]
* @param {string} [timeZone]
* @param {boolean} [isExternal]
* @param {boolean} [isOnline]
* @param {string} [appointmentIdExcluded]
* @param {boolean} [excludeUnavailableTimeSlots]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2DealsDealIdPackagesPackageIdAppointmenttimetablesGet(dealId: string, packageId: string, year?: number, month?: number, timeZone?: string, isExternal?: boolean, isOnline?: boolean, appointmentIdExcluded?: string, excludeUnavailableTimeSlots?: boolean, options?: any): AxiosPromise<GetAppointmentTimetablesResponseModel>;
/**
*
* @summary Get DealPackage.
* @param {string} dealId
* @param {string} packageId
* @param {string} [languageCode] Language code. Accepts either `en` (ISO 639-1 two-letter) or `en-US` (locale) format.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2DealsDealIdPackagesPackageIdGet(dealId: string, packageId: string, languageCode?: string, options?: any): AxiosPromise<DealPackageModel>;
/**
*
* @summary Get all DealService.
* @param {string} dealId
* @param {string} [languageCode]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2DealsDealIdServicesGet(dealId: string, languageCode?: string, page?: number, limit?: number, lastRetrieved?: Date, options?: any): AxiosPromise<DealServicesModel>;
/**
*
* @summary Get DealService.
* @param {string} dealId
* @param {string} serviceId
* @param {string} [languageCode] Language code. Accepts either `en` (ISO 639-1 two-letter) or `en-US` (locale) format.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2DealsDealIdServicesServiceIdGet(dealId: string, serviceId: string, languageCode?: string, options?: any): AxiosPromise<DealServiceModel>;
/**
*
* @summary Get all deals.
* @param {string} [xCloudhospitalPlatform] Platform identifier from request header
* @param {string} [id]
* @param {string} [name]
* @param {MarketingType} [marketingType]
* @param {string} [countryId]
* @param {string} [hospitalId]
* @param {string} [hospitalName]
* @param {string} [specialtyId]
* @param {string} [specialtyName]
* @param {string} [specialtyTypeId]
* @param {string} [specialtyTypeName]
* @param {string} [serviceId]
* @param {string} [serviceName]
* @param {string} [exceptHospitalId]
* @param {string} [exceptDealId]
* @param {Array<string>} [ids]
* @param {number} [serviceDuration]
* @param {string} [languageCode]
* @param {boolean} [returnDefaultValue]
* @param {Array<string>} [tags]
* @param {FilterOperator} [tagFilterOperator]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2DealsGet(xCloudhospitalPlatform?: string, id?: string, name?: string, marketingType?: MarketingType, countryId?: string, hospitalId?: string, hospitalName?: string, specialtyId?: string, specialtyName?: string, specialtyTypeId?: string, specialtyTypeName?: string, serviceId?: string, serviceName?: string, exceptHospitalId?: string, exceptDealId?: string, ids?: Array<string>, serviceDuration?: number, languageCode?: string, returnDefaultValue?: boolean, tags?: Array<string>, tagFilterOperator?: FilterOperator, page?: number, limit?: number, lastRetrieved?: Date, options?: any): AxiosPromise<DealsModel>;
/**
*
* @summary Get all deals.
* @param {string} [xCloudhospitalPlatform]
* @param {string} [id]
* @param {string} [name]
* @param {MarketingType} [marketingType]
* @param {string} [countryId]
* @param {string} [hospitalId]
* @param {string} [hospitalName]
* @param {string} [specialtyId]
* @param {string} [specialtyName]
* @param {string} [specialtyTypeId]
* @param {string} [specialtyTypeName]
* @param {string} [serviceId]
* @param {string} [serviceName]
* @param {string} [exceptHospitalId]
* @param {string} [exceptDealId]
* @param {Array<string>} [ids]
* @param {number} [serviceDuration]
* @param {string} [languageCode]
* @param {boolean} [returnDefaultValue]
* @param {Array<string>} [tags]
* @param {FilterOperator} [tagFilterOperator]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2DealsSimpleGet(xCloudhospitalPlatform?: string, id?: string, name?: string, marketingType?: MarketingType, countryId?: string, hospitalId?: string, hospitalName?: string, specialtyId?: string, specialtyName?: string, specialtyTypeId?: string, specialtyTypeName?: string, serviceId?: string, serviceName?: string, exceptHospitalId?: string, exceptDealId?: string, ids?: Array<string>, serviceDuration?: number, languageCode?: string, returnDefaultValue?: boolean, tags?: Array<string>, tagFilterOperator?: FilterOperator, page?: number, limit?: number, lastRetrieved?: Date, options?: any): AxiosPromise<DealsSimpleModel>;
/**
*
* @summary Get deal by slug.
* @param {string} slug
* @param {string} [xCloudhospitalPlatform] Platform identifier from request header
* @param {string} [languageCode] Language code. Accepts either `en` (ISO 639-1 two-letter) or `en-US` (locale) format.
* @param {boolean} [returnDefaultValue]
* @param {string} [previewSecret]
* @param {string} [hospitalId]
* @param {string} [countryCode]
* @param {number} [hospitalFaqLimit] Number of hospital FAQ items to return (1-200, default 6).
* @param {number} [platformFaqLimit] Number of platform FAQ items to return (1-200, default 6).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2DealsSlugGet(slug: string, xCloudhospitalPlatform?: string, languageCode?: string, returnDefaultValue?: boolean, previewSecret?: string, hospitalId?: string, countryCode?: string, hospitalFaqLimit?: number, platformFaqLimit?: number, options?: any): AxiosPromise<DealModel>;
};
/**
* Request parameters for apiV2DealsDealIdFormresultsGet operation in DealsApi.
* @export
* @interface DealsApiApiV2DealsDealIdFormresultsGetRequest
*/
export interface DealsApiApiV2DealsDealIdFormresultsGetRequest {
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsDealIdFormresultsGet
*/
readonly dealId: string;
/**
*
* @type {FormResultByHospitalSortingField}
* @memberof DealsApiApiV2DealsDealIdFormresultsGet
*/
readonly sortingField?: FormResultByHospitalSortingField;
/**
*
* @type {SortingDirection}
* @memberof DealsApiApiV2DealsDealIdFormresultsGet
*/
readonly sortingDirection?: SortingDirection;
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsDealIdFormresultsGet
*/
readonly languageCode?: string;
/**
*
* @type {Date}
* @memberof DealsApiApiV2DealsDealIdFormresultsGet
*/
readonly startDate?: Date;
/**
*
* @type {Date}
* @memberof DealsApiApiV2DealsDealIdFormresultsGet
*/
readonly endDate?: Date;
/**
*
* @type {FormTemplateType}
* @memberof DealsApiApiV2DealsDealIdFormresultsGet
*/
readonly formTemplateType?: FormTemplateType;
/**
*
* @type {FormResultStatus}
* @memberof DealsApiApiV2DealsDealIdFormresultsGet
*/
readonly status?: FormResultStatus;
/**
*
* @type {number}
* @memberof DealsApiApiV2DealsDealIdFormresultsGet
*/
readonly page?: number;
/**
*
* @type {number}
* @memberof DealsApiApiV2DealsDealIdFormresultsGet
*/
readonly limit?: number;
/**
*
* @type {Date}
* @memberof DealsApiApiV2DealsDealIdFormresultsGet
*/
readonly lastRetrieved?: Date;
}
/**
* Request parameters for apiV2DealsDealIdGet operation in DealsApi.
* @export
* @interface DealsApiApiV2DealsDealIdGetRequest
*/
export interface DealsApiApiV2DealsDealIdGetRequest {
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsDealIdGet
*/
readonly dealId: string;
/**
* Platform identifier from request header
* @type {string}
* @memberof DealsApiApiV2DealsDealIdGet
*/
readonly xCloudhospitalPlatform?: string;
/**
* Language code. Accepts either `en` (ISO 639-1 two-letter) or `en-US` (locale) format.
* @type {string}
* @memberof DealsApiApiV2DealsDealIdGet
*/
readonly languageCode?: string;
/**
*
* @type {boolean}
* @memberof DealsApiApiV2DealsDealIdGet
*/
readonly returnDefaultValue?: boolean;
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsDealIdGet
*/
readonly countryCode?: string;
/**
* Number of hospital FAQ items to return (1-200, default 6).
* @type {number}
* @memberof DealsApiApiV2DealsDealIdGet
*/
readonly hospitalFaqLimit?: number;
/**
* Number of platform FAQ items to return (1-200, default 6).
* @type {number}
* @memberof DealsApiApiV2DealsDealIdGet
*/
readonly platformFaqLimit?: number;
}
/**
* Request parameters for apiV2DealsDealIdPackagesGet operation in DealsApi.
* @export
* @interface DealsApiApiV2DealsDealIdPackagesGetRequest
*/
export interface DealsApiApiV2DealsDealIdPackagesGetRequest {
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsDealIdPackagesGet
*/
readonly dealId: string;
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsDealIdPackagesGet
*/
readonly relatedDealPackageId?: string;
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsDealIdPackagesGet
*/
readonly dealName?: string;
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsDealIdPackagesGet
*/
readonly name?: string;
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsDealIdPackagesGet
*/
readonly countryId?: string;
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsDealIdPackagesGet
*/
readonly hospitalId?: string;
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsDealIdPackagesGet
*/
readonly hospitalName?: string;
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsDealIdPackagesGet
*/
readonly languageCode?: string;
/**
*
* @type {boolean}
* @memberof DealsApiApiV2DealsDealIdPackagesGet
*/
readonly appointmentChEnabled?: boolean;
/**
*
* @type {boolean}
* @memberof DealsApiApiV2DealsDealIdPackagesGet
*/
readonly appointmentSaasEnabled?: boolean;
/**
*
* @type {boolean}
* @memberof DealsApiApiV2DealsDealIdPackagesGet
*/
readonly showHidden?: boolean;
/**
*
* @type {number}
* @memberof DealsApiApiV2DealsDealIdPackagesGet
*/
readonly page?: number;
/**
*
* @type {number}
* @memberof DealsApiApiV2DealsDealIdPackagesGet
*/
readonly limit?: number;
/**
*
* @type {Date}
* @memberof DealsApiApiV2DealsDealIdPackagesGet
*/
readonly lastRetrieved?: Date;
}
/**
* Request parameters for apiV2DealsDealIdPackagesPackageIdAppointmenttimetablesGet operation in DealsApi.
* @export
* @interface DealsApiApiV2DealsDealIdPackagesPackageIdAppointmenttimetablesGetRequest
*/
export interface DealsApiApiV2DealsDealIdPackagesPackageIdAppointmenttimetablesGetRequest {
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsDealIdPackagesPackageIdAppointmenttimetablesGet
*/
readonly dealId: string;
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsDealIdPackagesPackageIdAppointmenttimetablesGet
*/
readonly packageId: string;
/**
*
* @type {number}
* @memberof DealsApiApiV2DealsDealIdPackagesPackageIdAppointmenttimetablesGet
*/
readonly year?: number;
/**
*
* @type {number}
* @memberof DealsApiApiV2DealsDealIdPackagesPackageIdAppointmenttimetablesGet
*/
readonly month?: number;
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsDealIdPackagesPackageIdAppointmenttimetablesGet
*/
readonly timeZone?: string;
/**
*
* @type {boolean}
* @memberof DealsApiApiV2DealsDealIdPackagesPackageIdAppointmenttimetablesGet
*/
readonly isExternal?: boolean;
/**
*
* @type {boolean}
* @memberof DealsApiApiV2DealsDealIdPackagesPackageIdAppointmenttimetablesGet
*/
readonly isOnline?: boolean;
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsDealIdPackagesPackageIdAppointmenttimetablesGet
*/
readonly appointmentIdExcluded?: string;
/**
*
* @type {boolean}
* @memberof DealsApiApiV2DealsDealIdPackagesPackageIdAppointmenttimetablesGet
*/
readonly excludeUnavailableTimeSlots?: boolean;
}
/**
* Request parameters for apiV2DealsDealIdPackagesPackageIdGet operation in DealsApi.
* @export
* @interface DealsApiApiV2DealsDealIdPackagesPackageIdGetRequest
*/
export interface DealsApiApiV2DealsDealIdPackagesPackageIdGetRequest {
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsDealIdPackagesPackageIdGet
*/
readonly dealId: string;
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsDealIdPackagesPackageIdGet
*/
readonly packageId: string;
/**
* Language code. Accepts either `en` (ISO 639-1 two-letter) or `en-US` (locale) format.
* @type {string}
* @memberof DealsApiApiV2DealsDealIdPackagesPackageIdGet
*/
readonly languageCode?: string;
}
/**
* Request parameters for apiV2DealsDealIdServicesGet operation in DealsApi.
* @export
* @interface DealsApiApiV2DealsDealIdServicesGetRequest
*/
export interface DealsApiApiV2DealsDealIdServicesGetRequest {
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsDealIdServicesGet
*/
readonly dealId: string;
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsDealIdServicesGet
*/
readonly languageCode?: string;
/**
*
* @type {number}
* @memberof DealsApiApiV2DealsDealIdServicesGet
*/
readonly page?: number;
/**
*
* @type {number}
* @memberof DealsApiApiV2DealsDealIdServicesGet
*/
readonly limit?: number;
/**
*
* @type {Date}
* @memberof DealsApiApiV2DealsDealIdServicesGet
*/
readonly lastRetrieved?: Date;
}
/**
* Request parameters for apiV2DealsDealIdServicesServiceIdGet operation in DealsApi.
* @export
* @interface DealsApiApiV2DealsDealIdServicesServiceIdGetRequest
*/
export interface DealsApiApiV2DealsDealIdServicesServiceIdGetRequest {
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsDealIdServicesServiceIdGet
*/
readonly dealId: string;
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsDealIdServicesServiceIdGet
*/
readonly serviceId: string;
/**
* Language code. Accepts either `en` (ISO 639-1 two-letter) or `en-US` (locale) format.
* @type {string}
* @memberof DealsApiApiV2DealsDealIdServicesServiceIdGet
*/
readonly languageCode?: string;
}
/**
* Request parameters for apiV2DealsGet operation in DealsApi.
* @export
* @interface DealsApiApiV2DealsGetRequest
*/
export interface DealsApiApiV2DealsGetRequest {
/**
* Platform identifier from request header
* @type {string}
* @memberof DealsApiApiV2DealsGet
*/
readonly xCloudhospitalPlatform?: string;
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsGet
*/
readonly id?: string;
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsGet
*/
readonly name?: string;
/**
*
* @type {MarketingType}
* @memberof DealsApiApiV2DealsGet
*/
readonly marketingType?: MarketingType;
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsGet
*/
readonly countryId?: string;
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsGet
*/
readonly hospitalId?: string;
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsGet
*/
readonly hospitalName?: string;
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsGet
*/
readonly specialtyId?: string;
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsGet
*/
readonly specialtyName?: string;
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsGet
*/
readonly specialtyTypeId?: string;
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsGet
*/
readonly specialtyTypeName?: string;
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsGet
*/
readonly serviceId?: string;
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsGet
*/
readonly serviceName?: string;
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsGet
*/
readonly exceptHospitalId?: string;
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsGet
*/
readonly exceptDealId?: string;
/**
*
* @type {Array<string>}
* @memberof DealsApiApiV2DealsGet
*/
readonly ids?: Array<string>;
/**
*
* @type {number}
* @memberof DealsApiApiV2DealsGet
*/
readonly serviceDuration?: number;
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsGet
*/
readonly languageCode?: string;
/**
*
* @type {boolean}
* @memberof DealsApiApiV2DealsGet
*/
readonly returnDefaultValue?: boolean;
/**
*
* @type {Array<string>}
* @memberof DealsApiApiV2DealsGet
*/
readonly tags?: Array<string>;
/**
*
* @type {FilterOperator}
* @memberof DealsApiApiV2DealsGet
*/
readonly tagFilterOperator?: FilterOperator;
/**
*
* @type {number}
* @memberof DealsApiApiV2DealsGet
*/
readonly page?: number;
/**
*
* @type {number}
* @memberof DealsApiApiV2DealsGet
*/
readonly limit?: number;
/**
*
* @type {Date}
* @memberof DealsApiApiV2DealsGet
*/
readonly lastRetrieved?: Date;
}
/**
* Request parameters for apiV2DealsSimpleGet operation in DealsApi.
* @export
* @interface DealsApiApiV2DealsSimpleGetRequest
*/
export interface DealsApiApiV2DealsSimpleGetRequest {
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsSimpleGet
*/
readonly xCloudhospitalPlatform?: string;
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsSimpleGet
*/
readonly id?: string;
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsSimpleGet
*/
readonly name?: string;
/**
*
* @type {MarketingType}
* @memberof DealsApiApiV2DealsSimpleGet
*/
readonly marketingType?: MarketingType;
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsSimpleGet
*/
readonly countryId?: string;
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsSimpleGet
*/
readonly hospitalId?: string;
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsSimpleGet
*/
readonly hospitalName?: string;
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsSimpleGet
*/
readonly specialtyId?: string;
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsSimpleGet
*/
readonly specialtyName?: string;
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsSimpleGet
*/
readonly specialtyTypeId?: string;
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsSimpleGet
*/
readonly specialtyTypeName?: string;
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsSimpleGet
*/
readonly serviceId?: string;
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsSimpleGet
*/
readonly serviceName?: string;
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsSimpleGet
*/
readonly exceptHospitalId?: string;
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsSimpleGet
*/
readonly exceptDealId?: string;
/**
*
* @type {Array<string>}
* @memberof DealsApiApiV2DealsSimpleGet
*/
readonly ids?: Array<string>;
/**
*
* @type {number}
* @memberof DealsApiApiV2DealsSimpleGet
*/
readonly serviceDuration?: number;
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsSimpleGet
*/
readonly languageCode?: string;
/**
*
* @type {boolean}
* @memberof DealsApiApiV2DealsSimpleGet
*/
readonly returnDefaultValue?: boolean;
/**
*
* @type {Array<string>}
* @memberof DealsApiApiV2DealsSimpleGet
*/
readonly tags?: Array<string>;
/**
*
* @type {FilterOperator}
* @memberof DealsApiApiV2DealsSimpleGet
*/
readonly tagFilterOperator?: FilterOperator;
/**
*
* @type {number}
* @memberof DealsApiApiV2DealsSimpleGet
*/
readonly page?: number;
/**
*
* @type {number}
* @memberof DealsApiApiV2DealsSimpleGet
*/
readonly limit?: number;
/**
*
* @type {Date}
* @memberof DealsApiApiV2DealsSimpleGet
*/
readonly lastRetrieved?: Date;
}
/**
* Request parameters for apiV2DealsSlugGet operation in DealsApi.
* @export
* @interface DealsApiApiV2DealsSlugGetRequest
*/
export interface DealsApiApiV2DealsSlugGetRequest {
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsSlugGet
*/
readonly slug: string;
/**
* Platform identifier from request header
* @type {string}
* @memberof DealsApiApiV2DealsSlugGet
*/
readonly xCloudhospitalPlatform?: string;
/**
* Language code. Accepts either `en` (ISO 639-1 two-letter) or `en-US` (locale) format.
* @type {string}
* @memberof DealsApiApiV2DealsSlugGet
*/
readonly languageCode?: string;
/**
*
* @type {boolean}
* @memberof DealsApiApiV2DealsSlugGet
*/
readonly returnDefaultValue?: boolean;
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsSlugGet
*/
readonly previewSecret?: string;
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsSlugGet
*/
readonly hospitalId?: string;
/**
*
* @type {string}
* @memberof DealsApiApiV2DealsSlugGet
*/
readonly countryCode?: string;
/**
* Number of hospital FAQ items to return (1-200, default 6).
* @type {number}
* @memberof DealsApiApiV2DealsSlugGet
*/
readonly hospitalFaqLimit?: number;
/**
* Number of platform FAQ items to return (1-200, default 6).
* @type {number}
* @memberof DealsApiApiV2DealsSlugGet
*/
readonly platformFaqLimit?: number;
}
/**
* DealsApi - object-oriented interface
* @export
* @class DealsApi
* @extends {BaseAPI}
*/
export declare class DealsApi extends BaseAPI {
/**
*
* @summary Get formResults by dealId
* @param {DealsApiApiV2DealsDealIdFormresultsGetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DealsApi
*/
apiV2DealsDealIdFormresultsGet(requestParameters: DealsApiApiV2DealsDealIdFormresultsGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FormResultsModel, any>>;
/**
*
* @summary Get deal.
* @param {DealsApiApiV2DealsDealIdGetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DealsApi
*/
apiV2DealsDealIdGet(requestParameters: DealsApiApiV2DealsDealIdGetRequest, options?: AxiosRequestConfig): Promise<import("ax