Download the PHP package primitivesocial/bluemoonwrapper without Composer
On this page you can find all versions of the php package primitivesocial/bluemoonwrapper. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download primitivesocial/bluemoonwrapper
More information about primitivesocial/bluemoonwrapper
Files in primitivesocial/bluemoonwrapper
Package bluemoonwrapper
Short Description Bluemoon REST API Wrapper
License MIT
Homepage https://github.com/primitivesocial/bluemoonwrapper
Informations about the package bluemoonwrapper
BlueMoonRestWrapper
Wrapper around the Bluemoon REST API for Laravel.
Installation
Via Composer
Via composer.json file for git repo
Env vars
You must add a config file called bluemoon.php
. The package comes with one for all three Bluemoon setups out of the box.
You can also install the config by running php artisan vendor:publish
.
Usage
Create New Wrapper
The wrapper takes six variables. You can store these in the config or set these in this order:
clientLicense
: The Bluemoon property license.
clientUrl
: The Bluemoon API URL
clientSecret
: The Bluemoon API Secret
clientId
: The Bluemoon API ID
clientUsername
: The Bluemoon API username
clientPassword
: The Bluemoon API password
Setters
setPropertyId($id)
: Bluemoon Property ID of the property you are working with
setExternalId($id)
: For use with an external identifying ID. Helpful for tracking applications or leases in your app.
setApplicationId($id)
: ID of application in Bluemoon
Getters
getApplications
: Gets all Bluemoon applications
getApplication
: Gets Bluemoon application with ID set in setApplicationId
getApplicationAndParse
: Gets Bluemoon application with ID set in setApplicationId
and parses into it's various categories (i.e. pets, vehicles)
getApplicationFields
: Gets all fields associated with applications for the property set in setPropertyId
getLeaseFields
: Gets all fields associated with leases for the property set in setPropertyId
getToken
: Gets bearer token