avm_client 1.0.0

data/lib/avm_client/configuration.rb

@@ -0,0 +1,248 @@
+=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
+
+module AvmClient
+  class Configuration
+    # Defines url scheme
+    attr_accessor :scheme
+
+    # Defines url host
+    attr_accessor :host
+
+    # Defines url base path
+    attr_accessor :base_path
+
+    # Defines API keys used with API Key authentications.
+    #
+    # @return [Hash] key: parameter name, value: parameter value (API key)
+    #
+    # @example parameter name is "api_key", API key is "xxx" (e.g. "api_key=xxx" in query string)
+    #   config.api_key['api_key'] = 'xxx'
+    attr_accessor :api_key
+
+    # Defines API key prefixes used with API Key authentications.
+    #
+    # @return [Hash] key: parameter name, value: API key prefix
+    #
+    # @example parameter name is "Authorization", API key prefix is "Token" (e.g. "Authorization: Token xxx" in headers)
+    #   config.api_key_prefix['api_key'] = 'Token'
+    attr_accessor :api_key_prefix
+
+    # Defines the username used with HTTP basic authentication.
+    #
+    # @return [String]
+    attr_accessor :username
+
+    # Defines the password used with HTTP basic authentication.
+    #
+    # @return [String]
+    attr_accessor :password
+
+    # Defines the access token (Bearer) used with OAuth2.
+    attr_accessor :access_token
+
+    # Set this to enable/disable debugging. When enabled (set to true), HTTP request/response
+    # details will be logged with `logger.debug` (see the `logger` attribute).
+    # Default to false.
+    #
+    # @return [true, false]
+    attr_accessor :debugging
+
+    # Defines the logger used for debugging.
+    # Default to `Rails.logger` (when in Rails) or logging to STDOUT.
+    #
+    # @return [#debug]
+    attr_accessor :logger
+
+    # Defines the temporary folder to store downloaded files
+    # (for API endpoints that have file response).
+    # Default to use `Tempfile`.
+    #
+    # @return [String]
+    attr_accessor :temp_folder_path
+
+    # The time limit for HTTP request in seconds.
+    # Default to 0 (never times out).
+    attr_accessor :timeout
+
+    # Set this to false to skip client side validation in the operation.
+    # Default to true.
+    # @return [true, false]
+    attr_accessor :client_side_validation
+
+    ### TLS/SSL setting
+    # Set this to false to skip verifying SSL certificate when calling API from https server.
+    # Default to true.
+    #
+    # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
+    #
+    # @return [true, false]
+    attr_accessor :verify_ssl
+
+    ### TLS/SSL setting
+    # Set this to false to skip verifying SSL host name
+    # Default to true.
+    #
+    # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
+    #
+    # @return [true, false]
+    attr_accessor :verify_ssl_host
+
+    ### TLS/SSL setting
+    # Set this to customize the certificate file to verify the peer.
+    #
+    # @return [String] the path to the certificate file
+    #
+    # @see The `cainfo` option of Typhoeus, `--cert` option of libcurl. Related source code:
+    # https://github.com/typhoeus/typhoeus/blob/master/lib/typhoeus/easy_factory.rb#L145
+    attr_accessor :ssl_ca_cert
+
+    ### TLS/SSL setting
+    # Client certificate file (for client certificate)
+    attr_accessor :cert_file
+
+    ### TLS/SSL setting
+    # Client private key file (for client certificate)
+    attr_accessor :key_file
+
+    # Set this to customize parameters encoding of array parameter with multi collectionFormat.
+    # Default to nil.
+    #
+    # @see The params_encoding option of Ethon. Related source code:
+    # https://github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96
+    attr_accessor :params_encoding
+
+    attr_accessor :inject_format
+
+    attr_accessor :force_ending_format
+
+    def initialize
+      @scheme = 'https'
+      @host = 'avm.enbisys.com/api'
+      @base_path = ''
+      @api_key = {}
+      @api_key_prefix = {}
+      @timeout = 0
+      @client_side_validation = true
+      @verify_ssl = true
+      @verify_ssl_host = true
+      @params_encoding = nil
+      @cert_file = nil
+      @key_file = nil
+      @debugging = false
+      @inject_format = false
+      @force_ending_format = false
+      @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
+
+      yield(self) if block_given?
+    end
+
+    # The default Configuration object.
+    def self.default
+      @@default ||= Configuration.new
+    end
+
+    def configure
+      yield(self) if block_given?
+    end
+
+    def scheme=(scheme)
+      # remove :// from scheme
+      @scheme = scheme.sub(/:\/\//, '')
+    end
+
+    def host=(host)
+      # remove http(s):// and anything after a slash
+      @host = host.sub(/https?:\/\//, '').split('/').first
+    end
+
+    def base_path=(base_path)
+      # Add leading and trailing slashes to base_path
+      @base_path = "/#{base_path}".gsub(/\/+/, '/')
+      @base_path = '' if @base_path == '/'
+    end
+
+    def base_url
+      "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
+    end
+
+    # Gets API key (with prefix if set).
+    # @param [String] param_name the parameter name of API key auth
+    def api_key_with_prefix(param_name)
+      if @api_key_prefix[param_name]
+        "#{@api_key_prefix[param_name]} #{@api_key[param_name]}"
+      else
+        @api_key[param_name]
+      end
+    end
+
+    # Gets Basic Auth token string
+    def basic_auth_token
+      'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
+    end
+
+    # Returns Auth Settings hash for api client.
+    def auth_settings
+      {
+        'ApiKeyAuth' =>
+          {
+            type: 'api_key',
+            in: 'header',
+            key: 'X-API-KEY',
+            value: api_key_with_prefix('X-API-KEY')
+          },
+      }
+    end
+
+    # Returns an array of Server setting
+    def server_settings
+      [
+        {
+          url: "/",
+          description: "No descriptoin provided",
+        }
+      ]
+    end
+
+    # Returns URL based on server settings
+    #
+    # @param index array index of the server settings
+    # @param variables hash of variable and the corresponding value
+    def server_url(index, variables = {})
+      servers = server_settings
+
+      # check array index out of bound
+      if (index < 0 || index >= servers.size)
+        fail ArgumentError, "Invalid index #{index} when selecting the server. Must be less than #{servers.size}"
+      end
+
+      server = servers[index]
+      url = server[:url]
+
+      # go through variable and assign a value
+      server[:variables].each do |name, variable|
+        if variables.key?(name)
+          if (server[:variables][name][:enum_values].include? variables[name])
+            url.gsub! "{" + name.to_s + "}", variables[name]
+          else
+            fail ArgumentError, "The variable `#{name}` in the server URL has invalid value #{variables[name]}. Must be #{server[:variables][name][:enum_values]}."
+          end
+        else
+          # use default value
+          url.gsub! "{" + name.to_s + "}", server[:variables][name][:default_value]
+        end
+      end
+
+      url
+    end
+  end
+end

data/lib/avm_client/models/additional_features.rb

@@ -0,0 +1,373 @@
+=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 AdditionalFeatures
+    attr_accessor :price_of_previous_sale
+
+    attr_accessor :date_of_previous_sale
+
+    attr_accessor :leasehold_or_freehold
+
+    attr_accessor :wall_type
+
+    attr_accessor :wall_insulation
+
+    attr_accessor :wall_energy_efficiency
+
+    attr_accessor :roof_type
+
+    attr_accessor :roof_insulation
+
+    attr_accessor :roof_energy_efficiency
+
+    attr_accessor :window_glazing_type
+
+    attr_accessor :window_energy_efficiency
+
+    attr_accessor :current_energy_rating
+
+    attr_accessor :potential_energy_rating
+
+    attr_accessor :annual_heating_cost_in_pounds
+
+    attr_accessor :annual_hot_water_cost_in_pounds
+
+    attr_accessor :annual_lighting_cost_in_pounds
+
+    attr_accessor :annual_energy_consumption_in_k_wh
+
+    attr_accessor :floor_height_in_foot
+
+    attr_accessor :built_form
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'price_of_previous_sale' => :'priceOfPreviousSale',
+        :'date_of_previous_sale' => :'dateOfPreviousSale',
+        :'leasehold_or_freehold' => :'leaseholdOrFreehold',
+        :'wall_type' => :'wallType',
+        :'wall_insulation' => :'wallInsulation',
+        :'wall_energy_efficiency' => :'wallEnergyEfficiency',
+        :'roof_type' => :'roofType',
+        :'roof_insulation' => :'roofInsulation',
+        :'roof_energy_efficiency' => :'roofEnergyEfficiency',
+        :'window_glazing_type' => :'windowGlazingType',
+        :'window_energy_efficiency' => :'windowEnergyEfficiency',
+        :'current_energy_rating' => :'currentEnergyRating',
+        :'potential_energy_rating' => :'potentialEnergyRating',
+        :'annual_heating_cost_in_pounds' => :'annualHeatingCostInPounds',
+        :'annual_hot_water_cost_in_pounds' => :'annualHotWaterCostInPounds',
+        :'annual_lighting_cost_in_pounds' => :'annualLightingCostInPounds',
+        :'annual_energy_consumption_in_k_wh' => :'annualEnergyConsumptionInKWh',
+        :'floor_height_in_foot' => :'floorHeightInFoot',
+        :'built_form' => :'builtForm'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.avm_types
+      {
+        :'price_of_previous_sale' => :'Integer',
+        :'date_of_previous_sale' => :'Date',
+        :'leasehold_or_freehold' => :'LeaseholdOrFreehold',
+        :'wall_type' => :'WallType',
+        :'wall_insulation' => :'WallInsulation',
+        :'wall_energy_efficiency' => :'EnergyEfficiency',
+        :'roof_type' => :'RoofType',
+        :'roof_insulation' => :'RoofInsulation',
+        :'roof_energy_efficiency' => :'EnergyEfficiency',
+        :'window_glazing_type' => :'WindowGlazingType',
+        :'window_energy_efficiency' => :'EnergyEfficiency',
+        :'current_energy_rating' => :'EnergyRating',
+        :'potential_energy_rating' => :'EnergyRating',
+        :'annual_heating_cost_in_pounds' => :'Integer',
+        :'annual_hot_water_cost_in_pounds' => :'Integer',
+        :'annual_lighting_cost_in_pounds' => :'Integer',
+        :'annual_energy_consumption_in_k_wh' => :'Integer',
+        :'floor_height_in_foot' => :'Float',
+        :'built_form' => :'BuiltForm'
+      }
+    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::AdditionalFeatures` 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::AdditionalFeatures`. 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?(:'price_of_previous_sale')
+        self.price_of_previous_sale = attributes[:'price_of_previous_sale']
+      end
+
+      if attributes.key?(:'date_of_previous_sale')
+        self.date_of_previous_sale = attributes[:'date_of_previous_sale']
+      end
+
+      if attributes.key?(:'leasehold_or_freehold')
+        self.leasehold_or_freehold = attributes[:'leasehold_or_freehold']
+      end
+
+      if attributes.key?(:'wall_type')
+        self.wall_type = attributes[:'wall_type']
+      end
+
+      if attributes.key?(:'wall_insulation')
+        self.wall_insulation = attributes[:'wall_insulation']
+      end
+
+      if attributes.key?(:'wall_energy_efficiency')
+        self.wall_energy_efficiency = attributes[:'wall_energy_efficiency']
+      end
+
+      if attributes.key?(:'roof_type')
+        self.roof_type = attributes[:'roof_type']
+      end
+
+      if attributes.key?(:'roof_insulation')
+        self.roof_insulation = attributes[:'roof_insulation']
+      end
+
+      if attributes.key?(:'roof_energy_efficiency')
+        self.roof_energy_efficiency = attributes[:'roof_energy_efficiency']
+      end
+
+      if attributes.key?(:'window_glazing_type')
+        self.window_glazing_type = attributes[:'window_glazing_type']
+      end
+
+      if attributes.key?(:'window_energy_efficiency')
+        self.window_energy_efficiency = attributes[:'window_energy_efficiency']
+      end
+
+      if attributes.key?(:'current_energy_rating')
+        self.current_energy_rating = attributes[:'current_energy_rating']
+      end
+
+      if attributes.key?(:'potential_energy_rating')
+        self.potential_energy_rating = attributes[:'potential_energy_rating']
+      end
+
+      if attributes.key?(:'annual_heating_cost_in_pounds')
+        self.annual_heating_cost_in_pounds = attributes[:'annual_heating_cost_in_pounds']
+      end
+
+      if attributes.key?(:'annual_hot_water_cost_in_pounds')
+        self.annual_hot_water_cost_in_pounds = attributes[:'annual_hot_water_cost_in_pounds']
+      end
+
+      if attributes.key?(:'annual_lighting_cost_in_pounds')
+        self.annual_lighting_cost_in_pounds = attributes[:'annual_lighting_cost_in_pounds']
+      end
+
+      if attributes.key?(:'annual_energy_consumption_in_k_wh')
+        self.annual_energy_consumption_in_k_wh = attributes[:'annual_energy_consumption_in_k_wh']
+      end
+
+      if attributes.key?(:'floor_height_in_foot')
+        self.floor_height_in_foot = attributes[:'floor_height_in_foot']
+      end
+
+      if attributes.key?(:'built_form')
+        self.built_form = attributes[:'built_form']
+      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 !@price_of_previous_sale.nil? && @price_of_previous_sale < 1
+        invalid_properties.push('invalid value for "price_of_previous_sale", must be greater than or equal to 1.')
+      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 !@price_of_previous_sale.nil? && @price_of_previous_sale < 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] price_of_previous_sale Value to be assigned
+    def price_of_previous_sale=(price_of_previous_sale)
+      if !price_of_previous_sale.nil? && price_of_previous_sale < 1
+        fail ArgumentError, 'invalid value for "price_of_previous_sale", must be greater than or equal to 1.'
+      end
+
+      @price_of_previous_sale = price_of_previous_sale
+    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 &&
+          price_of_previous_sale == o.price_of_previous_sale &&
+          date_of_previous_sale == o.date_of_previous_sale &&
+          leasehold_or_freehold == o.leasehold_or_freehold &&
+          wall_type == o.wall_type &&
+          wall_insulation == o.wall_insulation &&
+          wall_energy_efficiency == o.wall_energy_efficiency &&
+          roof_type == o.roof_type &&
+          roof_insulation == o.roof_insulation &&
+          roof_energy_efficiency == o.roof_energy_efficiency &&
+          window_glazing_type == o.window_glazing_type &&
+          window_energy_efficiency == o.window_energy_efficiency &&
+          current_energy_rating == o.current_energy_rating &&
+          potential_energy_rating == o.potential_energy_rating &&
+          annual_heating_cost_in_pounds == o.annual_heating_cost_in_pounds &&
+          annual_hot_water_cost_in_pounds == o.annual_hot_water_cost_in_pounds &&
+          annual_lighting_cost_in_pounds == o.annual_lighting_cost_in_pounds &&
+          annual_energy_consumption_in_k_wh == o.annual_energy_consumption_in_k_wh &&
+          floor_height_in_foot == o.floor_height_in_foot &&
+          built_form == o.built_form
+    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
+      [price_of_previous_sale, date_of_previous_sale, leasehold_or_freehold, wall_type, wall_insulation, wall_energy_efficiency, roof_type, roof_insulation, roof_energy_efficiency, window_glazing_type, window_energy_efficiency, current_energy_rating, potential_energy_rating, annual_heating_cost_in_pounds, annual_hot_water_cost_in_pounds, annual_lighting_cost_in_pounds, annual_energy_consumption_in_k_wh, floor_height_in_foot, built_form].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/built_form.rb

@@ -0,0 +1,40 @@
+=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 BuiltForm
+    DETACHED = "detached".freeze
+    SEMI_DETACHED = "semi_detached".freeze
+    ENCLOSED_MID_TERRACE = "enclosed_mid_terrace".freeze
+    ENCLOSED_END_TERRACE = "enclosed_end_terrace".freeze
+    END_TERRACE = "end_terrace".freeze
+    MID_TERRACE = "mid_terrace".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 = BuiltForm.constants.select { |c| BuiltForm::const_get(c) == value }
+      raise "Invalid ENUM value #{value} for class #BuiltForm" if constantValues.empty?
+      value
+    end
+  end
+end

data/lib/avm_client/models/energy_efficiency.rb

@@ -0,0 +1,39 @@
+=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 EnergyEfficiency
+    AVERAGE = "average".freeze
+    GOOD = "good".freeze
+    POOR = "poor".freeze
+    VERY_GOOD = "very_good".freeze
+    VERY_POOR = "very_poor".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 = EnergyEfficiency.constants.select { |c| EnergyEfficiency::const_get(c) == value }
+      raise "Invalid ENUM value #{value} for class #EnergyEfficiency" if constantValues.empty?
+      value
+    end
+  end
+end