ipgeolocation_sdk 1.0.0 → 2.0.0

data/docs/Abuse.md

@@ -1,40 +0,0 @@
-# IpgeolocationSdk::Abuse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **route** | **String** |  | [optional] |
-| **country** | **String** |  | [optional] |
-| **handle** | **String** |  | [optional] |
-| **name** | **String** |  | [optional] |
-| **organization** | **String** |  | [optional] |
-| **role** | **String** |  | [optional] |
-| **kind** | **String** |  | [optional] |
-| **address** | **String** |  | [optional] |
-| **emails** | **Array<String>** |  | [optional] |
-| **phone_numbers** | **Array<String>** |  | [optional] |
-
-## Example
-
-```ruby
-require 'ipgeolocation_sdk'
-
-instance = IpgeolocationSdk::Abuse.new(
-  route: 8.8.8.0/24,
-  country: US,
-  handle: ABUSE5250-ARIN,
-  name: Abuse,
-  organization: Abuse,
-  role: abuse,
-  kind: group,
-  address: 1600 Amphitheatre Parkway
-Mountain View
-CA
-94043
-United States,
-  emails: ["network-abuse@google.com"],
-  phone_numbers: ["+1-650-253-0000"]
-)
-```
-

data/docs/AbuseContactApi.md

@@ -1,85 +0,0 @@
-# IpgeolocationSdk::AbuseContactApi
-
-All URIs are relative to *https://api.ipgeolocation.io/v2*
-
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**get_abuse_contact_info**](AbuseContactApi.md#get_abuse_contact_info) | **GET** /abuse |  |
-
-
-## get_abuse_contact_info
-
-> <AbuseResponse> get_abuse_contact_info(opts)
-
-
-
-The Abuse Contact API provides essential contact information to report abusive activity associated with IP addresses. By querying an IP address (IPv4 or IPv6), users receive detailed abuse contact data, including the responsible organization, abuse handling role, contact emails, phone numbers, and registered address. This enables users to swiftly take action to report and mitigate threats such as spam, DDoS attacks, and phishing.     In addition to abuse-specific contacts, the API also includes registration metadata like the registered country and abuse handle. This empowers cybersecurity teams, hosting providers, and compliance entities to take appropriate legal or administrative action. 
-
-### 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::AbuseContactApi.new
-opts = {
-  ip: '8.8.8.8', # String | query parameter 'ip'.
-  excludes: 'abuse.handle,abuse.emails', # String | You can exclude specific fields from the API response (except the ip field) by listing them in the excludes parameter as a comma-separated list. For example, you want to remove emails and handle from api response, you can put the keys in excludes parameter like this.
-  fields: 'abuse.role,abuse.emails' # String | You can customize the API response by using the fields parameter to include only the specific data you need. For example, to retrieve only the role and emails, specify these keys in the fields parameter as shown below.
-}
-
-begin
-  
-  result = api_instance.get_abuse_contact_info(opts)
-  p result
-rescue IpgeolocationSdk::ApiError => e
-  puts "Error when calling AbuseContactApi->get_abuse_contact_info: #{e}"
-end
-```
-
-#### Using the get_abuse_contact_info_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<AbuseResponse>, Integer, Hash)> get_abuse_contact_info_with_http_info(opts)
-
-```ruby
-begin
-  
-  data, status_code, headers = api_instance.get_abuse_contact_info_with_http_info(opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <AbuseResponse>
-rescue IpgeolocationSdk::ApiError => e
-  puts "Error when calling AbuseContactApi->get_abuse_contact_info_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **ip** | **String** | query parameter &#39;ip&#39;. | [optional] |
-| **excludes** | **String** | You can exclude specific fields from the API response (except the ip field) by listing them in the excludes parameter as a comma-separated list. For example, you want to remove emails and handle from api response, you can put the keys in excludes parameter like this. | [optional] |
-| **fields** | **String** | You can customize the API response by using the fields parameter to include only the specific data you need. For example, to retrieve only the role and emails, specify these keys in the fields parameter as shown below. | [optional] |
-
-### Return type
-
-[**AbuseResponse**](AbuseResponse.md)
-
-### Authorization
-
-[ApiKeyAuth](../README.md#ApiKeyAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json, application/xml
-

data/docs/AbuseResponse.md

@@ -1,20 +0,0 @@
-# IpgeolocationSdk::AbuseResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **ip** | **String** |  | [optional] |
-| **abuse** | [**Abuse**](Abuse.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'ipgeolocation_sdk'
-
-instance = IpgeolocationSdk::AbuseResponse.new(
-  ip: 8.8.8.8,
-  abuse: null
-)
-```
-

data/docs/AbuseResponseXML.md

@@ -1,20 +0,0 @@
-# IpgeolocationSdk::AbuseResponseXML
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **ip** | **String** |  | [optional] |
-| **abuse** | [**Abuse**](Abuse.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'ipgeolocation_sdk'
-
-instance = IpgeolocationSdk::AbuseResponseXML.new(
-  ip: 8.8.8.8,
-  abuse: null
-)
-```
-

data/docs/Astronomy.md

@@ -1,68 +0,0 @@
-# IpgeolocationSdk::Astronomy
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **time_zone** | **String** |  | [optional] |
-| **date** | **String** |  | [optional] |
-| **current_time** | **String** |  | [optional] |
-| **mid_night** | **String** |  | [optional] |
-| **night_end** | **String** |  | [optional] |
-| **morning** | [**AstronomyMorning**](AstronomyMorning.md) |  | [optional] |
-| **sunrise** | **String** |  | [optional] |
-| **sunset** | **String** |  | [optional] |
-| **evening** | [**AstronomyEvening**](AstronomyEvening.md) |  | [optional] |
-| **night_begin** | **String** |  | [optional] |
-| **sun_status** | **String** |  | [optional] |
-| **solar_noon** | **String** |  | [optional] |
-| **day_length** | **String** |  | [optional] |
-| **sun_altitude** | **Float** |  | [optional] |
-| **sun_distance** | **Float** |  | [optional] |
-| **sun_azimuth** | **Float** |  | [optional] |
-| **moon_phase** | **String** |  | [optional] |
-| **moonrise** | **String** |  | [optional] |
-| **moonset** | **String** |  | [optional] |
-| **moon_status** | **String** |  | [optional] |
-| **moon_altitude** | **Float** |  | [optional] |
-| **moon_distance** | **Float** |  | [optional] |
-| **moon_azimuth** | **Float** |  | [optional] |
-| **moon_parallactic_angle** | **Float** |  | [optional] |
-| **moon_illumination_percentage** | **String** |  | [optional] |
-| **moon_angle** | **Float** |  | [optional] |
-
-## Example
-
-```ruby
-require 'ipgeolocation_sdk'
-
-instance = IpgeolocationSdk::Astronomy.new(
-  time_zone: America/Los_Angeles,
-  date: 2025-07-17,
-  current_time: 08:03:36.532,
-  mid_night: 01:02,
-  night_end: 03:40,
-  morning: null,
-  sunrise: 05:39,
-  sunset: 20:24,
-  evening: null,
-  night_begin: 22:23,
-  sun_status: -,
-  solar_noon: 13:02,
-  day_length: 14:45,
-  sun_altitude: 24.957683470850487,
-  sun_distance: 152059278.3394745,
-  sun_azimuth: 82.93803947255543,
-  moon_phase: LAST_QUARTER,
-  moonrise: -:-,
-  moonset: 13:04,
-  moon_status: -,
-  moon_altitude: 50.865120808868284,
-  moon_distance: 371690.2207058187,
-  moon_azimuth: 224.27457358894264,
-  moon_parallactic_angle: 32.4113797557535,
-  moon_illumination_percentage: -55.99,
-  moon_angle: 263.11859022190265
-)
-```
-

data/docs/AstronomyApi.md

@@ -1,97 +0,0 @@
-# IpgeolocationSdk::AstronomyApi
-
-All URIs are relative to *https://api.ipgeolocation.io/v2*
-
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**get_astronomy_details**](AstronomyApi.md#get_astronomy_details) | **GET** /astronomy |  |
-
-
-## get_astronomy_details
-
-> <AstronomyResponse> get_astronomy_details(opts)
-
-
-
-The Astronomy API provides the location-based rise and set times for the Sun and Moon along with the current position, distance from earth, and azimuth of the Sun and the Moon for a specific date at the queried time. 
-
-### 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::AstronomyApi.new
-opts = {
-  ip: '8.8.8.8', # String | query paramter 'ip'. If not provided, will be your network IP
-  location: 'New York, US', # String | query paramter 'location'. If not provided, will be your ip location
-  lat: '40.76473', # String | query paramter 'lat'.
-  long: '-74.00084', # String | query paramter 'long'.
-  time_zone: 'Europe/London', # String | 
-  date: '2025-04-22', # String | The date (YYYY-MM-DD) to lookup for. default will be the current date
-  elevation: 9, # Float | query parameter 'elevation'
-  output: 'json', # String | Desired output format.
-  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`.
-}
-
-begin
-  
-  result = api_instance.get_astronomy_details(opts)
-  p result
-rescue IpgeolocationSdk::ApiError => e
-  puts "Error when calling AstronomyApi->get_astronomy_details: #{e}"
-end
-```
-
-#### Using the get_astronomy_details_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<AstronomyResponse>, Integer, Hash)> get_astronomy_details_with_http_info(opts)
-
-```ruby
-begin
-  
-  data, status_code, headers = api_instance.get_astronomy_details_with_http_info(opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <AstronomyResponse>
-rescue IpgeolocationSdk::ApiError => e
-  puts "Error when calling AstronomyApi->get_astronomy_details_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **ip** | **String** | query paramter &#39;ip&#39;. If not provided, will be your network IP | [optional] |
-| **location** | **String** | query paramter &#39;location&#39;. If not provided, will be your ip location | [optional] |
-| **lat** | **String** | query paramter &#39;lat&#39;. | [optional] |
-| **long** | **String** | query paramter &#39;long&#39;. | [optional] |
-| **time_zone** | **String** |  | [optional] |
-| **date** | **String** | The date (YYYY-MM-DD) to lookup for. default will be the current date | [optional] |
-| **elevation** | **Float** | query parameter &#39;elevation&#39; | [optional] |
-| **output** | **String** | Desired output format. | [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] |
-
-### Return type
-
-[**AstronomyResponse**](AstronomyResponse.md)
-
-### Authorization
-
-[ApiKeyAuth](../README.md#ApiKeyAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json, application/xml
-

data/docs/AstronomyEvening.md

@@ -1,36 +0,0 @@
-# IpgeolocationSdk::AstronomyEvening
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **golden_hour_begin** | **String** |  | [optional] |
-| **golden_hour_end** | **String** |  | [optional] |
-| **blue_hour_begin** | **String** |  | [optional] |
-| **blue_hour_end** | **String** |  | [optional] |
-| **civil_twilight_begin** | **String** |  | [optional] |
-| **civil_twilight_end** | **String** |  | [optional] |
-| **nautical_twilight_begin** | **String** |  | [optional] |
-| **nautical_twilight_end** | **String** |  | [optional] |
-| **astronomical_twilight_begin** | **String** |  | [optional] |
-| **astronomical_twilight_end** | **String** |  | [optional] |
-
-## Example
-
-```ruby
-require 'ipgeolocation_sdk'
-
-instance = IpgeolocationSdk::AstronomyEvening.new(
-  golden_hour_begin: 19:44,
-  golden_hour_end: 20:44,
-  blue_hour_begin: 20:44,
-  blue_hour_end: 21:09,
-  civil_twilight_begin: 20:24,
-  civil_twilight_end: 20:56,
-  nautical_twilight_begin: 20:56,
-  nautical_twilight_end: 21:37,
-  astronomical_twilight_begin: 21:37,
-  astronomical_twilight_end: 22:23
-)
-```
-

data/docs/AstronomyLocation.md

@@ -1,50 +0,0 @@
-# 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

@@ -1,36 +0,0 @@
-# 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

@@ -1,22 +0,0 @@
-# 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

@@ -1,22 +0,0 @@
-# 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

@@ -1,42 +0,0 @@
-# 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

@@ -1,42 +0,0 @@
-# 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

@@ -1,22 +0,0 @@
-# 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

@@ -1,22 +0,0 @@
-# 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

@@ -1,18 +0,0 @@
-# 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

@@ -1,18 +0,0 @@
-# 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
-)
-```
-