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 to Package.swift:

    dependencies: [        
        .package(name: "Aryeo", url: "https://github.com/AryeoHQ/aryeo-api-swift-sdk", .branch("master")),
    ],

Getting Started

import Foundation
import Aryeo

let jwt = "API_KEY"
let uuid = UUID(uuidString: "UUID")!

let dispatchGroup = DispatchGroup()
dispatchGroup.enter()

ListingsAPI.getListingsIdWithRequestBuilder(uuid: uuid)
    .addHeader(name: "Accept", value: "application/json")
    .addHeader(name: "Authorization", value: "Bearer \(jwt)")
    .execute(Aryeo.apiResponseQueue) { result -> Void in
    switch result {
    case let .success(response):
        dump(response.body?.data?.address.addressLine1)
        dispatchGroup.leave()
    case let .failure(error):
        dump(error)
        dispatchGroup.leave()
    }
}

dispatchGroup.notify(queue: DispatchQueue.main) {
    exit(EXIT_SUCCESS)
}

dispatchMain()

Documentation for 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.

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

Documentation For Authorization

Token

• Type: HTTP basic authentication

Author

jarrod@aryeo.com