vpndetection 4.0.1 → 5.1.0

data/lib/vpndetection/api/organization_wire_api.rb

@@ -0,0 +1,136 @@
+=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.15
+Contact: support@vpndetection.io
+Generated by: https://openapi-generator.tech
+Generator version: 7.25.0
+
+=end
+
+require 'cgi'
+
+module VPNDetection
+  class OrganizationWireApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Organization
+    # The organization this credential is scoped to.  There is no way to name a different one. A credential describes exactly one organization, so an identifier in the path could only ever be your own or a refusal. 
+    # @param [Hash] opts the optional parameters
+    # @return [AccountOrgWrap]
+    def account_org(opts = {})
+      data, _status_code, _headers = account_org_with_http_info(opts)
+      data
+    end
+
+    # Organization
+    # The organization this credential is scoped to.  There is no way to name a different one. A credential describes exactly one organization, so an identifier in the path could only ever be your own or a refusal. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AccountOrgWrap, Integer, Hash)>] AccountOrgWrap data, response status code and response headers
+    def account_org_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: OrganizationWireApi.account_org ...'
+      end
+      # resource path
+      local_var_path = '/api/v1/iam/org'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AccountOrgWrap'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"OrganizationWireApi.account_org",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: OrganizationWireApi#account_org\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Members
+    # Read-only. Adding or removing a member is an invitation flow with email in the middle rather than a POST, and modelling it as one here would promise something this API does not do. 
+    # @param [Hash] opts the optional parameters
+    # @return [AccountRc]
+    def account_org_members(opts = {})
+      data, _status_code, _headers = account_org_members_with_http_info(opts)
+      data
+    end
+
+    # Members
+    # Read-only. Adding or removing a member is an invitation flow with email in the middle rather than a POST, and modelling it as one here would promise something this API does not do. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AccountRc, Integer, Hash)>] AccountRc data, response status code and response headers
+    def account_org_members_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: OrganizationWireApi.account_org_members ...'
+      end
+      # resource path
+      local_var_path = '/api/v1/iam/org/members'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AccountRc'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"OrganizationWireApi.account_org_members",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: OrganizationWireApi#account_org_members\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

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

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

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

data/lib/vpndetection/client.rb

@@ -9,6 +9,9 @@ module VPNDetection
   DEFAULT_CONCURRENCY = 8
   DEFAULT_RETRIES = 2
   DEFAULT_TIMEOUT = 10
+  # The most addresses POST /batch takes in one call; a larger batch is sent in
+  # chunks of this size.
+  BATCH_MAX = 1000
 
   # A client for the VPNDetection API.
   #
@@ -23,7 +26,7 @@ module VPNDetection
     #   address.
     # @param cache [Boolean] pass false to disable caching.
     # @param cache_ttl [Numeric] how long an answer stays fresh, in seconds.
-    # @param concurrency [Integer] in-flight requests during a batch.
+    # @param concurrency [Integer] batch requests - chunks of up to 1000 addresses - in flight during a batch.
     # @param retries [Integer] extra attempts for a transient failure.
     # @param transport [Transport, nil] override the HTTP layer, mostly for tests.
     def initialize(api_key: nil, base_url: DEFAULT_BASE_URL, cache: true,
@@ -87,7 +90,7 @@ module VPNDetection
     #
     # Named for what it answers rather than `me`, which sits one letter from
     # {#my_ip} and means something quite different: one is which address you are
-    # calling FROM, the other is which account you are calling AS.
+    # calling FROM, the other is what the key you are calling WITH may spend.
     #
     # Unlike a lookup there is no useful unauthenticated answer, so a client
     # built without an API key gets an unauthorized error rather than a partial
@@ -101,20 +104,26 @@ module VPNDetection
     # Deliberately NOT cached: the whole point is what has been spent, and a
     # cached answer is a wrong one within seconds of the next request.
     #
-    # @return [AccountMe]
-    def my_account(retries: nil)
+    # @return [Entitlement]
+    def my_entitlement(retries: nil)
       Retries.with_retries(retries || @retries) do
-        Transport.account_result(@transport.account_request.run)
+        Transport.entitlement_result(@transport.entitlement_request.run)
       end
     end
 
-    # Classify many addresses in parallel.
+    # Classify many addresses in as few requests as possible.
     #
-    # Keyed by address rather than positional, so duplicates in the input
-    # collapse to a single request and the caller never has to line two lists
-    # up. An address that fails carries its error as its value, so one bad entry
-    # cannot lose the rest of the answers.
+    # Bogons are answered locally and cached answers are reused; everything else
+    # goes to the batch endpoint in chunks of up to 1000 addresses, with at most
+    # `concurrency` chunks in flight. Keyed by address rather than positional, so
+    # duplicates in the input collapse to a single entry and the caller never has
+    # to line two lists up. An address that fails carries its error as its value,
+    # so one bad entry cannot lose the rest of the answers: the API reports a
+    # per-entry failure with the status the single lookup would have answered,
+    # and a chunk that fails as a whole marks every address in it.
     #
+    # @param concurrency [Integer, nil] chunks in flight, for THIS batch only.
+    # @param retries [Integer, nil] extra attempts for a failed chunk, for THIS batch only.
     # @return [Hash{String => Result, Error}] in the order the addresses were given
     def lookup_batch(ips, concurrency: nil, retries: nil)
       addresses = ips.to_a.uniq
@@ -126,7 +135,8 @@ module VPNDetection
         hit.nil? ? pending << ip : answers[ip] = hit
       end
       unless pending.empty?
-        run_batch(pending, answers, concurrency || @concurrency, retries || @retries)
+        run_batch(pending.each_slice(BATCH_MAX).to_a, answers,
+                  concurrency || @concurrency, retries || @retries)
       end
 
       # Reinstated in input order: a hydra settles in completion order, and a
@@ -138,37 +148,58 @@ module VPNDetection
 
     # One hydra per call, sized for THIS call. Reusing an instance-level hydra
     # would silently cap a per-call concurrency at the client's setting, and
-    # would not be safe to drive from two threads either.
-    def run_batch(pending, answers, concurrency, retries)
+    # would not be safe to drive from two threads either. Each request is one
+    # chunk of up to 1000 addresses.
+    def run_batch(chunks, answers, concurrency, retries)
       hydra = Typhoeus::Hydra.new(max_concurrency: concurrency)
       attempts = Hash.new(0)
 
-      enqueue = lambda do |ip|
-        request = @transport.lookup_request(ip)
+      enqueue = lambda do |chunk|
+        request = @transport.batch_request(chunk)
         request.on_complete do |response|
-          outcome = settle(ip, response, attempts, retries, enqueue)
-          answers[ip] = outcome unless outcome.nil?
+          outcome = settle(chunk, response, attempts, retries, enqueue)
+          answers.merge!(outcome) unless outcome.nil?
         end
         hydra.queue(request)
       end
 
-      pending.each { |ip| enqueue.call(ip) }
+      chunks.each { |chunk| enqueue.call(chunk) }
       hydra.run
     end
 
-    def settle(ip, response, attempts, retries, enqueue)
-      result = Transport.lookup_result(response)
-      @cache&.set(ip, result)
-      result
+    # One POST /batch, mapped back onto the addresses it was asked about. A
+    # chunk-level failure - the call refused, the transport failing, the retries
+    # exhausted - becomes every address's error, exactly as it would have been
+    # had each been looked up alone.
+    def settle(chunk, response, attempts, retries, enqueue)
+      body = Transport.batch_body(response)
+      chunk.to_h do |ip|
+        answer = batch_answer(ip, body)
+        @cache&.set(ip, answer) if answer.is_a?(Result)
+        [ip, answer]
+      end
     rescue Error => e
-      return e unless e.retryable? && attempts[ip] < retries
+      return chunk.to_h { |ip| [ip, e] } unless e.retryable? && attempts[chunk] < retries
 
-      attempts[ip] += 1
+      attempts[chunk] += 1
       # Sleeping here stalls the whole hydra, which is what a server-supplied
       # delay asks for: it is telling every request to this host to back off.
-      sleep(Retries.delay_for(e, attempts[ip]))
-      enqueue.call(ip)
+      sleep(Retries.delay_for(e, attempts[chunk]))
+      enqueue.call(chunk)
       nil
     end
+
+    # Every address lands in exactly one of `results` and `errors`; an address in
+    # neither is the server breaking its own contract, and is reported as such
+    # rather than lost.
+    def batch_answer(ip, body)
+      if (served = body['results'][ip])
+        Result.new(served)
+      elsif (failed = body['errors'][ip])
+        Error.from_entry(failed['status'], failed['error'])
+      else
+        Error.new(:server_error, "the batch answer did not include #{ip}", status: 200)
+      end
+    end
   end
 end

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

data/lib/vpndetection/errors.rb

@@ -67,6 +67,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)

data/lib/vpndetection/models/account_create_apikey_request.rb

@@ -0,0 +1,177 @@
+=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.15
+Contact: support@vpndetection.io
+Generated by: https://openapi-generator.tech
+Generator version: 7.25.0
+
+=end
+
+require 'date'
+require 'time'
+
+module VPNDetection
+  class AccountCreateApikeyRequest < ApiModelBase
+    # A label you will recognise later. Shown wherever the key is listed.
+    attr_accessor :name
+
+    # What the new key may do. Omit for a key that carries no named scope, which is the safe default.
+    attr_accessor :allowed_scopes
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'allowed_scopes' => :'allowed_scopes'
+      }
+    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
+      {
+        :'name' => :'String',
+        :'allowed_scopes' => :'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::AccountCreateApikeyRequest` 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::AccountCreateApikeyRequest`. 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?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'allowed_scopes')
+        if (value = attributes[:'allowed_scopes']).is_a?(Array)
+          self.allowed_scopes = value
+        end
+      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 @name.nil?
+        invalid_properties.push('invalid value for "name", name 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 @name.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      @name = name
+    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 &&
+          name == o.name &&
+          allowed_scopes == o.allowed_scopes
+    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
+      [name, allowed_scopes].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