Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
184 changes: 184 additions & 0 deletions docs/api-reference/_blueprint.json
Original file line number Diff line number Diff line change
Expand Up @@ -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."
}
]
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -127084,6 +127200,16 @@
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": ""
},
{
"name": "privacy_mode",
"description": "",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": ""
}
]
}
Expand Down Expand Up @@ -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",
Expand Down
42 changes: 40 additions & 2 deletions docs/api-reference/acs/entrances/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -610,7 +610,7 @@ Indicates that this entrance requires additional configuration in the access con
<details>
<summary><code>salto_ks_privacy_mode</code></summary>

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*

Expand Down Expand Up @@ -638,6 +638,38 @@ Indicates that this entrance is in privacy mode. When privacy mode is enabled, a
- <code>salto_ks_privacy_mode</code>


</details>
<details>
<summary><code>privacy_mode</code></summary>

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:

- <code>privacy_mode</code>


</details>

---
Expand All @@ -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.
Expand All @@ -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.

---

Expand Down
38 changes: 38 additions & 0 deletions docs/api-reference/devices/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1749,6 +1749,38 @@ Indicates that the Salto KS lock is in Privacy Mode. Access Codes will not unloc
- <code>salto_ks_privacy_mode</code>


</details>
<details>
<summary><code>privacy_mode</code></summary>

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:

- <code>privacy_mode</code>


</details>
<details>
<summary><code>salto_ks_subscription_limit_almost_reached</code></summary>
Expand Down Expand Up @@ -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.
Expand Down
38 changes: 38 additions & 0 deletions docs/api-reference/devices/unmanaged/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1464,6 +1464,38 @@ Indicates that the Salto KS lock is in Privacy Mode. Access Codes will not unloc
- <code>salto_ks_privacy_mode</code>


</details>
<details>
<summary><code>privacy_mode</code></summary>

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:

- <code>privacy_mode</code>


</details>
<details>
<summary><code>salto_ks_subscription_limit_almost_reached</code></summary>
Expand Down Expand Up @@ -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.
Expand Down
Loading
Loading