From ac2eb8e7ba1a69b0634d233f8e18cb2b677750ef Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Thu, 24 Jul 2025 02:05:14 +0000 Subject: [PATCH 1/2] feat: Update to @seamapi/types@1.466.1 --- 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 a294531ae..465b8f583 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.4.4", - "@seamapi/types": "1.465.0", + "@seamapi/types": "1.466.1", "@types/command-exists": "^1.2.3", "change-case": "^5.4.4", "command-exists": "^1.2.9", @@ -886,9 +886,9 @@ } }, "node_modules/@seamapi/types": { - "version": "1.465.0", - "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.465.0.tgz", - "integrity": "sha512-qJ9Oly5zlxD533cooMgXZd65xM9f7x1vaPCDvVRBmFoiBUAXX9ICwWyH9ll4s8v4fMwAz444/CfDjOjJKGA/3Q==", + "version": "1.466.1", + "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.466.1.tgz", + "integrity": "sha512-sRDleDijArxo3RMWdxyaYZub+bpCs2FlJBcWhcYNMS3hPdyvlRWkqSuB88uu9H0WqK6mnzzPLNv/AO2EV1RVCw==", "dev": true, "license": "MIT", "engines": { diff --git a/package.json b/package.json index 62457a6ba..468d0b821 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.4.4", - "@seamapi/types": "1.465.0", + "@seamapi/types": "1.466.1", "@types/command-exists": "^1.2.3", "change-case": "^5.4.4", "command-exists": "^1.2.9", From 3e85d1e01a5999f599936a64888c5807411f95e0 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Thu, 24 Jul 2025 02:07:03 +0000 Subject: [PATCH 2/2] ci: Generate docs --- docs/SUMMARY.md | 1 - docs/api/_blueprint.json | 64 ++-- docs/api/_report.md | 25 +- docs/api/thermostats/README.md | 5 - docs/api/thermostats/update_weekly_program.md | 286 ------------------ 5 files changed, 44 insertions(+), 337 deletions(-) delete mode 100644 docs/api/thermostats/update_weekly_program.md diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index f43b3fff3..afd57906b 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -325,7 +325,6 @@ * [Set to Heat-Cool (Auto) Mode](api/thermostats/heat_cool.md) * [Set to Off Mode](api/thermostats/off.md) * [Update a Climate Preset](api/thermostats/update_climate_preset.md) - * [Update the Thermostat Weekly Program](api/thermostats/update_weekly_program.md) * [Thermostat Schedules](api/thermostats/schedules/README.md) * [Create a Thermostat Schedule](api/thermostats/schedules/create.md) * [Delete a Thermostat Schedule](api/thermostats/schedules/delete.md) diff --git a/docs/api/_blueprint.json b/docs/api/_blueprint.json index 659300598..fe9602ebf 100644 --- a/docs/api/_blueprint.json +++ b/docs/api/_blueprint.json @@ -54698,8 +54698,8 @@ "description": "Updates the thermostat weekly program for a thermostat device. To configure a weekly program, specify the ID of the daily program that you want to use for each day of the week. When you update a weekly program, the set of programs that you specify overwrites any previous weekly program for the thermostat.", "isDeprecated": false, "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Unreleased.", "isDraft": false, "draftMessage": "", "response": { @@ -54961,8 +54961,8 @@ "description": "Creates a new thermostat daily program. A daily program consists of a set of periods, where each period includes a start time and the key of a configured climate preset. Once you have defined a daily program, you can assign it to one or more days within a weekly program.", "isDeprecated": false, "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Unreleased.", "isDraft": false, "draftMessage": "", "response": { @@ -55204,8 +55204,8 @@ "description": "Deletes a thermostat daily program.", "isDeprecated": false, "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Unreleased.", "isDraft": false, "draftMessage": "", "response": { @@ -55341,8 +55341,8 @@ "description": "Updates a specified thermostat daily program. The periods that you specify overwrite any existing periods for the daily program.", "isDeprecated": false, "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Unreleased.", "isDraft": false, "draftMessage": "", "response": { @@ -55561,7 +55561,7 @@ } ], "parentPath": "/thermostats", - "isUndocumented": false, + "isUndocumented": true, "isDeprecated": false, "isDraft": false }, @@ -61506,9 +61506,9 @@ "parentPath": "/user_identities/enrollment_automations", "description": "Deletes a specified [enrollment automation](../capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system.md). You must delete all enrollment automations associated with a [user identity](../capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md#what-is-a-user-identity) before [deleting the user identity](https://docs.seam.co/latest/api/user_identities/delete).", "isDeprecated": false, - "deprecationMessage": "Will be removed. Instead, link the `user_identity` to the `acs_user` in the access system in which you want to issue credentials.", - "isUndocumented": false, - "undocumentedMessage": "", + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Will be removed.", "isDraft": false, "draftMessage": "", "response": { @@ -61554,9 +61554,9 @@ "parentPath": "/user_identities/enrollment_automations", "description": "Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system/).", "isDeprecated": false, - "deprecationMessage": "Will be removed. Instead, link the `user_identity` to the `acs_user` in the access system in which you want to issue credentials.", - "isUndocumented": false, - "undocumentedMessage": "", + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Will be removed.", "isDraft": false, "draftMessage": "", "response": { @@ -61606,9 +61606,9 @@ "parentPath": "/user_identities/enrollment_automations", "description": "Sets up a new [enrollment automation](../capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system.md) for a specified [user identity](../capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md#what-is-a-user-identity) with a specified [credential manager](../capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system.md).", "isDeprecated": false, - "deprecationMessage": "Will be removed. Instead, link the `user_identity` to the `acs_user` in the access system in which you want to issue credentials.", - "isUndocumented": false, - "undocumentedMessage": "", + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Will be removed.", "isDraft": false, "draftMessage": "", "response": { @@ -61712,9 +61712,9 @@ "parentPath": "/user_identities/enrollment_automations", "description": "Returns a list of all [enrollment automations](../capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system.md) for a specified [user identity](../capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md#what-is-a-user-identity).", "isDeprecated": false, - "deprecationMessage": "Will be removed. Instead, link the `user_identity` to the `acs_user` in the access system in which you want to issue credentials.", - "isUndocumented": false, - "undocumentedMessage": "", + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Will be removed.", "isDraft": false, "draftMessage": "", "response": { @@ -61759,7 +61759,7 @@ } ], "parentPath": "/user_identities", - "isUndocumented": false, + "isUndocumented": true, "isDeprecated": false, "isDraft": false }, @@ -84236,8 +84236,8 @@ "description": "Configured [daily programs](../capability-guides/thermostats/creating-and-managing-thermostat-programs.md) for the thermostat.", "isDeprecated": false, "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Unreleased.", "isDraft": false, "draftMessage": "", "propertyGroupKey": "thermostats", @@ -84359,8 +84359,8 @@ "description": "Current [weekly program](../capability-guides/thermostats/creating-and-managing-thermostat-programs.md) for the thermostat.", "isDeprecated": false, "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Unreleased.", "isDraft": false, "draftMessage": "", "propertyGroupKey": "thermostats", @@ -86797,11 +86797,11 @@ } ], "description": "Represents an [enrollment automation](../capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system.md) within the [Seam mobile access solution](../capability-guides/mobile-access/README.md).", - "isDeprecated": true, + "isDeprecated": false, "routePath": "/user_identities/enrollment_automations", - "deprecationMessage": "Will be removed. Instead, link the `user_identity` to the `acs_user` in the access system in which you want to issue credentials.", - "isUndocumented": false, - "undocumentedMessage": "", + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Will be removed.", "isDraft": false, "draftMessage": "", "propertyGroups": [], @@ -90992,8 +90992,8 @@ "isDeprecated": false, "routePath": "/thermostats/daily_programs", "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Unreleased.", "isDraft": false, "draftMessage": "", "propertyGroups": [], diff --git a/docs/api/_report.md b/docs/api/_report.md index aa8d87749..d18f33266 100644 --- a/docs/api/_report.md +++ b/docs/api/_report.md @@ -1,12 +1,5 @@ # Documentation Report -## Untitled - -### Routes - -- `/thermostats/daily_programs` -- `/user_identities/enrollment_automations` - ## Undocumented These items are intentionally undocumented. @@ -30,10 +23,12 @@ These items are intentionally undocumented. - `/seam/mobile_sdk/v1/acs/credentials`: No undocumented message provided - `/seam/mobile_sdk/v1/phone_sessions`: No undocumented message provided - `/seam/partner/v1/building_blocks/spaces`: No undocumented message provided +- `/thermostats/daily_programs`: No undocumented message provided - `/unstable_access_grants`: No undocumented message provided - `/unstable_access_methods`: No undocumented message provided - `/unstable_locations`: No undocumented message provided - `/unstable_partner/building_blocks`: No undocumented message provided +- `/user_identities/enrollment_automations`: No undocumented message provided ### Resources @@ -41,10 +36,12 @@ These items are intentionally undocumented. - `acs_credential_provisioning_automation`: Deprecated. Will be removed. - `bridge_client_session`: Seam Bridge client only. - `bridge_connected_systems`: Seam Bridge client only. +- `enrollment_automation`: Will be removed. - `instant_key`: Unreleased. - `location`: Will be removed. - `magic_link`: Unreleased. - `phone_session`: Seam Mobile SDK only. +- `thermostat_daily_program`: Unreleased. - `unmanaged_acs_access_group`: Unreleased. - `unmanaged_acs_credential`: Unreleased. - `unmanaged_acs_user`: Unreleased. @@ -99,6 +96,10 @@ These items are intentionally undocumented. - `/seam/mobile_sdk/v1/phone_sessions/get_or_create`: Mobile SDK only. - `/seam/partner/v1/building_blocks/spaces/auto_map`: Partner building blocks/UI only. - `/thermostats/get`: Will be removed. +- `/thermostats/update_weekly_program`: Unreleased. +- `/thermostats/daily_programs/create`: Unreleased. +- `/thermostats/daily_programs/delete`: Unreleased. +- `/thermostats/daily_programs/update`: Unreleased. - `/unstable_access_grants/create`: Unreleased. - `/unstable_access_grants/delete`: Unreleased. - `/unstable_access_grants/get`: Unreleased. @@ -119,6 +120,10 @@ These items are intentionally undocumented. - `/unstable_partner/building_blocks/generate_magic_link`: Experimental partner building blocks. - `/unstable_partner/building_blocks/manage_devices`: Experimental partner building blocks. - `/unstable_partner/building_blocks/organize_spaces`: Experimental partner building blocks. +- `/user_identities/enrollment_automations/delete`: Will be removed. +- `/user_identities/enrollment_automations/get`: Will be removed. +- `/user_identities/enrollment_automations/launch`: Will be removed. +- `/user_identities/enrollment_automations/list`: Will be removed. - `/workspaces/find_resources`: Unreleased. ### Endpoint parameters @@ -442,7 +447,6 @@ These items are deprecated. - `acs_credential_pool`: Not used. - `acs_credential_provisioning_automation`: Not used. -- `enrollment_automation`: Will be removed. Instead, link the `user_identity` to the `acs_user` in the access system in which you want to issue credentials. ### Resource properties @@ -557,14 +561,9 @@ These items are deprecated. - `/instant_keys/list` - `/locks/get` - `/spaces/get_related` -- `/user_identities/enrollment_automations/delete` -- `/user_identities/enrollment_automations/get` -- `/user_identities/enrollment_automations/launch` -- `/user_identities/enrollment_automations/list` ### Resources without resource samples -- `enrollment_automation` - `event: access_code.created` - `event: access_code.changed` - `event: access_code.scheduled_on_device` diff --git a/docs/api/thermostats/README.md b/docs/api/thermostats/README.md index 2dc983c8c..8c9e9a292 100644 --- a/docs/api/thermostats/README.md +++ b/docs/api/thermostats/README.md @@ -4365,8 +4365,3 @@ Sets a [temperature threshold](../../capability-guides/thermostats/setting-and-m Updates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). -[**`/thermostats/update_weekly_program`**](./update_weekly_program.md) - -Updates the thermostat weekly program for a thermostat device. To configure a weekly program, specify the ID of the daily program that you want to use for each day of the week. When you update a weekly program, the set of programs that you specify overwrites any previous weekly program for the thermostat. - - diff --git a/docs/api/thermostats/update_weekly_program.md b/docs/api/thermostats/update_weekly_program.md deleted file mode 100644 index e148d4e1c..000000000 --- a/docs/api/thermostats/update_weekly_program.md +++ /dev/null @@ -1,286 +0,0 @@ -# Update the Thermostat Weekly Program - -- [Request Parameters](#request-parameters) -- [Response](#response) - -Updates the thermostat weekly program for a thermostat device. To configure a weekly program, specify the ID of the daily program that you want to use for each day of the week. When you update a weekly program, the set of programs that you specify overwrites any previous weekly program for the thermostat. - - -{% tabs %} -{% tab title="JavaScript" %} - -Updates the thermostat weekly program for a thermostat device. - -#### Code: - -```javascript -await seam.thermostats.updateWeeklyProgram({ - device_id: "076546e8-966c-47dd-831b-8d98413bf070", - monday_program_id: "a36dccaa-aeb9-47da-bf1d-43a08ba5c870", - tuesday_program_id: "a36dccaa-aeb9-47da-bf1d-43a08ba5c870", - wednesday_program_id: "a36dccaa-aeb9-47da-bf1d-43a08ba5c870", - thursday_program_id: "a36dccaa-aeb9-47da-bf1d-43a08ba5c870", - friday_program_id: "a36dccaa-aeb9-47da-bf1d-43a08ba5c870", - saturday_program_id: "3bf5a788-caf8-40c5-a7d5-78b72e9b3a28", - sunday_program_id: "3bf5a788-caf8-40c5-a7d5-78b72e9b3a28", -}); -``` - -#### Output: - -```javascript -{ - "action_attempt_id": "a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d", - "action_type": "PUSH_THERMOSTAT_PROGRAMS", - "error": null, - "result": {}, - "status": "success" -} -``` -{% endtab %} - -{% tab title="cURL" %} - -Updates the thermostat weekly program for a thermostat device. - -#### Code: - -```curl -curl --include --request POST "https://connect.getseam.com/thermostats/update_weekly_program" \ - --header "Authorization: Bearer $SEAM_API_KEY" \ - --json @- < "a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d", - "action_type" => "PUSH_THERMOSTAT_PROGRAMS", - "error" => nil, - "result" => { - }, - "status" => "success", -} -``` -{% endtab %} - -{% tab title="PHP" %} - -Updates the thermostat weekly program for a thermostat device. - -#### Code: - -```php -$seam->thermostats->update_weekly_program( - device_id: "076546e8-966c-47dd-831b-8d98413bf070", - monday_program_id: "a36dccaa-aeb9-47da-bf1d-43a08ba5c870", - tuesday_program_id: "a36dccaa-aeb9-47da-bf1d-43a08ba5c870", - wednesday_program_id: "a36dccaa-aeb9-47da-bf1d-43a08ba5c870", - thursday_program_id: "a36dccaa-aeb9-47da-bf1d-43a08ba5c870", - friday_program_id: "a36dccaa-aeb9-47da-bf1d-43a08ba5c870", - saturday_program_id: "3bf5a788-caf8-40c5-a7d5-78b72e9b3a28", - sunday_program_id: "3bf5a788-caf8-40c5-a7d5-78b72e9b3a28" -); -``` - -#### Output: - -```php -[ - "action_attempt_id" => "a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d", - "action_type" => "PUSH_THERMOSTAT_PROGRAMS", - "error" => null, - "result" => [], - "status" => "success", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} - -Updates the thermostat weekly program for a thermostat device. - -#### Code: - -```seam_cli -seam thermostats update-weekly-program --device_id "076546e8-966c-47dd-831b-8d98413bf070" --monday_program_id "a36dccaa-aeb9-47da-bf1d-43a08ba5c870" --tuesday_program_id "a36dccaa-aeb9-47da-bf1d-43a08ba5c870" --wednesday_program_id "a36dccaa-aeb9-47da-bf1d-43a08ba5c870" --thursday_program_id "a36dccaa-aeb9-47da-bf1d-43a08ba5c870" --friday_program_id "a36dccaa-aeb9-47da-bf1d-43a08ba5c870" --saturday_program_id "3bf5a788-caf8-40c5-a7d5-78b72e9b3a28" --sunday_program_id "3bf5a788-caf8-40c5-a7d5-78b72e9b3a28" -``` - -#### Output: - -```seam_cli -{ - "action_attempt_id": "a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d", - "action_type": "PUSH_THERMOSTAT_PROGRAMS", - "error": null, - "result": {}, - "status": "success" -} -``` -{% endtab %} - -{% endtabs %} - - -
- -Authentication Methods - -- API key -- Client session token -- 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 - -**`device_id`** *String* (Required) - -ID of the thermostat device for which you want to update the weekly program. - ---- - -**`friday_program_id`** *String* - -ID of the thermostat daily program to run on Fridays. - ---- - -**`monday_program_id`** *String* - -ID of the thermostat daily program to run on Mondays. - ---- - -**`saturday_program_id`** *String* - -ID of the thermostat daily program to run on Saturdays. - ---- - -**`sunday_program_id`** *String* - -ID of the thermostat daily program to run on Sundays. - ---- - -**`thursday_program_id`** *String* - -ID of the thermostat daily program to run on Thursdays. - ---- - -**`tuesday_program_id`** *String* - -ID of the thermostat daily program to run on Tuesdays. - ---- - -**`wednesday_program_id`** *String* - -ID of the thermostat daily program to run on Wednesdays. - ---- - - -## Response - -[action\_attempt](./) - - -{% tabs %} -{% tab title="JSON" %} - - - -```json -{ - "action_attempt_id": "a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d", - "action_type": "PUSH_THERMOSTAT_PROGRAMS", - "error": null, - "result": {}, - "status": "success" -} -``` -{% endtab %} -{% endtabs %}