@seamapi/types 1.404.2 → 1.404.4
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 +22 -69
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +24 -223
- 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/acs/acs-system.d.ts +2 -66
- package/lib/seam/connect/models/acs/acs-system.js +1 -24
- package/lib/seam/connect/models/acs/acs-system.js.map +1 -1
- package/lib/seam/connect/models/devices/device-provider.d.ts +1 -1
- package/lib/seam/connect/models/devices/device-provider.js +0 -1
- package/lib/seam/connect/models/devices/device-provider.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +0 -34
- package/lib/seam/connect/openapi.js +15 -36
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +23 -157
- 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/acs/acs-system.ts +1 -32
- package/src/lib/seam/connect/models/devices/device-provider.ts +0 -1
- package/src/lib/seam/connect/openapi.ts +15 -40
- package/src/lib/seam/connect/route-types.ts +30 -157
|
@@ -1204,7 +1204,7 @@ export default {
|
|
|
1204
1204
|
},
|
|
1205
1205
|
name: {
|
|
1206
1206
|
description:
|
|
1207
|
-
"Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes
|
|
1207
|
+
"Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
1208
1208
|
nullable: true,
|
|
1209
1209
|
type: 'string',
|
|
1210
1210
|
},
|
|
@@ -1224,7 +1224,7 @@ export default {
|
|
|
1224
1224
|
},
|
|
1225
1225
|
status: {
|
|
1226
1226
|
description:
|
|
1227
|
-
'Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting.',
|
|
1227
|
+
'Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/lifecycle-of-access-codes).',
|
|
1228
1228
|
enum: ['setting', 'set', 'unset', 'removing', 'unknown'],
|
|
1229
1229
|
type: 'string',
|
|
1230
1230
|
},
|
|
@@ -2330,32 +2330,6 @@ export default {
|
|
|
2330
2330
|
type: 'string',
|
|
2331
2331
|
},
|
|
2332
2332
|
acs_user_count: { format: 'float', type: 'number' },
|
|
2333
|
-
can_add_acs_users_to_acs_access_groups: {
|
|
2334
|
-
description:
|
|
2335
|
-
'Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [adding users to access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#add-an-acs-user-to-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).',
|
|
2336
|
-
type: 'boolean',
|
|
2337
|
-
},
|
|
2338
|
-
can_automate_enrollment: {
|
|
2339
|
-
description:
|
|
2340
|
-
'Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
|
|
2341
|
-
type: 'boolean',
|
|
2342
|
-
},
|
|
2343
|
-
can_create_acs_access_groups: {
|
|
2344
|
-
description:
|
|
2345
|
-
'Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).',
|
|
2346
|
-
type: 'boolean',
|
|
2347
|
-
},
|
|
2348
|
-
can_create_user: { type: 'boolean' },
|
|
2349
|
-
can_delete_user: { type: 'boolean' },
|
|
2350
|
-
can_remove_acs_users_from_acs_access_groups: {
|
|
2351
|
-
description:
|
|
2352
|
-
'Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [removing users from access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#remove-an-acs-user-from-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).',
|
|
2353
|
-
type: 'boolean',
|
|
2354
|
-
},
|
|
2355
|
-
can_update_user_group_membership: { type: 'boolean' },
|
|
2356
|
-
can_update_user_information: { type: 'boolean' },
|
|
2357
|
-
can_update_user_schedule: { type: 'boolean' },
|
|
2358
|
-
can_update_user_supension_state: { type: 'boolean' },
|
|
2359
2333
|
connected_account_id: {
|
|
2360
2334
|
description:
|
|
2361
2335
|
'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
|
|
@@ -17260,7 +17234,7 @@ export default {
|
|
|
17260
17234
|
},
|
|
17261
17235
|
name: {
|
|
17262
17236
|
description:
|
|
17263
|
-
"Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes
|
|
17237
|
+
"Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
17264
17238
|
nullable: true,
|
|
17265
17239
|
type: 'string',
|
|
17266
17240
|
},
|
|
@@ -19873,7 +19847,7 @@ export default {
|
|
|
19873
19847
|
},
|
|
19874
19848
|
name: {
|
|
19875
19849
|
description:
|
|
19876
|
-
"Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes
|
|
19850
|
+
"Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
19877
19851
|
type: 'string',
|
|
19878
19852
|
},
|
|
19879
19853
|
prefer_native_scheduling: {
|
|
@@ -20016,7 +19990,7 @@ export default {
|
|
|
20016
19990
|
},
|
|
20017
19991
|
name: {
|
|
20018
19992
|
description:
|
|
20019
|
-
"Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes
|
|
19993
|
+
"Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
20020
19994
|
type: 'string',
|
|
20021
19995
|
},
|
|
20022
19996
|
prefer_native_scheduling: {
|
|
@@ -20151,7 +20125,7 @@ export default {
|
|
|
20151
20125
|
},
|
|
20152
20126
|
name: {
|
|
20153
20127
|
description:
|
|
20154
|
-
"Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes
|
|
20128
|
+
"Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
20155
20129
|
type: 'string',
|
|
20156
20130
|
},
|
|
20157
20131
|
prefer_native_scheduling: {
|
|
@@ -21254,7 +21228,7 @@ export default {
|
|
|
21254
21228
|
},
|
|
21255
21229
|
name: {
|
|
21256
21230
|
description:
|
|
21257
|
-
"Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes
|
|
21231
|
+
"Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
21258
21232
|
type: 'string',
|
|
21259
21233
|
},
|
|
21260
21234
|
prefer_native_scheduling: {
|
|
@@ -21402,7 +21376,7 @@ export default {
|
|
|
21402
21376
|
},
|
|
21403
21377
|
name: {
|
|
21404
21378
|
description:
|
|
21405
|
-
"Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes
|
|
21379
|
+
"Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
21406
21380
|
type: 'string',
|
|
21407
21381
|
},
|
|
21408
21382
|
prefer_native_scheduling: {
|
|
@@ -21551,7 +21525,7 @@ export default {
|
|
|
21551
21525
|
},
|
|
21552
21526
|
name: {
|
|
21553
21527
|
description:
|
|
21554
|
-
"Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes
|
|
21528
|
+
"Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
21555
21529
|
type: 'string',
|
|
21556
21530
|
},
|
|
21557
21531
|
prefer_native_scheduling: {
|
|
@@ -21651,7 +21625,7 @@ export default {
|
|
|
21651
21625
|
},
|
|
21652
21626
|
name: {
|
|
21653
21627
|
description:
|
|
21654
|
-
"Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes
|
|
21628
|
+
"Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
21655
21629
|
type: 'string',
|
|
21656
21630
|
},
|
|
21657
21631
|
starts_at: {
|
|
@@ -21715,7 +21689,7 @@ export default {
|
|
|
21715
21689
|
},
|
|
21716
21690
|
name: {
|
|
21717
21691
|
description:
|
|
21718
|
-
"Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes
|
|
21692
|
+
"Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
21719
21693
|
type: 'string',
|
|
21720
21694
|
},
|
|
21721
21695
|
starts_at: {
|
|
@@ -27751,7 +27725,6 @@ export default {
|
|
|
27751
27725
|
'igloohome',
|
|
27752
27726
|
'hubitat',
|
|
27753
27727
|
'controlbyweb',
|
|
27754
|
-
'smartthings',
|
|
27755
27728
|
'dormakaba_oracode',
|
|
27756
27729
|
'tedee',
|
|
27757
27730
|
'akiles',
|
|
@@ -27762,6 +27735,7 @@ export default {
|
|
|
27762
27735
|
'noiseaware',
|
|
27763
27736
|
'tado',
|
|
27764
27737
|
'sensi',
|
|
27738
|
+
'smartthings',
|
|
27765
27739
|
],
|
|
27766
27740
|
type: 'string',
|
|
27767
27741
|
},
|
|
@@ -28359,7 +28333,6 @@ export default {
|
|
|
28359
28333
|
'igloohome',
|
|
28360
28334
|
'hubitat',
|
|
28361
28335
|
'controlbyweb',
|
|
28362
|
-
'smartthings',
|
|
28363
28336
|
'dormakaba_oracode',
|
|
28364
28337
|
'tedee',
|
|
28365
28338
|
'akiles',
|
|
@@ -28370,6 +28343,7 @@ export default {
|
|
|
28370
28343
|
'noiseaware',
|
|
28371
28344
|
'tado',
|
|
28372
28345
|
'sensi',
|
|
28346
|
+
'smartthings',
|
|
28373
28347
|
],
|
|
28374
28348
|
type: 'string',
|
|
28375
28349
|
},
|
|
@@ -29285,7 +29259,6 @@ export default {
|
|
|
29285
29259
|
'salto',
|
|
29286
29260
|
'schlage',
|
|
29287
29261
|
'seam',
|
|
29288
|
-
'smartthings',
|
|
29289
29262
|
'wyze',
|
|
29290
29263
|
'yale',
|
|
29291
29264
|
'two_n',
|
|
@@ -29297,6 +29270,7 @@ export default {
|
|
|
29297
29270
|
'dormakaba_oracode',
|
|
29298
29271
|
'tedee',
|
|
29299
29272
|
'akiles',
|
|
29273
|
+
'smartthings',
|
|
29300
29274
|
],
|
|
29301
29275
|
type: 'string',
|
|
29302
29276
|
},
|
|
@@ -32912,6 +32886,7 @@ export default {
|
|
|
32912
32886
|
'nest',
|
|
32913
32887
|
'tado',
|
|
32914
32888
|
'sensi',
|
|
32889
|
+
'smartthings',
|
|
32915
32890
|
],
|
|
32916
32891
|
type: 'string',
|
|
32917
32892
|
},
|