File Coverage

blib/lib/Net/Async/Webservice/UPS/Types.pm

Criterion	Covered	Total	%
statement	21	21	100.0
branch			n/a
condition			n/a
subroutine	7	7	100.0
pod			n/a
total	28	28	100.0

package Net::Async::Webservice::UPS::Types;
$Net::Async::Webservice::UPS::Types::VERSION = '1.1.3';
{
  $Net::Async::Webservice::UPS::Types::DIST = 'Net-Async-Webservice-UPS';
}
use strict;
use warnings;
use Type::Library
    -base,
    -declare => qw( PickupType CustomerClassification
                    Cache Cacheable
                    Address Package PackageList
                    Rate RateList
                    RequestMode Service ReturnService
                    ServiceCode ServiceLabel
                    ReturnServiceCode ReturnServiceLabel
                    CreditCardCode CreditCardType
                    PackagingType MeasurementSystem
                    Measure SizeMeasurementUnit WeightMeasurementUnit Currency
                    Tolerance Payment ImageType Image
                    Contact Shipper CreditCard Label
                    ShipmentConfirm PackageResult
                    QVSubscription QVEvent QVFile QVDelivery QVGeneric
                    QVOrigin QVManifest QVPackage QVException QVReference
              );
use Type::Utils -all;
use Types::Standard -types;
use Scalar::Util 'weaken';
use namespace::autoclean;

# ABSTRACT: type library for UPS


enum PickupType,
    [qw(
           DAILY_PICKUP
           DAILY
           CUSTOMER_COUNTER
           ONE_TIME_PICKUP
           ONE_TIME
           ON_CALL_AIR
           SUGGESTED_RETAIL
           SUGGESTED_RETAIL_RATES
           LETTER_CENTER
           AIR_SERVICE_CENTER
   )];


enum CustomerClassification,
    [qw(
           WHOLESALE
           OCCASIONAL
           RETAIL
   )];


enum RequestMode, # there are probably more
    [qw(
           rate
           shop
   )];


enum ServiceCode,
    [qw(
           01
           02
           03
           07
           08
           11
           12
           12
           13
           14
           54
           59
           65
           86
           85
           83
           82
   )];


enum ServiceLabel,
    [qw(
        NEXT_DAY_AIR
        2ND_DAY_AIR
        GROUND
        WORLDWIDE_EXPRESS
        WORLDWIDE_EXPEDITED
        STANDARD
        3_DAY_SELECT
        3DAY_SELECT
        NEXT_DAY_AIR_SAVER
        NEXT_DAY_AIR_EARLY_AM
        WORLDWIDE_EXPRESS_PLUS
        2ND_DAY_AIR_AM
        SAVER
        TODAY_EXPRESS_SAVER
        TODAY_EXPRESS
        TODAY_DEDICATED_COURIER
        TODAY_STANDARD
   )];


enum PackagingType,
    [qw(
        LETTER
        PACKAGE
        TUBE
        UPS_PAK
        UPS_EXPRESS_BOX
        UPS_25KG_BOX
        UPS_10KG_BOX
   )];


enum CreditCardCode,
    [qw(
           01
           03
           04
           05
           06
           07
           08
   )];


enum CreditCardType,
    [qw(
           AMEX
           Discover
           MasterCard
           Optima
           VISA
           Bravo
           Diners
   )];


enum MeasurementSystem,
    [qw(
           metric
           english
   )];


enum SizeMeasurementUnit,
    [qw(
           IN
           CM
   )];


enum WeightMeasurementUnit,
    [qw(
           LBS
           KGS
   )];


declare Currency,
    as Str;


declare Measure,
    as StrictNum,
    where { $_ >= 0 },
    inline_as {
        my ($constraint, $varname) = @_;
        my $perlcode =
            $constraint->parent->inline_check($varname)
                . "&& ($varname >= 0)";
        return $perlcode;
    },
    message { ($_//'<undef>').' is not a valid measure, it must be a non-negative number' };


declare Tolerance,
    as StrictNum,
    where { $_ >= 0 && $_ <= 1 },
    inline_as {
        my ($constraint, $varname) = @_;
        my $perlcode =
            $constraint->parent->inline_check($varname)
                . "&& ($varname >= 0 && $varname <= 1)";
        return $perlcode;
    },
    message { ($_//'<undef>').' is not a valid tolerance, it must be a number between 0 and 1' };


class_type Address, { class => 'Net::Async::Webservice::UPS::Address' };
coerce Address, from Str, via {
    require Net::Async::Webservice::UPS::Address;
    Net::Async::Webservice::UPS::Address->new({postal_code => $_});
};
Address->coercion->freeze;


class_type Contact, { class => 'Net::Async::Webservice::UPS::Contact' };
coerce Contact, from Address, via {
    require Net::Async::Webservice::UPS::Contact;
    Net::Async::Webservice::UPS::Contact->new({address=>$_});
};
Contact->coercion->freeze;


class_type Shipper, { class => 'Net::Async::Webservice::UPS::Shipper' };


class_type Payment, { class => 'Net::Async::Webservice::UPS::Payment' };


class_type CreditCard, { class => 'Net::Async::Webservice::UPS::CreditCard' };


enum ImageType, [qw(EPL ZPL SPL STARPL GIF HTML)];


class_type Image, { class => 'Net::Async::Webservice::UPS::Response::Image' };
coerce Image, from HashRef, via {
    require Net::Async::Webservice::UPS::Response::Image;
    Net::Async::Webservice::UPS::Response::Image->from_hash($_);
};
Image->coercion->freeze;


class_type Label, { class => 'Net::Async::Webservice::UPS::Label' };
coerce Label, from Str, via {
    require Net::Async::Webservice::UPS::Label;
    Net::Async::Webservice::UPS::Label->new({ code => $_ });
};
Label->coercion->freeze;


class_type Package, { class => 'Net::Async::Webservice::UPS::Package' };
declare PackageList, as ArrayRef[Package];
coerce PackageList, from Package, via { [ $_ ] };
PackageList->coercion->freeze;


class_type PackageResult, { class => 'Net::Async::Webservice::UPS::Response::PackageResult' };


class_type Service, { class => 'Net::Async::Webservice::UPS::Service' };
coerce Service, from Str, via {
    require Net::Async::Webservice::UPS::Service;
    Net::Async::Webservice::UPS::Service->new({label=>$_});
};
Service->coercion->freeze;


class_type ReturnService, { class => 'Net::Async::Webservice::UPS::ReturnService' };
coerce ReturnService, from Str, via {
    require Net::Async::Webservice::UPS::ReturnService;
    Net::Async::Webservice::UPS::ReturnService->new({label=>$_});
};
ReturnService->coercion->freeze;


enum ReturnServiceCode,
    [qw(
           2
           3
           5
           8
           9
   )];


enum ReturnServiceLabel,
    [qw(
           PNM
           RS1
           RS3
           ERL
           PRL
   )];


class_type Rate, { class => 'Net::Async::Webservice::UPS::Rate' };
declare RateList, as ArrayRef[Rate];
coerce RateList, from Rate, via { [ $_ ] };
RateList->coercion->freeze;


class_type ShipmentConfirm, { class => 'Net::Async::Webservice::UPS::Response::ShipmentConfirm' };

class_type QVSubscription, { class => 'Net::Async::Webservice::UPS::QVSubscription' };

class_type QVEvent, { class => 'Net::Async::Webservice::UPS::Response::QV::Event' };
class_type QVFile, { class => 'Net::Async::Webservice::UPS::Response::QV::File' };
class_type QVDelivery, { class => 'Net::Async::Webservice::UPS::Response::QV::Delivery' };
class_type QVGeneric, { class => 'Net::Async::Webservice::UPS::Response::QV::Generic' };
class_type QVOrigin, { class => 'Net::Async::Webservice::UPS::Response::QV::Origin' };
class_type QVManifest, { class => 'Net::Async::Webservice::UPS::Response::QV::Manifest' };
class_type QVPackage, { class => 'Net::Async::Webservice::UPS::Response::QV::Package' };
class_type QVException, { class => 'Net::Async::Webservice::UPS::Response::QV::Exception' };
class_type QVReference, { class => 'Net::Async::Webservice::UPS::Response::QV::Reference' };


duck_type Cache, [qw(get set)];
duck_type Cacheable, [qw(cache_id)];

1;

__END__

=pod

=encoding UTF-8

=head1 NAME

Net::Async::Webservice::UPS::Types - type library for UPS

=head1 VERSION

version 1.1.3

=head1 DESCRIPTION

This L<Type::Library> declares a few type constraints and coercions
for use with L<Net::Async::Webservice::UPS>.

=head1 TYPES

=head2 C<PickupType>

C<E>num, one of C<DAILY_PICKUP> C<DAILY> C<CUSTOMER_COUNTER>
C<ONE_TIME_PICKUP> C<ONE_TIME> C<ON_CALL_AIR> C<SUGGESTED_RETAIL>
C<SUGGESTED_RETAIL_RATES> C<LETTER_CENTER> C<AIR_SERVICE_CENTER>

=head2 C<CustomerClassification>

C<E>num, one of C<WHOLESALE> C<OCCASIONAL> C<RETAIL>

=head2 C<RequestMode>

Enum, one of C<rate> C<shop>

=head2 C<ServiceCode>

Enum, one of C<01> C<02> C<03> C<07> C<08> C<11> C<12> C<12> C<13>
C<14> C<54> C<59> C<65> C<86> C<85> C<83> C<82>

=head2 C<ServiceLabel>

Enum, one of C<NEXT_DAY_AIR> C<2ND_DAY_AIR> C<GROUND>
C<WORLDWIDE_EXPRESS> C<WORLDWIDE_EXPEDITED> C<STANDARD>
C<3_DAY_SELECT> C<3DAY_SELECT> C<NEXT_DAY_AIR_SAVER>
C<NEXT_DAY_AIR_EARLY_AM> C<WORLDWIDE_EXPRESS_PLUS> C<2ND_DAY_AIR_AM>
C<SAVER> C<TODAY_EXPRESS_SAVER> C<TODAY_EXPRESS>
C<TODAY_DEDICATED_COURIER> C<TODAY_STANDARD>

=head2 C<PackagingType>

Enum, one of C<LETTER> C<PACKAGE> C<TUBE> C<UPS_PAK>
C<UPS_EXPRESS_BOX> C<UPS_25KG_BOX> C<UPS_10KG_BOX>

=head2 C<CreditCardCode>

Enum, one of C<01> C<03> C<04> C<05> C<06> C<07> C<08>

=head2 C<CreditCardType>

Enum, one of C<AMEX> C<Discover> C<MasterCard> C<Optima> C<VISA>
C<Bravo> C<Diners>.

=head2 C<MeasurementSystem>

Enum, one of C<metric> C<english>.

=head2 C<SizeMeasurementUnit>

Enum, one of C<IN> C<CM>

=head2 C<WeightMeasurementUnit>

Enum, one of C<LBS> C<KGS>

=head2 C<Currency>

String.

=head2 C<Measure>

Non-negative number.

=head2 C<Tolerance>

Number between 0 and 1.

=head2 C<Address>

Instance of L<Net::Async::Webservice::UPS::Address>, with automatic
coercion from string (interpreted as a US postal code).

=head2 C<Contact>

Instance of L<Net::Async::Webservice::UPS::Contact>.

=head2 C<Shipper>

Instance of L<Net::Async::Webservice::UPS::Shipper>.

=head2 C<Payment>

Instance of L<Net::Async::Webservice::UPS::Payment>.

=head2 C<CreditCard>

Instance of L<Net::Async::Webservice::UPS::CreditCard>.

=head2 C<ImageType>

Enum, one of C<EPL>, C<ZPL>, C<SPL>, C<STARPL>, C<GIF>, C<HTML>.

=head2 C<Image>

Instance of L<Net::Async::Webservice::UPS::Response::Image>, with
automatic coercion from hashref (via
L<Net::Async::Webservice::UPS::Response::Image/from_hash>).

=head2 C<Label>

Instance of L<Net::Async::Webservice::UPS::Label>, with automatic
coercion from string (interpreted as a label code).

=head2 C<Package>

Instance of L<Net::Async::Webservice::UPS::Package>.

=head2 C<PackageList>

Array ref of packages, with automatic coercion from a single package
to a singleton array.

=head2 C<PackageResult>

Instance of L<Net::Async::Webservice::UPS::Response::PackageResult>.

=head2 C<Service>

Instance of L<Net::Async::Webservice::UPS::Service>, with automatic
coercion from string (interpreted as a service label).

=head2 C<ReturnService>

Instance of L<Net::Async::Webservice::UPS::ReturnService>, with automatic
coercion from string (interpreted as a service label).

=head2 C<ReturnServiceCode>

Enum, one of C<2> C<3> C<5> C<8> C<9>

=head2 C<ReturnServiceLabel>

Enum, one of C<PNM> C<RS1> C<RS3> C<ERL> C<PRL>

=head2 C<Rate>

Instance of L<Net::Async::Webservice::UPS::Rate>.

=head2 C<RateList>

Array ref of rates, with automatic coercion from a single rate to a
singleton array.

=head2 C<ShipmentConfirm>

Instance of L<Net::Async::Webservice::UPS::Response::ShipmentConfirm>.

=head2 C<Cache>

Duck type, any object with a C<get> and a C<set> method.

=head2 C<Cacheable>

Duck type, any object with a C<cache_id> method.

=head1 AUTHORS

=over 4

=item *

Gianni Ceccarelli <[e-mail]>

=item *

Sherzod B. Ruzmetov <[e-mail]>

=back

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2015 by Gianni Ceccarelli <[e-mail]>.

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

=cut