FoyerDevelopers

Generated · Live registry

smartLocks tools

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

All tool domains

smartLocks.doors.create

writes

Smart locks: doors create. Mutation — changes data. See the input schema for argument details.

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.

Input parameters

FieldTypeRequiredNotes
idstringyes

Output fields

FieldTypeRequiredNotes
okliteralyesOne of: true

smartLocks.doors.list

read-only

Smart locks: doors list. Read-only query. See the input schema for argument details.

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

Smart locks: doors list provider locks. Mutation — changes data. See the input schema for argument details.

Input parameters

FieldTypeRequiredNotes
providerenumyesOne of: nuki, ttlock, tedee

Output fields

FieldTypeRequiredNotes
locksarray of objectyes
locks.lockRefstringyes
locks.namestringyes

smartLocks.doors.update

writes

Smart locks: doors update. Mutation — changes data. See the input schema for argument details.

Input parameters

FieldTypeRequiredNotes
idstringyes
namestringno
enabledbooleanno
positionintegerno

Output fields

FieldTypeRequiredNotes
okliteralyesOne of: true

smartLocks.listActiveCodes

read-only

Smart locks: list active codes. Read-only query. See the input schema for argument details.

Input parameters

FieldTypeRequiredNotes
stayIdstringyes

Output fields

Returns array of object. Fields of each element:

FieldTypeRequiredNotes
idstringyes
lockIdstringyes
codestringyes
validFromstringyes
validTostringyes

smartLocks.nukiGetConfig

read-only

Smart locks: nuki get config. Read-only query. See the input schema for argument details.

Input parameters

Returns object.

Output fields

FieldTypeRequiredNotes
enabledbooleanyes
tokenHintstring · nullableyes
smartlockIdstring · nullableyes
smartlockNamestring · nullableyes

smartLocks.tedeeGetConfig

read-only

Smart locks: tedee get config. Read-only query. See the input schema for argument details.

Input parameters

Returns object.

Output fields

FieldTypeRequiredNotes
credentialsHintstring · nullableyes

smartLocks.ttlockGetConfig

read-only

Smart locks: ttlock get config. Read-only query. See the input schema for argument details.

Input parameters

Returns object.

Output fields

FieldTypeRequiredNotes
enabledbooleanyes
credentialsHintstring · nullableyes
lockIdstring · nullableyes
lockNamestring · nullableyes