From dffd780e72b519ce5475924f9771fefe1bfcecd1 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Mon, 29 Sep 2025 19:09:07 +0000 Subject: [PATCH 1/2] feat: Update to @seamapi/types@1.593.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 a51791112..2441a4eaf 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.592.0", + "@seamapi/types": "1.593.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.592.0", - "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.592.0.tgz", - "integrity": "sha512-TV6UN6oBQ8bX5BKkZT4bs9yCC/M291ZELJFFM41RwQYlmqH9vJ586MJ8nCNBHXRTyxw9pndv+rq4x4t84kQhBg==", + "version": "1.593.0", + "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.593.0.tgz", + "integrity": "sha512-vQE+dNC6sly/QWQQgI3A/hIaasrakKcYBBthOGXHTJFY9J+3a74FMaJp07JCm/1hSPUuhbFscqdPSb0VX4Onxw==", "dev": true, "license": "MIT", "engines": { diff --git a/package.json b/package.json index 4ef984b9f..6e20fd22b 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.592.0", + "@seamapi/types": "1.593.0", "@types/command-exists": "^1.2.3", "change-case": "^5.4.4", "command-exists": "^1.2.9", From 230bfd734ca23caf94394ee6393ec040e1b895ce Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Mon, 29 Sep 2025 19:11:04 +0000 Subject: [PATCH 2/2] ci: Generate docs --- docs/api/_blueprint.json | 78 ++++++++++++++++++++++ docs/api/_report.md | 6 ++ docs/api/seam/customer/v1/spaces/README.md | 5 ++ docs/api/seam/customer/v1/spaces/list.md | 53 +++++++++++++++ 4 files changed, 142 insertions(+) create mode 100644 docs/api/seam/customer/v1/spaces/list.md diff --git a/docs/api/_blueprint.json b/docs/api/_blueprint.json index 2a9891663..c5f6ee7dd 100644 --- a/docs/api/_blueprint.json +++ b/docs/api/_blueprint.json @@ -52471,6 +52471,84 @@ ], "workspaceScope": "required", "codeSamples": [] + }, + { + "title": "List Spaces", + "name": "list", + "path": "/seam/customer/v1/spaces/list", + "parentPath": "/seam/customer/v1/spaces", + "description": "Returns a list of all spaces.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": true, + "draftMessage": "Early access.", + "response": { + "responseType": "resource_list", + "responseKey": "spaces", + "resourceType": "space", + "description": "OK", + "actionAttemptType": null + }, + "request": { + "methods": [ + "GET", + "POST" + ], + "semanticMethod": "GET", + "preferredMethod": "POST", + "parameters": [ + { + "name": "connected_account_id", + "description": "Filter spaces to only include those that contain devices or access control systems belonging to the specified connected account.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Only used internally.", + "isDraft": true, + "draftMessage": "Needs review.", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "search", + "description": "String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "space_key", + "description": "Filter spaces by space_key.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token" + ], + "workspaceScope": "required", + "codeSamples": [] } ], "parentPath": "/seam/customer/v1", diff --git a/docs/api/_report.md b/docs/api/_report.md index e431c450c..6385fa0da 100644 --- a/docs/api/_report.md +++ b/docs/api/_report.md @@ -159,6 +159,8 @@ These items are intentionally undocumented. - `is_programmed`: Not sure if this parameter is supported or what it does. - `/noise_sensors/noise_thresholds/update` - `sync`: Only used internally. +- `/seam/customer/v1/spaces/list` + - `connected_account_id`: Only used internally. - `/spaces/list` - `connected_account_id`: Only used internally. - `/thermostats/cool` @@ -465,6 +467,7 @@ These items have been marked as draft. - `/access_methods/unmanaged/get`: Early access. - `/access_methods/unmanaged/list`: Early access. - `/seam/customer/v1/spaces/create`: Early access. +- `/seam/customer/v1/spaces/list`: Early access. - `/spaces/add_acs_entrances`: Early access. - `/spaces/add_devices`: Early access. - `/spaces/create`: Early access. @@ -478,6 +481,8 @@ These items have been marked as draft. ### Endpoint parameters +- `/seam/customer/v1/spaces/list` + - `connected_account_id`: Needs review. - `/spaces/list` - `connected_account_id`: Needs review. @@ -616,6 +621,7 @@ These items are deprecated. - `/instant_keys/list` - `/locks/get` - `/seam/customer/v1/spaces/create` +- `/seam/customer/v1/spaces/list` - `/spaces/get_related` - `/user_identities/unmanaged/get` - `/user_identities/unmanaged/list` diff --git a/docs/api/seam/customer/v1/spaces/README.md b/docs/api/seam/customer/v1/spaces/README.md index f34e15dd8..dcb96d608 100644 --- a/docs/api/seam/customer/v1/spaces/README.md +++ b/docs/api/seam/customer/v1/spaces/README.md @@ -8,3 +8,8 @@ Creates a new space with optional parent space support. +[**`/seam/customer/v1/spaces/list`**](./list.md) + +Returns a list of all spaces. + + diff --git a/docs/api/seam/customer/v1/spaces/list.md b/docs/api/seam/customer/v1/spaces/list.md new file mode 100644 index 000000000..26fbe90b8 --- /dev/null +++ b/docs/api/seam/customer/v1/spaces/list.md @@ -0,0 +1,53 @@ +# List Spaces + +- [Request Parameters](#request-parameters) +- [Response](#response) + +Returns a list of all spaces. + + +
+ +Authentication Methods + +- Client session token + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication). +
+ +## Request Parameters + +**`search`** *String* + +String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`. + +--- + +**`space_key`** *String* + +Filter spaces by space_key. + +--- + + +## Response + +Array of [spaces](./../../../../spaces) + + +{% tabs %} +{% tab title="JSON" %} + + + +```json +{ + "created_at": "2025-06-16T16:54:17.946600Z", + "display_name": "My Space", + "name": "My Space", + "space_id": "5afeb047-3277-4102-b8c4-99edf05b91d2", + "workspace_id": "96bd12f9-6def-4bf4-b517-760417451ae9" +} +``` +{% endtab %} +{% endtabs %}