Aryeo SDK

Introduction

This is an auto-generated client SDK for interfacing with the Aryeo API. We support a variety of languages and frameworks that are a great starting point for experimenting with the API. If there is an additional language or framework that you want to see supported, then please reach out and make a contribution!

Authentication

To start using the Aryeo API, you will need to generate an API key from your group's developer settings. Then, make sure to provide your API key as a bearer token. Requests made without an API key will result in a 401 Unauthorized error.

Example: Authorization: Bearer {API_KEY}

Installation

Add the following block to Cargo.toml:

[dependencies]
aryeo = { git = "https://github.com/AryeoHQ/aryeo-api-rust-sdk", branch = "master" }

Getting Started

use aryeo::apis::{configuration::Configuration, listings_api as aryeo_api};

#[tokio::main]
async fn main() {
    let mut config = Configuration::default();    
    config.bearer_access_token = Some(String::from("API_KEY"));
    
    let result = aryeo_api::get_listings_id(
        &config, 
        "UUID"
    )
    .await;

    let result = match result {
        Ok(result) => result,
        Err(error) => panic!("Something went wrong, {:?}", error),
    };
    
    println!("{:?}", result);
}

Documentation for API Endpoints

All URIs are relative to https://api.aryeo.com/v1

Class	Method	HTTP request	Description
AppointmentsApi	get_appointments	GET /appointments	List all appointments.
AppointmentsApi	get_available_dates	GET /scheduling/available-dates	Fetch available days for a user or group
AppointmentsApi	get_available_timeslots	GET /scheduling/available-timeslots	Fetch available timeslots for a user or group
AppointmentsApi	get_unconfirmed_appointments	GET /unconfirmed-appointments	List all unconfirmed appointments.
AppointmentsApi	get_unconfirmed_appointments_id	GET /unconfirmed-appointments/{unconfirmed_appointment_id}	Retrieve an unconfirmed appointment.
AppointmentsApi	put_appointments_appointment_id_cancel	PUT /appointments/{appointment_id}/cancel	Cancel an appointment.
AppointmentsApi	put_appointments_appointment_id_reschedule	PUT /appointments/{appointment_id}/reschedule	Reschedule an appointment.
ListingsApi	get_listings	GET /listings	List all listings.
ListingsApi	get_listings_id	GET /listings/{listing_id}	Retrieve a listing.
OrdersApi	get_orders	GET /orders	List all orders.
OrdersApi	get_orders_id	GET /orders/{order_id}	Retrieve an order.
OrdersApi	get_products	GET /products	List all products.
OrdersApi	post_orders	POST /orders	Create an order.
VendorsApi	get_vendors	GET /vendors	List all vendors.
VendorsApi	get_vendors_id	GET /vendors/{vendor_id}	Retrieve a vendor.

Documentation For Models

• Address
• ApiError403
• ApiError404
• ApiError409
• ApiError500
• ApiFail422
• Appointment
• AppointmentCancelPutPayload
• AppointmentCollection
• AppointmentReschedulePutPayload
• AppointmentResource
• CalendarDay
• CalendarDayCollection
• FloorPlan
• Group
• GroupCollection
• GroupResource
• Image
• InteractiveContent
• Listing
• ListingBuilding
• ListingCollection
• ListingLot
• ListingPrice
• ListingResource
• Order
• OrderCollection
• OrderForm
• OrderItem
• OrderPostPayload
• OrderResource
• PaginationLinks
• PaginationMeta
• Product
• ProductCategory
• ProductCollection
• ProductVariant
• PropertyWebsite
• SocialProfiles
• Timeslot
• TimeslotCollection
• UnconfirmedAppointment
• UnconfirmedAppointmentCollection
• UnconfirmedAppointmentResource
• User
• Video

To get access to the crate's generated documentation, use:

cargo doc --open

Author

jarrod@aryeo.com