whoisfreaks 0.2.0

data/docs/GeolocationApi.md

@@ -0,0 +1,155 @@
+# WhoisFreaks::GeolocationApi
+
+All URIs are relative to *https://api.whoisfreaks.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**bulk_geolocation**](GeolocationApi.md#bulk_geolocation) | **POST** /v1.0/geolocation | Bulk IP Geolocation |
+| [**geolocation**](GeolocationApi.md#geolocation) | **GET** /v1.0/geolocation | IP Geolocation Lookup |
+
+
+## bulk_geolocation
+
+> <Array<GeolocationResponse>> bulk_geolocation(api_key, bulk_geolocation_request)
+
+Bulk IP Geolocation
+
+Up to 100 IPs.
+
+### Examples
+
+```ruby
+require 'time'
+require 'whoisfreaks'
+# setup authorization
+WhoisFreaks.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 = WhoisFreaks::GeolocationApi.new
+api_key = 'api_key_example' # String | Your WHOISFreaks API key
+bulk_geolocation_request = WhoisFreaks::BulkGeolocationRequest.new({ips: ['ips_example']}) # BulkGeolocationRequest | 
+
+begin
+  # Bulk IP Geolocation
+  result = api_instance.bulk_geolocation(api_key, bulk_geolocation_request)
+  p result
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling GeolocationApi->bulk_geolocation: #{e}"
+end
+```
+
+#### Using the bulk_geolocation_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<GeolocationResponse>>, Integer, Hash)> bulk_geolocation_with_http_info(api_key, bulk_geolocation_request)
+
+```ruby
+begin
+  # Bulk IP Geolocation
+  data, status_code, headers = api_instance.bulk_geolocation_with_http_info(api_key, bulk_geolocation_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<GeolocationResponse>>
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling GeolocationApi->bulk_geolocation_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **api_key** | **String** | Your WHOISFreaks API key |  |
+| **bulk_geolocation_request** | [**BulkGeolocationRequest**](BulkGeolocationRequest.md) |  |  |
+
+### Return type
+
+[**Array&lt;GeolocationResponse&gt;**](GeolocationResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## geolocation
+
+> <GeolocationResponse> geolocation(api_key, ip)
+
+IP Geolocation Lookup
+
+Get location, ASN, currency for an IP. 1 credit.
+
+### Examples
+
+```ruby
+require 'time'
+require 'whoisfreaks'
+# setup authorization
+WhoisFreaks.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 = WhoisFreaks::GeolocationApi.new
+api_key = 'api_key_example' # String | Your WHOISFreaks API key
+ip = 'ip_example' # String | 
+
+begin
+  # IP Geolocation Lookup
+  result = api_instance.geolocation(api_key, ip)
+  p result
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling GeolocationApi->geolocation: #{e}"
+end
+```
+
+#### Using the geolocation_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GeolocationResponse>, Integer, Hash)> geolocation_with_http_info(api_key, ip)
+
+```ruby
+begin
+  # IP Geolocation Lookup
+  data, status_code, headers = api_instance.geolocation_with_http_info(api_key, ip)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GeolocationResponse>
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling GeolocationApi->geolocation_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **api_key** | **String** | Your WHOISFreaks API key |  |
+| **ip** | **String** |  |  |
+
+### Return type
+
+[**GeolocationResponse**](GeolocationResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/GeolocationAsn.md

@@ -0,0 +1,26 @@
+# WhoisFreaks::GeolocationAsn
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **as_number** | **String** |  | [optional] |
+| **organization** | **String** |  | [optional] |
+| **type** | **String** |  | [optional] |
+| **domain** | **String** |  | [optional] |
+| **rir** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'whoisfreaks'
+
+instance = WhoisFreaks::GeolocationAsn.new(
+  as_number: null,
+  organization: null,
+  type: null,
+  domain: null,
+  rir: null
+)
+```
+

data/docs/GeolocationLocation.md

@@ -0,0 +1,38 @@
+# WhoisFreaks::GeolocationLocation
+
+## 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] |
+| **state_prov** | **String** |  | [optional] |
+| **city** | **String** |  | [optional] |
+| **zipcode** | **String** |  | [optional] |
+| **latitude** | **String** |  | [optional] |
+| **longitude** | **String** |  | [optional] |
+| **is_eu** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'whoisfreaks'
+
+instance = WhoisFreaks::GeolocationLocation.new(
+  continent_code: null,
+  continent_name: null,
+  country_code2: null,
+  country_code3: null,
+  country_name: null,
+  state_prov: null,
+  city: null,
+  zipcode: null,
+  latitude: null,
+  longitude: null,
+  is_eu: null
+)
+```
+

data/docs/GeolocationResponse.md

@@ -0,0 +1,24 @@
+# WhoisFreaks::GeolocationResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ip** | **String** |  | [optional] |
+| **location** | [**GeolocationLocation**](GeolocationLocation.md) |  | [optional] |
+| **network** | [**GeolocationResponseNetwork**](GeolocationResponseNetwork.md) |  | [optional] |
+| **currency** | [**GeolocationResponseCurrency**](GeolocationResponseCurrency.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'whoisfreaks'
+
+instance = WhoisFreaks::GeolocationResponse.new(
+  ip: null,
+  location: null,
+  network: null,
+  currency: null
+)
+```
+

data/docs/GeolocationResponseCurrency.md

@@ -0,0 +1,22 @@
+# WhoisFreaks::GeolocationResponseCurrency
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **symbol** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'whoisfreaks'
+
+instance = WhoisFreaks::GeolocationResponseCurrency.new(
+  code: null,
+  name: null,
+  symbol: null
+)
+```
+

data/docs/GeolocationResponseNetwork.md

@@ -0,0 +1,18 @@
+# WhoisFreaks::GeolocationResponseNetwork
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **asn** | [**GeolocationAsn**](GeolocationAsn.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'whoisfreaks'
+
+instance = WhoisFreaks::GeolocationResponseNetwork.new(
+  asn: null
+)
+```
+

data/docs/HistoricalDnsResponse.md

@@ -0,0 +1,24 @@
+# WhoisFreaks::HistoricalDnsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **total_records** | **Integer** |  | [optional] |
+| **total_pages** | **Integer** |  | [optional] |
+| **current_page** | **Integer** |  | [optional] |
+| **historical_dns_records** | [**Array<DnsResponse>**](DnsResponse.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'whoisfreaks'
+
+instance = WhoisFreaks::HistoricalDnsResponse.new(
+  total_records: null,
+  total_pages: null,
+  current_page: null,
+  historical_dns_records: null
+)
+```
+

data/docs/IPReputationApi.md

@@ -0,0 +1,155 @@
+# WhoisFreaks::IPReputationApi
+
+All URIs are relative to *https://api.whoisfreaks.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**bulk_ip_reputation**](IPReputationApi.md#bulk_ip_reputation) | **POST** /v1.0/security | Bulk IP Reputation |
+| [**ip_reputation**](IPReputationApi.md#ip_reputation) | **GET** /v1.0/security | IP Reputation Lookup |
+
+
+## bulk_ip_reputation
+
+> <Array<IpReputationResponse>> bulk_ip_reputation(api_key, bulk_geolocation_request)
+
+Bulk IP Reputation
+
+Up to 100 IPs.
+
+### Examples
+
+```ruby
+require 'time'
+require 'whoisfreaks'
+# setup authorization
+WhoisFreaks.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 = WhoisFreaks::IPReputationApi.new
+api_key = 'api_key_example' # String | Your WHOISFreaks API key
+bulk_geolocation_request = WhoisFreaks::BulkGeolocationRequest.new({ips: ['ips_example']}) # BulkGeolocationRequest | 
+
+begin
+  # Bulk IP Reputation
+  result = api_instance.bulk_ip_reputation(api_key, bulk_geolocation_request)
+  p result
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling IPReputationApi->bulk_ip_reputation: #{e}"
+end
+```
+
+#### Using the bulk_ip_reputation_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<IpReputationResponse>>, Integer, Hash)> bulk_ip_reputation_with_http_info(api_key, bulk_geolocation_request)
+
+```ruby
+begin
+  # Bulk IP Reputation
+  data, status_code, headers = api_instance.bulk_ip_reputation_with_http_info(api_key, bulk_geolocation_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<IpReputationResponse>>
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling IPReputationApi->bulk_ip_reputation_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **api_key** | **String** | Your WHOISFreaks API key |  |
+| **bulk_geolocation_request** | [**BulkGeolocationRequest**](BulkGeolocationRequest.md) |  |  |
+
+### Return type
+
+[**Array&lt;IpReputationResponse&gt;**](IpReputationResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## ip_reputation
+
+> <IpReputationResponse> ip_reputation(api_key, ip)
+
+IP Reputation Lookup
+
+Threat intel for IP — VPN, proxy, Tor, bots. 1 credit.
+
+### Examples
+
+```ruby
+require 'time'
+require 'whoisfreaks'
+# setup authorization
+WhoisFreaks.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 = WhoisFreaks::IPReputationApi.new
+api_key = 'api_key_example' # String | Your WHOISFreaks API key
+ip = 'ip_example' # String | 
+
+begin
+  # IP Reputation Lookup
+  result = api_instance.ip_reputation(api_key, ip)
+  p result
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling IPReputationApi->ip_reputation: #{e}"
+end
+```
+
+#### Using the ip_reputation_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<IpReputationResponse>, Integer, Hash)> ip_reputation_with_http_info(api_key, ip)
+
+```ruby
+begin
+  # IP Reputation Lookup
+  data, status_code, headers = api_instance.ip_reputation_with_http_info(api_key, ip)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <IpReputationResponse>
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling IPReputationApi->ip_reputation_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **api_key** | **String** | Your WHOISFreaks API key |  |
+| **ip** | **String** |  |  |
+
+### Return type
+
+[**IpReputationResponse**](IpReputationResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/IPWHOISApi.md

@@ -0,0 +1,85 @@
+# WhoisFreaks::IPWHOISApi
+
+All URIs are relative to *https://api.whoisfreaks.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**ip_whois**](IPWHOISApi.md#ip_whois) | **GET** /v1.0/ip-whois | IP WHOIS Lookup |
+
+
+## ip_whois
+
+> <IpWhoisResponse> ip_whois(api_key, ip, opts)
+
+IP WHOIS Lookup
+
+WHOIS for an IP address. 1 credit.
+
+### Examples
+
+```ruby
+require 'time'
+require 'whoisfreaks'
+# setup authorization
+WhoisFreaks.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 = WhoisFreaks::IPWHOISApi.new
+api_key = 'api_key_example' # String | Your WHOISFreaks API key
+ip = 'ip_example' # String | 
+opts = {
+  format: 'json' # String | 
+}
+
+begin
+  # IP WHOIS Lookup
+  result = api_instance.ip_whois(api_key, ip, opts)
+  p result
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling IPWHOISApi->ip_whois: #{e}"
+end
+```
+
+#### Using the ip_whois_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<IpWhoisResponse>, Integer, Hash)> ip_whois_with_http_info(api_key, ip, opts)
+
+```ruby
+begin
+  # IP WHOIS Lookup
+  data, status_code, headers = api_instance.ip_whois_with_http_info(api_key, ip, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <IpWhoisResponse>
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling IPWHOISApi->ip_whois_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **api_key** | **String** | Your WHOISFreaks API key |  |
+| **ip** | **String** |  |  |
+| **format** | **String** |  | [optional][default to &#39;json&#39;] |
+
+### Return type
+
+[**IpWhoisResponse**](IpWhoisResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/IpReputationResponse.md

@@ -0,0 +1,24 @@
+# WhoisFreaks::IpReputationResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ip** | **String** |  | [optional] |
+| **location** | [**GeolocationLocation**](GeolocationLocation.md) |  | [optional] |
+| **asn** | [**GeolocationAsn**](GeolocationAsn.md) |  | [optional] |
+| **security** | [**IpReputationSecurity**](IpReputationSecurity.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'whoisfreaks'
+
+instance = WhoisFreaks::IpReputationResponse.new(
+  ip: null,
+  location: null,
+  asn: null,
+  security: null
+)
+```
+

data/docs/IpReputationSecurity.md

@@ -0,0 +1,42 @@
+# WhoisFreaks::IpReputationSecurity
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **threat_score** | **Integer** |  | [optional] |
+| **is_tor** | **Boolean** |  | [optional] |
+| **is_proxy** | **Boolean** |  | [optional] |
+| **proxy_confidence_score** | **Integer** |  | [optional] |
+| **is_residential_proxy** | **Boolean** |  | [optional] |
+| **is_vpn** | **Boolean** |  | [optional] |
+| **vpn_confidence_score** | **Integer** |  | [optional] |
+| **is_anonymous** | **Boolean** |  | [optional] |
+| **is_known_attacker** | **Boolean** |  | [optional] |
+| **is_bot** | **Boolean** |  | [optional] |
+| **is_spam** | **Boolean** |  | [optional] |
+| **is_cloud_provider** | **Boolean** |  | [optional] |
+| **cloud_provider_name** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'whoisfreaks'
+
+instance = WhoisFreaks::IpReputationSecurity.new(
+  threat_score: null,
+  is_tor: null,
+  is_proxy: null,
+  proxy_confidence_score: null,
+  is_residential_proxy: null,
+  is_vpn: null,
+  vpn_confidence_score: null,
+  is_anonymous: null,
+  is_known_attacker: null,
+  is_bot: null,
+  is_spam: null,
+  is_cloud_provider: null,
+  cloud_provider_name: null
+)
+```
+

data/docs/IpWhoisResponse.md

@@ -0,0 +1,30 @@
+# WhoisFreaks::IpWhoisResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **Boolean** |  | [optional] |
+| **ip_address** | **String** |  | [optional] |
+| **query_time** | **String** |  | [optional] |
+| **whois_server** | **String** |  | [optional] |
+| **inet_nums** | [**Array<IpWhoisResponseInetNumsInner>**](IpWhoisResponseInetNumsInner.md) |  | [optional] |
+| **organization** | [**IpWhoisResponseOrganization**](IpWhoisResponseOrganization.md) |  | [optional] |
+| **abuse_contacts** | [**Array<IpWhoisResponseAbuseContactsInner>**](IpWhoisResponseAbuseContactsInner.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'whoisfreaks'
+
+instance = WhoisFreaks::IpWhoisResponse.new(
+  status: null,
+  ip_address: null,
+  query_time: null,
+  whois_server: null,
+  inet_nums: null,
+  organization: null,
+  abuse_contacts: null
+)
+```
+

data/docs/IpWhoisResponseAbuseContactsInner.md

@@ -0,0 +1,22 @@
+# WhoisFreaks::IpWhoisResponseAbuseContactsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **handle** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **email** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'whoisfreaks'
+
+instance = WhoisFreaks::IpWhoisResponseAbuseContactsInner.new(
+  handle: null,
+  name: null,
+  email: null
+)
+```
+

data/docs/IpWhoisResponseInetNumsInner.md

@@ -0,0 +1,28 @@
+# WhoisFreaks::IpWhoisResponseInetNumsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **start_ip** | **String** |  | [optional] |
+| **end_ip** | **String** |  | [optional] |
+| **cidr** | **Array<String>** |  | [optional] |
+| **net_name** | **String** |  | [optional] |
+| **organization** | **String** |  | [optional] |
+| **status** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'whoisfreaks'
+
+instance = WhoisFreaks::IpWhoisResponseInetNumsInner.new(
+  start_ip: null,
+  end_ip: null,
+  cidr: null,
+  net_name: null,
+  organization: null,
+  status: null
+)
+```
+