TIDY - AI Property Manager — Public API

Send natural-language requests to your TIDY account from the command line or integrate directly with the REST API.

tidy-request CLI

Install

Homebrew (macOS/Linux)

brew tap tidyapp/tap
brew install tidy-request

npm

npm install -g @tidydotcom/cli

curl (one-liner)

curl -fsSL https://raw.githubusercontent.com/TIDYAPP/customer_public_api/master/install.sh | bash

Usage

export TIDY_API_TOKEN=your_bearer_token

# Send a natural-language request
tidy-request "Schedule a deep clean for next Tuesday"

# With context
tidy-request "Fix the broken window" --address-id 123
tidy-request "What's the status of my property?" --booking-id 456

# List past requests
tidy-request --list

# Get a specific request
tidy-request --get REQUEST_ID

Set TIDY_API_HOST to point at a custom environment (default: http://localhost:3000).

Docs & API tokens: https://tidy.com/developers

README

Dry Gems

This project is using Dry-Initializer and Dry-Types on most of the classes like, Services, UseCases, Queries..

For more information about them those are the docs:

https://dry-rb.org/gems/dry-types/1.2/ https://dry-rb.org/gems/dry-initializer/3.0/

Migration Changes

rake db:create rake db:drop rake db:migrate rails g model customer

ENV's

See all necessary ENV's on .env-sample file