Skip to content

Commit 69e1f44

Browse files
Paweł Stępniakgitbook-bot
authored andcommitted
GITBOOK-730: feat: filtering customer resources
1 parent 3f8de7f commit 69e1f44

4 files changed

Lines changed: 375 additions & 8 deletions

File tree

docs/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,7 @@
129129
* [Customers](capability-guides/customer-portals/customers.md)
130130
* [Preview the customer portal in Console](capability-guides/customer-portals/preview-the-customer-portal-in-console.md)
131131
* [Integrate customer portal into your application](capability-guides/customer-portals/integrate-customer-portal-into-your-application.md)
132+
* [Filtering Portal Resources by Custom Metadata](capability-guides/customer-portals/filtering-portal-resources-by-custom-metadata.md)
132133
* [Reservation Automations](capability-guides/reservation-automations.md)
133134

134135
## UI Components

docs/api/customers/create_portal.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -311,9 +311,19 @@ The locale to use for the portal.
311311

312312
***
313313

314-
**`property_listing_filter`** _Object_
314+
**`customer_resources_filters`** _List_
315315

316-
Filter configuration for property listings based on their custom\_metadata. Keys and values must match the custom\_metadata stored on property listings.
316+
Filter configuration for resources based on their `custom_metadata`. Each filter specifies a field, operation, and value to match against resource `custom_metadata`. When multiple filters are provided, a resource must match all of them (AND logic). Applies to both property listings and reservations.
317+
318+
<details>
319+
320+
<summary>Filter object structure</summary>
321+
322+
* **`field`** _String_ — The `custom_metadata` field name to filter on. Must start with a letter or underscore and contain only alphanumeric characters and underscores.
323+
* **`operation`** _String_ — The comparison operation. Currently only `"="` is supported.
324+
* **`value`** _String or Boolean_ — The value to compare against.
325+
326+
</details>
317327

318328
***
319329

docs/capability-guides/customer-portals/customers.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,6 @@ Seam gives you a way to tag each customer with your own identifier through the `
1414

1515
`customer_key` is your unique identifier for a customer. You assign it when creating resources that belong to that customer. Seam then copies the same key to related resources, so you always have a reliable way to look them up.
1616

17-
Key uses:
18-
19-
* Connect Webviews: Tag a Webview with `customer_key`. When the customer connects their account, the resulting Connected Account inherits that key.
20-
* Customer Portals: Initialize a portal with `customer_key` so the portal shows only the devices, spaces, and accounts for that customer.
21-
* Lookups: Use `customer_key` to fetch all Connected Accounts, devices, or systems associated with a specific customer.
22-
2317
***
2418

2519
#### Key uses:

0 commit comments

Comments
 (0)