File Coverage

lib/Net/API/Stripe/GeoLocation.pm
Criterion Covered Total %
statement 19 24 79.1
branch n/a
condition n/a
subroutine 7 12 58.3
pod 5 5 100.0
total 31 41 75.6


line stmt bran cond sub pod time code
1             ##----------------------------------------------------------------------------
2             ## Stripe API - ~/lib/Net/API/Stripe/GeoLocation.pm
3             ## Version v0.100.0
4             ## Copyright(c) 2019 DEGUEST Pte. Ltd.
5             ## Author: Jacques Deguest <jack@deguest.jp>
6             ## Created 2019/11/02
7             ## Modified 2020/05/15
8             ##
9             ##----------------------------------------------------------------------------
10             BEGIN
11             {
12             use strict;
13 2     2   24206832 use warnings;
  2         14  
  2         61  
14 2     2   9 use parent qw( Net::API::Stripe::Generic );
  2         5  
  2         58  
15 2     2   11 use vars qw( $VERSION );
  2         3  
  2         11  
16 2     2   140 our( $VERSION ) = 'v0.100.0';
  2         4  
  2         121  
17 2     2   45 };
18              
19             use strict;
20 2     2   11 use warnings;
  2         6  
  2         38  
21 2     2   20  
  2         4  
  2         287  
22              
23 0     0 1    
24              
25 0     0 1    
26              
27 0     0 1   1;
28              
29 0     0 1    
30             =encoding utf8
31 0     0 1    
32             =head1 NAME
33              
34             Net::API::Stripe::GeoLocation - A Stripe Geo Location Object
35              
36             =head1 SYNOPSIS
37              
38             my $geo_loc = $stripe->fraud_review->ip_address_location({
39             city => 'Tokyo',
40             country => 'jp',
41             latitude => '35.6935496',
42             longitude => '139.7461204',
43             region => undef,
44             });
45              
46             =head1 VERSION
47              
48             v0.100.0
49              
50             =head1 DESCRIPTION
51              
52             Information related to the location of the payment. Note that this information is an approximation and attempts to locate the nearest population center - it should not be used to determine a specific address.
53              
54             This is used in L<Net::API::Stripe::Fraud::Review>
55              
56             =head1 CONSTRUCTOR
57              
58             =head2 new( %ARG )
59              
60             Creates a new L<Net::API::Stripe::GeoLocation> object.
61             It may also take an hash like arguments, that also are method of the same name.
62              
63             =head1 METHODS
64              
65             =head2 city string
66              
67             The city where the payment originated.
68              
69             =head2 country string
70              
71             Two-letter ISO code representing the country where the payment originated.
72              
73             =head2 latitude decimal
74              
75             The geographic latitude where the payment originated.
76              
77             =head2 longitude decimal
78              
79             The geographic longitude where the payment originated.
80              
81             =head2 region string
82              
83             The state/county/province/region where the payment originated.
84              
85             =head1 API SAMPLE
86              
87             {
88             "id": "prv_fake123456789",
89             "object": "review",
90             "billing_zip": null,
91             "charge": "ch_fake123456789",
92             "closed_reason": null,
93             "created": 1571480456,
94             "ip_address": null,
95             "ip_address_location": null,
96             "livemode": false,
97             "open": true,
98             "opened_reason": "rule",
99             "reason": "rule",
100             "session": null
101             }
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/radar/reviews/object>
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