Download the PHP package bonroyage/tripleseat without Composer
On this page you can find all versions of the php package bonroyage/tripleseat. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package tripleseat
PHP wrapper for Tripleseat API
A simple PHP wrapper around Tripleseat's API.
Requires at least PHP 8.2
Until v1 there may be backward incompatible changes with every minor version (0.x).
Getting started
First, create a new instance of the Tripleseat client and provide the API keys for authentication.
API keys
You'll need to attain your Tripleseat account's API keys. These can be found by logging in to your Tripleseat account and going to Settings -> Tripleseat API.
There is a public and secret key that is used for the majority of the API calls. These values are configured as the api_key
and secret_key
respectively.
A second public key is shown separately and is used for some lead operations. This is configured as public_key
.
Services
The following services are supported
Service | Documentation | Schema |
---|---|---|
Account | Tripleseat documentation | Schema |
Booking | Tripleseat documentation | Schema |
Contact | Tripleseat documentation | Schema |
Event | Tripleseat documentation | Schema |
Lead | Tripleseat documentation | Schema |
Location | Tripleseat documentation | Schema |
Site | Tripleseat documentation | Schema |
User | Tripleseat documentation | Schema |
Sites
A site represents a group of venues. Sites can have multiple locations.
You will most likely only need to retrieve or alter data for a single site, this is also enforced by Tripleseat. For example, you cannot create a contact that belongs to an account in a different site.
An InvalidSite
exception will be thrown if the site is not in the list of sites that your API keys give you access to.
What does it do in the background?
When you call an offset on the Tripleseat class, it first checks that the site ID is returned by the sites endpoint and then created a new instance of the Tripleseat class with the site_id
passed as additional property in the $auth
array.
Every request made with through this class will have site_id
added to the query parameters of each request.
What about endpoints that don't use site_id?
Endpoints like site
, location
, and user
don't support the site_id
parameter. They will always return the same result regardless of what site ID is passed.
all
and search
operations
When querying one of the all
or search
endpoints, the client will return a PaginatedResponse. These endpoints are paged and return 50 results per page.
The PaginatedResponse class is iterable (over the results loaded in that page). It also features the following helpers:
currentPage(): int
- gets the current page numbertotalPages(): int
- gets the total number of pageshasMore(): bool
- checks if the page number is below the total number of pagesnext(): ?PaginatedResponse
- get the next page (if applicable)results(): array
- get an array of this page's resultsall(): array
- load results from all pages into an arrayuntilPage(int $page): array
- load results from current until given page into an array
Note: The site
and location
services are not paged.
Other operations
Service | get(id) |
create(payload) |
update(id, payload) |
delete(id) |
---|---|---|---|---|
Account | ✅ | ✅ | ✅ | ✅ |
Booking | ✅ | ✅ | ✅ | ✅ |
Contact | ✅ | ✅ | ✅ | ✅ |
Event | ✅ | ✅ | ✅ | ✅ |
Lead | ✅ | ✅ (?) | ❌ | ✅ |
Location | ❌ | ❌ | ❌ | ❌ |
Site | ❌ | ❌ | ❌ | ❌ |
User | ✅ | ❌ | ❌ | ❌ |
Create and update payloads
Pass in the actual payload and the client will automatically wrap this with the correct key for the type. You can also provide an array with the payload already wrapped, this will not be wrapped again.
Exceptions
All exceptions thrown by this library implement the Tripleseat\Exceptions\TripleseatException
interface.
HTTP Client Compatibilities
You could use any PSR-18 compatible client to use with this library. No additional configurations are required. A list of compatible HTTP clients and client adapters can be found at php-http.org.
All versions of tripleseat with dependencies
ext-json Version *
php-http/client-implementation Version ^1.0
psr/http-factory Version ^1.0
php-http/discovery Version ^1.0
api-clients/psr7-oauth1 Version ^3.0