Skip to content

Generate /action_attempts route and all the endpoints #598

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
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/api/_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
- `/access_codes`
- `/access_codes/simulate`
- `/access_codes/unmanaged`
- `/action_attempts`
- `/bridges`
- `/client_sessions`
- `/connect_webviews`
Expand Down
293 changes: 293 additions & 0 deletions docs/api/action_attempts/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,293 @@
# Action Attempts

## `action_attempt`

Represents an attempt to perform an action against a device.

### `action_attempt_id`

Format: `UUID`

ID of the action attempt.

---

### `status`

Format: `Enum`

Possible enum values:
- `success`
- `pending`
- `error`

---

### `action_type`

Format: `String`

Type of the action attempt.

Possible enum values:
- `LOCK_DOOR`
- `UNLOCK_DOOR`
- `SCAN_CREDENTIAL`
- `ENCODE_ACCESS_METHOD`
- `ENCODE_CREDENTIAL`
- `RESET_SANDBOX_WORKSPACE`
- `SET_FAN_MODE`
- `SET_HVAC_MODE`
- `ACTIVATE_CLIMATE_PRESET`
- `SIMULATE_KEYPAD_CODE_ENTRY`
- `SIMULATE_MANUAL_LOCK_VIA_KEYPAD`
- `PUSH_THERMOSTAT_PROGRAMS`
- `SYNC_ACCESS_CODES`
- `CREATE_ACCESS_CODE`
- `DELETE_ACCESS_CODE`
- `UPDATE_ACCESS_CODE`
- `CREATE_NOISE_THRESHOLD`
- `DELETE_NOISE_THRESHOLD`
- `UPDATE_NOISE_THRESHOLD`

---

### `error`

Format: `Object`

Errors associated with the action attempt. Null for pending action attempts.

---

### `result`

Format: `Object`

Result of the action attempt. Null for pending action attempts.

---

## Endpoints


---

## Events

### `action_attempt.lock_door.succeeded`

A lock door [action attempt](../../core-concepts/action-attempts.md) succeeded.

<details>

<summary><code>action_attempt_id</code> Format: <code>UUID</code></summary>

ID of the [action attempt](../../core-concepts/action-attempts.md).
</details>
<details>

<summary><code>action_type</code> Format: <code>String</code></summary>

Type of action.
</details>
<details>

<summary><code>created_at</code> Format: <code>Datetime</code></summary>

Date and time at which the event was created.
</details>
<details>

<summary><code>event_id</code> Format: <code>UUID</code></summary>

ID of the event.
</details>
<details>

<summary><code>event_type</code> Format: <code>Enum</code></summary>

Value: `action_attempt.lock_door.succeeded`
</details>
<details>

<summary><code>occurred_at</code> Format: <code>Datetime</code></summary>

Date and time at which the event occurred.
</details>
<details>

<summary><code>status</code> Format: <code>String</code></summary>

Status of the action.
</details>
<details>

<summary><code>workspace_id</code> Format: <code>UUID</code></summary>

ID of the [workspace](../../core-concepts/workspaces/README.md).
</details>
---

### `action_attempt.lock_door.failed`

A lock door [action attempt](../../core-concepts/action-attempts.md) failed.

<details>

<summary><code>action_attempt_id</code> Format: <code>UUID</code></summary>

ID of the [action attempt](../../core-concepts/action-attempts.md).
</details>
<details>

<summary><code>action_type</code> Format: <code>String</code></summary>

Type of action.
</details>
<details>

<summary><code>created_at</code> Format: <code>Datetime</code></summary>

Date and time at which the event was created.
</details>
<details>

<summary><code>event_id</code> Format: <code>UUID</code></summary>

ID of the event.
</details>
<details>

<summary><code>event_type</code> Format: <code>Enum</code></summary>

Value: `action_attempt.lock_door.failed`
</details>
<details>

<summary><code>occurred_at</code> Format: <code>Datetime</code></summary>

Date and time at which the event occurred.
</details>
<details>

<summary><code>status</code> Format: <code>String</code></summary>

Status of the action.
</details>
<details>

<summary><code>workspace_id</code> Format: <code>UUID</code></summary>

ID of the [workspace](../../core-concepts/workspaces/README.md).
</details>
---

### `action_attempt.unlock_door.succeeded`

An unlock door [action attempt](../../core-concepts/action-attempts.md) succeeded.

<details>

<summary><code>action_attempt_id</code> Format: <code>UUID</code></summary>

ID of the [action attempt](../../core-concepts/action-attempts.md).
</details>
<details>

<summary><code>action_type</code> Format: <code>String</code></summary>

Type of action.
</details>
<details>

<summary><code>created_at</code> Format: <code>Datetime</code></summary>

Date and time at which the event was created.
</details>
<details>

<summary><code>event_id</code> Format: <code>UUID</code></summary>

ID of the event.
</details>
<details>

<summary><code>event_type</code> Format: <code>Enum</code></summary>

Value: `action_attempt.unlock_door.succeeded`
</details>
<details>

<summary><code>occurred_at</code> Format: <code>Datetime</code></summary>

Date and time at which the event occurred.
</details>
<details>

<summary><code>status</code> Format: <code>String</code></summary>

Status of the action.
</details>
<details>

<summary><code>workspace_id</code> Format: <code>UUID</code></summary>

ID of the [workspace](../../core-concepts/workspaces/README.md).
</details>
---

### `action_attempt.unlock_door.failed`

An unlock door [action attempt](../../core-concepts/action-attempts.md) failed.

<details>

<summary><code>action_attempt_id</code> Format: <code>UUID</code></summary>

ID of the [action attempt](../../core-concepts/action-attempts.md).
</details>
<details>

<summary><code>action_type</code> Format: <code>String</code></summary>

Type of action.
</details>
<details>

<summary><code>created_at</code> Format: <code>Datetime</code></summary>

Date and time at which the event was created.
</details>
<details>

<summary><code>event_id</code> Format: <code>UUID</code></summary>

ID of the event.
</details>
<details>

<summary><code>event_type</code> Format: <code>Enum</code></summary>

Value: `action_attempt.unlock_door.failed`
</details>
<details>

<summary><code>occurred_at</code> Format: <code>Datetime</code></summary>

Date and time at which the event occurred.
</details>
<details>

<summary><code>status</code> Format: <code>String</code></summary>

Status of the action.
</details>
<details>

<summary><code>workspace_id</code> Format: <code>UUID</code></summary>

ID of the [workspace](../../core-concepts/workspaces/README.md).
</details>
---

5 changes: 5 additions & 0 deletions src/data/paths.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -80,3 +80,8 @@
title: Enrollment Automations
resources:
- enrollment_automation

/action_attempts:
title: Action Attempts
resources:
- action_attempt
Loading
Loading