File Coverage

blib/lib/Net/API/Stripe/Address.pm
Criterion Covered Total %
statement 7 14 50.0
branch n/a
condition n/a
subroutine 3 10 30.0
pod 6 7 85.7
total 16 31 51.6


line stmt bran cond sub pod time code
1             ##----------------------------------------------------------------------------
2             ## Stripe API - ~/lib/Net/API/Stripe/Address.pm
3             ## Version v0.100.0
4             ## Copyright(c) 2020 DEGUEST Pte. Ltd.
5             ## Author: Jacques Deguest <@sitael.tokyo.deguest.jp>
6             ## Created 2019/11/02
7             ## Modified 2020/05/15
8             ##
9             ##----------------------------------------------------------------------------
10             package Net::API::Stripe::Address;
11             BEGIN
12             {
13 1     1   1327 use strict;
  1         2  
  1         34  
14 1     1   5 use parent qw( Net::API::Stripe::Generic );
  1         2  
  1         6  
15 1     1   193 our( $VERSION ) = 'v0.100.0';
16             };
17              
18 0     0 1   sub city { shift->_set_get_scalar( 'city', @_ ); }
19              
20 0     0 1   sub country { shift->_set_get_scalar( 'country', @_ ); }
21              
22 0     0 1   sub line1 { shift->_set_get_scalar( 'line1', @_ ); }
23              
24 0     0 1   sub line2 { shift->_set_get_scalar( 'line2', @_ ); }
25              
26 0     0 1   sub postal_code { shift->_set_get_scalar( 'postal_code', @_ ); }
27              
28 0     0 1   sub state { shift->_set_get_scalar( 'state', @_ ); }
29              
30 0     0 0   sub town { return( shift->_set_get_scalar( 'town', @_ ) ); }
31              
32             *zip_code = \&postal_code;
33              
34             1;
35              
36             __END__
37              
38             =encoding utf8
39              
40             =head1 NAME
41              
42             Net::API::Stripe::Address - A Stripe Address Object
43              
44             =head1 SYNOPSIS
45              
46             my $addr = $stripe->address({
47             line1 => '1-2-3 Kudan-minami, Chiyoda-ku',
48             line2 => 'Big Bldg 12F',
49             city => 'Tokyo',
50             postal_code => '123-4567',
51             country => 'jp',
52             });
53              
54             =head1 VERSION
55              
56             v0.100.0
57              
58             =head1 DESCRIPTION
59              
60             This is an Address module used everywhere in Stripe API.
61              
62             =head1 CONSTRUCTOR
63              
64             =over 4
65              
66             =item B<new>( %ARG )
67              
68             Creates a new L<Net::API::Stripe::Address> object.
69             It may also take an hash like arguments, that also are method of the same name.
70              
71             =back
72              
73             =head1 METHODS
74              
75             =over 4
76              
77             =item B<city> string
78              
79             City/District/Suburb/Town/Village.
80              
81             =item B<country> string
82              
83             2-letter country code.
84              
85             =item B<line1> string
86              
87             Address line 1 (Street address/PO Box/Company name).
88              
89             =item B<line2> string
90              
91             Address line 2 (Apartment/Suite/Unit/Building).
92              
93             =item B<postal_code> string
94              
95             ZIP or postal code.
96              
97             =item B<state> string
98              
99             State/County/Province/Region.
100              
101             =back
102              
103             =head1 HISTORY
104              
105             =head2 v0.1
106              
107             Initial version
108              
109             =head1 AUTHOR
110              
111             Jacques Deguest E<lt>F<jack@deguest.jp>E<gt>
112              
113             =head1 SEE ALSO
114              
115             Stripe API documentation:
116              
117             L<https://stripe.com/docs/api>
118              
119             =head1 COPYRIGHT & LICENSE
120              
121             Copyright (c) 2019-2020 DEGUEST Pte. Ltd.
122              
123             You can use, copy, modify and redistribute this package and associated
124             files under the same terms as Perl itself.
125              
126             =cut