avm_client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 62e433dd58427db0a4a2ceea70de4a2cc3d5ce6848039469ba3c48942e9e0e91
+  data.tar.gz: 0b72bc1e3b020ad4960fd476ae3d47454180fd7eb25886ecc56315ac21b0d471
+SHA512:
+  metadata.gz: 3eb64fc7e29208cbe13a6b55560486a375641fa731a13a1106dd9e4cb2a537b7f9b5420c81e228467227d47bc5b53d9625ac14da60b66b93422e178f6168fb00
+  data.tar.gz: 4870493cf84b76ea4c6280028f7a0d3e8dd51be4e82c269465bd66785a8c46f286f3090c414761b3383cb0efb4f479656d9f80b74f76aaa9668be90020153f1c

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.0.0'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/Gemfile.lock

@@ -0,0 +1,79 @@
+PATH
+  remote: .
+  specs:
+    avm_client (1.0.0)
+      json (~> 2.1, >= 2.1.0)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ZenTest (4.11.2)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    autotest-fsevent (0.2.14)
+      sys-uname
+    autotest-growl (0.2.16)
+    autotest-rails-pure (4.1.2)
+    byebug (10.0.2)
+    coderay (1.1.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    ethon (0.11.0)
+      ffi (>= 1.3.0)
+    ffi (1.9.25)
+    hashdiff (0.3.7)
+    json (2.1.0)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    public_suffix (3.0.3)
+    rake (12.0.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    safe_yaml (1.0.4)
+    sys-uname (1.0.3)
+      ffi (>= 1.0.0)
+    typhoeus (1.3.0)
+      ethon (>= 0.9.0)
+    vcr (3.0.3)
+    webmock (1.24.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  autotest (~> 4.4, >= 4.4.6)
+  autotest-fsevent (~> 0.2, >= 0.2.12)
+  autotest-growl (~> 0.2, >= 0.2.16)
+  autotest-rails-pure (~> 4.1, >= 4.1.2)
+  avm_client!
+  pry-byebug
+  rake (~> 12.0.0)
+  rspec (~> 3.6, >= 3.6.0)
+  vcr (~> 3.0, >= 3.0.1)
+  webmock (~> 1.24, >= 1.24.3)
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -0,0 +1,104 @@
+# avm_client
+
+AvmClient - the Ruby gem for the AVM
+
+This is api for AVM (automated valuation machine)
+
+This SDK is automatically generated by the [Avm Generator](https://Avm-generator.tech) project:
+
+- API version: 1.0.0
+- Package version: 1.0.0
+- Build package: org.Avmtools.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+require 'avm_client'
+
+# Setup authorization
+AvmClient.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-KEY'] = 'SET YOUR TOKEN HERE!'
+end
+
+api_instance = AvmClient::DefaultApi.new
+
+property_features = AvmClient::PropertyFeatures.new
+required_features = AvmClient::RequiredFeatures.new
+additional_features = AvmClient::AdditionalFeatures.new
+
+additional_features.built_form = AvmClient::BuiltForm::DETACHED
+additional_features.roof_energy_efficiency = AvmClient::EnergyEfficiency::GOOD
+
+required_features.postcode = 'b1 1tb'
+required_features.floor_level = AvmClient::FloorLevel::FLOOR_5
+required_features.new_or_resale = AvmClient::NewOrResale::NEW
+required_features.number_of_rooms = 2
+required_features.property_type = AvmClient::PropertyType::DETACHED_HOUSE
+required_features.total_floor_area_in_sqf = 160
+
+property_features.additional_features = additional_features
+property_features.required_features = required_features
+
+begin
+  price = api_instance.get_fast_valuation(property_features)
+  valuation = api_instance.get_valuation(property_features)
+  puts price
+  puts "price range from: #{valuation.price_range_from}"
+  puts "to: #{valuation.price_range_to}"
+rescue AvmClient::ApiError => e
+  puts "Exception when calling DefaultApi->get_fast_valuation: #{e}"
+end
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://avm.enbisys.com/api*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*AvmClient::DefaultApi* | [**get_fast_valuation**](docs/DefaultApi.md#get_fast_valuation) | **POST** /properties/getFastValuation | 
+*AvmClient::DefaultApi* | [**get_valuation**](docs/DefaultApi.md#get_valuation) | **POST** /properties/getValuation | 
+
+
+## Documentation for Models
+
+ - [AvmClient::AdditionalFeatures](docs/AdditionalFeatures.md)
+ - [AvmClient::BuiltForm](docs/BuiltForm.md)
+ - [AvmClient::EnergyEfficiency](docs/EnergyEfficiency.md)
+ - [AvmClient::EnergyRating](docs/EnergyRating.md)
+ - [AvmClient::FloorLevel](docs/FloorLevel.md)
+ - [AvmClient::LeaseholdOrFreehold](docs/LeaseholdOrFreehold.md)
+ - [AvmClient::NewOrResale](docs/NewOrResale.md)
+ - [AvmClient::Problem](docs/Problem.md)
+ - [AvmClient::PropertyFeatures](docs/PropertyFeatures.md)
+ - [AvmClient::PropertyType](docs/PropertyType.md)
+ - [AvmClient::RequiredFeatures](docs/RequiredFeatures.md)
+ - [AvmClient::RoofInsulation](docs/RoofInsulation.md)
+ - [AvmClient::RoofType](docs/RoofType.md)
+ - [AvmClient::Valuation](docs/Valuation.md)
+ - [AvmClient::ValuationPriceDistribution](docs/ValuationPriceDistribution.md)
+ - [AvmClient::WallInsulation](docs/WallInsulation.md)
+ - [AvmClient::WallType](docs/WallType.md)
+ - [AvmClient::WindowGlazingType](docs/WindowGlazingType.md)
+
+
+## Documentation for Authorization
+
+
+### ApiKeyAuth
+
+
+- **Type**: API key
+- **API key parameter name**: X-API-KEY
+- **Location**: HTTP header
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/avm_client.gemspec

@@ -0,0 +1,45 @@
+# -*- encoding: utf-8 -*-
+
+=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
+
+$:.push File.expand_path("../lib", __FILE__)
+require "avm_client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "avm_client"
+  s.version     = AvmClient::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["enbisys.com"]
+  s.email       = ["info@enbisys.com"]
+  s.homepage    = "https://avm.enbisys.com"
+  s.summary     = "AVM Ruby Gem"
+  s.description = "This is api for AVM (automated valuation machine)"
+  s.license     = "Unlicense"
+  s.required_ruby_version = ">= 1.9"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+  s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
+  s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
+  s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
+  s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
+  s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
+  s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/docs/AdditionalFeatures.md

@@ -0,0 +1,53 @@
+# AvmClient::AdditionalFeatures
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**price_of_previous_sale** | **Integer** |  | [optional] 
+**date_of_previous_sale** | **Date** |  | [optional] 
+**leasehold_or_freehold** | [**LeaseholdOrFreehold**](LeaseholdOrFreehold.md) |  | [optional] 
+**wall_type** | [**WallType**](WallType.md) |  | [optional] 
+**wall_insulation** | [**WallInsulation**](WallInsulation.md) |  | [optional] 
+**wall_energy_efficiency** | [**EnergyEfficiency**](EnergyEfficiency.md) |  | [optional] 
+**roof_type** | [**RoofType**](RoofType.md) |  | [optional] 
+**roof_insulation** | [**RoofInsulation**](RoofInsulation.md) |  | [optional] 
+**roof_energy_efficiency** | [**EnergyEfficiency**](EnergyEfficiency.md) |  | [optional] 
+**window_glazing_type** | [**WindowGlazingType**](WindowGlazingType.md) |  | [optional] 
+**window_energy_efficiency** | [**EnergyEfficiency**](EnergyEfficiency.md) |  | [optional] 
+**current_energy_rating** | [**EnergyRating**](EnergyRating.md) |  | [optional] 
+**potential_energy_rating** | [**EnergyRating**](EnergyRating.md) |  | [optional] 
+**annual_heating_cost_in_pounds** | **Integer** |  | [optional] 
+**annual_hot_water_cost_in_pounds** | **Integer** |  | [optional] 
+**annual_lighting_cost_in_pounds** | **Integer** |  | [optional] 
+**annual_energy_consumption_in_k_wh** | **Integer** |  | [optional] 
+**floor_height_in_foot** | **Float** |  | [optional] 
+**built_form** | [**BuiltForm**](BuiltForm.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AvmClient'
+
+instance = AvmClient::AdditionalFeatures.new(price_of_previous_sale: 300000,
+                                 date_of_previous_sale: null,
+                                 leasehold_or_freehold: null,
+                                 wall_type: null,
+                                 wall_insulation: null,
+                                 wall_energy_efficiency: null,
+                                 roof_type: null,
+                                 roof_insulation: null,
+                                 roof_energy_efficiency: null,
+                                 window_glazing_type: null,
+                                 window_energy_efficiency: null,
+                                 current_energy_rating: null,
+                                 potential_energy_rating: null,
+                                 annual_heating_cost_in_pounds: 817,
+                                 annual_hot_water_cost_in_pounds: 273,
+                                 annual_lighting_cost_in_pounds: 102,
+                                 annual_energy_consumption_in_k_wh: 25662,
+                                 floor_height_in_foot: 7.58,
+                                 built_form: null)
+```
+
+

data/docs/BuiltForm.md

@@ -0,0 +1,16 @@
+# AvmClient::BuiltForm
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'AvmClient'
+
+instance = AvmClient::BuiltForm.new()
+```
+
+

data/docs/DefaultApi.md

@@ -0,0 +1,67 @@
+# AvmClient::DefaultApi
+
+All URIs are relative to *https://avm.enbisys.com/api*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_fast_valuation**](DefaultApi.md#get_fast_valuation) | **POST** /properties/getFastValuation | 
+[**get_valuation**](DefaultApi.md#get_valuation) | **POST** /properties/getValuation | 
+
+
+
+## get_fast_valuation
+
+> Integer get_fast_valuation(property_features)
+
+
+
+Get only property price valuation without confidence estimation
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **property_features** | [**PropertyFeatures**](PropertyFeatures.md)| Property features that describe property | 
+
+### Return type
+
+**Integer**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json, application/problem+json
+
+
+## get_valuation
+
+> Valuation get_valuation(property_features)
+
+Get property price valuation with confidence estimation
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **property_features** | [**PropertyFeatures**](PropertyFeatures.md)| Property features to valuate | 
+
+### Return type
+
+[**Valuation**](Valuation.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/problem+json
+

data/docs/EnergyEfficiency.md

@@ -0,0 +1,16 @@
+# AvmClient::EnergyEfficiency
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'AvmClient'
+
+instance = AvmClient::EnergyEfficiency.new()
+```
+
+

data/docs/EnergyRating.md

@@ -0,0 +1,16 @@
+# AvmClient::EnergyRating
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'AvmClient'
+
+instance = AvmClient::EnergyRating.new()
+```
+
+

data/docs/FloorLevel.md

@@ -0,0 +1,16 @@
+# AvmClient::FloorLevel
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'AvmClient'
+
+instance = AvmClient::FloorLevel.new()
+```
+
+

data/docs/LeaseholdOrFreehold.md

@@ -0,0 +1,16 @@
+# AvmClient::LeaseholdOrFreehold
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'AvmClient'
+
+instance = AvmClient::LeaseholdOrFreehold.new()
+```
+
+

data/docs/NewOrResale.md

@@ -0,0 +1,16 @@
+# AvmClient::NewOrResale
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'AvmClient'
+
+instance = AvmClient::NewOrResale.new()
+```
+
+

data/docs/Problem.md

@@ -0,0 +1,25 @@
+# AvmClient::Problem
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | 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). | [optional] [default to 'about:blank']
+**title** | **String** | A short, summary of the problem type. Written in english and readable for engineers (usually not suited for non technical stakeholders and not localized) | [optional] 
+**status** | **Integer** | The HTTP status code generated by the origin server for this occurrence of the problem. | [optional] 
+**detail** | **String** | A human-readable explanation specific to this occurrence of the problem | [optional] 
+**instance** | **String** | A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AvmClient'
+
+instance = AvmClient::Problem.new(type: null,
+                                 title: Service Unavailable,
+                                 status: 503,
+                                 detail: null,
+                                 instance: null)
+```
+
+

data/docs/PropertyFeatures.md

@@ -0,0 +1,19 @@
+# AvmClient::PropertyFeatures
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**required_features** | [**RequiredFeatures**](RequiredFeatures.md) |  | 
+**additional_features** | [**AdditionalFeatures**](AdditionalFeatures.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AvmClient'
+
+instance = AvmClient::PropertyFeatures.new(required_features: null,
+                                 additional_features: null)
+```
+
+

data/docs/PropertyType.md

@@ -0,0 +1,16 @@
+# AvmClient::PropertyType
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'AvmClient'
+
+instance = AvmClient::PropertyType.new()
+```
+
+

data/docs/RequiredFeatures.md

@@ -0,0 +1,27 @@
+# AvmClient::RequiredFeatures
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**postcode** | **String** | Postcode | 
+**new_or_resale** | [**NewOrResale**](NewOrResale.md) |  | 
+**floor_level** | [**FloorLevel**](FloorLevel.md) |  | 
+**total_floor_area_in_sqf** | **Integer** | Floor area (sqf) | 
+**property_type** | [**PropertyType**](PropertyType.md) |  | 
+**number_of_rooms** | **Integer** |  | 
+
+## Code Sample
+
+```ruby
+require 'AvmClient'
+
+instance = AvmClient::RequiredFeatures.new(postcode: B1 1TB,
+                                 new_or_resale: null,
+                                 floor_level: null,
+                                 total_floor_area_in_sqf: 90,
+                                 property_type: null,
+                                 number_of_rooms: 3)
+```
+
+

data/docs/RoofInsulation.md

@@ -0,0 +1,16 @@
+# AvmClient::RoofInsulation
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'AvmClient'
+
+instance = AvmClient::RoofInsulation.new()
+```
+
+

data/docs/RoofType.md

@@ -0,0 +1,16 @@
+# AvmClient::RoofType
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'AvmClient'
+
+instance = AvmClient::RoofType.new()
+```
+
+

data/docs/Valuation.md

@@ -0,0 +1,25 @@
+# AvmClient::Valuation
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**most_probable_price** | **Integer** | Predicted price, pound | [optional] 
+**price_range_from** | **Integer** | Lower price boundary, pound | [optional] 
+**price_range_to** | **Integer** | Higher price boundary, pound | [optional] 
+**confidence** | **Integer** | Probability (in percents) that actual price is within the specified boundaries | [optional] 
+**price_distribution** | [**Array<ValuationPriceDistribution>**](ValuationPriceDistribution.md) | Describes the probabilities (in percents) that actual price is within particular subranges | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AvmClient'
+
+instance = AvmClient::Valuation.new(most_probable_price: 233000,
+                                 price_range_from: 230000,
+                                 price_range_to: 235000,
+                                 confidence: 95,
+                                 price_distribution: null)
+```
+
+

data/docs/ValuationPriceDistribution.md

@@ -0,0 +1,21 @@
+# AvmClient::ValuationPriceDistribution
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**price_from** | **Integer** | left subrange boundary | [optional] 
+**price_to** | **Integer** | right subrange boundary | [optional] 
+**probability** | **Float** | Probability that price is within the specified boundaries | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AvmClient'
+
+instance = AvmClient::ValuationPriceDistribution.new(price_from: 230000,
+                                 price_to: 231000,
+                                 probability: 0.05)
+```
+
+

data/docs/WallInsulation.md

@@ -0,0 +1,16 @@
+# AvmClient::WallInsulation
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'AvmClient'
+
+instance = AvmClient::WallInsulation.new()
+```
+
+