File Coverage

blib/lib/WebService/Toggl/API/Client.pm

Criterion	Covered	Total	%
statement	9	15	60.0
branch			n/a
condition	0	2	0.0
subroutine	3	6	50.0
pod			n/a
total	12	23	52.1

package WebService::Toggl::API::Client;

use WebService::Toggl::Role::Item as => 'JsonItem';

use Moo;
with 'WebService::Toggl::Role::API';
use namespace::clean;

with JsonItem(
    bools => [ qw() ],
    strings => [ qw(name notes at) ],
    integers => [ qw(id wid) ]
);


sub api_path { 'clients' }
sub api_id   { shift->id }


sub projects {
    my ($self, $args) = @_;
    $args ||= {};
    # todo: validate $args->{active} is [true,false,both]
    my $res = $self->api_get($self->my_url . '/projects', $args);
    return $self->new_set_from_raw('::Projects', $res->data);
}


1;
__END__


=encoding utf-8

=head1 NAME

WebService::Toggl::API::Client - Toggl's Client object

=head1 SYNOPSIS

 use WebService::Toggl;
 my $toggl = WebService::Toggl->new({api_key => 'foo'});

=head1 DESCRIPTION

This module is a wrapper object around the Toggl detailed report
L<described here|https://github.com/toggl/toggl_api_docs/blob/master/reports/detailed.md>.
It returns all of the time entries that match the request criteria.

=head1 REQUEST ATTRIBUTES

Request attributes common to all reports are detailed in the
L<::Role::Request|WebService::Toggl::Role::Report#REQUEST-ATTRIBUTES> pod.

=head2 page

Detailed reports are paged.  This attribute sets the requested page.
If left empty, Toggl will return the first page by default.

=head1 RESPONSE ATTRIBUTES

Response attributes common to all reports are detailed in the
L<::Role::Request|WebService::Toggl::Role::Report#RESPONSE-ATTRIBUTES> pod.

=head2 per_page

How many time entries are being returned per page. Current default is
50.  This is not settable.

=head2 total_count

The total number of records found.  This will be the greater of the
actual number of entries returned and the C<per_page> parameter.

=head1 REPORT DATA

The C<data()> attribute of a C<::Report::Details> object is an
arrayref of time entry hashrefs.  For the contents of this structure, see the
L<Toggl API docs|https://github.com/toggl/toggl_api_docs/blob/master/reports/detailed.md>.


=head1 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.

=head1 AUTHOR

Fitz Elliott E<lt>[e-mail]<gt>

=cut