Skip to content

Commit 2ab2b82

Browse files
seambotseambot
committed
ci: Generate docs
1 parent ff9e195 commit 2ab2b82

2 files changed

Lines changed: 293 additions & 1 deletion

File tree

‎docs/api/_report.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@
77
- `/access_codes`
88
- `/access_codes/simulate`
99
- `/access_codes/unmanaged`
10-
- `/action_attempts`
1110
- `/bridges`
1211
- `/client_sessions`
1312
- `/connect_webviews`

‎docs/api/action_attempts/README.md‎

Lines changed: 293 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,293 @@
1+
# Action Attempts
2+
3+
## `action_attempt`
4+
5+
Represents an attempt to perform an action against a device.
6+
7+
### `action_attempt_id`
8+
9+
Format: `UUID`
10+
11+
ID of the action attempt.
12+
13+
---
14+
15+
### `status`
16+
17+
Format: `Enum`
18+
19+
Possible enum values:
20+
- `success`
21+
- `pending`
22+
- `error`
23+
24+
---
25+
26+
### `action_type`
27+
28+
Format: `String`
29+
30+
Type of the action attempt.
31+
32+
Possible enum values:
33+
- `LOCK_DOOR`
34+
- `UNLOCK_DOOR`
35+
- `SCAN_CREDENTIAL`
36+
- `ENCODE_ACCESS_METHOD`
37+
- `ENCODE_CREDENTIAL`
38+
- `RESET_SANDBOX_WORKSPACE`
39+
- `SET_FAN_MODE`
40+
- `SET_HVAC_MODE`
41+
- `ACTIVATE_CLIMATE_PRESET`
42+
- `SIMULATE_KEYPAD_CODE_ENTRY`
43+
- `SIMULATE_MANUAL_LOCK_VIA_KEYPAD`
44+
- `PUSH_THERMOSTAT_PROGRAMS`
45+
- `SYNC_ACCESS_CODES`
46+
- `CREATE_ACCESS_CODE`
47+
- `DELETE_ACCESS_CODE`
48+
- `UPDATE_ACCESS_CODE`
49+
- `CREATE_NOISE_THRESHOLD`
50+
- `DELETE_NOISE_THRESHOLD`
51+
- `UPDATE_NOISE_THRESHOLD`
52+
53+
---
54+
55+
### `error`
56+
57+
Format: `Object`
58+
59+
Errors associated with the action attempt. Null for pending action attempts.
60+
61+
---
62+
63+
### `result`
64+
65+
Format: `Object`
66+
67+
Result of the action attempt. Null for pending action attempts.
68+
69+
---
70+
71+
## Endpoints
72+
73+
74+
---
75+
76+
## Events
77+
78+
### `action_attempt.lock_door.succeeded`
79+
80+
A lock door [action attempt](../../core-concepts/action-attempts.md) succeeded.
81+
82+
<details>
83+
84+
<summary><code>action_attempt_id</code> Format: <code>UUID</code></summary>
85+
86+
ID of the [action attempt](../../core-concepts/action-attempts.md).
87+
</details>
88+
<details>
89+
90+
<summary><code>action_type</code> Format: <code>String</code></summary>
91+
92+
Type of action.
93+
</details>
94+
<details>
95+
96+
<summary><code>created_at</code> Format: <code>Datetime</code></summary>
97+
98+
Date and time at which the event was created.
99+
</details>
100+
<details>
101+
102+
<summary><code>event_id</code> Format: <code>UUID</code></summary>
103+
104+
ID of the event.
105+
</details>
106+
<details>
107+
108+
<summary><code>event_type</code> Format: <code>Enum</code></summary>
109+
110+
Value: `action_attempt.lock_door.succeeded`
111+
</details>
112+
<details>
113+
114+
<summary><code>occurred_at</code> Format: <code>Datetime</code></summary>
115+
116+
Date and time at which the event occurred.
117+
</details>
118+
<details>
119+
120+
<summary><code>status</code> Format: <code>String</code></summary>
121+
122+
Status of the action.
123+
</details>
124+
<details>
125+
126+
<summary><code>workspace_id</code> Format: <code>UUID</code></summary>
127+
128+
ID of the [workspace](../../core-concepts/workspaces/README.md).
129+
</details>
130+
---
131+
132+
### `action_attempt.lock_door.failed`
133+
134+
A lock door [action attempt](../../core-concepts/action-attempts.md) failed.
135+
136+
<details>
137+
138+
<summary><code>action_attempt_id</code> Format: <code>UUID</code></summary>
139+
140+
ID of the [action attempt](../../core-concepts/action-attempts.md).
141+
</details>
142+
<details>
143+
144+
<summary><code>action_type</code> Format: <code>String</code></summary>
145+
146+
Type of action.
147+
</details>
148+
<details>
149+
150+
<summary><code>created_at</code> Format: <code>Datetime</code></summary>
151+
152+
Date and time at which the event was created.
153+
</details>
154+
<details>
155+
156+
<summary><code>event_id</code> Format: <code>UUID</code></summary>
157+
158+
ID of the event.
159+
</details>
160+
<details>
161+
162+
<summary><code>event_type</code> Format: <code>Enum</code></summary>
163+
164+
Value: `action_attempt.lock_door.failed`
165+
</details>
166+
<details>
167+
168+
<summary><code>occurred_at</code> Format: <code>Datetime</code></summary>
169+
170+
Date and time at which the event occurred.
171+
</details>
172+
<details>
173+
174+
<summary><code>status</code> Format: <code>String</code></summary>
175+
176+
Status of the action.
177+
</details>
178+
<details>
179+
180+
<summary><code>workspace_id</code> Format: <code>UUID</code></summary>
181+
182+
ID of the [workspace](../../core-concepts/workspaces/README.md).
183+
</details>
184+
---
185+
186+
### `action_attempt.unlock_door.succeeded`
187+
188+
An unlock door [action attempt](../../core-concepts/action-attempts.md) succeeded.
189+
190+
<details>
191+
192+
<summary><code>action_attempt_id</code> Format: <code>UUID</code></summary>
193+
194+
ID of the [action attempt](../../core-concepts/action-attempts.md).
195+
</details>
196+
<details>
197+
198+
<summary><code>action_type</code> Format: <code>String</code></summary>
199+
200+
Type of action.
201+
</details>
202+
<details>
203+
204+
<summary><code>created_at</code> Format: <code>Datetime</code></summary>
205+
206+
Date and time at which the event was created.
207+
</details>
208+
<details>
209+
210+
<summary><code>event_id</code> Format: <code>UUID</code></summary>
211+
212+
ID of the event.
213+
</details>
214+
<details>
215+
216+
<summary><code>event_type</code> Format: <code>Enum</code></summary>
217+
218+
Value: `action_attempt.unlock_door.succeeded`
219+
</details>
220+
<details>
221+
222+
<summary><code>occurred_at</code> Format: <code>Datetime</code></summary>
223+
224+
Date and time at which the event occurred.
225+
</details>
226+
<details>
227+
228+
<summary><code>status</code> Format: <code>String</code></summary>
229+
230+
Status of the action.
231+
</details>
232+
<details>
233+
234+
<summary><code>workspace_id</code> Format: <code>UUID</code></summary>
235+
236+
ID of the [workspace](../../core-concepts/workspaces/README.md).
237+
</details>
238+
---
239+
240+
### `action_attempt.unlock_door.failed`
241+
242+
An unlock door [action attempt](../../core-concepts/action-attempts.md) failed.
243+
244+
<details>
245+
246+
<summary><code>action_attempt_id</code> Format: <code>UUID</code></summary>
247+
248+
ID of the [action attempt](../../core-concepts/action-attempts.md).
249+
</details>
250+
<details>
251+
252+
<summary><code>action_type</code> Format: <code>String</code></summary>
253+
254+
Type of action.
255+
</details>
256+
<details>
257+
258+
<summary><code>created_at</code> Format: <code>Datetime</code></summary>
259+
260+
Date and time at which the event was created.
261+
</details>
262+
<details>
263+
264+
<summary><code>event_id</code> Format: <code>UUID</code></summary>
265+
266+
ID of the event.
267+
</details>
268+
<details>
269+
270+
<summary><code>event_type</code> Format: <code>Enum</code></summary>
271+
272+
Value: `action_attempt.unlock_door.failed`
273+
</details>
274+
<details>
275+
276+
<summary><code>occurred_at</code> Format: <code>Datetime</code></summary>
277+
278+
Date and time at which the event occurred.
279+
</details>
280+
<details>
281+
282+
<summary><code>status</code> Format: <code>String</code></summary>
283+
284+
Status of the action.
285+
</details>
286+
<details>
287+
288+
<summary><code>workspace_id</code> Format: <code>UUID</code></summary>
289+
290+
ID of the [workspace](../../core-concepts/workspaces/README.md).
291+
</details>
292+
---
293+

0 commit comments

Comments
 (0)