vpndetection 4.0.1 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 164314052bfd32f74acb272ff59c077ab1a841395c9818954ea83f6b167464ce
-  data.tar.gz: e41ccca025ec996d64861e26ba7fc6c3bbcca85628d9c402dedc35f372f96f6d
+  metadata.gz: aa0cdfbbc74c41bcfe5ecb123df7dc02f4d9255229d5b96764cd3046f290004a
+  data.tar.gz: 540b91db33957765bed48ab55b3cacc10dab5b55fa8d8a91d51ad21a3cee86de
 SHA512:
-  metadata.gz: 7b65573bf40eed189922a26a7131225bf1ba805a671404dd506a23d948e4ca98b2b4bf774dbeb3bcffdc1b7821fad819c3d9d19e75dbcf8ab46470c4a8a2f26d
-  data.tar.gz: c9685a07643394cd7eef10034b740fb119bf1d16d89be927baf80f8db342e99fb0aa5ba073614196ba31d32e84c4e3ddebdf594e9d919afac193e38c78326e1b
+  metadata.gz: 020525503bb0410d9c9a79b04230b6ce2956798813583d7dee1dd4f92c3f00cee496a273a5d8a4db240a1661d19674d939e8c0ceb9a2949669c2793eb3170a97
+  data.tar.gz: c0071cc728e2a67f3da1e6c33974ef223bc46e8b96057ea4a013909f408fc781246ba9ec4216ec35bd34001428d004f0d7709ea9957dac2689398b8c27349e15

data/README.md

@@ -48,6 +48,26 @@ result.is_hosting           # => true
 result.hosting['provider']  # => "M247"
 ```
 
+### Your own address
+
+```ruby
+result = client.my_ip
+result.ip   # => the address we saw this call come from
+```
+
+Same answer `lookup` would give for that address, and the same cost against your allowance. It is deliberately not cached: which address you are is the whole question, and a machine that moves between networks would otherwise be told where it used to be.
+
+### Your plan and usage
+
+```ruby
+acct = client.my_entitlement
+acct.plan.key          # => "max"
+acct.usage.requests    # => 580
+acct.usage.window_end  # => when the allowance resets
+```
+
+Usage counts against the anniversary of your subscription, not the calendar month and not the billing period, and it is the same number a lookup is gated on. `hard_limit` is `nil` on an uncapped plan, which is not the same as zero.
+
 ### Batch lookup
 
 You can do batch lookups with a list, which parallelizes requests for you efficiently:

data/lib/vpndetection/api/account_wire_api.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
@@ -19,25 +19,25 @@ module VPNDetection
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Your key, plan and usage
-    # Answers what the presented key is, what plan is behind it, and what has been spent against that plan's allowance in the current window. 
+    # Identity
+    # The identity behind this credential: what it is, the organization it is scoped to, and the scopes it currently holds.  `user` is present for an OAuth token and ABSENT for an API key, which has an organization but no person behind it. `credential.kind` says which you are holding, so a client can branch without guessing from a missing field.  Narrower than what the console shows its own user on purpose: an integration needs a name to display and an organization to address, not a profile. The `scopes` array is what the credential may do RIGHT NOW, so a client can render its own capabilities rather than discovering them from a 403. 
     # @param [Hash] opts the optional parameters
-    # @return [AccountMe]
-    def account_me(opts = {})
-      data, _status_code, _headers = account_me_with_http_info(opts)
+    # @return [Identity]
+    def account_identity(opts = {})
+      data, _status_code, _headers = account_identity_with_http_info(opts)
       data
     end
 
-    # Your key, plan and usage
-    # Answers what the presented key is, what plan is behind it, and what has been spent against that plan's allowance in the current window. 
+    # Identity
+    # The identity behind this credential: what it is, the organization it is scoped to, and the scopes it currently holds.  `user` is present for an OAuth token and ABSENT for an API key, which has an organization but no person behind it. `credential.kind` says which you are holding, so a client can branch without guessing from a missing field.  Narrower than what the console shows its own user on purpose: an integration needs a name to display and an organization to address, not a profile. The `scopes` array is what the credential may do RIGHT NOW, so a client can render its own capabilities rather than discovering them from a 403. 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(AccountMe, Integer, Hash)>] AccountMe data, response status code and response headers
-    def account_me_with_http_info(opts = {})
+    # @return [Array<(Identity, Integer, Hash)>] Identity data, response status code and response headers
+    def account_identity_with_http_info(opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: AccountWireApi.account_me ...'
+        @api_client.config.logger.debug 'Calling API: AccountWireApi.account_identity ...'
       end
       # resource path
-      local_var_path = '/api/v1/account/me'
+      local_var_path = '/api/v1/iam/identity'
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -54,13 +54,13 @@ module VPNDetection
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type] || 'AccountMe'
+      return_type = opts[:debug_return_type] || 'Identity'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['apiKeyQuery', 'bearerAuth', 'apiKeyHeader']
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
 
       new_options = opts.merge(
-        :operation => :"AccountWireApi.account_me",
+        :operation => :"AccountWireApi.account_identity",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -71,7 +71,7 @@ module VPNDetection
 
       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: AccountWireApi#account_me\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: AccountWireApi#account_identity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end

data/lib/vpndetection/api/api_keys_wire_api.rb

@@ -0,0 +1,336 @@
+=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 APIKeysWireApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create
+    # Creates a key and returns its secret.  This is the ONLY response that ever carries the secret, and only because this is the moment it comes into existence. Store it now. 
+    # @param account_create_apikey_request [AccountCreateApikeyRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [AccountCreatedApikey]
+    def account_create_apikey(account_create_apikey_request, opts = {})
+      data, _status_code, _headers = account_create_apikey_with_http_info(account_create_apikey_request, opts)
+      data
+    end
+
+    # Create
+    # Creates a key and returns its secret.  This is the ONLY response that ever carries the secret, and only because this is the moment it comes into existence. Store it now. 
+    # @param account_create_apikey_request [AccountCreateApikeyRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AccountCreatedApikey, Integer, Hash)>] AccountCreatedApikey data, response status code and response headers
+    def account_create_apikey_with_http_info(account_create_apikey_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: APIKeysWireApi.account_create_apikey ...'
+      end
+      # verify the required parameter 'account_create_apikey_request' is set
+      if @api_client.config.client_side_validation && account_create_apikey_request.nil?
+        fail ArgumentError, "Missing the required parameter 'account_create_apikey_request' when calling APIKeysWireApi.account_create_apikey"
+      end
+      # resource path
+      local_var_path = '/api/v1/iam/apikeys'
+
+      # 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']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(account_create_apikey_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AccountCreatedApikey'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"APIKeysWireApi.account_create_apikey",
+        :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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: APIKeysWireApi#account_create_apikey\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List
+    # Metadata only. A key's secret is never in a list - not here and not in the console - because a list is the response that ends up in logs, caches and support tickets.  `retrievable` says whether the secret could still be read back at all. A key issued before this product stored secrets recoverably was never kept, so `reveal` will refuse it permanently; rotating produces one that can be read. 
+    # @param [Hash] opts the optional parameters
+    # @return [ApikeyList]
+    def account_list_apikeys(opts = {})
+      data, _status_code, _headers = account_list_apikeys_with_http_info(opts)
+      data
+    end
+
+    # List
+    # Metadata only. A key&#39;s secret is never in a list - not here and not in the console - because a list is the response that ends up in logs, caches and support tickets.  &#x60;retrievable&#x60; says whether the secret could still be read back at all. A key issued before this product stored secrets recoverably was never kept, so &#x60;reveal&#x60; will refuse it permanently; rotating produces one that can be read. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApikeyList, Integer, Hash)>] ApikeyList data, response status code and response headers
+    def account_list_apikeys_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: APIKeysWireApi.account_list_apikeys ...'
+      end
+      # resource path
+      local_var_path = '/api/v1/iam/apikeys'
+
+      # 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] || 'ApikeyList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"APIKeysWireApi.account_list_apikeys",
+        :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: APIKeysWireApi#account_list_apikeys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Reveal
+    # Returns an existing key's secret.  Its own scope rather than part of `apikeys.manage`, because the two are different acts: rotating replaces a secret you never see, while this hands one over.  Refused with `NOT_RETRIEVABLE` for a key issued before this product stored secrets recoverably - that secret was never kept, so no retry will ever produce it. Rotate the key instead. 
+    # @param id [String] The key&#39;s id, as returned by the list endpoint. Never the key itself.
+    # @param [Hash] opts the optional parameters
+    # @return [AccountRevealedApikey]
+    def account_reveal_apikey(id, opts = {})
+      data, _status_code, _headers = account_reveal_apikey_with_http_info(id, opts)
+      data
+    end
+
+    # Reveal
+    # Returns an existing key&#39;s secret.  Its own scope rather than part of &#x60;apikeys.manage&#x60;, because the two are different acts: rotating replaces a secret you never see, while this hands one over.  Refused with &#x60;NOT_RETRIEVABLE&#x60; for a key issued before this product stored secrets recoverably - that secret was never kept, so no retry will ever produce it. Rotate the key instead. 
+    # @param id [String] The key&#39;s id, as returned by the list endpoint. Never the key itself.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AccountRevealedApikey, Integer, Hash)>] AccountRevealedApikey data, response status code and response headers
+    def account_reveal_apikey_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: APIKeysWireApi.account_reveal_apikey ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling APIKeysWireApi.account_reveal_apikey"
+      end
+      # resource path
+      local_var_path = '/api/v1/iam/apikeys/{id}/reveal'.sub('{id}', CGI.escape(id.to_s))
+
+      # 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] || 'AccountRevealedApikey'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"APIKeysWireApi.account_reveal_apikey",
+        :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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: APIKeysWireApi#account_reveal_apikey\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Revoke
+    # Stops the key working. Revocation is soft: the key stays listed with a `revoked_at`, because the organization still owns whatever it did while it was alive. 
+    # @param id [String] The key&#39;s id, as returned by the list endpoint. Never the key itself.
+    # @param [Hash] opts the optional parameters
+    # @return [AccountRc]
+    def account_revoke_apikey(id, opts = {})
+      data, _status_code, _headers = account_revoke_apikey_with_http_info(id, opts)
+      data
+    end
+
+    # Revoke
+    # Stops the key working. Revocation is soft: the key stays listed with a &#x60;revoked_at&#x60;, because the organization still owns whatever it did while it was alive. 
+    # @param id [String] The key&#39;s id, as returned by the list endpoint. Never the key itself.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AccountRc, Integer, Hash)>] AccountRc data, response status code and response headers
+    def account_revoke_apikey_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: APIKeysWireApi.account_revoke_apikey ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling APIKeysWireApi.account_revoke_apikey"
+      end
+      # resource path
+      local_var_path = '/api/v1/iam/apikeys/{id}/revoke'.sub('{id}', CGI.escape(id.to_s))
+
+      # 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 => :"APIKeysWireApi.account_revoke_apikey",
+        :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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: APIKeysWireApi#account_revoke_apikey\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Rotate
+    # Replaces the secret behind a key, keeping its id, name and settings. The previous secret stops working immediately. 
+    # @param id [String] The key&#39;s id, as returned by the list endpoint. Never the key itself.
+    # @param [Hash] opts the optional parameters
+    # @return [AccountCreatedApikey]
+    def account_rotate_apikey(id, opts = {})
+      data, _status_code, _headers = account_rotate_apikey_with_http_info(id, opts)
+      data
+    end
+
+    # Rotate
+    # Replaces the secret behind a key, keeping its id, name and settings. The previous secret stops working immediately. 
+    # @param id [String] The key&#39;s id, as returned by the list endpoint. Never the key itself.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AccountCreatedApikey, Integer, Hash)>] AccountCreatedApikey data, response status code and response headers
+    def account_rotate_apikey_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: APIKeysWireApi.account_rotate_apikey ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling APIKeysWireApi.account_rotate_apikey"
+      end
+      # resource path
+      local_var_path = '/api/v1/iam/apikeys/{id}/rotate'.sub('{id}', CGI.escape(id.to_s))
+
+      # 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] || 'AccountCreatedApikey'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"APIKeysWireApi.account_rotate_apikey",
+        :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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: APIKeysWireApi#account_rotate_apikey\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end