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?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): 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: DevicesApiDeleteDeviceRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void>>
Parameters
- requestParameters: DevicesApiDeleteDeviceRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void>>
Throws
Memberof
DevicesApi
- Defined in generated-client/api/devices-api.ts:472

getDeviceInfo

getDeviceInfo(
requestParameters: DevicesApiGetDeviceInfoRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<DeviceInfoDto>>
Parameters
- requestParameters: DevicesApiGetDeviceInfoRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<DeviceInfoDto>>
Throws
Memberof
DevicesApi
- Defined in generated-client/api/devices-api.ts:484

getDeviceOptions

getDeviceOptions(
requestParameters: DevicesApiGetDeviceOptionsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<DeviceOptionsDto>>
Parameters
- requestParameters: DevicesApiGetDeviceOptionsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<DeviceOptionsDto>>
Throws
Memberof
DevicesApi
- Defined in generated-client/api/devices-api.ts:496

getDevices

getDevices(
requestParameters?: DevicesApiGetDevicesRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<DeviceInfoDtoQueryResult>>
Parameters
- requestParameters: DevicesApiGetDevicesRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<DeviceInfoDtoQueryResult>>
Throws
Memberof
DevicesApi
- Defined in generated-client/api/devices-api.ts:508

updateDeviceOptions

updateDeviceOptions(
requestParameters: DevicesApiUpdateDeviceOptionsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void>>
Parameters
- requestParameters: DevicesApiUpdateDeviceOptionsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void>>
Throws
Memberof
DevicesApi
- Defined in generated-client/api/devices-api.ts:520