Class DevicePoolsClient

Device pool reads and per-device WireGuard config lookup.

Index

Constructors

Methods

get getDefault getDeviceWireGuard list

Constructors

constructor

new DevicePoolsClient(call: Caller): DevicePoolsClient
Parameters
- call: Caller
Returns DevicePoolsClient
- Defined in src/resources/device-pools.ts:19

Methods

get

get(poolId: string, opts?: RequestOptions): Promise<DevicePoolData>
Fetch a device pool by id.
Parameters
- poolId: string
- Optionalopts: RequestOptions
Returns Promise<DevicePoolData>
Throws
NotFoundError if the pool does not exist.
- Defined in src/resources/device-pools.ts:45

getDefault

getDefault(
params: { organizationId: string },
opts?: RequestOptions,
): Promise<DevicePoolData>
The organization's default pool. Back-compat single-pool read: the backend (getOrganizationPool) returns the org's first pool. Use list for all pools.
Parameters
- params: { organizationId: string }
- Optionalopts: RequestOptions
Returns Promise<DevicePoolData>
- Defined in src/resources/device-pools.ts:26

getDeviceWireGuard

getDeviceWireGuard(
params: { deviceId: string; poolId: string },
opts?: RequestOptions,
): Promise<DeviceWireGuardConfig>
A device's WireGuard config within a pool.

Deliberate behavior change (D3): the legacy api-client swallowed 404 and returned null; this method lets the pipeline's NotFoundError propagate when the device has no WireGuard config in the pool.
Parameters
- params: { deviceId: string; poolId: string }
- Optionalopts: RequestOptions
Returns Promise<DeviceWireGuardConfig>
- Defined in src/resources/device-pools.ts:56

list

list(
params: { organizationId: string },
opts?: RequestOptions,
): Promise<DevicePoolData[]>
All device pools for an organization.
Parameters
- params: { organizationId: string }
- Optionalopts: RequestOptions
Returns Promise<DevicePoolData[]>
- Defined in src/resources/device-pools.ts:34