@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
package/dist/connect.cjs
CHANGED
|
@@ -1437,7 +1437,6 @@ var PROVIDER_CATEGORY_MAP = {
|
|
|
1437
1437
|
thermostats: ["ecobee", "nest", "sensi", "honeywell_resideo"],
|
|
1438
1438
|
noise_sensors: ["minut", "noiseaware"],
|
|
1439
1439
|
access_control_systems: [
|
|
1440
|
-
"pti",
|
|
1441
1440
|
"visionline",
|
|
1442
1441
|
"assa_abloy_credential_service",
|
|
1443
1442
|
"latch",
|
|
@@ -1730,13 +1729,7 @@ var access_code = zod.z.object({
|
|
|
1730
1729
|
"Unique identifier for the device associated with the access code."
|
|
1731
1730
|
),
|
|
1732
1731
|
name: zod.z.string().nullable().describe(
|
|
1733
|
-
|
|
1734
|
-
|
|
1735
|
-
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\`.
|
|
1736
|
-
|
|
1737
|
-
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.
|
|
1738
|
-
|
|
1739
|
-
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).`
|
|
1732
|
+
"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)."
|
|
1740
1733
|
),
|
|
1741
1734
|
code: zod.z.string().nullable().describe(
|
|
1742
1735
|
"Code used for access. Typically, a numeric or alphanumeric string."
|
|
@@ -1761,7 +1754,7 @@ var access_code = zod.z.object({
|
|
|
1761
1754
|
"Date and time after which the time-bound access code becomes inactive."
|
|
1762
1755
|
),
|
|
1763
1756
|
status: zod.z.enum(["setting", "set", "unset", "removing", "unknown"]).describe(
|
|
1764
|
-
"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."
|
|
1757
|
+
"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)."
|
|
1765
1758
|
),
|
|
1766
1759
|
is_backup_access_code_available: zod.z.boolean().describe(
|
|
1767
1760
|
"Indicates whether a backup access code is available for use if the primary access code is lost or compromised."
|
|
@@ -5738,7 +5731,7 @@ var openapi_default = {
|
|
|
5738
5731
|
type: "boolean"
|
|
5739
5732
|
},
|
|
5740
5733
|
name: {
|
|
5741
|
-
description: "Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes
|
|
5734
|
+
description: "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).",
|
|
5742
5735
|
nullable: true,
|
|
5743
5736
|
type: "string"
|
|
5744
5737
|
},
|
|
@@ -5755,7 +5748,7 @@ var openapi_default = {
|
|
|
5755
5748
|
type: "string"
|
|
5756
5749
|
},
|
|
5757
5750
|
status: {
|
|
5758
|
-
description: "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.",
|
|
5751
|
+
description: "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).",
|
|
5759
5752
|
enum: ["setting", "set", "unset", "removing", "unknown"],
|
|
5760
5753
|
type: "string"
|
|
5761
5754
|
},
|
|
@@ -20388,7 +20381,7 @@ var openapi_default = {
|
|
|
20388
20381
|
type: "boolean"
|
|
20389
20382
|
},
|
|
20390
20383
|
name: {
|
|
20391
|
-
description: "Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes
|
|
20384
|
+
description: "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).",
|
|
20392
20385
|
nullable: true,
|
|
20393
20386
|
type: "string"
|
|
20394
20387
|
},
|
|
@@ -22749,7 +22742,7 @@ var openapi_default = {
|
|
|
22749
22742
|
type: "string"
|
|
22750
22743
|
},
|
|
22751
22744
|
name: {
|
|
22752
|
-
description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes
|
|
22745
|
+
description: "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).",
|
|
22753
22746
|
type: "string"
|
|
22754
22747
|
},
|
|
22755
22748
|
prefer_native_scheduling: {
|
|
@@ -22878,7 +22871,7 @@ var openapi_default = {
|
|
|
22878
22871
|
type: "string"
|
|
22879
22872
|
},
|
|
22880
22873
|
name: {
|
|
22881
|
-
description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes
|
|
22874
|
+
description: "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).",
|
|
22882
22875
|
type: "string"
|
|
22883
22876
|
},
|
|
22884
22877
|
prefer_native_scheduling: {
|
|
@@ -22999,7 +22992,7 @@ var openapi_default = {
|
|
|
22999
22992
|
type: "string"
|
|
23000
22993
|
},
|
|
23001
22994
|
name: {
|
|
23002
|
-
description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes
|
|
22995
|
+
description: "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).",
|
|
23003
22996
|
type: "string"
|
|
23004
22997
|
},
|
|
23005
22998
|
prefer_native_scheduling: {
|
|
@@ -24034,7 +24027,7 @@ var openapi_default = {
|
|
|
24034
24027
|
type: "string"
|
|
24035
24028
|
},
|
|
24036
24029
|
name: {
|
|
24037
|
-
description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes
|
|
24030
|
+
description: "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).",
|
|
24038
24031
|
type: "string"
|
|
24039
24032
|
},
|
|
24040
24033
|
prefer_native_scheduling: {
|
|
@@ -24166,7 +24159,7 @@ var openapi_default = {
|
|
|
24166
24159
|
type: "string"
|
|
24167
24160
|
},
|
|
24168
24161
|
name: {
|
|
24169
|
-
description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes
|
|
24162
|
+
description: "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).",
|
|
24170
24163
|
type: "string"
|
|
24171
24164
|
},
|
|
24172
24165
|
prefer_native_scheduling: {
|
|
@@ -24299,7 +24292,7 @@ var openapi_default = {
|
|
|
24299
24292
|
type: "string"
|
|
24300
24293
|
},
|
|
24301
24294
|
name: {
|
|
24302
|
-
description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes
|
|
24295
|
+
description: "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).",
|
|
24303
24296
|
type: "string"
|
|
24304
24297
|
},
|
|
24305
24298
|
prefer_native_scheduling: {
|
|
@@ -24390,7 +24383,7 @@ var openapi_default = {
|
|
|
24390
24383
|
type: "string"
|
|
24391
24384
|
},
|
|
24392
24385
|
name: {
|
|
24393
|
-
description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes
|
|
24386
|
+
description: "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).",
|
|
24394
24387
|
type: "string"
|
|
24395
24388
|
},
|
|
24396
24389
|
starts_at: {
|
|
@@ -24449,7 +24442,7 @@ var openapi_default = {
|
|
|
24449
24442
|
type: "string"
|
|
24450
24443
|
},
|
|
24451
24444
|
name: {
|
|
24452
|
-
description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes
|
|
24445
|
+
description: "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).",
|
|
24453
24446
|
type: "string"
|
|
24454
24447
|
},
|
|
24455
24448
|
starts_at: {
|
|
@@ -30156,7 +30149,6 @@ var openapi_default = {
|
|
|
30156
30149
|
"igloohome",
|
|
30157
30150
|
"hubitat",
|
|
30158
30151
|
"controlbyweb",
|
|
30159
|
-
"smartthings",
|
|
30160
30152
|
"dormakaba_oracode",
|
|
30161
30153
|
"tedee",
|
|
30162
30154
|
"akiles",
|
|
@@ -30166,7 +30158,8 @@ var openapi_default = {
|
|
|
30166
30158
|
"nest",
|
|
30167
30159
|
"noiseaware",
|
|
30168
30160
|
"tado",
|
|
30169
|
-
"sensi"
|
|
30161
|
+
"sensi",
|
|
30162
|
+
"smartthings"
|
|
30170
30163
|
],
|
|
30171
30164
|
type: "string"
|
|
30172
30165
|
},
|
|
@@ -30739,7 +30732,6 @@ var openapi_default = {
|
|
|
30739
30732
|
"igloohome",
|
|
30740
30733
|
"hubitat",
|
|
30741
30734
|
"controlbyweb",
|
|
30742
|
-
"smartthings",
|
|
30743
30735
|
"dormakaba_oracode",
|
|
30744
30736
|
"tedee",
|
|
30745
30737
|
"akiles",
|
|
@@ -30749,7 +30741,8 @@ var openapi_default = {
|
|
|
30749
30741
|
"nest",
|
|
30750
30742
|
"noiseaware",
|
|
30751
30743
|
"tado",
|
|
30752
|
-
"sensi"
|
|
30744
|
+
"sensi",
|
|
30745
|
+
"smartthings"
|
|
30753
30746
|
],
|
|
30754
30747
|
type: "string"
|
|
30755
30748
|
},
|
|
@@ -31640,7 +31633,6 @@ var openapi_default = {
|
|
|
31640
31633
|
"salto",
|
|
31641
31634
|
"schlage",
|
|
31642
31635
|
"seam",
|
|
31643
|
-
"smartthings",
|
|
31644
31636
|
"wyze",
|
|
31645
31637
|
"yale",
|
|
31646
31638
|
"two_n",
|
|
@@ -31651,7 +31643,8 @@ var openapi_default = {
|
|
|
31651
31643
|
"four_suites",
|
|
31652
31644
|
"dormakaba_oracode",
|
|
31653
31645
|
"tedee",
|
|
31654
|
-
"akiles"
|
|
31646
|
+
"akiles",
|
|
31647
|
+
"smartthings"
|
|
31655
31648
|
],
|
|
31656
31649
|
type: "string"
|
|
31657
31650
|
},
|
|
@@ -35091,7 +35084,8 @@ var openapi_default = {
|
|
|
35091
35084
|
"honeywell_resideo",
|
|
35092
35085
|
"nest",
|
|
35093
35086
|
"tado",
|
|
35094
|
-
"sensi"
|
|
35087
|
+
"sensi",
|
|
35088
|
+
"smartthings"
|
|
35095
35089
|
],
|
|
35096
35090
|
type: "string"
|
|
35097
35091
|
},
|