whoisfreaks 0.2.0

data/docs/DatabasesSubdomainsApi.md

@@ -0,0 +1,235 @@
+# WhoisFreaks::DatabasesSubdomainsApi
+
+All URIs are relative to *https://api.whoisfreaks.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**db_subdomains_daily**](DatabasesSubdomainsApi.md#db_subdomains_daily) | **GET** /v3.2/download/dbupdate/daily/subdomains | Subdomains Daily |
+| [**db_subdomains_monthly**](DatabasesSubdomainsApi.md#db_subdomains_monthly) | **GET** /v3.2/download/dbupdate/monthly/subdomains | Subdomains Monthly |
+| [**db_subdomains_weekly**](DatabasesSubdomainsApi.md#db_subdomains_weekly) | **GET** /v3.2/download/dbupdate/weekly/subdomains | Subdomains Weekly |
+
+
+## db_subdomains_daily
+
+> String db_subdomains_daily(api_key, opts)
+
+Subdomains Daily
+
+Subdomains Daily. 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::DatabasesSubdomainsApi.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
+  # Subdomains Daily
+  result = api_instance.db_subdomains_daily(api_key, opts)
+  p result
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DatabasesSubdomainsApi->db_subdomains_daily: #{e}"
+end
+```
+
+#### Using the db_subdomains_daily_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> db_subdomains_daily_with_http_info(api_key, opts)
+
+```ruby
+begin
+  # Subdomains Daily
+  data, status_code, headers = api_instance.db_subdomains_daily_with_http_info(api_key, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DatabasesSubdomainsApi->db_subdomains_daily_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
+
+
+## db_subdomains_monthly
+
+> String db_subdomains_monthly(api_key, opts)
+
+Subdomains Monthly
+
+Subdomains Monthly. 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::DatabasesSubdomainsApi.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
+  # Subdomains Monthly
+  result = api_instance.db_subdomains_monthly(api_key, opts)
+  p result
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DatabasesSubdomainsApi->db_subdomains_monthly: #{e}"
+end
+```
+
+#### Using the db_subdomains_monthly_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> db_subdomains_monthly_with_http_info(api_key, opts)
+
+```ruby
+begin
+  # Subdomains Monthly
+  data, status_code, headers = api_instance.db_subdomains_monthly_with_http_info(api_key, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DatabasesSubdomainsApi->db_subdomains_monthly_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
+
+
+## db_subdomains_weekly
+
+> String db_subdomains_weekly(api_key, opts)
+
+Subdomains Weekly
+
+Subdomains Weekly. 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::DatabasesSubdomainsApi.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
+  # Subdomains Weekly
+  result = api_instance.db_subdomains_weekly(api_key, opts)
+  p result
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DatabasesSubdomainsApi->db_subdomains_weekly: #{e}"
+end
+```
+
+#### Using the db_subdomains_weekly_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> db_subdomains_weekly_with_http_info(api_key, opts)
+
+```ruby
+begin
+  # Subdomains Weekly
+  data, status_code, headers = api_instance.db_subdomains_weekly_with_http_info(api_key, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DatabasesSubdomainsApi->db_subdomains_weekly_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/DatabasesWHOISApi.md

@@ -0,0 +1,235 @@
+# WhoisFreaks::DatabasesWHOISApi
+
+All URIs are relative to *https://api.whoisfreaks.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**db_whois_daily**](DatabasesWHOISApi.md#db_whois_daily) | **GET** /v3.3/download/dbupdate/daily/domains/whois | WHOIS Database Daily |
+| [**db_whois_monthly**](DatabasesWHOISApi.md#db_whois_monthly) | **GET** /v3.3/download/dbupdate/monthly/domains/whois | WHOIS Database Monthly |
+| [**db_whois_weekly**](DatabasesWHOISApi.md#db_whois_weekly) | **GET** /v3.3/download/dbupdate/weekly/domains/whois | WHOIS Database Weekly |
+
+
+## db_whois_daily
+
+> String db_whois_daily(api_key, opts)
+
+WHOIS Database Daily
+
+WHOIS Database Daily. 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::DatabasesWHOISApi.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
+  # WHOIS Database Daily
+  result = api_instance.db_whois_daily(api_key, opts)
+  p result
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DatabasesWHOISApi->db_whois_daily: #{e}"
+end
+```
+
+#### Using the db_whois_daily_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> db_whois_daily_with_http_info(api_key, opts)
+
+```ruby
+begin
+  # WHOIS Database Daily
+  data, status_code, headers = api_instance.db_whois_daily_with_http_info(api_key, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DatabasesWHOISApi->db_whois_daily_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
+
+
+## db_whois_monthly
+
+> String db_whois_monthly(api_key, opts)
+
+WHOIS Database Monthly
+
+WHOIS Database Monthly. 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::DatabasesWHOISApi.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
+  # WHOIS Database Monthly
+  result = api_instance.db_whois_monthly(api_key, opts)
+  p result
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DatabasesWHOISApi->db_whois_monthly: #{e}"
+end
+```
+
+#### Using the db_whois_monthly_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> db_whois_monthly_with_http_info(api_key, opts)
+
+```ruby
+begin
+  # WHOIS Database Monthly
+  data, status_code, headers = api_instance.db_whois_monthly_with_http_info(api_key, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DatabasesWHOISApi->db_whois_monthly_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
+
+
+## db_whois_weekly
+
+> String db_whois_weekly(api_key, opts)
+
+WHOIS Database Weekly
+
+WHOIS Database Weekly. 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::DatabasesWHOISApi.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
+  # WHOIS Database Weekly
+  result = api_instance.db_whois_weekly(api_key, opts)
+  p result
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DatabasesWHOISApi->db_whois_weekly: #{e}"
+end
+```
+
+#### Using the db_whois_weekly_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> db_whois_weekly_with_http_info(api_key, opts)
+
+```ruby
+begin
+  # WHOIS Database Weekly
+  data, status_code, headers = api_instance.db_whois_weekly_with_http_info(api_key, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DatabasesWHOISApi->db_whois_weekly_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/DnsBulk200Response.md

@@ -0,0 +1,18 @@
+# WhoisFreaks::DnsBulk200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **bulk_dns_info** | [**Array<DnsResponse>**](DnsResponse.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'whoisfreaks'
+
+instance = WhoisFreaks::DnsBulk200Response.new(
+  bulk_dns_info: null
+)
+```
+

data/docs/DnsBulkRequest.md

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

data/docs/DnsRecord.md

@@ -0,0 +1,34 @@
+# WhoisFreaks::DnsRecord
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **type** | **Integer** |  | [optional] |
+| **dns_type** | **String** |  | [optional] |
+| **ttl** | **Integer** |  | [optional] |
+| **raw_text** | **String** |  | [optional] |
+| **address** | **String** |  | [optional] |
+| **target** | **String** |  | [optional] |
+| **priority** | **Integer** |  | [optional] |
+| **single_name** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'whoisfreaks'
+
+instance = WhoisFreaks::DnsRecord.new(
+  name: null,
+  type: null,
+  dns_type: null,
+  ttl: null,
+  raw_text: null,
+  address: null,
+  target: null,
+  priority: null,
+  single_name: null
+)
+```
+

data/docs/DnsResponse.md

@@ -0,0 +1,26 @@
+# WhoisFreaks::DnsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **query_time** | **String** |  | [optional] |
+| **domain_name** | **String** |  | [optional] |
+| **ip_address** | **String** |  | [optional] |
+| **dns_types** | **Hash<String, Integer>** |  | [optional] |
+| **dns_records** | [**Array<DnsRecord>**](DnsRecord.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'whoisfreaks'
+
+instance = WhoisFreaks::DnsResponse.new(
+  query_time: null,
+  domain_name: null,
+  ip_address: null,
+  dns_types: null,
+  dns_records: null
+)
+```
+