SDK kit for the Bookwhen API.
PHP 8.1 and later.
Composer
$ composer require inshore/bookwhen
Simply expose your Bookwhen API key as the environment property
INSHORE_BOOKWHEN_API_KEY
via .env or how you prefer.
$bookwhen = new Bookwhen();implements https://api.bookwhen.com/v2#tag/Attachment
Attachments
https://api.bookwhen.com/v2#tag/Attachment/paths/~1attachments/get
// Fetch attachments accessible by the API token.
$attachments = $bookwhen->attachments());Filters
The filter parameters can be passed in as function parameters.
title - Filter on the file title text.
fileName - Filter on the file name.
fileType - Filter on the file type.
// Fetch attachments accessible by the API token.
$attachments = $bookwhen->attachments(fileName: 'CV'));
$attachments = $bookwhen->attachments(fileType: 'pdf'));
$attachments = $bookwhen->attachments(title: 'Title to filter by'));
$attachments = $bookwhen->attachments(fileName: 'CV', fileType: 'pdf', title: 'Title to filter by'));Attachment
https://api.bookwhen.com/v2#tag/Attachment/paths/1attachments1%7Battachment_id%7D/g
// Returns the attachment for the provided attachment ID.
$attachment = $bookwhen->attachment('ev-smij-20200530100000' );
###Class Passes
implements https://api.bookwhen.com/v2#tag/ClassPass
ClassPasses
https://api.bookwhen.com/v2#tag/ClassPass/paths/~1class_passes/get
// Fetch class passes accessible by the API token.
$classPasses = $bookwhen->classPasses());Filters
The filter parameters can be passed in as function parameters
title - Filter on the title text of the pass.
detail - Filter on the details text.
usageType - Filter on the type of the pass: personal or any.
cost - Filter on the cost with an exact value or use a comparison operator. e.g. filter[cost][gte]=2000
gt - greater than
gte - greater than or equal
lt - less than
lte - less than or equal
eq - equal to
usageAllowance - Filter on pass usage allowance. This also accepts a comparison operator like cost.
useRestrictedForDays - Filter on pass days restriction. This also accepts a comparison operator like cost.
// Fetch class passes accessible by the API token.
$classPasses = $bookwhen->classPasses());
$classPasses = $bookwhen->classPasses(title: 'Title to filter by'));ClassPass
https://api.bookwhen.com/v2#tag/ClassPass/paths/~1class_passes~1%7Bclass_pass_id%7D/get
// Returns the class pass for the provided class pass ID.
$classPass = $bookwhen->classPass('ev-smij-20200530100000');https://api.bookwhen.com/v2#tag/Event
Events
https://api.bookwhen.com/v2#tag/Event/paths/~1events/get
// Returns the event for the provided event ID.
$event = $bookwhen->events();Filters
calendar - Restrict to events on the given calendars (schedule pages).
entry - Restrict to given entries.
location - Array of location slugs to include.
tag - Array of tag words to include.
title - Array of entry titles to search for.
detail - Array of entry details to search for.
from - Inclusive time to fetch events from in format YYYYMMDD or YYYYMMDDHHMISS. Defaults to today.
to - Non-inclusive time to fetch events until in format YYYYMMDD or YYYYMMDDHHMISS
compact - Boolean: Combine events in a course into a single virtual event.
Includes
By default the event will NOT have its attachments, location and tickets populated.
To retrieve an event with the included relationships, simply pass boolean true for the relationship that is required.
includeAttachments includeLocation includeTickets includeTickets.class_passes includeTickets.events
for example to retrieve the event with its location and tickets.
// Returns the event for the provided event ID.
$event = $bookwhen->events(title: 'Title to filter by'));Event
https://api.bookwhen.com/v2#tag/Event/paths/1events1%7Bevent_id%7D/get
// Returns the event for the provided event ID.
$event = $bookwhen->event('ev-smij-20200530100000');// Returns the event for the provided event ID.
$event = $bookwhen->event(eventId: 'ev-smij-20200530100000', includeLocation: true, includeTickets: true);###Events###
// Fetch events accessible by the API token.
$events = $bookwhen->events());Filters
The event list can be filtered as per the api documentation
Includes
By default the event will NOT have its attachments, location and tickets populated.
To retrieve an event withg the included relationships, simply pass boolean true for the relationship that is required.
includeAttachments includeLocation includeTickets.class_passes includeTickets.events
for example to retrieve the event with its location and tickets.
// Fetch events accessible by the API token.
$events = $bookwhen->events(location: true, includeTickets: true);));Implements https://api.bookwhen.com/v2#tag/Location
Locations
https://api.bookwhen.com/v2#tag/Location/paths/~1locations/get
// Fetch events accessible by the API token.
$locations = $bookwhen->locations());
// Returns the location for the provided location ID.Filters
addressText - Restrict to locations containing the address text filter.
additionalInfo - Filter by the text contained in the additional info.
// Fetch events accessible by the API token.
$locations = $bookwhen->locations(addressText: 'Remote'));
// Returns the location for the provided location ID.Location
https://api.bookwhen.com/v2#tag/Location/paths/1locations1%7Blocation_id%7D/get
// Returns the location for the provided location ID.
$location = $bookwhen->location('ev-smij-20200530100000');Implements https://api.bookwhen.com/v2#tag/Ticket
Tickets
https://api.bookwhen.com/v2#tag/Ticket/paths/~1tickets/get
// Fetch tickets for the given event.
$eventId = 'ev-smij-20200530100000';
$client->tickets($eventId);Includes
By default the tickets will NOT have its attachments, evetns and location populated.
To retrieve an event withg the included relationships, simply pass boolean true for the relationship that is required.
includeAttachments includeLocation includeTickets.class_passes includeTickets.events
// Fetch tickets for the given event.
$eventId = 'ev-smij-20200530100000';
$client->tickets($eventId, includeAttachments: true);Ticket
https://api.bookwhen.com/v2#tag/Ticket/paths/1tickets1%7Bticket_id%7D/get
// Retrieve a single ticket.
$ticketId = 'ti-sboe-20200320100000-tk1m';
$client->ticket($ticketId);Includes
By default the tickets will NOT have its attachments, evetns and location populated.
To retrieve an event withg the included relationships, simply pass boolean true for the relationship that is required.
includeAttachments includeLocation includeTickets.class_passes includeTickets.events
// Retrieve a single ticket.
$client->ticket('ti-sboe-20200320100000-tk1m', includeAttachments: true););Full syslog level logging is available and can be enabled by passing a level in when instatiating the Client. As illustrated in RFC 5424 which describes the syslog protocol, the following levels of intensity are applied.
DEBUG: Detailed debugging information. INFO: Handles normal events. Example: SQL logs NOTICE: Handles normal events, but with more important events WARNING: Warning status, where you should take an action before it will become an error. ERROR: Error status, where something is wrong and needs your immediate action CRITICAL: Critical status. Example: System component is not available ALERT: Immediate action should be exercised. This should trigger some alerts and wake you up during night time. EMERGENCY: It is used when the system is unusable.
$bookwhen = new Bookwhen()->debug('Debug');
WIP
$ composer phpunitPlease see https://github.com/inshore/bookwhen/blob/develop/CONTRIBUTING.md for details.
If you require assistance with this package or implementing in your own project or business...
<script type="text/javascript" src="https://cdnjs.buymeacoffee.com/1.0.0/button.prod.min.js" data-name="bmc-button" data-slug="danielmullin" data-color="#FFDD00" data-emoji="" data-font="Cookie" data-text="Buy me a coffee" data-outline-color="#000000" data-font-color="#000000" data-coffee-color="#ffffff" ></script>https://www.buymeacoffee.com/danielmullin
- Daniel Mullin inshore@danielmullin.com
- Brandon Lubbehusen inshore@danielmullin.com
This package was heavily influenced by Nuno Maduro and the https://github.com/openai-php/client package.
MIT https://github.com/inshore/bookwhen/blob/master/LICENSE.md