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 & Usage

Requirements

PHP 7.2 and later.

Composer

    "require": {
        "aryeohq/aryeo-api-php-sdk": "dev-master"
    },
    "repositories": [
        {
            "url": "git@github.com:AryeoHQ/aryeo-api-php-sdk.git",
            "type": "vcs"
        }
    ]

Getting Started

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$config = Aryeo\Configuration::getDefaultConfiguration()->setAccessToken('API_KEY');

$apiInstance = new Aryeo\Api\ListingsApi(null, $config);

$uuid = "UUID";

try {
    $result = $apiInstance->getListingsId($uuid);
    echo $result["data"]["address"]["address_line_1"], "\n";
} catch (Exception $e) {
    echo 'Exception when calling ListingsApi->getListingsId: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

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

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

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

Authorization

Token

• Type: Bearer authentication

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

jarrod@aryeo.com