From 0bde8724aba69f56e487196efb516eb7c4072ec1 Mon Sep 17 00:00:00 2001
From: Andrii Balitskyi <10balian10@gmail.com>
Date: Thu, 20 Mar 2025 14:51:10 +0100
Subject: [PATCH 01/18] Avoid nested details tags
---
src/layouts/api-route.hbs | 2 +-
src/layouts/partials/api-resource.hbs | 4 ++--
src/layouts/partials/property-collapsible.hbs | 7 +++++++
...perty-details.hbs => property-content.hbs} | 19 ++++++++++++------
.../partials/property-nested-internal.hbs | 15 ++++++++++++++
src/layouts/partials/property-nested.hbs | 20 +++++++++++++++++++
6 files changed, 58 insertions(+), 9 deletions(-)
create mode 100644 src/layouts/partials/property-collapsible.hbs
rename src/layouts/partials/{property-details.hbs => property-content.hbs} (52%)
create mode 100644 src/layouts/partials/property-nested-internal.hbs
create mode 100644 src/layouts/partials/property-nested.hbs
diff --git a/src/layouts/api-route.hbs b/src/layouts/api-route.hbs
index 5274b67d..5ccea7ab 100644
--- a/src/layouts/api-route.hbs
+++ b/src/layouts/api-route.hbs
@@ -48,7 +48,7 @@
{{/if}}
{{#each properties}}
-{{> property-details this}}
+{{> property-collapsible this}}
{{/each}}
---
diff --git a/src/layouts/partials/api-resource.hbs b/src/layouts/partials/api-resource.hbs
index 86205b41..6f432d75 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 this}}
+{{> property-collapsible this}}
{{/each}}
{{/if}}
{{/unless}}
{{#if listProperties}}
{{#each listProperties}}
-{{> property-details this}}
+{{> 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 00000000..0c3bfb4f
--- /dev/null
+++ b/src/layouts/partials/property-collapsible.hbs
@@ -0,0 +1,7 @@
+
+
+{{name}} Format: {{format}}{{#if listItemFormat}} Item format: {{listItemFormat}}{{/if}}
+
+{{> property-content}}
+
+
diff --git a/src/layouts/partials/property-details.hbs b/src/layouts/partials/property-content.hbs
similarity index 52%
rename from src/layouts/partials/property-details.hbs
rename to src/layouts/partials/property-content.hbs
index 919ab20f..2de829c8 100644
--- a/src/layouts/partials/property-details.hbs
+++ b/src/layouts/partials/property-content.hbs
@@ -1,6 +1,3 @@
-
-
-{{name}} Format: {{format}}{{#if listItemFormat}} Item format: {{listItemFormat}}{{/if}}
{{#if isDeprecated}}
{{> deprecated-warning}}
@@ -17,10 +14,20 @@ Possible enum values:
{{/each}}
{{/if}}
+{{#unless (eq objectProperties undefined)}}
+{{#if (eq objectProperties.length 0)}}
+
+This object has no properties.
+{{else}}
+{{#each objectProperties}}
+
+{{> property-nested this}}
+{{/each}}
+{{/if}}
+{{/unless}}
{{#if listProperties}}
{{#each listProperties}}
-{{> property-details this}}
+{{> property-nested this}}
{{/each}}
-{{/if}}
-
+{{/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 00000000..806863a4
--- /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 00000000..c077fac9
--- /dev/null
+++ b/src/layouts/partials/property-nested.hbs
@@ -0,0 +1,20 @@
+**{{name}}** Format: {{format}}{{#if listItemFormat}} Item format: {{listItemFormat}}{{/if}}
+{{> property-nested-internal}}
+
+{{#unless (eq objectProperties undefined)}}
+{{#if (eq objectProperties.length 0)}}
+
+This object has no properties.
+{{else}}
+{{#each objectProperties}}
+
+{{> property-nested this}}
+{{/each}}
+{{/if}}
+{{/unless}}
+{{#if listProperties}}
+{{#each listProperties}}
+
+{{> property-nested this}}
+{{/each}}
+{{/if}}
\ No newline at end of file
From 6895ff499bf6d08f0560040970c41c30337591ac Mon Sep 17 00:00:00 2001
From: Seam Bot
Date: Thu, 20 Mar 2025 13:52:13 +0000
Subject: [PATCH 02/18] ci: Generate docs
---
docs/api/acs/access_groups/README.md | 22 +
docs/api/acs/credentials/README.md | 78 ++
docs/api/acs/encoders/README.md | 38 +
docs/api/acs/encoders/encode_credential.md | 173 ++-
docs/api/acs/encoders/scan_credential.md | 987 ++++++++++++++++--
docs/api/acs/entrances/README.md | 93 +-
docs/api/acs/systems/README.md | 50 +
docs/api/acs/users/README.md | 20 +
docs/api/phones/README.md | 70 +-
.../thermostats/activate_climate_preset.md | 4 +
docs/api/thermostats/cool.md | 4 +
docs/api/thermostats/heat.md | 4 +
docs/api/thermostats/heat_cool.md | 4 +
docs/api/thermostats/off.md | 4 +
docs/api/thermostats/schedules/README.md | 4 +
docs/api/thermostats/set_fan_mode.md | 4 +
docs/api/thermostats/set_hvac_mode.md | 4 +
.../enrollment_automations/README.md | 12 +
18 files changed, 1441 insertions(+), 134 deletions(-)
diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md
index afbc61aa..62299169 100644
--- a/docs/api/acs/access_groups/README.md
+++ b/docs/api/acs/access_groups/README.md
@@ -113,24 +113,30 @@ Warnings associated with the `acs_access_group`.
created_at Format: Datetime
+
Date and time at which Seam created the warning.
+
message Format: String
+
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+
warning_code Format: String
+
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+
---
@@ -176,60 +182,76 @@ An ACS access group was deleted.
acs_access_group_id Format: UUID
+
+
acs_system_id Format: UUID
+
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
+
connected_account_id Format: UUID
+
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
+
created_at Format: Datetime
+
Date and time at which the event was created.
+
event_id Format: UUID
+
ID of the event.
+
event_type Format: String
+
+
occurred_at Format: Datetime
+
Date and time at which the event occurred.
+
workspace_id Format: UUID
+
ID of the [workspace](../../../core-concepts/workspaces/README.md).
+
---
diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md
index 564bcd03..2c62854a 100644
--- a/docs/api/acs/credentials/README.md
+++ b/docs/api/acs/credentials/README.md
@@ -57,30 +57,40 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access-
door_names Format: List Item format: String
+
+
endpoint_id Format: String
+
+
key_id Format: String
+
+
key_issuing_request_id Format: String
+
+
override_guest_acs_entrance_ids Format: List Item format: String
+
+
---
@@ -137,12 +147,16 @@ Errors associated with the [credential](../../../capability-guides/access-system
error_code Format: String
+
+
message Format: String
+
+
---
@@ -252,52 +266,68 @@ Visionline-specific metadata for the [credential](../../../capability-guides/acc
auto_join Format: Boolean
+
+
card_function_type Format: Enum
+
Possible enum values:
- `guest`
- `staff`
+
card_id Format: String
+
+
common_acs_entrance_ids Format: List Item format: UUID
+
+
credential_id Format: String
+
+
guest_acs_entrance_ids Format: List Item format: UUID
+
+
is_valid Format: Boolean
+
+
joiner_acs_credential_ids Format: List Item format: UUID
+
+
---
@@ -397,60 +427,76 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia
acs_credential_id Format: UUID
+
+
acs_system_id Format: UUID
+
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
+
connected_account_id Format: UUID
+
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
+
created_at Format: Datetime
+
Date and time at which the event was created.
+
event_id Format: UUID
+
ID of the event.
+
event_type Format: String
+
+
occurred_at Format: Datetime
+
Date and time at which the event occurred.
+
workspace_id Format: UUID
+
ID of the [workspace](../../../core-concepts/workspaces/README.md).
+
---
@@ -463,60 +509,76 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia
acs_credential_id Format: UUID
+
+
acs_system_id Format: UUID
+
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
+
connected_account_id Format: UUID
+
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
+
created_at Format: Datetime
+
Date and time at which the event was created.
+
event_id Format: UUID
+
ID of the event.
+
event_type Format: String
+
+
occurred_at Format: Datetime
+
Date and time at which the event occurred.
+
workspace_id Format: UUID
+
ID of the [workspace](../../../core-concepts/workspaces/README.md).
+
---
@@ -529,60 +591,76 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia
acs_credential_id Format: UUID
+
+
acs_system_id Format: UUID
+
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
+
connected_account_id Format: UUID
+
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
+
created_at Format: Datetime
+
Date and time at which the event was created.
+
event_id Format: UUID
+
ID of the event.
+
event_type Format: String
+
+
occurred_at Format: Datetime
+
Date and time at which the event occurred.
+
workspace_id Format: UUID
+
ID of the [workspace](../../../core-concepts/workspaces/README.md).
+
---
diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md
index c1e2997f..e4183472 100644
--- a/docs/api/acs/encoders/README.md
+++ b/docs/api/acs/encoders/README.md
@@ -48,24 +48,30 @@ Errors associated with the [encoder](../../../capability-guides/access-systems/w
created_at Format: Datetime
+
Date and time at which Seam created the error.
+
error_code Format: String
+
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
message Format: String
+
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
---
@@ -102,62 +108,78 @@ An [ACS encoder](../../../capability-guides/access-systems/working-with-card-enc
acs_encoder_id Format: UUID
+
ID of the [ACS encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
+
acs_system_id Format: UUID
+
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
+
connected_account_id Format: UUID
+
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
+
created_at Format: Datetime
+
Date and time at which the event was created.
+
event_id Format: UUID
+
ID of the event.
+
event_type Format: String
+
+
occurred_at Format: Datetime
+
Date and time at which the event occurred.
+
workspace_id Format: UUID
+
ID of the [workspace](../../../core-concepts/workspaces/README.md).
+
---
@@ -170,62 +192,78 @@ An [ACS encoder](../../../capability-guides/access-systems/working-with-card-enc
acs_encoder_id Format: UUID
+
ID of the [ACS encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
+
acs_system_id Format: UUID
+
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
+
connected_account_id Format: UUID
+
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
+
created_at Format: Datetime
+
Date and time at which the event was created.
+
event_id Format: UUID
+
ID of the event.
+
event_type Format: String
+
+
occurred_at Format: Datetime
+
Date and time at which the event occurred.
+
workspace_id Format: UUID
+
ID of the [workspace](../../../core-concepts/workspaces/README.md).
+
---
diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md
index 4ff61ba9..7f49eb56 100644
--- a/docs/api/acs/encoders/encode_credential.md
+++ b/docs/api/acs/encoders/encode_credential.md
@@ -62,12 +62,15 @@ Format: `Object`
message Format: String
+
+
type Format: Enum
+
Possible enum values:
- `uncategorized_error`
- `action_attempt_expired`
@@ -75,6 +78,7 @@ Possible enum values:
- `incompatible_card_format`
- `credential_cannot_be_reissued`
+
---
@@ -89,6 +93,7 @@ Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/acces
access_method Format: Enum
+
Access method for the [credential](../../../capability-guides/access-systems/managing-credentials.md). Supported values: `code`, `card`, `mobile_key`.
Possible enum values:
@@ -96,140 +101,197 @@ Possible enum values:
- `card`
- `mobile_key`
+
acs_credential_id Format: UUID
+
ID of the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
acs_credential_pool_id Format: UUID
+
+
acs_system_id Format: UUID
+
ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
acs_user_id Format: UUID
+
ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](../../../capability-guides/access-systems/managing-credentials.md) belongs.
+
assa_abloy_vostio_metadata Format: Object
+
Vostio-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+**door_names** Format: List Item format: String
+
+
+
+
+**endpoint_id** Format: String
+
+
+
+
+**key_id** Format: String
+
+
+
+
+**key_issuing_request_id** Format: String
+
+
+
+
+**override_guest_acs_entrance_ids** Format: List Item format: String
+
+
+
+
assa_abloy_vostio_metadata.door_names Format: List Item format: String
+
+
assa_abloy_vostio_metadata.endpoint_id Format: String
+
+
assa_abloy_vostio_metadata.key_id Format: String
+
+
assa_abloy_vostio_metadata.key_issuing_request_id Format: String
+
+
assa_abloy_vostio_metadata.override_guest_acs_entrance_ids Format: List Item format: String
+
+
card_number Format: String
+
Number of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
code Format: String
+
Access (PIN) code for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
created_at Format: Datetime
+
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was created.
+
display_name Format: String
+
Display name that corresponds to the [credential](../../../capability-guides/access-systems/managing-credentials.md) type.
+
ends_at Format: String
+
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
+
errors Format: List Item format: Object
+
Errors associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
+**error_code** Format: String
-error_code Format: String
-
-
-message Format: String
+**message** Format: String
+
+
+
-
external_type Format: Enum
+
Brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.
Possible enum values:
@@ -241,172 +303,249 @@ Possible enum values:
- `assa_abloy_vostio_key`
- `salto_space_key`
+
external_type_display_name Format: String
+
Display name that corresponds to the brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type.
+
is_issued Format: Boolean
+
Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been encoded onto a card.
+
is_latest_desired_state_synced_with_provider Format: Boolean
+
Indicates whether the latest state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been synced from Seam to the provider.
+
is_managed Format: Boolean
+
+
is_multi_phone_sync_credential Format: Boolean
+
Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).
+
is_one_time_use Format: Boolean
+
Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) can only be used once. If `true`, the code becomes invalid after the first use.
+
issued_at Format: Datetime
+
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was encoded onto a card.
+
latest_desired_state_synced_with_provider_at Format: Datetime
+
Date and time at which the state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) was most recently synced from Seam to the provider.
+
parent_acs_credential_id Format: UUID
+
ID of the parent [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
starts_at Format: String
+
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+
visionline_metadata Format: Object
+
Visionline-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+**auto_join** Format: Boolean
+
+
+
+
+**card_function_type** Format: Enum
+
+
+Possible enum values:
+- `guest`
+- `staff`
+
+
+**card_id** Format: String
+
+
+
+
+**common_acs_entrance_ids** Format: List Item format: UUID
+
+
+
+
+**credential_id** Format: String
+
+
+
+
+**guest_acs_entrance_ids** Format: List Item format: UUID
+
+
+
+
+**is_valid** Format: Boolean
+
+
+
+
+**joiner_acs_credential_ids** Format: List Item format: UUID
+
+
+
+
visionline_metadata.auto_join Format: Boolean
+
+
visionline_metadata.card_function_type Format: Enum
+
Possible enum values:
- `guest`
- `staff`
+
visionline_metadata.card_id Format: String
+
+
visionline_metadata.common_acs_entrance_ids Format: List Item format: UUID
+
+
visionline_metadata.credential_id Format: String
+
+
visionline_metadata.guest_acs_entrance_ids Format: List Item format: UUID
+
+
visionline_metadata.is_valid Format: Boolean
+
+
visionline_metadata.joiner_acs_credential_ids Format: List Item format: UUID
+
+
warnings Format: List Item format: Object
+
Warnings associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-created_at Format: Datetime
+**created_at** Format: Datetime
Date and time at which Seam created the warning.
-
-
-message Format: String
+**message** Format: String
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
-
-
-warning_code Format: Enum
+**warning_code** Format: Enum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
@@ -418,15 +557,17 @@ Possible enum values:
- `unknown_issue_with_acs_credential`
- `needs_to_be_reissued`
-
+
workspace_id Format: UUID
+
ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
---
diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md
index cbe3e050..c3558d7f 100644
--- a/docs/api/acs/encoders/scan_credential.md
+++ b/docs/api/acs/encoders/scan_credential.md
@@ -53,184 +53,825 @@ Format: `Object`
message Format: String
+
+
type Format: Enum
+
Possible enum values:
- `uncategorized_error`
- `action_attempt_expired`
- `no_credential_on_encoder`
+
+
+
+---
+
+#### `result`
+
+Format: `Object`
+
+
+
+acs_credential_on_encoder Format: Object
+
+
+Snapshot of credential data read from physical encoder.
+
+
+**card_number** Format: String
+
+A number or string that physically identifies the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+
+
+**created_at** Format: Datetime
+
+Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was created.
+
+
+
+**ends_at** Format: Datetime
+
+Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) will stop being usable.
+
+
+
+**is_issued** Format: Boolean
+
+
+
+
+**starts_at** Format: Datetime
+
+Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) becomes usable.
+
+
+
+**visionline_metadata** Format: Object
+
+Visionline-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+
+
+**cancelled** Format: Boolean
+
+Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is cancelled.
+
+
+
+**card_format** Format: Enum
+
+Format of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+Possible enum values:
+- `TLCode`
+- `rfid48`
+
+
+**card_holder** Format: String
+
+Holden of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+
+
+**card_id** Format: String
+
+Card ID for the Visionline card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+
+
+**common_acs_entrance_ids** Format: List Item format: UUID
+
+IDs of the common [entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md) for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+
+
+**discarded** Format: Boolean
+
+Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is discarded.
+
+
+
+**expired** Format: Boolean
+
+Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is expired.
+
+
+
+**guest_acs_entrance_ids** Format: List Item format: UUID
+
+IDs of the guest [entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md) for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+
+
+**number_of_issued_cards** Format: Number
+
+Number of issued cards associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+
+
+**overridden** Format: Boolean
+
+Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is overridden.
+
+
+
+**overwritten** Format: Boolean
+
+Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is overwritten.
+
+
+
+**pending_auto_update** Format: Boolean
+
+Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is pending auto-update.
+
+
+
+**visionline_metadata.cancelled** Format: Boolean
+
+Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is cancelled.
+
+
+
+**visionline_metadata.card_format** Format: Enum
+
+Format of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+Possible enum values:
+- `TLCode`
+- `rfid48`
+
+
+**visionline_metadata.card_holder** Format: String
+
+Holden of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+
+
+**visionline_metadata.card_id** Format: String
+
+Card ID for the Visionline card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+
+
+**visionline_metadata.common_acs_entrance_ids** Format: List Item format: UUID
+
+IDs of the common [entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md) for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+
+
+**visionline_metadata.discarded** Format: Boolean
+
+Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is discarded.
+
+
+
+**visionline_metadata.expired** Format: Boolean
+
+Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is expired.
+
+
+
+**visionline_metadata.guest_acs_entrance_ids** Format: List Item format: UUID
+
+IDs of the guest [entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md) for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+
+
+**visionline_metadata.number_of_issued_cards** Format: Number
+
+Number of issued cards associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+
+
+**visionline_metadata.overridden** Format: Boolean
+
+Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is overridden.
+
+
+
+**visionline_metadata.overwritten** Format: Boolean
+
+Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is overwritten.
+
+
+
+**visionline_metadata.pending_auto_update** Format: Boolean
+
+Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is pending auto-update.
+
+
+
+
+
+
+
+acs_credential_on_encoder.card_number Format: String
+
+
+A number or string that physically identifies the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+
+
+
+
+
+acs_credential_on_encoder.created_at Format: Datetime
+
+
+Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was created.
+
+
+
+
+
+
+acs_credential_on_encoder.ends_at Format: Datetime
+
+
+Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) will stop being usable.
+
+
+
+
+
+
+acs_credential_on_encoder.is_issued Format: Boolean
+
+
+
+
+
+
+
+acs_credential_on_encoder.starts_at Format: Datetime
+
+
+Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) becomes usable.
+
+
----
+
+
+acs_credential_on_encoder.visionline_metadata Format: Object
+
+
+Visionline-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+
+**cancelled** Format: Boolean
+
+Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is cancelled.
+
+
+
+**card_format** Format: Enum
+
+Format of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+Possible enum values:
+- `TLCode`
+- `rfid48`
+
+
+**card_holder** Format: String
+
+Holden of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+
+
+**card_id** Format: String
+
+Card ID for the Visionline card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+
+
+**common_acs_entrance_ids** Format: List Item format: UUID
+
+IDs of the common [entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md) for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+
+
+**discarded** Format: Boolean
+
+Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is discarded.
+
+
+
+**expired** Format: Boolean
+
+Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is expired.
+
+
+
+**guest_acs_entrance_ids** Format: List Item format: UUID
+
+IDs of the guest [entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md) for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+
+
+**number_of_issued_cards** Format: Number
+
+Number of issued cards associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+
+
+**overridden** Format: Boolean
+
+Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is overridden.
+
+
+
+**overwritten** Format: Boolean
+
+Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is overwritten.
+
+
+
+**pending_auto_update** Format: Boolean
+
+Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is pending auto-update.
+
+
+
+
+
+
+
+acs_credential_on_encoder.visionline_metadata.cancelled Format: Boolean
+
+
+Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is cancelled.
+
+
+
+
+
+
+acs_credential_on_encoder.visionline_metadata.card_format Format: Enum
+
+
+Format of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+Possible enum values:
+- `TLCode`
+- `rfid48`
+
+
+
+
+
+
+acs_credential_on_encoder.visionline_metadata.card_holder Format: String
+
+
+Holden of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+
+
+
+
+
+acs_credential_on_encoder.visionline_metadata.card_id Format: String
+
+
+Card ID for the Visionline card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+
+
+
+
+
+acs_credential_on_encoder.visionline_metadata.common_acs_entrance_ids Format: List Item format: UUID
+
+
+IDs of the common [entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md) for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+
+
+
+
+
+acs_credential_on_encoder.visionline_metadata.discarded Format: Boolean
+
+
+Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is discarded.
+
+
+
+
+
+
+acs_credential_on_encoder.visionline_metadata.expired Format: Boolean
+
+
+Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is expired.
+
+
+
+
+
+
+acs_credential_on_encoder.visionline_metadata.guest_acs_entrance_ids Format: List Item format: UUID
+
+
+IDs of the guest [entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md) for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+
+
+
+
+
+acs_credential_on_encoder.visionline_metadata.number_of_issued_cards Format: Number
+
+
+Number of issued cards associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+
+
+
+
+
+acs_credential_on_encoder.visionline_metadata.overridden Format: Boolean
+
+
+Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is overridden.
+
+
+
+
+
+
+acs_credential_on_encoder.visionline_metadata.overwritten Format: Boolean
+
+
+Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is overwritten.
+
+
+
+
+
+
+acs_credential_on_encoder.visionline_metadata.pending_auto_update Format: Boolean
+
+
+Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is pending auto-update.
+
+
+
+
+
+
+acs_credential_on_seam Format: Object
+
+
+Matching acs_credential currently encoded on this card.
+
+
+**access_method** Format: Enum
+
+Access method for the [credential](../../../capability-guides/access-systems/managing-credentials.md). Supported values: `code`, `card`, `mobile_key`.
+
+Possible enum values:
+- `code`
+- `card`
+- `mobile_key`
+
+
+**acs_credential_id** Format: UUID
+
+ID of the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+
+
+**acs_credential_pool_id** Format: UUID
+
+
+
+
+**acs_system_id** Format: UUID
+
+ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+
+
+**acs_user_id** Format: UUID
+
+ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](../../../capability-guides/access-systems/managing-credentials.md) belongs.
+
+
+
+**assa_abloy_vostio_metadata** Format: Object
+
+Vostio-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+
+
+**door_names** Format: List Item format: String
+
+
+
+
+**endpoint_id** Format: String
+
+
+
+
+**key_id** Format: String
+
+
+
+
+**key_issuing_request_id** Format: String
+
+
+
+
+**override_guest_acs_entrance_ids** Format: List Item format: String
+
+
+
+
+**assa_abloy_vostio_metadata.door_names** Format: List Item format: String
+
+
+
+
+**assa_abloy_vostio_metadata.endpoint_id** Format: String
+
+
+
+
+**assa_abloy_vostio_metadata.key_id** Format: String
+
+
+
+
+**assa_abloy_vostio_metadata.key_issuing_request_id** Format: String
+
+
+
+
+**assa_abloy_vostio_metadata.override_guest_acs_entrance_ids** Format: List Item format: String
+
+
+
+
+**card_number** Format: String
+
+Number of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+
+
+**code** Format: String
+
+Access (PIN) code for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+
+
+**created_at** Format: Datetime
+
+Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was created.
+
+
+
+**display_name** Format: String
+
+Display name that corresponds to the [credential](../../../capability-guides/access-systems/managing-credentials.md) type.
+
+
+
+**ends_at** Format: String
+
+Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
+
+
+
+**errors** Format: List Item format: Object
+
+Errors associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+
+
+**error_code** Format: String
+
+
+
+
+**message** Format: String
+
+
+
+
+**external_type** Format: Enum
+
+Brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.
+
+Possible enum values:
+- `pti_card`
+- `brivo_credential`
+- `hid_credential`
+- `visionline_card`
+- `salto_ks_credential`
+- `assa_abloy_vostio_key`
+- `salto_space_key`
+
+
+**external_type_display_name** Format: String
+
+Display name that corresponds to the brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type.
+
+
+
+**is_issued** Format: Boolean
+
+Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been encoded onto a card.
+
+
+
+**is_latest_desired_state_synced_with_provider** Format: Boolean
+
+Indicates whether the latest state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been synced from Seam to the provider.
+
+
+
+**is_managed** Format: Boolean
+
+
+
+
+**is_multi_phone_sync_credential** Format: Boolean
+
+Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).
+
+
+
+**is_one_time_use** Format: Boolean
+
+Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) can only be used once. If `true`, the code becomes invalid after the first use.
+
+
+
+**issued_at** Format: Datetime
+
+Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was encoded onto a card.
+
+
+
+**latest_desired_state_synced_with_provider_at** Format: Datetime
+
+Date and time at which the state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) was most recently synced from Seam to the provider.
+
+
+
+**parent_acs_credential_id** Format: UUID
+
+ID of the parent [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+
+
+**starts_at** Format: String
+
+Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+
+
+
+**visionline_metadata** Format: Object
+
+Visionline-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+
+
+**auto_join** Format: Boolean
+
-#### `result`
-Format: `Object`
-
+**card_function_type** Format: Enum
-acs_credential_on_encoder Format: Object
-Snapshot of credential data read from physical encoder.
+Possible enum values:
+- `guest`
+- `staff`
-
-
+**card_id** Format: String
-acs_credential_on_encoder.card_number Format: String
-A number or string that physically identifies the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
+**common_acs_entrance_ids** Format: List Item format: UUID
-acs_credential_on_encoder.created_at Format: Datetime
-Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was created.
-
-
+**credential_id** Format: String
-acs_credential_on_encoder.ends_at Format: Datetime
-Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) will stop being usable.
-
-
+**guest_acs_entrance_ids** Format: List Item format: UUID
-acs_credential_on_encoder.is_issued Format: Boolean
-
-
-acs_credential_on_encoder.starts_at Format: Datetime
+**is_valid** Format: Boolean
-Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) becomes usable.
-
-
-acs_credential_on_encoder.visionline_metadata Format: Object
+**joiner_acs_credential_ids** Format: List Item format: UUID
-Visionline-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-acs_credential_on_encoder.visionline_metadata.cancelled Format: Boolean
+**visionline_metadata.auto_join** Format: Boolean
-Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is cancelled.
-
-
-acs_credential_on_encoder.visionline_metadata.card_format Format: Enum
+**visionline_metadata.card_function_type** Format: Enum
-Format of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
Possible enum values:
-- `TLCode`
-- `rfid48`
+- `guest`
+- `staff`
-
-
+**visionline_metadata.card_id** Format: String
-acs_credential_on_encoder.visionline_metadata.card_holder Format: String
-Holden of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
+**visionline_metadata.common_acs_entrance_ids** Format: List Item format: UUID
-acs_credential_on_encoder.visionline_metadata.card_id Format: String
-Card ID for the Visionline card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
+**visionline_metadata.credential_id** Format: String
-acs_credential_on_encoder.visionline_metadata.common_acs_entrance_ids Format: List Item format: UUID
-IDs of the common [entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md) for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
+**visionline_metadata.guest_acs_entrance_ids** Format: List Item format: UUID
-acs_credential_on_encoder.visionline_metadata.discarded Format: Boolean
-Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is discarded.
-
-
+**visionline_metadata.is_valid** Format: Boolean
-acs_credential_on_encoder.visionline_metadata.expired Format: Boolean
-Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is expired.
-
-
+**visionline_metadata.joiner_acs_credential_ids** Format: List Item format: UUID
-acs_credential_on_encoder.visionline_metadata.guest_acs_entrance_ids Format: List Item format: UUID
-IDs of the guest [entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md) for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
+**warnings** Format: List Item format: Object
-acs_credential_on_encoder.visionline_metadata.number_of_issued_cards Format: Number
+Warnings associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-Number of issued cards associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
+**created_at** Format: Datetime
-acs_credential_on_encoder.visionline_metadata.overridden Format: Boolean
+Date and time at which Seam created the warning.
-Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is overridden.
-
-
+**message** Format: String
-acs_credential_on_encoder.visionline_metadata.overwritten Format: Boolean
+Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
-Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is overwritten.
-
-
+**warning_code** Format: Enum
-acs_credential_on_encoder.visionline_metadata.pending_auto_update Format: Boolean
+Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
-Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is pending auto-update.
+Possible enum values:
+- `waiting_to_be_issued`
+- `schedule_externally_modified`
+- `schedule_modified`
+- `being_deleted`
+- `unknown_issue_with_acs_credential`
+- `needs_to_be_reissued`
-
-
+**workspace_id** Format: UUID
+
+ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-acs_credential_on_seam Format: Object
-Matching acs_credential currently encoded on this card.
@@ -238,6 +879,7 @@ Matching acs_credential currently encoded on this card.
acs_credential_on_seam.access_method Format: Enum
+
Access method for the [credential](../../../capability-guides/access-systems/managing-credentials.md). Supported values: `code`, `card`, `mobile_key`.
Possible enum values:
@@ -245,140 +887,197 @@ Possible enum values:
- `card`
- `mobile_key`
+
acs_credential_on_seam.acs_credential_id Format: UUID
+
ID of the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
acs_credential_on_seam.acs_credential_pool_id Format: UUID
+
+
acs_credential_on_seam.acs_system_id Format: UUID
+
ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
acs_credential_on_seam.acs_user_id Format: UUID
+
ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](../../../capability-guides/access-systems/managing-credentials.md) belongs.
+
acs_credential_on_seam.assa_abloy_vostio_metadata Format: Object
+
Vostio-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+**door_names** Format: List Item format: String
+
+
+
+
+**endpoint_id** Format: String
+
+
+
+
+**key_id** Format: String
+
+
+
+
+**key_issuing_request_id** Format: String
+
+
+
+
+**override_guest_acs_entrance_ids** Format: List Item format: String
+
+
+
+
acs_credential_on_seam.assa_abloy_vostio_metadata.door_names Format: List Item format: String
+
+
acs_credential_on_seam.assa_abloy_vostio_metadata.endpoint_id Format: String
+
+
acs_credential_on_seam.assa_abloy_vostio_metadata.key_id Format: String
+
+
acs_credential_on_seam.assa_abloy_vostio_metadata.key_issuing_request_id Format: String
+
+
acs_credential_on_seam.assa_abloy_vostio_metadata.override_guest_acs_entrance_ids Format: List Item format: String
+
+
acs_credential_on_seam.card_number Format: String
+
Number of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
acs_credential_on_seam.code Format: String
+
Access (PIN) code for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
acs_credential_on_seam.created_at Format: Datetime
+
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was created.
+
acs_credential_on_seam.display_name Format: String
+
Display name that corresponds to the [credential](../../../capability-guides/access-systems/managing-credentials.md) type.
+
acs_credential_on_seam.ends_at Format: String
+
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
+
acs_credential_on_seam.errors Format: List Item format: Object
+
Errors associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
+**error_code** Format: String
-error_code Format: String
-
-
-message Format: String
+**message** Format: String
+
+
+
-
acs_credential_on_seam.external_type Format: Enum
+
Brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.
Possible enum values:
@@ -390,172 +1089,249 @@ Possible enum values:
- `assa_abloy_vostio_key`
- `salto_space_key`
+
acs_credential_on_seam.external_type_display_name Format: String
+
Display name that corresponds to the brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type.
+
acs_credential_on_seam.is_issued Format: Boolean
+
Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been encoded onto a card.
+
acs_credential_on_seam.is_latest_desired_state_synced_with_provider Format: Boolean
+
Indicates whether the latest state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been synced from Seam to the provider.
+
acs_credential_on_seam.is_managed Format: Boolean
+
+
acs_credential_on_seam.is_multi_phone_sync_credential Format: Boolean
+
Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).
+
acs_credential_on_seam.is_one_time_use Format: Boolean
+
Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) can only be used once. If `true`, the code becomes invalid after the first use.
+
acs_credential_on_seam.issued_at Format: Datetime
+
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was encoded onto a card.
+
acs_credential_on_seam.latest_desired_state_synced_with_provider_at Format: Datetime
+
Date and time at which the state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) was most recently synced from Seam to the provider.
+
acs_credential_on_seam.parent_acs_credential_id Format: UUID
+
ID of the parent [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
acs_credential_on_seam.starts_at Format: String
+
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+
acs_credential_on_seam.visionline_metadata Format: Object
+
Visionline-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+**auto_join** Format: Boolean
+
+
+
+
+**card_function_type** Format: Enum
+
+
+Possible enum values:
+- `guest`
+- `staff`
+
+
+**card_id** Format: String
+
+
+
+
+**common_acs_entrance_ids** Format: List Item format: UUID
+
+
+
+
+**credential_id** Format: String
+
+
+
+
+**guest_acs_entrance_ids** Format: List Item format: UUID
+
+
+
+
+**is_valid** Format: Boolean
+
+
+
+
+**joiner_acs_credential_ids** Format: List Item format: UUID
+
+
+
+
acs_credential_on_seam.visionline_metadata.auto_join Format: Boolean
+
+
acs_credential_on_seam.visionline_metadata.card_function_type Format: Enum
+
Possible enum values:
- `guest`
- `staff`
+
acs_credential_on_seam.visionline_metadata.card_id Format: String
+
+
acs_credential_on_seam.visionline_metadata.common_acs_entrance_ids Format: List Item format: UUID
+
+
acs_credential_on_seam.visionline_metadata.credential_id Format: String
+
+
acs_credential_on_seam.visionline_metadata.guest_acs_entrance_ids Format: List Item format: UUID
+
+
acs_credential_on_seam.visionline_metadata.is_valid Format: Boolean
+
+
acs_credential_on_seam.visionline_metadata.joiner_acs_credential_ids Format: List Item format: UUID
+
+
acs_credential_on_seam.warnings Format: List Item format: Object
-Warnings associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+Warnings associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-created_at Format: Datetime
+**created_at** Format: Datetime
Date and time at which Seam created the warning.
-
-
-message Format: String
+**message** Format: String
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
-
-
-warning_code Format: Enum
+**warning_code** Format: Enum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
@@ -567,15 +1343,17 @@ Possible enum values:
- `unknown_issue_with_acs_credential`
- `needs_to_be_reissued`
-
+
acs_credential_on_seam.workspace_id Format: UUID
+
ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
@@ -583,21 +1361,20 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains
warnings Format: List Item format: Object
-
-warning_code Format: Enum
+**warning_code** Format: Enum
+
Possible enum values:
- `acs_credential_on_encoder_out_of_sync`
- `acs_credential_on_seam_not_found`
-
-
+**warning_message** Format: String
+
+
-warning_message Format: String
-
---
diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md
index 026a4352..4ae8be36 100644
--- a/docs/api/acs/entrances/README.md
+++ b/docs/api/acs/entrances/README.md
@@ -30,36 +30,46 @@ ASSA ABLOY Vostio-specific metadata associated with the [entrance](../../../capa
door_name Format: String
+
+
door_number Format: Number
+
+
door_type Format: Enum
+
Possible enum values:
- `CommonDoor`
- `EntranceDoor`
- `GuestDoor`
- `Elevator`
+
pms_id Format: String
+
+
stand_open Format: Boolean
+
+
---
@@ -90,6 +100,8 @@ dormakaba Community-specific metadata associated with the [entrance](../../../ca
access_point_name Format: String
+
+
---
@@ -106,16 +118,20 @@ Errors associated with the [entrance](../../../capability-guides/access-systems/
error_code Format: String
+
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
message Format: String
+
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
---
@@ -130,24 +146,32 @@ Latch-specific metadata associated with the [entrance](../../../capability-guide
accessibility_type Format: String
+
+
door_name Format: String
+
+
door_type Format: String
+
+
is_connected Format: Boolean
+
+
---
@@ -162,48 +186,64 @@ Salto KS-specific metadata associated with the [entrance](../../../capability-gu
battery_level Format: String
+
+
door_name Format: String
+
+
intrusion_alarm Format: Boolean
+
+
left_open_alarm Format: Boolean
+
+
lock_type Format: String
+
+
locked_state Format: String
+
+
online Format: Boolean
+
+
privacy_mode Format: Boolean
+
+
---
@@ -218,18 +258,24 @@ Salto Space-specific metadata associated with the [entrance](../../../capability
door_description Format: String
+
+
door_name Format: String
+
+
ext_door_id Format: String
+
+
---
@@ -244,6 +290,7 @@ Visionline-specific metadata associated with the [entrance](../../../capability-
door_category Format: Enum
+
Possible enum values:
- `entrance`
- `guest`
@@ -251,12 +298,15 @@ Possible enum values:
- `common`
- `common (PMS)`
+
door_name Format: String
+
+
@@ -264,22 +314,21 @@ Possible enum values:
profiles Format: List Item format: Object
-
-visionline_door_profile_id Format: String
+**visionline_door_profile_id** Format: String
+
-
-
-visionline_door_profile_type Format: Enum
+**visionline_door_profile_type** Format: Enum
+
Possible enum values:
- `BLE`
- `commonDoor`
- `touch`
-
+
---
@@ -311,60 +360,76 @@ An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entra
acs_entrance_id Format: UUID
+
+
acs_system_id Format: UUID
+
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
+
connected_account_id Format: UUID
+
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
+
created_at Format: Datetime
+
Date and time at which the event was created.
+
event_id Format: UUID
+
ID of the event.
+
event_type Format: String
+
+
occurred_at Format: Datetime
+
Date and time at which the event occurred.
+
workspace_id Format: UUID
+
ID of the [workspace](../../../core-concepts/workspaces/README.md).
+
---
@@ -377,60 +442,76 @@ An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entra
acs_entrance_id Format: UUID
+
+
acs_system_id Format: UUID
+
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
+
connected_account_id Format: UUID
+
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
+
created_at Format: Datetime
+
Date and time at which the event was created.
+
event_id Format: UUID
+
ID of the event.
+
event_type Format: String
+
+
occurred_at Format: Datetime
+
Date and time at which the event occurred.
+
workspace_id Format: UUID
+
ID of the [workspace](../../../core-concepts/workspaces/README.md).
+
---
diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md
index 240f7503..d2f242b8 100644
--- a/docs/api/acs/systems/README.md
+++ b/docs/api/acs/systems/README.md
@@ -155,8 +155,10 @@ Format: `Object`
time_zone Format: String
+
Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located.
+
---
@@ -212,24 +214,30 @@ Format: `Object`
lan_address Format: String
+
IP address or hostname of the main Visionline server relative to [Seam Bridge](../../../capability-guides/seam-bridge.md) on the local network.
+
mobile_access_uuid Format: String
+
Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset.
+
system_id Format: String
+
Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager.
+
---
@@ -333,54 +341,68 @@ An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) wa
acs_system_id Format: UUID
+
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
+
connected_account_id Format: UUID
+
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
+
created_at Format: Datetime
+
Date and time at which the event was created.
+
event_id Format: UUID
+
ID of the event.
+
event_type Format: String
+
+
occurred_at Format: Datetime
+
Date and time at which the event occurred.
+
workspace_id Format: UUID
+
ID of the [workspace](../../../core-concepts/workspaces/README.md).
+
---
@@ -393,54 +415,68 @@ An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) wa
acs_system_id Format: UUID
+
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
+
connected_account_id Format: UUID
+
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
+
created_at Format: Datetime
+
Date and time at which the event was created.
+
event_id Format: UUID
+
ID of the event.
+
event_type Format: String
+
+
occurred_at Format: Datetime
+
Date and time at which the event occurred.
+
workspace_id Format: UUID
+
ID of the [workspace](../../../core-concepts/workspaces/README.md).
+
---
@@ -453,54 +489,68 @@ An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) wa
acs_system_id Format: UUID
+
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
+
connected_account_id Format: UUID
+
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
+
created_at Format: Datetime
+
Date and time at which the event was created.
+
event_id Format: UUID
+
ID of the event.
+
event_type Format: String
+
+
occurred_at Format: Datetime
+
Date and time at which the event occurred.
+
workspace_id Format: UUID
+
ID of the [workspace](../../../core-concepts/workspaces/README.md).
+
---
diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md
index 248661f4..b0345f8a 100644
--- a/docs/api/acs/users/README.md
+++ b/docs/api/acs/users/README.md
@@ -14,16 +14,20 @@ Format: `Object`
ends_at Format: Datetime
+
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.
+
starts_at Format: Datetime
+
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.
+
---
@@ -299,60 +303,76 @@ An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-
acs_system_id Format: UUID
+
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
+
acs_user_id Format: UUID
+
+
connected_account_id Format: UUID
+
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
+
created_at Format: Datetime
+
Date and time at which the event was created.
+
event_id Format: UUID
+
ID of the event.
+
event_type Format: String
+
+
occurred_at Format: Datetime
+
Date and time at which the event occurred.
+
workspace_id Format: UUID
+
ID of the [workspace](../../../core-concepts/workspaces/README.md).
+
---
diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md
index 3028245c..2a000227 100644
--- a/docs/api/phones/README.md
+++ b/docs/api/phones/README.md
@@ -60,12 +60,16 @@ Errors associated with the `phone`.
error_code Format: String
+
+
message Format: String
+
+
---
@@ -88,56 +92,92 @@ Properties of the phone.
assa_abloy_credential_service_metadata Format: Object
+
ASSA ABLOY Credential Service metadata for the phone.
+
+**endpoints** Format: List Item format: Object
+
+Endpoints associated with the phone.
+
+
+
+**endpoint_id** Format: String
+
+ID of the associated endpoint.
+
+
+
+**is_active** Format: Boolean
+
+Indicated whether the endpoint is active.
+
+
+
+**has_active_endpoint** Format: Boolean
+
+Indicates whether the credential service has active endpoints associated with the phone.
+
+
+
assa_abloy_credential_service_metadata.endpoints Format: List Item format: Object
+
Endpoints associated with the phone.
-
-
-endpoint_id Format: String
+**endpoint_id** Format: String
ID of the associated endpoint.
-
-
-is_active Format: Boolean
+**is_active** Format: Boolean
Indicated whether the endpoint is active.
-
+
+
assa_abloy_credential_service_metadata.has_active_endpoint Format: Boolean
+
Indicates whether the credential service has active endpoints associated with the phone.
+
salto_space_credential_service_metadata Format: Object
+
Salto Space credential service metadata for the phone.
+
+**has_active_phone** Format: Boolean
+
+Indicates whether the credential service has an active associated phone.
+
+
+
salto_space_credential_service_metadata.has_active_phone Format: Boolean
+
Indicates whether the credential service has an active associated phone.
+
---
@@ -154,12 +194,16 @@ Warnings associated with the `phone`.
message Format: String
+
+
warning_code Format: String
+
+
---
@@ -196,46 +240,58 @@ A phone device was deactivated.
created_at Format: Datetime
+
Date and time at which the event was created.
+
device_id Format: UUID
+
ID of the [device](../../core-concepts/devices/README.md).
+
event_id Format: UUID
+
ID of the event.
+
event_type Format: String
+
+
occurred_at Format: Datetime
+
Date and time at which the event occurred.
+
workspace_id Format: UUID
+
ID of the [workspace](../../core-concepts/workspaces/README.md).
+
---
diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md
index 5b931e56..459edb33 100644
--- a/docs/api/thermostats/activate_climate_preset.md
+++ b/docs/api/thermostats/activate_climate_preset.md
@@ -194,12 +194,16 @@ Format: `Object`
message Format: String
+
+
type Format: String
+
+
---
diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md
index 9564ca04..0a2b1a79 100644
--- a/docs/api/thermostats/cool.md
+++ b/docs/api/thermostats/cool.md
@@ -204,12 +204,16 @@ Format: `Object`
message Format: String
+
+
type Format: String
+
+
---
diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md
index 44c9ad73..9bdadc97 100644
--- a/docs/api/thermostats/heat.md
+++ b/docs/api/thermostats/heat.md
@@ -204,12 +204,16 @@ Format: `Object`
message Format: String
+
+
type Format: String
+
+
---
diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md
index 21d674ad..cf4dce1f 100644
--- a/docs/api/thermostats/heat_cool.md
+++ b/docs/api/thermostats/heat_cool.md
@@ -228,12 +228,16 @@ Format: `Object`
message Format: String
+
+
type Format: String
+
+
---
diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md
index b5b82471..51ffdb07 100644
--- a/docs/api/thermostats/off.md
+++ b/docs/api/thermostats/off.md
@@ -176,12 +176,16 @@ Format: `Object`
message Format: String
+
+
type Format: String
+
+
---
diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md
index 48b777e4..d41cb991 100644
--- a/docs/api/thermostats/schedules/README.md
+++ b/docs/api/thermostats/schedules/README.md
@@ -48,16 +48,20 @@ Errors associated with the [thermostat schedule](../../../capability-guides/ther
error_code Format: String
+
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
message Format: String
+
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
---
diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md
index bdf5e7d3..5424b213 100644
--- a/docs/api/thermostats/set_fan_mode.md
+++ b/docs/api/thermostats/set_fan_mode.md
@@ -204,12 +204,16 @@ Format: `Object`
message Format: String
+
+
type Format: String
+
+
---
diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md
index 64185341..c8636c6c 100644
--- a/docs/api/thermostats/set_hvac_mode.md
+++ b/docs/api/thermostats/set_hvac_mode.md
@@ -242,12 +242,16 @@ Format: `Object`
message Format: String
+
+
type Format: String
+
+
---
diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md
index f27a8723..8d33daf1 100644
--- a/docs/api/user_identities/enrollment_automations/README.md
+++ b/docs/api/user_identities/enrollment_automations/README.md
@@ -71,46 +71,58 @@ An [enrollment automation](../../../capability-guides/mobile-access/issuing-mobi
created_at Format: Datetime
+
Date and time at which the event was created.
+
enrollment_automation_id Format: UUID
+
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).
+
event_id Format: UUID
+
ID of the event.
+
event_type Format: String
+
+
occurred_at Format: Datetime
+
Date and time at which the event occurred.
+
workspace_id Format: UUID
+
ID of the [workspace](../../../core-concepts/workspaces/README.md).
+
---
From dfbe256a317b248cd5c2b855dcaea39127bdb5fe Mon Sep 17 00:00:00 2001
From: Andrii Balitskyi <10balian10@gmail.com>
Date: Thu, 20 Mar 2025 15:04:27 +0100
Subject: [PATCH 03/18] Don't render nested object props
---
src/layouts/partials/property-content.hbs | 11 -----------
src/layouts/partials/property-nested.hbs | 11 -----------
2 files changed, 22 deletions(-)
diff --git a/src/layouts/partials/property-content.hbs b/src/layouts/partials/property-content.hbs
index 2de829c8..1c56f55b 100644
--- a/src/layouts/partials/property-content.hbs
+++ b/src/layouts/partials/property-content.hbs
@@ -14,17 +14,6 @@ Possible enum values:
{{/each}}
{{/if}}
-{{#unless (eq objectProperties undefined)}}
-{{#if (eq objectProperties.length 0)}}
-
-This object has no properties.
-{{else}}
-{{#each objectProperties}}
-
-{{> property-nested this}}
-{{/each}}
-{{/if}}
-{{/unless}}
{{#if listProperties}}
{{#each listProperties}}
diff --git a/src/layouts/partials/property-nested.hbs b/src/layouts/partials/property-nested.hbs
index c077fac9..9a085433 100644
--- a/src/layouts/partials/property-nested.hbs
+++ b/src/layouts/partials/property-nested.hbs
@@ -1,17 +1,6 @@
**{{name}}** Format: {{format}}{{#if listItemFormat}} Item format: {{listItemFormat}}{{/if}}
{{> property-nested-internal}}
-{{#unless (eq objectProperties undefined)}}
-{{#if (eq objectProperties.length 0)}}
-
-This object has no properties.
-{{else}}
-{{#each objectProperties}}
-
-{{> property-nested this}}
-{{/each}}
-{{/if}}
-{{/unless}}
{{#if listProperties}}
{{#each listProperties}}
From f71094ea0560bedcafffae3f0ec232ae377a5468 Mon Sep 17 00:00:00 2001
From: Seam Bot
Date: Thu, 20 Mar 2025 14:05:45 +0000
Subject: [PATCH 04/18] ci: Generate docs
---
docs/api/acs/encoders/encode_credential.md | 68 --
docs/api/acs/encoders/scan_credential.md | 817 ++-------------------
docs/api/phones/README.md | 30 -
3 files changed, 76 insertions(+), 839 deletions(-)
diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md
index 7f49eb56..194510bc 100644
--- a/docs/api/acs/encoders/encode_credential.md
+++ b/docs/api/acs/encoders/encode_credential.md
@@ -150,31 +150,6 @@ ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-system
Vostio-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-**door_names** Format: List Item format: String
-
-
-
-
-**endpoint_id** Format: String
-
-
-
-
-**key_id** Format: String
-
-
-
-
-**key_issuing_request_id** Format: String
-
-
-
-
-**override_guest_acs_entrance_ids** Format: List Item format: String
-
-
-
-
@@ -412,49 +387,6 @@ Date and time at which the [credential](../../../capability-guides/access-system
Visionline-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-**auto_join** Format: Boolean
-
-
-
-
-**card_function_type** Format: Enum
-
-
-Possible enum values:
-- `guest`
-- `staff`
-
-
-**card_id** Format: String
-
-
-
-
-**common_acs_entrance_ids** Format: List Item format: UUID
-
-
-
-
-**credential_id** Format: String
-
-
-
-
-**guest_acs_entrance_ids** Format: List Item format: UUID
-
-
-
-
-**is_valid** Format: Boolean
-
-
-
-
-**joiner_acs_credential_ids** Format: List Item format: UUID
-
-
-
-
diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md
index c3558d7f..26473346 100644
--- a/docs/api/acs/encoders/scan_credential.md
+++ b/docs/api/acs/encoders/scan_credential.md
@@ -84,793 +84,196 @@ Format: `Object`
Snapshot of credential data read from physical encoder.
-**card_number** Format: String
-
-A number or string that physically identifies the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-**created_at** Format: Datetime
-
-Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was created.
-
-
-
-**ends_at** Format: Datetime
-
-Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) will stop being usable.
-
-
-
-**is_issued** Format: Boolean
-
-
-
-
-**starts_at** Format: Datetime
-
-Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) becomes usable.
-
-
-
-**visionline_metadata** Format: Object
-
-Visionline-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-**cancelled** Format: Boolean
-
-Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is cancelled.
-
-
-
-**card_format** Format: Enum
-
-Format of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-Possible enum values:
-- `TLCode`
-- `rfid48`
-
-
-**card_holder** Format: String
-
-Holden of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-**card_id** Format: String
-
-Card ID for the Visionline card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-**common_acs_entrance_ids** Format: List Item format: UUID
-
-IDs of the common [entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md) for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-**discarded** Format: Boolean
-
-Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is discarded.
-
-
-
-**expired** Format: Boolean
-
-Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is expired.
-
-
-
-**guest_acs_entrance_ids** Format: List Item format: UUID
-
-IDs of the guest [entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md) for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-**number_of_issued_cards** Format: Number
-
-Number of issued cards associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-**overridden** Format: Boolean
-
-Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is overridden.
-
-
-
-**overwritten** Format: Boolean
-
-Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is overwritten.
-
-
-
-**pending_auto_update** Format: Boolean
-
-Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is pending auto-update.
-
-
-
-**visionline_metadata.cancelled** Format: Boolean
-
-Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is cancelled.
-
-
-
-**visionline_metadata.card_format** Format: Enum
-
-Format of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-Possible enum values:
-- `TLCode`
-- `rfid48`
-
-
-**visionline_metadata.card_holder** Format: String
-
-Holden of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-**visionline_metadata.card_id** Format: String
-
-Card ID for the Visionline card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-**visionline_metadata.common_acs_entrance_ids** Format: List Item format: UUID
-
-IDs of the common [entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md) for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-**visionline_metadata.discarded** Format: Boolean
-
-Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is discarded.
-
-
-
-**visionline_metadata.expired** Format: Boolean
-
-Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is expired.
-
-
-
-**visionline_metadata.guest_acs_entrance_ids** Format: List Item format: UUID
-
-IDs of the guest [entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md) for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-**visionline_metadata.number_of_issued_cards** Format: Number
-
-Number of issued cards associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-**visionline_metadata.overridden** Format: Boolean
-
-Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is overridden.
-
-
-
-**visionline_metadata.overwritten** Format: Boolean
-
-Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is overwritten.
-
-
-
-**visionline_metadata.pending_auto_update** Format: Boolean
-
-Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is pending auto-update.
-
-
-
-
-
-
-
-acs_credential_on_encoder.card_number Format: String
-
-
-A number or string that physically identifies the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-
-
-
-acs_credential_on_encoder.created_at Format: Datetime
-
-
-Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was created.
-
-
-
-
-
-
-acs_credential_on_encoder.ends_at Format: Datetime
-
-
-Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) will stop being usable.
-
-
-
-
-
-
-acs_credential_on_encoder.is_issued Format: Boolean
-
-
-
-
-
-
-
-acs_credential_on_encoder.starts_at Format: Datetime
-
-
-Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) becomes usable.
-
-
-
-
-
-
-acs_credential_on_encoder.visionline_metadata Format: Object
-
-
-Visionline-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-**cancelled** Format: Boolean
-
-Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is cancelled.
-
-
-
-**card_format** Format: Enum
-
-Format of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-Possible enum values:
-- `TLCode`
-- `rfid48`
-
-
-**card_holder** Format: String
-
-Holden of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-**card_id** Format: String
-
-Card ID for the Visionline card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-**common_acs_entrance_ids** Format: List Item format: UUID
-
-IDs of the common [entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md) for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-**discarded** Format: Boolean
-
-Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is discarded.
-
-
-
-**expired** Format: Boolean
-
-Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is expired.
-
-
-
-**guest_acs_entrance_ids** Format: List Item format: UUID
-
-IDs of the guest [entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md) for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-**number_of_issued_cards** Format: Number
-
-Number of issued cards associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-**overridden** Format: Boolean
-
-Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is overridden.
-
-
-
-**overwritten** Format: Boolean
-
-Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is overwritten.
-
-
-
-**pending_auto_update** Format: Boolean
-
-Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is pending auto-update.
-
-
-
-
-
-
-
-acs_credential_on_encoder.visionline_metadata.cancelled Format: Boolean
-
-
-Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is cancelled.
-
-
-
-
-
-
-acs_credential_on_encoder.visionline_metadata.card_format Format: Enum
-
-
-Format of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-Possible enum values:
-- `TLCode`
-- `rfid48`
-
-
-
-
-
-
-acs_credential_on_encoder.visionline_metadata.card_holder Format: String
-
-
-Holden of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-
-
-
-acs_credential_on_encoder.visionline_metadata.card_id Format: String
-
-
-Card ID for the Visionline card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-
-
-
-acs_credential_on_encoder.visionline_metadata.common_acs_entrance_ids Format: List Item format: UUID
-
-
-IDs of the common [entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md) for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-
-
-
-acs_credential_on_encoder.visionline_metadata.discarded Format: Boolean
-
-
-Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is discarded.
-
-
-
-
-
-
-acs_credential_on_encoder.visionline_metadata.expired Format: Boolean
-
-
-Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is expired.
-
-
-
-
-
-
-acs_credential_on_encoder.visionline_metadata.guest_acs_entrance_ids Format: List Item format: UUID
-
-
-IDs of the guest [entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md) for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-
-
-
-acs_credential_on_encoder.visionline_metadata.number_of_issued_cards Format: Number
-
-
-Number of issued cards associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-
-
-
-acs_credential_on_encoder.visionline_metadata.overridden Format: Boolean
-
-
-Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is overridden.
-
-
-
-
-
-
-acs_credential_on_encoder.visionline_metadata.overwritten Format: Boolean
-
-
-Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is overwritten.
-
-
-
-
-
-
-acs_credential_on_encoder.visionline_metadata.pending_auto_update Format: Boolean
-
-
-Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is pending auto-update.
-
-
-
-
-
-
-acs_credential_on_seam Format: Object
-
-
-Matching acs_credential currently encoded on this card.
-
-
-**access_method** Format: Enum
-
-Access method for the [credential](../../../capability-guides/access-systems/managing-credentials.md). Supported values: `code`, `card`, `mobile_key`.
-
-Possible enum values:
-- `code`
-- `card`
-- `mobile_key`
-
-
-**acs_credential_id** Format: UUID
-
-ID of the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-**acs_credential_pool_id** Format: UUID
-
-
-
-
-**acs_system_id** Format: UUID
-
-ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-**acs_user_id** Format: UUID
-
-ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](../../../capability-guides/access-systems/managing-credentials.md) belongs.
-
-
-
-**assa_abloy_vostio_metadata** Format: Object
-
-Vostio-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-**door_names** Format: List Item format: String
-
-
-
-
-**endpoint_id** Format: String
-
-
-
-
-**key_id** Format: String
-
-
-
-
-**key_issuing_request_id** Format: String
-
-
-
-
-**override_guest_acs_entrance_ids** Format: List Item format: String
-
-
-
-
-**assa_abloy_vostio_metadata.door_names** Format: List Item format: String
-
-
-
-
-**assa_abloy_vostio_metadata.endpoint_id** Format: String
-
-
-
-
-**assa_abloy_vostio_metadata.key_id** Format: String
-
-
-
-
-**assa_abloy_vostio_metadata.key_issuing_request_id** Format: String
-
-
-
-
-**assa_abloy_vostio_metadata.override_guest_acs_entrance_ids** Format: List Item format: String
-
-
-
+
-**card_number** Format: String
+
-Number of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+acs_credential_on_encoder.card_number Format: String
+A number or string that physically identifies the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-**code** Format: String
-Access (PIN) code for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+
+acs_credential_on_encoder.created_at Format: Datetime
-**created_at** Format: Datetime
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was created.
+
-**display_name** Format: String
-
-Display name that corresponds to the [credential](../../../capability-guides/access-systems/managing-credentials.md) type.
-
-
-
-**ends_at** Format: String
-
-Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
-
-
-
-**errors** Format: List Item format: Object
-
-Errors associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-**error_code** Format: String
-
-
-
-
-**message** Format: String
-
-
-
-
-**external_type** Format: Enum
-
-Brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.
-
-Possible enum values:
-- `pti_card`
-- `brivo_credential`
-- `hid_credential`
-- `visionline_card`
-- `salto_ks_credential`
-- `assa_abloy_vostio_key`
-- `salto_space_key`
-
-
-**external_type_display_name** Format: String
-
-Display name that corresponds to the brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type.
-
-
-
-**is_issued** Format: Boolean
-
-Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been encoded onto a card.
-
-
-
-**is_latest_desired_state_synced_with_provider** Format: Boolean
-
-Indicates whether the latest state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been synced from Seam to the provider.
-
-
-
-**is_managed** Format: Boolean
-
-
-
-
-**is_multi_phone_sync_credential** Format: Boolean
-
-Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).
-
-
-
-**is_one_time_use** Format: Boolean
-
-Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) can only be used once. If `true`, the code becomes invalid after the first use.
+
+acs_credential_on_encoder.ends_at Format: Datetime
-**issued_at** Format: Datetime
+Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) will stop being usable.
-Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was encoded onto a card.
+
+
-**latest_desired_state_synced_with_provider_at** Format: Datetime
+acs_credential_on_encoder.is_issued Format: Boolean
-Date and time at which the state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) was most recently synced from Seam to the provider.
+
-**parent_acs_credential_id** Format: UUID
+
-ID of the parent [credential](../../../capability-guides/access-systems/managing-credentials.md).
+acs_credential_on_encoder.starts_at Format: Datetime
+Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) becomes usable.
-**starts_at** Format: String
-Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+
+
+acs_credential_on_encoder.visionline_metadata Format: Object
-**visionline_metadata** Format: Object
Visionline-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
-**auto_join** Format: Boolean
-
-
-
-
-**card_function_type** Format: Enum
-
-
-Possible enum values:
-- `guest`
-- `staff`
+
+acs_credential_on_encoder.visionline_metadata.cancelled Format: Boolean
-**card_id** Format: String
+Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is cancelled.
+
-**common_acs_entrance_ids** Format: List Item format: UUID
+
+acs_credential_on_encoder.visionline_metadata.card_format Format: Enum
+Format of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-**credential_id** Format: String
+Possible enum values:
+- `TLCode`
+- `rfid48`
+
+
-**guest_acs_entrance_ids** Format: List Item format: UUID
+acs_credential_on_encoder.visionline_metadata.card_holder Format: String
+Holden of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-**is_valid** Format: Boolean
+
+
+acs_credential_on_encoder.visionline_metadata.card_id Format: String
-**joiner_acs_credential_ids** Format: List Item format: UUID
+Card ID for the Visionline card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+
-**visionline_metadata.auto_join** Format: Boolean
+acs_credential_on_encoder.visionline_metadata.common_acs_entrance_ids Format: List Item format: UUID
+IDs of the common [entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md) for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-**visionline_metadata.card_function_type** Format: Enum
+
+
-Possible enum values:
-- `guest`
-- `staff`
+acs_credential_on_encoder.visionline_metadata.discarded Format: Boolean
-**visionline_metadata.card_id** Format: String
+Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is discarded.
+
+
-**visionline_metadata.common_acs_entrance_ids** Format: List Item format: UUID
+acs_credential_on_encoder.visionline_metadata.expired Format: Boolean
+Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is expired.
-**visionline_metadata.credential_id** Format: String
+
+
+acs_credential_on_encoder.visionline_metadata.guest_acs_entrance_ids Format: List Item format: UUID
-**visionline_metadata.guest_acs_entrance_ids** Format: List Item format: UUID
+IDs of the guest [entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md) for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+
-**visionline_metadata.is_valid** Format: Boolean
+acs_credential_on_encoder.visionline_metadata.number_of_issued_cards Format: Number
+Number of issued cards associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-**visionline_metadata.joiner_acs_credential_ids** Format: List Item format: UUID
+
+
+acs_credential_on_encoder.visionline_metadata.overridden Format: Boolean
-**warnings** Format: List Item format: Object
+Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is overridden.
-Warnings associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+
-**created_at** Format: Datetime
+acs_credential_on_encoder.visionline_metadata.overwritten Format: Boolean
-Date and time at which Seam created the warning.
+Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is overwritten.
-**message** Format: String
+
-Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+
+acs_credential_on_encoder.visionline_metadata.pending_auto_update Format: Boolean
-**warning_code** Format: Enum
+Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is pending auto-update.
-Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
-Possible enum values:
-- `waiting_to_be_issued`
-- `schedule_externally_modified`
-- `schedule_modified`
-- `being_deleted`
-- `unknown_issue_with_acs_credential`
-- `needs_to_be_reissued`
+
+
-**workspace_id** Format: UUID
+acs_credential_on_seam Format: Object
-ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+Matching acs_credential currently encoded on this card.
@@ -936,31 +339,6 @@ ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-system
Vostio-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-**door_names** Format: List Item format: String
-
-
-
-
-**endpoint_id** Format: String
-
-
-
-
-**key_id** Format: String
-
-
-
-
-**key_issuing_request_id** Format: String
-
-
-
-
-**override_guest_acs_entrance_ids** Format: List Item format: String
-
-
-
-
@@ -1198,49 +576,6 @@ Date and time at which the [credential](../../../capability-guides/access-system
Visionline-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-**auto_join** Format: Boolean
-
-
-
-
-**card_function_type** Format: Enum
-
-
-Possible enum values:
-- `guest`
-- `staff`
-
-
-**card_id** Format: String
-
-
-
-
-**common_acs_entrance_ids** Format: List Item format: UUID
-
-
-
-
-**credential_id** Format: String
-
-
-
-
-**guest_acs_entrance_ids** Format: List Item format: UUID
-
-
-
-
-**is_valid** Format: Boolean
-
-
-
-
-**joiner_acs_credential_ids** Format: List Item format: UUID
-
-
-
-
diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md
index 2a000227..ea94c934 100644
--- a/docs/api/phones/README.md
+++ b/docs/api/phones/README.md
@@ -96,30 +96,6 @@ Properties of the phone.
ASSA ABLOY Credential Service metadata for the phone.
-**endpoints** Format: List Item format: Object
-
-Endpoints associated with the phone.
-
-
-
-**endpoint_id** Format: String
-
-ID of the associated endpoint.
-
-
-
-**is_active** Format: Boolean
-
-Indicated whether the endpoint is active.
-
-
-
-**has_active_endpoint** Format: Boolean
-
-Indicates whether the credential service has active endpoints associated with the phone.
-
-
-
@@ -162,12 +138,6 @@ Indicates whether the credential service has active endpoints associated with th
Salto Space credential service metadata for the phone.
-**has_active_phone** Format: Boolean
-
-Indicates whether the credential service has an active associated phone.
-
-
-
From 1f2ae8c5587236fd62a5dd2a654d826d0dd02d73 Mon Sep 17 00:00:00 2001
From: Andrii Balitskyi <10balian10@gmail.com>
Date: Thu, 20 Mar 2025 15:08:43 +0100
Subject: [PATCH 05/18] Fix property-content.hbs identationn
---
src/layouts/partials/property-content.hbs | 5 ++---
1 file changed, 2 insertions(+), 3 deletions(-)
diff --git a/src/layouts/partials/property-content.hbs b/src/layouts/partials/property-content.hbs
index 1c56f55b..3f4a3ee0 100644
--- a/src/layouts/partials/property-content.hbs
+++ b/src/layouts/partials/property-content.hbs
@@ -2,17 +2,16 @@
{{> deprecated-warning}}
{{/if}}
-
{{#if description}}
-{{description}}
+{{description}}
{{/if}}
{{#if enumValues}}
+
Possible enum values:
{{#each enumValues}}
- `{{this}}`
{{/each}}
-
{{/if}}
{{#if listProperties}}
{{#each listProperties}}
From 5111ef4dfe4607137d48f1d4de00b8b96681a2bf Mon Sep 17 00:00:00 2001
From: Seam Bot
Date: Thu, 20 Mar 2025 14:09:56 +0000
Subject: [PATCH 06/18] ci: Generate docs
---
docs/api/acs/access_groups/README.md | 11 ----
docs/api/acs/credentials/README.md | 39 ------------
docs/api/acs/encoders/README.md | 19 ------
docs/api/acs/encoders/encode_credential.md | 41 ------------
docs/api/acs/encoders/scan_credential.md | 62 -------------------
docs/api/acs/entrances/README.md | 42 -------------
docs/api/acs/systems/README.md | 25 --------
docs/api/acs/users/README.md | 10 ---
docs/api/phones/README.md | 15 -----
.../thermostats/activate_climate_preset.md | 2 -
docs/api/thermostats/cool.md | 2 -
docs/api/thermostats/heat.md | 2 -
docs/api/thermostats/heat_cool.md | 2 -
docs/api/thermostats/off.md | 2 -
docs/api/thermostats/schedules/README.md | 2 -
docs/api/thermostats/set_fan_mode.md | 2 -
docs/api/thermostats/set_hvac_mode.md | 2 -
.../enrollment_automations/README.md | 6 --
18 files changed, 286 deletions(-)
diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md
index 62299169..3de65f1a 100644
--- a/docs/api/acs/access_groups/README.md
+++ b/docs/api/acs/access_groups/README.md
@@ -116,7 +116,6 @@ Warnings associated with the `acs_access_group`.
Date and time at which Seam created the warning.
-
@@ -126,7 +125,6 @@ Date and time at which Seam created the warning.
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
-
@@ -136,7 +134,6 @@ Detailed description of the warning. Provides insights into the issue and potent
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
-
---
@@ -183,7 +180,6 @@ An ACS access group was deleted.
acs_access_group_id Format: UUID
-
@@ -193,7 +189,6 @@ An ACS access group was deleted.
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-
@@ -203,7 +198,6 @@ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-syst
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-
@@ -213,7 +207,6 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m
Date and time at which the event was created.
-
@@ -223,7 +216,6 @@ Date and time at which the event was created.
ID of the event.
-
@@ -231,7 +223,6 @@ ID of the event.
event_type Format: String
-
@@ -241,7 +232,6 @@ ID of the event.
Date and time at which the event occurred.
-
@@ -251,7 +241,6 @@ Date and time at which the event occurred.
ID of the [workspace](../../../core-concepts/workspaces/README.md).
-
---
diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md
index 2c62854a..eff0b90b 100644
--- a/docs/api/acs/credentials/README.md
+++ b/docs/api/acs/credentials/README.md
@@ -58,7 +58,6 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access-
door_names Format: List Item format: String
-
@@ -66,7 +65,6 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access-
endpoint_id Format: String
-
@@ -74,7 +72,6 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access-
key_id Format: String
-
@@ -82,7 +79,6 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access-
key_issuing_request_id Format: String
-
@@ -90,7 +86,6 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access-
override_guest_acs_entrance_ids Format: List Item format: String
-
---
@@ -148,7 +143,6 @@ Errors associated with the [credential](../../../capability-guides/access-system
error_code Format: String
-
@@ -156,7 +150,6 @@ Errors associated with the [credential](../../../capability-guides/access-system
message Format: String
-
---
@@ -267,7 +260,6 @@ Visionline-specific metadata for the [credential](../../../capability-guides/acc
auto_join Format: Boolean
-
@@ -279,7 +271,6 @@ Possible enum values:
- `guest`
- `staff`
-
@@ -287,7 +278,6 @@ Possible enum values:
card_id Format: String
-
@@ -295,7 +285,6 @@ Possible enum values:
common_acs_entrance_ids Format: List Item format: UUID
-
@@ -303,7 +292,6 @@ Possible enum values:
credential_id Format: String
-
@@ -311,7 +299,6 @@ Possible enum values:
guest_acs_entrance_ids Format: List Item format: UUID
-
@@ -319,7 +306,6 @@ Possible enum values:
is_valid Format: Boolean
-
@@ -327,7 +313,6 @@ Possible enum values:
joiner_acs_credential_ids Format: List Item format: UUID
-
---
@@ -428,7 +413,6 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia
acs_credential_id Format: UUID
-
@@ -438,7 +422,6 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-
@@ -448,7 +431,6 @@ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-syst
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-
@@ -458,7 +440,6 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m
Date and time at which the event was created.
-
@@ -468,7 +449,6 @@ Date and time at which the event was created.
ID of the event.
-
@@ -476,7 +456,6 @@ ID of the event.
event_type Format: String
-
@@ -486,7 +465,6 @@ ID of the event.
Date and time at which the event occurred.
-
@@ -496,7 +474,6 @@ Date and time at which the event occurred.
ID of the [workspace](../../../core-concepts/workspaces/README.md).
-
---
@@ -510,7 +487,6 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia
acs_credential_id Format: UUID
-
@@ -520,7 +496,6 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-
@@ -530,7 +505,6 @@ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-syst
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-
@@ -540,7 +514,6 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m
Date and time at which the event was created.
-
@@ -550,7 +523,6 @@ Date and time at which the event was created.
ID of the event.
-
@@ -558,7 +530,6 @@ ID of the event.
event_type Format: String
-
@@ -568,7 +539,6 @@ ID of the event.
Date and time at which the event occurred.
-
@@ -578,7 +548,6 @@ Date and time at which the event occurred.
ID of the [workspace](../../../core-concepts/workspaces/README.md).
-
---
@@ -592,7 +561,6 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia
acs_credential_id Format: UUID
-
@@ -602,7 +570,6 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-
@@ -612,7 +579,6 @@ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-syst
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-
@@ -622,7 +588,6 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m
Date and time at which the event was created.
-
@@ -632,7 +597,6 @@ Date and time at which the event was created.
ID of the event.
-
@@ -640,7 +604,6 @@ ID of the event.
event_type Format: String
-
@@ -650,7 +613,6 @@ ID of the event.
Date and time at which the event occurred.
-
@@ -660,7 +622,6 @@ Date and time at which the event occurred.
ID of the [workspace](../../../core-concepts/workspaces/README.md).
-
---
diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md
index e4183472..052e792f 100644
--- a/docs/api/acs/encoders/README.md
+++ b/docs/api/acs/encoders/README.md
@@ -51,7 +51,6 @@ Errors associated with the [encoder](../../../capability-guides/access-systems/w
Date and time at which Seam created the error.
-
@@ -61,7 +60,6 @@ Date and time at which Seam created the error.
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
-
@@ -71,7 +69,6 @@ Unique identifier of the type of error. Enables quick recognition and categoriza
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
-
---
@@ -111,7 +108,6 @@ An [ACS encoder](../../../capability-guides/access-systems/working-with-card-enc
ID of the [ACS encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
-
@@ -121,7 +117,6 @@ ID of the [ACS encoder](../../../capability-guides/access-systems/working-with-c
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-
@@ -131,7 +126,6 @@ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-syst
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-
@@ -141,7 +135,6 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m
Date and time at which the event was created.
-
@@ -151,7 +144,6 @@ Date and time at which the event was created.
ID of the event.
-
@@ -159,7 +151,6 @@ ID of the event.
event_type Format: String
-
@@ -169,7 +160,6 @@ ID of the event.
Date and time at which the event occurred.
-
@@ -179,7 +169,6 @@ Date and time at which the event occurred.
ID of the [workspace](../../../core-concepts/workspaces/README.md).
-
---
@@ -195,7 +184,6 @@ An [ACS encoder](../../../capability-guides/access-systems/working-with-card-enc
ID of the [ACS encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
-
@@ -205,7 +193,6 @@ ID of the [ACS encoder](../../../capability-guides/access-systems/working-with-c
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-
@@ -215,7 +202,6 @@ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-syst
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-
@@ -225,7 +211,6 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m
Date and time at which the event was created.
-
@@ -235,7 +220,6 @@ Date and time at which the event was created.
ID of the event.
-
@@ -243,7 +227,6 @@ ID of the event.
event_type Format: String
-
@@ -253,7 +236,6 @@ ID of the event.
Date and time at which the event occurred.
-
@@ -263,7 +245,6 @@ Date and time at which the event occurred.
ID of the [workspace](../../../core-concepts/workspaces/README.md).
-
---
diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md
index 194510bc..21aca3df 100644
--- a/docs/api/acs/encoders/encode_credential.md
+++ b/docs/api/acs/encoders/encode_credential.md
@@ -63,7 +63,6 @@ Format: `Object`
message Format: String
-
@@ -78,7 +77,6 @@ Possible enum values:
- `incompatible_card_format`
- `credential_cannot_be_reissued`
-
---
@@ -101,7 +99,6 @@ Possible enum values:
- `card`
- `mobile_key`
-
@@ -111,7 +108,6 @@ Possible enum values:
ID of the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
@@ -119,7 +115,6 @@ ID of the [credential](../../../capability-guides/access-systems/managing-creden
acs_credential_pool_id Format: UUID
-
@@ -129,7 +124,6 @@ ID of the [credential](../../../capability-guides/access-systems/managing-creden
ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
@@ -139,7 +133,6 @@ ID of the [access control system](https://docs.seam.co/latest/capability-guides/
ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](../../../capability-guides/access-systems/managing-credentials.md) belongs.
-
@@ -149,7 +142,6 @@ ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-system
Vostio-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
@@ -157,7 +149,6 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access-
assa_abloy_vostio_metadata.door_names Format: List Item format: String
-
@@ -165,7 +156,6 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access-
assa_abloy_vostio_metadata.endpoint_id Format: String
-
@@ -173,7 +163,6 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access-
assa_abloy_vostio_metadata.key_id Format: String
-
@@ -181,7 +170,6 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access-
assa_abloy_vostio_metadata.key_issuing_request_id Format: String
-
@@ -189,7 +177,6 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access-
assa_abloy_vostio_metadata.override_guest_acs_entrance_ids Format: List Item format: String
-
@@ -199,7 +186,6 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access-
Number of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
@@ -209,7 +195,6 @@ Number of the card associated with the [credential](../../../capability-guides/a
Access (PIN) code for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
@@ -219,7 +204,6 @@ Access (PIN) code for the [credential](../../../capability-guides/access-systems
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was created.
-
@@ -229,7 +213,6 @@ Date and time at which the [credential](../../../capability-guides/access-system
Display name that corresponds to the [credential](../../../capability-guides/access-systems/managing-credentials.md) type.
-
@@ -239,7 +222,6 @@ Display name that corresponds to the [credential](../../../capability-guides/acc
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
-
@@ -249,7 +231,6 @@ Date and time at which the [credential](../../../capability-guides/access-system
Errors associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
**error_code** Format: String
@@ -278,7 +259,6 @@ Possible enum values:
- `assa_abloy_vostio_key`
- `salto_space_key`
-
@@ -288,7 +268,6 @@ Possible enum values:
Display name that corresponds to the brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type.
-
@@ -298,7 +277,6 @@ Display name that corresponds to the brand-specific terminology for the [credent
Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been encoded onto a card.
-
@@ -308,7 +286,6 @@ Indicates whether the [credential](../../../capability-guides/access-systems/man
Indicates whether the latest state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been synced from Seam to the provider.
-
@@ -316,7 +293,6 @@ Indicates whether the latest state of the [credential](../../../capability-guide
is_managed Format: Boolean
-
@@ -326,7 +302,6 @@ Indicates whether the latest state of the [credential](../../../capability-guide
Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).
-
@@ -336,7 +311,6 @@ Indicates whether the [credential](../../../capability-guides/access-systems/man
Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) can only be used once. If `true`, the code becomes invalid after the first use.
-
@@ -346,7 +320,6 @@ Indicates whether the [credential](../../../capability-guides/access-systems/man
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was encoded onto a card.
-
@@ -356,7 +329,6 @@ Date and time at which the [credential](../../../capability-guides/access-system
Date and time at which the state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) was most recently synced from Seam to the provider.
-
@@ -366,7 +338,6 @@ Date and time at which the state of the [credential](../../../capability-guides/
ID of the parent [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
@@ -376,7 +347,6 @@ ID of the parent [credential](../../../capability-guides/access-systems/managing
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
-
@@ -386,7 +356,6 @@ Date and time at which the [credential](../../../capability-guides/access-system
Visionline-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
@@ -394,7 +363,6 @@ Visionline-specific metadata for the [credential](../../../capability-guides/acc
visionline_metadata.auto_join Format: Boolean
-
@@ -406,7 +374,6 @@ Possible enum values:
- `guest`
- `staff`
-
@@ -414,7 +381,6 @@ Possible enum values:
visionline_metadata.card_id Format: String
-
@@ -422,7 +388,6 @@ Possible enum values:
visionline_metadata.common_acs_entrance_ids Format: List Item format: UUID
-
@@ -430,7 +395,6 @@ Possible enum values:
visionline_metadata.credential_id Format: String
-
@@ -438,7 +402,6 @@ Possible enum values:
visionline_metadata.guest_acs_entrance_ids Format: List Item format: UUID
-
@@ -446,7 +409,6 @@ Possible enum values:
visionline_metadata.is_valid Format: Boolean
-
@@ -454,7 +416,6 @@ Possible enum values:
visionline_metadata.joiner_acs_credential_ids Format: List Item format: UUID
-
@@ -464,7 +425,6 @@ Possible enum values:
Warnings associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
**created_at** Format: Datetime
Date and time at which Seam created the warning.
@@ -499,7 +459,6 @@ Possible enum values:
ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
---
diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md
index 26473346..b2e6b922 100644
--- a/docs/api/acs/encoders/scan_credential.md
+++ b/docs/api/acs/encoders/scan_credential.md
@@ -54,7 +54,6 @@ Format: `Object`
message Format: String
-
@@ -67,7 +66,6 @@ Possible enum values:
- `action_attempt_expired`
- `no_credential_on_encoder`
-
---
@@ -83,7 +81,6 @@ Format: `Object`
Snapshot of credential data read from physical encoder.
-
@@ -93,7 +90,6 @@ Snapshot of credential data read from physical encoder.
A number or string that physically identifies the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
@@ -103,7 +99,6 @@ A number or string that physically identifies the card associated with the [cred
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was created.
-
@@ -113,7 +108,6 @@ Date and time at which the [credential](../../../capability-guides/access-system
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) will stop being usable.
-
@@ -121,7 +115,6 @@ Date and time at which the [credential](../../../capability-guides/access-system
acs_credential_on_encoder.is_issued Format: Boolean
-
@@ -131,7 +124,6 @@ Date and time at which the [credential](../../../capability-guides/access-system
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) becomes usable.
-
@@ -141,7 +133,6 @@ Date and time at which the [credential](../../../capability-guides/access-system
Visionline-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
@@ -151,7 +142,6 @@ Visionline-specific metadata for the [credential](../../../capability-guides/acc
Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is cancelled.
-
@@ -165,7 +155,6 @@ Possible enum values:
- `TLCode`
- `rfid48`
-
@@ -175,7 +164,6 @@ Possible enum values:
Holden of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
@@ -185,7 +173,6 @@ Holden of the card associated with the [credential](../../../capability-guides/a
Card ID for the Visionline card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
@@ -195,7 +182,6 @@ Card ID for the Visionline card associated with the [credential](../../../capabi
IDs of the common [entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md) for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
@@ -205,7 +191,6 @@ IDs of the common [entrances](../../../capability-guides/access-systems/retrievi
Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is discarded.
-
@@ -215,7 +200,6 @@ Indicates whether the card associated with the [credential](../../../capability-
Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is expired.
-
@@ -225,7 +209,6 @@ Indicates whether the card associated with the [credential](../../../capability-
IDs of the guest [entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md) for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
@@ -235,7 +218,6 @@ IDs of the guest [entrances](../../../capability-guides/access-systems/retrievin
Number of issued cards associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
@@ -245,7 +227,6 @@ Number of issued cards associated with the [credential](../../../capability-guid
Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is overridden.
-
@@ -255,7 +236,6 @@ Indicates whether the card associated with the [credential](../../../capability-
Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is overwritten.
-
@@ -265,7 +245,6 @@ Indicates whether the card associated with the [credential](../../../capability-
Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is pending auto-update.
-
@@ -275,7 +254,6 @@ Indicates whether the card associated with the [credential](../../../capability-
Matching acs_credential currently encoded on this card.
-
@@ -290,7 +268,6 @@ Possible enum values:
- `card`
- `mobile_key`
-
@@ -300,7 +277,6 @@ Possible enum values:
ID of the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
@@ -308,7 +284,6 @@ ID of the [credential](../../../capability-guides/access-systems/managing-creden
acs_credential_on_seam.acs_credential_pool_id Format: UUID
-
@@ -318,7 +293,6 @@ ID of the [credential](../../../capability-guides/access-systems/managing-creden
ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
@@ -328,7 +302,6 @@ ID of the [access control system](https://docs.seam.co/latest/capability-guides/
ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](../../../capability-guides/access-systems/managing-credentials.md) belongs.
-
@@ -338,7 +311,6 @@ ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-system
Vostio-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
@@ -346,7 +318,6 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access-
acs_credential_on_seam.assa_abloy_vostio_metadata.door_names Format: List Item format: String
-
@@ -354,7 +325,6 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access-
acs_credential_on_seam.assa_abloy_vostio_metadata.endpoint_id Format: String
-
@@ -362,7 +332,6 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access-
acs_credential_on_seam.assa_abloy_vostio_metadata.key_id Format: String
-
@@ -370,7 +339,6 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access-
acs_credential_on_seam.assa_abloy_vostio_metadata.key_issuing_request_id Format: String
-
@@ -378,7 +346,6 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access-
acs_credential_on_seam.assa_abloy_vostio_metadata.override_guest_acs_entrance_ids Format: List Item format: String
-
@@ -388,7 +355,6 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access-
Number of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
@@ -398,7 +364,6 @@ Number of the card associated with the [credential](../../../capability-guides/a
Access (PIN) code for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
@@ -408,7 +373,6 @@ Access (PIN) code for the [credential](../../../capability-guides/access-systems
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was created.
-
@@ -418,7 +382,6 @@ Date and time at which the [credential](../../../capability-guides/access-system
Display name that corresponds to the [credential](../../../capability-guides/access-systems/managing-credentials.md) type.
-
@@ -428,7 +391,6 @@ Display name that corresponds to the [credential](../../../capability-guides/acc
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
-
@@ -438,7 +400,6 @@ Date and time at which the [credential](../../../capability-guides/access-system
Errors associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
**error_code** Format: String
@@ -467,7 +428,6 @@ Possible enum values:
- `assa_abloy_vostio_key`
- `salto_space_key`
-
@@ -477,7 +437,6 @@ Possible enum values:
Display name that corresponds to the brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type.
-
@@ -487,7 +446,6 @@ Display name that corresponds to the brand-specific terminology for the [credent
Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been encoded onto a card.
-
@@ -497,7 +455,6 @@ Indicates whether the [credential](../../../capability-guides/access-systems/man
Indicates whether the latest state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been synced from Seam to the provider.
-
@@ -505,7 +462,6 @@ Indicates whether the latest state of the [credential](../../../capability-guide
acs_credential_on_seam.is_managed Format: Boolean
-
@@ -515,7 +471,6 @@ Indicates whether the latest state of the [credential](../../../capability-guide
Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).
-
@@ -525,7 +480,6 @@ Indicates whether the [credential](../../../capability-guides/access-systems/man
Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) can only be used once. If `true`, the code becomes invalid after the first use.
-
@@ -535,7 +489,6 @@ Indicates whether the [credential](../../../capability-guides/access-systems/man
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was encoded onto a card.
-
@@ -545,7 +498,6 @@ Date and time at which the [credential](../../../capability-guides/access-system
Date and time at which the state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) was most recently synced from Seam to the provider.
-
@@ -555,7 +507,6 @@ Date and time at which the state of the [credential](../../../capability-guides/
ID of the parent [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
@@ -565,7 +516,6 @@ ID of the parent [credential](../../../capability-guides/access-systems/managing
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
-
@@ -575,7 +525,6 @@ Date and time at which the [credential](../../../capability-guides/access-system
Visionline-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
@@ -583,7 +532,6 @@ Visionline-specific metadata for the [credential](../../../capability-guides/acc
acs_credential_on_seam.visionline_metadata.auto_join Format: Boolean
-
@@ -595,7 +543,6 @@ Possible enum values:
- `guest`
- `staff`
-
@@ -603,7 +550,6 @@ Possible enum values:
acs_credential_on_seam.visionline_metadata.card_id Format: String
-
@@ -611,7 +557,6 @@ Possible enum values:
acs_credential_on_seam.visionline_metadata.common_acs_entrance_ids Format: List Item format: UUID
-
@@ -619,7 +564,6 @@ Possible enum values:
acs_credential_on_seam.visionline_metadata.credential_id Format: String
-
@@ -627,7 +571,6 @@ Possible enum values:
acs_credential_on_seam.visionline_metadata.guest_acs_entrance_ids Format: List Item format: UUID
-
@@ -635,7 +578,6 @@ Possible enum values:
acs_credential_on_seam.visionline_metadata.is_valid Format: Boolean
-
@@ -643,7 +585,6 @@ Possible enum values:
acs_credential_on_seam.visionline_metadata.joiner_acs_credential_ids Format: List Item format: UUID
-
@@ -653,7 +594,6 @@ Possible enum values:
Warnings associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
**created_at** Format: Datetime
Date and time at which Seam created the warning.
@@ -688,7 +628,6 @@ Possible enum values:
ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
@@ -696,7 +635,6 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains
warnings Format: List Item format: Object
-
**warning_code** Format: Enum
diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md
index 4ae8be36..26ae37db 100644
--- a/docs/api/acs/entrances/README.md
+++ b/docs/api/acs/entrances/README.md
@@ -31,7 +31,6 @@ ASSA ABLOY Vostio-specific metadata associated with the [entrance](../../../capa
door_name Format: String
-
@@ -39,7 +38,6 @@ ASSA ABLOY Vostio-specific metadata associated with the [entrance](../../../capa
door_number Format: Number
-
@@ -53,7 +51,6 @@ Possible enum values:
- `GuestDoor`
- `Elevator`
-
@@ -61,7 +58,6 @@ Possible enum values:
pms_id Format: String
-
@@ -69,7 +65,6 @@ Possible enum values:
stand_open Format: Boolean
-
---
@@ -101,7 +96,6 @@ dormakaba Community-specific metadata associated with the [entrance](../../../ca
access_point_name Format: String
-
---
@@ -121,7 +115,6 @@ Errors associated with the [entrance](../../../capability-guides/access-systems/
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
-
@@ -131,7 +124,6 @@ Unique identifier of the type of error. Enables quick recognition and categoriza
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
-
---
@@ -147,7 +139,6 @@ Latch-specific metadata associated with the [entrance](../../../capability-guide
accessibility_type Format: String
-
@@ -155,7 +146,6 @@ Latch-specific metadata associated with the [entrance](../../../capability-guide
door_name Format: String
-
@@ -163,7 +153,6 @@ Latch-specific metadata associated with the [entrance](../../../capability-guide
door_type Format: String
-
@@ -171,7 +160,6 @@ Latch-specific metadata associated with the [entrance](../../../capability-guide
is_connected Format: Boolean
-
---
@@ -187,7 +175,6 @@ Salto KS-specific metadata associated with the [entrance](../../../capability-gu
battery_level Format: String
-
@@ -195,7 +182,6 @@ Salto KS-specific metadata associated with the [entrance](../../../capability-gu
door_name Format: String
-
@@ -203,7 +189,6 @@ Salto KS-specific metadata associated with the [entrance](../../../capability-gu
intrusion_alarm Format: Boolean
-
@@ -211,7 +196,6 @@ Salto KS-specific metadata associated with the [entrance](../../../capability-gu
left_open_alarm Format: Boolean
-
@@ -219,7 +203,6 @@ Salto KS-specific metadata associated with the [entrance](../../../capability-gu
lock_type Format: String
-
@@ -227,7 +210,6 @@ Salto KS-specific metadata associated with the [entrance](../../../capability-gu
locked_state Format: String
-
@@ -235,7 +217,6 @@ Salto KS-specific metadata associated with the [entrance](../../../capability-gu
online Format: Boolean
-
@@ -243,7 +224,6 @@ Salto KS-specific metadata associated with the [entrance](../../../capability-gu
privacy_mode Format: Boolean
-
---
@@ -259,7 +239,6 @@ Salto Space-specific metadata associated with the [entrance](../../../capability
door_description Format: String
-
@@ -267,7 +246,6 @@ Salto Space-specific metadata associated with the [entrance](../../../capability
door_name Format: String
-
@@ -275,7 +253,6 @@ Salto Space-specific metadata associated with the [entrance](../../../capability
ext_door_id Format: String
-
---
@@ -298,7 +275,6 @@ Possible enum values:
- `common`
- `common (PMS)`
-
@@ -306,7 +282,6 @@ Possible enum values:
door_name Format: String
-
@@ -314,7 +289,6 @@ Possible enum values:
profiles Format: List Item format: Object
-
**visionline_door_profile_id** Format: String
@@ -361,7 +335,6 @@ An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entra
acs_entrance_id Format: UUID
-
@@ -371,7 +344,6 @@ An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entra
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-
@@ -381,7 +353,6 @@ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-syst
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-
@@ -391,7 +362,6 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m
Date and time at which the event was created.
-
@@ -401,7 +371,6 @@ Date and time at which the event was created.
ID of the event.
-
@@ -409,7 +378,6 @@ ID of the event.
event_type Format: String
-
@@ -419,7 +387,6 @@ ID of the event.
Date and time at which the event occurred.
-
@@ -429,7 +396,6 @@ Date and time at which the event occurred.
ID of the [workspace](../../../core-concepts/workspaces/README.md).
-
---
@@ -443,7 +409,6 @@ An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entra
acs_entrance_id Format: UUID
-
@@ -453,7 +418,6 @@ An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entra
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-
@@ -463,7 +427,6 @@ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-syst
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-
@@ -473,7 +436,6 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m
Date and time at which the event was created.
-
@@ -483,7 +445,6 @@ Date and time at which the event was created.
ID of the event.
-
@@ -491,7 +452,6 @@ ID of the event.
event_type Format: String
-
@@ -501,7 +461,6 @@ ID of the event.
Date and time at which the event occurred.
-
@@ -511,7 +470,6 @@ Date and time at which the event occurred.
ID of the [workspace](../../../core-concepts/workspaces/README.md).
-
---
diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md
index d2f242b8..9d7bfd78 100644
--- a/docs/api/acs/systems/README.md
+++ b/docs/api/acs/systems/README.md
@@ -158,7 +158,6 @@ Format: `Object`
Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located.
-
---
@@ -217,7 +216,6 @@ Format: `Object`
IP address or hostname of the main Visionline server relative to [Seam Bridge](../../../capability-guides/seam-bridge.md) on the local network.
-
@@ -227,7 +225,6 @@ IP address or hostname of the main Visionline server relative to [Seam Bridge](.
Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset.
-
@@ -237,7 +234,6 @@ Keyset loaded into a reader. Mobile keys and reader administration tools securel
Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager.
-
---
@@ -344,7 +340,6 @@ An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) wa
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-
@@ -354,7 +349,6 @@ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-syst
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-
@@ -364,7 +358,6 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m
Date and time at which the event was created.
-
@@ -374,7 +367,6 @@ Date and time at which the event was created.
ID of the event.
-
@@ -382,7 +374,6 @@ ID of the event.
event_type Format: String
-
@@ -392,7 +383,6 @@ ID of the event.
Date and time at which the event occurred.
-
@@ -402,7 +392,6 @@ Date and time at which the event occurred.
ID of the [workspace](../../../core-concepts/workspaces/README.md).
-
---
@@ -418,7 +407,6 @@ An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) wa
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-
@@ -428,7 +416,6 @@ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-syst
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-
@@ -438,7 +425,6 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m
Date and time at which the event was created.
-
@@ -448,7 +434,6 @@ Date and time at which the event was created.
ID of the event.
-
@@ -456,7 +441,6 @@ ID of the event.
event_type Format: String
-
@@ -466,7 +450,6 @@ ID of the event.
Date and time at which the event occurred.
-
@@ -476,7 +459,6 @@ Date and time at which the event occurred.
ID of the [workspace](../../../core-concepts/workspaces/README.md).
-
---
@@ -492,7 +474,6 @@ An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) wa
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-
@@ -502,7 +483,6 @@ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-syst
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-
@@ -512,7 +492,6 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m
Date and time at which the event was created.
-
@@ -522,7 +501,6 @@ Date and time at which the event was created.
ID of the event.
-
@@ -530,7 +508,6 @@ ID of the event.
event_type Format: String
-
@@ -540,7 +517,6 @@ ID of the event.
Date and time at which the event occurred.
-
@@ -550,7 +526,6 @@ Date and time at which the event occurred.
ID of the [workspace](../../../core-concepts/workspaces/README.md).
-
---
diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md
index b0345f8a..fc1bb285 100644
--- a/docs/api/acs/users/README.md
+++ b/docs/api/acs/users/README.md
@@ -17,7 +17,6 @@ Format: `Object`
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.
-
@@ -27,7 +26,6 @@ Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org
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.
-
---
@@ -306,7 +304,6 @@ An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-
@@ -314,7 +311,6 @@ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-syst
acs_user_id Format: UUID
-
@@ -324,7 +320,6 @@ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-syst
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-
@@ -334,7 +329,6 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m
Date and time at which the event was created.
-
@@ -344,7 +338,6 @@ Date and time at which the event was created.
ID of the event.
-
@@ -352,7 +345,6 @@ ID of the event.
event_type Format: String
-
@@ -362,7 +354,6 @@ ID of the event.
Date and time at which the event occurred.
-
@@ -372,7 +363,6 @@ Date and time at which the event occurred.
ID of the [workspace](../../../core-concepts/workspaces/README.md).
-
---
diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md
index ea94c934..6ac9076c 100644
--- a/docs/api/phones/README.md
+++ b/docs/api/phones/README.md
@@ -61,7 +61,6 @@ Errors associated with the `phone`.
error_code Format: String
-
@@ -69,7 +68,6 @@ Errors associated with the `phone`.
message Format: String
-
---
@@ -95,7 +93,6 @@ Properties of the phone.
ASSA ABLOY Credential Service metadata for the phone.
-
@@ -105,7 +102,6 @@ ASSA ABLOY Credential Service metadata for the phone.
Endpoints associated with the phone.
-
**endpoint_id** Format: String
ID of the associated endpoint.
@@ -127,7 +123,6 @@ Indicated whether the endpoint is active.
Indicates whether the credential service has active endpoints associated with the phone.
-
@@ -137,7 +132,6 @@ Indicates whether the credential service has active endpoints associated with th
Salto Space credential service metadata for the phone.
-
@@ -147,7 +141,6 @@ Salto Space credential service metadata for the phone.
Indicates whether the credential service has an active associated phone.
-
---
@@ -165,7 +158,6 @@ Warnings associated with the `phone`.
message Format: String
-
@@ -173,7 +165,6 @@ Warnings associated with the `phone`.
warning_code Format: String
-
---
@@ -213,7 +204,6 @@ A phone device was deactivated.
Date and time at which the event was created.
-
@@ -223,7 +213,6 @@ Date and time at which the event was created.
ID of the [device](../../core-concepts/devices/README.md).
-
@@ -233,7 +222,6 @@ ID of the [device](../../core-concepts/devices/README.md).
ID of the event.
-
@@ -241,7 +229,6 @@ ID of the event.
event_type Format: String
-
@@ -251,7 +238,6 @@ ID of the event.
Date and time at which the event occurred.
-
@@ -261,7 +247,6 @@ Date and time at which the event occurred.
ID of the [workspace](../../core-concepts/workspaces/README.md).
-
---
diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md
index 459edb33..01db7d7a 100644
--- a/docs/api/thermostats/activate_climate_preset.md
+++ b/docs/api/thermostats/activate_climate_preset.md
@@ -195,7 +195,6 @@ Format: `Object`
message Format: String
-
@@ -203,7 +202,6 @@ Format: `Object`
type Format: String
-
---
diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md
index 0a2b1a79..cdbe8810 100644
--- a/docs/api/thermostats/cool.md
+++ b/docs/api/thermostats/cool.md
@@ -205,7 +205,6 @@ Format: `Object`
message Format: String
-
@@ -213,7 +212,6 @@ Format: `Object`
type Format: String
-
---
diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md
index 9bdadc97..aa6d3f2e 100644
--- a/docs/api/thermostats/heat.md
+++ b/docs/api/thermostats/heat.md
@@ -205,7 +205,6 @@ Format: `Object`
message Format: String
-
@@ -213,7 +212,6 @@ Format: `Object`
type Format: String
-
---
diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md
index cf4dce1f..2b085d1e 100644
--- a/docs/api/thermostats/heat_cool.md
+++ b/docs/api/thermostats/heat_cool.md
@@ -229,7 +229,6 @@ Format: `Object`
message Format: String
-
@@ -237,7 +236,6 @@ Format: `Object`
type Format: String
-
---
diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md
index 51ffdb07..97b85fa1 100644
--- a/docs/api/thermostats/off.md
+++ b/docs/api/thermostats/off.md
@@ -177,7 +177,6 @@ Format: `Object`
message Format: String
-
@@ -185,7 +184,6 @@ Format: `Object`
type Format: String
-
---
diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md
index d41cb991..d9183fc0 100644
--- a/docs/api/thermostats/schedules/README.md
+++ b/docs/api/thermostats/schedules/README.md
@@ -51,7 +51,6 @@ Errors associated with the [thermostat schedule](../../../capability-guides/ther
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
-
@@ -61,7 +60,6 @@ Unique identifier of the type of error. Enables quick recognition and categoriza
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
-
---
diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md
index 5424b213..c5942c85 100644
--- a/docs/api/thermostats/set_fan_mode.md
+++ b/docs/api/thermostats/set_fan_mode.md
@@ -205,7 +205,6 @@ Format: `Object`
message Format: String
-
@@ -213,7 +212,6 @@ Format: `Object`
type Format: String
-
---
diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md
index c8636c6c..5b4890b4 100644
--- a/docs/api/thermostats/set_hvac_mode.md
+++ b/docs/api/thermostats/set_hvac_mode.md
@@ -243,7 +243,6 @@ Format: `Object`
message Format: String
-
@@ -251,7 +250,6 @@ Format: `Object`
type Format: String
-
---
diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md
index 8d33daf1..5043fcec 100644
--- a/docs/api/user_identities/enrollment_automations/README.md
+++ b/docs/api/user_identities/enrollment_automations/README.md
@@ -74,7 +74,6 @@ An [enrollment automation](../../../capability-guides/mobile-access/issuing-mobi
Date and time at which the event was created.
-
@@ -84,7 +83,6 @@ Date and time at which the event was created.
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).
-
@@ -94,7 +92,6 @@ ID of the [enrollment automation](../../../capability-guides/mobile-access/issui
ID of the event.
-
@@ -102,7 +99,6 @@ ID of the event.
event_type Format: String
-
@@ -112,7 +108,6 @@ ID of the event.
Date and time at which the event occurred.
-
@@ -122,7 +117,6 @@ Date and time at which the event occurred.
ID of the [workspace](../../../core-concepts/workspaces/README.md).
-
---
From 7091b71bcaf12f366ab8fa2a485e483ac8080e2c Mon Sep 17 00:00:00 2001
From: Andrii Balitskyi <10balian10@gmail.com>
Date: Thu, 20 Mar 2025 15:12:55 +0100
Subject: [PATCH 07/18] Fix indentation
---
src/layouts/partials/property-content.hbs | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/src/layouts/partials/property-content.hbs b/src/layouts/partials/property-content.hbs
index 3f4a3ee0..5eddb89f 100644
--- a/src/layouts/partials/property-content.hbs
+++ b/src/layouts/partials/property-content.hbs
@@ -1,21 +1,21 @@
{{#if isDeprecated}}
-
{{> deprecated-warning}}
+
{{/if}}
{{#if description}}
-
{{description}}
+
{{/if}}
{{#if enumValues}}
-
Possible enum values:
{{#each enumValues}}
- `{{this}}`
{{/each}}
+
{{/if}}
{{#if listProperties}}
{{#each listProperties}}
-
{{> property-nested this}}
+
{{/each}}
{{/if}}
\ No newline at end of file
From 6b75e7cdcec86b0b37a0f7243ecf9f2d9ccb7b4b Mon Sep 17 00:00:00 2001
From: Seam Bot
Date: Thu, 20 Mar 2025 14:14:08 +0000
Subject: [PATCH 08/18] ci: Generate docs
---
docs/api/acs/access_groups/README.md | 18 ++--
docs/api/acs/credentials/README.md | 38 ++++----
docs/api/acs/encoders/README.md | 34 +++----
docs/api/acs/encoders/encode_credential.md | 52 +++++------
docs/api/acs/encoders/scan_credential.md | 92 +++++++++----------
docs/api/acs/entrances/README.md | 34 +++----
docs/api/acs/systems/README.md | 44 ++++-----
docs/api/acs/users/README.md | 16 ++--
docs/api/phones/README.md | 20 ++--
docs/api/thermostats/schedules/README.md | 4 +-
.../enrollment_automations/README.md | 10 +-
11 files changed, 181 insertions(+), 181 deletions(-)
diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md
index 3de65f1a..3a2743c2 100644
--- a/docs/api/acs/access_groups/README.md
+++ b/docs/api/acs/access_groups/README.md
@@ -113,27 +113,27 @@ Warnings associated with the `acs_access_group`.
created_at Format: Datetime
-
Date and time at which Seam created the warning.
+
message Format: String
-
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+
warning_code Format: String
-
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+
---
@@ -186,36 +186,36 @@ An ACS access group was deleted.
acs_system_id Format: UUID
-
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
+
connected_account_id Format: UUID
-
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
+
created_at Format: Datetime
-
Date and time at which the event was created.
+
event_id Format: UUID
-
ID of the event.
+
@@ -229,18 +229,18 @@ ID of the event.
occurred_at Format: Datetime
-
Date and time at which the event occurred.
+
workspace_id Format: UUID
-
ID of the [workspace](../../../core-concepts/workspaces/README.md).
+
---
diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md
index eff0b90b..9bd5b284 100644
--- a/docs/api/acs/credentials/README.md
+++ b/docs/api/acs/credentials/README.md
@@ -266,11 +266,11 @@ Visionline-specific metadata for the [credential](../../../capability-guides/acc
card_function_type Format: Enum
-
Possible enum values:
- `guest`
- `staff`
+
@@ -419,36 +419,36 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia
acs_system_id Format: UUID
-
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
+
connected_account_id Format: UUID
-
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
+
created_at Format: Datetime
-
Date and time at which the event was created.
+
event_id Format: UUID
-
ID of the event.
+
@@ -462,18 +462,18 @@ ID of the event.
occurred_at Format: Datetime
-
Date and time at which the event occurred.
+
workspace_id Format: UUID
-
ID of the [workspace](../../../core-concepts/workspaces/README.md).
+
---
@@ -493,36 +493,36 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia
acs_system_id Format: UUID
-
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
+
connected_account_id Format: UUID
-
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
+
created_at Format: Datetime
-
Date and time at which the event was created.
+
event_id Format: UUID
-
ID of the event.
+
@@ -536,18 +536,18 @@ ID of the event.
occurred_at Format: Datetime
-
Date and time at which the event occurred.
+
workspace_id Format: UUID
-
ID of the [workspace](../../../core-concepts/workspaces/README.md).
+
---
@@ -567,36 +567,36 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia
acs_system_id Format: UUID
-
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
+
connected_account_id Format: UUID
-
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
+
created_at Format: Datetime
-
Date and time at which the event was created.
+
event_id Format: UUID
-
ID of the event.
+
@@ -610,18 +610,18 @@ ID of the event.
occurred_at Format: Datetime
-
Date and time at which the event occurred.
+
workspace_id Format: UUID
-
ID of the [workspace](../../../core-concepts/workspaces/README.md).
+
---
diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md
index 052e792f..9faac7f2 100644
--- a/docs/api/acs/encoders/README.md
+++ b/docs/api/acs/encoders/README.md
@@ -48,27 +48,27 @@ Errors associated with the [encoder](../../../capability-guides/access-systems/w
created_at Format: Datetime
-
Date and time at which Seam created the error.
+
error_code Format: String
-
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
message Format: String
-
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
---
@@ -105,45 +105,45 @@ An [ACS encoder](../../../capability-guides/access-systems/working-with-card-enc
acs_encoder_id Format: UUID
-
ID of the [ACS encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
+
acs_system_id Format: UUID
-
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
+
connected_account_id Format: UUID
-
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
+
created_at Format: Datetime
-
Date and time at which the event was created.
+
event_id Format: UUID
-
ID of the event.
+
@@ -157,18 +157,18 @@ ID of the event.
occurred_at Format: Datetime
-
Date and time at which the event occurred.
+
workspace_id Format: UUID
-
ID of the [workspace](../../../core-concepts/workspaces/README.md).
+
---
@@ -181,45 +181,45 @@ An [ACS encoder](../../../capability-guides/access-systems/working-with-card-enc
acs_encoder_id Format: UUID
-
ID of the [ACS encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
+
acs_system_id Format: UUID
-
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
+
connected_account_id Format: UUID
-
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
+
created_at Format: Datetime
-
Date and time at which the event was created.
+
event_id Format: UUID
-
ID of the event.
+
@@ -233,18 +233,18 @@ ID of the event.
occurred_at Format: Datetime
-
Date and time at which the event occurred.
+
workspace_id Format: UUID
-
ID of the [workspace](../../../core-concepts/workspaces/README.md).
+
---
diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md
index 21aca3df..7a9d66a9 100644
--- a/docs/api/acs/encoders/encode_credential.md
+++ b/docs/api/acs/encoders/encode_credential.md
@@ -69,7 +69,6 @@ Format: `Object`
type Format: Enum
-
Possible enum values:
- `uncategorized_error`
- `action_attempt_expired`
@@ -77,6 +76,7 @@ Possible enum values:
- `incompatible_card_format`
- `credential_cannot_be_reissued`
+
---
@@ -91,7 +91,6 @@ Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/acces
access_method Format: Enum
-
Access method for the [credential](../../../capability-guides/access-systems/managing-credentials.md). Supported values: `code`, `card`, `mobile_key`.
Possible enum values:
@@ -99,15 +98,16 @@ Possible enum values:
- `card`
- `mobile_key`
+
acs_credential_id Format: UUID
-
ID of the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
@@ -121,27 +121,27 @@ ID of the [credential](../../../capability-guides/access-systems/managing-creden
acs_system_id Format: UUID
-
ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
acs_user_id Format: UUID
-
ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](../../../capability-guides/access-systems/managing-credentials.md) belongs.
+
assa_abloy_vostio_metadata Format: Object
-
Vostio-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
@@ -183,52 +183,51 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access-
card_number Format: String
-
Number of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
code Format: String
-
Access (PIN) code for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
created_at Format: Datetime
-
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was created.
+
display_name Format: String
-
Display name that corresponds to the [credential](../../../capability-guides/access-systems/managing-credentials.md) type.
+
ends_at Format: String
-
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
+
errors Format: List Item format: Object
-
Errors associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
**error_code** Format: String
@@ -241,13 +240,13 @@ Errors associated with the [credential](../../../capability-guides/access-system
+
external_type Format: Enum
-
Brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.
Possible enum values:
@@ -259,33 +258,34 @@ Possible enum values:
- `assa_abloy_vostio_key`
- `salto_space_key`
+
external_type_display_name Format: String
-
Display name that corresponds to the brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type.
+
is_issued Format: Boolean
-
Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been encoded onto a card.
+
is_latest_desired_state_synced_with_provider Format: Boolean
-
Indicates whether the latest state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been synced from Seam to the provider.
+
@@ -299,63 +299,63 @@ Indicates whether the latest state of the [credential](../../../capability-guide
is_multi_phone_sync_credential Format: Boolean
-
Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).
+
is_one_time_use Format: Boolean
-
Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) can only be used once. If `true`, the code becomes invalid after the first use.
+
issued_at Format: Datetime
-
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was encoded onto a card.
+
latest_desired_state_synced_with_provider_at Format: Datetime
-
Date and time at which the state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) was most recently synced from Seam to the provider.
+
parent_acs_credential_id Format: UUID
-
ID of the parent [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
starts_at Format: String
-
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+
visionline_metadata Format: Object
-
Visionline-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
@@ -369,11 +369,11 @@ Visionline-specific metadata for the [credential](../../../capability-guides/acc
visionline_metadata.card_function_type Format: Enum
-
Possible enum values:
- `guest`
- `staff`
+
@@ -422,7 +422,6 @@ Possible enum values:
warnings Format: List Item format: Object
-
Warnings associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
**created_at** Format: Datetime
@@ -450,15 +449,16 @@ Possible enum values:
- `needs_to_be_reissued`
+
workspace_id Format: UUID
-
ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
---
diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md
index b2e6b922..3e6c3358 100644
--- a/docs/api/acs/encoders/scan_credential.md
+++ b/docs/api/acs/encoders/scan_credential.md
@@ -60,12 +60,12 @@ Format: `Object`
type Format: Enum
-
Possible enum values:
- `uncategorized_error`
- `action_attempt_expired`
- `no_credential_on_encoder`
+
---
@@ -78,36 +78,36 @@ Format: `Object`
acs_credential_on_encoder Format: Object
-
Snapshot of credential data read from physical encoder.
+
acs_credential_on_encoder.card_number Format: String
-
A number or string that physically identifies the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
acs_credential_on_encoder.created_at Format: Datetime
-
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was created.
+
acs_credential_on_encoder.ends_at Format: Datetime
-
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) will stop being usable.
+
@@ -121,146 +121,145 @@ Date and time at which the [credential](../../../capability-guides/access-system
acs_credential_on_encoder.starts_at Format: Datetime
-
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) becomes usable.
+
acs_credential_on_encoder.visionline_metadata Format: Object
-
Visionline-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
acs_credential_on_encoder.visionline_metadata.cancelled Format: Boolean
-
Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is cancelled.
+
acs_credential_on_encoder.visionline_metadata.card_format Format: Enum
-
Format of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
Possible enum values:
- `TLCode`
- `rfid48`
+
acs_credential_on_encoder.visionline_metadata.card_holder Format: String
-
Holden of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
acs_credential_on_encoder.visionline_metadata.card_id Format: String
-
Card ID for the Visionline card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
acs_credential_on_encoder.visionline_metadata.common_acs_entrance_ids Format: List Item format: UUID
-
IDs of the common [entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md) for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
acs_credential_on_encoder.visionline_metadata.discarded Format: Boolean
-
Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is discarded.
+
acs_credential_on_encoder.visionline_metadata.expired Format: Boolean
-
Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is expired.
+
acs_credential_on_encoder.visionline_metadata.guest_acs_entrance_ids Format: List Item format: UUID
-
IDs of the guest [entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md) for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
acs_credential_on_encoder.visionline_metadata.number_of_issued_cards Format: Number
-
Number of issued cards associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
acs_credential_on_encoder.visionline_metadata.overridden Format: Boolean
-
Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is overridden.
+
acs_credential_on_encoder.visionline_metadata.overwritten Format: Boolean
-
Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is overwritten.
+
acs_credential_on_encoder.visionline_metadata.pending_auto_update Format: Boolean
-
Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is pending auto-update.
+
acs_credential_on_seam Format: Object
-
Matching acs_credential currently encoded on this card.
+
acs_credential_on_seam.access_method Format: Enum
-
Access method for the [credential](../../../capability-guides/access-systems/managing-credentials.md). Supported values: `code`, `card`, `mobile_key`.
Possible enum values:
@@ -268,15 +267,16 @@ Possible enum values:
- `card`
- `mobile_key`
+
acs_credential_on_seam.acs_credential_id Format: UUID
-
ID of the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
@@ -290,27 +290,27 @@ ID of the [credential](../../../capability-guides/access-systems/managing-creden
acs_credential_on_seam.acs_system_id Format: UUID
-
ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
acs_credential_on_seam.acs_user_id Format: UUID
-
ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](../../../capability-guides/access-systems/managing-credentials.md) belongs.
+
acs_credential_on_seam.assa_abloy_vostio_metadata Format: Object
-
Vostio-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
@@ -352,52 +352,51 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access-
acs_credential_on_seam.card_number Format: String
-
Number of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
acs_credential_on_seam.code Format: String
-
Access (PIN) code for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
acs_credential_on_seam.created_at Format: Datetime
-
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was created.
+
acs_credential_on_seam.display_name Format: String
-
Display name that corresponds to the [credential](../../../capability-guides/access-systems/managing-credentials.md) type.
+
acs_credential_on_seam.ends_at Format: String
-
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
+
acs_credential_on_seam.errors Format: List Item format: Object
-
Errors associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
**error_code** Format: String
@@ -410,13 +409,13 @@ Errors associated with the [credential](../../../capability-guides/access-system
+
acs_credential_on_seam.external_type Format: Enum
-
Brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.
Possible enum values:
@@ -428,33 +427,34 @@ Possible enum values:
- `assa_abloy_vostio_key`
- `salto_space_key`
+
acs_credential_on_seam.external_type_display_name Format: String
-
Display name that corresponds to the brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type.
+
acs_credential_on_seam.is_issued Format: Boolean
-
Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been encoded onto a card.
+
acs_credential_on_seam.is_latest_desired_state_synced_with_provider Format: Boolean
-
Indicates whether the latest state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been synced from Seam to the provider.
+
@@ -468,63 +468,63 @@ Indicates whether the latest state of the [credential](../../../capability-guide
acs_credential_on_seam.is_multi_phone_sync_credential Format: Boolean
-
Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).
+
acs_credential_on_seam.is_one_time_use Format: Boolean
-
Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) can only be used once. If `true`, the code becomes invalid after the first use.
+
acs_credential_on_seam.issued_at Format: Datetime
-
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was encoded onto a card.
+
acs_credential_on_seam.latest_desired_state_synced_with_provider_at Format: Datetime
-
Date and time at which the state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) was most recently synced from Seam to the provider.
+
acs_credential_on_seam.parent_acs_credential_id Format: UUID
-
ID of the parent [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
acs_credential_on_seam.starts_at Format: String
-
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+
acs_credential_on_seam.visionline_metadata Format: Object
-
Visionline-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
@@ -538,11 +538,11 @@ Visionline-specific metadata for the [credential](../../../capability-guides/acc
acs_credential_on_seam.visionline_metadata.card_function_type Format: Enum
-
Possible enum values:
- `guest`
- `staff`
+
@@ -591,7 +591,6 @@ Possible enum values:
acs_credential_on_seam.warnings Format: List Item format: Object
-
Warnings associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
**created_at** Format: Datetime
@@ -619,22 +618,22 @@ Possible enum values:
- `needs_to_be_reissued`
+
acs_credential_on_seam.workspace_id Format: UUID
-
ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
warnings Format: List Item format: Object
-
**warning_code** Format: Enum
@@ -648,6 +647,7 @@ Possible enum values:
+
---
diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md
index 26ae37db..ee2c6446 100644
--- a/docs/api/acs/entrances/README.md
+++ b/docs/api/acs/entrances/README.md
@@ -44,13 +44,13 @@ ASSA ABLOY Vostio-specific metadata associated with the [entrance](../../../capa
door_type Format: Enum
-
Possible enum values:
- `CommonDoor`
- `EntranceDoor`
- `GuestDoor`
- `Elevator`
+
@@ -112,18 +112,18 @@ Errors associated with the [entrance](../../../capability-guides/access-systems/
error_code Format: String
-
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
message Format: String
-
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
---
@@ -267,7 +267,6 @@ Visionline-specific metadata associated with the [entrance](../../../capability-
door_category Format: Enum
-
Possible enum values:
- `entrance`
- `guest`
@@ -275,6 +274,7 @@ Possible enum values:
- `common`
- `common (PMS)`
+
@@ -288,7 +288,6 @@ Possible enum values:
profiles Format: List Item format: Object
-
**visionline_door_profile_id** Format: String
@@ -303,6 +302,7 @@ Possible enum values:
- `touch`
+
---
@@ -341,36 +341,36 @@ An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entra
acs_system_id Format: UUID
-
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
+
connected_account_id Format: UUID
-
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
+
created_at Format: Datetime
-
Date and time at which the event was created.
+
event_id Format: UUID
-
ID of the event.
+
@@ -384,18 +384,18 @@ ID of the event.
occurred_at Format: Datetime
-
Date and time at which the event occurred.
+
workspace_id Format: UUID
-
ID of the [workspace](../../../core-concepts/workspaces/README.md).
+
---
@@ -415,36 +415,36 @@ An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entra
acs_system_id Format: UUID
-
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
+
connected_account_id Format: UUID
-
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
+
created_at Format: Datetime
-
Date and time at which the event was created.
+
event_id Format: UUID
-
ID of the event.
+
@@ -458,18 +458,18 @@ ID of the event.
occurred_at Format: Datetime
-
Date and time at which the event occurred.
+
workspace_id Format: UUID
-
ID of the [workspace](../../../core-concepts/workspaces/README.md).
+
---
diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md
index 9d7bfd78..39719164 100644
--- a/docs/api/acs/systems/README.md
+++ b/docs/api/acs/systems/README.md
@@ -155,9 +155,9 @@ Format: `Object`
time_zone Format: String
-
Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located.
+
---
@@ -213,27 +213,27 @@ Format: `Object`
lan_address Format: String
-
IP address or hostname of the main Visionline server relative to [Seam Bridge](../../../capability-guides/seam-bridge.md) on the local network.
+
mobile_access_uuid Format: String
-
Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset.
+
system_id Format: String
-
Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager.
+
---
@@ -337,36 +337,36 @@ An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) wa
acs_system_id Format: UUID
-
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
+
connected_account_id Format: UUID
-
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
+
created_at Format: Datetime
-
Date and time at which the event was created.
+
event_id Format: UUID
-
ID of the event.
+
@@ -380,18 +380,18 @@ ID of the event.
occurred_at Format: Datetime
-
Date and time at which the event occurred.
+
workspace_id Format: UUID
-
ID of the [workspace](../../../core-concepts/workspaces/README.md).
+
---
@@ -404,36 +404,36 @@ An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) wa
acs_system_id Format: UUID
-
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
+
connected_account_id Format: UUID
-
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
+
created_at Format: Datetime
-
Date and time at which the event was created.
+
event_id Format: UUID
-
ID of the event.
+
@@ -447,18 +447,18 @@ ID of the event.
occurred_at Format: Datetime
-
Date and time at which the event occurred.
+
workspace_id Format: UUID
-
ID of the [workspace](../../../core-concepts/workspaces/README.md).
+
---
@@ -471,36 +471,36 @@ An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) wa
acs_system_id Format: UUID
-
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
+
connected_account_id Format: UUID
-
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
+
created_at Format: Datetime
-
Date and time at which the event was created.
+
event_id Format: UUID
-
ID of the event.
+
@@ -514,18 +514,18 @@ ID of the event.
occurred_at Format: Datetime
-
Date and time at which the event occurred.
+
workspace_id Format: UUID
-
ID of the [workspace](../../../core-concepts/workspaces/README.md).
+
---
diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md
index fc1bb285..3e5d0b76 100644
--- a/docs/api/acs/users/README.md
+++ b/docs/api/acs/users/README.md
@@ -14,18 +14,18 @@ Format: `Object`
ends_at Format: Datetime
-
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.
+
starts_at Format: Datetime
-
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.
+
---
@@ -301,9 +301,9 @@ An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-
acs_system_id Format: UUID
-
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
+
@@ -317,27 +317,27 @@ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-syst
connected_account_id Format: UUID
-
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
+
created_at Format: Datetime
-
Date and time at which the event was created.
+
event_id Format: UUID
-
ID of the event.
+
@@ -351,18 +351,18 @@ ID of the event.
occurred_at Format: Datetime
-
Date and time at which the event occurred.
+
workspace_id Format: UUID
-
ID of the [workspace](../../../core-concepts/workspaces/README.md).
+
---
diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md
index 6ac9076c..c8fcef0e 100644
--- a/docs/api/phones/README.md
+++ b/docs/api/phones/README.md
@@ -90,16 +90,15 @@ Properties of the phone.
assa_abloy_credential_service_metadata Format: Object
-
ASSA ABLOY Credential Service metadata for the phone.
+
assa_abloy_credential_service_metadata.endpoints Format: List Item format: Object
-
Endpoints associated with the phone.
**endpoint_id** Format: String
@@ -114,33 +113,34 @@ Indicated whether the endpoint is active.
+
assa_abloy_credential_service_metadata.has_active_endpoint Format: Boolean
-
Indicates whether the credential service has active endpoints associated with the phone.
+
salto_space_credential_service_metadata Format: Object
-
Salto Space credential service metadata for the phone.
+
salto_space_credential_service_metadata.has_active_phone Format: Boolean
-
Indicates whether the credential service has an active associated phone.
+
---
@@ -201,27 +201,27 @@ A phone device was deactivated.
created_at Format: Datetime
-
Date and time at which the event was created.
+
device_id Format: UUID
-
ID of the [device](../../core-concepts/devices/README.md).
+
event_id Format: UUID
-
ID of the event.
+
@@ -235,18 +235,18 @@ ID of the event.
occurred_at Format: Datetime
-
Date and time at which the event occurred.
+
workspace_id Format: UUID
-
ID of the [workspace](../../core-concepts/workspaces/README.md).
+
---
diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md
index d9183fc0..6652e179 100644
--- a/docs/api/thermostats/schedules/README.md
+++ b/docs/api/thermostats/schedules/README.md
@@ -48,18 +48,18 @@ Errors associated with the [thermostat schedule](../../../capability-guides/ther
error_code Format: String
-
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
message Format: String
-
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+
---
diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md
index 5043fcec..8d286d7f 100644
--- a/docs/api/user_identities/enrollment_automations/README.md
+++ b/docs/api/user_identities/enrollment_automations/README.md
@@ -71,27 +71,27 @@ An [enrollment automation](../../../capability-guides/mobile-access/issuing-mobi
created_at Format: Datetime
-
Date and time at which the event was created.
+
enrollment_automation_id Format: UUID
-
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).
+
event_id Format: UUID
-
ID of the event.
+
@@ -105,18 +105,18 @@ ID of the event.
occurred_at Format: Datetime
-
Date and time at which the event occurred.
+
workspace_id Format: UUID
-
ID of the [workspace](../../../core-concepts/workspaces/README.md).
+
---
From eba34beff6ac0e6e6955333f51c360ba6096c30f Mon Sep 17 00:00:00 2001
From: Andrii Balitskyi <10balian10@gmail.com>
Date: Thu, 20 Mar 2025 15:17:43 +0100
Subject: [PATCH 09/18] Fix indentation
---
src/layouts/partials/property-collapsible.hbs | 1 -
1 file changed, 1 deletion(-)
diff --git a/src/layouts/partials/property-collapsible.hbs b/src/layouts/partials/property-collapsible.hbs
index 0c3bfb4f..9567314c 100644
--- a/src/layouts/partials/property-collapsible.hbs
+++ b/src/layouts/partials/property-collapsible.hbs
@@ -3,5 +3,4 @@
{{name}} Format: {{format}}{{#if listItemFormat}} Item format: {{listItemFormat}}{{/if}}
{{> property-content}}
-
From e328d9640ae71ee408bf7cdfe456c8250e0726ce Mon Sep 17 00:00:00 2001
From: Seam Bot
Date: Thu, 20 Mar 2025 14:18:58 +0000
Subject: [PATCH 10/18] ci: Generate docs
---
docs/api/acs/access_groups/README.md | 11 ----
docs/api/acs/credentials/README.md | 39 ------------
docs/api/acs/encoders/README.md | 19 ------
docs/api/acs/encoders/encode_credential.md | 41 ------------
docs/api/acs/encoders/scan_credential.md | 62 -------------------
docs/api/acs/entrances/README.md | 42 -------------
docs/api/acs/systems/README.md | 25 --------
docs/api/acs/users/README.md | 10 ---
docs/api/phones/README.md | 15 -----
.../thermostats/activate_climate_preset.md | 2 -
docs/api/thermostats/cool.md | 2 -
docs/api/thermostats/heat.md | 2 -
docs/api/thermostats/heat_cool.md | 2 -
docs/api/thermostats/off.md | 2 -
docs/api/thermostats/schedules/README.md | 2 -
docs/api/thermostats/set_fan_mode.md | 2 -
docs/api/thermostats/set_hvac_mode.md | 2 -
.../enrollment_automations/README.md | 6 --
18 files changed, 286 deletions(-)
diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md
index 3a2743c2..afbc61aa 100644
--- a/docs/api/acs/access_groups/README.md
+++ b/docs/api/acs/access_groups/README.md
@@ -115,7 +115,6 @@ Warnings associated with the `acs_access_group`.
Date and time at which Seam created the warning.
-
@@ -124,7 +123,6 @@ Date and time at which Seam created the warning.
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
-
@@ -133,7 +131,6 @@ Detailed description of the warning. Provides insights into the issue and potent
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
-
---
@@ -179,7 +176,6 @@ An ACS access group was deleted.
acs_access_group_id Format: UUID
-
@@ -188,7 +184,6 @@ An ACS access group was deleted.
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-
@@ -197,7 +192,6 @@ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-syst
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-
@@ -206,7 +200,6 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m
Date and time at which the event was created.
-
@@ -215,14 +208,12 @@ Date and time at which the event was created.
ID of the event.
-
event_type Format: String
-
@@ -231,7 +222,6 @@ ID of the event.
Date and time at which the event occurred.
-
@@ -240,7 +230,6 @@ Date and time at which the event occurred.
ID of the [workspace](../../../core-concepts/workspaces/README.md).
-
---
diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md
index 9bd5b284..564bcd03 100644
--- a/docs/api/acs/credentials/README.md
+++ b/docs/api/acs/credentials/README.md
@@ -57,35 +57,30 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access-
door_names Format: List Item format: String
-
endpoint_id Format: String
-
key_id Format: String
-
key_issuing_request_id Format: String
-
override_guest_acs_entrance_ids Format: List Item format: String
-
---
@@ -142,14 +137,12 @@ Errors associated with the [credential](../../../capability-guides/access-system
error_code Format: String
-
message Format: String
-
---
@@ -259,7 +252,6 @@ Visionline-specific metadata for the [credential](../../../capability-guides/acc
auto_join Format: Boolean
-
@@ -270,49 +262,42 @@ Possible enum values:
- `guest`
- `staff`
-
card_id Format: String
-
common_acs_entrance_ids Format: List Item format: UUID
-
credential_id Format: String
-
guest_acs_entrance_ids Format: List Item format: UUID
-
is_valid Format: Boolean
-
joiner_acs_credential_ids Format: List Item format: UUID
-
---
@@ -412,7 +397,6 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia
acs_credential_id Format: UUID
-
@@ -421,7 +405,6 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-
@@ -430,7 +413,6 @@ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-syst
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-
@@ -439,7 +421,6 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m
Date and time at which the event was created.
-
@@ -448,14 +429,12 @@ Date and time at which the event was created.
ID of the event.
-
event_type Format: String
-
@@ -464,7 +443,6 @@ ID of the event.
Date and time at which the event occurred.
-
@@ -473,7 +451,6 @@ Date and time at which the event occurred.
ID of the [workspace](../../../core-concepts/workspaces/README.md).
-
---
@@ -486,7 +463,6 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia
acs_credential_id Format: UUID
-
@@ -495,7 +471,6 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-
@@ -504,7 +479,6 @@ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-syst
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-
@@ -513,7 +487,6 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m
Date and time at which the event was created.
-
@@ -522,14 +495,12 @@ Date and time at which the event was created.
ID of the event.
-
event_type Format: String
-
@@ -538,7 +509,6 @@ ID of the event.
Date and time at which the event occurred.
-
@@ -547,7 +517,6 @@ Date and time at which the event occurred.
ID of the [workspace](../../../core-concepts/workspaces/README.md).
-
---
@@ -560,7 +529,6 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia
acs_credential_id Format: UUID
-
@@ -569,7 +537,6 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-
@@ -578,7 +545,6 @@ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-syst
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-
@@ -587,7 +553,6 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m
Date and time at which the event was created.
-
@@ -596,14 +561,12 @@ Date and time at which the event was created.
ID of the event.
-
event_type Format: String
-
@@ -612,7 +575,6 @@ ID of the event.
Date and time at which the event occurred.
-
@@ -621,7 +583,6 @@ Date and time at which the event occurred.
ID of the [workspace](../../../core-concepts/workspaces/README.md).
-
---
diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md
index 9faac7f2..c1e2997f 100644
--- a/docs/api/acs/encoders/README.md
+++ b/docs/api/acs/encoders/README.md
@@ -50,7 +50,6 @@ Errors associated with the [encoder](../../../capability-guides/access-systems/w
Date and time at which Seam created the error.
-
@@ -59,7 +58,6 @@ Date and time at which Seam created the error.
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
-
@@ -68,7 +66,6 @@ Unique identifier of the type of error. Enables quick recognition and categoriza
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
-
---
@@ -107,7 +104,6 @@ An [ACS encoder](../../../capability-guides/access-systems/working-with-card-enc
ID of the [ACS encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
-
@@ -116,7 +112,6 @@ ID of the [ACS encoder](../../../capability-guides/access-systems/working-with-c
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-
@@ -125,7 +120,6 @@ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-syst
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-
@@ -134,7 +128,6 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m
Date and time at which the event was created.
-
@@ -143,14 +136,12 @@ Date and time at which the event was created.
ID of the event.
-
event_type Format: String
-
@@ -159,7 +150,6 @@ ID of the event.
Date and time at which the event occurred.
-
@@ -168,7 +158,6 @@ Date and time at which the event occurred.
ID of the [workspace](../../../core-concepts/workspaces/README.md).
-
---
@@ -183,7 +172,6 @@ An [ACS encoder](../../../capability-guides/access-systems/working-with-card-enc
ID of the [ACS encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
-
@@ -192,7 +180,6 @@ ID of the [ACS encoder](../../../capability-guides/access-systems/working-with-c
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-
@@ -201,7 +188,6 @@ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-syst
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-
@@ -210,7 +196,6 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m
Date and time at which the event was created.
-
@@ -219,14 +204,12 @@ Date and time at which the event was created.
ID of the event.
-
event_type Format: String
-
@@ -235,7 +218,6 @@ ID of the event.
Date and time at which the event occurred.
-
@@ -244,7 +226,6 @@ Date and time at which the event occurred.
ID of the [workspace](../../../core-concepts/workspaces/README.md).
-
---
diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md
index 7a9d66a9..e9dd87b1 100644
--- a/docs/api/acs/encoders/encode_credential.md
+++ b/docs/api/acs/encoders/encode_credential.md
@@ -62,7 +62,6 @@ Format: `Object`
message Format: String
-
@@ -76,7 +75,6 @@ Possible enum values:
- `incompatible_card_format`
- `credential_cannot_be_reissued`
-
---
@@ -98,7 +96,6 @@ Possible enum values:
- `card`
- `mobile_key`
-
@@ -107,14 +104,12 @@ Possible enum values:
ID of the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
acs_credential_pool_id Format: UUID
-
@@ -123,7 +118,6 @@ ID of the [credential](../../../capability-guides/access-systems/managing-creden
ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
@@ -132,7 +126,6 @@ ID of the [access control system](https://docs.seam.co/latest/capability-guides/
ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](../../../capability-guides/access-systems/managing-credentials.md) belongs.
-
@@ -141,42 +134,36 @@ ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-system
Vostio-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
assa_abloy_vostio_metadata.door_names Format: List Item format: String
-
assa_abloy_vostio_metadata.endpoint_id Format: String
-
assa_abloy_vostio_metadata.key_id Format: String
-
assa_abloy_vostio_metadata.key_issuing_request_id Format: String
-
assa_abloy_vostio_metadata.override_guest_acs_entrance_ids Format: List Item format: String
-
@@ -185,7 +172,6 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access-
Number of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
@@ -194,7 +180,6 @@ Number of the card associated with the [credential](../../../capability-guides/a
Access (PIN) code for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
@@ -203,7 +188,6 @@ Access (PIN) code for the [credential](../../../capability-guides/access-systems
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was created.
-
@@ -212,7 +196,6 @@ Date and time at which the [credential](../../../capability-guides/access-system
Display name that corresponds to the [credential](../../../capability-guides/access-systems/managing-credentials.md) type.
-
@@ -221,7 +204,6 @@ Display name that corresponds to the [credential](../../../capability-guides/acc
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
-
@@ -240,7 +222,6 @@ Errors associated with the [credential](../../../capability-guides/access-system
-
@@ -258,7 +239,6 @@ Possible enum values:
- `assa_abloy_vostio_key`
- `salto_space_key`
-
@@ -267,7 +247,6 @@ Possible enum values:
Display name that corresponds to the brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type.
-
@@ -276,7 +255,6 @@ Display name that corresponds to the brand-specific terminology for the [credent
Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been encoded onto a card.
-
@@ -285,14 +263,12 @@ Indicates whether the [credential](../../../capability-guides/access-systems/man
Indicates whether the latest state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been synced from Seam to the provider.
-
is_managed Format: Boolean
-
@@ -301,7 +277,6 @@ Indicates whether the latest state of the [credential](../../../capability-guide
Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).
-
@@ -310,7 +285,6 @@ Indicates whether the [credential](../../../capability-guides/access-systems/man
Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) can only be used once. If `true`, the code becomes invalid after the first use.
-
@@ -319,7 +293,6 @@ Indicates whether the [credential](../../../capability-guides/access-systems/man
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was encoded onto a card.
-
@@ -328,7 +301,6 @@ Date and time at which the [credential](../../../capability-guides/access-system
Date and time at which the state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) was most recently synced from Seam to the provider.
-
@@ -337,7 +309,6 @@ Date and time at which the state of the [credential](../../../capability-guides/
ID of the parent [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
@@ -346,7 +317,6 @@ ID of the parent [credential](../../../capability-guides/access-systems/managing
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
-
@@ -355,14 +325,12 @@ Date and time at which the [credential](../../../capability-guides/access-system
Visionline-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
visionline_metadata.auto_join Format: Boolean
-
@@ -373,49 +341,42 @@ Possible enum values:
- `guest`
- `staff`
-
visionline_metadata.card_id Format: String
-
visionline_metadata.common_acs_entrance_ids Format: List Item format: UUID
-
visionline_metadata.credential_id Format: String
-
visionline_metadata.guest_acs_entrance_ids Format: List Item format: UUID
-
visionline_metadata.is_valid Format: Boolean
-
visionline_metadata.joiner_acs_credential_ids Format: List Item format: UUID
-
@@ -449,7 +410,6 @@ Possible enum values:
- `needs_to_be_reissued`
-
@@ -458,7 +418,6 @@ Possible enum values:
ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
---
diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md
index 3e6c3358..6604a5e8 100644
--- a/docs/api/acs/encoders/scan_credential.md
+++ b/docs/api/acs/encoders/scan_credential.md
@@ -53,7 +53,6 @@ Format: `Object`
message Format: String
-
@@ -65,7 +64,6 @@ Possible enum values:
- `action_attempt_expired`
- `no_credential_on_encoder`
-
---
@@ -80,7 +78,6 @@ Format: `Object`
Snapshot of credential data read from physical encoder.
-
@@ -89,7 +86,6 @@ Snapshot of credential data read from physical encoder.
A number or string that physically identifies the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
@@ -98,7 +94,6 @@ A number or string that physically identifies the card associated with the [cred
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was created.
-
@@ -107,14 +102,12 @@ Date and time at which the [credential](../../../capability-guides/access-system
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) will stop being usable.
-
acs_credential_on_encoder.is_issued Format: Boolean
-
@@ -123,7 +116,6 @@ Date and time at which the [credential](../../../capability-guides/access-system
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) becomes usable.
-
@@ -132,7 +124,6 @@ Date and time at which the [credential](../../../capability-guides/access-system
Visionline-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
@@ -141,7 +132,6 @@ Visionline-specific metadata for the [credential](../../../capability-guides/acc
Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is cancelled.
-
@@ -154,7 +144,6 @@ Possible enum values:
- `TLCode`
- `rfid48`
-
@@ -163,7 +152,6 @@ Possible enum values:
Holden of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
@@ -172,7 +160,6 @@ Holden of the card associated with the [credential](../../../capability-guides/a
Card ID for the Visionline card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
@@ -181,7 +168,6 @@ Card ID for the Visionline card associated with the [credential](../../../capabi
IDs of the common [entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md) for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
@@ -190,7 +176,6 @@ IDs of the common [entrances](../../../capability-guides/access-systems/retrievi
Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is discarded.
-
@@ -199,7 +184,6 @@ Indicates whether the card associated with the [credential](../../../capability-
Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is expired.
-
@@ -208,7 +192,6 @@ Indicates whether the card associated with the [credential](../../../capability-
IDs of the guest [entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md) for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
@@ -217,7 +200,6 @@ IDs of the guest [entrances](../../../capability-guides/access-systems/retrievin
Number of issued cards associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
@@ -226,7 +208,6 @@ Number of issued cards associated with the [credential](../../../capability-guid
Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is overridden.
-
@@ -235,7 +216,6 @@ Indicates whether the card associated with the [credential](../../../capability-
Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is overwritten.
-
@@ -244,7 +224,6 @@ Indicates whether the card associated with the [credential](../../../capability-
Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is pending auto-update.
-
@@ -253,7 +232,6 @@ Indicates whether the card associated with the [credential](../../../capability-
Matching acs_credential currently encoded on this card.
-
@@ -267,7 +245,6 @@ Possible enum values:
- `card`
- `mobile_key`
-
@@ -276,14 +253,12 @@ Possible enum values:
ID of the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
acs_credential_on_seam.acs_credential_pool_id Format: UUID
-
@@ -292,7 +267,6 @@ ID of the [credential](../../../capability-guides/access-systems/managing-creden
ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
@@ -301,7 +275,6 @@ ID of the [access control system](https://docs.seam.co/latest/capability-guides/
ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](../../../capability-guides/access-systems/managing-credentials.md) belongs.
-
@@ -310,42 +283,36 @@ ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-system
Vostio-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
acs_credential_on_seam.assa_abloy_vostio_metadata.door_names Format: List Item format: String
-
acs_credential_on_seam.assa_abloy_vostio_metadata.endpoint_id Format: String
-
acs_credential_on_seam.assa_abloy_vostio_metadata.key_id Format: String
-
acs_credential_on_seam.assa_abloy_vostio_metadata.key_issuing_request_id Format: String
-
acs_credential_on_seam.assa_abloy_vostio_metadata.override_guest_acs_entrance_ids Format: List Item format: String
-
@@ -354,7 +321,6 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access-
Number of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
@@ -363,7 +329,6 @@ Number of the card associated with the [credential](../../../capability-guides/a
Access (PIN) code for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
@@ -372,7 +337,6 @@ Access (PIN) code for the [credential](../../../capability-guides/access-systems
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was created.
-
@@ -381,7 +345,6 @@ Date and time at which the [credential](../../../capability-guides/access-system
Display name that corresponds to the [credential](../../../capability-guides/access-systems/managing-credentials.md) type.
-
@@ -390,7 +353,6 @@ Display name that corresponds to the [credential](../../../capability-guides/acc
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
-
@@ -409,7 +371,6 @@ Errors associated with the [credential](../../../capability-guides/access-system
-
@@ -427,7 +388,6 @@ Possible enum values:
- `assa_abloy_vostio_key`
- `salto_space_key`
-
@@ -436,7 +396,6 @@ Possible enum values:
Display name that corresponds to the brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type.
-
@@ -445,7 +404,6 @@ Display name that corresponds to the brand-specific terminology for the [credent
Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been encoded onto a card.
-
@@ -454,14 +412,12 @@ Indicates whether the [credential](../../../capability-guides/access-systems/man
Indicates whether the latest state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been synced from Seam to the provider.
-
acs_credential_on_seam.is_managed Format: Boolean
-
@@ -470,7 +426,6 @@ Indicates whether the latest state of the [credential](../../../capability-guide
Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).
-
@@ -479,7 +434,6 @@ Indicates whether the [credential](../../../capability-guides/access-systems/man
Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) can only be used once. If `true`, the code becomes invalid after the first use.
-
@@ -488,7 +442,6 @@ Indicates whether the [credential](../../../capability-guides/access-systems/man
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was encoded onto a card.
-
@@ -497,7 +450,6 @@ Date and time at which the [credential](../../../capability-guides/access-system
Date and time at which the state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) was most recently synced from Seam to the provider.
-
@@ -506,7 +458,6 @@ Date and time at which the state of the [credential](../../../capability-guides/
ID of the parent [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
@@ -515,7 +466,6 @@ ID of the parent [credential](../../../capability-guides/access-systems/managing
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
-
@@ -524,14 +474,12 @@ Date and time at which the [credential](../../../capability-guides/access-system
Visionline-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
acs_credential_on_seam.visionline_metadata.auto_join Format: Boolean
-
@@ -542,49 +490,42 @@ Possible enum values:
- `guest`
- `staff`
-
acs_credential_on_seam.visionline_metadata.card_id Format: String
-
acs_credential_on_seam.visionline_metadata.common_acs_entrance_ids Format: List Item format: UUID
-
acs_credential_on_seam.visionline_metadata.credential_id Format: String
-
acs_credential_on_seam.visionline_metadata.guest_acs_entrance_ids Format: List Item format: UUID
-
acs_credential_on_seam.visionline_metadata.is_valid Format: Boolean
-
acs_credential_on_seam.visionline_metadata.joiner_acs_credential_ids Format: List Item format: UUID
-
@@ -618,7 +559,6 @@ Possible enum values:
- `needs_to_be_reissued`
-
@@ -627,7 +567,6 @@ Possible enum values:
ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
@@ -647,7 +586,6 @@ Possible enum values:
-
---
diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md
index ee2c6446..d81195a5 100644
--- a/docs/api/acs/entrances/README.md
+++ b/docs/api/acs/entrances/README.md
@@ -30,14 +30,12 @@ ASSA ABLOY Vostio-specific metadata associated with the [entrance](../../../capa
door_name Format: String
-
door_number Format: Number
-
@@ -50,21 +48,18 @@ Possible enum values:
- `GuestDoor`
- `Elevator`
-
pms_id Format: String
-
stand_open Format: Boolean
-
---
@@ -95,7 +90,6 @@ dormakaba Community-specific metadata associated with the [entrance](../../../ca
access_point_name Format: String
-
---
@@ -114,7 +108,6 @@ Errors associated with the [entrance](../../../capability-guides/access-systems/
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
-
@@ -123,7 +116,6 @@ Unique identifier of the type of error. Enables quick recognition and categoriza
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
-
---
@@ -138,28 +130,24 @@ Latch-specific metadata associated with the [entrance](../../../capability-guide
accessibility_type Format: String
-
door_name Format: String
-
door_type Format: String
-
is_connected Format: Boolean
-
---
@@ -174,56 +162,48 @@ Salto KS-specific metadata associated with the [entrance](../../../capability-gu
battery_level Format: String
-
door_name Format: String
-
intrusion_alarm Format: Boolean
-
left_open_alarm Format: Boolean
-
lock_type Format: String
-
locked_state Format: String
-
online Format: Boolean
-
privacy_mode Format: Boolean
-
---
@@ -238,21 +218,18 @@ Salto Space-specific metadata associated with the [entrance](../../../capability
door_description Format: String
-
door_name Format: String
-
ext_door_id Format: String
-
---
@@ -274,14 +251,12 @@ Possible enum values:
- `common`
- `common (PMS)`
-
door_name Format: String
-
@@ -302,7 +277,6 @@ Possible enum values:
- `touch`
-
---
@@ -334,7 +308,6 @@ An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entra
acs_entrance_id Format: UUID
-
@@ -343,7 +316,6 @@ An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entra
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-
@@ -352,7 +324,6 @@ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-syst
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-
@@ -361,7 +332,6 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m
Date and time at which the event was created.
-
@@ -370,14 +340,12 @@ Date and time at which the event was created.
ID of the event.
-
event_type Format: String
-
@@ -386,7 +354,6 @@ ID of the event.
Date and time at which the event occurred.
-
@@ -395,7 +362,6 @@ Date and time at which the event occurred.
ID of the [workspace](../../../core-concepts/workspaces/README.md).
-
---
@@ -408,7 +374,6 @@ An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entra
acs_entrance_id Format: UUID
-
@@ -417,7 +382,6 @@ An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entra
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-
@@ -426,7 +390,6 @@ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-syst
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-
@@ -435,7 +398,6 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m
Date and time at which the event was created.
-
@@ -444,14 +406,12 @@ Date and time at which the event was created.
ID of the event.
-
event_type Format: String
-
@@ -460,7 +420,6 @@ ID of the event.
Date and time at which the event occurred.
-
@@ -469,7 +428,6 @@ Date and time at which the event occurred.
ID of the [workspace](../../../core-concepts/workspaces/README.md).
-
---
diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md
index 39719164..240f7503 100644
--- a/docs/api/acs/systems/README.md
+++ b/docs/api/acs/systems/README.md
@@ -157,7 +157,6 @@ Format: `Object`
Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located.
-
---
@@ -215,7 +214,6 @@ Format: `Object`
IP address or hostname of the main Visionline server relative to [Seam Bridge](../../../capability-guides/seam-bridge.md) on the local network.
-
@@ -224,7 +222,6 @@ IP address or hostname of the main Visionline server relative to [Seam Bridge](.
Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset.
-
@@ -233,7 +230,6 @@ Keyset loaded into a reader. Mobile keys and reader administration tools securel
Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager.
-
---
@@ -339,7 +335,6 @@ An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) wa
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-
@@ -348,7 +343,6 @@ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-syst
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-
@@ -357,7 +351,6 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m
Date and time at which the event was created.
-
@@ -366,14 +359,12 @@ Date and time at which the event was created.
ID of the event.
-
event_type Format: String
-
@@ -382,7 +373,6 @@ ID of the event.
Date and time at which the event occurred.
-
@@ -391,7 +381,6 @@ Date and time at which the event occurred.
ID of the [workspace](../../../core-concepts/workspaces/README.md).
-
---
@@ -406,7 +395,6 @@ An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) wa
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-
@@ -415,7 +403,6 @@ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-syst
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-
@@ -424,7 +411,6 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m
Date and time at which the event was created.
-
@@ -433,14 +419,12 @@ Date and time at which the event was created.
ID of the event.
-
event_type Format: String
-
@@ -449,7 +433,6 @@ ID of the event.
Date and time at which the event occurred.
-
@@ -458,7 +441,6 @@ Date and time at which the event occurred.
ID of the [workspace](../../../core-concepts/workspaces/README.md).
-
---
@@ -473,7 +455,6 @@ An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) wa
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-
@@ -482,7 +463,6 @@ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-syst
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-
@@ -491,7 +471,6 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m
Date and time at which the event was created.
-
@@ -500,14 +479,12 @@ Date and time at which the event was created.
ID of the event.
-
event_type Format: String
-
@@ -516,7 +493,6 @@ ID of the event.
Date and time at which the event occurred.
-
@@ -525,7 +501,6 @@ Date and time at which the event occurred.
ID of the [workspace](../../../core-concepts/workspaces/README.md).
-
---
diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md
index 3e5d0b76..248661f4 100644
--- a/docs/api/acs/users/README.md
+++ b/docs/api/acs/users/README.md
@@ -16,7 +16,6 @@ Format: `Object`
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.
-
@@ -25,7 +24,6 @@ Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org
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.
-
---
@@ -303,14 +301,12 @@ An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-
acs_user_id Format: UUID
-
@@ -319,7 +315,6 @@ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-syst
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-
@@ -328,7 +323,6 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m
Date and time at which the event was created.
-
@@ -337,14 +331,12 @@ Date and time at which the event was created.
ID of the event.
-
event_type Format: String
-
@@ -353,7 +345,6 @@ ID of the event.
Date and time at which the event occurred.
-
@@ -362,7 +353,6 @@ Date and time at which the event occurred.
ID of the [workspace](../../../core-concepts/workspaces/README.md).
-
---
diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md
index c8fcef0e..b487a903 100644
--- a/docs/api/phones/README.md
+++ b/docs/api/phones/README.md
@@ -60,14 +60,12 @@ Errors associated with the `phone`.
error_code Format: String
-
message Format: String
-
---
@@ -92,7 +90,6 @@ Properties of the phone.
ASSA ABLOY Credential Service metadata for the phone.
-
@@ -113,7 +110,6 @@ Indicated whether the endpoint is active.
-
@@ -122,7 +118,6 @@ Indicated whether the endpoint is active.
Indicates whether the credential service has active endpoints associated with the phone.
-
@@ -131,7 +126,6 @@ Indicates whether the credential service has active endpoints associated with th
Salto Space credential service metadata for the phone.
-
@@ -140,7 +134,6 @@ Salto Space credential service metadata for the phone.
Indicates whether the credential service has an active associated phone.
-
---
@@ -157,14 +150,12 @@ Warnings associated with the `phone`.
message Format: String
-
warning_code Format: String
-
---
@@ -203,7 +194,6 @@ A phone device was deactivated.
Date and time at which the event was created.
-
@@ -212,7 +202,6 @@ Date and time at which the event was created.
ID of the [device](../../core-concepts/devices/README.md).
-
@@ -221,14 +210,12 @@ ID of the [device](../../core-concepts/devices/README.md).
ID of the event.
-
event_type Format: String
-
@@ -237,7 +224,6 @@ ID of the event.
Date and time at which the event occurred.
-
@@ -246,7 +232,6 @@ Date and time at which the event occurred.
ID of the [workspace](../../core-concepts/workspaces/README.md).
-
---
diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md
index 01db7d7a..5b931e56 100644
--- a/docs/api/thermostats/activate_climate_preset.md
+++ b/docs/api/thermostats/activate_climate_preset.md
@@ -194,14 +194,12 @@ Format: `Object`
message Format: String
-
type Format: String
-
---
diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md
index cdbe8810..9564ca04 100644
--- a/docs/api/thermostats/cool.md
+++ b/docs/api/thermostats/cool.md
@@ -204,14 +204,12 @@ Format: `Object`
message Format: String
-
type Format: String
-
---
diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md
index aa6d3f2e..44c9ad73 100644
--- a/docs/api/thermostats/heat.md
+++ b/docs/api/thermostats/heat.md
@@ -204,14 +204,12 @@ Format: `Object`
message Format: String
-
type Format: String
-
---
diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md
index 2b085d1e..21d674ad 100644
--- a/docs/api/thermostats/heat_cool.md
+++ b/docs/api/thermostats/heat_cool.md
@@ -228,14 +228,12 @@ Format: `Object`
message Format: String
-
type Format: String
-
---
diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md
index 97b85fa1..b5b82471 100644
--- a/docs/api/thermostats/off.md
+++ b/docs/api/thermostats/off.md
@@ -176,14 +176,12 @@ Format: `Object`
message Format: String
-
type Format: String
-
---
diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md
index 6652e179..48b777e4 100644
--- a/docs/api/thermostats/schedules/README.md
+++ b/docs/api/thermostats/schedules/README.md
@@ -50,7 +50,6 @@ Errors associated with the [thermostat schedule](../../../capability-guides/ther
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
-
@@ -59,7 +58,6 @@ Unique identifier of the type of error. Enables quick recognition and categoriza
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
-
---
diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md
index c5942c85..bdf5e7d3 100644
--- a/docs/api/thermostats/set_fan_mode.md
+++ b/docs/api/thermostats/set_fan_mode.md
@@ -204,14 +204,12 @@ Format: `Object`
message Format: String
-
type Format: String
-
---
diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md
index 5b4890b4..64185341 100644
--- a/docs/api/thermostats/set_hvac_mode.md
+++ b/docs/api/thermostats/set_hvac_mode.md
@@ -242,14 +242,12 @@ Format: `Object`
message Format: String
-
type Format: String
-
---
diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md
index 8d286d7f..f27a8723 100644
--- a/docs/api/user_identities/enrollment_automations/README.md
+++ b/docs/api/user_identities/enrollment_automations/README.md
@@ -73,7 +73,6 @@ An [enrollment automation](../../../capability-guides/mobile-access/issuing-mobi
Date and time at which the event was created.
-
@@ -82,7 +81,6 @@ Date and time at which the event was created.
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).
-
@@ -91,14 +89,12 @@ ID of the [enrollment automation](../../../capability-guides/mobile-access/issui
ID of the event.
-
event_type Format: String
-
@@ -107,7 +103,6 @@ ID of the event.
Date and time at which the event occurred.
-
@@ -116,7 +111,6 @@ Date and time at which the event occurred.
ID of the [workspace](../../../core-concepts/workspaces/README.md).
-
---
From a73a6ad459f09464b9fc17c622fba1fab25ac593 Mon Sep 17 00:00:00 2001
From: Andrii Balitskyi <10balian10@gmail.com>
Date: Thu, 20 Mar 2025 15:23:09 +0100
Subject: [PATCH 11/18] Fix indentation
---
src/layouts/partials/property-content.hbs | 1 -
1 file changed, 1 deletion(-)
diff --git a/src/layouts/partials/property-content.hbs b/src/layouts/partials/property-content.hbs
index 5eddb89f..498982c1 100644
--- a/src/layouts/partials/property-content.hbs
+++ b/src/layouts/partials/property-content.hbs
@@ -11,7 +11,6 @@ Possible enum values:
{{#each enumValues}}
- `{{this}}`
{{/each}}
-
{{/if}}
{{#if listProperties}}
{{#each listProperties}}
From d96ecca6f04eaf3cc998bbaaf6790997e8488119 Mon Sep 17 00:00:00 2001
From: Andrii Balitskyi <10balian10@gmail.com>
Date: Thu, 20 Mar 2025 15:24:15 +0100
Subject: [PATCH 12/18] Don't make nested prop name bold
---
src/layouts/partials/property-nested.hbs | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/layouts/partials/property-nested.hbs b/src/layouts/partials/property-nested.hbs
index 9a085433..e4ba7886 100644
--- a/src/layouts/partials/property-nested.hbs
+++ b/src/layouts/partials/property-nested.hbs
@@ -1,4 +1,4 @@
-**{{name}}** Format: {{format}}{{#if listItemFormat}} Item format: {{listItemFormat}}{{/if}}
+{{name}} Format: {{format}}{{#if listItemFormat}} Item format: {{listItemFormat}}{{/if}}
{{> property-nested-internal}}
{{#if listProperties}}
From 8b6550f51485e7fcdd39e355e6ba0a0d2672d640 Mon Sep 17 00:00:00 2001
From: Seam Bot
Date: Thu, 20 Mar 2025 14:25:22 +0000
Subject: [PATCH 13/18] ci: Generate docs
---
docs/api/acs/credentials/README.md | 1 -
docs/api/acs/encoders/encode_credential.md | 14 +++++---------
docs/api/acs/encoders/scan_credential.md | 19 +++++++------------
docs/api/acs/entrances/README.md | 6 ++----
docs/api/phones/README.md | 4 ++--
5 files changed, 16 insertions(+), 28 deletions(-)
diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md
index 564bcd03..a1f8d2e1 100644
--- a/docs/api/acs/credentials/README.md
+++ b/docs/api/acs/credentials/README.md
@@ -261,7 +261,6 @@ Visionline-specific metadata for the [credential](../../../capability-guides/acc
Possible enum values:
- `guest`
- `staff`
-
diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md
index e9dd87b1..5ea60ebd 100644
--- a/docs/api/acs/encoders/encode_credential.md
+++ b/docs/api/acs/encoders/encode_credential.md
@@ -74,7 +74,6 @@ Possible enum values:
- `no_credential_on_encoder`
- `incompatible_card_format`
- `credential_cannot_be_reissued`
-
---
@@ -95,7 +94,6 @@ Possible enum values:
- `code`
- `card`
- `mobile_key`
-
@@ -212,12 +210,12 @@ Date and time at which the [credential](../../../capability-guides/access-system
Errors associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-**error_code** Format: String
+error_code Format: String
-**message** Format: String
+message Format: String
@@ -238,7 +236,6 @@ Possible enum values:
- `salto_ks_credential`
- `assa_abloy_vostio_key`
- `salto_space_key`
-
@@ -340,7 +337,6 @@ Visionline-specific metadata for the [credential](../../../capability-guides/acc
Possible enum values:
- `guest`
- `staff`
-
@@ -385,19 +381,19 @@ Possible enum values:
Warnings associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-**created_at** Format: Datetime
+created_at Format: Datetime
Date and time at which Seam created the warning.
-**message** Format: String
+message Format: String
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
-**warning_code** Format: Enum
+warning_code Format: Enum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md
index 6604a5e8..92d79873 100644
--- a/docs/api/acs/encoders/scan_credential.md
+++ b/docs/api/acs/encoders/scan_credential.md
@@ -63,7 +63,6 @@ Possible enum values:
- `uncategorized_error`
- `action_attempt_expired`
- `no_credential_on_encoder`
-
---
@@ -143,7 +142,6 @@ Format of the card associated with the [credential](../../../capability-guides/a
Possible enum values:
- `TLCode`
- `rfid48`
-
@@ -244,7 +242,6 @@ Possible enum values:
- `code`
- `card`
- `mobile_key`
-
@@ -361,12 +358,12 @@ Date and time at which the [credential](../../../capability-guides/access-system
Errors associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-**error_code** Format: String
+error_code Format: String
-**message** Format: String
+message Format: String
@@ -387,7 +384,6 @@ Possible enum values:
- `salto_ks_credential`
- `assa_abloy_vostio_key`
- `salto_space_key`
-
@@ -489,7 +485,6 @@ Visionline-specific metadata for the [credential](../../../capability-guides/acc
Possible enum values:
- `guest`
- `staff`
-
@@ -534,19 +529,19 @@ Possible enum values:
Warnings associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-**created_at** Format: Datetime
+created_at Format: Datetime
Date and time at which Seam created the warning.
-**message** Format: String
+message Format: String
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
-**warning_code** Format: Enum
+warning_code Format: Enum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
@@ -573,7 +568,7 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains
warnings Format: List Item format: Object
-**warning_code** Format: Enum
+warning_code Format: Enum
Possible enum values:
@@ -581,7 +576,7 @@ Possible enum values:
- `acs_credential_on_seam_not_found`
-**warning_message** Format: String
+warning_message Format: String
diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md
index d81195a5..82cdab7f 100644
--- a/docs/api/acs/entrances/README.md
+++ b/docs/api/acs/entrances/README.md
@@ -47,7 +47,6 @@ Possible enum values:
- `EntranceDoor`
- `GuestDoor`
- `Elevator`
-
@@ -250,7 +249,6 @@ Possible enum values:
- `elevator reader`
- `common`
- `common (PMS)`
-
@@ -263,12 +261,12 @@ Possible enum values:
profiles Format: List Item format: Object
-**visionline_door_profile_id** Format: String
+visionline_door_profile_id Format: String
-**visionline_door_profile_type** Format: Enum
+visionline_door_profile_type Format: Enum
Possible enum values:
diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md
index b487a903..c0ed4ea8 100644
--- a/docs/api/phones/README.md
+++ b/docs/api/phones/README.md
@@ -98,13 +98,13 @@ ASSA ABLOY Credential Service metadata for the phone.
Endpoints associated with the phone.
-**endpoint_id** Format: String
+endpoint_id Format: String
ID of the associated endpoint.
-**is_active** Format: Boolean
+is_active Format: Boolean
Indicated whether the endpoint is active.
From 70276be0e98fa588046bfaf588a48e8a727bfbd6 Mon Sep 17 00:00:00 2001
From: Andrii Balitskyi <10balian10@gmail.com>
Date: Fri, 21 Mar 2025 13:23:42 +0100
Subject: [PATCH 14/18] Make nested props into bulleted list
---
src/layouts/partials/property-content.hbs | 2 +-
src/layouts/partials/property-nested.hbs | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/src/layouts/partials/property-content.hbs b/src/layouts/partials/property-content.hbs
index 498982c1..e8b52bbc 100644
--- a/src/layouts/partials/property-content.hbs
+++ b/src/layouts/partials/property-content.hbs
@@ -14,7 +14,7 @@ Possible enum values:
{{/if}}
{{#if listProperties}}
{{#each listProperties}}
-{{> property-nested this}}
+- {{> property-nested 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
index e4ba7886..8e019d18 100644
--- a/src/layouts/partials/property-nested.hbs
+++ b/src/layouts/partials/property-nested.hbs
@@ -4,6 +4,6 @@
{{#if listProperties}}
{{#each listProperties}}
-{{> property-nested this}}
+- {{> property-nested this}}
{{/each}}
{{/if}}
\ No newline at end of file
From 2ed47eba377acf9cf0d7bc4b0eba295e5c2f81ea Mon Sep 17 00:00:00 2001
From: Seam Bot
Date: Fri, 21 Mar 2025 12:24:46 +0000
Subject: [PATCH 15/18] ci: Generate docs
---
docs/api/acs/encoders/encode_credential.md | 15 ++++++++++-----
docs/api/acs/encoders/scan_credential.md | 21 ++++++++++++++-------
docs/api/acs/entrances/README.md | 6 ++++--
docs/api/phones/README.md | 6 ++++--
4 files changed, 32 insertions(+), 16 deletions(-)
diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md
index 5ea60ebd..9cad198b 100644
--- a/docs/api/acs/encoders/encode_credential.md
+++ b/docs/api/acs/encoders/encode_credential.md
@@ -210,12 +210,14 @@ Date and time at which the [credential](../../../capability-guides/access-system
Errors associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-error_code Format: String
+- error_code Format: String
-message Format: String
+
+- message Format: String
+
@@ -381,19 +383,21 @@ Possible enum values:
Warnings associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-created_at Format: Datetime
+- created_at Format: Datetime
Date and time at which Seam created the warning.
-message Format: String
+
+- message Format: String
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
-warning_code Format: Enum
+
+- warning_code Format: Enum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
@@ -406,6 +410,7 @@ Possible enum values:
- `needs_to_be_reissued`
+
diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md
index 92d79873..d29bdd11 100644
--- a/docs/api/acs/encoders/scan_credential.md
+++ b/docs/api/acs/encoders/scan_credential.md
@@ -358,12 +358,14 @@ Date and time at which the [credential](../../../capability-guides/access-system
Errors associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-error_code Format: String
+- error_code Format: String
-message Format: String
+
+- message Format: String
+
@@ -529,19 +531,21 @@ Possible enum values:
Warnings associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-created_at Format: Datetime
+- created_at Format: Datetime
Date and time at which Seam created the warning.
-message Format: String
+
+- message Format: String
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
-warning_code Format: Enum
+
+- warning_code Format: Enum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
@@ -554,6 +558,7 @@ Possible enum values:
- `needs_to_be_reissued`
+
@@ -568,7 +573,7 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains
warnings Format: List Item format: Object
-warning_code Format: Enum
+- warning_code Format: Enum
Possible enum values:
@@ -576,7 +581,9 @@ Possible enum values:
- `acs_credential_on_seam_not_found`
-warning_message Format: String
+
+- warning_message Format: String
+
diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md
index 82cdab7f..c4b299a2 100644
--- a/docs/api/acs/entrances/README.md
+++ b/docs/api/acs/entrances/README.md
@@ -261,12 +261,13 @@ Possible enum values:
profiles Format: List Item format: Object
-visionline_door_profile_id Format: String
+- visionline_door_profile_id Format: String
-visionline_door_profile_type Format: Enum
+
+- visionline_door_profile_type Format: Enum
Possible enum values:
@@ -275,6 +276,7 @@ Possible enum values:
- `touch`
+
---
diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md
index c0ed4ea8..12802301 100644
--- a/docs/api/phones/README.md
+++ b/docs/api/phones/README.md
@@ -98,18 +98,20 @@ ASSA ABLOY Credential Service metadata for the phone.
Endpoints associated with the phone.
-endpoint_id Format: String
+- endpoint_id Format: String
ID of the associated endpoint.
-is_active Format: Boolean
+
+- is_active Format: Boolean
Indicated whether the endpoint is active.
+
From 42adec8243a9429240e54495eabb8309e5d8ba1e Mon Sep 17 00:00:00 2001
From: Andrii Balitskyi <10balian10@gmail.com>
Date: Wed, 26 Mar 2025 13:20:07 +0100
Subject: [PATCH 16/18] Allign with the bullet content
---
src/layouts/partials/property-collapsible.hbs | 3 +--
src/layouts/partials/property-content.hbs | 7 ++++---
src/layouts/partials/property-nested-internal.hbs | 12 ++++++------
src/layouts/partials/property-nested.hbs | 1 -
4 files changed, 11 insertions(+), 12 deletions(-)
diff --git a/src/layouts/partials/property-collapsible.hbs b/src/layouts/partials/property-collapsible.hbs
index 9567314c..7db38f98 100644
--- a/src/layouts/partials/property-collapsible.hbs
+++ b/src/layouts/partials/property-collapsible.hbs
@@ -1,6 +1,5 @@
{{name}} Format: {{format}}{{#if listItemFormat}} Item format: {{listItemFormat}}{{/if}}
-
{{> property-content}}
-
+
\ No newline at end of file
diff --git a/src/layouts/partials/property-content.hbs b/src/layouts/partials/property-content.hbs
index e8b52bbc..07866a38 100644
--- a/src/layouts/partials/property-content.hbs
+++ b/src/layouts/partials/property-content.hbs
@@ -1,12 +1,13 @@
{{#if isDeprecated}}
-{{> deprecated-warning}}
+{{> deprecated-warning}}
{{/if}}
{{#if description}}
-{{description}}
+{{description}}
{{/if}}
{{#if enumValues}}
+
Possible enum values:
{{#each enumValues}}
- `{{this}}`
@@ -14,7 +15,7 @@ Possible enum values:
{{/if}}
{{#if listProperties}}
{{#each listProperties}}
-- {{> property-nested this}}
+- {{> property-nested this}}
{{/each}}
{{/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
index 806863a4..4b59f007 100644
--- a/src/layouts/partials/property-nested-internal.hbs
+++ b/src/layouts/partials/property-nested-internal.hbs
@@ -1,15 +1,15 @@
{{#if isDeprecated}}
-{{> deprecated-warning}}
+ {{> deprecated-warning}}
{{/if}}
-
{{#if description}}
-{{description}}
-{{/if}}
+ {{description}}
+{{/if}}
{{#if enumValues}}
-Possible enum values:
+
+ Possible enum values:
{{#each enumValues}}
-- `{{this}}`
+ - `{{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
index 8e019d18..92689d8b 100644
--- a/src/layouts/partials/property-nested.hbs
+++ b/src/layouts/partials/property-nested.hbs
@@ -1,6 +1,5 @@
{{name}} Format: {{format}}{{#if listItemFormat}} Item format: {{listItemFormat}}{{/if}}
{{> property-nested-internal}}
-
{{#if listProperties}}
{{#each listProperties}}
From 2b345d72227c325e44f7d13caee5ecb3b5b74b19 Mon Sep 17 00:00:00 2001
From: Seam Bot
Date: Wed, 26 Mar 2025 12:21:08 +0000
Subject: [PATCH 17/18] ci: Generate docs
---
docs/api/acs/access_groups/README.md | 22 ---
docs/api/acs/credentials/README.md | 77 ---------
docs/api/acs/encoders/README.md | 38 -----
docs/api/acs/encoders/encode_credential.md | 109 ++----------
docs/api/acs/encoders/scan_credential.md | 161 ++----------------
docs/api/acs/entrances/README.md | 95 +----------
docs/api/acs/systems/README.md | 50 ------
docs/api/acs/users/README.md | 20 ---
docs/api/phones/README.md | 38 +----
.../thermostats/activate_climate_preset.md | 4 -
docs/api/thermostats/cool.md | 4 -
docs/api/thermostats/heat.md | 4 -
docs/api/thermostats/heat_cool.md | 4 -
docs/api/thermostats/off.md | 4 -
docs/api/thermostats/schedules/README.md | 4 -
docs/api/thermostats/set_fan_mode.md | 4 -
docs/api/thermostats/set_hvac_mode.md | 4 -
.../enrollment_automations/README.md | 12 --
18 files changed, 29 insertions(+), 625 deletions(-)
diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md
index afbc61aa..64b7d4a1 100644
--- a/docs/api/acs/access_groups/README.md
+++ b/docs/api/acs/access_groups/README.md
@@ -114,25 +114,19 @@ Warnings associated with the `acs_access_group`.
created_at Format: Datetime
Date and time at which Seam created the warning.
-
-
message Format: String
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
-
-
warning_code Format: String
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
-
-
---
### `workspace_id`
@@ -175,62 +169,46 @@ An ACS access group was deleted.
acs_access_group_id Format: UUID
-
-
acs_system_id Format: UUID
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-
-
connected_account_id Format: UUID
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-
-
created_at Format: Datetime
Date and time at which the event was created.
-
-
event_id Format: UUID
ID of the event.
-
-
event_type Format: String
-
-
occurred_at Format: Datetime
Date and time at which the event occurred.
-
-
workspace_id Format: UUID
ID of the [workspace](../../../core-concepts/workspaces/README.md).
-
-
---
diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md
index a1f8d2e1..50e2daff 100644
--- a/docs/api/acs/credentials/README.md
+++ b/docs/api/acs/credentials/README.md
@@ -56,33 +56,23 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access-
door_names Format: List Item format: String
-
-
endpoint_id Format: String
-
-
key_id Format: String
-
-
key_issuing_request_id Format: String
-
-
override_guest_acs_entrance_ids Format: List Item format: String
-
-
---
### `card_number`
@@ -136,15 +126,11 @@ Errors associated with the [credential](../../../capability-guides/access-system
error_code Format: String
-
-
message Format: String
-
-
---
### `external_type`
@@ -251,9 +237,7 @@ Visionline-specific metadata for the [credential](../../../capability-guides/acc
auto_join Format: Boolean
-
-
card_function_type Format: Enum
@@ -262,43 +246,30 @@ Possible enum values:
- `guest`
- `staff`
-
card_id Format: String
-
-
common_acs_entrance_ids Format: List Item format: UUID
-
-
credential_id Format: String
-
-
guest_acs_entrance_ids Format: List Item format: UUID
-
-
is_valid Format: Boolean
-
-
joiner_acs_credential_ids Format: List Item format: UUID
-
-
---
### [`warnings`](./#warnings-1)
@@ -395,63 +366,47 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia
acs_credential_id Format: UUID
-
-
acs_system_id Format: UUID
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-
-
connected_account_id Format: UUID
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-
-
created_at Format: Datetime
Date and time at which the event was created.
-
-
event_id Format: UUID
ID of the event.
-
-
event_type Format: String
-
-
occurred_at Format: Datetime
Date and time at which the event occurred.
-
-
workspace_id Format: UUID
ID of the [workspace](../../../core-concepts/workspaces/README.md).
-
-
---
### `acs_credential.issued`
@@ -461,63 +416,47 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia
acs_credential_id Format: UUID
-
-
acs_system_id Format: UUID
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-
-
connected_account_id Format: UUID
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-
-
created_at Format: Datetime
Date and time at which the event was created.
-
-
event_id Format: UUID
ID of the event.
-
-
event_type Format: String
-
-
occurred_at Format: Datetime
Date and time at which the event occurred.
-
-
workspace_id Format: UUID
ID of the [workspace](../../../core-concepts/workspaces/README.md).
-
-
---
### `acs_credential.reissued`
@@ -527,62 +466,46 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia
acs_credential_id Format: UUID
-
-
acs_system_id Format: UUID
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-
-
connected_account_id Format: UUID
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-
-
created_at Format: Datetime
Date and time at which the event was created.
-
-
event_id Format: UUID
ID of the event.
-
-
event_type Format: String
-
-
occurred_at Format: Datetime
Date and time at which the event occurred.
-
-
workspace_id Format: UUID
ID of the [workspace](../../../core-concepts/workspaces/README.md).
-
-
---
diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md
index c1e2997f..631552e6 100644
--- a/docs/api/acs/encoders/README.md
+++ b/docs/api/acs/encoders/README.md
@@ -49,25 +49,19 @@ Errors associated with the [encoder](../../../capability-guides/access-systems/w
created_at Format: Datetime
Date and time at which Seam created the error.
-
-
error_code Format: String
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
-
-
message Format: String
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
-
-
---
### `workspace_id`
@@ -103,63 +97,47 @@ An [ACS encoder](../../../capability-guides/access-systems/working-with-card-enc
acs_encoder_id Format: UUID
ID of the [ACS encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
-
-
acs_system_id Format: UUID
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-
-
connected_account_id Format: UUID
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-
-
created_at Format: Datetime
Date and time at which the event was created.
-
-
event_id Format: UUID
ID of the event.
-
-
event_type Format: String
-
-
occurred_at Format: Datetime
Date and time at which the event occurred.
-
-
workspace_id Format: UUID
ID of the [workspace](../../../core-concepts/workspaces/README.md).
-
-
---
### `acs_encoder.removed`
@@ -171,62 +149,46 @@ An [ACS encoder](../../../capability-guides/access-systems/working-with-card-enc
acs_encoder_id Format: UUID
ID of the [ACS encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
-
-
acs_system_id Format: UUID
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-
-
connected_account_id Format: UUID
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-
-
created_at Format: Datetime
Date and time at which the event was created.
-
-
event_id Format: UUID
ID of the event.
-
-
event_type Format: String
-
-
occurred_at Format: Datetime
Date and time at which the event occurred.
-
-
workspace_id Format: UUID
ID of the [workspace](../../../core-concepts/workspaces/README.md).
-
-
---
diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md
index 9cad198b..d925231b 100644
--- a/docs/api/acs/encoders/encode_credential.md
+++ b/docs/api/acs/encoders/encode_credential.md
@@ -61,9 +61,7 @@ Format: `Object`
message Format: String
-
-
type Format: Enum
@@ -75,7 +73,6 @@ Possible enum values:
- `incompatible_card_format`
- `credential_cannot_be_reissued`
-
---
#### `result`
@@ -95,115 +92,84 @@ Possible enum values:
- `card`
- `mobile_key`
-
acs_credential_id Format: UUID
ID of the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
acs_credential_pool_id Format: UUID
-
-
acs_system_id Format: UUID
ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
acs_user_id Format: UUID
ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](../../../capability-guides/access-systems/managing-credentials.md) belongs.
-
-
assa_abloy_vostio_metadata Format: Object
Vostio-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
assa_abloy_vostio_metadata.door_names Format: List Item format: String
-
-
assa_abloy_vostio_metadata.endpoint_id Format: String
-
-
assa_abloy_vostio_metadata.key_id Format: String
-
-
assa_abloy_vostio_metadata.key_issuing_request_id Format: String
-
-
assa_abloy_vostio_metadata.override_guest_acs_entrance_ids Format: List Item format: String
-
-
card_number Format: String
Number of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
code Format: String
Access (PIN) code for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
created_at Format: Datetime
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was created.
-
-
display_name Format: String
Display name that corresponds to the [credential](../../../capability-guides/access-systems/managing-credentials.md) type.
-
-
ends_at Format: String
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
-
-
errors Format: List Item format: Object
@@ -213,17 +179,9 @@ Errors associated with the [credential](../../../capability-guides/access-system
- error_code Format: String
-
-
-
- message Format: String
-
-
-
-
-
external_type Format: Enum
@@ -239,99 +197,74 @@ Possible enum values:
- `assa_abloy_vostio_key`
- `salto_space_key`
-
external_type_display_name Format: String
Display name that corresponds to the brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type.
-
-
is_issued Format: Boolean
Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been encoded onto a card.
-
-
is_latest_desired_state_synced_with_provider Format: Boolean
Indicates whether the latest state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been synced from Seam to the provider.
-
-
is_managed Format: Boolean
-
-
is_multi_phone_sync_credential Format: Boolean
Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).
-
-
is_one_time_use Format: Boolean
Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) can only be used once. If `true`, the code becomes invalid after the first use.
-
-
issued_at Format: Datetime
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was encoded onto a card.
-
-
latest_desired_state_synced_with_provider_at Format: Datetime
Date and time at which the state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) was most recently synced from Seam to the provider.
-
-
parent_acs_credential_id Format: UUID
ID of the parent [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
starts_at Format: String
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
-
-
visionline_metadata Format: Object
Visionline-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
visionline_metadata.auto_join Format: Boolean
-
-
visionline_metadata.card_function_type Format: Enum
@@ -340,43 +273,30 @@ Possible enum values:
- `guest`
- `staff`
-
visionline_metadata.card_id Format: String
-
-
visionline_metadata.common_acs_entrance_ids Format: List Item format: UUID
-
-
visionline_metadata.credential_id Format: String
-
-
visionline_metadata.guest_acs_entrance_ids Format: List Item format: UUID
-
-
visionline_metadata.is_valid Format: Boolean
-
-
visionline_metadata.joiner_acs_credential_ids Format: List Item format: UUID
-
-
warnings Format: List Item format: Object
@@ -385,42 +305,33 @@ Warnings associated with the [credential](../../../capability-guides/access-syst
- created_at Format: Datetime
-Date and time at which Seam created the warning.
-
-
+ Date and time at which Seam created the warning.
- message Format: String
-Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
-
-
+ Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- warning_code Format: Enum
-Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
-
-Possible enum values:
-- `waiting_to_be_issued`
-- `schedule_externally_modified`
-- `schedule_modified`
-- `being_deleted`
-- `unknown_issue_with_acs_credential`
-- `needs_to_be_reissued`
-
+ Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+ Possible enum values:
+ - `waiting_to_be_issued`
+ - `schedule_externally_modified`
+ - `schedule_modified`
+ - `being_deleted`
+ - `unknown_issue_with_acs_credential`
+ - `needs_to_be_reissued`
-
workspace_id Format: UUID
ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
---
#### `status`
diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md
index d29bdd11..742c3bf5 100644
--- a/docs/api/acs/encoders/scan_credential.md
+++ b/docs/api/acs/encoders/scan_credential.md
@@ -52,9 +52,7 @@ Format: `Object`
message Format: String
-
-
type Format: Enum
@@ -64,7 +62,6 @@ Possible enum values:
- `action_attempt_expired`
- `no_credential_on_encoder`
-
---
#### `result`
@@ -76,63 +73,47 @@ Format: `Object`
acs_credential_on_encoder Format: Object
Snapshot of credential data read from physical encoder.
-
-
acs_credential_on_encoder.card_number Format: String
A number or string that physically identifies the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
acs_credential_on_encoder.created_at Format: Datetime
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was created.
-
-
acs_credential_on_encoder.ends_at Format: Datetime
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) will stop being usable.
-
-
acs_credential_on_encoder.is_issued Format: Boolean
-
-
acs_credential_on_encoder.starts_at Format: Datetime
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) becomes usable.
-
-
acs_credential_on_encoder.visionline_metadata Format: Object
Visionline-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
acs_credential_on_encoder.visionline_metadata.cancelled Format: Boolean
Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is cancelled.
-
-
acs_credential_on_encoder.visionline_metadata.card_format Format: Enum
@@ -143,95 +124,72 @@ Possible enum values:
- `TLCode`
- `rfid48`
-
acs_credential_on_encoder.visionline_metadata.card_holder Format: String
Holden of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
acs_credential_on_encoder.visionline_metadata.card_id Format: String
Card ID for the Visionline card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
acs_credential_on_encoder.visionline_metadata.common_acs_entrance_ids Format: List Item format: UUID
IDs of the common [entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md) for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
acs_credential_on_encoder.visionline_metadata.discarded Format: Boolean
Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is discarded.
-
-
acs_credential_on_encoder.visionline_metadata.expired Format: Boolean
Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is expired.
-
-
acs_credential_on_encoder.visionline_metadata.guest_acs_entrance_ids Format: List Item format: UUID
IDs of the guest [entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md) for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
acs_credential_on_encoder.visionline_metadata.number_of_issued_cards Format: Number
Number of issued cards associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
acs_credential_on_encoder.visionline_metadata.overridden Format: Boolean
Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is overridden.
-
-
acs_credential_on_encoder.visionline_metadata.overwritten Format: Boolean
Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is overwritten.
-
-
acs_credential_on_encoder.visionline_metadata.pending_auto_update Format: Boolean
Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is pending auto-update.
-
-
acs_credential_on_seam Format: Object
Matching acs_credential currently encoded on this card.
-
-
acs_credential_on_seam.access_method Format: Enum
@@ -243,115 +201,84 @@ Possible enum values:
- `card`
- `mobile_key`
-
acs_credential_on_seam.acs_credential_id Format: UUID
ID of the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
acs_credential_on_seam.acs_credential_pool_id Format: UUID
-
-
acs_credential_on_seam.acs_system_id Format: UUID
ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
acs_credential_on_seam.acs_user_id Format: UUID
ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](../../../capability-guides/access-systems/managing-credentials.md) belongs.
-
-
acs_credential_on_seam.assa_abloy_vostio_metadata Format: Object
Vostio-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
acs_credential_on_seam.assa_abloy_vostio_metadata.door_names Format: List Item format: String
-
-
acs_credential_on_seam.assa_abloy_vostio_metadata.endpoint_id Format: String
-
-
acs_credential_on_seam.assa_abloy_vostio_metadata.key_id Format: String
-
-
acs_credential_on_seam.assa_abloy_vostio_metadata.key_issuing_request_id Format: String
-
-
acs_credential_on_seam.assa_abloy_vostio_metadata.override_guest_acs_entrance_ids Format: List Item format: String
-
-
acs_credential_on_seam.card_number Format: String
Number of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
acs_credential_on_seam.code Format: String
Access (PIN) code for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
acs_credential_on_seam.created_at Format: Datetime
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was created.
-
-
acs_credential_on_seam.display_name Format: String
Display name that corresponds to the [credential](../../../capability-guides/access-systems/managing-credentials.md) type.
-
-
acs_credential_on_seam.ends_at Format: String
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
-
-
acs_credential_on_seam.errors Format: List Item format: Object
@@ -361,17 +288,9 @@ Errors associated with the [credential](../../../capability-guides/access-system
- error_code Format: String
-
-
-
- message Format: String
-
-
-
-
-
acs_credential_on_seam.external_type Format: Enum
@@ -387,99 +306,74 @@ Possible enum values:
- `assa_abloy_vostio_key`
- `salto_space_key`
-
acs_credential_on_seam.external_type_display_name Format: String
Display name that corresponds to the brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type.
-
-
acs_credential_on_seam.is_issued Format: Boolean
Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been encoded onto a card.
-
-
acs_credential_on_seam.is_latest_desired_state_synced_with_provider Format: Boolean
Indicates whether the latest state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been synced from Seam to the provider.
-
-
acs_credential_on_seam.is_managed Format: Boolean
-
-
acs_credential_on_seam.is_multi_phone_sync_credential Format: Boolean
Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).
-
-
acs_credential_on_seam.is_one_time_use Format: Boolean
Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) can only be used once. If `true`, the code becomes invalid after the first use.
-
-
acs_credential_on_seam.issued_at Format: Datetime
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was encoded onto a card.
-
-
acs_credential_on_seam.latest_desired_state_synced_with_provider_at Format: Datetime
Date and time at which the state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) was most recently synced from Seam to the provider.
-
-
acs_credential_on_seam.parent_acs_credential_id Format: UUID
ID of the parent [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
acs_credential_on_seam.starts_at Format: String
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
-
-
acs_credential_on_seam.visionline_metadata Format: Object
Visionline-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
acs_credential_on_seam.visionline_metadata.auto_join Format: Boolean
-
-
acs_credential_on_seam.visionline_metadata.card_function_type Format: Enum
@@ -488,43 +382,30 @@ Possible enum values:
- `guest`
- `staff`
-
acs_credential_on_seam.visionline_metadata.card_id Format: String
-
-
acs_credential_on_seam.visionline_metadata.common_acs_entrance_ids Format: List Item format: UUID
-
-
acs_credential_on_seam.visionline_metadata.credential_id Format: String
-
-
acs_credential_on_seam.visionline_metadata.guest_acs_entrance_ids Format: List Item format: UUID
-
-
acs_credential_on_seam.visionline_metadata.is_valid Format: Boolean
-
-
acs_credential_on_seam.visionline_metadata.joiner_acs_credential_ids Format: List Item format: UUID
-
-
acs_credential_on_seam.warnings Format: List Item format: Object
@@ -533,63 +414,47 @@ Warnings associated with the [credential](../../../capability-guides/access-syst
- created_at Format: Datetime
-Date and time at which Seam created the warning.
-
-
+ Date and time at which Seam created the warning.
- message Format: String
-Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
-
-
+ Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- warning_code Format: Enum
-Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
-
-Possible enum values:
-- `waiting_to_be_issued`
-- `schedule_externally_modified`
-- `schedule_modified`
-- `being_deleted`
-- `unknown_issue_with_acs_credential`
-- `needs_to_be_reissued`
-
+ Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+ Possible enum values:
+ - `waiting_to_be_issued`
+ - `schedule_externally_modified`
+ - `schedule_modified`
+ - `being_deleted`
+ - `unknown_issue_with_acs_credential`
+ - `needs_to_be_reissued`
-
acs_credential_on_seam.workspace_id Format: UUID
ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
warnings Format: List Item format: Object
- warning_code Format: Enum
-
-Possible enum values:
-- `acs_credential_on_encoder_out_of_sync`
-- `acs_credential_on_seam_not_found`
-
+ Possible enum values:
+ - `acs_credential_on_encoder_out_of_sync`
+ - `acs_credential_on_seam_not_found`
- warning_message Format: String
-
-
-
-
-
---
#### `status`
diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md
index c4b299a2..679a31ba 100644
--- a/docs/api/acs/entrances/README.md
+++ b/docs/api/acs/entrances/README.md
@@ -29,15 +29,11 @@ ASSA ABLOY Vostio-specific metadata associated with the [entrance](../../../capa
door_name Format: String
-
-
door_number Format: Number
-
-
door_type Format: Enum
@@ -48,19 +44,14 @@ Possible enum values:
- `GuestDoor`
- `Elevator`
-
pms_id Format: String
-
-
stand_open Format: Boolean
-
-
---
### `created_at`
@@ -88,9 +79,7 @@ dormakaba Community-specific metadata associated with the [entrance](../../../ca
access_point_name Format: String
-
-
---
### `errors`
@@ -106,17 +95,13 @@ Errors associated with the [entrance](../../../capability-guides/access-systems/
error_code Format: String
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
-
-
message Format: String
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
-
-
---
### `latch_metadata`
@@ -128,27 +113,19 @@ Latch-specific metadata associated with the [entrance](../../../capability-guide
accessibility_type Format: String
-
-
door_name Format: String
-
-
door_type Format: String
-
-
is_connected Format: Boolean
-
-
---
### `salto_ks_metadata`
@@ -160,51 +137,35 @@ Salto KS-specific metadata associated with the [entrance](../../../capability-gu
battery_level Format: String
-
-
door_name Format: String
-
-
intrusion_alarm Format: Boolean
-
-
left_open_alarm Format: Boolean
-
-
lock_type Format: String
-
-
locked_state Format: String
-
-
online Format: Boolean
-
-
privacy_mode Format: Boolean
-
-
---
### `salto_space_metadata`
@@ -216,21 +177,15 @@ Salto Space-specific metadata associated with the [entrance](../../../capability
door_description Format: String
-
-
door_name Format: String
-
-
ext_door_id Format: String
-
-
---
### `visionline_metadata`
@@ -250,13 +205,10 @@ Possible enum values:
- `common`
- `common (PMS)`
-
door_name Format: String
-
-
profiles Format: List Item format: Object
@@ -264,21 +216,14 @@ Possible enum values:
- visionline_door_profile_id Format: String
-
-
-
- visionline_door_profile_type Format: Enum
-
-Possible enum values:
-- `BLE`
-- `commonDoor`
-- `touch`
-
-
+ Possible enum values:
+ - `BLE`
+ - `commonDoor`
+ - `touch`
-
---
## Endpoints
@@ -307,63 +252,47 @@ An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entra
acs_entrance_id Format: UUID
-
-
acs_system_id Format: UUID
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-
-
connected_account_id Format: UUID
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-
-
created_at Format: Datetime
Date and time at which the event was created.
-
-
event_id Format: UUID
ID of the event.
-
-
event_type Format: String
-
-
occurred_at Format: Datetime
Date and time at which the event occurred.
-
-
workspace_id Format: UUID
ID of the [workspace](../../../core-concepts/workspaces/README.md).
-
-
---
### `acs_entrance.removed`
@@ -373,62 +302,46 @@ An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entra
acs_entrance_id Format: UUID
-
-
acs_system_id Format: UUID
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-
-
connected_account_id Format: UUID
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-
-
created_at Format: Datetime
Date and time at which the event was created.
-
-
event_id Format: UUID
ID of the event.
-
-
event_type Format: String
-
-
occurred_at Format: Datetime
Date and time at which the event occurred.
-
-
workspace_id Format: UUID
ID of the [workspace](../../../core-concepts/workspaces/README.md).
-
-
---
diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md
index 240f7503..4a67cc67 100644
--- a/docs/api/acs/systems/README.md
+++ b/docs/api/acs/systems/README.md
@@ -156,9 +156,7 @@ Format: `Object`
time_zone Format: String
Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located.
-
-
---
### `name`
@@ -213,25 +211,19 @@ Format: `Object`
lan_address Format: String
IP address or hostname of the main Visionline server relative to [Seam Bridge](../../../capability-guides/seam-bridge.md) on the local network.
-
-
mobile_access_uuid Format: String
Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset.
-
-
system_id Format: String
Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager.
-
-
---
### [`warnings`](./#warnings-1)
@@ -334,55 +326,41 @@ An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) wa
acs_system_id Format: UUID
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-
-
connected_account_id Format: UUID
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-
-
created_at Format: Datetime
Date and time at which the event was created.
-
-
event_id Format: UUID
ID of the event.
-
-
event_type Format: String
-
-
occurred_at Format: Datetime
Date and time at which the event occurred.
-
-
workspace_id Format: UUID
ID of the [workspace](../../../core-concepts/workspaces/README.md).
-
-
---
### `acs_system.added`
@@ -394,55 +372,41 @@ An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) wa
acs_system_id Format: UUID
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-
-
connected_account_id Format: UUID
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-
-
created_at Format: Datetime
Date and time at which the event was created.
-
-
event_id Format: UUID
ID of the event.
-
-
event_type Format: String
-
-
occurred_at Format: Datetime
Date and time at which the event occurred.
-
-
workspace_id Format: UUID
ID of the [workspace](../../../core-concepts/workspaces/README.md).
-
-
---
### `acs_system.disconnected`
@@ -454,54 +418,40 @@ An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) wa
acs_system_id Format: UUID
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-
-
connected_account_id Format: UUID
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-
-
created_at Format: Datetime
Date and time at which the event was created.
-
-
event_id Format: UUID
ID of the event.
-
-
event_type Format: String
-
-
occurred_at Format: Datetime
Date and time at which the event occurred.
-
-
workspace_id Format: UUID
ID of the [workspace](../../../core-concepts/workspaces/README.md).
-
-
---
diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md
index 248661f4..fe807715 100644
--- a/docs/api/acs/users/README.md
+++ b/docs/api/acs/users/README.md
@@ -15,17 +15,13 @@ Format: `Object`
ends_at Format: Datetime
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.
-
-
starts_at Format: Datetime
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.
-
-
---
### `acs_system_id`
@@ -300,60 +296,44 @@ An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-
acs_system_id Format: UUID
ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
-
-
acs_user_id Format: UUID
-
-
connected_account_id Format: UUID
ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
-
-
created_at Format: Datetime
Date and time at which the event was created.
-
-
event_id Format: UUID
ID of the event.
-
-
event_type Format: String
-
-
occurred_at Format: Datetime
Date and time at which the event occurred.
-
-
workspace_id Format: UUID
ID of the [workspace](../../../core-concepts/workspaces/README.md).
-
-
---
diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md
index 12802301..e6ebc297 100644
--- a/docs/api/phones/README.md
+++ b/docs/api/phones/README.md
@@ -59,15 +59,11 @@ Errors associated with the `phone`.
error_code Format: String
-
-
message Format: String
-
-
---
### `nickname`
@@ -89,9 +85,7 @@ Properties of the phone.
assa_abloy_credential_service_metadata Format: Object
ASSA ABLOY Credential Service metadata for the phone.
-
-
assa_abloy_credential_service_metadata.endpoints Format: List Item format: Object
@@ -100,44 +94,32 @@ Endpoints associated with the phone.
- endpoint_id Format: String
-ID of the associated endpoint.
-
-
+ ID of the associated endpoint.
- is_active Format: Boolean
-Indicated whether the endpoint is active.
-
-
-
+ Indicated whether the endpoint is active.
-
assa_abloy_credential_service_metadata.has_active_endpoint Format: Boolean
Indicates whether the credential service has active endpoints associated with the phone.
-
-
salto_space_credential_service_metadata Format: Object
Salto Space credential service metadata for the phone.
-
-
salto_space_credential_service_metadata.has_active_phone Format: Boolean
Indicates whether the credential service has an active associated phone.
-
-
---
### `warnings`
@@ -151,15 +133,11 @@ Warnings associated with the `phone`.
message Format: String
-
-
warning_code Format: String
-
-
---
### `workspace_id`
@@ -195,46 +173,34 @@ A phone device was deactivated.
created_at Format: Datetime
Date and time at which the event was created.
-
-
device_id Format: UUID
ID of the [device](../../core-concepts/devices/README.md).
-
-
event_id Format: UUID
ID of the event.
-
-
event_type Format: String
-
-
occurred_at Format: Datetime
Date and time at which the event occurred.
-
-
workspace_id Format: UUID
ID of the [workspace](../../core-concepts/workspaces/README.md).
-
-
---
diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md
index 5b931e56..00bec5ac 100644
--- a/docs/api/thermostats/activate_climate_preset.md
+++ b/docs/api/thermostats/activate_climate_preset.md
@@ -193,15 +193,11 @@ Format: `Object`
message Format: String
-
-
type Format: String
-
-
---
#### `result`
diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md
index 9564ca04..7f5e4d24 100644
--- a/docs/api/thermostats/cool.md
+++ b/docs/api/thermostats/cool.md
@@ -203,15 +203,11 @@ Format: `Object`
message Format: String
-
-
type Format: String
-
-
---
#### `result`
diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md
index 44c9ad73..a10c1f66 100644
--- a/docs/api/thermostats/heat.md
+++ b/docs/api/thermostats/heat.md
@@ -203,15 +203,11 @@ Format: `Object`
message Format: String
-
-
type Format: String
-
-
---
#### `result`
diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md
index 21d674ad..3a417485 100644
--- a/docs/api/thermostats/heat_cool.md
+++ b/docs/api/thermostats/heat_cool.md
@@ -227,15 +227,11 @@ Format: `Object`
message Format: String
-
-
type Format: String
-
-
---
#### `result`
diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md
index b5b82471..efabee62 100644
--- a/docs/api/thermostats/off.md
+++ b/docs/api/thermostats/off.md
@@ -175,15 +175,11 @@ Format: `Object`
message Format: String
-
-
type Format: String
-
-
---
#### `result`
diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md
index 48b777e4..3323b4ad 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
error_code Format: String
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
-
-
message Format: String
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
-
-
---
### `max_override_period_minutes`
diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md
index bdf5e7d3..46786b50 100644
--- a/docs/api/thermostats/set_fan_mode.md
+++ b/docs/api/thermostats/set_fan_mode.md
@@ -203,15 +203,11 @@ Format: `Object`
message Format: String
-
-
type Format: String
-
-
---
#### `result`
diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md
index 64185341..7b676247 100644
--- a/docs/api/thermostats/set_hvac_mode.md
+++ b/docs/api/thermostats/set_hvac_mode.md
@@ -241,15 +241,11 @@ Format: `Object`
message Format: String
-
-
type Format: String
-
-
---
#### `result`
diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md
index f27a8723..04899ddf 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
created_at Format: Datetime
Date and time at which the event was created.
-
-
enrollment_automation_id Format: UUID
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).
-
-
event_id Format: UUID
ID of the event.
-
-
event_type Format: String
-
-
occurred_at Format: Datetime
Date and time at which the event occurred.
-
-
workspace_id Format: UUID
ID of the [workspace](../../../core-concepts/workspaces/README.md).
-
-
---
From 5533701d9d40bddf55f28b1abbba838538ec8492 Mon Sep 17 00:00:00 2001
From: Seam Bot
Date: Thu, 27 Mar 2025 16:26:29 +0000
Subject: [PATCH 18/18] ci: Generate docs
---
docs/api/acs/encoders/encode_credential.md | 280 +-----------
docs/api/acs/encoders/scan_credential.md | 412 ------------------
.../thermostats/activate_climate_preset.md | 22 -
docs/api/thermostats/cool.md | 25 --
docs/api/thermostats/heat.md | 25 --
docs/api/thermostats/heat_cool.md | 25 --
docs/api/thermostats/off.md | 25 --
docs/api/thermostats/set_fan_mode.md | 25 --
docs/api/thermostats/set_hvac_mode.md | 25 --
9 files changed, 1 insertion(+), 863 deletions(-)
diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md
index e0668db3..680f0666 100644
--- a/docs/api/acs/encoders/encode_credential.md
+++ b/docs/api/acs/encoders/encode_credential.md
@@ -52,286 +52,8 @@ ID of the action attempt.
Format: `String`
----
-
-#### `error`
-
-Format: `Object`
-
-
-
-message Format: String
-
-
-
-type Format: Enum
-
-Possible enum values:
-- `uncategorized_error`
-- `action_attempt_expired`
-- `no_credential_on_encoder`
-- `incompatible_card_format`
-- `credential_cannot_be_reissued`
-
----
-
-#### `result`
-
-Format: `Object`
-
-Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). The `acs_credential` object represents a [credential](../../../capability-guides/access-systems/managing-credentials.md) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code.
-
-
-
-access_method Format: Enum
-
-Access method for the [credential](../../../capability-guides/access-systems/managing-credentials.md). Supported values: `code`, `card`, `mobile_key`.
-
-Possible enum values:
-- `code`
-- `card`
-- `mobile_key`
-
-
-
-acs_credential_id Format: UUID
-
-ID of the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-acs_credential_pool_id Format: UUID
-
-
-
-acs_system_id Format: UUID
-
-ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-acs_user_id Format: UUID
-
-ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](../../../capability-guides/access-systems/managing-credentials.md) belongs.
-
-
-
-assa_abloy_vostio_metadata Format: Object
-
-Vostio-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-assa_abloy_vostio_metadata.door_names Format: List Item format: String
-
-
-
-assa_abloy_vostio_metadata.endpoint_id Format: String
-
-
-
-assa_abloy_vostio_metadata.key_id Format: String
-
-
-
-assa_abloy_vostio_metadata.key_issuing_request_id Format: String
-
-
-
-assa_abloy_vostio_metadata.override_guest_acs_entrance_ids Format: List Item format: String
-
-
-
-card_number Format: String
-
-Number of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-code Format: String
-
-Access (PIN) code for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-created_at Format: Datetime
-
-Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was created.
-
-
-
-display_name Format: String
-
-Display name that corresponds to the [credential](../../../capability-guides/access-systems/managing-credentials.md) type.
-
-
-
-ends_at Format: String
-
-Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
-
-
-
-errors Format: List Item format: Object
-
-Errors associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-- error_code Format: String
-
-
-- message Format: String
-
-
-
-
-external_type Format: Enum
-
-Brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.
-
-Possible enum values:
-- `pti_card`
-- `brivo_credential`
-- `hid_credential`
-- `visionline_card`
-- `salto_ks_credential`
-- `assa_abloy_vostio_key`
-- `salto_space_key`
-
-
-
-external_type_display_name Format: String
-
-Display name that corresponds to the brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type.
-
-
-
-is_issued Format: Boolean
-
-Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been encoded onto a card.
-
-
-
-is_latest_desired_state_synced_with_provider Format: Boolean
-
-Indicates whether the latest state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been synced from Seam to the provider.
-
-
-
-is_managed Format: Boolean
-
-
-
-is_multi_phone_sync_credential Format: Boolean
-
-Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).
-
-
-
-is_one_time_use Format: Boolean
-
-Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) can only be used once. If `true`, the code becomes invalid after the first use.
-
-
-
-issued_at Format: Datetime
-
-Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was encoded onto a card.
-
-
-
-latest_desired_state_synced_with_provider_at Format: Datetime
-
-Date and time at which the state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) was most recently synced from Seam to the provider.
-
-
-
-parent_acs_credential_id Format: UUID
-
-ID of the parent [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-starts_at Format: String
-
-Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
-
-
-
-visionline_metadata Format: Object
-
-Visionline-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-visionline_metadata.auto_join Format: Boolean
-
-
-
-visionline_metadata.card_function_type Format: Enum
-
-Possible enum values:
-- `guest`
-- `staff`
-
-
-
-visionline_metadata.card_id Format: String
-
-
-
-visionline_metadata.common_acs_entrance_ids Format: List Item format: UUID
-
-
-
-visionline_metadata.credential_id Format: String
-
-
-
-visionline_metadata.guest_acs_entrance_ids Format: List Item format: UUID
-
-
-
-visionline_metadata.is_valid Format: Boolean
-
-
-
-visionline_metadata.joiner_acs_credential_ids Format: List Item format: UUID
-
-
-
-warnings Format: List Item format: Object
-
-Warnings associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-- created_at Format: Datetime
-
- Date and time at which Seam created the warning.
-
-
-- message Format: String
-
- Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
-
-
-- warning_code Format: Enum
-
- Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
-
- Possible enum values:
- - `waiting_to_be_issued`
- - `schedule_externally_modified`
- - `schedule_modified`
- - `being_deleted`
- - `unknown_issue_with_acs_credential`
- - `needs_to_be_reissued`
-
-
-
-
-workspace_id Format: UUID
+Type of action that the action attempt tracks.
-ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
---
#### `status`
diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md
index 0f581783..ec39e369 100644
--- a/docs/api/acs/encoders/scan_credential.md
+++ b/docs/api/acs/encoders/scan_credential.md
@@ -45,418 +45,6 @@ Format: `String`
---
-#### `error`
-
-Format: `Object`
-
-
-
-message Format: String
-
-
-
-type Format: Enum
-
-Possible enum values:
-- `uncategorized_error`
-- `action_attempt_expired`
-- `no_credential_on_encoder`
-
----
-
-#### `result`
-
-Format: `Object`
-
-
-
-acs_credential_on_encoder Format: Object
-
-Snapshot of credential data read from physical encoder.
-
-
-
-acs_credential_on_encoder.card_number Format: String
-
-A number or string that physically identifies the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-acs_credential_on_encoder.created_at Format: Datetime
-
-Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was created.
-
-
-
-acs_credential_on_encoder.ends_at Format: Datetime
-
-Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) will stop being usable.
-
-
-
-acs_credential_on_encoder.is_issued Format: Boolean
-
-
-
-acs_credential_on_encoder.starts_at Format: Datetime
-
-Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) becomes usable.
-
-
-
-acs_credential_on_encoder.visionline_metadata Format: Object
-
-Visionline-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-acs_credential_on_encoder.visionline_metadata.cancelled Format: Boolean
-
-Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is cancelled.
-
-
-
-acs_credential_on_encoder.visionline_metadata.card_format Format: Enum
-
-Format of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-Possible enum values:
-- `TLCode`
-- `rfid48`
-
-
-
-acs_credential_on_encoder.visionline_metadata.card_holder Format: String
-
-Holden of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-acs_credential_on_encoder.visionline_metadata.card_id Format: String
-
-Card ID for the Visionline card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-acs_credential_on_encoder.visionline_metadata.common_acs_entrance_ids Format: List Item format: UUID
-
-IDs of the common [entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md) for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-acs_credential_on_encoder.visionline_metadata.discarded Format: Boolean
-
-Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is discarded.
-
-
-
-acs_credential_on_encoder.visionline_metadata.expired Format: Boolean
-
-Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is expired.
-
-
-
-acs_credential_on_encoder.visionline_metadata.guest_acs_entrance_ids Format: List Item format: UUID
-
-IDs of the guest [entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md) for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-acs_credential_on_encoder.visionline_metadata.number_of_issued_cards Format: Number
-
-Number of issued cards associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-acs_credential_on_encoder.visionline_metadata.overridden Format: Boolean
-
-Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is overridden.
-
-
-
-acs_credential_on_encoder.visionline_metadata.overwritten Format: Boolean
-
-Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is overwritten.
-
-
-
-acs_credential_on_encoder.visionline_metadata.pending_auto_update Format: Boolean
-
-Indicates whether the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md) is pending auto-update.
-
-
-
-acs_credential_on_seam Format: Object
-
-Matching acs_credential currently encoded on this card.
-
-
-
-acs_credential_on_seam.access_method Format: Enum
-
-Access method for the [credential](../../../capability-guides/access-systems/managing-credentials.md). Supported values: `code`, `card`, `mobile_key`.
-
-Possible enum values:
-- `code`
-- `card`
-- `mobile_key`
-
-
-
-acs_credential_on_seam.acs_credential_id Format: UUID
-
-ID of the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-acs_credential_on_seam.acs_credential_pool_id Format: UUID
-
-
-
-acs_credential_on_seam.acs_system_id Format: UUID
-
-ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-acs_credential_on_seam.acs_user_id Format: UUID
-
-ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](../../../capability-guides/access-systems/managing-credentials.md) belongs.
-
-
-
-acs_credential_on_seam.assa_abloy_vostio_metadata Format: Object
-
-Vostio-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-acs_credential_on_seam.assa_abloy_vostio_metadata.door_names Format: List Item format: String
-
-
-
-acs_credential_on_seam.assa_abloy_vostio_metadata.endpoint_id Format: String
-
-
-
-acs_credential_on_seam.assa_abloy_vostio_metadata.key_id Format: String
-
-
-
-acs_credential_on_seam.assa_abloy_vostio_metadata.key_issuing_request_id Format: String
-
-
-
-acs_credential_on_seam.assa_abloy_vostio_metadata.override_guest_acs_entrance_ids Format: List Item format: String
-
-
-
-acs_credential_on_seam.card_number Format: String
-
-Number of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-acs_credential_on_seam.code Format: String
-
-Access (PIN) code for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-acs_credential_on_seam.created_at Format: Datetime
-
-Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was created.
-
-
-
-acs_credential_on_seam.display_name Format: String
-
-Display name that corresponds to the [credential](../../../capability-guides/access-systems/managing-credentials.md) type.
-
-
-
-acs_credential_on_seam.ends_at Format: String
-
-Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
-
-
-
-acs_credential_on_seam.errors Format: List Item format: Object
-
-Errors associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-- error_code Format: String
-
-
-- message Format: String
-
-
-
-
-acs_credential_on_seam.external_type Format: Enum
-
-Brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.
-
-Possible enum values:
-- `pti_card`
-- `brivo_credential`
-- `hid_credential`
-- `visionline_card`
-- `salto_ks_credential`
-- `assa_abloy_vostio_key`
-- `salto_space_key`
-
-
-
-acs_credential_on_seam.external_type_display_name Format: String
-
-Display name that corresponds to the brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type.
-
-
-
-acs_credential_on_seam.is_issued Format: Boolean
-
-Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been encoded onto a card.
-
-
-
-acs_credential_on_seam.is_latest_desired_state_synced_with_provider Format: Boolean
-
-Indicates whether the latest state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been synced from Seam to the provider.
-
-
-
-acs_credential_on_seam.is_managed Format: Boolean
-
-
-
-acs_credential_on_seam.is_multi_phone_sync_credential Format: Boolean
-
-Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).
-
-
-
-acs_credential_on_seam.is_one_time_use Format: Boolean
-
-Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) can only be used once. If `true`, the code becomes invalid after the first use.
-
-
-
-acs_credential_on_seam.issued_at Format: Datetime
-
-Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was encoded onto a card.
-
-
-
-acs_credential_on_seam.latest_desired_state_synced_with_provider_at Format: Datetime
-
-Date and time at which the state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) was most recently synced from Seam to the provider.
-
-
-
-acs_credential_on_seam.parent_acs_credential_id Format: UUID
-
-ID of the parent [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-acs_credential_on_seam.starts_at Format: String
-
-Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
-
-
-
-acs_credential_on_seam.visionline_metadata Format: Object
-
-Visionline-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-acs_credential_on_seam.visionline_metadata.auto_join Format: Boolean
-
-
-
-acs_credential_on_seam.visionline_metadata.card_function_type Format: Enum
-
-Possible enum values:
-- `guest`
-- `staff`
-
-
-
-acs_credential_on_seam.visionline_metadata.card_id Format: String
-
-
-
-acs_credential_on_seam.visionline_metadata.common_acs_entrance_ids Format: List Item format: UUID
-
-
-
-acs_credential_on_seam.visionline_metadata.credential_id Format: String
-
-
-
-acs_credential_on_seam.visionline_metadata.guest_acs_entrance_ids Format: List Item format: UUID
-
-
-
-acs_credential_on_seam.visionline_metadata.is_valid Format: Boolean
-
-
-
-acs_credential_on_seam.visionline_metadata.joiner_acs_credential_ids Format: List Item format: UUID
-
-
-
-acs_credential_on_seam.warnings Format: List Item format: Object
-
-Warnings associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-- created_at Format: Datetime
-
- Date and time at which Seam created the warning.
-
-
-- message Format: String
-
- Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
-
-
-- warning_code Format: Enum
-
- Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
-
- Possible enum values:
- - `waiting_to_be_issued`
- - `schedule_externally_modified`
- - `schedule_modified`
- - `being_deleted`
- - `unknown_issue_with_acs_credential`
- - `needs_to_be_reissued`
-
-
-
-
-acs_credential_on_seam.workspace_id Format: UUID
-
-ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-
-
-
-warnings Format: List Item format: Object
-
-- warning_code Format: Enum
-
- Possible enum values:
- - `acs_credential_on_encoder_out_of_sync`
- - `acs_credential_on_seam_not_found`
-
-
-- warning_message Format: String
-
-
----
-
#### `status`
Format: `Enum`
diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md
index 5c6e7443..54efb64e 100644
--- a/docs/api/thermostats/activate_climate_preset.md
+++ b/docs/api/thermostats/activate_climate_preset.md
@@ -186,28 +186,6 @@ Format: `String`
---
-#### `error`
-
-Format: `Object`
-
-
-
-message Format: String
-
-
-
-type Format: String
-
----
-
-#### `result`
-
-Format: `Object`
-
-This object has no properties.
-
----
-
#### `status`
Format: `Enum`
diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md
index cfda4e77..5879fe40 100644
--- a/docs/api/thermostats/cool.md
+++ b/docs/api/thermostats/cool.md
@@ -196,31 +196,6 @@ Format: `String`
---
-<<<<<<< HEAD
-#### `error`
-
-Format: `Object`
-
-
-
-message Format: String
-
-
-
-type Format: String
-
----
-
-#### `result`
-
-Format: `Object`
-
-This object has no properties.
-
----
-
-=======
->>>>>>> 85fe55468e31eda661e51396831b1d6d9a7dd530
#### `status`
Format: `Enum`
diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md
index ec851a54..5b9d14db 100644
--- a/docs/api/thermostats/heat.md
+++ b/docs/api/thermostats/heat.md
@@ -196,31 +196,6 @@ Format: `String`
---
-<<<<<<< HEAD
-#### `error`
-
-Format: `Object`
-
-
-
-message Format: String
-
-
-
-type Format: String
-
----
-
-#### `result`
-
-Format: `Object`
-
-This object has no properties.
-
----
-
-=======
->>>>>>> 85fe55468e31eda661e51396831b1d6d9a7dd530
#### `status`
Format: `Enum`
diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md
index 0e3cf33d..35d1f5cc 100644
--- a/docs/api/thermostats/heat_cool.md
+++ b/docs/api/thermostats/heat_cool.md
@@ -220,31 +220,6 @@ Format: `String`
---
-<<<<<<< HEAD
-#### `error`
-
-Format: `Object`
-
-
-
-message Format: String
-
-
-
-type Format: String
-
----
-
-#### `result`
-
-Format: `Object`
-
-This object has no properties.
-
----
-
-=======
->>>>>>> 85fe55468e31eda661e51396831b1d6d9a7dd530
#### `status`
Format: `Enum`
diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md
index 4e4be33f..a0004017 100644
--- a/docs/api/thermostats/off.md
+++ b/docs/api/thermostats/off.md
@@ -168,31 +168,6 @@ Format: `String`
---
-<<<<<<< HEAD
-#### `error`
-
-Format: `Object`
-
-
-
-message Format: String
-
-
-
-type Format: String
-
----
-
-#### `result`
-
-Format: `Object`
-
-This object has no properties.
-
----
-
-=======
->>>>>>> 85fe55468e31eda661e51396831b1d6d9a7dd530
#### `status`
Format: `Enum`
diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md
index 95c6c6fb..5ceb9216 100644
--- a/docs/api/thermostats/set_fan_mode.md
+++ b/docs/api/thermostats/set_fan_mode.md
@@ -196,31 +196,6 @@ Format: `String`
---
-<<<<<<< HEAD
-#### `error`
-
-Format: `Object`
-
-
-
-message Format: String
-
-
-
-type Format: String
-
----
-
-#### `result`
-
-Format: `Object`
-
-This object has no properties.
-
----
-
-=======
->>>>>>> 85fe55468e31eda661e51396831b1d6d9a7dd530
#### `status`
Format: `Enum`
diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md
index 17ec824e..f1e05acf 100644
--- a/docs/api/thermostats/set_hvac_mode.md
+++ b/docs/api/thermostats/set_hvac_mode.md
@@ -234,31 +234,6 @@ Format: `String`
---
-<<<<<<< HEAD
-#### `error`
-
-Format: `Object`
-
-
-
-message Format: String
-
-
-
-type Format: String
-
----
-
-#### `result`
-
-Format: `Object`
-
-This object has no properties.
-
----
-
-=======
->>>>>>> 85fe55468e31eda661e51396831b1d6d9a7dd530
#### `status`
Format: `Enum`