Download the PHP package capeandbay/birdeye without Composer
On this page you can find all versions of the php package capeandbay/birdeye. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download capeandbay/birdeye
More information about capeandbay/birdeye
Files in capeandbay/birdeye
Package birdeye
Short Description Client-side SDK Package for Laravel that integrates with the BirdEye REST API
License MIT
Homepage https://github.com/capeandbay/birdeye
Informations about the package birdeye
BirdEye Service SDK for Laravel
BirdEye helps your business be found and chosen by new customers, be connected with your existing customers, and deliver the best end-to-end customer experience.
This is an implementation of the BirdEye REST API designed to be used with Laravel PHP Framework v6, 7 and beyond.
Cape & Bay is not affiliated with BirdEye. We prefer to build custom packages for our needs, but it may also help you or be a good reference for your own implementation.
Getting Started
Quick Links
- Installation
- Configuration
- Seed the Database
- Using the Trait
- Usage
- Check In
- Change Log
- Contributing
- Security
- License
Installation
Via Composer
The package will automatically register itself. You can optionally publish the config file with:
The settings can be found in the generated config/birdeye.php
configuration file. .
You can publish the migration with:
If you need to, update the config, before running the migration.
After publishing the migration you can create the birdeye_businesses
table by running the migrations:
Configuration
By default, the package uses the following environment variables to auto-configure the plugin without modification:
Note that you can always swap out preloaded classes with a project's arbitrary own; the package will use that class in that context.
Using Multiple Accounts
To use multiple accounts, leave config('birdeye.deets.parent_business_id)
blank.
Instead, populate config('birdeye.accounts)
like the following example
Finally, run the cron php artisan birdeye:init
to migrate the child businesses of each parent.
Migrate the Child Business Data
Run the built-in CLI Command to migrate the accounts' child business into the ecosystem
You can run this command again to add new accounts' child businesses, by adding to the config and running again
Using the Trait
This package is bundle with a simple trait that when coupled with one of your project's
Eloquent models can link to any of the records in the birdeye_businesses
table by
use of an Eloquent relation.
Start by Adding the trait to one of your project's models by including the dependancy and
importing the trait HasBirdEyeBusiness
like so -
Be sure to include $birdeye_id_column
where 'some_column'
is the foreign key
to birdeye_businesses.internal_id
Note - that in order to complete the relationship you will need to manually
enter the relationship id or roll your own automated method.
This exposes an elequent relation birdeye_business()
that an be used in queries.
To use the trait, peep this example and adapt -
The contents of the BirdEye Business are available to be used with rest of the package Library to ping BirdEye to interface with them!
Usage
Check an EndUser Customer into a business
Change log
Please see the changelog for more information on what has changed recently.
Contributing
Please see contributing.md for details and a todolist.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
- Angel Gonzalez
- All Contributors
License
MIT. Please see the license file for more information.
All versions of birdeye with dependencies
ixudra/curl Version ^6.19
goldspecdigital/laravel-eloquent-uuid Version ^6.0|^7.0|^8.0