whoisfreaks 0.2.0

data/docs/AsnWhoisResponseAutNumsInner.md

@@ -0,0 +1,26 @@
+# WhoisFreaks::AsnWhoisResponseAutNumsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **aut_num** | **String** |  | [optional] |
+| **as_name** | **String** |  | [optional] |
+| **description** | **Array<String>** |  | [optional] |
+| **status** | **String** |  | [optional] |
+| **date_created** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'whoisfreaks'
+
+instance = WhoisFreaks::AsnWhoisResponseAutNumsInner.new(
+  aut_num: null,
+  as_name: null,
+  description: null,
+  status: null,
+  date_created: null
+)
+```
+

data/docs/AsnWhoisResponseOrganization.md

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

data/docs/BulkDomainAvailabilityRequest.md

@@ -0,0 +1,20 @@
+# WhoisFreaks::BulkDomainAvailabilityRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **domain_names** | **Array<String>** | Mode 1 — list of full domain names. Cannot be used with tld. | [optional] |
+| **tld** | **Array<String>** | Mode 2 — TLDs to check against the domain query param. Cannot be used with domainNames. | [optional] |
+
+## Example
+
+```ruby
+require 'whoisfreaks'
+
+instance = WhoisFreaks::BulkDomainAvailabilityRequest.new(
+  domain_names: null,
+  tld: null
+)
+```
+

data/docs/BulkDomainAvailabilityV2Item.md

@@ -0,0 +1,22 @@
+# WhoisFreaks::BulkDomainAvailabilityV2Item
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **domain** | **String** |  | [optional] |
+| **availability** | **String** |  | [optional] |
+| **status** | **Boolean** | Whether the registry lookup succeeded. false => treat availability as UNKNOWN. | [optional] |
+
+## Example
+
+```ruby
+require 'whoisfreaks'
+
+instance = WhoisFreaks::BulkDomainAvailabilityV2Item.new(
+  domain: google.us,
+  availability: UNAVAILABLE,
+  status: true
+)
+```
+

data/docs/BulkDomainAvailabilityV2Response.md

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

data/docs/BulkGeolocationRequest.md

@@ -0,0 +1,18 @@
+# WhoisFreaks::BulkGeolocationRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ips** | **Array<String>** |  |  |
+
+## Example
+
+```ruby
+require 'whoisfreaks'
+
+instance = WhoisFreaks::BulkGeolocationRequest.new(
+  ips: null
+)
+```
+

data/docs/BulkWhois200Response.md

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

data/docs/BulkWhoisRequest.md

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

data/docs/Contact.md

@@ -0,0 +1,38 @@
+# WhoisFreaks::Contact
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **handle** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **company** | **String** |  | [optional] |
+| **street** | **String** |  | [optional] |
+| **city** | **String** |  | [optional] |
+| **state** | **String** |  | [optional] |
+| **zip_code** | **String** |  | [optional] |
+| **country_name** | **String** |  | [optional] |
+| **country_code** | **String** |  | [optional] |
+| **email_address** | **String** |  | [optional] |
+| **phone** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'whoisfreaks'
+
+instance = WhoisFreaks::Contact.new(
+  handle: null,
+  name: null,
+  company: null,
+  street: null,
+  city: null,
+  state: null,
+  zip_code: null,
+  country_name: null,
+  country_code: null,
+  email_address: null,
+  phone: null
+)
+```
+

data/docs/DNSApi.md

@@ -0,0 +1,335 @@
+# WhoisFreaks::DNSApi
+
+All URIs are relative to *https://api.whoisfreaks.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**dns_bulk**](DNSApi.md#dns_bulk) | **POST** /v2.0/dns/bulk/live | Bulk DNS Lookup |
+| [**dns_historical**](DNSApi.md#dns_historical) | **GET** /v2.0/dns/historical | Historical DNS Lookup |
+| [**dns_live**](DNSApi.md#dns_live) | **GET** /v2.0/dns/live | Live DNS Lookup |
+| [**dns_reverse**](DNSApi.md#dns_reverse) | **GET** /v2.1/dns/reverse | Reverse DNS Lookup |
+
+
+## dns_bulk
+
+> <DnsBulk200Response> dns_bulk(api_key, type, dns_bulk_request, opts)
+
+Bulk DNS Lookup
+
+Up to 100 domains + 100 IPs in one request.
+
+### 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::DNSApi.new
+api_key = 'api_key_example' # String | Your WHOISFreaks API key
+type = 'type_example' # String | 
+dns_bulk_request = WhoisFreaks::DnsBulkRequest.new # DnsBulkRequest | 
+opts = {
+  format: 'json' # String | 
+}
+
+begin
+  # Bulk DNS Lookup
+  result = api_instance.dns_bulk(api_key, type, dns_bulk_request, opts)
+  p result
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DNSApi->dns_bulk: #{e}"
+end
+```
+
+#### Using the dns_bulk_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DnsBulk200Response>, Integer, Hash)> dns_bulk_with_http_info(api_key, type, dns_bulk_request, opts)
+
+```ruby
+begin
+  # Bulk DNS Lookup
+  data, status_code, headers = api_instance.dns_bulk_with_http_info(api_key, type, dns_bulk_request, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DnsBulk200Response>
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DNSApi->dns_bulk_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **api_key** | **String** | Your WHOISFreaks API key |  |
+| **type** | **String** |  | [default to &#39;all&#39;] |
+| **dns_bulk_request** | [**DnsBulkRequest**](DnsBulkRequest.md) |  |  |
+| **format** | **String** |  | [optional][default to &#39;json&#39;] |
+
+### Return type
+
+[**DnsBulk200Response**](DnsBulk200Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## dns_historical
+
+> <HistoricalDnsResponse> dns_historical(api_key, domain_name, type, opts)
+
+Historical DNS Lookup
+
+All historical DNS records. 2 credits per page (100 records/page).
+
+### 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::DNSApi.new
+api_key = 'api_key_example' # String | Your WHOISFreaks API key
+domain_name = 'domain_name_example' # String | 
+type = 'type_example' # String | 
+opts = {
+  page: 56, # Integer | 
+  format: 'json' # String | 
+}
+
+begin
+  # Historical DNS Lookup
+  result = api_instance.dns_historical(api_key, domain_name, type, opts)
+  p result
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DNSApi->dns_historical: #{e}"
+end
+```
+
+#### Using the dns_historical_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<HistoricalDnsResponse>, Integer, Hash)> dns_historical_with_http_info(api_key, domain_name, type, opts)
+
+```ruby
+begin
+  # Historical DNS Lookup
+  data, status_code, headers = api_instance.dns_historical_with_http_info(api_key, domain_name, type, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <HistoricalDnsResponse>
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DNSApi->dns_historical_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **api_key** | **String** | Your WHOISFreaks API key |  |
+| **domain_name** | **String** |  |  |
+| **type** | **String** |  | [default to &#39;all&#39;] |
+| **page** | **Integer** |  | [optional][default to 1] |
+| **format** | **String** |  | [optional][default to &#39;json&#39;] |
+
+### Return type
+
+[**HistoricalDnsResponse**](HistoricalDnsResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## dns_live
+
+> <DnsResponse> dns_live(api_key, type, opts)
+
+Live DNS Lookup
+
+Real-time DNS record lookup. 1 credit per query.
+
+### 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::DNSApi.new
+api_key = 'api_key_example' # String | Your WHOISFreaks API key
+type = 'type_example' # String | all or comma-separated: A,MX,NS,TXT,SOA,SPF,AAAA,CNAME
+opts = {
+  domain_name: 'domain_name_example', # String | 
+  ip_address: 'ip_address_example', # String | Use for PTR lookups
+  format: 'json' # String | 
+}
+
+begin
+  # Live DNS Lookup
+  result = api_instance.dns_live(api_key, type, opts)
+  p result
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DNSApi->dns_live: #{e}"
+end
+```
+
+#### Using the dns_live_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DnsResponse>, Integer, Hash)> dns_live_with_http_info(api_key, type, opts)
+
+```ruby
+begin
+  # Live DNS Lookup
+  data, status_code, headers = api_instance.dns_live_with_http_info(api_key, type, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DnsResponse>
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DNSApi->dns_live_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **api_key** | **String** | Your WHOISFreaks API key |  |
+| **type** | **String** | all or comma-separated: A,MX,NS,TXT,SOA,SPF,AAAA,CNAME | [default to &#39;all&#39;] |
+| **domain_name** | **String** |  | [optional] |
+| **ip_address** | **String** | Use for PTR lookups | [optional] |
+| **format** | **String** |  | [optional][default to &#39;json&#39;] |
+
+### Return type
+
+[**DnsResponse**](DnsResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## dns_reverse
+
+> <ReverseDnsResponse> dns_reverse(api_key, value, type, opts)
+
+Reverse DNS Lookup
+
+Search domains by IP or DNS value. 5 credits per page.
+
+### 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::DNSApi.new
+api_key = 'api_key_example' # String | Your WHOISFreaks API key
+value = 'value_example' # String | IP, CIDR, or record value
+type = 'a' # String | 
+opts = {
+  exact: true, # Boolean | 
+  page: 56, # Integer | 
+  format: 'json' # String | 
+}
+
+begin
+  # Reverse DNS Lookup
+  result = api_instance.dns_reverse(api_key, value, type, opts)
+  p result
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DNSApi->dns_reverse: #{e}"
+end
+```
+
+#### Using the dns_reverse_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ReverseDnsResponse>, Integer, Hash)> dns_reverse_with_http_info(api_key, value, type, opts)
+
+```ruby
+begin
+  # Reverse DNS Lookup
+  data, status_code, headers = api_instance.dns_reverse_with_http_info(api_key, value, type, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ReverseDnsResponse>
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DNSApi->dns_reverse_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **api_key** | **String** | Your WHOISFreaks API key |  |
+| **value** | **String** | IP, CIDR, or record value |  |
+| **type** | **String** |  |  |
+| **exact** | **Boolean** |  | [optional][default to true] |
+| **page** | **Integer** |  | [optional][default to 1] |
+| **format** | **String** |  | [optional][default to &#39;json&#39;] |
+
+### Return type
+
+[**ReverseDnsResponse**](ReverseDnsResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/DatabaseFileStatus.md

@@ -0,0 +1,24 @@
+# WhoisFreaks::DatabaseFileStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **newly** | [**Hash<String, DatabaseFileStatusNewlyValue>**](DatabaseFileStatusNewlyValue.md) |  | [optional] |
+| **expired** | [**DatabaseFileStatusNewlyValue**](DatabaseFileStatusNewlyValue.md) |  | [optional] |
+| **dropped** | [**DatabaseFileStatusNewlyValue**](DatabaseFileStatusNewlyValue.md) |  | [optional] |
+| **database_updates** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'whoisfreaks'
+
+instance = WhoisFreaks::DatabaseFileStatus.new(
+  newly: null,
+  expired: null,
+  dropped: null,
+  database_updates: null
+)
+```
+

data/docs/DatabaseFileStatusNewlyValue.md

@@ -0,0 +1,20 @@
+# WhoisFreaks::DatabaseFileStatusNewlyValue
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **last_update** | **String** |  | [optional] |
+| **available_from** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'whoisfreaks'
+
+instance = WhoisFreaks::DatabaseFileStatusNewlyValue.new(
+  last_update: null,
+  available_from: null
+)
+```
+