You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/api/access_codes/README.md
+12-1Lines changed: 12 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ Represents a smart lock [access code](https://docs.seam.co/latest/capability-gui
13
13
14
14
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.
15
15
16
-
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`.
16
+
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.
17
17
18
18
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.
19
19
@@ -1771,6 +1771,12 @@ Indicates whether the access code is waiting for a code assignment.
1771
1771
**`name`***String*
1772
1772
1773
1773
Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
1774
+
1775
+
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`.
1776
+
1777
+
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.
1778
+
1779
+
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).
1774
1780
1775
1781
1776
1782
@@ -3258,6 +3264,11 @@ Creates new [access codes](https://docs.seam.co/latest/capability-guides/smart-l
3258
3264
Deletes an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
Copy file name to clipboardExpand all lines: docs/api/access_codes/create.md
+8-2Lines changed: 8 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati
30
30
31
31
**`device_id`** (Required)
32
32
33
-
ID of the device for which to create the new access code.
33
+
ID of the device for which you want to create the new access code.
34
34
35
35
---
36
36
@@ -88,7 +88,13 @@ Maximum rounding adjustment. To create a daily-bound [offline access code](https
88
88
89
89
**`name`**
90
90
91
-
Name of the new access code.
91
+
Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
92
+
93
+
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`.
94
+
95
+
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.
96
+
97
+
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).
Copy file name to clipboardExpand all lines: docs/api/access_codes/create_multiple.md
+8-2Lines changed: 8 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,7 +38,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati
38
38
39
39
**`device_ids`***of UUIDs* (Required)
40
40
41
-
IDs of the devices for which to create the new access codes.
41
+
IDs of the devices for which you want to create the new access codes.
42
42
43
43
---
44
44
@@ -96,7 +96,13 @@ Maximum rounding adjustment. To create a daily-bound [offline access code](https
96
96
97
97
**`name`**
98
98
99
-
Name of the new access code.
99
+
Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
100
+
101
+
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`.
102
+
103
+
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.
104
+
105
+
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).
Copy file name to clipboardExpand all lines: docs/api/access_codes/pull_backup_access_code.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,9 +6,9 @@
6
6
7
7
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).
8
8
9
-
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.
9
+
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.
10
10
11
-
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.
11
+
You can pull a backup access codefrom 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.
12
12
13
13
You can only pull backup access codes for time-bound access codes.
Copy file name to clipboardExpand all lines: docs/api/access_codes/report_device_constraints.md
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,6 +6,8 @@
6
6
7
7
Enables you to report access code-related constraints for a device. Currently, supports reporting supported code length constraints for SmartThings devices.
8
8
9
+
Specify either `supported_code_lengths` or `min_code_length`/`max_code_length`.
10
+
9
11
{% tabs %}
10
12
{% tab title="Signature" %}
11
13
```
@@ -30,7 +32,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati
30
32
31
33
**`device_id`** (Required)
32
34
33
-
ID of the device for which to report constraints.
35
+
ID of the device for which you want to report constraints.
Copy file name to clipboardExpand all lines: docs/api/access_codes/unmanaged/README.md
+10Lines changed: 10 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,6 +17,10 @@ When you create an access code on a device in Seam, it is created as a managed a
17
17
18
18
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.
19
19
20
+
Not all providers support unmanaged access codes. The following providers do not support unmanaged access codes:
@@ -1690,6 +1694,12 @@ Indicates that Seam does not manage the access code.
1690
1694
**`name`***String*
1691
1695
1692
1696
Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
1697
+
1698
+
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`.
1699
+
1700
+
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.
1701
+
1702
+
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).
0 commit comments