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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
|
package GeoIP2::Model::Enterprise;
use strict;
use warnings;
our $VERSION = '2.006002';
use Moo;
use namespace::clean -except => 'meta';
with 'GeoIP2::Role::Model::Location', 'GeoIP2::Role::Model::HasSubdivisions';
## no critic (ProhibitUnusedPrivateSubroutines)
sub _has { has(@_) }
## use critic
__PACKAGE__->_define_attributes_for_keys( __PACKAGE__->_all_record_names() );
1;
# ABSTRACT: Model class for GeoIP2 Enterprise
__END__
=pod
=encoding UTF-8
=head1 NAME
GeoIP2::Model::Enterprise - Model class for GeoIP2 Enterprise
=head1 VERSION
version 2.006002
=head1 SYNOPSIS
use 5.008;
use GeoIP2::WebService::Client;
my $reader = GeoIP2::Database::Reader->new(
file => '/path/to/database',
locales => [ 'en', 'de', ]
);
my $enterprise = $reader->enterprise( ip => '24.24.24.24' );
my $city_rec = $enterprise->city();
print $city_rec->name(), "\n";
=head1 DESCRIPTION
This class provides a model for the data returned by the GeoIP2 Enterprise
database.
The only difference between the City and Enterprise model classes is
which fields in each record may be populated. See
L<http://dev.maxmind.com/geoip/geoip2/web-services> for more details.
=head1 METHODS
This class provides the following methods.
=head2 $enterprise->city()
Returns a L<GeoIP2::Record::City> object representing city data for the
requested IP address.
=head2 $enterprise->continent()
Returns a L<GeoIP2::Record::Continent> object representing continent data for
the requested IP address.
=head2 $enterprise->country()
Returns a L<GeoIP2::Record::Country> object representing country data for the
requested IP address. This record represents the country where MaxMind
believes the IP is located.
=head2 $enterprise->location()
Returns a L<GeoIP2::Record::Location> object representing location data for the
requested IP address.
=head2 $enterprise->postal()
Returns a L<GeoIP2::Record::Postal> object representing postal code data for
the requested IP address.
=head2 $enterprise->registered_country()
Returns a L<GeoIP2::Record::Country> object representing the registered
country data for the requested IP address. This record represents the country
where the ISP has registered a given IP block and may differ from the
user's country.
=head2 $enterprise->represented_country()
Returns a L<GeoIP2::Record::RepresentedCountry> object for the country
represented by the requested IP address. The represented country may differ
from the C<country> for things like military bases.
=head2 $enterprise->subdivisions()
Returns an array of L<GeoIP2::Record::Subdivision> objects representing the
country subdivisions for the requested IP address. The number and type of
subdivisions varies by country, but a subdivision is typically a state,
province, county, etc.
Some countries have multiple levels of subdivisions. For instance, the
subdivisions array for Oxford in the United Kingdom would have England as the
first element and Oxfordshire as the second element. The subdivisions array
for Minneapolis in the United States would have a single object for Minnesota.
If the response did not contain any subdivisions, this method returns an empty
list.
=head2 $enterprise->most_specific_subdivision()
Returns a single L<GeoIP2::Record::Subdivision> object representing the most
specific subdivision returned.
If the response did not contain any subdivisions, this method returns a
L<GeoIP2::Record::Subdivision> object with no values.
=head2 $enterprise->traits()
Returns a L<GeoIP2::Record::Traits> object representing the traits for the
requested IP address.
=head1 SUPPORT
Bugs may be submitted through L<https://github.com/maxmind/GeoIP2-perl/issues>.
=head1 AUTHORS
=over 4
=item *
Dave Rolsky <drolsky@maxmind.com>
=item *
Greg Oschwald <goschwald@maxmind.com>
=item *
Mark Fowler <mfowler@maxmind.com>
=item *
Olaf Alders <oalders@maxmind.com>
=back
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2013 - 2019 by MaxMind, Inc.
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
|
