NAME
WebService::Shippo::Address - Address class
VERSION
version 0.0.19
SYNOPIS
Note: Though you must use WebService::Shippo when importing the Shippo API wrapper, you may freely discard the leading WebService:: portion of the namespace when subsequently referring to classes that make up this distribution. You will see this practice being employed consistently in example code.
# This file can be found in the distribution:
# bin/synopses/addresses.pl
#
use strict;
use WebService::Shippo;
use Test::More;
# If your client doesn't use a configuration file and you haven't set the
# SHIPPO_TOKEN environment variable, you should provide authentication
# details below:
#
Shippo->api_key( 'PASTE YOUR PRIVATE AUTH TOKEN HERE' )
unless Shippo->api_key;
diag 'Create an address';
my $address = Shippo::Address->create(
object_purpose => 'PURCHASE',
name => 'John Smith',
street1 => '6512 Greene Rd.',
street2 => '',
company => 'Initech',
phone => '+1 234 346 7333',
city => 'Woodridge',
state => 'IL',
zip => '60517',
country => 'US',
email => 'user@gmail.com',
metadata => 'Customer ID 123456'
);
diag $address->to_string;
my $id = $address->object_id;
diag "Fetch an address object identified by its object_id ($id)";
$address = Shippo::Address->fetch( $id );
diag $address->to_string;
diag 'Validate the address object';
my $val_1 = $address->validate;
diag $val_1->to_string;
diag "Validate an address object identified by its object_id ($id)";
my $val_2 = Shippo::Address->validate( $id );
diag $val_2->to_string;
diag "Get 'all' (but really the first 200 or less) address objects";
{
my $collection = Shippo::Addresses->all;
for my $address ( $collection->results ) {
print "$address->{object_id}\n";
}
}
diag "Really get all address objects";
{
my $collection = Shippo::Addresses->all;
while ( $collection ) {
for my $address ( $collection->results ) {
print "$address->{object_id}\n";
}
$collection = $collection->next_page;
}
}
diag "Simple iteration through entire object collection";
{
my $it = Shippo::Address->iterator();
while ( my ( $address ) = $it->() ) {
print "$address->{object_id}\n";
}
}
diag "Specialised iterator using a sequence of lambda functions as a filter";
{
my $next_validated_purchase_address = Shippo::Address->iterator(
callback {
my ( $address ) = @_;
# Discard address unless validated and valid
return
unless $address->object_source eq 'VALIDATOR'
&& $address->object_state eq 'VALID';
# Else, keep address
return $address;
}
callback {
my ( $address ) = @_;
# Discard address unless created for transaction
return
unless $address->object_purpose eq 'PURCHASE';
# Else, keep address
return $address;
}
);
while ( my ( $address ) = $next_validated_purchase_address->() ) {
print $address; # Automatically stringified using "to_string";
}
}
diag "Collector using a sequence of lambda functions as a filter";
{
my $all_validated_purchase_addresses = Shippo::Address->collector(
callback {
my ( $address ) = @_;
# Discard address unless validated and valid
return
unless $address->object_source eq 'VALIDATOR'
&& $address->object_state eq 'VALID';
# Else, keep address
return $address;
}
callback {
my ( $address ) = @_;
# Discard address unless created for transaction
return
unless $address->object_purpose eq 'PURCHASE';
# Else, keep address
return $address;
}
);
for my $address ( $all_validated_purchase_addresses->() ) {
print $address;
}
}
DESCRIPTION
Address objects are used for creating Shipments, obtaining Rates and printing Labels, and thus are one of the fundamental building blocks of the Shippo API.
API DOCUMENTATION
For more information about Addresses, consult the Shippo API documentation:
REPOSITORY
AUTHOR
Iain Campbell <cpanic@cpan.org>
COPYRIGHT AND LICENSE
This software is copyright (c) 2015 by Iain Campbell.
You may distribute this software under the terms of either the GNU General Public License or the Artistic License, as specified in the Perl README file.