Generate /action_attempts route and all the endpoints

.gitbook.yaml

@@ -76,8 +76,8 @@ redirects:
   api-clients/access-control-systems/users/update-user: api/acs/users/update.md
   api-clients/access-control-systems/users: api/acs/users/README.md
   api-clients/access-control-systems: api/acs/README.md
-  api-clients/action-attempt/get-action-attempt: api-clients/action_attempts/get.md
-  api-clients/action-attempt: api-clients/action_attempts/README.md
+  api-clients/action-attempt/get-action-attempt: api/action_attempts/get.md
+  api-clients/action-attempt: api/action_attempts/README.md
   api-clients/client-sessions/create-a-client-session: api/client_sessions/create.md
   api-clients/client-sessions/delete-a-client-session: api/client_sessions/delete.md
   api-clients/client-sessions/get-a-client-session: api/client_sessions/get.md

docs/SUMMARY.md

@@ -226,8 +226,8 @@
   * [Encode an Access Method](api/access_methods/encode.md)
   * [Get an Access Method](api/access_methods/get.md)
   * [List Access Methods](api/access_methods/list.md)
-* [Action Attempts](api-clients/action_attempts/README.md)
-  * [Get Action Attempt](api-clients/action_attempts/get.md)
+* [Action Attempts](api/action_attempts/README.md)
+  * [Get Action Attempt](api/action_attempts/get.md)
 * [Client Sessions](api/client_sessions/README.md)
   * [Create a Client Session](api/client_sessions/create.md)
   * [Delete a Client Session](api/client_sessions/delete.md)

docs/api-overview/overview.md

@@ -30,5 +30,5 @@ See the following reference topics:
 ## Monitoring
 
 * [Events](../api-clients/events/)
-* [Action Attempts](../api-clients/action_attempts/)
+* [Action Attempts](../api/action_attempts/)
 * [Connected Accounts](../api/connected_accounts/)

docs/api/action_attempts/README.md

@@ -0,0 +1,274 @@
+# Action Attempts
+
+## The action_attempt Object
+
+- [Properties](./#properties)
+- [Events](./#events)
+
+
+Represents an attempt to perform an action against a device.
+
+---
+## Properties
+
+**`action_attempt_id`** *UUID*
+
+ID of the action attempt.
+
+
+
+
+---
+
+**`status`** *Enum*
+
+
+
+<details>
+<summary>Enum values</summary>
+
+- <code>success</code>
+- <code>pending</code>
+- <code>error</code>
+</details>
+
+
+---
+
+**`action_type`** *String*
+
+Type of the action attempt.
+
+
+<details>
+<summary>Enum values</summary>
+
+- <code>LOCK_DOOR</code>
+- <code>UNLOCK_DOOR</code>
+- <code>SCAN_CREDENTIAL</code>
+- <code>ENCODE_CREDENTIAL</code>
+- <code>RESET_SANDBOX_WORKSPACE</code>
+- <code>SET_FAN_MODE</code>
+- <code>SET_HVAC_MODE</code>
+- <code>ACTIVATE_CLIMATE_PRESET</code>
+- <code>SIMULATE_KEYPAD_CODE_ENTRY</code>
+- <code>SIMULATE_MANUAL_LOCK_VIA_KEYPAD</code>
+- <code>PUSH_THERMOSTAT_PROGRAMS</code>
+- <code>SYNC_ACCESS_CODES</code>
+- <code>CREATE_ACCESS_CODE</code>
+- <code>DELETE_ACCESS_CODE</code>
+- <code>UPDATE_ACCESS_CODE</code>
+- <code>CREATE_NOISE_THRESHOLD</code>
+- <code>DELETE_NOISE_THRESHOLD</code>
+- <code>UPDATE_NOISE_THRESHOLD</code>
+</details>
+
+
+---
+
+**`error`** *Object*
+
+Errors associated with the action attempt. Null for pending action attempts.
+
+
+
+
+---
+
+**`result`** *Object*
+
+Result of the action attempt. Null for pending action attempts.
+
+
+
+
+---
+
+
+## Events
+
+**`action_attempt.lock_door.succeeded`**
+
+A lock door [action attempt](../../core-concepts/action-attempts.md) succeeded.
+
+<details>
+
+<summary>Properties</summary>
+
+<strong><code>action_attempt_id</code></strong> <i>UUID</i>
+
+  ID of the affected action attempt.
+
+<strong><code>action_type</code></strong> <i>String</i>
+
+  Type of the action.
+
+<strong><code>created_at</code></strong> <i>Datetime</i>
+
+  Date and time at which the event was created.
+
+<strong><code>event_id</code></strong> <i>UUID</i>
+
+  ID of the event.
+
+<strong><code>event_type</code></strong> <i>Enum</i>
+
+  Value: `action_attempt.lock_door.succeeded`
+
+<strong><code>occurred_at</code></strong> <i>Datetime</i>
+
+  Date and time at which the event occurred.
+
+<strong><code>status</code></strong> <i>String</i>
+
+  Status of the action.
+
+<strong><code>workspace_id</code></strong> <i>UUID</i>
+
+  ID of the [workspace](../../core-concepts/workspaces/README.md) associated with the event.
+</details>
+
+---
+
+**`action_attempt.lock_door.failed`**
+
+A lock door [action attempt](../../core-concepts/action-attempts.md) failed.
+
+<details>
+
+<summary>Properties</summary>
+
+<strong><code>action_attempt_id</code></strong> <i>UUID</i>
+
+  ID of the affected action attempt.
+
+<strong><code>action_type</code></strong> <i>String</i>
+
+  Type of the action.
+
+<strong><code>created_at</code></strong> <i>Datetime</i>
+
+  Date and time at which the event was created.
+
+<strong><code>event_id</code></strong> <i>UUID</i>
+
+  ID of the event.
+
+<strong><code>event_type</code></strong> <i>Enum</i>
+
+  Value: `action_attempt.lock_door.failed`
+
+<strong><code>occurred_at</code></strong> <i>Datetime</i>
+
+  Date and time at which the event occurred.
+
+<strong><code>status</code></strong> <i>String</i>
+
+  Status of the action.
+
+<strong><code>workspace_id</code></strong> <i>UUID</i>
+
+  ID of the [workspace](../../core-concepts/workspaces/README.md) associated with the event.
+</details>
+
+---
+
+**`action_attempt.unlock_door.succeeded`**
+
+An unlock door [action attempt](../../core-concepts/action-attempts.md) succeeded.
+
+<details>
+
+<summary>Properties</summary>
+
+<strong><code>action_attempt_id</code></strong> <i>UUID</i>
+
+  ID of the affected action attempt.
+
+<strong><code>action_type</code></strong> <i>String</i>
+
+  Type of the action.
+
+<strong><code>created_at</code></strong> <i>Datetime</i>
+
+  Date and time at which the event was created.
+
+<strong><code>event_id</code></strong> <i>UUID</i>
+
+  ID of the event.
+
+<strong><code>event_type</code></strong> <i>Enum</i>
+
+  Value: `action_attempt.unlock_door.succeeded`
+
+<strong><code>occurred_at</code></strong> <i>Datetime</i>
+
+  Date and time at which the event occurred.
+
+<strong><code>status</code></strong> <i>String</i>
+
+  Status of the action.
+
+<strong><code>workspace_id</code></strong> <i>UUID</i>
+
+  ID of the [workspace](../../core-concepts/workspaces/README.md) associated with the event.
+</details>
+
+---
+
+**`action_attempt.unlock_door.failed`**
+
+An unlock door [action attempt](../../core-concepts/action-attempts.md) failed.
+
+<details>
+
+<summary>Properties</summary>
+
+<strong><code>action_attempt_id</code></strong> <i>UUID</i>
+
+  ID of the affected action attempt.
+
+<strong><code>action_type</code></strong> <i>String</i>
+
+  Type of the action.
+
+<strong><code>created_at</code></strong> <i>Datetime</i>
+
+  Date and time at which the event was created.
+
+<strong><code>event_id</code></strong> <i>UUID</i>
+
+  ID of the event.
+
+<strong><code>event_type</code></strong> <i>Enum</i>
+
+  Value: `action_attempt.unlock_door.failed`
+
+<strong><code>occurred_at</code></strong> <i>Datetime</i>
+
+  Date and time at which the event occurred.
+
+<strong><code>status</code></strong> <i>String</i>
+
+  Status of the action.
+
+<strong><code>workspace_id</code></strong> <i>UUID</i>
+
+  ID of the [workspace](../../core-concepts/workspaces/README.md) associated with the event.
+</details>
+
+---
+
+## Endpoints
+
+
+[**`/action_attempts/get`**](./get.md)
+
+Returns a specified [action attempt](../../core-concepts/action-attempts.md).
+
+
+[**`/action_attempts/list`**](./list.md)
+
+Returns a list of the [action attempts](../../core-concepts/action-attempts.md) that you specify as an array of `action_attempt_id`s.
+
+