JDEGUEST / Net-API-Stripe-v2.0.6 / lib / Net / API / Stripe / GeoLocation.pm 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
—
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133

              
##----------------------------------------------------------------------------
## Stripe API - ~/lib/Net/API/Stripe/GeoLocation.pm
## Version v0.100.0
## Copyright(c) 2019 DEGUEST Pte. Ltd.
## Author: Jacques Deguest <jack@deguest.jp>
## Created 2019/11/02
## Modified 2020/05/15
## 
##----------------------------------------------------------------------------
package Net::API::Stripe::GeoLocation;
BEGIN
{
    use strict;
    use warnings;
    use parent qw( Net::API::Stripe::Generic );
    use vars qw( $VERSION );
    our( $VERSION ) = 'v0.100.0';
};
use strict;
use warnings;
sub city { return( shift->_set_get_scalar( 'city', @_ ) ); }
sub country { return( shift->_set_get_scalar( 'country', @_ ) ); }
sub latitude { return( shift->_set_get_number( 'latitude', @_ ) ); }
sub longitude { return( shift->_set_get_number( 'longitude', @_ ) ); }
sub region { return( shift->_set_get_scalar( 'region', @_ ) ); }
1;
__END__
=encoding utf8
=head1 NAME
Net::API::Stripe::GeoLocation - A Stripe Geo Location Object
=head1 SYNOPSIS
    my $geo_loc = $stripe->fraud_review->ip_address_location({
        city => 'Tokyo',
        country => 'jp',
        latitude => '35.6935496',
        longitude => '139.7461204',
        region => undef,
    });
=head1 VERSION
    v0.100.0
=head1 DESCRIPTION
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.
This is used in L<Net::API::Stripe::Fraud::Review>
=head1 CONSTRUCTOR
=head2 new( %ARG )
Creates a new L<Net::API::Stripe::GeoLocation> object.
It may also take an hash like arguments, that also are method of the same name.
=head1 METHODS
=head2 city string
The city where the payment originated.
=head2 country string
Two-letter ISO code representing the country where the payment originated.
=head2 latitude decimal
The geographic latitude where the payment originated.
=head2 longitude decimal
The geographic longitude where the payment originated.
=head2 region string
The state/county/province/region where the payment originated.
=head1 API SAMPLE
    {
      "id": "prv_fake123456789",
      "object": "review",
      "billing_zip": null,
      "charge": "ch_fake123456789",
      "closed_reason": null,
      "created": 1571480456,
      "ip_address": null,
      "ip_address_location": null,
      "livemode": false,
      "open": true,
      "opened_reason": "rule",
      "reason": "rule",
      "session": null
    }
=head1 HISTORY
=head2 v0.1
Initial version
=head1 AUTHOR
Jacques Deguest E<lt>F<jack@deguest.jp>E<gt>
=head1 SEE ALSO
Stripe API documentation:
L<https://stripe.com/docs/api/radar/reviews/object>
=head1 COPYRIGHT & LICENSE
Copyright (c) 2019-2020 DEGUEST Pte. Ltd.
You can use, copy, modify and redistribute this package and associated
files under the same terms as Perl itself.
=cut