Class: ScrapeBadger::ImmobiliareApi

Inherits:
Object
  • Object
show all
Defined in:
lib/scrapebadger/api/immobiliare_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ImmobiliareApi

Returns a new instance of ImmobiliareApi.



19
20
21
 
# File 'lib/scrapebadger/api/immobiliare_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/scrapebadger/api/immobiliare_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#immobiliare_get_agency_profile(agency_id, opts = {}) ⇒ Object

Get agency profile Public agency/advertiser profile.

Parameters:

  • agency_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :market (String) —

    it | es | gr | lu (default to 'it')

Returns:

  • (Object) 


28
29
30
31
 
# File 'lib/scrapebadger/api/immobiliare_api.rb', line 28

def immobiliare_get_agency_profile(agency_id, opts = {})
  data, _status_code, _headers = immobiliare_get_agency_profile_with_http_info(agency_id, opts)
  data
end

#immobiliare_get_agency_profile_with_http_info(agency_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Get agency profile Public agency/advertiser profile.

Parameters:

  • agency_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :market (String) —

    it | es | gr | lu (default to 'it')

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/scrapebadger/api/immobiliare_api.rb', line 39

def immobiliare_get_agency_profile_with_http_info(agency_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ImmobiliareApi.immobiliare_get_agency_profile ...'
  end
  # verify the required parameter 'agency_id' is set
  if @api_client.config.client_side_validation && agency_id.nil?
    fail ArgumentError, "Missing the required parameter 'agency_id' when calling ImmobiliareApi.immobiliare_get_agency_profile"
  end
  # resource path
  local_var_path = '/v1/immobiliare/agencies/{agency_id}'.sub('{' + 'agency_id' + '}', CGI.escape(agency_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'market'] = opts[:'market'] if !opts[:'market'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"ImmobiliareApi.immobiliare_get_agency_profile",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ImmobiliareApi#immobiliare_get_agency_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#immobiliare_get_an_agency_s_listings(agency_id, opts = {}) ⇒ Object

Get an agency's listings An agency's active listings.

Parameters:

  • agency_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :market (String) —

    it | es | gr | lu (default to 'it')

  • :contract (String) —

    sale | rent (default to 'sale')

  • :page (Integer) — default: default to 1

Returns:

  • (Object) 


96
97
98
99
 
# File 'lib/scrapebadger/api/immobiliare_api.rb', line 96

def immobiliare_get_an_agency_s_listings(agency_id, opts = {})
  data, _status_code, _headers = immobiliare_get_an_agency_s_listings_with_http_info(agency_id, opts)
  data
end

#immobiliare_get_an_agency_s_listings_with_http_info(agency_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Get an agency's listings An agency's active listings.

Parameters:

  • agency_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :market (String) —

    it | es | gr | lu (default to 'it')

  • :contract (String) —

    sale | rent (default to 'sale')

  • :page (Integer) — default: default to 1

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/scrapebadger/api/immobiliare_api.rb', line 109

def immobiliare_get_an_agency_s_listings_with_http_info(agency_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ImmobiliareApi.immobiliare_get_an_agency_s_listings ...'
  end
  # verify the required parameter 'agency_id' is set
  if @api_client.config.client_side_validation && agency_id.nil?
    fail ArgumentError, "Missing the required parameter 'agency_id' when calling ImmobiliareApi.immobiliare_get_an_agency_s_listings"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling ImmobiliareApi.immobiliare_get_an_agency_s_listings, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/immobiliare/agencies/{agency_id}/listings'.sub('{' + 'agency_id' + '}', CGI.escape(agency_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'market'] = opts[:'market'] if !opts[:'market'].nil?
  query_params[:'contract'] = opts[:'contract'] if !opts[:'contract'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"ImmobiliareApi.immobiliare_get_an_agency_s_listings",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ImmobiliareApi#immobiliare_get_an_agency_s_listings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#immobiliare_get_listing_detail(listing_id, opts = {}) ⇒ Object

Get listing detail Full detail for a single listing.

Parameters:

  • listing_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :market (String) —

    it | es | gr | lu (default to 'it')

Returns:

  • (Object) 


170
171
172
173
 
# File 'lib/scrapebadger/api/immobiliare_api.rb', line 170

def immobiliare_get_listing_detail(listing_id, opts = {})
  data, _status_code, _headers = immobiliare_get_listing_detail_with_http_info(listing_id, opts)
  data
end

#immobiliare_get_listing_detail_with_http_info(listing_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Get listing detail Full detail for a single listing.

Parameters:

  • listing_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :market (String) —

    it | es | gr | lu (default to 'it')

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/scrapebadger/api/immobiliare_api.rb', line 181

def immobiliare_get_listing_detail_with_http_info(listing_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ImmobiliareApi.immobiliare_get_listing_detail ...'
  end
  # verify the required parameter 'listing_id' is set
  if @api_client.config.client_side_validation && listing_id.nil?
    fail ArgumentError, "Missing the required parameter 'listing_id' when calling ImmobiliareApi.immobiliare_get_listing_detail"
  end
  # resource path
  local_var_path = '/v1/immobiliare/listings/{listing_id}'.sub('{' + 'listing_id' + '}', CGI.escape(listing_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'market'] = opts[:'market'] if !opts[:'market'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"ImmobiliareApi.immobiliare_get_listing_detail",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ImmobiliareApi#immobiliare_get_listing_detail\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#immobiliare_immobiliare_scraper_health_check(opts = {}) ⇒ Object

Immobiliare scraper health check Check health of the Immobiliare scraper service (accepts HEAD).

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


234
235
236
237
 
# File 'lib/scrapebadger/api/immobiliare_api.rb', line 234

def immobiliare_immobiliare_scraper_health_check(opts = {})
  data, _status_code, _headers = immobiliare_immobiliare_scraper_health_check_with_http_info(opts)
  data
end

#immobiliare_immobiliare_scraper_health_check_head(opts = {}) ⇒ Object

Immobiliare scraper health check Check health of the Immobiliare scraper service (accepts HEAD).

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


291
292
293
294
 
# File 'lib/scrapebadger/api/immobiliare_api.rb', line 291

def immobiliare_immobiliare_scraper_health_check_head(opts = {})
  data, _status_code, _headers = immobiliare_immobiliare_scraper_health_check_head_with_http_info(opts)
  data
end

#immobiliare_immobiliare_scraper_health_check_head_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

Immobiliare scraper health check Check health of the Immobiliare scraper service (accepts HEAD).

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/scrapebadger/api/immobiliare_api.rb', line 300

def immobiliare_immobiliare_scraper_health_check_head_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ImmobiliareApi.immobiliare_immobiliare_scraper_health_check_head ...'
  end
  # resource path
  local_var_path = '/v1/immobiliare/health'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"ImmobiliareApi.immobiliare_immobiliare_scraper_health_check_head",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:HEAD, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ImmobiliareApi#immobiliare_immobiliare_scraper_health_check_head\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#immobiliare_immobiliare_scraper_health_check_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

Immobiliare scraper health check Check health of the Immobiliare scraper service (accepts HEAD).

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/scrapebadger/api/immobiliare_api.rb', line 243

def immobiliare_immobiliare_scraper_health_check_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ImmobiliareApi.immobiliare_immobiliare_scraper_health_check ...'
  end
  # resource path
  local_var_path = '/v1/immobiliare/health'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"ImmobiliareApi.immobiliare_immobiliare_scraper_health_check",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ImmobiliareApi#immobiliare_immobiliare_scraper_health_check\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#immobiliare_list_filter_enums(opts = {}) ⇒ Object

List filter enums

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


347
348
349
350
 
# File 'lib/scrapebadger/api/immobiliare_api.rb', line 347

def immobiliare_list_filter_enums(opts = {})
  data, _status_code, _headers = immobiliare_list_filter_enums_with_http_info(opts)
  data
end

#immobiliare_list_filter_enums_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

List filter enums

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/scrapebadger/api/immobiliare_api.rb', line 355

def immobiliare_list_filter_enums_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ImmobiliareApi.immobiliare_list_filter_enums ...'
  end
  # resource path
  local_var_path = '/v1/immobiliare/reference'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"ImmobiliareApi.immobiliare_list_filter_enums",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ImmobiliareApi#immobiliare_list_filter_enums\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#immobiliare_list_markets(opts = {}) ⇒ Object

List markets

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


402
403
404
405
 
# File 'lib/scrapebadger/api/immobiliare_api.rb', line 402

def immobiliare_list_markets(opts = {})
  data, _status_code, _headers = immobiliare_list_markets_with_http_info(opts)
  data
end

#immobiliare_list_markets_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

List markets

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
 
# File 'lib/scrapebadger/api/immobiliare_api.rb', line 410

def immobiliare_list_markets_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ImmobiliareApi.immobiliare_list_markets ...'
  end
  # resource path
  local_var_path = '/v1/immobiliare/markets'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"ImmobiliareApi.immobiliare_list_markets",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ImmobiliareApi#immobiliare_list_markets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#immobiliare_location_autocomplete(query, opts = {}) ⇒ Object

Location autocomplete Resolve a place name to region/province/city ids usable in search.

Parameters:

  • query (String) —

    Free-text place name, e.g. 'Milano'

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :market (String) —

    it | es | gr | lu (default to 'it')

Returns:

  • (Object) 


460
461
462
463
 
# File 'lib/scrapebadger/api/immobiliare_api.rb', line 460

def immobiliare_location_autocomplete(query, opts = {})
  data, _status_code, _headers = immobiliare_location_autocomplete_with_http_info(query, opts)
  data
end

#immobiliare_location_autocomplete_with_http_info(query, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Location autocomplete Resolve a place name to region/province/city ids usable in search.

Parameters:

  • query (String) —

    Free-text place name, e.g. 'Milano'

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :market (String) —

    it | es | gr | lu (default to 'it')

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
 
# File 'lib/scrapebadger/api/immobiliare_api.rb', line 471

def immobiliare_location_autocomplete_with_http_info(query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ImmobiliareApi.immobiliare_location_autocomplete ...'
  end
  # verify the required parameter 'query' is set
  if @api_client.config.client_side_validation && query.nil?
    fail ArgumentError, "Missing the required parameter 'query' when calling ImmobiliareApi.immobiliare_location_autocomplete"
  end
  # resource path
  local_var_path = '/v1/immobiliare/autocomplete'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'query'] = query
  query_params[:'market'] = opts[:'market'] if !opts[:'market'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"ImmobiliareApi.immobiliare_location_autocomplete",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ImmobiliareApi#immobiliare_location_autocomplete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#immobiliare_price_m_time_series(region_id, opts = {}) ⇒ Object

Price €/m² time series Historical €/m² price statistics for an area.

Parameters:

  • region_id (String) —

    Region id, e.g. 'lom'

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :market (String) —

    it | es | gr | lu (default to 'it')

  • :province_id (String) —

    Province id, e.g. 'MI'

  • :city_id (String) —

    City id (idComune)

  • :contract (String) —

    sale | rent (default to 'sale')

Returns:

  • (Object) 


530
531
532
533
 
# File 'lib/scrapebadger/api/immobiliare_api.rb', line 530

def immobiliare_price_m_time_series(region_id, opts = {})
  data, _status_code, _headers = immobiliare_price_m_time_series_with_http_info(region_id, opts)
  data
end

#immobiliare_price_m_time_series_with_http_info(region_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Price €/m² time series Historical €/m² price statistics for an area.

Parameters:

  • region_id (String) —

    Region id, e.g. 'lom'

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :market (String) —

    it | es | gr | lu (default to 'it')

  • :province_id (String) —

    Province id, e.g. 'MI'

  • :city_id (String) —

    City id (idComune)

  • :contract (String) —

    sale | rent (default to 'sale')

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
 
# File 'lib/scrapebadger/api/immobiliare_api.rb', line 544

def immobiliare_price_m_time_series_with_http_info(region_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ImmobiliareApi.immobiliare_price_m_time_series ...'
  end
  # verify the required parameter 'region_id' is set
  if @api_client.config.client_side_validation && region_id.nil?
    fail ArgumentError, "Missing the required parameter 'region_id' when calling ImmobiliareApi.immobiliare_price_m_time_series"
  end
  # resource path
  local_var_path = '/v1/immobiliare/market-insights/prices'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'region_id'] = region_id
  query_params[:'market'] = opts[:'market'] if !opts[:'market'].nil?
  query_params[:'province_id'] = opts[:'province_id'] if !opts[:'province_id'].nil?
  query_params[:'city_id'] = opts[:'city_id'] if !opts[:'city_id'].nil?
  query_params[:'contract'] = opts[:'contract'] if !opts[:'contract'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"ImmobiliareApi.immobiliare_price_m_time_series",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ImmobiliareApi#immobiliare_price_m_time_series\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#immobiliare_search_listings(opts = {}) ⇒ Object

Search listings Search Immobiliare-group listings (scope by location + contract + filters).

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :market (String) —

    it | es | gr | lu (default to 'it')

  • :location (String) —

    Free-text place (auto-resolved)

  • :region_id (String) —

    fkRegione (from /autocomplete)

  • :province_id (String) —

    idProvincia (from /autocomplete)

  • :city_id (String) —

    idComune (from /autocomplete)

  • :contract (String) —

    sale | rent (default to 'sale')

  • :category (String) —

    see /reference (default to 'residential')

  • :price_min (Integer)
  • :price_max (Integer)
  • :surface_min (Integer)
  • :surface_max (Integer)
  • :rooms_min (Integer)
  • :rooms_max (Integer)
  • :bathrooms_min (Integer)
  • :sort (String) —

    see /reference (default to 'relevance')

  • :page (Integer) — default: default to 1

Returns:

  • (Object) 


617
618
619
620
 
# File 'lib/scrapebadger/api/immobiliare_api.rb', line 617

def immobiliare_search_listings(opts = {})
  data, _status_code, _headers = immobiliare_search_listings_with_http_info(opts)
  data
end

#immobiliare_search_listings_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

Search listings Search Immobiliare-group listings (scope by location + contract + filters).

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :market (String) —

    it | es | gr | lu (default to 'it')

  • :location (String) —

    Free-text place (auto-resolved)

  • :region_id (String) —

    fkRegione (from /autocomplete)

  • :province_id (String) —

    idProvincia (from /autocomplete)

  • :city_id (String) —

    idComune (from /autocomplete)

  • :contract (String) —

    sale | rent (default to 'sale')

  • :category (String) —

    see /reference (default to 'residential')

  • :price_min (Integer)
  • :price_max (Integer)
  • :surface_min (Integer)
  • :surface_max (Integer)
  • :rooms_min (Integer)
  • :rooms_max (Integer)
  • :bathrooms_min (Integer)
  • :sort (String) —

    see /reference (default to 'relevance')

  • :page (Integer) — default: default to 1

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
 
# File 'lib/scrapebadger/api/immobiliare_api.rb', line 642

def immobiliare_search_listings_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ImmobiliareApi.immobiliare_search_listings ...'
  end
  if @api_client.config.client_side_validation && !opts[:'price_min'].nil? && opts[:'price_min'] < 0
    fail ArgumentError, 'invalid value for "opts[:"price_min"]" when calling ImmobiliareApi.immobiliare_search_listings, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'price_max'].nil? && opts[:'price_max'] < 0
    fail ArgumentError, 'invalid value for "opts[:"price_max"]" when calling ImmobiliareApi.immobiliare_search_listings, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'surface_min'].nil? && opts[:'surface_min'] < 0
    fail ArgumentError, 'invalid value for "opts[:"surface_min"]" when calling ImmobiliareApi.immobiliare_search_listings, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'surface_max'].nil? && opts[:'surface_max'] < 0
    fail ArgumentError, 'invalid value for "opts[:"surface_max"]" when calling ImmobiliareApi.immobiliare_search_listings, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'rooms_min'].nil? && opts[:'rooms_min'] < 0
    fail ArgumentError, 'invalid value for "opts[:"rooms_min"]" when calling ImmobiliareApi.immobiliare_search_listings, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'rooms_max'].nil? && opts[:'rooms_max'] < 0
    fail ArgumentError, 'invalid value for "opts[:"rooms_max"]" when calling ImmobiliareApi.immobiliare_search_listings, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'bathrooms_min'].nil? && opts[:'bathrooms_min'] < 0
    fail ArgumentError, 'invalid value for "opts[:"bathrooms_min"]" when calling ImmobiliareApi.immobiliare_search_listings, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling ImmobiliareApi.immobiliare_search_listings, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/immobiliare/search'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'market'] = opts[:'market'] if !opts[:'market'].nil?
  query_params[:'location'] = opts[:'location'] if !opts[:'location'].nil?
  query_params[:'region_id'] = opts[:'region_id'] if !opts[:'region_id'].nil?
  query_params[:'province_id'] = opts[:'province_id'] if !opts[:'province_id'].nil?
  query_params[:'city_id'] = opts[:'city_id'] if !opts[:'city_id'].nil?
  query_params[:'contract'] = opts[:'contract'] if !opts[:'contract'].nil?
  query_params[:'category'] = opts[:'category'] if !opts[:'category'].nil?
  query_params[:'price_min'] = opts[:'price_min'] if !opts[:'price_min'].nil?
  query_params[:'price_max'] = opts[:'price_max'] if !opts[:'price_max'].nil?
  query_params[:'surface_min'] = opts[:'surface_min'] if !opts[:'surface_min'].nil?
  query_params[:'surface_max'] = opts[:'surface_max'] if !opts[:'surface_max'].nil?
  query_params[:'rooms_min'] = opts[:'rooms_min'] if !opts[:'rooms_min'].nil?
  query_params[:'rooms_max'] = opts[:'rooms_max'] if !opts[:'rooms_max'].nil?
  query_params[:'bathrooms_min'] = opts[:'bathrooms_min'] if !opts[:'bathrooms_min'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"ImmobiliareApi.immobiliare_search_listings",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ImmobiliareApi#immobiliare_search_listings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end