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
27 changes: 27 additions & 0 deletions docs/api-reference/_blueprint.json
Original file line number Diff line number Diff line change
Expand Up @@ -52120,6 +52120,20 @@
"semanticMethod": "PATCH",
"preferredMethod": "PATCH",
"parameters": [
{
"name": "backup_access_code_pool_enabled",
"description": "Indicates whether the device's [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is enabled. Set to `false` to disable the pool: Seam stops refilling it and removes any backup codes that have not yet been pulled into active use.",
"isRequired": false,
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"hasDefault": false,
"format": "boolean",
"jsonType": "boolean"
},
{
"name": "custom_metadata",
"description": "Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter devices by the desired metadata](https://docs.seam.co/core-concepts/devices/filtering-devices-by-custom-metadata).",
Expand Down Expand Up @@ -117436,6 +117450,19 @@
"format": "boolean",
"jsonType": "boolean"
},
{
"name": "backup_access_code_pool_enabled",
"description": "Indicates whether the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is currently enabled for the device. To disable it, set this to `false` using [/devices/update](https://docs.seam.co/api/devices/update).",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"propertyGroupKey": "access_codes",
"format": "boolean",
"jsonType": "boolean"
},
{
"name": "code_constraints",
"description": "Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific.",
Expand Down
9 changes: 9 additions & 0 deletions docs/api-reference/devices/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3746,6 +3746,15 @@ Metadata for a Wyze device.
---

## Access Codes
**`backup_access_code_pool_enabled`** *Boolean*

Indicates whether the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is currently enabled for the device. To disable it, set this to `false` using [/devices/update](https://docs.seam.co/api/devices/update).




---

**`code_constraints`** *List* *of Objects*

Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific.
Expand Down
6 changes: 6 additions & 0 deletions docs/api-reference/devices/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,12 @@ ID of the device that you want to update.

---

**`backup_access_code_pool_enabled`** *Boolean*

Indicates whether the device's [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is enabled. Set to `false` to disable the pool: Seam stops refilling it and removes any backup codes that have not yet been pulled into active use.

---

**`custom_metadata`** *Object*

Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter devices by the desired metadata](https://docs.seam.co/core-concepts/devices/filtering-devices-by-custom-metadata).
Expand Down
9 changes: 9 additions & 0 deletions docs/api-reference/locks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2131,6 +2131,15 @@ Metadata for an Avigilon Alta system.

</details>

---

**`backup_access_code_pool_enabled`** *Boolean*

Indicates whether the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is currently enabled for the device. To disable it, set this to `false` using [/devices/update](https://docs.seam.co/api/devices/update).




---

**`brivo_metadata`** *Object*
Expand Down
7 changes: 7 additions & 0 deletions mintlify-docs/api/devices/object.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -1478,6 +1478,9 @@ Represents a [device](/core-concepts/devices) that has been connected to Seam.
<ResponseField name="auto_lock_enabled" type="Boolean">
Indicates whether automatic locking is enabled.
</ResponseField>
<ResponseField name="backup_access_code_pool_enabled" type="Boolean">
Indicates whether the [backup access code pool](/low-level-apis/smart-locks/access-codes/backup-access-codes) is currently enabled for the device. To disable it, set this to `false` using [/devices/update](/api/devices/update).
</ResponseField>
<ResponseField name="code_constraints" type="Array">
Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific.
<Expandable title="properties">
Expand Down Expand Up @@ -2063,6 +2066,10 @@ Represents a [device](/core-concepts/devices) that has been connected to Seam.
The supports offline access codes.
</ResponseField>

<ResponseField name="backup_access_code_pool_enabled" type="Boolean">
Indicates whether the [backup access code pool](/low-level-apis/smart-locks/access-codes/backup-access-codes) is currently enabled for the device. To disable it, set this to `false` using [/devices/update](/api/devices/update).
</ResponseField>

<ResponseField name="code_constraints" type="Array">
Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific.
<Expandable title="properties">
Expand Down
7 changes: 7 additions & 0 deletions mintlify-docs/api/locks/object.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -1189,6 +1189,9 @@ See also [Webhooks](/developer-tools/webhooks).
<ResponseField name="auto_lock_enabled" type="Boolean">
Indicates whether automatic locking is enabled.
</ResponseField>
<ResponseField name="backup_access_code_pool_enabled" type="Boolean">
Indicates whether the [backup access code pool](/low-level-apis/smart-locks/access-codes/backup-access-codes) is currently enabled for the device. To disable it, set this to `false` using [/devices/update](/api/devices/update).
</ResponseField>
<ResponseField name="code_constraints" type="Array">
Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific.
<Expandable title="properties">
Expand Down Expand Up @@ -1726,6 +1729,10 @@ See also [Webhooks](/developer-tools/webhooks).
The supports offline access codes.
</ResponseField>

<ResponseField name="backup_access_code_pool_enabled" type="Boolean">
Indicates whether the [backup access code pool](/low-level-apis/smart-locks/access-codes/backup-access-codes) is currently enabled for the device. To disable it, set this to `false` using [/devices/update](/api/devices/update).
</ResponseField>

<ResponseField name="code_constraints" type="Array">
Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific.
<Expandable title="properties">
Expand Down
3 changes: 3 additions & 0 deletions mintlify-docs/api/thermostats/object.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -1319,6 +1319,9 @@ The Seam API represents a thermostat as a `device` resource that includes both b
<ResponseField name="auto_lock_enabled" type="Boolean">
Indicates whether automatic locking is enabled.
</ResponseField>
<ResponseField name="backup_access_code_pool_enabled" type="Boolean">
Indicates whether the [backup access code pool](/low-level-apis/smart-locks/access-codes/backup-access-codes) is currently enabled for the device. To disable it, set this to `false` using [/devices/update](/api/devices/update).
</ResponseField>
<ResponseField name="code_constraints" type="Array">
Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific.
<Expandable title="properties">
Expand Down
13 changes: 13 additions & 0 deletions mintlify-docs/openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -7154,6 +7154,11 @@
"type": "boolean",
"x-property-group-key": "locks"
},
"backup_access_code_pool_enabled": {
"description": "Indicates whether the [backup access code pool](/low-level-apis/smart-locks/access-codes/backup-access-codes) is currently enabled for the device. To disable it, set this to `false` using [/devices/update](/api/devices/update).",
"type": "boolean",
"x-property-group-key": "access_codes"
},
"code_constraints": {
"description": "Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific.",
"items": {
Expand Down Expand Up @@ -54016,6 +54021,10 @@
"application/json": {
"schema": {
"properties": {
"backup_access_code_pool_enabled": {
"description": "Indicates whether the device's [backup access code pool](/low-level-apis/smart-locks/access-codes/backup-access-codes) is enabled. Set to `false` to disable the pool: Seam stops refilling it and removes any backup codes that have not yet been pulled into active use.",
"type": "boolean"
},
"custom_metadata": {
"additionalProperties": {
"nullable": true,
Expand Down Expand Up @@ -54128,6 +54137,10 @@
"application/json": {
"schema": {
"properties": {
"backup_access_code_pool_enabled": {
"description": "Indicates whether the device's [backup access code pool](/low-level-apis/smart-locks/access-codes/backup-access-codes) is enabled. Set to `false` to disable the pool: Seam stops refilling it and removes any backup codes that have not yet been pulled into active use.",
"type": "boolean"
},
"custom_metadata": {
"additionalProperties": {
"nullable": true,
Expand Down
8 changes: 4 additions & 4 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
"@prettier/plugin-ruby": "^4.0.4",
"@seamapi/blueprint": "^0.56.0",
"@seamapi/smith": "^0.5.2",
"@seamapi/types": "1.938.0",
"@seamapi/types": "1.939.0",
"@types/command-exists": "^1.2.3",
"change-case": "^5.4.4",
"command-exists": "^1.2.9",
Expand Down
Loading