vpndetection 5.0.0 → 5.2.0

data/lib/vpndetection/errors.rb

@@ -38,25 +38,26 @@ module VPNDetection
     def self.from_status(status, headers, body, message: nil)
       message ||= message_of(body) || "request failed with status #{status}"
       retry_after = parse_retry_after(header(headers, 'retry-after'))
+      kind = kind_for(status, headers)
 
+      new(kind, message, status: status, retry_after_seconds: kind == :rate_limited ? retry_after : nil)
+    end
+
+    # What a response with this status is, whatever its body says.
+    def self.kind_for(status, headers)
       case status
-      when 429
-        # Present means transient, absent means an allowance is spent. Nothing
-        # else in the response separates the two.
-        if retry_after.nil?
-          new(:quota_exceeded, message, status: status)
-        else
-          new(:rate_limited, message, status: status, retry_after_seconds: retry_after)
-        end
-      when 400 then new(:bad_request, message, status: status)
-      when 401 then new(:unauthorized, message, status: status)
-      when 403 then new(:forbidden, message, status: status)
+      # Present means transient, absent means an allowance is spent. Nothing
+      # else in the response separates the two.
+      when 429 then parse_retry_after(header(headers, 'retry-after')).nil? ? :quota_exceeded : :rate_limited
+      when 400 then :bad_request
+      when 401 then :unauthorized
+      when 403 then :forbidden
       # Every other 4xx is a CLIENT error. Classifying on the RANGE rather than
       # on an enumerated list is what keeps a 404 from a bad dataset id falling
       # through to the retryable server_error default and being retried twice
       # before it fails.
-      when 400..499 then new(:bad_request, message, status: status)
-      else new(:server_error, message, status: status)
+      when 400..499 then :bad_request
+      else :server_error
       end
     end
 
@@ -67,6 +68,13 @@ module VPNDetection
       new(:network, message)
     end
 
+    # A per-entry failure inside a successful batch: the status the single lookup
+    # would have answered, and its message, with no headers at all - so a 429
+    # here is a spent allowance, which is the only kind the API puts in an entry.
+    def self.from_entry(status, message)
+      from_status(status.to_i, {}, nil, message: message.to_s)
+    end
+
     # Case-insensitive, and works with a plain Hash as well as with the
     # case-blind header object Typhoeus builds from a live response.
     def self.header(headers, name)
@@ -104,4 +112,44 @@ module VPNDetection
 
     private_class_method :header, :message_of, :parse_retry_after
   end
+
+  # The authorization server refusing an OAuth request: a 4xx whose body names an
+  # RFC 6749 `error` code. Never retryable, whatever the status, because every
+  # code it can carry answers the request as it was made.
+  #
+  # Not `OauthError`: that constant is the generated model of the error body.
+  class OauthRequestError < Error
+    # The `error` code, such as `slow_down` or `invalid_grant`.
+    attr_reader :error_code
+    # `error_description` when the server sent one as a string, otherwise nil.
+    attr_reader :error_description
+
+    # The refusal a response carries, as the most specific class its code has.
+    def self.for_code(error_code, error_description, status:, headers: {})
+      klass = case error_code
+              when 'access_denied' then OauthAccessDeniedError
+              when 'expired_token' then OauthExpiredTokenError
+              else OauthRequestError
+              end
+      klass.new(error_code, error_description, kind: Error.kind_for(status, headers), status: status)
+    end
+
+    def initialize(error_code, error_description = nil, kind: :bad_request, status: nil)
+      super(kind, error_description.nil? ? error_code : "#{error_code}: #{error_description}", status: status)
+      @error_code = error_code
+      @error_description = error_description
+    end
+
+    def retryable?
+      false
+    end
+  end
+
+  # The person refused the sign-in. Their device code is spent.
+  class OauthAccessDeniedError < OauthRequestError; end
+
+  # The device code is no longer valid: it expired, or was already exchanged or
+  # refused. Raised with no status when {OauthApi#poll_device_token} reaches the
+  # code's lifetime before the server says so.
+  class OauthExpiredTokenError < OauthRequestError; end
 end

data/lib/vpndetection/models/account_create_apikey_request.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.09.15
+The version of the OpenAPI document: 2026.09.16
 Contact: support@vpndetection.io
 Generated by: https://openapi-generator.tech
 Generator version: 7.25.0

data/lib/vpndetection/models/account_created_apikey.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.09.15
+The version of the OpenAPI document: 2026.09.16
 Contact: support@vpndetection.io
 Generated by: https://openapi-generator.tech
 Generator version: 7.25.0

data/lib/vpndetection/models/account_org.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.09.15
+The version of the OpenAPI document: 2026.09.16
 Contact: support@vpndetection.io
 Generated by: https://openapi-generator.tech
 Generator version: 7.25.0

data/lib/vpndetection/models/account_org_ref.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.09.15
+The version of the OpenAPI document: 2026.09.16
 Contact: support@vpndetection.io
 Generated by: https://openapi-generator.tech
 Generator version: 7.25.0

data/lib/vpndetection/models/account_org_wrap.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.09.15
+The version of the OpenAPI document: 2026.09.16
 Contact: support@vpndetection.io
 Generated by: https://openapi-generator.tech
 Generator version: 7.25.0

data/lib/vpndetection/models/account_rc.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.09.15
+The version of the OpenAPI document: 2026.09.16
 Contact: support@vpndetection.io
 Generated by: https://openapi-generator.tech
 Generator version: 7.25.0

data/lib/vpndetection/models/account_revealed_apikey.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.09.15
+The version of the OpenAPI document: 2026.09.16
 Contact: support@vpndetection.io
 Generated by: https://openapi-generator.tech
 Generator version: 7.25.0

data/lib/vpndetection/models/account_user.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.09.15
+The version of the OpenAPI document: 2026.09.16
 Contact: support@vpndetection.io
 Generated by: https://openapi-generator.tech
 Generator version: 7.25.0

data/lib/vpndetection/models/apikey_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.09.15
+The version of the OpenAPI document: 2026.09.16
 Contact: support@vpndetection.io
 Generated by: https://openapi-generator.tech
 Generator version: 7.25.0

data/lib/vpndetection/models/apikey_list.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.09.15
+The version of the OpenAPI document: 2026.09.16
 Contact: support@vpndetection.io
 Generated by: https://openapi-generator.tech
 Generator version: 7.25.0

data/lib/vpndetection/models/batch_lookup_error.rb

@@ -0,0 +1,193 @@
+=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.09.16
+Contact: support@vpndetection.io
+Generated by: https://openapi-generator.tech
+Generator version: 7.25.0
+
+=end
+
+require 'date'
+require 'time'
+
+module VPNDetection
+  # Why one entry of a batch was not answered, as the single lookup would have reported it.
+  class BatchLookupError < ApiModelBase
+    # The HTTP status `GET /{ip}` would have answered for this entry: `400` for a string that is not an address, `429` for a spent allowance, `500` when the VPN dataset could not be consulted. A `429` here is never a throttle; the whole call is refused instead. 
+    attr_accessor :status
+
+    # The same message the single lookup carries for that status.
+    attr_accessor :error
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'status' => :'status',
+        :'error' => :'error'
+      }
+    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
+      {
+        :'status' => :'Integer',
+        :'error' => :'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::BatchLookupError` 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::BatchLookupError`. 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?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'error')
+        self.error = attributes[:'error']
+      else
+        self.error = 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 @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      if @error.nil?
+        invalid_properties.push('invalid value for "error", error 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 @status.nil?
+      return false if @error.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] status Value to be assigned
+    def status=(status)
+      if status.nil?
+        fail ArgumentError, 'status cannot be nil'
+      end
+
+      @status = status
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] error Value to be assigned
+    def error=(error)
+      if error.nil?
+        fail ArgumentError, 'error cannot be nil'
+      end
+
+      @error = error
+    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 &&
+          status == o.status &&
+          error == o.error
+    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
+      [status, error].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/batch_lookup_request.rb

@@ -0,0 +1,185 @@
+=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.09.16
+Contact: support@vpndetection.io
+Generated by: https://openapi-generator.tech
+Generator version: 7.25.0
+
+=end
+
+require 'date'
+require 'time'
+
+module VPNDetection
+  class BatchLookupRequest < ApiModelBase
+    # The addresses to classify, 1 to 1000 per call, counted before duplicates collapse. Each distinct string is one lookup. 
+    attr_accessor :ips
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'ips' => :'ips'
+      }
+    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
+      {
+        :'ips' => :'Array<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::BatchLookupRequest` 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::BatchLookupRequest`. 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?(:'ips')
+        if (value = attributes[:'ips']).is_a?(Array)
+          self.ips = value
+        end
+      else
+        self.ips = 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 @ips.nil?
+        invalid_properties.push('invalid value for "ips", ips cannot be nil.')
+      end
+
+      if @ips.length > 1000
+        invalid_properties.push('invalid value for "ips", number of items must be less than or equal to 1000.')
+      end
+
+      if @ips.length < 1
+        invalid_properties.push('invalid value for "ips", number of items must be greater than or equal to 1.')
+      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 @ips.nil?
+      return false if @ips.length > 1000
+      return false if @ips.length < 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] ips Value to be assigned
+    def ips=(ips)
+      if ips.nil?
+        fail ArgumentError, 'ips cannot be nil'
+      end
+
+      if ips.length > 1000
+        fail ArgumentError, 'invalid value for "ips", number of items must be less than or equal to 1000.'
+      end
+
+      if ips.length < 1
+        fail ArgumentError, 'invalid value for "ips", number of items must be greater than or equal to 1.'
+      end
+
+      @ips = ips
+    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 &&
+          ips == o.ips
+    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
+      [ips].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