Net::FreshBooks::API::Role::Iterator - Read-only roles


Net-FreshBooks-API documentation  | view source Contained in the Net-FreshBooks-API distribution.

Index


NAME

Top

Net::FreshBooks::API::Role::Iterator - Read-only roles

VERSION

Top

version 0.21

SYNOPSIS

Top

These roles are used for iterating over returned results as well as handling pagination. See the various modules which implement these methods for specific examples of how these methods are used.

get( $args )

get_all( $args )

Iterates over all pages of results provided by FreshBooks. Calling get_all means you don't need to worry about explicitly handling pagination in requests. Returns an ARRAYREF of the requested objects.

list( $args )

Returns an iterator object.

AUTHORS

Top

COPYRIGHT AND LICENSE

Top


Net-FreshBooks-API documentation  | view source Contained in the Net-FreshBooks-API distribution.