Skip to content

Commit 8d43ff8

Browse files
authored
feat: Update to @seamapi/[email protected] (#749)
* feat: Update to @seamapi/[email protected] * ci: Generate docs
1 parent 219fb82 commit 8d43ff8

File tree

7 files changed

+49
-342
lines changed

7 files changed

+49
-342
lines changed

docs/SUMMARY.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -325,7 +325,6 @@
325325
* [Set to Heat-Cool (Auto) Mode](api/thermostats/heat_cool.md)
326326
* [Set to Off Mode](api/thermostats/off.md)
327327
* [Update a Climate Preset](api/thermostats/update_climate_preset.md)
328-
* [Update the Thermostat Weekly Program](api/thermostats/update_weekly_program.md)
329328
* [Thermostat Schedules](api/thermostats/schedules/README.md)
330329
* [Create a Thermostat Schedule](api/thermostats/schedules/create.md)
331330
* [Delete a Thermostat Schedule](api/thermostats/schedules/delete.md)

docs/api/_blueprint.json

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -54698,8 +54698,8 @@
5469854698
"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.",
5469954699
"isDeprecated": false,
5470054700
"deprecationMessage": "",
54701-
"isUndocumented": false,
54702-
"undocumentedMessage": "",
54701+
"isUndocumented": true,
54702+
"undocumentedMessage": "Unreleased.",
5470354703
"isDraft": false,
5470454704
"draftMessage": "",
5470554705
"response": {
@@ -54961,8 +54961,8 @@
5496154961
"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.",
5496254962
"isDeprecated": false,
5496354963
"deprecationMessage": "",
54964-
"isUndocumented": false,
54965-
"undocumentedMessage": "",
54964+
"isUndocumented": true,
54965+
"undocumentedMessage": "Unreleased.",
5496654966
"isDraft": false,
5496754967
"draftMessage": "",
5496854968
"response": {
@@ -55204,8 +55204,8 @@
5520455204
"description": "Deletes a thermostat daily program.",
5520555205
"isDeprecated": false,
5520655206
"deprecationMessage": "",
55207-
"isUndocumented": false,
55208-
"undocumentedMessage": "",
55207+
"isUndocumented": true,
55208+
"undocumentedMessage": "Unreleased.",
5520955209
"isDraft": false,
5521055210
"draftMessage": "",
5521155211
"response": {
@@ -55341,8 +55341,8 @@
5534155341
"description": "Updates a specified thermostat daily program. The periods that you specify overwrite any existing periods for the daily program.",
5534255342
"isDeprecated": false,
5534355343
"deprecationMessage": "",
55344-
"isUndocumented": false,
55345-
"undocumentedMessage": "",
55344+
"isUndocumented": true,
55345+
"undocumentedMessage": "Unreleased.",
5534655346
"isDraft": false,
5534755347
"draftMessage": "",
5534855348
"response": {
@@ -55561,7 +55561,7 @@
5556155561
}
5556255562
],
5556355563
"parentPath": "/thermostats",
55564-
"isUndocumented": false,
55564+
"isUndocumented": true,
5556555565
"isDeprecated": false,
5556655566
"isDraft": false
5556755567
},
@@ -61506,9 +61506,9 @@
6150661506
"parentPath": "/user_identities/enrollment_automations",
6150761507
"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).",
6150861508
"isDeprecated": false,
61509-
"deprecationMessage": "Will be removed. Instead, link the `user_identity` to the `acs_user` in the access system in which you want to issue credentials.",
61510-
"isUndocumented": false,
61511-
"undocumentedMessage": "",
61509+
"deprecationMessage": "",
61510+
"isUndocumented": true,
61511+
"undocumentedMessage": "Will be removed.",
6151261512
"isDraft": false,
6151361513
"draftMessage": "",
6151461514
"response": {
@@ -61554,9 +61554,9 @@
6155461554
"parentPath": "/user_identities/enrollment_automations",
6155561555
"description": "Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system/).",
6155661556
"isDeprecated": false,
61557-
"deprecationMessage": "Will be removed. Instead, link the `user_identity` to the `acs_user` in the access system in which you want to issue credentials.",
61558-
"isUndocumented": false,
61559-
"undocumentedMessage": "",
61557+
"deprecationMessage": "",
61558+
"isUndocumented": true,
61559+
"undocumentedMessage": "Will be removed.",
6156061560
"isDraft": false,
6156161561
"draftMessage": "",
6156261562
"response": {
@@ -61606,9 +61606,9 @@
6160661606
"parentPath": "/user_identities/enrollment_automations",
6160761607
"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).",
6160861608
"isDeprecated": false,
61609-
"deprecationMessage": "Will be removed. Instead, link the `user_identity` to the `acs_user` in the access system in which you want to issue credentials.",
61610-
"isUndocumented": false,
61611-
"undocumentedMessage": "",
61609+
"deprecationMessage": "",
61610+
"isUndocumented": true,
61611+
"undocumentedMessage": "Will be removed.",
6161261612
"isDraft": false,
6161361613
"draftMessage": "",
6161461614
"response": {
@@ -61712,9 +61712,9 @@
6171261712
"parentPath": "/user_identities/enrollment_automations",
6171361713
"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).",
6171461714
"isDeprecated": false,
61715-
"deprecationMessage": "Will be removed. Instead, link the `user_identity` to the `acs_user` in the access system in which you want to issue credentials.",
61716-
"isUndocumented": false,
61717-
"undocumentedMessage": "",
61715+
"deprecationMessage": "",
61716+
"isUndocumented": true,
61717+
"undocumentedMessage": "Will be removed.",
6171861718
"isDraft": false,
6171961719
"draftMessage": "",
6172061720
"response": {
@@ -61759,7 +61759,7 @@
6175961759
}
6176061760
],
6176161761
"parentPath": "/user_identities",
61762-
"isUndocumented": false,
61762+
"isUndocumented": true,
6176361763
"isDeprecated": false,
6176461764
"isDraft": false
6176561765
},
@@ -84236,8 +84236,8 @@
8423684236
"description": "Configured [daily programs](../capability-guides/thermostats/creating-and-managing-thermostat-programs.md) for the thermostat.",
8423784237
"isDeprecated": false,
8423884238
"deprecationMessage": "",
84239-
"isUndocumented": false,
84240-
"undocumentedMessage": "",
84239+
"isUndocumented": true,
84240+
"undocumentedMessage": "Unreleased.",
8424184241
"isDraft": false,
8424284242
"draftMessage": "",
8424384243
"propertyGroupKey": "thermostats",
@@ -84359,8 +84359,8 @@
8435984359
"description": "Current [weekly program](../capability-guides/thermostats/creating-and-managing-thermostat-programs.md) for the thermostat.",
8436084360
"isDeprecated": false,
8436184361
"deprecationMessage": "",
84362-
"isUndocumented": false,
84363-
"undocumentedMessage": "",
84362+
"isUndocumented": true,
84363+
"undocumentedMessage": "Unreleased.",
8436484364
"isDraft": false,
8436584365
"draftMessage": "",
8436684366
"propertyGroupKey": "thermostats",
@@ -86797,11 +86797,11 @@
8679786797
}
8679886798
],
8679986799
"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).",
86800-
"isDeprecated": true,
86800+
"isDeprecated": false,
8680186801
"routePath": "/user_identities/enrollment_automations",
86802-
"deprecationMessage": "Will be removed. Instead, link the `user_identity` to the `acs_user` in the access system in which you want to issue credentials.",
86803-
"isUndocumented": false,
86804-
"undocumentedMessage": "",
86802+
"deprecationMessage": "",
86803+
"isUndocumented": true,
86804+
"undocumentedMessage": "Will be removed.",
8680586805
"isDraft": false,
8680686806
"draftMessage": "",
8680786807
"propertyGroups": [],
@@ -90992,8 +90992,8 @@
9099290992
"isDeprecated": false,
9099390993
"routePath": "/thermostats/daily_programs",
9099490994
"deprecationMessage": "",
90995-
"isUndocumented": false,
90996-
"undocumentedMessage": "",
90995+
"isUndocumented": true,
90996+
"undocumentedMessage": "Unreleased.",
9099790997
"isDraft": false,
9099890998
"draftMessage": "",
9099990999
"propertyGroups": [],

docs/api/_report.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,5 @@
11
# Documentation Report
22

3-
## Untitled
4-
5-
### Routes
6-
7-
- `/thermostats/daily_programs`
8-
- `/user_identities/enrollment_automations`
9-
103
## Undocumented
114

125
These items are intentionally undocumented.
@@ -30,21 +23,25 @@ These items are intentionally undocumented.
3023
- `/seam/mobile_sdk/v1/acs/credentials`: No undocumented message provided
3124
- `/seam/mobile_sdk/v1/phone_sessions`: No undocumented message provided
3225
- `/seam/partner/v1/building_blocks/spaces`: No undocumented message provided
26+
- `/thermostats/daily_programs`: No undocumented message provided
3327
- `/unstable_access_grants`: No undocumented message provided
3428
- `/unstable_access_methods`: No undocumented message provided
3529
- `/unstable_locations`: No undocumented message provided
3630
- `/unstable_partner/building_blocks`: No undocumented message provided
31+
- `/user_identities/enrollment_automations`: No undocumented message provided
3732

3833
### Resources
3934

4035
- `acs_credential_pool`: Deprecated. Will be removed.
4136
- `acs_credential_provisioning_automation`: Deprecated. Will be removed.
4237
- `bridge_client_session`: Seam Bridge client only.
4338
- `bridge_connected_systems`: Seam Bridge client only.
39+
- `enrollment_automation`: Will be removed.
4440
- `instant_key`: Unreleased.
4541
- `location`: Will be removed.
4642
- `magic_link`: Unreleased.
4743
- `phone_session`: Seam Mobile SDK only.
44+
- `thermostat_daily_program`: Unreleased.
4845
- `unmanaged_acs_access_group`: Unreleased.
4946
- `unmanaged_acs_credential`: Unreleased.
5047
- `unmanaged_acs_user`: Unreleased.
@@ -99,6 +96,10 @@ These items are intentionally undocumented.
9996
- `/seam/mobile_sdk/v1/phone_sessions/get_or_create`: Mobile SDK only.
10097
- `/seam/partner/v1/building_blocks/spaces/auto_map`: Partner building blocks/UI only.
10198
- `/thermostats/get`: Will be removed.
99+
- `/thermostats/update_weekly_program`: Unreleased.
100+
- `/thermostats/daily_programs/create`: Unreleased.
101+
- `/thermostats/daily_programs/delete`: Unreleased.
102+
- `/thermostats/daily_programs/update`: Unreleased.
102103
- `/unstable_access_grants/create`: Unreleased.
103104
- `/unstable_access_grants/delete`: Unreleased.
104105
- `/unstable_access_grants/get`: Unreleased.
@@ -119,6 +120,10 @@ These items are intentionally undocumented.
119120
- `/unstable_partner/building_blocks/generate_magic_link`: Experimental partner building blocks.
120121
- `/unstable_partner/building_blocks/manage_devices`: Experimental partner building blocks.
121122
- `/unstable_partner/building_blocks/organize_spaces`: Experimental partner building blocks.
123+
- `/user_identities/enrollment_automations/delete`: Will be removed.
124+
- `/user_identities/enrollment_automations/get`: Will be removed.
125+
- `/user_identities/enrollment_automations/launch`: Will be removed.
126+
- `/user_identities/enrollment_automations/list`: Will be removed.
122127
- `/workspaces/find_resources`: Unreleased.
123128

124129
### Endpoint parameters
@@ -442,7 +447,6 @@ These items are deprecated.
442447

443448
- `acs_credential_pool`: Not used.
444449
- `acs_credential_provisioning_automation`: Not used.
445-
- `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.
446450

447451
### Resource properties
448452

@@ -557,14 +561,9 @@ These items are deprecated.
557561
- `/instant_keys/list`
558562
- `/locks/get`
559563
- `/spaces/get_related`
560-
- `/user_identities/enrollment_automations/delete`
561-
- `/user_identities/enrollment_automations/get`
562-
- `/user_identities/enrollment_automations/launch`
563-
- `/user_identities/enrollment_automations/list`
564564

565565
### Resources without resource samples
566566

567-
- `enrollment_automation`
568567
- `event: access_code.created`
569568
- `event: access_code.changed`
570569
- `event: access_code.scheduled_on_device`

docs/api/thermostats/README.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4365,8 +4365,3 @@ Sets a [temperature threshold](../../capability-guides/thermostats/setting-and-m
43654365
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).
43664366

43674367

4368-
[**`/thermostats/update_weekly_program`**](./update_weekly_program.md)
4369-
4370-
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.
4371-
4372-

0 commit comments

Comments
 (0)