whoisfreaks 0.2.0

data/docs/DatabasesIPSecurityApi.md

@@ -0,0 +1,153 @@
+# WhoisFreaks::DatabasesIPSecurityApi
+
+All URIs are relative to *https://api.whoisfreaks.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**db_ip_security**](DatabasesIPSecurityApi.md#db_ip_security) | **GET** /v3.3/download/snapshot/ip/security | IP Security Snapshot |
+| [**db_ip_security_status**](DatabasesIPSecurityApi.md#db_ip_security_status) | **GET** /v3.3/status/snapshot/ip/security | IP Security Snapshot Status |
+
+
+## db_ip_security
+
+> String db_ip_security(api_key, date)
+
+IP Security Snapshot
+
+IP Security 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::DatabasesIPSecurityApi.new
+api_key = 'api_key_example' # String | Your WHOISFreaks API key
+date = Date.parse('2013-10-20') # Date | 
+
+begin
+  # IP Security Snapshot
+  result = api_instance.db_ip_security(api_key, date)
+  p result
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DatabasesIPSecurityApi->db_ip_security: #{e}"
+end
+```
+
+#### Using the db_ip_security_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> db_ip_security_with_http_info(api_key, date)
+
+```ruby
+begin
+  # IP Security Snapshot
+  data, status_code, headers = api_instance.db_ip_security_with_http_info(api_key, date)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DatabasesIPSecurityApi->db_ip_security_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **api_key** | **String** | Your WHOISFreaks API key |  |
+| **date** | **Date** |  |  |
+
+### Return type
+
+**String**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/csv, application/json
+
+
+## db_ip_security_status
+
+> <SnapshotStatus> db_ip_security_status(api_key)
+
+IP Security Snapshot Status
+
+IP Security 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::DatabasesIPSecurityApi.new
+api_key = 'api_key_example' # String | Your WHOISFreaks API key
+
+begin
+  # IP Security Snapshot Status
+  result = api_instance.db_ip_security_status(api_key)
+  p result
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DatabasesIPSecurityApi->db_ip_security_status: #{e}"
+end
+```
+
+#### Using the db_ip_security_status_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SnapshotStatus>, Integer, Hash)> db_ip_security_status_with_http_info(api_key)
+
+```ruby
+begin
+  # IP Security Snapshot Status
+  data, status_code, headers = api_instance.db_ip_security_status_with_http_info(api_key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SnapshotStatus>
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DatabasesIPSecurityApi->db_ip_security_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
+

data/docs/DatabasesIPWHOISApi.md

@@ -0,0 +1,153 @@
+# WhoisFreaks::DatabasesIPWHOISApi
+
+All URIs are relative to *https://api.whoisfreaks.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**db_ip_whois**](DatabasesIPWHOISApi.md#db_ip_whois) | **GET** /v3.3/download/snapshot/ip/whois | IP WHOIS Snapshot |
+| [**db_ip_whois_status**](DatabasesIPWHOISApi.md#db_ip_whois_status) | **GET** /v3.3/status/snapshot/ip/whois | IP WHOIS Snapshot Status |
+
+
+## db_ip_whois
+
+> Object db_ip_whois(api_key, date)
+
+IP WHOIS Snapshot
+
+IP WHOIS 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::DatabasesIPWHOISApi.new
+api_key = 'api_key_example' # String | Your WHOISFreaks API key
+date = Date.parse('2013-10-20') # Date | 
+
+begin
+  # IP WHOIS Snapshot
+  result = api_instance.db_ip_whois(api_key, date)
+  p result
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DatabasesIPWHOISApi->db_ip_whois: #{e}"
+end
+```
+
+#### Using the db_ip_whois_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> db_ip_whois_with_http_info(api_key, date)
+
+```ruby
+begin
+  # IP WHOIS Snapshot
+  data, status_code, headers = api_instance.db_ip_whois_with_http_info(api_key, date)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DatabasesIPWHOISApi->db_ip_whois_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **api_key** | **String** | Your WHOISFreaks API key |  |
+| **date** | **Date** |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## db_ip_whois_status
+
+> <SnapshotStatus> db_ip_whois_status(api_key)
+
+IP WHOIS Snapshot Status
+
+IP WHOIS 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::DatabasesIPWHOISApi.new
+api_key = 'api_key_example' # String | Your WHOISFreaks API key
+
+begin
+  # IP WHOIS Snapshot Status
+  result = api_instance.db_ip_whois_status(api_key)
+  p result
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DatabasesIPWHOISApi->db_ip_whois_status: #{e}"
+end
+```
+
+#### Using the db_ip_whois_status_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SnapshotStatus>, Integer, Hash)> db_ip_whois_status_with_http_info(api_key)
+
+```ruby
+begin
+  # IP WHOIS Snapshot Status
+  data, status_code, headers = api_instance.db_ip_whois_status_with_http_info(api_key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SnapshotStatus>
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DatabasesIPWHOISApi->db_ip_whois_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
+