Class DevicesApi

DevicesApi - object-oriented interface

Export

DevicesApi

Hierarchy

BaseAPI
- DevicesApi

Index

Constructors

Properties

axios basePath configuration

Methods

deleteDevice getDeviceInfo getDeviceOptions getDevices updateDeviceOptions

Constructors

constructor

new DevicesApi(configuration?, basePath?, axios?): DevicesApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns DevicesApi
Inherited from BaseAPI.constructor
- Defined in generated-client/base.ts:52

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

deleteDevice

deleteDevice(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: DevicesApiDeleteDeviceRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Deletes a device.

Throws
Memberof
DevicesApi
- Defined in generated-client/api/devices-api.ts:472

getDeviceInfo

getDeviceInfo(requestParameters, options?): Promise<AxiosResponse<DeviceInfoDto, any>>
Parameters
- requestParameters: DevicesApiGetDeviceInfoRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<DeviceInfoDto, any>>
Summary
Get info for a device.

Throws
Memberof
DevicesApi
- Defined in generated-client/api/devices-api.ts:484

getDeviceOptions

getDeviceOptions(requestParameters, options?): Promise<AxiosResponse<DeviceOptionsDto, any>>
Parameters
- requestParameters: DevicesApiGetDeviceOptionsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<DeviceOptionsDto, any>>
Summary
Get options for a device.

Throws
Memberof
DevicesApi
- Defined in generated-client/api/devices-api.ts:496

getDevices

getDevices(requestParameters?, options?): Promise<AxiosResponse<DeviceInfoDtoQueryResult, any>>
Parameters
- requestParameters: DevicesApiGetDevicesRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<DeviceInfoDtoQueryResult, any>>
Summary
Get Devices.

Throws
Memberof
DevicesApi
- Defined in generated-client/api/devices-api.ts:508

updateDeviceOptions

updateDeviceOptions(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: DevicesApiUpdateDeviceOptionsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Update device options.

Throws
Memberof
DevicesApi
- Defined in generated-client/api/devices-api.ts:520