API::Trello - Trello.com API Client
version 0.06
use API::Trello; my $trello = API::Trello->new( key => 'KEY', token => 'TOKEN', identifier => 'APPLICATION NAME', ); $trello->debug(1); $trello->fatal(1); my $board = $trello->boards('4d5ea62fd76a'); my $results = $board->fetch; # after some introspection $board->update( ... );
This distribution provides an object-oriented thin-client library for interacting with the Trello (http://trello.com) API. For usage and documentation information visit https://trello.com/docs/gettingstarted/index.html. API::Trello is derived from API::Client and inherits all of it's functionality. Please read the documentation for API::Client for more usage information.
$trello->identifier; $trello->identifier('IDENTIFIER');
The identifier attribute should be set to a string that identifies your application.
$trello->key; $trello->key('KEY');
The key attribute should be set to the account holder's API key.
$trello->token; $trello->token('TOKEN');
The token attribute should be set to the account holder's API access token.
The identifier attribute should be set using a string to identify your app.
$trello->debug; $trello->debug(1);
The debug attribute if true prints HTTP requests and responses to standard out.
$trello->fatal; $trello->fatal(1);
The fatal attribute if true promotes 4xx and 5xx server response codes to exceptions, a API::Client::Exception object.
$trello->retries; $trello->retries(10);
The retries attribute determines how many times an HTTP request should be retried if a 4xx or 5xx response is received. This attribute defaults to 0.
$trello->timeout; $trello->timeout(5);
The timeout attribute determines how long an HTTP connection should be kept alive. This attribute defaults to 10.
$trello->url; $trello->url(Mojo::URL->new('https://api.trello.com'));
The url attribute set the base/pre-configured URL object that will be used in all HTTP requests. This attribute expects a Mojo::URL object.
$trello->user_agent; $trello->user_agent(Mojo::UserAgent->new);
The user_agent attribute set the pre-configured UserAgent object that will be used in all HTTP requests. This attribute expects a Mojo::UserAgent object.
my $result = $trello->action($verb, %args); # e.g. $trello->action('head', %args); # HEAD request $trello->action('options', %args); # OPTIONS request $trello->action('patch', %args); # PATCH request
The action method issues a request to the API resource represented by the object. The first parameter will be used as the HTTP request method. The arguments, expected to be a list of key/value pairs, will be included in the request if the key is either data or query.
data
query
my $results = $trello->create(%args); # or $trello->POST(%args);
The create method issues a POST request to the API resource represented by the object. The arguments, expected to be a list of key/value pairs, will be included in the request if the key is either data or query.
POST
my $results = $trello->delete(%args); # or $trello->DELETE(%args);
The delete method issues a DELETE request to the API resource represented by the object. The arguments, expected to be a list of key/value pairs, will be included in the request if the key is either data or query.
DELETE
my $results = $trello->fetch(%args); # or $trello->GET(%args);
The fetch method issues a GET request to the API resource represented by the object. The arguments, expected to be a list of key/value pairs, will be included in the request if the key is either data or query.
GET
my $results = $trello->update(%args); # or $trello->PUT(%args);
The update method issues a PUT request to the API resource represented by the object. The arguments, expected to be a list of key/value pairs, will be included in the request if the key is either data or query.
PUT
$trello->actions;
The actions method returns a new instance representative of the API actions resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://trello.com/docs/api/action/index.html.
$trello->batch;
The batch method returns a new instance representative of the API batch resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://trello.com/docs/api/batch/index.html.
$trello->boards;
The boards method returns a new instance representative of the API boards resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://trello.com/docs/api/board/index.html.
$trello->cards;
The cards method returns a new instance representative of the API cards resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://trello.com/docs/api/card/index.html.
$trello->checklists;
The checklists method returns a new instance representative of the API checklists resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://trello.com/docs/api/checklist/index.html.
$trello->labels;
The labels method returns a new instance representative of the API labels resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://trello.com/docs/api/label/index.html.
$trello->lists;
The lists method returns a new instance representative of the API lists resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://trello.com/docs/api/list/index.html.
$trello->members;
The members method returns a new instance representative of the API members resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://trello.com/docs/api/member/index.html.
$trello->notifications;
The notifications method returns a new instance representative of the API notifications resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://trello.com/docs/api/notification/index.html.
$trello->organizations;
The organizations method returns a new instance representative of the API organizations resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://trello.com/docs/api/organization/index.html.
$trello->search;
The search method returns a new instance representative of the API search resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://trello.com/docs/api/search/index.html.
$trello->sessions;
The sessions method returns a new instance representative of the API sessions resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://trello.com/docs/api/session/index.html.
$trello->tokens;
The tokens method returns a new instance representative of the API tokens resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://trello.com/docs/api/token/index.html.
$trello->types;
The types method returns a new instance representative of the API types resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://trello.com/docs/api/type/index.html.
$trello->webhooks;
The webhooks method returns a new instance representative of the API webhooks resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://trello.com/docs/api/webhook/index.html.
Al Newkirk <anewkirk@ana.io>
This software is copyright (c) 2014 by Al Newkirk.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install API::Trello, copy and paste the appropriate command in to your terminal.
cpanm
cpanm API::Trello
CPAN shell
perl -MCPAN -e shell install API::Trello
For more information on module installation, please visit the detailed CPAN module installation guide.