ch-api-client-typescript2
Version:
Openapi generated typescript-axios client for CloudHospital
435 lines • 15.9 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 { HospitalServiceModel } from '../models';
import { HospitalServicesModel } from '../models';
import { MarketingType } from '../models';
import { Procedure } from '../models';
/**
* ServicesApi - axios parameter creator
* @export
*/
export declare const ServicesApiAxiosParamCreator: (configuration?: Configuration) => {
/**
*
* @summary Get all HospitalServices.
* @param {string} [xCloudhospitalPlatform] Platform identifier from request header
* @param {string} [id]
* @param {string} [name]
* @param {string} [slug]
* @param {string} [hospitalId]
* @param {string} [hospitalName]
* @param {string} [hospitalSlug]
* @param {string} [specialtyId]
* @param {string} [specialtyName]
* @param {string} [specialtyTypeId]
* @param {string} [specialtyTypeName]
* @param {string} [serviceCategoryId]
* @param {boolean} [appointmentEnabled]
* @param {MarketingType} [marketingType]
* @param {Procedure} [procedure]
* @param {Date} [created]
* @param {string} [languageCode]
* @param {boolean} [returnDefaultValue]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2ServicesGet: (xCloudhospitalPlatform?: string, id?: string, name?: string, slug?: string, hospitalId?: string, hospitalName?: string, hospitalSlug?: string, specialtyId?: string, specialtyName?: string, specialtyTypeId?: string, specialtyTypeName?: string, serviceCategoryId?: string, appointmentEnabled?: boolean, marketingType?: MarketingType, procedure?: Procedure, created?: Date, languageCode?: string, returnDefaultValue?: boolean, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get Hospital service by id
* @param {string} serviceId
* @param {string} [xCloudhospitalPlatform] Platform identifier from request header
* @param {string} [languageCode]
* @param {boolean} [returnDefaultValue]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2ServicesServiceIdGet: (serviceId: string, xCloudhospitalPlatform?: string, languageCode?: string, returnDefaultValue?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get Hospital service by slug
* @param {string} slug
* @param {string} [xCloudhospitalPlatform] Platform identifier from request header
* @param {string} [hospitalId]
* @param {string} [languageCode]
* @param {boolean} [returnDefaultValue]
* @param {string} [previewSecret]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2ServicesSlugGet: (slug: string, xCloudhospitalPlatform?: string, hospitalId?: string, languageCode?: string, returnDefaultValue?: boolean, previewSecret?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* ServicesApi - functional programming interface
* @export
*/
export declare const ServicesApiFp: (configuration?: Configuration) => {
/**
*
* @summary Get all HospitalServices.
* @param {string} [xCloudhospitalPlatform] Platform identifier from request header
* @param {string} [id]
* @param {string} [name]
* @param {string} [slug]
* @param {string} [hospitalId]
* @param {string} [hospitalName]
* @param {string} [hospitalSlug]
* @param {string} [specialtyId]
* @param {string} [specialtyName]
* @param {string} [specialtyTypeId]
* @param {string} [specialtyTypeName]
* @param {string} [serviceCategoryId]
* @param {boolean} [appointmentEnabled]
* @param {MarketingType} [marketingType]
* @param {Procedure} [procedure]
* @param {Date} [created]
* @param {string} [languageCode]
* @param {boolean} [returnDefaultValue]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2ServicesGet(xCloudhospitalPlatform?: string, id?: string, name?: string, slug?: string, hospitalId?: string, hospitalName?: string, hospitalSlug?: string, specialtyId?: string, specialtyName?: string, specialtyTypeId?: string, specialtyTypeName?: string, serviceCategoryId?: string, appointmentEnabled?: boolean, marketingType?: MarketingType, procedure?: Procedure, created?: Date, languageCode?: string, returnDefaultValue?: boolean, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<HospitalServicesModel>>;
/**
*
* @summary Get Hospital service by id
* @param {string} serviceId
* @param {string} [xCloudhospitalPlatform] Platform identifier from request header
* @param {string} [languageCode]
* @param {boolean} [returnDefaultValue]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2ServicesServiceIdGet(serviceId: string, xCloudhospitalPlatform?: string, languageCode?: string, returnDefaultValue?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<HospitalServiceModel>>;
/**
*
* @summary Get Hospital service by slug
* @param {string} slug
* @param {string} [xCloudhospitalPlatform] Platform identifier from request header
* @param {string} [hospitalId]
* @param {string} [languageCode]
* @param {boolean} [returnDefaultValue]
* @param {string} [previewSecret]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2ServicesSlugGet(slug: string, xCloudhospitalPlatform?: string, hospitalId?: string, languageCode?: string, returnDefaultValue?: boolean, previewSecret?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<HospitalServiceModel>>;
};
/**
* ServicesApi - factory interface
* @export
*/
export declare const ServicesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
*
* @summary Get all HospitalServices.
* @param {string} [xCloudhospitalPlatform] Platform identifier from request header
* @param {string} [id]
* @param {string} [name]
* @param {string} [slug]
* @param {string} [hospitalId]
* @param {string} [hospitalName]
* @param {string} [hospitalSlug]
* @param {string} [specialtyId]
* @param {string} [specialtyName]
* @param {string} [specialtyTypeId]
* @param {string} [specialtyTypeName]
* @param {string} [serviceCategoryId]
* @param {boolean} [appointmentEnabled]
* @param {MarketingType} [marketingType]
* @param {Procedure} [procedure]
* @param {Date} [created]
* @param {string} [languageCode]
* @param {boolean} [returnDefaultValue]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2ServicesGet(xCloudhospitalPlatform?: string, id?: string, name?: string, slug?: string, hospitalId?: string, hospitalName?: string, hospitalSlug?: string, specialtyId?: string, specialtyName?: string, specialtyTypeId?: string, specialtyTypeName?: string, serviceCategoryId?: string, appointmentEnabled?: boolean, marketingType?: MarketingType, procedure?: Procedure, created?: Date, languageCode?: string, returnDefaultValue?: boolean, page?: number, limit?: number, lastRetrieved?: Date, options?: any): AxiosPromise<HospitalServicesModel>;
/**
*
* @summary Get Hospital service by id
* @param {string} serviceId
* @param {string} [xCloudhospitalPlatform] Platform identifier from request header
* @param {string} [languageCode]
* @param {boolean} [returnDefaultValue]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2ServicesServiceIdGet(serviceId: string, xCloudhospitalPlatform?: string, languageCode?: string, returnDefaultValue?: boolean, options?: any): AxiosPromise<HospitalServiceModel>;
/**
*
* @summary Get Hospital service by slug
* @param {string} slug
* @param {string} [xCloudhospitalPlatform] Platform identifier from request header
* @param {string} [hospitalId]
* @param {string} [languageCode]
* @param {boolean} [returnDefaultValue]
* @param {string} [previewSecret]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2ServicesSlugGet(slug: string, xCloudhospitalPlatform?: string, hospitalId?: string, languageCode?: string, returnDefaultValue?: boolean, previewSecret?: string, options?: any): AxiosPromise<HospitalServiceModel>;
};
/**
* Request parameters for apiV2ServicesGet operation in ServicesApi.
* @export
* @interface ServicesApiApiV2ServicesGetRequest
*/
export interface ServicesApiApiV2ServicesGetRequest {
/**
* Platform identifier from request header
* @type {string}
* @memberof ServicesApiApiV2ServicesGet
*/
readonly xCloudhospitalPlatform?: string;
/**
*
* @type {string}
* @memberof ServicesApiApiV2ServicesGet
*/
readonly id?: string;
/**
*
* @type {string}
* @memberof ServicesApiApiV2ServicesGet
*/
readonly name?: string;
/**
*
* @type {string}
* @memberof ServicesApiApiV2ServicesGet
*/
readonly slug?: string;
/**
*
* @type {string}
* @memberof ServicesApiApiV2ServicesGet
*/
readonly hospitalId?: string;
/**
*
* @type {string}
* @memberof ServicesApiApiV2ServicesGet
*/
readonly hospitalName?: string;
/**
*
* @type {string}
* @memberof ServicesApiApiV2ServicesGet
*/
readonly hospitalSlug?: string;
/**
*
* @type {string}
* @memberof ServicesApiApiV2ServicesGet
*/
readonly specialtyId?: string;
/**
*
* @type {string}
* @memberof ServicesApiApiV2ServicesGet
*/
readonly specialtyName?: string;
/**
*
* @type {string}
* @memberof ServicesApiApiV2ServicesGet
*/
readonly specialtyTypeId?: string;
/**
*
* @type {string}
* @memberof ServicesApiApiV2ServicesGet
*/
readonly specialtyTypeName?: string;
/**
*
* @type {string}
* @memberof ServicesApiApiV2ServicesGet
*/
readonly serviceCategoryId?: string;
/**
*
* @type {boolean}
* @memberof ServicesApiApiV2ServicesGet
*/
readonly appointmentEnabled?: boolean;
/**
*
* @type {MarketingType}
* @memberof ServicesApiApiV2ServicesGet
*/
readonly marketingType?: MarketingType;
/**
*
* @type {Procedure}
* @memberof ServicesApiApiV2ServicesGet
*/
readonly procedure?: Procedure;
/**
*
* @type {Date}
* @memberof ServicesApiApiV2ServicesGet
*/
readonly created?: Date;
/**
*
* @type {string}
* @memberof ServicesApiApiV2ServicesGet
*/
readonly languageCode?: string;
/**
*
* @type {boolean}
* @memberof ServicesApiApiV2ServicesGet
*/
readonly returnDefaultValue?: boolean;
/**
*
* @type {number}
* @memberof ServicesApiApiV2ServicesGet
*/
readonly page?: number;
/**
*
* @type {number}
* @memberof ServicesApiApiV2ServicesGet
*/
readonly limit?: number;
/**
*
* @type {Date}
* @memberof ServicesApiApiV2ServicesGet
*/
readonly lastRetrieved?: Date;
}
/**
* Request parameters for apiV2ServicesServiceIdGet operation in ServicesApi.
* @export
* @interface ServicesApiApiV2ServicesServiceIdGetRequest
*/
export interface ServicesApiApiV2ServicesServiceIdGetRequest {
/**
*
* @type {string}
* @memberof ServicesApiApiV2ServicesServiceIdGet
*/
readonly serviceId: string;
/**
* Platform identifier from request header
* @type {string}
* @memberof ServicesApiApiV2ServicesServiceIdGet
*/
readonly xCloudhospitalPlatform?: string;
/**
*
* @type {string}
* @memberof ServicesApiApiV2ServicesServiceIdGet
*/
readonly languageCode?: string;
/**
*
* @type {boolean}
* @memberof ServicesApiApiV2ServicesServiceIdGet
*/
readonly returnDefaultValue?: boolean;
}
/**
* Request parameters for apiV2ServicesSlugGet operation in ServicesApi.
* @export
* @interface ServicesApiApiV2ServicesSlugGetRequest
*/
export interface ServicesApiApiV2ServicesSlugGetRequest {
/**
*
* @type {string}
* @memberof ServicesApiApiV2ServicesSlugGet
*/
readonly slug: string;
/**
* Platform identifier from request header
* @type {string}
* @memberof ServicesApiApiV2ServicesSlugGet
*/
readonly xCloudhospitalPlatform?: string;
/**
*
* @type {string}
* @memberof ServicesApiApiV2ServicesSlugGet
*/
readonly hospitalId?: string;
/**
*
* @type {string}
* @memberof ServicesApiApiV2ServicesSlugGet
*/
readonly languageCode?: string;
/**
*
* @type {boolean}
* @memberof ServicesApiApiV2ServicesSlugGet
*/
readonly returnDefaultValue?: boolean;
/**
*
* @type {string}
* @memberof ServicesApiApiV2ServicesSlugGet
*/
readonly previewSecret?: string;
}
/**
* ServicesApi - object-oriented interface
* @export
* @class ServicesApi
* @extends {BaseAPI}
*/
export declare class ServicesApi extends BaseAPI {
/**
*
* @summary Get all HospitalServices.
* @param {ServicesApiApiV2ServicesGetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ServicesApi
*/
apiV2ServicesGet(requestParameters?: ServicesApiApiV2ServicesGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<HospitalServicesModel, any>>;
/**
*
* @summary Get Hospital service by id
* @param {ServicesApiApiV2ServicesServiceIdGetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ServicesApi
*/
apiV2ServicesServiceIdGet(requestParameters: ServicesApiApiV2ServicesServiceIdGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<HospitalServiceModel, any>>;
/**
*
* @summary Get Hospital service by slug
* @param {ServicesApiApiV2ServicesSlugGetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ServicesApi
*/
apiV2ServicesSlugGet(requestParameters: ServicesApiApiV2ServicesSlugGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<HospitalServiceModel, any>>;
}
//# sourceMappingURL=services-api.d.ts.map