diff --git a/docs/api/_blueprint.json b/docs/api/_blueprint.json index fcb25c5f5..7c2563d14 100644 --- a/docs/api/_blueprint.json +++ b/docs/api/_blueprint.json @@ -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).", @@ -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": "", @@ -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" } ] }, diff --git a/docs/api/_report.md b/docs/api/_report.md index ef3731e82..4cbe37d88 100644 --- a/docs/api/_report.md +++ b/docs/api/_report.md @@ -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` @@ -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` diff --git a/docs/api/access_codes/create_multiple.md b/docs/api/access_codes/create_multiple.md index 198418705..b1ceade3d 100644 --- a/docs/api/access_codes/create_multiple.md +++ b/docs/api/access_codes/create_multiple.md @@ -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. @@ -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. --- @@ -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 diff --git a/package-lock.json b/package-lock.json index fcff41cc8..794c89e29 100644 --- a/package-lock.json +++ b/package-lock.json @@ -14,7 +14,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", @@ -983,9 +983,9 @@ } }, "node_modules/@seamapi/types": { - "version": "1.714.0", - "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.714.0.tgz", - "integrity": "sha512-1qXAySW4bToON/VJortPk7/Q+WbyQO/VWgcjvNnOuixNISrBYQtATx3OkzZ0qYNfsNWyIWMapwMFOdlWMr8aHQ==", + "version": "1.715.0", + "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.715.0.tgz", + "integrity": "sha512-Xrditcy49q44ElhyoFnso8Aadi39cDrb4/ZOasUYdU5aOQxzvMg/ksUB+VtDwzsPi1At6tpb9WirvqDaKlHIUA==", "dev": true, "license": "MIT", "engines": { diff --git a/package.json b/package.json index dd9f9d84f..2d86238d3 100644 --- a/package.json +++ b/package.json @@ -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",