From 1a036f56ef9993c1ae99e1a67a8aaf11df60f7db Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Fri, 14 Nov 2025 13:12:20 +0000 Subject: [PATCH 1/2] feat: Update to @seamapi/types@1.661.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 68ddcd72c..4e8fbde51 100644 --- a/package-lock.json +++ b/package-lock.json @@ -14,7 +14,7 @@ "@prettier/plugin-ruby": "^4.0.4", "@seamapi/blueprint": "^0.52.2", "@seamapi/smith": "^0.5.2", - "@seamapi/types": "1.660.0", + "@seamapi/types": "1.661.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.660.0", - "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.660.0.tgz", - "integrity": "sha512-6EwsXXI9gK5Nh5v9KAUTlZivMJd6/VwTjFf/MPjMAlbVlE8BEYakjuPpb1Q63IYKKxqwdlbYkYwEDZ+LRPUlrQ==", + "version": "1.661.0", + "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.661.0.tgz", + "integrity": "sha512-R8P0VYqM5KnboNXR3BQjlICDfrkEfwUhsWcSDuJO0WIpEI4e007xdhR5hynA+Xqo8Icx/ZSjo9HSVtWqtdSB7A==", "dev": true, "license": "MIT", "engines": { diff --git a/package.json b/package.json index 03754c64f..289880e9f 100644 --- a/package.json +++ b/package.json @@ -32,7 +32,7 @@ "@prettier/plugin-ruby": "^4.0.4", "@seamapi/blueprint": "^0.52.2", "@seamapi/smith": "^0.5.2", - "@seamapi/types": "1.660.0", + "@seamapi/types": "1.661.0", "@types/command-exists": "^1.2.3", "change-case": "^5.4.4", "command-exists": "^1.2.9", From 32fa3c1f012f785be6b623d1354bc5b481c89fdd Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Fri, 14 Nov 2025 13:14:10 +0000 Subject: [PATCH 2/2] ci: Generate docs --- docs/api/_blueprint.json | 5 +- docs/api/_report.md | 2 - .../connected_accounts/simulate/disconnect.md | 3 + docs/api/customers/create_portal.md | 202 +++++++++++------- 4 files changed, 134 insertions(+), 78 deletions(-) diff --git a/docs/api/_blueprint.json b/docs/api/_blueprint.json index fc2a9a066..00512428e 100644 --- a/docs/api/_blueprint.json +++ b/docs/api/_blueprint.json @@ -27018,7 +27018,7 @@ "parameters": [ { "name": "connected_account_id", - "description": "", + "description": "ID of the connected account you want to simulate as disconnected.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -27035,7 +27035,8 @@ "hasPagination": false, "authMethods": [ "api_key", - "personal_access_token" + "personal_access_token", + "client_session_token" ], "workspaceScope": "required", "codeSamples": [] diff --git a/docs/api/_report.md b/docs/api/_report.md index 1537b3d3c..594e5c0f4 100644 --- a/docs/api/_report.md +++ b/docs/api/_report.md @@ -379,8 +379,6 @@ Items that are intentionally undocumented are not included in this section. - `device_selection_mode` - `/connected_accounts/delete` - `sync` -- `/connected_accounts/simulate/disconnect` - - `connected_account_id` - `/customers/create_portal` - `features` - `customer_data` diff --git a/docs/api/connected_accounts/simulate/disconnect.md b/docs/api/connected_accounts/simulate/disconnect.md index 259a8c2fa..6c85a90f6 100644 --- a/docs/api/connected_accounts/simulate/disconnect.md +++ b/docs/api/connected_accounts/simulate/disconnect.md @@ -11,6 +11,7 @@ Simulates a connected account becoming disconnected from Seam. Only applicable f Authentication Methods - API key +- Client session token - Personal access token
Must also include the `seam-workspace` header in the request. @@ -21,6 +22,8 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`connected_account_id`** *String* (Required) +ID of the connected account you want to simulate as disconnected. + --- diff --git a/docs/api/customers/create_portal.md b/docs/api/customers/create_portal.md index 57b094758..370f0218e 100644 --- a/docs/api/customers/create_portal.md +++ b/docs/api/customers/create_portal.md @@ -1,324 +1,378 @@ # 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.
-*** +--- -**`customization_profile_id`** _String_ + +**`customization_profile_id`** *String* The ID of the customization profile to use for the portal. -*** +--- -**`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. +manage_devices Object -### deprecated: Use `manage` instead. +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
-*** +--- -**`locale`** _String_ + +**`locale`** *String* The locale to use for the portal. -*** +--- + ## Response {% hint style="success" %} -Returns: [**magic\_link**](../unstable_partner/building_blocks/) +Returns: +**[magic\_link](./../unstable_partner/building_blocks)** + {% endhint %} + {% tabs %} {% tab title="JSON" %} + + + ```json { "building_block_type": "connect_accounts",