Skip to content

Commit e19a345

Browse files
committed
ci: Generate docs
1 parent b5d62af commit e19a345

11 files changed

Lines changed: 311 additions & 31 deletions

File tree

docs/api/_report.md

Lines changed: 74 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@
7979
- `/workspaces/get`
8080
- `/workspaces/list`
8181
- `/workspaces/reset_sandbox`
82+
- `/workspaces/update`
8283

8384
## Undocumented
8485

@@ -91,28 +92,23 @@ These items are intentionally undocumented.
9192
- `/acs/credential_provisioning_automations`: No undocumented message provided
9293
- `/acs/credentials/unmanaged`: No undocumented message provided
9394
- `/acs/users/unmanaged`: No undocumented message provided
95+
- `/locks/simulate`: No undocumented message provided
9496
- `/seam/bridge/v1/bridge_client_sessions`: No undocumented message provided
9597
- `/seam/bridge/v1/bridge_connected_systems`: No undocumented message provided
98+
- `/seam/instant_key/v1/client_sessions`: No undocumented message provided
99+
- `/thermostats/daily_programs`: No undocumented message provided
96100
- `/unstable_access_grants`: No undocumented message provided
101+
- `/unstable_access_methods`: No undocumented message provided
97102
- `/unstable_locations`: No undocumented message provided
98103

99104
### Resources
100105

101106
- `instant_key`: Unreleased.
102107

103-
### Resource properties
104-
105-
- `acs_user.is_latest_desired_state_synced_with_provider`: Only used internally.
106-
- `acs_user.latest_desired_state_synced_with_provider_at`: Only used internally.
107-
- `acs_user.pending_mutations`: Experimental.
108-
- `thermostat_schedule.unstable_is_override_allowed`: Unstable
109-
- `unmanaged_acs_user.is_latest_desired_state_synced_with_provider`: Only used internally.
110-
- `unmanaged_acs_user.latest_desired_state_synced_with_provider_at`: Only used internally.
111-
- `unmanaged_acs_user.pending_mutations`: Experimental.
112-
113108
### Namespaces
114109

115110
- `/seam/bridge/v1`: No undocumented message provided
111+
- `/seam/instant_key/v1`: No undocumented message provided
116112

117113
### Endpoints
118114

@@ -126,24 +122,33 @@ These items are intentionally undocumented.
126122
- `/acs/users/unmanaged/get`: No unmanaged users are currently implemented.
127123
- `/acs/users/unmanaged/list`: No unmanaged users are currently implemented.
128124
- `/devices/delete`: Deleting a device is no longer supported and will be removed.
129-
- `/devices/simulate/access_code_lock`: Unreleased.
130-
- `/devices/simulate/access_code_unlock`: Unreleased.
125+
- `/locks/simulate/keypad_code_entry`: Unreleased.
126+
- `/locks/simulate/manual_lock_via_keypad`: Unreleased.
131127
- `/seam/bridge/v1/bridge_client_sessions/create`: Seam Bridge Client only.
132128
- `/seam/bridge/v1/bridge_client_sessions/get`: Seam Bridge Client only.
133129
- `/seam/bridge/v1/bridge_client_sessions/refresh_telemetry_token`: Seam Bridge Client only.
134130
- `/seam/bridge/v1/bridge_client_sessions/regenerate_pairing_code`: Seam Bridge Client only.
135131
- `/seam/bridge/v1/bridge_client_sessions/report_status`: Seam Bridge Client only.
136132
- `/seam/bridge/v1/bridge_connected_systems/list`: Seam Bridge Client only.
133+
- `/seam/instant_key/v1/client_sessions/exchange_short_code`: Seam Instant Key only.
134+
- `/thermostats/activate_weekly_program`: Unreleased.
135+
- `/thermostats/clear_weekly_program`: Unreleased.
137136
- `/thermostats/get`: Will be removed.
137+
- `/thermostats/daily_programs/create`: Unreleased.
138+
- `/thermostats/daily_programs/delete`: Unreleased.
139+
- `/thermostats/daily_programs/update`: Unreleased.
138140
- `/unstable_access_grants/create`: Unreleased.
139141
- `/unstable_access_grants/get`: Unreleased.
140142
- `/unstable_access_grants/list`: Unreleased.
141-
- `/unstable_access_grants/list_access_methods`: Unreleased.
143+
- `/unstable_access_methods/get`: Unreleased.
144+
- `/unstable_access_methods/list`: Unreleased.
145+
- `/unstable_locations/add_acs_entrances`: Experimental locations.
142146
- `/unstable_locations/add_devices`: Experimental locations.
143147
- `/unstable_locations/create`: Experimental locations.
144148
- `/unstable_locations/delete`: Experimental locations.
145149
- `/unstable_locations/get`: Experimental locations.
146150
- `/unstable_locations/list`: Experimental locations.
151+
- `/unstable_locations/remove_acs_entrances`: Experimental locations.
147152
- `/unstable_locations/remove_devices`: Experimental locations.
148153
- `/unstable_locations/update`: Experimental locations.
149154

@@ -159,6 +164,8 @@ These items are intentionally undocumented.
159164
- `sync`: Only used internally.
160165
- `/access_codes/unmanaged/delete`
161166
- `sync`: Only used internally.
167+
- `/acs/entrances/list`
168+
- `location_id`: Experimental locations.
162169
- `/devices/list`
163170
- `exclude_if`: Only used internally.
164171
- `include_if`: Only used internally.
@@ -235,16 +242,19 @@ Items that are intentionally undocumented are not included in this section.
235242
- `acs_credential_provisioning_automation.workspace_id`
236243
- `acs_system.acs_access_group_count`
237244
- `acs_system.acs_user_count`
245+
- `acs_system.can_create_user`
246+
- `acs_system.can_delete_user`
247+
- `acs_system.can_update_user_group_membership`
248+
- `acs_system.can_update_user_information`
249+
- `acs_system.can_update_user_schedule`
250+
- `acs_system.can_update_user_supension_state`
238251
- `acs_system.location`
239252
- `acs_system.system_type`
240253
- `acs_system.system_type_display_name`
241254
- `acs_system.visionline_metadata`
242255
- `acs_user.email`
243256
- `acs_user.hid_acs_system_id`
244-
- `acs_user.is_latest_desired_state_synced_with_provider`
245257
- `acs_user.is_managed`
246-
- `acs_user.latest_desired_state_synced_with_provider_at`
247-
- `acs_user.pending_mutations`
248258
- `client_session.client_session_id`
249259
- `client_session.connect_webview_ids`
250260
- `client_session.connected_account_ids`
@@ -337,10 +347,7 @@ Items that are intentionally undocumented are not included in this section.
337347
- `unmanaged_acs_credential.is_managed`
338348
- `unmanaged_acs_user.email`
339349
- `unmanaged_acs_user.hid_acs_system_id`
340-
- `unmanaged_acs_user.is_latest_desired_state_synced_with_provider`
341350
- `unmanaged_acs_user.is_managed`
342-
- `unmanaged_acs_user.latest_desired_state_synced_with_provider_at`
343-
- `unmanaged_acs_user.pending_mutations`
344351
- `unmanaged_device.can_hvac_cool`
345352
- `unmanaged_device.can_hvac_heat`
346353
- `unmanaged_device.can_hvac_heat_cool`
@@ -362,6 +369,7 @@ Items that are intentionally undocumented are not included in this section.
362369
- `webhook.webhook_id`
363370
- `workspace.company_name`
364371
- `workspace.connect_partner_name`
372+
- `workspace.connect_webview_customization`
365373
- `workspace.is_sandbox`
366374
- `workspace.name`
367375
- `workspace.workspace_id`
@@ -397,8 +405,6 @@ Items that are intentionally undocumented are not included in this section.
397405
- `/devices/get`
398406
- `/devices/list_device_providers`
399407
- `/devices/update`
400-
- `/devices/simulate/access_code_lock`
401-
- `/devices/simulate/access_code_unlock`
402408
- `/devices/simulate/connect`
403409
- `/devices/simulate/disconnect`
404410
- `/devices/simulate/remove`
@@ -411,6 +417,8 @@ Items that are intentionally undocumented are not included in this section.
411417
- `/locks/list`
412418
- `/locks/lock_door`
413419
- `/locks/unlock_door`
420+
- `/locks/simulate/keypad_code_entry`
421+
- `/locks/simulate/manual_lock_via_keypad`
414422
- `/networks/get`
415423
- `/networks/list`
416424
- `/noise_sensors/list`
@@ -430,6 +438,7 @@ Items that are intentionally undocumented are not included in this section.
430438
- `/workspaces/get`
431439
- `/workspaces/list`
432440
- `/workspaces/reset_sandbox`
441+
- `/workspaces/update`
433442

434443
### Endpoint parameters
435444

@@ -473,6 +482,7 @@ Items that are intentionally undocumented are not included in this section.
473482
- `/acs/entrances/list`
474483
- `acs_credential_id`
475484
- `acs_system_id`
485+
- `location_id`
476486
- `/acs/entrances/list_credentials_with_access`
477487
- `acs_entrance_id`
478488
- `include_if`
@@ -570,12 +580,6 @@ Items that are intentionally undocumented are not included in this section.
570580
- `is_managed`
571581
- `name`
572582
- `properties`
573-
- `/devices/simulate/access_code_lock`
574-
- `access_code_id`
575-
- `device_id`
576-
- `/devices/simulate/access_code_unlock`
577-
- `access_code_id`
578-
- `device_id`
579583
- `/devices/simulate/connect`
580584
- `device_id`
581585
- `/devices/simulate/disconnect`
@@ -625,6 +629,11 @@ Items that are intentionally undocumented are not included in this section.
625629
- `/locks/unlock_door`
626630
- `device_id`
627631
- `sync`
632+
- `/locks/simulate/keypad_code_entry`
633+
- `code`
634+
- `device_id`
635+
- `/locks/simulate/manual_lock_via_keypad`
636+
- `device_id`
628637
- `/networks/get`
629638
- `network_id`
630639
- `/noise_sensors/list`
@@ -685,18 +694,26 @@ Items that are intentionally undocumented are not included in this section.
685694
- `/thermostats/set_hvac_mode`
686695
- `hvac_mode_setting`
687696
- `/unstable_access_grants/create`
688-
- `desired_access_methods`
697+
- `requested_access_methods`
698+
- `/unstable_locations/add_acs_entrances`
699+
- `acs_entrance_ids`
700+
- `location_id`
689701
- `/unstable_locations/add_devices`
690702
- `device_ids`
691703
- `location_id`
692704
- `/unstable_locations/create`
705+
- `acs_entrance_ids`
706+
- `device_ids`
693707
- `geolocation`
694708
- `name`
695709
- `time_zone`
696710
- `/unstable_locations/delete`
697711
- `location_id`
698712
- `/unstable_locations/get`
699713
- `location_id`
714+
- `/unstable_locations/remove_acs_entrances`
715+
- `acs_entrance_ids`
716+
- `location_id`
700717
- `/unstable_locations/remove_devices`
701718
- `device_ids`
702719
- `location_id`
@@ -724,12 +741,18 @@ Items that are intentionally undocumented are not included in this section.
724741
- `/workspaces/create`
725742
- `company_name`
726743
- `connect_partner_name`
744+
- `connect_webview_customization`
727745
- `is_sandbox`
728746
- `name`
729747
- `webview_logo_shape`
730748
- `webview_primary_button_color`
731749
- `webview_primary_button_text_color`
732750
- `webview_success_message`
751+
- `/workspaces/update`
752+
- `connect_partner_name`
753+
- `connect_webview_customization`
754+
- `is_suspended`
755+
- `name`
733756

734757
## Deprecated
735758

@@ -764,17 +787,25 @@ These items are deprecated.
764787
- `manual_override_allowed`: Use 'thermostat_schedule.is_override_allowed'
765788
- `/workspaces/create`
766789
- `connect_partner_name`: use company_name
790+
- `webview_logo_shape`: Use `connect_webview_customization.webview_logo_shape` instead.
791+
- `webview_primary_button_color`: Use `connect_webview_customization.webview_primary_button_color` instead.
792+
- `webview_primary_button_text_color`: Use `connect_webview_customization.webview_primary_button_text_color` instead.
793+
- `webview_success_message`: Use `connect_webview_customization.webview_success_message` instead.
767794

768795
### Extra response keys
769796

770797
- `/access_codes/create`
771798
- `action_attempt`
799+
- `/access_codes/list`
800+
- `pagination`
772801
- `/access_codes/pull_backup_access_code`
773802
- `backup_access_code`
774803
- `/acs/users/list`
775804
- `pagination`
776805
- `/connected_accounts/list`
777806
- `pagination`
807+
- `/devices/list`
808+
- `pagination`
778809
- `/events/get`
779810
- `message`
780811
- `/locks/get`
@@ -799,6 +830,7 @@ These items are deprecated.
799830
- `/access_codes/get`
800831
- `/access_codes/list`
801832
- `/access_codes/pull_backup_access_code`
833+
- `/access_codes/report_device_constraints`
802834
- `/access_codes/update`
803835
- `/access_codes/update_multiple`
804836
- `/access_codes/simulate/create_unmanaged_access_code`
@@ -812,6 +844,7 @@ These items are deprecated.
812844
- `/acs/credentials/create_offline_code`
813845
- `/acs/credentials/unmanaged/get`
814846
- `/acs/credentials/unmanaged/list`
847+
- `/acs/encoders/encode_access_method`
815848
- `/acs/encoders/encode_credential`
816849
- `/acs/encoders/get`
817850
- `/acs/encoders/list`
@@ -849,8 +882,6 @@ These items are deprecated.
849882
- `/devices/list`
850883
- `/devices/list_device_providers`
851884
- `/devices/update`
852-
- `/devices/simulate/access_code_lock`
853-
- `/devices/simulate/access_code_unlock`
854885
- `/devices/simulate/connect`
855886
- `/devices/simulate/disconnect`
856887
- `/devices/simulate/remove`
@@ -863,6 +894,8 @@ These items are deprecated.
863894
- `/locks/list`
864895
- `/locks/lock_door`
865896
- `/locks/unlock_door`
897+
- `/locks/simulate/keypad_code_entry`
898+
- `/locks/simulate/manual_lock_via_keypad`
866899
- `/networks/get`
867900
- `/networks/list`
868901
- `/noise_sensors/list`
@@ -882,18 +915,27 @@ These items are deprecated.
882915
- `/seam/bridge/v1/bridge_client_sessions/regenerate_pairing_code`
883916
- `/seam/bridge/v1/bridge_client_sessions/report_status`
884917
- `/seam/bridge/v1/bridge_connected_systems/list`
918+
- `/seam/instant_key/v1/client_sessions/exchange_short_code`
919+
- `/thermostats/activate_weekly_program`
920+
- `/thermostats/clear_weekly_program`
885921
- `/thermostats/get`
922+
- `/thermostats/daily_programs/create`
923+
- `/thermostats/daily_programs/delete`
924+
- `/thermostats/daily_programs/update`
886925
- `/thermostats/simulate/hvac_mode_adjusted`
887926
- `/thermostats/simulate/temperature_reached`
888927
- `/unstable_access_grants/create`
889928
- `/unstable_access_grants/get`
890929
- `/unstable_access_grants/list`
891-
- `/unstable_access_grants/list_access_methods`
930+
- `/unstable_access_methods/get`
931+
- `/unstable_access_methods/list`
932+
- `/unstable_locations/add_acs_entrances`
892933
- `/unstable_locations/add_devices`
893934
- `/unstable_locations/create`
894935
- `/unstable_locations/delete`
895936
- `/unstable_locations/get`
896937
- `/unstable_locations/list`
938+
- `/unstable_locations/remove_acs_entrances`
897939
- `/unstable_locations/remove_devices`
898940
- `/unstable_locations/update`
899941
- `/user_identities/generate_instant_key`
@@ -907,3 +949,4 @@ These items are deprecated.
907949
- `/workspaces/get`
908950
- `/workspaces/list`
909951
- `/workspaces/reset_sandbox`
952+
- `/workspaces/update`

docs/api/acs/credentials/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,7 @@ Possible enum values:
151151
- `salto_ks_credential`
152152
- `assa_abloy_vostio_key`
153153
- `salto_space_key`
154+
- `latch_access`
154155

155156
---
156157

docs/api/acs/encoders/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,9 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains
9090

9191
## Endpoints
9292

93+
### [`/acs/encoders/encode_access_method`](./encode_access_method.md)
94+
95+
Encodes an existing access method onto a plastic card placed on the specified [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
9396
### [`/acs/encoders/encode_credential`](./encode_credential.md)
9497

9598
Encodes an existing [credential](../../../capability-guides/access-systems/managing-credentials.md) onto a plastic card placed on the specified [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).

0 commit comments

Comments
 (0)