Skip to content

feat: Update to @seamapi/types@1.715.0 #1036

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
seambot merged 2 commits into from
Jan 16, 2026
Merged

feat: Update to @seamapi/types@1.715.0 #1036

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6beaac4
feat: Update to @seamapi/types@1.715.0
seambot Jan 16, 2026
5d4f67c
ci: Generate docs
seambot Jan 16, 2026
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
115 changes: 1 addition & 114 deletions docs/api/_blueprint.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1064,91 +1064,6 @@
"format": "boolean",
"jsonType": "boolean"
},
{
"name": "is_offline_access_code",
"description": "Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).",
"isRequired": false,
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"hasDefault": false,
"format": "boolean",
"jsonType": "boolean"
},
{
"name": "is_one_time_use",
"description": "Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code.",
"isRequired": false,
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"hasDefault": false,
"format": "boolean",
"jsonType": "boolean"
},
{
"name": "max_time_rounding",
"description": "Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.",
"isRequired": false,
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"hasDefault": true,
"default": "1hour",
"format": "enum",
"jsonType": "string",
"values": [
{
"name": "1hour",
"description": "",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": ""
},
{
"name": "1day",
"description": "",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": ""
},
{
"name": "1h",
"description": "",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": ""
},
{
"name": "1d",
"description": "",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": ""
}
]
},
{
"name": "name",
"description": "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\nNote that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\nTo provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\nTo help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
Expand Down Expand Up @@ -1179,7 +1094,7 @@
},
{
"name": "preferred_code_length",
"description": "Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length.",
"description": "Preferred code length. If the affected devices do not support the preferred code length, Seam reverts to using the shortest supported code length.",
"isRequired": false,
"isDeprecated": false,
"deprecationMessage": "",
Expand All @@ -1204,34 +1119,6 @@
"hasDefault": false,
"format": "string",
"jsonType": "string"
},
{
"name": "use_backup_access_code_pool",
"description": "Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).",
"isRequired": false,
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"hasDefault": false,
"format": "boolean",
"jsonType": "boolean"
},
{
"name": "use_offline_access_code",
"description": "",
"isRequired": false,
"isDeprecated": true,
"deprecationMessage": "Use `is_offline_access_code` instead.",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"hasDefault": false,
"format": "boolean",
"jsonType": "boolean"
}
]
},
Expand Down
3 changes: 0 additions & 3 deletions docs/api/_report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -352,7 +352,6 @@ Items that are intentionally undocumented are not included in this section.
- `use_offline_access_code`
- `/access_codes/create_multiple`
- `attempt_for_offline_device`
- `use_offline_access_code`
- `/access_codes/delete`
- `sync`
- `/access_codes/update`
Expand Down Expand Up @@ -578,8 +577,6 @@ These items are deprecated.

- `/access_codes/create`
- `use_offline_access_code`: Use `is_offline_access_code` instead.
- `/access_codes/create_multiple`
- `use_offline_access_code`: Use `is_offline_access_code` instead.
- `/access_codes/update`
- `use_offline_access_code`: Use `is_offline_access_code` instead.
- `/access_grants/create`
Expand Down
34 changes: 1 addition & 33 deletions docs/api/access_codes/create_multiple.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -378,24 +378,6 @@ Indicates whether [external modification](https://docs.seam.co/latest/capability

---

**`is_offline_access_code`** *Boolean*

Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).

---

**`is_one_time_use`** *Boolean*

Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code.

---

**`max_time_rounding`** *String*

Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.

---

**`name`** *String*

Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
Expand All @@ -416,7 +398,7 @@ Indicates whether [native scheduling](https://docs.seam.co/latest/capability-gui

**`preferred_code_length`** *Number*

Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length.
Preferred code length. If the affected devices do not support the preferred code length, Seam reverts to using the shortest supported code length.

---

Expand All @@ -426,20 +408,6 @@ Date and time at which the validity of the new access code starts, in [ISO 8601]

---

**`use_backup_access_code_pool`** *Boolean*

Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).

---

**`use_offline_access_code`** *Boolean*

{% hint style="warning" %}
**Deprecated**. Use `is_offline_access_code` instead.
{% endhint %}

---


## Response

Expand Down
8 changes: 4 additions & 4 deletions package-lock.json
View file
Open in desktop

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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
"@prettier/plugin-ruby": "^4.0.4",
"@seamapi/blueprint": "^0.53.0",
"@seamapi/smith": "^0.5.2",
"@seamapi/types": "1.714.0",
"@seamapi/types": "1.715.0",
"@types/command-exists": "^1.2.3",
"change-case": "^5.4.4",
"command-exists": "^1.2.9",
Expand Down
Loading