@seamapi/types 1.404.2 → 1.404.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/connect.cjs +21 -27
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +23 -101
- package/lib/seam/connect/models/access-codes/managed-access-code.js +2 -8
- package/lib/seam/connect/models/access-codes/managed-access-code.js.map +1 -1
- package/lib/seam/connect/models/devices/device-provider.d.ts +1 -1
- package/lib/seam/connect/models/devices/device-provider.js +0 -1
- package/lib/seam/connect/models/devices/device-provider.js.map +1 -1
- package/lib/seam/connect/openapi.js +15 -14
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +23 -101
- package/package.json +1 -1
- package/src/lib/seam/connect/models/access-codes/managed-access-code.ts +2 -8
- package/src/lib/seam/connect/models/devices/device-provider.ts +0 -1
- package/src/lib/seam/connect/openapi.ts +15 -14
- package/src/lib/seam/connect/route-types.ts +30 -101
|
@@ -6,13 +6,7 @@ export interface Routes {
|
|
|
6
6
|
jsonBody: {
|
|
7
7
|
/** ID of the device for which you want to create the new access code. */
|
|
8
8
|
device_id: string;
|
|
9
|
-
/** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
10
|
-
|
|
11
|
-
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`.
|
|
12
|
-
|
|
13
|
-
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.
|
|
14
|
-
|
|
15
|
-
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). */
|
|
9
|
+
/** 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). */
|
|
16
10
|
name?: string | undefined;
|
|
17
11
|
/** 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. */
|
|
18
12
|
starts_at?: string | undefined;
|
|
@@ -1169,13 +1163,7 @@ export interface Routes {
|
|
|
1169
1163
|
access_code_id: string;
|
|
1170
1164
|
/** Unique identifier for the device associated with the access code. */
|
|
1171
1165
|
device_id: string;
|
|
1172
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
1173
|
-
|
|
1174
|
-
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`.
|
|
1175
|
-
|
|
1176
|
-
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.
|
|
1177
|
-
|
|
1178
|
-
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). */
|
|
1166
|
+
/** 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). */
|
|
1179
1167
|
name: string | null;
|
|
1180
1168
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
1181
1169
|
code: string | null;
|
|
@@ -1602,7 +1590,7 @@ export interface Routes {
|
|
|
1602
1590
|
starts_at?: (string | null) | undefined;
|
|
1603
1591
|
/** Date and time after which the time-bound access code becomes inactive. */
|
|
1604
1592
|
ends_at?: (string | null) | undefined;
|
|
1605
|
-
/** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. */
|
|
1593
|
+
/** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/lifecycle-of-access-codes). */
|
|
1606
1594
|
status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
|
|
1607
1595
|
/** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
|
|
1608
1596
|
is_backup_access_code_available: boolean;
|
|
@@ -1630,13 +1618,7 @@ export interface Routes {
|
|
|
1630
1618
|
behavior_when_code_cannot_be_shared?: 'throw' | 'create_random_code';
|
|
1631
1619
|
/** 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. */
|
|
1632
1620
|
preferred_code_length?: number | undefined;
|
|
1633
|
-
/** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
1634
|
-
|
|
1635
|
-
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`.
|
|
1636
|
-
|
|
1637
|
-
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.
|
|
1638
|
-
|
|
1639
|
-
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). */
|
|
1621
|
+
/** 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). */
|
|
1640
1622
|
name?: string | undefined;
|
|
1641
1623
|
/** 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. */
|
|
1642
1624
|
starts_at?: string | undefined;
|
|
@@ -1677,13 +1659,7 @@ export interface Routes {
|
|
|
1677
1659
|
access_code_id: string;
|
|
1678
1660
|
/** Unique identifier for the device associated with the access code. */
|
|
1679
1661
|
device_id: string;
|
|
1680
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
1681
|
-
|
|
1682
|
-
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`.
|
|
1683
|
-
|
|
1684
|
-
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.
|
|
1685
|
-
|
|
1686
|
-
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). */
|
|
1662
|
+
/** 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). */
|
|
1687
1663
|
name: string | null;
|
|
1688
1664
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
1689
1665
|
code: string | null;
|
|
@@ -2110,7 +2086,7 @@ export interface Routes {
|
|
|
2110
2086
|
starts_at?: (string | null) | undefined;
|
|
2111
2087
|
/** Date and time after which the time-bound access code becomes inactive. */
|
|
2112
2088
|
ends_at?: (string | null) | undefined;
|
|
2113
|
-
/** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. */
|
|
2089
|
+
/** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/lifecycle-of-access-codes). */
|
|
2114
2090
|
status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
|
|
2115
2091
|
/** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
|
|
2116
2092
|
is_backup_access_code_available: boolean;
|
|
@@ -3299,13 +3275,7 @@ export interface Routes {
|
|
|
3299
3275
|
access_code_id: string;
|
|
3300
3276
|
/** Unique identifier for the device associated with the access code. */
|
|
3301
3277
|
device_id: string;
|
|
3302
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
3303
|
-
|
|
3304
|
-
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`.
|
|
3305
|
-
|
|
3306
|
-
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.
|
|
3307
|
-
|
|
3308
|
-
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). */
|
|
3278
|
+
/** 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). */
|
|
3309
3279
|
name: string | null;
|
|
3310
3280
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
3311
3281
|
code: string | null;
|
|
@@ -3732,7 +3702,7 @@ export interface Routes {
|
|
|
3732
3702
|
starts_at?: (string | null) | undefined;
|
|
3733
3703
|
/** Date and time after which the time-bound access code becomes inactive. */
|
|
3734
3704
|
ends_at?: (string | null) | undefined;
|
|
3735
|
-
/** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. */
|
|
3705
|
+
/** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/lifecycle-of-access-codes). */
|
|
3736
3706
|
status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
|
|
3737
3707
|
/** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
|
|
3738
3708
|
is_backup_access_code_available: boolean;
|
|
@@ -3781,13 +3751,7 @@ export interface Routes {
|
|
|
3781
3751
|
access_code_id: string;
|
|
3782
3752
|
/** Unique identifier for the device associated with the access code. */
|
|
3783
3753
|
device_id: string;
|
|
3784
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
3785
|
-
|
|
3786
|
-
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`.
|
|
3787
|
-
|
|
3788
|
-
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.
|
|
3789
|
-
|
|
3790
|
-
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). */
|
|
3754
|
+
/** 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). */
|
|
3791
3755
|
name: string | null;
|
|
3792
3756
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
3793
3757
|
code: string | null;
|
|
@@ -4214,7 +4178,7 @@ export interface Routes {
|
|
|
4214
4178
|
starts_at?: (string | null) | undefined;
|
|
4215
4179
|
/** Date and time after which the time-bound access code becomes inactive. */
|
|
4216
4180
|
ends_at?: (string | null) | undefined;
|
|
4217
|
-
/** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. */
|
|
4181
|
+
/** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/lifecycle-of-access-codes). */
|
|
4218
4182
|
status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
|
|
4219
4183
|
/** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
|
|
4220
4184
|
is_backup_access_code_available: boolean;
|
|
@@ -4271,13 +4235,7 @@ export interface Routes {
|
|
|
4271
4235
|
access_code_id: string;
|
|
4272
4236
|
/** Unique identifier for the device associated with the access code. */
|
|
4273
4237
|
device_id: string;
|
|
4274
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
4275
|
-
|
|
4276
|
-
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`.
|
|
4277
|
-
|
|
4278
|
-
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.
|
|
4279
|
-
|
|
4280
|
-
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). */
|
|
4238
|
+
/** 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). */
|
|
4281
4239
|
name: string | null;
|
|
4282
4240
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
4283
4241
|
code: string | null;
|
|
@@ -4704,7 +4662,7 @@ export interface Routes {
|
|
|
4704
4662
|
starts_at?: (string | null) | undefined;
|
|
4705
4663
|
/** Date and time after which the time-bound access code becomes inactive. */
|
|
4706
4664
|
ends_at?: (string | null) | undefined;
|
|
4707
|
-
/** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. */
|
|
4665
|
+
/** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/lifecycle-of-access-codes). */
|
|
4708
4666
|
status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
|
|
4709
4667
|
/** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
|
|
4710
4668
|
is_backup_access_code_available: boolean;
|
|
@@ -4739,13 +4697,7 @@ export interface Routes {
|
|
|
4739
4697
|
access_code_id: string;
|
|
4740
4698
|
/** Unique identifier for the device associated with the access code. */
|
|
4741
4699
|
device_id: string;
|
|
4742
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
4743
|
-
|
|
4744
|
-
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`.
|
|
4745
|
-
|
|
4746
|
-
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.
|
|
4747
|
-
|
|
4748
|
-
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). */
|
|
4700
|
+
/** 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). */
|
|
4749
4701
|
name: string | null;
|
|
4750
4702
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
4751
4703
|
code: string | null;
|
|
@@ -5172,7 +5124,7 @@ export interface Routes {
|
|
|
5172
5124
|
starts_at?: (string | null) | undefined;
|
|
5173
5125
|
/** Date and time after which the time-bound access code becomes inactive. */
|
|
5174
5126
|
ends_at?: (string | null) | undefined;
|
|
5175
|
-
/** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. */
|
|
5127
|
+
/** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/lifecycle-of-access-codes). */
|
|
5176
5128
|
status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
|
|
5177
5129
|
/** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
|
|
5178
5130
|
is_backup_access_code_available: boolean;
|
|
@@ -5240,13 +5192,7 @@ export interface Routes {
|
|
|
5240
5192
|
access_code_id: string;
|
|
5241
5193
|
/** Unique identifier for the device associated with the access code. */
|
|
5242
5194
|
device_id: string;
|
|
5243
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
5244
|
-
|
|
5245
|
-
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`.
|
|
5246
|
-
|
|
5247
|
-
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.
|
|
5248
|
-
|
|
5249
|
-
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). */
|
|
5195
|
+
/** 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). */
|
|
5250
5196
|
name: string | null;
|
|
5251
5197
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
5252
5198
|
code: string | null;
|
|
@@ -6849,13 +6795,7 @@ export interface Routes {
|
|
|
6849
6795
|
access_code_id: string;
|
|
6850
6796
|
/** Unique identifier for the device associated with the access code. */
|
|
6851
6797
|
device_id: string;
|
|
6852
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
6853
|
-
|
|
6854
|
-
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`.
|
|
6855
|
-
|
|
6856
|
-
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.
|
|
6857
|
-
|
|
6858
|
-
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). */
|
|
6798
|
+
/** 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). */
|
|
6859
6799
|
name: string | null;
|
|
6860
6800
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
6861
6801
|
code: string | null;
|
|
@@ -7307,13 +7247,7 @@ export interface Routes {
|
|
|
7307
7247
|
access_code_id: string;
|
|
7308
7248
|
/** Unique identifier for the device associated with the access code. */
|
|
7309
7249
|
device_id: string;
|
|
7310
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
7311
|
-
|
|
7312
|
-
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`.
|
|
7313
|
-
|
|
7314
|
-
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.
|
|
7315
|
-
|
|
7316
|
-
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). */
|
|
7250
|
+
/** 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). */
|
|
7317
7251
|
name: string | null;
|
|
7318
7252
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
7319
7253
|
code: string | null;
|
|
@@ -7769,13 +7703,7 @@ export interface Routes {
|
|
|
7769
7703
|
method: 'POST' | 'PATCH' | 'PUT';
|
|
7770
7704
|
queryParams: {};
|
|
7771
7705
|
jsonBody: {
|
|
7772
|
-
/** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
7773
|
-
|
|
7774
|
-
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`.
|
|
7775
|
-
|
|
7776
|
-
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.
|
|
7777
|
-
|
|
7778
|
-
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). */
|
|
7706
|
+
/** 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). */
|
|
7779
7707
|
name?: string | undefined;
|
|
7780
7708
|
/** 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. */
|
|
7781
7709
|
starts_at?: string | undefined;
|
|
@@ -8929,13 +8857,7 @@ export interface Routes {
|
|
|
8929
8857
|
ends_at?: string | undefined;
|
|
8930
8858
|
/** 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. */
|
|
8931
8859
|
starts_at?: string | undefined;
|
|
8932
|
-
/** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
8933
|
-
|
|
8934
|
-
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`.
|
|
8935
|
-
|
|
8936
|
-
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.
|
|
8937
|
-
|
|
8938
|
-
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). */
|
|
8860
|
+
/** 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). */
|
|
8939
8861
|
name?: string | undefined;
|
|
8940
8862
|
/** Key that links the group of access codes, assigned on creation by `/access_codes/create_multiple`. */
|
|
8941
8863
|
common_code_key: string;
|
|
@@ -20307,7 +20229,7 @@ export interface Routes {
|
|
|
20307
20229
|
/** Array of device types for which you want to list devices. */
|
|
20308
20230
|
device_types?: Array<('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone')> | undefined;
|
|
20309
20231
|
/** Manufacturer for which you want to list devices. */
|
|
20310
|
-
manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'hubitat' | 'controlbyweb' | '
|
|
20232
|
+
manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'hubitat' | 'controlbyweb' | 'dormakaba_oracode' | 'tedee' | 'akiles' | 'ecobee' | 'honeywell_resideo' | 'minut' | 'nest' | 'noiseaware' | 'tado' | 'sensi' | 'smartthings') | undefined;
|
|
20311
20233
|
/** Array of device IDs for which you want to list devices. */
|
|
20312
20234
|
device_ids?: string[] | undefined;
|
|
20313
20235
|
/** Numerical limit on the number of devices to return. */
|
|
@@ -21474,7 +21396,7 @@ export interface Routes {
|
|
|
21474
21396
|
/** Array of device types for which you want to list devices. */
|
|
21475
21397
|
device_types?: Array<('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone')> | undefined;
|
|
21476
21398
|
/** Manufacturer for which you want to list devices. */
|
|
21477
|
-
manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'hubitat' | 'controlbyweb' | '
|
|
21399
|
+
manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'hubitat' | 'controlbyweb' | 'dormakaba_oracode' | 'tedee' | 'akiles' | 'ecobee' | 'honeywell_resideo' | 'minut' | 'nest' | 'noiseaware' | 'tado' | 'sensi' | 'smartthings') | undefined;
|
|
21478
21400
|
/** Array of device IDs for which you want to list devices. */
|
|
21479
21401
|
device_ids?: string[] | undefined;
|
|
21480
21402
|
/** Numerical limit on the number of devices to return. */
|
|
@@ -26128,7 +26050,7 @@ export interface Routes {
|
|
|
26128
26050
|
/** Array of device types by which to filter devices. */
|
|
26129
26051
|
device_types?: Array<'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock'> | undefined;
|
|
26130
26052
|
/** Manufacturer by which to filter devices. */
|
|
26131
|
-
manufacturer?: ('akuvox' | 'august' | 'brivo' | 'butterflymx' | 'avigilon_alta' | 'doorking' | 'genie' | 'igloo' | 'linear' | 'lockly' | 'kwikset' | 'nuki' | 'salto' | 'schlage' | 'seam' | '
|
|
26053
|
+
manufacturer?: ('akuvox' | 'august' | 'brivo' | 'butterflymx' | 'avigilon_alta' | 'doorking' | 'genie' | 'igloo' | 'linear' | 'lockly' | 'kwikset' | 'nuki' | 'salto' | 'schlage' | 'seam' | 'wyze' | 'yale' | 'two_n' | 'controlbyweb' | 'ttlock' | 'igloohome' | 'hubitat' | 'four_suites' | 'dormakaba_oracode' | 'tedee' | 'akiles' | 'smartthings') | undefined;
|
|
26132
26054
|
/** Array of device IDs for which you want to list devices. */
|
|
26133
26055
|
device_ids?: string[] | undefined;
|
|
26134
26056
|
/** Numerical limit on the number of devices to return. */
|
|
@@ -44470,7 +44392,7 @@ export interface Routes {
|
|
|
44470
44392
|
/** Array of device types by which to filter thermostat devices. */
|
|
44471
44393
|
device_types?: Array<'ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat'> | undefined;
|
|
44472
44394
|
/** Manufacturer by which to filter thermostat devices. */
|
|
44473
|
-
manufacturer?: ('ecobee' | 'honeywell_resideo' | 'nest' | 'tado' | 'sensi') | undefined;
|
|
44395
|
+
manufacturer?: ('ecobee' | 'honeywell_resideo' | 'nest' | 'tado' | 'sensi' | 'smartthings') | undefined;
|
|
44474
44396
|
/** Array of device IDs for which you want to list devices. */
|
|
44475
44397
|
device_ids?: string[] | undefined;
|
|
44476
44398
|
/** Numerical limit on the number of devices to return. */
|
package/package.json
CHANGED
|
@@ -532,13 +532,7 @@ export const access_code = z.object({
|
|
|
532
532
|
.string()
|
|
533
533
|
.nullable()
|
|
534
534
|
.describe(
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
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\`.
|
|
538
|
-
|
|
539
|
-
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.
|
|
540
|
-
|
|
541
|
-
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).`,
|
|
535
|
+
"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).",
|
|
542
536
|
),
|
|
543
537
|
code: z
|
|
544
538
|
.string()
|
|
@@ -587,7 +581,7 @@ export const access_code = z.object({
|
|
|
587
581
|
status: z
|
|
588
582
|
.enum(['setting', 'set', 'unset', 'removing', 'unknown'])
|
|
589
583
|
.describe(
|
|
590
|
-
'Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting.',
|
|
584
|
+
'Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/lifecycle-of-access-codes).',
|
|
591
585
|
),
|
|
592
586
|
is_backup_access_code_available: z
|
|
593
587
|
.boolean()
|
|
@@ -114,7 +114,6 @@ export const PROVIDER_CATEGORY_MAP = {
|
|
|
114
114
|
thermostats: ['ecobee', 'nest', 'sensi', 'honeywell_resideo'],
|
|
115
115
|
noise_sensors: ['minut', 'noiseaware'],
|
|
116
116
|
access_control_systems: [
|
|
117
|
-
'pti',
|
|
118
117
|
'visionline',
|
|
119
118
|
'assa_abloy_credential_service',
|
|
120
119
|
'latch',
|
|
@@ -1204,7 +1204,7 @@ export default {
|
|
|
1204
1204
|
},
|
|
1205
1205
|
name: {
|
|
1206
1206
|
description:
|
|
1207
|
-
"Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes
|
|
1207
|
+
"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).",
|
|
1208
1208
|
nullable: true,
|
|
1209
1209
|
type: 'string',
|
|
1210
1210
|
},
|
|
@@ -1224,7 +1224,7 @@ export default {
|
|
|
1224
1224
|
},
|
|
1225
1225
|
status: {
|
|
1226
1226
|
description:
|
|
1227
|
-
'Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting.',
|
|
1227
|
+
'Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/lifecycle-of-access-codes).',
|
|
1228
1228
|
enum: ['setting', 'set', 'unset', 'removing', 'unknown'],
|
|
1229
1229
|
type: 'string',
|
|
1230
1230
|
},
|
|
@@ -17260,7 +17260,7 @@ export default {
|
|
|
17260
17260
|
},
|
|
17261
17261
|
name: {
|
|
17262
17262
|
description:
|
|
17263
|
-
"Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes
|
|
17263
|
+
"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).",
|
|
17264
17264
|
nullable: true,
|
|
17265
17265
|
type: 'string',
|
|
17266
17266
|
},
|
|
@@ -19873,7 +19873,7 @@ export default {
|
|
|
19873
19873
|
},
|
|
19874
19874
|
name: {
|
|
19875
19875
|
description:
|
|
19876
|
-
"Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes
|
|
19876
|
+
"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).",
|
|
19877
19877
|
type: 'string',
|
|
19878
19878
|
},
|
|
19879
19879
|
prefer_native_scheduling: {
|
|
@@ -20016,7 +20016,7 @@ export default {
|
|
|
20016
20016
|
},
|
|
20017
20017
|
name: {
|
|
20018
20018
|
description:
|
|
20019
|
-
"Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes
|
|
20019
|
+
"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).",
|
|
20020
20020
|
type: 'string',
|
|
20021
20021
|
},
|
|
20022
20022
|
prefer_native_scheduling: {
|
|
@@ -20151,7 +20151,7 @@ export default {
|
|
|
20151
20151
|
},
|
|
20152
20152
|
name: {
|
|
20153
20153
|
description:
|
|
20154
|
-
"Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes
|
|
20154
|
+
"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).",
|
|
20155
20155
|
type: 'string',
|
|
20156
20156
|
},
|
|
20157
20157
|
prefer_native_scheduling: {
|
|
@@ -21254,7 +21254,7 @@ export default {
|
|
|
21254
21254
|
},
|
|
21255
21255
|
name: {
|
|
21256
21256
|
description:
|
|
21257
|
-
"Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes
|
|
21257
|
+
"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).",
|
|
21258
21258
|
type: 'string',
|
|
21259
21259
|
},
|
|
21260
21260
|
prefer_native_scheduling: {
|
|
@@ -21402,7 +21402,7 @@ export default {
|
|
|
21402
21402
|
},
|
|
21403
21403
|
name: {
|
|
21404
21404
|
description:
|
|
21405
|
-
"Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes
|
|
21405
|
+
"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).",
|
|
21406
21406
|
type: 'string',
|
|
21407
21407
|
},
|
|
21408
21408
|
prefer_native_scheduling: {
|
|
@@ -21551,7 +21551,7 @@ export default {
|
|
|
21551
21551
|
},
|
|
21552
21552
|
name: {
|
|
21553
21553
|
description:
|
|
21554
|
-
"Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes
|
|
21554
|
+
"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).",
|
|
21555
21555
|
type: 'string',
|
|
21556
21556
|
},
|
|
21557
21557
|
prefer_native_scheduling: {
|
|
@@ -21651,7 +21651,7 @@ export default {
|
|
|
21651
21651
|
},
|
|
21652
21652
|
name: {
|
|
21653
21653
|
description:
|
|
21654
|
-
"Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes
|
|
21654
|
+
"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).",
|
|
21655
21655
|
type: 'string',
|
|
21656
21656
|
},
|
|
21657
21657
|
starts_at: {
|
|
@@ -21715,7 +21715,7 @@ export default {
|
|
|
21715
21715
|
},
|
|
21716
21716
|
name: {
|
|
21717
21717
|
description:
|
|
21718
|
-
"Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes
|
|
21718
|
+
"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).",
|
|
21719
21719
|
type: 'string',
|
|
21720
21720
|
},
|
|
21721
21721
|
starts_at: {
|
|
@@ -27751,7 +27751,6 @@ export default {
|
|
|
27751
27751
|
'igloohome',
|
|
27752
27752
|
'hubitat',
|
|
27753
27753
|
'controlbyweb',
|
|
27754
|
-
'smartthings',
|
|
27755
27754
|
'dormakaba_oracode',
|
|
27756
27755
|
'tedee',
|
|
27757
27756
|
'akiles',
|
|
@@ -27762,6 +27761,7 @@ export default {
|
|
|
27762
27761
|
'noiseaware',
|
|
27763
27762
|
'tado',
|
|
27764
27763
|
'sensi',
|
|
27764
|
+
'smartthings',
|
|
27765
27765
|
],
|
|
27766
27766
|
type: 'string',
|
|
27767
27767
|
},
|
|
@@ -28359,7 +28359,6 @@ export default {
|
|
|
28359
28359
|
'igloohome',
|
|
28360
28360
|
'hubitat',
|
|
28361
28361
|
'controlbyweb',
|
|
28362
|
-
'smartthings',
|
|
28363
28362
|
'dormakaba_oracode',
|
|
28364
28363
|
'tedee',
|
|
28365
28364
|
'akiles',
|
|
@@ -28370,6 +28369,7 @@ export default {
|
|
|
28370
28369
|
'noiseaware',
|
|
28371
28370
|
'tado',
|
|
28372
28371
|
'sensi',
|
|
28372
|
+
'smartthings',
|
|
28373
28373
|
],
|
|
28374
28374
|
type: 'string',
|
|
28375
28375
|
},
|
|
@@ -29285,7 +29285,6 @@ export default {
|
|
|
29285
29285
|
'salto',
|
|
29286
29286
|
'schlage',
|
|
29287
29287
|
'seam',
|
|
29288
|
-
'smartthings',
|
|
29289
29288
|
'wyze',
|
|
29290
29289
|
'yale',
|
|
29291
29290
|
'two_n',
|
|
@@ -29297,6 +29296,7 @@ export default {
|
|
|
29297
29296
|
'dormakaba_oracode',
|
|
29298
29297
|
'tedee',
|
|
29299
29298
|
'akiles',
|
|
29299
|
+
'smartthings',
|
|
29300
29300
|
],
|
|
29301
29301
|
type: 'string',
|
|
29302
29302
|
},
|
|
@@ -32912,6 +32912,7 @@ export default {
|
|
|
32912
32912
|
'nest',
|
|
32913
32913
|
'tado',
|
|
32914
32914
|
'sensi',
|
|
32915
|
+
'smartthings',
|
|
32915
32916
|
],
|
|
32916
32917
|
type: 'string',
|
|
32917
32918
|
},
|