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 package.json:

"dependencies": {
  "aryeo": "github:AryeoHQ/aryeo-api-js-sdk"
}

Getting Started

var Aryeo = require('aryeo');

var defaultClient = Aryeo.ApiClient.instance;

var JWT = defaultClient.authentications['JWT'];
JWT.accessToken = "API_KEY"

var api = new Aryeo.ListingsApi()
api.getListingsId("UUID", (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log(`${data.data.address.address_line_1}`);
  }
});

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
Aryeo.AppointmentsApi	getAppointments	GET /appointments	List all appointments.
Aryeo.AppointmentsApi	getAvailableDates	GET /scheduling/available-dates	Fetch available days for a user or group
Aryeo.AppointmentsApi	getAvailableTimeslots	GET /scheduling/available-timeslots	Fetch available timeslots for a user or group
Aryeo.AppointmentsApi	getUnconfirmedAppointments	GET /unconfirmed-appointments	List all unconfirmed appointments.
Aryeo.AppointmentsApi	getUnconfirmedAppointmentsId	GET /unconfirmed-appointments/{unconfirmed_appointment_id}	Retrieve an unconfirmed appointment.
Aryeo.AppointmentsApi	putAppointmentsAppointmentIdCancel	PUT /appointments/{appointment_id}/cancel	Cancel an appointment.
Aryeo.AppointmentsApi	putAppointmentsAppointmentIdReschedule	PUT /appointments/{appointment_id}/reschedule	Reschedule an appointment.
Aryeo.ListingsApi	getListings	GET /listings	List all listings.
Aryeo.ListingsApi	getListingsId	GET /listings/{listing_id}	Retrieve a listing.
Aryeo.OrdersApi	getOrders	GET /orders	List all orders.
Aryeo.OrdersApi	getOrdersId	GET /orders/{order_id}	Retrieve an order.
Aryeo.OrdersApi	getProducts	GET /products	List all products.
Aryeo.OrdersApi	postOrders	POST /orders	Create an order.
Aryeo.VendorsApi	getVendors	GET /vendors	List all vendors.
Aryeo.VendorsApi	getVendorsId	GET /vendors/{vendor_id}	Retrieve a vendor.

Documentation for Models

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

Documentation for Authorization

Token

• Type: Bearer authentication

Author

jarrod@aryeo.com