Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
64 changes: 32 additions & 32 deletions docs/api/_blueprint.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down Expand Up @@ -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": {
Expand Down Expand Up @@ -55204,8 +55204,8 @@
"description": "Deletes a thermostat daily program.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isUndocumented": true,
"undocumentedMessage": "Unreleased.",
"isDraft": false,
"draftMessage": "",
"response": {
Expand Down Expand Up @@ -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": {
Expand Down Expand Up @@ -55561,7 +55561,7 @@
}
],
"parentPath": "/thermostats",
"isUndocumented": false,
"isUndocumented": true,
"isDeprecated": false,
"isDraft": false
},
Expand Down Expand Up @@ -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": {
Expand Down Expand Up @@ -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": {
Expand Down Expand Up @@ -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": {
Expand Down Expand Up @@ -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": {
Expand Down Expand Up @@ -61759,7 +61759,7 @@
}
],
"parentPath": "/user_identities",
"isUndocumented": false,
"isUndocumented": true,
"isDeprecated": false,
"isDraft": false
},
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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": [],
Expand Down Expand Up @@ -90992,8 +90992,8 @@
"isDeprecated": false,
"routePath": "/thermostats/daily_programs",
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isUndocumented": true,
"undocumentedMessage": "Unreleased.",
"isDraft": false,
"draftMessage": "",
"propertyGroups": [],
Expand Down
25 changes: 12 additions & 13 deletions docs/api/_report.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,5 @@
# Documentation Report

## Untitled

### Routes

- `/thermostats/daily_programs`
- `/user_identities/enrollment_automations`

## Undocumented

These items are intentionally undocumented.
Expand All @@ -30,21 +23,25 @@ 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

- `acs_credential_pool`: Deprecated. Will be removed.
- `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.
Expand Down Expand Up @@ -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.
Expand All @@ -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
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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`
Expand Down
5 changes: 0 additions & 5 deletions docs/api/thermostats/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.


Loading
Loading