avm_client 1.0.0

data/lib/avm_client/models/energy_rating.rb

@@ -0,0 +1,42 @@
+=begin
+#AVM
+
+#This is api for AVM (automated valuation machine)
+
+The version of the AvmClient document: 1.0.0
+Contact: info@enbisys.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.3
+
+=end
+
+require 'date'
+
+module AvmClient
+  class EnergyRating
+    A = "A".freeze
+    B = "B".freeze
+    C = "C".freeze
+    D = "D".freeze
+    E = "E".freeze
+    F = "F".freeze
+    G = "G".freeze
+    I = "I".freeze
+
+    # 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)
+      constantValues = EnergyRating.constants.select { |c| EnergyRating::const_get(c) == value }
+      raise "Invalid ENUM value #{value} for class #EnergyRating" if constantValues.empty?
+      value
+    end
+  end
+end

data/lib/avm_client/models/floor_level.rb

@@ -0,0 +1,59 @@
+=begin
+#AVM
+
+#This is api for AVM (automated valuation machine)
+
+The version of the AvmClient document: 1.0.0
+Contact: info@enbisys.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.3
+
+=end
+
+require 'date'
+
+module AvmClient
+  class FloorLevel
+    BASEMENT = "basement".freeze
+    GROUND = "ground".freeze
+    MIDDLE = "middle".freeze
+    TOP = "top".freeze
+    FLOOR_1 = "floor_1".freeze
+    FLOOR_2 = "floor_2".freeze
+    FLOOR_3 = "floor_3".freeze
+    FLOOR_4 = "floor_4".freeze
+    FLOOR_5 = "floor_5".freeze
+    FLOOR_6 = "floor_6".freeze
+    FLOOR_7 = "floor_7".freeze
+    FLOOR_8 = "floor_8".freeze
+    FLOOR_9 = "floor_9".freeze
+    FLOOR_10 = "floor_10".freeze
+    FLOOR_11 = "floor_11".freeze
+    FLOOR_12 = "floor_12".freeze
+    FLOOR_13 = "floor_13".freeze
+    FLOOR_14 = "floor_14".freeze
+    FLOOR_15 = "floor_15".freeze
+    FLOOR_16 = "floor_16".freeze
+    FLOOR_17 = "floor_17".freeze
+    FLOOR_18 = "floor_18".freeze
+    FLOOR_19 = "floor_19".freeze
+    FLOOR_20 = "floor_20".freeze
+    FLOOR_21_OR_ABOVE = "floor_21_or_above".freeze
+
+    # 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)
+      constantValues = FloorLevel.constants.select { |c| FloorLevel::const_get(c) == value }
+      raise "Invalid ENUM value #{value} for class #FloorLevel" if constantValues.empty?
+      value
+    end
+  end
+end

data/lib/avm_client/models/leasehold_or_freehold.rb

@@ -0,0 +1,36 @@
+=begin
+#AVM
+
+#This is api for AVM (automated valuation machine)
+
+The version of the AvmClient document: 1.0.0
+Contact: info@enbisys.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.3
+
+=end
+
+require 'date'
+
+module AvmClient
+  class LeaseholdOrFreehold
+    FREEHOLD = "freehold".freeze
+    LEASEHOLD = "leasehold".freeze
+
+    # 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)
+      constantValues = LeaseholdOrFreehold.constants.select { |c| LeaseholdOrFreehold::const_get(c) == value }
+      raise "Invalid ENUM value #{value} for class #LeaseholdOrFreehold" if constantValues.empty?
+      value
+    end
+  end
+end

data/lib/avm_client/models/new_or_resale.rb

@@ -0,0 +1,36 @@
+=begin
+#AVM
+
+#This is api for AVM (automated valuation machine)
+
+The version of the AvmClient document: 1.0.0
+Contact: info@enbisys.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.3
+
+=end
+
+require 'date'
+
+module AvmClient
+  class NewOrResale
+    NEW = "new".freeze
+    RESALE = "resale".freeze
+
+    # 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)
+      constantValues = NewOrResale.constants.select { |c| NewOrResale::const_get(c) == value }
+      raise "Invalid ENUM value #{value} for class #NewOrResale" if constantValues.empty?
+      value
+    end
+  end
+end

data/lib/avm_client/models/problem.rb

@@ -0,0 +1,264 @@
+=begin
+#AVM
+
+#This is api for AVM (automated valuation machine)
+
+The version of the AvmClient document: 1.0.0
+Contact: info@enbisys.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.3
+
+=end
+
+require 'date'
+
+module AvmClient
+  # A Problem Details object (RFC 7807)
+  class Problem
+    # A relative URI reference that identifies the problem type. When dereferenced, it SHOULD provide human-readable documentation for the problem type (e.g. using HTML).
+    attr_accessor :type
+
+    # A short, summary of the problem type. Written in english and readable for engineers (usually not suited for non technical stakeholders and not localized)
+    attr_accessor :title
+
+    # The HTTP status code generated by the origin server for this occurrence of the problem.
+    attr_accessor :status
+
+    # A human-readable explanation specific to this occurrence of the problem
+    attr_accessor :detail
+
+    # A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
+    attr_accessor :instance
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'type' => :'type',
+        :'title' => :'title',
+        :'status' => :'status',
+        :'detail' => :'detail',
+        :'instance' => :'instance'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.avm_types
+      {
+        :'type' => :'String',
+        :'title' => :'String',
+        :'status' => :'Integer',
+        :'detail' => :'String',
+        :'instance' => :'String'
+      }
+    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 `AvmClient::Problem` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `AvmClient::Problem`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = 'about:blank'
+      end
+
+      if attributes.key?(:'title')
+        self.title = attributes[:'title']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'detail')
+        self.detail = attributes[:'detail']
+      end
+
+      if attributes.key?(:'instance')
+        self.instance = attributes[:'instance']
+      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
+      invalid_properties = Array.new
+      if !@status.nil? && @status >= 600
+        invalid_properties.push('invalid value for "status", must be smaller than 600.')
+      end
+
+      if !@status.nil? && @status < 400
+        invalid_properties.push('invalid value for "status", must be greater than or equal to 400.')
+      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?
+      return false if !@status.nil? && @status >= 600
+      return false if !@status.nil? && @status < 400
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] status Value to be assigned
+    def status=(status)
+      if !status.nil? && status >= 600
+        fail ArgumentError, 'invalid value for "status", must be smaller than 600.'
+      end
+
+      if !status.nil? && status < 400
+        fail ArgumentError, 'invalid value for "status", must be greater than or equal to 400.'
+      end
+
+      @status = status
+    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 &&
+          type == o.type &&
+          title == o.title &&
+          status == o.status &&
+          detail == o.detail &&
+          instance == o.instance
+    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
+      [type, title, status, detail, instance].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)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.avm_types.each_pair do |key, type|
+        if 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[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        AvmClient.const_get(type).build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_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)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end

data/lib/avm_client/models/property_features.rb

@@ -0,0 +1,210 @@
+=begin
+#AVM
+
+#This is api for AVM (automated valuation machine)
+
+The version of the AvmClient document: 1.0.0
+Contact: info@enbisys.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.3
+
+=end
+
+require 'date'
+
+module AvmClient
+  class PropertyFeatures
+    attr_accessor :required_features
+
+    attr_accessor :additional_features
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'required_features' => :'requiredFeatures',
+        :'additional_features' => :'additionalFeatures'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.avm_types
+      {
+        :'required_features' => :'RequiredFeatures',
+        :'additional_features' => :'AdditionalFeatures'
+      }
+    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 `AvmClient::PropertyFeatures` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `AvmClient::PropertyFeatures`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'required_features')
+        self.required_features = attributes[:'required_features']
+      end
+
+      if attributes.key?(:'additional_features')
+        self.additional_features = attributes[:'additional_features']
+      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
+      invalid_properties = Array.new
+      if @required_features.nil?
+        invalid_properties.push('invalid value for "required_features", required_features 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?
+      return false if @required_features.nil?
+      true
+    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 &&
+          required_features == o.required_features &&
+          additional_features == o.additional_features
+    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
+      [required_features, additional_features].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)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.avm_types.each_pair do |key, type|
+        if 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[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        AvmClient.const_get(type).build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_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)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end

data/lib/avm_client/models/property_type.rb

@@ -0,0 +1,38 @@
+=begin
+#AVM
+
+#This is api for AVM (automated valuation machine)
+
+The version of the AvmClient document: 1.0.0
+Contact: info@enbisys.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.3
+
+=end
+
+require 'date'
+
+module AvmClient
+  class PropertyType
+    FLAT = "flat".freeze
+    SEMI_DETACHED_HOUSE = "semi_detached_house".freeze
+    DETACHED_HOUSE = "detached_house".freeze
+    TERRACED_HOUSE = "terraced_house".freeze
+
+    # 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)
+      constantValues = PropertyType.constants.select { |c| PropertyType::const_get(c) == value }
+      raise "Invalid ENUM value #{value} for class #PropertyType" if constantValues.empty?
+      value
+    end
+  end
+end