vpndetection 5.9.0 → 5.10.0

data/lib/vpndetection/models/location.rb

@@ -0,0 +1,409 @@
+=begin
+#VPNDetection API
+
+#The VPNDetection API: classify any IP address, and download the databases behind the answers.  See https://docs.vpndetection.io for guides and https://github.com/vpndetection-io for the official client libraries. 
+
+The version of the OpenAPI document: 2026.10.20
+Contact: support@vpndetection.io
+Generated by: https://openapi-generator.tech
+Generator version: 7.25.0
+
+=end
+
+require 'date'
+require 'time'
+
+module VPNDetection
+  # Where the address is, to the country: the fields of our IP Country database. Free and paid plans. Each field is present whenever the object is, so an address in no country, or a private one, answers empty strings. 
+  class Location < ApiModelBase
+    # Continent code: AF, AN (Antarctica), AS, EU, NA, OC or SA.
+    attr_accessor :continent
+
+    # Continent name.
+    attr_accessor :continent_name
+
+    # ISO 3166-1 alpha-2 country code.
+    attr_accessor :country
+
+    # Country name.
+    attr_accessor :country_name
+
+    # IANA timezone of the address.
+    attr_accessor :timezone
+
+    # ISO 4217 code of the country's currency, where there is one.
+    attr_accessor :currency_code
+
+    # Name of the country's currency, where there is one.
+    attr_accessor :currency_name
+
+    # Symbol of the country's currency, where known.
+    attr_accessor :currency_symbol
+
+    # The country's flag, as an emoji.
+    attr_accessor :flag_emoji
+
+    # The Unicode code points of the flag emoji.
+    attr_accessor :flag_unicode
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'continent' => :'continent',
+        :'continent_name' => :'continent_name',
+        :'country' => :'country',
+        :'country_name' => :'country_name',
+        :'timezone' => :'timezone',
+        :'currency_code' => :'currency_code',
+        :'currency_name' => :'currency_name',
+        :'currency_symbol' => :'currency_symbol',
+        :'flag_emoji' => :'flag_emoji',
+        :'flag_unicode' => :'flag_unicode'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'continent' => :'String',
+        :'continent_name' => :'String',
+        :'country' => :'String',
+        :'country_name' => :'String',
+        :'timezone' => :'String',
+        :'currency_code' => :'String',
+        :'currency_name' => :'String',
+        :'currency_symbol' => :'String',
+        :'flag_emoji' => :'String',
+        :'flag_unicode' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `VPNDetection::Location` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `VPNDetection::Location`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'continent')
+        self.continent = attributes[:'continent']
+      else
+        self.continent = nil
+      end
+
+      if attributes.key?(:'continent_name')
+        self.continent_name = attributes[:'continent_name']
+      else
+        self.continent_name = nil
+      end
+
+      if attributes.key?(:'country')
+        self.country = attributes[:'country']
+      else
+        self.country = nil
+      end
+
+      if attributes.key?(:'country_name')
+        self.country_name = attributes[:'country_name']
+      else
+        self.country_name = nil
+      end
+
+      if attributes.key?(:'timezone')
+        self.timezone = attributes[:'timezone']
+      else
+        self.timezone = nil
+      end
+
+      if attributes.key?(:'currency_code')
+        self.currency_code = attributes[:'currency_code']
+      else
+        self.currency_code = nil
+      end
+
+      if attributes.key?(:'currency_name')
+        self.currency_name = attributes[:'currency_name']
+      else
+        self.currency_name = nil
+      end
+
+      if attributes.key?(:'currency_symbol')
+        self.currency_symbol = attributes[:'currency_symbol']
+      else
+        self.currency_symbol = nil
+      end
+
+      if attributes.key?(:'flag_emoji')
+        self.flag_emoji = attributes[:'flag_emoji']
+      else
+        self.flag_emoji = nil
+      end
+
+      if attributes.key?(:'flag_unicode')
+        self.flag_unicode = attributes[:'flag_unicode']
+      else
+        self.flag_unicode = nil
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @continent.nil?
+        invalid_properties.push('invalid value for "continent", continent cannot be nil.')
+      end
+
+      if @continent_name.nil?
+        invalid_properties.push('invalid value for "continent_name", continent_name cannot be nil.')
+      end
+
+      if @country.nil?
+        invalid_properties.push('invalid value for "country", country cannot be nil.')
+      end
+
+      if @country_name.nil?
+        invalid_properties.push('invalid value for "country_name", country_name cannot be nil.')
+      end
+
+      if @timezone.nil?
+        invalid_properties.push('invalid value for "timezone", timezone cannot be nil.')
+      end
+
+      if @currency_code.nil?
+        invalid_properties.push('invalid value for "currency_code", currency_code cannot be nil.')
+      end
+
+      if @currency_name.nil?
+        invalid_properties.push('invalid value for "currency_name", currency_name cannot be nil.')
+      end
+
+      if @currency_symbol.nil?
+        invalid_properties.push('invalid value for "currency_symbol", currency_symbol cannot be nil.')
+      end
+
+      if @flag_emoji.nil?
+        invalid_properties.push('invalid value for "flag_emoji", flag_emoji cannot be nil.')
+      end
+
+      if @flag_unicode.nil?
+        invalid_properties.push('invalid value for "flag_unicode", flag_unicode cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @continent.nil?
+      return false if @continent_name.nil?
+      return false if @country.nil?
+      return false if @country_name.nil?
+      return false if @timezone.nil?
+      return false if @currency_code.nil?
+      return false if @currency_name.nil?
+      return false if @currency_symbol.nil?
+      return false if @flag_emoji.nil?
+      return false if @flag_unicode.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] continent Value to be assigned
+    def continent=(continent)
+      if continent.nil?
+        fail ArgumentError, 'continent cannot be nil'
+      end
+
+      @continent = continent
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] continent_name Value to be assigned
+    def continent_name=(continent_name)
+      if continent_name.nil?
+        fail ArgumentError, 'continent_name cannot be nil'
+      end
+
+      @continent_name = continent_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] country Value to be assigned
+    def country=(country)
+      if country.nil?
+        fail ArgumentError, 'country cannot be nil'
+      end
+
+      @country = country
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] country_name Value to be assigned
+    def country_name=(country_name)
+      if country_name.nil?
+        fail ArgumentError, 'country_name cannot be nil'
+      end
+
+      @country_name = country_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] timezone Value to be assigned
+    def timezone=(timezone)
+      if timezone.nil?
+        fail ArgumentError, 'timezone cannot be nil'
+      end
+
+      @timezone = timezone
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] currency_code Value to be assigned
+    def currency_code=(currency_code)
+      if currency_code.nil?
+        fail ArgumentError, 'currency_code cannot be nil'
+      end
+
+      @currency_code = currency_code
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] currency_name Value to be assigned
+    def currency_name=(currency_name)
+      if currency_name.nil?
+        fail ArgumentError, 'currency_name cannot be nil'
+      end
+
+      @currency_name = currency_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] currency_symbol Value to be assigned
+    def currency_symbol=(currency_symbol)
+      if currency_symbol.nil?
+        fail ArgumentError, 'currency_symbol cannot be nil'
+      end
+
+      @currency_symbol = currency_symbol
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] flag_emoji Value to be assigned
+    def flag_emoji=(flag_emoji)
+      if flag_emoji.nil?
+        fail ArgumentError, 'flag_emoji cannot be nil'
+      end
+
+      @flag_emoji = flag_emoji
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] flag_unicode Value to be assigned
+    def flag_unicode=(flag_unicode)
+      if flag_unicode.nil?
+        fail ArgumentError, 'flag_unicode cannot be nil'
+      end
+
+      @flag_unicode = flag_unicode
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          continent == o.continent &&
+          continent_name == o.continent_name &&
+          country == o.country &&
+          country_name == o.country_name &&
+          timezone == o.timezone &&
+          currency_code == o.currency_code &&
+          currency_name == o.currency_name &&
+          currency_symbol == o.currency_symbol &&
+          flag_emoji == o.flag_emoji &&
+          flag_unicode == o.flag_unicode
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [continent, continent_name, country, country_name, timezone, currency_code, currency_name, currency_symbol, flag_emoji, flag_unicode].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end

data/lib/vpndetection/models/lookup_error.rb

@@ -3,7 +3,7 @@
 
 #The VPNDetection API: classify any IP address, and download the databases behind the answers.  See https://docs.vpndetection.io for guides and https://github.com/vpndetection-io for the official client libraries. 
 
-The version of the OpenAPI document: 2026.10.19
+The version of the OpenAPI document: 2026.10.20
 Contact: support@vpndetection.io
 Generated by: https://openapi-generator.tech
 Generator version: 7.25.0

data/lib/vpndetection/models/lookup_response.rb

@@ -3,7 +3,7 @@
 
 #The VPNDetection API: classify any IP address, and download the databases behind the answers.  See https://docs.vpndetection.io for guides and https://github.com/vpndetection-io for the official client libraries. 
 
-The version of the OpenAPI document: 2026.10.19
+The version of the OpenAPI document: 2026.10.20
 Contact: support@vpndetection.io
 Generated by: https://openapi-generator.tech
 Generator version: 7.25.0
@@ -22,57 +22,61 @@ module VPNDetection
     # Whether the address is VPN infrastructure. Keys off presence in the VPN dataset, so an unattributed range with no provider is still `true`. 
     attr_accessor :is_vpn
 
-    # Whether the address belongs to a hosting or cloud provider. Starter and above.
+    # Whether the address belongs to a hosting or cloud provider. Paid plans.
     attr_accessor :is_hosting
 
-    # Whether the address is privacy relay or enterprise web gateway egress, such as iCloud Private Relay or Zscaler. Starter and above.
+    # Whether the address is privacy relay or enterprise web gateway egress, such as iCloud Private Relay or Zscaler. Free and paid plans.
     attr_accessor :is_relay
 
-    # Whether the address is a Tor node. Starter and above.
+    # Whether the address is a Tor node. Free and paid plans.
     attr_accessor :is_tor
 
-    # Whether the address belongs to a CDN. Starter and above.
+    # Whether the address belongs to a CDN. Paid plans.
     attr_accessor :is_cdn
 
-    # Whether the address was seen in a residential proxy pool. Scale and above.
+    # Whether the address was seen in a residential proxy pool. Paid plans.
     attr_accessor :is_resproxy
 
-    # Whether the address was seen in a datacenter proxy pool. Scale and above.
+    # Whether the address was seen in a datacenter proxy pool. Paid plans.
     attr_accessor :is_dcproxy
 
-    # Whether the address was seen in a mobile proxy pool. Scale and above.
+    # Whether the address was seen in a mobile proxy pool. Paid plans.
     attr_accessor :is_mobproxy
 
-    # Whether a public proxy, one anyone can connect through, listens on the address or sends its traffic out from it. Scale and above.
+    # Whether a public proxy, one anyone can connect through, listens on the address or sends its traffic out from it. Paid plans.
     attr_accessor :is_pubproxy
 
-    # Detail for `is_vpn`. Empty when `is_vpn` is false. Starter and above. 
+    # Detail for `is_vpn`. Empty when `is_vpn` is false. Paid plans. 
     attr_accessor :vpn
 
-    # Detail for `is_hosting`. Empty when false. Scale and above.
+    # Detail for `is_hosting`. Empty when false. Paid plans.
     attr_accessor :hosting
 
-    # Detail for `is_relay`. Empty when false. Scale and above.
+    # Detail for `is_relay`. Empty when false. Free and paid plans.
     attr_accessor :relay
 
-    # Detail for `is_tor`. Empty when false. Scale and above. The tor dataset carries no provider, so `provider` is always an empty string. 
+    # Detail for `is_tor`. Empty when false. Free and paid plans. The tor dataset carries no provider, so `provider` is always an empty string. 
     attr_accessor :tor
 
-    # Detail for `is_cdn`. Empty when false. Scale and above.
+    # Detail for `is_cdn`. Empty when false. Paid plans.
     attr_accessor :cdn
 
-    # Detail for `is_resproxy`. Empty when false. Max only.
+    # Detail for `is_resproxy`. Empty when false. Paid plans.
     attr_accessor :resproxy
 
-    # Detail for `is_dcproxy`. Empty when false. Max only.
+    # Detail for `is_dcproxy`. Empty when false. Paid plans.
     attr_accessor :dcproxy
 
-    # Detail for `is_mobproxy`. Empty when false. Max only.
+    # Detail for `is_mobproxy`. Empty when false. Paid plans.
     attr_accessor :mobproxy
 
-    # Detail for `is_pubproxy`. Empty when false. Max only.
+    # Detail for `is_pubproxy`. Empty when false. Paid plans.
     attr_accessor :pubproxy
 
+    attr_accessor :location
+
+    attr_accessor :asn
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -94,7 +98,9 @@ module VPNDetection
         :'resproxy' => :'resproxy',
         :'dcproxy' => :'dcproxy',
         :'mobproxy' => :'mobproxy',
-        :'pubproxy' => :'pubproxy'
+        :'pubproxy' => :'pubproxy',
+        :'location' => :'location',
+        :'asn' => :'asn'
       }
     end
 
@@ -129,7 +135,9 @@ module VPNDetection
         :'resproxy' => :'ProxyDetail',
         :'dcproxy' => :'ProxyDetail',
         :'mobproxy' => :'ProxyDetail',
-        :'pubproxy' => :'PubproxyDetail'
+        :'pubproxy' => :'PubproxyDetail',
+        :'location' => :'Location',
+        :'asn' => :'Asn'
       }
     end
 
@@ -234,6 +242,14 @@ module VPNDetection
       if attributes.key?(:'pubproxy')
         self.pubproxy = attributes[:'pubproxy']
       end
+
+      if attributes.key?(:'location')
+        self.location = attributes[:'location']
+      end
+
+      if attributes.key?(:'asn')
+        self.asn = attributes[:'asn']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -304,7 +320,9 @@ module VPNDetection
           resproxy == o.resproxy &&
           dcproxy == o.dcproxy &&
           mobproxy == o.mobproxy &&
-          pubproxy == o.pubproxy
+          pubproxy == o.pubproxy &&
+          location == o.location &&
+          asn == o.asn
     end
 
     # @see the `==` method
@@ -316,7 +334,7 @@ module VPNDetection
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [ip, is_vpn, is_hosting, is_relay, is_tor, is_cdn, is_resproxy, is_dcproxy, is_mobproxy, is_pubproxy, vpn, hosting, relay, tor, cdn, resproxy, dcproxy, mobproxy, pubproxy].hash
+      [ip, is_vpn, is_hosting, is_relay, is_tor, is_cdn, is_resproxy, is_dcproxy, is_mobproxy, is_pubproxy, vpn, hosting, relay, tor, cdn, resproxy, dcproxy, mobproxy, pubproxy, location, asn].hash
     end
 
     # Builds the object from hash

data/lib/vpndetection/models/oauth_error.rb

@@ -3,7 +3,7 @@
 
 #The VPNDetection API: classify any IP address, and download the databases behind the answers.  See https://docs.vpndetection.io for guides and https://github.com/vpndetection-io for the official client libraries. 
 
-The version of the OpenAPI document: 2026.10.19
+The version of the OpenAPI document: 2026.10.20
 Contact: support@vpndetection.io
 Generated by: https://openapi-generator.tech
 Generator version: 7.25.0

data/lib/vpndetection/models/oauth_metadata.rb

@@ -3,7 +3,7 @@
 
 #The VPNDetection API: classify any IP address, and download the databases behind the answers.  See https://docs.vpndetection.io for guides and https://github.com/vpndetection-io for the official client libraries. 
 
-The version of the OpenAPI document: 2026.10.19
+The version of the OpenAPI document: 2026.10.20
 Contact: support@vpndetection.io
 Generated by: https://openapi-generator.tech
 Generator version: 7.25.0

data/lib/vpndetection/models/proxy_detail.rb

@@ -3,7 +3,7 @@
 
 #The VPNDetection API: classify any IP address, and download the databases behind the answers.  See https://docs.vpndetection.io for guides and https://github.com/vpndetection-io for the official client libraries. 
 
-The version of the OpenAPI document: 2026.10.19
+The version of the OpenAPI document: 2026.10.20
 Contact: support@vpndetection.io
 Generated by: https://openapi-generator.tech
 Generator version: 7.25.0

data/lib/vpndetection/models/pubproxy_detail.rb

@@ -3,7 +3,7 @@
 
 #The VPNDetection API: classify any IP address, and download the databases behind the answers.  See https://docs.vpndetection.io for guides and https://github.com/vpndetection-io for the official client libraries. 
 
-The version of the OpenAPI document: 2026.10.19
+The version of the OpenAPI document: 2026.10.20
 Contact: support@vpndetection.io
 Generated by: https://openapi-generator.tech
 Generator version: 7.25.0

data/lib/vpndetection/models/standing.rb

@@ -3,7 +3,7 @@
 
 #The VPNDetection API: classify any IP address, and download the databases behind the answers.  See https://docs.vpndetection.io for guides and https://github.com/vpndetection-io for the official client libraries. 
 
-The version of the OpenAPI document: 2026.10.19
+The version of the OpenAPI document: 2026.10.20
 Contact: support@vpndetection.io
 Generated by: https://openapi-generator.tech
 Generator version: 7.25.0

data/lib/vpndetection/models/token_response.rb

@@ -3,7 +3,7 @@
 
 #The VPNDetection API: classify any IP address, and download the databases behind the answers.  See https://docs.vpndetection.io for guides and https://github.com/vpndetection-io for the official client libraries. 
 
-The version of the OpenAPI document: 2026.10.19
+The version of the OpenAPI document: 2026.10.20
 Contact: support@vpndetection.io
 Generated by: https://openapi-generator.tech
 Generator version: 7.25.0

data/lib/vpndetection/models/vpn_detail.rb

@@ -3,7 +3,7 @@
 
 #The VPNDetection API: classify any IP address, and download the databases behind the answers.  See https://docs.vpndetection.io for guides and https://github.com/vpndetection-io for the official client libraries. 
 
-The version of the OpenAPI document: 2026.10.19
+The version of the OpenAPI document: 2026.10.20
 Contact: support@vpndetection.io
 Generated by: https://openapi-generator.tech
 Generator version: 7.25.0
@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module VPNDetection
-  # What is known about the VPN attribution. Every key is present when the object is populated, empty values included; the object is `{}` when `is_vpn` is false. `confidence` and `method` are max only, so on a lower plan they are absent from a populated object rather than empty. 
+  # What is known about the VPN attribution. Every key is present when the object is populated, empty values included; the object is `{}` when `is_vpn` is false. 
   class VpnDetail < ApiModelBase
     # The VPN provider, or an empty string for an unattributed range.
     attr_accessor :provider
@@ -22,10 +22,10 @@ module VPNDetection
     # The most recent date this address was observed as VPN infrastructure.
     attr_accessor :last_seen
 
-    # How strongly the attribution is supported. Max only.
+    # How strongly the attribution is supported.
     attr_accessor :confidence
 
-    # The class of evidence the attribution rests on, one of four values. Max only.  `scan` - we spoke the VPN protocol to the address ourselves and got a valid server response. `scrape` - the operator published the address through its own API, client or configuration. `registry` - public registration or naming records attribute it to the operator. `infer` - the address was extrapolated from confirmed neighbors in the same block. 
+    # Never returned since 2026-10-20: no plan is answered with the class of evidence an attribution rests on. Declared so that a client typed against it keeps compiling; read `confidence` instead. 
     attr_accessor :method
 
     # Attribute mapping from ruby-style variable name to JSON key.