From 13b3214586e4805b682cc0ab664265c6dfaa6091 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Thu, 23 Oct 2025 12:42:33 +0000 Subject: [PATCH 1/2] feat: Update to @seamapi/types@1.630.0 --- package-lock.json | 8 ++++---- package.json | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/package-lock.json b/package-lock.json index 42c66f632..a2a6f0449 100644 --- a/package-lock.json +++ b/package-lock.json @@ -14,7 +14,7 @@ "@prettier/plugin-ruby": "^4.0.4", "@seamapi/blueprint": "^0.51.3", "@seamapi/smith": "^0.5.2", - "@seamapi/types": "1.629.0", + "@seamapi/types": "1.630.0", "@types/command-exists": "^1.2.3", "change-case": "^5.4.4", "command-exists": "^1.2.9", @@ -983,9 +983,9 @@ } }, "node_modules/@seamapi/types": { - "version": "1.629.0", - "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.629.0.tgz", - "integrity": "sha512-MPSWob7lnSsqqU/JIy71XwGNqumuu8OlAWKsXcDbnteE1ED17aBcmjeofXIcNgGF2ua6j8EFwWaY5yDiqol9Qg==", + "version": "1.630.0", + "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.630.0.tgz", + "integrity": "sha512-xIHGo9G/fiZabXvFBNihGsHOyfAoHf7XpWvH9YpGCe5EMyRqrjYmuSIziCC+mq7wziypWx4UzaAwcZQrBwc9Pg==", "dev": true, "license": "MIT", "engines": { diff --git a/package.json b/package.json index 2dad30b6f..2f4045422 100644 --- a/package.json +++ b/package.json @@ -32,7 +32,7 @@ "@prettier/plugin-ruby": "^4.0.4", "@seamapi/blueprint": "^0.51.3", "@seamapi/smith": "^0.5.2", - "@seamapi/types": "1.629.0", + "@seamapi/types": "1.630.0", "@types/command-exists": "^1.2.3", "change-case": "^5.4.4", "command-exists": "^1.2.9", From 5fb3396178755d3a671af7ceb33863ea2d8b5bcb Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Thu, 23 Oct 2025 12:44:33 +0000 Subject: [PATCH 2/2] ci: Generate docs --- docs/api/customers/create_portal.md | 190 ++++++++++++++++++---------- 1 file changed, 121 insertions(+), 69 deletions(-) diff --git a/docs/api/customers/create_portal.md b/docs/api/customers/create_portal.md index 8bfc79a65..b48f9f10b 100644 --- a/docs/api/customers/create_portal.md +++ b/docs/api/customers/create_portal.md @@ -1,310 +1,362 @@ # Create Customer Portal - {% hint style="info" %} **Early Access Preview.** The customers API is currently in Alpha. We're actively developing it and seeking early feedback at [support@seam.co](mailto:support@seam.co). Expect breaking changes as we refine the design. {% endhint %} -* [Request Parameters](create_portal.md#request-parameters) -* [Response](create_portal.md#response) +- [Request Parameters](#request-parameters) +- [Response](#response) Creates a new customer portal magic link with configurable features. +
Authentication Methods -* API key -* Personal access token\ - Must also include the `seam-workspace` header in the request. +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication). -
## Request Parameters -**`customer_data`** _Object_ +**`customer_data`** *Object*
-access_grants List +access_grants List List of access grants.
-*** +--- + +
-bookings List +bookings List List of bookings.
-*** +--- + +
-buildings List +buildings List List of buildings.
-*** +--- + +
-common_areas List +common_areas List List of shared common areas.
-*** +--- + +
-customer_key String +customer_key String Your unique identifier for the customer.
-*** +--- + +
-facilities List +facilities List List of gym or fitness facilities.
-*** +--- + +
-guests List +guests List List of guests.
-*** +--- + +
-listings List +listings List List of property listings.
-*** +--- + +
-properties List +properties List List of short-term rental properties.
-*** +--- + +
-property_listings List +property_listings List List of property listings.
-*** +--- + +
-reservations List +reservations List List of reservations.
-*** +--- + +
-residents List +residents List List of residents.
-*** +--- + +
-rooms List +rooms List List of hotel or hospitality rooms.
-*** +--- + +
-sites List +sites List List of general sites or areas.
-*** +--- + +
-spaces List +spaces List List of general spaces or areas.
-*** +--- + +
-staff_members List +staff_members List List of staff members.
-*** +--- + +
-tenants List +tenants List List of tenants.
-*** +--- + +
-units List +units List List of multi-family residential units.
-*** +--- + +
-user_identities List +user_identities List List of user identities.
-*** +--- + +
-users List +users List List of users.
-*** +--- -**`features`** _Object_ + +**`features`** *Object*
-configure Object +configure Object Configuration for the configure feature.
-*** +--- + +
-connect Object +connect Object Configuration for the connect accounts feature.
-*** +--- + +
-manage Object +manage Object Configuration for the manage feature.
-*** +--- -
-manage_devices Object -### Configuration for the manage devices feature. +
-### deprecated: Use `manage` instead. +manage_devices Object + +Configuration for the manage devices feature. +--- +deprecated: Use `manage` instead. +---
-*** +--- + +
-organize Object +organize Object Configuration for the organize feature.
-*** +--- -**`is_embedded`** _Boolean_ + +**`is_embedded`** *Boolean* Whether the portal is embedded in another application. -*** +--- -**`landing_page`** _Object_ +**`landing_page`** *Object* Configuration for the landing page when the portal loads.
-manage Object +manage Object +
+--- -
-*** ## Response -[magic\_link](../unstable_partner/building_blocks/) +[magic\_link](./../unstable_partner/building_blocks) + {% tabs %} {% tab title="JSON" %} + + + ```json { "building_block_type": "connect_accounts",