Olaf Alders > Net-FreshBooks-API-0.24 > Net::FreshBooks::API::Gateway

Download:
Net-FreshBooks-API-0.24.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 0.24   Source  

NAME ^

Net::FreshBooks::API::Gateway - List gateways available in your FreshBooks account

VERSION ^

version 0.24

SYNOPSIS ^

    my $fb = Net::FreshBooks::API->new(...);
    my $gateways = $fb->gateway->get_all();

    # or
    my $autobill_gateways = $fb->gateway->get_all({ autobill_capable => 1 });

list

Returns an Net::FreshBooks::API::Iterator object. Currently, all list() functionality defaults to 15 items per page.

    # list all gateways
    my $gateways = $fb->gateway->list();

    print $gateways->total . " gateways\n";
    print $gateways->pages . " pages of results\n";

    while ( my $gateway = $gateways->next ) {
        print join( "\t", $gateway->name, $gateway->autobill_capable ) . "\n";
    }

get_all

Returns an ARRAYREF of all possible results, handling pagination for you.

DESCRIPTION ^

Returns a list of payment gateways enabled in your FreshBooks account that can process credit card transactions. You can optionally filter by autobill_capable to return only gateways that support auto-bills. See http://developers.freshbooks.com/docs/gateway/ for more info.

You should note that there is no "get" method for Gateways as the API does not provide it.

AUTHORS ^

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2011 by Edmund von der Burg & Olaf Alders.

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

syntax highlighting: