Methods

__construct()

__construct(array  $data = array()) 

Create new Empyr user.

Parameters

array $data

Data to set field with.

Throws

\GuzzleHttp\Exception\GuzzleException
\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields

lookup()

lookup(  $email = '') : \Linusx\Empyr\Controllers\EmpyrUser

Lookup user by email.

Parameters

$email

Throws

\GuzzleHttp\Exception\GuzzleException
\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields

Returns

\Linusx\Empyr\Controllers\EmpyrUser

user()

user(integer  $id) : \Linusx\Empyr\Controllers\EmpyrUser

Lookup user by ID.

Parameters

integer $id

User ID to get

Throws

\GuzzleHttp\Exception\GuzzleException

Returns

\Linusx\Empyr\Controllers\EmpyrUser

alerts()

alerts(array  $options = array()) : \Linusx\Empyr\Controllers\EmpyrUser

Get alerts for a user.

Parameters

array $options

Throws

\GuzzleHttp\Exception\GuzzleException
\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields

Returns

\Linusx\Empyr\Controllers\EmpyrUser

donations()

donations(array  $options = array()) : \Linusx\Empyr\Controllers\EmpyrUser

Get donation list for a user.

Parameters

array $options

Throws

\GuzzleHttp\Exception\GuzzleException
\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields

Returns

\Linusx\Empyr\Controllers\EmpyrUser

forgotPassword()

forgotPassword() : \Linusx\Empyr\Controllers\EmpyrUser

Get donation list for a user.

Throws

\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields
\GuzzleHttp\Exception\GuzzleException

Returns

\Linusx\Empyr\Controllers\EmpyrUser

listOAuth()

listOAuth() : \Linusx\Empyr\Controllers\EmpyrUser

Get donation list for a user.

Throws

\GuzzleHttp\Exception\GuzzleException
\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields

Returns

\Linusx\Empyr\Controllers\EmpyrUser

notificationSettings()

notificationSettings() : \Linusx\Empyr\Controllers\EmpyrUser

Retrieves the notification settings for a user.

Throws

\GuzzleHttp\Exception\GuzzleException
\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields

Returns

\Linusx\Empyr\Controllers\EmpyrUser

payments()

payments(array  $options = array()) : \Linusx\Empyr\Controllers\EmpyrUser

Retrieves a list of payments for the given user.

Parameters

array $options

Throws

\GuzzleHttp\Exception\GuzzleException
\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields

Returns

\Linusx\Empyr\Controllers\EmpyrUser

rewardList()

rewardList(array  $options = array()) : \Linusx\Empyr\Controllers\EmpyrUser

Returns a list of cash rewards.

Parameters

array $options

Throws

\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields
\GuzzleHttp\Exception\GuzzleException

Returns

\Linusx\Empyr\Controllers\EmpyrUser

search()

search(string  $query = '', array  $options = array()) : \Linusx\Empyr\Controllers\EmpyrUser

Will search for users based on their first and last name.

Parameters

string $query
array $options

Throws

\GuzzleHttp\Exception\GuzzleException

Returns

\Linusx\Empyr\Controllers\EmpyrUser

signupWithCard()

signupWithCard() : \Linusx\Empyr\Controllers\EmpyrUser

Signs up a user with an associated card.

Note that if the user already exists then the card will be added to the account.

Returns

\Linusx\Empyr\Controllers\EmpyrUser

friendsList()

friendsList(array  $options = array()) : \Linusx\Empyr\Controllers\EmpyrUser

Retrieves a list of friends for the user.

Parameters

array $options

Throws

\GuzzleHttp\Exception\GuzzleException
\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields

Returns

\Linusx\Empyr\Controllers\EmpyrUser

fundraiserHistory()

fundraiserHistory(array  $options = array()) : \Linusx\Empyr\Controllers\EmpyrUser

Returns a list of fundraiser user totals.

Parameters

array $options

Throws

\GuzzleHttp\Exception\GuzzleException
\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields

Returns

\Linusx\Empyr\Controllers\EmpyrUser

leaderboard()

leaderboard(array  $options = array()) : \Linusx\Empyr\Controllers\EmpyrUser

Retrieves a leaderboard for the given user.

Parameters

array $options

Throws

\GuzzleHttp\Exception\GuzzleException
\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields

Returns

\Linusx\Empyr\Controllers\EmpyrUser

recommendations()

recommendations(array  $options = array()) : \Linusx\Empyr\Controllers\EmpyrUser

Will retrieve a list of user recommendations or alternatively if businesses are provided it will check if one of the provided businesses is in the recommendations list.

Parameters

array $options

Throws

\GuzzleHttp\Exception\GuzzleException
\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields

Returns

\Linusx\Empyr\Controllers\EmpyrUser

summary()

summary(array  $options = array()) : \Linusx\Empyr\Controllers\EmpyrUser

Retrieves the most recent summary of information and data about a user.

Parameters

array $options

Throws

\GuzzleHttp\Exception\GuzzleException
\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields

Returns

\Linusx\Empyr\Controllers\EmpyrUser

transactions()

transactions(array  $options = array()) : \Linusx\Empyr\Controllers\EmpyrUser

Retrieves a list of transactions for the given user.

Parameters

array $options

Throws

\GuzzleHttp\Exception\GuzzleException
\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields

Returns

\Linusx\Empyr\Controllers\EmpyrUser

venueHistory()

venueHistory(array  $options = array()) : \Linusx\Empyr\Controllers\EmpyrUser

Retrieves the most recent summary of information and data about a user.

Parameters

array $options

Throws

\GuzzleHttp\Exception\GuzzleException
\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields

Returns

\Linusx\Empyr\Controllers\EmpyrUser

addReward()

addReward(array  $options = array()) : \Linusx\Empyr\Controllers\EmpyrUser

Retrieves the most recent summary of information and data about a user.

Parameters

array $options

Throws

\GuzzleHttp\Exception\GuzzleException
\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields

Returns

\Linusx\Empyr\Controllers\EmpyrUser

alertsDismiss()

alertsDismiss(array  $options = array()) : \Linusx\Empyr\Controllers\EmpyrUser

Decrements the number of alerts for the logged in user by the specified amount.

Parameters

array $options

Throws

\GuzzleHttp\Exception\GuzzleException
\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields

Returns

\Linusx\Empyr\Controllers\EmpyrUser

friendApprove()

friendApprove(array  $options = array()) : \Linusx\Empyr\Controllers\EmpyrUser

Approve a friendship request.

Parameters

array $options

Throws

\GuzzleHttp\Exception\GuzzleException
\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields

Returns

\Linusx\Empyr\Controllers\EmpyrUser

friendDeny()

friendDeny(array  $options = array()) : \Linusx\Empyr\Controllers\EmpyrUser

Deny/Unfriend a user.

Parameters

array $options

Throws

\GuzzleHttp\Exception\GuzzleException
\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields

Returns

\Linusx\Empyr\Controllers\EmpyrUser

donate()

donate(array  $options = array()) : \Linusx\Empyr\Controllers\EmpyrUser

Performs a donation on behalf of the acting user.

Parameters

array $options

Throws

\GuzzleHttp\Exception\GuzzleException
\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields

Returns

\Linusx\Empyr\Controllers\EmpyrUser

invite()

invite(array  $options = array()) : \Linusx\Empyr\Controllers\EmpyrUser

Will invite users on behalf of the current user.

Parameters

array $options

Throws

\GuzzleHttp\Exception\GuzzleException
\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields

Returns

\Linusx\Empyr\Controllers\EmpyrUser

offerLink()

offerLink(array  $options = array()) : \Linusx\Empyr\Controllers\EmpyrUser

Link a business and a user.

Parameters

array $options

Throws

\GuzzleHttp\Exception\GuzzleException
\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields

Returns

\Linusx\Empyr\Controllers\EmpyrUser

offerLinksList()

offerLinksList(array  $options = array()) : \Linusx\Empyr\Controllers\EmpyrUser

Get a list of links for a user.

Parameters

array $options

Throws

\GuzzleHttp\Exception\GuzzleException
\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields

Returns

\Linusx\Empyr\Controllers\EmpyrUser

oauthLink()

oauthLink(array  $options = array()) : \Linusx\Empyr\Controllers\EmpyrUser

Links/stores OAuth credentials for a user.

Parameters

array $options

Throws

\GuzzleHttp\Exception\GuzzleException
\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields

Returns

\Linusx\Empyr\Controllers\EmpyrUser

oauthUnlink()

oauthUnlink(array  $options = array()) : \Linusx\Empyr\Controllers\EmpyrUser

UnLinks OAuth credentials for a user.

Parameters

array $options

Throws

\GuzzleHttp\Exception\GuzzleException
\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields

Returns

\Linusx\Empyr\Controllers\EmpyrUser

friendRequest()

friendRequest(array  $options = array()) : \Linusx\Empyr\Controllers\EmpyrUser

Request a friendship with the provided user.

Parameters

array $options

Throws

\GuzzleHttp\Exception\GuzzleException
\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields

Returns

\Linusx\Empyr\Controllers\EmpyrUser

offerUnlink()

offerUnlink(array  $options = array()) : \Linusx\Empyr\Controllers\EmpyrUser

Unlink a previously linked offer.

Parameters

array $options

Throws

\GuzzleHttp\Exception\GuzzleException
\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields

Returns

\Linusx\Empyr\Controllers\EmpyrUser

add()

add(array  $options = array()) : \Linusx\Empyr\Controllers\EmpyrUser

Signs up a user.

Parameters

array $options

Throws

\GuzzleHttp\Exception\GuzzleException
\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields

Returns

\Linusx\Empyr\Controllers\EmpyrUser

update()

update(array  $options = array()) : \Linusx\Empyr\Controllers\EmpyrUser

Updates a user with the provided settings.

Parameters

array $options

Throws

\GuzzleHttp\Exception\GuzzleException
\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields

Returns

\Linusx\Empyr\Controllers\EmpyrUser

updatePhoto()

updatePhoto(string  $file_path) : \Linusx\Empyr\Controllers\EmpyrUser

Update profile picture.

Parameters

string $file_path

File path to send.

Throws

\GuzzleHttp\Exception\GuzzleException
\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields

Returns

\Linusx\Empyr\Controllers\EmpyrUser

updatePassword()

updatePassword(array  $options = array()) : \Linusx\Empyr\Controllers\EmpyrUser

Updates a user's secure settings requiring a password.

Parameters

array $options

Throws

\GuzzleHttp\Exception\GuzzleException
\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields

Returns

\Linusx\Empyr\Controllers\EmpyrUser