view release on metacpan or  search on metacpan

README.mkdn  view on Meta::CPAN

# METHODS

## action

    my $result = $basecamp->action($verb, %args);

    # e.g.

    $basecamp->action('head', %args);    # HEAD request
    $basecamp->action('options', %args); # OPTIONS request
    $basecamp->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`.

## create

    my $results = $basecamp->create(%args);

    # or

    $basecamp->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`.

## delete

    my $results = $basecamp->delete(%args);

    # or

    $basecamp->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`.

## fetch

    my $results = $basecamp->fetch(%args);

    # or

    $basecamp->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`.

## update

    my $results = $basecamp->update(%args);

    # or

    $basecamp->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`.

# RESOURCES

## accesses

    $basecamp->projects('605816632')->accesses;

The accesses method returns a new instance representative of the API
_Accesses_ 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://github.com/basecamp/bcx-api/blob/master/sections/accesses.md](https://github.com/basecamp/bcx-api/blob/master/sections/accesses.md).

## attachments

    $basecamp->attachments;

The attachments method returns a new instance representative of the API
_Attachments_ 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://github.com/basecamp/bcx-api/blob/master/sections/attachments.md](https://github.com/basecamp/bcx-api/blob/master/sections/attachments.md).

## calendar\_events

    $basecamp->calendar_events;

The calendar\_events method returns a new instance representative of the API
_Calendar Events_ 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://github.com/basecamp/bcx-api/blob/master/sections/calendar\_events.md](https://github.com/basecamp/bcx-api/blob/master/sections/calendar_events.md).

## calendars

    $basecamp->calendars;

The calendars method returns a new instance representative of the API
_Calendars_ 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://github.com/basecamp/bcx-api/blob/master/sections/calendars.md](https://github.com/basecamp/bcx-api/blob/master/sections/calendars.md).

## comments

    $basecamp->projects('605816632')->comments;

The comments method returns a new instance representative of the API
_Comments_ 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://github.com/basecamp/bcx-api/blob/master/sections/comments.md](https://github.com/basecamp/bcx-api/blob/master/sections/comments.md).

## documents

    $basecamp->documents;

The documents method returns a new instance representative of the API
_Documents_ 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://github.com/basecamp/bcx-api/blob/master/sections/documents.md](https://github.com/basecamp/bcx-api/blob/master/sections/documents.md).

## events