whoisfreaks 0.2.0

data/docs/DatabasesNewlyRegisteredApi.md

@@ -0,0 +1,551 @@
+# WhoisFreaks::DatabasesNewlyRegisteredApi
+
+All URIs are relative to *https://api.whoisfreaks.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**db_newly_cctld**](DatabasesNewlyRegisteredApi.md#db_newly_cctld) | **GET** /v3.1/download/domainer/cctld | Newly Registered ccTLD (CSV) |
+| [**db_newly_cctld_cleaned**](DatabasesNewlyRegisteredApi.md#db_newly_cctld_cleaned) | **GET** /v3.1/download/domainer/cctld/cleaned | Newly Registered ccTLD Cleaned WHOIS (CSV) |
+| [**db_newly_cctld_json**](DatabasesNewlyRegisteredApi.md#db_newly_cctld_json) | **GET** /v3.1/domains/newly/cctld | Newly Registered ccTLD (JSON) |
+| [**db_newly_dns**](DatabasesNewlyRegisteredApi.md#db_newly_dns) | **GET** /v3.1/download/domainer/newly/dns | Newly Registered With DNS |
+| [**db_newly_gtld**](DatabasesNewlyRegisteredApi.md#db_newly_gtld) | **GET** /v3.1/download/domainer/gtld | Newly Registered gTLD (CSV) |
+| [**db_newly_gtld_cleaned**](DatabasesNewlyRegisteredApi.md#db_newly_gtld_cleaned) | **GET** /v3.1/download/domainer/gtld/cleaned | Newly Registered gTLD Cleaned WHOIS (CSV) |
+| [**db_newly_gtld_json**](DatabasesNewlyRegisteredApi.md#db_newly_gtld_json) | **GET** /v3.1/domains/newly/gtld | Newly Registered gTLD (JSON) |
+
+
+## db_newly_cctld
+
+> String db_newly_cctld(api_key, whois, opts)
+
+Newly Registered ccTLD (CSV)
+
+Newly Registered ccTLD (CSV). 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::DatabasesNewlyRegisteredApi.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
+  tlds: 'tlds_example' # String | 
+}
+
+begin
+  # Newly Registered ccTLD (CSV)
+  result = api_instance.db_newly_cctld(api_key, whois, opts)
+  p result
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DatabasesNewlyRegisteredApi->db_newly_cctld: #{e}"
+end
+```
+
+#### Using the db_newly_cctld_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> db_newly_cctld_with_http_info(api_key, whois, opts)
+
+```ruby
+begin
+  # Newly Registered ccTLD (CSV)
+  data, status_code, headers = api_instance.db_newly_cctld_with_http_info(api_key, whois, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DatabasesNewlyRegisteredApi->db_newly_cctld_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] |
+| **tlds** | **String** |  | [optional] |
+
+### Return type
+
+**String**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/csv, application/json
+
+
+## db_newly_cctld_cleaned
+
+> String db_newly_cctld_cleaned(api_key, opts)
+
+Newly Registered ccTLD Cleaned WHOIS (CSV)
+
+Newly Registered ccTLD Cleaned WHOIS (CSV). 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::DatabasesNewlyRegisteredApi.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
+  # Newly Registered ccTLD Cleaned WHOIS (CSV)
+  result = api_instance.db_newly_cctld_cleaned(api_key, opts)
+  p result
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DatabasesNewlyRegisteredApi->db_newly_cctld_cleaned: #{e}"
+end
+```
+
+#### Using the db_newly_cctld_cleaned_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> db_newly_cctld_cleaned_with_http_info(api_key, opts)
+
+```ruby
+begin
+  # Newly Registered ccTLD Cleaned WHOIS (CSV)
+  data, status_code, headers = api_instance.db_newly_cctld_cleaned_with_http_info(api_key, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DatabasesNewlyRegisteredApi->db_newly_cctld_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
+
+
+## db_newly_cctld_json
+
+> Array&lt;String&gt; db_newly_cctld_json(api_key, opts)
+
+Newly Registered ccTLD (JSON)
+
+Newly Registered ccTLD (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::DatabasesNewlyRegisteredApi.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
+  # Newly Registered ccTLD (JSON)
+  result = api_instance.db_newly_cctld_json(api_key, opts)
+  p result
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DatabasesNewlyRegisteredApi->db_newly_cctld_json: #{e}"
+end
+```
+
+#### Using the db_newly_cctld_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_newly_cctld_json_with_http_info(api_key, opts)
+
+```ruby
+begin
+  # Newly Registered ccTLD (JSON)
+  data, status_code, headers = api_instance.db_newly_cctld_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 DatabasesNewlyRegisteredApi->db_newly_cctld_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_newly_dns
+
+> Array&lt;Object&gt; db_newly_dns(api_key, opts)
+
+Newly Registered With DNS
+
+Newly Registered With DNS. 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::DatabasesNewlyRegisteredApi.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
+  # Newly Registered With DNS
+  result = api_instance.db_newly_dns(api_key, opts)
+  p result
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DatabasesNewlyRegisteredApi->db_newly_dns: #{e}"
+end
+```
+
+#### Using the db_newly_dns_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Array&lt;Object&gt;, Integer, Hash)> db_newly_dns_with_http_info(api_key, opts)
+
+```ruby
+begin
+  # Newly Registered With DNS
+  data, status_code, headers = api_instance.db_newly_dns_with_http_info(api_key, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Array&lt;Object&gt;
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DatabasesNewlyRegisteredApi->db_newly_dns_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
+
+**Array&lt;Object&gt;**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## db_newly_gtld
+
+> String db_newly_gtld(api_key, whois, opts)
+
+Newly Registered gTLD (CSV)
+
+Newly Registered gTLD (CSV). 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::DatabasesNewlyRegisteredApi.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
+  tlds: 'tlds_example' # String | 
+}
+
+begin
+  # Newly Registered gTLD (CSV)
+  result = api_instance.db_newly_gtld(api_key, whois, opts)
+  p result
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DatabasesNewlyRegisteredApi->db_newly_gtld: #{e}"
+end
+```
+
+#### Using the db_newly_gtld_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> db_newly_gtld_with_http_info(api_key, whois, opts)
+
+```ruby
+begin
+  # Newly Registered gTLD (CSV)
+  data, status_code, headers = api_instance.db_newly_gtld_with_http_info(api_key, whois, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DatabasesNewlyRegisteredApi->db_newly_gtld_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] |
+| **tlds** | **String** |  | [optional] |
+
+### Return type
+
+**String**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/csv, application/json
+
+
+## db_newly_gtld_cleaned
+
+> String db_newly_gtld_cleaned(api_key, opts)
+
+Newly Registered gTLD Cleaned WHOIS (CSV)
+
+Newly Registered gTLD Cleaned WHOIS (CSV). 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::DatabasesNewlyRegisteredApi.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
+  # Newly Registered gTLD Cleaned WHOIS (CSV)
+  result = api_instance.db_newly_gtld_cleaned(api_key, opts)
+  p result
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DatabasesNewlyRegisteredApi->db_newly_gtld_cleaned: #{e}"
+end
+```
+
+#### Using the db_newly_gtld_cleaned_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> db_newly_gtld_cleaned_with_http_info(api_key, opts)
+
+```ruby
+begin
+  # Newly Registered gTLD Cleaned WHOIS (CSV)
+  data, status_code, headers = api_instance.db_newly_gtld_cleaned_with_http_info(api_key, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DatabasesNewlyRegisteredApi->db_newly_gtld_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
+
+
+## db_newly_gtld_json
+
+> Array&lt;String&gt; db_newly_gtld_json(api_key, opts)
+
+Newly Registered gTLD (JSON)
+
+Newly Registered gTLD (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::DatabasesNewlyRegisteredApi.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
+  # Newly Registered gTLD (JSON)
+  result = api_instance.db_newly_gtld_json(api_key, opts)
+  p result
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DatabasesNewlyRegisteredApi->db_newly_gtld_json: #{e}"
+end
+```
+
+#### Using the db_newly_gtld_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_newly_gtld_json_with_http_info(api_key, opts)
+
+```ruby
+begin
+  # Newly Registered gTLD (JSON)
+  data, status_code, headers = api_instance.db_newly_gtld_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 DatabasesNewlyRegisteredApi->db_newly_gtld_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
+