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,904 @@
1
+ # ScrapeBadger::WalmartApi
2
+
3
+ All URIs are relative to *https://scrapebadger.com*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**walmart_browse_a_category**](WalmartApi.md#walmart_browse_a_category) | **GET** /v1/walmart/category | Browse a category |
8
+ | [**walmart_deals_rollbacks_and_clearance**](WalmartApi.md#walmart_deals_rollbacks_and_clearance) | **GET** /v1/walmart/deals | Deals, rollbacks and clearance |
9
+ | [**walmart_get_a_seller_s_catalogue**](WalmartApi.md#walmart_get_a_seller_s_catalogue) | **GET** /v1/walmart/sellers/{seller_id}/products | Get a seller's catalogue |
10
+ | [**walmart_get_product_detail**](WalmartApi.md#walmart_get_product_detail) | **GET** /v1/walmart/products/{item_id} | Get product detail |
11
+ | [**walmart_get_product_reviews**](WalmartApi.md#walmart_get_product_reviews) | **GET** /v1/walmart/products/{item_id}/reviews | Get product reviews |
12
+ | [**walmart_get_seller_profile**](WalmartApi.md#walmart_get_seller_profile) | **GET** /v1/walmart/sellers/{seller_id} | Get seller profile |
13
+ | [**walmart_get_store_nearby_stores**](WalmartApi.md#walmart_get_store_nearby_stores) | **GET** /v1/walmart/stores/{store_id} | Get store + nearby stores |
14
+ | [**walmart_list_supported_markets**](WalmartApi.md#walmart_list_supported_markets) | **GET** /v1/walmart/markets | List supported markets |
15
+ | [**walmart_search_products**](WalmartApi.md#walmart_search_products) | **GET** /v1/walmart/search | Search products |
16
+ | [**walmart_search_suggestions**](WalmartApi.md#walmart_search_suggestions) | **GET** /v1/walmart/autocomplete | Search suggestions |
17
+ | [**walmart_walmart_scraper_health_check**](WalmartApi.md#walmart_walmart_scraper_health_check) | **GET** /v1/walmart/health | Walmart scraper health check |
18
+ | [**walmart_walmart_scraper_health_check_head**](WalmartApi.md#walmart_walmart_scraper_health_check_head) | **HEAD** /v1/walmart/health | Walmart scraper health check |
19
+
20
+
21
+ ## walmart_browse_a_category
22
+
23
+ > Object walmart_browse_a_category(path, opts)
24
+
25
+ Browse a category
26
+
27
+ Browse a Walmart category. Same result shape as search. No `sort`: Walmart's browse pages ignore it. Sort on `/search` instead.
28
+
29
+ ### Examples
30
+
31
+ ```ruby
32
+ require 'time'
33
+ require 'scrapebadger'
34
+ # setup authorization
35
+ ScrapeBadger.configure do |config|
36
+ # Configure API key authorization: ApiKeyAuth
37
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
38
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
39
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
40
+ end
41
+
42
+ api_instance = ScrapeBadger::WalmartApi.new
43
+ path = 'path_example' # String | Browse path, e.g. 'electronics/3944', or a '/cp/...' path
44
+ opts = {
45
+ page: 56, # Integer |
46
+ min_price: 8.14, # Float |
47
+ max_price: 8.14, # Float |
48
+ facet: 'facet_example' # String |
49
+ }
50
+
51
+ begin
52
+ # Browse a category
53
+ result = api_instance.walmart_browse_a_category(path, opts)
54
+ p result
55
+ rescue ScrapeBadger::ApiError => e
56
+ puts "Error when calling WalmartApi->walmart_browse_a_category: #{e}"
57
+ end
58
+ ```
59
+
60
+ #### Using the walmart_browse_a_category_with_http_info variant
61
+
62
+ This returns an Array which contains the response data, status code and headers.
63
+
64
+ > <Array(Object, Integer, Hash)> walmart_browse_a_category_with_http_info(path, opts)
65
+
66
+ ```ruby
67
+ begin
68
+ # Browse a category
69
+ data, status_code, headers = api_instance.walmart_browse_a_category_with_http_info(path, opts)
70
+ p status_code # => 2xx
71
+ p headers # => { ... }
72
+ p data # => Object
73
+ rescue ScrapeBadger::ApiError => e
74
+ puts "Error when calling WalmartApi->walmart_browse_a_category_with_http_info: #{e}"
75
+ end
76
+ ```
77
+
78
+ ### Parameters
79
+
80
+ | Name | Type | Description | Notes |
81
+ | ---- | ---- | ----------- | ----- |
82
+ | **path** | **String** | Browse path, e.g. &#39;electronics/3944&#39;, or a &#39;/cp/...&#39; path | |
83
+ | **page** | **Integer** | | [optional][default to 1] |
84
+ | **min_price** | **Float** | | [optional] |
85
+ | **max_price** | **Float** | | [optional] |
86
+ | **facet** | **String** | | [optional] |
87
+
88
+ ### Return type
89
+
90
+ **Object**
91
+
92
+ ### Authorization
93
+
94
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
95
+
96
+ ### HTTP request headers
97
+
98
+ - **Content-Type**: Not defined
99
+ - **Accept**: application/json
100
+
101
+
102
+ ## walmart_deals_rollbacks_and_clearance
103
+
104
+ > Object walmart_deals_rollbacks_and_clearance(opts)
105
+
106
+ Deals, rollbacks and clearance
107
+
108
+ Walmart's current deals, rollbacks and clearance.
109
+
110
+ ### Examples
111
+
112
+ ```ruby
113
+ require 'time'
114
+ require 'scrapebadger'
115
+ # setup authorization
116
+ ScrapeBadger.configure do |config|
117
+ # Configure API key authorization: ApiKeyAuth
118
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
119
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
120
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
121
+ end
122
+
123
+ api_instance = ScrapeBadger::WalmartApi.new
124
+ opts = {
125
+ page: 56, # Integer |
126
+ min_price: 8.14, # Float |
127
+ max_price: 8.14 # Float |
128
+ }
129
+
130
+ begin
131
+ # Deals, rollbacks and clearance
132
+ result = api_instance.walmart_deals_rollbacks_and_clearance(opts)
133
+ p result
134
+ rescue ScrapeBadger::ApiError => e
135
+ puts "Error when calling WalmartApi->walmart_deals_rollbacks_and_clearance: #{e}"
136
+ end
137
+ ```
138
+
139
+ #### Using the walmart_deals_rollbacks_and_clearance_with_http_info variant
140
+
141
+ This returns an Array which contains the response data, status code and headers.
142
+
143
+ > <Array(Object, Integer, Hash)> walmart_deals_rollbacks_and_clearance_with_http_info(opts)
144
+
145
+ ```ruby
146
+ begin
147
+ # Deals, rollbacks and clearance
148
+ data, status_code, headers = api_instance.walmart_deals_rollbacks_and_clearance_with_http_info(opts)
149
+ p status_code # => 2xx
150
+ p headers # => { ... }
151
+ p data # => Object
152
+ rescue ScrapeBadger::ApiError => e
153
+ puts "Error when calling WalmartApi->walmart_deals_rollbacks_and_clearance_with_http_info: #{e}"
154
+ end
155
+ ```
156
+
157
+ ### Parameters
158
+
159
+ | Name | Type | Description | Notes |
160
+ | ---- | ---- | ----------- | ----- |
161
+ | **page** | **Integer** | | [optional][default to 1] |
162
+ | **min_price** | **Float** | | [optional] |
163
+ | **max_price** | **Float** | | [optional] |
164
+
165
+ ### Return type
166
+
167
+ **Object**
168
+
169
+ ### Authorization
170
+
171
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
172
+
173
+ ### HTTP request headers
174
+
175
+ - **Content-Type**: Not defined
176
+ - **Accept**: application/json
177
+
178
+
179
+ ## walmart_get_a_seller_s_catalogue
180
+
181
+ > Object walmart_get_a_seller_s_catalogue(seller_id, query, opts)
182
+
183
+ Get a seller's catalogue
184
+
185
+ A marketplace seller's catalogue, scoped by a search term.
186
+
187
+ ### Examples
188
+
189
+ ```ruby
190
+ require 'time'
191
+ require 'scrapebadger'
192
+ # setup authorization
193
+ ScrapeBadger.configure do |config|
194
+ # Configure API key authorization: ApiKeyAuth
195
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
196
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
197
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
198
+ end
199
+
200
+ api_instance = ScrapeBadger::WalmartApi.new
201
+ seller_id = 'seller_id_example' # String | Numeric catalog seller id, e.g. '101040442' — the `catalog_seller_id` on a product, NOT the 32-char hex `seller_id` (which 404s).
202
+ query = 'query_example' # String | Required — Walmart returns nothing for a seller facet alone
203
+ opts = {
204
+ page: 56, # Integer |
205
+ sort: 'sort_example' # String |
206
+ }
207
+
208
+ begin
209
+ # Get a seller's catalogue
210
+ result = api_instance.walmart_get_a_seller_s_catalogue(seller_id, query, opts)
211
+ p result
212
+ rescue ScrapeBadger::ApiError => e
213
+ puts "Error when calling WalmartApi->walmart_get_a_seller_s_catalogue: #{e}"
214
+ end
215
+ ```
216
+
217
+ #### Using the walmart_get_a_seller_s_catalogue_with_http_info variant
218
+
219
+ This returns an Array which contains the response data, status code and headers.
220
+
221
+ > <Array(Object, Integer, Hash)> walmart_get_a_seller_s_catalogue_with_http_info(seller_id, query, opts)
222
+
223
+ ```ruby
224
+ begin
225
+ # Get a seller's catalogue
226
+ data, status_code, headers = api_instance.walmart_get_a_seller_s_catalogue_with_http_info(seller_id, query, opts)
227
+ p status_code # => 2xx
228
+ p headers # => { ... }
229
+ p data # => Object
230
+ rescue ScrapeBadger::ApiError => e
231
+ puts "Error when calling WalmartApi->walmart_get_a_seller_s_catalogue_with_http_info: #{e}"
232
+ end
233
+ ```
234
+
235
+ ### Parameters
236
+
237
+ | Name | Type | Description | Notes |
238
+ | ---- | ---- | ----------- | ----- |
239
+ | **seller_id** | **String** | Numeric catalog seller id, e.g. &#39;101040442&#39; — the &#x60;catalog_seller_id&#x60; on a product, NOT the 32-char hex &#x60;seller_id&#x60; (which 404s). | |
240
+ | **query** | **String** | Required — Walmart returns nothing for a seller facet alone | |
241
+ | **page** | **Integer** | | [optional][default to 1] |
242
+ | **sort** | **String** | | [optional] |
243
+
244
+ ### Return type
245
+
246
+ **Object**
247
+
248
+ ### Authorization
249
+
250
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
251
+
252
+ ### HTTP request headers
253
+
254
+ - **Content-Type**: Not defined
255
+ - **Accept**: application/json
256
+
257
+
258
+ ## walmart_get_product_detail
259
+
260
+ > Object walmart_get_product_detail(item_id)
261
+
262
+ Get product detail
263
+
264
+ Full product detail — price, stock, specs, variants, seller, reviews sample.
265
+
266
+ ### Examples
267
+
268
+ ```ruby
269
+ require 'time'
270
+ require 'scrapebadger'
271
+ # setup authorization
272
+ ScrapeBadger.configure do |config|
273
+ # Configure API key authorization: ApiKeyAuth
274
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
275
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
276
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
277
+ end
278
+
279
+ api_instance = ScrapeBadger::WalmartApi.new
280
+ item_id = 'item_id_example' # String | Walmart usItemId, e.g. '5689919121'
281
+
282
+ begin
283
+ # Get product detail
284
+ result = api_instance.walmart_get_product_detail(item_id)
285
+ p result
286
+ rescue ScrapeBadger::ApiError => e
287
+ puts "Error when calling WalmartApi->walmart_get_product_detail: #{e}"
288
+ end
289
+ ```
290
+
291
+ #### Using the walmart_get_product_detail_with_http_info variant
292
+
293
+ This returns an Array which contains the response data, status code and headers.
294
+
295
+ > <Array(Object, Integer, Hash)> walmart_get_product_detail_with_http_info(item_id)
296
+
297
+ ```ruby
298
+ begin
299
+ # Get product detail
300
+ data, status_code, headers = api_instance.walmart_get_product_detail_with_http_info(item_id)
301
+ p status_code # => 2xx
302
+ p headers # => { ... }
303
+ p data # => Object
304
+ rescue ScrapeBadger::ApiError => e
305
+ puts "Error when calling WalmartApi->walmart_get_product_detail_with_http_info: #{e}"
306
+ end
307
+ ```
308
+
309
+ ### Parameters
310
+
311
+ | Name | Type | Description | Notes |
312
+ | ---- | ---- | ----------- | ----- |
313
+ | **item_id** | **String** | Walmart usItemId, e.g. &#39;5689919121&#39; | |
314
+
315
+ ### Return type
316
+
317
+ **Object**
318
+
319
+ ### Authorization
320
+
321
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
322
+
323
+ ### HTTP request headers
324
+
325
+ - **Content-Type**: Not defined
326
+ - **Accept**: application/json
327
+
328
+
329
+ ## walmart_get_product_reviews
330
+
331
+ > Object walmart_get_product_reviews(item_id, opts)
332
+
333
+ Get product reviews
334
+
335
+ Paginated reviews with the full star histogram. 10 per page.
336
+
337
+ ### Examples
338
+
339
+ ```ruby
340
+ require 'time'
341
+ require 'scrapebadger'
342
+ # setup authorization
343
+ ScrapeBadger.configure do |config|
344
+ # Configure API key authorization: ApiKeyAuth
345
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
346
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
347
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
348
+ end
349
+
350
+ api_instance = ScrapeBadger::WalmartApi.new
351
+ item_id = 'item_id_example' # String | Walmart usItemId, e.g. '5689919121'
352
+ opts = {
353
+ page: 56, # Integer |
354
+ sort: 'sort_example' # String | relevancy | submission-desc | submission-asc | rating-desc | rating-asc | helpful
355
+ }
356
+
357
+ begin
358
+ # Get product reviews
359
+ result = api_instance.walmart_get_product_reviews(item_id, opts)
360
+ p result
361
+ rescue ScrapeBadger::ApiError => e
362
+ puts "Error when calling WalmartApi->walmart_get_product_reviews: #{e}"
363
+ end
364
+ ```
365
+
366
+ #### Using the walmart_get_product_reviews_with_http_info variant
367
+
368
+ This returns an Array which contains the response data, status code and headers.
369
+
370
+ > <Array(Object, Integer, Hash)> walmart_get_product_reviews_with_http_info(item_id, opts)
371
+
372
+ ```ruby
373
+ begin
374
+ # Get product reviews
375
+ data, status_code, headers = api_instance.walmart_get_product_reviews_with_http_info(item_id, opts)
376
+ p status_code # => 2xx
377
+ p headers # => { ... }
378
+ p data # => Object
379
+ rescue ScrapeBadger::ApiError => e
380
+ puts "Error when calling WalmartApi->walmart_get_product_reviews_with_http_info: #{e}"
381
+ end
382
+ ```
383
+
384
+ ### Parameters
385
+
386
+ | Name | Type | Description | Notes |
387
+ | ---- | ---- | ----------- | ----- |
388
+ | **item_id** | **String** | Walmart usItemId, e.g. &#39;5689919121&#39; | |
389
+ | **page** | **Integer** | | [optional][default to 1] |
390
+ | **sort** | **String** | relevancy | submission-desc | submission-asc | rating-desc | rating-asc | helpful | [optional] |
391
+
392
+ ### Return type
393
+
394
+ **Object**
395
+
396
+ ### Authorization
397
+
398
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
399
+
400
+ ### HTTP request headers
401
+
402
+ - **Content-Type**: Not defined
403
+ - **Accept**: application/json
404
+
405
+
406
+ ## walmart_get_seller_profile
407
+
408
+ > Object walmart_get_seller_profile(seller_id)
409
+
410
+ Get seller profile
411
+
412
+ Marketplace seller profile — contact details, address, rating, policies. No `page`: adding one makes Walmart's own SSR throw. Use `/sellers/{id}/products` for the catalogue.
413
+
414
+ ### Examples
415
+
416
+ ```ruby
417
+ require 'time'
418
+ require 'scrapebadger'
419
+ # setup authorization
420
+ ScrapeBadger.configure do |config|
421
+ # Configure API key authorization: ApiKeyAuth
422
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
423
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
424
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
425
+ end
426
+
427
+ api_instance = ScrapeBadger::WalmartApi.new
428
+ seller_id = 'seller_id_example' # String | Numeric catalog seller id, e.g. '101040442' — the `catalog_seller_id` on a product, NOT the 32-char hex `seller_id` (which 404s).
429
+
430
+ begin
431
+ # Get seller profile
432
+ result = api_instance.walmart_get_seller_profile(seller_id)
433
+ p result
434
+ rescue ScrapeBadger::ApiError => e
435
+ puts "Error when calling WalmartApi->walmart_get_seller_profile: #{e}"
436
+ end
437
+ ```
438
+
439
+ #### Using the walmart_get_seller_profile_with_http_info variant
440
+
441
+ This returns an Array which contains the response data, status code and headers.
442
+
443
+ > <Array(Object, Integer, Hash)> walmart_get_seller_profile_with_http_info(seller_id)
444
+
445
+ ```ruby
446
+ begin
447
+ # Get seller profile
448
+ data, status_code, headers = api_instance.walmart_get_seller_profile_with_http_info(seller_id)
449
+ p status_code # => 2xx
450
+ p headers # => { ... }
451
+ p data # => Object
452
+ rescue ScrapeBadger::ApiError => e
453
+ puts "Error when calling WalmartApi->walmart_get_seller_profile_with_http_info: #{e}"
454
+ end
455
+ ```
456
+
457
+ ### Parameters
458
+
459
+ | Name | Type | Description | Notes |
460
+ | ---- | ---- | ----------- | ----- |
461
+ | **seller_id** | **String** | Numeric catalog seller id, e.g. &#39;101040442&#39; — the &#x60;catalog_seller_id&#x60; on a product, NOT the 32-char hex &#x60;seller_id&#x60; (which 404s). | |
462
+
463
+ ### Return type
464
+
465
+ **Object**
466
+
467
+ ### Authorization
468
+
469
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
470
+
471
+ ### HTTP request headers
472
+
473
+ - **Content-Type**: Not defined
474
+ - **Accept**: application/json
475
+
476
+
477
+ ## walmart_get_store_nearby_stores
478
+
479
+ > Object walmart_get_store_nearby_stores(store_id)
480
+
481
+ Get store + nearby stores
482
+
483
+ Store detail with hours, per-department services, and nearby stores.
484
+
485
+ ### Examples
486
+
487
+ ```ruby
488
+ require 'time'
489
+ require 'scrapebadger'
490
+ # setup authorization
491
+ ScrapeBadger.configure do |config|
492
+ # Configure API key authorization: ApiKeyAuth
493
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
494
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
495
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
496
+ end
497
+
498
+ api_instance = ScrapeBadger::WalmartApi.new
499
+ store_id = 'store_id_example' # String | Walmart store number, e.g. '100'
500
+
501
+ begin
502
+ # Get store + nearby stores
503
+ result = api_instance.walmart_get_store_nearby_stores(store_id)
504
+ p result
505
+ rescue ScrapeBadger::ApiError => e
506
+ puts "Error when calling WalmartApi->walmart_get_store_nearby_stores: #{e}"
507
+ end
508
+ ```
509
+
510
+ #### Using the walmart_get_store_nearby_stores_with_http_info variant
511
+
512
+ This returns an Array which contains the response data, status code and headers.
513
+
514
+ > <Array(Object, Integer, Hash)> walmart_get_store_nearby_stores_with_http_info(store_id)
515
+
516
+ ```ruby
517
+ begin
518
+ # Get store + nearby stores
519
+ data, status_code, headers = api_instance.walmart_get_store_nearby_stores_with_http_info(store_id)
520
+ p status_code # => 2xx
521
+ p headers # => { ... }
522
+ p data # => Object
523
+ rescue ScrapeBadger::ApiError => e
524
+ puts "Error when calling WalmartApi->walmart_get_store_nearby_stores_with_http_info: #{e}"
525
+ end
526
+ ```
527
+
528
+ ### Parameters
529
+
530
+ | Name | Type | Description | Notes |
531
+ | ---- | ---- | ----------- | ----- |
532
+ | **store_id** | **String** | Walmart store number, e.g. &#39;100&#39; | |
533
+
534
+ ### Return type
535
+
536
+ **Object**
537
+
538
+ ### Authorization
539
+
540
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
541
+
542
+ ### HTTP request headers
543
+
544
+ - **Content-Type**: Not defined
545
+ - **Accept**: application/json
546
+
547
+
548
+ ## walmart_list_supported_markets
549
+
550
+ > Object walmart_list_supported_markets
551
+
552
+ List supported markets
553
+
554
+ Supported Walmart markets.
555
+
556
+ ### Examples
557
+
558
+ ```ruby
559
+ require 'time'
560
+ require 'scrapebadger'
561
+ # setup authorization
562
+ ScrapeBadger.configure do |config|
563
+ # Configure API key authorization: ApiKeyAuth
564
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
565
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
566
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
567
+ end
568
+
569
+ api_instance = ScrapeBadger::WalmartApi.new
570
+
571
+ begin
572
+ # List supported markets
573
+ result = api_instance.walmart_list_supported_markets
574
+ p result
575
+ rescue ScrapeBadger::ApiError => e
576
+ puts "Error when calling WalmartApi->walmart_list_supported_markets: #{e}"
577
+ end
578
+ ```
579
+
580
+ #### Using the walmart_list_supported_markets_with_http_info variant
581
+
582
+ This returns an Array which contains the response data, status code and headers.
583
+
584
+ > <Array(Object, Integer, Hash)> walmart_list_supported_markets_with_http_info
585
+
586
+ ```ruby
587
+ begin
588
+ # List supported markets
589
+ data, status_code, headers = api_instance.walmart_list_supported_markets_with_http_info
590
+ p status_code # => 2xx
591
+ p headers # => { ... }
592
+ p data # => Object
593
+ rescue ScrapeBadger::ApiError => e
594
+ puts "Error when calling WalmartApi->walmart_list_supported_markets_with_http_info: #{e}"
595
+ end
596
+ ```
597
+
598
+ ### Parameters
599
+
600
+ This endpoint does not need any parameter.
601
+
602
+ ### Return type
603
+
604
+ **Object**
605
+
606
+ ### Authorization
607
+
608
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
609
+
610
+ ### HTTP request headers
611
+
612
+ - **Content-Type**: Not defined
613
+ - **Accept**: application/json
614
+
615
+
616
+ ## walmart_search_products
617
+
618
+ > Object walmart_search_products(query, opts)
619
+
620
+ Search products
621
+
622
+ Search walmart.com. ~40-60 organic products per page; ad tiles are dropped.
623
+
624
+ ### Examples
625
+
626
+ ```ruby
627
+ require 'time'
628
+ require 'scrapebadger'
629
+ # setup authorization
630
+ ScrapeBadger.configure do |config|
631
+ # Configure API key authorization: ApiKeyAuth
632
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
633
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
634
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
635
+ end
636
+
637
+ api_instance = ScrapeBadger::WalmartApi.new
638
+ query = 'query_example' # String | Search keywords, e.g. 'laptop'
639
+ opts = {
640
+ page: 56, # Integer | Results dry up after page 10
641
+ sort: 'sort_example', # String | best_match | best_seller | price_low | price_high | rating_high | new
642
+ min_price: 8.14, # Float |
643
+ max_price: 8.14, # Float |
644
+ facet: 'facet_example' # String | Facet filter, e.g. 'brand:HP'
645
+ }
646
+
647
+ begin
648
+ # Search products
649
+ result = api_instance.walmart_search_products(query, opts)
650
+ p result
651
+ rescue ScrapeBadger::ApiError => e
652
+ puts "Error when calling WalmartApi->walmart_search_products: #{e}"
653
+ end
654
+ ```
655
+
656
+ #### Using the walmart_search_products_with_http_info variant
657
+
658
+ This returns an Array which contains the response data, status code and headers.
659
+
660
+ > <Array(Object, Integer, Hash)> walmart_search_products_with_http_info(query, opts)
661
+
662
+ ```ruby
663
+ begin
664
+ # Search products
665
+ data, status_code, headers = api_instance.walmart_search_products_with_http_info(query, opts)
666
+ p status_code # => 2xx
667
+ p headers # => { ... }
668
+ p data # => Object
669
+ rescue ScrapeBadger::ApiError => e
670
+ puts "Error when calling WalmartApi->walmart_search_products_with_http_info: #{e}"
671
+ end
672
+ ```
673
+
674
+ ### Parameters
675
+
676
+ | Name | Type | Description | Notes |
677
+ | ---- | ---- | ----------- | ----- |
678
+ | **query** | **String** | Search keywords, e.g. &#39;laptop&#39; | |
679
+ | **page** | **Integer** | Results dry up after page 10 | [optional][default to 1] |
680
+ | **sort** | **String** | best_match | best_seller | price_low | price_high | rating_high | new | [optional] |
681
+ | **min_price** | **Float** | | [optional] |
682
+ | **max_price** | **Float** | | [optional] |
683
+ | **facet** | **String** | Facet filter, e.g. &#39;brand:HP&#39; | [optional] |
684
+
685
+ ### Return type
686
+
687
+ **Object**
688
+
689
+ ### Authorization
690
+
691
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
692
+
693
+ ### HTTP request headers
694
+
695
+ - **Content-Type**: Not defined
696
+ - **Accept**: application/json
697
+
698
+
699
+ ## walmart_search_suggestions
700
+
701
+ > Object walmart_search_suggestions(query)
702
+
703
+ Search suggestions
704
+
705
+ Walmart search-box suggestions.
706
+
707
+ ### Examples
708
+
709
+ ```ruby
710
+ require 'time'
711
+ require 'scrapebadger'
712
+ # setup authorization
713
+ ScrapeBadger.configure do |config|
714
+ # Configure API key authorization: ApiKeyAuth
715
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
716
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
717
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
718
+ end
719
+
720
+ api_instance = ScrapeBadger::WalmartApi.new
721
+ query = 'query_example' # String | Partial search term, e.g. 'lapt'
722
+
723
+ begin
724
+ # Search suggestions
725
+ result = api_instance.walmart_search_suggestions(query)
726
+ p result
727
+ rescue ScrapeBadger::ApiError => e
728
+ puts "Error when calling WalmartApi->walmart_search_suggestions: #{e}"
729
+ end
730
+ ```
731
+
732
+ #### Using the walmart_search_suggestions_with_http_info variant
733
+
734
+ This returns an Array which contains the response data, status code and headers.
735
+
736
+ > <Array(Object, Integer, Hash)> walmart_search_suggestions_with_http_info(query)
737
+
738
+ ```ruby
739
+ begin
740
+ # Search suggestions
741
+ data, status_code, headers = api_instance.walmart_search_suggestions_with_http_info(query)
742
+ p status_code # => 2xx
743
+ p headers # => { ... }
744
+ p data # => Object
745
+ rescue ScrapeBadger::ApiError => e
746
+ puts "Error when calling WalmartApi->walmart_search_suggestions_with_http_info: #{e}"
747
+ end
748
+ ```
749
+
750
+ ### Parameters
751
+
752
+ | Name | Type | Description | Notes |
753
+ | ---- | ---- | ----------- | ----- |
754
+ | **query** | **String** | Partial search term, e.g. &#39;lapt&#39; | |
755
+
756
+ ### Return type
757
+
758
+ **Object**
759
+
760
+ ### Authorization
761
+
762
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
763
+
764
+ ### HTTP request headers
765
+
766
+ - **Content-Type**: Not defined
767
+ - **Accept**: application/json
768
+
769
+
770
+ ## walmart_walmart_scraper_health_check
771
+
772
+ > Object walmart_walmart_scraper_health_check
773
+
774
+ Walmart scraper health check
775
+
776
+ Check health of the Walmart scraper service (accepts HEAD for UptimeRobot).
777
+
778
+ ### Examples
779
+
780
+ ```ruby
781
+ require 'time'
782
+ require 'scrapebadger'
783
+ # setup authorization
784
+ ScrapeBadger.configure do |config|
785
+ # Configure API key authorization: ApiKeyAuth
786
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
787
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
788
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
789
+ end
790
+
791
+ api_instance = ScrapeBadger::WalmartApi.new
792
+
793
+ begin
794
+ # Walmart scraper health check
795
+ result = api_instance.walmart_walmart_scraper_health_check
796
+ p result
797
+ rescue ScrapeBadger::ApiError => e
798
+ puts "Error when calling WalmartApi->walmart_walmart_scraper_health_check: #{e}"
799
+ end
800
+ ```
801
+
802
+ #### Using the walmart_walmart_scraper_health_check_with_http_info variant
803
+
804
+ This returns an Array which contains the response data, status code and headers.
805
+
806
+ > <Array(Object, Integer, Hash)> walmart_walmart_scraper_health_check_with_http_info
807
+
808
+ ```ruby
809
+ begin
810
+ # Walmart scraper health check
811
+ data, status_code, headers = api_instance.walmart_walmart_scraper_health_check_with_http_info
812
+ p status_code # => 2xx
813
+ p headers # => { ... }
814
+ p data # => Object
815
+ rescue ScrapeBadger::ApiError => e
816
+ puts "Error when calling WalmartApi->walmart_walmart_scraper_health_check_with_http_info: #{e}"
817
+ end
818
+ ```
819
+
820
+ ### Parameters
821
+
822
+ This endpoint does not need any parameter.
823
+
824
+ ### Return type
825
+
826
+ **Object**
827
+
828
+ ### Authorization
829
+
830
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
831
+
832
+ ### HTTP request headers
833
+
834
+ - **Content-Type**: Not defined
835
+ - **Accept**: application/json
836
+
837
+
838
+ ## walmart_walmart_scraper_health_check_head
839
+
840
+ > Object walmart_walmart_scraper_health_check_head
841
+
842
+ Walmart scraper health check
843
+
844
+ Check health of the Walmart scraper service (accepts HEAD for UptimeRobot).
845
+
846
+ ### Examples
847
+
848
+ ```ruby
849
+ require 'time'
850
+ require 'scrapebadger'
851
+ # setup authorization
852
+ ScrapeBadger.configure do |config|
853
+ # Configure API key authorization: ApiKeyAuth
854
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
855
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
856
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
857
+ end
858
+
859
+ api_instance = ScrapeBadger::WalmartApi.new
860
+
861
+ begin
862
+ # Walmart scraper health check
863
+ result = api_instance.walmart_walmart_scraper_health_check_head
864
+ p result
865
+ rescue ScrapeBadger::ApiError => e
866
+ puts "Error when calling WalmartApi->walmart_walmart_scraper_health_check_head: #{e}"
867
+ end
868
+ ```
869
+
870
+ #### Using the walmart_walmart_scraper_health_check_head_with_http_info variant
871
+
872
+ This returns an Array which contains the response data, status code and headers.
873
+
874
+ > <Array(Object, Integer, Hash)> walmart_walmart_scraper_health_check_head_with_http_info
875
+
876
+ ```ruby
877
+ begin
878
+ # Walmart scraper health check
879
+ data, status_code, headers = api_instance.walmart_walmart_scraper_health_check_head_with_http_info
880
+ p status_code # => 2xx
881
+ p headers # => { ... }
882
+ p data # => Object
883
+ rescue ScrapeBadger::ApiError => e
884
+ puts "Error when calling WalmartApi->walmart_walmart_scraper_health_check_head_with_http_info: #{e}"
885
+ end
886
+ ```
887
+
888
+ ### Parameters
889
+
890
+ This endpoint does not need any parameter.
891
+
892
+ ### Return type
893
+
894
+ **Object**
895
+
896
+ ### Authorization
897
+
898
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
899
+
900
+ ### HTTP request headers
901
+
902
+ - **Content-Type**: Not defined
903
+ - **Accept**: application/json
904
+