immoscout 1.0.0

data/lib/immoscout/models/document.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative 'concerns/renderable'
+require_relative 'concerns/propertiable'
+require_relative 'actions/attachment'
+
+module Immoscout
+  module Models
+    class Document < Base
+      include Immoscout::Models::Concerns::Renderable
+      include Immoscout::Models::Concerns::Propertiable
+      include Immoscout::Models::Actions::Attachment
+
+      attr_accessor :attachable, :file
+
+      self.json_wrapper = "common.attachment"
+
+      property :id, alias: :@id
+      property :type, alias: :'@xsi.type'
+      property :href, alias: :'@xlink.href'
+      property :publish_date, alias: :@publish_date
+      property :creation, alias: :@creation
+      property :modification, alias: :@modification
+      property :title
+      property :external_id
+      property :external_check_sum
+      property :floorplan
+      property :url
+    end
+  end
+end

data/lib/immoscout/models/house_buy.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require_relative 'concerns/renderable'
+require_relative 'concerns/propertiable'
+require_relative 'actions/real_estate'
+require_relative 'parts/api_search_data'
+require_relative 'parts/address'
+require_relative 'parts/contact'
+require_relative 'parts/price'
+require_relative 'parts/courtage'
+require_relative 'parts/energy_source'
+require_relative 'parts/energy_certificate'
+require_relative 'parts/firing_type'
+
+module Immoscout
+  module Models
+    class HouseBuy < Base
+      include Immoscout::Models::Concerns::Renderable
+      include Immoscout::Models::Concerns::Propertiable
+      include Immoscout::Models::Actions::RealEstate
+
+      self.json_wrapper = "realestates.houseBuy"
+
+      property :id, alias: :@id
+      property :external_id
+      property :title
+      property :creation_date
+      property :last_modification_date
+      property :type, alias: :'@xsi.type'
+      property :href, alias: :'@xlink.href'
+      property :publish_date, alias: :@publish_date
+      property :creation, alias: :@creation
+      property :modification, alias: :@modification
+      property :group_number
+      property :real_estate_project_id
+      property :address, coerce: Immoscout::Models::Parts::Address
+      property :api_search_data, coerce: Immoscout::Models::Parts::ApiSearchData
+      property :real_estate_state
+      property :description_note
+      property :furnishing_note
+      property :location_note
+      property :other_note
+      property :show_address
+      property :contact, coerce: Immoscout::Models::Parts::Contact
+      property :building_type
+      property :price, coerce: Immoscout::Models::Parts::Price
+      property :courtage, coerce: Immoscout::Models::Parts::Courtage
+      property :energy_sources_enev2014,
+               coerce: Immoscout::Models::Parts::EnergySource
+      property :energy_certificate,
+               coerce: Immoscout::Models::Parts::EnergyCertificate
+      property :firing_types,
+               coerce: Immoscout::Models::Parts::FiringType, array: true
+      property :cellar
+      property :handicapped_accessible
+      property :number_of_parking_spaces
+      property :condition
+      property :last_refurbishment
+      property :interior_quality
+      property :construction_year
+      property :free_from
+      property :heating_type
+      property :heating_type_enev2014
+      property :building_energy_rating_type
+      property :thermal_characteristic
+      property :energy_consumption_contains_warm_water
+      property :number_of_floors
+      property :usable_floor_space
+      property :number_of_bed_rooms
+      property :number_of_bath_rooms
+      property :guest_toilet
+      property :parking_space_type
+      property :rented
+      property :rental_income
+      property :listed
+      property :parking_space_price
+      property :summer_residence_practical
+      property :living_space
+      property :number_of_rooms
+      property :energy_performance_certificate
+      # house specific properties
+      property :lodger_flat
+      property :construction_phase
+      property :plot_area
+    end
+  end
+end

data/lib/immoscout/models/parts/address.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative '../base'
+require_relative '../parts/coordinate'
+require_relative '../parts/geo_hierarchy'
+require_relative '../concerns/propertiable'
+require_relative '../concerns/renderable'
+
+module Immoscout
+  module Models
+    module Parts
+      class Address < Base
+        include Immoscout::Models::Concerns::Renderable
+        include Immoscout::Models::Concerns::Propertiable
+        property :street
+        property :house_number
+        property :postcode
+        property :city
+        property :wgs84_coordinate, coerce: Immoscout::Models::Parts::Coordinate
+        property :geo_hierarchy,
+                 coerce: Immoscout::Models::Parts::GeoHierarchy,
+                 readonly: true
+      end
+    end
+  end
+end

data/lib/immoscout/models/parts/api_search_data.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative '../base'
+require_relative '../concerns/propertiable'
+require_relative '../concerns/renderable'
+
+module Immoscout
+  module Models
+    module Parts
+      class ApiSearchData < Base
+        include Immoscout::Models::Concerns::Renderable
+        include Immoscout::Models::Concerns::Propertiable
+        property :search_field1
+        property :search_field2
+        property :search_field3
+      end
+    end
+  end
+end

data/lib/immoscout/models/parts/contact.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative '../base'
+require_relative '../concerns/propertiable'
+require_relative '../concerns/renderable'
+
+module Immoscout
+  module Models
+    module Parts
+      class Contact < Base
+        include Immoscout::Models::Concerns::Renderable
+        include Immoscout::Models::Concerns::Propertiable
+        property :id, alias: :@id
+        property :external_id, alias: :@external_id
+      end
+    end
+  end
+end

data/lib/immoscout/models/parts/coordinate.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative '../base'
+require_relative '../concerns/propertiable'
+require_relative '../concerns/renderable'
+
+module Immoscout
+  module Models
+    module Parts
+      class Coordinate < Base
+        include Immoscout::Models::Concerns::Renderable
+        include Immoscout::Models::Concerns::Propertiable
+        property :latitude
+        property :longitude
+      end
+    end
+  end
+end

data/lib/immoscout/models/parts/courtage.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative '../base'
+require_relative '../concerns/propertiable'
+require_relative '../concerns/renderable'
+
+module Immoscout
+  module Models
+    module Parts
+      class Courtage < Base
+        include Immoscout::Models::Concerns::Renderable
+        include Immoscout::Models::Concerns::Propertiable
+        property :has_courtage
+        property :courtage
+        property :courtage_note
+      end
+    end
+  end
+end

data/lib/immoscout/models/parts/energy_certificate.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative '../base'
+require_relative '../concerns/propertiable'
+require_relative '../concerns/renderable'
+
+module Immoscout
+  module Models
+    module Parts
+      class EnergyCertificate < Base
+        include Immoscout::Models::Concerns::Renderable
+        include Immoscout::Models::Concerns::Propertiable
+        property :energy_certificate_availability
+        property :energy_certificate_creation_date
+        property :energy_efficiency_class
+      end
+    end
+  end
+end

data/lib/immoscout/models/parts/energy_source.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative '../base'
+require_relative '../concerns/propertiable'
+require_relative '../concerns/renderable'
+
+module Immoscout
+  module Models
+    module Parts
+      class EnergySource < Base
+        include Immoscout::Models::Concerns::Renderable
+        include Immoscout::Models::Concerns::Propertiable
+        property :energy_source_enev2014
+      end
+    end
+  end
+end

data/lib/immoscout/models/parts/firing_type.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative '../base'
+require_relative '../concerns/propertiable'
+require_relative '../concerns/renderable'
+
+module Immoscout
+  module Models
+    module Parts
+      class FiringType < Base
+        include Immoscout::Models::Concerns::Renderable
+        include Immoscout::Models::Concerns::Propertiable
+        property :firing_type
+      end
+    end
+  end
+end

data/lib/immoscout/models/parts/geo_code.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative '../base'
+require_relative '../concerns/propertiable'
+require_relative '../concerns/renderable'
+
+module Immoscout
+  module Models
+    module Parts
+      class GeoCode < Base
+        include Immoscout::Models::Concerns::Renderable
+        include Immoscout::Models::Concerns::Propertiable
+        property :geo_code_id
+        property :full_geo_code_id
+      end
+    end
+  end
+end

data/lib/immoscout/models/parts/geo_hierarchy.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative '../base'
+require_relative '../concerns/propertiable'
+require_relative '../concerns/renderable'
+require_relative 'geo_code'
+
+module Immoscout
+  module Models
+    module Parts
+      class GeoHierarchy < Base
+        include Immoscout::Models::Concerns::Renderable
+        include Immoscout::Models::Concerns::Propertiable
+        property :continent, coerce: Immoscout::Models::Parts::GeoCode
+        property :country, coerce: Immoscout::Models::Parts::GeoCode
+        property :region, coerce: Immoscout::Models::Parts::GeoCode
+        property :city, coerce: Immoscout::Models::Parts::GeoCode
+        property :quarter, coerce: Immoscout::Models::Parts::GeoCode
+        property :neighbourhood, coerce: Immoscout::Models::Parts::GeoCode
+      end
+    end
+  end
+end

data/lib/immoscout/models/parts/price.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative '../base'
+require_relative '../concerns/propertiable'
+require_relative '../concerns/renderable'
+
+module Immoscout
+  module Models
+    module Parts
+      class Price < Base
+        include Immoscout::Models::Concerns::Renderable
+        include Immoscout::Models::Concerns::Propertiable
+        property :value
+        property :currency
+        property :marketing_type
+        property :price_interval_type
+      end
+    end
+  end
+end

data/lib/immoscout/models/parts/publish_channel.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative '../base'
+require_relative '../concerns/propertiable'
+require_relative '../concerns/renderable'
+
+module Immoscout
+  module Models
+    module Parts
+      class PublishChannel < Base
+        include Immoscout::Models::Concerns::Renderable
+        include Immoscout::Models::Concerns::Propertiable
+        property :id, alias: :@id, default: 10_000
+      end
+    end
+  end
+end

data/lib/immoscout/models/parts/real_estate.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative '../base'
+require_relative '../concerns/propertiable'
+require_relative '../concerns/renderable'
+
+module Immoscout
+  module Models
+    module Parts
+      class RealEstate < Base
+        include Immoscout::Models::Concerns::Renderable
+        include Immoscout::Models::Concerns::Propertiable
+        property :id, alias: :@id
+      end
+    end
+  end
+end

data/lib/immoscout/models/parts/url.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative '../base'
+require_relative '../concerns/propertiable'
+require_relative '../concerns/renderable'
+
+module Immoscout
+  module Models
+    module Parts
+      class Url < Base
+        include Immoscout::Models::Concerns::Renderable
+        include Immoscout::Models::Concerns::Propertiable
+        property :scale, alias: :@scale
+        property :href, alias: :@href
+      end
+    end
+  end
+end

data/lib/immoscout/models/parts/urls.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative '../base'
+require_relative '../concerns/propertiable'
+require_relative '../concerns/renderable'
+require_relative 'url'
+
+module Immoscout
+  module Models
+    module Parts
+      class Urls < Base
+        include Immoscout::Models::Concerns::Renderable
+        include Immoscout::Models::Concerns::Propertiable
+        property :url, coerce: Immoscout::Models::Parts::Url, array: true
+      end
+    end
+  end
+end

data/lib/immoscout/models/picture.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'concerns/renderable'
+require_relative 'concerns/propertiable'
+require_relative 'parts/urls'
+require_relative 'actions/attachment'
+
+module Immoscout
+  module Models
+    class Picture < Base
+      include Immoscout::Models::Concerns::Renderable
+      include Immoscout::Models::Concerns::Propertiable
+      include Immoscout::Models::Actions::Attachment
+
+      attr_accessor :attachable, :file
+
+      self.json_wrapper = "common.attachment"
+
+      property :id, alias: :@id
+      property :type, alias: :'@xsi.type', default: "common:Picture"
+      property :href, alias: :'@xlink.href'
+      property :publish_date, alias: :@publish_date
+      property :creation, alias: :@creation
+      property :modification, alias: :@modification
+      property :title
+      property :external_id
+      property :external_check_sum
+      property :floorplan
+      property :title_picture
+      property :urls, coerce: Immoscout::Models::Parts::Urls, array: true
+    end
+  end
+end