NAME

WebService::Toggl::Report - Base Role for WebService::Toggl::Report objects

DESCRIPTION

This role provide behavoir common to all WebService::Toggl::Report:: objects.

REQUIRES

api_path

Consuming classes must provide their endpoint on the Reports API. Ex. The WebService::Toggl::Report::Summary object's api_path is summary.

ATTRIBUTES

base_url

The base of the URL for the Toggl Reports API. Defaults to /reports/api/v8.

my_url

URL for the current Report object.

raw

The raw data structure returned by querying the API.

REQUEST ATTRIBUTES

workspace_id

The ID of the workspace for which the report is being generated.

since / until

DateTime objects representing the bounding period for the report. Defaults to until = today, since = today - 6 days

RESPONSE ATTRIBUTES

These attributes are common to all reports. See the Toggl API Docs for more information

total_grand

Total time (in milliseconds) represented by the entries in the report.

total_billable

Total billable time (in milliseconds) represented by the entries in the report.

total_currencies

Total earnings represented by the entries in the report.

data

The detailed contents of the report. This will differ between each type of report.

LICENSE

Copyright (C) Fitz Elliott.

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

AUTHOR

Fitz Elliott <felliott@fiskur.org>

cpanm WebService::Toggl

perl -MCPAN -e shell
install WebService::Toggl