mirror of
https://github.com/simstudioai/sim.git
synced 2026-02-19 02:34:37 -05:00
54e1439224
* added scaffolding for auto-generating docs for integrations based on block definition, get rendering error for mdx pages * page renders, have to add more useful information * standardized tool naming convention, added script to autogenerate docs for integrations, added docs for each tool * re-generated docs, updated CONTRIBUTING.md to reflect new format * added a dedicated tools page * added additional information for tools, added manual section logic to docs producer * added a link back to sim studio, fixed z level issue on mobile, added better intro * updated script to more accurately reflect the params for each tool, as well as the overall blocks' output
125 lines
5.2 KiB
Plaintext
125 lines
5.2 KiB
Plaintext
---
|
|
title: Guesty
|
|
description: Interact with Guesty property management system
|
|
---
|
|
|
|
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
|
|
|
<BlockInfoCard
|
|
type="guesty"
|
|
color="#0051F8"
|
|
icon={true}
|
|
iconSvg={`<svg className="block-icon"
|
|
|
|
|
|
|
|
viewBox="0 0 101 100"
|
|
fill="none"
|
|
xmlns="http://www.w3.org/2000/svg"
|
|
>
|
|
<path
|
|
d="M56.6019 2.6685C53.2445 0.339792 48.8025 0.308905 45.413 2.5907L44.1323 3.45286C44.1309 3.45379 44.1296 3.45471 44.1282 3.45564L5.37916 29.5416C5.37801 29.5424 5.37687 29.5431 5.37572 29.5439L4.37839 30.2153C1.64126 32.058 0 35.1414 0 38.441V90.0841C0 95.5599 4.4395 100 9.91593 100H67.4737C72.9501 100 77.389 95.5605 77.389 90.0841V49.6765C77.389 46.3038 75.675 43.1622 72.8385 41.3373L56.3027 30.6989C53.0908 28.6325 48.9777 28.5944 45.728 30.6009L28.3986 41.301C25.4732 43.1073 23.6922 46.3001 23.6922 49.7382V75.553H33.3248V51.0025C33.3248 50.1189 33.7823 49.2983 34.5337 48.8337L34.535 48.8329L49.5731 39.5476C50.408 39.0322 51.4645 39.0414 52.29 39.5714L66.5886 48.7705C67.3167 49.24 67.7564 50.0471 67.7564 50.9134V87.8176C67.7564 89.2256 66.6152 90.3674 65.2072 90.3674H12.1824C10.7742 90.3674 9.63262 89.2256 9.63262 87.8176V39.6474C9.63262 38.7995 10.0541 38.0071 10.7571 37.5331L49.5075 11.4463C50.3783 10.8601 51.5192 10.8675 52.3822 11.4646L89.8995 37.4867C89.9007 37.4877 89.9024 37.4886 89.9035 37.4896C90.588 37.9663 90.9959 38.7476 90.9959 39.5819V100H100.629V38.3956C100.629 35.1448 99.0352 32.1005 96.3641 30.2478L95.3969 29.5767C95.3941 29.575 95.3918 29.5733 95.3895 29.5717L56.6019 2.6685Z"
|
|
fill="currentColor"
|
|
/>
|
|
</svg>`}
|
|
/>
|
|
|
|
{/* MANUAL-CONTENT-START:intro */}
|
|
[Guesty](https://www.guesty.com) is a comprehensive property management platform designed for short-term and vacation rental property managers. It provides a centralized system to manage listings, reservations, guest communications, and operations across multiple booking channels like Airbnb, Booking.com, and VRBO.
|
|
|
|
With Guesty, property managers can:
|
|
|
|
- **Centralize operations**: Manage multiple properties and listings from a single dashboard
|
|
- **Automate workflows**: Set up automated messaging, task assignments, and cleaning schedules
|
|
- **Synchronize calendars**: Keep availability updated across all booking channels
|
|
- **Process payments**: Handle secure payment processing and financial reporting
|
|
- **Manage guest communications**: Streamline guest interactions through unified inbox
|
|
- **Generate reports**: Access analytics and insights to optimize property performance
|
|
|
|
In Sim Studio, the Guesty integration enables your agents to interact directly with your property management system programmatically. This allows for powerful automation scenarios such as reservation management, guest communication, and operational workflows. Your agents can retrieve detailed reservation information by ID, including guest details, booking dates, and property information. They can also search for guests by phone number to access their profiles and booking history. This integration bridges the gap between your AI workflows and your property management operations, enabling seamless handling of hospitality tasks without manual intervention. By connecting Sim Studio with Guesty, you can automate guest communications, streamline check-in processes, manage reservation details, and enhance the overall guest experience through intelligent automation.
|
|
{/* MANUAL-CONTENT-END */}
|
|
|
|
|
|
## Usage Instructions
|
|
|
|
Access Guesty property management data including reservations and guest information. Retrieve reservation details by ID or search for guests by phone number.
|
|
|
|
|
|
|
|
## Tools
|
|
|
|
### `guesty_reservation`
|
|
|
|
Fetch reservation details from Guesty by reservation ID
|
|
|
|
#### Input
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| --------- | ---- | -------- | ----------- |
|
|
| `apiKey` | string | Yes | Your Guesty API token |
|
|
| `reservationId` | string | Yes | The ID of the reservation to fetch |
|
|
|
|
#### Output
|
|
|
|
| Parameter | Type |
|
|
| --------- | ---- |
|
|
| `id` | string |
|
|
| `guest` | string |
|
|
| `email` | string |
|
|
| `phone` | string |
|
|
|
|
### `guesty_guest`
|
|
|
|
Search for guests in Guesty by phone number
|
|
|
|
#### Input
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| --------- | ---- | -------- | ----------- |
|
|
| `apiKey` | string | Yes | Your Guesty API token |
|
|
| `phoneNumber` | string | Yes | The phone number to search for |
|
|
|
|
#### Output
|
|
|
|
| Parameter | Type |
|
|
| --------- | ---- |
|
|
| `guests` | string |
|
|
| `fullName` | string |
|
|
| `email` | string |
|
|
| `phone` | string |
|
|
| `address` | string |
|
|
| `city` | string |
|
|
| `country` | string |
|
|
|
|
|
|
|
|
## Block Configuration
|
|
|
|
### Input
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| --------- | ---- | -------- | ----------- |
|
|
| `action` | string | Yes | Action |
|
|
|
|
|
|
|
|
### Outputs
|
|
|
|
| Output | Type | Description |
|
|
| ------ | ---- | ----------- |
|
|
| `response` | object | Output from response |
|
|
| ↳ `id` | string | id of the response |
|
|
| ↳ `guest` | json | guest of the response |
|
|
| ↳ `checkIn` | string | checkIn of the response |
|
|
| ↳ `checkOut` | string | checkOut of the response |
|
|
| ↳ `status` | string | status of the response |
|
|
| ↳ `listing` | json | listing of the response |
|
|
| ↳ `money` | json | money of the response |
|
|
| ↳ `guests` | json | guests of the response |
|
|
|
|
|
|
## Notes
|
|
|
|
- Category: `tools`
|
|
- Type: `guesty`
|