Download the PHP package inshore/laravel-bookwhen without Composer
On this page you can find all versions of the php package inshore/laravel-bookwhen. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download inshore/laravel-bookwhen
More information about inshore/laravel-bookwhen
Files in inshore/laravel-bookwhen
Package laravel-bookwhen
Short Description Bookwhen API SDK providing plug & play access to the Bookwhen booking platform inside you Laravel application.
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package laravel-bookwhen
inShore.je - Laravel Bookwhen PHP API SDK
Laravel SDK kit for the Bookwhen API.
Install
Requirements
PHP 8.1 and later.
Composer
Usage
Firstly ensure that the config and other items have been published by running vendor:publish
Select the InShore\Bookwhen\ServiceProvider option.
Now simply add your Bookwhen API key to your .env
You can then check evberything is working by going to http://localhost:8000/bookwhen/ in your browser or as per your setup.
Beyond this to actually access your Bookwhen data include the Booikwhen facade.
Then use as follows...
Attachments
implements https://api.bookwhen.com/v2#tag/Attachment
Attachments
https://api.bookwhen.com/v2#tag/Attachment/paths/~1attachments/get
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.
Attachment
https://api.bookwhen.com/v2#tag/Attachment/paths/~1attachments~1%7Battachment_id%7D/g
Class Passes
implements https://api.bookwhen.com/v2#tag/ClassPass
ClassPasses
https://api.bookwhen.com/v2#tag/ClassPass/paths/~1class_passes/get
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.
ClassPass
https://api.bookwhen.com/v2#tag/ClassPass/paths/~1class_passes~1%7Bclass_pass_id%7D/get
Events
https://api.bookwhen.com/v2#tag/Event
Events
https://api.bookwhen.com/v2#tag/Event/paths/~1events/get
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.
Event
https://api.bookwhen.com/v2#tag/Event/paths/~1events~1%7Bevent_id%7D/get
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.
Locations
Implements https://api.bookwhen.com/v2#tag/Location
Locations
https://api.bookwhen.com/v2#tag/Location/paths/~1locations/get
Filters
addressText - Restrict to locations containing the address text filter.
additionalInfo - Filter by the text contained in the additional info.
Location
https://api.bookwhen.com/v2#tag/Location/paths/~1locations~1%7Blocation_id%7D/get
Tickets
Implements https://api.bookwhen.com/v2#tag/Ticket
Tickets
https://api.bookwhen.com/v2#tag/Ticket/paths/~1tickets/get
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
Ticket
https://api.bookwhen.com/v2#tag/Ticket/paths/~1tickets~1%7Bticket_id%7D/get
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
Logging
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');
Testing
WIP
Contributing
Please see https://github.com/inshore/laravel-bookwhen/blob/main/CONTRIBUTING.md for details.
Support
If you require assistance with this package or implementing in your own project or business...
https://www.buymeacoffee.com/danielmullin
Credits
- Daniel Mullin [email protected]
- Brandon Lubbehusen [email protected]
License
MIT
https://github.com/inshore/laravel-bookwhen/blob/main/LICENSE.md
