vpndetection 1.0.0

data/lib/vpndetection/models/error_envelope.rb

@@ -0,0 +1,164 @@
+=begin
+#VPNDetection API
+
+#The VPNDetection API: classify any IP address, and download the datasets 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.04
+Contact: support@vpndetection.io
+Generated by: https://openapi-generator.tech
+Generator version: 7.25.0
+
+=end
+
+require 'date'
+require 'time'
+
+module VPNDetection
+  class ErrorEnvelope < ApiModelBase
+    attr_accessor :rc
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'rc' => :'rc'
+      }
+    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
+      {
+        :'rc' => :'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::ErrorEnvelope` 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::ErrorEnvelope`. 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?(:'rc')
+        self.rc = attributes[:'rc']
+      else
+        self.rc = 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 @rc.nil?
+        invalid_properties.push('invalid value for "rc", rc 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 @rc.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] rc Value to be assigned
+    def rc=(rc)
+      if rc.nil?
+        fail ArgumentError, 'rc cannot be nil'
+      end
+
+      @rc = rc
+    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 &&
+          rc == o.rc
+    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
+      [rc].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/licensed_dataset.rb

@@ -0,0 +1,358 @@
+=begin
+#VPNDetection API
+
+#The VPNDetection API: classify any IP address, and download the datasets 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.04
+Contact: support@vpndetection.io
+Generated by: https://openapi-generator.tech
+Generator version: 7.25.0
+
+=end
+
+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`. 
+  class LicensedDataset < ApiModelBase
+    # The dataset 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 :redistribution
+
+    attr_accessor :starts
+
+    # Null when the license does not expire.
+    attr_accessor :expires
+
+    # 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. 
+    attr_accessor :versions
+
+    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
+      {
+        :'base' => :'base',
+        :'name' => :'name',
+        :'summary' => :'summary',
+        :'redistribution' => :'redistribution',
+        :'starts' => :'starts',
+        :'expires' => :'expires',
+        :'in_term' => :'in_term',
+        :'standing' => :'standing',
+        :'versions' => :'versions'
+      }
+    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
+      {
+        :'base' => :'String',
+        :'name' => :'String',
+        :'summary' => :'String',
+        :'redistribution' => :'String',
+        :'starts' => :'Time',
+        :'expires' => :'Time',
+        :'in_term' => :'Boolean',
+        :'standing' => :'String',
+        :'versions' => :'Array<LicensedVersion>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'starts',
+        :'expires',
+      ])
+    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::LicensedDataset` 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::LicensedDataset`. 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?(:'base')
+        self.base = attributes[:'base']
+      else
+        self.base = nil
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'summary')
+        self.summary = attributes[:'summary']
+      end
+
+      if attributes.key?(:'redistribution')
+        self.redistribution = attributes[:'redistribution']
+      else
+        self.redistribution = nil
+      end
+
+      if attributes.key?(:'starts')
+        self.starts = attributes[:'starts']
+      end
+
+      if attributes.key?(:'expires')
+        self.expires = attributes[:'expires']
+      end
+
+      if attributes.key?(:'in_term')
+        self.in_term = attributes[:'in_term']
+      else
+        self.in_term = nil
+      end
+
+      if attributes.key?(:'standing')
+        self.standing = attributes[:'standing']
+      else
+        self.standing = nil
+      end
+
+      if attributes.key?(:'versions')
+        if (value = attributes[:'versions']).is_a?(Array)
+          self.versions = value
+        end
+      else
+        self.versions = 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 @base.nil?
+        invalid_properties.push('invalid value for "base", base cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @redistribution.nil?
+        invalid_properties.push('invalid value for "redistribution", redistribution cannot be nil.')
+      end
+
+      if @in_term.nil?
+        invalid_properties.push('invalid value for "in_term", in_term cannot be nil.')
+      end
+
+      if @standing.nil?
+        invalid_properties.push('invalid value for "standing", standing cannot be nil.')
+      end
+
+      if @versions.nil?
+        invalid_properties.push('invalid value for "versions", versions 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 @base.nil?
+      return false if @name.nil?
+      return false if @redistribution.nil?
+      redistribution_validator = EnumAttributeValidator.new('String', ["evaluation", "internal", "redistribute"])
+      return false unless redistribution_validator.valid?(@redistribution)
+      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
+
+    # Custom attribute writer method with validation
+    # @param [Object] base Value to be assigned
+    def base=(base)
+      if base.nil?
+        fail ArgumentError, 'base cannot be nil'
+      end
+
+      @base = base
+    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
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] redistribution Object to be assigned
+    def redistribution=(redistribution)
+      validator = EnumAttributeValidator.new('String', ["evaluation", "internal", "redistribute"])
+      unless validator.valid?(redistribution)
+        fail ArgumentError, "invalid value for \"redistribution\", must be one of #{validator.allowable_values}."
+      end
+      @redistribution = redistribution
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] in_term Value to be assigned
+    def in_term=(in_term)
+      if in_term.nil?
+        fail ArgumentError, 'in_term cannot be nil'
+      end
+
+      @in_term = in_term
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] standing Object 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}."
+      end
+      @standing = standing
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] versions Value to be assigned
+    def versions=(versions)
+      if versions.nil?
+        fail ArgumentError, 'versions cannot be nil'
+      end
+
+      @versions = versions
+    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 &&
+          base == o.base &&
+          name == o.name &&
+          summary == o.summary &&
+          redistribution == o.redistribution &&
+          starts == o.starts &&
+          expires == o.expires &&
+          in_term == o.in_term &&
+          standing == o.standing &&
+          versions == o.versions
+    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
+      [base, name, summary, redistribution, starts, expires, in_term, standing, versions].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