/ 
Business-CPI-0.916
River stage one • 5 direct dependents • 5 total dependents
/ Business::CPI::Role::Account::Address

NAME

Business::CPI::Role::Account::Address - Business::CPI role for Addresses

VERSION

version 0.916

SYNOPSIS

$cpi->create_account({
    # ...
    address    => {
        street     => 'Av. ABC',
        number     => '1000',
        complement => '7º andar',
        district   => 'Bairro XYZ',
        city       => 'Rio de Janeiro',
        state      => 'RJ',
        country    => 'br',
    },
    # ...
});

DESCRIPTION

This role represents addresses in the context of accounts in gateways, both of individuals and companies.

ATTRIBUTES

line1

The first line of the complete address. This may be set directly in the constructor, or it will be generated automatically using the other fields.

line2

Second line of the complete address. As with the first line, it can be automatically generated using the other fields.

street

The name of the street, route, avenue, etc.

number

The address number in the street.

district

District, borough or neighborhood.

complement

Complement, such as the apartment number, for example.

zip_code

Zip or postal code.

city

The city of the address.

state

The state in which the city is located. Business::CPI will always store the code of the state, if it exists, even if the gateway expects the full name.

country

Locale::Country code for the country. You can set using the ISO 3166-1 two-letter code, or the full name in English. It will coerce it and store the ISO 3166-1 two-letter code.

SPONSORED BY

Estante Virtual - http://www.estantevirtual.com.br

SEE ALSO

Business::CPI, Business::CPI::Role::Account, Business::CPI::Role::Account::Business

AUTHOR

André Walker <andre@andrewalker.net>

COPYRIGHT AND LICENSE

This software is copyright (c) 2014 by André Walker.

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