@seamapi/types 1.872.0 → 1.874.0
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 +133 -24
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +1446 -38602
- package/dist/index.cjs +133 -24
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/access-codes/managed-access-code.d.ts +24 -24
- package/lib/seam/connect/models/access-codes/managed-access-code.js +5 -12
- package/lib/seam/connect/models/access-codes/managed-access-code.js.map +1 -1
- package/lib/seam/connect/models/access-codes/unmanaged-access-code.d.ts +5 -5
- package/lib/seam/connect/models/acs/acs-entrance.d.ts +48 -0
- package/lib/seam/connect/models/acs/acs-entrance.js +13 -0
- package/lib/seam/connect/models/acs/acs-entrance.js.map +1 -1
- package/lib/seam/connect/models/batch.d.ts +5 -37478
- package/lib/seam/connect/models/batch.js.map +1 -1
- package/lib/seam/connect/models/devices/device.d.ts +58 -0
- package/lib/seam/connect/models/devices/device.js +12 -0
- package/lib/seam/connect/models/devices/device.js.map +1 -1
- package/lib/seam/connect/models/devices/unmanaged-device.d.ts +21 -0
- package/lib/seam/connect/models/phones/phone-session.d.ts +98 -0
- package/lib/seam/connect/openapi.js +102 -8
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +250 -11
- package/package.json +1 -1
- package/src/lib/seam/connect/models/access-codes/managed-access-code.ts +5 -12
- package/src/lib/seam/connect/models/acs/acs-entrance.ts +18 -0
- package/src/lib/seam/connect/models/batch.ts +38 -2
- package/src/lib/seam/connect/models/devices/device.ts +13 -0
- package/src/lib/seam/connect/openapi.ts +120 -8
- package/src/lib/seam/connect/route-types.ts +281 -11
package/dist/index.cjs
CHANGED
|
@@ -1604,6 +1604,14 @@ var max_access_codes_reached = common_device_warning.extend({
|
|
|
1604
1604
|
---
|
|
1605
1605
|
Indicates that the device has reached its maximum number of active access codes. Delete existing codes before creating new ones.
|
|
1606
1606
|
`);
|
|
1607
|
+
var insufficient_permissions = common_device_warning.extend({
|
|
1608
|
+
warning_code: zod.z.literal("insufficient_permissions").describe(warning_code_description2)
|
|
1609
|
+
}).describe(`
|
|
1610
|
+
---
|
|
1611
|
+
variant_group_key: locks
|
|
1612
|
+
---
|
|
1613
|
+
Indicates that the connected Kwikset account has member-level access to this lock's home. Admin or owner access is required to manage access codes and control the lock remotely.
|
|
1614
|
+
`);
|
|
1607
1615
|
var device_warning = zod.z.discriminatedUnion("warning_code", [
|
|
1608
1616
|
partial_backup_access_code_pool,
|
|
1609
1617
|
many_active_backup_codes,
|
|
@@ -1628,7 +1636,8 @@ var device_warning = zod.z.discriminatedUnion("warning_code", [
|
|
|
1628
1636
|
keynest_unsupported_locker,
|
|
1629
1637
|
accessory_keypad_setup_required,
|
|
1630
1638
|
unreliable_online_status,
|
|
1631
|
-
max_access_codes_reached
|
|
1639
|
+
max_access_codes_reached,
|
|
1640
|
+
insufficient_permissions
|
|
1632
1641
|
]);
|
|
1633
1642
|
zod.z.object({
|
|
1634
1643
|
partial_backup_access_code_pool: partial_backup_access_code_pool.optional().nullable(),
|
|
@@ -1657,7 +1666,8 @@ zod.z.object({
|
|
|
1657
1666
|
keynest_unsupported_locker: keynest_unsupported_locker.optional().nullable(),
|
|
1658
1667
|
accessory_keypad_setup_required: accessory_keypad_setup_required.optional().nullable(),
|
|
1659
1668
|
unreliable_online_status: unreliable_online_status.optional().nullable(),
|
|
1660
|
-
max_access_codes_reached: max_access_codes_reached.optional().nullable()
|
|
1669
|
+
max_access_codes_reached: max_access_codes_reached.optional().nullable(),
|
|
1670
|
+
insufficient_permissions: insufficient_permissions.optional().nullable()
|
|
1661
1671
|
});
|
|
1662
1672
|
var device_provider_info = zod.z.object({
|
|
1663
1673
|
provider_category: zod.z.string().describe(
|
|
@@ -2395,15 +2405,10 @@ var kwikset_unable_to_confirm_deletion = common_access_code_error.extend({
|
|
|
2395
2405
|
Unable to confirm the deletion of the access code on Kwikset device.
|
|
2396
2406
|
`
|
|
2397
2407
|
);
|
|
2398
|
-
var
|
|
2399
|
-
error_code: zod.z.literal("
|
|
2408
|
+
var insufficient_permissions2 = common_access_code_error.extend({
|
|
2409
|
+
error_code: zod.z.literal("insufficient_permissions").describe(error_code_description3)
|
|
2400
2410
|
}).describe(
|
|
2401
|
-
|
|
2402
|
-
---
|
|
2403
|
-
deprecated: Use \`provider_issue\` instead.
|
|
2404
|
-
---
|
|
2405
|
-
Admin role required\u2014insufficient permissions to manage PINs on this Kwikset device. Please have a Home Admin update your role in the Kwikset app, or ask them to set the PIN.
|
|
2406
|
-
`
|
|
2411
|
+
"Admin role required\u2014insufficient permissions to manage PINs on this device. Please have an admin update your role, or ask them to set the PIN."
|
|
2407
2412
|
);
|
|
2408
2413
|
var august_lock_invalid_code_length = common_access_code_error.extend({
|
|
2409
2414
|
error_code: zod.z.literal("august_lock_invalid_code_length").describe(error_code_description3)
|
|
@@ -2516,7 +2521,7 @@ var access_code_error = zod.z.discriminatedUnion("error_code", [
|
|
|
2516
2521
|
wyze_duplicate_code_name,
|
|
2517
2522
|
wyze_potential_duplicate_code,
|
|
2518
2523
|
dormakaba_oracode_invalid_time_range,
|
|
2519
|
-
|
|
2524
|
+
insufficient_permissions2,
|
|
2520
2525
|
keynest_unsupported_third_party_locker,
|
|
2521
2526
|
replaced_by_newer_access_code
|
|
2522
2527
|
]).describe(
|
|
@@ -2534,7 +2539,7 @@ zod.z.object({
|
|
|
2534
2539
|
access_code_state_unconfirmed: access_code_state_unconfirmed.optional().nullable(),
|
|
2535
2540
|
kwikset_unable_to_confirm_code: kwikset_unable_to_confirm_code.optional().nullable(),
|
|
2536
2541
|
kwikset_unable_to_confirm_deletion: kwikset_unable_to_confirm_deletion.optional().nullable(),
|
|
2537
|
-
|
|
2542
|
+
insufficient_permissions: insufficient_permissions2.optional().nullable(),
|
|
2538
2543
|
code_modified_external_to_seam_error: code_modified_external_to_seam_error.optional().nullable(),
|
|
2539
2544
|
august_lock_invalid_code_length: august_lock_invalid_code_length.optional().nullable(),
|
|
2540
2545
|
august_lock_temporarily_offline: august_lock_temporarily_offline_error.optional().nullable(),
|
|
@@ -3922,17 +3927,24 @@ var entrance_setup_required = common_acs_entrance_warning.extend({
|
|
|
3922
3927
|
}).describe(
|
|
3923
3928
|
"Indicates that this entrance requires additional configuration in the access control system before Seam can fully manage it."
|
|
3924
3929
|
);
|
|
3930
|
+
var salto_ks_privacy_mode2 = common_acs_entrance_warning.extend({
|
|
3931
|
+
warning_code: zod.z.literal("salto_ks_privacy_mode").describe(warning_code_description8)
|
|
3932
|
+
}).describe(
|
|
3933
|
+
"Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access."
|
|
3934
|
+
);
|
|
3925
3935
|
var acs_entrance_warning = zod.z.discriminatedUnion("warning_code", [
|
|
3926
3936
|
salto_ks_entrance_access_code_support_removed,
|
|
3927
3937
|
entrance_shares_zone,
|
|
3928
|
-
entrance_setup_required
|
|
3938
|
+
entrance_setup_required,
|
|
3939
|
+
salto_ks_privacy_mode2
|
|
3929
3940
|
]).describe(
|
|
3930
3941
|
"Warning associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)."
|
|
3931
3942
|
);
|
|
3932
3943
|
zod.z.object({
|
|
3933
3944
|
salto_ks_entrance_access_code_support_removed: salto_ks_entrance_access_code_support_removed.optional().nullable(),
|
|
3934
3945
|
entrance_shares_zone: entrance_shares_zone.optional().nullable(),
|
|
3935
|
-
entrance_setup_required: entrance_setup_required.optional().nullable()
|
|
3946
|
+
entrance_setup_required: entrance_setup_required.optional().nullable(),
|
|
3947
|
+
salto_ks_privacy_mode: salto_ks_privacy_mode2.optional().nullable()
|
|
3936
3948
|
});
|
|
3937
3949
|
var acs_entrance_capability_flags = zod.z.object({
|
|
3938
3950
|
can_unlock_with_mobile_key: zod.z.boolean().optional().describe(
|
|
@@ -4012,6 +4024,9 @@ var acs_entrance = zod.z.object({
|
|
|
4012
4024
|
),
|
|
4013
4025
|
avigilon_alta_metadata: acs_entrance_avigilon_alta_metadata.optional().describe(
|
|
4014
4026
|
"Avigilon Alta-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)."
|
|
4027
|
+
),
|
|
4028
|
+
is_locked: zod.z.boolean().optional().describe(
|
|
4029
|
+
"Indicates whether the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) is currently locked."
|
|
4015
4030
|
)
|
|
4016
4031
|
}).merge(acs_entrance_capability_flags).describe(`
|
|
4017
4032
|
---
|
|
@@ -7906,8 +7921,7 @@ var openapi = {
|
|
|
7906
7921
|
"x-deprecated": "Use `provider_issue` instead."
|
|
7907
7922
|
},
|
|
7908
7923
|
{
|
|
7909
|
-
|
|
7910
|
-
description: "Admin role required\u2014insufficient permissions to manage PINs on this Kwikset device. Please have a Home Admin update your role in the Kwikset app, or ask them to set the PIN.",
|
|
7924
|
+
description: "Admin role required\u2014insufficient permissions to manage PINs on this device. Please have an admin update your role, or ask them to set the PIN.",
|
|
7911
7925
|
properties: {
|
|
7912
7926
|
created_at: {
|
|
7913
7927
|
description: "Date and time at which Seam created the error.",
|
|
@@ -7916,7 +7930,7 @@ var openapi = {
|
|
|
7916
7930
|
},
|
|
7917
7931
|
error_code: {
|
|
7918
7932
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
7919
|
-
enum: ["
|
|
7933
|
+
enum: ["insufficient_permissions"],
|
|
7920
7934
|
type: "string"
|
|
7921
7935
|
},
|
|
7922
7936
|
is_access_code_error: {
|
|
@@ -7930,8 +7944,7 @@ var openapi = {
|
|
|
7930
7944
|
}
|
|
7931
7945
|
},
|
|
7932
7946
|
required: ["message", "is_access_code_error", "error_code"],
|
|
7933
|
-
type: "object"
|
|
7934
|
-
"x-deprecated": "Use `provider_issue` instead."
|
|
7947
|
+
type: "object"
|
|
7935
7948
|
},
|
|
7936
7949
|
{
|
|
7937
7950
|
deprecated: true,
|
|
@@ -11330,6 +11343,10 @@ var openapi = {
|
|
|
11330
11343
|
},
|
|
11331
11344
|
type: "object"
|
|
11332
11345
|
},
|
|
11346
|
+
is_locked: {
|
|
11347
|
+
description: "Indicates whether the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) is currently locked.",
|
|
11348
|
+
type: "boolean"
|
|
11349
|
+
},
|
|
11333
11350
|
latch_metadata: {
|
|
11334
11351
|
description: "Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
|
|
11335
11352
|
properties: {
|
|
@@ -11549,6 +11566,27 @@ var openapi = {
|
|
|
11549
11566
|
},
|
|
11550
11567
|
required: ["created_at", "message", "warning_code"],
|
|
11551
11568
|
type: "object"
|
|
11569
|
+
},
|
|
11570
|
+
{
|
|
11571
|
+
description: "Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access.",
|
|
11572
|
+
properties: {
|
|
11573
|
+
created_at: {
|
|
11574
|
+
description: "Date and time at which Seam created the warning.",
|
|
11575
|
+
format: "date-time",
|
|
11576
|
+
type: "string"
|
|
11577
|
+
},
|
|
11578
|
+
message: {
|
|
11579
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
11580
|
+
type: "string"
|
|
11581
|
+
},
|
|
11582
|
+
warning_code: {
|
|
11583
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
11584
|
+
enum: ["salto_ks_privacy_mode"],
|
|
11585
|
+
type: "string"
|
|
11586
|
+
}
|
|
11587
|
+
},
|
|
11588
|
+
required: ["created_at", "message", "warning_code"],
|
|
11589
|
+
type: "object"
|
|
11552
11590
|
}
|
|
11553
11591
|
]
|
|
11554
11592
|
},
|
|
@@ -21961,6 +21999,28 @@ var openapi = {
|
|
|
21961
21999
|
],
|
|
21962
22000
|
type: "object",
|
|
21963
22001
|
"x-variant-group-key": "access_codes"
|
|
22002
|
+
},
|
|
22003
|
+
{
|
|
22004
|
+
description: "Indicates that the connected Kwikset account has member-level access to this lock's home. Admin or owner access is required to manage access codes and control the lock remotely.",
|
|
22005
|
+
properties: {
|
|
22006
|
+
created_at: {
|
|
22007
|
+
description: "Date and time at which Seam created the warning.",
|
|
22008
|
+
format: "date-time",
|
|
22009
|
+
type: "string"
|
|
22010
|
+
},
|
|
22011
|
+
message: {
|
|
22012
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
22013
|
+
type: "string"
|
|
22014
|
+
},
|
|
22015
|
+
warning_code: {
|
|
22016
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
22017
|
+
enum: ["insufficient_permissions"],
|
|
22018
|
+
type: "string"
|
|
22019
|
+
}
|
|
22020
|
+
},
|
|
22021
|
+
required: ["message", "created_at", "warning_code"],
|
|
22022
|
+
type: "object",
|
|
22023
|
+
"x-variant-group-key": "locks"
|
|
21964
22024
|
}
|
|
21965
22025
|
]
|
|
21966
22026
|
},
|
|
@@ -30745,6 +30805,10 @@ var openapi = {
|
|
|
30745
30805
|
},
|
|
30746
30806
|
type: "object"
|
|
30747
30807
|
},
|
|
30808
|
+
is_locked: {
|
|
30809
|
+
description: "Indicates whether the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) is currently locked.",
|
|
30810
|
+
type: "boolean"
|
|
30811
|
+
},
|
|
30748
30812
|
latch_metadata: {
|
|
30749
30813
|
description: "Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
|
|
30750
30814
|
properties: {
|
|
@@ -30978,6 +31042,31 @@ var openapi = {
|
|
|
30978
31042
|
"warning_code"
|
|
30979
31043
|
],
|
|
30980
31044
|
type: "object"
|
|
31045
|
+
},
|
|
31046
|
+
{
|
|
31047
|
+
description: "Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access.",
|
|
31048
|
+
properties: {
|
|
31049
|
+
created_at: {
|
|
31050
|
+
description: "Date and time at which Seam created the warning.",
|
|
31051
|
+
format: "date-time",
|
|
31052
|
+
type: "string"
|
|
31053
|
+
},
|
|
31054
|
+
message: {
|
|
31055
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
31056
|
+
type: "string"
|
|
31057
|
+
},
|
|
31058
|
+
warning_code: {
|
|
31059
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
31060
|
+
enum: ["salto_ks_privacy_mode"],
|
|
31061
|
+
type: "string"
|
|
31062
|
+
}
|
|
31063
|
+
},
|
|
31064
|
+
required: [
|
|
31065
|
+
"created_at",
|
|
31066
|
+
"message",
|
|
31067
|
+
"warning_code"
|
|
31068
|
+
],
|
|
31069
|
+
type: "object"
|
|
30981
31070
|
}
|
|
30982
31071
|
]
|
|
30983
31072
|
},
|
|
@@ -32559,8 +32648,7 @@ var openapi = {
|
|
|
32559
32648
|
"x-deprecated": "Use `provider_issue` instead."
|
|
32560
32649
|
},
|
|
32561
32650
|
{
|
|
32562
|
-
|
|
32563
|
-
description: "Admin role required\u2014insufficient permissions to manage PINs on this Kwikset device. Please have a Home Admin update your role in the Kwikset app, or ask them to set the PIN.",
|
|
32651
|
+
description: "Admin role required\u2014insufficient permissions to manage PINs on this device. Please have an admin update your role, or ask them to set the PIN.",
|
|
32564
32652
|
properties: {
|
|
32565
32653
|
created_at: {
|
|
32566
32654
|
description: "Date and time at which Seam created the error.",
|
|
@@ -32569,7 +32657,7 @@ var openapi = {
|
|
|
32569
32657
|
},
|
|
32570
32658
|
error_code: {
|
|
32571
32659
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
32572
|
-
enum: ["
|
|
32660
|
+
enum: ["insufficient_permissions"],
|
|
32573
32661
|
type: "string"
|
|
32574
32662
|
},
|
|
32575
32663
|
is_access_code_error: {
|
|
@@ -32583,8 +32671,7 @@ var openapi = {
|
|
|
32583
32671
|
}
|
|
32584
32672
|
},
|
|
32585
32673
|
required: ["message", "is_access_code_error", "error_code"],
|
|
32586
|
-
type: "object"
|
|
32587
|
-
"x-deprecated": "Use `provider_issue` instead."
|
|
32674
|
+
type: "object"
|
|
32588
32675
|
},
|
|
32589
32676
|
{
|
|
32590
32677
|
deprecated: true,
|
|
@@ -36595,6 +36682,28 @@ var openapi = {
|
|
|
36595
36682
|
],
|
|
36596
36683
|
type: "object",
|
|
36597
36684
|
"x-variant-group-key": "access_codes"
|
|
36685
|
+
},
|
|
36686
|
+
{
|
|
36687
|
+
description: "Indicates that the connected Kwikset account has member-level access to this lock's home. Admin or owner access is required to manage access codes and control the lock remotely.",
|
|
36688
|
+
properties: {
|
|
36689
|
+
created_at: {
|
|
36690
|
+
description: "Date and time at which Seam created the warning.",
|
|
36691
|
+
format: "date-time",
|
|
36692
|
+
type: "string"
|
|
36693
|
+
},
|
|
36694
|
+
message: {
|
|
36695
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
36696
|
+
type: "string"
|
|
36697
|
+
},
|
|
36698
|
+
warning_code: {
|
|
36699
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
36700
|
+
enum: ["insufficient_permissions"],
|
|
36701
|
+
type: "string"
|
|
36702
|
+
}
|
|
36703
|
+
},
|
|
36704
|
+
required: ["message", "created_at", "warning_code"],
|
|
36705
|
+
type: "object",
|
|
36706
|
+
"x-variant-group-key": "locks"
|
|
36598
36707
|
}
|
|
36599
36708
|
]
|
|
36600
36709
|
},
|