repull 0.2.25 → 0.2.26
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/connect_api.rb +2 -2
- data/lib/repull/api/conversations_api.rb +3 -0
- data/lib/repull/api/properties_api.rb +3 -0
- data/lib/repull/api/reservations_api.rb +3 -0
- data/lib/repull/api/reviews_api.rb +3 -0
- data/lib/repull/api/vrbo_api.rb +4 -4
- data/lib/repull/models/connect_session_completed_event.rb +281 -0
- data/lib/repull/models/connect_session_completed_payload.rb +210 -0
- data/lib/repull/models/conversation.rb +12 -1
- data/lib/repull/models/conversation_detail.rb +12 -1
- data/lib/repull/models/create_connect_session_request.rb +1 -1
- data/lib/repull/models/create_connection_request.rb +8 -8
- data/lib/repull/models/property.rb +14 -2
- data/lib/repull/models/record_account.rb +170 -0
- data/lib/repull/models/reservation.rb +12 -1
- data/lib/repull/models/review.rb +12 -1
- 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 +3 -0
- data/openapi/v1.json +164 -7
- data/scripts/regen.sh +1 -1
- metadata +4 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: fef8493c31534a2fc602d8313b944226dca625c07020289f1f092f52aefcf1a0
|
|
4
|
+
data.tar.gz: d89110c66d3cf8712533219602b188406ce24f71c200acc304332045d7db657a
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: f5e3002a7e8ed1d585bd7dcaf3f79281de903c4bdd1bcd2b2f53e60cd26e193fb730784c342f7770363bfb5bbe7d71b2f231c7cbb3b1488b3a00fa3f985e1804
|
|
7
|
+
data.tar.gz: f50bc87cb20b444c2d06695b2d60dd85347a9c4aedc9fdf5b1d7798efa19b25a91a02e5994c9a5cec8f7716578a3d8ac6fb95880fb6933c83528500184f76acc
|
|
@@ -156,7 +156,7 @@ module Repull
|
|
|
156
156
|
end
|
|
157
157
|
|
|
158
158
|
# Connect to PMS/OTA provider
|
|
159
|
-
# Establish a connection to a PMS or OTA platform. Credentials vary by provider — see docs for each provider. Airbnb-specific: pass `redirectUrl` (where to send the user after consent) and optionally `accessType`. Three tiers: `read_only` grants read-only scopes; `messaging` grants read scopes plus message read/send but NOT property management, so it can coexist with another app (e.g. an existing PMS) that already holds property management on the same Airbnb account; `full_access` — the default — grants full host scopes including the exclusive property management (only one app per Airbnb account can hold it). The response returns a hosted `url` to redirect the user to. Booking.com: pass `redirectUrl` (no `accessType`). The response returns a hosted `url` — send the user there to designate FantasticStay in their Booking.com Extranet and paste their Hotel ID. Same response shape as Airbnb (`url`, `sessionId`, `expiresAt`). PMS providers
|
|
159
|
+
# Establish a connection to a PMS or OTA platform. Credentials vary by provider — see docs for each provider. Airbnb-specific: pass `redirectUrl` (where to send the user after consent) and optionally `accessType`. Three tiers: `read_only` grants read-only scopes; `messaging` grants read scopes plus message read/send but NOT property management, so it can coexist with another app (e.g. an existing PMS) that already holds property management on the same Airbnb account; `full_access` — the default — grants full host scopes including the exclusive property management (only one app per Airbnb account can hold it). The response returns a hosted `url` to redirect the user to. Booking.com: pass `redirectUrl` (no `accessType`). The response returns a hosted `url` — send the user there to designate FantasticStay in their Booking.com Extranet and paste their Hotel ID. Same response shape as Airbnb (`url`, `sessionId`, `expiresAt`). Plumguide passes `clientId`/`clientSecret`. PMS providers are not connected by this call: send their credentials to `POST /v1/connect/{provider}/credentials`, or start a hosted session with `POST /v1/connect`.
|
|
160
160
|
# @param provider [String] PMS provider slug (e.g., hostaway, guesty, ownerrez)
|
|
161
161
|
# @param [Hash] opts the optional parameters
|
|
162
162
|
# @option opts [CreateConnectionRequest] :create_connection_request
|
|
@@ -167,7 +167,7 @@ module Repull
|
|
|
167
167
|
end
|
|
168
168
|
|
|
169
169
|
# Connect to PMS/OTA provider
|
|
170
|
-
# Establish a connection to a PMS or OTA platform. Credentials vary by provider — see docs for each provider. Airbnb-specific: pass `redirectUrl` (where to send the user after consent) and optionally `accessType`. Three tiers: `read_only` grants read-only scopes; `messaging` grants read scopes plus message read/send but NOT property management, so it can coexist with another app (e.g. an existing PMS) that already holds property management on the same Airbnb account; `full_access` — the default — grants full host scopes including the exclusive property management (only one app per Airbnb account can hold it). The response returns a hosted `url` to redirect the user to. Booking.com: pass `redirectUrl` (no `accessType`). The response returns a hosted `url` — send the user there to designate FantasticStay in their Booking.com Extranet and paste their Hotel ID. Same response shape as Airbnb (`url`, `sessionId`, `expiresAt`). PMS providers
|
|
170
|
+
# Establish a connection to a PMS or OTA platform. Credentials vary by provider — see docs for each provider. Airbnb-specific: pass `redirectUrl` (where to send the user after consent) and optionally `accessType`. Three tiers: `read_only` grants read-only scopes; `messaging` grants read scopes plus message read/send but NOT property management, so it can coexist with another app (e.g. an existing PMS) that already holds property management on the same Airbnb account; `full_access` — the default — grants full host scopes including the exclusive property management (only one app per Airbnb account can hold it). The response returns a hosted `url` to redirect the user to. Booking.com: pass `redirectUrl` (no `accessType`). The response returns a hosted `url` — send the user there to designate FantasticStay in their Booking.com Extranet and paste their Hotel ID. Same response shape as Airbnb (`url`, `sessionId`, `expiresAt`). Plumguide passes `clientId`/`clientSecret`. PMS providers are not connected by this call: send their credentials to `POST /v1/connect/{provider}/credentials`, or start a hosted session with `POST /v1/connect`.
|
|
171
171
|
# @param provider [String] PMS provider slug (e.g., hostaway, guesty, ownerrez)
|
|
172
172
|
# @param [Hash] opts the optional parameters
|
|
173
173
|
# @option opts [CreateConnectionRequest] :create_connection_request
|
|
@@ -336,6 +336,7 @@ module Repull
|
|
|
336
336
|
# List conversations
|
|
337
337
|
# Cursor-paginated list of message threads owned by the workspace. Use `pagination.nextCursor` from one response as the `cursor` query param of the next request. `?offset=` is also accepted as a first-class alias for shallow paging (0..10000) — see the `offset` parameter below. Mutually exclusive with `cursor`. Filters: `platform` (`airbnb`|`booking`|`vrbo`|`website`|`email`), `status` (`open`|`archived` — `archived` is a stable no-op until the bit lands on `message_threads`). **Inactive listings:** conversations that belong to an inactive listing (by the thread's listing or its reservation's listing) are left out of the page and of `pagination.total`. Inactive listings keep syncing; activate the listing to use it here.
|
|
338
338
|
# @param [Hash] opts the optional parameters
|
|
339
|
+
# @option opts [String] :account Only the records of one connected account, as `provider:externalAccountId` — the pair from a webhook `account` block, `connect.session.completed`, or `GET /v1/connect/{provider}` → `accounts`. A record belongs to an account when it is on that account's listings and on its channel (a PMS account: came in through that PMS). An account with no listings returns an empty page.
|
|
339
340
|
# @option opts [String] :x_schema Apply a custom or built-in schema to transform the response. Built-in: `native` (default), `calry`, `calry-v1`. Custom: any schema name created via `POST /v1/schema/custom`. Unknown / inactive schema names fall back to `native`.
|
|
340
341
|
# @option opts [String] :cursor Opaque cursor returned in the previous response's `pagination.nextCursor`. Omit to fetch the first page.
|
|
341
342
|
# @option opts [Integer] :offset First-class alias for cursor-based pagination. Mutually exclusive with `cursor` — passing both returns 422. Accepts integers in `[0, 10000]`; deeper walks must use `cursor` (constant per-page cost). The response always includes `pagination.nextCursor` so consumers can switch from offset → cursor mid-walk for deep pagination without re-keying. (default to 0)
|
|
@@ -351,6 +352,7 @@ module Repull
|
|
|
351
352
|
# List conversations
|
|
352
353
|
# Cursor-paginated list of message threads owned by the workspace. Use `pagination.nextCursor` from one response as the `cursor` query param of the next request. `?offset=` is also accepted as a first-class alias for shallow paging (0..10000) — see the `offset` parameter below. Mutually exclusive with `cursor`. Filters: `platform` (`airbnb`|`booking`|`vrbo`|`website`|`email`), `status` (`open`|`archived` — `archived` is a stable no-op until the bit lands on `message_threads`). **Inactive listings:** conversations that belong to an inactive listing (by the thread's listing or its reservation's listing) are left out of the page and of `pagination.total`. Inactive listings keep syncing; activate the listing to use it here.
|
|
353
354
|
# @param [Hash] opts the optional parameters
|
|
355
|
+
# @option opts [String] :account Only the records of one connected account, as `provider:externalAccountId` — the pair from a webhook `account` block, `connect.session.completed`, or `GET /v1/connect/{provider}` → `accounts`. A record belongs to an account when it is on that account's listings and on its channel (a PMS account: came in through that PMS). An account with no listings returns an empty page.
|
|
354
356
|
# @option opts [String] :x_schema Apply a custom or built-in schema to transform the response. Built-in: `native` (default), `calry`, `calry-v1`. Custom: any schema name created via `POST /v1/schema/custom`. Unknown / inactive schema names fall back to `native`.
|
|
355
357
|
# @option opts [String] :cursor Opaque cursor returned in the previous response's `pagination.nextCursor`. Omit to fetch the first page.
|
|
356
358
|
# @option opts [Integer] :offset First-class alias for cursor-based pagination. Mutually exclusive with `cursor` — passing both returns 422. Accepts integers in `[0, 10000]`; deeper walks must use `cursor` (constant per-page cost). The response always includes `pagination.nextCursor` so consumers can switch from offset → cursor mid-walk for deep pagination without re-keying. (default to 0)
|
|
@@ -391,6 +393,7 @@ module Repull
|
|
|
391
393
|
|
|
392
394
|
# query parameters
|
|
393
395
|
query_params = opts[:query_params] || {}
|
|
396
|
+
query_params[:'account'] = opts[:'account'] if !opts[:'account'].nil?
|
|
394
397
|
query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
|
|
395
398
|
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
|
396
399
|
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
@@ -92,6 +92,7 @@ module Repull
|
|
|
92
92
|
# List properties (older name for /v1/listings)
|
|
93
93
|
# **`/v1/properties` is the older name for `/v1/listings`** — the same listings, the same ids. It stays for existing integrations; new code should use `/v1/listings`, which is where create, content, publishing and markups live. Cursor-paginated list of properties for the authenticated workspace. Walk pages with `?cursor=<pagination.nextCursor>`; stop when `pagination.hasMore` is `false`. Cursor is opaque base64 — do not parse it. `?offset=` is also accepted as a first-class alias for shallow paging (0..10000) — see the `offset` parameter below. Mutually exclusive with `cursor`. Filters: `q` (substring on name/street/city), `status` (active|inactive|all), `lifecycle_status` (exact match on the listing's lifecycle state). Other unknown params (e.g. `?search=` or `?propertyId=`) are rejected with 422 — no silent unfiltered results. **Incremental sync (only changes since last poll):** pass `?updated_since=<ISO8601>` to receive only properties changed at or after that instant. Each property carries `updatedAt` — the last row of the final page is your next watermark. `updated_since` changes the page ordering to `updatedAt ASC, id ASC` (and the cursor with it); see the parameter description. `GET /v1/listings` does NOT yet accept `updated_since` — use this endpoint for property-side incremental sync. **Inactive properties:** an inactive property keeps syncing, but cannot be read or changed through the API until it is activated. They are only listed when `status` asks for them, and then with `id`, `name`, `status`, `lifecycleStatus`, `channels` and `updatedAt` only — enough to choose what to activate with `PATCH /v1/listings/{id}`.
|
|
94
94
|
# @param [Hash] opts the optional parameters
|
|
95
|
+
# @option opts [String] :account Only the records of one connected account, as `provider:externalAccountId` — the pair from a webhook `account` block, `connect.session.completed`, or `GET /v1/connect/{provider}` → `accounts`. A record belongs to an account when it is on that account's listings and on its channel (a PMS account: came in through that PMS). An account with no listings returns an empty page.
|
|
95
96
|
# @option opts [Integer] :limit Page size (max 100). Requests over the cap return 422. (default to 50)
|
|
96
97
|
# @option opts [String] :cursor Opaque cursor returned in the previous response's `pagination.nextCursor`. Omit to fetch the first page.
|
|
97
98
|
# @option opts [Integer] :offset First-class alias for cursor-based pagination. Mutually exclusive with `cursor` — passing both returns 422. Accepts integers in `[0, 10000]`; deeper walks must use `cursor` (constant per-page cost). The response always includes `pagination.nextCursor` so consumers can switch from offset → cursor mid-walk for deep pagination without re-keying. (default to 0)
|
|
@@ -110,6 +111,7 @@ module Repull
|
|
|
110
111
|
# List properties (older name for /v1/listings)
|
|
111
112
|
# **`/v1/properties` is the older name for `/v1/listings`** — the same listings, the same ids. It stays for existing integrations; new code should use `/v1/listings`, which is where create, content, publishing and markups live. Cursor-paginated list of properties for the authenticated workspace. Walk pages with `?cursor=<pagination.nextCursor>`; stop when `pagination.hasMore` is `false`. Cursor is opaque base64 — do not parse it. `?offset=` is also accepted as a first-class alias for shallow paging (0..10000) — see the `offset` parameter below. Mutually exclusive with `cursor`. Filters: `q` (substring on name/street/city), `status` (active|inactive|all), `lifecycle_status` (exact match on the listing's lifecycle state). Other unknown params (e.g. `?search=` or `?propertyId=`) are rejected with 422 — no silent unfiltered results. **Incremental sync (only changes since last poll):** pass `?updated_since=<ISO8601>` to receive only properties changed at or after that instant. Each property carries `updatedAt` — the last row of the final page is your next watermark. `updated_since` changes the page ordering to `updatedAt ASC, id ASC` (and the cursor with it); see the parameter description. `GET /v1/listings` does NOT yet accept `updated_since` — use this endpoint for property-side incremental sync. **Inactive properties:** an inactive property keeps syncing, but cannot be read or changed through the API until it is activated. They are only listed when `status` asks for them, and then with `id`, `name`, `status`, `lifecycleStatus`, `channels` and `updatedAt` only — enough to choose what to activate with `PATCH /v1/listings/{id}`.
|
|
112
113
|
# @param [Hash] opts the optional parameters
|
|
114
|
+
# @option opts [String] :account Only the records of one connected account, as `provider:externalAccountId` — the pair from a webhook `account` block, `connect.session.completed`, or `GET /v1/connect/{provider}` → `accounts`. A record belongs to an account when it is on that account's listings and on its channel (a PMS account: came in through that PMS). An account with no listings returns an empty page.
|
|
113
115
|
# @option opts [Integer] :limit Page size (max 100). Requests over the cap return 422. (default to 50)
|
|
114
116
|
# @option opts [String] :cursor Opaque cursor returned in the previous response's `pagination.nextCursor`. Omit to fetch the first page.
|
|
115
117
|
# @option opts [Integer] :offset First-class alias for cursor-based pagination. Mutually exclusive with `cursor` — passing both returns 422. Accepts integers in `[0, 10000]`; deeper walks must use `cursor` (constant per-page cost). The response always includes `pagination.nextCursor` so consumers can switch from offset → cursor mid-walk for deep pagination without re-keying. (default to 0)
|
|
@@ -153,6 +155,7 @@ module Repull
|
|
|
153
155
|
|
|
154
156
|
# query parameters
|
|
155
157
|
query_params = opts[:query_params] || {}
|
|
158
|
+
query_params[:'account'] = opts[:'account'] if !opts[:'account'].nil?
|
|
156
159
|
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
157
160
|
query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
|
|
158
161
|
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
|
@@ -384,6 +384,7 @@ module Repull
|
|
|
384
384
|
# List reservations
|
|
385
385
|
# Cursor-paginated list of reservations across all connected PMS platforms. Filter by platform, status, listing, or check-in date range. **Pagination:** Walk pages with `?cursor=` — pass `pagination.nextCursor` from one response back as `?cursor=` on the next request. Stop when `pagination.hasMore` is `false`. `limit` defaults to 50, max 100; requesting more returns 422 (no silent truncation). `?offset=` is also accepted as a first-class alias for shallow paging (0..10000) — see the `offset` parameter below. Mutually exclusive with `cursor`. For deep pagination cursor remains O(1) per page; offset > 10000 returns 422 with a docs link. **Incremental sync (only changes since last poll):** pass `?updated_since=<ISO8601>` to receive only reservations amended, cancelled, or created at or after that instant — no full re-walk. Each row carries `updatedAt`; the last row of the final page is your next watermark. Note that `updated_since` changes the page ordering to `updatedAt ASC, id ASC` (and the cursor with it) so mid-walk amendments cannot be skipped — see the parameter description for the full contract. Reservations on inactive listings are left out (counts and cursors included); they keep syncing and reappear once the listing is activated. Filtering by an inactive listing (`listing_id`) returns `403 listing_inactive`.
|
|
386
386
|
# @param [Hash] opts the optional parameters
|
|
387
|
+
# @option opts [String] :account Only the records of one connected account, as `provider:externalAccountId` — the pair from a webhook `account` block, `connect.session.completed`, or `GET /v1/connect/{provider}` → `accounts`. A record belongs to an account when it is on that account's listings and on its channel (a PMS account: came in through that PMS). An account with no listings returns an empty page.
|
|
387
388
|
# @option opts [String] :x_schema Apply a custom or built-in schema to transform the response. Built-in: `native` (default), `calry`, `calry-v1`. Custom: any schema name created via `POST /v1/schema/custom`. Unknown / inactive schema names fall back to `native`.
|
|
388
389
|
# @option opts [Integer] :limit Page size (max 100). Requests over the cap return 422. (default to 50)
|
|
389
390
|
# @option opts [String] :cursor Opaque cursor returned in the previous response's `pagination.nextCursor`. Omit to fetch the first page.
|
|
@@ -412,6 +413,7 @@ module Repull
|
|
|
412
413
|
# List reservations
|
|
413
414
|
# Cursor-paginated list of reservations across all connected PMS platforms. Filter by platform, status, listing, or check-in date range. **Pagination:** Walk pages with `?cursor=` — pass `pagination.nextCursor` from one response back as `?cursor=` on the next request. Stop when `pagination.hasMore` is `false`. `limit` defaults to 50, max 100; requesting more returns 422 (no silent truncation). `?offset=` is also accepted as a first-class alias for shallow paging (0..10000) — see the `offset` parameter below. Mutually exclusive with `cursor`. For deep pagination cursor remains O(1) per page; offset > 10000 returns 422 with a docs link. **Incremental sync (only changes since last poll):** pass `?updated_since=<ISO8601>` to receive only reservations amended, cancelled, or created at or after that instant — no full re-walk. Each row carries `updatedAt`; the last row of the final page is your next watermark. Note that `updated_since` changes the page ordering to `updatedAt ASC, id ASC` (and the cursor with it) so mid-walk amendments cannot be skipped — see the parameter description for the full contract. Reservations on inactive listings are left out (counts and cursors included); they keep syncing and reappear once the listing is activated. Filtering by an inactive listing (`listing_id`) returns `403 listing_inactive`.
|
|
414
415
|
# @param [Hash] opts the optional parameters
|
|
416
|
+
# @option opts [String] :account Only the records of one connected account, as `provider:externalAccountId` — the pair from a webhook `account` block, `connect.session.completed`, or `GET /v1/connect/{provider}` → `accounts`. A record belongs to an account when it is on that account's listings and on its channel (a PMS account: came in through that PMS). An account with no listings returns an empty page.
|
|
415
417
|
# @option opts [String] :x_schema Apply a custom or built-in schema to transform the response. Built-in: `native` (default), `calry`, `calry-v1`. Custom: any schema name created via `POST /v1/schema/custom`. Unknown / inactive schema names fall back to `native`.
|
|
416
418
|
# @option opts [Integer] :limit Page size (max 100). Requests over the cap return 422. (default to 50)
|
|
417
419
|
# @option opts [String] :cursor Opaque cursor returned in the previous response's `pagination.nextCursor`. Omit to fetch the first page.
|
|
@@ -461,6 +463,7 @@ module Repull
|
|
|
461
463
|
|
|
462
464
|
# query parameters
|
|
463
465
|
query_params = opts[:query_params] || {}
|
|
466
|
+
query_params[:'account'] = opts[:'account'] if !opts[:'account'].nil?
|
|
464
467
|
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
465
468
|
query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
|
|
466
469
|
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
|
@@ -88,6 +88,7 @@ module Repull
|
|
|
88
88
|
# List reviews
|
|
89
89
|
# Cursor-paginated guest + host review stream for the workspace. This surface returns the complete cross-channel history — separate from `/v1/channels/airbnb/reviews` which hits Airbnb live. `?offset=` is also accepted as a first-class alias for shallow paging (0..10000) — see the `offset` parameter below. Mutually exclusive with `cursor`. Filters: `platform` (`airbnb`|`booking`|`vrbo`), `listing_id` (internal Repull listing id), `rating_min` / `rating_max` (inclusive bounds, 0..5), `status` (`responded`|`unanswered`|`all`), `reviewer_role` (`guest` (default) | `host` | `all`). **Inactive listings:** reviews of inactive listings are left out of the page and of `pagination.total`. Filtering by an inactive `listing_id` returns `403 listing_inactive`. Inactive listings keep syncing; activate the listing to use it here.
|
|
90
90
|
# @param [Hash] opts the optional parameters
|
|
91
|
+
# @option opts [String] :account Only the records of one connected account, as `provider:externalAccountId` — the pair from a webhook `account` block, `connect.session.completed`, or `GET /v1/connect/{provider}` → `accounts`. A record belongs to an account when it is on that account's listings and on its channel (a PMS account: came in through that PMS). An account with no listings returns an empty page.
|
|
91
92
|
# @option opts [String] :x_schema Apply a custom or built-in schema to transform the response. Built-in: `native` (default), `calry`, `calry-v1`. Custom: any schema name created via `POST /v1/schema/custom`. Unknown / inactive schema names fall back to `native`.
|
|
92
93
|
# @option opts [String] :cursor Opaque cursor returned in the previous response's `pagination.nextCursor`.
|
|
93
94
|
# @option opts [Integer] :offset First-class alias for cursor-based pagination. Mutually exclusive with `cursor` — passing both returns 422. Accepts integers in `[0, 10000]`; deeper walks must use `cursor` (constant per-page cost). The response always includes `pagination.nextCursor` so consumers can switch from offset → cursor mid-walk for deep pagination without re-keying. (default to 0)
|
|
@@ -107,6 +108,7 @@ module Repull
|
|
|
107
108
|
# List reviews
|
|
108
109
|
# Cursor-paginated guest + host review stream for the workspace. This surface returns the complete cross-channel history — separate from `/v1/channels/airbnb/reviews` which hits Airbnb live. `?offset=` is also accepted as a first-class alias for shallow paging (0..10000) — see the `offset` parameter below. Mutually exclusive with `cursor`. Filters: `platform` (`airbnb`|`booking`|`vrbo`), `listing_id` (internal Repull listing id), `rating_min` / `rating_max` (inclusive bounds, 0..5), `status` (`responded`|`unanswered`|`all`), `reviewer_role` (`guest` (default) | `host` | `all`). **Inactive listings:** reviews of inactive listings are left out of the page and of `pagination.total`. Filtering by an inactive `listing_id` returns `403 listing_inactive`. Inactive listings keep syncing; activate the listing to use it here.
|
|
109
110
|
# @param [Hash] opts the optional parameters
|
|
111
|
+
# @option opts [String] :account Only the records of one connected account, as `provider:externalAccountId` — the pair from a webhook `account` block, `connect.session.completed`, or `GET /v1/connect/{provider}` → `accounts`. A record belongs to an account when it is on that account's listings and on its channel (a PMS account: came in through that PMS). An account with no listings returns an empty page.
|
|
110
112
|
# @option opts [String] :x_schema Apply a custom or built-in schema to transform the response. Built-in: `native` (default), `calry`, `calry-v1`. Custom: any schema name created via `POST /v1/schema/custom`. Unknown / inactive schema names fall back to `native`.
|
|
111
113
|
# @option opts [String] :cursor Opaque cursor returned in the previous response's `pagination.nextCursor`.
|
|
112
114
|
# @option opts [Integer] :offset First-class alias for cursor-based pagination. Mutually exclusive with `cursor` — passing both returns 422. Accepts integers in `[0, 10000]`; deeper walks must use `cursor` (constant per-page cost). The response always includes `pagination.nextCursor` so consumers can switch from offset → cursor mid-walk for deep pagination without re-keying. (default to 0)
|
|
@@ -171,6 +173,7 @@ module Repull
|
|
|
171
173
|
|
|
172
174
|
# query parameters
|
|
173
175
|
query_params = opts[:query_params] || {}
|
|
176
|
+
query_params[:'account'] = opts[:'account'] if !opts[:'account'].nil?
|
|
174
177
|
query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
|
|
175
178
|
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
|
176
179
|
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
data/lib/repull/api/vrbo_api.rb
CHANGED
|
@@ -20,7 +20,7 @@ module Repull
|
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
22
|
# List VRBO listings
|
|
23
|
-
# List
|
|
23
|
+
# List the Vrbo units linked to this workspace's listings, from the host's connected Vrbo account (host sign-in, beta). Inactive listings are left out; they keep syncing and reappear once activated. Use `GET /v1/listings?status=inactive` to find them.
|
|
24
24
|
# @param [Hash] opts the optional parameters
|
|
25
25
|
# @return [Array<VrboListing>]
|
|
26
26
|
def list_vrbo_listings(opts = {})
|
|
@@ -29,7 +29,7 @@ module Repull
|
|
|
29
29
|
end
|
|
30
30
|
|
|
31
31
|
# List VRBO listings
|
|
32
|
-
# List
|
|
32
|
+
# List the Vrbo units linked to this workspace's listings, from the host's connected Vrbo account (host sign-in, beta). Inactive listings are left out; they keep syncing and reappear once activated. Use `GET /v1/listings?status=inactive` to find them.
|
|
33
33
|
# @param [Hash] opts the optional parameters
|
|
34
34
|
# @return [Array<(Array<VrboListing>, Integer, Hash)>] Array<VrboListing> data, response status code and response headers
|
|
35
35
|
def list_vrbo_listings_with_http_info(opts = {})
|
|
@@ -77,7 +77,7 @@ module Repull
|
|
|
77
77
|
end
|
|
78
78
|
|
|
79
79
|
# List VRBO reservations
|
|
80
|
-
# Cursor-paginated list of
|
|
80
|
+
# Cursor-paginated list of Vrbo reservations imported from the host's connected Vrbo account (host sign-in, beta). The full normalised record — guest, price breakdown, policy — is on `GET /v1/reservations?platform=vrbo`. `?offset=` is accepted as a first-class alias for `?cursor=` (mutually exclusive; offset capped at 10000). Reservations on inactive listings are left out (counts and cursors included); they keep syncing and reappear once the listing is activated.
|
|
81
81
|
# @param [Hash] opts the optional parameters
|
|
82
82
|
# @option opts [String] :cursor Opaque cursor returned in the previous response's `pagination.nextCursor`.
|
|
83
83
|
# @option opts [Integer] :offset First-class alias for cursor-based pagination. Mutually exclusive with `cursor` — passing both returns 422. Accepts integers in `[0, 10000]`; deeper walks must use `cursor` (constant per-page cost). The response always includes `pagination.nextCursor` so consumers can switch from offset → cursor mid-walk for deep pagination without re-keying. (default to 0)
|
|
@@ -90,7 +90,7 @@ module Repull
|
|
|
90
90
|
end
|
|
91
91
|
|
|
92
92
|
# List VRBO reservations
|
|
93
|
-
# Cursor-paginated list of
|
|
93
|
+
# Cursor-paginated list of Vrbo reservations imported from the host's connected Vrbo account (host sign-in, beta). The full normalised record — guest, price breakdown, policy — is on `GET /v1/reservations?platform=vrbo`. `?offset=` is accepted as a first-class alias for `?cursor=` (mutually exclusive; offset capped at 10000). Reservations on inactive listings are left out (counts and cursors included); they keep syncing and reappear once the listing is activated.
|
|
94
94
|
# @param [Hash] opts the optional parameters
|
|
95
95
|
# @option opts [String] :cursor Opaque cursor returned in the previous response's `pagination.nextCursor`.
|
|
96
96
|
# @option opts [Integer] :offset First-class alias for cursor-based pagination. Mutually exclusive with `cursor` — passing both returns 422. Accepts integers in `[0, 10000]`; deeper walks must use `cursor` (constant per-page cost). The response always includes `pagination.nextCursor` so consumers can switch from offset → cursor mid-walk for deep pagination without re-keying. (default to 0)
|
|
@@ -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
|
+
class ConnectSessionCompletedEvent < ApiModelBase
|
|
18
|
+
# The event name. This field is `event`, not `type`.
|
|
19
|
+
attr_accessor :event
|
|
20
|
+
|
|
21
|
+
# Stable across every delivery and replay of this logical event — dedupe on it.
|
|
22
|
+
attr_accessor :event_id
|
|
23
|
+
|
|
24
|
+
attr_accessor :api_version
|
|
25
|
+
|
|
26
|
+
# When this delivery was built.
|
|
27
|
+
attr_accessor :timestamp
|
|
28
|
+
|
|
29
|
+
attr_accessor :account
|
|
30
|
+
|
|
31
|
+
attr_accessor :data
|
|
32
|
+
|
|
33
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
|
34
|
+
def self.attribute_map
|
|
35
|
+
{
|
|
36
|
+
:'event' => :'event',
|
|
37
|
+
:'event_id' => :'eventId',
|
|
38
|
+
:'api_version' => :'apiVersion',
|
|
39
|
+
:'timestamp' => :'timestamp',
|
|
40
|
+
:'account' => :'account',
|
|
41
|
+
:'data' => :'data'
|
|
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
|
+
:'event' => :'String',
|
|
59
|
+
:'event_id' => :'String',
|
|
60
|
+
:'api_version' => :'String',
|
|
61
|
+
:'timestamp' => :'Time',
|
|
62
|
+
:'account' => :'WebhookEventAccount',
|
|
63
|
+
:'data' => :'ConnectSessionCompletedPayload'
|
|
64
|
+
}
|
|
65
|
+
end
|
|
66
|
+
|
|
67
|
+
# List of attributes with nullable: true
|
|
68
|
+
def self.openapi_nullable
|
|
69
|
+
Set.new([
|
|
70
|
+
:'account',
|
|
71
|
+
])
|
|
72
|
+
end
|
|
73
|
+
|
|
74
|
+
# Initializes the object
|
|
75
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
76
|
+
def initialize(attributes = {})
|
|
77
|
+
if (!attributes.is_a?(Hash))
|
|
78
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `Repull::ConnectSessionCompletedEvent` initialize method"
|
|
79
|
+
end
|
|
80
|
+
|
|
81
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
|
82
|
+
acceptable_attribute_map = self.class.acceptable_attribute_map
|
|
83
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
84
|
+
if (!acceptable_attribute_map.key?(k.to_sym))
|
|
85
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `Repull::ConnectSessionCompletedEvent`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
|
|
86
|
+
end
|
|
87
|
+
h[k.to_sym] = v
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
if attributes.key?(:'event')
|
|
91
|
+
self.event = attributes[:'event']
|
|
92
|
+
else
|
|
93
|
+
self.event = nil
|
|
94
|
+
end
|
|
95
|
+
|
|
96
|
+
if attributes.key?(:'event_id')
|
|
97
|
+
self.event_id = attributes[:'event_id']
|
|
98
|
+
else
|
|
99
|
+
self.event_id = nil
|
|
100
|
+
end
|
|
101
|
+
|
|
102
|
+
if attributes.key?(:'api_version')
|
|
103
|
+
self.api_version = attributes[:'api_version']
|
|
104
|
+
else
|
|
105
|
+
self.api_version = nil
|
|
106
|
+
end
|
|
107
|
+
|
|
108
|
+
if attributes.key?(:'timestamp')
|
|
109
|
+
self.timestamp = attributes[:'timestamp']
|
|
110
|
+
else
|
|
111
|
+
self.timestamp = nil
|
|
112
|
+
end
|
|
113
|
+
|
|
114
|
+
if attributes.key?(:'account')
|
|
115
|
+
self.account = attributes[:'account']
|
|
116
|
+
end
|
|
117
|
+
|
|
118
|
+
if attributes.key?(:'data')
|
|
119
|
+
self.data = attributes[:'data']
|
|
120
|
+
else
|
|
121
|
+
self.data = nil
|
|
122
|
+
end
|
|
123
|
+
end
|
|
124
|
+
|
|
125
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
|
126
|
+
# @return Array for valid properties with the reasons
|
|
127
|
+
def list_invalid_properties
|
|
128
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
|
129
|
+
invalid_properties = Array.new
|
|
130
|
+
if @event.nil?
|
|
131
|
+
invalid_properties.push('invalid value for "event", event cannot be nil.')
|
|
132
|
+
end
|
|
133
|
+
|
|
134
|
+
if @event_id.nil?
|
|
135
|
+
invalid_properties.push('invalid value for "event_id", event_id cannot be nil.')
|
|
136
|
+
end
|
|
137
|
+
|
|
138
|
+
if @api_version.nil?
|
|
139
|
+
invalid_properties.push('invalid value for "api_version", api_version cannot be nil.')
|
|
140
|
+
end
|
|
141
|
+
|
|
142
|
+
if @timestamp.nil?
|
|
143
|
+
invalid_properties.push('invalid value for "timestamp", timestamp cannot be nil.')
|
|
144
|
+
end
|
|
145
|
+
|
|
146
|
+
if @data.nil?
|
|
147
|
+
invalid_properties.push('invalid value for "data", data cannot be nil.')
|
|
148
|
+
end
|
|
149
|
+
|
|
150
|
+
invalid_properties
|
|
151
|
+
end
|
|
152
|
+
|
|
153
|
+
# Check to see if the all the properties in the model are valid
|
|
154
|
+
# @return true if the model is valid
|
|
155
|
+
def valid?
|
|
156
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
|
157
|
+
return false if @event.nil?
|
|
158
|
+
return false if @event_id.nil?
|
|
159
|
+
return false if @api_version.nil?
|
|
160
|
+
return false if @timestamp.nil?
|
|
161
|
+
return false if @data.nil?
|
|
162
|
+
true
|
|
163
|
+
end
|
|
164
|
+
|
|
165
|
+
# Custom attribute writer method with validation
|
|
166
|
+
# @param [Object] event Value to be assigned
|
|
167
|
+
def event=(event)
|
|
168
|
+
if event.nil?
|
|
169
|
+
fail ArgumentError, 'event cannot be nil'
|
|
170
|
+
end
|
|
171
|
+
|
|
172
|
+
@event = event
|
|
173
|
+
end
|
|
174
|
+
|
|
175
|
+
# Custom attribute writer method with validation
|
|
176
|
+
# @param [Object] event_id Value to be assigned
|
|
177
|
+
def event_id=(event_id)
|
|
178
|
+
if event_id.nil?
|
|
179
|
+
fail ArgumentError, 'event_id cannot be nil'
|
|
180
|
+
end
|
|
181
|
+
|
|
182
|
+
@event_id = event_id
|
|
183
|
+
end
|
|
184
|
+
|
|
185
|
+
# Custom attribute writer method with validation
|
|
186
|
+
# @param [Object] api_version Value to be assigned
|
|
187
|
+
def api_version=(api_version)
|
|
188
|
+
if api_version.nil?
|
|
189
|
+
fail ArgumentError, 'api_version cannot be nil'
|
|
190
|
+
end
|
|
191
|
+
|
|
192
|
+
@api_version = api_version
|
|
193
|
+
end
|
|
194
|
+
|
|
195
|
+
# Custom attribute writer method with validation
|
|
196
|
+
# @param [Object] timestamp Value to be assigned
|
|
197
|
+
def timestamp=(timestamp)
|
|
198
|
+
if timestamp.nil?
|
|
199
|
+
fail ArgumentError, 'timestamp cannot be nil'
|
|
200
|
+
end
|
|
201
|
+
|
|
202
|
+
@timestamp = timestamp
|
|
203
|
+
end
|
|
204
|
+
|
|
205
|
+
# Custom attribute writer method with validation
|
|
206
|
+
# @param [Object] data Value to be assigned
|
|
207
|
+
def data=(data)
|
|
208
|
+
if data.nil?
|
|
209
|
+
fail ArgumentError, 'data cannot be nil'
|
|
210
|
+
end
|
|
211
|
+
|
|
212
|
+
@data = data
|
|
213
|
+
end
|
|
214
|
+
|
|
215
|
+
# Checks equality by comparing each attribute.
|
|
216
|
+
# @param [Object] Object to be compared
|
|
217
|
+
def ==(o)
|
|
218
|
+
return true if self.equal?(o)
|
|
219
|
+
self.class == o.class &&
|
|
220
|
+
event == o.event &&
|
|
221
|
+
event_id == o.event_id &&
|
|
222
|
+
api_version == o.api_version &&
|
|
223
|
+
timestamp == o.timestamp &&
|
|
224
|
+
account == o.account &&
|
|
225
|
+
data == o.data
|
|
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
|
+
[event, event_id, api_version, timestamp, account, data].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
|