NAME

WebService::SmartyStreets

VERSION

version 0.0102

SYNOPSIS

use WebService::SmartyStreets;

my $ss = WebService::SmartyStreets->new(
    auth_id     => 'abc123',
    auth_token  => 'zyx456',
);

$ss->verify_address(...);

DESCRIPTION

This module provides bindings for the SmartyStreets API.

METHODS

new

Instantiates a new WebService::SmartyStreets client object.

my $ss = WebService::SmartyStreets->new(
    auth_id    => $auth_id,
    auth_token => $auth_token,
    timeout    => $retries,    # optional
    retries    => $retries,    # optional
);

Parameters

- auth_id

Required �

A valid SmartyStreets auth id for your account.
- auth_token

Required �

A valid SmartyStreets auth token for your account.
- timeout

Optional �

The number of seconds to wait per request until timing out. Defaults to 10.
- retries

Optional �

The number of times to retry requests in cases when SmartyStreets returns a 5xx response. Defaults to 0.

verify_address

Validates an address given.

Request:

verify_address(
    street  => '370 Townsend St',
    city    => 'San Francisco',
    state   => 'CA',
    zipcode => '94107',
);

Response:

[{
    street   => '370 Townsend St',
    city     => 'San Francisco',
    state    => 'CA',
    zipcode  => '94107-1607',
}]

Exceptions:

- WebService::SmartyStreets::Exception::AddressNotFound

Address Not Found.
- WebService::SmartyStreets::Exception::AddressMissingInformation

The address you entered was found but more information is needed to match to a specific address.

BUGS

Please report any bugs or feature requests on the bugtracker website https://github.com/aanari/WebService-SmartyStreets/issues

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

AUTHOR

Ali Anari ali@anari.me

COPYRIGHT AND LICENSE

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

ironcamel/WebService-SmartyStreets