AlmondTill/G3N API

NewDevicePeripheralInput

input type

Create-input for a DevicePeripheral. The tenant is derived SERVER-SIDE; deviceId (the parent — rides the header) is tenant-scoped + non-doomed server-side (provisioning precedes pairing — pending_pairing/active/suspended all accept peripherals); model/type/connection coherence validates against the preset registry at the boundary AND in the kit.

Fields

FieldTypeRequiredNotes
captionStringnoOptional: when omitted the per-type default applies — the preset model's display name ('Zebra DS2208'); when supplied it must be non-blank.
deviceIdID ID!yesThe owning Device — tenant-scoped + non-doomed. Immutable after birth.
peripheralTypeDevicePeripheralType DevicePeripheralType!yesImmutable after birth.
modelString String!yesA preset-registry key (cannedPeripheralModels) whose peripheralType matches. Immutable after birth.
connectionDevicePeripheralConnection DevicePeripheralConnection!yesOne of the model’s supported modes.
registrationCodeStringnoThe reader-displayed Stripe registration code — REQUIRED iff card_reader+network (the smart reader registers at birth, on the org’s connected account), REFUSED otherwise (strict both ways). Consumed by Stripe — never stored.

Used by