diff --git a/docs/api/_blueprint.json b/docs/api/_blueprint.json index 0392469d9..0384e019e 100644 --- a/docs/api/_blueprint.json +++ b/docs/api/_blueprint.json @@ -51386,6 +51386,63 @@ } ] }, + { + "name": "reservation_spaces_updated", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "object", + "jsonType": "object", + "parameters": [ + { + "name": "config", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "object", + "jsonType": "object", + "parameters": [] + }, + { + "name": "rule", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "reservation_spaces_updated", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ] + }, { "name": "reservation_time_updated", "description": "", 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", diff --git a/package-lock.json b/package-lock.json index 1dc61cbe6..a5ab19492 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.670.0", + "@seamapi/types": "1.671.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.670.0", - "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.670.0.tgz", - "integrity": "sha512-Nm7FsubpITwFg/QqlLBZoXMmNE2EvWDvbK+wW0pQ++7JrGJCaypopkpF2ASJHEwI7IcRlAsG5MZWmz+O3oeCqQ==", + "version": "1.671.0", + "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.671.0.tgz", + "integrity": "sha512-Yunwc6zEq14eBMvSjPIkh16y+FEXVYui0d39jHEy+WG8/a9Nj2+9Nvk03UQ8JPrUjYuGGdcmkDXG/oPJhnYPMg==", "dev": true, "license": "MIT", "engines": { diff --git a/package.json b/package.json index f722922d5..c4c73eb6f 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.670.0", + "@seamapi/types": "1.671.0", "@types/command-exists": "^1.2.3", "change-case": "^5.4.4", "command-exists": "^1.2.9",