@seamapi/types 1.404.2 → 1.404.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/connect.cjs +21 -27
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +23 -101
- package/lib/seam/connect/models/access-codes/managed-access-code.js +2 -8
- package/lib/seam/connect/models/access-codes/managed-access-code.js.map +1 -1
- package/lib/seam/connect/models/devices/device-provider.d.ts +1 -1
- package/lib/seam/connect/models/devices/device-provider.js +0 -1
- package/lib/seam/connect/models/devices/device-provider.js.map +1 -1
- package/lib/seam/connect/openapi.js +15 -14
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +23 -101
- package/package.json +1 -1
- package/src/lib/seam/connect/models/access-codes/managed-access-code.ts +2 -8
- package/src/lib/seam/connect/models/devices/device-provider.ts +0 -1
- package/src/lib/seam/connect/openapi.ts +15 -14
- package/src/lib/seam/connect/route-types.ts +30 -101
|
@@ -6,13 +6,7 @@ export interface Routes {
|
|
|
6
6
|
jsonBody: {
|
|
7
7
|
/** ID of the device for which you want to create the new access code. */
|
|
8
8
|
device_id: string
|
|
9
|
-
/** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
10
|
-
|
|
11
|
-
Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
|
|
12
|
-
|
|
13
|
-
To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
|
|
14
|
-
|
|
15
|
-
To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
9
|
+
/** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
16
10
|
name?: string | undefined
|
|
17
11
|
/** Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
18
12
|
starts_at?: string | undefined
|
|
@@ -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
|
|
@@ -1845,7 +1833,7 @@ export interface Routes {
|
|
|
1845
1833
|
starts_at?: (string | null) | undefined
|
|
1846
1834
|
/** Date and time after which the time-bound access code becomes inactive. */
|
|
1847
1835
|
ends_at?: (string | null) | undefined
|
|
1848
|
-
/** 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). */
|
|
1849
1837
|
status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown'
|
|
1850
1838
|
/** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
|
|
1851
1839
|
is_backup_access_code_available: boolean
|
|
@@ -1873,13 +1861,7 @@ export interface Routes {
|
|
|
1873
1861
|
behavior_when_code_cannot_be_shared?: 'throw' | 'create_random_code'
|
|
1874
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. */
|
|
1875
1863
|
preferred_code_length?: number | undefined
|
|
1876
|
-
/** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
1877
|
-
|
|
1878
|
-
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`.
|
|
1879
|
-
|
|
1880
|
-
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.
|
|
1881
|
-
|
|
1882
|
-
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). */
|
|
1883
1865
|
name?: string | undefined
|
|
1884
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. */
|
|
1885
1867
|
starts_at?: string | undefined
|
|
@@ -1920,13 +1902,7 @@ export interface Routes {
|
|
|
1920
1902
|
access_code_id: string
|
|
1921
1903
|
/** Unique identifier for the device associated with the access code. */
|
|
1922
1904
|
device_id: string
|
|
1923
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
1924
|
-
|
|
1925
|
-
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`.
|
|
1926
|
-
|
|
1927
|
-
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.
|
|
1928
|
-
|
|
1929
|
-
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). */
|
|
1930
1906
|
name: string | null
|
|
1931
1907
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
1932
1908
|
code: string | null
|
|
@@ -2407,7 +2383,7 @@ export interface Routes {
|
|
|
2407
2383
|
starts_at?: (string | null) | undefined
|
|
2408
2384
|
/** Date and time after which the time-bound access code becomes inactive. */
|
|
2409
2385
|
ends_at?: (string | null) | undefined
|
|
2410
|
-
/** 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). */
|
|
2411
2387
|
status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown'
|
|
2412
2388
|
/** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
|
|
2413
2389
|
is_backup_access_code_available: boolean
|
|
@@ -3785,13 +3761,7 @@ export interface Routes {
|
|
|
3785
3761
|
access_code_id: string
|
|
3786
3762
|
/** Unique identifier for the device associated with the access code. */
|
|
3787
3763
|
device_id: string
|
|
3788
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
3789
|
-
|
|
3790
|
-
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`.
|
|
3791
|
-
|
|
3792
|
-
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.
|
|
3793
|
-
|
|
3794
|
-
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). */
|
|
3795
3765
|
name: string | null
|
|
3796
3766
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
3797
3767
|
code: string | null
|
|
@@ -4272,7 +4242,7 @@ export interface Routes {
|
|
|
4272
4242
|
starts_at?: (string | null) | undefined
|
|
4273
4243
|
/** Date and time after which the time-bound access code becomes inactive. */
|
|
4274
4244
|
ends_at?: (string | null) | undefined
|
|
4275
|
-
/** 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). */
|
|
4276
4246
|
status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown'
|
|
4277
4247
|
/** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
|
|
4278
4248
|
is_backup_access_code_available: boolean
|
|
@@ -4321,13 +4291,7 @@ export interface Routes {
|
|
|
4321
4291
|
access_code_id: string
|
|
4322
4292
|
/** Unique identifier for the device associated with the access code. */
|
|
4323
4293
|
device_id: string
|
|
4324
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
4325
|
-
|
|
4326
|
-
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`.
|
|
4327
|
-
|
|
4328
|
-
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.
|
|
4329
|
-
|
|
4330
|
-
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). */
|
|
4331
4295
|
name: string | null
|
|
4332
4296
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
4333
4297
|
code: string | null
|
|
@@ -4808,7 +4772,7 @@ export interface Routes {
|
|
|
4808
4772
|
starts_at?: (string | null) | undefined
|
|
4809
4773
|
/** Date and time after which the time-bound access code becomes inactive. */
|
|
4810
4774
|
ends_at?: (string | null) | undefined
|
|
4811
|
-
/** 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). */
|
|
4812
4776
|
status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown'
|
|
4813
4777
|
/** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
|
|
4814
4778
|
is_backup_access_code_available: boolean
|
|
@@ -4865,13 +4829,7 @@ export interface Routes {
|
|
|
4865
4829
|
access_code_id: string
|
|
4866
4830
|
/** Unique identifier for the device associated with the access code. */
|
|
4867
4831
|
device_id: string
|
|
4868
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
4869
|
-
|
|
4870
|
-
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`.
|
|
4871
|
-
|
|
4872
|
-
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.
|
|
4873
|
-
|
|
4874
|
-
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). */
|
|
4875
4833
|
name: string | null
|
|
4876
4834
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
4877
4835
|
code: string | null
|
|
@@ -5352,7 +5310,7 @@ export interface Routes {
|
|
|
5352
5310
|
starts_at?: (string | null) | undefined
|
|
5353
5311
|
/** Date and time after which the time-bound access code becomes inactive. */
|
|
5354
5312
|
ends_at?: (string | null) | undefined
|
|
5355
|
-
/** 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). */
|
|
5356
5314
|
status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown'
|
|
5357
5315
|
/** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
|
|
5358
5316
|
is_backup_access_code_available: boolean
|
|
@@ -5387,13 +5345,7 @@ export interface Routes {
|
|
|
5387
5345
|
access_code_id: string
|
|
5388
5346
|
/** Unique identifier for the device associated with the access code. */
|
|
5389
5347
|
device_id: string
|
|
5390
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
5391
|
-
|
|
5392
|
-
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`.
|
|
5393
|
-
|
|
5394
|
-
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.
|
|
5395
|
-
|
|
5396
|
-
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). */
|
|
5397
5349
|
name: string | null
|
|
5398
5350
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
5399
5351
|
code: string | null
|
|
@@ -5874,7 +5826,7 @@ export interface Routes {
|
|
|
5874
5826
|
starts_at?: (string | null) | undefined
|
|
5875
5827
|
/** Date and time after which the time-bound access code becomes inactive. */
|
|
5876
5828
|
ends_at?: (string | null) | undefined
|
|
5877
|
-
/** 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). */
|
|
5878
5830
|
status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown'
|
|
5879
5831
|
/** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
|
|
5880
5832
|
is_backup_access_code_available: boolean
|
|
@@ -5942,13 +5894,7 @@ export interface Routes {
|
|
|
5942
5894
|
access_code_id: string
|
|
5943
5895
|
/** Unique identifier for the device associated with the access code. */
|
|
5944
5896
|
device_id: string
|
|
5945
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
5946
|
-
|
|
5947
|
-
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`.
|
|
5948
|
-
|
|
5949
|
-
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.
|
|
5950
|
-
|
|
5951
|
-
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). */
|
|
5952
5898
|
name: string | null
|
|
5953
5899
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
5954
5900
|
code: string | null
|
|
@@ -7794,13 +7740,7 @@ export interface Routes {
|
|
|
7794
7740
|
access_code_id: string
|
|
7795
7741
|
/** Unique identifier for the device associated with the access code. */
|
|
7796
7742
|
device_id: string
|
|
7797
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
7798
|
-
|
|
7799
|
-
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`.
|
|
7800
|
-
|
|
7801
|
-
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.
|
|
7802
|
-
|
|
7803
|
-
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). */
|
|
7804
7744
|
name: string | null
|
|
7805
7745
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
7806
7746
|
code: string | null
|
|
@@ -8306,13 +8246,7 @@ export interface Routes {
|
|
|
8306
8246
|
access_code_id: string
|
|
8307
8247
|
/** Unique identifier for the device associated with the access code. */
|
|
8308
8248
|
device_id: string
|
|
8309
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
8310
|
-
|
|
8311
|
-
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`.
|
|
8312
|
-
|
|
8313
|
-
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.
|
|
8314
|
-
|
|
8315
|
-
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). */
|
|
8316
8250
|
name: string | null
|
|
8317
8251
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
8318
8252
|
code: string | null
|
|
@@ -8822,13 +8756,7 @@ export interface Routes {
|
|
|
8822
8756
|
method: 'POST' | 'PATCH' | 'PUT'
|
|
8823
8757
|
queryParams: {}
|
|
8824
8758
|
jsonBody: {
|
|
8825
|
-
/** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
8826
|
-
|
|
8827
|
-
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`.
|
|
8828
|
-
|
|
8829
|
-
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.
|
|
8830
|
-
|
|
8831
|
-
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). */
|
|
8832
8760
|
name?: string | undefined
|
|
8833
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. */
|
|
8834
8762
|
starts_at?: string | undefined
|
|
@@ -10171,13 +10099,7 @@ export interface Routes {
|
|
|
10171
10099
|
ends_at?: string | undefined
|
|
10172
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. */
|
|
10173
10101
|
starts_at?: string | undefined
|
|
10174
|
-
/** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
10175
|
-
|
|
10176
|
-
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`.
|
|
10177
|
-
|
|
10178
|
-
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.
|
|
10179
|
-
|
|
10180
|
-
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). */
|
|
10181
10103
|
name?: string | undefined
|
|
10182
10104
|
/** Key that links the group of access codes, assigned on creation by `/access_codes/create_multiple`. */
|
|
10183
10105
|
common_code_key: string
|
|
@@ -23730,7 +23652,6 @@ export interface Routes {
|
|
|
23730
23652
|
| 'igloohome'
|
|
23731
23653
|
| 'hubitat'
|
|
23732
23654
|
| 'controlbyweb'
|
|
23733
|
-
| 'smartthings'
|
|
23734
23655
|
| 'dormakaba_oracode'
|
|
23735
23656
|
| 'tedee'
|
|
23736
23657
|
| 'akiles'
|
|
@@ -23741,6 +23662,7 @@ export interface Routes {
|
|
|
23741
23662
|
| 'noiseaware'
|
|
23742
23663
|
| 'tado'
|
|
23743
23664
|
| 'sensi'
|
|
23665
|
+
| 'smartthings'
|
|
23744
23666
|
)
|
|
23745
23667
|
| undefined
|
|
23746
23668
|
/** Array of device IDs for which you want to list devices. */
|
|
@@ -25432,7 +25354,6 @@ export interface Routes {
|
|
|
25432
25354
|
| 'igloohome'
|
|
25433
25355
|
| 'hubitat'
|
|
25434
25356
|
| 'controlbyweb'
|
|
25435
|
-
| 'smartthings'
|
|
25436
25357
|
| 'dormakaba_oracode'
|
|
25437
25358
|
| 'tedee'
|
|
25438
25359
|
| 'akiles'
|
|
@@ -25443,6 +25364,7 @@ export interface Routes {
|
|
|
25443
25364
|
| 'noiseaware'
|
|
25444
25365
|
| 'tado'
|
|
25445
25366
|
| 'sensi'
|
|
25367
|
+
| 'smartthings'
|
|
25446
25368
|
)
|
|
25447
25369
|
| undefined
|
|
25448
25370
|
/** Array of device IDs for which you want to list devices. */
|
|
@@ -31153,7 +31075,6 @@ export interface Routes {
|
|
|
31153
31075
|
| 'salto'
|
|
31154
31076
|
| 'schlage'
|
|
31155
31077
|
| 'seam'
|
|
31156
|
-
| 'smartthings'
|
|
31157
31078
|
| 'wyze'
|
|
31158
31079
|
| 'yale'
|
|
31159
31080
|
| 'two_n'
|
|
@@ -31165,6 +31086,7 @@ export interface Routes {
|
|
|
31165
31086
|
| 'dormakaba_oracode'
|
|
31166
31087
|
| 'tedee'
|
|
31167
31088
|
| 'akiles'
|
|
31089
|
+
| 'smartthings'
|
|
31168
31090
|
)
|
|
31169
31091
|
| undefined
|
|
31170
31092
|
/** Array of device IDs for which you want to list devices. */
|
|
@@ -53132,7 +53054,14 @@ export interface Routes {
|
|
|
53132
53054
|
| undefined
|
|
53133
53055
|
/** Manufacturer by which to filter thermostat devices. */
|
|
53134
53056
|
manufacturer?:
|
|
53135
|
-
| (
|
|
53057
|
+
| (
|
|
53058
|
+
| 'ecobee'
|
|
53059
|
+
| 'honeywell_resideo'
|
|
53060
|
+
| 'nest'
|
|
53061
|
+
| 'tado'
|
|
53062
|
+
| 'sensi'
|
|
53063
|
+
| 'smartthings'
|
|
53064
|
+
)
|
|
53136
53065
|
| undefined
|
|
53137
53066
|
/** Array of device IDs for which you want to list devices. */
|
|
53138
53067
|
device_ids?: string[] | undefined
|