repull 0.2.22 → 0.2.23

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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: d82e6cd661dd24e5c301a3162fff5560c896fa50d1696e44654d6db67db81317
4
- data.tar.gz: 1d972a3761ad092c24275b67aa19631e960a4a751096b014d738bbb426878ede
3
+ metadata.gz: be99faa1ce8ed6c0f212d4e08868a97f1a17d60bfb706cf5a8d3e38edfba78ff
4
+ data.tar.gz: 97fde1b3eb6f93014f233b7bf3fb7fbc5b4ad9b3d5273833e8245175f2444d4a
5
5
  SHA512:
6
- metadata.gz: 234137120348095122ef508b8e5f3d7131d9710a78eed691605725ebd8fb1e63126aa343cc1f403bd3c23fdc021f0309e2d3bba564e4d1f935120881057f38b4
7
- data.tar.gz: c8d682f2905897c8ab0b91a18e637dd1e5c953217f924d0c5fe1822d68267c91b97162338191dc7f86bad343752e6b676c5afd4bf8c84486c5b7fcef16df6e46
6
+ metadata.gz: f72d50e4e84bcf98d4e7800bd603aeb6b8bc7606ad6f1b4edd37296d58c6504e2303b03f1d2c2faefccde29576ddb4e7fce0a1d6fef4bab772fb32bb7fb7adf2
7
+ data.tar.gz: 6075f9b6a4e73b0b088319fc366b06251730944d36390fda2e3bfd8003696a6e6037375b93b163b1036dd2c625ac7e7f12f11891bfc0bb5c8110f74d74797911
@@ -744,24 +744,24 @@ module Repull
744
744
  return data, status_code, headers
745
745
  end
746
746
 
747
- # Edit Airbnb host review
748
- # Edit a host-side review for an Airbnb stay. Airbnb collapses POST + PUT into the same upstream call (`PUT /v2/listing_reviews/{id}`), so this endpoint covers both initial submit and subsequent edits while the review window is open. Body is a partial `AirbnbReview` — pass the fields you want to change (rating, public review, private feedback, category ratings). Returns `403 listing_inactive` when the listing this resolves to is inactive. An inactive listing keeps syncing, but cannot be read or changed through the API until it is activated.
749
- # @param id [String] Airbnb review id (`HRabc123` style).
750
- # @param airbnb_review [AirbnbReview]
747
+ # Submit your review of a guest (publishes, final)
748
+ # Submit your review of a guest — the review with `reviewerRole: \"host\"`. **Submitting publishes it and is final:** Airbnb has no draft and does not allow edits; a second submission is `409 review_already_submitted`. Airbnb accepts it up to 14 days after checkout (`expiresAt`). Required: `publicReview`, `isRevieweeRecommended` (whether you would host the guest again), and a 1–5 rating for **each** of `cleanliness`, `communication` and `respect_house_rules` — send `rating` to use one score for all three, `categoryRatings` to score them individually, or both (`rating` fills any category you did not rate). Optional: `privateFeedback`, a note to the guest that is not published. A request missing a required piece is refused with `422 invalid_params` naming it, before anything is sent to Airbnb. ```json { \"publicReview\": \"Joanne was a great guest.\", \"rating\": 5, \"privateFeedback\": \"Thanks for leaving the place so tidy!\", \"isRevieweeRecommended\": true } ``` A guest's review of you (`reviewerRole: \"guest\"`) cannot be written here — `409 not_host_review`; reply to it with `POST /v1/channels/airbnb/reviews/{id}/respond`. After the window closes: `409 review_window_closed`. Full guide: https://repull.dev/docs/channels/airbnb/reviews
749
+ # @param id [String] The review's `id` or `externalReviewId`, both as returned by `GET /v1/reviews`.
750
+ # @param airbnb_host_review_submit [AirbnbHostReviewSubmit]
751
751
  # @param [Hash] opts the optional parameters
752
752
  # @return [AirbnbReview]
753
- def edit_airbnb_review(id, airbnb_review, opts = {})
754
- data, _status_code, _headers = edit_airbnb_review_with_http_info(id, airbnb_review, opts)
753
+ def edit_airbnb_review(id, airbnb_host_review_submit, opts = {})
754
+ data, _status_code, _headers = edit_airbnb_review_with_http_info(id, airbnb_host_review_submit, opts)
755
755
  data
756
756
  end
757
757
 
758
- # Edit Airbnb host review
759
- # Edit a host-side review for an Airbnb stay. Airbnb collapses POST + PUT into the same upstream call (`PUT /v2/listing_reviews/{id}`), so this endpoint covers both initial submit and subsequent edits while the review window is open. Body is a partial `AirbnbReview` — pass the fields you want to change (rating, public review, private feedback, category ratings). Returns `403 listing_inactive` when the listing this resolves to is inactive. An inactive listing keeps syncing, but cannot be read or changed through the API until it is activated.
760
- # @param id [String] Airbnb review id (`HRabc123` style).
761
- # @param airbnb_review [AirbnbReview]
758
+ # Submit your review of a guest (publishes, final)
759
+ # Submit your review of a guest — the review with `reviewerRole: \"host\"`. **Submitting publishes it and is final:** Airbnb has no draft and does not allow edits; a second submission is `409 review_already_submitted`. Airbnb accepts it up to 14 days after checkout (`expiresAt`). Required: `publicReview`, `isRevieweeRecommended` (whether you would host the guest again), and a 1–5 rating for **each** of `cleanliness`, `communication` and `respect_house_rules` — send `rating` to use one score for all three, `categoryRatings` to score them individually, or both (`rating` fills any category you did not rate). Optional: `privateFeedback`, a note to the guest that is not published. A request missing a required piece is refused with `422 invalid_params` naming it, before anything is sent to Airbnb. ```json { \"publicReview\": \"Joanne was a great guest.\", \"rating\": 5, \"privateFeedback\": \"Thanks for leaving the place so tidy!\", \"isRevieweeRecommended\": true } ``` A guest's review of you (`reviewerRole: \"guest\"`) cannot be written here — `409 not_host_review`; reply to it with `POST /v1/channels/airbnb/reviews/{id}/respond`. After the window closes: `409 review_window_closed`. Full guide: https://repull.dev/docs/channels/airbnb/reviews
760
+ # @param id [String] The review's `id` or `externalReviewId`, both as returned by `GET /v1/reviews`.
761
+ # @param airbnb_host_review_submit [AirbnbHostReviewSubmit]
762
762
  # @param [Hash] opts the optional parameters
763
763
  # @return [Array<(AirbnbReview, Integer, Hash)>] AirbnbReview data, response status code and response headers
764
- def edit_airbnb_review_with_http_info(id, airbnb_review, opts = {})
764
+ def edit_airbnb_review_with_http_info(id, airbnb_host_review_submit, opts = {})
765
765
  if @api_client.config.debugging
766
766
  @api_client.config.logger.debug 'Calling API: AirbnbApi.edit_airbnb_review ...'
767
767
  end
@@ -769,9 +769,9 @@ module Repull
769
769
  if @api_client.config.client_side_validation && id.nil?
770
770
  fail ArgumentError, "Missing the required parameter 'id' when calling AirbnbApi.edit_airbnb_review"
771
771
  end
772
- # verify the required parameter 'airbnb_review' is set
773
- if @api_client.config.client_side_validation && airbnb_review.nil?
774
- fail ArgumentError, "Missing the required parameter 'airbnb_review' when calling AirbnbApi.edit_airbnb_review"
772
+ # verify the required parameter 'airbnb_host_review_submit' is set
773
+ if @api_client.config.client_side_validation && airbnb_host_review_submit.nil?
774
+ fail ArgumentError, "Missing the required parameter 'airbnb_host_review_submit' when calling AirbnbApi.edit_airbnb_review"
775
775
  end
776
776
  # resource path
777
777
  local_var_path = '/v1/channels/airbnb/reviews/{id}'.sub('{id}', CGI.escape(id.to_s))
@@ -793,7 +793,7 @@ module Repull
793
793
  form_params = opts[:form_params] || {}
794
794
 
795
795
  # http body (model)
796
- post_body = opts[:debug_body] || @api_client.object_to_http_body(airbnb_review)
796
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(airbnb_host_review_submit)
797
797
 
798
798
  # return_type
799
799
  return_type = opts[:debug_return_type] || 'AirbnbReview'
@@ -0,0 +1,281 @@
1
+ =begin
2
+ #Repull API
3
+
4
+ #The unified API for vacation rental tech. Connect to 50+ PMS platforms and 4 OTA channels through one REST API. Built-in AI operations for guest communication, pricing, and listing optimization. ## 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`, and `resetsAt` fields. ## Plan Limits (402 — `listings_limit_exceeded`) The Repull API also enforces a per-tier cap on **active listings**: | Tier | Active listings cap | |---|---| | `free` | 3 | | `starter` | 50 | | `custom` | unlimited | When a customer's active-listing count is above their tier cap, the API returns **`402 Payment Required`** with `error.code = \"listings_limit_exceeded\"` on every route EXCEPT: - `/v1/health` — uptime probes are never gated. - `/v1/usage/*` — so dashboards can render the over-cap state. - Any `DELETE` — so the customer can trim listings to get back under the cap without paying. Unlike 429, 402 is NOT a \"wait and retry\" condition — `Retry-After` is not set. The only paths back to 200 are: 1. `DELETE` enough listings to come back under the cap, or 2. Upgrade at `https://repull.dev/dashboard/billing`. The server-side usage cache is 60s, so the first 200 after an upgrade may take up to a minute. The envelope mirrors `rate_limit_exceeded` for SDK ergonomics: `tier`, `limit`, `active_listings`, `upgrade_url`, plus the standard `code` / `message` / `fix` / `docs_url` / `request_id`.
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
+ # Your review of a guest. Airbnb requires `publicReview`, `isRevieweeRecommended`, and a rating for each of cleanliness, communication and respect_house_rules — through `rating`, `categoryRatings`, or both. Submitting publishes it and is final.
18
+ class AirbnbHostReviewSubmit < ApiModelBase
19
+ # Shown publicly on the guest's profile. `comment` is accepted as an alias.
20
+ attr_accessor :public_review
21
+
22
+ # Used for every category not rated in `categoryRatings`.
23
+ attr_accessor :rating
24
+
25
+ # Per-category scores. Categories not listed take `rating`; without `rating`, all three must be listed.
26
+ attr_accessor :category_ratings
27
+
28
+ # Optional. A note to the guest that is not published.
29
+ attr_accessor :private_feedback
30
+
31
+ # Required. Whether you would host this guest again.
32
+ attr_accessor :is_reviewee_recommended
33
+
34
+ # Attribute mapping from ruby-style variable name to JSON key.
35
+ def self.attribute_map
36
+ {
37
+ :'public_review' => :'publicReview',
38
+ :'rating' => :'rating',
39
+ :'category_ratings' => :'categoryRatings',
40
+ :'private_feedback' => :'privateFeedback',
41
+ :'is_reviewee_recommended' => :'isRevieweeRecommended'
42
+ }
43
+ end
44
+
45
+ # Returns attribute mapping this model knows about
46
+ def self.acceptable_attribute_map
47
+ attribute_map
48
+ end
49
+
50
+ # Returns all the JSON keys this model knows about
51
+ def self.acceptable_attributes
52
+ acceptable_attribute_map.values
53
+ end
54
+
55
+ # Attribute type mapping.
56
+ def self.openapi_types
57
+ {
58
+ :'public_review' => :'String',
59
+ :'rating' => :'Integer',
60
+ :'category_ratings' => :'Array<AirbnbHostReviewSubmitCategoryRatingsInner>',
61
+ :'private_feedback' => :'String',
62
+ :'is_reviewee_recommended' => :'Boolean'
63
+ }
64
+ end
65
+
66
+ # List of attributes with nullable: true
67
+ def self.openapi_nullable
68
+ Set.new([
69
+ ])
70
+ end
71
+
72
+ # Initializes the object
73
+ # @param [Hash] attributes Model attributes in the form of hash
74
+ def initialize(attributes = {})
75
+ if (!attributes.is_a?(Hash))
76
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Repull::AirbnbHostReviewSubmit` initialize method"
77
+ end
78
+
79
+ # check to see if the attribute exists and convert string to symbol for hash key
80
+ acceptable_attribute_map = self.class.acceptable_attribute_map
81
+ attributes = attributes.each_with_object({}) { |(k, v), h|
82
+ if (!acceptable_attribute_map.key?(k.to_sym))
83
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Repull::AirbnbHostReviewSubmit`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
84
+ end
85
+ h[k.to_sym] = v
86
+ }
87
+
88
+ if attributes.key?(:'public_review')
89
+ self.public_review = attributes[:'public_review']
90
+ else
91
+ self.public_review = nil
92
+ end
93
+
94
+ if attributes.key?(:'rating')
95
+ self.rating = attributes[:'rating']
96
+ end
97
+
98
+ if attributes.key?(:'category_ratings')
99
+ if (value = attributes[:'category_ratings']).is_a?(Array)
100
+ self.category_ratings = value
101
+ end
102
+ end
103
+
104
+ if attributes.key?(:'private_feedback')
105
+ self.private_feedback = attributes[:'private_feedback']
106
+ end
107
+
108
+ if attributes.key?(:'is_reviewee_recommended')
109
+ self.is_reviewee_recommended = attributes[:'is_reviewee_recommended']
110
+ else
111
+ self.is_reviewee_recommended = nil
112
+ end
113
+ end
114
+
115
+ # Show invalid properties with the reasons. Usually used together with valid?
116
+ # @return Array for valid properties with the reasons
117
+ def list_invalid_properties
118
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
119
+ invalid_properties = Array.new
120
+ if @public_review.nil?
121
+ invalid_properties.push('invalid value for "public_review", public_review cannot be nil.')
122
+ end
123
+
124
+ if @public_review.to_s.length > 1000
125
+ invalid_properties.push('invalid value for "public_review", the character length must be smaller than or equal to 1000.')
126
+ end
127
+
128
+ if !@rating.nil? && @rating > 5
129
+ invalid_properties.push('invalid value for "rating", must be smaller than or equal to 5.')
130
+ end
131
+
132
+ if !@rating.nil? && @rating < 1
133
+ invalid_properties.push('invalid value for "rating", must be greater than or equal to 1.')
134
+ end
135
+
136
+ if !@private_feedback.nil? && @private_feedback.to_s.length > 1000
137
+ invalid_properties.push('invalid value for "private_feedback", the character length must be smaller than or equal to 1000.')
138
+ end
139
+
140
+ if @is_reviewee_recommended.nil?
141
+ invalid_properties.push('invalid value for "is_reviewee_recommended", is_reviewee_recommended cannot be nil.')
142
+ end
143
+
144
+ invalid_properties
145
+ end
146
+
147
+ # Check to see if the all the properties in the model are valid
148
+ # @return true if the model is valid
149
+ def valid?
150
+ warn '[DEPRECATED] the `valid?` method is obsolete'
151
+ return false if @public_review.nil?
152
+ return false if @public_review.to_s.length > 1000
153
+ return false if !@rating.nil? && @rating > 5
154
+ return false if !@rating.nil? && @rating < 1
155
+ return false if !@private_feedback.nil? && @private_feedback.to_s.length > 1000
156
+ return false if @is_reviewee_recommended.nil?
157
+ true
158
+ end
159
+
160
+ # Custom attribute writer method with validation
161
+ # @param [Object] public_review Value to be assigned
162
+ def public_review=(public_review)
163
+ if public_review.nil?
164
+ fail ArgumentError, 'public_review cannot be nil'
165
+ end
166
+
167
+ if public_review.to_s.length > 1000
168
+ fail ArgumentError, 'invalid value for "public_review", the character length must be smaller than or equal to 1000.'
169
+ end
170
+
171
+ @public_review = public_review
172
+ end
173
+
174
+ # Custom attribute writer method with validation
175
+ # @param [Object] rating Value to be assigned
176
+ def rating=(rating)
177
+ if rating.nil?
178
+ fail ArgumentError, 'rating cannot be nil'
179
+ end
180
+
181
+ if rating > 5
182
+ fail ArgumentError, 'invalid value for "rating", must be smaller than or equal to 5.'
183
+ end
184
+
185
+ if rating < 1
186
+ fail ArgumentError, 'invalid value for "rating", must be greater than or equal to 1.'
187
+ end
188
+
189
+ @rating = rating
190
+ end
191
+
192
+ # Custom attribute writer method with validation
193
+ # @param [Object] private_feedback Value to be assigned
194
+ def private_feedback=(private_feedback)
195
+ if private_feedback.nil?
196
+ fail ArgumentError, 'private_feedback cannot be nil'
197
+ end
198
+
199
+ if private_feedback.to_s.length > 1000
200
+ fail ArgumentError, 'invalid value for "private_feedback", the character length must be smaller than or equal to 1000.'
201
+ end
202
+
203
+ @private_feedback = private_feedback
204
+ end
205
+
206
+ # Custom attribute writer method with validation
207
+ # @param [Object] is_reviewee_recommended Value to be assigned
208
+ def is_reviewee_recommended=(is_reviewee_recommended)
209
+ if is_reviewee_recommended.nil?
210
+ fail ArgumentError, 'is_reviewee_recommended cannot be nil'
211
+ end
212
+
213
+ @is_reviewee_recommended = is_reviewee_recommended
214
+ end
215
+
216
+ # Checks equality by comparing each attribute.
217
+ # @param [Object] Object to be compared
218
+ def ==(o)
219
+ return true if self.equal?(o)
220
+ self.class == o.class &&
221
+ public_review == o.public_review &&
222
+ rating == o.rating &&
223
+ category_ratings == o.category_ratings &&
224
+ private_feedback == o.private_feedback &&
225
+ is_reviewee_recommended == o.is_reviewee_recommended
226
+ end
227
+
228
+ # @see the `==` method
229
+ # @param [Object] Object to be compared
230
+ def eql?(o)
231
+ self == o
232
+ end
233
+
234
+ # Calculates hash code according to all attributes.
235
+ # @return [Integer] Hash code
236
+ def hash
237
+ [public_review, rating, category_ratings, private_feedback, is_reviewee_recommended].hash
238
+ end
239
+
240
+ # Builds the object from hash
241
+ # @param [Hash] attributes Model attributes in the form of hash
242
+ # @return [Object] Returns the model itself
243
+ def self.build_from_hash(attributes)
244
+ return nil unless attributes.is_a?(Hash)
245
+ attributes = attributes.transform_keys(&:to_sym)
246
+ transformed_hash = {}
247
+ openapi_types.each_pair do |key, type|
248
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
249
+ transformed_hash["#{key}"] = nil
250
+ elsif type =~ /\AArray<(.*)>/i
251
+ # check to ensure the input is an array given that the attribute
252
+ # is documented as an array but the input is not
253
+ if attributes[attribute_map[key]].is_a?(Array)
254
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
255
+ end
256
+ elsif !attributes[attribute_map[key]].nil?
257
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
258
+ end
259
+ end
260
+ new(transformed_hash)
261
+ end
262
+
263
+ # Returns the object in the form of hash
264
+ # @return [Hash] Returns the object in the form of hash
265
+ def to_hash
266
+ hash = {}
267
+ self.class.attribute_map.each_pair do |attr, param|
268
+ value = self.send(attr)
269
+ if value.nil?
270
+ is_nullable = self.class.openapi_nullable.include?(attr)
271
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
272
+ end
273
+
274
+ hash[param] = _to_hash(value)
275
+ end
276
+ hash
277
+ end
278
+
279
+ end
280
+
281
+ end
@@ -0,0 +1,261 @@
1
+ =begin
2
+ #Repull API
3
+
4
+ #The unified API for vacation rental tech. Connect to 50+ PMS platforms and 4 OTA channels through one REST API. Built-in AI operations for guest communication, pricing, and listing optimization. ## 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`, and `resetsAt` fields. ## Plan Limits (402 — `listings_limit_exceeded`) The Repull API also enforces a per-tier cap on **active listings**: | Tier | Active listings cap | |---|---| | `free` | 3 | | `starter` | 50 | | `custom` | unlimited | When a customer's active-listing count is above their tier cap, the API returns **`402 Payment Required`** with `error.code = \"listings_limit_exceeded\"` on every route EXCEPT: - `/v1/health` — uptime probes are never gated. - `/v1/usage/*` — so dashboards can render the over-cap state. - Any `DELETE` — so the customer can trim listings to get back under the cap without paying. Unlike 429, 402 is NOT a \"wait and retry\" condition — `Retry-After` is not set. The only paths back to 200 are: 1. `DELETE` enough listings to come back under the cap, or 2. Upgrade at `https://repull.dev/dashboard/billing`. The server-side usage cache is 60s, so the first 200 after an upgrade may take up to a minute. The envelope mirrors `rate_limit_exceeded` for SDK ergonomics: `tier`, `limit`, `active_listings`, `upgrade_url`, plus the standard `code` / `message` / `fix` / `docs_url` / `request_id`.
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
+ class AirbnbHostReviewSubmitCategoryRatingsInner < ApiModelBase
18
+ attr_accessor :category
19
+
20
+ attr_accessor :rating
21
+
22
+ # Optional note for this category (Airbnb caps it at 50 characters).
23
+ attr_accessor :comment
24
+
25
+ class EnumAttributeValidator
26
+ attr_reader :datatype
27
+ attr_reader :allowable_values
28
+
29
+ def initialize(datatype, allowable_values)
30
+ @allowable_values = allowable_values.map do |value|
31
+ case datatype.to_s
32
+ when /Integer/i
33
+ value.to_i
34
+ when /Float/i
35
+ value.to_f
36
+ else
37
+ value
38
+ end
39
+ end
40
+ end
41
+
42
+ def valid?(value)
43
+ !value || allowable_values.include?(value)
44
+ end
45
+ end
46
+
47
+ # Attribute mapping from ruby-style variable name to JSON key.
48
+ def self.attribute_map
49
+ {
50
+ :'category' => :'category',
51
+ :'rating' => :'rating',
52
+ :'comment' => :'comment'
53
+ }
54
+ end
55
+
56
+ # Returns attribute mapping this model knows about
57
+ def self.acceptable_attribute_map
58
+ attribute_map
59
+ end
60
+
61
+ # Returns all the JSON keys this model knows about
62
+ def self.acceptable_attributes
63
+ acceptable_attribute_map.values
64
+ end
65
+
66
+ # Attribute type mapping.
67
+ def self.openapi_types
68
+ {
69
+ :'category' => :'String',
70
+ :'rating' => :'Integer',
71
+ :'comment' => :'String'
72
+ }
73
+ end
74
+
75
+ # List of attributes with nullable: true
76
+ def self.openapi_nullable
77
+ Set.new([
78
+ ])
79
+ end
80
+
81
+ # Initializes the object
82
+ # @param [Hash] attributes Model attributes in the form of hash
83
+ def initialize(attributes = {})
84
+ if (!attributes.is_a?(Hash))
85
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Repull::AirbnbHostReviewSubmitCategoryRatingsInner` initialize method"
86
+ end
87
+
88
+ # check to see if the attribute exists and convert string to symbol for hash key
89
+ acceptable_attribute_map = self.class.acceptable_attribute_map
90
+ attributes = attributes.each_with_object({}) { |(k, v), h|
91
+ if (!acceptable_attribute_map.key?(k.to_sym))
92
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Repull::AirbnbHostReviewSubmitCategoryRatingsInner`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
93
+ end
94
+ h[k.to_sym] = v
95
+ }
96
+
97
+ if attributes.key?(:'category')
98
+ self.category = attributes[:'category']
99
+ else
100
+ self.category = nil
101
+ end
102
+
103
+ if attributes.key?(:'rating')
104
+ self.rating = attributes[:'rating']
105
+ else
106
+ self.rating = nil
107
+ end
108
+
109
+ if attributes.key?(:'comment')
110
+ self.comment = attributes[:'comment']
111
+ end
112
+ end
113
+
114
+ # Show invalid properties with the reasons. Usually used together with valid?
115
+ # @return Array for valid properties with the reasons
116
+ def list_invalid_properties
117
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
118
+ invalid_properties = Array.new
119
+ if @category.nil?
120
+ invalid_properties.push('invalid value for "category", category cannot be nil.')
121
+ end
122
+
123
+ if @rating.nil?
124
+ invalid_properties.push('invalid value for "rating", rating cannot be nil.')
125
+ end
126
+
127
+ if @rating > 5
128
+ invalid_properties.push('invalid value for "rating", must be smaller than or equal to 5.')
129
+ end
130
+
131
+ if @rating < 1
132
+ invalid_properties.push('invalid value for "rating", must be greater than or equal to 1.')
133
+ end
134
+
135
+ if !@comment.nil? && @comment.to_s.length > 50
136
+ invalid_properties.push('invalid value for "comment", the character length must be smaller than or equal to 50.')
137
+ end
138
+
139
+ invalid_properties
140
+ end
141
+
142
+ # Check to see if the all the properties in the model are valid
143
+ # @return true if the model is valid
144
+ def valid?
145
+ warn '[DEPRECATED] the `valid?` method is obsolete'
146
+ return false if @category.nil?
147
+ category_validator = EnumAttributeValidator.new('String', ["cleanliness", "communication", "respect_house_rules"])
148
+ return false unless category_validator.valid?(@category)
149
+ return false if @rating.nil?
150
+ return false if @rating > 5
151
+ return false if @rating < 1
152
+ return false if !@comment.nil? && @comment.to_s.length > 50
153
+ true
154
+ end
155
+
156
+ # Custom attribute writer method checking allowed values (enum).
157
+ # @param [Object] category Object to be assigned
158
+ def category=(category)
159
+ validator = EnumAttributeValidator.new('String', ["cleanliness", "communication", "respect_house_rules"])
160
+ unless validator.valid?(category)
161
+ fail ArgumentError, "invalid value for \"category\", must be one of #{validator.allowable_values}."
162
+ end
163
+ @category = category
164
+ end
165
+
166
+ # Custom attribute writer method with validation
167
+ # @param [Object] rating Value to be assigned
168
+ def rating=(rating)
169
+ if rating.nil?
170
+ fail ArgumentError, 'rating cannot be nil'
171
+ end
172
+
173
+ if rating > 5
174
+ fail ArgumentError, 'invalid value for "rating", must be smaller than or equal to 5.'
175
+ end
176
+
177
+ if rating < 1
178
+ fail ArgumentError, 'invalid value for "rating", must be greater than or equal to 1.'
179
+ end
180
+
181
+ @rating = rating
182
+ end
183
+
184
+ # Custom attribute writer method with validation
185
+ # @param [Object] comment Value to be assigned
186
+ def comment=(comment)
187
+ if comment.nil?
188
+ fail ArgumentError, 'comment cannot be nil'
189
+ end
190
+
191
+ if comment.to_s.length > 50
192
+ fail ArgumentError, 'invalid value for "comment", the character length must be smaller than or equal to 50.'
193
+ end
194
+
195
+ @comment = comment
196
+ end
197
+
198
+ # Checks equality by comparing each attribute.
199
+ # @param [Object] Object to be compared
200
+ def ==(o)
201
+ return true if self.equal?(o)
202
+ self.class == o.class &&
203
+ category == o.category &&
204
+ rating == o.rating &&
205
+ comment == o.comment
206
+ end
207
+
208
+ # @see the `==` method
209
+ # @param [Object] Object to be compared
210
+ def eql?(o)
211
+ self == o
212
+ end
213
+
214
+ # Calculates hash code according to all attributes.
215
+ # @return [Integer] Hash code
216
+ def hash
217
+ [category, rating, comment].hash
218
+ end
219
+
220
+ # Builds the object from hash
221
+ # @param [Hash] attributes Model attributes in the form of hash
222
+ # @return [Object] Returns the model itself
223
+ def self.build_from_hash(attributes)
224
+ return nil unless attributes.is_a?(Hash)
225
+ attributes = attributes.transform_keys(&:to_sym)
226
+ transformed_hash = {}
227
+ openapi_types.each_pair do |key, type|
228
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
229
+ transformed_hash["#{key}"] = nil
230
+ elsif type =~ /\AArray<(.*)>/i
231
+ # check to ensure the input is an array given that the attribute
232
+ # is documented as an array but the input is not
233
+ if attributes[attribute_map[key]].is_a?(Array)
234
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
235
+ end
236
+ elsif !attributes[attribute_map[key]].nil?
237
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
238
+ end
239
+ end
240
+ new(transformed_hash)
241
+ end
242
+
243
+ # Returns the object in the form of hash
244
+ # @return [Hash] Returns the object in the form of hash
245
+ def to_hash
246
+ hash = {}
247
+ self.class.attribute_map.each_pair do |attr, param|
248
+ value = self.send(attr)
249
+ if value.nil?
250
+ is_nullable = self.class.openapi_nullable.include?(attr)
251
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
252
+ end
253
+
254
+ hash[param] = _to_hash(value)
255
+ end
256
+ hash
257
+ end
258
+
259
+ end
260
+
261
+ end
@@ -11,5 +11,5 @@ Generator version: 7.22.0
11
11
  =end
12
12
 
13
13
  module Repull
14
- VERSION = '0.2.22'
14
+ VERSION = '0.2.23'
15
15
  end
data/lib/repull.rb CHANGED
@@ -46,6 +46,8 @@ require 'repull/models/airbnb_content_write_response'
46
46
  require 'repull/models/airbnb_data_freshness'
47
47
  require 'repull/models/airbnb_description_write_request'
48
48
  require 'repull/models/airbnb_description_write_request_description'
49
+ require 'repull/models/airbnb_host_review_submit'
50
+ require 'repull/models/airbnb_host_review_submit_category_ratings_inner'
49
51
  require 'repull/models/airbnb_listing'
50
52
  require 'repull/models/airbnb_listing_action200_response'
51
53
  require 'repull/models/airbnb_listing_action200_response_one_of'
data/openapi/v1.json CHANGED
@@ -5636,6 +5636,82 @@
5636
5636
  }
5637
5637
  }
5638
5638
  },
5639
+ "AirbnbHostReviewSubmit": {
5640
+ "type": "object",
5641
+ "description": "Your review of a guest. Airbnb requires `publicReview`, `isRevieweeRecommended`, and a rating for each of cleanliness, communication and respect_house_rules \u2014 through `rating`, `categoryRatings`, or both. Submitting publishes it and is final.",
5642
+ "required": [
5643
+ "publicReview",
5644
+ "isRevieweeRecommended"
5645
+ ],
5646
+ "properties": {
5647
+ "publicReview": {
5648
+ "type": "string",
5649
+ "maxLength": 1000,
5650
+ "description": "Shown publicly on the guest's profile. `comment` is accepted as an alias.",
5651
+ "example": "Joanne was a great guest. The space was kept clean and communication was clear."
5652
+ },
5653
+ "rating": {
5654
+ "type": "integer",
5655
+ "minimum": 1,
5656
+ "maximum": 5,
5657
+ "description": "Used for every category not rated in `categoryRatings`.",
5658
+ "example": 5
5659
+ },
5660
+ "categoryRatings": {
5661
+ "type": "array",
5662
+ "description": "Per-category scores. Categories not listed take `rating`; without `rating`, all three must be listed.",
5663
+ "items": {
5664
+ "type": "object",
5665
+ "required": [
5666
+ "category",
5667
+ "rating"
5668
+ ],
5669
+ "properties": {
5670
+ "category": {
5671
+ "type": "string",
5672
+ "enum": [
5673
+ "cleanliness",
5674
+ "communication",
5675
+ "respect_house_rules"
5676
+ ]
5677
+ },
5678
+ "rating": {
5679
+ "type": "integer",
5680
+ "minimum": 1,
5681
+ "maximum": 5
5682
+ },
5683
+ "comment": {
5684
+ "type": "string",
5685
+ "maxLength": 50,
5686
+ "description": "Optional note for this category (Airbnb caps it at 50 characters)."
5687
+ }
5688
+ }
5689
+ }
5690
+ },
5691
+ "privateFeedback": {
5692
+ "type": "string",
5693
+ "maxLength": 1000,
5694
+ "description": "Optional. A note to the guest that is not published."
5695
+ },
5696
+ "isRevieweeRecommended": {
5697
+ "type": "boolean",
5698
+ "description": "Required. Whether you would host this guest again."
5699
+ }
5700
+ },
5701
+ "example": {
5702
+ "publicReview": "Joanne was a great guest. The space was kept clean and communication was clear.",
5703
+ "rating": 5,
5704
+ "categoryRatings": [
5705
+ {
5706
+ "category": "cleanliness",
5707
+ "rating": 5,
5708
+ "comment": "Left it spotless"
5709
+ }
5710
+ ],
5711
+ "privateFeedback": "Thanks for being such a considerate guest!",
5712
+ "isRevieweeRecommended": true
5713
+ }
5714
+ },
5639
5715
  "AirbnbReview": {
5640
5716
  "type": "object",
5641
5717
  "description": "An Airbnb review (guest \u2192 host or host \u2192 guest).",
@@ -18729,8 +18805,8 @@
18729
18805
  "/v1/channels/airbnb/reviews/{id}": {
18730
18806
  "put": {
18731
18807
  "operationId": "edit_airbnb_review",
18732
- "summary": "Edit Airbnb host review",
18733
- "description": "Edit a host-side review for an Airbnb stay. Airbnb collapses POST + PUT into the same upstream call (`PUT /v2/listing_reviews/{id}`), so this endpoint covers both initial submit and subsequent edits while the review window is open.\n\nBody is a partial `AirbnbReview` \u2014 pass the fields you want to change (rating, public review, private feedback, category ratings).\n\nReturns `403 listing_inactive` when the listing this resolves to is inactive. An inactive listing keeps syncing, but cannot be read or changed through the API until it is activated.",
18808
+ "summary": "Submit your review of a guest (publishes, final)",
18809
+ "description": "Submit your review of a guest \u2014 the review with `reviewerRole: \"host\"`. **Submitting publishes it and is final:** Airbnb has no draft and does not allow edits; a second submission is `409 review_already_submitted`. Airbnb accepts it up to 14 days after checkout (`expiresAt`).\n\nRequired: `publicReview`, `isRevieweeRecommended` (whether you would host the guest again), and a 1\u20135 rating for **each** of `cleanliness`, `communication` and `respect_house_rules` \u2014 send `rating` to use one score for all three, `categoryRatings` to score them individually, or both (`rating` fills any category you did not rate). Optional: `privateFeedback`, a note to the guest that is not published. A request missing a required piece is refused with `422 invalid_params` naming it, before anything is sent to Airbnb.\n\n```json\n{\n \"publicReview\": \"Joanne was a great guest.\",\n \"rating\": 5,\n \"privateFeedback\": \"Thanks for leaving the place so tidy!\",\n \"isRevieweeRecommended\": true\n}\n```\n\nA guest's review of you (`reviewerRole: \"guest\"`) cannot be written here \u2014 `409 not_host_review`; reply to it with `POST /v1/channels/airbnb/reviews/{id}/respond`. After the window closes: `409 review_window_closed`. Full guide: https://repull.dev/docs/channels/airbnb/reviews",
18734
18810
  "tags": [
18735
18811
  "Airbnb"
18736
18812
  ],
@@ -18742,7 +18818,7 @@
18742
18818
  "schema": {
18743
18819
  "type": "string"
18744
18820
  },
18745
- "description": "Airbnb review id (`HRabc123` style)."
18821
+ "description": "The review's `id` or `externalReviewId`, both as returned by `GET /v1/reviews`."
18746
18822
  }
18747
18823
  ],
18748
18824
  "requestBody": {
@@ -18750,7 +18826,7 @@
18750
18826
  "content": {
18751
18827
  "application/json": {
18752
18828
  "schema": {
18753
- "$ref": "#/components/schemas/AirbnbReview"
18829
+ "$ref": "#/components/schemas/AirbnbHostReviewSubmit"
18754
18830
  }
18755
18831
  }
18756
18832
  }
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: repull
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.22
4
+ version: 0.2.23
5
5
  platform: ruby
6
6
  authors:
7
7
  - Ivan Nikolov
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2026-09-27 00:00:00.000000000 Z
11
+ date: 2026-09-28 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus
@@ -121,6 +121,8 @@ files:
121
121
  - lib/repull/models/airbnb_data_freshness.rb
122
122
  - lib/repull/models/airbnb_description_write_request.rb
123
123
  - lib/repull/models/airbnb_description_write_request_description.rb
124
+ - lib/repull/models/airbnb_host_review_submit.rb
125
+ - lib/repull/models/airbnb_host_review_submit_category_ratings_inner.rb
124
126
  - lib/repull/models/airbnb_listing.rb
125
127
  - lib/repull/models/airbnb_listing_action200_response.rb
126
128
  - lib/repull/models/airbnb_listing_action200_response_one_of.rb