diff --git a/docs/api-reference/_blueprint.json b/docs/api-reference/_blueprint.json index 11c11fa5e..10dde0de2 100644 --- a/docs/api-reference/_blueprint.json +++ b/docs/api-reference/_blueprint.json @@ -104492,6 +104492,64 @@ ] } ], + "description": "deprecated: Use `privacy_mode` instead. Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access." + }, + { + "resourceType": null, + "variantGroupKey": null, + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "privacy_mode", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], "description": "Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access." } ] @@ -121363,6 +121421,64 @@ ], "description": "Indicates that the Salto KS lock is in Privacy Mode. Access Codes will not unlock doors." }, + { + "resourceType": null, + "variantGroupKey": "access_codes", + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "privacy_mode", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Indicates that the lock is in Privacy Mode. Access codes and remote unlock are blocked until Privacy Mode is disabled." + }, { "resourceType": null, "variantGroupKey": "locks", @@ -127084,6 +127200,16 @@ "undocumentedMessage": "", "isDraft": false, "draftMessage": "" + }, + { + "name": "privacy_mode", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" } ] } @@ -140089,6 +140215,64 @@ ], "description": "Indicates that the Salto KS lock is in Privacy Mode. Access Codes will not unlock doors." }, + { + "resourceType": null, + "variantGroupKey": "access_codes", + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "privacy_mode", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Indicates that the lock is in Privacy Mode. Access codes and remote unlock are blocked until Privacy Mode is disabled." + }, { "resourceType": null, "variantGroupKey": "locks", diff --git a/docs/api-reference/acs/entrances/README.md b/docs/api-reference/acs/entrances/README.md index 492f9ec9c..6bbb9406d 100644 --- a/docs/api-reference/acs/entrances/README.md +++ b/docs/api-reference/acs/entrances/README.md @@ -610,7 +610,7 @@ Indicates that this entrance requires additional configuration in the access con
salto_ks_privacy_mode -Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access. +deprecated: Use `privacy_mode` instead. Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access. **`created_at`** *Datetime* @@ -638,6 +638,38 @@ Indicates that this entrance is in privacy mode. When privacy mode is enabled, a - salto_ks_privacy_mode +
+
+privacy_mode + +Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access. + + **`created_at`** *Datetime* + + + Date and time at which Seam created the warning. + + + --- + + **`message`** *String* + + + Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. + + + --- + + **`warning_code`** *Enum* + + + Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. + + Enum values: + + - privacy_mode + +
--- @@ -657,6 +689,12 @@ Indicates that this entrance shares a zone with other entrances in Avigilon Alta --- +**`privacy_mode`** + +Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access. + +--- + **`salto_ks_entrance_access_code_support_removed`** Indicates that a change in the reported device model has been detected for this Salto KS entrance, which may occur after an IQ hub reset. Access code support may be affected. See https://help.getseam.com/articles/5098842588-salto-ks-lock-loses-access-code-support for troubleshooting steps. @@ -665,7 +703,7 @@ Indicates that a change in the reported device model has been detected for this **`salto_ks_privacy_mode`** -Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access. +deprecated: Use `privacy_mode` instead. Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access. --- diff --git a/docs/api-reference/devices/README.md b/docs/api-reference/devices/README.md index 7f50fba13..4641ee859 100644 --- a/docs/api-reference/devices/README.md +++ b/docs/api-reference/devices/README.md @@ -1749,6 +1749,38 @@ Indicates that the Salto KS lock is in Privacy Mode. Access Codes will not unloc - salto_ks_privacy_mode + +
+privacy_mode + +Indicates that the lock is in Privacy Mode. Access codes and remote unlock are blocked until Privacy Mode is disabled. + + **`created_at`** *Datetime* + + + Date and time at which Seam created the warning. + + + --- + + **`message`** *String* + + + Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. + + + --- + + **`warning_code`** *Enum* + + + Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. + + Enum values: + + - privacy_mode + +
salto_ks_subscription_limit_almost_reached @@ -5206,6 +5238,12 @@ Indicates that the backup access code is unhealthy. --- +**`privacy_mode`** + +Indicates that the lock is in Privacy Mode. Access codes and remote unlock are blocked until Privacy Mode is disabled. + +--- + **`provider_issue`** Indicates a provider-specific issue that may affect device functionality. diff --git a/docs/api-reference/devices/unmanaged/README.md b/docs/api-reference/devices/unmanaged/README.md index bd070f4e3..e53c81de8 100644 --- a/docs/api-reference/devices/unmanaged/README.md +++ b/docs/api-reference/devices/unmanaged/README.md @@ -1464,6 +1464,38 @@ Indicates that the Salto KS lock is in Privacy Mode. Access Codes will not unloc - salto_ks_privacy_mode +
+
+privacy_mode + +Indicates that the lock is in Privacy Mode. Access codes and remote unlock are blocked until Privacy Mode is disabled. + + **`created_at`** *Datetime* + + + Date and time at which Seam created the warning. + + + --- + + **`message`** *String* + + + Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. + + + --- + + **`warning_code`** *Enum* + + + Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. + + Enum values: + + - privacy_mode + +
salto_ks_subscription_limit_almost_reached @@ -2336,6 +2368,12 @@ Indicates that the backup access code is unhealthy. --- +**`privacy_mode`** + +Indicates that the lock is in Privacy Mode. Access codes and remote unlock are blocked until Privacy Mode is disabled. + +--- + **`provider_issue`** Indicates a provider-specific issue that may affect device functionality. diff --git a/docs/api-reference/locks/README.md b/docs/api-reference/locks/README.md index cfc60a3f3..3f71c230a 100644 --- a/docs/api-reference/locks/README.md +++ b/docs/api-reference/locks/README.md @@ -1508,6 +1508,38 @@ Indicates that the Salto KS lock is in Privacy Mode. Access Codes will not unloc - salto_ks_privacy_mode +
+
+privacy_mode + +Indicates that the lock is in Privacy Mode. Access codes and remote unlock are blocked until Privacy Mode is disabled. + + **`created_at`** *Datetime* + + + Date and time at which Seam created the warning. + + + --- + + **`message`** *String* + + + Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. + + + --- + + **`warning_code`** *Enum* + + + Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. + + Enum values: + + - privacy_mode + +
salto_ks_subscription_limit_almost_reached @@ -3952,6 +3984,12 @@ Indicates that the device is in power saving mode and may have limited functiona --- +**`privacy_mode`** + +Indicates that the lock is in Privacy Mode. Access codes and remote unlock are blocked until Privacy Mode is disabled. + +--- + **`provider_issue`** Indicates a provider-specific issue that may affect device functionality. diff --git a/docs/api-reference/thermostats/README.md b/docs/api-reference/thermostats/README.md index 31b4d6a55..d0629be94 100644 --- a/docs/api-reference/thermostats/README.md +++ b/docs/api-reference/thermostats/README.md @@ -1624,6 +1624,38 @@ Indicates that the Salto KS lock is in Privacy Mode. Access Codes will not unloc - salto_ks_privacy_mode +
+
+privacy_mode + +Indicates that the lock is in Privacy Mode. Access codes and remote unlock are blocked until Privacy Mode is disabled. + + **`created_at`** *Datetime* + + + Date and time at which Seam created the warning. + + + --- + + **`message`** *String* + + + Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. + + + --- + + **`warning_code`** *Enum* + + + Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. + + Enum values: + + - privacy_mode + +
salto_ks_subscription_limit_almost_reached diff --git a/mintlify-docs/api/acs/entrances/errors.mdx b/mintlify-docs/api/acs/entrances/errors.mdx index d6e08bbbf..8b71291ea 100644 --- a/mintlify-docs/api/acs/entrances/errors.mdx +++ b/mintlify-docs/api/acs/entrances/errors.mdx @@ -45,6 +45,12 @@ Indicates that this entrance shares a zone with other entrances in Avigilon Alta --- +### `privacy_mode` + +Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access. + +--- + ### `salto_ks_entrance_access_code_support_removed` Indicates that a change in the reported device model has been detected for this Salto KS entrance, which may occur after an IQ hub reset. Access code support may be affected. See https://help.getseam.com/articles/5098842588-salto-ks-lock-loses-access-code-support for troubleshooting steps. @@ -53,6 +59,6 @@ Indicates that a change in the reported device model has been detected for this ### `salto_ks_privacy_mode` -Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access. +deprecated: Use `privacy_mode` instead. Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access. --- diff --git a/mintlify-docs/api/devices/errors.mdx b/mintlify-docs/api/devices/errors.mdx index b9ebcd91b..3fd193f5d 100644 --- a/mintlify-docs/api/devices/errors.mdx +++ b/mintlify-docs/api/devices/errors.mdx @@ -237,6 +237,12 @@ Indicates that the backup access code is unhealthy. --- +#### `privacy_mode` + +Indicates that the lock is in Privacy Mode. Access codes and remote unlock are blocked until Privacy Mode is disabled. + +--- + #### `provider_issue` Indicates a provider-specific issue that may affect device functionality. diff --git a/mintlify-docs/api/devices/unmanaged/errors.mdx b/mintlify-docs/api/devices/unmanaged/errors.mdx index ae9e3008e..1e3e9630a 100644 --- a/mintlify-docs/api/devices/unmanaged/errors.mdx +++ b/mintlify-docs/api/devices/unmanaged/errors.mdx @@ -237,6 +237,12 @@ Indicates that the backup access code is unhealthy. --- +#### `privacy_mode` + +Indicates that the lock is in Privacy Mode. Access codes and remote unlock are blocked until Privacy Mode is disabled. + +--- + #### `provider_issue` Indicates a provider-specific issue that may affect device functionality. diff --git a/mintlify-docs/openapi.json b/mintlify-docs/openapi.json index 98ac10ec4..6a613ea9a 100644 --- a/mintlify-docs/openapi.json +++ b/mintlify-docs/openapi.json @@ -2748,124 +2748,26 @@ "type": "object" }, "warnings": { + "type": "array", "description": "Warnings associated with the [entrance](/low-level-apis/access-systems/retrieving-entrance-details).", "items": { - "description": "Warning associated with the [entrance](/low-level-apis/access-systems/retrieving-entrance-details).", - "discriminator": { - "propertyName": "warning_code" - }, - "oneOf": [ - { - "description": "Indicates that a change in the reported device model has been detected for this Salto KS entrance, which may occur after an IQ hub reset. Access code support may be affected. See https://help.getseam.com/articles/5098842588-salto-ks-lock-loses-access-code-support for troubleshooting steps.", - "properties": { - "created_at": { - "description": "Date and time at which Seam created the warning.", - "format": "date-time", - "type": "string" - }, - "message": { - "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", - "type": "string" - }, - "warning_code": { - "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", - "enum": [ - "salto_ks_entrance_access_code_support_removed" - ], - "type": "string" - } - }, - "required": [ - "created_at", - "message", - "warning_code" - ], - "type": "object" - }, - { - "description": "Indicates that this entrance shares a zone with other entrances in Avigilon Alta and cannot be added to an access group individually.", - "properties": { - "created_at": { - "description": "Date and time at which Seam created the warning.", - "format": "date-time", - "type": "string" - }, - "message": { - "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", - "type": "string" - }, - "warning_code": { - "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", - "enum": [ - "entrance_shares_zone" - ], - "type": "string" - } - }, - "required": [ - "created_at", - "message", - "warning_code" - ], - "type": "object" + "type": "object", + "properties": { + "error_code": { + "type": "string", + "description": "Error or warning code." }, - { - "description": "Indicates that this entrance requires additional configuration in the access control system before Seam can fully manage it.", - "properties": { - "created_at": { - "description": "Date and time at which Seam created the warning.", - "format": "date-time", - "type": "string" - }, - "message": { - "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", - "type": "string" - }, - "warning_code": { - "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", - "enum": [ - "entrance_setup_required" - ], - "type": "string" - } - }, - "required": [ - "created_at", - "message", - "warning_code" - ], - "type": "object" + "message": { + "type": "string", + "description": "Human-readable description." }, - { - "description": "Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access.", - "properties": { - "created_at": { - "description": "Date and time at which Seam created the warning.", - "format": "date-time", - "type": "string" - }, - "message": { - "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", - "type": "string" - }, - "warning_code": { - "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", - "enum": [ - "salto_ks_privacy_mode" - ], - "type": "string" - } - }, - "required": [ - "created_at", - "message", - "warning_code" - ], - "type": "object" + "created_at": { + "type": "string", + "format": "date-time", + "description": "When this error or warning was generated." } - ] - }, - "type": "array" + } + } } }, "required": [ @@ -19960,7 +19862,7 @@ "type": "object" }, { - "description": "Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access.", + "description": "deprecated: Use `privacy_mode` instead. Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", @@ -19985,6 +19887,33 @@ "warning_code" ], "type": "object" + }, + { + "description": "Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access.", + "properties": { + "created_at": { + "description": "Date and time at which Seam created the warning.", + "format": "date-time", + "type": "string" + }, + "message": { + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "type": "string" + }, + "warning_code": { + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "enum": [ + "privacy_mode" + ], + "type": "string" + } + }, + "required": [ + "created_at", + "message", + "warning_code" + ], + "type": "object" } ] }, diff --git a/package-lock.json b/package-lock.json index 203b1e3cf..237b8edd2 100644 --- a/package-lock.json +++ b/package-lock.json @@ -14,7 +14,7 @@ "@prettier/plugin-ruby": "^4.0.4", "@seamapi/blueprint": "^0.56.0", "@seamapi/smith": "^0.5.2", - "@seamapi/types": "1.951.0", + "@seamapi/types": "1.952.0", "@types/command-exists": "^1.2.3", "change-case": "^5.4.4", "command-exists": "^1.2.9", @@ -4094,9 +4094,9 @@ } }, "node_modules/@seamapi/types": { - "version": "1.951.0", - "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.951.0.tgz", - "integrity": "sha512-jHBP7KAmlzKU8qcidtMDisZ7fUIMBrAoJmKFOHJ4TmIcBp+u1plTXoU48gYUhHiNHDi1NTGgiU+uOc/pv4/EwA==", + "version": "1.952.0", + "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.952.0.tgz", + "integrity": "sha512-PFeT7KF9f1cpy8GTOaBpVmqzwlnqfV8GBuHJ4Yr4uuMaP+Fq1nV5GTcJRQW5GBq1ztCk7WHswH+HFInjyMIK/A==", "dev": true, "license": "MIT", "engines": { diff --git a/package.json b/package.json index 807addd44..411b049d9 100644 --- a/package.json +++ b/package.json @@ -44,7 +44,7 @@ "@prettier/plugin-ruby": "^4.0.4", "@seamapi/blueprint": "^0.56.0", "@seamapi/smith": "^0.5.2", - "@seamapi/types": "1.951.0", + "@seamapi/types": "1.952.0", "@types/command-exists": "^1.2.3", "change-case": "^5.4.4", "command-exists": "^1.2.9",