Class Devices

Hierarchy

APIResource
- Devices

Index

Constructors

Properties

Methods

Constructors

constructor

new Devices(client: GboxClient): GboxClient.V1.Devices
Parameters
- client: GboxClient
Returns GboxClient.V1.Devices
Inherited from APIResource.constructor
- Defined in src/core/resource.ts:8

Properties

`Protected`_client

_client: GboxClient

Methods

get

get(
deviceID: string,
options?: RequestOptions,
): APIPromise<GboxClient.V1.DeviceInfo>
Get device info
Parameters
- deviceID: string
- Optionaloptions: RequestOptions
Returns APIPromise<GboxClient.V1.DeviceInfo>
Example
```
const deviceInfo = await client.v1.devices.get(
  'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
);
```
- Defined in src/resources/v1/devices.ts:44

list

list(
params?: GboxClient.V1.DeviceListParams | null | undefined,
options?: RequestOptions,
): APIPromise<GboxClient.V1.GetDeviceListResponse>
Get device list
Parameters
- params: GboxClient.V1.DeviceListParams | null | undefined = {}
- Optionaloptions: RequestOptions
Returns APIPromise<GboxClient.V1.GetDeviceListResponse>
Example
```
const getDeviceListResponse =
  await client.v1.devices.list();
```
- Defined in src/resources/v1/devices.ts:19

toBox

toBox(
    deviceID: string,
    body: GboxClient.V1.DeviceToBoxParams,
    options?: RequestOptions,
): APIPromise<string>
Create a new box using a physical device
Parameters
- deviceID: string
- body: GboxClient.V1.DeviceToBoxParams
- Optionaloptions: RequestOptions
Returns APIPromise<string>
Example
```
const response = await client.v1.devices.toBox(
  'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
);
```
- Defined in src/resources/v1/devices.ts:58