From 348135cc3d927b36d67959ccecd27980d67c66b6 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Wed, 8 Oct 2025 20:14:18 +0000 Subject: [PATCH 1/2] feat: Update to @seamapi/types@1.606.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 3292bfac9..b789d4be4 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.605.0", + "@seamapi/types": "1.606.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.605.0", - "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.605.0.tgz", - "integrity": "sha512-zHYVoSa51EbGYsZ1TJbMjqX2yOn/xAkOzkbIhosy+bvblg9Qx5QZvmFI9ohhGSlR3y7q/3kwLxcg0lXl32nhdw==", + "version": "1.606.0", + "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.606.0.tgz", + "integrity": "sha512-7u/N9aoEMGBfEssuDgalzLuj7dlDji19nWDwjKohtJnJ94waRNxede3AjH1Zhfc524pJoB+blwsFQg5UOEDSRA==", "dev": true, "license": "MIT", "engines": { diff --git a/package.json b/package.json index 7e71cdd75..deab366e4 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.605.0", + "@seamapi/types": "1.606.0", "@types/command-exists": "^1.2.3", "change-case": "^5.4.4", "command-exists": "^1.2.9", From 75fcb8b03f476d6929b42378216957a593a5dbe4 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Wed, 8 Oct 2025 20:16:00 +0000 Subject: [PATCH 2/2] ci: Generate docs --- docs/api/_blueprint.json | 375 ++++++++++++++++++++++++++++ docs/api/_report.md | 3 + docs/api/customers/create_portal.md | 12 + docs/api/customers/push_data.md | 63 +++++ docs/api/seam/customer/v1/README.md | 4 + 5 files changed, 457 insertions(+) diff --git a/docs/api/_blueprint.json b/docs/api/_blueprint.json index 8271e3233..15297873a 100644 --- a/docs/api/_blueprint.json +++ b/docs/api/_blueprint.json @@ -28638,6 +28638,94 @@ } ] }, + { + "name": "staff_members", + "description": "List of staff members.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "object", + "itemParameters": [ + { + "name": "email_address", + "description": "Email address associated with the user identity.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "name", + "description": "Your display name for this user identity resource.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "phone_number", + "description": "Phone number associated with the user identity.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "site_keys", + "description": "List of unique identifiers for the sites the staff member is associated with.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "string" + }, + { + "name": "staff_member_key", + "description": "Your unique identifier for the staff.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + }, { "name": "tenants", "description": "List of tenants.", @@ -30679,6 +30767,94 @@ } ] }, + { + "name": "staff_members", + "description": "List of staff members.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "object", + "itemParameters": [ + { + "name": "email_address", + "description": "Email address associated with the user identity.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "name", + "description": "Your display name for this user identity resource.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "phone_number", + "description": "Phone number associated with the user identity.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "site_keys", + "description": "List of unique identifiers for the sites the staff member is associated with.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "string" + }, + { + "name": "staff_member_key", + "description": "Your unique identifier for the staff.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + }, { "name": "tenants", "description": "List of tenants.", @@ -53341,6 +53517,124 @@ "isDeprecated": false, "isDraft": true }, + { + "path": "/seam/customer/v1/staff_members", + "name": "staff_members", + "namespacePath": "/seam/customer/v1", + "endpoints": [ + { + "title": "List Staff Members for Customer Space", + "name": "list", + "path": "/seam/customer/v1/staff_members/list", + "parentPath": "/seam/customer/v1/staff_members", + "description": "Returns a list of staff members for a specific customer. This endpoint is designed for customer portals and supports filtering by space_key.\nProvided space_key or space_id can be a child space, in which case the staff members for the parent space will be returned.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Internal endpoint for customer portals.", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource_list", + "responseKey": "staff_members", + "resourceType": "staff_member", + "description": "OK", + "actionAttemptType": null + }, + "request": { + "methods": [ + "GET", + "POST" + ], + "semanticMethod": "GET", + "preferredMethod": "POST", + "parameters": [ + { + "name": "created_before", + "description": "Timestamp by which to limit returned staff members. Returns staff members created before this timestamp.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "limit", + "description": "Maximum number of records to return per page.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": 500, + "format": "number", + "jsonType": "number" + }, + { + "name": "page_cursor", + "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "space_id", + "description": "Filter staff members by space ID (UUID).", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "space_key", + "description": "Filter staff members by space key.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + }, + "hasPagination": true, + "authMethods": [ + "client_session_token" + ], + "workspaceScope": "required", + "codeSamples": [] + } + ], + "parentPath": "/seam/customer/v1", + "isUndocumented": true, + "isDeprecated": false, + "isDraft": false + }, { "path": "/seam/customer/v1/webhooks/connectors/[workspace_id]", "name": "[workspace_id]", @@ -96722,6 +97016,87 @@ } ] }, + { + "resourceType": "staff_member", + "properties": [ + { + "name": "email_address", + "description": "Email address associated with the user identity.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "name", + "description": "Your display name for this user identity resource.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "phone_number", + "description": "Phone number associated with the user identity.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "site_keys", + "description": "List of unique identifiers for the sites the staff member is associated with.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "string" + }, + { + "name": "staff_member_key", + "description": "Your unique identifier for the staff.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Represents a staff member for a specific customer.", + "isDeprecated": false, + "routePath": "/seam/customer/v1/staff_members", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": [], + "resourceSamples": [] + }, { "resourceType": "thermostat_daily_program", "properties": [ diff --git a/docs/api/_report.md b/docs/api/_report.md index fd51020af..345893fe1 100644 --- a/docs/api/_report.md +++ b/docs/api/_report.md @@ -22,6 +22,7 @@ These items are intentionally undocumented. - `/seam/customer/v1/portals`: No undocumented message provided - `/seam/customer/v1/reservations`: No undocumented message provided - `/seam/customer/v1/settings`: No undocumented message provided +- `/seam/customer/v1/staff_members`: No undocumented message provided - `/seam/instant_key/v1/client_sessions`: No undocumented message provided - `/seam/instant_key/v1/preview`: No undocumented message provided - `/seam/mobile_sdk/v1/acs/credentials`: No undocumented message provided @@ -96,6 +97,7 @@ These items are intentionally undocumented. - `/seam/customer/v1/reservations/list`: Internal endpoint for customer portals. - `/seam/customer/v1/settings/get`: Internal endpoint for customer portals. - `/seam/customer/v1/settings/update`: Internal endpoint for customer portals. +- `/seam/customer/v1/staff_members/list`: Internal endpoint for customer portals. - `/seam/instant_key/v1/client_sessions/exchange_short_code`: Seam Instant Key only. - `/seam/instant_key/v1/preview/get`: Seam Instant Key only. - `/seam/mobile_sdk/v1/acs/credentials/list`: Mobile SDK only. @@ -639,6 +641,7 @@ These items are deprecated. ### Resources without resource samples +- `staff_member` - `event: access_code.created` - `event: access_code.changed` - `event: access_code.scheduled_on_device` diff --git a/docs/api/customers/create_portal.md b/docs/api/customers/create_portal.md index a60b399db..b48f9f10b 100644 --- a/docs/api/customers/create_portal.md +++ b/docs/api/customers/create_portal.md @@ -204,6 +204,18 @@ List of general spaces or areas. +
+ +staff_members List + +List of staff members. + +
+ +--- + + +
tenants List diff --git a/docs/api/customers/push_data.md b/docs/api/customers/push_data.md index 483e9c349..eb553d405 100644 --- a/docs/api/customers/push_data.md +++ b/docs/api/customers/push_data.md @@ -1054,6 +1054,69 @@ Your unique identifier for the space. --- +**`staff_members`** *Array* *of Objects* + +List of staff members. + +
+ +email_address String + +Email address associated with the user identity. + +
+ +--- + + + +
+ +name String + +Your display name for this user identity resource. + +
+ +--- + + + +
+ +phone_number String + +Phone number associated with the user identity. + +
+ +--- + + + +
+ +site_keys List + +List of unique identifiers for the sites the staff member is associated with. + +
+ +--- + + + +
+ +staff_member_key String + +Your unique identifier for the staff. + +
+ +--- + + **`tenants`** *Array* *of Objects* List of tenants. diff --git a/docs/api/seam/customer/v1/README.md b/docs/api/seam/customer/v1/README.md index b087b951c..f44c24a36 100644 --- a/docs/api/seam/customer/v1/README.md +++ b/docs/api/seam/customer/v1/README.md @@ -10,3 +10,7 @@ description: The V1 namespace contains the following resources: +### [`staff_member`](./staff_members/README.md#staff_member) +Represents a staff member for a specific customer. + +---