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.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/LICENSE +21 -0
- data/README.md +548 -0
- data/Rakefile +10 -0
- data/docs/AccountApi.md +76 -0
- data/docs/AccountInfo.md +28 -0
- data/docs/AmazonApi.md +1244 -0
- data/docs/ApartmentsApi.md +373 -0
- data/docs/BaiduApi.md +447 -0
- data/docs/BillingLogListResponse.md +24 -0
- data/docs/BillingLogResponse.md +32 -0
- data/docs/BingApi.md +610 -0
- data/docs/ChatGPTApi.md +521 -0
- data/docs/DepopApi.md +542 -0
- data/docs/DuckDuckGoApi.md +700 -0
- data/docs/EBayApi.md +1019 -0
- data/docs/FacebookApi.md +1671 -0
- data/docs/FilterRuleCreate.md +28 -0
- data/docs/FilterRuleDeliveryLogListResponse.md +24 -0
- data/docs/FilterRuleDeliveryLogResponse.md +44 -0
- data/docs/FilterRuleListResponse.md +24 -0
- data/docs/FilterRuleResponse.md +40 -0
- data/docs/FilterRuleUpdate.md +30 -0
- data/docs/FilterRuleValidateRequest.md +18 -0
- data/docs/FilterRuleValidateResponse.md +22 -0
- data/docs/GoogleApi.md +3175 -0
- data/docs/HTTPValidationError.md +18 -0
- data/docs/IdealistaApi.md +822 -0
- data/docs/ImmobiliareApi.md +773 -0
- data/docs/InstagramApi.md +1673 -0
- data/docs/LeboncoinApi.md +884 -0
- data/docs/LinkedInApi.md +925 -0
- data/docs/LoopNetApi.md +529 -0
- data/docs/PortalApiRoutersV1TwitterFilterRulesFilterRulePricingResponse.md +20 -0
- data/docs/RealtorApi.md +474 -0
- data/docs/RedditApi.md +1677 -0
- data/docs/RedfinApi.md +616 -0
- data/docs/StreamMonitorCreate.md +26 -0
- data/docs/StreamMonitorListResponse.md +24 -0
- data/docs/StreamMonitorResponse.md +42 -0
- data/docs/StreamMonitorUpdate.md +28 -0
- data/docs/SubscriptionInfo.md +40 -0
- data/docs/TikTokApi.md +2104 -0
- data/docs/TweetDeliveryLogListResponse.md +24 -0
- data/docs/TweetDeliveryLogResponse.md +44 -0
- data/docs/TwitterApi.md +4091 -0
- data/docs/ValidationError.md +22 -0
- data/docs/ValidationErrorLocInner.md +15 -0
- data/docs/VintedApi.md +766 -0
- data/docs/WalmartApi.md +904 -0
- data/docs/WebApi.md +634 -0
- data/docs/WebhookCreate.md +22 -0
- data/docs/WebhookListItem.md +28 -0
- data/docs/WebhookListResponse.md +20 -0
- data/docs/WebhookResponse.md +26 -0
- data/docs/WebhookTestRequest.md +18 -0
- data/docs/WebhookTestResponse.md +24 -0
- data/docs/YahooApi.md +602 -0
- data/docs/YandexApi.md +450 -0
- data/docs/YouTubeApi.md +2872 -0
- data/docs/ZillowApi.md +622 -0
- data/git_push.sh +57 -0
- data/lib/scrapebadger/api/account_api.rb +79 -0
- data/lib/scrapebadger/api/amazon_api.rb +1165 -0
- data/lib/scrapebadger/api/apartments_api.rb +377 -0
- data/lib/scrapebadger/api/baidu_api.rb +436 -0
- data/lib/scrapebadger/api/bing_api.rb +580 -0
- data/lib/scrapebadger/api/chat_gpt_api.rb +466 -0
- data/lib/scrapebadger/api/depop_api.rb +518 -0
- data/lib/scrapebadger/api/duck_duck_go_api.rb +675 -0
- data/lib/scrapebadger/api/e_bay_api.rb +1029 -0
- data/lib/scrapebadger/api/facebook_api.rb +1492 -0
- data/lib/scrapebadger/api/google_api.rb +3191 -0
- data/lib/scrapebadger/api/idealista_api.rb +864 -0
- data/lib/scrapebadger/api/immobiliare_api.rb +734 -0
- data/lib/scrapebadger/api/instagram_api.rb +1555 -0
- data/lib/scrapebadger/api/leboncoin_api.rb +818 -0
- data/lib/scrapebadger/api/linked_in_api.rb +832 -0
- data/lib/scrapebadger/api/loop_net_api.rb +503 -0
- data/lib/scrapebadger/api/realtor_api.rb +481 -0
- data/lib/scrapebadger/api/reddit_api.rb +1601 -0
- data/lib/scrapebadger/api/redfin_api.rb +625 -0
- data/lib/scrapebadger/api/tik_tok_api.rb +2029 -0
- data/lib/scrapebadger/api/twitter_api.rb +3696 -0
- data/lib/scrapebadger/api/vinted_api.rb +705 -0
- data/lib/scrapebadger/api/walmart_api.rb +876 -0
- data/lib/scrapebadger/api/web_api.rb +547 -0
- data/lib/scrapebadger/api/yahoo_api.rb +560 -0
- data/lib/scrapebadger/api/yandex_api.rb +422 -0
- data/lib/scrapebadger/api/you_tube_api.rb +2520 -0
- data/lib/scrapebadger/api/zillow_api.rb +634 -0
- data/lib/scrapebadger/api_client.rb +394 -0
- data/lib/scrapebadger/api_error.rb +58 -0
- data/lib/scrapebadger/configuration.rb +308 -0
- data/lib/scrapebadger/models/account_info.rb +288 -0
- data/lib/scrapebadger/models/billing_log_list_response.rb +272 -0
- data/lib/scrapebadger/models/billing_log_response.rb +334 -0
- data/lib/scrapebadger/models/filter_rule_create.rb +427 -0
- data/lib/scrapebadger/models/filter_rule_delivery_log_list_response.rb +272 -0
- data/lib/scrapebadger/models/filter_rule_delivery_log_response.rb +422 -0
- data/lib/scrapebadger/models/filter_rule_list_response.rb +272 -0
- data/lib/scrapebadger/models/filter_rule_response.rb +390 -0
- data/lib/scrapebadger/models/filter_rule_update.rb +389 -0
- data/lib/scrapebadger/models/filter_rule_validate_request.rb +250 -0
- data/lib/scrapebadger/models/filter_rule_validate_response.rb +248 -0
- data/lib/scrapebadger/models/http_validation_error.rb +216 -0
- data/lib/scrapebadger/models/portal_api_routers_v1_twitter_filter_rules_filter_rule_pricing_response.rb +238 -0
- data/lib/scrapebadger/models/stream_monitor_create.rb +373 -0
- data/lib/scrapebadger/models/stream_monitor_list_response.rb +272 -0
- data/lib/scrapebadger/models/stream_monitor_response.rb +406 -0
- data/lib/scrapebadger/models/stream_monitor_update.rb +335 -0
- data/lib/scrapebadger/models/subscription_info.rb +352 -0
- data/lib/scrapebadger/models/tweet_delivery_log_list_response.rb +272 -0
- data/lib/scrapebadger/models/tweet_delivery_log_response.rb +422 -0
- data/lib/scrapebadger/models/validation_error.rb +255 -0
- data/lib/scrapebadger/models/validation_error_loc_inner.rb +104 -0
- data/lib/scrapebadger/models/webhook_create.rb +282 -0
- data/lib/scrapebadger/models/webhook_list_item.rb +302 -0
- data/lib/scrapebadger/models/webhook_list_response.rb +240 -0
- data/lib/scrapebadger/models/webhook_response.rb +286 -0
- data/lib/scrapebadger/models/webhook_test_request.rb +223 -0
- data/lib/scrapebadger/models/webhook_test_response.rb +259 -0
- data/lib/scrapebadger/version.rb +15 -0
- data/lib/scrapebadger.rb +96 -0
- data/scrapebadger.gemspec +39 -0
- data/spec/api/account_api_spec.rb +46 -0
- data/spec/api/amazon_api_spec.rb +258 -0
- data/spec/api/apartments_api_spec.rb +98 -0
- data/spec/api/baidu_api_spec.rb +109 -0
- data/spec/api/bing_api_spec.rb +141 -0
- data/spec/api/chat_gpt_api_spec.rb +123 -0
- data/spec/api/depop_api_spec.rb +132 -0
- data/spec/api/duck_duck_go_api_spec.rb +162 -0
- data/spec/api/e_bay_api_spec.rb +222 -0
- data/spec/api/facebook_api_spec.rb +326 -0
- data/spec/api/google_api_spec.rb +649 -0
- data/spec/api/idealista_api_spec.rb +197 -0
- data/spec/api/immobiliare_api_spec.rb +174 -0
- data/spec/api/instagram_api_spec.rb +309 -0
- data/spec/api/leboncoin_api_spec.rb +184 -0
- data/spec/api/linked_in_api_spec.rb +197 -0
- data/spec/api/loop_net_api_spec.rb +127 -0
- data/spec/api/realtor_api_spec.rb +123 -0
- data/spec/api/reddit_api_spec.rb +331 -0
- data/spec/api/redfin_api_spec.rb +147 -0
- data/spec/api/tik_tok_api_spec.rb +413 -0
- data/spec/api/twitter_api_spec.rb +735 -0
- data/spec/api/vinted_api_spec.rb +169 -0
- data/spec/api/walmart_api_spec.rb +192 -0
- data/spec/api/web_api_spec.rb +136 -0
- data/spec/api/yahoo_api_spec.rb +137 -0
- data/spec/api/yandex_api_spec.rb +111 -0
- data/spec/api/you_tube_api_spec.rb +500 -0
- data/spec/api/zillow_api_spec.rb +150 -0
- data/spec/models/account_info_spec.rb +66 -0
- data/spec/models/billing_log_list_response_spec.rb +54 -0
- data/spec/models/billing_log_response_spec.rb +78 -0
- data/spec/models/filter_rule_create_spec.rb +66 -0
- data/spec/models/filter_rule_delivery_log_list_response_spec.rb +54 -0
- data/spec/models/filter_rule_delivery_log_response_spec.rb +114 -0
- data/spec/models/filter_rule_list_response_spec.rb +54 -0
- data/spec/models/filter_rule_response_spec.rb +102 -0
- data/spec/models/filter_rule_update_spec.rb +72 -0
- data/spec/models/filter_rule_validate_request_spec.rb +36 -0
- data/spec/models/filter_rule_validate_response_spec.rb +48 -0
- data/spec/models/http_validation_error_spec.rb +36 -0
- data/spec/models/portal_api_routers_v1_twitter_filter_rules_filter_rule_pricing_response_spec.rb +42 -0
- data/spec/models/stream_monitor_create_spec.rb +60 -0
- data/spec/models/stream_monitor_list_response_spec.rb +54 -0
- data/spec/models/stream_monitor_response_spec.rb +108 -0
- data/spec/models/stream_monitor_update_spec.rb +66 -0
- data/spec/models/subscription_info_spec.rb +102 -0
- data/spec/models/tweet_delivery_log_list_response_spec.rb +54 -0
- data/spec/models/tweet_delivery_log_response_spec.rb +114 -0
- data/spec/models/validation_error_loc_inner_spec.rb +21 -0
- data/spec/models/validation_error_spec.rb +48 -0
- data/spec/models/webhook_create_spec.rb +48 -0
- data/spec/models/webhook_list_item_spec.rb +66 -0
- data/spec/models/webhook_list_response_spec.rb +42 -0
- data/spec/models/webhook_response_spec.rb +60 -0
- data/spec/models/webhook_test_request_spec.rb +36 -0
- data/spec/models/webhook_test_response_spec.rb +54 -0
- data/spec/spec_helper.rb +111 -0
- metadata +324 -0
data/docs/VintedApi.md
ADDED
|
@@ -0,0 +1,766 @@
|
|
|
1
|
+
# ScrapeBadger::VintedApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://scrapebadger.com*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**vinted_get_item_details**](VintedApi.md#vinted_get_item_details) | **GET** /v1/vinted/items/{item_id} | Get item details |
|
|
8
|
+
| [**vinted_get_user_profile**](VintedApi.md#vinted_get_user_profile) | **GET** /v1/vinted/users/{user_id} | Get user profile |
|
|
9
|
+
| [**vinted_get_user_s_listed_items**](VintedApi.md#vinted_get_user_s_listed_items) | **GET** /v1/vinted/users/{user_id}/items | Get user's listed items |
|
|
10
|
+
| [**vinted_list_colors**](VintedApi.md#vinted_list_colors) | **GET** /v1/vinted/colors | List colors |
|
|
11
|
+
| [**vinted_list_item_conditions**](VintedApi.md#vinted_list_item_conditions) | **GET** /v1/vinted/statuses | List item conditions |
|
|
12
|
+
| [**vinted_list_markets**](VintedApi.md#vinted_list_markets) | **GET** /v1/vinted/markets | List markets |
|
|
13
|
+
| [**vinted_search_brands**](VintedApi.md#vinted_search_brands) | **GET** /v1/vinted/brands | Search brands |
|
|
14
|
+
| [**vinted_search_vinted_items**](VintedApi.md#vinted_search_vinted_items) | **GET** /v1/vinted/search | Search Vinted items |
|
|
15
|
+
| [**vinted_vinted_scraper_health_check**](VintedApi.md#vinted_vinted_scraper_health_check) | **GET** /v1/vinted/health | Vinted scraper health check |
|
|
16
|
+
| [**vinted_vinted_scraper_health_check_head**](VintedApi.md#vinted_vinted_scraper_health_check_head) | **HEAD** /v1/vinted/health | Vinted scraper health check |
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
## vinted_get_item_details
|
|
20
|
+
|
|
21
|
+
> Object vinted_get_item_details(item_id, opts)
|
|
22
|
+
|
|
23
|
+
Get item details
|
|
24
|
+
|
|
25
|
+
Get detailed information about a Vinted item.
|
|
26
|
+
|
|
27
|
+
### Examples
|
|
28
|
+
|
|
29
|
+
```ruby
|
|
30
|
+
require 'time'
|
|
31
|
+
require 'scrapebadger'
|
|
32
|
+
# setup authorization
|
|
33
|
+
ScrapeBadger.configure do |config|
|
|
34
|
+
# Configure API key authorization: ApiKeyAuth
|
|
35
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
36
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
37
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
38
|
+
end
|
|
39
|
+
|
|
40
|
+
api_instance = ScrapeBadger::VintedApi.new
|
|
41
|
+
item_id = 56 # Integer |
|
|
42
|
+
opts = {
|
|
43
|
+
market: 'market_example' # String |
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
begin
|
|
47
|
+
# Get item details
|
|
48
|
+
result = api_instance.vinted_get_item_details(item_id, opts)
|
|
49
|
+
p result
|
|
50
|
+
rescue ScrapeBadger::ApiError => e
|
|
51
|
+
puts "Error when calling VintedApi->vinted_get_item_details: #{e}"
|
|
52
|
+
end
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
#### Using the vinted_get_item_details_with_http_info variant
|
|
56
|
+
|
|
57
|
+
This returns an Array which contains the response data, status code and headers.
|
|
58
|
+
|
|
59
|
+
> <Array(Object, Integer, Hash)> vinted_get_item_details_with_http_info(item_id, opts)
|
|
60
|
+
|
|
61
|
+
```ruby
|
|
62
|
+
begin
|
|
63
|
+
# Get item details
|
|
64
|
+
data, status_code, headers = api_instance.vinted_get_item_details_with_http_info(item_id, opts)
|
|
65
|
+
p status_code # => 2xx
|
|
66
|
+
p headers # => { ... }
|
|
67
|
+
p data # => Object
|
|
68
|
+
rescue ScrapeBadger::ApiError => e
|
|
69
|
+
puts "Error when calling VintedApi->vinted_get_item_details_with_http_info: #{e}"
|
|
70
|
+
end
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
### Parameters
|
|
74
|
+
|
|
75
|
+
| Name | Type | Description | Notes |
|
|
76
|
+
| ---- | ---- | ----------- | ----- |
|
|
77
|
+
| **item_id** | **Integer** | | |
|
|
78
|
+
| **market** | **String** | | [optional][default to 'fr'] |
|
|
79
|
+
|
|
80
|
+
### Return type
|
|
81
|
+
|
|
82
|
+
**Object**
|
|
83
|
+
|
|
84
|
+
### Authorization
|
|
85
|
+
|
|
86
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
87
|
+
|
|
88
|
+
### HTTP request headers
|
|
89
|
+
|
|
90
|
+
- **Content-Type**: Not defined
|
|
91
|
+
- **Accept**: application/json
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
## vinted_get_user_profile
|
|
95
|
+
|
|
96
|
+
> Object vinted_get_user_profile(user_id, opts)
|
|
97
|
+
|
|
98
|
+
Get user profile
|
|
99
|
+
|
|
100
|
+
Get a Vinted user's profile.
|
|
101
|
+
|
|
102
|
+
### Examples
|
|
103
|
+
|
|
104
|
+
```ruby
|
|
105
|
+
require 'time'
|
|
106
|
+
require 'scrapebadger'
|
|
107
|
+
# setup authorization
|
|
108
|
+
ScrapeBadger.configure do |config|
|
|
109
|
+
# Configure API key authorization: ApiKeyAuth
|
|
110
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
111
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
112
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
113
|
+
end
|
|
114
|
+
|
|
115
|
+
api_instance = ScrapeBadger::VintedApi.new
|
|
116
|
+
user_id = 56 # Integer |
|
|
117
|
+
opts = {
|
|
118
|
+
market: 'market_example' # String |
|
|
119
|
+
}
|
|
120
|
+
|
|
121
|
+
begin
|
|
122
|
+
# Get user profile
|
|
123
|
+
result = api_instance.vinted_get_user_profile(user_id, opts)
|
|
124
|
+
p result
|
|
125
|
+
rescue ScrapeBadger::ApiError => e
|
|
126
|
+
puts "Error when calling VintedApi->vinted_get_user_profile: #{e}"
|
|
127
|
+
end
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
#### Using the vinted_get_user_profile_with_http_info variant
|
|
131
|
+
|
|
132
|
+
This returns an Array which contains the response data, status code and headers.
|
|
133
|
+
|
|
134
|
+
> <Array(Object, Integer, Hash)> vinted_get_user_profile_with_http_info(user_id, opts)
|
|
135
|
+
|
|
136
|
+
```ruby
|
|
137
|
+
begin
|
|
138
|
+
# Get user profile
|
|
139
|
+
data, status_code, headers = api_instance.vinted_get_user_profile_with_http_info(user_id, opts)
|
|
140
|
+
p status_code # => 2xx
|
|
141
|
+
p headers # => { ... }
|
|
142
|
+
p data # => Object
|
|
143
|
+
rescue ScrapeBadger::ApiError => e
|
|
144
|
+
puts "Error when calling VintedApi->vinted_get_user_profile_with_http_info: #{e}"
|
|
145
|
+
end
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
### Parameters
|
|
149
|
+
|
|
150
|
+
| Name | Type | Description | Notes |
|
|
151
|
+
| ---- | ---- | ----------- | ----- |
|
|
152
|
+
| **user_id** | **Integer** | | |
|
|
153
|
+
| **market** | **String** | | [optional][default to 'fr'] |
|
|
154
|
+
|
|
155
|
+
### Return type
|
|
156
|
+
|
|
157
|
+
**Object**
|
|
158
|
+
|
|
159
|
+
### Authorization
|
|
160
|
+
|
|
161
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
162
|
+
|
|
163
|
+
### HTTP request headers
|
|
164
|
+
|
|
165
|
+
- **Content-Type**: Not defined
|
|
166
|
+
- **Accept**: application/json
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
## vinted_get_user_s_listed_items
|
|
170
|
+
|
|
171
|
+
> Object vinted_get_user_s_listed_items(user_id, opts)
|
|
172
|
+
|
|
173
|
+
Get user's listed items
|
|
174
|
+
|
|
175
|
+
Get items listed by a Vinted user.
|
|
176
|
+
|
|
177
|
+
### Examples
|
|
178
|
+
|
|
179
|
+
```ruby
|
|
180
|
+
require 'time'
|
|
181
|
+
require 'scrapebadger'
|
|
182
|
+
# setup authorization
|
|
183
|
+
ScrapeBadger.configure do |config|
|
|
184
|
+
# Configure API key authorization: ApiKeyAuth
|
|
185
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
186
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
187
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
188
|
+
end
|
|
189
|
+
|
|
190
|
+
api_instance = ScrapeBadger::VintedApi.new
|
|
191
|
+
user_id = 56 # Integer |
|
|
192
|
+
opts = {
|
|
193
|
+
market: 'market_example', # String |
|
|
194
|
+
page: 56, # Integer |
|
|
195
|
+
per_page: 56 # Integer |
|
|
196
|
+
}
|
|
197
|
+
|
|
198
|
+
begin
|
|
199
|
+
# Get user's listed items
|
|
200
|
+
result = api_instance.vinted_get_user_s_listed_items(user_id, opts)
|
|
201
|
+
p result
|
|
202
|
+
rescue ScrapeBadger::ApiError => e
|
|
203
|
+
puts "Error when calling VintedApi->vinted_get_user_s_listed_items: #{e}"
|
|
204
|
+
end
|
|
205
|
+
```
|
|
206
|
+
|
|
207
|
+
#### Using the vinted_get_user_s_listed_items_with_http_info variant
|
|
208
|
+
|
|
209
|
+
This returns an Array which contains the response data, status code and headers.
|
|
210
|
+
|
|
211
|
+
> <Array(Object, Integer, Hash)> vinted_get_user_s_listed_items_with_http_info(user_id, opts)
|
|
212
|
+
|
|
213
|
+
```ruby
|
|
214
|
+
begin
|
|
215
|
+
# Get user's listed items
|
|
216
|
+
data, status_code, headers = api_instance.vinted_get_user_s_listed_items_with_http_info(user_id, opts)
|
|
217
|
+
p status_code # => 2xx
|
|
218
|
+
p headers # => { ... }
|
|
219
|
+
p data # => Object
|
|
220
|
+
rescue ScrapeBadger::ApiError => e
|
|
221
|
+
puts "Error when calling VintedApi->vinted_get_user_s_listed_items_with_http_info: #{e}"
|
|
222
|
+
end
|
|
223
|
+
```
|
|
224
|
+
|
|
225
|
+
### Parameters
|
|
226
|
+
|
|
227
|
+
| Name | Type | Description | Notes |
|
|
228
|
+
| ---- | ---- | ----------- | ----- |
|
|
229
|
+
| **user_id** | **Integer** | | |
|
|
230
|
+
| **market** | **String** | | [optional][default to 'fr'] |
|
|
231
|
+
| **page** | **Integer** | | [optional][default to 1] |
|
|
232
|
+
| **per_page** | **Integer** | | [optional][default to 20] |
|
|
233
|
+
|
|
234
|
+
### Return type
|
|
235
|
+
|
|
236
|
+
**Object**
|
|
237
|
+
|
|
238
|
+
### Authorization
|
|
239
|
+
|
|
240
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
241
|
+
|
|
242
|
+
### HTTP request headers
|
|
243
|
+
|
|
244
|
+
- **Content-Type**: Not defined
|
|
245
|
+
- **Accept**: application/json
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
## vinted_list_colors
|
|
249
|
+
|
|
250
|
+
> Object vinted_list_colors(opts)
|
|
251
|
+
|
|
252
|
+
List colors
|
|
253
|
+
|
|
254
|
+
Get available Vinted colors for filtering.
|
|
255
|
+
|
|
256
|
+
### Examples
|
|
257
|
+
|
|
258
|
+
```ruby
|
|
259
|
+
require 'time'
|
|
260
|
+
require 'scrapebadger'
|
|
261
|
+
# setup authorization
|
|
262
|
+
ScrapeBadger.configure do |config|
|
|
263
|
+
# Configure API key authorization: ApiKeyAuth
|
|
264
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
265
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
266
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
267
|
+
end
|
|
268
|
+
|
|
269
|
+
api_instance = ScrapeBadger::VintedApi.new
|
|
270
|
+
opts = {
|
|
271
|
+
market: 'market_example' # String |
|
|
272
|
+
}
|
|
273
|
+
|
|
274
|
+
begin
|
|
275
|
+
# List colors
|
|
276
|
+
result = api_instance.vinted_list_colors(opts)
|
|
277
|
+
p result
|
|
278
|
+
rescue ScrapeBadger::ApiError => e
|
|
279
|
+
puts "Error when calling VintedApi->vinted_list_colors: #{e}"
|
|
280
|
+
end
|
|
281
|
+
```
|
|
282
|
+
|
|
283
|
+
#### Using the vinted_list_colors_with_http_info variant
|
|
284
|
+
|
|
285
|
+
This returns an Array which contains the response data, status code and headers.
|
|
286
|
+
|
|
287
|
+
> <Array(Object, Integer, Hash)> vinted_list_colors_with_http_info(opts)
|
|
288
|
+
|
|
289
|
+
```ruby
|
|
290
|
+
begin
|
|
291
|
+
# List colors
|
|
292
|
+
data, status_code, headers = api_instance.vinted_list_colors_with_http_info(opts)
|
|
293
|
+
p status_code # => 2xx
|
|
294
|
+
p headers # => { ... }
|
|
295
|
+
p data # => Object
|
|
296
|
+
rescue ScrapeBadger::ApiError => e
|
|
297
|
+
puts "Error when calling VintedApi->vinted_list_colors_with_http_info: #{e}"
|
|
298
|
+
end
|
|
299
|
+
```
|
|
300
|
+
|
|
301
|
+
### Parameters
|
|
302
|
+
|
|
303
|
+
| Name | Type | Description | Notes |
|
|
304
|
+
| ---- | ---- | ----------- | ----- |
|
|
305
|
+
| **market** | **String** | | [optional][default to 'fr'] |
|
|
306
|
+
|
|
307
|
+
### Return type
|
|
308
|
+
|
|
309
|
+
**Object**
|
|
310
|
+
|
|
311
|
+
### Authorization
|
|
312
|
+
|
|
313
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
314
|
+
|
|
315
|
+
### HTTP request headers
|
|
316
|
+
|
|
317
|
+
- **Content-Type**: Not defined
|
|
318
|
+
- **Accept**: application/json
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
## vinted_list_item_conditions
|
|
322
|
+
|
|
323
|
+
> Object vinted_list_item_conditions(opts)
|
|
324
|
+
|
|
325
|
+
List item conditions
|
|
326
|
+
|
|
327
|
+
Get available item condition statuses.
|
|
328
|
+
|
|
329
|
+
### Examples
|
|
330
|
+
|
|
331
|
+
```ruby
|
|
332
|
+
require 'time'
|
|
333
|
+
require 'scrapebadger'
|
|
334
|
+
# setup authorization
|
|
335
|
+
ScrapeBadger.configure do |config|
|
|
336
|
+
# Configure API key authorization: ApiKeyAuth
|
|
337
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
338
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
339
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
340
|
+
end
|
|
341
|
+
|
|
342
|
+
api_instance = ScrapeBadger::VintedApi.new
|
|
343
|
+
opts = {
|
|
344
|
+
market: 'market_example' # String |
|
|
345
|
+
}
|
|
346
|
+
|
|
347
|
+
begin
|
|
348
|
+
# List item conditions
|
|
349
|
+
result = api_instance.vinted_list_item_conditions(opts)
|
|
350
|
+
p result
|
|
351
|
+
rescue ScrapeBadger::ApiError => e
|
|
352
|
+
puts "Error when calling VintedApi->vinted_list_item_conditions: #{e}"
|
|
353
|
+
end
|
|
354
|
+
```
|
|
355
|
+
|
|
356
|
+
#### Using the vinted_list_item_conditions_with_http_info variant
|
|
357
|
+
|
|
358
|
+
This returns an Array which contains the response data, status code and headers.
|
|
359
|
+
|
|
360
|
+
> <Array(Object, Integer, Hash)> vinted_list_item_conditions_with_http_info(opts)
|
|
361
|
+
|
|
362
|
+
```ruby
|
|
363
|
+
begin
|
|
364
|
+
# List item conditions
|
|
365
|
+
data, status_code, headers = api_instance.vinted_list_item_conditions_with_http_info(opts)
|
|
366
|
+
p status_code # => 2xx
|
|
367
|
+
p headers # => { ... }
|
|
368
|
+
p data # => Object
|
|
369
|
+
rescue ScrapeBadger::ApiError => e
|
|
370
|
+
puts "Error when calling VintedApi->vinted_list_item_conditions_with_http_info: #{e}"
|
|
371
|
+
end
|
|
372
|
+
```
|
|
373
|
+
|
|
374
|
+
### Parameters
|
|
375
|
+
|
|
376
|
+
| Name | Type | Description | Notes |
|
|
377
|
+
| ---- | ---- | ----------- | ----- |
|
|
378
|
+
| **market** | **String** | | [optional][default to 'fr'] |
|
|
379
|
+
|
|
380
|
+
### Return type
|
|
381
|
+
|
|
382
|
+
**Object**
|
|
383
|
+
|
|
384
|
+
### Authorization
|
|
385
|
+
|
|
386
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
387
|
+
|
|
388
|
+
### HTTP request headers
|
|
389
|
+
|
|
390
|
+
- **Content-Type**: Not defined
|
|
391
|
+
- **Accept**: application/json
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
## vinted_list_markets
|
|
395
|
+
|
|
396
|
+
> Object vinted_list_markets
|
|
397
|
+
|
|
398
|
+
List markets
|
|
399
|
+
|
|
400
|
+
List all supported Vinted markets.
|
|
401
|
+
|
|
402
|
+
### Examples
|
|
403
|
+
|
|
404
|
+
```ruby
|
|
405
|
+
require 'time'
|
|
406
|
+
require 'scrapebadger'
|
|
407
|
+
# setup authorization
|
|
408
|
+
ScrapeBadger.configure do |config|
|
|
409
|
+
# Configure API key authorization: ApiKeyAuth
|
|
410
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
411
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
412
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
413
|
+
end
|
|
414
|
+
|
|
415
|
+
api_instance = ScrapeBadger::VintedApi.new
|
|
416
|
+
|
|
417
|
+
begin
|
|
418
|
+
# List markets
|
|
419
|
+
result = api_instance.vinted_list_markets
|
|
420
|
+
p result
|
|
421
|
+
rescue ScrapeBadger::ApiError => e
|
|
422
|
+
puts "Error when calling VintedApi->vinted_list_markets: #{e}"
|
|
423
|
+
end
|
|
424
|
+
```
|
|
425
|
+
|
|
426
|
+
#### Using the vinted_list_markets_with_http_info variant
|
|
427
|
+
|
|
428
|
+
This returns an Array which contains the response data, status code and headers.
|
|
429
|
+
|
|
430
|
+
> <Array(Object, Integer, Hash)> vinted_list_markets_with_http_info
|
|
431
|
+
|
|
432
|
+
```ruby
|
|
433
|
+
begin
|
|
434
|
+
# List markets
|
|
435
|
+
data, status_code, headers = api_instance.vinted_list_markets_with_http_info
|
|
436
|
+
p status_code # => 2xx
|
|
437
|
+
p headers # => { ... }
|
|
438
|
+
p data # => Object
|
|
439
|
+
rescue ScrapeBadger::ApiError => e
|
|
440
|
+
puts "Error when calling VintedApi->vinted_list_markets_with_http_info: #{e}"
|
|
441
|
+
end
|
|
442
|
+
```
|
|
443
|
+
|
|
444
|
+
### Parameters
|
|
445
|
+
|
|
446
|
+
This endpoint does not need any parameter.
|
|
447
|
+
|
|
448
|
+
### Return type
|
|
449
|
+
|
|
450
|
+
**Object**
|
|
451
|
+
|
|
452
|
+
### Authorization
|
|
453
|
+
|
|
454
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
455
|
+
|
|
456
|
+
### HTTP request headers
|
|
457
|
+
|
|
458
|
+
- **Content-Type**: Not defined
|
|
459
|
+
- **Accept**: application/json
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
## vinted_search_brands
|
|
463
|
+
|
|
464
|
+
> Object vinted_search_brands(keyword, opts)
|
|
465
|
+
|
|
466
|
+
Search brands
|
|
467
|
+
|
|
468
|
+
Search Vinted brands.
|
|
469
|
+
|
|
470
|
+
### Examples
|
|
471
|
+
|
|
472
|
+
```ruby
|
|
473
|
+
require 'time'
|
|
474
|
+
require 'scrapebadger'
|
|
475
|
+
# setup authorization
|
|
476
|
+
ScrapeBadger.configure do |config|
|
|
477
|
+
# Configure API key authorization: ApiKeyAuth
|
|
478
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
479
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
480
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
481
|
+
end
|
|
482
|
+
|
|
483
|
+
api_instance = ScrapeBadger::VintedApi.new
|
|
484
|
+
keyword = 'keyword_example' # String | Brand search keyword
|
|
485
|
+
opts = {
|
|
486
|
+
market: 'market_example' # String |
|
|
487
|
+
}
|
|
488
|
+
|
|
489
|
+
begin
|
|
490
|
+
# Search brands
|
|
491
|
+
result = api_instance.vinted_search_brands(keyword, opts)
|
|
492
|
+
p result
|
|
493
|
+
rescue ScrapeBadger::ApiError => e
|
|
494
|
+
puts "Error when calling VintedApi->vinted_search_brands: #{e}"
|
|
495
|
+
end
|
|
496
|
+
```
|
|
497
|
+
|
|
498
|
+
#### Using the vinted_search_brands_with_http_info variant
|
|
499
|
+
|
|
500
|
+
This returns an Array which contains the response data, status code and headers.
|
|
501
|
+
|
|
502
|
+
> <Array(Object, Integer, Hash)> vinted_search_brands_with_http_info(keyword, opts)
|
|
503
|
+
|
|
504
|
+
```ruby
|
|
505
|
+
begin
|
|
506
|
+
# Search brands
|
|
507
|
+
data, status_code, headers = api_instance.vinted_search_brands_with_http_info(keyword, opts)
|
|
508
|
+
p status_code # => 2xx
|
|
509
|
+
p headers # => { ... }
|
|
510
|
+
p data # => Object
|
|
511
|
+
rescue ScrapeBadger::ApiError => e
|
|
512
|
+
puts "Error when calling VintedApi->vinted_search_brands_with_http_info: #{e}"
|
|
513
|
+
end
|
|
514
|
+
```
|
|
515
|
+
|
|
516
|
+
### Parameters
|
|
517
|
+
|
|
518
|
+
| Name | Type | Description | Notes |
|
|
519
|
+
| ---- | ---- | ----------- | ----- |
|
|
520
|
+
| **keyword** | **String** | Brand search keyword | |
|
|
521
|
+
| **market** | **String** | | [optional][default to 'fr'] |
|
|
522
|
+
|
|
523
|
+
### Return type
|
|
524
|
+
|
|
525
|
+
**Object**
|
|
526
|
+
|
|
527
|
+
### Authorization
|
|
528
|
+
|
|
529
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
530
|
+
|
|
531
|
+
### HTTP request headers
|
|
532
|
+
|
|
533
|
+
- **Content-Type**: Not defined
|
|
534
|
+
- **Accept**: application/json
|
|
535
|
+
|
|
536
|
+
|
|
537
|
+
## vinted_search_vinted_items
|
|
538
|
+
|
|
539
|
+
> Object vinted_search_vinted_items(query, opts)
|
|
540
|
+
|
|
541
|
+
Search Vinted items
|
|
542
|
+
|
|
543
|
+
Search Vinted catalog items with filters.
|
|
544
|
+
|
|
545
|
+
### Examples
|
|
546
|
+
|
|
547
|
+
```ruby
|
|
548
|
+
require 'time'
|
|
549
|
+
require 'scrapebadger'
|
|
550
|
+
# setup authorization
|
|
551
|
+
ScrapeBadger.configure do |config|
|
|
552
|
+
# Configure API key authorization: ApiKeyAuth
|
|
553
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
554
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
555
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
556
|
+
end
|
|
557
|
+
|
|
558
|
+
api_instance = ScrapeBadger::VintedApi.new
|
|
559
|
+
query = 'query_example' # String | Search text
|
|
560
|
+
opts = {
|
|
561
|
+
market: 'market_example', # String | Market code
|
|
562
|
+
seller_country: 'seller_country_example', # String | Filter to items whose seller is physically located in one of these comma-separated ISO-2 country codes (e.g. 'fr' or 'fr,be'). Market domains federate cross-border EU listings and Vinted has no native country filter, so each item is enriched with its seller's country and non-matching ones are dropped. Adds 1 credit per uncached seller looked up (cached for 7 days).
|
|
563
|
+
page: 56, # Integer |
|
|
564
|
+
per_page: 56, # Integer |
|
|
565
|
+
price_from: 8.14, # Float |
|
|
566
|
+
price_to: 8.14, # Float |
|
|
567
|
+
brand_ids: 'brand_ids_example', # String |
|
|
568
|
+
catalog_ids: 'catalog_ids_example', # String | Comma-separated Vinted catalog (category) IDs to restrict the search to, e.g. '1904' or '1904,79'. Vinted applies this before searching, so pagination totals reflect the filtered set. A catalog ID is the `catalog[]` value in a Vinted category URL (vinted.fr/catalog?catalog[]=1904).
|
|
569
|
+
color_ids: 'color_ids_example', # String | Comma-separated color IDs
|
|
570
|
+
status_ids: 'status_ids_example', # String | Comma-separated condition/status IDs
|
|
571
|
+
order: 'order_example' # String |
|
|
572
|
+
}
|
|
573
|
+
|
|
574
|
+
begin
|
|
575
|
+
# Search Vinted items
|
|
576
|
+
result = api_instance.vinted_search_vinted_items(query, opts)
|
|
577
|
+
p result
|
|
578
|
+
rescue ScrapeBadger::ApiError => e
|
|
579
|
+
puts "Error when calling VintedApi->vinted_search_vinted_items: #{e}"
|
|
580
|
+
end
|
|
581
|
+
```
|
|
582
|
+
|
|
583
|
+
#### Using the vinted_search_vinted_items_with_http_info variant
|
|
584
|
+
|
|
585
|
+
This returns an Array which contains the response data, status code and headers.
|
|
586
|
+
|
|
587
|
+
> <Array(Object, Integer, Hash)> vinted_search_vinted_items_with_http_info(query, opts)
|
|
588
|
+
|
|
589
|
+
```ruby
|
|
590
|
+
begin
|
|
591
|
+
# Search Vinted items
|
|
592
|
+
data, status_code, headers = api_instance.vinted_search_vinted_items_with_http_info(query, opts)
|
|
593
|
+
p status_code # => 2xx
|
|
594
|
+
p headers # => { ... }
|
|
595
|
+
p data # => Object
|
|
596
|
+
rescue ScrapeBadger::ApiError => e
|
|
597
|
+
puts "Error when calling VintedApi->vinted_search_vinted_items_with_http_info: #{e}"
|
|
598
|
+
end
|
|
599
|
+
```
|
|
600
|
+
|
|
601
|
+
### Parameters
|
|
602
|
+
|
|
603
|
+
| Name | Type | Description | Notes |
|
|
604
|
+
| ---- | ---- | ----------- | ----- |
|
|
605
|
+
| **query** | **String** | Search text | |
|
|
606
|
+
| **market** | **String** | Market code | [optional][default to 'fr'] |
|
|
607
|
+
| **seller_country** | **String** | Filter to items whose seller is physically located in one of these comma-separated ISO-2 country codes (e.g. 'fr' or 'fr,be'). Market domains federate cross-border EU listings and Vinted has no native country filter, so each item is enriched with its seller's country and non-matching ones are dropped. Adds 1 credit per uncached seller looked up (cached for 7 days). | [optional] |
|
|
608
|
+
| **page** | **Integer** | | [optional][default to 1] |
|
|
609
|
+
| **per_page** | **Integer** | | [optional][default to 20] |
|
|
610
|
+
| **price_from** | **Float** | | [optional] |
|
|
611
|
+
| **price_to** | **Float** | | [optional] |
|
|
612
|
+
| **brand_ids** | **String** | | [optional] |
|
|
613
|
+
| **catalog_ids** | **String** | Comma-separated Vinted catalog (category) IDs to restrict the search to, e.g. '1904' or '1904,79'. Vinted applies this before searching, so pagination totals reflect the filtered set. A catalog ID is the `catalog[]` value in a Vinted category URL (vinted.fr/catalog?catalog[]=1904). | [optional] |
|
|
614
|
+
| **color_ids** | **String** | Comma-separated color IDs | [optional] |
|
|
615
|
+
| **status_ids** | **String** | Comma-separated condition/status IDs | [optional] |
|
|
616
|
+
| **order** | **String** | | [optional] |
|
|
617
|
+
|
|
618
|
+
### Return type
|
|
619
|
+
|
|
620
|
+
**Object**
|
|
621
|
+
|
|
622
|
+
### Authorization
|
|
623
|
+
|
|
624
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
625
|
+
|
|
626
|
+
### HTTP request headers
|
|
627
|
+
|
|
628
|
+
- **Content-Type**: Not defined
|
|
629
|
+
- **Accept**: application/json
|
|
630
|
+
|
|
631
|
+
|
|
632
|
+
## vinted_vinted_scraper_health_check
|
|
633
|
+
|
|
634
|
+
> Object vinted_vinted_scraper_health_check
|
|
635
|
+
|
|
636
|
+
Vinted scraper health check
|
|
637
|
+
|
|
638
|
+
Check health of the Vinted scraper service. Accepts ``HEAD`` so external uptime checkers (UptimeRobot uses HEAD by default for HTTP monitors) don't get a 405 Method Not Allowed.
|
|
639
|
+
|
|
640
|
+
### Examples
|
|
641
|
+
|
|
642
|
+
```ruby
|
|
643
|
+
require 'time'
|
|
644
|
+
require 'scrapebadger'
|
|
645
|
+
# setup authorization
|
|
646
|
+
ScrapeBadger.configure do |config|
|
|
647
|
+
# Configure API key authorization: ApiKeyAuth
|
|
648
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
649
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
650
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
651
|
+
end
|
|
652
|
+
|
|
653
|
+
api_instance = ScrapeBadger::VintedApi.new
|
|
654
|
+
|
|
655
|
+
begin
|
|
656
|
+
# Vinted scraper health check
|
|
657
|
+
result = api_instance.vinted_vinted_scraper_health_check
|
|
658
|
+
p result
|
|
659
|
+
rescue ScrapeBadger::ApiError => e
|
|
660
|
+
puts "Error when calling VintedApi->vinted_vinted_scraper_health_check: #{e}"
|
|
661
|
+
end
|
|
662
|
+
```
|
|
663
|
+
|
|
664
|
+
#### Using the vinted_vinted_scraper_health_check_with_http_info variant
|
|
665
|
+
|
|
666
|
+
This returns an Array which contains the response data, status code and headers.
|
|
667
|
+
|
|
668
|
+
> <Array(Object, Integer, Hash)> vinted_vinted_scraper_health_check_with_http_info
|
|
669
|
+
|
|
670
|
+
```ruby
|
|
671
|
+
begin
|
|
672
|
+
# Vinted scraper health check
|
|
673
|
+
data, status_code, headers = api_instance.vinted_vinted_scraper_health_check_with_http_info
|
|
674
|
+
p status_code # => 2xx
|
|
675
|
+
p headers # => { ... }
|
|
676
|
+
p data # => Object
|
|
677
|
+
rescue ScrapeBadger::ApiError => e
|
|
678
|
+
puts "Error when calling VintedApi->vinted_vinted_scraper_health_check_with_http_info: #{e}"
|
|
679
|
+
end
|
|
680
|
+
```
|
|
681
|
+
|
|
682
|
+
### Parameters
|
|
683
|
+
|
|
684
|
+
This endpoint does not need any parameter.
|
|
685
|
+
|
|
686
|
+
### Return type
|
|
687
|
+
|
|
688
|
+
**Object**
|
|
689
|
+
|
|
690
|
+
### Authorization
|
|
691
|
+
|
|
692
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
693
|
+
|
|
694
|
+
### HTTP request headers
|
|
695
|
+
|
|
696
|
+
- **Content-Type**: Not defined
|
|
697
|
+
- **Accept**: application/json
|
|
698
|
+
|
|
699
|
+
|
|
700
|
+
## vinted_vinted_scraper_health_check_head
|
|
701
|
+
|
|
702
|
+
> Object vinted_vinted_scraper_health_check_head
|
|
703
|
+
|
|
704
|
+
Vinted scraper health check
|
|
705
|
+
|
|
706
|
+
Check health of the Vinted scraper service. Accepts ``HEAD`` so external uptime checkers (UptimeRobot uses HEAD by default for HTTP monitors) don't get a 405 Method Not Allowed.
|
|
707
|
+
|
|
708
|
+
### Examples
|
|
709
|
+
|
|
710
|
+
```ruby
|
|
711
|
+
require 'time'
|
|
712
|
+
require 'scrapebadger'
|
|
713
|
+
# setup authorization
|
|
714
|
+
ScrapeBadger.configure do |config|
|
|
715
|
+
# Configure API key authorization: ApiKeyAuth
|
|
716
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
717
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
718
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
719
|
+
end
|
|
720
|
+
|
|
721
|
+
api_instance = ScrapeBadger::VintedApi.new
|
|
722
|
+
|
|
723
|
+
begin
|
|
724
|
+
# Vinted scraper health check
|
|
725
|
+
result = api_instance.vinted_vinted_scraper_health_check_head
|
|
726
|
+
p result
|
|
727
|
+
rescue ScrapeBadger::ApiError => e
|
|
728
|
+
puts "Error when calling VintedApi->vinted_vinted_scraper_health_check_head: #{e}"
|
|
729
|
+
end
|
|
730
|
+
```
|
|
731
|
+
|
|
732
|
+
#### Using the vinted_vinted_scraper_health_check_head_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)> vinted_vinted_scraper_health_check_head_with_http_info
|
|
737
|
+
|
|
738
|
+
```ruby
|
|
739
|
+
begin
|
|
740
|
+
# Vinted scraper health check
|
|
741
|
+
data, status_code, headers = api_instance.vinted_vinted_scraper_health_check_head_with_http_info
|
|
742
|
+
p status_code # => 2xx
|
|
743
|
+
p headers # => { ... }
|
|
744
|
+
p data # => Object
|
|
745
|
+
rescue ScrapeBadger::ApiError => e
|
|
746
|
+
puts "Error when calling VintedApi->vinted_vinted_scraper_health_check_head_with_http_info: #{e}"
|
|
747
|
+
end
|
|
748
|
+
```
|
|
749
|
+
|
|
750
|
+
### Parameters
|
|
751
|
+
|
|
752
|
+
This endpoint does not need any parameter.
|
|
753
|
+
|
|
754
|
+
### Return type
|
|
755
|
+
|
|
756
|
+
**Object**
|
|
757
|
+
|
|
758
|
+
### Authorization
|
|
759
|
+
|
|
760
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
761
|
+
|
|
762
|
+
### HTTP request headers
|
|
763
|
+
|
|
764
|
+
- **Content-Type**: Not defined
|
|
765
|
+
- **Accept**: application/json
|
|
766
|
+
|