whoisfreaks 0.2.0

data/docs/DatabasesExpiringDroppedApi.md

@@ -0,0 +1,395 @@
+# WhoisFreaks::DatabasesExpiringDroppedApi
+
+All URIs are relative to *https://api.whoisfreaks.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**db_dropped**](DatabasesExpiringDroppedApi.md#db_dropped) | **GET** /v3.1/download/domainer/dropped | Dropped Domains |
+| [**db_dropped_backlinks**](DatabasesExpiringDroppedApi.md#db_dropped_backlinks) | **GET** /v3.3/download/domainer/dropped/backlinks | Dropped With Backlinks |
+| [**db_dropped_json**](DatabasesExpiringDroppedApi.md#db_dropped_json) | **GET** /v3.1/domains/dropped | Dropped Domains (JSON) |
+| [**db_expired**](DatabasesExpiringDroppedApi.md#db_expired) | **GET** /v3.1/download/domainer/expired | Expiring Domains |
+| [**db_expired_cleaned**](DatabasesExpiringDroppedApi.md#db_expired_cleaned) | **GET** /v3.1/download/domainer/expired/cleaned | Expiring Cleaned WHOIS |
+
+
+## db_dropped
+
+> String db_dropped(api_key, whois, opts)
+
+Dropped Domains
+
+Dropped Domains. Returns the file/snapshot described by this operation.
+
+### 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::DatabasesExpiringDroppedApi.new
+api_key = 'api_key_example' # String | Your WHOISFreaks API key
+whois = true # Boolean | 
+opts = {
+  date: Date.parse('2013-10-20') # Date | yyyy-MM-dd; omit for latest
+}
+
+begin
+  # Dropped Domains
+  result = api_instance.db_dropped(api_key, whois, opts)
+  p result
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DatabasesExpiringDroppedApi->db_dropped: #{e}"
+end
+```
+
+#### Using the db_dropped_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> db_dropped_with_http_info(api_key, whois, opts)
+
+```ruby
+begin
+  # Dropped Domains
+  data, status_code, headers = api_instance.db_dropped_with_http_info(api_key, whois, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DatabasesExpiringDroppedApi->db_dropped_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **api_key** | **String** | Your WHOISFreaks API key |  |
+| **whois** | **Boolean** |  |  |
+| **date** | **Date** | yyyy-MM-dd; omit for latest | [optional] |
+
+### Return type
+
+**String**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/csv, application/json
+
+
+## db_dropped_backlinks
+
+> String db_dropped_backlinks(api_key, opts)
+
+Dropped With Backlinks
+
+Dropped With Backlinks. Returns the file/snapshot described by this operation.
+
+### 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::DatabasesExpiringDroppedApi.new
+api_key = 'api_key_example' # String | Your WHOISFreaks API key
+opts = {
+  whois: true, # Boolean | 
+  date: Date.parse('2013-10-20') # Date | yyyy-MM-dd; omit for latest
+}
+
+begin
+  # Dropped With Backlinks
+  result = api_instance.db_dropped_backlinks(api_key, opts)
+  p result
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DatabasesExpiringDroppedApi->db_dropped_backlinks: #{e}"
+end
+```
+
+#### Using the db_dropped_backlinks_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> db_dropped_backlinks_with_http_info(api_key, opts)
+
+```ruby
+begin
+  # Dropped With Backlinks
+  data, status_code, headers = api_instance.db_dropped_backlinks_with_http_info(api_key, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DatabasesExpiringDroppedApi->db_dropped_backlinks_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **api_key** | **String** | Your WHOISFreaks API key |  |
+| **whois** | **Boolean** |  | [optional] |
+| **date** | **Date** | yyyy-MM-dd; omit for latest | [optional] |
+
+### Return type
+
+**String**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/csv, application/json
+
+
+## db_dropped_json
+
+> Array&lt;String&gt; db_dropped_json(api_key, opts)
+
+Dropped Domains (JSON)
+
+Dropped Domains (JSON). Returns the file/snapshot described by this operation.
+
+### 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::DatabasesExpiringDroppedApi.new
+api_key = 'api_key_example' # String | Your WHOISFreaks API key
+opts = {
+  date: Date.parse('2013-10-20'), # Date | yyyy-MM-dd; omit for latest
+  tlds: 'tlds_example' # String | 
+}
+
+begin
+  # Dropped Domains (JSON)
+  result = api_instance.db_dropped_json(api_key, opts)
+  p result
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DatabasesExpiringDroppedApi->db_dropped_json: #{e}"
+end
+```
+
+#### Using the db_dropped_json_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Array&lt;String&gt;, Integer, Hash)> db_dropped_json_with_http_info(api_key, opts)
+
+```ruby
+begin
+  # Dropped Domains (JSON)
+  data, status_code, headers = api_instance.db_dropped_json_with_http_info(api_key, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Array&lt;String&gt;
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DatabasesExpiringDroppedApi->db_dropped_json_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **api_key** | **String** | Your WHOISFreaks API key |  |
+| **date** | **Date** | yyyy-MM-dd; omit for latest | [optional] |
+| **tlds** | **String** |  | [optional] |
+
+### Return type
+
+**Array&lt;String&gt;**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## db_expired
+
+> String db_expired(api_key, whois, opts)
+
+Expiring Domains
+
+Expiring Domains. Returns the file/snapshot described by this operation.
+
+### 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::DatabasesExpiringDroppedApi.new
+api_key = 'api_key_example' # String | Your WHOISFreaks API key
+whois = true # Boolean | 
+opts = {
+  date: Date.parse('2013-10-20') # Date | yyyy-MM-dd; omit for latest
+}
+
+begin
+  # Expiring Domains
+  result = api_instance.db_expired(api_key, whois, opts)
+  p result
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DatabasesExpiringDroppedApi->db_expired: #{e}"
+end
+```
+
+#### Using the db_expired_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> db_expired_with_http_info(api_key, whois, opts)
+
+```ruby
+begin
+  # Expiring Domains
+  data, status_code, headers = api_instance.db_expired_with_http_info(api_key, whois, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DatabasesExpiringDroppedApi->db_expired_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **api_key** | **String** | Your WHOISFreaks API key |  |
+| **whois** | **Boolean** |  |  |
+| **date** | **Date** | yyyy-MM-dd; omit for latest | [optional] |
+
+### Return type
+
+**String**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/csv, application/json
+
+
+## db_expired_cleaned
+
+> String db_expired_cleaned(api_key, opts)
+
+Expiring Cleaned WHOIS
+
+Expiring Cleaned WHOIS. Returns the file/snapshot described by this operation.
+
+### 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::DatabasesExpiringDroppedApi.new
+api_key = 'api_key_example' # String | Your WHOISFreaks API key
+opts = {
+  date: Date.parse('2013-10-20') # Date | yyyy-MM-dd; omit for latest
+}
+
+begin
+  # Expiring Cleaned WHOIS
+  result = api_instance.db_expired_cleaned(api_key, opts)
+  p result
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DatabasesExpiringDroppedApi->db_expired_cleaned: #{e}"
+end
+```
+
+#### Using the db_expired_cleaned_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> db_expired_cleaned_with_http_info(api_key, opts)
+
+```ruby
+begin
+  # Expiring Cleaned WHOIS
+  data, status_code, headers = api_instance.db_expired_cleaned_with_http_info(api_key, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DatabasesExpiringDroppedApi->db_expired_cleaned_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **api_key** | **String** | Your WHOISFreaks API key |  |
+| **date** | **Date** | yyyy-MM-dd; omit for latest | [optional] |
+
+### Return type
+
+**String**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/csv, application/json
+

data/docs/DatabasesIPGeolocationApi.md

@@ -0,0 +1,299 @@
+# WhoisFreaks::DatabasesIPGeolocationApi
+
+All URIs are relative to *https://api.whoisfreaks.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**db_ip_city**](DatabasesIPGeolocationApi.md#db_ip_city) | **GET** /v3.3/download/snapshot/ip/city | IP to City Snapshot |
+| [**db_ip_city_status**](DatabasesIPGeolocationApi.md#db_ip_city_status) | **GET** /v3.3/status/snapshot/ip/city | IP to City Snapshot Status |
+| [**db_ip_country**](DatabasesIPGeolocationApi.md#db_ip_country) | **GET** /v3.3/download/snapshot/ip/country | IP to Country Snapshot |
+| [**db_ip_country_status**](DatabasesIPGeolocationApi.md#db_ip_country_status) | **GET** /v3.3/status/snapshot/ip/country | IP to Country Snapshot Status |
+
+
+## db_ip_city
+
+> File db_ip_city(api_key, date)
+
+IP to City Snapshot
+
+IP to City Snapshot. Returns the file/snapshot described by this operation.
+
+### 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::DatabasesIPGeolocationApi.new
+api_key = 'api_key_example' # String | Your WHOISFreaks API key
+date = Date.parse('2013-10-20') # Date | 
+
+begin
+  # IP to City Snapshot
+  result = api_instance.db_ip_city(api_key, date)
+  p result
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DatabasesIPGeolocationApi->db_ip_city: #{e}"
+end
+```
+
+#### Using the db_ip_city_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(File, Integer, Hash)> db_ip_city_with_http_info(api_key, date)
+
+```ruby
+begin
+  # IP to City Snapshot
+  data, status_code, headers = api_instance.db_ip_city_with_http_info(api_key, date)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => File
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DatabasesIPGeolocationApi->db_ip_city_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **api_key** | **String** | Your WHOISFreaks API key |  |
+| **date** | **Date** |  |  |
+
+### Return type
+
+**File**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/zip, application/json
+
+
+## db_ip_city_status
+
+> <SnapshotStatus> db_ip_city_status(api_key)
+
+IP to City Snapshot Status
+
+IP to City Snapshot Status. Returns the file/snapshot described by this operation.
+
+### 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::DatabasesIPGeolocationApi.new
+api_key = 'api_key_example' # String | Your WHOISFreaks API key
+
+begin
+  # IP to City Snapshot Status
+  result = api_instance.db_ip_city_status(api_key)
+  p result
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DatabasesIPGeolocationApi->db_ip_city_status: #{e}"
+end
+```
+
+#### Using the db_ip_city_status_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SnapshotStatus>, Integer, Hash)> db_ip_city_status_with_http_info(api_key)
+
+```ruby
+begin
+  # IP to City Snapshot Status
+  data, status_code, headers = api_instance.db_ip_city_status_with_http_info(api_key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SnapshotStatus>
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DatabasesIPGeolocationApi->db_ip_city_status_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **api_key** | **String** | Your WHOISFreaks API key |  |
+
+### Return type
+
+[**SnapshotStatus**](SnapshotStatus.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## db_ip_country
+
+> File db_ip_country(api_key, date)
+
+IP to Country Snapshot
+
+IP to Country Snapshot. Returns the file/snapshot described by this operation.
+
+### 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::DatabasesIPGeolocationApi.new
+api_key = 'api_key_example' # String | Your WHOISFreaks API key
+date = Date.parse('2013-10-20') # Date | 
+
+begin
+  # IP to Country Snapshot
+  result = api_instance.db_ip_country(api_key, date)
+  p result
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DatabasesIPGeolocationApi->db_ip_country: #{e}"
+end
+```
+
+#### Using the db_ip_country_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(File, Integer, Hash)> db_ip_country_with_http_info(api_key, date)
+
+```ruby
+begin
+  # IP to Country Snapshot
+  data, status_code, headers = api_instance.db_ip_country_with_http_info(api_key, date)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => File
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DatabasesIPGeolocationApi->db_ip_country_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **api_key** | **String** | Your WHOISFreaks API key |  |
+| **date** | **Date** |  |  |
+
+### Return type
+
+**File**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/zip, application/json
+
+
+## db_ip_country_status
+
+> <SnapshotStatus> db_ip_country_status(api_key)
+
+IP to Country Snapshot Status
+
+IP to Country Snapshot Status. Returns the file/snapshot described by this operation.
+
+### 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::DatabasesIPGeolocationApi.new
+api_key = 'api_key_example' # String | Your WHOISFreaks API key
+
+begin
+  # IP to Country Snapshot Status
+  result = api_instance.db_ip_country_status(api_key)
+  p result
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DatabasesIPGeolocationApi->db_ip_country_status: #{e}"
+end
+```
+
+#### Using the db_ip_country_status_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SnapshotStatus>, Integer, Hash)> db_ip_country_status_with_http_info(api_key)
+
+```ruby
+begin
+  # IP to Country Snapshot Status
+  data, status_code, headers = api_instance.db_ip_country_status_with_http_info(api_key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SnapshotStatus>
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DatabasesIPGeolocationApi->db_ip_country_status_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **api_key** | **String** | Your WHOISFreaks API key |  |
+
+### Return type
+
+[**SnapshotStatus**](SnapshotStatus.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+