NAME

Net::Easypost::Address

VERSION

version 0.20

SYNOPSIS

Net::Easypost::Address->new

NAME

Net::Easypost::Address

ATTRIBUTES

mode

string: Set based on which api-key you used, either "test" or "production"

street1

string: First line of the address

street2

string: Second line of the address

city

string: City the address is located in

state

string: State or province the address is located in

zip

string: ZIP or postal code the address is located in

country

string: ISO 3166 country code for the country the address is located in

residential

boolean: Whether or not this address would be considered residential

carrier_facility

string: The specific designation for the address (only relevant if the address is a carrier facility)

name

string: Name of the person. Both name and company can be included

company

string: Name of the organization. Both name and company can be included

phone

string: Phone number to reach the person or organization

email

string: Email to reach the person or organization

federal_tax_id

string: Federal tax identifier of the person or organization

state_tax_id

string: State tax identifier of the person or organization

verifications

*CURRENTLY NOT IMPLEMENTED* Verifications: The result of any verifications requested

METHODS

_build_fieldnames

Attributes that make up an Address, from Net::Easypost::Resource

_build_role

Prefix to data when POSTing to the Easypost API about Address objects

_build_operation

Base API endpoint for operations on Address objects

clone

Make a new copy of this object and return it

as_string

Format this address as it might be seen on a mailing label. This class overloads stringification using this method, so something like say $addr should just work.

merge

This method takes a Net::Easypost::Address object and an arrayref of fields to copy into this object. This method only merges fields that are defined on the other object.

verify

This method takes a Net::Easypost::Address object and verifies its underlying address.

If a non-US address is asked for verification, a warning will be emitted and the object itself will be returned.

AUTHOR

Mark Allen <mrallen1@yahoo.com>, Hunter McMillen <mcmillhj@gmail.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2012 by Mark Allen.

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