NAME

WebService::Bonusly - A handy library for accessing the Bonus.ly API

VERSION

version 0.151580

SYNOPSIS

use WebService::Bonusly;
my $bonusly = WebService::Bonusly->new( token => $token );
    
$res = $bonusly->authentication->sessions(
    email => '...',
    password => '...',
);
    
$res = $bonusly->bonuses->get( id => '...' );
$res = $bonusly->bonuses->give(
    receiver_email => '...',
    reason => '...',
    amount => 42,
);
$res = $bonusly->bonuses->list;
    
$res = $bonusly->companies->show;
$res = $bonusly->companies->update;
    
$res = $bonusly->leaderboards->standouts;
    
$res = $bonusly->redemptions->get( id => '...' );
    
$res = $bonusly->rewards->get( id => '...' );
$res = $bonusly->rewards->list;
$res = $bonusly->rewards->take(
    denomination_id => '...',
    user_id => '...',
);
    
$res = $bonusly->users->add(
    email => '...',
    first_name => '...',
    last_name => '...',
);
$res = $bonusly->users->delete( id => '...' );
$res = $bonusly->users->get( id => '...' );
$res = $bonusly->users->list;
$res = $bonusly->users->redemptions;
$res = $bonusly->users->update( id => '...' );
    
$res = $bonusly->values->get( id => '...' );
$res = $bonusly->values->list;

DESCRIPTION

This is a fairly simple library for performing actions with the Bonus.ly API.

ATTRIBUTES

token

This is the access token to use to perform actions with.

authentication

This provides methods for accessing the Authentication aspects of the API. This provides the following methods:

sessions

$res = $bonusly->authentication->sessions(%params);

Performs a POST against /api/v1/sessions at bonus.ly.

Required Parameters: email, password

bonuses

This provides methods for accessing the Bonuses aspects of the API. This provides the following methods:

get

$res = $bonusly->bonuses->get(%params);

Performs a GET against /api/v1/bonuses/:id at bonus.ly.

Required Parameters: id

give

$res = $bonusly->bonuses->give(%params);

Performs a POST against /api/v1/bonuses at bonus.ly.

Required Parameters: receiver_email, reason, amount

Optional Parameters: giver_email

list

$res = $bonusly->bonuses->list(%params);

Performs a GET against /api/v1/bonuses at bonus.ly.

Optional Parameters: limit, start_time, end_time, non_zero, top_level, giver_email, receiver_email, user_email, hashtag

companies

This provides methods for accessing the Companies aspects of the API. This provides the following methods:

show

$res = $bonusly->companies->show;

Performs a GET against /api/v1/companies/show at bonus.ly.

update

$res = $bonusly->companies->update(%params);

Performs a PUT against /api/v1/companies/update at bonus.ly.

Optional Parameters: name, custom_properties

The custom_properties parameter must be given a reference to a hash.

leaderboards

This provides methods for accessing the Leaderboards aspects of the API. This provides the following methods:

standouts

$res = $bonusly->leaderboards->standouts(%params);

Performs a GET against /api/v1/analytics/standouts at bonus.ly.

Optional Parameters: role, value, custom_property_name, custom_property_value

redemptions

This provides methods for accessing the Redemptions aspects of the API. This provides the following methods:

get

$res = $bonusly->redemptions->get(%params);

Performs a GET against /api/v1/redemptions/:id at bonus.ly.

Required Parameters: id

rewards

This provides methods for accessing the Rewards aspects of the API. This provides the following methods:

get

$res = $bonusly->rewards->get(%params);

Performs a GET against /api/v1/rewards/:id at bonus.ly.

Required Parameters: id

list

$res = $bonusly->rewards->list(%params);

Performs a GET against /api/v1/rewards at bonus.ly.

Optional Parameters: catalog_country, request_country, personalize_for

take

$res = $bonusly->rewards->take(%params);

Performs a POST against /api/v1/rewards at bonus.ly.

Required Parameters: denomination_id, user_id

users

This provides methods for accessing the Users aspects of the API. This provides the following methods:

add

$res = $bonusly->users->add(%params);

Performs a POST against /api/v1/users at bonus.ly.

Required Parameters: email, first_name, last_name

Optional Parameters: custom_properties, user_mode, budget_boost, external_unique_id

The custom_properties parameter must be given a reference to a hash.

delete

$res = $bonusly->users->delete(%params);

Performs a DELETE against /api/v1/users/:id at bonus.ly.

Required Parameters: id

get

$res = $bonusly->users->get(%params);

Performs a GET against /api/v1/users/:id at bonus.ly.

Required Parameters: id

list

$res = $bonusly->users->list;

Performs a GET against /api/v1/users at bonus.ly.

redemptions

$res = $bonusly->users->redemptions;

Performs a GET against /api/v1/users/:id/redemptions at bonus.ly.

update

$res = $bonusly->users->update(%params);

Performs a PUT against /api/v1/users/:id at bonus.ly.

Required Parameters: id

Optional Parameters: email, first_name, last_name, custom_properties, user_mode, budget_boost, external_unique_id

The custom_properties parameter must be given a reference to a hash.

values

This provides methods for accessing the Values aspects of the API. This provides the following methods:

get

$res = $bonusly->values->get(%params);

Performs a GET against /api/v1/values/:id at bonus.ly.

Required Parameters: id

list

$res = $bonusly->values->list;

Performs a GET against /api/v1/values at bonus.ly.

AUTHOR

Andrew Sterling Hanenkamp <hanenkamp@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2015 by Qubling Software LLC.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

cpanm WebService::Bonusly

perl -MCPAN -e shell
install WebService::Bonusly