diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index 47899cc97..62031cc8e 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -117,25 +117,19 @@ Warnings associated with the `acs_access_group`. <summary><code>created_at</code> Format: <code>Datetime</code></summary> Date and time at which Seam created the warning. - </details> - <details> <summary><code>message</code> Format: <code>String</code></summary> Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. - </details> - <details> <summary><code>warning_code</code> Format: <code>String</code></summary> Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. - </details> - --- ### `workspace_id` @@ -178,62 +172,46 @@ An ACS access group was deleted. <details> <summary><code>acs_access_group_id</code> Format: <code>UUID</code></summary> - </details> - <details> <summary><code>acs_system_id</code> Format: <code>UUID</code></summary> ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). - </details> - <details> <summary><code>connected_account_id</code> Format: <code>UUID</code></summary> ID of the [connected account](../../../core-concepts/connected-accounts/README.md). - </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>String</code></summary> - </details> - <details> <summary><code>occurred_at</code> Format: <code>Datetime</code></summary> Date and time at which the event occurred. - </details> - <details> <summary><code>workspace_id</code> Format: <code>UUID</code></summary> ID of the [workspace](../../../core-concepts/workspaces/README.md). - </details> - --- diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index d3c0d2dc8..1a69523ec 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -60,33 +60,23 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access- <details> <summary><code>door_names</code> Format: <code>List</code> Item format: <code>String</code></summary> - </details> - <details> <summary><code>endpoint_id</code> Format: <code>String</code></summary> - </details> - <details> <summary><code>key_id</code> Format: <code>String</code></summary> - </details> - <details> <summary><code>key_issuing_request_id</code> Format: <code>String</code></summary> - </details> - <details> <summary><code>override_guest_acs_entrance_ids</code> Format: <code>List</code> Item format: <code>String</code></summary> - </details> - --- ### `card_number` @@ -140,15 +130,11 @@ Errors associated with the [credential](../../../capability-guides/access-system <details> <summary><code>error_code</code> Format: <code>String</code></summary> - </details> - <details> <summary><code>message</code> Format: <code>String</code></summary> - </details> - --- ### `external_type` @@ -255,9 +241,7 @@ Visionline-specific metadata for the [credential](../../../capability-guides/acc <details> <summary><code>auto_join</code> Format: <code>Boolean</code></summary> - </details> - <details> <summary><code>card_function_type</code> Format: <code>Enum</code></summary> @@ -265,45 +249,31 @@ Visionline-specific metadata for the [credential](../../../capability-guides/acc Possible enum values: - `guest` - `staff` - </details> - <details> <summary><code>card_id</code> Format: <code>String</code></summary> - </details> - <details> <summary><code>common_acs_entrance_ids</code> Format: <code>List</code> Item format: <code>UUID</code></summary> - </details> - <details> <summary><code>credential_id</code> Format: <code>String</code></summary> - </details> - <details> <summary><code>guest_acs_entrance_ids</code> Format: <code>List</code> Item format: <code>UUID</code></summary> - </details> - <details> <summary><code>is_valid</code> Format: <code>Boolean</code></summary> - </details> - <details> <summary><code>joiner_acs_credential_ids</code> Format: <code>List</code> Item format: <code>UUID</code></summary> - </details> - --- ### [`warnings`](./#warnings-1) @@ -400,63 +370,47 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia <details> <summary><code>acs_credential_id</code> Format: <code>UUID</code></summary> - </details> - <details> <summary><code>acs_system_id</code> Format: <code>UUID</code></summary> ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). - </details> - <details> <summary><code>connected_account_id</code> Format: <code>UUID</code></summary> ID of the [connected account](../../../core-concepts/connected-accounts/README.md). - </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>String</code></summary> - </details> - <details> <summary><code>occurred_at</code> Format: <code>Datetime</code></summary> Date and time at which the event occurred. - </details> - <details> <summary><code>workspace_id</code> Format: <code>UUID</code></summary> ID of the [workspace](../../../core-concepts/workspaces/README.md). - </details> - --- ### `acs_credential.issued` @@ -466,63 +420,47 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia <details> <summary><code>acs_credential_id</code> Format: <code>UUID</code></summary> - </details> - <details> <summary><code>acs_system_id</code> Format: <code>UUID</code></summary> ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). - </details> - <details> <summary><code>connected_account_id</code> Format: <code>UUID</code></summary> ID of the [connected account](../../../core-concepts/connected-accounts/README.md). - </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>String</code></summary> - </details> - <details> <summary><code>occurred_at</code> Format: <code>Datetime</code></summary> Date and time at which the event occurred. - </details> - <details> <summary><code>workspace_id</code> Format: <code>UUID</code></summary> ID of the [workspace](../../../core-concepts/workspaces/README.md). - </details> - --- ### `acs_credential.reissued` @@ -532,62 +470,46 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia <details> <summary><code>acs_credential_id</code> Format: <code>UUID</code></summary> - </details> - <details> <summary><code>acs_system_id</code> Format: <code>UUID</code></summary> ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). - </details> - <details> <summary><code>connected_account_id</code> Format: <code>UUID</code></summary> ID of the [connected account](../../../core-concepts/connected-accounts/README.md). - </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>String</code></summary> - </details> - <details> <summary><code>occurred_at</code> Format: <code>Datetime</code></summary> Date and time at which the event occurred. - </details> - <details> <summary><code>workspace_id</code> Format: <code>UUID</code></summary> ID of the [workspace](../../../core-concepts/workspaces/README.md). - </details> - --- diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md index 8a6173442..2e1b40f45 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -62,25 +62,19 @@ Errors associated with the [encoder](../../../capability-guides/access-systems/w <summary><code>created_at</code> Format: <code>Datetime</code></summary> Date and time at which Seam created the error. - </details> - <details> <summary><code>error_code</code> Format: <code>String</code></summary> Unique identifier of the type of error. Enables quick recognition and categorization of the issue. - </details> - <details> <summary><code>message</code> Format: <code>String</code></summary> Detailed description of the error. Provides insights into the issue and potentially how to rectify it. - </details> - --- ### `workspace_id` @@ -116,63 +110,47 @@ An [ACS encoder](../../../capability-guides/access-systems/working-with-card-enc <summary><code>acs_encoder_id</code> Format: <code>UUID</code></summary> ID of the [ACS encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). - </details> - <details> <summary><code>acs_system_id</code> Format: <code>UUID</code></summary> ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). - </details> - <details> <summary><code>connected_account_id</code> Format: <code>UUID</code></summary> ID of the [connected account](../../../core-concepts/connected-accounts/README.md). - </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>String</code></summary> - </details> - <details> <summary><code>occurred_at</code> Format: <code>Datetime</code></summary> Date and time at which the event occurred. - </details> - <details> <summary><code>workspace_id</code> Format: <code>UUID</code></summary> ID of the [workspace](../../../core-concepts/workspaces/README.md). - </details> - --- ### `acs_encoder.removed` @@ -184,62 +162,46 @@ An [ACS encoder](../../../capability-guides/access-systems/working-with-card-enc <summary><code>acs_encoder_id</code> Format: <code>UUID</code></summary> ID of the [ACS encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). - </details> - <details> <summary><code>acs_system_id</code> Format: <code>UUID</code></summary> ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). - </details> - <details> <summary><code>connected_account_id</code> Format: <code>UUID</code></summary> ID of the [connected account](../../../core-concepts/connected-accounts/README.md). - </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>String</code></summary> - </details> - <details> <summary><code>occurred_at</code> Format: <code>Datetime</code></summary> Date and time at which the event occurred. - </details> - <details> <summary><code>workspace_id</code> Format: <code>UUID</code></summary> ID of the [workspace](../../../core-concepts/workspaces/README.md). - </details> - --- diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index bd16ae187..b1f5a2df2 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -31,15 +31,11 @@ ASSA ABLOY Vostio-specific metadata associated with the [entrance](../../../capa <details> <summary><code>door_name</code> Format: <code>String</code></summary> - </details> - <details> <summary><code>door_number</code> Format: <code>Number</code></summary> - </details> - <details> <summary><code>door_type</code> Format: <code>Enum</code></summary> @@ -49,21 +45,15 @@ Possible enum values: - `EntranceDoor` - `GuestDoor` - `Elevator` - </details> - <details> <summary><code>pms_id</code> Format: <code>String</code></summary> - </details> - <details> <summary><code>stand_open</code> Format: <code>Boolean</code></summary> - </details> - --- ### `created_at` @@ -91,9 +81,7 @@ dormakaba Community-specific metadata associated with the [entrance](../../../ca <details> <summary><code>access_point_name</code> Format: <code>String</code></summary> - </details> - --- ### `errors` @@ -109,17 +97,13 @@ Errors associated with the [entrance](../../../capability-guides/access-systems/ <summary><code>error_code</code> Format: <code>String</code></summary> Unique identifier of the type of error. Enables quick recognition and categorization of the issue. - </details> - <details> <summary><code>message</code> Format: <code>String</code></summary> Detailed description of the error. Provides insights into the issue and potentially how to rectify it. - </details> - --- ### `latch_metadata` @@ -131,27 +115,19 @@ Latch-specific metadata associated with the [entrance](../../../capability-guide <details> <summary><code>accessibility_type</code> Format: <code>String</code></summary> - </details> - <details> <summary><code>door_name</code> Format: <code>String</code></summary> - </details> - <details> <summary><code>door_type</code> Format: <code>String</code></summary> - </details> - <details> <summary><code>is_connected</code> Format: <code>Boolean</code></summary> - </details> - --- ### `salto_ks_metadata` @@ -163,51 +139,35 @@ Salto KS-specific metadata associated with the [entrance](../../../capability-gu <details> <summary><code>battery_level</code> Format: <code>String</code></summary> - </details> - <details> <summary><code>door_name</code> Format: <code>String</code></summary> - </details> - <details> <summary><code>intrusion_alarm</code> Format: <code>Boolean</code></summary> - </details> - <details> <summary><code>left_open_alarm</code> Format: <code>Boolean</code></summary> - </details> - <details> <summary><code>lock_type</code> Format: <code>String</code></summary> - </details> - <details> <summary><code>locked_state</code> Format: <code>String</code></summary> - </details> - <details> <summary><code>online</code> Format: <code>Boolean</code></summary> - </details> - <details> <summary><code>privacy_mode</code> Format: <code>Boolean</code></summary> - </details> - --- ### `salto_space_metadata` @@ -219,21 +179,15 @@ Salto Space-specific metadata associated with the [entrance](../../../capability <details> <summary><code>door_description</code> Format: <code>String</code></summary> - </details> - <details> <summary><code>door_name</code> Format: <code>String</code></summary> - </details> - <details> <summary><code>ext_door_id</code> Format: <code>String</code></summary> - </details> - --- ### `visionline_metadata` @@ -252,38 +206,26 @@ Possible enum values: - `elevator reader` - `common` - `common (PMS)` - </details> - <details> <summary><code>door_name</code> Format: <code>String</code></summary> - </details> - <details> <summary><code>profiles</code> Format: <code>List</code> Item format: <code>Object</code></summary> +- <code>visionline_door_profile_id</code> Format: <code>String</code> -<details> - -<summary><code>visionline_door_profile_id</code> Format: <code>String</code></summary> - -</details> - -<details> -<summary><code>visionline_door_profile_type</code> Format: <code>Enum</code></summary> +- <code>visionline_door_profile_type</code> Format: <code>Enum</code> -Possible enum values: -- `BLE` -- `commonDoor` -- `touch` + Possible enum values: + - `BLE` + - `commonDoor` + - `touch` </details> -</details> - --- ## Endpoints @@ -312,63 +254,47 @@ An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entra <details> <summary><code>acs_entrance_id</code> Format: <code>UUID</code></summary> - </details> - <details> <summary><code>acs_system_id</code> Format: <code>UUID</code></summary> ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). - </details> - <details> <summary><code>connected_account_id</code> Format: <code>UUID</code></summary> ID of the [connected account](../../../core-concepts/connected-accounts/README.md). - </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>String</code></summary> - </details> - <details> <summary><code>occurred_at</code> Format: <code>Datetime</code></summary> Date and time at which the event occurred. - </details> - <details> <summary><code>workspace_id</code> Format: <code>UUID</code></summary> ID of the [workspace](../../../core-concepts/workspaces/README.md). - </details> - --- ### `acs_entrance.removed` @@ -378,62 +304,46 @@ An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entra <details> <summary><code>acs_entrance_id</code> Format: <code>UUID</code></summary> - </details> - <details> <summary><code>acs_system_id</code> Format: <code>UUID</code></summary> ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). - </details> - <details> <summary><code>connected_account_id</code> Format: <code>UUID</code></summary> ID of the [connected account](../../../core-concepts/connected-accounts/README.md). - </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>String</code></summary> - </details> - <details> <summary><code>occurred_at</code> Format: <code>Datetime</code></summary> Date and time at which the event occurred. - </details> - <details> <summary><code>workspace_id</code> Format: <code>UUID</code></summary> ID of the [workspace](../../../core-concepts/workspaces/README.md). - </details> - --- diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index 12bd62e2d..bd7e6ecd5 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -160,9 +160,7 @@ Format: `Object` <summary><code>time_zone</code> Format: <code>String</code></summary> Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located. - </details> - --- ### `name` @@ -217,25 +215,19 @@ Format: `Object` <summary><code>lan_address</code> Format: <code>String</code></summary> IP address or hostname of the main Visionline server relative to [Seam Bridge](../../../capability-guides/seam-bridge.md) on the local network. - </details> - <details> <summary><code>mobile_access_uuid</code> Format: <code>String</code></summary> Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset. - </details> - <details> <summary><code>system_id</code> Format: <code>String</code></summary> Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager. - </details> - --- ### [`warnings`](./#warnings-1) @@ -338,55 +330,41 @@ An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) wa <summary><code>acs_system_id</code> Format: <code>UUID</code></summary> ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). - </details> - <details> <summary><code>connected_account_id</code> Format: <code>UUID</code></summary> ID of the [connected account](../../../core-concepts/connected-accounts/README.md). - </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>String</code></summary> - </details> - <details> <summary><code>occurred_at</code> Format: <code>Datetime</code></summary> Date and time at which the event occurred. - </details> - <details> <summary><code>workspace_id</code> Format: <code>UUID</code></summary> ID of the [workspace](../../../core-concepts/workspaces/README.md). - </details> - --- ### `acs_system.added` @@ -398,55 +376,41 @@ An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) wa <summary><code>acs_system_id</code> Format: <code>UUID</code></summary> ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). - </details> - <details> <summary><code>connected_account_id</code> Format: <code>UUID</code></summary> ID of the [connected account](../../../core-concepts/connected-accounts/README.md). - </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>String</code></summary> - </details> - <details> <summary><code>occurred_at</code> Format: <code>Datetime</code></summary> Date and time at which the event occurred. - </details> - <details> <summary><code>workspace_id</code> Format: <code>UUID</code></summary> ID of the [workspace](../../../core-concepts/workspaces/README.md). - </details> - --- ### `acs_system.disconnected` @@ -458,54 +422,40 @@ An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) wa <summary><code>acs_system_id</code> Format: <code>UUID</code></summary> ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). - </details> - <details> <summary><code>connected_account_id</code> Format: <code>UUID</code></summary> ID of the [connected account](../../../core-concepts/connected-accounts/README.md). - </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>String</code></summary> - </details> - <details> <summary><code>occurred_at</code> Format: <code>Datetime</code></summary> Date and time at which the event occurred. - </details> - <details> <summary><code>workspace_id</code> Format: <code>UUID</code></summary> ID of the [workspace](../../../core-concepts/workspaces/README.md). - </details> - --- diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index de90115c5..d30a590f5 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -19,17 +19,13 @@ Format: `Object` <summary><code>ends_at</code> Format: <code>Datetime</code></summary> Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. - </details> - <details> <summary><code>starts_at</code> Format: <code>Datetime</code></summary> Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. - </details> - --- ### `acs_system_id` @@ -304,60 +300,44 @@ An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user- <summary><code>acs_system_id</code> Format: <code>UUID</code></summary> ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). - </details> - <details> <summary><code>acs_user_id</code> Format: <code>UUID</code></summary> - </details> - <details> <summary><code>connected_account_id</code> Format: <code>UUID</code></summary> ID of the [connected account](../../../core-concepts/connected-accounts/README.md). - </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>String</code></summary> - </details> - <details> <summary><code>occurred_at</code> Format: <code>Datetime</code></summary> Date and time at which the event occurred. - </details> - <details> <summary><code>workspace_id</code> Format: <code>UUID</code></summary> ID of the [workspace](../../../core-concepts/workspaces/README.md). - </details> - --- diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index 3028245cb..e6ebc2971 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -59,15 +59,11 @@ Errors associated with the `phone`. <details> <summary><code>error_code</code> Format: <code>String</code></summary> - </details> - <details> <summary><code>message</code> Format: <code>String</code></summary> - </details> - --- ### `nickname` @@ -89,57 +85,41 @@ Properties of the phone. <summary><code>assa_abloy_credential_service_metadata</code> Format: <code>Object</code></summary> ASSA ABLOY Credential Service metadata for the phone. - </details> - <details> <summary><code>assa_abloy_credential_service_metadata.endpoints</code> Format: <code>List</code> Item format: <code>Object</code></summary> Endpoints associated with the phone. +- <code>endpoint_id</code> Format: <code>String</code> -<details> - -<summary><code>endpoint_id</code> Format: <code>String</code></summary> - -ID of the associated endpoint. + ID of the associated endpoint. -</details> - -<details> -<summary><code>is_active</code> Format: <code>Boolean</code></summary> +- <code>is_active</code> Format: <code>Boolean</code> -Indicated whether the endpoint is active. + Indicated whether the endpoint is active. </details> -</details> - <details> <summary><code>assa_abloy_credential_service_metadata.has_active_endpoint</code> Format: <code>Boolean</code></summary> Indicates whether the credential service has active endpoints associated with the phone. - </details> - <details> <summary><code>salto_space_credential_service_metadata</code> Format: <code>Object</code></summary> Salto Space credential service metadata for the phone. - </details> - <details> <summary><code>salto_space_credential_service_metadata.has_active_phone</code> Format: <code>Boolean</code></summary> Indicates whether the credential service has an active associated phone. - </details> - --- ### `warnings` @@ -153,15 +133,11 @@ Warnings associated with the `phone`. <details> <summary><code>message</code> Format: <code>String</code></summary> - </details> - <details> <summary><code>warning_code</code> Format: <code>String</code></summary> - </details> - --- ### `workspace_id` @@ -197,46 +173,34 @@ A phone device was deactivated. <summary><code>created_at</code> Format: <code>Datetime</code></summary> Date and time at which the event was created. - </details> - <details> <summary><code>device_id</code> Format: <code>UUID</code></summary> ID of the [device](../../core-concepts/devices/README.md). - </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>String</code></summary> - </details> - <details> <summary><code>occurred_at</code> Format: <code>Datetime</code></summary> Date and time at which the event occurred. - </details> - <details> <summary><code>workspace_id</code> Format: <code>UUID</code></summary> ID of the [workspace](../../core-concepts/workspaces/README.md). - </details> - --- diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md index 48b777e4f..3323b4adf 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -49,17 +49,13 @@ Errors associated with the [thermostat schedule](../../../capability-guides/ther <summary><code>error_code</code> Format: <code>String</code></summary> Unique identifier of the type of error. Enables quick recognition and categorization of the issue. - </details> - <details> <summary><code>message</code> Format: <code>String</code></summary> Detailed description of the error. Provides insights into the issue and potentially how to rectify it. - </details> - --- ### `max_override_period_minutes` diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md index f27a87236..04899ddf7 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -72,46 +72,34 @@ An [enrollment automation](../../../capability-guides/mobile-access/issuing-mobi <summary><code>created_at</code> Format: <code>Datetime</code></summary> Date and time at which the event was created. - </details> - <details> <summary><code>enrollment_automation_id</code> Format: <code>UUID</code></summary> ID of the [enrollment automation](../../../capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system.md#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut). - </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>String</code></summary> - </details> - <details> <summary><code>occurred_at</code> Format: <code>Datetime</code></summary> Date and time at which the event occurred. - </details> - <details> <summary><code>workspace_id</code> Format: <code>UUID</code></summary> ID of the [workspace](../../../core-concepts/workspaces/README.md). - </details> - --- diff --git a/src/layouts/api-route.hbs b/src/layouts/api-route.hbs index 5bea8e43e..e84975e6f 100644 --- a/src/layouts/api-route.hbs +++ b/src/layouts/api-route.hbs @@ -48,7 +48,7 @@ {{/if}} {{#each properties}} -{{> property-details }} +{{> property-collapsible this}} {{/each}} --- diff --git a/src/layouts/partials/api-resource.hbs b/src/layouts/partials/api-resource.hbs index 6e41f9731..6f432d754 100644 --- a/src/layouts/partials/api-resource.hbs +++ b/src/layouts/partials/api-resource.hbs @@ -42,14 +42,14 @@ This object has no properties. {{else}} {{#each objectProperties}} -{{> property-details }} +{{> property-collapsible this}} {{/each}} {{/if}} {{/unless}} {{#if listProperties}} {{#each listProperties}} -{{> property-details }} +{{> property-collapsible this}} {{/each}} {{/if}} diff --git a/src/layouts/partials/property-collapsible.hbs b/src/layouts/partials/property-collapsible.hbs new file mode 100644 index 000000000..7db38f980 --- /dev/null +++ b/src/layouts/partials/property-collapsible.hbs @@ -0,0 +1,5 @@ +<details> + +<summary><code>{{name}}</code> Format: <code>{{format}}</code>{{#if listItemFormat}} Item format: <code>{{listItemFormat}}</code>{{/if}}</summary> +{{> property-content}} +</details> \ No newline at end of file diff --git a/src/layouts/partials/property-details.hbs b/src/layouts/partials/property-content.hbs similarity index 55% rename from src/layouts/partials/property-details.hbs rename to src/layouts/partials/property-content.hbs index ee296e6e6..07866a381 100644 --- a/src/layouts/partials/property-details.hbs +++ b/src/layouts/partials/property-content.hbs @@ -1,26 +1,21 @@ -<details> - -<summary><code>{{name}}</code> Format: <code>{{format}}</code>{{#if listItemFormat}} Item format: <code>{{listItemFormat}}</code>{{/if}}</summary> {{#if isDeprecated}} {{> deprecated-warning}} {{/if}} - {{#if description}} -{{description}} +{{description}} {{/if}} {{#if enumValues}} + Possible enum values: {{#each enumValues}} - `{{this}}` {{/each}} - {{/if}} {{#if listProperties}} {{#each listProperties}} -{{> property-details }} +- {{> property-nested this}} {{/each}} -{{/if}} -</details> +{{/if}} \ No newline at end of file diff --git a/src/layouts/partials/property-nested-internal.hbs b/src/layouts/partials/property-nested-internal.hbs new file mode 100644 index 000000000..4b59f0076 --- /dev/null +++ b/src/layouts/partials/property-nested-internal.hbs @@ -0,0 +1,15 @@ +{{#if isDeprecated}} + + {{> deprecated-warning}} +{{/if}} +{{#if description}} + + {{description}} +{{/if}} +{{#if enumValues}} + + Possible enum values: +{{#each enumValues}} + - `{{this}}` +{{/each}} +{{/if}} \ No newline at end of file diff --git a/src/layouts/partials/property-nested.hbs b/src/layouts/partials/property-nested.hbs new file mode 100644 index 000000000..92689d8b6 --- /dev/null +++ b/src/layouts/partials/property-nested.hbs @@ -0,0 +1,8 @@ +<code>{{name}}</code> Format: <code>{{format}}</code>{{#if listItemFormat}} Item format: <code>{{listItemFormat}}</code>{{/if}} +{{> property-nested-internal}} +{{#if listProperties}} +{{#each listProperties}} + +- {{> property-nested this}} +{{/each}} +{{/if}} \ No newline at end of file