whoisfreaks-js 0.9.0

package/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.

package/README.md

@@ -0,0 +1,268 @@
+# whoisfreaks
+
+WhoisFreaks - JavaScript client for whoisfreaks
+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.9.0
+- Generator version: 7.11.0
+- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
+For more information, please visit [https://whoisfreaks.com](https://whoisfreaks.com)
+
+## Installation
+
+### For [Node.js](https://nodejs.org/)
+
+#### npm
+
+To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).
+
+Then install it via:
+
+```shell
+npm install whoisfreaks --save
+```
+
+Finally, you need to build the module:
+
+```shell
+npm run build
+```
+
+##### Local development
+
+To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run:
+
+```shell
+npm install
+```
+
+Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:
+
+```shell
+npm link
+```
+
+To use the link you just defined in your project, switch to the directory you want to use your whoisfreaks from, and run:
+
+```shell
+npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
+```
+
+Finally, you need to build the module:
+
+```shell
+npm run build
+```
+
+#### git
+
+If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID
+then install it via:
+
+```shell
+    npm install GIT_USER_ID/GIT_REPO_ID --save
+```
+
+### For browser
+
+The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following
+the above steps with Node.js and installing browserify with `npm install -g browserify`,
+perform the following (assuming *main.js* is your entry file):
+
+```shell
+browserify main.js > bundle.js
+```
+
+Then include *bundle.js* in the HTML pages.
+
+### Webpack Configuration
+
+Using Webpack you may encounter the following error: "Module not found: Error:
+Cannot resolve module", most certainly you should disable AMD loader. Add/merge
+the following section to your webpack config:
+
+```javascript
+module: {
+  rules: [
+    {
+      parser: {
+        amd: false
+      }
+    }
+  ]
+}
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) instruction and execute the following JS code:
+
+```javascript
+var WhoisFreaks = require('whoisfreaks');
+
+var defaultClient = WhoisFreaks.ApiClient.instance;
+// Configure API key authorization: ApiKeyAuth
+var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
+ApiKeyAuth.apiKey = "YOUR API KEY"
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//ApiKeyAuth.apiKeyPrefix['apiKey'] = "Token"
+
+var api = new WhoisFreaks.ASNWHOISApi()
+var apiKey = "apiKey_example"; // {String} Your WHOISFreaks API key
+var asn = "as15169"; // {String} 
+var opts = {
+  'format': "'json'" // {String} 
+};
+api.asnWhois(apiKey, asn, opts).then(function(data) {
+  console.log('API called successfully. Returned data: ' + data);
+}, function(error) {
+  console.error(error);
+});
+
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.whoisfreaks.com*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*WhoisFreaks.ASNWHOISApi* | [**asnWhois**](docs/ASNWHOISApi.md#asnWhois) | **GET** /v2.0/asn-whois | ASN WHOIS Lookup
+*WhoisFreaks.AccountApi* | [**accountUsage**](docs/AccountApi.md#accountUsage) | **GET** /v1.0/whoisapi/usage | Account Usage
+*WhoisFreaks.AccountApi* | [**databaseFileStatus**](docs/AccountApi.md#databaseFileStatus) | **GET** /v3.3/status | Database File Status (Public)
+*WhoisFreaks.AccountApi* | [**rotateApiKey**](docs/AccountApi.md#rotateApiKey) | **GET** /v1.0/api-key/rotate | Rotate API Key
+*WhoisFreaks.DNSApi* | [**dnsBulk**](docs/DNSApi.md#dnsBulk) | **POST** /v2.0/dns/bulk/live | Bulk DNS Lookup
+*WhoisFreaks.DNSApi* | [**dnsHistorical**](docs/DNSApi.md#dnsHistorical) | **GET** /v2.0/dns/historical | Historical DNS Lookup
+*WhoisFreaks.DNSApi* | [**dnsLive**](docs/DNSApi.md#dnsLive) | **GET** /v2.0/dns/live | Live DNS Lookup
+*WhoisFreaks.DNSApi* | [**dnsReverse**](docs/DNSApi.md#dnsReverse) | **GET** /v2.1/dns/reverse | Reverse DNS Lookup
+*WhoisFreaks.DatabasesASNWHOISApi* | [**dbAsnWhois**](docs/DatabasesASNWHOISApi.md#dbAsnWhois) | **GET** /v3.3/download/snapshot/asn/whois | ASN WHOIS Snapshot
+*WhoisFreaks.DatabasesASNWHOISApi* | [**dbAsnWhoisStatus**](docs/DatabasesASNWHOISApi.md#dbAsnWhoisStatus) | **GET** /v3.3/status/snapshot/asn/whois | ASN WHOIS Snapshot Status
+*WhoisFreaks.DatabasesDNSApi* | [**dbDnsDaily**](docs/DatabasesDNSApi.md#dbDnsDaily) | **GET** /v3.2/download/dbupdate/daily/dns | DNS Database Daily
+*WhoisFreaks.DatabasesDNSApi* | [**dbDnsMonthly**](docs/DatabasesDNSApi.md#dbDnsMonthly) | **GET** /v3.2/download/dbupdate/monthly/dns | DNS Database Monthly
+*WhoisFreaks.DatabasesDNSApi* | [**dbDnsWeekly**](docs/DatabasesDNSApi.md#dbDnsWeekly) | **GET** /v3.2/download/dbupdate/weekly/dns | DNS Database Weekly
+*WhoisFreaks.DatabasesExpiringDroppedApi* | [**dbDropped**](docs/DatabasesExpiringDroppedApi.md#dbDropped) | **GET** /v3.1/download/domainer/dropped | Dropped Domains
+*WhoisFreaks.DatabasesExpiringDroppedApi* | [**dbDroppedBacklinks**](docs/DatabasesExpiringDroppedApi.md#dbDroppedBacklinks) | **GET** /v3.3/download/domainer/dropped/backlinks | Dropped With Backlinks
+*WhoisFreaks.DatabasesExpiringDroppedApi* | [**dbDroppedJson**](docs/DatabasesExpiringDroppedApi.md#dbDroppedJson) | **GET** /v3.1/domains/dropped | Dropped Domains (JSON)
+*WhoisFreaks.DatabasesExpiringDroppedApi* | [**dbExpired**](docs/DatabasesExpiringDroppedApi.md#dbExpired) | **GET** /v3.1/download/domainer/expired | Expiring Domains
+*WhoisFreaks.DatabasesExpiringDroppedApi* | [**dbExpiredCleaned**](docs/DatabasesExpiringDroppedApi.md#dbExpiredCleaned) | **GET** /v3.1/download/domainer/expired/cleaned | Expiring Cleaned WHOIS
+*WhoisFreaks.DatabasesIPGeolocationApi* | [**dbIpCity**](docs/DatabasesIPGeolocationApi.md#dbIpCity) | **GET** /v3.3/download/snapshot/ip/city | IP to City Snapshot
+*WhoisFreaks.DatabasesIPGeolocationApi* | [**dbIpCityStatus**](docs/DatabasesIPGeolocationApi.md#dbIpCityStatus) | **GET** /v3.3/status/snapshot/ip/city | IP to City Snapshot Status
+*WhoisFreaks.DatabasesIPGeolocationApi* | [**dbIpCountry**](docs/DatabasesIPGeolocationApi.md#dbIpCountry) | **GET** /v3.3/download/snapshot/ip/country | IP to Country Snapshot
+*WhoisFreaks.DatabasesIPGeolocationApi* | [**dbIpCountryStatus**](docs/DatabasesIPGeolocationApi.md#dbIpCountryStatus) | **GET** /v3.3/status/snapshot/ip/country | IP to Country Snapshot Status
+*WhoisFreaks.DatabasesIPSecurityApi* | [**dbIpSecurity**](docs/DatabasesIPSecurityApi.md#dbIpSecurity) | **GET** /v3.3/download/snapshot/ip/security | IP Security Snapshot
+*WhoisFreaks.DatabasesIPSecurityApi* | [**dbIpSecurityStatus**](docs/DatabasesIPSecurityApi.md#dbIpSecurityStatus) | **GET** /v3.3/status/snapshot/ip/security | IP Security Snapshot Status
+*WhoisFreaks.DatabasesIPWHOISApi* | [**dbIpWhois**](docs/DatabasesIPWHOISApi.md#dbIpWhois) | **GET** /v3.3/download/snapshot/ip/whois | IP WHOIS Snapshot
+*WhoisFreaks.DatabasesIPWHOISApi* | [**dbIpWhoisStatus**](docs/DatabasesIPWHOISApi.md#dbIpWhoisStatus) | **GET** /v3.3/status/snapshot/ip/whois | IP WHOIS Snapshot Status
+*WhoisFreaks.DatabasesNewlyRegisteredApi* | [**dbNewlyCctld**](docs/DatabasesNewlyRegisteredApi.md#dbNewlyCctld) | **GET** /v3.1/download/domainer/cctld | Newly Registered ccTLD (CSV)
+*WhoisFreaks.DatabasesNewlyRegisteredApi* | [**dbNewlyCctldCleaned**](docs/DatabasesNewlyRegisteredApi.md#dbNewlyCctldCleaned) | **GET** /v3.1/download/domainer/cctld/cleaned | Newly Registered ccTLD Cleaned WHOIS (CSV)
+*WhoisFreaks.DatabasesNewlyRegisteredApi* | [**dbNewlyCctldJson**](docs/DatabasesNewlyRegisteredApi.md#dbNewlyCctldJson) | **GET** /v3.1/domains/newly/cctld | Newly Registered ccTLD (JSON)
+*WhoisFreaks.DatabasesNewlyRegisteredApi* | [**dbNewlyDns**](docs/DatabasesNewlyRegisteredApi.md#dbNewlyDns) | **GET** /v3.1/download/domainer/newly/dns | Newly Registered With DNS
+*WhoisFreaks.DatabasesNewlyRegisteredApi* | [**dbNewlyGtld**](docs/DatabasesNewlyRegisteredApi.md#dbNewlyGtld) | **GET** /v3.1/download/domainer/gtld | Newly Registered gTLD (CSV)
+*WhoisFreaks.DatabasesNewlyRegisteredApi* | [**dbNewlyGtldCleaned**](docs/DatabasesNewlyRegisteredApi.md#dbNewlyGtldCleaned) | **GET** /v3.1/download/domainer/gtld/cleaned | Newly Registered gTLD Cleaned WHOIS (CSV)
+*WhoisFreaks.DatabasesNewlyRegisteredApi* | [**dbNewlyGtldJson**](docs/DatabasesNewlyRegisteredApi.md#dbNewlyGtldJson) | **GET** /v3.1/domains/newly/gtld | Newly Registered gTLD (JSON)
+*WhoisFreaks.DatabasesSubdomainsApi* | [**dbSubdomainsDaily**](docs/DatabasesSubdomainsApi.md#dbSubdomainsDaily) | **GET** /v3.2/download/dbupdate/daily/subdomains | Subdomains Daily
+*WhoisFreaks.DatabasesSubdomainsApi* | [**dbSubdomainsMonthly**](docs/DatabasesSubdomainsApi.md#dbSubdomainsMonthly) | **GET** /v3.2/download/dbupdate/monthly/subdomains | Subdomains Monthly
+*WhoisFreaks.DatabasesSubdomainsApi* | [**dbSubdomainsWeekly**](docs/DatabasesSubdomainsApi.md#dbSubdomainsWeekly) | **GET** /v3.2/download/dbupdate/weekly/subdomains | Subdomains Weekly
+*WhoisFreaks.DatabasesWHOISApi* | [**dbWhoisDaily**](docs/DatabasesWHOISApi.md#dbWhoisDaily) | **GET** /v3.3/download/dbupdate/daily/domains/whois | WHOIS Database Daily
+*WhoisFreaks.DatabasesWHOISApi* | [**dbWhoisMonthly**](docs/DatabasesWHOISApi.md#dbWhoisMonthly) | **GET** /v3.3/download/dbupdate/monthly/domains/whois | WHOIS Database Monthly
+*WhoisFreaks.DatabasesWHOISApi* | [**dbWhoisWeekly**](docs/DatabasesWHOISApi.md#dbWhoisWeekly) | **GET** /v3.3/download/dbupdate/weekly/domains/whois | WHOIS Database Weekly
+*WhoisFreaks.DomainAvailabilityApi* | [**bulkDomainAvailabilityV2**](docs/DomainAvailabilityApi.md#bulkDomainAvailabilityV2) | **POST** /v2.0/domain/availability | Bulk Domain Availability Check
+*WhoisFreaks.DomainAvailabilityApi* | [**domainAvailabilityV2**](docs/DomainAvailabilityApi.md#domainAvailabilityV2) | **GET** /v2.0/domain/availability | Domain Availability Check with Suggestions
+*WhoisFreaks.DomainReputationApi* | [**domainReputation**](docs/DomainReputationApi.md#domainReputation) | **GET** /v1/domain/security | Domain Reputation Lookup
+*WhoisFreaks.GeolocationApi* | [**bulkGeolocation**](docs/GeolocationApi.md#bulkGeolocation) | **POST** /v1.0/geolocation | Bulk IP Geolocation
+*WhoisFreaks.GeolocationApi* | [**geolocation**](docs/GeolocationApi.md#geolocation) | **GET** /v1.0/geolocation | IP Geolocation Lookup
+*WhoisFreaks.IPReputationApi* | [**bulkIpReputation**](docs/IPReputationApi.md#bulkIpReputation) | **POST** /v1.0/security | Bulk IP Reputation
+*WhoisFreaks.IPReputationApi* | [**ipReputation**](docs/IPReputationApi.md#ipReputation) | **GET** /v1.0/security | IP Reputation Lookup
+*WhoisFreaks.IPWHOISApi* | [**ipWhois**](docs/IPWHOISApi.md#ipWhois) | **GET** /v1.0/ip-whois | IP WHOIS Lookup
+*WhoisFreaks.SSLApi* | [**sslLookup**](docs/SSLApi.md#sslLookup) | **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* | [**bulkWhois**](docs/WHOISApi.md#bulkWhois) | **POST** /v2.0/bulkwhois/live | Bulk WHOIS Lookup
+*WhoisFreaks.WHOISApi* | [**whoisHistoricalOrReverse**](docs/WHOISApi.md#whoisHistoricalOrReverse) | **GET** /v1.0/whois | WHOIS Historical or Reverse Lookup
+*WhoisFreaks.WHOISApi* | [**whoisLive**](docs/WHOISApi.md#whoisLive) | **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
+