@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.
@@ -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
@@ -1358,13 +1352,7 @@ export interface Routes {
1358
1352
  access_code_id: string
1359
1353
  /** Unique identifier for the device associated with the access code. */
1360
1354
  device_id: string
1361
- /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
1362
-
1363
- 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`.
1364
-
1365
- 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.
1366
-
1367
- 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). */
1355
+ /** 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). */
1368
1356
  name: string | null
1369
1357
  /** Code used for access. Typically, a numeric or alphanumeric string. */
1370
1358
  code: string | null
@@ -1718,8 +1706,11 @@ export interface Routes {
1718
1706
  | {
1719
1707
  /** Date and time at which Seam created the error. */
1720
1708
  created_at: string
1709
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1721
1710
  message: string
1711
+ /** Indicates whether the error is related specifically to the connected account. */
1722
1712
  is_connected_account_error?: boolean | undefined
1713
+ /** Indicates whether the error is related to Seam Bridge. */
1723
1714
  is_bridge_error?: boolean | undefined
1724
1715
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1725
1716
  error_code: 'invalid_credentials'
@@ -1727,8 +1718,11 @@ export interface Routes {
1727
1718
  | {
1728
1719
  /** Date and time at which Seam created the error. */
1729
1720
  created_at: string
1721
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1730
1722
  message: string
1723
+ /** Indicates whether the error is related specifically to the connected account. */
1731
1724
  is_connected_account_error?: boolean | undefined
1725
+ /** Indicates whether the error is related to Seam Bridge. */
1732
1726
  is_bridge_error?: boolean | undefined
1733
1727
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1734
1728
  error_code: 'bridge_disconnected'
@@ -1839,7 +1833,7 @@ export interface Routes {
1839
1833
  starts_at?: (string | null) | undefined
1840
1834
  /** Date and time after which the time-bound access code becomes inactive. */
1841
1835
  ends_at?: (string | null) | undefined
1842
- /** 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. */
1836
+ /** 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). */
1843
1837
  status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown'
1844
1838
  /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
1845
1839
  is_backup_access_code_available: boolean
@@ -1867,13 +1861,7 @@ export interface Routes {
1867
1861
  behavior_when_code_cannot_be_shared?: 'throw' | 'create_random_code'
1868
1862
  /** 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. */
1869
1863
  preferred_code_length?: number | undefined
1870
- /** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
1871
-
1872
- 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`.
1873
-
1874
- 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.
1875
-
1876
- 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). */
1864
+ /** 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). */
1877
1865
  name?: string | undefined
1878
1866
  /** 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. */
1879
1867
  starts_at?: string | undefined
@@ -1914,13 +1902,7 @@ export interface Routes {
1914
1902
  access_code_id: string
1915
1903
  /** Unique identifier for the device associated with the access code. */
1916
1904
  device_id: string
1917
- /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
1918
-
1919
- 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`.
1920
-
1921
- 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.
1922
-
1923
- 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). */
1905
+ /** 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). */
1924
1906
  name: string | null
1925
1907
  /** Code used for access. Typically, a numeric or alphanumeric string. */
1926
1908
  code: string | null
@@ -2274,8 +2256,11 @@ export interface Routes {
2274
2256
  | {
2275
2257
  /** Date and time at which Seam created the error. */
2276
2258
  created_at: string
2259
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
2277
2260
  message: string
2261
+ /** Indicates whether the error is related specifically to the connected account. */
2278
2262
  is_connected_account_error?: boolean | undefined
2263
+ /** Indicates whether the error is related to Seam Bridge. */
2279
2264
  is_bridge_error?: boolean | undefined
2280
2265
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
2281
2266
  error_code: 'invalid_credentials'
@@ -2283,8 +2268,11 @@ export interface Routes {
2283
2268
  | {
2284
2269
  /** Date and time at which Seam created the error. */
2285
2270
  created_at: string
2271
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
2286
2272
  message: string
2273
+ /** Indicates whether the error is related specifically to the connected account. */
2287
2274
  is_connected_account_error?: boolean | undefined
2275
+ /** Indicates whether the error is related to Seam Bridge. */
2288
2276
  is_bridge_error?: boolean | undefined
2289
2277
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
2290
2278
  error_code: 'bridge_disconnected'
@@ -2395,7 +2383,7 @@ export interface Routes {
2395
2383
  starts_at?: (string | null) | undefined
2396
2384
  /** Date and time after which the time-bound access code becomes inactive. */
2397
2385
  ends_at?: (string | null) | undefined
2398
- /** 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. */
2386
+ /** 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). */
2399
2387
  status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown'
2400
2388
  /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
2401
2389
  is_backup_access_code_available: boolean
@@ -3773,13 +3761,7 @@ export interface Routes {
3773
3761
  access_code_id: string
3774
3762
  /** Unique identifier for the device associated with the access code. */
3775
3763
  device_id: string
3776
- /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
3777
-
3778
- 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`.
3779
-
3780
- 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.
3781
-
3782
- 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). */
3764
+ /** 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). */
3783
3765
  name: string | null
3784
3766
  /** Code used for access. Typically, a numeric or alphanumeric string. */
3785
3767
  code: string | null
@@ -4133,8 +4115,11 @@ export interface Routes {
4133
4115
  | {
4134
4116
  /** Date and time at which Seam created the error. */
4135
4117
  created_at: string
4118
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4136
4119
  message: string
4120
+ /** Indicates whether the error is related specifically to the connected account. */
4137
4121
  is_connected_account_error?: boolean | undefined
4122
+ /** Indicates whether the error is related to Seam Bridge. */
4138
4123
  is_bridge_error?: boolean | undefined
4139
4124
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4140
4125
  error_code: 'invalid_credentials'
@@ -4142,8 +4127,11 @@ export interface Routes {
4142
4127
  | {
4143
4128
  /** Date and time at which Seam created the error. */
4144
4129
  created_at: string
4130
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4145
4131
  message: string
4132
+ /** Indicates whether the error is related specifically to the connected account. */
4146
4133
  is_connected_account_error?: boolean | undefined
4134
+ /** Indicates whether the error is related to Seam Bridge. */
4147
4135
  is_bridge_error?: boolean | undefined
4148
4136
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4149
4137
  error_code: 'bridge_disconnected'
@@ -4254,7 +4242,7 @@ export interface Routes {
4254
4242
  starts_at?: (string | null) | undefined
4255
4243
  /** Date and time after which the time-bound access code becomes inactive. */
4256
4244
  ends_at?: (string | null) | undefined
4257
- /** 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. */
4245
+ /** 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). */
4258
4246
  status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown'
4259
4247
  /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
4260
4248
  is_backup_access_code_available: boolean
@@ -4303,13 +4291,7 @@ export interface Routes {
4303
4291
  access_code_id: string
4304
4292
  /** Unique identifier for the device associated with the access code. */
4305
4293
  device_id: string
4306
- /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
4307
-
4308
- 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`.
4309
-
4310
- 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.
4311
-
4312
- 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). */
4294
+ /** 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). */
4313
4295
  name: string | null
4314
4296
  /** Code used for access. Typically, a numeric or alphanumeric string. */
4315
4297
  code: string | null
@@ -4663,8 +4645,11 @@ export interface Routes {
4663
4645
  | {
4664
4646
  /** Date and time at which Seam created the error. */
4665
4647
  created_at: string
4648
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4666
4649
  message: string
4650
+ /** Indicates whether the error is related specifically to the connected account. */
4667
4651
  is_connected_account_error?: boolean | undefined
4652
+ /** Indicates whether the error is related to Seam Bridge. */
4668
4653
  is_bridge_error?: boolean | undefined
4669
4654
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4670
4655
  error_code: 'invalid_credentials'
@@ -4672,8 +4657,11 @@ export interface Routes {
4672
4657
  | {
4673
4658
  /** Date and time at which Seam created the error. */
4674
4659
  created_at: string
4660
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4675
4661
  message: string
4662
+ /** Indicates whether the error is related specifically to the connected account. */
4676
4663
  is_connected_account_error?: boolean | undefined
4664
+ /** Indicates whether the error is related to Seam Bridge. */
4677
4665
  is_bridge_error?: boolean | undefined
4678
4666
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4679
4667
  error_code: 'bridge_disconnected'
@@ -4784,7 +4772,7 @@ export interface Routes {
4784
4772
  starts_at?: (string | null) | undefined
4785
4773
  /** Date and time after which the time-bound access code becomes inactive. */
4786
4774
  ends_at?: (string | null) | undefined
4787
- /** 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. */
4775
+ /** 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). */
4788
4776
  status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown'
4789
4777
  /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
4790
4778
  is_backup_access_code_available: boolean
@@ -4841,13 +4829,7 @@ export interface Routes {
4841
4829
  access_code_id: string
4842
4830
  /** Unique identifier for the device associated with the access code. */
4843
4831
  device_id: string
4844
- /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
4845
-
4846
- 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`.
4847
-
4848
- 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.
4849
-
4850
- 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). */
4832
+ /** 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). */
4851
4833
  name: string | null
4852
4834
  /** Code used for access. Typically, a numeric or alphanumeric string. */
4853
4835
  code: string | null
@@ -5201,8 +5183,11 @@ export interface Routes {
5201
5183
  | {
5202
5184
  /** Date and time at which Seam created the error. */
5203
5185
  created_at: string
5186
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5204
5187
  message: string
5188
+ /** Indicates whether the error is related specifically to the connected account. */
5205
5189
  is_connected_account_error?: boolean | undefined
5190
+ /** Indicates whether the error is related to Seam Bridge. */
5206
5191
  is_bridge_error?: boolean | undefined
5207
5192
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5208
5193
  error_code: 'invalid_credentials'
@@ -5210,8 +5195,11 @@ export interface Routes {
5210
5195
  | {
5211
5196
  /** Date and time at which Seam created the error. */
5212
5197
  created_at: string
5198
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5213
5199
  message: string
5200
+ /** Indicates whether the error is related specifically to the connected account. */
5214
5201
  is_connected_account_error?: boolean | undefined
5202
+ /** Indicates whether the error is related to Seam Bridge. */
5215
5203
  is_bridge_error?: boolean | undefined
5216
5204
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5217
5205
  error_code: 'bridge_disconnected'
@@ -5322,7 +5310,7 @@ export interface Routes {
5322
5310
  starts_at?: (string | null) | undefined
5323
5311
  /** Date and time after which the time-bound access code becomes inactive. */
5324
5312
  ends_at?: (string | null) | undefined
5325
- /** 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. */
5313
+ /** 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). */
5326
5314
  status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown'
5327
5315
  /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
5328
5316
  is_backup_access_code_available: boolean
@@ -5357,13 +5345,7 @@ export interface Routes {
5357
5345
  access_code_id: string
5358
5346
  /** Unique identifier for the device associated with the access code. */
5359
5347
  device_id: string
5360
- /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
5361
-
5362
- 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`.
5363
-
5364
- 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.
5365
-
5366
- 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). */
5348
+ /** 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). */
5367
5349
  name: string | null
5368
5350
  /** Code used for access. Typically, a numeric or alphanumeric string. */
5369
5351
  code: string | null
@@ -5717,8 +5699,11 @@ export interface Routes {
5717
5699
  | {
5718
5700
  /** Date and time at which Seam created the error. */
5719
5701
  created_at: string
5702
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5720
5703
  message: string
5704
+ /** Indicates whether the error is related specifically to the connected account. */
5721
5705
  is_connected_account_error?: boolean | undefined
5706
+ /** Indicates whether the error is related to Seam Bridge. */
5722
5707
  is_bridge_error?: boolean | undefined
5723
5708
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5724
5709
  error_code: 'invalid_credentials'
@@ -5726,8 +5711,11 @@ export interface Routes {
5726
5711
  | {
5727
5712
  /** Date and time at which Seam created the error. */
5728
5713
  created_at: string
5714
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5729
5715
  message: string
5716
+ /** Indicates whether the error is related specifically to the connected account. */
5730
5717
  is_connected_account_error?: boolean | undefined
5718
+ /** Indicates whether the error is related to Seam Bridge. */
5731
5719
  is_bridge_error?: boolean | undefined
5732
5720
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5733
5721
  error_code: 'bridge_disconnected'
@@ -5838,7 +5826,7 @@ export interface Routes {
5838
5826
  starts_at?: (string | null) | undefined
5839
5827
  /** Date and time after which the time-bound access code becomes inactive. */
5840
5828
  ends_at?: (string | null) | undefined
5841
- /** 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. */
5829
+ /** 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). */
5842
5830
  status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown'
5843
5831
  /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
5844
5832
  is_backup_access_code_available: boolean
@@ -5906,13 +5894,7 @@ export interface Routes {
5906
5894
  access_code_id: string
5907
5895
  /** Unique identifier for the device associated with the access code. */
5908
5896
  device_id: string
5909
- /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
5910
-
5911
- 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`.
5912
-
5913
- 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.
5914
-
5915
- 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). */
5897
+ /** 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). */
5916
5898
  name: string | null
5917
5899
  /** Code used for access. Typically, a numeric or alphanumeric string. */
5918
5900
  code: string | null
@@ -6266,8 +6248,11 @@ export interface Routes {
6266
6248
  | {
6267
6249
  /** Date and time at which Seam created the error. */
6268
6250
  created_at: string
6251
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
6269
6252
  message: string
6253
+ /** Indicates whether the error is related specifically to the connected account. */
6270
6254
  is_connected_account_error?: boolean | undefined
6255
+ /** Indicates whether the error is related to Seam Bridge. */
6271
6256
  is_bridge_error?: boolean | undefined
6272
6257
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6273
6258
  error_code: 'invalid_credentials'
@@ -6275,8 +6260,11 @@ export interface Routes {
6275
6260
  | {
6276
6261
  /** Date and time at which Seam created the error. */
6277
6262
  created_at: string
6263
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
6278
6264
  message: string
6265
+ /** Indicates whether the error is related specifically to the connected account. */
6279
6266
  is_connected_account_error?: boolean | undefined
6267
+ /** Indicates whether the error is related to Seam Bridge. */
6280
6268
  is_bridge_error?: boolean | undefined
6281
6269
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6282
6270
  error_code: 'bridge_disconnected'
@@ -7752,13 +7740,7 @@ export interface Routes {
7752
7740
  access_code_id: string
7753
7741
  /** Unique identifier for the device associated with the access code. */
7754
7742
  device_id: string
7755
- /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
7756
-
7757
- 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`.
7758
-
7759
- 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.
7760
-
7761
- 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). */
7743
+ /** 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). */
7762
7744
  name: string | null
7763
7745
  /** Code used for access. Typically, a numeric or alphanumeric string. */
7764
7746
  code: string | null
@@ -8112,8 +8094,11 @@ export interface Routes {
8112
8094
  | {
8113
8095
  /** Date and time at which Seam created the error. */
8114
8096
  created_at: string
8097
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
8115
8098
  message: string
8099
+ /** Indicates whether the error is related specifically to the connected account. */
8116
8100
  is_connected_account_error?: boolean | undefined
8101
+ /** Indicates whether the error is related to Seam Bridge. */
8117
8102
  is_bridge_error?: boolean | undefined
8118
8103
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
8119
8104
  error_code: 'invalid_credentials'
@@ -8121,8 +8106,11 @@ export interface Routes {
8121
8106
  | {
8122
8107
  /** Date and time at which Seam created the error. */
8123
8108
  created_at: string
8109
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
8124
8110
  message: string
8111
+ /** Indicates whether the error is related specifically to the connected account. */
8125
8112
  is_connected_account_error?: boolean | undefined
8113
+ /** Indicates whether the error is related to Seam Bridge. */
8126
8114
  is_bridge_error?: boolean | undefined
8127
8115
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
8128
8116
  error_code: 'bridge_disconnected'
@@ -8258,13 +8246,7 @@ export interface Routes {
8258
8246
  access_code_id: string
8259
8247
  /** Unique identifier for the device associated with the access code. */
8260
8248
  device_id: string
8261
- /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
8262
-
8263
- 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`.
8264
-
8265
- 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.
8266
-
8267
- 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). */
8249
+ /** 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). */
8268
8250
  name: string | null
8269
8251
  /** Code used for access. Typically, a numeric or alphanumeric string. */
8270
8252
  code: string | null
@@ -8618,8 +8600,11 @@ export interface Routes {
8618
8600
  | {
8619
8601
  /** Date and time at which Seam created the error. */
8620
8602
  created_at: string
8603
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
8621
8604
  message: string
8605
+ /** Indicates whether the error is related specifically to the connected account. */
8622
8606
  is_connected_account_error?: boolean | undefined
8607
+ /** Indicates whether the error is related to Seam Bridge. */
8623
8608
  is_bridge_error?: boolean | undefined
8624
8609
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
8625
8610
  error_code: 'invalid_credentials'
@@ -8627,8 +8612,11 @@ export interface Routes {
8627
8612
  | {
8628
8613
  /** Date and time at which Seam created the error. */
8629
8614
  created_at: string
8615
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
8630
8616
  message: string
8617
+ /** Indicates whether the error is related specifically to the connected account. */
8631
8618
  is_connected_account_error?: boolean | undefined
8619
+ /** Indicates whether the error is related to Seam Bridge. */
8632
8620
  is_bridge_error?: boolean | undefined
8633
8621
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
8634
8622
  error_code: 'bridge_disconnected'
@@ -8768,13 +8756,7 @@ export interface Routes {
8768
8756
  method: 'POST' | 'PATCH' | 'PUT'
8769
8757
  queryParams: {}
8770
8758
  jsonBody: {
8771
- /** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
8772
-
8773
- 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`.
8774
-
8775
- 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.
8776
-
8777
- 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). */
8759
+ /** 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). */
8778
8760
  name?: string | undefined
8779
8761
  /** 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. */
8780
8762
  starts_at?: string | undefined
@@ -10117,13 +10099,7 @@ export interface Routes {
10117
10099
  ends_at?: string | undefined
10118
10100
  /** 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. */
10119
10101
  starts_at?: string | undefined
10120
- /** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
10121
-
10122
- 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`.
10123
-
10124
- 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.
10125
-
10126
- 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). */
10102
+ /** 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). */
10127
10103
  name?: string | undefined
10128
10104
  /** Key that links the group of access codes, assigned on creation by `/access_codes/create_multiple`. */
10129
10105
  common_code_key: string
@@ -17734,8 +17710,12 @@ export interface Routes {
17734
17710
  queryParams: {}
17735
17711
  jsonBody: {}
17736
17712
  commonParams: {
17737
- /** ID of the access system user that you want to delete. */
17738
- acs_user_id: string
17713
+ /** ID of the access system user that you want to delete. You must provide either acs_user_id or user_identity_id */
17714
+ acs_user_id?: string | undefined
17715
+ /** 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. */
17716
+ user_identity_id?: string | undefined
17717
+ /** ID of the access system that you want to delete. You must provide acs_system_id with user_identity_id. */
17718
+ acs_system_id?: string | undefined
17739
17719
  }
17740
17720
  formData: {}
17741
17721
  jsonResponse: {}
@@ -17746,8 +17726,12 @@ export interface Routes {
17746
17726
  queryParams: {}
17747
17727
  jsonBody: {}
17748
17728
  commonParams: {
17749
- /** ID of the access system user that you want to get. */
17750
- acs_user_id: string
17729
+ /** ID of the access system user that you want to get. You can only provide acs_user_id or user_identity_id. */
17730
+ acs_user_id?: string | undefined
17731
+ /** ID of the user identity that you want to get. You can only provide acs_user_id or user_identity_id. */
17732
+ user_identity_id?: string | undefined
17733
+ /** ID of the access system that you want to get. You can only provide acs_user_id or user_identity_id. */
17734
+ acs_system_id?: string | undefined
17751
17735
  }
17752
17736
  formData: {}
17753
17737
  jsonResponse: {
@@ -18347,8 +18331,12 @@ export interface Routes {
18347
18331
  method: 'POST'
18348
18332
  queryParams: {}
18349
18333
  jsonBody: {
18350
- /** ID of the access system user for whom you want to revoke access. */
18351
- acs_user_id: string
18334
+ /** ID of the access system user for whom you want to revoke access. You can only provide acs_user_id or user_identity_id. */
18335
+ acs_user_id?: string | undefined
18336
+ /** ID of the user identity for whom you want to revoke access. You can only provide acs_user_id or user_identity_id. */
18337
+ user_identity_id?: string | undefined
18338
+ /** ID of the access system for which you want to revoke access. You can only provide acs_system_id with user_identity_id. */
18339
+ acs_system_id?: string | undefined
18352
18340
  }
18353
18341
  commonParams: {}
18354
18342
  formData: {}
@@ -18360,8 +18348,12 @@ export interface Routes {
18360
18348
  queryParams: {}
18361
18349
  jsonBody: {}
18362
18350
  commonParams: {
18363
- /** ID of the access system user that you want to suspend. */
18364
- acs_user_id: string
18351
+ /** 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. */
18352
+ acs_user_id?: string | undefined
18353
+ /** 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. */
18354
+ user_identity_id?: string | undefined
18355
+ /** 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. */
18356
+ acs_system_id?: string | undefined
18365
18357
  }
18366
18358
  formData: {}
18367
18359
  jsonResponse: {}
@@ -18837,8 +18829,12 @@ export interface Routes {
18837
18829
  queryParams: {}
18838
18830
  jsonBody: {}
18839
18831
  commonParams: {
18840
- /** ID of the access system user that you want to unsuspend. */
18841
- acs_user_id: string
18832
+ /** 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. */
18833
+ acs_user_id?: string | undefined
18834
+ /** 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. */
18835
+ user_identity_id?: string | undefined
18836
+ /** ID of the access system of the user that you want to unsuspend. You can only provide acs_system_id with user_identity_id. */
18837
+ acs_system_id?: string | undefined
18842
18838
  }
18843
18839
  formData: {}
18844
18840
  jsonResponse: {}
@@ -18857,8 +18853,12 @@ export interface Routes {
18857
18853
  ends_at: string
18858
18854
  } | null)
18859
18855
  | undefined
18860
- /** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
18861
- acs_user_id: string
18856
+ /** ID of the access system user that you want to update. You can only provide acs_user_id or user_identity_id. */
18857
+ acs_user_id?: string | undefined
18858
+ /** 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. */
18859
+ user_identity_id?: string | undefined
18860
+ /** ID of the access system that you want to update. You can only provide acs_system_id with user_identity_id. */
18861
+ acs_system_id?: string | undefined
18862
18862
  /** Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
18863
18863
  full_name?: string | undefined
18864
18864
  /**
@@ -22045,25 +22045,39 @@ export interface Routes {
22045
22045
  jsonResponse: {
22046
22046
  /** 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. */
22047
22047
  connected_account: {
22048
+ /** Unique identifier for the connected account. */
22048
22049
  connected_account_id?: string | undefined
22050
+ /** Date and time at which the connected account was created. */
22049
22051
  created_at?: string | undefined
22052
+ /** User identifier associated with the connected account. */
22050
22053
  user_identifier?:
22051
22054
  | {
22055
+ /** Username of the user identifier associated with the connected account. */
22052
22056
  username?: string | undefined
22057
+ /** API URL for the user identifier associated with the connected account. */
22053
22058
  api_url?: string | undefined
22059
+ /** Email address of the user identifier associated with the connected account. */
22054
22060
  email?: string | undefined
22061
+ /** Phone number of the user identifier associated with the connected account. */
22055
22062
  phone?: string | undefined
22063
+ /** Indicates whether the user identifier associated with the connected account is exclusive. */
22056
22064
  exclusive?: boolean | undefined
22057
22065
  }
22058
22066
  | undefined
22067
+ /** Type of connected account. */
22059
22068
  account_type?: string | undefined
22069
+ /** Display name for the connected account type. */
22060
22070
  account_type_display_name: string
22071
+ /** Errors associated with the connected account. */
22061
22072
  errors: Array<
22062
22073
  | {
22063
22074
  /** Date and time at which Seam created the error. */
22064
22075
  created_at: string
22076
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22065
22077
  message: string
22078
+ /** Indicates whether the error is related specifically to the connected account. */
22066
22079
  is_connected_account_error?: boolean | undefined
22080
+ /** Indicates whether the error is related to Seam Bridge. */
22067
22081
  is_bridge_error?: boolean | undefined
22068
22082
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22069
22083
  error_code: 'account_disconnected'
@@ -22071,8 +22085,11 @@ export interface Routes {
22071
22085
  | {
22072
22086
  /** Date and time at which Seam created the error. */
22073
22087
  created_at: string
22088
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22074
22089
  message: string
22090
+ /** Indicates whether the error is related specifically to the connected account. */
22075
22091
  is_connected_account_error?: boolean | undefined
22092
+ /** Indicates whether the error is related to Seam Bridge. */
22076
22093
  is_bridge_error?: boolean | undefined
22077
22094
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22078
22095
  error_code: 'invalid_credentials'
@@ -22080,8 +22097,11 @@ export interface Routes {
22080
22097
  | {
22081
22098
  /** Date and time at which Seam created the error. */
22082
22099
  created_at: string
22100
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22083
22101
  message: string
22102
+ /** Indicates whether the error is related specifically to the connected account. */
22084
22103
  is_connected_account_error?: boolean | undefined
22104
+ /** Indicates whether the error is related to Seam Bridge. */
22085
22105
  is_bridge_error?: boolean | undefined
22086
22106
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22087
22107
  error_code: 'bridge_disconnected'
@@ -22089,25 +22109,36 @@ export interface Routes {
22089
22109
  | {
22090
22110
  /** Date and time at which Seam created the error. */
22091
22111
  created_at: string
22112
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22092
22113
  message: string
22114
+ /** Indicates whether the error is related specifically to the connected account. */
22093
22115
  is_connected_account_error?: boolean | undefined
22116
+ /** Indicates whether the error is related to Seam Bridge. */
22094
22117
  is_bridge_error?: boolean | undefined
22095
22118
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22096
22119
  error_code: 'salto_ks_subscription_limit_exceeded'
22120
+ /** Salto KS metadata associated with the connected account that has an error. */
22097
22121
  salto_ks_metadata: {
22122
+ /** Salto sites associated with the connected account that has an error. */
22098
22123
  sites: Array<{
22124
+ /** ID of a Salto site associated with the connected account that has an error. */
22099
22125
  site_id: string
22126
+ /** Name of a Salto site associated with the connected account that has an error. */
22100
22127
  site_name: string
22128
+ /** Count of subscribed site users for a Salto site associated with the connected account that has an error. */
22101
22129
  subscribed_site_user_count: number
22130
+ /** Subscription limit of site users for a Salto site associated with the connected account that has an error. */
22102
22131
  site_user_subscription_limit: number
22103
22132
  }>
22104
22133
  }
22105
22134
  }
22106
22135
  >
22136
+ /** Warnings associated with the connected account. */
22107
22137
  warnings: Array<
22108
22138
  | {
22109
22139
  /** Date and time at which Seam created the warning. */
22110
22140
  created_at: string
22141
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
22111
22142
  message: string
22112
22143
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
22113
22144
  warning_code: 'scheduled_maintenance_window'
@@ -22115,6 +22146,7 @@ export interface Routes {
22115
22146
  | {
22116
22147
  /** Date and time at which Seam created the warning. */
22117
22148
  created_at: string
22149
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
22118
22150
  message: string
22119
22151
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
22120
22152
  warning_code: 'unknown_issue_with_connected_account'
@@ -22122,14 +22154,21 @@ export interface Routes {
22122
22154
  | {
22123
22155
  /** Date and time at which Seam created the warning. */
22124
22156
  created_at: string
22157
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
22125
22158
  message: string
22126
22159
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
22127
22160
  warning_code: 'salto_ks_subscription_limit_almost_reached'
22161
+ /** Salto KS metadata associated with the connected account that has a warning. */
22128
22162
  salto_ks_metadata: {
22163
+ /** Salto sites associated with the connected account that has a warning. */
22129
22164
  sites: Array<{
22165
+ /** ID of a Salto site associated with the connected account that has a warning. */
22130
22166
  site_id: string
22167
+ /** Name of a Salto site associated with the connected account that has a warning. */
22131
22168
  site_name: string
22169
+ /** Subscription limit of site users for a Salto site associated with the connected account that has a warning. */
22132
22170
  site_user_subscription_limit: number
22171
+ /** Count of subscribed site users for a Salto site associated with the connected account that has a warning. */
22133
22172
  subscribed_site_user_count: number
22134
22173
  }>
22135
22174
  }
@@ -22137,6 +22176,7 @@ export interface Routes {
22137
22176
  >
22138
22177
  /** 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. */
22139
22178
  custom_metadata: Record<string, string | boolean>
22179
+ /** 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. */
22140
22180
  automatically_manage_new_devices: boolean
22141
22181
  }
22142
22182
  }
@@ -22160,25 +22200,39 @@ export interface Routes {
22160
22200
  formData: {}
22161
22201
  jsonResponse: {
22162
22202
  connected_accounts: Array<{
22203
+ /** Unique identifier for the connected account. */
22163
22204
  connected_account_id?: string | undefined
22205
+ /** Date and time at which the connected account was created. */
22164
22206
  created_at?: string | undefined
22207
+ /** User identifier associated with the connected account. */
22165
22208
  user_identifier?:
22166
22209
  | {
22210
+ /** Username of the user identifier associated with the connected account. */
22167
22211
  username?: string | undefined
22212
+ /** API URL for the user identifier associated with the connected account. */
22168
22213
  api_url?: string | undefined
22214
+ /** Email address of the user identifier associated with the connected account. */
22169
22215
  email?: string | undefined
22216
+ /** Phone number of the user identifier associated with the connected account. */
22170
22217
  phone?: string | undefined
22218
+ /** Indicates whether the user identifier associated with the connected account is exclusive. */
22171
22219
  exclusive?: boolean | undefined
22172
22220
  }
22173
22221
  | undefined
22222
+ /** Type of connected account. */
22174
22223
  account_type?: string | undefined
22224
+ /** Display name for the connected account type. */
22175
22225
  account_type_display_name: string
22226
+ /** Errors associated with the connected account. */
22176
22227
  errors: Array<
22177
22228
  | {
22178
22229
  /** Date and time at which Seam created the error. */
22179
22230
  created_at: string
22231
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22180
22232
  message: string
22233
+ /** Indicates whether the error is related specifically to the connected account. */
22181
22234
  is_connected_account_error?: boolean | undefined
22235
+ /** Indicates whether the error is related to Seam Bridge. */
22182
22236
  is_bridge_error?: boolean | undefined
22183
22237
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22184
22238
  error_code: 'account_disconnected'
@@ -22186,8 +22240,11 @@ export interface Routes {
22186
22240
  | {
22187
22241
  /** Date and time at which Seam created the error. */
22188
22242
  created_at: string
22243
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22189
22244
  message: string
22245
+ /** Indicates whether the error is related specifically to the connected account. */
22190
22246
  is_connected_account_error?: boolean | undefined
22247
+ /** Indicates whether the error is related to Seam Bridge. */
22191
22248
  is_bridge_error?: boolean | undefined
22192
22249
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22193
22250
  error_code: 'invalid_credentials'
@@ -22195,8 +22252,11 @@ export interface Routes {
22195
22252
  | {
22196
22253
  /** Date and time at which Seam created the error. */
22197
22254
  created_at: string
22255
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22198
22256
  message: string
22257
+ /** Indicates whether the error is related specifically to the connected account. */
22199
22258
  is_connected_account_error?: boolean | undefined
22259
+ /** Indicates whether the error is related to Seam Bridge. */
22200
22260
  is_bridge_error?: boolean | undefined
22201
22261
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22202
22262
  error_code: 'bridge_disconnected'
@@ -22204,25 +22264,36 @@ export interface Routes {
22204
22264
  | {
22205
22265
  /** Date and time at which Seam created the error. */
22206
22266
  created_at: string
22267
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22207
22268
  message: string
22269
+ /** Indicates whether the error is related specifically to the connected account. */
22208
22270
  is_connected_account_error?: boolean | undefined
22271
+ /** Indicates whether the error is related to Seam Bridge. */
22209
22272
  is_bridge_error?: boolean | undefined
22210
22273
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22211
22274
  error_code: 'salto_ks_subscription_limit_exceeded'
22275
+ /** Salto KS metadata associated with the connected account that has an error. */
22212
22276
  salto_ks_metadata: {
22277
+ /** Salto sites associated with the connected account that has an error. */
22213
22278
  sites: Array<{
22279
+ /** ID of a Salto site associated with the connected account that has an error. */
22214
22280
  site_id: string
22281
+ /** Name of a Salto site associated with the connected account that has an error. */
22215
22282
  site_name: string
22283
+ /** Count of subscribed site users for a Salto site associated with the connected account that has an error. */
22216
22284
  subscribed_site_user_count: number
22285
+ /** Subscription limit of site users for a Salto site associated with the connected account that has an error. */
22217
22286
  site_user_subscription_limit: number
22218
22287
  }>
22219
22288
  }
22220
22289
  }
22221
22290
  >
22291
+ /** Warnings associated with the connected account. */
22222
22292
  warnings: Array<
22223
22293
  | {
22224
22294
  /** Date and time at which Seam created the warning. */
22225
22295
  created_at: string
22296
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
22226
22297
  message: string
22227
22298
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
22228
22299
  warning_code: 'scheduled_maintenance_window'
@@ -22230,6 +22301,7 @@ export interface Routes {
22230
22301
  | {
22231
22302
  /** Date and time at which Seam created the warning. */
22232
22303
  created_at: string
22304
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
22233
22305
  message: string
22234
22306
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
22235
22307
  warning_code: 'unknown_issue_with_connected_account'
@@ -22237,14 +22309,21 @@ export interface Routes {
22237
22309
  | {
22238
22310
  /** Date and time at which Seam created the warning. */
22239
22311
  created_at: string
22312
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
22240
22313
  message: string
22241
22314
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
22242
22315
  warning_code: 'salto_ks_subscription_limit_almost_reached'
22316
+ /** Salto KS metadata associated with the connected account that has a warning. */
22243
22317
  salto_ks_metadata: {
22318
+ /** Salto sites associated with the connected account that has a warning. */
22244
22319
  sites: Array<{
22320
+ /** ID of a Salto site associated with the connected account that has a warning. */
22245
22321
  site_id: string
22322
+ /** Name of a Salto site associated with the connected account that has a warning. */
22246
22323
  site_name: string
22324
+ /** Subscription limit of site users for a Salto site associated with the connected account that has a warning. */
22247
22325
  site_user_subscription_limit: number
22326
+ /** Count of subscribed site users for a Salto site associated with the connected account that has a warning. */
22248
22327
  subscribed_site_user_count: number
22249
22328
  }>
22250
22329
  }
@@ -22252,6 +22331,7 @@ export interface Routes {
22252
22331
  >
22253
22332
  /** 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. */
22254
22333
  custom_metadata: Record<string, string | boolean>
22334
+ /** 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. */
22255
22335
  automatically_manage_new_devices: boolean
22256
22336
  }>
22257
22337
  /** Information about the current page of results. */
@@ -22282,25 +22362,39 @@ export interface Routes {
22282
22362
  jsonResponse: {
22283
22363
  /** 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. */
22284
22364
  connected_account: {
22365
+ /** Unique identifier for the connected account. */
22285
22366
  connected_account_id?: string | undefined
22367
+ /** Date and time at which the connected account was created. */
22286
22368
  created_at?: string | undefined
22369
+ /** User identifier associated with the connected account. */
22287
22370
  user_identifier?:
22288
22371
  | {
22372
+ /** Username of the user identifier associated with the connected account. */
22289
22373
  username?: string | undefined
22374
+ /** API URL for the user identifier associated with the connected account. */
22290
22375
  api_url?: string | undefined
22376
+ /** Email address of the user identifier associated with the connected account. */
22291
22377
  email?: string | undefined
22378
+ /** Phone number of the user identifier associated with the connected account. */
22292
22379
  phone?: string | undefined
22380
+ /** Indicates whether the user identifier associated with the connected account is exclusive. */
22293
22381
  exclusive?: boolean | undefined
22294
22382
  }
22295
22383
  | undefined
22384
+ /** Type of connected account. */
22296
22385
  account_type?: string | undefined
22386
+ /** Display name for the connected account type. */
22297
22387
  account_type_display_name: string
22388
+ /** Errors associated with the connected account. */
22298
22389
  errors: Array<
22299
22390
  | {
22300
22391
  /** Date and time at which Seam created the error. */
22301
22392
  created_at: string
22393
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22302
22394
  message: string
22395
+ /** Indicates whether the error is related specifically to the connected account. */
22303
22396
  is_connected_account_error?: boolean | undefined
22397
+ /** Indicates whether the error is related to Seam Bridge. */
22304
22398
  is_bridge_error?: boolean | undefined
22305
22399
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22306
22400
  error_code: 'account_disconnected'
@@ -22308,8 +22402,11 @@ export interface Routes {
22308
22402
  | {
22309
22403
  /** Date and time at which Seam created the error. */
22310
22404
  created_at: string
22405
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22311
22406
  message: string
22407
+ /** Indicates whether the error is related specifically to the connected account. */
22312
22408
  is_connected_account_error?: boolean | undefined
22409
+ /** Indicates whether the error is related to Seam Bridge. */
22313
22410
  is_bridge_error?: boolean | undefined
22314
22411
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22315
22412
  error_code: 'invalid_credentials'
@@ -22317,8 +22414,11 @@ export interface Routes {
22317
22414
  | {
22318
22415
  /** Date and time at which Seam created the error. */
22319
22416
  created_at: string
22417
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22320
22418
  message: string
22419
+ /** Indicates whether the error is related specifically to the connected account. */
22321
22420
  is_connected_account_error?: boolean | undefined
22421
+ /** Indicates whether the error is related to Seam Bridge. */
22322
22422
  is_bridge_error?: boolean | undefined
22323
22423
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22324
22424
  error_code: 'bridge_disconnected'
@@ -22326,25 +22426,36 @@ export interface Routes {
22326
22426
  | {
22327
22427
  /** Date and time at which Seam created the error. */
22328
22428
  created_at: string
22429
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22329
22430
  message: string
22431
+ /** Indicates whether the error is related specifically to the connected account. */
22330
22432
  is_connected_account_error?: boolean | undefined
22433
+ /** Indicates whether the error is related to Seam Bridge. */
22331
22434
  is_bridge_error?: boolean | undefined
22332
22435
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22333
22436
  error_code: 'salto_ks_subscription_limit_exceeded'
22437
+ /** Salto KS metadata associated with the connected account that has an error. */
22334
22438
  salto_ks_metadata: {
22439
+ /** Salto sites associated with the connected account that has an error. */
22335
22440
  sites: Array<{
22441
+ /** ID of a Salto site associated with the connected account that has an error. */
22336
22442
  site_id: string
22443
+ /** Name of a Salto site associated with the connected account that has an error. */
22337
22444
  site_name: string
22445
+ /** Count of subscribed site users for a Salto site associated with the connected account that has an error. */
22338
22446
  subscribed_site_user_count: number
22447
+ /** Subscription limit of site users for a Salto site associated with the connected account that has an error. */
22339
22448
  site_user_subscription_limit: number
22340
22449
  }>
22341
22450
  }
22342
22451
  }
22343
22452
  >
22453
+ /** Warnings associated with the connected account. */
22344
22454
  warnings: Array<
22345
22455
  | {
22346
22456
  /** Date and time at which Seam created the warning. */
22347
22457
  created_at: string
22458
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
22348
22459
  message: string
22349
22460
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
22350
22461
  warning_code: 'scheduled_maintenance_window'
@@ -22352,6 +22463,7 @@ export interface Routes {
22352
22463
  | {
22353
22464
  /** Date and time at which Seam created the warning. */
22354
22465
  created_at: string
22466
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
22355
22467
  message: string
22356
22468
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
22357
22469
  warning_code: 'unknown_issue_with_connected_account'
@@ -22359,14 +22471,21 @@ export interface Routes {
22359
22471
  | {
22360
22472
  /** Date and time at which Seam created the warning. */
22361
22473
  created_at: string
22474
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
22362
22475
  message: string
22363
22476
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
22364
22477
  warning_code: 'salto_ks_subscription_limit_almost_reached'
22478
+ /** Salto KS metadata associated with the connected account that has a warning. */
22365
22479
  salto_ks_metadata: {
22480
+ /** Salto sites associated with the connected account that has a warning. */
22366
22481
  sites: Array<{
22482
+ /** ID of a Salto site associated with the connected account that has a warning. */
22367
22483
  site_id: string
22484
+ /** Name of a Salto site associated with the connected account that has a warning. */
22368
22485
  site_name: string
22486
+ /** Subscription limit of site users for a Salto site associated with the connected account that has a warning. */
22369
22487
  site_user_subscription_limit: number
22488
+ /** Count of subscribed site users for a Salto site associated with the connected account that has a warning. */
22370
22489
  subscribed_site_user_count: number
22371
22490
  }>
22372
22491
  }
@@ -22374,6 +22493,7 @@ export interface Routes {
22374
22493
  >
22375
22494
  /** 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. */
22376
22495
  custom_metadata: Record<string, string | boolean>
22496
+ /** 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. */
22377
22497
  automatically_manage_new_devices: boolean
22378
22498
  }
22379
22499
  }
@@ -23254,8 +23374,11 @@ export interface Routes {
23254
23374
  | {
23255
23375
  /** Date and time at which Seam created the error. */
23256
23376
  created_at: string
23377
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23257
23378
  message: string
23379
+ /** Indicates whether the error is related specifically to the connected account. */
23258
23380
  is_connected_account_error?: boolean | undefined
23381
+ /** Indicates whether the error is related to Seam Bridge. */
23259
23382
  is_bridge_error?: boolean | undefined
23260
23383
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
23261
23384
  error_code: 'invalid_credentials'
@@ -23263,8 +23386,11 @@ export interface Routes {
23263
23386
  | {
23264
23387
  /** Date and time at which Seam created the error. */
23265
23388
  created_at: string
23389
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23266
23390
  message: string
23391
+ /** Indicates whether the error is related specifically to the connected account. */
23267
23392
  is_connected_account_error?: boolean | undefined
23393
+ /** Indicates whether the error is related to Seam Bridge. */
23268
23394
  is_bridge_error?: boolean | undefined
23269
23395
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
23270
23396
  error_code: 'bridge_disconnected'
@@ -23526,7 +23652,6 @@ export interface Routes {
23526
23652
  | 'igloohome'
23527
23653
  | 'hubitat'
23528
23654
  | 'controlbyweb'
23529
- | 'smartthings'
23530
23655
  | 'dormakaba_oracode'
23531
23656
  | 'tedee'
23532
23657
  | 'akiles'
@@ -23537,6 +23662,7 @@ export interface Routes {
23537
23662
  | 'noiseaware'
23538
23663
  | 'tado'
23539
23664
  | 'sensi'
23665
+ | 'smartthings'
23540
23666
  )
23541
23667
  | undefined
23542
23668
  /** Array of device IDs for which you want to list devices. */
@@ -24438,8 +24564,11 @@ export interface Routes {
24438
24564
  | {
24439
24565
  /** Date and time at which Seam created the error. */
24440
24566
  created_at: string
24567
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
24441
24568
  message: string
24569
+ /** Indicates whether the error is related specifically to the connected account. */
24442
24570
  is_connected_account_error?: boolean | undefined
24571
+ /** Indicates whether the error is related to Seam Bridge. */
24443
24572
  is_bridge_error?: boolean | undefined
24444
24573
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
24445
24574
  error_code: 'invalid_credentials'
@@ -24447,8 +24576,11 @@ export interface Routes {
24447
24576
  | {
24448
24577
  /** Date and time at which Seam created the error. */
24449
24578
  created_at: string
24579
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
24450
24580
  message: string
24581
+ /** Indicates whether the error is related specifically to the connected account. */
24451
24582
  is_connected_account_error?: boolean | undefined
24583
+ /** Indicates whether the error is related to Seam Bridge. */
24452
24584
  is_bridge_error?: boolean | undefined
24453
24585
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
24454
24586
  error_code: 'bridge_disconnected'
@@ -24891,8 +25023,11 @@ export interface Routes {
24891
25023
  | {
24892
25024
  /** Date and time at which Seam created the error. */
24893
25025
  created_at: string
25026
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
24894
25027
  message: string
25028
+ /** Indicates whether the error is related specifically to the connected account. */
24895
25029
  is_connected_account_error?: boolean | undefined
25030
+ /** Indicates whether the error is related to Seam Bridge. */
24896
25031
  is_bridge_error?: boolean | undefined
24897
25032
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
24898
25033
  error_code: 'invalid_credentials'
@@ -24900,8 +25035,11 @@ export interface Routes {
24900
25035
  | {
24901
25036
  /** Date and time at which Seam created the error. */
24902
25037
  created_at: string
25038
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
24903
25039
  message: string
25040
+ /** Indicates whether the error is related specifically to the connected account. */
24904
25041
  is_connected_account_error?: boolean | undefined
25042
+ /** Indicates whether the error is related to Seam Bridge. */
24905
25043
  is_bridge_error?: boolean | undefined
24906
25044
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
24907
25045
  error_code: 'bridge_disconnected'
@@ -25216,7 +25354,6 @@ export interface Routes {
25216
25354
  | 'igloohome'
25217
25355
  | 'hubitat'
25218
25356
  | 'controlbyweb'
25219
- | 'smartthings'
25220
25357
  | 'dormakaba_oracode'
25221
25358
  | 'tedee'
25222
25359
  | 'akiles'
@@ -25227,6 +25364,7 @@ export interface Routes {
25227
25364
  | 'noiseaware'
25228
25365
  | 'tado'
25229
25366
  | 'sensi'
25367
+ | 'smartthings'
25230
25368
  )
25231
25369
  | undefined
25232
25370
  /** Array of device IDs for which you want to list devices. */
@@ -25440,8 +25578,11 @@ export interface Routes {
25440
25578
  | {
25441
25579
  /** Date and time at which Seam created the error. */
25442
25580
  created_at: string
25581
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
25443
25582
  message: string
25583
+ /** Indicates whether the error is related specifically to the connected account. */
25444
25584
  is_connected_account_error?: boolean | undefined
25585
+ /** Indicates whether the error is related to Seam Bridge. */
25445
25586
  is_bridge_error?: boolean | undefined
25446
25587
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
25447
25588
  error_code: 'invalid_credentials'
@@ -25449,8 +25590,11 @@ export interface Routes {
25449
25590
  | {
25450
25591
  /** Date and time at which Seam created the error. */
25451
25592
  created_at: string
25593
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
25452
25594
  message: string
25595
+ /** Indicates whether the error is related specifically to the connected account. */
25453
25596
  is_connected_account_error?: boolean | undefined
25597
+ /** Indicates whether the error is related to Seam Bridge. */
25454
25598
  is_bridge_error?: boolean | undefined
25455
25599
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
25456
25600
  error_code: 'bridge_disconnected'
@@ -29693,8 +29837,11 @@ export interface Routes {
29693
29837
  | {
29694
29838
  /** Date and time at which Seam created the error. */
29695
29839
  created_at: string
29840
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
29696
29841
  message: string
29842
+ /** Indicates whether the error is related specifically to the connected account. */
29697
29843
  is_connected_account_error?: boolean | undefined
29844
+ /** Indicates whether the error is related to Seam Bridge. */
29698
29845
  is_bridge_error?: boolean | undefined
29699
29846
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
29700
29847
  error_code: 'invalid_credentials'
@@ -29702,8 +29849,11 @@ export interface Routes {
29702
29849
  | {
29703
29850
  /** Date and time at which Seam created the error. */
29704
29851
  created_at: string
29852
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
29705
29853
  message: string
29854
+ /** Indicates whether the error is related specifically to the connected account. */
29706
29855
  is_connected_account_error?: boolean | undefined
29856
+ /** Indicates whether the error is related to Seam Bridge. */
29707
29857
  is_bridge_error?: boolean | undefined
29708
29858
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
29709
29859
  error_code: 'bridge_disconnected'
@@ -30683,8 +30833,11 @@ export interface Routes {
30683
30833
  | {
30684
30834
  /** Date and time at which Seam created the error. */
30685
30835
  created_at: string
30836
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
30686
30837
  message: string
30838
+ /** Indicates whether the error is related specifically to the connected account. */
30687
30839
  is_connected_account_error?: boolean | undefined
30840
+ /** Indicates whether the error is related to Seam Bridge. */
30688
30841
  is_bridge_error?: boolean | undefined
30689
30842
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
30690
30843
  error_code: 'invalid_credentials'
@@ -30692,8 +30845,11 @@ export interface Routes {
30692
30845
  | {
30693
30846
  /** Date and time at which Seam created the error. */
30694
30847
  created_at: string
30848
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
30695
30849
  message: string
30850
+ /** Indicates whether the error is related specifically to the connected account. */
30696
30851
  is_connected_account_error?: boolean | undefined
30852
+ /** Indicates whether the error is related to Seam Bridge. */
30697
30853
  is_bridge_error?: boolean | undefined
30698
30854
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
30699
30855
  error_code: 'bridge_disconnected'
@@ -30919,7 +31075,6 @@ export interface Routes {
30919
31075
  | 'salto'
30920
31076
  | 'schlage'
30921
31077
  | 'seam'
30922
- | 'smartthings'
30923
31078
  | 'wyze'
30924
31079
  | 'yale'
30925
31080
  | 'two_n'
@@ -30931,6 +31086,7 @@ export interface Routes {
30931
31086
  | 'dormakaba_oracode'
30932
31087
  | 'tedee'
30933
31088
  | 'akiles'
31089
+ | 'smartthings'
30934
31090
  )
30935
31091
  | undefined
30936
31092
  /** Array of device IDs for which you want to list devices. */
@@ -31832,8 +31988,11 @@ export interface Routes {
31832
31988
  | {
31833
31989
  /** Date and time at which Seam created the error. */
31834
31990
  created_at: string
31991
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
31835
31992
  message: string
31993
+ /** Indicates whether the error is related specifically to the connected account. */
31836
31994
  is_connected_account_error?: boolean | undefined
31995
+ /** Indicates whether the error is related to Seam Bridge. */
31837
31996
  is_bridge_error?: boolean | undefined
31838
31997
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
31839
31998
  error_code: 'invalid_credentials'
@@ -31841,8 +32000,11 @@ export interface Routes {
31841
32000
  | {
31842
32001
  /** Date and time at which Seam created the error. */
31843
32002
  created_at: string
32003
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
31844
32004
  message: string
32005
+ /** Indicates whether the error is related specifically to the connected account. */
31845
32006
  is_connected_account_error?: boolean | undefined
32007
+ /** Indicates whether the error is related to Seam Bridge. */
31846
32008
  is_bridge_error?: boolean | undefined
31847
32009
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
31848
32010
  error_code: 'bridge_disconnected'
@@ -32821,8 +32983,11 @@ export interface Routes {
32821
32983
  | {
32822
32984
  /** Date and time at which Seam created the error. */
32823
32985
  created_at: string
32986
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
32824
32987
  message: string
32988
+ /** Indicates whether the error is related specifically to the connected account. */
32825
32989
  is_connected_account_error?: boolean | undefined
32990
+ /** Indicates whether the error is related to Seam Bridge. */
32826
32991
  is_bridge_error?: boolean | undefined
32827
32992
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
32828
32993
  error_code: 'invalid_credentials'
@@ -32830,8 +32995,11 @@ export interface Routes {
32830
32995
  | {
32831
32996
  /** Date and time at which Seam created the error. */
32832
32997
  created_at: string
32998
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
32833
32999
  message: string
33000
+ /** Indicates whether the error is related specifically to the connected account. */
32834
33001
  is_connected_account_error?: boolean | undefined
33002
+ /** Indicates whether the error is related to Seam Bridge. */
32835
33003
  is_bridge_error?: boolean | undefined
32836
33004
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
32837
33005
  error_code: 'bridge_disconnected'
@@ -39136,8 +39304,11 @@ export interface Routes {
39136
39304
  | {
39137
39305
  /** Date and time at which Seam created the error. */
39138
39306
  created_at: string
39307
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
39139
39308
  message: string
39309
+ /** Indicates whether the error is related specifically to the connected account. */
39140
39310
  is_connected_account_error?: boolean | undefined
39311
+ /** Indicates whether the error is related to Seam Bridge. */
39141
39312
  is_bridge_error?: boolean | undefined
39142
39313
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
39143
39314
  error_code: 'invalid_credentials'
@@ -39145,8 +39316,11 @@ export interface Routes {
39145
39316
  | {
39146
39317
  /** Date and time at which Seam created the error. */
39147
39318
  created_at: string
39319
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
39148
39320
  message: string
39321
+ /** Indicates whether the error is related specifically to the connected account. */
39149
39322
  is_connected_account_error?: boolean | undefined
39323
+ /** Indicates whether the error is related to Seam Bridge. */
39150
39324
  is_bridge_error?: boolean | undefined
39151
39325
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
39152
39326
  error_code: 'bridge_disconnected'
@@ -40125,8 +40299,11 @@ export interface Routes {
40125
40299
  | {
40126
40300
  /** Date and time at which Seam created the error. */
40127
40301
  created_at: string
40302
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
40128
40303
  message: string
40304
+ /** Indicates whether the error is related specifically to the connected account. */
40129
40305
  is_connected_account_error?: boolean | undefined
40306
+ /** Indicates whether the error is related to Seam Bridge. */
40130
40307
  is_bridge_error?: boolean | undefined
40131
40308
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
40132
40309
  error_code: 'invalid_credentials'
@@ -40134,8 +40311,11 @@ export interface Routes {
40134
40311
  | {
40135
40312
  /** Date and time at which Seam created the error. */
40136
40313
  created_at: string
40314
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
40137
40315
  message: string
40316
+ /** Indicates whether the error is related specifically to the connected account. */
40138
40317
  is_connected_account_error?: boolean | undefined
40318
+ /** Indicates whether the error is related to Seam Bridge. */
40139
40319
  is_bridge_error?: boolean | undefined
40140
40320
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
40141
40321
  error_code: 'bridge_disconnected'
@@ -50064,8 +50244,11 @@ export interface Routes {
50064
50244
  | {
50065
50245
  /** Date and time at which Seam created the error. */
50066
50246
  created_at: string
50247
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
50067
50248
  message: string
50249
+ /** Indicates whether the error is related specifically to the connected account. */
50068
50250
  is_connected_account_error?: boolean | undefined
50251
+ /** Indicates whether the error is related to Seam Bridge. */
50069
50252
  is_bridge_error?: boolean | undefined
50070
50253
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
50071
50254
  error_code: 'invalid_credentials'
@@ -50073,8 +50256,11 @@ export interface Routes {
50073
50256
  | {
50074
50257
  /** Date and time at which Seam created the error. */
50075
50258
  created_at: string
50259
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
50076
50260
  message: string
50261
+ /** Indicates whether the error is related specifically to the connected account. */
50077
50262
  is_connected_account_error?: boolean | undefined
50263
+ /** Indicates whether the error is related to Seam Bridge. */
50078
50264
  is_bridge_error?: boolean | undefined
50079
50265
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
50080
50266
  error_code: 'bridge_disconnected'
@@ -52868,7 +53054,14 @@ export interface Routes {
52868
53054
  | undefined
52869
53055
  /** Manufacturer by which to filter thermostat devices. */
52870
53056
  manufacturer?:
52871
- | ('ecobee' | 'honeywell_resideo' | 'nest' | 'tado' | 'sensi')
53057
+ | (
53058
+ | 'ecobee'
53059
+ | 'honeywell_resideo'
53060
+ | 'nest'
53061
+ | 'tado'
53062
+ | 'sensi'
53063
+ | 'smartthings'
53064
+ )
52872
53065
  | undefined
52873
53066
  /** Array of device IDs for which you want to list devices. */
52874
53067
  device_ids?: string[] | undefined
@@ -53769,8 +53962,11 @@ export interface Routes {
53769
53962
  | {
53770
53963
  /** Date and time at which Seam created the error. */
53771
53964
  created_at: string
53965
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
53772
53966
  message: string
53967
+ /** Indicates whether the error is related specifically to the connected account. */
53773
53968
  is_connected_account_error?: boolean | undefined
53969
+ /** Indicates whether the error is related to Seam Bridge. */
53774
53970
  is_bridge_error?: boolean | undefined
53775
53971
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
53776
53972
  error_code: 'invalid_credentials'
@@ -53778,8 +53974,11 @@ export interface Routes {
53778
53974
  | {
53779
53975
  /** Date and time at which Seam created the error. */
53780
53976
  created_at: string
53977
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
53781
53978
  message: string
53979
+ /** Indicates whether the error is related specifically to the connected account. */
53782
53980
  is_connected_account_error?: boolean | undefined
53981
+ /** Indicates whether the error is related to Seam Bridge. */
53783
53982
  is_bridge_error?: boolean | undefined
53784
53983
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
53785
53984
  error_code: 'bridge_disconnected'
@@ -54758,8 +54957,11 @@ export interface Routes {
54758
54957
  | {
54759
54958
  /** Date and time at which Seam created the error. */
54760
54959
  created_at: string
54960
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
54761
54961
  message: string
54962
+ /** Indicates whether the error is related specifically to the connected account. */
54762
54963
  is_connected_account_error?: boolean | undefined
54964
+ /** Indicates whether the error is related to Seam Bridge. */
54763
54965
  is_bridge_error?: boolean | undefined
54764
54966
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
54765
54967
  error_code: 'invalid_credentials'
@@ -54767,8 +54969,11 @@ export interface Routes {
54767
54969
  | {
54768
54970
  /** Date and time at which Seam created the error. */
54769
54971
  created_at: string
54972
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
54770
54973
  message: string
54974
+ /** Indicates whether the error is related specifically to the connected account. */
54771
54975
  is_connected_account_error?: boolean | undefined
54976
+ /** Indicates whether the error is related to Seam Bridge. */
54772
54977
  is_bridge_error?: boolean | undefined
54773
54978
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
54774
54979
  error_code: 'bridge_disconnected'
@@ -62071,8 +62276,11 @@ export interface Routes {
62071
62276
  | {
62072
62277
  /** Date and time at which Seam created the error. */
62073
62278
  created_at: string
62279
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
62074
62280
  message: string
62281
+ /** Indicates whether the error is related specifically to the connected account. */
62075
62282
  is_connected_account_error?: boolean | undefined
62283
+ /** Indicates whether the error is related to Seam Bridge. */
62076
62284
  is_bridge_error?: boolean | undefined
62077
62285
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
62078
62286
  error_code: 'invalid_credentials'
@@ -62080,8 +62288,11 @@ export interface Routes {
62080
62288
  | {
62081
62289
  /** Date and time at which Seam created the error. */
62082
62290
  created_at: string
62291
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
62083
62292
  message: string
62293
+ /** Indicates whether the error is related specifically to the connected account. */
62084
62294
  is_connected_account_error?: boolean | undefined
62295
+ /** Indicates whether the error is related to Seam Bridge. */
62085
62296
  is_bridge_error?: boolean | undefined
62086
62297
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
62087
62298
  error_code: 'bridge_disconnected'
@@ -63062,8 +63273,11 @@ export interface Routes {
63062
63273
  | {
63063
63274
  /** Date and time at which Seam created the error. */
63064
63275
  created_at: string
63276
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
63065
63277
  message: string
63278
+ /** Indicates whether the error is related specifically to the connected account. */
63066
63279
  is_connected_account_error?: boolean | undefined
63280
+ /** Indicates whether the error is related to Seam Bridge. */
63067
63281
  is_bridge_error?: boolean | undefined
63068
63282
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
63069
63283
  error_code: 'invalid_credentials'
@@ -63071,8 +63285,11 @@ export interface Routes {
63071
63285
  | {
63072
63286
  /** Date and time at which Seam created the error. */
63073
63287
  created_at: string
63288
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
63074
63289
  message: string
63290
+ /** Indicates whether the error is related specifically to the connected account. */
63075
63291
  is_connected_account_error?: boolean | undefined
63292
+ /** Indicates whether the error is related to Seam Bridge. */
63076
63293
  is_bridge_error?: boolean | undefined
63077
63294
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
63078
63295
  error_code: 'bridge_disconnected'