@seamapi/types 1.404.1 → 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 +416 -138
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +448 -122
- 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/connected-accounts/connected-account.js +121 -41
- package/lib/seam/connect/models/connected-accounts/connected-account.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.d.ts +125 -9
- package/lib/seam/connect/openapi.js +328 -90
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +323 -113
- 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/connected-accounts/connected-account.ts +172 -44
- package/src/lib/seam/connect/models/devices/device-provider.ts +0 -1
- package/src/lib/seam/connect/openapi.ts +404 -90
- package/src/lib/seam/connect/route-types.ts +330 -113
|
@@ -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;
|
|
@@ -1490,16 +1478,22 @@ export interface Routes {
|
|
|
1490
1478
|
} | {
|
|
1491
1479
|
/** Date and time at which Seam created the error. */
|
|
1492
1480
|
created_at: string;
|
|
1481
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
1493
1482
|
message: string;
|
|
1483
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
1494
1484
|
is_connected_account_error?: boolean | undefined;
|
|
1485
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
1495
1486
|
is_bridge_error?: boolean | undefined;
|
|
1496
1487
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
1497
1488
|
error_code: 'invalid_credentials';
|
|
1498
1489
|
} | {
|
|
1499
1490
|
/** Date and time at which Seam created the error. */
|
|
1500
1491
|
created_at: string;
|
|
1492
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
1501
1493
|
message: string;
|
|
1494
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
1502
1495
|
is_connected_account_error?: boolean | undefined;
|
|
1496
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
1503
1497
|
is_bridge_error?: boolean | undefined;
|
|
1504
1498
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
1505
1499
|
error_code: 'bridge_disconnected';
|
|
@@ -1596,7 +1590,7 @@ export interface Routes {
|
|
|
1596
1590
|
starts_at?: (string | null) | undefined;
|
|
1597
1591
|
/** Date and time after which the time-bound access code becomes inactive. */
|
|
1598
1592
|
ends_at?: (string | null) | undefined;
|
|
1599
|
-
/** 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). */
|
|
1600
1594
|
status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
|
|
1601
1595
|
/** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
|
|
1602
1596
|
is_backup_access_code_available: boolean;
|
|
@@ -1624,13 +1618,7 @@ export interface Routes {
|
|
|
1624
1618
|
behavior_when_code_cannot_be_shared?: 'throw' | 'create_random_code';
|
|
1625
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. */
|
|
1626
1620
|
preferred_code_length?: number | undefined;
|
|
1627
|
-
/** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
1628
|
-
|
|
1629
|
-
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`.
|
|
1630
|
-
|
|
1631
|
-
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.
|
|
1632
|
-
|
|
1633
|
-
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). */
|
|
1634
1622
|
name?: string | undefined;
|
|
1635
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. */
|
|
1636
1624
|
starts_at?: string | undefined;
|
|
@@ -1671,13 +1659,7 @@ export interface Routes {
|
|
|
1671
1659
|
access_code_id: string;
|
|
1672
1660
|
/** Unique identifier for the device associated with the access code. */
|
|
1673
1661
|
device_id: string;
|
|
1674
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
1675
|
-
|
|
1676
|
-
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`.
|
|
1677
|
-
|
|
1678
|
-
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.
|
|
1679
|
-
|
|
1680
|
-
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). */
|
|
1681
1663
|
name: string | null;
|
|
1682
1664
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
1683
1665
|
code: string | null;
|
|
@@ -1992,16 +1974,22 @@ export interface Routes {
|
|
|
1992
1974
|
} | {
|
|
1993
1975
|
/** Date and time at which Seam created the error. */
|
|
1994
1976
|
created_at: string;
|
|
1977
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
1995
1978
|
message: string;
|
|
1979
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
1996
1980
|
is_connected_account_error?: boolean | undefined;
|
|
1981
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
1997
1982
|
is_bridge_error?: boolean | undefined;
|
|
1998
1983
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
1999
1984
|
error_code: 'invalid_credentials';
|
|
2000
1985
|
} | {
|
|
2001
1986
|
/** Date and time at which Seam created the error. */
|
|
2002
1987
|
created_at: string;
|
|
1988
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
2003
1989
|
message: string;
|
|
1990
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
2004
1991
|
is_connected_account_error?: boolean | undefined;
|
|
1992
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
2005
1993
|
is_bridge_error?: boolean | undefined;
|
|
2006
1994
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
2007
1995
|
error_code: 'bridge_disconnected';
|
|
@@ -2098,7 +2086,7 @@ export interface Routes {
|
|
|
2098
2086
|
starts_at?: (string | null) | undefined;
|
|
2099
2087
|
/** Date and time after which the time-bound access code becomes inactive. */
|
|
2100
2088
|
ends_at?: (string | null) | undefined;
|
|
2101
|
-
/** 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). */
|
|
2102
2090
|
status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
|
|
2103
2091
|
/** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
|
|
2104
2092
|
is_backup_access_code_available: boolean;
|
|
@@ -3287,13 +3275,7 @@ export interface Routes {
|
|
|
3287
3275
|
access_code_id: string;
|
|
3288
3276
|
/** Unique identifier for the device associated with the access code. */
|
|
3289
3277
|
device_id: string;
|
|
3290
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
3291
|
-
|
|
3292
|
-
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`.
|
|
3293
|
-
|
|
3294
|
-
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.
|
|
3295
|
-
|
|
3296
|
-
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). */
|
|
3297
3279
|
name: string | null;
|
|
3298
3280
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
3299
3281
|
code: string | null;
|
|
@@ -3608,16 +3590,22 @@ export interface Routes {
|
|
|
3608
3590
|
} | {
|
|
3609
3591
|
/** Date and time at which Seam created the error. */
|
|
3610
3592
|
created_at: string;
|
|
3593
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
3611
3594
|
message: string;
|
|
3595
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
3612
3596
|
is_connected_account_error?: boolean | undefined;
|
|
3597
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
3613
3598
|
is_bridge_error?: boolean | undefined;
|
|
3614
3599
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
3615
3600
|
error_code: 'invalid_credentials';
|
|
3616
3601
|
} | {
|
|
3617
3602
|
/** Date and time at which Seam created the error. */
|
|
3618
3603
|
created_at: string;
|
|
3604
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
3619
3605
|
message: string;
|
|
3606
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
3620
3607
|
is_connected_account_error?: boolean | undefined;
|
|
3608
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
3621
3609
|
is_bridge_error?: boolean | undefined;
|
|
3622
3610
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
3623
3611
|
error_code: 'bridge_disconnected';
|
|
@@ -3714,7 +3702,7 @@ export interface Routes {
|
|
|
3714
3702
|
starts_at?: (string | null) | undefined;
|
|
3715
3703
|
/** Date and time after which the time-bound access code becomes inactive. */
|
|
3716
3704
|
ends_at?: (string | null) | undefined;
|
|
3717
|
-
/** 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). */
|
|
3718
3706
|
status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
|
|
3719
3707
|
/** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
|
|
3720
3708
|
is_backup_access_code_available: boolean;
|
|
@@ -3763,13 +3751,7 @@ export interface Routes {
|
|
|
3763
3751
|
access_code_id: string;
|
|
3764
3752
|
/** Unique identifier for the device associated with the access code. */
|
|
3765
3753
|
device_id: string;
|
|
3766
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
3767
|
-
|
|
3768
|
-
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`.
|
|
3769
|
-
|
|
3770
|
-
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.
|
|
3771
|
-
|
|
3772
|
-
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). */
|
|
3773
3755
|
name: string | null;
|
|
3774
3756
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
3775
3757
|
code: string | null;
|
|
@@ -4084,16 +4066,22 @@ export interface Routes {
|
|
|
4084
4066
|
} | {
|
|
4085
4067
|
/** Date and time at which Seam created the error. */
|
|
4086
4068
|
created_at: string;
|
|
4069
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
4087
4070
|
message: string;
|
|
4071
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
4088
4072
|
is_connected_account_error?: boolean | undefined;
|
|
4073
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
4089
4074
|
is_bridge_error?: boolean | undefined;
|
|
4090
4075
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
4091
4076
|
error_code: 'invalid_credentials';
|
|
4092
4077
|
} | {
|
|
4093
4078
|
/** Date and time at which Seam created the error. */
|
|
4094
4079
|
created_at: string;
|
|
4080
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
4095
4081
|
message: string;
|
|
4082
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
4096
4083
|
is_connected_account_error?: boolean | undefined;
|
|
4084
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
4097
4085
|
is_bridge_error?: boolean | undefined;
|
|
4098
4086
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
4099
4087
|
error_code: 'bridge_disconnected';
|
|
@@ -4190,7 +4178,7 @@ export interface Routes {
|
|
|
4190
4178
|
starts_at?: (string | null) | undefined;
|
|
4191
4179
|
/** Date and time after which the time-bound access code becomes inactive. */
|
|
4192
4180
|
ends_at?: (string | null) | undefined;
|
|
4193
|
-
/** 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). */
|
|
4194
4182
|
status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
|
|
4195
4183
|
/** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
|
|
4196
4184
|
is_backup_access_code_available: boolean;
|
|
@@ -4247,13 +4235,7 @@ export interface Routes {
|
|
|
4247
4235
|
access_code_id: string;
|
|
4248
4236
|
/** Unique identifier for the device associated with the access code. */
|
|
4249
4237
|
device_id: string;
|
|
4250
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
4251
|
-
|
|
4252
|
-
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`.
|
|
4253
|
-
|
|
4254
|
-
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.
|
|
4255
|
-
|
|
4256
|
-
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). */
|
|
4257
4239
|
name: string | null;
|
|
4258
4240
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
4259
4241
|
code: string | null;
|
|
@@ -4568,16 +4550,22 @@ export interface Routes {
|
|
|
4568
4550
|
} | {
|
|
4569
4551
|
/** Date and time at which Seam created the error. */
|
|
4570
4552
|
created_at: string;
|
|
4553
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
4571
4554
|
message: string;
|
|
4555
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
4572
4556
|
is_connected_account_error?: boolean | undefined;
|
|
4557
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
4573
4558
|
is_bridge_error?: boolean | undefined;
|
|
4574
4559
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
4575
4560
|
error_code: 'invalid_credentials';
|
|
4576
4561
|
} | {
|
|
4577
4562
|
/** Date and time at which Seam created the error. */
|
|
4578
4563
|
created_at: string;
|
|
4564
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
4579
4565
|
message: string;
|
|
4566
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
4580
4567
|
is_connected_account_error?: boolean | undefined;
|
|
4568
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
4581
4569
|
is_bridge_error?: boolean | undefined;
|
|
4582
4570
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
4583
4571
|
error_code: 'bridge_disconnected';
|
|
@@ -4674,7 +4662,7 @@ export interface Routes {
|
|
|
4674
4662
|
starts_at?: (string | null) | undefined;
|
|
4675
4663
|
/** Date and time after which the time-bound access code becomes inactive. */
|
|
4676
4664
|
ends_at?: (string | null) | undefined;
|
|
4677
|
-
/** 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). */
|
|
4678
4666
|
status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
|
|
4679
4667
|
/** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
|
|
4680
4668
|
is_backup_access_code_available: boolean;
|
|
@@ -4709,13 +4697,7 @@ export interface Routes {
|
|
|
4709
4697
|
access_code_id: string;
|
|
4710
4698
|
/** Unique identifier for the device associated with the access code. */
|
|
4711
4699
|
device_id: string;
|
|
4712
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
4713
|
-
|
|
4714
|
-
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`.
|
|
4715
|
-
|
|
4716
|
-
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.
|
|
4717
|
-
|
|
4718
|
-
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). */
|
|
4719
4701
|
name: string | null;
|
|
4720
4702
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
4721
4703
|
code: string | null;
|
|
@@ -5030,16 +5012,22 @@ export interface Routes {
|
|
|
5030
5012
|
} | {
|
|
5031
5013
|
/** Date and time at which Seam created the error. */
|
|
5032
5014
|
created_at: string;
|
|
5015
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
5033
5016
|
message: string;
|
|
5017
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
5034
5018
|
is_connected_account_error?: boolean | undefined;
|
|
5019
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
5035
5020
|
is_bridge_error?: boolean | undefined;
|
|
5036
5021
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
5037
5022
|
error_code: 'invalid_credentials';
|
|
5038
5023
|
} | {
|
|
5039
5024
|
/** Date and time at which Seam created the error. */
|
|
5040
5025
|
created_at: string;
|
|
5026
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
5041
5027
|
message: string;
|
|
5028
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
5042
5029
|
is_connected_account_error?: boolean | undefined;
|
|
5030
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
5043
5031
|
is_bridge_error?: boolean | undefined;
|
|
5044
5032
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
5045
5033
|
error_code: 'bridge_disconnected';
|
|
@@ -5136,7 +5124,7 @@ export interface Routes {
|
|
|
5136
5124
|
starts_at?: (string | null) | undefined;
|
|
5137
5125
|
/** Date and time after which the time-bound access code becomes inactive. */
|
|
5138
5126
|
ends_at?: (string | null) | undefined;
|
|
5139
|
-
/** 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). */
|
|
5140
5128
|
status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
|
|
5141
5129
|
/** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
|
|
5142
5130
|
is_backup_access_code_available: boolean;
|
|
@@ -5204,13 +5192,7 @@ export interface Routes {
|
|
|
5204
5192
|
access_code_id: string;
|
|
5205
5193
|
/** Unique identifier for the device associated with the access code. */
|
|
5206
5194
|
device_id: string;
|
|
5207
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
5208
|
-
|
|
5209
|
-
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`.
|
|
5210
|
-
|
|
5211
|
-
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.
|
|
5212
|
-
|
|
5213
|
-
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). */
|
|
5214
5196
|
name: string | null;
|
|
5215
5197
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
5216
5198
|
code: string | null;
|
|
@@ -5525,16 +5507,22 @@ export interface Routes {
|
|
|
5525
5507
|
} | {
|
|
5526
5508
|
/** Date and time at which Seam created the error. */
|
|
5527
5509
|
created_at: string;
|
|
5510
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
5528
5511
|
message: string;
|
|
5512
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
5529
5513
|
is_connected_account_error?: boolean | undefined;
|
|
5514
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
5530
5515
|
is_bridge_error?: boolean | undefined;
|
|
5531
5516
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
5532
5517
|
error_code: 'invalid_credentials';
|
|
5533
5518
|
} | {
|
|
5534
5519
|
/** Date and time at which Seam created the error. */
|
|
5535
5520
|
created_at: string;
|
|
5521
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
5536
5522
|
message: string;
|
|
5523
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
5537
5524
|
is_connected_account_error?: boolean | undefined;
|
|
5525
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
5538
5526
|
is_bridge_error?: boolean | undefined;
|
|
5539
5527
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
5540
5528
|
error_code: 'bridge_disconnected';
|
|
@@ -6807,13 +6795,7 @@ export interface Routes {
|
|
|
6807
6795
|
access_code_id: string;
|
|
6808
6796
|
/** Unique identifier for the device associated with the access code. */
|
|
6809
6797
|
device_id: string;
|
|
6810
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
6811
|
-
|
|
6812
|
-
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`.
|
|
6813
|
-
|
|
6814
|
-
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.
|
|
6815
|
-
|
|
6816
|
-
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). */
|
|
6817
6799
|
name: string | null;
|
|
6818
6800
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
6819
6801
|
code: string | null;
|
|
@@ -7128,16 +7110,22 @@ export interface Routes {
|
|
|
7128
7110
|
} | {
|
|
7129
7111
|
/** Date and time at which Seam created the error. */
|
|
7130
7112
|
created_at: string;
|
|
7113
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
7131
7114
|
message: string;
|
|
7115
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
7132
7116
|
is_connected_account_error?: boolean | undefined;
|
|
7117
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
7133
7118
|
is_bridge_error?: boolean | undefined;
|
|
7134
7119
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
7135
7120
|
error_code: 'invalid_credentials';
|
|
7136
7121
|
} | {
|
|
7137
7122
|
/** Date and time at which Seam created the error. */
|
|
7138
7123
|
created_at: string;
|
|
7124
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
7139
7125
|
message: string;
|
|
7126
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
7140
7127
|
is_connected_account_error?: boolean | undefined;
|
|
7128
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
7141
7129
|
is_bridge_error?: boolean | undefined;
|
|
7142
7130
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
7143
7131
|
error_code: 'bridge_disconnected';
|
|
@@ -7259,13 +7247,7 @@ export interface Routes {
|
|
|
7259
7247
|
access_code_id: string;
|
|
7260
7248
|
/** Unique identifier for the device associated with the access code. */
|
|
7261
7249
|
device_id: string;
|
|
7262
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
7263
|
-
|
|
7264
|
-
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`.
|
|
7265
|
-
|
|
7266
|
-
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.
|
|
7267
|
-
|
|
7268
|
-
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). */
|
|
7269
7251
|
name: string | null;
|
|
7270
7252
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
7271
7253
|
code: string | null;
|
|
@@ -7580,16 +7562,22 @@ export interface Routes {
|
|
|
7580
7562
|
} | {
|
|
7581
7563
|
/** Date and time at which Seam created the error. */
|
|
7582
7564
|
created_at: string;
|
|
7565
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
7583
7566
|
message: string;
|
|
7567
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
7584
7568
|
is_connected_account_error?: boolean | undefined;
|
|
7569
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
7585
7570
|
is_bridge_error?: boolean | undefined;
|
|
7586
7571
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
7587
7572
|
error_code: 'invalid_credentials';
|
|
7588
7573
|
} | {
|
|
7589
7574
|
/** Date and time at which Seam created the error. */
|
|
7590
7575
|
created_at: string;
|
|
7576
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
7591
7577
|
message: string;
|
|
7578
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
7592
7579
|
is_connected_account_error?: boolean | undefined;
|
|
7580
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
7593
7581
|
is_bridge_error?: boolean | undefined;
|
|
7594
7582
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
7595
7583
|
error_code: 'bridge_disconnected';
|
|
@@ -7715,13 +7703,7 @@ export interface Routes {
|
|
|
7715
7703
|
method: 'POST' | 'PATCH' | 'PUT';
|
|
7716
7704
|
queryParams: {};
|
|
7717
7705
|
jsonBody: {
|
|
7718
|
-
/** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
7719
|
-
|
|
7720
|
-
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`.
|
|
7721
|
-
|
|
7722
|
-
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.
|
|
7723
|
-
|
|
7724
|
-
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). */
|
|
7725
7707
|
name?: string | undefined;
|
|
7726
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. */
|
|
7727
7709
|
starts_at?: string | undefined;
|
|
@@ -8875,13 +8857,7 @@ export interface Routes {
|
|
|
8875
8857
|
ends_at?: string | undefined;
|
|
8876
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. */
|
|
8877
8859
|
starts_at?: string | undefined;
|
|
8878
|
-
/** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
8879
|
-
|
|
8880
|
-
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`.
|
|
8881
|
-
|
|
8882
|
-
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.
|
|
8883
|
-
|
|
8884
|
-
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). */
|
|
8885
8861
|
name?: string | undefined;
|
|
8886
8862
|
/** Key that links the group of access codes, assigned on creation by `/access_codes/create_multiple`. */
|
|
8887
8863
|
common_code_key: string;
|
|
@@ -15292,8 +15268,12 @@ export interface Routes {
|
|
|
15292
15268
|
queryParams: {};
|
|
15293
15269
|
jsonBody: {};
|
|
15294
15270
|
commonParams: {
|
|
15295
|
-
/** ID of the access system user that you want to delete. */
|
|
15296
|
-
acs_user_id
|
|
15271
|
+
/** ID of the access system user that you want to delete. You must provide either acs_user_id or user_identity_id */
|
|
15272
|
+
acs_user_id?: string | undefined;
|
|
15273
|
+
/** ID of the user identity that you want to delete. You must provide either acs_user_id or user_identity_id. If you provide user_identity_id, you must also provide acs_system_id. */
|
|
15274
|
+
user_identity_id?: string | undefined;
|
|
15275
|
+
/** ID of the access system that you want to delete. You must provide acs_system_id with user_identity_id. */
|
|
15276
|
+
acs_system_id?: string | undefined;
|
|
15297
15277
|
};
|
|
15298
15278
|
formData: {};
|
|
15299
15279
|
jsonResponse: {};
|
|
@@ -15304,8 +15284,12 @@ export interface Routes {
|
|
|
15304
15284
|
queryParams: {};
|
|
15305
15285
|
jsonBody: {};
|
|
15306
15286
|
commonParams: {
|
|
15307
|
-
/** ID of the access system user that you want to get. */
|
|
15308
|
-
acs_user_id
|
|
15287
|
+
/** ID of the access system user that you want to get. You can only provide acs_user_id or user_identity_id. */
|
|
15288
|
+
acs_user_id?: string | undefined;
|
|
15289
|
+
/** ID of the user identity that you want to get. You can only provide acs_user_id or user_identity_id. */
|
|
15290
|
+
user_identity_id?: string | undefined;
|
|
15291
|
+
/** ID of the access system that you want to get. You can only provide acs_user_id or user_identity_id. */
|
|
15292
|
+
acs_system_id?: string | undefined;
|
|
15309
15293
|
};
|
|
15310
15294
|
formData: {};
|
|
15311
15295
|
jsonResponse: {
|
|
@@ -15816,8 +15800,12 @@ export interface Routes {
|
|
|
15816
15800
|
method: 'POST';
|
|
15817
15801
|
queryParams: {};
|
|
15818
15802
|
jsonBody: {
|
|
15819
|
-
/** ID of the access system user for whom you want to revoke access. */
|
|
15820
|
-
acs_user_id
|
|
15803
|
+
/** ID of the access system user for whom you want to revoke access. You can only provide acs_user_id or user_identity_id. */
|
|
15804
|
+
acs_user_id?: string | undefined;
|
|
15805
|
+
/** ID of the user identity for whom you want to revoke access. You can only provide acs_user_id or user_identity_id. */
|
|
15806
|
+
user_identity_id?: string | undefined;
|
|
15807
|
+
/** ID of the access system for which you want to revoke access. You can only provide acs_system_id with user_identity_id. */
|
|
15808
|
+
acs_system_id?: string | undefined;
|
|
15821
15809
|
};
|
|
15822
15810
|
commonParams: {};
|
|
15823
15811
|
formData: {};
|
|
@@ -15829,8 +15817,12 @@ export interface Routes {
|
|
|
15829
15817
|
queryParams: {};
|
|
15830
15818
|
jsonBody: {};
|
|
15831
15819
|
commonParams: {
|
|
15832
|
-
/** ID of the access system user that you want to suspend. */
|
|
15833
|
-
acs_user_id
|
|
15820
|
+
/** ID of the access system user that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id. */
|
|
15821
|
+
acs_user_id?: string | undefined;
|
|
15822
|
+
/** ID of the user identity that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id. */
|
|
15823
|
+
user_identity_id?: string | undefined;
|
|
15824
|
+
/** ID of the access system that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id. */
|
|
15825
|
+
acs_system_id?: string | undefined;
|
|
15834
15826
|
};
|
|
15835
15827
|
formData: {};
|
|
15836
15828
|
jsonResponse: {};
|
|
@@ -16240,8 +16232,12 @@ export interface Routes {
|
|
|
16240
16232
|
queryParams: {};
|
|
16241
16233
|
jsonBody: {};
|
|
16242
16234
|
commonParams: {
|
|
16243
|
-
/** ID of the access system user that you want to unsuspend. */
|
|
16244
|
-
acs_user_id
|
|
16235
|
+
/** ID of the access system user that you want to unsuspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id. */
|
|
16236
|
+
acs_user_id?: string | undefined;
|
|
16237
|
+
/** ID of the user identity that you want to unsuspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id. */
|
|
16238
|
+
user_identity_id?: string | undefined;
|
|
16239
|
+
/** ID of the access system of the user that you want to unsuspend. You can only provide acs_system_id with user_identity_id. */
|
|
16240
|
+
acs_system_id?: string | undefined;
|
|
16245
16241
|
};
|
|
16246
16242
|
formData: {};
|
|
16247
16243
|
jsonResponse: {};
|
|
@@ -16258,8 +16254,12 @@ export interface Routes {
|
|
|
16258
16254
|
/** Ending timestamp for the access system user's access. */
|
|
16259
16255
|
ends_at: string;
|
|
16260
16256
|
} | null) | undefined;
|
|
16261
|
-
/** ID of the
|
|
16262
|
-
acs_user_id
|
|
16257
|
+
/** ID of the access system user that you want to update. You can only provide acs_user_id or user_identity_id. */
|
|
16258
|
+
acs_user_id?: string | undefined;
|
|
16259
|
+
/** ID of the user identity that you want to update. You can only provide acs_user_id or user_identity_id. If you provide user_identity_id, you must also provide acs_system_id. */
|
|
16260
|
+
user_identity_id?: string | undefined;
|
|
16261
|
+
/** ID of the access system that you want to update. You can only provide acs_system_id with user_identity_id. */
|
|
16262
|
+
acs_system_id?: string | undefined;
|
|
16263
16263
|
/** Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
|
|
16264
16264
|
full_name?: string | undefined;
|
|
16265
16265
|
/**
|
|
@@ -19003,87 +19003,127 @@ export interface Routes {
|
|
|
19003
19003
|
jsonResponse: {
|
|
19004
19004
|
/** Represents a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). A connected account is an external third-party account to which your user has authorized Seam to get access, for example, an August account with a list of door locks. */
|
|
19005
19005
|
connected_account: {
|
|
19006
|
+
/** Unique identifier for the connected account. */
|
|
19006
19007
|
connected_account_id?: string | undefined;
|
|
19008
|
+
/** Date and time at which the connected account was created. */
|
|
19007
19009
|
created_at?: string | undefined;
|
|
19010
|
+
/** User identifier associated with the connected account. */
|
|
19008
19011
|
user_identifier?: {
|
|
19012
|
+
/** Username of the user identifier associated with the connected account. */
|
|
19009
19013
|
username?: string | undefined;
|
|
19014
|
+
/** API URL for the user identifier associated with the connected account. */
|
|
19010
19015
|
api_url?: string | undefined;
|
|
19016
|
+
/** Email address of the user identifier associated with the connected account. */
|
|
19011
19017
|
email?: string | undefined;
|
|
19018
|
+
/** Phone number of the user identifier associated with the connected account. */
|
|
19012
19019
|
phone?: string | undefined;
|
|
19020
|
+
/** Indicates whether the user identifier associated with the connected account is exclusive. */
|
|
19013
19021
|
exclusive?: boolean | undefined;
|
|
19014
19022
|
} | undefined;
|
|
19023
|
+
/** Type of connected account. */
|
|
19015
19024
|
account_type?: string | undefined;
|
|
19025
|
+
/** Display name for the connected account type. */
|
|
19016
19026
|
account_type_display_name: string;
|
|
19027
|
+
/** Errors associated with the connected account. */
|
|
19017
19028
|
errors: Array<{
|
|
19018
19029
|
/** Date and time at which Seam created the error. */
|
|
19019
19030
|
created_at: string;
|
|
19031
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
19020
19032
|
message: string;
|
|
19033
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
19021
19034
|
is_connected_account_error?: boolean | undefined;
|
|
19035
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
19022
19036
|
is_bridge_error?: boolean | undefined;
|
|
19023
19037
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
19024
19038
|
error_code: 'account_disconnected';
|
|
19025
19039
|
} | {
|
|
19026
19040
|
/** Date and time at which Seam created the error. */
|
|
19027
19041
|
created_at: string;
|
|
19042
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
19028
19043
|
message: string;
|
|
19044
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
19029
19045
|
is_connected_account_error?: boolean | undefined;
|
|
19046
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
19030
19047
|
is_bridge_error?: boolean | undefined;
|
|
19031
19048
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
19032
19049
|
error_code: 'invalid_credentials';
|
|
19033
19050
|
} | {
|
|
19034
19051
|
/** Date and time at which Seam created the error. */
|
|
19035
19052
|
created_at: string;
|
|
19053
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
19036
19054
|
message: string;
|
|
19055
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
19037
19056
|
is_connected_account_error?: boolean | undefined;
|
|
19057
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
19038
19058
|
is_bridge_error?: boolean | undefined;
|
|
19039
19059
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
19040
19060
|
error_code: 'bridge_disconnected';
|
|
19041
19061
|
} | {
|
|
19042
19062
|
/** Date and time at which Seam created the error. */
|
|
19043
19063
|
created_at: string;
|
|
19064
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
19044
19065
|
message: string;
|
|
19066
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
19045
19067
|
is_connected_account_error?: boolean | undefined;
|
|
19068
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
19046
19069
|
is_bridge_error?: boolean | undefined;
|
|
19047
19070
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
19048
19071
|
error_code: 'salto_ks_subscription_limit_exceeded';
|
|
19072
|
+
/** Salto KS metadata associated with the connected account that has an error. */
|
|
19049
19073
|
salto_ks_metadata: {
|
|
19074
|
+
/** Salto sites associated with the connected account that has an error. */
|
|
19050
19075
|
sites: Array<{
|
|
19076
|
+
/** ID of a Salto site associated with the connected account that has an error. */
|
|
19051
19077
|
site_id: string;
|
|
19078
|
+
/** Name of a Salto site associated with the connected account that has an error. */
|
|
19052
19079
|
site_name: string;
|
|
19080
|
+
/** Count of subscribed site users for a Salto site associated with the connected account that has an error. */
|
|
19053
19081
|
subscribed_site_user_count: number;
|
|
19082
|
+
/** Subscription limit of site users for a Salto site associated with the connected account that has an error. */
|
|
19054
19083
|
site_user_subscription_limit: number;
|
|
19055
19084
|
}>;
|
|
19056
19085
|
};
|
|
19057
19086
|
}>;
|
|
19087
|
+
/** Warnings associated with the connected account. */
|
|
19058
19088
|
warnings: Array<{
|
|
19059
19089
|
/** Date and time at which Seam created the warning. */
|
|
19060
19090
|
created_at: string;
|
|
19091
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
19061
19092
|
message: string;
|
|
19062
19093
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
19063
19094
|
warning_code: 'scheduled_maintenance_window';
|
|
19064
19095
|
} | {
|
|
19065
19096
|
/** Date and time at which Seam created the warning. */
|
|
19066
19097
|
created_at: string;
|
|
19098
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
19067
19099
|
message: string;
|
|
19068
19100
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
19069
19101
|
warning_code: 'unknown_issue_with_connected_account';
|
|
19070
19102
|
} | {
|
|
19071
19103
|
/** Date and time at which Seam created the warning. */
|
|
19072
19104
|
created_at: string;
|
|
19105
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
19073
19106
|
message: string;
|
|
19074
19107
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
19075
19108
|
warning_code: 'salto_ks_subscription_limit_almost_reached';
|
|
19109
|
+
/** Salto KS metadata associated with the connected account that has a warning. */
|
|
19076
19110
|
salto_ks_metadata: {
|
|
19111
|
+
/** Salto sites associated with the connected account that has a warning. */
|
|
19077
19112
|
sites: Array<{
|
|
19113
|
+
/** ID of a Salto site associated with the connected account that has a warning. */
|
|
19078
19114
|
site_id: string;
|
|
19115
|
+
/** Name of a Salto site associated with the connected account that has a warning. */
|
|
19079
19116
|
site_name: string;
|
|
19117
|
+
/** Subscription limit of site users for a Salto site associated with the connected account that has a warning. */
|
|
19080
19118
|
site_user_subscription_limit: number;
|
|
19119
|
+
/** Count of subscribed site users for a Salto site associated with the connected account that has a warning. */
|
|
19081
19120
|
subscribed_site_user_count: number;
|
|
19082
19121
|
}>;
|
|
19083
19122
|
};
|
|
19084
19123
|
}>;
|
|
19085
19124
|
/** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
|
|
19086
19125
|
custom_metadata: Record<string, string | boolean>;
|
|
19126
|
+
/** Indicates whether Seam should [import all new devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API. */
|
|
19087
19127
|
automatically_manage_new_devices: boolean;
|
|
19088
19128
|
};
|
|
19089
19129
|
};
|
|
@@ -19107,87 +19147,127 @@ export interface Routes {
|
|
|
19107
19147
|
formData: {};
|
|
19108
19148
|
jsonResponse: {
|
|
19109
19149
|
connected_accounts: Array<{
|
|
19150
|
+
/** Unique identifier for the connected account. */
|
|
19110
19151
|
connected_account_id?: string | undefined;
|
|
19152
|
+
/** Date and time at which the connected account was created. */
|
|
19111
19153
|
created_at?: string | undefined;
|
|
19154
|
+
/** User identifier associated with the connected account. */
|
|
19112
19155
|
user_identifier?: {
|
|
19156
|
+
/** Username of the user identifier associated with the connected account. */
|
|
19113
19157
|
username?: string | undefined;
|
|
19158
|
+
/** API URL for the user identifier associated with the connected account. */
|
|
19114
19159
|
api_url?: string | undefined;
|
|
19160
|
+
/** Email address of the user identifier associated with the connected account. */
|
|
19115
19161
|
email?: string | undefined;
|
|
19162
|
+
/** Phone number of the user identifier associated with the connected account. */
|
|
19116
19163
|
phone?: string | undefined;
|
|
19164
|
+
/** Indicates whether the user identifier associated with the connected account is exclusive. */
|
|
19117
19165
|
exclusive?: boolean | undefined;
|
|
19118
19166
|
} | undefined;
|
|
19167
|
+
/** Type of connected account. */
|
|
19119
19168
|
account_type?: string | undefined;
|
|
19169
|
+
/** Display name for the connected account type. */
|
|
19120
19170
|
account_type_display_name: string;
|
|
19171
|
+
/** Errors associated with the connected account. */
|
|
19121
19172
|
errors: Array<{
|
|
19122
19173
|
/** Date and time at which Seam created the error. */
|
|
19123
19174
|
created_at: string;
|
|
19175
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
19124
19176
|
message: string;
|
|
19177
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
19125
19178
|
is_connected_account_error?: boolean | undefined;
|
|
19179
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
19126
19180
|
is_bridge_error?: boolean | undefined;
|
|
19127
19181
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
19128
19182
|
error_code: 'account_disconnected';
|
|
19129
19183
|
} | {
|
|
19130
19184
|
/** Date and time at which Seam created the error. */
|
|
19131
19185
|
created_at: string;
|
|
19186
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
19132
19187
|
message: string;
|
|
19188
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
19133
19189
|
is_connected_account_error?: boolean | undefined;
|
|
19190
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
19134
19191
|
is_bridge_error?: boolean | undefined;
|
|
19135
19192
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
19136
19193
|
error_code: 'invalid_credentials';
|
|
19137
19194
|
} | {
|
|
19138
19195
|
/** Date and time at which Seam created the error. */
|
|
19139
19196
|
created_at: string;
|
|
19197
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
19140
19198
|
message: string;
|
|
19199
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
19141
19200
|
is_connected_account_error?: boolean | undefined;
|
|
19201
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
19142
19202
|
is_bridge_error?: boolean | undefined;
|
|
19143
19203
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
19144
19204
|
error_code: 'bridge_disconnected';
|
|
19145
19205
|
} | {
|
|
19146
19206
|
/** Date and time at which Seam created the error. */
|
|
19147
19207
|
created_at: string;
|
|
19208
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
19148
19209
|
message: string;
|
|
19210
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
19149
19211
|
is_connected_account_error?: boolean | undefined;
|
|
19212
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
19150
19213
|
is_bridge_error?: boolean | undefined;
|
|
19151
19214
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
19152
19215
|
error_code: 'salto_ks_subscription_limit_exceeded';
|
|
19216
|
+
/** Salto KS metadata associated with the connected account that has an error. */
|
|
19153
19217
|
salto_ks_metadata: {
|
|
19218
|
+
/** Salto sites associated with the connected account that has an error. */
|
|
19154
19219
|
sites: Array<{
|
|
19220
|
+
/** ID of a Salto site associated with the connected account that has an error. */
|
|
19155
19221
|
site_id: string;
|
|
19222
|
+
/** Name of a Salto site associated with the connected account that has an error. */
|
|
19156
19223
|
site_name: string;
|
|
19224
|
+
/** Count of subscribed site users for a Salto site associated with the connected account that has an error. */
|
|
19157
19225
|
subscribed_site_user_count: number;
|
|
19226
|
+
/** Subscription limit of site users for a Salto site associated with the connected account that has an error. */
|
|
19158
19227
|
site_user_subscription_limit: number;
|
|
19159
19228
|
}>;
|
|
19160
19229
|
};
|
|
19161
19230
|
}>;
|
|
19231
|
+
/** Warnings associated with the connected account. */
|
|
19162
19232
|
warnings: Array<{
|
|
19163
19233
|
/** Date and time at which Seam created the warning. */
|
|
19164
19234
|
created_at: string;
|
|
19235
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
19165
19236
|
message: string;
|
|
19166
19237
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
19167
19238
|
warning_code: 'scheduled_maintenance_window';
|
|
19168
19239
|
} | {
|
|
19169
19240
|
/** Date and time at which Seam created the warning. */
|
|
19170
19241
|
created_at: string;
|
|
19242
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
19171
19243
|
message: string;
|
|
19172
19244
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
19173
19245
|
warning_code: 'unknown_issue_with_connected_account';
|
|
19174
19246
|
} | {
|
|
19175
19247
|
/** Date and time at which Seam created the warning. */
|
|
19176
19248
|
created_at: string;
|
|
19249
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
19177
19250
|
message: string;
|
|
19178
19251
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
19179
19252
|
warning_code: 'salto_ks_subscription_limit_almost_reached';
|
|
19253
|
+
/** Salto KS metadata associated with the connected account that has a warning. */
|
|
19180
19254
|
salto_ks_metadata: {
|
|
19255
|
+
/** Salto sites associated with the connected account that has a warning. */
|
|
19181
19256
|
sites: Array<{
|
|
19257
|
+
/** ID of a Salto site associated with the connected account that has a warning. */
|
|
19182
19258
|
site_id: string;
|
|
19259
|
+
/** Name of a Salto site associated with the connected account that has a warning. */
|
|
19183
19260
|
site_name: string;
|
|
19261
|
+
/** Subscription limit of site users for a Salto site associated with the connected account that has a warning. */
|
|
19184
19262
|
site_user_subscription_limit: number;
|
|
19263
|
+
/** Count of subscribed site users for a Salto site associated with the connected account that has a warning. */
|
|
19185
19264
|
subscribed_site_user_count: number;
|
|
19186
19265
|
}>;
|
|
19187
19266
|
};
|
|
19188
19267
|
}>;
|
|
19189
19268
|
/** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
|
|
19190
19269
|
custom_metadata: Record<string, string | boolean>;
|
|
19270
|
+
/** Indicates whether Seam should [import all new devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API. */
|
|
19191
19271
|
automatically_manage_new_devices: boolean;
|
|
19192
19272
|
}>;
|
|
19193
19273
|
/** Information about the current page of results. */
|
|
@@ -19218,87 +19298,127 @@ export interface Routes {
|
|
|
19218
19298
|
jsonResponse: {
|
|
19219
19299
|
/** Represents a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). A connected account is an external third-party account to which your user has authorized Seam to get access, for example, an August account with a list of door locks. */
|
|
19220
19300
|
connected_account: {
|
|
19301
|
+
/** Unique identifier for the connected account. */
|
|
19221
19302
|
connected_account_id?: string | undefined;
|
|
19303
|
+
/** Date and time at which the connected account was created. */
|
|
19222
19304
|
created_at?: string | undefined;
|
|
19305
|
+
/** User identifier associated with the connected account. */
|
|
19223
19306
|
user_identifier?: {
|
|
19307
|
+
/** Username of the user identifier associated with the connected account. */
|
|
19224
19308
|
username?: string | undefined;
|
|
19309
|
+
/** API URL for the user identifier associated with the connected account. */
|
|
19225
19310
|
api_url?: string | undefined;
|
|
19311
|
+
/** Email address of the user identifier associated with the connected account. */
|
|
19226
19312
|
email?: string | undefined;
|
|
19313
|
+
/** Phone number of the user identifier associated with the connected account. */
|
|
19227
19314
|
phone?: string | undefined;
|
|
19315
|
+
/** Indicates whether the user identifier associated with the connected account is exclusive. */
|
|
19228
19316
|
exclusive?: boolean | undefined;
|
|
19229
19317
|
} | undefined;
|
|
19318
|
+
/** Type of connected account. */
|
|
19230
19319
|
account_type?: string | undefined;
|
|
19320
|
+
/** Display name for the connected account type. */
|
|
19231
19321
|
account_type_display_name: string;
|
|
19322
|
+
/** Errors associated with the connected account. */
|
|
19232
19323
|
errors: Array<{
|
|
19233
19324
|
/** Date and time at which Seam created the error. */
|
|
19234
19325
|
created_at: string;
|
|
19326
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
19235
19327
|
message: string;
|
|
19328
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
19236
19329
|
is_connected_account_error?: boolean | undefined;
|
|
19330
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
19237
19331
|
is_bridge_error?: boolean | undefined;
|
|
19238
19332
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
19239
19333
|
error_code: 'account_disconnected';
|
|
19240
19334
|
} | {
|
|
19241
19335
|
/** Date and time at which Seam created the error. */
|
|
19242
19336
|
created_at: string;
|
|
19337
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
19243
19338
|
message: string;
|
|
19339
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
19244
19340
|
is_connected_account_error?: boolean | undefined;
|
|
19341
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
19245
19342
|
is_bridge_error?: boolean | undefined;
|
|
19246
19343
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
19247
19344
|
error_code: 'invalid_credentials';
|
|
19248
19345
|
} | {
|
|
19249
19346
|
/** Date and time at which Seam created the error. */
|
|
19250
19347
|
created_at: string;
|
|
19348
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
19251
19349
|
message: string;
|
|
19350
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
19252
19351
|
is_connected_account_error?: boolean | undefined;
|
|
19352
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
19253
19353
|
is_bridge_error?: boolean | undefined;
|
|
19254
19354
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
19255
19355
|
error_code: 'bridge_disconnected';
|
|
19256
19356
|
} | {
|
|
19257
19357
|
/** Date and time at which Seam created the error. */
|
|
19258
19358
|
created_at: string;
|
|
19359
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
19259
19360
|
message: string;
|
|
19361
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
19260
19362
|
is_connected_account_error?: boolean | undefined;
|
|
19363
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
19261
19364
|
is_bridge_error?: boolean | undefined;
|
|
19262
19365
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
19263
19366
|
error_code: 'salto_ks_subscription_limit_exceeded';
|
|
19367
|
+
/** Salto KS metadata associated with the connected account that has an error. */
|
|
19264
19368
|
salto_ks_metadata: {
|
|
19369
|
+
/** Salto sites associated with the connected account that has an error. */
|
|
19265
19370
|
sites: Array<{
|
|
19371
|
+
/** ID of a Salto site associated with the connected account that has an error. */
|
|
19266
19372
|
site_id: string;
|
|
19373
|
+
/** Name of a Salto site associated with the connected account that has an error. */
|
|
19267
19374
|
site_name: string;
|
|
19375
|
+
/** Count of subscribed site users for a Salto site associated with the connected account that has an error. */
|
|
19268
19376
|
subscribed_site_user_count: number;
|
|
19377
|
+
/** Subscription limit of site users for a Salto site associated with the connected account that has an error. */
|
|
19269
19378
|
site_user_subscription_limit: number;
|
|
19270
19379
|
}>;
|
|
19271
19380
|
};
|
|
19272
19381
|
}>;
|
|
19382
|
+
/** Warnings associated with the connected account. */
|
|
19273
19383
|
warnings: Array<{
|
|
19274
19384
|
/** Date and time at which Seam created the warning. */
|
|
19275
19385
|
created_at: string;
|
|
19386
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
19276
19387
|
message: string;
|
|
19277
19388
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
19278
19389
|
warning_code: 'scheduled_maintenance_window';
|
|
19279
19390
|
} | {
|
|
19280
19391
|
/** Date and time at which Seam created the warning. */
|
|
19281
19392
|
created_at: string;
|
|
19393
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
19282
19394
|
message: string;
|
|
19283
19395
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
19284
19396
|
warning_code: 'unknown_issue_with_connected_account';
|
|
19285
19397
|
} | {
|
|
19286
19398
|
/** Date and time at which Seam created the warning. */
|
|
19287
19399
|
created_at: string;
|
|
19400
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
19288
19401
|
message: string;
|
|
19289
19402
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
19290
19403
|
warning_code: 'salto_ks_subscription_limit_almost_reached';
|
|
19404
|
+
/** Salto KS metadata associated with the connected account that has a warning. */
|
|
19291
19405
|
salto_ks_metadata: {
|
|
19406
|
+
/** Salto sites associated with the connected account that has a warning. */
|
|
19292
19407
|
sites: Array<{
|
|
19408
|
+
/** ID of a Salto site associated with the connected account that has a warning. */
|
|
19293
19409
|
site_id: string;
|
|
19410
|
+
/** Name of a Salto site associated with the connected account that has a warning. */
|
|
19294
19411
|
site_name: string;
|
|
19412
|
+
/** Subscription limit of site users for a Salto site associated with the connected account that has a warning. */
|
|
19295
19413
|
site_user_subscription_limit: number;
|
|
19414
|
+
/** Count of subscribed site users for a Salto site associated with the connected account that has a warning. */
|
|
19296
19415
|
subscribed_site_user_count: number;
|
|
19297
19416
|
}>;
|
|
19298
19417
|
};
|
|
19299
19418
|
}>;
|
|
19300
19419
|
/** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
|
|
19301
19420
|
custom_metadata: Record<string, string | boolean>;
|
|
19421
|
+
/** Indicates whether Seam should [import all new devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API. */
|
|
19302
19422
|
automatically_manage_new_devices: boolean;
|
|
19303
19423
|
};
|
|
19304
19424
|
};
|
|
@@ -19964,16 +20084,22 @@ export interface Routes {
|
|
|
19964
20084
|
} | {
|
|
19965
20085
|
/** Date and time at which Seam created the error. */
|
|
19966
20086
|
created_at: string;
|
|
20087
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
19967
20088
|
message: string;
|
|
20089
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
19968
20090
|
is_connected_account_error?: boolean | undefined;
|
|
20091
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
19969
20092
|
is_bridge_error?: boolean | undefined;
|
|
19970
20093
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
19971
20094
|
error_code: 'invalid_credentials';
|
|
19972
20095
|
} | {
|
|
19973
20096
|
/** Date and time at which Seam created the error. */
|
|
19974
20097
|
created_at: string;
|
|
20098
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
19975
20099
|
message: string;
|
|
20100
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
19976
20101
|
is_connected_account_error?: boolean | undefined;
|
|
20102
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
19977
20103
|
is_bridge_error?: boolean | undefined;
|
|
19978
20104
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
19979
20105
|
error_code: 'bridge_disconnected';
|
|
@@ -20103,7 +20229,7 @@ export interface Routes {
|
|
|
20103
20229
|
/** Array of device types for which you want to list devices. */
|
|
20104
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;
|
|
20105
20231
|
/** Manufacturer for which you want to list devices. */
|
|
20106
|
-
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;
|
|
20107
20233
|
/** Array of device IDs for which you want to list devices. */
|
|
20108
20234
|
device_ids?: string[] | undefined;
|
|
20109
20235
|
/** Numerical limit on the number of devices to return. */
|
|
@@ -20760,16 +20886,22 @@ export interface Routes {
|
|
|
20760
20886
|
} | {
|
|
20761
20887
|
/** Date and time at which Seam created the error. */
|
|
20762
20888
|
created_at: string;
|
|
20889
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
20763
20890
|
message: string;
|
|
20891
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
20764
20892
|
is_connected_account_error?: boolean | undefined;
|
|
20893
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
20765
20894
|
is_bridge_error?: boolean | undefined;
|
|
20766
20895
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
20767
20896
|
error_code: 'invalid_credentials';
|
|
20768
20897
|
} | {
|
|
20769
20898
|
/** Date and time at which Seam created the error. */
|
|
20770
20899
|
created_at: string;
|
|
20900
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
20771
20901
|
message: string;
|
|
20902
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
20772
20903
|
is_connected_account_error?: boolean | undefined;
|
|
20904
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
20773
20905
|
is_bridge_error?: boolean | undefined;
|
|
20774
20906
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
20775
20907
|
error_code: 'bridge_disconnected';
|
|
@@ -21072,16 +21204,22 @@ export interface Routes {
|
|
|
21072
21204
|
} | {
|
|
21073
21205
|
/** Date and time at which Seam created the error. */
|
|
21074
21206
|
created_at: string;
|
|
21207
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
21075
21208
|
message: string;
|
|
21209
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
21076
21210
|
is_connected_account_error?: boolean | undefined;
|
|
21211
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
21077
21212
|
is_bridge_error?: boolean | undefined;
|
|
21078
21213
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
21079
21214
|
error_code: 'invalid_credentials';
|
|
21080
21215
|
} | {
|
|
21081
21216
|
/** Date and time at which Seam created the error. */
|
|
21082
21217
|
created_at: string;
|
|
21218
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
21083
21219
|
message: string;
|
|
21220
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
21084
21221
|
is_connected_account_error?: boolean | undefined;
|
|
21222
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
21085
21223
|
is_bridge_error?: boolean | undefined;
|
|
21086
21224
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
21087
21225
|
error_code: 'bridge_disconnected';
|
|
@@ -21258,7 +21396,7 @@ export interface Routes {
|
|
|
21258
21396
|
/** Array of device types for which you want to list devices. */
|
|
21259
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;
|
|
21260
21398
|
/** Manufacturer for which you want to list devices. */
|
|
21261
|
-
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;
|
|
21262
21400
|
/** Array of device IDs for which you want to list devices. */
|
|
21263
21401
|
device_ids?: string[] | undefined;
|
|
21264
21402
|
/** Numerical limit on the number of devices to return. */
|
|
@@ -21382,16 +21520,22 @@ export interface Routes {
|
|
|
21382
21520
|
} | {
|
|
21383
21521
|
/** Date and time at which Seam created the error. */
|
|
21384
21522
|
created_at: string;
|
|
21523
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
21385
21524
|
message: string;
|
|
21525
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
21386
21526
|
is_connected_account_error?: boolean | undefined;
|
|
21527
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
21387
21528
|
is_bridge_error?: boolean | undefined;
|
|
21388
21529
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
21389
21530
|
error_code: 'invalid_credentials';
|
|
21390
21531
|
} | {
|
|
21391
21532
|
/** Date and time at which Seam created the error. */
|
|
21392
21533
|
created_at: string;
|
|
21534
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
21393
21535
|
message: string;
|
|
21536
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
21394
21537
|
is_connected_account_error?: boolean | undefined;
|
|
21538
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
21395
21539
|
is_bridge_error?: boolean | undefined;
|
|
21396
21540
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
21397
21541
|
error_code: 'bridge_disconnected';
|
|
@@ -25000,16 +25144,22 @@ export interface Routes {
|
|
|
25000
25144
|
} | {
|
|
25001
25145
|
/** Date and time at which Seam created the error. */
|
|
25002
25146
|
created_at: string;
|
|
25147
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
25003
25148
|
message: string;
|
|
25149
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
25004
25150
|
is_connected_account_error?: boolean | undefined;
|
|
25151
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
25005
25152
|
is_bridge_error?: boolean | undefined;
|
|
25006
25153
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
25007
25154
|
error_code: 'invalid_credentials';
|
|
25008
25155
|
} | {
|
|
25009
25156
|
/** Date and time at which Seam created the error. */
|
|
25010
25157
|
created_at: string;
|
|
25158
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
25011
25159
|
message: string;
|
|
25160
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
25012
25161
|
is_connected_account_error?: boolean | undefined;
|
|
25162
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
25013
25163
|
is_bridge_error?: boolean | undefined;
|
|
25014
25164
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
25015
25165
|
error_code: 'bridge_disconnected';
|
|
@@ -25755,16 +25905,22 @@ export interface Routes {
|
|
|
25755
25905
|
} | {
|
|
25756
25906
|
/** Date and time at which Seam created the error. */
|
|
25757
25907
|
created_at: string;
|
|
25908
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
25758
25909
|
message: string;
|
|
25910
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
25759
25911
|
is_connected_account_error?: boolean | undefined;
|
|
25912
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
25760
25913
|
is_bridge_error?: boolean | undefined;
|
|
25761
25914
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
25762
25915
|
error_code: 'invalid_credentials';
|
|
25763
25916
|
} | {
|
|
25764
25917
|
/** Date and time at which Seam created the error. */
|
|
25765
25918
|
created_at: string;
|
|
25919
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
25766
25920
|
message: string;
|
|
25921
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
25767
25922
|
is_connected_account_error?: boolean | undefined;
|
|
25923
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
25768
25924
|
is_bridge_error?: boolean | undefined;
|
|
25769
25925
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
25770
25926
|
error_code: 'bridge_disconnected';
|
|
@@ -25894,7 +26050,7 @@ export interface Routes {
|
|
|
25894
26050
|
/** Array of device types by which to filter devices. */
|
|
25895
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;
|
|
25896
26052
|
/** Manufacturer by which to filter devices. */
|
|
25897
|
-
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;
|
|
25898
26054
|
/** Array of device IDs for which you want to list devices. */
|
|
25899
26055
|
device_ids?: string[] | undefined;
|
|
25900
26056
|
/** Numerical limit on the number of devices to return. */
|
|
@@ -26551,16 +26707,22 @@ export interface Routes {
|
|
|
26551
26707
|
} | {
|
|
26552
26708
|
/** Date and time at which Seam created the error. */
|
|
26553
26709
|
created_at: string;
|
|
26710
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
26554
26711
|
message: string;
|
|
26712
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
26555
26713
|
is_connected_account_error?: boolean | undefined;
|
|
26714
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
26556
26715
|
is_bridge_error?: boolean | undefined;
|
|
26557
26716
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
26558
26717
|
error_code: 'invalid_credentials';
|
|
26559
26718
|
} | {
|
|
26560
26719
|
/** Date and time at which Seam created the error. */
|
|
26561
26720
|
created_at: string;
|
|
26721
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
26562
26722
|
message: string;
|
|
26723
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
26563
26724
|
is_connected_account_error?: boolean | undefined;
|
|
26725
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
26564
26726
|
is_bridge_error?: boolean | undefined;
|
|
26565
26727
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
26566
26728
|
error_code: 'bridge_disconnected';
|
|
@@ -27305,16 +27467,22 @@ export interface Routes {
|
|
|
27305
27467
|
} | {
|
|
27306
27468
|
/** Date and time at which Seam created the error. */
|
|
27307
27469
|
created_at: string;
|
|
27470
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
27308
27471
|
message: string;
|
|
27472
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
27309
27473
|
is_connected_account_error?: boolean | undefined;
|
|
27474
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
27310
27475
|
is_bridge_error?: boolean | undefined;
|
|
27311
27476
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
27312
27477
|
error_code: 'invalid_credentials';
|
|
27313
27478
|
} | {
|
|
27314
27479
|
/** Date and time at which Seam created the error. */
|
|
27315
27480
|
created_at: string;
|
|
27481
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
27316
27482
|
message: string;
|
|
27483
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
27317
27484
|
is_connected_account_error?: boolean | undefined;
|
|
27485
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
27318
27486
|
is_bridge_error?: boolean | undefined;
|
|
27319
27487
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
27320
27488
|
error_code: 'bridge_disconnected';
|
|
@@ -32599,16 +32767,22 @@ export interface Routes {
|
|
|
32599
32767
|
} | {
|
|
32600
32768
|
/** Date and time at which Seam created the error. */
|
|
32601
32769
|
created_at: string;
|
|
32770
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
32602
32771
|
message: string;
|
|
32772
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
32603
32773
|
is_connected_account_error?: boolean | undefined;
|
|
32774
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
32604
32775
|
is_bridge_error?: boolean | undefined;
|
|
32605
32776
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
32606
32777
|
error_code: 'invalid_credentials';
|
|
32607
32778
|
} | {
|
|
32608
32779
|
/** Date and time at which Seam created the error. */
|
|
32609
32780
|
created_at: string;
|
|
32781
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
32610
32782
|
message: string;
|
|
32783
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
32611
32784
|
is_connected_account_error?: boolean | undefined;
|
|
32785
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
32612
32786
|
is_bridge_error?: boolean | undefined;
|
|
32613
32787
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
32614
32788
|
error_code: 'bridge_disconnected';
|
|
@@ -33353,16 +33527,22 @@ export interface Routes {
|
|
|
33353
33527
|
} | {
|
|
33354
33528
|
/** Date and time at which Seam created the error. */
|
|
33355
33529
|
created_at: string;
|
|
33530
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
33356
33531
|
message: string;
|
|
33532
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
33357
33533
|
is_connected_account_error?: boolean | undefined;
|
|
33534
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
33358
33535
|
is_bridge_error?: boolean | undefined;
|
|
33359
33536
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
33360
33537
|
error_code: 'invalid_credentials';
|
|
33361
33538
|
} | {
|
|
33362
33539
|
/** Date and time at which Seam created the error. */
|
|
33363
33540
|
created_at: string;
|
|
33541
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
33364
33542
|
message: string;
|
|
33543
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
33365
33544
|
is_connected_account_error?: boolean | undefined;
|
|
33545
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
33366
33546
|
is_bridge_error?: boolean | undefined;
|
|
33367
33547
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
33368
33548
|
error_code: 'bridge_disconnected';
|
|
@@ -41819,16 +41999,22 @@ export interface Routes {
|
|
|
41819
41999
|
} | {
|
|
41820
42000
|
/** Date and time at which Seam created the error. */
|
|
41821
42001
|
created_at: string;
|
|
42002
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
41822
42003
|
message: string;
|
|
42004
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
41823
42005
|
is_connected_account_error?: boolean | undefined;
|
|
42006
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
41824
42007
|
is_bridge_error?: boolean | undefined;
|
|
41825
42008
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
41826
42009
|
error_code: 'invalid_credentials';
|
|
41827
42010
|
} | {
|
|
41828
42011
|
/** Date and time at which Seam created the error. */
|
|
41829
42012
|
created_at: string;
|
|
42013
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
41830
42014
|
message: string;
|
|
42015
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
41831
42016
|
is_connected_account_error?: boolean | undefined;
|
|
42017
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
41832
42018
|
is_bridge_error?: boolean | undefined;
|
|
41833
42019
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
41834
42020
|
error_code: 'bridge_disconnected';
|
|
@@ -44206,7 +44392,7 @@ export interface Routes {
|
|
|
44206
44392
|
/** Array of device types by which to filter thermostat devices. */
|
|
44207
44393
|
device_types?: Array<'ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat'> | undefined;
|
|
44208
44394
|
/** Manufacturer by which to filter thermostat devices. */
|
|
44209
|
-
manufacturer?: ('ecobee' | 'honeywell_resideo' | 'nest' | 'tado' | 'sensi') | undefined;
|
|
44395
|
+
manufacturer?: ('ecobee' | 'honeywell_resideo' | 'nest' | 'tado' | 'sensi' | 'smartthings') | undefined;
|
|
44210
44396
|
/** Array of device IDs for which you want to list devices. */
|
|
44211
44397
|
device_ids?: string[] | undefined;
|
|
44212
44398
|
/** Numerical limit on the number of devices to return. */
|
|
@@ -44863,16 +45049,22 @@ export interface Routes {
|
|
|
44863
45049
|
} | {
|
|
44864
45050
|
/** Date and time at which Seam created the error. */
|
|
44865
45051
|
created_at: string;
|
|
45052
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
44866
45053
|
message: string;
|
|
45054
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
44867
45055
|
is_connected_account_error?: boolean | undefined;
|
|
45056
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
44868
45057
|
is_bridge_error?: boolean | undefined;
|
|
44869
45058
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
44870
45059
|
error_code: 'invalid_credentials';
|
|
44871
45060
|
} | {
|
|
44872
45061
|
/** Date and time at which Seam created the error. */
|
|
44873
45062
|
created_at: string;
|
|
45063
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
44874
45064
|
message: string;
|
|
45065
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
44875
45066
|
is_connected_account_error?: boolean | undefined;
|
|
45067
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
44876
45068
|
is_bridge_error?: boolean | undefined;
|
|
44877
45069
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
44878
45070
|
error_code: 'bridge_disconnected';
|
|
@@ -45617,16 +45809,22 @@ export interface Routes {
|
|
|
45617
45809
|
} | {
|
|
45618
45810
|
/** Date and time at which Seam created the error. */
|
|
45619
45811
|
created_at: string;
|
|
45812
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
45620
45813
|
message: string;
|
|
45814
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
45621
45815
|
is_connected_account_error?: boolean | undefined;
|
|
45816
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
45622
45817
|
is_bridge_error?: boolean | undefined;
|
|
45623
45818
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
45624
45819
|
error_code: 'invalid_credentials';
|
|
45625
45820
|
} | {
|
|
45626
45821
|
/** Date and time at which Seam created the error. */
|
|
45627
45822
|
created_at: string;
|
|
45823
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
45628
45824
|
message: string;
|
|
45825
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
45629
45826
|
is_connected_account_error?: boolean | undefined;
|
|
45827
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
45630
45828
|
is_bridge_error?: boolean | undefined;
|
|
45631
45829
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
45632
45830
|
error_code: 'bridge_disconnected';
|
|
@@ -51910,16 +52108,22 @@ export interface Routes {
|
|
|
51910
52108
|
} | {
|
|
51911
52109
|
/** Date and time at which Seam created the error. */
|
|
51912
52110
|
created_at: string;
|
|
52111
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
51913
52112
|
message: string;
|
|
52113
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
51914
52114
|
is_connected_account_error?: boolean | undefined;
|
|
52115
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
51915
52116
|
is_bridge_error?: boolean | undefined;
|
|
51916
52117
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
51917
52118
|
error_code: 'invalid_credentials';
|
|
51918
52119
|
} | {
|
|
51919
52120
|
/** Date and time at which Seam created the error. */
|
|
51920
52121
|
created_at: string;
|
|
52122
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
51921
52123
|
message: string;
|
|
52124
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
51922
52125
|
is_connected_account_error?: boolean | undefined;
|
|
52126
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
51923
52127
|
is_bridge_error?: boolean | undefined;
|
|
51924
52128
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
51925
52129
|
error_code: 'bridge_disconnected';
|
|
@@ -52666,16 +52870,22 @@ export interface Routes {
|
|
|
52666
52870
|
} | {
|
|
52667
52871
|
/** Date and time at which Seam created the error. */
|
|
52668
52872
|
created_at: string;
|
|
52873
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
52669
52874
|
message: string;
|
|
52875
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
52670
52876
|
is_connected_account_error?: boolean | undefined;
|
|
52877
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
52671
52878
|
is_bridge_error?: boolean | undefined;
|
|
52672
52879
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
52673
52880
|
error_code: 'invalid_credentials';
|
|
52674
52881
|
} | {
|
|
52675
52882
|
/** Date and time at which Seam created the error. */
|
|
52676
52883
|
created_at: string;
|
|
52884
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
52677
52885
|
message: string;
|
|
52886
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
52678
52887
|
is_connected_account_error?: boolean | undefined;
|
|
52888
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
52679
52889
|
is_bridge_error?: boolean | undefined;
|
|
52680
52890
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
52681
52891
|
error_code: 'bridge_disconnected';
|