Skip to main content

@dialstack/sdk-dev / js/src / UpdateDeviceRequest

Interface: UpdateDeviceRequest

Defined in: sdk/js/src/types/device.ts:438

Request payload for POST /v1/devices/{id}. Tri-state fields (name, base_id) accept three values: omit to leave unchanged, a string to set, or explicit JSON null to clear.

Properties​

base?​

TypeScript
base?: string | null;

Defined in: sdk/js/src/types/device.ts:477

Tri-state parent base. dect_handset only — repair to a different base (string) or unpair (null).


base_id?​

TypeScript
base_id?: string | null;

Defined in: sdk/js/src/types/device.ts:479

Deprecated​

Use base. Retained for backwards compatibility.


button_template?​

TypeScript
button_template?: string | null;

Defined in: sdk/js/src/types/device.ts:470

Tri-state programmable-key template binding.


button_template_id?​

TypeScript
button_template_id?: string | null;

Defined in: sdk/js/src/types/device.ts:472

Deprecated​

Use button_template. Retained for backwards compatibility.


ipei?​

TypeScript
ipei?: string;

Defined in: sdk/js/src/types/device.ts:446

Handset IPEI. dect_handset only.


location?​

TypeScript
location?: string | null;

Defined in: sdk/js/src/types/device.ts:463

Dispatch location. deskphone and dect_base only. Omit to leave unchanged, send a location ID to move the device, or send null to reset it to the default: the account's only location, else the location of a user on the device, else the account's main location. Move the device to a user's site before assigning that user, or the assignment is refused with location_conflict.


location_id?​

TypeScript
location_id?: string | null;

Defined in: sdk/js/src/types/device.ts:468

Deprecated​

Use location. Retained for backwards compatibility. null resets to the default, as for location.


model?​

TypeScript
model?: string;

Defined in: sdk/js/src/types/device.ts:440

Device model.


name?​

TypeScript
name?: string | null;

Defined in: sdk/js/src/types/device.ts:448

Tri-state human-friendly label.


overrides?​

TypeScript
overrides?: DeviceSettings;

Defined in: sdk/js/src/types/device.ts:444

Device-specific settings overrides.


serial_number?​

TypeScript
serial_number?: string | null;

Defined in: sdk/js/src/types/device.ts:454

Manufacturer serial number (1-64 letters, digits, or dashes; surrounding whitespace is trimmed). deskphone and dect_base only. Send null or an empty string to clear.


status?​

TypeScript
status?: DeviceStatus;

Defined in: sdk/js/src/types/device.ts:442

Device status.