vpndetection 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82db389580885df117745fbef0d540728daf6f3628e6a03945fc7b5b912935f4
-  data.tar.gz: 8f8a3c8f07f52d1f8f0fc875260b8ac2380353a739116982234be415a03dc82c
+  metadata.gz: d80c8ce32eeb125e13622a5edae6ea738396941432e2d1d666872b5d1f1caff5
+  data.tar.gz: b895a219283c89c84690405ad7bd7719175d7e4303885e05de9325a1f273c785
 SHA512:
-  metadata.gz: 910c251330b89bba4cc317fd29e572c37d20fb62226012a259a4dfdd659c6aa9fed111d3dfa2c74ce5585640069ba11764c0a416716fc8dc10d555ce2f532f4d
-  data.tar.gz: fdeb0cac2780aef06da6faccd5409f74efd0d0b0f50ac23c53af4fdedbee6316fad80c715302491a655545e7afb00b6ea39528acbed4a0ed6357e35c24edf2dc
+  metadata.gz: 579cb6d0adcd24b1e83b8bcca8d9aefcde2c5f2ff99a0534cf447a397a133942bdeab4c41245cc541c9e46e6c193601e850a02a70c1e0e29ba79d6dcd0d77f82
+  data.tar.gz: efb8371a1b228608ebc835bf15fd7942004b9aabca5668c6cc0d471e26ddcce5367e9daa2e376bb57934ed67e509aad521754981481c94d65c335ef42a673807

data/lib/vpndetection/api/database_wire_api.rb

@@ -22,7 +22,7 @@ module VPNDetection
     # Checksums
     # Checksums for one published file, so a download can be verified after it lands. 
     # @param id [String] 
-    # @param format [String] 
+    # @param format [DatabaseFormat] 
     # @param [Hash] opts the optional parameters
     # @return [DatabaseChecksumsResponse]
     def database_checksum(id, format, opts = {})
@@ -33,7 +33,7 @@ module VPNDetection
     # Checksums
     # Checksums for one published file, so a download can be verified after it lands. 
     # @param id [String] 
-    # @param format [String] 
+    # @param format [DatabaseFormat] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(DatabaseChecksumsResponse, Integer, Hash)>] DatabaseChecksumsResponse data, response status code and response headers
     def database_checksum_with_http_info(id, format, opts = {})
@@ -48,11 +48,6 @@ module VPNDetection
       if @api_client.config.client_side_validation && format.nil?
         fail ArgumentError, "Missing the required parameter 'format' when calling DatabaseWireApi.database_checksum"
       end
-      # verify enum value
-      allowable_values = ["csvgz", "mmdb"]
-      if @api_client.config.client_side_validation && !allowable_values.include?(format)
-        fail ArgumentError, "invalid value for \"format\", must be one of #{allowable_values}"
-      end
       # resource path
       local_var_path = '/api/v1/database/checksum'
 
@@ -96,7 +91,7 @@ module VPNDetection
     end
 
     # Metadata
-    # Poll this to decide whether today's build is worth fetching: it carries `updated` and `entries` without downloading anything.  No `format` parameter - one document describes every format the dataset is built in. 
+    # Poll this to decide whether today's build is worth fetching: it carries `updated` and `entries` without downloading anything.  No `format` parameter - one document describes every format the database is built in. 
     # @param id [String] 
     # @param [Hash] opts the optional parameters
     # @return [DatabaseMetadata]
@@ -106,7 +101,7 @@ module VPNDetection
     end
 
     # Metadata
-    # Poll this to decide whether today&#39;s build is worth fetching: it carries &#x60;updated&#x60; and &#x60;entries&#x60; without downloading anything.  No &#x60;format&#x60; parameter - one document describes every format the dataset is built in. 
+    # Poll this to decide whether today&#39;s build is worth fetching: it carries &#x60;updated&#x60; and &#x60;entries&#x60; without downloading anything.  No &#x60;format&#x60; parameter - one document describes every format the database is built in. 
     # @param id [String] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(DatabaseMetadata, Integer, Hash)>] DatabaseMetadata data, response status code and response headers
@@ -162,7 +157,7 @@ module VPNDetection
     # Download
     # Answers `302` with a time-limited URL pointing straight at object storage. Follow the redirect; the link authorizes the START of a transfer, so one already running is not interrupted when it lapses. 
     # @param id [String] Dataset id, e.g. vpn_ip_extended_v1
-    # @param format [String] Not every dataset is built in every format. The &#x60;_provider&#x60; catalogues are keyed by provider id rather than by IP range, so no MMDB exists for them. 
+    # @param format [DatabaseFormat] Not every database is built in every format. The &#x60;_provider&#x60; catalogues are keyed by provider id rather than by IP range, so no MMDB exists for them. 
     # @param [Hash] opts the optional parameters
     # @return [nil]
     def download_database(id, format, opts = {})
@@ -173,7 +168,7 @@ module VPNDetection
     # Download
     # Answers &#x60;302&#x60; with a time-limited URL pointing straight at object storage. Follow the redirect; the link authorizes the START of a transfer, so one already running is not interrupted when it lapses. 
     # @param id [String] Dataset id, e.g. vpn_ip_extended_v1
-    # @param format [String] Not every dataset is built in every format. The &#x60;_provider&#x60; catalogues are keyed by provider id rather than by IP range, so no MMDB exists for them. 
+    # @param format [DatabaseFormat] Not every database is built in every format. The &#x60;_provider&#x60; catalogues are keyed by provider id rather than by IP range, so no MMDB exists for them. 
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
     def download_database_with_http_info(id, format, opts = {})
@@ -188,11 +183,6 @@ module VPNDetection
       if @api_client.config.client_side_validation && format.nil?
         fail ArgumentError, "Missing the required parameter 'format' when calling DatabaseWireApi.download_database"
       end
-      # verify enum value
-      allowable_values = ["csvgz", "mmdb"]
-      if @api_client.config.client_side_validation && !allowable_values.include?(format)
-        fail ArgumentError, "invalid value for \"format\", must be one of #{allowable_values}"
-      end
       # resource path
       local_var_path = '/api/v1/database/download'
 
@@ -236,7 +226,7 @@ module VPNDetection
     end
 
     # List
-    # Every dataset this organization holds a licence for, with the term and the license_type right beside each one. 
+    # Every database this organization holds a licence for, with the term and the license_type right beside each one. 
     # @param [Hash] opts the optional parameters
     # @return [DatabaseList]
     def list_databases(opts = {})
@@ -245,7 +235,7 @@ module VPNDetection
     end
 
     # List
-    # Every dataset this organization holds a licence for, with the term and the license_type right beside each one. 
+    # Every database this organization holds a licence for, with the term and the license_type right beside each one. 
     # @param [Hash] opts the optional parameters
     # @return [Array<(DatabaseList, Integer, Hash)>] DatabaseList data, response status code and response headers
     def list_databases_with_http_info(opts = {})

data/lib/vpndetection/api/lookup_wire_api.rb

@@ -81,5 +81,62 @@ module VPNDetection
       end
       return data, status_code, headers
     end
+
+    # Lookup your own address
+    # Answers what is known about the address this request came from, which is the same answer `GET /{ip}` gives for that address: the plan behind the presented key decides which fields come back, and the request counts against the same allowance.  The address is the one our edge observed, so a request through a proxy or a VPN reports the exit it left through rather than the machine that made it. That is usually the point of asking. 
+    # @param [Hash] opts the optional parameters
+    # @return [LookupResponse]
+    def lookup_my_ip(opts = {})
+      data, _status_code, _headers = lookup_my_ip_with_http_info(opts)
+      data
+    end
+
+    # Lookup your own address
+    # Answers what is known about the address this request came from, which is the same answer `GET /{ip}` gives for that address: the plan behind the presented key decides which fields come back, and the request counts against the same allowance.  The address is the one our edge observed, so a request through a proxy or a VPN reports the exit it left through rather than the machine that made it. That is usually the point of asking. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(LookupResponse, Integer, Hash)>] LookupResponse data, response status code and response headers
+    def lookup_my_ip_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: LookupWireApi.lookup_my_ip ...'
+      end
+      # resource path
+      local_var_path = '/myip'
+
+      # 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] || 'LookupResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKeyQuery', 'bearerAuth', 'apiKeyHeader']
+
+      new_options = opts.merge(
+        :operation => :"LookupWireApi.lookup_my_ip",
+        :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: LookupWireApi#lookup_my_ip\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end

data/lib/vpndetection/models/database.rb

@@ -14,16 +14,15 @@ require 'date'
 require 'time'
 
 module VPNDetection
-  # One dataset FAMILY your organization is licensed for. A license covers the family, while a download names a specific version, so the ids you pass to the download and checksum endpoints come from `versions`. 
+  # One database FAMILY your organization is licensed for. A license covers the family, while a download names a specific version, so the ids you pass to the download and checksum endpoints come from `versions`. 
   class Database < ApiModelBase
-    # The dataset family, e.g. `vpn_ip`. What the license is held against.
+    # The database family, e.g. `vpn_ip`. What the license is held against.
     attr_accessor :base
 
     attr_accessor :name
 
     attr_accessor :summary
 
-    # What your license permits you to do with the data.
     attr_accessor :license_type
 
     attr_accessor :starts
@@ -40,7 +39,6 @@ module VPNDetection
     # False when the license has lapsed; downloads are refused.
     attr_accessor :in_term
 
-    # `licensed` is a live grant, `expired` one whose term has ended, and `unlicensed` a dataset published but never bought. 
     attr_accessor :standing
 
     # Every published version of this family. The `id` here is what the download and checksum endpoints take. 
@@ -101,13 +99,13 @@ module VPNDetection
         :'base' => :'String',
         :'name' => :'String',
         :'summary' => :'String',
-        :'license_type' => :'String',
+        :'license_type' => :'LicenseType',
         :'starts' => :'Time',
         :'expires' => :'Time',
         :'renews_at' => :'Time',
         :'notice_due_at' => :'Time',
         :'in_term' => :'Boolean',
-        :'standing' => :'String',
+        :'standing' => :'Standing',
         :'versions' => :'Array<DatabaseVersion>'
       }
     end
@@ -251,12 +249,8 @@ module VPNDetection
       return false if @name.nil?
       return false if @summary.nil?
       return false if @license_type.nil?
-      license_type_validator = EnumAttributeValidator.new('String', ["evaluation", "standard", "redistribute"])
-      return false unless license_type_validator.valid?(@license_type)
       return false if @in_term.nil?
       return false if @standing.nil?
-      standing_validator = EnumAttributeValidator.new('String', ["expired", "licensed", "unlicensed"])
-      return false unless standing_validator.valid?(@standing)
       return false if @versions.nil?
       true
     end
@@ -291,13 +285,13 @@ module VPNDetection
       @summary = summary
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] license_type Object to be assigned
+    # Custom attribute writer method with validation
+    # @param [Object] license_type Value to be assigned
     def license_type=(license_type)
-      validator = EnumAttributeValidator.new('String', ["evaluation", "standard", "redistribute"])
-      unless validator.valid?(license_type)
-        fail ArgumentError, "invalid value for \"license_type\", must be one of #{validator.allowable_values}."
+      if license_type.nil?
+        fail ArgumentError, 'license_type cannot be nil'
       end
+
       @license_type = license_type
     end
 
@@ -311,13 +305,13 @@ module VPNDetection
       @in_term = in_term
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] standing Object to be assigned
+    # Custom attribute writer method with validation
+    # @param [Object] standing Value to be assigned
     def standing=(standing)
-      validator = EnumAttributeValidator.new('String', ["expired", "licensed", "unlicensed"])
-      unless validator.valid?(standing)
-        fail ArgumentError, "invalid value for \"standing\", must be one of #{validator.allowable_values}."
+      if standing.nil?
+        fail ArgumentError, 'standing cannot be nil'
       end
+
       @standing = standing
     end
 

data/lib/vpndetection/models/database_format.rb

@@ -0,0 +1,40 @@
+=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.13
+Contact: support@vpndetection.io
+Generated by: https://openapi-generator.tech
+Generator version: 7.25.0
+
+=end
+
+require 'date'
+require 'time'
+
+module VPNDetection
+  class DatabaseFormat
+    CSVGZ = "csvgz".freeze
+    MMDB = "mmdb".freeze
+
+    def self.all_vars
+      @all_vars ||= [CSVGZ, MMDB].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if DatabaseFormat.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #DatabaseFormat"
+    end
+  end
+end

data/lib/vpndetection/models/database_format_size.rb

@@ -63,7 +63,7 @@ module VPNDetection
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'format' => :'String',
+        :'format' => :'DatabaseFormat',
         :'bytes' => :'Integer'
       }
     end
@@ -121,18 +121,16 @@ module VPNDetection
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @format.nil?
-      format_validator = EnumAttributeValidator.new('String', ["csvgz", "mmdb"])
-      return false unless format_validator.valid?(@format)
       true
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] format Object to be assigned
+    # Custom attribute writer method with validation
+    # @param [Object] format Value to be assigned
     def format=(format)
-      validator = EnumAttributeValidator.new('String', ["csvgz", "mmdb"])
-      unless validator.valid?(format)
-        fail ArgumentError, "invalid value for \"format\", must be one of #{validator.allowable_values}."
+      if format.nil?
+        fail ArgumentError, 'format cannot be nil'
       end
+
       @format = format
     end
 

data/lib/vpndetection/models/database_version.rb

@@ -15,7 +15,7 @@ require 'time'
 
 module VPNDetection
   class DatabaseVersion < ApiModelBase
-    # The versioned dataset id, e.g. `vpn_ip_v1`. Pass this to download.
+    # The versioned database id, e.g. `vpn_ip_v1`. Pass this to download.
     attr_accessor :id
 
     attr_accessor :version
@@ -27,28 +27,6 @@ module VPNDetection
     # The formats an evaluation sample is published in, if any.
     attr_accessor :sample_formats
 
-    class EnumAttributeValidator
-      attr_reader :datatype
-      attr_reader :allowable_values
-
-      def initialize(datatype, allowable_values)
-        @allowable_values = allowable_values.map do |value|
-          case datatype.to_s
-          when /Integer/i
-            value.to_i
-          when /Float/i
-            value.to_f
-          else
-            value
-          end
-        end
-      end
-
-      def valid?(value)
-        !value || allowable_values.include?(value)
-      end
-    end
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -77,7 +55,7 @@ module VPNDetection
         :'version' => :'Integer',
         :'summary' => :'String',
         :'formats' => :'Array<DatabaseFormatSize>',
-        :'sample_formats' => :'Array<String>'
+        :'sample_formats' => :'Array<DatabaseFormat>'
       }
     end
 

data/lib/vpndetection/models/license_type.rb

@@ -0,0 +1,41 @@
+=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.13
+Contact: support@vpndetection.io
+Generated by: https://openapi-generator.tech
+Generator version: 7.25.0
+
+=end
+
+require 'date'
+require 'time'
+
+module VPNDetection
+  class LicenseType
+    EVALUATION = "evaluation".freeze
+    STANDARD = "standard".freeze
+    REDISTRIBUTE = "redistribute".freeze
+
+    def self.all_vars
+      @all_vars ||= [EVALUATION, STANDARD, REDISTRIBUTE].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if LicenseType.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #LicenseType"
+    end
+  end
+end

data/lib/vpndetection/models/standing.rb

@@ -0,0 +1,41 @@
+=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.13
+Contact: support@vpndetection.io
+Generated by: https://openapi-generator.tech
+Generator version: 7.25.0
+
+=end
+
+require 'date'
+require 'time'
+
+module VPNDetection
+  class Standing
+    EXPIRED = "expired".freeze
+    LICENSED = "licensed".freeze
+    UNLICENSED = "unlicensed".freeze
+
+    def self.all_vars
+      @all_vars ||= [EXPIRED, LICENSED, UNLICENSED].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if Standing.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #Standing"
+    end
+  end
+end

data/lib/vpndetection/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module VPNDetection
-  VERSION = '2.0.0'
+  VERSION = '3.0.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vpndetection
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Mslm Dev
@@ -63,6 +63,7 @@ files:
 - lib/vpndetection/models/class_detail.rb
 - lib/vpndetection/models/database.rb
 - lib/vpndetection/models/database_checksums_response.rb
+- lib/vpndetection/models/database_format.rb
 - lib/vpndetection/models/database_format_size.rb
 - lib/vpndetection/models/database_list.rb
 - lib/vpndetection/models/database_metadata.rb
@@ -72,9 +73,11 @@ files:
 - lib/vpndetection/models/download.rb
 - lib/vpndetection/models/download_list.rb
 - lib/vpndetection/models/error_envelope.rb
+- lib/vpndetection/models/license_type.rb
 - lib/vpndetection/models/lookup_error.rb
 - lib/vpndetection/models/lookup_response.rb
 - lib/vpndetection/models/proxy_detail.rb
+- lib/vpndetection/models/standing.rb
 - lib/vpndetection/models/vpn_detail.rb
 - lib/vpndetection/result.rb
 - lib/vpndetection/retries.rb