Class DeviceApi

DeviceApi - object-oriented interface

Hierarchy

BaseAPI
- DeviceApi

Index

Constructors

Properties

axios basePath configuration

Methods

deleteDevice getDeviceInfo getDeviceOptions getDevices updateDeviceOptions

Constructors

constructor

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

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: Configuration | undefined

Methods

deleteDevice

deleteDevice(
requestParameters?: DeviceApiDeleteDeviceRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: DeviceApiDeleteDeviceRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/device-api.ts:440

getDeviceInfo

getDeviceInfo(
requestParameters: DeviceApiGetDeviceInfoRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<DeviceInfoDto, any, {}>>
Parameters
- requestParameters: DeviceApiGetDeviceInfoRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<DeviceInfoDto, any, {}>>

Throws
- Defined in generated-client/api/device-api.ts:451

getDeviceOptions

getDeviceOptions(
requestParameters: DeviceApiGetDeviceOptionsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<DeviceOptionsDto, any, {}>>
Parameters
- requestParameters: DeviceApiGetDeviceOptionsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<DeviceOptionsDto, any, {}>>

Throws
- Defined in generated-client/api/device-api.ts:462

getDevices

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

Throws
- Defined in generated-client/api/device-api.ts:473

updateDeviceOptions

updateDeviceOptions(
requestParameters: DeviceApiUpdateDeviceOptionsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: DeviceApiUpdateDeviceOptionsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/device-api.ts:484