ch-api-client-typescript2/lib/api/devices-api.d.ts

Openapi generated typescript-axios client for CloudHospital

/**
 * CloudHospital Api
 * CloudHospital application with Swagger, Swashbuckle, and API versioning.
 *
 * The version of the OpenAPI document: 2
 * Contact: developer@icloudhospital.com
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
import { Configuration } from '../configuration';
import { RequestArgs, BaseAPI } from '../base';
import { CreateDeviceCommand } from '../models';
import { DeviceModel } from '../models';
import { DevicesModel } from '../models';
import { Platform } from '../models';
import { UpdateDeviceCommand } from '../models';
/**
 * DevicesApi - axios parameter creator
 * @export
 */
export declare const DevicesApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *
     * @summary Get all devices.
     * @param {string} [id]
     * @param {string} [token]
     * @param {Platform} [platform]
     * @param {boolean} [appAlert]
     * @param {boolean} [eventAlert]
     * @param {boolean} [noticeAlert]
     * @param {number} [page]
     * @param {number} [limit]
     * @param {Date} [lastRetrieved]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2DevicesGet: (id?: string, token?: string, platform?: Platform, appAlert?: boolean, eventAlert?: boolean, noticeAlert?: boolean, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Delete device.
     * @param {string} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2DevicesIdDelete: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get device.
     * @param {string} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2DevicesIdGet: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Update device.
     * @param {string} id
     * @param {UpdateDeviceCommand} [updateDeviceCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2DevicesIdPut: (id: string, updateDeviceCommand?: UpdateDeviceCommand, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Create device.
     * @param {CreateDeviceCommand} [createDeviceCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2DevicesPost: (createDeviceCommand?: CreateDeviceCommand, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * DevicesApi - functional programming interface
 * @export
 */
export declare const DevicesApiFp: (configuration?: Configuration) => {
    /**
     *
     * @summary Get all devices.
     * @param {string} [id]
     * @param {string} [token]
     * @param {Platform} [platform]
     * @param {boolean} [appAlert]
     * @param {boolean} [eventAlert]
     * @param {boolean} [noticeAlert]
     * @param {number} [page]
     * @param {number} [limit]
     * @param {Date} [lastRetrieved]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2DevicesGet(id?: string, token?: string, platform?: Platform, appAlert?: boolean, eventAlert?: boolean, noticeAlert?: boolean, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DevicesModel>>;
    /**
     *
     * @summary Delete device.
     * @param {string} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2DevicesIdDelete(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
    /**
     *
     * @summary Get device.
     * @param {string} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2DevicesIdGet(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceModel>>;
    /**
     *
     * @summary Update device.
     * @param {string} id
     * @param {UpdateDeviceCommand} [updateDeviceCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2DevicesIdPut(id: string, updateDeviceCommand?: UpdateDeviceCommand, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
    /**
     *
     * @summary Create device.
     * @param {CreateDeviceCommand} [createDeviceCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2DevicesPost(createDeviceCommand?: CreateDeviceCommand, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceModel>>;
};
/**
 * DevicesApi - factory interface
 * @export
 */
export declare const DevicesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     *
     * @summary Get all devices.
     * @param {string} [id]
     * @param {string} [token]
     * @param {Platform} [platform]
     * @param {boolean} [appAlert]
     * @param {boolean} [eventAlert]
     * @param {boolean} [noticeAlert]
     * @param {number} [page]
     * @param {number} [limit]
     * @param {Date} [lastRetrieved]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2DevicesGet(id?: string, token?: string, platform?: Platform, appAlert?: boolean, eventAlert?: boolean, noticeAlert?: boolean, page?: number, limit?: number, lastRetrieved?: Date, options?: any): AxiosPromise<DevicesModel>;
    /**
     *
     * @summary Delete device.
     * @param {string} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2DevicesIdDelete(id: string, options?: any): AxiosPromise<boolean>;
    /**
     *
     * @summary Get device.
     * @param {string} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2DevicesIdGet(id: string, options?: any): AxiosPromise<DeviceModel>;
    /**
     *
     * @summary Update device.
     * @param {string} id
     * @param {UpdateDeviceCommand} [updateDeviceCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2DevicesIdPut(id: string, updateDeviceCommand?: UpdateDeviceCommand, options?: any): AxiosPromise<boolean>;
    /**
     *
     * @summary Create device.
     * @param {CreateDeviceCommand} [createDeviceCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2DevicesPost(createDeviceCommand?: CreateDeviceCommand, options?: any): AxiosPromise<DeviceModel>;
};
/**
 * Request parameters for apiV2DevicesGet operation in DevicesApi.
 * @export
 * @interface DevicesApiApiV2DevicesGetRequest
 */
export interface DevicesApiApiV2DevicesGetRequest {
    /**
     *
     * @type {string}
     * @memberof DevicesApiApiV2DevicesGet
     */
    readonly id?: string;
    /**
     *
     * @type {string}
     * @memberof DevicesApiApiV2DevicesGet
     */
    readonly token?: string;
    /**
     *
     * @type {Platform}
     * @memberof DevicesApiApiV2DevicesGet
     */
    readonly platform?: Platform;
    /**
     *
     * @type {boolean}
     * @memberof DevicesApiApiV2DevicesGet
     */
    readonly appAlert?: boolean;
    /**
     *
     * @type {boolean}
     * @memberof DevicesApiApiV2DevicesGet
     */
    readonly eventAlert?: boolean;
    /**
     *
     * @type {boolean}
     * @memberof DevicesApiApiV2DevicesGet
     */
    readonly noticeAlert?: boolean;
    /**
     *
     * @type {number}
     * @memberof DevicesApiApiV2DevicesGet
     */
    readonly page?: number;
    /**
     *
     * @type {number}
     * @memberof DevicesApiApiV2DevicesGet
     */
    readonly limit?: number;
    /**
     *
     * @type {Date}
     * @memberof DevicesApiApiV2DevicesGet
     */
    readonly lastRetrieved?: Date;
}
/**
 * Request parameters for apiV2DevicesIdDelete operation in DevicesApi.
 * @export
 * @interface DevicesApiApiV2DevicesIdDeleteRequest
 */
export interface DevicesApiApiV2DevicesIdDeleteRequest {
    /**
     *
     * @type {string}
     * @memberof DevicesApiApiV2DevicesIdDelete
     */
    readonly id: string;
}
/**
 * Request parameters for apiV2DevicesIdGet operation in DevicesApi.
 * @export
 * @interface DevicesApiApiV2DevicesIdGetRequest
 */
export interface DevicesApiApiV2DevicesIdGetRequest {
    /**
     *
     * @type {string}
     * @memberof DevicesApiApiV2DevicesIdGet
     */
    readonly id: string;
}
/**
 * Request parameters for apiV2DevicesIdPut operation in DevicesApi.
 * @export
 * @interface DevicesApiApiV2DevicesIdPutRequest
 */
export interface DevicesApiApiV2DevicesIdPutRequest {
    /**
     *
     * @type {string}
     * @memberof DevicesApiApiV2DevicesIdPut
     */
    readonly id: string;
    /**
     *
     * @type {UpdateDeviceCommand}
     * @memberof DevicesApiApiV2DevicesIdPut
     */
    readonly updateDeviceCommand?: UpdateDeviceCommand;
}
/**
 * Request parameters for apiV2DevicesPost operation in DevicesApi.
 * @export
 * @interface DevicesApiApiV2DevicesPostRequest
 */
export interface DevicesApiApiV2DevicesPostRequest {
    /**
     *
     * @type {CreateDeviceCommand}
     * @memberof DevicesApiApiV2DevicesPost
     */
    readonly createDeviceCommand?: CreateDeviceCommand;
}
/**
 * DevicesApi - object-oriented interface
 * @export
 * @class DevicesApi
 * @extends {BaseAPI}
 */
export declare class DevicesApi extends BaseAPI {
    /**
     *
     * @summary Get all devices.
     * @param {DevicesApiApiV2DevicesGetRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof DevicesApi
     */
    apiV2DevicesGet(requestParameters?: DevicesApiApiV2DevicesGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DevicesModel, any>>;
    /**
     *
     * @summary Delete device.
     * @param {DevicesApiApiV2DevicesIdDeleteRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof DevicesApi
     */
    apiV2DevicesIdDelete(requestParameters: DevicesApiApiV2DevicesIdDeleteRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>;
    /**
     *
     * @summary Get device.
     * @param {DevicesApiApiV2DevicesIdGetRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof DevicesApi
     */
    apiV2DevicesIdGet(requestParameters: DevicesApiApiV2DevicesIdGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeviceModel, any>>;
    /**
     *
     * @summary Update device.
     * @param {DevicesApiApiV2DevicesIdPutRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof DevicesApi
     */
    apiV2DevicesIdPut(requestParameters: DevicesApiApiV2DevicesIdPutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>;
    /**
     *
     * @summary Create device.
     * @param {DevicesApiApiV2DevicesPostRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof DevicesApi
     */
    apiV2DevicesPost(requestParameters?: DevicesApiApiV2DevicesPostRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeviceModel, any>>;
}
//# sourceMappingURL=devices-api.d.ts.map