Skip to content
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

Render events on route pages #476

Merged
merged 15 commits into from
Jan 7, 2025
Merged
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
29 changes: 2 additions & 27 deletions docs/api/_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,14 +178,13 @@ Items that are intentionally undocumented are not included in this section.
- `client_session`
- `connect_webview`
- `connected_account`
- `device`
- `device_provider`
- `event`
- `network`
- `noise_threshold`
- `phone`
- `service_health`
- `unmanaged_access_code`
- `unmanaged_device`
- `webhook`
- `workspace`

Expand Down Expand Up @@ -266,18 +265,6 @@ Items that are intentionally undocumented are not included in this section.
- `connected_account.errors`
- `connected_account.user_identifier`
- `connected_account.warnings`
- `device.can_hvac_cool`
- `device.can_hvac_heat`
- `device.can_hvac_heat_cool`
- `device.can_program_offline_access_codes`
- `device.can_program_online_access_codes`
- `device.can_remotely_lock`
- `device.can_remotely_unlock`
- `device.can_simulate_connection`
- `device.can_simulate_disconnection`
- `device.can_simulate_removal`
- `device.can_turn_off_hvac`
- `device.custom_metadata`
- `device_provider.can_hvac_cool`
- `device_provider.can_hvac_heat`
- `device_provider.can_hvac_heat_cool`
Expand All @@ -293,6 +280,7 @@ Items that are intentionally undocumented are not included in this section.
- `device_provider.display_name`
- `device_provider.image_url`
- `device_provider.provider_categories`
- `event.event_type`
- `network.created_at`
- `network.display_name`
- `network.network_id`
Expand Down Expand Up @@ -323,19 +311,6 @@ Items that are intentionally undocumented are not included in this section.
- `service_health.status`
- `unmanaged_access_code.is_managed`
- `unmanaged_access_code.status`
- `unmanaged_device.can_hvac_cool`
- `unmanaged_device.can_hvac_heat`
- `unmanaged_device.can_hvac_heat_cool`
- `unmanaged_device.can_program_offline_access_codes`
- `unmanaged_device.can_program_online_access_codes`
- `unmanaged_device.can_remotely_lock`
- `unmanaged_device.can_remotely_unlock`
- `unmanaged_device.can_simulate_connection`
- `unmanaged_device.can_simulate_disconnection`
- `unmanaged_device.can_simulate_removal`
- `unmanaged_device.can_turn_off_hvac`
- `unmanaged_device.is_managed`
- `unmanaged_device.properties`
- `user_identity.display_name`
- `user_identity.full_name`
- `webhook.event_types`
Expand Down
151 changes: 143 additions & 8 deletions docs/api/acs/credentials/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -213,56 +213,56 @@ Visionline-specific metadata for the credential.

<details>

<summary><code>auto_join</code> Format: <code>boolean</code></summary>
<summary><code>auto_join</code> Format: <code>Boolean</code></summary>


</details>

<details>

<summary><code>card_function_type</code> Format: <code>enum</code></summary>
<summary><code>card_function_type</code> Format: <code>Enum</code></summary>


</details>

<details>

<summary><code>card_id</code> Format: <code>string</code></summary>
<summary><code>card_id</code> Format: <code>String</code></summary>


</details>

<details>

<summary><code>common_acs_entrance_ids</code> Format: <code>list</code></summary>
<summary><code>common_acs_entrance_ids</code> Format: <code>List</code></summary>


</details>

<details>

<summary><code>credential_id</code> Format: <code>string</code></summary>
<summary><code>credential_id</code> Format: <code>String</code></summary>


</details>

<details>

<summary><code>guest_acs_entrance_ids</code> Format: <code>list</code></summary>
<summary><code>guest_acs_entrance_ids</code> Format: <code>List</code></summary>


</details>

<details>

<summary><code>is_valid</code> Format: <code>boolean</code></summary>
<summary><code>is_valid</code> Format: <code>Boolean</code></summary>


</details>

<details>

<summary><code>joiner_acs_credential_ids</code> Format: <code>list</code></summary>
<summary><code>joiner_acs_credential_ids</code> Format: <code>List</code></summary>


</details>
Expand Down Expand Up @@ -314,3 +314,138 @@ Unassigns a specified [credential](../../../capability-guides/access-systems/man
### [`/acs/credentials/update`](./update.md)

Updates the code and ends at date and time for a specified [credential](../../../capability-guides/access-systems/managing-credentials.md).

## Events

### `acs_credential.deleted`

An ACS credential was deleted.

<details>

<summary><code>acs_credential_id</code> Format: <code>ID</code></summary>

</details>

<details>

<summary><code>acs_system_id</code> Format: <code>ID</code></summary>

ID of the ACS system.

</details>

<details>

<summary><code>connected_account_id</code> Format: <code>ID</code></summary>

ID of the connected account.

</details>

<details>

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

Time at which the event was created.

</details>

<details>

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

ID of the event.

</details>

<details>

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

</details>

<details>

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

Time when the event occurred.

</details>

<details>

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

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

</details>

---

### `acs_credential.issued`

An ACS credential was issued.

<details>

<summary><code>acs_credential_id</code> Format: <code>ID</code></summary>

</details>

<details>

<summary><code>acs_system_id</code> Format: <code>ID</code></summary>

ID of the ACS system.

</details>

<details>

<summary><code>connected_account_id</code> Format: <code>ID</code></summary>

ID of the connected account.

</details>

<details>

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

Time at which the event was created.

</details>

<details>

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

ID of the event.

</details>

<details>

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

</details>

<details>

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

Time when the event occurred.

</details>

<details>

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

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

</details>

---

Loading
Loading