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
32 changes: 16 additions & 16 deletions docs/api/access_codes/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,65 +28,65 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati

## Request Parameters

**`device_id`** (Required)
**`device_id`** *String* (Required)

ID of the device for which you want to create the new access code.

---

**`allow_external_modification`**
**`allow_external_modification`** *Boolean*

Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.

---

**`attempt_for_offline_device`**
**`attempt_for_offline_device`** *Boolean*

---

**`code`**
**`code`** *String*

Code to be used for access.

---

**`common_code_key`**
**`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](../../capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes.md).

---

**`ends_at`**
**`ends_at`** *String*

Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.

---

**`is_external_modification_allowed`**
**`is_external_modification_allowed`** *Boolean*

Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.

---

**`is_offline_access_code`**
**`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`**
**`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`**
**`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`**
**`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 @@ -98,31 +98,31 @@ Name of the new access code. Enables administrators and users to identify the ac

---

**`prefer_native_scheduling`**
**`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`.

---

**`preferred_code_length`**
**`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.

---

**`starts_at`**
**`starts_at`** *String*

Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.

---

**`use_backup_access_code_pool`**
**`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`](../../api-clients/access_codes/pull_backup_access_code.md).

---

**`use_offline_access_code`**
**`use_offline_access_code`** *Boolean*

---

Expand Down
32 changes: 16 additions & 16 deletions docs/api/access_codes/create_multiple.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,65 +36,65 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati

## Request Parameters

**`device_ids`** *of UUIDs* (Required)
**`device_ids`** *Array* *of UUIDs* (Required)

IDs of the devices for which you want to create the new access codes.

---

**`allow_external_modification`**
**`allow_external_modification`** *Boolean*

Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.

---

**`attempt_for_offline_device`**
**`attempt_for_offline_device`** *Boolean*

---

**`behavior_when_code_cannot_be_shared`**
**`behavior_when_code_cannot_be_shared`** *String*

Desired behavior if any device cannot share a code. If `throw` (default), no access codes will be created if any device cannot share a code. If `create_random_code`, a random code will be created on devices that cannot share a code.

---

**`code`**
**`code`** *String*

Code to be used for access.

---

**`ends_at`**
**`ends_at`** *String*

Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.

---

**`is_external_modification_allowed`**
**`is_external_modification_allowed`** *Boolean*

Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.

---

**`is_offline_access_code`**
**`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`**
**`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`**
**`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`**
**`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 @@ -106,31 +106,31 @@ Name of the new access code. Enables administrators and users to identify the ac

---

**`prefer_native_scheduling`**
**`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`.

---

**`preferred_code_length`**
**`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.

---

**`starts_at`**
**`starts_at`** *String*

Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.

---

**`use_backup_access_code_pool`**
**`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`](../../api-clients/access_codes/pull_backup_access_code.md).

---

**`use_offline_access_code`**
**`use_offline_access_code`** *Boolean*

---

Expand Down
4 changes: 2 additions & 2 deletions docs/api/access_codes/delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,13 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati

## Request Parameters

**`access_code_id`** (Required)
**`access_code_id`** *String* (Required)

ID of the access code that you want to delete.

---

**`device_id`**
**`device_id`** *String*

ID of the device for which you want to delete the access code.

Expand Down
2 changes: 1 addition & 1 deletion docs/api/access_codes/generate_code.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati

## Request Parameters

**`device_id`** (Required)
**`device_id`** *String* (Required)

ID of the device for which you want to generate a code.

Expand Down
6 changes: 3 additions & 3 deletions docs/api/access_codes/get.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,19 +28,19 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati

## Request Parameters

**`access_code_id`**
**`access_code_id`** *String*

ID of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.

---

**`code`**
**`code`** *String*

Code of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.

---

**`device_id`**
**`device_id`** *String*

ID of the device containing the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.

Expand Down
10 changes: 5 additions & 5 deletions docs/api/access_codes/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,31 +30,31 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati

## Request Parameters

**`access_code_ids`** *of UUIDs*
**`access_code_ids`** *Array* *of UUIDs*

IDs of the access codes that you want to retrieve. Specify either `device_id` or `access_code_ids`.

---

**`device_id`**
**`device_id`** *String*

ID of the device for which you want to list access codes. Specify either `device_id` or `access_code_ids`.

---

**`limit`**
**`limit`** *Number*

Numerical limit on the number of access codes to return.

---

**`page_cursor`**
**`page_cursor`** *String*

Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.

---

**`user_identifier_key`**
**`user_identifier_key`** *String*

Your user ID for the user by which to filter access codes.

Expand Down
2 changes: 1 addition & 1 deletion docs/api/access_codes/pull_backup_access_code.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati

## Request Parameters

**`access_code_id`** (Required)
**`access_code_id`** *String* (Required)

ID of the access code for which you want to pull a backup access code.

Expand Down
8 changes: 4 additions & 4 deletions docs/api/access_codes/report_device_constraints.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,25 +30,25 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati

## Request Parameters

**`device_id`** (Required)
**`device_id`** *String* (Required)

ID of the device for which you want to report constraints.

---

**`max_code_length`**
**`max_code_length`** *Number*

Maximum supported code length as an integer between 4 and 20, inclusive. You can specify either `min_code_length`/`max_code_length` or `supported_code_lengths`.

---

**`min_code_length`**
**`min_code_length`** *Number*

Minimum supported code length as an integer between 4 and 20, inclusive. You can specify either `min_code_length`/`max_code_length` or `supported_code_lengths`.

---

**`supported_code_lengths`** *of Numbers*
**`supported_code_lengths`** *Array* *of Numbers*

Array of supported code lengths as integers between 4 and 20, inclusive. You can specify either `supported_code_lengths` or `min_code_length`/`max_code_length`.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,19 +28,19 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati

## Request Parameters

**`code`** (Required)
**`code`** *String* (Required)

Code of the simulated unmanaged access code.

---

**`device_id`** (Required)
**`device_id`** *String* (Required)

ID of the device for which you want to simulate the creation of an unmanaged access code.

---

**`name`** (Required)
**`name`** *String* (Required)

Name of the simulated unmanaged access code.

Expand Down
Loading
Loading