ci: Generate docs

Author: seambot

docs/api/_blueprint.json

@@ -13,7 +13,7 @@ Represents a smart lock [access code](https://docs.seam.co/latest/capability-gui
 
 An access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly. Using the Seam Access Code API, you can easily generate access codes on the hundreds of door lock models with which we integrate.
 
-Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`.
+Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`. An ongoing access code is active, until it has been removed from the device. To specify an ongoing access code, leave both `starts_at` and `ends_at` empty. A time-bound access code will be programmed at the `starts_at` time and removed at the `ends_at` time.
 
 In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code.
 
@@ -1771,6 +1771,12 @@ Indicates whether the access code is waiting for a code assignment.
 **`name`** *String*
 
 Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
+      
+      Note 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`.
+      
+      To 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.
+      
+      To 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).
 
 
 
@@ -3258,6 +3264,11 @@ Creates new [access codes](https://docs.seam.co/latest/capability-guides/smart-l
 Deletes an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
 
 
+[**`/access_codes/generate_code`**](./generate_code.md)
+
+Generates a code for an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes), given a device ID.
+
+
 [**`/access_codes/get`**](./get.md)
 
 Returns a specified [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).

docs/api/_report.md

@@ -30,7 +30,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati
 
 **`device_id`**  (Required)
 
-ID of the device for which to create the new access code.
+ID of the device for which you want to create the new access code.
 
 ---
 
@@ -88,7 +88,13 @@ Maximum rounding adjustment. To create a daily-bound [offline access code](https
 
 **`name`** 
 
-Name of the new access code.
+Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
+      
+      Note 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`.
+      
+      To 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.
+      
+      To 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).
 
 ---
 

docs/api/access_codes/README.md

@@ -38,7 +38,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati
 
 **`device_ids`**  *of UUIDs* (Required)
 
-IDs of the devices for which to create the new access codes.
+IDs of the devices for which you want to create the new access codes.
 
 ---
 
@@ -96,7 +96,13 @@ Maximum rounding adjustment. To create a daily-bound [offline access code](https
 
 **`name`** 
 
-Name of the new access code.
+Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
+      
+      Note 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`.
+      
+      To 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.
+      
+      To 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).
 
 ---
 

docs/api/access_codes/create.md

@@ -30,13 +30,13 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati
 
 **`access_code_id`**  (Required)
 
-ID of the access code to delete.
+ID of the access code that you want to delete.
 
 ---
 
 **`device_id`** 
 
-ID of the device for which to delete the access code.
+ID of the device for which you want to delete the access code.
 
 ---
 

docs/api/access_codes/create_multiple.md

@@ -0,0 +1,49 @@
+# Generate a Code
+
+- [Request Parameters](./#request-parameters)
+- [Response](./#response)
+- [Examples](./#examples)
+
+Generates a code for an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes), given a device ID.
+
+{% tabs %}
+{% tab title="Signature" %}
+```
+POST /access_codes/generate_code ⇒ { generated_code }
+```
+{% endtab %}
+{% endtabs %}
+
+<details>
+
+<summary>Authentication Methods</summary>
+
+- API key
+- Client session token
+- Personal access token
+  <br>Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+</details>
+
+## Request Parameters
+
+**`device_id`**  (Required)
+
+ID of the device for which you want to generate a code.
+
+---
+
+
+## Response
+
+[access\_code](./)
+{% tabs %}
+{% tab title="JSON" %}
+```json
+{
+  JSON representation of access_code
+}
+```
+{% endtab %}
+{% endtabs %}

docs/api/access_codes/delete.md

@@ -6,9 +6,9 @@
 
 Retrieves a backup access code for an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). See also [Managing Backup Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes).
 
-A backup access code pool is a collection of pre-programmed access codes stored on a device, ready for use. These codes are programmed in addition to the regular access codes on Seam, serving as a safety net for any issues with the primary codes.
+A backup access code pool is a collection of pre-programmed access codes stored on a device, ready for use. These codes are programmed in addition to the regular access codes on Seam, serving as a safety net for any issues with the primary codes. If there's ever a complication with a primary access code—be it due to intermittent connectivity, manual removal from a device, or provider outages—a backup code can be retrieved. Its end time can then be adjusted to align with the original code, facilitating seamless and uninterrupted access.
 
-If there's ever a complication with a primary access code—be it due to intermittent connectivity, manual removal from a device, or provider outages—a backup code can be retrieved. Its end time can then be adjusted to align with the original code, facilitating seamless and uninterrupted access.
+You can pull a backup access code from the pool at any time. These backup codes are guaranteed to work immediately and automatically programmed to be removed from the device after the access code ends.
 
 You can only pull backup access codes for time-bound access codes.
 

docs/api/access_codes/generate_code.md

@@ -6,6 +6,8 @@
 
 Enables you to report access code-related constraints for a device. Currently, supports reporting supported code length constraints for SmartThings devices.
 
+Specify either `supported_code_lengths` or `min_code_length`/`max_code_length`.
+
 {% tabs %}
 {% tab title="Signature" %}
 ```
@@ -30,7 +32,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati
 
 **`device_id`**  (Required)
 
-ID of the device for which to report constraints.
+ID of the device for which you want to report constraints.
 
 ---
 

docs/api/access_codes/pull_backup_access_code.md

@@ -17,6 +17,10 @@ When you create an access code on a device in Seam, it is created as a managed a
 
 Prior to using Seam to manage your devices, you may have used another lock management system to manage the access codes on your devices. Where possible, we help you keep any existing access codes on devices and transition those codes to ones managed by your Seam workspace.
 
+Not all providers support unmanaged access codes. The following providers do not support unmanaged access codes:
+
+- [Kwikset](https://docs.seam.co/latest/device-and-system-integration-guides/kwikset-locks)
+
 {% tabs %}
 {% tab title="JSON" %}
 ```json
@@ -1690,6 +1694,12 @@ Indicates that Seam does not manage the access code.
 **`name`** *String*
 
 Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
+      
+      Note 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`.
+      
+      To 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.
+      
+      To 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).