FoyerDevelopers

Generated · Live registry

tenants tools

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

All tool domains

tenants.anreiseFotoHochladen

writes

Uploads a photo for a step of the arrival guide (Base64) — same storage as the settings page. Returns the `photoKey` (a new key `<step>-<8 hex>.jpg` per upload, downscaled to ≤ 2000 px, metadata removed); then add it as `{ key }` to the step's `fotos` via `tenants.update-arrival-guide-settings` (up to 4 photos). Owner and team, as in the browser. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
stepKeyenumyesOne of: location, entrance, room, keybox, door_opener, enter, door_exit, rules, wifi
base64stringyes
mimeTypestringyes

Output fields

FieldTypeRequiredNotes
photoKeystringyes

tenants.connectStatus

read-only

Stripe-Connect status for the current tenant. Returns whether the tenant has connected their Stripe account and is onboarded (payouts-enabled). Used by the /direct surface to render the right state (CTA vs connected-summary). Read-only query.

Input parameters

Returns object.

Output fields

FieldTypeRequiredNotes
connectedbooleanyes
onboardedbooleanyes
accountIdstring · nullableyes
onboardedAtstring · nullableyes
bookingComRateSyncEnabledbooleanyes

tenants.getArrivalGuideSettings

read-only

Returns the settings of the guest arrival guide (arrival and access information, Wi-Fi, video links, etc.); an empty object if there is no entry. May contain access credentials. Any signed-in role. Read-only.

Input parameters

Returns object.

Output fields

FieldTypeRequiredNotes
enabledbooleanno
addressstringno
entranceCodeNamestringno
helpPhonestringno
keyboxCodePatternstringno
weitereZugangscodesarray of stringno
wifiobjectno
wifi.ssidstringno
wifi.passwordstringno
stepsobjectno
steps.locationobjectno
steps.entranceobjectno
steps.roomobjectno
steps.keyboxobjectno
steps.door_openerobjectno
steps.enterobjectno
steps.door_exitobjectno
steps.rulesobjectno
steps.wifiobjectno

tenants.getBookingHotelId

read-only

The property's Booking.com hotel ID. With it Foyer links every Booking.com booking without a phone number to its extranet page — since 28 Sep 2026 Booking.com no longer passes the number on to Beds24. `null` = not set. Read-only query.

Input parameters

Returns object.

Output fields

FieldTypeRequiredNotes
bookingHotelIdstring · nullableyes

tenants.getBrandVoice

read-only

Read the tenant's brand-voice settings. Returns null if unset (the pipeline falls back to a generic "warm professional" default). Read-only query.

Input parameters

Returns object.

Output fields

The whole object may be null.

FieldTypeRequiredNotes
descriptionstringyes
toneenumyesOne of: warm, professional, casual
voiceTrainingEnabledbooleanno

tenants.getCalendarRoomSort

read-only

The property-wide room order in the calendar. Any signed-in user may READ it — the calendar needs it to display rooms, not just the owner. Read-only query.

Input parameters

Returns object.

Output fields

FieldTypeRequiredNotes
sortenumyesOne of: floor_number, number, type

tenants.getPortalLayoutVersion

read-only

Pre-arrival portal layout. Returns the current setting so the Settings UI can render the right toggle state. - "v1" = legacy Meldeschein-only wizard - "v2" = new section-based PortalShell (Meldeschein + future hotel-info sections) Existing tenants are pinned to v1; new tenants default to v2. Read-only query.

Input parameters

Returns object.

Output fields

FieldTypeRequiredNotes
versionenumyesOne of: v1, v2

tenants.getRechnungAutoSenden

read-only

Rechnungsantwort automatisch senden? Read-only query.

Input parameters

Returns object.

Output fields

FieldTypeRequiredNotes
anbooleanyes
read-only

read the email section of channel_import_meta for the tenant. Returns the email import status, defaulting to idle when never run. Used by the email import UI in /settings/credentials to render status. Read-only query.

Input parameters

Returns object.

Output fields

The whole object may be null.

FieldTypeRequiredNotes
googleMapsUrlstringno
bookingComUrlstringno
tripadvisorUrlstringno
customUrlstringno
customLabelstringno

tenants.getReviewRequestSettings

read-only

Returns the setting for the automatic review request after check-out: enabled and delayHours (waiting time of 1, 2 or 24 hours); with no entry, off and 1. Any signed-in role. Read-only.

Input parameters

Returns object.

Output fields

FieldTypeRequiredNotes
enabledbooleanno
delayHoursliteralno

tenants.getServicezeit

read-only

The property's service hours: when the team answers guests, in minutes since midnight. Foyer inserts them into texts as `%service_from%` / `%service_until%`. Read-only query.

Input parameters

Returns object.

Output fields

FieldTypeRequiredNotes
serviceVonMinintegeryes
serviceBisMinintegeryes

tenants.get_brand_voice_stats

read-only

Returns brand-voice training readiness stats for the tenant: number of manual outbound messages eligible as style anchors (length ≥ 30 chars, within 90-day lookback), last anchor timestamp, per-channel breakdown (whatsapp / email / hospitable), and the voiceTrainingEnabled flag. Read-only — no side effects.

Input parameters

Returns object.

Output fields

FieldTypeRequiredNotes
anchorCountnumberyes
lastAnchorAtstring · nullableyes
channelBreakdownobjectyes
channelBreakdown.whatsappnumberyes
channelBreakdown.emailnumberyes
channelBreakdown.hospitablenumberyes
voiceTrainingEnabledbooleanyes

tenants.get_channel_import_meta

read-only

Read the current Hospitable (and future channel) import status for the tenant. Returns status ('idle' | 'running' | 'done' | 'error'), lastRunAt, importedCount, and errorMessage if the last run failed. Use this to check import progress before triggering a new import.

Input parameters

Returns object.

Output fields

FieldTypeRequiredNotes
hospitableobjectno
hospitable.statusenumyesOne of: idle, running, done, error
hospitable.lastRunAtstring · nullableyes
hospitable.importedCountnumberyes
hospitable.errorMessagestringno

tenants.get_email_import_meta

read-only

Read the current email (Postmark inbound) import status for the tenant. Returns status ('idle' | 'running' | 'done' | 'error'), lastRunAt, importedCount, and errorMessage if the last run failed. Use this to check email import progress before triggering a new import via triggerEmailImport.

Input parameters

Returns object.

Output fields

FieldTypeRequiredNotes
statusenumyesOne of: idle, running, done, error
lastRunAtstring · nullableyes
importedCountnumberyes
errorMessagestringno

tenants.get_faq_detection_mode

read-only

Read the tenant's FAQ detection mode: 'lexical' (trigger-phrase matching, default), 'openai', or 'voyage' (semantic embeddings). Read-only.

Input parameters

Returns object.

Output fields

FieldTypeRequiredNotes
modestringyes

tenants.qualitaetZustimmung

read-only

The property's consent to Annex 3 of the data processing agreement (improving the automatic evaluation, /avv#anlage-3) and the status of the last evaluation run (metrics without personal data). Read-only query.

Input parameters

Returns object.

Output fields

FieldTypeRequiredNotes
zustimmungAmstring · nullableyes
letzterLaufobject · nullableyes
letzterLauf.gelaufenAtstringyes
letzterLauf.aufenthalteintegeryes
letzterLauf.neueFaelleintegeryes
letzterLauf.kennzahlenobjectyes
faelleintegeryes

tenants.qualitaetZustimmungSetzen

writes

Grants or revokes consent to Annex 3 of the data processing agreement (AVV). Owner only — the owner is the one who concludes the contract. Revoking immediately deletes the property's evaluation set (AVV Annex 3 para. 8); both are recorded in audit_log. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
anbooleanyes

Output fields

FieldTypeRequiredNotes
okliteralyesOne of: true
anbooleanyes
geloeschtintegeryes

tenants.rechnungAutoSendenProtokoll

read-only

Who received an automatic reply and who did not — and why. At most ONE “gesendet” (sent) per booking and question; if the guest asks again, this shows “entwurf / schon_automatisch_beantwortet” (draft / already answered automatically). The most recent 100. Read-only query.

Input parameters

Returns object.

Output fields

Returns array of object. Fields of each element:

FieldTypeRequiredNotes
idstringyes
createdAtstringyes
gastNamestring · nullableyes
stayIdstringyes
conversationIdstring · nullableyes
fragestring · nullableyes
ergebnisenumyesOne of: geplant, gesendet, entwurf
grundstring · nullableyes

tenants.setBookingHotelId

writes

Set the Booking.com hotel ID or remove it (empty/`null`). Owner only; digits only (the ID is in the extranet address, e.g. `hotel_id=64804`). Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
bookingHotelIdstring · nullableyes

Output fields

FieldTypeRequiredNotes
okliteralyesOne of: true
bookingHotelIdstring · nullableyes

tenants.setCalendarRoomSort

writes

Sets it. Owner ONLY: the order applies to all operators, and whoever changes it rearranges the list the front desk clicks on. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
sortenumyesOne of: floor_number, number, type

Output fields

FieldTypeRequiredNotes
sortenumyesOne of: floor_number, number, type

tenants.setRechnungAutoSenden

writes

Turns automatic sending of the invoice reply on or off. Owner only: from then on Foyer writes to guests in the owner's name without anyone reviewing it. The legacy column `tenants.rechnung_auto_senden` is kept in sync but no longer read. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
anbooleanyes

Output fields

FieldTypeRequiredNotes
okliteralyesOne of: true
anbooleanyes

tenants.setReviewRequestSettings

writes

Turns the automatic review request after check-out on or off (enabled) and sets the waiting time delayHours (1, 2 or 24, default 1). Owner only. Changes data. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
enabledbooleanyes
delayHoursliteralnoDefault: 1

Output fields

FieldTypeRequiredNotes
okbooleanyes

tenants.setServicezeit

writes

Sets the property's service hours. Owner only: the times then appear in messages to guests. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
serviceVonMinintegeryes
serviceBisMinintegeryes

Output fields

FieldTypeRequiredNotes
okliteralyesOne of: true

tenants.setVoiceTrainingEnabled

writes

Toggle voice training (style anchors) on/off for this tenant. When disabled, buildComposeContext() skips the anchor query and the LLM falls back to the static brand-voice description only. Owner-only — affects the AI pipeline. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
enabledbooleanyes

Output fields

FieldTypeRequiredNotes
okbooleanyes
enabledbooleanyes

tenants.set_faq_detection_mode

writes

Set the tenant's FAQ detection mode ('lexical' | 'openai' | 'voyage'). Semantic modes need the provider's API key in the server env and embeddings computed via ai_questions.regenerate_embeddings. Owner-only, mutating.

Input parameters

FieldTypeRequiredNotes
modeenumyesOne of: lexical, openai, voyage

Output fields

FieldTypeRequiredNotes
okliteralyesOne of: true
modestringyes

tenants.triggerEmailImport

writes

enqueue an async email (Postmark inbound) historical import job. Guards against double-enqueue: if channel_import_meta.email.status is already 'running', returns { ok: false, reason: 'already_running' }. Otherwise sets status to 'running' and enqueues the pg-boss job `channel.import.email` which calls importEmailHistory() and writes the final status back. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
lookbackDaysintegernoDefault: 90

Output fields

FieldTypeRequiredNotes
okbooleanyes
reasonliteralnoOne of: already_running

tenants.update-arrival-guide-settings

writesconfirm

Replace the tenant's arrival-guide settings wholesale (address, entrance/keybox code names, weitereZugangscodes (further custom codes that are access data, e.g. Wi-Fi; withheld from bookings without access), wifi ssid/password, and per-step enabled/bodyTranslations/helpTranslations/fotos/videoUrl/nurZimmer for the 9 guide steps; door_opener/door_exit are off unless enabled:true; nurZimmer limits a step to those rooms, empty = all). fotos: up to 4 photos per step, each { key (from tenants.anreiseFotoHochladen, must belong to the step), ausschnitt? { x, y: centre 0..1 of the photo, zoom 1..4 }, ganz? { rand: '#rrggbb', oben?, unten? 0..0.4 } (show the whole photo fitted, the area beside it in that colour; oben/unten trim that share off the top/bottom first; ausschnitt is then ignored), punkte? [{ n 1..9 unique per step, x, y 0..1, b?, h? }] } — point n marks line n of the step's first numbered list; with b and h (width/height 0.02..1 of the photo, x/y = centre, must lie inside the photo) it is drawn as a numbered frame instead of a dot. pfeile? [{ n 1..9, art: 'gerade', x, y (start), zx, zy (tip), length >= 0.02 } | { n, art: 'dreh', x, y (centre), r 0.02..0.5 (radius as share of the photo width, x±r inside the photo), gegen? (true = counter-clockwise) }], max 9 per photo — motion arrows for line n; n may repeat a point's or frame's n. Legacy photoKey alone is still accepted (= fotos[0]). videoUrl must be http(s). Owner-only, mutating — replaces the whole JSONB (read-modify-write happens caller-side; send fotos back unchanged to keep crop, ganz, points and arrows).

Input parameters

FieldTypeRequiredNotes
enabledbooleanno
addressstringno
entranceCodeNamestringno
helpPhonestringno
keyboxCodePatternstringno
weitereZugangscodesarray of stringno
wifiobjectno
wifi.ssidstringno
wifi.passwordstringno
stepsobjectno
steps.locationobjectno
steps.entranceobjectno
steps.roomobjectno
steps.keyboxobjectno
steps.door_openerobjectno
steps.enterobjectno
steps.door_exitobjectno
steps.rulesobjectno
steps.wifiobjectno

Output fields

FieldTypeRequiredNotes
okliteralyesOne of: true

tenants.updateBrandVoice

writes

Save brand-voice settings. Owner-only — this is the operator's voice, not staff's. Empty/whitespace description is rejected (would defeat the purpose). The value lands in tenants.brand_voice_settings jsonb and is read on every L2 LLM compose via buildComposeContext(). Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
descriptionstringyes
toneenumyesOne of: warm, professional, casual

Output fields

FieldTypeRequiredNotes
okbooleanyes

tenants.updatePortalLayoutVersion

writes

Flip the pre-arrival portal layout. Reversible — no destructive side effects, no token state touched. The next request to /check-in/[token] picks up the new value through the loader. Owner-only because it changes the public guest-facing surface. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
versionenumyesOne of: v1, v2

Output fields

FieldTypeRequiredNotes
okbooleanyes
versionenumyesOne of: v1, v2
writes

Replaces the property's review links (googleMapsUrl, bookingComUrl, tripadvisorUrl, plus a custom link customUrl with customLabel); fields that are omitted or empty are removed. Owner only. Changes data. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
googleMapsUrlstring | literalno
bookingComUrlstring | literalno
tripadvisorUrlstring | literalno
customUrlstring | literalno
customLabelstring | literalno

Output fields

FieldTypeRequiredNotes
okbooleanyes

tenants.update_rooms

writesconfirm

Update the tenant's room count. Sockel is 30€/mo for ≤2 rooms; each additional room is 10€/mo. The matching Stripe extra-room line item is synced best-effort; the next webhook reconciliation catches any drift. Mutating action — requires _confirm: true.

Input parameters

FieldTypeRequiredNotes
roomsintegeryes

Output fields

FieldTypeRequiredNotes
okliteralyesOne of: true
stripeSyncanyyesRaw Stripe sync result, passed through verbatim — shape is Stripe's, not ours.