FoyerDevelopers

Generated · Live registry

properties tools

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

All tool domains

properties.byUuid

read-only

Properties: by uuid. Read-only query. See the input schema for argument details.

Input parameters

FieldTypeRequiredNotes
propertyUuidstringyes

Output fields

FieldTypeRequiredNotes
propertyUuidstringyes
namestring · nullableyes
picturestring · nullableyes
addressLinestring · nullableyes
citystring · nullableyes
countrystring · nullableyes
mappedRoomobject · nullableyes
mappedRoom.namestringyes
mappedRoom.maintenanceStatusstringyes
capacitiesobjectyes
capacities.bedroomsnumber · nullableyes
capacities.bathroomsnumber · nullableyes
capacities.bedsnumber · nullableyes
capacities.maxGuestsnumber · nullableyes
amenitiesarray of stringyes
pricingobject · nullableyes
pricing.currencystring · nullableyes
pricing.minCentsnumber · nullableyes
pricing.maxCentsnumber · nullableyes
pricing.avgCentsnumber · nullableyes
pricing.nextAvailableDatestring · nullableyes
pricing.minNightsnumber · nullableyes
pricing.windowDaysnumberyes
houseRulesobject · nullableyes
houseRules.smokingboolean · nullableyes
houseRules.petsboolean · nullableyes
houseRules.eventsboolean · nullableyes
upcomingReservationsarray of objectyes
upcomingReservations.stayIdstringyes
upcomingReservations.guestNamestring · nullableyes
upcomingReservations.checkInstring · nullableyes
upcomingReservations.checkOutstring · nullableyes
upcomingReservations.exConversationIdstring · nullableyes
upcomingReservations.externalRefstring · nullableyes

properties.get

read-only

Fetch a single property's detail by its Hospitable property UUID (core fields, mapped local room, capacities, amenities, price/availability summary, house rules, upcoming reservations). DRY: delegates to getPropertyByUuid() (same as tRPC properties.byUuid).

Input parameters

FieldTypeRequiredNotes
propertyUuidstringyes

Output fields

FieldTypeRequiredNotes
propertyUuidstringyes
namestring · nullableyes
picturestring · nullableyes
addressLinestring · nullableyes
citystring · nullableyes
countrystring · nullableyes
mappedRoomobject · nullableyes
mappedRoom.namestringyes
mappedRoom.maintenanceStatusstringyes
capacitiesobjectyes
capacities.bedroomsnumber · nullableyes
capacities.bathroomsnumber · nullableyes
capacities.bedsnumber · nullableyes
capacities.maxGuestsnumber · nullableyes
amenitiesarray of stringyes
pricingobject · nullableyes
pricing.currencystring · nullableyes
pricing.minCentsnumber · nullableyes
pricing.maxCentsnumber · nullableyes
pricing.avgCentsnumber · nullableyes
pricing.nextAvailableDatestring · nullableyes
pricing.minNightsnumber · nullableyes
pricing.windowDaysnumberyes
houseRulesobject · nullableyes
houseRules.smokingboolean · nullableyes
houseRules.petsboolean · nullableyes
houseRules.eventsboolean · nullableyes
upcomingReservationsarray of objectyes
upcomingReservations.stayIdstringyes
upcomingReservations.guestNamestring · nullableyes
upcomingReservations.checkInany · nullableyes
upcomingReservations.checkOutany · nullableyes
upcomingReservations.exConversationIdstring · nullableyes
upcomingReservations.externalRefstring · nullableyes

properties.korrekturLoeschen

writesconfirm

Delete a correction ('back to Hospitable') and immediately re-notify the staydb with the reverted block. Can make the sent object poorer than the current correction. Requires confirmation.

Input parameters

FieldTypeRequiredNotes
objektUuidstringyes
schluesselenumyesOne of: room_details, amenities, property_type, room_type, public_name, address, house_rules, tags, capacity, listings, summary, description

Output fields

FieldTypeRequiredNotes
geloeschtbooleanyes
versandobjectyes

properties.korrekturSetzen

writesconfirm

Set (or replace) a top-level correction for an objekt block field and immediately notify the staydb (POST /webhook/prop) if the resulting block still passes completeness. Requires confirmation.

Input parameters

FieldTypeRequiredNotes
objektUuidstringyes
schluesselenumyesOne of: room_details, amenities, property_type, room_type, public_name, address, house_rules, tags, capacity, listings, summary, description
wertanyyes
grundstringyes

Output fields

FieldTypeRequiredNotes
gespeichertbooleanyes
versandobjectyes

properties.objektbestand

read-only

Properties: objektbestand. Read-only query. See the input schema for argument details.

Input parameters

FieldTypeRequiredNotes
objektUuidstringyes

Output fields

FieldTypeRequiredNotes
hatSpiegelbooleanyes
geholtAmstring · nullableyes
zeilenarray of objectyes
zeilen.schluesselenumyesOne of: room_details, amenities, property_type, room_type, public_name, address, house_rules, tags, capacity, listings, summary, description
zeilen.geerbtanyyesHospitables letzter Spiegel-Stand fuer diesen Schluessel — Gestalt haengt vom Schluessel ab (Array, Objekt oder String), siehe objektbestand.ts.
zeilen.korrekturobject · nullableyes
zeilen.giltanyyes`korrektur.wert ?? geerbt` — was tatsaechlich gesendet wuerde.