NAME

Business::Fixflo::Client

DESCRIPTION

This is a class for the lower level requests to the fixflo API. generally there is nothing you should be doing with this.

ATTRIBUTES

username

Your Fixflo username (required if api_key not supplied)

password

Your Fixflo password (required if api_key not supplied)

api_key

Your Fixflo API Key (required if username and password not supplied)

custom_domain

Your Fixflo custom domain

user_agent

The user agent string used in requests to the Fixflo API, defaults to business-fixflo/perl/v . $version_of_this_library.

url_suffix

The url suffix to use after the custom domain, defaults to fixflo.com

base_url

The full url to use in calling the Fixflo API, defaults to:

    value of $ENV{FIXFLO_URL}
    or https:// $self->custom_domain . $self->url_suffix

api_path

The version of the Fixflo API to use, defaults to:

    /api/$Business::Fixflo::API_VERSION

METHODS

    api_get
    api_post
    api_delete

Make a request to the Fixflo API:

    my $data = $Client->api_get( 'Issues',\%params );

May return a Business::Fixflo::Paginator object (when calling endpoints that return lists of items) or a Business::Fixflo:: object for the Issue, Agency, etc.

AUTHOR

Lee Johnson - leejo@cpan.org

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. If you would like to contribute documentation, features, bug fixes, or anything else then please raise an issue / pull request:

    https://github.com/Humanstate/business-fixflo