ipgeolocation_sdk 1.0.0

data/docs/IPLocationApi.md

@@ -0,0 +1,175 @@
+# IpgeolocationSdk::IPLocationApi
+
+All URIs are relative to *https://api.ipgeolocation.io/v2*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_bulk_ip_geolocation**](IPLocationApi.md#get_bulk_ip_geolocation) | **POST** /ipgeo-bulk |  |
+| [**get_ip_geolocation**](IPLocationApi.md#get_ip_geolocation) | **GET** /ipgeo |  |
+
+
+## get_bulk_ip_geolocation
+
+> <Array<GetBulkIpGeolocation200ResponseInner>> get_bulk_ip_geolocation(get_bulk_ip_geolocation_request, opts)
+
+
+
+This feature is available only on our paid API subscriptions (STANDARD or ADVANCED). This endpoint allows you to perform the geolocation lookup for multiple IPv4, IPv6 addresses or domain names (maximum 50,000) at the same time. The requests count per lookup is equal to total IP addresses or domain names passed. To perform bulk IP Geolocation Lookup, send a POST request and pass the \"ips\" array as JSON data along with it.  
+
+### Examples
+
+```ruby
+require 'time'
+require 'ipgeolocation_sdk'
+# setup authorization
+IpgeolocationSdk.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['apiKey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['apiKey'] = 'Bearer'
+end
+
+api_instance = IpgeolocationSdk::IPLocationApi.new
+get_bulk_ip_geolocation_request = IpgeolocationSdk::GetBulkIpGeolocationRequest.new # GetBulkIpGeolocationRequest | 
+opts = {
+  lang: 'en', # String | By default, the API responds in English. You can change the response language by passing the language code as a query parameter `lang`. Multi language feature is available only for `paid users`.
+  fields: 'location, location.country_name, network.asn.organization', # String | you can filter the API response by specifying the fields that you need, instead of getting the full response. To do this, pass the desired field names using the `fields` query parameter with each field represented as a dot-separated path.
+  excludes: 'location.continent_code,currency,network', # String | you can also filter the API response by excluding specific fields (except the IP address) that you don't need. To do this, pass the unwanted field names using the excludes query parameter, with each field represented as a dot-separated path
+  include: 'security', # String | IP Geolocation API also provides IP-Security, abuse, timezone, user-agent and DMA (Designated Market Area) code, which is specifically used in the US for marketing and regional targeting information on Advanced API subscription, but doesn't respond it by default. To get these information along with the geolocation information, you must pass the `include=security` or `include=abuse` or `include=dma` or `include=time_zone` or `include=user-agent` or you can fetch multiples by adding values in comma-separated way. In addition to that, IPGeolocation API also provide hostname lookup for an IP address on all the paid API subscriptions (STANDARD and ADVANCED), but doesn't respond it by default. To get the hostname for an IP address, you can pass one of the three values `hostname, liveHostname, hostnameFallbackLive` as a URL parameter `include=`.
+  output: 'json' # String | Desired output format(json or xml).
+}
+
+begin
+  
+  result = api_instance.get_bulk_ip_geolocation(get_bulk_ip_geolocation_request, opts)
+  p result
+rescue IpgeolocationSdk::ApiError => e
+  puts "Error when calling IPLocationApi->get_bulk_ip_geolocation: #{e}"
+end
+```
+
+#### Using the get_bulk_ip_geolocation_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<GetBulkIpGeolocation200ResponseInner>>, Integer, Hash)> get_bulk_ip_geolocation_with_http_info(get_bulk_ip_geolocation_request, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.get_bulk_ip_geolocation_with_http_info(get_bulk_ip_geolocation_request, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<GetBulkIpGeolocation200ResponseInner>>
+rescue IpgeolocationSdk::ApiError => e
+  puts "Error when calling IPLocationApi->get_bulk_ip_geolocation_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **get_bulk_ip_geolocation_request** | [**GetBulkIpGeolocationRequest**](GetBulkIpGeolocationRequest.md) |  |  |
+| **lang** | **String** | By default, the API responds in English. You can change the response language by passing the language code as a query parameter &#x60;lang&#x60;. Multi language feature is available only for &#x60;paid users&#x60;. | [optional] |
+| **fields** | **String** | you can filter the API response by specifying the fields that you need, instead of getting the full response. To do this, pass the desired field names using the &#x60;fields&#x60; query parameter with each field represented as a dot-separated path. | [optional] |
+| **excludes** | **String** | you can also filter the API response by excluding specific fields (except the IP address) that you don&#39;t need. To do this, pass the unwanted field names using the excludes query parameter, with each field represented as a dot-separated path | [optional] |
+| **include** | **String** | IP Geolocation API also provides IP-Security, abuse, timezone, user-agent and DMA (Designated Market Area) code, which is specifically used in the US for marketing and regional targeting information on Advanced API subscription, but doesn&#39;t respond it by default. To get these information along with the geolocation information, you must pass the &#x60;include&#x3D;security&#x60; or &#x60;include&#x3D;abuse&#x60; or &#x60;include&#x3D;dma&#x60; or &#x60;include&#x3D;time_zone&#x60; or &#x60;include&#x3D;user-agent&#x60; or you can fetch multiples by adding values in comma-separated way. In addition to that, IPGeolocation API also provide hostname lookup for an IP address on all the paid API subscriptions (STANDARD and ADVANCED), but doesn&#39;t respond it by default. To get the hostname for an IP address, you can pass one of the three values &#x60;hostname, liveHostname, hostnameFallbackLive&#x60; as a URL parameter &#x60;include&#x3D;&#x60;. | [optional] |
+| **output** | **String** | Desired output format(json or xml). | [optional] |
+
+### Return type
+
+[**Array&lt;GetBulkIpGeolocation200ResponseInner&gt;**](GetBulkIpGeolocation200ResponseInner.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json, application/xml
+
+
+## get_ip_geolocation
+
+> <GeolocationResponse> get_ip_geolocation(opts)
+
+
+
+IP Geolocation API provides real-time and accurate geolocation, network, abuse, and security information for any IPv4 or IPv6 address and domain name along with the user-agent detail for the provided user-agent string. You can geolocate your online visitors and provide them the customized user-experience accordingly.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ipgeolocation_sdk'
+# setup authorization
+IpgeolocationSdk.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['apiKey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['apiKey'] = 'Bearer'
+end
+
+api_instance = IpgeolocationSdk::IPLocationApi.new
+opts = {
+  ip: '8.8.8.8 OR dns.google.com', # String | In order to find geolocation information about an IP (ipv4 ipv6) address or a domain name, pass it as a query parameter ip. When this endpoint is queried without an IP address, it returns the geolocation information of the device/client which is calling it
+  lang: 'en', # String | By default, the API responds in English. You can change the response language by passing the language code as a query parameter `lang`. Multi language feature is available only for `paid users`.
+  fields: 'location, location.country_name, network.asn.organization', # String | you can filter the API response by specifying the fields that you need, instead of getting the full response. To do this, pass the desired field names using the `fields` query parameter with each field represented as a dot-separated path.
+  excludes: 'location.continent_code,currency,network', # String | you can also filter the API response by excluding specific fields (except the IP address) that you don't need. To do this, pass the unwanted field names using the excludes query parameter, with each field represented as a dot-separated path
+  include: 'security', # String | IP Geolocation API also provides IP-Security, abuse, timezone, user-agent and DMA (Designated Market Area) code, which is specifically used in the US for marketing and regional targeting information on Advanced API subscription, but doesn't respond it by default. To get these information along with the geolocation information, you must pass the `include=security` or `include=abuse` or `include=dma` or `include=time_zone` or `include=user-agent` or you can fetch multiples by adding values in comma-separated way. In addition to that, IPGeolocation API also provide hostname lookup for an IP address on all the paid API subscriptions (STANDARD and ADVANCED), but doesn't respond it by default. To get the hostname for an IP address, you can pass one of the three values `hostname, liveHostname, hostnameFallbackLive` as a URL parameter `include=`.
+  output: 'json' # String | Desired output format (json or xml).
+}
+
+begin
+  
+  result = api_instance.get_ip_geolocation(opts)
+  p result
+rescue IpgeolocationSdk::ApiError => e
+  puts "Error when calling IPLocationApi->get_ip_geolocation: #{e}"
+end
+```
+
+#### Using the get_ip_geolocation_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GeolocationResponse>, Integer, Hash)> get_ip_geolocation_with_http_info(opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.get_ip_geolocation_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GeolocationResponse>
+rescue IpgeolocationSdk::ApiError => e
+  puts "Error when calling IPLocationApi->get_ip_geolocation_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ip** | **String** | In order to find geolocation information about an IP (ipv4 ipv6) address or a domain name, pass it as a query parameter ip. When this endpoint is queried without an IP address, it returns the geolocation information of the device/client which is calling it | [optional] |
+| **lang** | **String** | By default, the API responds in English. You can change the response language by passing the language code as a query parameter &#x60;lang&#x60;. Multi language feature is available only for &#x60;paid users&#x60;. | [optional] |
+| **fields** | **String** | you can filter the API response by specifying the fields that you need, instead of getting the full response. To do this, pass the desired field names using the &#x60;fields&#x60; query parameter with each field represented as a dot-separated path. | [optional] |
+| **excludes** | **String** | you can also filter the API response by excluding specific fields (except the IP address) that you don&#39;t need. To do this, pass the unwanted field names using the excludes query parameter, with each field represented as a dot-separated path | [optional] |
+| **include** | **String** | IP Geolocation API also provides IP-Security, abuse, timezone, user-agent and DMA (Designated Market Area) code, which is specifically used in the US for marketing and regional targeting information on Advanced API subscription, but doesn&#39;t respond it by default. To get these information along with the geolocation information, you must pass the &#x60;include&#x3D;security&#x60; or &#x60;include&#x3D;abuse&#x60; or &#x60;include&#x3D;dma&#x60; or &#x60;include&#x3D;time_zone&#x60; or &#x60;include&#x3D;user-agent&#x60; or you can fetch multiples by adding values in comma-separated way. In addition to that, IPGeolocation API also provide hostname lookup for an IP address on all the paid API subscriptions (STANDARD and ADVANCED), but doesn&#39;t respond it by default. To get the hostname for an IP address, you can pass one of the three values &#x60;hostname, liveHostname, hostnameFallbackLive&#x60; as a URL parameter &#x60;include&#x3D;&#x60;. | [optional] |
+| **output** | **String** | Desired output format (json or xml). | [optional] |
+
+### Return type
+
+[**GeolocationResponse**](GeolocationResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/xml
+

data/docs/Location.md

@@ -0,0 +1,58 @@
+# IpgeolocationSdk::Location
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **continent_code** | **String** |  | [optional] |
+| **continent_name** | **String** |  | [optional] |
+| **country_code2** | **String** |  | [optional] |
+| **country_code3** | **String** |  | [optional] |
+| **country_name** | **String** |  | [optional] |
+| **country_name_official** | **String** |  | [optional] |
+| **country_capital** | **String** |  | [optional] |
+| **state_prov** | **String** |  | [optional] |
+| **state_code** | **String** |  | [optional] |
+| **district** | **String** |  | [optional] |
+| **city** | **String** |  | [optional] |
+| **zipcode** | **String** |  | [optional] |
+| **latitude** | **String** |  | [optional] |
+| **longitude** | **String** |  | [optional] |
+| **is_eu** | **Boolean** |  | [optional] |
+| **country_flag** | **String** |  | [optional] |
+| **geoname_id** | **String** |  | [optional] |
+| **country_emoji** | **String** |  | [optional] |
+| **accuracy_radius** | **String** |  | [optional] |
+| **locality** | **String** |  | [optional] |
+| **dma_code** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+instance = IpgeolocationSdk::Location.new(
+  continent_code: NA,
+  continent_name: North America,
+  country_code2: US,
+  country_code3: USA,
+  country_name: United States,
+  country_name_official: United States of America,
+  country_capital: Washington, D.C.,
+  state_prov: California,
+  state_code: US-CA,
+  district: Santa Clara,
+  city: Mountain View,
+  zipcode: 94043-1351,
+  latitude: 37.42240,
+  longitude: -122.08421,
+  is_eu: false,
+  country_flag: https://ipgeolocation.io/static/flags/us_64.png,
+  geoname_id: 6301403,
+  country_emoji: ,
+  accuracy_radius: 1000,
+  locality: Mountain View,
+  dma_code: 807
+)
+```
+

data/docs/LocationMinimal.md

@@ -0,0 +1,52 @@
+# IpgeolocationSdk::LocationMinimal
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **continent_code** | **String** |  | [optional] |
+| **continent_name** | **String** |  | [optional] |
+| **country_code2** | **String** |  | [optional] |
+| **country_code3** | **String** |  | [optional] |
+| **country_name** | **String** |  | [optional] |
+| **country_name_official** | **String** |  | [optional] |
+| **country_capital** | **String** |  | [optional] |
+| **state_prov** | **String** |  | [optional] |
+| **state_code** | **String** |  | [optional] |
+| **district** | **String** |  | [optional] |
+| **city** | **String** |  | [optional] |
+| **zipcode** | **String** |  | [optional] |
+| **latitude** | **String** |  | [optional] |
+| **longitude** | **String** |  | [optional] |
+| **is_eu** | **Boolean** |  | [optional] |
+| **country_flag** | **String** |  | [optional] |
+| **geoname_id** | **String** |  | [optional] |
+| **country_emoji** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+instance = IpgeolocationSdk::LocationMinimal.new(
+  continent_code: NA,
+  continent_name: North America,
+  country_code2: US,
+  country_code3: USA,
+  country_name: United States,
+  country_name_official: United States of America,
+  country_capital: Washington, D.C.,
+  state_prov: California,
+  state_code: US-CA,
+  district: Santa Clara,
+  city: Mountain View,
+  zipcode: 94043-1351,
+  latitude: 37.42240,
+  longitude: -122.08421,
+  is_eu: false,
+  country_flag: https://ipgeolocation.io/static/flags/us_64.png,
+  geoname_id: 6301403,
+  country_emoji: 
+)
+```
+

data/docs/Network.md

@@ -0,0 +1,22 @@
+# IpgeolocationSdk::Network
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **asn** | [**NetworkAsn**](NetworkAsn.md) |  | [optional] |
+| **connection_type** | **String** |  | [optional] |
+| **company** | [**NetworkCompany**](NetworkCompany.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+instance = IpgeolocationSdk::Network.new(
+  asn: null,
+  connection_type: wired,
+  company: null
+)
+```
+

data/docs/NetworkAsn.md

@@ -0,0 +1,38 @@
+# IpgeolocationSdk::NetworkAsn
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **as_number** | **String** |  | [optional] |
+| **organization** | **String** |  | [optional] |
+| **country** | **String** |  | [optional] |
+| **asn_name** | **String** |  | [optional] |
+| **type** | **String** |  | [optional] |
+| **domain** | **String** |  | [optional] |
+| **date_allocated** | **String** |  | [optional] |
+| **allocation_status** | **String** |  | [optional] |
+| **num_of_ipv4_routes** | **String** |  | [optional] |
+| **num_of_ipv6_routes** | **String** |  | [optional] |
+| **rir** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+instance = IpgeolocationSdk::NetworkAsn.new(
+  as_number: AS15169,
+  organization: Google LLC,
+  country: US,
+  asn_name: GOOGLE,
+  type: isp,
+  domain: about.google,
+  date_allocated: ,
+  allocation_status: Assigned,
+  num_of_ipv4_routes: 1099,
+  num_of_ipv6_routes: 107,
+  rir: ARIN
+)
+```
+

data/docs/NetworkCompany.md

@@ -0,0 +1,22 @@
+# IpgeolocationSdk::NetworkCompany
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **type** | **String** |  | [optional] |
+| **domain** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+instance = IpgeolocationSdk::NetworkCompany.new(
+  name: Google LLC,
+  type: hosting,
+  domain: google.com
+)
+```
+

data/docs/NetworkMinimal.md

@@ -0,0 +1,20 @@
+# IpgeolocationSdk::NetworkMinimal
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **asn** | [**NetworkMinimalAsn**](NetworkMinimalAsn.md) |  | [optional] |
+| **company** | [**NetworkMinimalCompany**](NetworkMinimalCompany.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+instance = IpgeolocationSdk::NetworkMinimal.new(
+  asn: null,
+  company: null
+)
+```
+

data/docs/NetworkMinimalAsn.md

@@ -0,0 +1,22 @@
+# IpgeolocationSdk::NetworkMinimalAsn
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **as_number** | **String** |  | [optional] |
+| **organization** | **String** |  | [optional] |
+| **country** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+instance = IpgeolocationSdk::NetworkMinimalAsn.new(
+  as_number: AS15169,
+  organization: Google LLC,
+  country: US
+)
+```
+

data/docs/NetworkMinimalCompany.md

@@ -0,0 +1,18 @@
+# IpgeolocationSdk::NetworkMinimalCompany
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+instance = IpgeolocationSdk::NetworkMinimalCompany.new(
+  name: Google LLC
+)
+```
+

data/docs/ParseBulkUserAgentStringsRequest.md

@@ -0,0 +1,18 @@
+# IpgeolocationSdk::ParseBulkUserAgentStringsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ua_strings** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+instance = IpgeolocationSdk::ParseBulkUserAgentStringsRequest.new(
+  ua_strings: ["Mozilla/5.0 (Linux; Android 8.0.0; SM-G960F Build/R16NW) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/62.0.3202.84 Mobile Safari/537.36","Mozilla/5.0 (X11; U; Linux armv7l like Android; en-us) AppleWebKit/531.2+ (KHTML, like Gecko) Version/5.0 Safari/533.2+ Kindle/3.0+","Mozilla/5.0 (Linux; U; en-US) AppleWebKit/528.5+ (KHTML, like Gecko, Safari/528.5+) Version/4.0 Kindle/3.0 (screen 600x800; rotate)"]
+)
+```
+

data/docs/ParseUserAgentStringRequest.md

@@ -0,0 +1,18 @@
+# IpgeolocationSdk::ParseUserAgentStringRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ua_string** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+instance = IpgeolocationSdk::ParseUserAgentStringRequest.new(
+  ua_string: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_2) AppleWebKit/601.3.9 (KHTML, like Gecko) Version/9.0.2 Safari/601.3.9
+)
+```
+

data/docs/Security.md

@@ -0,0 +1,38 @@
+# IpgeolocationSdk::Security
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **threat_score** | **Integer** |  | [optional] |
+| **is_tor** | **Boolean** |  | [optional] |
+| **is_proxy** | **Boolean** |  | [optional] |
+| **proxy_type** | **String** |  | [optional] |
+| **proxy_provider** | **String** |  | [optional] |
+| **is_anonymous** | **Boolean** |  | [optional] |
+| **is_known_attacker** | **Boolean** |  | [optional] |
+| **is_spam** | **Boolean** |  | [optional] |
+| **is_bot** | **Boolean** |  | [optional] |
+| **is_cloud_provider** | **Boolean** |  | [optional] |
+| **cloud_provider** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+instance = IpgeolocationSdk::Security.new(
+  threat_score: 80,
+  is_tor: false,
+  is_proxy: true,
+  proxy_type: VPN,
+  proxy_provider: ,
+  is_anonymous: true,
+  is_known_attacker: true,
+  is_spam: false,
+  is_bot: false,
+  is_cloud_provider: false,
+  cloud_provider: 
+)
+```
+

data/docs/SecurityAPIResponse.md

@@ -0,0 +1,34 @@
+# IpgeolocationSdk::SecurityAPIResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ip** | **String** |  | [optional] |
+| **hostname** | **String** |  | [optional] |
+| **security** | [**Security**](Security.md) |  | [optional] |
+| **location** | [**LocationMinimal**](LocationMinimal.md) |  | [optional] |
+| **network** | [**NetworkMinimal**](NetworkMinimal.md) |  | [optional] |
+| **time_zone** | [**TimeZone**](TimeZone.md) |  | [optional] |
+| **user_agent** | [**UserAgentData**](UserAgentData.md) |  | [optional] |
+| **country_metadata** | [**CountryMetadata**](CountryMetadata.md) |  | [optional] |
+| **currency** | [**Currency**](Currency.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+instance = IpgeolocationSdk::SecurityAPIResponse.new(
+  ip: 8.8.8.8,
+  hostname: 195-154-221-54.rev.poneytelecom.eu,
+  security: null,
+  location: null,
+  network: null,
+  time_zone: null,
+  user_agent: null,
+  country_metadata: null,
+  currency: null
+)
+```
+

data/docs/SecurityAPIXMLResponse.md

@@ -0,0 +1,34 @@
+# IpgeolocationSdk::SecurityAPIXMLResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ip** | **String** |  | [optional] |
+| **hostname** | **String** |  | [optional] |
+| **security** | [**Security**](Security.md) |  | [optional] |
+| **location** | [**LocationMinimal**](LocationMinimal.md) |  | [optional] |
+| **network** | [**NetworkMinimal**](NetworkMinimal.md) |  | [optional] |
+| **time_zone** | [**TimeZone**](TimeZone.md) |  | [optional] |
+| **user_agent** | [**UserAgentData**](UserAgentData.md) |  | [optional] |
+| **country_metadata** | [**CountryMetadata**](CountryMetadata.md) |  | [optional] |
+| **currency** | [**Currency**](Currency.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+instance = IpgeolocationSdk::SecurityAPIXMLResponse.new(
+  ip: 8.8.8.8,
+  hostname: 195-154-221-54.rev.poneytelecom.eu,
+  security: null,
+  location: null,
+  network: null,
+  time_zone: null,
+  user_agent: null,
+  country_metadata: null,
+  currency: null
+)
+```
+

data/docs/SecurityAPIXMLResponseArray.md

@@ -0,0 +1,34 @@
+# IpgeolocationSdk::SecurityAPIXMLResponseArray
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ip** | **String** |  | [optional] |
+| **hostname** | **String** |  | [optional] |
+| **security** | [**Security**](Security.md) |  | [optional] |
+| **location** | [**LocationMinimal**](LocationMinimal.md) |  | [optional] |
+| **network** | [**NetworkMinimal**](NetworkMinimal.md) |  | [optional] |
+| **time_zone** | [**TimeZone**](TimeZone.md) |  | [optional] |
+| **user_agent** | [**UserAgentData**](UserAgentData.md) |  | [optional] |
+| **country_metadata** | [**CountryMetadata**](CountryMetadata.md) |  | [optional] |
+| **currency** | [**Currency**](Currency.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+instance = IpgeolocationSdk::SecurityAPIXMLResponseArray.new(
+  ip: 8.8.8.8,
+  hostname: 195-154-221-54.rev.poneytelecom.eu,
+  security: null,
+  location: null,
+  network: null,
+  time_zone: null,
+  user_agent: null,
+  country_metadata: null,
+  currency: null
+)
+```
+