ipgeolocation_sdk 1.0.0

data/docs/AstronomyLocation.md

@@ -0,0 +1,50 @@
+# IpgeolocationSdk::AstronomyLocation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **location_string** | **String** |  | [optional] |
+| **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] |
+| **is_eu** | **Boolean** |  | [optional] |
+| **state_prov** | **String** |  | [optional] |
+| **state_code** | **String** |  | [optional] |
+| **district** | **String** |  | [optional] |
+| **city** | **String** |  | [optional] |
+| **locality** | **String** |  | [optional] |
+| **zipcode** | **String** |  | [optional] |
+| **latitude** | **String** |  | [optional] |
+| **longitude** | **String** |  | [optional] |
+| **elevation** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+instance = IpgeolocationSdk::AstronomyLocation.new(
+  location_string: Londong, UK,
+  continent_code: OC,
+  continent_name: Oceania,
+  country_code2: AU,
+  country_code3: AUS,
+  country_name: Australia,
+  country_name_official: Commonwealth of Australia,
+  is_eu: false,
+  state_prov: Queensland,
+  state_code: AU-QLD,
+  district: South Brisbane,
+  city: Brisbane,
+  locality: ,
+  zipcode: 4101,
+  latitude: -27.47306,
+  longitude: 153.01421,
+  elevation: 36.6
+)
+```
+

data/docs/AstronomyMorning.md

@@ -0,0 +1,36 @@
+# IpgeolocationSdk::AstronomyMorning
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **astronomical_twilight_begin** | **String** |  | [optional] |
+| **astronomical_twilight_end** | **String** |  | [optional] |
+| **nautical_twilight_begin** | **String** |  | [optional] |
+| **nautical_twilight_end** | **String** |  | [optional] |
+| **civil_twilight_begin** | **String** |  | [optional] |
+| **civil_twilight_end** | **String** |  | [optional] |
+| **blue_hour_begin** | **String** |  | [optional] |
+| **blue_hour_end** | **String** |  | [optional] |
+| **golden_hour_begin** | **String** |  | [optional] |
+| **golden_hour_end** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+instance = IpgeolocationSdk::AstronomyMorning.new(
+  astronomical_twilight_begin: 03:40,
+  astronomical_twilight_end: 04:27,
+  nautical_twilight_begin: 04:27,
+  nautical_twilight_end: 05:07,
+  civil_twilight_begin: 05:07,
+  civil_twilight_end: 05:39,
+  blue_hour_begin: 04:54,
+  blue_hour_end: 05:20,
+  golden_hour_begin: 05:20,
+  golden_hour_end: 06:19
+)
+```
+

data/docs/AstronomyResponse.md

@@ -0,0 +1,22 @@
+# IpgeolocationSdk::AstronomyResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ip** | **String** |  | [optional] |
+| **location** | [**AstronomyLocation**](AstronomyLocation.md) |  | [optional] |
+| **astronomy** | [**Astronomy**](Astronomy.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+instance = IpgeolocationSdk::AstronomyResponse.new(
+  ip: 8.8.8.8,
+  location: null,
+  astronomy: null
+)
+```
+

data/docs/AstronomyXMLResponse.md

@@ -0,0 +1,22 @@
+# IpgeolocationSdk::AstronomyXMLResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ip** | **String** |  | [optional] |
+| **location** | [**TimezoneLocation**](TimezoneLocation.md) |  | [optional] |
+| **astronomy** | [**Astronomy**](Astronomy.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+instance = IpgeolocationSdk::AstronomyXMLResponse.new(
+  ip: 8.8.8.8,
+  location: null,
+  astronomy: null
+)
+```
+

data/docs/BulkIPGeolocation.md

@@ -0,0 +1,42 @@
+# IpgeolocationSdk::BulkIPGeolocation
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'ipgeolocation_sdk'
+```
+
+### build
+
+Find the appropriate object from the `the provided method is_error and is_success` and casts the data into it.
+
+#### Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+IpgeolocationSdk::BulkIPGeolocation.build(data)
+# => #<ErrorResponse:0x00007fdd4aab02a0>
+
+IpgeolocationSdk::BulkIPGeolocation.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `ErrorResponse`
+- `GeolocationResponse`
+- `nil` (if no type matches)
+

data/docs/BulkIPSecurity.md

@@ -0,0 +1,42 @@
+# IpgeolocationSdk::BulkIPSecurity
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'ipgeolocation_sdk'
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+IpgeolocationSdk::BulkIPSecurity.build(data)
+# => #<ErrorResponse:0x00007fdd4aab02a0>
+
+IpgeolocationSdk::BulkIPSecurity.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `ErrorResponse`
+- `SecurityAPIResponse`
+- `nil` (if no type matches)
+

data/docs/CountryMetadata.md

@@ -0,0 +1,22 @@
+# IpgeolocationSdk::CountryMetadata
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **calling_code** | **String** |  | [optional] |
+| **tld** | **String** |  | [optional] |
+| **languages** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+instance = IpgeolocationSdk::CountryMetadata.new(
+  calling_code: +1,
+  tld: .us,
+  languages: ["en-US","es-US","haw","fr"]
+)
+```
+

data/docs/Currency.md

@@ -0,0 +1,22 @@
+# IpgeolocationSdk::Currency
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **symbol** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+instance = IpgeolocationSdk::Currency.new(
+  code: USD,
+  name: US Dollar,
+  symbol: $
+)
+```
+

data/docs/ErrorResponse.md

@@ -0,0 +1,18 @@
+# IpgeolocationSdk::ErrorResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+instance = IpgeolocationSdk::ErrorResponse.new(
+  message: The message showing the error
+)
+```
+

data/docs/ErrorXMLResponse.md

@@ -0,0 +1,18 @@
+# IpgeolocationSdk::ErrorXMLResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+instance = IpgeolocationSdk::ErrorXMLResponse.new(
+  message: The Message showing the error
+)
+```
+

data/docs/ErrorXMLResponseArray.md

@@ -0,0 +1,18 @@
+# IpgeolocationSdk::ErrorXMLResponseArray
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+instance = IpgeolocationSdk::ErrorXMLResponseArray.new(
+  message: The Message showing the error
+)
+```
+

data/docs/GeolocationResponse.md

@@ -0,0 +1,38 @@
+# IpgeolocationSdk::GeolocationResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ip** | **String** |  | [optional] |
+| **hostname** | **String** |  | [optional] |
+| **domain** | **String** |  | [optional] |
+| **location** | [**Location**](Location.md) |  | [optional] |
+| **country_metadata** | [**CountryMetadata**](CountryMetadata.md) |  | [optional] |
+| **network** | [**Network**](Network.md) |  | [optional] |
+| **currency** | [**Currency**](Currency.md) |  | [optional] |
+| **security** | [**Security**](Security.md) |  | [optional] |
+| **abuse** | [**Abuse**](Abuse.md) |  | [optional] |
+| **time_zone** | [**TimeZone**](TimeZone.md) |  | [optional] |
+| **user_agent** | [**UserAgentData**](UserAgentData.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+instance = IpgeolocationSdk::GeolocationResponse.new(
+  ip: 8.8.8.8,
+  hostname: dns.google,
+  domain: google.com,
+  location: null,
+  country_metadata: null,
+  network: null,
+  currency: null,
+  security: null,
+  abuse: null,
+  time_zone: null,
+  user_agent: null
+)
+```
+

data/docs/GeolocationXMLResponse.md

@@ -0,0 +1,38 @@
+# IpgeolocationSdk::GeolocationXMLResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ip** | **String** |  | [optional] |
+| **hostname** | **String** |  | [optional] |
+| **domain** | **String** |  | [optional] |
+| **location** | [**Location**](Location.md) |  | [optional] |
+| **country_metadata** | [**CountryMetadata**](CountryMetadata.md) |  | [optional] |
+| **network** | [**Network**](Network.md) |  | [optional] |
+| **currency** | [**Currency**](Currency.md) |  | [optional] |
+| **security** | [**Security**](Security.md) |  | [optional] |
+| **abuse** | [**Abuse**](Abuse.md) |  | [optional] |
+| **time_zone** | [**TimeZone**](TimeZone.md) |  | [optional] |
+| **user_agent** | [**UserAgentData**](UserAgentData.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+instance = IpgeolocationSdk::GeolocationXMLResponse.new(
+  ip: 8.8.8.8,
+  hostname: dns.google,
+  domain: google.com,
+  location: null,
+  country_metadata: null,
+  network: null,
+  currency: null,
+  security: null,
+  abuse: null,
+  time_zone: null,
+  user_agent: null
+)
+```
+

data/docs/GeolocationXMLResponseArray.md

@@ -0,0 +1,38 @@
+# IpgeolocationSdk::GeolocationXMLResponseArray
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ip** | **String** |  | [optional] |
+| **hostname** | **String** |  | [optional] |
+| **domain** | **String** |  | [optional] |
+| **location** | [**Location**](Location.md) |  | [optional] |
+| **country_metadata** | [**CountryMetadata**](CountryMetadata.md) |  | [optional] |
+| **network** | [**Network**](Network.md) |  | [optional] |
+| **currency** | [**Currency**](Currency.md) |  | [optional] |
+| **security** | [**Security**](Security.md) |  | [optional] |
+| **abuse** | [**Abuse**](Abuse.md) |  | [optional] |
+| **time_zone** | [**TimeZone**](TimeZone.md) |  | [optional] |
+| **user_agent** | [**UserAgentData**](UserAgentData.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+instance = IpgeolocationSdk::GeolocationXMLResponseArray.new(
+  ip: 8.8.8.8,
+  hostname: dns.google,
+  domain: google.com,
+  location: null,
+  country_metadata: null,
+  network: null,
+  currency: null,
+  security: null,
+  abuse: null,
+  time_zone: null,
+  user_agent: null
+)
+```
+

data/docs/GetBulkIpGeolocation200ResponseInner1.md

@@ -0,0 +1,49 @@
+# IpgeolocationSdk::GetBulkIpGeolocation200ResponseInner1
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+IpgeolocationSdk::GetBulkIpGeolocation200ResponseInner1.openapi_one_of
+# =>
+# [
+#   :'ErrorXMLResponseArray',
+#   :'GeolocationXMLResponseArray'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+IpgeolocationSdk::GetBulkIpGeolocation200ResponseInner1.build(data)
+# => #<ErrorXMLResponseArray:0x00007fdd4aab02a0>
+
+IpgeolocationSdk::GetBulkIpGeolocation200ResponseInner1.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `ErrorXMLResponseArray`
+- `GeolocationXMLResponseArray`
+- `nil` (if no type matches)
+

data/docs/GetBulkIpGeolocationRequest.md

@@ -0,0 +1,18 @@
+# IpgeolocationSdk::GetBulkIpGeolocationRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ips** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+instance = IpgeolocationSdk::GetBulkIpGeolocationRequest.new(
+  ips: ["2.2.2.2","3.3.3.3"]
+)
+```
+

data/docs/GetBulkIpSecurityInfo200ResponseInner1.md

@@ -0,0 +1,49 @@
+# IpgeolocationSdk::GetBulkIpSecurityInfo200ResponseInner1
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+IpgeolocationSdk::GetBulkIpSecurityInfo200ResponseInner1.openapi_one_of
+# =>
+# [
+#   :'ErrorXMLResponseArray',
+#   :'SecurityAPIXMLResponseArray'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+IpgeolocationSdk::GetBulkIpSecurityInfo200ResponseInner1.build(data)
+# => #<ErrorXMLResponseArray:0x00007fdd4aab02a0>
+
+IpgeolocationSdk::GetBulkIpSecurityInfo200ResponseInner1.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `ErrorXMLResponseArray`
+- `SecurityAPIXMLResponseArray`
+- `nil` (if no type matches)
+