FoyerDevelopers

Generated · Live registry

smartLocks tools

18 tools in this domain, generated from the running registry.

All tool domains

smartLocks.batterien

read-only

Open Nuki device tasks (battery `aufgaben`, faulty door `stoerungen`) AND the logs of the most recent runs. Does NOT call Nuki live, so the handover and smart locks pages stay fast. Any staff member. Read-only query.

Input parameters

FieldTypeRequiredNotes
mitLaufbooleanno
mitWaechterbooleanno
mitProtokollbooleanno

Output fields

FieldTypeRequiredNotes
aufgabenarray of objectyes
aufgaben.taskIdstringyes
aufgaben.titlestringyes
aufgaben.prioritystringyes
aufgaben.statusstringyes
aufgaben.createdAtstringyes
aufgaben.tuerIdstringyes
aufgaben.komponenteenumyesOne of: geraet, keypad, tuersensor
letzterLaufobject · nullableyes
letzterLauf.atstringyes
letzterLauf.geprueftarray of stringyes
letzterLauf.fehlendarray of stringyes
letzterLauf.ohneSignalarray of stringyes
letzterLauf.kritischarray of string · nullableno
letzterLauf.fehlerstring · nullableyes
stoerungenarray of objectyes
stoerungen.taskIdstringyes
stoerungen.titlestringyes
stoerungen.prioritystringyes
stoerungen.statusstringyes
stoerungen.createdAtstringyes
stoerungen.seitstring · nullableyes
stoerungen.tuerIdstringyes
stoerungen.grundstringyes
tuerLaufobject · nullableyes
tuerLauf.atstring · nullableyes
tuerLauf.tuerenobjectyes
tuerLauf.fehlerstring · nullableyes
tuerLauf.fehlerSeitstring · nullableyes
aufgabenSichtbarbooleanyes
protokollobject · nullableyes
protokoll.klingelnarray of objectyes
protokoll.falschCodearray of objectyes
protokoll.daueroeffnungarray of objectyes
protokoll.logScopeFehltbooleanyes
waechterAusfallobject · nullableyes
waechterAusfall.artenumyesOne of: nuki, gestoppt
waechterAusfall.seitstringyes
waechterAusfall.fehlerstringyes

smartLocks.batterienPruefen

writes

Batterie-Abgleich jetzt statt erst um 06:15 ausfuehren. Owner-only (schreibt Aufgaben). Mutation — changes data.

Input parameters

Returns object.

Output fields

FieldTypeRequiredNotes
angelegtintegeryes
geschlossenintegeryes
abgebrochenintegeryes
fehlendintegeryes

smartLocks.doors.create

writes

Add a door. Provider account must exist. Owner-only. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
namestringyes
providerenumyesOne of: nuki, ttlock, tedee
lockRefstringyes
lockNamestringno

Output fields

FieldTypeRequiredNotes
idstringyes

smartLocks.doors.delete

writesconfirm

Delete a door mapping from the smart-lock registry. Refused (`gaeste_codes_aktiv`) while the door still carries live personal guest codes — delete or let them expire first; `takt_laeuft` (CONFLICT) while Foyer's guest-code run is working — retry in a moment.

Input parameters

FieldTypeRequiredNotes
idstringyes

Output fields

FieldTypeRequiredNotes
okliteralyesOne of: true

smartLocks.doors.list

read-only

All doors, default-door order (position, createdAt). Any staff. Read-only query.

Input parameters

Returns object.

Output fields

Returns array of object. Fields of each element:

FieldTypeRequiredNotes
idstringyes
namestringyes
providerenumyesOne of: nuki, ttlock, tedee
lockNamestring · nullableyes
enabledbooleanyes
positionintegeryes

smartLocks.doors.listProviderLocks

writes

List the provider account's locks (setup "Schlösser laden" (load locks)). Owner-only. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
providerenumyesOne of: nuki, ttlock, tedee

Output fields

FieldTypeRequiredNotes
locksarray of objectyes
locks.lockRefstringyes
locks.namestringyes

smartLocks.doors.update

writes

Rename / enable / reorder a door. Owner-only. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
idstringyes
namestringno
enabledbooleanno
positionintegerno

Output fields

FieldTypeRequiredNotes
okliteralyesOne of: true

smartLocks.haustuerCodeAnzeigen

writesconfirm

Reveal the code value of ONE keypad-code entry (Nuki type 13) at the front door, read live from Nuki. The code is a house key: it is never stored in Foyer, but every call is audit-logged (door.code_shown: who, when, door, authId). Only entries whose `erlaubt.anzeigen` is true. Owner only. Requires confirmation.

Input parameters

FieldTypeRequiredNotes
doorIdstringyes
authIdstringyes

Output fields

FieldTypeRequiredNotes
codestringyes

smartLocks.haustuerCodeVorschau

read-only

Preview of a front-door code rotation: which Nuki entry is the current guest code, until when the old code stays valid, how many stays may already have it. Changes nothing. Owner only.

Input parameters

FieldTypeRequiredNotes
doorIdstringyes

Output fields

FieldTypeRequiredNotes
alteAuthobjectyes
gueltigBisstringyes
betroffeneAufenthalteintegeryes
mitVorgabeAltCodeintegeryes
woertlichInTextenintegeryes

smartLocks.haustuerCodeWechseln

writesconfirm

Rotate the guests' front-door keypad code: creates a new random code at Nuki, waits for Nuki to confirm (up to ~3 min), THEN switches guest messages and the arrival guide to it; the old code stays valid until the affected guests have left. Returns the new code in plaintext once. On `rueckleseprobe_zeitueberschreitung` (Nuki did not confirm in time) the result is `fehlgeschlagen` with `authName`: the shared code stays the OLD one, but an unconfirmed entry with that name may remain at Nuki — tell the owner to check the Nuki app (Authorizations) for an entry named exactly `authName` and delete it if present. Never relay or guess a code. Physical security: a wrong rotation can lock guests out. Owner only, audit-logged. Requires confirmation.

Input parameters

FieldTypeRequiredNotes
doorIdstringyes
alteAuthIdstring · nullableno

Output fields

One of 2 shapes, depending on the outcome:

Shape 1

FieldTypeRequiredNotes
ergebnisliteralyesOne of: gewechselt
neuerCodestringyes
neueAuthNamestringyes
gueltigBisstringyes

Shape 2

FieldTypeRequiredNotes
ergebnisliteralyesOne of: fehlgeschlagen
grundstringyes
authNamestringno

smartLocks.haustuerZugang

read-only

Who has access to the front door: every Nuki authorization of each active Nuki door, read LIVE from Nuki (≤ 60 s cache). Contains the names of Nuki app users (personal data, live only — Foyer does not store them) but never a code value. Each entry carries `erlaubt` — which actions the protection rules allow (show code, edit name/code/active, delete), `grund` when something is locked (gaestecode_geschuetzt, foyer_gaeste_code = a personal per-booking guest code managed by Foyer: show only, manage it via the booking; schonfrist_laeuft, nuki_beschaeftigt, geraet; zeitfenster_eintrag = the entry carries a time window set in the Nuki app: edit name/code/active is not allowed, only viewing and deleting). An existing time window (`vonTag`/`bisTag`) is shown read-only: Foyer does not write time windows and does not write to entries that have one. Owner only.

Input parameters

Returns object.

Output fields

Returns array of object. Fields of each element:

FieldTypeRequiredNotes
doorIdstringyes
doorNamestringyes
standenumyesOne of: ok, fehler
fehlerstring · nullableyes
abgerufenAmstringyes
codesBekanntbooleanyes
traegtGaesteCodebooleanyes
eintraegearray of objectyes
eintraege.idstringyes
eintraege.namestringyes
eintraege.typstringyes
eintraege.enabledbooleanyes
eintraege.allowedFromDatestring · nullableyes
eintraege.allowedUntilDatestring · nullableyes
eintraege.allowedWeekDaysinteger · nullableyes
eintraege.allowedFromTimeinteger · nullableyes
eintraege.allowedUntilTimeinteger · nullableyes
eintraege.lastActiveDatestring · nullableyes
eintraege.fehlerbooleanyes
eintraege.istGaesteCodebooleanyes
eintraege.vonTagstring · nullableyes
eintraege.bisTagstring · nullableyes
eintraege.deaktivierungNachstring · nullableyes
eintraege.erlaubtobjectyes

smartLocks.haustuerZugangBearbeiten

writesconfirm

Edit a Nuki authorization at the front door. An entry that carries a time window (set in the Nuki app) is NOT editable here — name, code and active are rejected with `zeitfenster_eintrag` (Foyer would have to write the window back, which Nuki drops or hides); change it in the Nuki app, deleting works. Foyer does NOT write time windows (decision 2026-10-05, Nuki drops them): a `zeitfenster` that differs from the entry's current window is rejected with `zeitfenster_nicht_verfuegbar` — do not send it; windows can only be set in the Nuki app. Fields: name (1–32 chars), code (keypad codes only: 6 digits 1–9, not starting with 12, not trivial, not used by another entry) and active/inactive. Send only the fields to change; code-change names (“Foyer Gäste <digit>…”, older “Foyer Gäste ab …”) are reserved. The current guest code and old codes in their grace period are protected (rename only). Waits for Nuki to confirm EVERY field (up to ~3 min); `gespeichert` only after the read-back. If Nuki drops the time window (entry would be unlimited) Foyer deactivates the entry and creates an urgent task (`zeitfenster_verworfen_deaktiviert`). If Nuki does not confirm in time, Foyer re-checks after ~10 min (`unbestaetigt_nachpruefung_geplant`). `gespeichert` may carry `hinweis: zeitfenster_verworfen_inaktiv` — the entry is inactive but Nuki dropped its existing time window; tell the owner. ACTIVATING an entry without a time window requires `unbegrenztBestaetigt: true` — the code then applies WITHOUT time limit; ask the owner explicitly before setting it (otherwise `aktivierung_ohne_zeitfenster`). An entry whose window has expired (`zeitfenster_abgelaufen`) can only be deactivated or deleted here. Owner only, audit-logged. Requires confirmation.

Input parameters

FieldTypeRequiredNotes
doorIdstringyes
authIdstringyes
aenderungobjectyes
aenderung.namestringno
aenderung.codestringno
aenderung.zeitfensterobjectno
aenderung.aktivbooleanno
aenderung.unbegrenztBestaetigtbooleanno

Output fields

One of 2 shapes, depending on the outcome:

Shape 1

FieldTypeRequiredNotes
ergebnisliteralyesOne of: gespeichert
hinweisstringno

Shape 2

FieldTypeRequiredNotes
ergebnisliteralyesOne of: fehlgeschlagen
grundstringyes

smartLocks.haustuerZugangLoeschen

writesconfirm

Delete a Nuki authorization at the front door. Not possible for the current guest code, old codes in their grace period, or the bridge/keypad devices. Deleting an APP entry (typ `app`) means that person can no longer open the door with the Nuki app — say so when asking for confirmation. Waits for Nuki to confirm the entry is gone (up to ~3 min). Owner only, audit-logged. Requires confirmation.

Input parameters

FieldTypeRequiredNotes
doorIdstringyes
authIdstringyes

Output fields

One of 2 shapes, depending on the outcome:

Shape 1

FieldTypeRequiredNotes
ergebnisliteralyesOne of: geloescht

Shape 2

FieldTypeRequiredNotes
ergebnisliteralyesOne of: fehlgeschlagen
grundstringyes

smartLocks.listActiveCodes

read-only

Lists a stay's (stayId) active (not revoked) door codes with lock ID, code in plain text, and validity period. Operations roles only (owner, staff, reception). Read-only.

Input parameters

FieldTypeRequiredNotes
stayIdstringyes

Output fields

Returns array of object. Fields of each element:

FieldTypeRequiredNotes
idstringyes
lockIdstringyes
codestringyes
validFromstringyes
validTostringyes

smartLocks.nukiGetConfig

read-only

Owner config view (never returns the token — only its hint). Read-only query.

Input parameters

Returns object.

Output fields

FieldTypeRequiredNotes
enabledbooleanyes
tokenHintstring · nullableyes
smartlockIdstring · nullableyes
smartlockNamestring · nullableyes

smartLocks.tedeeGetConfig

read-only

Owner config view (never returns the PAK — only its hint). Read-only query.

Input parameters

Returns object.

Output fields

FieldTypeRequiredNotes
credentialsHintstring · nullableyes

smartLocks.ttlockGetConfig

read-only

Owner config view (never returns credentials — only the hint). Read-only query.

Input parameters

Returns object.

Output fields

FieldTypeRequiredNotes
enabledbooleanyes
credentialsHintstring · nullableyes
lockIdstring · nullableyes
lockNamestring · nullableyes

smartLocks.unlockErgebnis

read-only

Did Nuki confirm the opening triggered by this click? (B2) `offen` = no result yet (the job runs ~10 s after the click). Like `unlock`: requires the smart_locks module and an operator role (owner/staff/reception); reads via `withSystem`. Read-only query.

Input parameters

FieldTypeRequiredNotes
doorIdstringyes
geklicktAmstringyes

Output fields

FieldTypeRequiredNotes
ergebnisenumyesOne of: offen, bestaetigt, unbestaetigt