scrapebadger 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (185) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/LICENSE +21 -0
  4. data/README.md +548 -0
  5. data/Rakefile +10 -0
  6. data/docs/AccountApi.md +76 -0
  7. data/docs/AccountInfo.md +28 -0
  8. data/docs/AmazonApi.md +1244 -0
  9. data/docs/ApartmentsApi.md +373 -0
  10. data/docs/BaiduApi.md +447 -0
  11. data/docs/BillingLogListResponse.md +24 -0
  12. data/docs/BillingLogResponse.md +32 -0
  13. data/docs/BingApi.md +610 -0
  14. data/docs/ChatGPTApi.md +521 -0
  15. data/docs/DepopApi.md +542 -0
  16. data/docs/DuckDuckGoApi.md +700 -0
  17. data/docs/EBayApi.md +1019 -0
  18. data/docs/FacebookApi.md +1671 -0
  19. data/docs/FilterRuleCreate.md +28 -0
  20. data/docs/FilterRuleDeliveryLogListResponse.md +24 -0
  21. data/docs/FilterRuleDeliveryLogResponse.md +44 -0
  22. data/docs/FilterRuleListResponse.md +24 -0
  23. data/docs/FilterRuleResponse.md +40 -0
  24. data/docs/FilterRuleUpdate.md +30 -0
  25. data/docs/FilterRuleValidateRequest.md +18 -0
  26. data/docs/FilterRuleValidateResponse.md +22 -0
  27. data/docs/GoogleApi.md +3175 -0
  28. data/docs/HTTPValidationError.md +18 -0
  29. data/docs/IdealistaApi.md +822 -0
  30. data/docs/ImmobiliareApi.md +773 -0
  31. data/docs/InstagramApi.md +1673 -0
  32. data/docs/LeboncoinApi.md +884 -0
  33. data/docs/LinkedInApi.md +925 -0
  34. data/docs/LoopNetApi.md +529 -0
  35. data/docs/PortalApiRoutersV1TwitterFilterRulesFilterRulePricingResponse.md +20 -0
  36. data/docs/RealtorApi.md +474 -0
  37. data/docs/RedditApi.md +1677 -0
  38. data/docs/RedfinApi.md +616 -0
  39. data/docs/StreamMonitorCreate.md +26 -0
  40. data/docs/StreamMonitorListResponse.md +24 -0
  41. data/docs/StreamMonitorResponse.md +42 -0
  42. data/docs/StreamMonitorUpdate.md +28 -0
  43. data/docs/SubscriptionInfo.md +40 -0
  44. data/docs/TikTokApi.md +2104 -0
  45. data/docs/TweetDeliveryLogListResponse.md +24 -0
  46. data/docs/TweetDeliveryLogResponse.md +44 -0
  47. data/docs/TwitterApi.md +4091 -0
  48. data/docs/ValidationError.md +22 -0
  49. data/docs/ValidationErrorLocInner.md +15 -0
  50. data/docs/VintedApi.md +766 -0
  51. data/docs/WalmartApi.md +904 -0
  52. data/docs/WebApi.md +634 -0
  53. data/docs/WebhookCreate.md +22 -0
  54. data/docs/WebhookListItem.md +28 -0
  55. data/docs/WebhookListResponse.md +20 -0
  56. data/docs/WebhookResponse.md +26 -0
  57. data/docs/WebhookTestRequest.md +18 -0
  58. data/docs/WebhookTestResponse.md +24 -0
  59. data/docs/YahooApi.md +602 -0
  60. data/docs/YandexApi.md +450 -0
  61. data/docs/YouTubeApi.md +2872 -0
  62. data/docs/ZillowApi.md +622 -0
  63. data/git_push.sh +57 -0
  64. data/lib/scrapebadger/api/account_api.rb +79 -0
  65. data/lib/scrapebadger/api/amazon_api.rb +1165 -0
  66. data/lib/scrapebadger/api/apartments_api.rb +377 -0
  67. data/lib/scrapebadger/api/baidu_api.rb +436 -0
  68. data/lib/scrapebadger/api/bing_api.rb +580 -0
  69. data/lib/scrapebadger/api/chat_gpt_api.rb +466 -0
  70. data/lib/scrapebadger/api/depop_api.rb +518 -0
  71. data/lib/scrapebadger/api/duck_duck_go_api.rb +675 -0
  72. data/lib/scrapebadger/api/e_bay_api.rb +1029 -0
  73. data/lib/scrapebadger/api/facebook_api.rb +1492 -0
  74. data/lib/scrapebadger/api/google_api.rb +3191 -0
  75. data/lib/scrapebadger/api/idealista_api.rb +864 -0
  76. data/lib/scrapebadger/api/immobiliare_api.rb +734 -0
  77. data/lib/scrapebadger/api/instagram_api.rb +1555 -0
  78. data/lib/scrapebadger/api/leboncoin_api.rb +818 -0
  79. data/lib/scrapebadger/api/linked_in_api.rb +832 -0
  80. data/lib/scrapebadger/api/loop_net_api.rb +503 -0
  81. data/lib/scrapebadger/api/realtor_api.rb +481 -0
  82. data/lib/scrapebadger/api/reddit_api.rb +1601 -0
  83. data/lib/scrapebadger/api/redfin_api.rb +625 -0
  84. data/lib/scrapebadger/api/tik_tok_api.rb +2029 -0
  85. data/lib/scrapebadger/api/twitter_api.rb +3696 -0
  86. data/lib/scrapebadger/api/vinted_api.rb +705 -0
  87. data/lib/scrapebadger/api/walmart_api.rb +876 -0
  88. data/lib/scrapebadger/api/web_api.rb +547 -0
  89. data/lib/scrapebadger/api/yahoo_api.rb +560 -0
  90. data/lib/scrapebadger/api/yandex_api.rb +422 -0
  91. data/lib/scrapebadger/api/you_tube_api.rb +2520 -0
  92. data/lib/scrapebadger/api/zillow_api.rb +634 -0
  93. data/lib/scrapebadger/api_client.rb +394 -0
  94. data/lib/scrapebadger/api_error.rb +58 -0
  95. data/lib/scrapebadger/configuration.rb +308 -0
  96. data/lib/scrapebadger/models/account_info.rb +288 -0
  97. data/lib/scrapebadger/models/billing_log_list_response.rb +272 -0
  98. data/lib/scrapebadger/models/billing_log_response.rb +334 -0
  99. data/lib/scrapebadger/models/filter_rule_create.rb +427 -0
  100. data/lib/scrapebadger/models/filter_rule_delivery_log_list_response.rb +272 -0
  101. data/lib/scrapebadger/models/filter_rule_delivery_log_response.rb +422 -0
  102. data/lib/scrapebadger/models/filter_rule_list_response.rb +272 -0
  103. data/lib/scrapebadger/models/filter_rule_response.rb +390 -0
  104. data/lib/scrapebadger/models/filter_rule_update.rb +389 -0
  105. data/lib/scrapebadger/models/filter_rule_validate_request.rb +250 -0
  106. data/lib/scrapebadger/models/filter_rule_validate_response.rb +248 -0
  107. data/lib/scrapebadger/models/http_validation_error.rb +216 -0
  108. data/lib/scrapebadger/models/portal_api_routers_v1_twitter_filter_rules_filter_rule_pricing_response.rb +238 -0
  109. data/lib/scrapebadger/models/stream_monitor_create.rb +373 -0
  110. data/lib/scrapebadger/models/stream_monitor_list_response.rb +272 -0
  111. data/lib/scrapebadger/models/stream_monitor_response.rb +406 -0
  112. data/lib/scrapebadger/models/stream_monitor_update.rb +335 -0
  113. data/lib/scrapebadger/models/subscription_info.rb +352 -0
  114. data/lib/scrapebadger/models/tweet_delivery_log_list_response.rb +272 -0
  115. data/lib/scrapebadger/models/tweet_delivery_log_response.rb +422 -0
  116. data/lib/scrapebadger/models/validation_error.rb +255 -0
  117. data/lib/scrapebadger/models/validation_error_loc_inner.rb +104 -0
  118. data/lib/scrapebadger/models/webhook_create.rb +282 -0
  119. data/lib/scrapebadger/models/webhook_list_item.rb +302 -0
  120. data/lib/scrapebadger/models/webhook_list_response.rb +240 -0
  121. data/lib/scrapebadger/models/webhook_response.rb +286 -0
  122. data/lib/scrapebadger/models/webhook_test_request.rb +223 -0
  123. data/lib/scrapebadger/models/webhook_test_response.rb +259 -0
  124. data/lib/scrapebadger/version.rb +15 -0
  125. data/lib/scrapebadger.rb +96 -0
  126. data/scrapebadger.gemspec +39 -0
  127. data/spec/api/account_api_spec.rb +46 -0
  128. data/spec/api/amazon_api_spec.rb +258 -0
  129. data/spec/api/apartments_api_spec.rb +98 -0
  130. data/spec/api/baidu_api_spec.rb +109 -0
  131. data/spec/api/bing_api_spec.rb +141 -0
  132. data/spec/api/chat_gpt_api_spec.rb +123 -0
  133. data/spec/api/depop_api_spec.rb +132 -0
  134. data/spec/api/duck_duck_go_api_spec.rb +162 -0
  135. data/spec/api/e_bay_api_spec.rb +222 -0
  136. data/spec/api/facebook_api_spec.rb +326 -0
  137. data/spec/api/google_api_spec.rb +649 -0
  138. data/spec/api/idealista_api_spec.rb +197 -0
  139. data/spec/api/immobiliare_api_spec.rb +174 -0
  140. data/spec/api/instagram_api_spec.rb +309 -0
  141. data/spec/api/leboncoin_api_spec.rb +184 -0
  142. data/spec/api/linked_in_api_spec.rb +197 -0
  143. data/spec/api/loop_net_api_spec.rb +127 -0
  144. data/spec/api/realtor_api_spec.rb +123 -0
  145. data/spec/api/reddit_api_spec.rb +331 -0
  146. data/spec/api/redfin_api_spec.rb +147 -0
  147. data/spec/api/tik_tok_api_spec.rb +413 -0
  148. data/spec/api/twitter_api_spec.rb +735 -0
  149. data/spec/api/vinted_api_spec.rb +169 -0
  150. data/spec/api/walmart_api_spec.rb +192 -0
  151. data/spec/api/web_api_spec.rb +136 -0
  152. data/spec/api/yahoo_api_spec.rb +137 -0
  153. data/spec/api/yandex_api_spec.rb +111 -0
  154. data/spec/api/you_tube_api_spec.rb +500 -0
  155. data/spec/api/zillow_api_spec.rb +150 -0
  156. data/spec/models/account_info_spec.rb +66 -0
  157. data/spec/models/billing_log_list_response_spec.rb +54 -0
  158. data/spec/models/billing_log_response_spec.rb +78 -0
  159. data/spec/models/filter_rule_create_spec.rb +66 -0
  160. data/spec/models/filter_rule_delivery_log_list_response_spec.rb +54 -0
  161. data/spec/models/filter_rule_delivery_log_response_spec.rb +114 -0
  162. data/spec/models/filter_rule_list_response_spec.rb +54 -0
  163. data/spec/models/filter_rule_response_spec.rb +102 -0
  164. data/spec/models/filter_rule_update_spec.rb +72 -0
  165. data/spec/models/filter_rule_validate_request_spec.rb +36 -0
  166. data/spec/models/filter_rule_validate_response_spec.rb +48 -0
  167. data/spec/models/http_validation_error_spec.rb +36 -0
  168. data/spec/models/portal_api_routers_v1_twitter_filter_rules_filter_rule_pricing_response_spec.rb +42 -0
  169. data/spec/models/stream_monitor_create_spec.rb +60 -0
  170. data/spec/models/stream_monitor_list_response_spec.rb +54 -0
  171. data/spec/models/stream_monitor_response_spec.rb +108 -0
  172. data/spec/models/stream_monitor_update_spec.rb +66 -0
  173. data/spec/models/subscription_info_spec.rb +102 -0
  174. data/spec/models/tweet_delivery_log_list_response_spec.rb +54 -0
  175. data/spec/models/tweet_delivery_log_response_spec.rb +114 -0
  176. data/spec/models/validation_error_loc_inner_spec.rb +21 -0
  177. data/spec/models/validation_error_spec.rb +48 -0
  178. data/spec/models/webhook_create_spec.rb +48 -0
  179. data/spec/models/webhook_list_item_spec.rb +66 -0
  180. data/spec/models/webhook_list_response_spec.rb +42 -0
  181. data/spec/models/webhook_response_spec.rb +60 -0
  182. data/spec/models/webhook_test_request_spec.rb +36 -0
  183. data/spec/models/webhook_test_response_spec.rb +54 -0
  184. data/spec/spec_helper.rb +111 -0
  185. metadata +324 -0
@@ -0,0 +1,634 @@
1
+ =begin
2
+ #ScrapeBadger API
3
+
4
+ #Unified credit-based scraping API. https://docs.scrapebadger.com
5
+
6
+ The version of the OpenAPI document: 0.1.0
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.10.0
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module ScrapeBadger
16
+ class ZillowApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Get agent profile + listings
23
+ # Get a Zillow professional's profile and their active listings.
24
+ # @param [Hash] opts the optional parameters
25
+ # @option opts [String] :username Zillow profile username
26
+ # @option opts [String] :url Full Zillow /profile/... URL
27
+ # @return [Object]
28
+ def zillow_get_agent_profile_listings(opts = {})
29
+ data, _status_code, _headers = zillow_get_agent_profile_listings_with_http_info(opts)
30
+ data
31
+ end
32
+
33
+ # Get agent profile + listings
34
+ # Get a Zillow professional's profile and their active listings.
35
+ # @param [Hash] opts the optional parameters
36
+ # @option opts [String] :username Zillow profile username
37
+ # @option opts [String] :url Full Zillow /profile/... URL
38
+ # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
39
+ def zillow_get_agent_profile_listings_with_http_info(opts = {})
40
+ if @api_client.config.debugging
41
+ @api_client.config.logger.debug 'Calling API: ZillowApi.zillow_get_agent_profile_listings ...'
42
+ end
43
+ # resource path
44
+ local_var_path = '/v1/zillow/agent'
45
+
46
+ # query parameters
47
+ query_params = opts[:query_params] || {}
48
+ query_params[:'username'] = opts[:'username'] if !opts[:'username'].nil?
49
+ query_params[:'url'] = opts[:'url'] if !opts[:'url'].nil?
50
+
51
+ # header parameters
52
+ header_params = opts[:header_params] || {}
53
+ # HTTP header 'Accept' (if needed)
54
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
55
+
56
+ # form parameters
57
+ form_params = opts[:form_params] || {}
58
+
59
+ # http body (model)
60
+ post_body = opts[:debug_body]
61
+
62
+ # return_type
63
+ return_type = opts[:debug_return_type] || 'Object'
64
+
65
+ # auth_names
66
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
67
+
68
+ new_options = opts.merge(
69
+ :operation => :"ZillowApi.zillow_get_agent_profile_listings",
70
+ :header_params => header_params,
71
+ :query_params => query_params,
72
+ :form_params => form_params,
73
+ :body => post_body,
74
+ :auth_names => auth_names,
75
+ :return_type => return_type
76
+ )
77
+
78
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
79
+ if @api_client.config.debugging
80
+ @api_client.config.logger.debug "API called: ZillowApi#zillow_get_agent_profile_listings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
81
+ end
82
+ return data, status_code, headers
83
+ end
84
+
85
+ # Get property detail
86
+ # Get a single Zillow property's full detail by zpid.
87
+ # @param zpid [String]
88
+ # @param [Hash] opts the optional parameters
89
+ # @return [Object]
90
+ def zillow_get_property_detail(zpid, opts = {})
91
+ data, _status_code, _headers = zillow_get_property_detail_with_http_info(zpid, opts)
92
+ data
93
+ end
94
+
95
+ # Get property detail
96
+ # Get a single Zillow property&#39;s full detail by zpid.
97
+ # @param zpid [String]
98
+ # @param [Hash] opts the optional parameters
99
+ # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
100
+ def zillow_get_property_detail_with_http_info(zpid, opts = {})
101
+ if @api_client.config.debugging
102
+ @api_client.config.logger.debug 'Calling API: ZillowApi.zillow_get_property_detail ...'
103
+ end
104
+ # verify the required parameter 'zpid' is set
105
+ if @api_client.config.client_side_validation && zpid.nil?
106
+ fail ArgumentError, "Missing the required parameter 'zpid' when calling ZillowApi.zillow_get_property_detail"
107
+ end
108
+ # resource path
109
+ local_var_path = '/v1/zillow/property/{zpid}'.sub('{' + 'zpid' + '}', CGI.escape(zpid.to_s))
110
+
111
+ # query parameters
112
+ query_params = opts[:query_params] || {}
113
+
114
+ # header parameters
115
+ header_params = opts[:header_params] || {}
116
+ # HTTP header 'Accept' (if needed)
117
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
118
+
119
+ # form parameters
120
+ form_params = opts[:form_params] || {}
121
+
122
+ # http body (model)
123
+ post_body = opts[:debug_body]
124
+
125
+ # return_type
126
+ return_type = opts[:debug_return_type] || 'Object'
127
+
128
+ # auth_names
129
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
130
+
131
+ new_options = opts.merge(
132
+ :operation => :"ZillowApi.zillow_get_property_detail",
133
+ :header_params => header_params,
134
+ :query_params => query_params,
135
+ :form_params => form_params,
136
+ :body => post_body,
137
+ :auth_names => auth_names,
138
+ :return_type => return_type
139
+ )
140
+
141
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
142
+ if @api_client.config.debugging
143
+ @api_client.config.logger.debug "API called: ZillowApi#zillow_get_property_detail\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
144
+ end
145
+ return data, status_code, headers
146
+ end
147
+
148
+ # Get property detail by URL
149
+ # Get a single Zillow property's full detail by its homedetails URL.
150
+ # @param url [String] Full Zillow /homedetails/... URL
151
+ # @param [Hash] opts the optional parameters
152
+ # @return [Object]
153
+ def zillow_get_property_detail_by_url(url, opts = {})
154
+ data, _status_code, _headers = zillow_get_property_detail_by_url_with_http_info(url, opts)
155
+ data
156
+ end
157
+
158
+ # Get property detail by URL
159
+ # Get a single Zillow property&#39;s full detail by its homedetails URL.
160
+ # @param url [String] Full Zillow /homedetails/... URL
161
+ # @param [Hash] opts the optional parameters
162
+ # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
163
+ def zillow_get_property_detail_by_url_with_http_info(url, opts = {})
164
+ if @api_client.config.debugging
165
+ @api_client.config.logger.debug 'Calling API: ZillowApi.zillow_get_property_detail_by_url ...'
166
+ end
167
+ # verify the required parameter 'url' is set
168
+ if @api_client.config.client_side_validation && url.nil?
169
+ fail ArgumentError, "Missing the required parameter 'url' when calling ZillowApi.zillow_get_property_detail_by_url"
170
+ end
171
+ # resource path
172
+ local_var_path = '/v1/zillow/property'
173
+
174
+ # query parameters
175
+ query_params = opts[:query_params] || {}
176
+ query_params[:'url'] = url
177
+
178
+ # header parameters
179
+ header_params = opts[:header_params] || {}
180
+ # HTTP header 'Accept' (if needed)
181
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
182
+
183
+ # form parameters
184
+ form_params = opts[:form_params] || {}
185
+
186
+ # http body (model)
187
+ post_body = opts[:debug_body]
188
+
189
+ # return_type
190
+ return_type = opts[:debug_return_type] || 'Object'
191
+
192
+ # auth_names
193
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
194
+
195
+ new_options = opts.merge(
196
+ :operation => :"ZillowApi.zillow_get_property_detail_by_url",
197
+ :header_params => header_params,
198
+ :query_params => query_params,
199
+ :form_params => form_params,
200
+ :body => post_body,
201
+ :auth_names => auth_names,
202
+ :return_type => return_type
203
+ )
204
+
205
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
206
+ if @api_client.config.debugging
207
+ @api_client.config.logger.debug "API called: ZillowApi#zillow_get_property_detail_by_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
208
+ end
209
+ return data, status_code, headers
210
+ end
211
+
212
+ # List coverage markets
213
+ # List Zillow coverage regions (US + Canada).
214
+ # @param [Hash] opts the optional parameters
215
+ # @return [Object]
216
+ def zillow_list_coverage_markets(opts = {})
217
+ data, _status_code, _headers = zillow_list_coverage_markets_with_http_info(opts)
218
+ data
219
+ end
220
+
221
+ # List coverage markets
222
+ # List Zillow coverage regions (US + Canada).
223
+ # @param [Hash] opts the optional parameters
224
+ # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
225
+ def zillow_list_coverage_markets_with_http_info(opts = {})
226
+ if @api_client.config.debugging
227
+ @api_client.config.logger.debug 'Calling API: ZillowApi.zillow_list_coverage_markets ...'
228
+ end
229
+ # resource path
230
+ local_var_path = '/v1/zillow/markets'
231
+
232
+ # query parameters
233
+ query_params = opts[:query_params] || {}
234
+
235
+ # header parameters
236
+ header_params = opts[:header_params] || {}
237
+ # HTTP header 'Accept' (if needed)
238
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
239
+
240
+ # form parameters
241
+ form_params = opts[:form_params] || {}
242
+
243
+ # http body (model)
244
+ post_body = opts[:debug_body]
245
+
246
+ # return_type
247
+ return_type = opts[:debug_return_type] || 'Object'
248
+
249
+ # auth_names
250
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
251
+
252
+ new_options = opts.merge(
253
+ :operation => :"ZillowApi.zillow_list_coverage_markets",
254
+ :header_params => header_params,
255
+ :query_params => query_params,
256
+ :form_params => form_params,
257
+ :body => post_body,
258
+ :auth_names => auth_names,
259
+ :return_type => return_type
260
+ )
261
+
262
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
263
+ if @api_client.config.debugging
264
+ @api_client.config.logger.debug "API called: ZillowApi#zillow_list_coverage_markets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
265
+ end
266
+ return data, status_code, headers
267
+ end
268
+
269
+ # Region/address suggestions
270
+ # Resolve a search term to Zillow regions/addresses.
271
+ # @param query [String] Partial location — city, ZIP, address, neighborhood
272
+ # @param [Hash] opts the optional parameters
273
+ # @return [Object]
274
+ def zillow_region_address_suggestions(query, opts = {})
275
+ data, _status_code, _headers = zillow_region_address_suggestions_with_http_info(query, opts)
276
+ data
277
+ end
278
+
279
+ # Region/address suggestions
280
+ # Resolve a search term to Zillow regions/addresses.
281
+ # @param query [String] Partial location — city, ZIP, address, neighborhood
282
+ # @param [Hash] opts the optional parameters
283
+ # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
284
+ def zillow_region_address_suggestions_with_http_info(query, opts = {})
285
+ if @api_client.config.debugging
286
+ @api_client.config.logger.debug 'Calling API: ZillowApi.zillow_region_address_suggestions ...'
287
+ end
288
+ # verify the required parameter 'query' is set
289
+ if @api_client.config.client_side_validation && query.nil?
290
+ fail ArgumentError, "Missing the required parameter 'query' when calling ZillowApi.zillow_region_address_suggestions"
291
+ end
292
+ # resource path
293
+ local_var_path = '/v1/zillow/autocomplete'
294
+
295
+ # query parameters
296
+ query_params = opts[:query_params] || {}
297
+ query_params[:'query'] = query
298
+
299
+ # header parameters
300
+ header_params = opts[:header_params] || {}
301
+ # HTTP header 'Accept' (if needed)
302
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
303
+
304
+ # form parameters
305
+ form_params = opts[:form_params] || {}
306
+
307
+ # http body (model)
308
+ post_body = opts[:debug_body]
309
+
310
+ # return_type
311
+ return_type = opts[:debug_return_type] || 'Object'
312
+
313
+ # auth_names
314
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
315
+
316
+ new_options = opts.merge(
317
+ :operation => :"ZillowApi.zillow_region_address_suggestions",
318
+ :header_params => header_params,
319
+ :query_params => query_params,
320
+ :form_params => form_params,
321
+ :body => post_body,
322
+ :auth_names => auth_names,
323
+ :return_type => return_type
324
+ )
325
+
326
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
327
+ if @api_client.config.debugging
328
+ @api_client.config.logger.debug "API called: ZillowApi#zillow_region_address_suggestions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
329
+ end
330
+ return data, status_code, headers
331
+ end
332
+
333
+ # Search properties
334
+ # Search Zillow for for-sale / for-rent / recently-sold properties.
335
+ # @param location [String] City/state, ZIP, address or neighborhood
336
+ # @param [Hash] opts the optional parameters
337
+ # @option opts [String] :status for_sale|for_rent|sold (default to 'for_sale')
338
+ # @option opts [Integer] :page (default to 1)
339
+ # @option opts [String] :sort homes_for_you|newest|price_high_to_low|price_low_to_high|bedrooms|bathrooms|square_feet|lot_size|year_built
340
+ # @option opts [Integer] :price_min
341
+ # @option opts [Integer] :price_max
342
+ # @option opts [Integer] :beds_min
343
+ # @option opts [Float] :baths_min
344
+ # @option opts [String] :home_type houses|condos|townhomes|apartments|manufactured|lots|multi_family
345
+ # @option opts [Integer] :sqft_min
346
+ # @option opts [Integer] :sqft_max
347
+ # @option opts [Integer] :lot_min
348
+ # @option opts [Integer] :lot_max
349
+ # @option opts [Integer] :year_built_min
350
+ # @option opts [Integer] :year_built_max
351
+ # @option opts [Integer] :hoa_max
352
+ # @option opts [String] :keywords
353
+ # @option opts [String] :days_on
354
+ # @option opts [Float] :north Map bounds for tiling past the 820 cap
355
+ # @option opts [Float] :south
356
+ # @option opts [Float] :east
357
+ # @option opts [Float] :west
358
+ # @return [Object]
359
+ def zillow_search_properties(location, opts = {})
360
+ data, _status_code, _headers = zillow_search_properties_with_http_info(location, opts)
361
+ data
362
+ end
363
+
364
+ # Search properties
365
+ # Search Zillow for for-sale / for-rent / recently-sold properties.
366
+ # @param location [String] City/state, ZIP, address or neighborhood
367
+ # @param [Hash] opts the optional parameters
368
+ # @option opts [String] :status for_sale|for_rent|sold (default to 'for_sale')
369
+ # @option opts [Integer] :page (default to 1)
370
+ # @option opts [String] :sort homes_for_you|newest|price_high_to_low|price_low_to_high|bedrooms|bathrooms|square_feet|lot_size|year_built
371
+ # @option opts [Integer] :price_min
372
+ # @option opts [Integer] :price_max
373
+ # @option opts [Integer] :beds_min
374
+ # @option opts [Float] :baths_min
375
+ # @option opts [String] :home_type houses|condos|townhomes|apartments|manufactured|lots|multi_family
376
+ # @option opts [Integer] :sqft_min
377
+ # @option opts [Integer] :sqft_max
378
+ # @option opts [Integer] :lot_min
379
+ # @option opts [Integer] :lot_max
380
+ # @option opts [Integer] :year_built_min
381
+ # @option opts [Integer] :year_built_max
382
+ # @option opts [Integer] :hoa_max
383
+ # @option opts [String] :keywords
384
+ # @option opts [String] :days_on
385
+ # @option opts [Float] :north Map bounds for tiling past the 820 cap
386
+ # @option opts [Float] :south
387
+ # @option opts [Float] :east
388
+ # @option opts [Float] :west
389
+ # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
390
+ def zillow_search_properties_with_http_info(location, opts = {})
391
+ if @api_client.config.debugging
392
+ @api_client.config.logger.debug 'Calling API: ZillowApi.zillow_search_properties ...'
393
+ end
394
+ # verify the required parameter 'location' is set
395
+ if @api_client.config.client_side_validation && location.nil?
396
+ fail ArgumentError, "Missing the required parameter 'location' when calling ZillowApi.zillow_search_properties"
397
+ end
398
+ if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] > 20
399
+ fail ArgumentError, 'invalid value for "opts[:"page"]" when calling ZillowApi.zillow_search_properties, must be smaller than or equal to 20.'
400
+ end
401
+
402
+ if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
403
+ fail ArgumentError, 'invalid value for "opts[:"page"]" when calling ZillowApi.zillow_search_properties, must be greater than or equal to 1.'
404
+ end
405
+
406
+ if @api_client.config.client_side_validation && !opts[:'price_min'].nil? && opts[:'price_min'] < 0
407
+ fail ArgumentError, 'invalid value for "opts[:"price_min"]" when calling ZillowApi.zillow_search_properties, must be greater than or equal to 0.'
408
+ end
409
+
410
+ if @api_client.config.client_side_validation && !opts[:'price_max'].nil? && opts[:'price_max'] < 0
411
+ fail ArgumentError, 'invalid value for "opts[:"price_max"]" when calling ZillowApi.zillow_search_properties, must be greater than or equal to 0.'
412
+ end
413
+
414
+ if @api_client.config.client_side_validation && !opts[:'beds_min'].nil? && opts[:'beds_min'] > 10
415
+ fail ArgumentError, 'invalid value for "opts[:"beds_min"]" when calling ZillowApi.zillow_search_properties, must be smaller than or equal to 10.'
416
+ end
417
+
418
+ if @api_client.config.client_side_validation && !opts[:'beds_min'].nil? && opts[:'beds_min'] < 0
419
+ fail ArgumentError, 'invalid value for "opts[:"beds_min"]" when calling ZillowApi.zillow_search_properties, must be greater than or equal to 0.'
420
+ end
421
+
422
+ if @api_client.config.client_side_validation && !opts[:'baths_min'].nil? && opts[:'baths_min'] > 10
423
+ fail ArgumentError, 'invalid value for "opts[:"baths_min"]" when calling ZillowApi.zillow_search_properties, must be smaller than or equal to 10.'
424
+ end
425
+
426
+ if @api_client.config.client_side_validation && !opts[:'baths_min'].nil? && opts[:'baths_min'] < 0
427
+ fail ArgumentError, 'invalid value for "opts[:"baths_min"]" when calling ZillowApi.zillow_search_properties, must be greater than or equal to 0.'
428
+ end
429
+
430
+ if @api_client.config.client_side_validation && !opts[:'sqft_min'].nil? && opts[:'sqft_min'] < 0
431
+ fail ArgumentError, 'invalid value for "opts[:"sqft_min"]" when calling ZillowApi.zillow_search_properties, must be greater than or equal to 0.'
432
+ end
433
+
434
+ if @api_client.config.client_side_validation && !opts[:'sqft_max'].nil? && opts[:'sqft_max'] < 0
435
+ fail ArgumentError, 'invalid value for "opts[:"sqft_max"]" when calling ZillowApi.zillow_search_properties, must be greater than or equal to 0.'
436
+ end
437
+
438
+ if @api_client.config.client_side_validation && !opts[:'lot_min'].nil? && opts[:'lot_min'] < 0
439
+ fail ArgumentError, 'invalid value for "opts[:"lot_min"]" when calling ZillowApi.zillow_search_properties, must be greater than or equal to 0.'
440
+ end
441
+
442
+ if @api_client.config.client_side_validation && !opts[:'lot_max'].nil? && opts[:'lot_max'] < 0
443
+ fail ArgumentError, 'invalid value for "opts[:"lot_max"]" when calling ZillowApi.zillow_search_properties, must be greater than or equal to 0.'
444
+ end
445
+
446
+ if @api_client.config.client_side_validation && !opts[:'year_built_min'].nil? && opts[:'year_built_min'] < 1800
447
+ fail ArgumentError, 'invalid value for "opts[:"year_built_min"]" when calling ZillowApi.zillow_search_properties, must be greater than or equal to 1800.'
448
+ end
449
+
450
+ if @api_client.config.client_side_validation && !opts[:'year_built_max'].nil? && opts[:'year_built_max'] < 1800
451
+ fail ArgumentError, 'invalid value for "opts[:"year_built_max"]" when calling ZillowApi.zillow_search_properties, must be greater than or equal to 1800.'
452
+ end
453
+
454
+ if @api_client.config.client_side_validation && !opts[:'hoa_max'].nil? && opts[:'hoa_max'] < 0
455
+ fail ArgumentError, 'invalid value for "opts[:"hoa_max"]" when calling ZillowApi.zillow_search_properties, must be greater than or equal to 0.'
456
+ end
457
+
458
+ # resource path
459
+ local_var_path = '/v1/zillow/search'
460
+
461
+ # query parameters
462
+ query_params = opts[:query_params] || {}
463
+ query_params[:'location'] = location
464
+ query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
465
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
466
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
467
+ query_params[:'price_min'] = opts[:'price_min'] if !opts[:'price_min'].nil?
468
+ query_params[:'price_max'] = opts[:'price_max'] if !opts[:'price_max'].nil?
469
+ query_params[:'beds_min'] = opts[:'beds_min'] if !opts[:'beds_min'].nil?
470
+ query_params[:'baths_min'] = opts[:'baths_min'] if !opts[:'baths_min'].nil?
471
+ query_params[:'home_type'] = opts[:'home_type'] if !opts[:'home_type'].nil?
472
+ query_params[:'sqft_min'] = opts[:'sqft_min'] if !opts[:'sqft_min'].nil?
473
+ query_params[:'sqft_max'] = opts[:'sqft_max'] if !opts[:'sqft_max'].nil?
474
+ query_params[:'lot_min'] = opts[:'lot_min'] if !opts[:'lot_min'].nil?
475
+ query_params[:'lot_max'] = opts[:'lot_max'] if !opts[:'lot_max'].nil?
476
+ query_params[:'year_built_min'] = opts[:'year_built_min'] if !opts[:'year_built_min'].nil?
477
+ query_params[:'year_built_max'] = opts[:'year_built_max'] if !opts[:'year_built_max'].nil?
478
+ query_params[:'hoa_max'] = opts[:'hoa_max'] if !opts[:'hoa_max'].nil?
479
+ query_params[:'keywords'] = opts[:'keywords'] if !opts[:'keywords'].nil?
480
+ query_params[:'days_on'] = opts[:'days_on'] if !opts[:'days_on'].nil?
481
+ query_params[:'north'] = opts[:'north'] if !opts[:'north'].nil?
482
+ query_params[:'south'] = opts[:'south'] if !opts[:'south'].nil?
483
+ query_params[:'east'] = opts[:'east'] if !opts[:'east'].nil?
484
+ query_params[:'west'] = opts[:'west'] if !opts[:'west'].nil?
485
+
486
+ # header parameters
487
+ header_params = opts[:header_params] || {}
488
+ # HTTP header 'Accept' (if needed)
489
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
490
+
491
+ # form parameters
492
+ form_params = opts[:form_params] || {}
493
+
494
+ # http body (model)
495
+ post_body = opts[:debug_body]
496
+
497
+ # return_type
498
+ return_type = opts[:debug_return_type] || 'Object'
499
+
500
+ # auth_names
501
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
502
+
503
+ new_options = opts.merge(
504
+ :operation => :"ZillowApi.zillow_search_properties",
505
+ :header_params => header_params,
506
+ :query_params => query_params,
507
+ :form_params => form_params,
508
+ :body => post_body,
509
+ :auth_names => auth_names,
510
+ :return_type => return_type
511
+ )
512
+
513
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
514
+ if @api_client.config.debugging
515
+ @api_client.config.logger.debug "API called: ZillowApi#zillow_search_properties\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
516
+ end
517
+ return data, status_code, headers
518
+ end
519
+
520
+ # Zillow scraper health check
521
+ # Check health of the Zillow scraper service (accepts HEAD for UptimeRobot).
522
+ # @param [Hash] opts the optional parameters
523
+ # @return [Object]
524
+ def zillow_zillow_scraper_health_check(opts = {})
525
+ data, _status_code, _headers = zillow_zillow_scraper_health_check_with_http_info(opts)
526
+ data
527
+ end
528
+
529
+ # Zillow scraper health check
530
+ # Check health of the Zillow scraper service (accepts HEAD for UptimeRobot).
531
+ # @param [Hash] opts the optional parameters
532
+ # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
533
+ def zillow_zillow_scraper_health_check_with_http_info(opts = {})
534
+ if @api_client.config.debugging
535
+ @api_client.config.logger.debug 'Calling API: ZillowApi.zillow_zillow_scraper_health_check ...'
536
+ end
537
+ # resource path
538
+ local_var_path = '/v1/zillow/health'
539
+
540
+ # query parameters
541
+ query_params = opts[:query_params] || {}
542
+
543
+ # header parameters
544
+ header_params = opts[:header_params] || {}
545
+ # HTTP header 'Accept' (if needed)
546
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
547
+
548
+ # form parameters
549
+ form_params = opts[:form_params] || {}
550
+
551
+ # http body (model)
552
+ post_body = opts[:debug_body]
553
+
554
+ # return_type
555
+ return_type = opts[:debug_return_type] || 'Object'
556
+
557
+ # auth_names
558
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
559
+
560
+ new_options = opts.merge(
561
+ :operation => :"ZillowApi.zillow_zillow_scraper_health_check",
562
+ :header_params => header_params,
563
+ :query_params => query_params,
564
+ :form_params => form_params,
565
+ :body => post_body,
566
+ :auth_names => auth_names,
567
+ :return_type => return_type
568
+ )
569
+
570
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
571
+ if @api_client.config.debugging
572
+ @api_client.config.logger.debug "API called: ZillowApi#zillow_zillow_scraper_health_check\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
573
+ end
574
+ return data, status_code, headers
575
+ end
576
+
577
+ # Zillow scraper health check
578
+ # Check health of the Zillow scraper service (accepts HEAD for UptimeRobot).
579
+ # @param [Hash] opts the optional parameters
580
+ # @return [Object]
581
+ def zillow_zillow_scraper_health_check_head(opts = {})
582
+ data, _status_code, _headers = zillow_zillow_scraper_health_check_head_with_http_info(opts)
583
+ data
584
+ end
585
+
586
+ # Zillow scraper health check
587
+ # Check health of the Zillow scraper service (accepts HEAD for UptimeRobot).
588
+ # @param [Hash] opts the optional parameters
589
+ # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
590
+ def zillow_zillow_scraper_health_check_head_with_http_info(opts = {})
591
+ if @api_client.config.debugging
592
+ @api_client.config.logger.debug 'Calling API: ZillowApi.zillow_zillow_scraper_health_check_head ...'
593
+ end
594
+ # resource path
595
+ local_var_path = '/v1/zillow/health'
596
+
597
+ # query parameters
598
+ query_params = opts[:query_params] || {}
599
+
600
+ # header parameters
601
+ header_params = opts[:header_params] || {}
602
+ # HTTP header 'Accept' (if needed)
603
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
604
+
605
+ # form parameters
606
+ form_params = opts[:form_params] || {}
607
+
608
+ # http body (model)
609
+ post_body = opts[:debug_body]
610
+
611
+ # return_type
612
+ return_type = opts[:debug_return_type] || 'Object'
613
+
614
+ # auth_names
615
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
616
+
617
+ new_options = opts.merge(
618
+ :operation => :"ZillowApi.zillow_zillow_scraper_health_check_head",
619
+ :header_params => header_params,
620
+ :query_params => query_params,
621
+ :form_params => form_params,
622
+ :body => post_body,
623
+ :auth_names => auth_names,
624
+ :return_type => return_type
625
+ )
626
+
627
+ data, status_code, headers = @api_client.call_api(:HEAD, local_var_path, new_options)
628
+ if @api_client.config.debugging
629
+ @api_client.config.logger.debug "API called: ZillowApi#zillow_zillow_scraper_health_check_head\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
630
+ end
631
+ return data, status_code, headers
632
+ end
633
+ end
634
+ end