File Coverage

lib/Net/API/Stripe/Terminal/Location.pm
Criterion Covered Total %
statement 19 26 73.0
branch n/a
condition n/a
subroutine 7 14 50.0
pod 7 7 100.0
total 33 47 70.2


line stmt bran cond sub pod time code
1             ##----------------------------------------------------------------------------
2             ## Stripe API - ~/lib/Net/API/Stripe/Terminal/Location.pm
3             ## Version v0.101.0
4             ## Copyright(c) 2019 DEGUEST Pte. Ltd.
5             ## Author: Jacques Deguest <jack@deguest.jp>
6             ## Created 2019/11/02
7             ## Modified 2022/10/29
8             ##
9             ##----------------------------------------------------------------------------
10             ## https://stripe.com/docs/api/terminal/locations
11             BEGIN
12             {
13             use strict;
14 2     2   20261375 use warnings;
  2         15  
  2         71  
15 2     2   13 use parent qw( Net::API::Stripe::Generic );
  2         4  
  2         58  
16 2     2   11 use vars qw( $VERSION );
  2         4  
  2         11  
17 2     2   143 our( $VERSION ) = 'v0.101.0';
  2         5  
  2         137  
18 2     2   42 };
19              
20             use strict;
21 2     2   11 use warnings;
  2         5  
  2         52  
22 2     2   10  
  2         5  
  2         385  
23              
24 0     0 1    
25              
26 0     0 1    
27              
28 0     0 1    
29              
30 0     0 1   1;
31             # NOTE: POD
32 0     0 1    
33             =encoding utf8
34 0     0 1    
35             =head1 NAME
36 0     0 1    
37             Net::API::Stripe::Terminal::Location - A Strip Terminal Reader Location Object
38              
39             =head1 SYNOPSIS
40              
41             my $loc = $stripe->location({
42             address => $address_object,
43             display_name => 'Tokyo central',
44             });
45              
46             See documentation in L<Net::API::Stripe> for example to make api calls to Stripe to create those objects.
47              
48             =head1 VERSION
49              
50             v0.101.0
51              
52             =head1 DESCRIPTION
53              
54             A Location represents a grouping of readers.
55              
56             =head1 CONSTRUCTOR
57              
58             =head2 new( %ARG )
59              
60             Creates a new L<Net::API::Stripe::Terminal::Location> 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 id string
66              
67             Unique identifier for the object.
68              
69             =head2 object string, value is "terminal.location"
70              
71             String representing the object’s type. Objects of the same type share the same value.
72              
73             =head2 address hash
74              
75             The full address of the location.
76              
77             This is a L<Net::API::Stripe::Address> object.
78              
79             =head2 configuration_overrides string
80              
81             The ID of a configuration that will be used to customize all readers in this location.
82              
83             =head2 display_name string
84              
85             The display name of the location.
86              
87             =head2 livemode boolean
88              
89             Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
90              
91             =head2 metadata hash
92              
93             Set of [key-value pairs](/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
94              
95             =head1 API SAMPLE
96              
97             {
98             "id": "tml_fake123456789",
99             "object": "terminal.location",
100             "address": {
101             "city": "Anytown",
102             "country": "US",
103             "line1": "1234 Main street",
104             "line2": null,
105             "postal_code": "123456",
106             "state": null
107             },
108             "display_name": "My First Store"
109             }
110              
111             =head1 HISTORY
112              
113             =head2 v0.1
114              
115             Initial version
116              
117             =head1 AUTHOR
118              
119             Jacques Deguest E<lt>F<jack@deguest.jp>E<gt>
120              
121             =head1 SEE ALSO
122              
123             Stripe API documentation:
124              
125             L<https://stripe.com/docs/api/terminal/locations>, L<https://stripe.com/docs/terminal/readers/fleet-management#create>
126              
127             =head1 COPYRIGHT & LICENSE
128              
129             Copyright (c) 2019-2020 DEGUEST Pte. Ltd.
130              
131             You can use, copy, modify and redistribute this package and associated
132             files under the same terms as Perl itself.
133              
134             =cut