ch-api-client-typescript2
Version:
Openapi generated typescript-axios client for CloudHospital
569 lines • 23.5 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 { UserFavoriteDealsModel } from '../models';
import { UserFavoriteDoctorAffiliationsModel } from '../models';
import { UserFavoriteHospitalsModel } from '../models';
import { UserFavoriteModel } from '../models';
/**
* UserFavoritesApi - axios parameter creator
* @export
*/
export declare const UserFavoritesApiAxiosParamCreator: (configuration?: Configuration) => {
/**
*
* @summary Removes a deal from favorite.
* @param {string} dealId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2UserfavoritesDealsDealIdDelete: (dealId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Marks a deal as favorite.
* @param {string} dealId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2UserfavoritesDealsDealIdPost: (dealId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get a list of deals that user marks as favorite.
* @param {string} [languageCode]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2UserfavoritesDealsGet: (languageCode?: string, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Removes a doctor from favorite.
* @param {string} doctorAffiliationId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2UserfavoritesDoctoraffiliationsDoctorAffiliationIdDelete: (doctorAffiliationId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Marks a doctor as favorite.
* @param {string} doctorAffiliationId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2UserfavoritesDoctoraffiliationsDoctorAffiliationIdPost: (doctorAffiliationId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get a list of doctors that user marks as favorite.
* @param {string} [languageCode]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2UserfavoritesDoctoraffiliationsGet: (languageCode?: string, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get user favorites <br>Provides a list of identifiers for all domains the user has marked as favorite.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2UserfavoritesGet: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get a list of hospitals that user marks as favorite.
* @param {string} [languageCode]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2UserfavoritesHospitalsGet: (languageCode?: string, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Removes a hospital from favorite.
* @param {string} hospitalId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2UserfavoritesHospitalsHospitalIdDelete: (hospitalId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Marks a hospital as favorite.
* @param {string} hospitalId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2UserfavoritesHospitalsHospitalIdPost: (hospitalId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* UserFavoritesApi - functional programming interface
* @export
*/
export declare const UserFavoritesApiFp: (configuration?: Configuration) => {
/**
*
* @summary Removes a deal from favorite.
* @param {string} dealId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2UserfavoritesDealsDealIdDelete(dealId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
/**
*
* @summary Marks a deal as favorite.
* @param {string} dealId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2UserfavoritesDealsDealIdPost(dealId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
/**
*
* @summary Get a list of deals that user marks as favorite.
* @param {string} [languageCode]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2UserfavoritesDealsGet(languageCode?: string, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserFavoriteDealsModel>>;
/**
*
* @summary Removes a doctor from favorite.
* @param {string} doctorAffiliationId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2UserfavoritesDoctoraffiliationsDoctorAffiliationIdDelete(doctorAffiliationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
/**
*
* @summary Marks a doctor as favorite.
* @param {string} doctorAffiliationId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2UserfavoritesDoctoraffiliationsDoctorAffiliationIdPost(doctorAffiliationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
/**
*
* @summary Get a list of doctors that user marks as favorite.
* @param {string} [languageCode]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2UserfavoritesDoctoraffiliationsGet(languageCode?: string, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserFavoriteDoctorAffiliationsModel>>;
/**
*
* @summary Get user favorites <br>Provides a list of identifiers for all domains the user has marked as favorite.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2UserfavoritesGet(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserFavoriteModel>>;
/**
*
* @summary Get a list of hospitals that user marks as favorite.
* @param {string} [languageCode]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2UserfavoritesHospitalsGet(languageCode?: string, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserFavoriteHospitalsModel>>;
/**
*
* @summary Removes a hospital from favorite.
* @param {string} hospitalId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2UserfavoritesHospitalsHospitalIdDelete(hospitalId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
/**
*
* @summary Marks a hospital as favorite.
* @param {string} hospitalId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2UserfavoritesHospitalsHospitalIdPost(hospitalId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
};
/**
* UserFavoritesApi - factory interface
* @export
*/
export declare const UserFavoritesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
*
* @summary Removes a deal from favorite.
* @param {string} dealId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2UserfavoritesDealsDealIdDelete(dealId: string, options?: any): AxiosPromise<boolean>;
/**
*
* @summary Marks a deal as favorite.
* @param {string} dealId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2UserfavoritesDealsDealIdPost(dealId: string, options?: any): AxiosPromise<boolean>;
/**
*
* @summary Get a list of deals that user marks as favorite.
* @param {string} [languageCode]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2UserfavoritesDealsGet(languageCode?: string, page?: number, limit?: number, lastRetrieved?: Date, options?: any): AxiosPromise<UserFavoriteDealsModel>;
/**
*
* @summary Removes a doctor from favorite.
* @param {string} doctorAffiliationId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2UserfavoritesDoctoraffiliationsDoctorAffiliationIdDelete(doctorAffiliationId: string, options?: any): AxiosPromise<boolean>;
/**
*
* @summary Marks a doctor as favorite.
* @param {string} doctorAffiliationId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2UserfavoritesDoctoraffiliationsDoctorAffiliationIdPost(doctorAffiliationId: string, options?: any): AxiosPromise<boolean>;
/**
*
* @summary Get a list of doctors that user marks as favorite.
* @param {string} [languageCode]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2UserfavoritesDoctoraffiliationsGet(languageCode?: string, page?: number, limit?: number, lastRetrieved?: Date, options?: any): AxiosPromise<UserFavoriteDoctorAffiliationsModel>;
/**
*
* @summary Get user favorites <br>Provides a list of identifiers for all domains the user has marked as favorite.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2UserfavoritesGet(options?: any): AxiosPromise<UserFavoriteModel>;
/**
*
* @summary Get a list of hospitals that user marks as favorite.
* @param {string} [languageCode]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2UserfavoritesHospitalsGet(languageCode?: string, page?: number, limit?: number, lastRetrieved?: Date, options?: any): AxiosPromise<UserFavoriteHospitalsModel>;
/**
*
* @summary Removes a hospital from favorite.
* @param {string} hospitalId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2UserfavoritesHospitalsHospitalIdDelete(hospitalId: string, options?: any): AxiosPromise<boolean>;
/**
*
* @summary Marks a hospital as favorite.
* @param {string} hospitalId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2UserfavoritesHospitalsHospitalIdPost(hospitalId: string, options?: any): AxiosPromise<boolean>;
};
/**
* Request parameters for apiV2UserfavoritesDealsDealIdDelete operation in UserFavoritesApi.
* @export
* @interface UserFavoritesApiApiV2UserfavoritesDealsDealIdDeleteRequest
*/
export interface UserFavoritesApiApiV2UserfavoritesDealsDealIdDeleteRequest {
/**
*
* @type {string}
* @memberof UserFavoritesApiApiV2UserfavoritesDealsDealIdDelete
*/
readonly dealId: string;
}
/**
* Request parameters for apiV2UserfavoritesDealsDealIdPost operation in UserFavoritesApi.
* @export
* @interface UserFavoritesApiApiV2UserfavoritesDealsDealIdPostRequest
*/
export interface UserFavoritesApiApiV2UserfavoritesDealsDealIdPostRequest {
/**
*
* @type {string}
* @memberof UserFavoritesApiApiV2UserfavoritesDealsDealIdPost
*/
readonly dealId: string;
}
/**
* Request parameters for apiV2UserfavoritesDealsGet operation in UserFavoritesApi.
* @export
* @interface UserFavoritesApiApiV2UserfavoritesDealsGetRequest
*/
export interface UserFavoritesApiApiV2UserfavoritesDealsGetRequest {
/**
*
* @type {string}
* @memberof UserFavoritesApiApiV2UserfavoritesDealsGet
*/
readonly languageCode?: string;
/**
*
* @type {number}
* @memberof UserFavoritesApiApiV2UserfavoritesDealsGet
*/
readonly page?: number;
/**
*
* @type {number}
* @memberof UserFavoritesApiApiV2UserfavoritesDealsGet
*/
readonly limit?: number;
/**
*
* @type {Date}
* @memberof UserFavoritesApiApiV2UserfavoritesDealsGet
*/
readonly lastRetrieved?: Date;
}
/**
* Request parameters for apiV2UserfavoritesDoctoraffiliationsDoctorAffiliationIdDelete operation in UserFavoritesApi.
* @export
* @interface UserFavoritesApiApiV2UserfavoritesDoctoraffiliationsDoctorAffiliationIdDeleteRequest
*/
export interface UserFavoritesApiApiV2UserfavoritesDoctoraffiliationsDoctorAffiliationIdDeleteRequest {
/**
*
* @type {string}
* @memberof UserFavoritesApiApiV2UserfavoritesDoctoraffiliationsDoctorAffiliationIdDelete
*/
readonly doctorAffiliationId: string;
}
/**
* Request parameters for apiV2UserfavoritesDoctoraffiliationsDoctorAffiliationIdPost operation in UserFavoritesApi.
* @export
* @interface UserFavoritesApiApiV2UserfavoritesDoctoraffiliationsDoctorAffiliationIdPostRequest
*/
export interface UserFavoritesApiApiV2UserfavoritesDoctoraffiliationsDoctorAffiliationIdPostRequest {
/**
*
* @type {string}
* @memberof UserFavoritesApiApiV2UserfavoritesDoctoraffiliationsDoctorAffiliationIdPost
*/
readonly doctorAffiliationId: string;
}
/**
* Request parameters for apiV2UserfavoritesDoctoraffiliationsGet operation in UserFavoritesApi.
* @export
* @interface UserFavoritesApiApiV2UserfavoritesDoctoraffiliationsGetRequest
*/
export interface UserFavoritesApiApiV2UserfavoritesDoctoraffiliationsGetRequest {
/**
*
* @type {string}
* @memberof UserFavoritesApiApiV2UserfavoritesDoctoraffiliationsGet
*/
readonly languageCode?: string;
/**
*
* @type {number}
* @memberof UserFavoritesApiApiV2UserfavoritesDoctoraffiliationsGet
*/
readonly page?: number;
/**
*
* @type {number}
* @memberof UserFavoritesApiApiV2UserfavoritesDoctoraffiliationsGet
*/
readonly limit?: number;
/**
*
* @type {Date}
* @memberof UserFavoritesApiApiV2UserfavoritesDoctoraffiliationsGet
*/
readonly lastRetrieved?: Date;
}
/**
* Request parameters for apiV2UserfavoritesHospitalsGet operation in UserFavoritesApi.
* @export
* @interface UserFavoritesApiApiV2UserfavoritesHospitalsGetRequest
*/
export interface UserFavoritesApiApiV2UserfavoritesHospitalsGetRequest {
/**
*
* @type {string}
* @memberof UserFavoritesApiApiV2UserfavoritesHospitalsGet
*/
readonly languageCode?: string;
/**
*
* @type {number}
* @memberof UserFavoritesApiApiV2UserfavoritesHospitalsGet
*/
readonly page?: number;
/**
*
* @type {number}
* @memberof UserFavoritesApiApiV2UserfavoritesHospitalsGet
*/
readonly limit?: number;
/**
*
* @type {Date}
* @memberof UserFavoritesApiApiV2UserfavoritesHospitalsGet
*/
readonly lastRetrieved?: Date;
}
/**
* Request parameters for apiV2UserfavoritesHospitalsHospitalIdDelete operation in UserFavoritesApi.
* @export
* @interface UserFavoritesApiApiV2UserfavoritesHospitalsHospitalIdDeleteRequest
*/
export interface UserFavoritesApiApiV2UserfavoritesHospitalsHospitalIdDeleteRequest {
/**
*
* @type {string}
* @memberof UserFavoritesApiApiV2UserfavoritesHospitalsHospitalIdDelete
*/
readonly hospitalId: string;
}
/**
* Request parameters for apiV2UserfavoritesHospitalsHospitalIdPost operation in UserFavoritesApi.
* @export
* @interface UserFavoritesApiApiV2UserfavoritesHospitalsHospitalIdPostRequest
*/
export interface UserFavoritesApiApiV2UserfavoritesHospitalsHospitalIdPostRequest {
/**
*
* @type {string}
* @memberof UserFavoritesApiApiV2UserfavoritesHospitalsHospitalIdPost
*/
readonly hospitalId: string;
}
/**
* UserFavoritesApi - object-oriented interface
* @export
* @class UserFavoritesApi
* @extends {BaseAPI}
*/
export declare class UserFavoritesApi extends BaseAPI {
/**
*
* @summary Removes a deal from favorite.
* @param {UserFavoritesApiApiV2UserfavoritesDealsDealIdDeleteRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof UserFavoritesApi
*/
apiV2UserfavoritesDealsDealIdDelete(requestParameters: UserFavoritesApiApiV2UserfavoritesDealsDealIdDeleteRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>;
/**
*
* @summary Marks a deal as favorite.
* @param {UserFavoritesApiApiV2UserfavoritesDealsDealIdPostRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof UserFavoritesApi
*/
apiV2UserfavoritesDealsDealIdPost(requestParameters: UserFavoritesApiApiV2UserfavoritesDealsDealIdPostRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>;
/**
*
* @summary Get a list of deals that user marks as favorite.
* @param {UserFavoritesApiApiV2UserfavoritesDealsGetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof UserFavoritesApi
*/
apiV2UserfavoritesDealsGet(requestParameters?: UserFavoritesApiApiV2UserfavoritesDealsGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UserFavoriteDealsModel, any>>;
/**
*
* @summary Removes a doctor from favorite.
* @param {UserFavoritesApiApiV2UserfavoritesDoctoraffiliationsDoctorAffiliationIdDeleteRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof UserFavoritesApi
*/
apiV2UserfavoritesDoctoraffiliationsDoctorAffiliationIdDelete(requestParameters: UserFavoritesApiApiV2UserfavoritesDoctoraffiliationsDoctorAffiliationIdDeleteRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>;
/**
*
* @summary Marks a doctor as favorite.
* @param {UserFavoritesApiApiV2UserfavoritesDoctoraffiliationsDoctorAffiliationIdPostRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof UserFavoritesApi
*/
apiV2UserfavoritesDoctoraffiliationsDoctorAffiliationIdPost(requestParameters: UserFavoritesApiApiV2UserfavoritesDoctoraffiliationsDoctorAffiliationIdPostRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>;
/**
*
* @summary Get a list of doctors that user marks as favorite.
* @param {UserFavoritesApiApiV2UserfavoritesDoctoraffiliationsGetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof UserFavoritesApi
*/
apiV2UserfavoritesDoctoraffiliationsGet(requestParameters?: UserFavoritesApiApiV2UserfavoritesDoctoraffiliationsGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UserFavoriteDoctorAffiliationsModel, any>>;
/**
*
* @summary Get user favorites <br>Provides a list of identifiers for all domains the user has marked as favorite.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof UserFavoritesApi
*/
apiV2UserfavoritesGet(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UserFavoriteModel, any>>;
/**
*
* @summary Get a list of hospitals that user marks as favorite.
* @param {UserFavoritesApiApiV2UserfavoritesHospitalsGetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof UserFavoritesApi
*/
apiV2UserfavoritesHospitalsGet(requestParameters?: UserFavoritesApiApiV2UserfavoritesHospitalsGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UserFavoriteHospitalsModel, any>>;
/**
*
* @summary Removes a hospital from favorite.
* @param {UserFavoritesApiApiV2UserfavoritesHospitalsHospitalIdDeleteRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof UserFavoritesApi
*/
apiV2UserfavoritesHospitalsHospitalIdDelete(requestParameters: UserFavoritesApiApiV2UserfavoritesHospitalsHospitalIdDeleteRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>;
/**
*
* @summary Marks a hospital as favorite.
* @param {UserFavoritesApiApiV2UserfavoritesHospitalsHospitalIdPostRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof UserFavoritesApi
*/
apiV2UserfavoritesHospitalsHospitalIdPost(requestParameters: UserFavoritesApiApiV2UserfavoritesHospitalsHospitalIdPostRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>;
}
//# sourceMappingURL=user-favorites-api.d.ts.map