whoisfreaks 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1a1c797baf91f188c4cc0caad30317db8f8b67def004e75bceee3034345528f8
+  data.tar.gz: 67d4080acacf35be908a8ad9fae98eff1dcddb0d75f9e3e16e3e716581f27a45
+SHA512:
+  metadata.gz: a6bd39d6a70b6da109773d7aa6b9c09f359a829e56510a0bb08c8645ecfaedc3cbab5469b965b48851abf332a22edf76ecbf048de3208650e61942820b868239
+  data.tar.gz: f315b9f37d7fec132008af8950edff412be1eaca5709020cdc2928a6c2417b11aa91d2ea84ffd8bfdf3020f17175d7603d2fb40c63409242508e46dc20337c8c

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 WhoisFreaks
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,229 @@
+# whoisfreaks
+
+WhoisFreaks - the Ruby gem for the WhoisFreaks API
+
+Complete WhoisFreaks API — WHOIS, DNS, SSL, Geolocation, Typosquatting, IP Intelligence, Domain Reputation, and bulk database downloads. ## Authentication
+All requests require an `apiKey` query parameter.
+## Resources
+- Docs: https://whoisfreaks.com/documentation
+- Billing: https://billing.whoisfreaks.com
+- Support: support@whoisfreaks.com
+
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.0.0
+- Package version: 0.2.0
+- Generator version: 7.11.0
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+For more information, please visit [https://whoisfreaks.com](https://whoisfreaks.com)
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build whoisfreaks.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./whoisfreaks-0.2.0.gem
+```
+
+(for development, run `gem install --dev ./whoisfreaks-0.2.0.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'whoisfreaks', '~> 0.2.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'whoisfreaks', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+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'
+  # Configure faraday connection
+  config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
+end
+
+api_instance = WhoisFreaks::ASNWHOISApi.new
+api_key = 'api_key_example' # String | Your WHOISFreaks API key
+asn = 'as15169' # String | 
+opts = {
+  format: 'json' # String | 
+}
+
+begin
+  #ASN WHOIS Lookup
+  result = api_instance.asn_whois(api_key, asn, opts)
+  p result
+rescue WhoisFreaks::ApiError => e
+  puts "Exception when calling ASNWHOISApi->asn_whois: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.whoisfreaks.com*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*WhoisFreaks::ASNWHOISApi* | [**asn_whois**](docs/ASNWHOISApi.md#asn_whois) | **GET** /v2.0/asn-whois | ASN WHOIS Lookup
+*WhoisFreaks::AccountApi* | [**account_usage**](docs/AccountApi.md#account_usage) | **GET** /v1.0/whoisapi/usage | Account Usage
+*WhoisFreaks::AccountApi* | [**database_file_status**](docs/AccountApi.md#database_file_status) | **GET** /v3.3/status | Database File Status (Public)
+*WhoisFreaks::AccountApi* | [**rotate_api_key**](docs/AccountApi.md#rotate_api_key) | **GET** /v1.0/api-key/rotate | Rotate API Key
+*WhoisFreaks::DNSApi* | [**dns_bulk**](docs/DNSApi.md#dns_bulk) | **POST** /v2.0/dns/bulk/live | Bulk DNS Lookup
+*WhoisFreaks::DNSApi* | [**dns_historical**](docs/DNSApi.md#dns_historical) | **GET** /v2.0/dns/historical | Historical DNS Lookup
+*WhoisFreaks::DNSApi* | [**dns_live**](docs/DNSApi.md#dns_live) | **GET** /v2.0/dns/live | Live DNS Lookup
+*WhoisFreaks::DNSApi* | [**dns_reverse**](docs/DNSApi.md#dns_reverse) | **GET** /v2.1/dns/reverse | Reverse DNS Lookup
+*WhoisFreaks::DatabasesASNWHOISApi* | [**db_asn_whois**](docs/DatabasesASNWHOISApi.md#db_asn_whois) | **GET** /v3.3/download/snapshot/asn/whois | ASN WHOIS Snapshot
+*WhoisFreaks::DatabasesASNWHOISApi* | [**db_asn_whois_status**](docs/DatabasesASNWHOISApi.md#db_asn_whois_status) | **GET** /v3.3/status/snapshot/asn/whois | ASN WHOIS Snapshot Status
+*WhoisFreaks::DatabasesDNSApi* | [**db_dns_daily**](docs/DatabasesDNSApi.md#db_dns_daily) | **GET** /v3.2/download/dbupdate/daily/dns | DNS Database Daily
+*WhoisFreaks::DatabasesDNSApi* | [**db_dns_monthly**](docs/DatabasesDNSApi.md#db_dns_monthly) | **GET** /v3.2/download/dbupdate/monthly/dns | DNS Database Monthly
+*WhoisFreaks::DatabasesDNSApi* | [**db_dns_weekly**](docs/DatabasesDNSApi.md#db_dns_weekly) | **GET** /v3.2/download/dbupdate/weekly/dns | DNS Database Weekly
+*WhoisFreaks::DatabasesExpiringDroppedApi* | [**db_dropped**](docs/DatabasesExpiringDroppedApi.md#db_dropped) | **GET** /v3.1/download/domainer/dropped | Dropped Domains
+*WhoisFreaks::DatabasesExpiringDroppedApi* | [**db_dropped_backlinks**](docs/DatabasesExpiringDroppedApi.md#db_dropped_backlinks) | **GET** /v3.3/download/domainer/dropped/backlinks | Dropped With Backlinks
+*WhoisFreaks::DatabasesExpiringDroppedApi* | [**db_dropped_json**](docs/DatabasesExpiringDroppedApi.md#db_dropped_json) | **GET** /v3.1/domains/dropped | Dropped Domains (JSON)
+*WhoisFreaks::DatabasesExpiringDroppedApi* | [**db_expired**](docs/DatabasesExpiringDroppedApi.md#db_expired) | **GET** /v3.1/download/domainer/expired | Expiring Domains
+*WhoisFreaks::DatabasesExpiringDroppedApi* | [**db_expired_cleaned**](docs/DatabasesExpiringDroppedApi.md#db_expired_cleaned) | **GET** /v3.1/download/domainer/expired/cleaned | Expiring Cleaned WHOIS
+*WhoisFreaks::DatabasesIPGeolocationApi* | [**db_ip_city**](docs/DatabasesIPGeolocationApi.md#db_ip_city) | **GET** /v3.3/download/snapshot/ip/city | IP to City Snapshot
+*WhoisFreaks::DatabasesIPGeolocationApi* | [**db_ip_city_status**](docs/DatabasesIPGeolocationApi.md#db_ip_city_status) | **GET** /v3.3/status/snapshot/ip/city | IP to City Snapshot Status
+*WhoisFreaks::DatabasesIPGeolocationApi* | [**db_ip_country**](docs/DatabasesIPGeolocationApi.md#db_ip_country) | **GET** /v3.3/download/snapshot/ip/country | IP to Country Snapshot
+*WhoisFreaks::DatabasesIPGeolocationApi* | [**db_ip_country_status**](docs/DatabasesIPGeolocationApi.md#db_ip_country_status) | **GET** /v3.3/status/snapshot/ip/country | IP to Country Snapshot Status
+*WhoisFreaks::DatabasesIPSecurityApi* | [**db_ip_security**](docs/DatabasesIPSecurityApi.md#db_ip_security) | **GET** /v3.3/download/snapshot/ip/security | IP Security Snapshot
+*WhoisFreaks::DatabasesIPSecurityApi* | [**db_ip_security_status**](docs/DatabasesIPSecurityApi.md#db_ip_security_status) | **GET** /v3.3/status/snapshot/ip/security | IP Security Snapshot Status
+*WhoisFreaks::DatabasesIPWHOISApi* | [**db_ip_whois**](docs/DatabasesIPWHOISApi.md#db_ip_whois) | **GET** /v3.3/download/snapshot/ip/whois | IP WHOIS Snapshot
+*WhoisFreaks::DatabasesIPWHOISApi* | [**db_ip_whois_status**](docs/DatabasesIPWHOISApi.md#db_ip_whois_status) | **GET** /v3.3/status/snapshot/ip/whois | IP WHOIS Snapshot Status
+*WhoisFreaks::DatabasesNewlyRegisteredApi* | [**db_newly_cctld**](docs/DatabasesNewlyRegisteredApi.md#db_newly_cctld) | **GET** /v3.1/download/domainer/cctld | Newly Registered ccTLD (CSV)
+*WhoisFreaks::DatabasesNewlyRegisteredApi* | [**db_newly_cctld_cleaned**](docs/DatabasesNewlyRegisteredApi.md#db_newly_cctld_cleaned) | **GET** /v3.1/download/domainer/cctld/cleaned | Newly Registered ccTLD Cleaned WHOIS (CSV)
+*WhoisFreaks::DatabasesNewlyRegisteredApi* | [**db_newly_cctld_json**](docs/DatabasesNewlyRegisteredApi.md#db_newly_cctld_json) | **GET** /v3.1/domains/newly/cctld | Newly Registered ccTLD (JSON)
+*WhoisFreaks::DatabasesNewlyRegisteredApi* | [**db_newly_dns**](docs/DatabasesNewlyRegisteredApi.md#db_newly_dns) | **GET** /v3.1/download/domainer/newly/dns | Newly Registered With DNS
+*WhoisFreaks::DatabasesNewlyRegisteredApi* | [**db_newly_gtld**](docs/DatabasesNewlyRegisteredApi.md#db_newly_gtld) | **GET** /v3.1/download/domainer/gtld | Newly Registered gTLD (CSV)
+*WhoisFreaks::DatabasesNewlyRegisteredApi* | [**db_newly_gtld_cleaned**](docs/DatabasesNewlyRegisteredApi.md#db_newly_gtld_cleaned) | **GET** /v3.1/download/domainer/gtld/cleaned | Newly Registered gTLD Cleaned WHOIS (CSV)
+*WhoisFreaks::DatabasesNewlyRegisteredApi* | [**db_newly_gtld_json**](docs/DatabasesNewlyRegisteredApi.md#db_newly_gtld_json) | **GET** /v3.1/domains/newly/gtld | Newly Registered gTLD (JSON)
+*WhoisFreaks::DatabasesSubdomainsApi* | [**db_subdomains_daily**](docs/DatabasesSubdomainsApi.md#db_subdomains_daily) | **GET** /v3.2/download/dbupdate/daily/subdomains | Subdomains Daily
+*WhoisFreaks::DatabasesSubdomainsApi* | [**db_subdomains_monthly**](docs/DatabasesSubdomainsApi.md#db_subdomains_monthly) | **GET** /v3.2/download/dbupdate/monthly/subdomains | Subdomains Monthly
+*WhoisFreaks::DatabasesSubdomainsApi* | [**db_subdomains_weekly**](docs/DatabasesSubdomainsApi.md#db_subdomains_weekly) | **GET** /v3.2/download/dbupdate/weekly/subdomains | Subdomains Weekly
+*WhoisFreaks::DatabasesWHOISApi* | [**db_whois_daily**](docs/DatabasesWHOISApi.md#db_whois_daily) | **GET** /v3.3/download/dbupdate/daily/domains/whois | WHOIS Database Daily
+*WhoisFreaks::DatabasesWHOISApi* | [**db_whois_monthly**](docs/DatabasesWHOISApi.md#db_whois_monthly) | **GET** /v3.3/download/dbupdate/monthly/domains/whois | WHOIS Database Monthly
+*WhoisFreaks::DatabasesWHOISApi* | [**db_whois_weekly**](docs/DatabasesWHOISApi.md#db_whois_weekly) | **GET** /v3.3/download/dbupdate/weekly/domains/whois | WHOIS Database Weekly
+*WhoisFreaks::DomainAvailabilityApi* | [**bulk_domain_availability_v2**](docs/DomainAvailabilityApi.md#bulk_domain_availability_v2) | **POST** /v2.0/domain/availability | Bulk Domain Availability Check
+*WhoisFreaks::DomainAvailabilityApi* | [**domain_availability_v2**](docs/DomainAvailabilityApi.md#domain_availability_v2) | **GET** /v2.0/domain/availability | Domain Availability Check with Suggestions
+*WhoisFreaks::DomainReputationApi* | [**domain_reputation**](docs/DomainReputationApi.md#domain_reputation) | **GET** /v1/domain/security | Domain Reputation Lookup
+*WhoisFreaks::GeolocationApi* | [**bulk_geolocation**](docs/GeolocationApi.md#bulk_geolocation) | **POST** /v1.0/geolocation | Bulk IP Geolocation
+*WhoisFreaks::GeolocationApi* | [**geolocation**](docs/GeolocationApi.md#geolocation) | **GET** /v1.0/geolocation | IP Geolocation Lookup
+*WhoisFreaks::IPReputationApi* | [**bulk_ip_reputation**](docs/IPReputationApi.md#bulk_ip_reputation) | **POST** /v1.0/security | Bulk IP Reputation
+*WhoisFreaks::IPReputationApi* | [**ip_reputation**](docs/IPReputationApi.md#ip_reputation) | **GET** /v1.0/security | IP Reputation Lookup
+*WhoisFreaks::IPWHOISApi* | [**ip_whois**](docs/IPWHOISApi.md#ip_whois) | **GET** /v1.0/ip-whois | IP WHOIS Lookup
+*WhoisFreaks::SSLApi* | [**ssl_lookup**](docs/SSLApi.md#ssl_lookup) | **GET** /v1.0/ssl/live | SSL Certificate Lookup
+*WhoisFreaks::SubdomainsApi* | [**subdomains**](docs/SubdomainsApi.md#subdomains) | **GET** /v1.0/subdomains | Subdomains Lookup
+*WhoisFreaks::TyposquattingApi* | [**typosquatting**](docs/TyposquattingApi.md#typosquatting) | **GET** /v3.0/domain/typos | Typosquatting Lookup
+*WhoisFreaks::WHOISApi* | [**bulk_whois**](docs/WHOISApi.md#bulk_whois) | **POST** /v2.0/bulkwhois/live | Bulk WHOIS Lookup
+*WhoisFreaks::WHOISApi* | [**whois_historical_or_reverse**](docs/WHOISApi.md#whois_historical_or_reverse) | **GET** /v1.0/whois | WHOIS Historical or Reverse Lookup
+*WhoisFreaks::WHOISApi* | [**whois_live**](docs/WHOISApi.md#whois_live) | **GET** /v2.0/whois/live | Live WHOIS Lookup
+
+
+## Documentation for Models
+
+ - [WhoisFreaks::AccountUsageResponse](docs/AccountUsageResponse.md)
+ - [WhoisFreaks::AccountUsageResponseApiCredits](docs/AccountUsageResponseApiCredits.md)
+ - [WhoisFreaks::AccountUsageResponseApiSubscription](docs/AccountUsageResponseApiSubscription.md)
+ - [WhoisFreaks::AsnWhoisResponse](docs/AsnWhoisResponse.md)
+ - [WhoisFreaks::AsnWhoisResponseAutNumsInner](docs/AsnWhoisResponseAutNumsInner.md)
+ - [WhoisFreaks::AsnWhoisResponseOrganization](docs/AsnWhoisResponseOrganization.md)
+ - [WhoisFreaks::BulkDomainAvailabilityRequest](docs/BulkDomainAvailabilityRequest.md)
+ - [WhoisFreaks::BulkDomainAvailabilityV2Item](docs/BulkDomainAvailabilityV2Item.md)
+ - [WhoisFreaks::BulkDomainAvailabilityV2Response](docs/BulkDomainAvailabilityV2Response.md)
+ - [WhoisFreaks::BulkGeolocationRequest](docs/BulkGeolocationRequest.md)
+ - [WhoisFreaks::BulkWhois200Response](docs/BulkWhois200Response.md)
+ - [WhoisFreaks::BulkWhoisRequest](docs/BulkWhoisRequest.md)
+ - [WhoisFreaks::Contact](docs/Contact.md)
+ - [WhoisFreaks::DatabaseFileStatus](docs/DatabaseFileStatus.md)
+ - [WhoisFreaks::DatabaseFileStatusNewlyValue](docs/DatabaseFileStatusNewlyValue.md)
+ - [WhoisFreaks::DnsBulk200Response](docs/DnsBulk200Response.md)
+ - [WhoisFreaks::DnsBulkRequest](docs/DnsBulkRequest.md)
+ - [WhoisFreaks::DnsRecord](docs/DnsRecord.md)
+ - [WhoisFreaks::DnsResponse](docs/DnsResponse.md)
+ - [WhoisFreaks::DomainAvailabilityV2Item](docs/DomainAvailabilityV2Item.md)
+ - [WhoisFreaks::DomainAvailabilityV2Response](docs/DomainAvailabilityV2Response.md)
+ - [WhoisFreaks::DomainReputationDgaFeatures](docs/DomainReputationDgaFeatures.md)
+ - [WhoisFreaks::DomainReputationDgaScore](docs/DomainReputationDgaScore.md)
+ - [WhoisFreaks::DomainReputationEvidenceSummary](docs/DomainReputationEvidenceSummary.md)
+ - [WhoisFreaks::DomainReputationIndicators](docs/DomainReputationIndicators.md)
+ - [WhoisFreaks::DomainReputationInput](docs/DomainReputationInput.md)
+ - [WhoisFreaks::DomainReputationIntelligence](docs/DomainReputationIntelligence.md)
+ - [WhoisFreaks::DomainReputationPivotMatch](docs/DomainReputationPivotMatch.md)
+ - [WhoisFreaks::DomainReputationRelatedIoc](docs/DomainReputationRelatedIoc.md)
+ - [WhoisFreaks::DomainReputationResponse](docs/DomainReputationResponse.md)
+ - [WhoisFreaks::DomainReputationRiskCategory](docs/DomainReputationRiskCategory.md)
+ - [WhoisFreaks::DomainReputationSignal](docs/DomainReputationSignal.md)
+ - [WhoisFreaks::DomainReputationSignals](docs/DomainReputationSignals.md)
+ - [WhoisFreaks::DomainReputationTrustSignals](docs/DomainReputationTrustSignals.md)
+ - [WhoisFreaks::ErrorResponse](docs/ErrorResponse.md)
+ - [WhoisFreaks::GeolocationAsn](docs/GeolocationAsn.md)
+ - [WhoisFreaks::GeolocationLocation](docs/GeolocationLocation.md)
+ - [WhoisFreaks::GeolocationResponse](docs/GeolocationResponse.md)
+ - [WhoisFreaks::GeolocationResponseCurrency](docs/GeolocationResponseCurrency.md)
+ - [WhoisFreaks::GeolocationResponseNetwork](docs/GeolocationResponseNetwork.md)
+ - [WhoisFreaks::HistoricalDnsResponse](docs/HistoricalDnsResponse.md)
+ - [WhoisFreaks::IpReputationResponse](docs/IpReputationResponse.md)
+ - [WhoisFreaks::IpReputationSecurity](docs/IpReputationSecurity.md)
+ - [WhoisFreaks::IpWhoisResponse](docs/IpWhoisResponse.md)
+ - [WhoisFreaks::IpWhoisResponseAbuseContactsInner](docs/IpWhoisResponseAbuseContactsInner.md)
+ - [WhoisFreaks::IpWhoisResponseInetNumsInner](docs/IpWhoisResponseInetNumsInner.md)
+ - [WhoisFreaks::IpWhoisResponseOrganization](docs/IpWhoisResponseOrganization.md)
+ - [WhoisFreaks::Registrar](docs/Registrar.md)
+ - [WhoisFreaks::ReverseDnsResponse](docs/ReverseDnsResponse.md)
+ - [WhoisFreaks::ReverseWhoisResponse](docs/ReverseWhoisResponse.md)
+ - [WhoisFreaks::SnapshotStatus](docs/SnapshotStatus.md)
+ - [WhoisFreaks::SslCertificate](docs/SslCertificate.md)
+ - [WhoisFreaks::SslResponse](docs/SslResponse.md)
+ - [WhoisFreaks::Subdomain](docs/Subdomain.md)
+ - [WhoisFreaks::SubdomainsResponse](docs/SubdomainsResponse.md)
+ - [WhoisFreaks::TyposquattingDomain](docs/TyposquattingDomain.md)
+ - [WhoisFreaks::TyposquattingResponse](docs/TyposquattingResponse.md)
+ - [WhoisFreaks::WhoisHistoricalOrReverse200Response](docs/WhoisHistoricalOrReverse200Response.md)
+ - [WhoisFreaks::WhoisHistoricalResponse](docs/WhoisHistoricalResponse.md)
+ - [WhoisFreaks::WhoisResponse](docs/WhoisResponse.md)
+
+
+## Documentation for Authorization
+
+
+Authentication schemes defined for the API:
+### ApiKeyAuth
+
+
+- **Type**: API key
+- **API key parameter name**: apiKey
+- **Location**: URL query string
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/ASNWHOISApi.md

@@ -0,0 +1,85 @@
+# WhoisFreaks::ASNWHOISApi
+
+All URIs are relative to *https://api.whoisfreaks.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**asn_whois**](ASNWHOISApi.md#asn_whois) | **GET** /v2.0/asn-whois | ASN WHOIS Lookup |
+
+
+## asn_whois
+
+> <AsnWhoisResponse> asn_whois(api_key, asn, opts)
+
+ASN WHOIS Lookup
+
+WHOIS for an ASN. 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::ASNWHOISApi.new
+api_key = 'api_key_example' # String | Your WHOISFreaks API key
+asn = 'as15169' # String | 
+opts = {
+  format: 'json' # String | 
+}
+
+begin
+  # ASN WHOIS Lookup
+  result = api_instance.asn_whois(api_key, asn, opts)
+  p result
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling ASNWHOISApi->asn_whois: #{e}"
+end
+```
+
+#### Using the asn_whois_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AsnWhoisResponse>, Integer, Hash)> asn_whois_with_http_info(api_key, asn, opts)
+
+```ruby
+begin
+  # ASN WHOIS Lookup
+  data, status_code, headers = api_instance.asn_whois_with_http_info(api_key, asn, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AsnWhoisResponse>
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling ASNWHOISApi->asn_whois_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **api_key** | **String** | Your WHOISFreaks API key |  |
+| **asn** | **String** |  |  |
+| **format** | **String** |  | [optional][default to &#39;json&#39;] |
+
+### Return type
+
+[**AsnWhoisResponse**](AsnWhoisResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/AccountApi.md

@@ -0,0 +1,213 @@
+# WhoisFreaks::AccountApi
+
+All URIs are relative to *https://api.whoisfreaks.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**account_usage**](AccountApi.md#account_usage) | **GET** /v1.0/whoisapi/usage | Account Usage |
+| [**database_file_status**](AccountApi.md#database_file_status) | **GET** /v3.3/status | Database File Status (Public) |
+| [**rotate_api_key**](AccountApi.md#rotate_api_key) | **GET** /v1.0/api-key/rotate | Rotate API Key |
+
+
+## account_usage
+
+> <AccountUsageResponse> account_usage(api_key)
+
+Account Usage
+
+Account Usage. 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::AccountApi.new
+api_key = 'api_key_example' # String | Your WHOISFreaks API key
+
+begin
+  # Account Usage
+  result = api_instance.account_usage(api_key)
+  p result
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling AccountApi->account_usage: #{e}"
+end
+```
+
+#### Using the account_usage_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AccountUsageResponse>, Integer, Hash)> account_usage_with_http_info(api_key)
+
+```ruby
+begin
+  # Account Usage
+  data, status_code, headers = api_instance.account_usage_with_http_info(api_key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AccountUsageResponse>
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling AccountApi->account_usage_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **api_key** | **String** | Your WHOISFreaks API key |  |
+
+### Return type
+
+[**AccountUsageResponse**](AccountUsageResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## database_file_status
+
+> <DatabaseFileStatus> database_file_status
+
+Database File Status (Public)
+
+No API key required. Returns freshness of all downloadable files.
+
+### Examples
+
+```ruby
+require 'time'
+require 'whoisfreaks'
+
+api_instance = WhoisFreaks::AccountApi.new
+
+begin
+  # Database File Status (Public)
+  result = api_instance.database_file_status
+  p result
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling AccountApi->database_file_status: #{e}"
+end
+```
+
+#### Using the database_file_status_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DatabaseFileStatus>, Integer, Hash)> database_file_status_with_http_info
+
+```ruby
+begin
+  # Database File Status (Public)
+  data, status_code, headers = api_instance.database_file_status_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DatabaseFileStatus>
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling AccountApi->database_file_status_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**DatabaseFileStatus**](DatabaseFileStatus.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## rotate_api_key
+
+> String rotate_api_key(api_key)
+
+Rotate API Key
+
+Rotate API Key. 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::AccountApi.new
+api_key = 'api_key_example' # String | Your WHOISFreaks API key
+
+begin
+  # Rotate API Key
+  result = api_instance.rotate_api_key(api_key)
+  p result
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling AccountApi->rotate_api_key: #{e}"
+end
+```
+
+#### Using the rotate_api_key_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> rotate_api_key_with_http_info(api_key)
+
+```ruby
+begin
+  # Rotate API Key
+  data, status_code, headers = api_instance.rotate_api_key_with_http_info(api_key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue WhoisFreaks::ApiError => e
+  puts "Error when calling AccountApi->rotate_api_key_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **api_key** | **String** | Your WHOISFreaks API key |  |
+
+### Return type
+
+**String**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/plain
+

data/docs/AccountUsageResponse.md

@@ -0,0 +1,22 @@
+# WhoisFreaks::AccountUsageResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **api_key** | **String** |  | [optional] |
+| **api_credits** | [**AccountUsageResponseApiCredits**](AccountUsageResponseApiCredits.md) |  | [optional] |
+| **api_subscription** | [**AccountUsageResponseApiSubscription**](AccountUsageResponseApiSubscription.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'whoisfreaks'
+
+instance = WhoisFreaks::AccountUsageResponse.new(
+  api_key: null,
+  api_credits: null,
+  api_subscription: null
+)
+```
+

data/docs/AccountUsageResponseApiCredits.md

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

data/docs/AccountUsageResponseApiSubscription.md

@@ -0,0 +1,26 @@
+# WhoisFreaks::AccountUsageResponseApiSubscription
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **subscription_status** | **String** |  | [optional] |
+| **request_limit** | **Integer** |  | [optional] |
+| **served_requests** | **Integer** |  | [optional] |
+| **surcharge_request_limit** | **Integer** |  | [optional] |
+| **served_surcharge_requests** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'whoisfreaks'
+
+instance = WhoisFreaks::AccountUsageResponseApiSubscription.new(
+  subscription_status: null,
+  request_limit: null,
+  served_requests: null,
+  surcharge_request_limit: null,
+  served_surcharge_requests: null
+)
+```
+

data/docs/AsnWhoisResponse.md

@@ -0,0 +1,28 @@
+# WhoisFreaks::AsnWhoisResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **Boolean** |  | [optional] |
+| **as_number** | **String** |  | [optional] |
+| **query_time** | **String** |  | [optional] |
+| **whois_server** | **String** |  | [optional] |
+| **aut_nums** | [**Array<AsnWhoisResponseAutNumsInner>**](AsnWhoisResponseAutNumsInner.md) |  | [optional] |
+| **organization** | [**AsnWhoisResponseOrganization**](AsnWhoisResponseOrganization.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'whoisfreaks'
+
+instance = WhoisFreaks::AsnWhoisResponse.new(
+  status: null,
+  as_number: null,
+  query_time: null,
+  whois_server: null,
+  aut_nums: null,
+  organization: null
+)
+```
+