repull 0.2.51 → 0.2.52
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 +4 -4
- data/lib/repull/api/listings_api.rb +63 -0
- data/lib/repull/models/apply_connection_mappings200_response_results_inner.rb +14 -4
- data/lib/repull/models/auto_map_connection_units200_response.rb +1 -1
- data/lib/repull/models/auto_map_connection_units200_response_results_inner.rb +184 -0
- data/lib/repull/models/get_listing_ical200_response.rb +298 -0
- data/lib/repull/models/get_listing_ical200_response_vrbo_inner.rb +285 -0
- data/lib/repull/models/get_usage_logs200_response_data_inner.rb +12 -1
- data/lib/repull/models/list_connection_units200_response_units_inner.rb +1 -1
- data/lib/repull/models/listing_ical_feed_changed_event.rb +282 -0
- data/lib/repull/models/listing_ical_feed_changed_payload.rb +355 -0
- data/lib/repull/models/listing_ical_feed_changed_payload_feed.rb +159 -0
- data/lib/repull/models/webhook_event.rb +2 -0
- data/lib/repull/models/webhook_event_type.rb +2 -1
- data/lib/repull/version.rb +1 -1
- data/lib/repull.rb +6 -0
- data/openapi/v1.json +263 -1
- metadata +8 -2
|
@@ -0,0 +1,355 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Repull API
|
|
3
|
+
|
|
4
|
+
#The unified API for vacation rental tech. Connect Airbnb, Booking.com, Vrbo and more channels, plus 14 PMS platforms, through one REST API. ## Designed for AI agents Every error response on this API includes machine-parseable fields so an LLM (Claude in MCP, Cursor, Cline, GPT, etc.) can self-recover without escalating to a human: - `error.code` — stable string identifier (e.g. `invalid_params`, `rate_limit_exceeded`) - `error.message` — human-readable cause - `error.fix` — exact recovery steps (e.g. \"Pass `check_in_after` as ISO 8601: `?check_in_after=2026-01-15`\") - `error.docs_url` — link to the canonical write-up at `https://repull.dev/docs/errors/{code}` - `error.request_id` — id to correlate with server-side logs - `error.field` / `error.value_received` / `error.valid_values` / `error.did_you_mean` — when the error is parameter-specific - `error.retry_after` — seconds to wait before retrying (rate-limit + transient upstream) `Access-Control-Expose-Headers` lists `x-request-id` and the `X-RateLimit-*` family so browsers can read them on cross-origin responses. ## Quick Start 1. Get an API key at https://repull.dev/dashboard 2. Connect a PMS: `POST /v1/connect/{provider}` 3. List properties: `GET /v1/properties` 4. Get reservations: `GET /v1/reservations` ## Authentication All requests require a Bearer token: ``` Authorization: Bearer sk_live_YOUR_API_KEY ``` ## Request Correlation (X-Request-ID) Every response carries an `X-Request-ID` header, e.g. `X-Request-ID: req_01HXY...`. Include this id in support tickets and bug reports — we can trace the full request lifecycle (auth, rate limit, handler, downstream calls, log row) from a single id. You may set the header on the inbound request to forward your own trace id; we will echo it back instead of generating a new one. Accepted format: `^[\\\\w.-]{1,128}$`. The id is also embedded in error envelopes as `request_id` so server-side log diffs work even when the response headers are stripped by an intermediate proxy. ## Rate Limits The public API enforces a per-API-key sliding-window rate limit on top of the per-tier monthly + daily-AI quotas. **Default policy:** 600 requests per 60 seconds, per API key. Sliding window — there is no fixed-minute boundary you can burst across. Every response includes: | Header | Meaning | |---|---| | `X-RateLimit-Limit` | Requests permitted in the current window. | | `X-RateLimit-Remaining` | Requests left in the current window after this call. | | `X-RateLimit-Reset` | Unix epoch (seconds) when the next slot opens. | | `X-RateLimit-Policy` | Machine-readable policy descriptor, e.g. `600;w=60`. | | `Retry-After` | Seconds to wait before retrying. **Only present on 429 responses.** | **On 429 (rate_limit_exceeded):** the response body matches the standard error envelope with `code: \"rate_limit_exceeded\"`, plus `limit`, `window_seconds`, `retry_after`, and `request_id` fields. SDKs MUST honor `Retry-After` and use exponential backoff with jitter on subsequent retries — never a tight loop. Recommended backoff: ``` sleep_ms = (Retry-After * 1000) + random(0..250) ``` Monthly + daily-AI tier quotas (`free`, `starter`, `custom`) are enforced separately and also surface as 429s; they include `tier`, `scope`, `limit`, `used` and `resets_at` fields. **The way past a request quota.** The monthly quota refusal (`429 rate_limit_exceeded` with `scope: \"monthly\"`), `402 credits_exhausted` and `429 daily_limit_exceeded` also carry `upgrade` (the cheapest plan that covers your usage: its exact monthly price for your listings, its request quotas and a `checkout_url` that opens checkout for that price; `plan: \"custom\"` with a `contact_email` when no self-serve plan covers it), `credits` (pay-as-you-go: `usd_per_1000_requests`, `top_up_url`, your `balance_usd`), `resets_at` and `projected_monthly_requests`. The per-minute 429 (`scope: \"per_api_key\"`) carries none of these: wait `Retry-After`. ## Plan listing limits Each plan includes a number of **active listings**: | Tier | Active listings | |---|---| | `free` | 3 | | `starter` | no cap: 10 included, then billed per listing | | `custom` | no cap | Going over the plan never blocks your API calls. Listings beyond the plan are **held back**: they stay connected and keep syncing, but they are not served. A held-back listing answers `403 listing_inactive` with `reason: \"plan_limit\"`, and collection routes leave it out. Every JSON response then carries a `planNotice` and the `X-Repull-Listings-Held-Back` header, so you know there is more to see. Choose which listings are active with `POST /v1/listings/status`. Upgrading at `https://repull.dev/dashboard/billing` lifts the cap but does not switch held-back listings on: you choose which to activate afterwards, with the same call or from the dashboard, and each one you switch on is billed from then. Only a call that would itself take you over the plan is refused, with **`402 listings_limit_exceeded`**: activating listings (`PATCH /v1/listings/{id}` with `{ \"active\": true }`, `POST /v1/listings/status`) or creating one (`POST /v1/listings`). Nothing else changes. The envelope carries the tier, the limit, the active count and an upgrade link next to the standard `code` / `message` / `fix` / `docs_url` / `request_id`. If an account has more active listings than its plan (for example after a downgrade), calls are still served and `planNotice` says so (code \"listings_over_plan\"). ## Failed payments If your plan's renewal payment fails, nothing is blocked: your API calls keep working while Stripe retries the card. Every successful JSON response then carries a `billingNotice` (code `payment_failed`) with the amount, when it failed, the next automatic retry (`nextRetryAt`) and `payUrl`, the invoice to pay. It disappears once the invoice is paid.
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 1.0.0
|
|
7
|
+
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.22.0
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'date'
|
|
14
|
+
require 'time'
|
|
15
|
+
|
|
16
|
+
module Repull
|
|
17
|
+
# Payload for `listing.ical_feed_changed`: Repull changed a Vrbo unit's imported calendars, or could not. Repull imports the listing's Repull iCal backup feed into every calendar-synced Vrbo unit, and removes other tools' imported feeds while Repull is the unit's master calendar.
|
|
18
|
+
class ListingIcalFeedChangedPayload < ApiModelBase
|
|
19
|
+
attr_accessor :object
|
|
20
|
+
|
|
21
|
+
attr_accessor :provider
|
|
22
|
+
|
|
23
|
+
# `repull_feed_added`: the Repull feed is now imported (`reason: \"repull_feed_missing\"` when it had been removed on Vrbo and was put back). `repull_feed_add_failed`: Vrbo did not take it — ask the host to add `repullFeedUrl` in Vrbo → Calendar → Import calendar, named \"Repull\"; nothing else is changed on the unit until it is there. `other_feed_removed`: another tool's imported calendar (`feed`) was removed. `other_feed_remove_failed`: removing it failed — ask the host to remove it in Vrbo → Calendar → Import calendar. Repull also emails the workspace owner when an action failed.
|
|
24
|
+
attr_accessor :action
|
|
25
|
+
|
|
26
|
+
attr_accessor :feed
|
|
27
|
+
|
|
28
|
+
# The listing's Repull iCal backup feed (`GET /v1/listings/{id}/ical`).
|
|
29
|
+
attr_accessor :repull_feed_url
|
|
30
|
+
|
|
31
|
+
# Why Repull acted.
|
|
32
|
+
attr_accessor :reason
|
|
33
|
+
|
|
34
|
+
# `calendar_sync_enabled`: calendar sync was just switched on for the unit. `drift_check`: the daily Vrbo calendar check.
|
|
35
|
+
attr_accessor :trigger
|
|
36
|
+
|
|
37
|
+
# Vrbo's answer, on a failed action.
|
|
38
|
+
attr_accessor :error
|
|
39
|
+
|
|
40
|
+
attr_accessor :occurred_at
|
|
41
|
+
|
|
42
|
+
attr_accessor :docs_url
|
|
43
|
+
|
|
44
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
|
45
|
+
def self.attribute_map
|
|
46
|
+
{
|
|
47
|
+
:'object' => :'object',
|
|
48
|
+
:'provider' => :'provider',
|
|
49
|
+
:'action' => :'action',
|
|
50
|
+
:'feed' => :'feed',
|
|
51
|
+
:'repull_feed_url' => :'repullFeedUrl',
|
|
52
|
+
:'reason' => :'reason',
|
|
53
|
+
:'trigger' => :'trigger',
|
|
54
|
+
:'error' => :'error',
|
|
55
|
+
:'occurred_at' => :'occurredAt',
|
|
56
|
+
:'docs_url' => :'docsUrl'
|
|
57
|
+
}
|
|
58
|
+
end
|
|
59
|
+
|
|
60
|
+
# Returns attribute mapping this model knows about
|
|
61
|
+
def self.acceptable_attribute_map
|
|
62
|
+
attribute_map
|
|
63
|
+
end
|
|
64
|
+
|
|
65
|
+
# Returns all the JSON keys this model knows about
|
|
66
|
+
def self.acceptable_attributes
|
|
67
|
+
acceptable_attribute_map.values
|
|
68
|
+
end
|
|
69
|
+
|
|
70
|
+
# Attribute type mapping.
|
|
71
|
+
def self.openapi_types
|
|
72
|
+
{
|
|
73
|
+
:'object' => :'ListingWebhookObject',
|
|
74
|
+
:'provider' => :'String',
|
|
75
|
+
:'action' => :'String',
|
|
76
|
+
:'feed' => :'ListingIcalFeedChangedPayloadFeed',
|
|
77
|
+
:'repull_feed_url' => :'String',
|
|
78
|
+
:'reason' => :'String',
|
|
79
|
+
:'trigger' => :'String',
|
|
80
|
+
:'error' => :'String',
|
|
81
|
+
:'occurred_at' => :'Time',
|
|
82
|
+
:'docs_url' => :'String'
|
|
83
|
+
}
|
|
84
|
+
end
|
|
85
|
+
|
|
86
|
+
# List of attributes with nullable: true
|
|
87
|
+
def self.openapi_nullable
|
|
88
|
+
Set.new([
|
|
89
|
+
:'reason',
|
|
90
|
+
:'error',
|
|
91
|
+
])
|
|
92
|
+
end
|
|
93
|
+
|
|
94
|
+
# Initializes the object
|
|
95
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
96
|
+
def initialize(attributes = {})
|
|
97
|
+
if (!attributes.is_a?(Hash))
|
|
98
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `Repull::ListingIcalFeedChangedPayload` initialize method"
|
|
99
|
+
end
|
|
100
|
+
|
|
101
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
|
102
|
+
acceptable_attribute_map = self.class.acceptable_attribute_map
|
|
103
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
104
|
+
if (!acceptable_attribute_map.key?(k.to_sym))
|
|
105
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `Repull::ListingIcalFeedChangedPayload`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
|
|
106
|
+
end
|
|
107
|
+
h[k.to_sym] = v
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
if attributes.key?(:'object')
|
|
111
|
+
self.object = attributes[:'object']
|
|
112
|
+
else
|
|
113
|
+
self.object = nil
|
|
114
|
+
end
|
|
115
|
+
|
|
116
|
+
if attributes.key?(:'provider')
|
|
117
|
+
self.provider = attributes[:'provider']
|
|
118
|
+
else
|
|
119
|
+
self.provider = nil
|
|
120
|
+
end
|
|
121
|
+
|
|
122
|
+
if attributes.key?(:'action')
|
|
123
|
+
self.action = attributes[:'action']
|
|
124
|
+
else
|
|
125
|
+
self.action = nil
|
|
126
|
+
end
|
|
127
|
+
|
|
128
|
+
if attributes.key?(:'feed')
|
|
129
|
+
self.feed = attributes[:'feed']
|
|
130
|
+
else
|
|
131
|
+
self.feed = nil
|
|
132
|
+
end
|
|
133
|
+
|
|
134
|
+
if attributes.key?(:'repull_feed_url')
|
|
135
|
+
self.repull_feed_url = attributes[:'repull_feed_url']
|
|
136
|
+
else
|
|
137
|
+
self.repull_feed_url = nil
|
|
138
|
+
end
|
|
139
|
+
|
|
140
|
+
if attributes.key?(:'reason')
|
|
141
|
+
self.reason = attributes[:'reason']
|
|
142
|
+
end
|
|
143
|
+
|
|
144
|
+
if attributes.key?(:'trigger')
|
|
145
|
+
self.trigger = attributes[:'trigger']
|
|
146
|
+
else
|
|
147
|
+
self.trigger = nil
|
|
148
|
+
end
|
|
149
|
+
|
|
150
|
+
if attributes.key?(:'error')
|
|
151
|
+
self.error = attributes[:'error']
|
|
152
|
+
end
|
|
153
|
+
|
|
154
|
+
if attributes.key?(:'occurred_at')
|
|
155
|
+
self.occurred_at = attributes[:'occurred_at']
|
|
156
|
+
else
|
|
157
|
+
self.occurred_at = nil
|
|
158
|
+
end
|
|
159
|
+
|
|
160
|
+
if attributes.key?(:'docs_url')
|
|
161
|
+
self.docs_url = attributes[:'docs_url']
|
|
162
|
+
end
|
|
163
|
+
end
|
|
164
|
+
|
|
165
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
|
166
|
+
# @return Array for valid properties with the reasons
|
|
167
|
+
def list_invalid_properties
|
|
168
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
|
169
|
+
invalid_properties = Array.new
|
|
170
|
+
if @object.nil?
|
|
171
|
+
invalid_properties.push('invalid value for "object", object cannot be nil.')
|
|
172
|
+
end
|
|
173
|
+
|
|
174
|
+
if @provider.nil?
|
|
175
|
+
invalid_properties.push('invalid value for "provider", provider cannot be nil.')
|
|
176
|
+
end
|
|
177
|
+
|
|
178
|
+
if @action.nil?
|
|
179
|
+
invalid_properties.push('invalid value for "action", action cannot be nil.')
|
|
180
|
+
end
|
|
181
|
+
|
|
182
|
+
if @feed.nil?
|
|
183
|
+
invalid_properties.push('invalid value for "feed", feed cannot be nil.')
|
|
184
|
+
end
|
|
185
|
+
|
|
186
|
+
if @repull_feed_url.nil?
|
|
187
|
+
invalid_properties.push('invalid value for "repull_feed_url", repull_feed_url cannot be nil.')
|
|
188
|
+
end
|
|
189
|
+
|
|
190
|
+
if @trigger.nil?
|
|
191
|
+
invalid_properties.push('invalid value for "trigger", trigger cannot be nil.')
|
|
192
|
+
end
|
|
193
|
+
|
|
194
|
+
if @occurred_at.nil?
|
|
195
|
+
invalid_properties.push('invalid value for "occurred_at", occurred_at cannot be nil.')
|
|
196
|
+
end
|
|
197
|
+
|
|
198
|
+
invalid_properties
|
|
199
|
+
end
|
|
200
|
+
|
|
201
|
+
# Check to see if the all the properties in the model are valid
|
|
202
|
+
# @return true if the model is valid
|
|
203
|
+
def valid?
|
|
204
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
|
205
|
+
return false if @object.nil?
|
|
206
|
+
return false if @provider.nil?
|
|
207
|
+
return false if @action.nil?
|
|
208
|
+
return false if @feed.nil?
|
|
209
|
+
return false if @repull_feed_url.nil?
|
|
210
|
+
return false if @trigger.nil?
|
|
211
|
+
return false if @occurred_at.nil?
|
|
212
|
+
true
|
|
213
|
+
end
|
|
214
|
+
|
|
215
|
+
# Custom attribute writer method with validation
|
|
216
|
+
# @param [Object] object Value to be assigned
|
|
217
|
+
def object=(object)
|
|
218
|
+
if object.nil?
|
|
219
|
+
fail ArgumentError, 'object cannot be nil'
|
|
220
|
+
end
|
|
221
|
+
|
|
222
|
+
@object = object
|
|
223
|
+
end
|
|
224
|
+
|
|
225
|
+
# Custom attribute writer method with validation
|
|
226
|
+
# @param [Object] provider Value to be assigned
|
|
227
|
+
def provider=(provider)
|
|
228
|
+
if provider.nil?
|
|
229
|
+
fail ArgumentError, 'provider cannot be nil'
|
|
230
|
+
end
|
|
231
|
+
|
|
232
|
+
@provider = provider
|
|
233
|
+
end
|
|
234
|
+
|
|
235
|
+
# Custom attribute writer method with validation
|
|
236
|
+
# @param [Object] action Value to be assigned
|
|
237
|
+
def action=(action)
|
|
238
|
+
if action.nil?
|
|
239
|
+
fail ArgumentError, 'action cannot be nil'
|
|
240
|
+
end
|
|
241
|
+
|
|
242
|
+
@action = action
|
|
243
|
+
end
|
|
244
|
+
|
|
245
|
+
# Custom attribute writer method with validation
|
|
246
|
+
# @param [Object] feed Value to be assigned
|
|
247
|
+
def feed=(feed)
|
|
248
|
+
if feed.nil?
|
|
249
|
+
fail ArgumentError, 'feed cannot be nil'
|
|
250
|
+
end
|
|
251
|
+
|
|
252
|
+
@feed = feed
|
|
253
|
+
end
|
|
254
|
+
|
|
255
|
+
# Custom attribute writer method with validation
|
|
256
|
+
# @param [Object] repull_feed_url Value to be assigned
|
|
257
|
+
def repull_feed_url=(repull_feed_url)
|
|
258
|
+
if repull_feed_url.nil?
|
|
259
|
+
fail ArgumentError, 'repull_feed_url cannot be nil'
|
|
260
|
+
end
|
|
261
|
+
|
|
262
|
+
@repull_feed_url = repull_feed_url
|
|
263
|
+
end
|
|
264
|
+
|
|
265
|
+
# Custom attribute writer method with validation
|
|
266
|
+
# @param [Object] trigger Value to be assigned
|
|
267
|
+
def trigger=(trigger)
|
|
268
|
+
if trigger.nil?
|
|
269
|
+
fail ArgumentError, 'trigger cannot be nil'
|
|
270
|
+
end
|
|
271
|
+
|
|
272
|
+
@trigger = trigger
|
|
273
|
+
end
|
|
274
|
+
|
|
275
|
+
# Custom attribute writer method with validation
|
|
276
|
+
# @param [Object] occurred_at Value to be assigned
|
|
277
|
+
def occurred_at=(occurred_at)
|
|
278
|
+
if occurred_at.nil?
|
|
279
|
+
fail ArgumentError, 'occurred_at cannot be nil'
|
|
280
|
+
end
|
|
281
|
+
|
|
282
|
+
@occurred_at = occurred_at
|
|
283
|
+
end
|
|
284
|
+
|
|
285
|
+
# Checks equality by comparing each attribute.
|
|
286
|
+
# @param [Object] Object to be compared
|
|
287
|
+
def ==(o)
|
|
288
|
+
return true if self.equal?(o)
|
|
289
|
+
self.class == o.class &&
|
|
290
|
+
object == o.object &&
|
|
291
|
+
provider == o.provider &&
|
|
292
|
+
action == o.action &&
|
|
293
|
+
feed == o.feed &&
|
|
294
|
+
repull_feed_url == o.repull_feed_url &&
|
|
295
|
+
reason == o.reason &&
|
|
296
|
+
trigger == o.trigger &&
|
|
297
|
+
error == o.error &&
|
|
298
|
+
occurred_at == o.occurred_at &&
|
|
299
|
+
docs_url == o.docs_url
|
|
300
|
+
end
|
|
301
|
+
|
|
302
|
+
# @see the `==` method
|
|
303
|
+
# @param [Object] Object to be compared
|
|
304
|
+
def eql?(o)
|
|
305
|
+
self == o
|
|
306
|
+
end
|
|
307
|
+
|
|
308
|
+
# Calculates hash code according to all attributes.
|
|
309
|
+
# @return [Integer] Hash code
|
|
310
|
+
def hash
|
|
311
|
+
[object, provider, action, feed, repull_feed_url, reason, trigger, error, occurred_at, docs_url].hash
|
|
312
|
+
end
|
|
313
|
+
|
|
314
|
+
# Builds the object from hash
|
|
315
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
316
|
+
# @return [Object] Returns the model itself
|
|
317
|
+
def self.build_from_hash(attributes)
|
|
318
|
+
return nil unless attributes.is_a?(Hash)
|
|
319
|
+
attributes = attributes.transform_keys(&:to_sym)
|
|
320
|
+
transformed_hash = {}
|
|
321
|
+
openapi_types.each_pair do |key, type|
|
|
322
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
|
323
|
+
transformed_hash["#{key}"] = nil
|
|
324
|
+
elsif type =~ /\AArray<(.*)>/i
|
|
325
|
+
# check to ensure the input is an array given that the attribute
|
|
326
|
+
# is documented as an array but the input is not
|
|
327
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
|
328
|
+
transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
|
|
329
|
+
end
|
|
330
|
+
elsif !attributes[attribute_map[key]].nil?
|
|
331
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
|
|
332
|
+
end
|
|
333
|
+
end
|
|
334
|
+
new(transformed_hash)
|
|
335
|
+
end
|
|
336
|
+
|
|
337
|
+
# Returns the object in the form of hash
|
|
338
|
+
# @return [Hash] Returns the object in the form of hash
|
|
339
|
+
def to_hash
|
|
340
|
+
hash = {}
|
|
341
|
+
self.class.attribute_map.each_pair do |attr, param|
|
|
342
|
+
value = self.send(attr)
|
|
343
|
+
if value.nil?
|
|
344
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
345
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
346
|
+
end
|
|
347
|
+
|
|
348
|
+
hash[param] = _to_hash(value)
|
|
349
|
+
end
|
|
350
|
+
hash
|
|
351
|
+
end
|
|
352
|
+
|
|
353
|
+
end
|
|
354
|
+
|
|
355
|
+
end
|
|
@@ -0,0 +1,159 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Repull API
|
|
3
|
+
|
|
4
|
+
#The unified API for vacation rental tech. Connect Airbnb, Booking.com, Vrbo and more channels, plus 14 PMS platforms, through one REST API. ## Designed for AI agents Every error response on this API includes machine-parseable fields so an LLM (Claude in MCP, Cursor, Cline, GPT, etc.) can self-recover without escalating to a human: - `error.code` — stable string identifier (e.g. `invalid_params`, `rate_limit_exceeded`) - `error.message` — human-readable cause - `error.fix` — exact recovery steps (e.g. \"Pass `check_in_after` as ISO 8601: `?check_in_after=2026-01-15`\") - `error.docs_url` — link to the canonical write-up at `https://repull.dev/docs/errors/{code}` - `error.request_id` — id to correlate with server-side logs - `error.field` / `error.value_received` / `error.valid_values` / `error.did_you_mean` — when the error is parameter-specific - `error.retry_after` — seconds to wait before retrying (rate-limit + transient upstream) `Access-Control-Expose-Headers` lists `x-request-id` and the `X-RateLimit-*` family so browsers can read them on cross-origin responses. ## Quick Start 1. Get an API key at https://repull.dev/dashboard 2. Connect a PMS: `POST /v1/connect/{provider}` 3. List properties: `GET /v1/properties` 4. Get reservations: `GET /v1/reservations` ## Authentication All requests require a Bearer token: ``` Authorization: Bearer sk_live_YOUR_API_KEY ``` ## Request Correlation (X-Request-ID) Every response carries an `X-Request-ID` header, e.g. `X-Request-ID: req_01HXY...`. Include this id in support tickets and bug reports — we can trace the full request lifecycle (auth, rate limit, handler, downstream calls, log row) from a single id. You may set the header on the inbound request to forward your own trace id; we will echo it back instead of generating a new one. Accepted format: `^[\\\\w.-]{1,128}$`. The id is also embedded in error envelopes as `request_id` so server-side log diffs work even when the response headers are stripped by an intermediate proxy. ## Rate Limits The public API enforces a per-API-key sliding-window rate limit on top of the per-tier monthly + daily-AI quotas. **Default policy:** 600 requests per 60 seconds, per API key. Sliding window — there is no fixed-minute boundary you can burst across. Every response includes: | Header | Meaning | |---|---| | `X-RateLimit-Limit` | Requests permitted in the current window. | | `X-RateLimit-Remaining` | Requests left in the current window after this call. | | `X-RateLimit-Reset` | Unix epoch (seconds) when the next slot opens. | | `X-RateLimit-Policy` | Machine-readable policy descriptor, e.g. `600;w=60`. | | `Retry-After` | Seconds to wait before retrying. **Only present on 429 responses.** | **On 429 (rate_limit_exceeded):** the response body matches the standard error envelope with `code: \"rate_limit_exceeded\"`, plus `limit`, `window_seconds`, `retry_after`, and `request_id` fields. SDKs MUST honor `Retry-After` and use exponential backoff with jitter on subsequent retries — never a tight loop. Recommended backoff: ``` sleep_ms = (Retry-After * 1000) + random(0..250) ``` Monthly + daily-AI tier quotas (`free`, `starter`, `custom`) are enforced separately and also surface as 429s; they include `tier`, `scope`, `limit`, `used` and `resets_at` fields. **The way past a request quota.** The monthly quota refusal (`429 rate_limit_exceeded` with `scope: \"monthly\"`), `402 credits_exhausted` and `429 daily_limit_exceeded` also carry `upgrade` (the cheapest plan that covers your usage: its exact monthly price for your listings, its request quotas and a `checkout_url` that opens checkout for that price; `plan: \"custom\"` with a `contact_email` when no self-serve plan covers it), `credits` (pay-as-you-go: `usd_per_1000_requests`, `top_up_url`, your `balance_usd`), `resets_at` and `projected_monthly_requests`. The per-minute 429 (`scope: \"per_api_key\"`) carries none of these: wait `Retry-After`. ## Plan listing limits Each plan includes a number of **active listings**: | Tier | Active listings | |---|---| | `free` | 3 | | `starter` | no cap: 10 included, then billed per listing | | `custom` | no cap | Going over the plan never blocks your API calls. Listings beyond the plan are **held back**: they stay connected and keep syncing, but they are not served. A held-back listing answers `403 listing_inactive` with `reason: \"plan_limit\"`, and collection routes leave it out. Every JSON response then carries a `planNotice` and the `X-Repull-Listings-Held-Back` header, so you know there is more to see. Choose which listings are active with `POST /v1/listings/status`. Upgrading at `https://repull.dev/dashboard/billing` lifts the cap but does not switch held-back listings on: you choose which to activate afterwards, with the same call or from the dashboard, and each one you switch on is billed from then. Only a call that would itself take you over the plan is refused, with **`402 listings_limit_exceeded`**: activating listings (`PATCH /v1/listings/{id}` with `{ \"active\": true }`, `POST /v1/listings/status`) or creating one (`POST /v1/listings`). Nothing else changes. The envelope carries the tier, the limit, the active count and an upgrade link next to the standard `code` / `message` / `fix` / `docs_url` / `request_id`. If an account has more active listings than its plan (for example after a downgrade), calls are still served and `planNotice` says so (code \"listings_over_plan\"). ## Failed payments If your plan's renewal payment fails, nothing is blocked: your API calls keep working while Stripe retries the card. Every successful JSON response then carries a `billingNotice` (code `payment_failed`) with the amount, when it failed, the next automatic retry (`nextRetryAt`) and `payUrl`, the invoice to pay. It disappears once the invoice is paid.
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 1.0.0
|
|
7
|
+
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.22.0
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'date'
|
|
14
|
+
require 'time'
|
|
15
|
+
|
|
16
|
+
module Repull
|
|
17
|
+
# The imported calendar acted on, as Vrbo shows it.
|
|
18
|
+
class ListingIcalFeedChangedPayloadFeed < ApiModelBase
|
|
19
|
+
attr_accessor :name
|
|
20
|
+
|
|
21
|
+
attr_accessor :url
|
|
22
|
+
|
|
23
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
|
24
|
+
def self.attribute_map
|
|
25
|
+
{
|
|
26
|
+
:'name' => :'name',
|
|
27
|
+
:'url' => :'url'
|
|
28
|
+
}
|
|
29
|
+
end
|
|
30
|
+
|
|
31
|
+
# Returns attribute mapping this model knows about
|
|
32
|
+
def self.acceptable_attribute_map
|
|
33
|
+
attribute_map
|
|
34
|
+
end
|
|
35
|
+
|
|
36
|
+
# Returns all the JSON keys this model knows about
|
|
37
|
+
def self.acceptable_attributes
|
|
38
|
+
acceptable_attribute_map.values
|
|
39
|
+
end
|
|
40
|
+
|
|
41
|
+
# Attribute type mapping.
|
|
42
|
+
def self.openapi_types
|
|
43
|
+
{
|
|
44
|
+
:'name' => :'String',
|
|
45
|
+
:'url' => :'String'
|
|
46
|
+
}
|
|
47
|
+
end
|
|
48
|
+
|
|
49
|
+
# List of attributes with nullable: true
|
|
50
|
+
def self.openapi_nullable
|
|
51
|
+
Set.new([
|
|
52
|
+
:'name',
|
|
53
|
+
:'url'
|
|
54
|
+
])
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
# Initializes the object
|
|
58
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
59
|
+
def initialize(attributes = {})
|
|
60
|
+
if (!attributes.is_a?(Hash))
|
|
61
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `Repull::ListingIcalFeedChangedPayloadFeed` initialize method"
|
|
62
|
+
end
|
|
63
|
+
|
|
64
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
|
65
|
+
acceptable_attribute_map = self.class.acceptable_attribute_map
|
|
66
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
67
|
+
if (!acceptable_attribute_map.key?(k.to_sym))
|
|
68
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `Repull::ListingIcalFeedChangedPayloadFeed`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
|
|
69
|
+
end
|
|
70
|
+
h[k.to_sym] = v
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
if attributes.key?(:'name')
|
|
74
|
+
self.name = attributes[:'name']
|
|
75
|
+
end
|
|
76
|
+
|
|
77
|
+
if attributes.key?(:'url')
|
|
78
|
+
self.url = attributes[:'url']
|
|
79
|
+
end
|
|
80
|
+
end
|
|
81
|
+
|
|
82
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
|
83
|
+
# @return Array for valid properties with the reasons
|
|
84
|
+
def list_invalid_properties
|
|
85
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
|
86
|
+
invalid_properties = Array.new
|
|
87
|
+
invalid_properties
|
|
88
|
+
end
|
|
89
|
+
|
|
90
|
+
# Check to see if the all the properties in the model are valid
|
|
91
|
+
# @return true if the model is valid
|
|
92
|
+
def valid?
|
|
93
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
|
94
|
+
true
|
|
95
|
+
end
|
|
96
|
+
|
|
97
|
+
# Checks equality by comparing each attribute.
|
|
98
|
+
# @param [Object] Object to be compared
|
|
99
|
+
def ==(o)
|
|
100
|
+
return true if self.equal?(o)
|
|
101
|
+
self.class == o.class &&
|
|
102
|
+
name == o.name &&
|
|
103
|
+
url == o.url
|
|
104
|
+
end
|
|
105
|
+
|
|
106
|
+
# @see the `==` method
|
|
107
|
+
# @param [Object] Object to be compared
|
|
108
|
+
def eql?(o)
|
|
109
|
+
self == o
|
|
110
|
+
end
|
|
111
|
+
|
|
112
|
+
# Calculates hash code according to all attributes.
|
|
113
|
+
# @return [Integer] Hash code
|
|
114
|
+
def hash
|
|
115
|
+
[name, url].hash
|
|
116
|
+
end
|
|
117
|
+
|
|
118
|
+
# Builds the object from hash
|
|
119
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
120
|
+
# @return [Object] Returns the model itself
|
|
121
|
+
def self.build_from_hash(attributes)
|
|
122
|
+
return nil unless attributes.is_a?(Hash)
|
|
123
|
+
attributes = attributes.transform_keys(&:to_sym)
|
|
124
|
+
transformed_hash = {}
|
|
125
|
+
openapi_types.each_pair do |key, type|
|
|
126
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
|
127
|
+
transformed_hash["#{key}"] = nil
|
|
128
|
+
elsif type =~ /\AArray<(.*)>/i
|
|
129
|
+
# check to ensure the input is an array given that the attribute
|
|
130
|
+
# is documented as an array but the input is not
|
|
131
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
|
132
|
+
transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
|
|
133
|
+
end
|
|
134
|
+
elsif !attributes[attribute_map[key]].nil?
|
|
135
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
|
|
136
|
+
end
|
|
137
|
+
end
|
|
138
|
+
new(transformed_hash)
|
|
139
|
+
end
|
|
140
|
+
|
|
141
|
+
# Returns the object in the form of hash
|
|
142
|
+
# @return [Hash] Returns the object in the form of hash
|
|
143
|
+
def to_hash
|
|
144
|
+
hash = {}
|
|
145
|
+
self.class.attribute_map.each_pair do |attr, param|
|
|
146
|
+
value = self.send(attr)
|
|
147
|
+
if value.nil?
|
|
148
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
149
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
150
|
+
end
|
|
151
|
+
|
|
152
|
+
hash[param] = _to_hash(value)
|
|
153
|
+
end
|
|
154
|
+
hash
|
|
155
|
+
end
|
|
156
|
+
|
|
157
|
+
end
|
|
158
|
+
|
|
159
|
+
end
|
|
@@ -40,6 +40,7 @@ module Repull
|
|
|
40
40
|
:'InquiryUpdatedEvent',
|
|
41
41
|
:'ListingCreatedEvent',
|
|
42
42
|
:'ListingDeletedEvent',
|
|
43
|
+
:'ListingIcalFeedChangedEvent',
|
|
43
44
|
:'ListingReactivatedEvent',
|
|
44
45
|
:'ListingSuspendedEvent',
|
|
45
46
|
:'ListingUpdatedEvent',
|
|
@@ -96,6 +97,7 @@ module Repull
|
|
|
96
97
|
:'inquiry.updated' => :'InquiryUpdatedEvent',
|
|
97
98
|
:'listing.created' => :'ListingCreatedEvent',
|
|
98
99
|
:'listing.deleted' => :'ListingDeletedEvent',
|
|
100
|
+
:'listing.ical_feed_changed' => :'ListingIcalFeedChangedEvent',
|
|
99
101
|
:'listing.reactivated' => :'ListingReactivatedEvent',
|
|
100
102
|
:'listing.suspended' => :'ListingSuspendedEvent',
|
|
101
103
|
:'listing.updated' => :'ListingUpdatedEvent',
|
|
@@ -39,6 +39,7 @@ module Repull
|
|
|
39
39
|
LISTING_DELETED = "listing.deleted".freeze
|
|
40
40
|
LISTING_SUSPENDED = "listing.suspended".freeze
|
|
41
41
|
LISTING_REACTIVATED = "listing.reactivated".freeze
|
|
42
|
+
LISTING_ICAL_FEED_CHANGED = "listing.ical_feed_changed".freeze
|
|
42
43
|
ACCOUNT_CREATED = "account.created".freeze
|
|
43
44
|
CONNECT_SESSION_COMPLETED = "connect.session.completed".freeze
|
|
44
45
|
CONNECT_SESSION_ABANDONED = "connect.session.abandoned".freeze
|
|
@@ -62,7 +63,7 @@ module Repull
|
|
|
62
63
|
USAGE_QUOTA_WARNING = "usage.quota.warning".freeze
|
|
63
64
|
|
|
64
65
|
def self.all_vars
|
|
65
|
-
@all_vars ||= [RESERVATION_CREATED, RESERVATION_UPDATED, RESERVATION_CANCELLED, RESERVATION_MESSAGE_RECEIVED, CONVERSATION_MESSAGE_STATUS_CHANGED, RESERVATION_MESSAGE_SENT, RESERVATION_MESSAGE_UPDATED, RESERVATION_MESSAGE_READ, RESERVATION_MESSAGE_REACTION, RESERVATION_ALTERATION_CREATED, RESERVATION_ALTERATION_RESPONDED, RESERVATION_REQUEST_CREATED, RESERVATION_REQUEST_UPDATED, BOOKING_UNACKNOWLEDGED, CHANNEL_SYNC_FAILED, CHANNEL_DEGRADED, RESERVATION_THREAD_ASSIGNED, INQUIRY_CREATED, INQUIRY_UPDATED, LISTING_CREATED, LISTING_UPDATED, LISTING_DELETED, LISTING_SUSPENDED, LISTING_REACTIVATED, ACCOUNT_CREATED, CONNECT_SESSION_COMPLETED, CONNECT_SESSION_ABANDONED, ACCOUNT_DISCONNECTED, ACCOUNT_IMPORT_STARTED, ACCOUNT_IMPORT_COMPLETED, ACCOUNT_IMPORT_FAILED, ACCOUNT_UNITS_ADDED, ACCOUNT_CALENDAR_ACCESS_CHANGED, ACCOUNT_NOTIFICATIONS_MISSING, REVIEW_CREATED, REVIEW_RESPONDED, AI_OPERATION_COMPLETED, AI_OPERATION_FAILED, PAYMENT_COMPLETED, PAYMENT_REFUNDED, PAYOUT_COMPLETED, MIGRATION_COMPLETED, MIGRATION_FAILED, REPULL_PING, USAGE_QUOTA_WARNING].freeze
|
|
66
|
+
@all_vars ||= [RESERVATION_CREATED, RESERVATION_UPDATED, RESERVATION_CANCELLED, RESERVATION_MESSAGE_RECEIVED, CONVERSATION_MESSAGE_STATUS_CHANGED, RESERVATION_MESSAGE_SENT, RESERVATION_MESSAGE_UPDATED, RESERVATION_MESSAGE_READ, RESERVATION_MESSAGE_REACTION, RESERVATION_ALTERATION_CREATED, RESERVATION_ALTERATION_RESPONDED, RESERVATION_REQUEST_CREATED, RESERVATION_REQUEST_UPDATED, BOOKING_UNACKNOWLEDGED, CHANNEL_SYNC_FAILED, CHANNEL_DEGRADED, RESERVATION_THREAD_ASSIGNED, INQUIRY_CREATED, INQUIRY_UPDATED, LISTING_CREATED, LISTING_UPDATED, LISTING_DELETED, LISTING_SUSPENDED, LISTING_REACTIVATED, LISTING_ICAL_FEED_CHANGED, ACCOUNT_CREATED, CONNECT_SESSION_COMPLETED, CONNECT_SESSION_ABANDONED, ACCOUNT_DISCONNECTED, ACCOUNT_IMPORT_STARTED, ACCOUNT_IMPORT_COMPLETED, ACCOUNT_IMPORT_FAILED, ACCOUNT_UNITS_ADDED, ACCOUNT_CALENDAR_ACCESS_CHANGED, ACCOUNT_NOTIFICATIONS_MISSING, REVIEW_CREATED, REVIEW_RESPONDED, AI_OPERATION_COMPLETED, AI_OPERATION_FAILED, PAYMENT_COMPLETED, PAYMENT_REFUNDED, PAYOUT_COMPLETED, MIGRATION_COMPLETED, MIGRATION_FAILED, REPULL_PING, USAGE_QUOTA_WARNING].freeze
|
|
66
67
|
end
|
|
67
68
|
|
|
68
69
|
# Builds the enum from string
|
data/lib/repull/version.rb
CHANGED
data/lib/repull.rb
CHANGED
|
@@ -109,6 +109,7 @@ require 'repull/models/apply_connection_mappings200_response_results_inner'
|
|
|
109
109
|
require 'repull/models/apply_connection_mappings_request'
|
|
110
110
|
require 'repull/models/apply_connection_mappings_request_mappings_inner'
|
|
111
111
|
require 'repull/models/auto_map_connection_units200_response'
|
|
112
|
+
require 'repull/models/auto_map_connection_units200_response_results_inner'
|
|
112
113
|
require 'repull/models/auto_map_connection_units_request'
|
|
113
114
|
require 'repull/models/availability_batch_write_request'
|
|
114
115
|
require 'repull/models/availability_write_request'
|
|
@@ -291,6 +292,8 @@ require 'repull/models/get_listing_calendar_sync200_response_channels_inner'
|
|
|
291
292
|
require 'repull/models/get_listing_calendar_sync200_response_channels_inner_problems_inner'
|
|
292
293
|
require 'repull/models/get_listing_calendar_sync200_response_channels_inner_queue'
|
|
293
294
|
require 'repull/models/get_listing_calendar_sync200_response_channels_inner_queue_last_push'
|
|
295
|
+
require 'repull/models/get_listing_ical200_response'
|
|
296
|
+
require 'repull/models/get_listing_ical200_response_vrbo_inner'
|
|
294
297
|
require 'repull/models/get_listing_markups200_response'
|
|
295
298
|
require 'repull/models/get_listing_markups200_response_airbnb_inner'
|
|
296
299
|
require 'repull/models/get_listing_markups200_response_booking_inner'
|
|
@@ -424,6 +427,9 @@ require 'repull/models/listing_fee'
|
|
|
424
427
|
require 'repull/models/listing_generate_content_request'
|
|
425
428
|
require 'repull/models/listing_generate_content_response'
|
|
426
429
|
require 'repull/models/listing_hotel'
|
|
430
|
+
require 'repull/models/listing_ical_feed_changed_event'
|
|
431
|
+
require 'repull/models/listing_ical_feed_changed_payload'
|
|
432
|
+
require 'repull/models/listing_ical_feed_changed_payload_feed'
|
|
427
433
|
require 'repull/models/listing_list_response'
|
|
428
434
|
require 'repull/models/listing_market_state_request'
|
|
429
435
|
require 'repull/models/listing_market_state_response'
|