diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index b84ce257e..4feb7dcb4 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -58,6 +58,286 @@ Value: `ENCODE_CREDENTIAL` --- +#### `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` + +If an encoding attempt was successful, includes the `acs_credential` data that was encoded onto the 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). +
+
+ +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 + +ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md). +
+--- + #### `status` Format: `Enum` diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index db039d972..d2c63285c 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -47,6 +47,418 @@ Value: `SCAN_CREDENTIAL` --- +#### `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 0dd999a99..155a95ae2 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -188,6 +188,28 @@ Value: `ACTIVATE_CLIMATE_PRESET` --- +#### `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 8845660f8..a2aedc3db 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -198,6 +198,28 @@ Value: `SET_HVAC_MODE` --- +#### `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/heat.md b/docs/api/thermostats/heat.md index 24e6c1289..963159410 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -198,6 +198,28 @@ Value: `SET_HVAC_MODE` --- +#### `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/heat_cool.md b/docs/api/thermostats/heat_cool.md index e6cdae671..56e095626 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -222,6 +222,28 @@ Value: `SET_HVAC_MODE` --- +#### `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/off.md b/docs/api/thermostats/off.md index e8b7b24db..c765601a5 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -170,6 +170,28 @@ Value: `SET_HVAC_MODE` --- +#### `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/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index e6a1fe930..6c7043653 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -208,6 +208,28 @@ Value: `SET_FAN_MODE` --- +#### `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/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index e2c779c5f..1887d9536 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -240,6 +240,28 @@ Value: `SET_HVAC_MODE` --- +#### `error` + +Format: `Object` + +
+ +message Format: String +
+
+ +type Format: String +
+--- + +#### `result` + +Format: `Object` + +This object has no properties. + +--- + #### `status` Format: `Enum` diff --git a/package-lock.json b/package-lock.json index 132ebcb5e..3a302e388 100644 --- a/package-lock.json +++ b/package-lock.json @@ -13,7 +13,7 @@ "@metalsmith/metadata": "^0.3.0", "@prettier/plugin-php": "^0.22.2", "@prettier/plugin-ruby": "^4.0.4", - "@seamapi/blueprint": "^0.38.0", + "@seamapi/blueprint": "^0.40.1", "@seamapi/types": "1.384.0", "change-case": "^5.4.4", "command-exists": "^1.2.9", @@ -767,9 +767,9 @@ "peer": true }, "node_modules/@seamapi/blueprint": { - "version": "0.38.0", - "resolved": "https://registry.npmjs.org/@seamapi/blueprint/-/blueprint-0.38.0.tgz", - "integrity": "sha512-NlmzFZgoWORyKIsrKpTUdwOwHLzyV421VsYbDEPD/s/2c4wZoQdunjLHc1qgdfqvb5602+XVFldyi6bs0ssRNA==", + "version": "0.40.1", + "resolved": "https://registry.npmjs.org/@seamapi/blueprint/-/blueprint-0.40.1.tgz", + "integrity": "sha512-Xwpc39dReqYQCnIcWcmaPWnkW8aYL5f8wbk3FWRwWKVd8qDUcun3mdsqzcnS7lqwyuqhgUS02xyPR203fGOLjA==", "license": "MIT", "dependencies": { "change-case": "^5.4.4", diff --git a/package.json b/package.json index bf5ebab36..605e5dfe4 100644 --- a/package.json +++ b/package.json @@ -33,7 +33,7 @@ "@metalsmith/metadata": "^0.3.0", "@prettier/plugin-php": "^0.22.2", "@prettier/plugin-ruby": "^4.0.4", - "@seamapi/blueprint": "^0.38.0", + "@seamapi/blueprint": "^0.40.1", "@seamapi/types": "1.384.0", "change-case": "^5.4.4", "command-exists": "^1.2.9",