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
2,238 changes: 1,119 additions & 1,119 deletions docs/api-reference/_blueprint.json

Large diffs are not rendered by default.

122 changes: 61 additions & 61 deletions docs/api-reference/access_codes/README.md

Large diffs are not rendered by default.

18 changes: 9 additions & 9 deletions docs/api-reference/access_codes/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
- [Response](#response)
- [Examples](#examples)

Creates a new [access code](https://docs.seam.co/latest/low-level-apis/access-codes). For granting access, we recommend [Access Grants](https://docs.seam.co/latest/use-cases/granting-access) instead: they work across both standalone smart locks and access control systems and manage the underlying codes for you. Use this low-level endpoint only when you need direct control over a code on a single device, such as setting a custom PIN value.
Creates a new [access code](https://docs.seam.co/low-level-apis/access-codes). For granting access, we recommend [Access Grants](https://docs.seam.co/use-cases/granting-access) instead: they work across both standalone smart locks and access control systems and manage the underlying codes for you. Use this low-level endpoint only when you need direct control over a code on a single device, such as setting a custom PIN value.


{% tabs %}
Expand Down Expand Up @@ -287,7 +287,7 @@ ID of the device for which you want to create the new access code.

**`allow_external_modification`** *Boolean*

Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
Indicates whether [external modification](https://docs.seam.co/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.

---

Expand All @@ -303,7 +303,7 @@ Code to be used for access.

**`common_code_key`** *String*

Key to identify access codes that should have the same code. Any two access codes with the same `common_code_key` are guaranteed to have the same `code`. See also [Creating and Updating Multiple Linked Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes).
Key to identify access codes that should have the same code. Any two access codes with the same `common_code_key` are guaranteed to have the same `code`. See also [Creating and Updating Multiple Linked Access Codes](https://docs.seam.co/capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes).

---

Expand All @@ -315,25 +315,25 @@ Date and time at which the validity of the new access code ends, in [ISO 8601](h

**`is_external_modification_allowed`** *Boolean*

Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
Indicates whether [external modification](https://docs.seam.co/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.

---

**`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).
Indicates whether the access code is an [offline access code](https://docs.seam.co/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.
Indicates whether the [offline access code](https://docs.seam.co/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`.
Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.

---

Expand All @@ -351,7 +351,7 @@ To help your users identify codes set by Seam, Seam provides the name exactly as

**`prefer_native_scheduling`** *Boolean*

Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.
Indicates whether [native scheduling](https://docs.seam.co/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.

---

Expand All @@ -369,7 +369,7 @@ 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/capability-guides/smart-locks/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).
Indicates whether to use a [backup access code pool](https://docs.seam.co/capability-guides/smart-locks/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/api/access_codes/pull_backup_access_code).

---

Expand Down
12 changes: 6 additions & 6 deletions docs/api-reference/access_codes/create_multiple.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
- [Request Parameters](#request-parameters)
- [Response](#response)

Creates new [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that share a common code across multiple devices.
Creates new [access codes](https://docs.seam.co/capability-guides/smart-locks/access-codes) that share a common code across multiple devices.

Users with more than one door lock in a property may want to create groups of linked access codes, all of which have the same code (PIN). For example, a short-term rental host may want to provide guests the same PIN for both a front door lock and a back door lock.

If you specify a custom code, Seam assigns this custom code to each of the resulting access codes. However, in this case, Seam does not link these access codes together with a `common_code_key`. That is, `common_code_key` remains null for these access codes.

If you want to change these access codes that are not linked by a `common_code_key`, you cannot use `/access_codes/update_multiple`. However, you can update each of these access codes individually, using `/access_codes/update`.

See also [Creating and Updating Multiple Linked Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes).
See also [Creating and Updating Multiple Linked Access Codes](https://docs.seam.co/capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes).


{% tabs %}
Expand Down Expand Up @@ -346,7 +346,7 @@ IDs of the devices for which you want to create the new access codes.

**`allow_external_modification`** *Boolean*

Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
Indicates whether [external modification](https://docs.seam.co/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.

---

Expand Down Expand Up @@ -374,7 +374,7 @@ Date and time at which the validity of the new access code ends, in [ISO 8601](h

**`is_external_modification_allowed`** *Boolean*

Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
Indicates whether [external modification](https://docs.seam.co/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.

---

Expand All @@ -392,7 +392,7 @@ To help your users identify codes set by Seam, Seam provides the name exactly as

**`prefer_native_scheduling`** *Boolean*

Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.
Indicates whether [native scheduling](https://docs.seam.co/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.

---

Expand All @@ -410,7 +410,7 @@ 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/capability-guides/smart-locks/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).
Indicates whether to use a [backup access code pool](https://docs.seam.co/capability-guides/smart-locks/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/api/access_codes/pull_backup_access_code).

---

Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/access_codes/delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
- [Request Parameters](#request-parameters)
- [Response](#response)

Deletes an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
Deletes an [access code](https://docs.seam.co/capability-guides/smart-locks/access-codes).


{% tabs %}
Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/access_codes/generate_code.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
- [Request Parameters](#request-parameters)
- [Response](#response)

Generates a code for an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes), given a device ID.
Generates a code for an [access code](https://docs.seam.co/capability-guides/smart-locks/access-codes), given a device ID.


{% tabs %}
Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/access_codes/get.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
- [Request Parameters](#request-parameters)
- [Response](#response)

Returns a specified [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
Returns a specified [access code](https://docs.seam.co/capability-guides/smart-locks/access-codes).

You must specify either `access_code_id` or both `device_id` and `code`.

Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/access_codes/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
- [Request Parameters](#request-parameters)
- [Response](#response)

Returns a list of all [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
Returns a list of all [access codes](https://docs.seam.co/capability-guides/smart-locks/access-codes).

Specify `device_id`, `access_code_ids`, `access_method_id`, or `access_grant_id`.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
- [Request Parameters](#request-parameters)
- [Response](#response)

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).
Retrieves a backup access code for an [access code](https://docs.seam.co/capability-guides/smart-locks/access-codes). See also [Managing Backup Access Codes](https://docs.seam.co/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. 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.

Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/access_codes/simulate/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@

[**`/access_codes/simulate/create_unmanaged_access_code`**](./create_unmanaged_access_code.md)

Simulates the creation of an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) in a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).
Simulates the creation of an [unmanaged access code](https://docs.seam.co/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) in a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).


Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
- [Request Parameters](#request-parameters)
- [Response](#response)

Simulates the creation of an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) in a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).
Simulates the creation of an [unmanaged access code](https://docs.seam.co/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) in a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).


{% tabs %}
Expand Down
Loading
Loading