whoisfreaks 0.2.0

data/docs/DomainAvailabilityApi.md

@@ -0,0 +1,169 @@
+# WhoisFreaks::DomainAvailabilityApi
+
+All URIs are relative to *https://api.whoisfreaks.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**bulk_domain_availability_v2**](DomainAvailabilityApi.md#bulk_domain_availability_v2) | **POST** /v2.0/domain/availability | Bulk Domain Availability Check |
+| [**domain_availability_v2**](DomainAvailabilityApi.md#domain_availability_v2) | **GET** /v2.0/domain/availability | Domain Availability Check with Suggestions |
+
+
+## bulk_domain_availability_v2
+
+> <BulkDomainAvailabilityV2Response> bulk_domain_availability_v2(api_key, bulk_domain_availability_request, opts)
+
+Bulk Domain Availability Check
+
+Two bulk modes. Mode 1: POST domainNames array. Mode 2: POST tld array plus domain query param. Max 100 domains per request. 1 credit per domain checked.
+
+### 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::DomainAvailabilityApi.new
+api_key = 'api_key_example' # String | Your WHOISFreaks API key
+bulk_domain_availability_request = WhoisFreaks::BulkDomainAvailabilityRequest.new # BulkDomainAvailabilityRequest | 
+opts = {
+  domain: 'google.com', # String | Required for TLD-mode bulk check (base domain).
+  format: 'json' # String | 
+}
+
+begin
+  # Bulk Domain Availability Check
+  result = api_instance.bulk_domain_availability_v2(api_key, bulk_domain_availability_request, opts)
+  p result
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DomainAvailabilityApi->bulk_domain_availability_v2: #{e}"
+end
+```
+
+#### Using the bulk_domain_availability_v2_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BulkDomainAvailabilityV2Response>, Integer, Hash)> bulk_domain_availability_v2_with_http_info(api_key, bulk_domain_availability_request, opts)
+
+```ruby
+begin
+  # Bulk Domain Availability Check
+  data, status_code, headers = api_instance.bulk_domain_availability_v2_with_http_info(api_key, bulk_domain_availability_request, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BulkDomainAvailabilityV2Response>
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DomainAvailabilityApi->bulk_domain_availability_v2_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **api_key** | **String** | Your WHOISFreaks API key |  |
+| **bulk_domain_availability_request** | [**BulkDomainAvailabilityRequest**](BulkDomainAvailabilityRequest.md) |  |  |
+| **domain** | **String** | Required for TLD-mode bulk check (base domain). | [optional] |
+| **format** | **String** |  | [optional][default to &#39;json&#39;] |
+
+### Return type
+
+[**BulkDomainAvailabilityV2Response**](BulkDomainAvailabilityV2Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## domain_availability_v2
+
+> <DomainAvailabilityV2Response> domain_availability_v2(api_key, domain, opts)
+
+Domain Availability Check with Suggestions
+
+Check availability of a single domain and optionally get suggestions across multiple TLDs. 1 credit per domain checked. sug=false checks only the queried domain; sug=true returns up to `count` (max 100) TLD suggestions.
+
+### 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::DomainAvailabilityApi.new
+api_key = 'api_key_example' # String | Your WHOISFreaks API key
+domain = 'google.com' # String | The domain name to check
+opts = {
+  sug: true, # Boolean | Whether to return TLD suggestions alongside the queried domain.
+  count: 56, # Integer | Number of TLD suggestions to return when sug=true. Maximum is 100.
+  format: 'json' # String | 
+}
+
+begin
+  # Domain Availability Check with Suggestions
+  result = api_instance.domain_availability_v2(api_key, domain, opts)
+  p result
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DomainAvailabilityApi->domain_availability_v2: #{e}"
+end
+```
+
+#### Using the domain_availability_v2_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DomainAvailabilityV2Response>, Integer, Hash)> domain_availability_v2_with_http_info(api_key, domain, opts)
+
+```ruby
+begin
+  # Domain Availability Check with Suggestions
+  data, status_code, headers = api_instance.domain_availability_v2_with_http_info(api_key, domain, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DomainAvailabilityV2Response>
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DomainAvailabilityApi->domain_availability_v2_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **api_key** | **String** | Your WHOISFreaks API key |  |
+| **domain** | **String** | The domain name to check |  |
+| **sug** | **Boolean** | Whether to return TLD suggestions alongside the queried domain. | [optional][default to false] |
+| **count** | **Integer** | Number of TLD suggestions to return when sug&#x3D;true. Maximum is 100. | [optional][default to 5] |
+| **format** | **String** |  | [optional][default to &#39;json&#39;] |
+
+### Return type
+
+[**DomainAvailabilityV2Response**](DomainAvailabilityV2Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/DomainAvailabilityV2Item.md

@@ -0,0 +1,20 @@
+# WhoisFreaks::DomainAvailabilityV2Item
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **domain** | **String** | The full domain name that was checked | [optional] |
+| **availability** | **String** | Availability status of the domain. | [optional] |
+
+## Example
+
+```ruby
+require 'whoisfreaks'
+
+instance = WhoisFreaks::DomainAvailabilityV2Item.new(
+  domain: google.com,
+  availability: UNAVAILABLE
+)
+```
+

data/docs/DomainAvailabilityV2Response.md

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

data/docs/DomainReputationApi.md

@@ -0,0 +1,85 @@
+# WhoisFreaks::DomainReputationApi
+
+All URIs are relative to *https://api.whoisfreaks.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**domain_reputation**](DomainReputationApi.md#domain_reputation) | **GET** /v1/domain/security | Domain Reputation Lookup |
+
+
+## domain_reputation
+
+> <DomainReputationResponse> domain_reputation(api_key, domain_name, opts)
+
+Domain Reputation Lookup
+
+Real-time domain threat assessment. Returns risk verdict, trust score, DGA analysis, threat intelligence matches, and security signals. 1 credit.
+
+### 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::DomainReputationApi.new
+api_key = 'api_key_example' # String | Your WHOISFreaks API key
+domain_name = 'amazon.com' # String | The domain name to assess
+opts = {
+  format: 'json' # String | 
+}
+
+begin
+  # Domain Reputation Lookup
+  result = api_instance.domain_reputation(api_key, domain_name, opts)
+  p result
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DomainReputationApi->domain_reputation: #{e}"
+end
+```
+
+#### Using the domain_reputation_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DomainReputationResponse>, Integer, Hash)> domain_reputation_with_http_info(api_key, domain_name, opts)
+
+```ruby
+begin
+  # Domain Reputation Lookup
+  data, status_code, headers = api_instance.domain_reputation_with_http_info(api_key, domain_name, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DomainReputationResponse>
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling DomainReputationApi->domain_reputation_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **api_key** | **String** | Your WHOISFreaks API key |  |
+| **domain_name** | **String** | The domain name to assess |  |
+| **format** | **String** |  | [optional][default to &#39;json&#39;] |
+
+### Return type
+
+[**DomainReputationResponse**](DomainReputationResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/DomainReputationDgaFeatures.md

@@ -0,0 +1,30 @@
+# WhoisFreaks::DomainReputationDgaFeatures
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **domain_length** | **Integer** |  | [optional] |
+| **vowel_consonant_ratio** | **Float** |  | [optional] |
+| **ngram_perplexity** | **Float** |  | [optional] |
+| **shannon_entropy** | **Float** |  | [optional] |
+| **digit_letter_ratio** | **Float** |  | [optional] |
+| **consonant_streak_max** | **Integer** |  | [optional] |
+| **tld_in_known_dga_set** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'whoisfreaks'
+
+instance = WhoisFreaks::DomainReputationDgaFeatures.new(
+  domain_length: 6,
+  vowel_consonant_ratio: 1.0,
+  ngram_perplexity: -8.074,
+  shannon_entropy: 2.2516291673878226,
+  digit_letter_ratio: 0.0,
+  consonant_streak_max: 1,
+  tld_in_known_dga_set: false
+)
+```
+

data/docs/DomainReputationDgaScore.md

@@ -0,0 +1,26 @@
+# WhoisFreaks::DomainReputationDgaScore
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **score** | **Float** |  | [optional] |
+| **is_dga** | **Boolean** |  | [optional] |
+| **model** | **String** |  | [optional] |
+| **features** | [**DomainReputationDgaFeatures**](DomainReputationDgaFeatures.md) |  | [optional] |
+| **interpretation** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'whoisfreaks'
+
+instance = WhoisFreaks::DomainReputationDgaScore.new(
+  score: 0.0,
+  is_dga: false,
+  model: deterministic_features_v1,
+  features: null,
+  interpretation: human_readable
+)
+```
+

data/docs/DomainReputationEvidenceSummary.md

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

data/docs/DomainReputationIndicators.md

@@ -0,0 +1,34 @@
+# WhoisFreaks::DomainReputationIndicators
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **is_newly_registered** | **Boolean** |  | [optional] |
+| **uses_free_extension** | **Boolean** |  | [optional] |
+| **uses_free_ssl** | **Boolean** |  | [optional] |
+| **has_privacy_whois** | **Boolean** |  | [optional] |
+| **ssl_age_days** | **Integer** |  | [optional] |
+| **has_dmarc** | **Boolean** |  | [optional] |
+| **has_spf** | **Boolean** |  | [optional] |
+| **domain_age_days** | **Integer** |  | [optional] |
+| **registrar** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'whoisfreaks'
+
+instance = WhoisFreaks::DomainReputationIndicators.new(
+  is_newly_registered: false,
+  uses_free_extension: false,
+  uses_free_ssl: false,
+  has_privacy_whois: false,
+  ssl_age_days: 64,
+  has_dmarc: true,
+  has_spf: true,
+  domain_age_days: 11572,
+  registrar: MarkMonitor, Inc
+)
+```
+

data/docs/DomainReputationInput.md

@@ -0,0 +1,18 @@
+# WhoisFreaks::DomainReputationInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **domain** | **String** | The domain that was assessed | [optional] |
+
+## Example
+
+```ruby
+require 'whoisfreaks'
+
+instance = WhoisFreaks::DomainReputationInput.new(
+  domain: amazon.com
+)
+```
+

data/docs/DomainReputationIntelligence.md

@@ -0,0 +1,32 @@
+# WhoisFreaks::DomainReputationIntelligence
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ioc_type** | **String** |  | [optional] |
+| **ioc_value** | **String** |  | [optional] |
+| **related_iocs** | [**Array<DomainReputationRelatedIoc>**](DomainReputationRelatedIoc.md) |  | [optional] |
+| **feed_tags** | **Array<String>** |  | [optional] |
+| **stix_pattern** | **String** |  | [optional] |
+| **recommended_action** | **String** |  | [optional] |
+| **first_seen** | **Time** |  | [optional] |
+| **last_seen** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'whoisfreaks'
+
+instance = WhoisFreaks::DomainReputationIntelligence.new(
+  ioc_type: domain,
+  ioc_value: amazon.com,
+  related_iocs: null,
+  feed_tags: null,
+  stix_pattern: [domain-name:value = 'amazon.com'],
+  recommended_action: monitor,
+  first_seen: null,
+  last_seen: null
+)
+```
+

data/docs/DomainReputationPivotMatch.md

@@ -0,0 +1,24 @@
+# WhoisFreaks::DomainReputationPivotMatch
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pivot** | **String** |  | [optional] |
+| **pivot_type** | **String** |  | [optional] |
+| **total_related_threats** | **Integer** |  | [optional] |
+| **confidence** | **Float** |  | [optional] |
+
+## Example
+
+```ruby
+require 'whoisfreaks'
+
+instance = WhoisFreaks::DomainReputationPivotMatch.new(
+  pivot: +1 2062664064,
+  pivot_type: phone,
+  total_related_threats: 11314,
+  confidence: 0.7
+)
+```
+

data/docs/DomainReputationRelatedIoc.md

@@ -0,0 +1,22 @@
+# WhoisFreaks::DomainReputationRelatedIoc
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  | [optional] |
+| **value** | **String** |  | [optional] |
+| **confidence** | **Float** |  | [optional] |
+
+## Example
+
+```ruby
+require 'whoisfreaks'
+
+instance = WhoisFreaks::DomainReputationRelatedIoc.new(
+  type: ipv4,
+  value: 98.87.170.71,
+  confidence: 0.9
+)
+```
+

data/docs/DomainReputationResponse.md

@@ -0,0 +1,36 @@
+# WhoisFreaks::DomainReputationResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **input** | [**DomainReputationInput**](DomainReputationInput.md) |  | [optional] |
+| **assessed_at** | **Time** |  | [optional] |
+| **version** | **String** |  | [optional] |
+| **processing_time_ms** | **Integer** |  | [optional] |
+| **risk_category** | [**DomainReputationRiskCategory**](DomainReputationRiskCategory.md) |  | [optional] |
+| **dga_score** | [**DomainReputationDgaScore**](DomainReputationDgaScore.md) |  | [optional] |
+| **trust_signals** | [**DomainReputationTrustSignals**](DomainReputationTrustSignals.md) |  | [optional] |
+| **intelligence** | [**DomainReputationIntelligence**](DomainReputationIntelligence.md) |  | [optional] |
+| **evidence_summary** | [**DomainReputationEvidenceSummary**](DomainReputationEvidenceSummary.md) |  | [optional] |
+| **errors** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'whoisfreaks'
+
+instance = WhoisFreaks::DomainReputationResponse.new(
+  input: null,
+  assessed_at: 2026-07-08T07:45:50.084747871Z,
+  version: 1.0.0,
+  processing_time_ms: 2009,
+  risk_category: null,
+  dga_score: null,
+  trust_signals: null,
+  intelligence: null,
+  evidence_summary: null,
+  errors: null
+)
+```
+

data/docs/DomainReputationRiskCategory.md

@@ -0,0 +1,30 @@
+# WhoisFreaks::DomainReputationRiskCategory
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **verdict** | **String** |  | [optional] |
+| **confidence** | **Float** |  | [optional] |
+| **primary_threat** | **String** |  | [optional] |
+| **severity** | **String** |  | [optional] |
+| **threat_types** | **Array<String>** |  | [optional] |
+| **sources** | **Array<String>** |  | [optional] |
+| **pivot_matches** | [**Array<DomainReputationPivotMatch>**](DomainReputationPivotMatch.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'whoisfreaks'
+
+instance = WhoisFreaks::DomainReputationRiskCategory.new(
+  verdict: suspicious,
+  confidence: 0.7,
+  primary_threat: null,
+  severity: medium,
+  threat_types: null,
+  sources: null,
+  pivot_matches: null
+)
+```
+

data/docs/DomainReputationSignal.md

@@ -0,0 +1,28 @@
+# WhoisFreaks::DomainReputationSignal
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** |  | [optional] |
+| **weight** | **Integer** |  | [optional] |
+| **polarity** | **String** |  | [optional] |
+| **category** | **String** |  | [optional] |
+| **evidence** | **String** |  | [optional] |
+| **confidence** | **Float** |  | [optional] |
+
+## Example
+
+```ruby
+require 'whoisfreaks'
+
+instance = WhoisFreaks::DomainReputationSignal.new(
+  code: spf_configured,
+  weight: 5,
+  polarity: positive,
+  category: email_security,
+  evidence: SPF record found,
+  confidence: 1.0
+)
+```
+

data/docs/DomainReputationSignals.md

@@ -0,0 +1,22 @@
+# WhoisFreaks::DomainReputationSignals
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **positive** | [**Array<DomainReputationSignal>**](DomainReputationSignal.md) |  | [optional] |
+| **negative** | [**Array<DomainReputationSignal>**](DomainReputationSignal.md) |  | [optional] |
+| **neutral** | [**Array<DomainReputationSignal>**](DomainReputationSignal.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'whoisfreaks'
+
+instance = WhoisFreaks::DomainReputationSignals.new(
+  positive: null,
+  negative: null,
+  neutral: null
+)
+```
+

data/docs/DomainReputationTrustSignals.md

@@ -0,0 +1,24 @@
+# WhoisFreaks::DomainReputationTrustSignals
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **trust_score** | **Integer** |  | [optional] |
+| **trust_band** | **String** |  | [optional] |
+| **signals** | [**DomainReputationSignals**](DomainReputationSignals.md) |  | [optional] |
+| **indicators** | [**DomainReputationIndicators**](DomainReputationIndicators.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'whoisfreaks'
+
+instance = WhoisFreaks::DomainReputationTrustSignals.new(
+  trust_score: 71,
+  trust_band: high,
+  signals: null,
+  indicators: null
+)
+```
+

data/docs/ErrorResponse.md

@@ -0,0 +1,26 @@
+# WhoisFreaks::ErrorResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **Boolean** |  | [optional] |
+| **message** | **String** |  | [optional] |
+| **timestamp** | **String** |  | [optional] |
+| **path** | **String** |  | [optional] |
+| **error** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'whoisfreaks'
+
+instance = WhoisFreaks::ErrorResponse.new(
+  status: null,
+  message: null,
+  timestamp: null,
+  path: null,
+  error: null
+)
+```
+