module JustimmoClient

cities(**options) click to toggle source

Get a list of cities and their zip codes. @see V1::RealtyInterface.zip_codes_and_cities query parameters (API Version 1) @return (see V1::RealtyInterface.zip_codes_and_cities)

# File lib/justimmo_client/interface.rb, line 96
def cities(**options)
  interface(:realty).zip_codes_and_cities(options)
end

configure(&block) click to toggle source

Loads configuration and initializes the API.

# File lib/justimmo_client.rb, line 11
def configure(&block)
  JustimmoClient::Config.configure(&block)
  initialize_api
end

countries(**options) click to toggle source

Get a list of countries. @see V1::RealtyInterface.countries query parameters (API Version 1) @return (see V1::RealtyInterface.countries)

# File lib/justimmo_client/interface.rb, line 75
def countries(**options)
  interface(:realty).countries(options)
end

employee(id) click to toggle source

Retrieve detailed information about a single employee. @param (see V1::EmployeeInterface.detail) @return (see V1::EmployeeInterface.detail)

# File lib/justimmo_client/interface.rb, line 46
def employee(id)
  interface(:employee).detail(id)
end

employee_ids() click to toggle source

Get a list of all employee IDs. @return (see V1::EmployeeInterface.ids)

# File lib/justimmo_client/interface.rb, line 52
def employee_ids
  interface(:employee).ids
end

employees() click to toggle source

Retrieve a list of employee data. @return (see V1::EmployeeInterface.list)

# File lib/justimmo_client/interface.rb, line 39
def employees
  interface(:employee).list
end

federal_states(**options) click to toggle source

Get a list of federal states. @see V1::RealtyInterface.federal_states query parameters (API Version 1) @return (see V1::RealtyInterface.federal_states)

# File lib/justimmo_client/interface.rb, line 82
def federal_states(**options)
  interface(:realty).federal_states(options)
end

initialize_api() click to toggle source

# File lib/justimmo_client.rb, line 16
def initialize_api
  api_ver = JustimmoClient::Config.api_ver
  send :autoload, "V#{api_ver}", "justimmo_client/api/v#{api_ver}"
end

realties(**options) click to toggle source

Get a list of realty objects with limited information. @see V1::RealtyInterface.list query parameters (API Version 1) @option (see V1::RealtyInterface.list) @example Filter by zip code and limit to three results.

JustimmoClient.realties(zip_code: 6800, limit: 3)

@return (see V1::RealtyInterface.list)

# File lib/justimmo_client/interface.rb, line 15
def realties(**options)
  interface(:realty).list(options)
end

realty(id, lang: nil) click to toggle source

Get detailed information about a single realty. @see V1::RealtyInterface.detail query parameters (API Version 1) @param (see V1::RealtyInterface.detail) @return (see V1::RealtyInterface.detail)

# File lib/justimmo_client/interface.rb, line 23
def realty(id, lang: nil)
  interface(:realty).detail(id, lang: lang)
end

realty_categories(**options) click to toggle source

Get a list of available categories. @see V1::RealtyInterface.categories query parameters (API Version 1) @return (see V1::RealtyInterface.categories)

# File lib/justimmo_client/interface.rb, line 61
def realty_categories(**options)
  interface(:realty).categories(options)
end

realty_ids(options = {}) click to toggle source

Get a list of all realty ids. @see V1::RealtyInterface.ids query parameters (API Version 1) @option (see V1::RealtyInterface.ids) @return (see V1::RealtyInterface.ids)

# File lib/justimmo_client/interface.rb, line 31
def realty_ids(options = {})
  interface(:realty).ids(options)
end

realty_types(**options) click to toggle source

Get a list of available realty types. @see V1::RealtyInterface.types query parameters (API Version 1) @return (see V1::RealtyInterface.types)

# File lib/justimmo_client/interface.rb, line 68
def realty_types(**options)
  interface(:realty).types(options)
end

regions(**options) click to toggle source

Get a list of regions. @see V1::RealtyInterface.regions query parameters (API Version 1) @return (see V1::RealtyInterface.regions)

# File lib/justimmo_client/interface.rb, line 89
def regions(**options)
  interface(:realty).regions(options)
end

Constants

Public Instance Methods