Skip to content

Commit 01fdcc4

Browse files
committed
ci: Generate docs
1 parent 40da8c1 commit 01fdcc4

2 files changed

Lines changed: 134 additions & 1 deletion

File tree

docs/api/_report.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@
1515
- `/devices`
1616
- `/devices/simulate`
1717
- `/devices/unmanaged`
18-
- `/events`
1918
- `/locks`
2019
- `/networks`
2120
- `/noise_sensors`

docs/api/events/README.md

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
# Events
2+
3+
## `event`
4+
5+
### `created_at`
6+
7+
Format: `Datetime`
8+
9+
Date and time at which the event was created.
10+
11+
---
12+
13+
### `event_id`
14+
15+
Format: `UUID`
16+
17+
ID of the event.
18+
19+
---
20+
21+
### `event_type`
22+
23+
Format: `Enum`
24+
25+
Possible enum values:
26+
- `access_code.created`
27+
- `access_code.changed`
28+
- `access_code.scheduled_on_device`
29+
- `access_code.set_on_device`
30+
- `access_code.removed_from_device`
31+
- `access_code.delay_in_setting_on_device`
32+
- `access_code.failed_to_set_on_device`
33+
- `access_code.deleted`
34+
- `access_code.delay_in_removing_from_device`
35+
- `access_code.failed_to_remove_from_device`
36+
- `access_code.modified_external_to_seam`
37+
- `access_code.deleted_external_to_seam`
38+
- `access_code.backup_access_code_pulled`
39+
- `access_code.unmanaged.converted_to_managed`
40+
- `access_code.unmanaged.failed_to_convert_to_managed`
41+
- `access_code.unmanaged.created`
42+
- `access_code.unmanaged.removed`
43+
- `access_grant.created`
44+
- `access_grant.deleted`
45+
- `access_grant.access_granted_to_all_doors`
46+
- `access_grant.access_granted_to_door`
47+
- `access_grant.access_to_door_lost`
48+
- `access_method.issued`
49+
- `access_method.revoked`
50+
- `access_method.card_encoding_required`
51+
- `acs_system.connected`
52+
- `acs_system.added`
53+
- `acs_system.disconnected`
54+
- `acs_credential.deleted`
55+
- `acs_credential.issued`
56+
- `acs_credential.reissued`
57+
- `acs_credential.invalidated`
58+
- `acs_user.created`
59+
- `acs_user.deleted`
60+
- `acs_encoder.added`
61+
- `acs_encoder.removed`
62+
- `acs_access_group.deleted`
63+
- `acs_entrance.added`
64+
- `acs_entrance.removed`
65+
- `client_session.deleted`
66+
- `connected_account.connected`
67+
- `connected_account.created`
68+
- `connected_account.successful_login`
69+
- `connected_account.disconnected`
70+
- `connected_account.completed_first_sync`
71+
- `connected_account.deleted`
72+
- `connected_account.completed_first_sync_after_reconnection`
73+
- `action_attempt.lock_door.succeeded`
74+
- `action_attempt.lock_door.failed`
75+
- `action_attempt.unlock_door.succeeded`
76+
- `action_attempt.unlock_door.failed`
77+
- `connect_webview.login_succeeded`
78+
- `connect_webview.login_failed`
79+
- `device.connected`
80+
- `device.added`
81+
- `device.converted_to_unmanaged`
82+
- `device.unmanaged.converted_to_managed`
83+
- `device.unmanaged.connected`
84+
- `device.disconnected`
85+
- `device.unmanaged.disconnected`
86+
- `device.tampered`
87+
- `device.low_battery`
88+
- `device.battery_status_changed`
89+
- `device.removed`
90+
- `device.deleted`
91+
- `device.third_party_integration_detected`
92+
- `device.third_party_integration_no_longer_detected`
93+
- `device.salto.privacy_mode_activated`
94+
- `device.salto.privacy_mode_deactivated`
95+
- `device.connection_became_flaky`
96+
- `device.connection_stabilized`
97+
- `device.error.subscription_required`
98+
- `device.error.subscription_required.resolved`
99+
- `device.accessory_keypad_connected`
100+
- `device.accessory_keypad_disconnected`
101+
- `noise_sensor.noise_threshold_triggered`
102+
- `lock.locked`
103+
- `lock.unlocked`
104+
- `lock.access_denied`
105+
- `thermostat.climate_preset_activated`
106+
- `thermostat.manually_adjusted`
107+
- `thermostat.temperature_threshold_exceeded`
108+
- `thermostat.temperature_threshold_no_longer_exceeded`
109+
- `thermostat.temperature_reached_set_point`
110+
- `thermostat.temperature_changed`
111+
- `device.name_changed`
112+
- `enrollment_automation.deleted`
113+
- `phone.deactivated`
114+
115+
---
116+
117+
### `occurred_at`
118+
119+
Format: `Datetime`
120+
121+
Date and time at which the event occurred.
122+
123+
---
124+
125+
### `workspace_id`
126+
127+
Format: `UUID`
128+
129+
ID of the [workspace](../../core-concepts/workspaces/README.md).
130+
131+
---
132+
133+
## Endpoints
134+

0 commit comments

Comments
 (0)