@seamapi/types 1.873.0 → 1.875.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 +70 -25
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +481 -37794
- package/dist/index.cjs +70 -25
- 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/batch.d.ts +5 -37512
- 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/openapi.js +51 -11
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +151 -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/batch.ts +38 -2
- package/src/lib/seam/connect/models/devices/device.ts +13 -0
- package/src/lib/seam/connect/openapi.ts +60 -11
- package/src/lib/seam/connect/route-types.ts +171 -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(),
|
|
@@ -7916,8 +7921,7 @@ var openapi = {
|
|
|
7916
7921
|
"x-deprecated": "Use `provider_issue` instead."
|
|
7917
7922
|
},
|
|
7918
7923
|
{
|
|
7919
|
-
|
|
7920
|
-
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.",
|
|
7921
7925
|
properties: {
|
|
7922
7926
|
created_at: {
|
|
7923
7927
|
description: "Date and time at which Seam created the error.",
|
|
@@ -7926,7 +7930,7 @@ var openapi = {
|
|
|
7926
7930
|
},
|
|
7927
7931
|
error_code: {
|
|
7928
7932
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
7929
|
-
enum: ["
|
|
7933
|
+
enum: ["insufficient_permissions"],
|
|
7930
7934
|
type: "string"
|
|
7931
7935
|
},
|
|
7932
7936
|
is_access_code_error: {
|
|
@@ -7940,8 +7944,7 @@ var openapi = {
|
|
|
7940
7944
|
}
|
|
7941
7945
|
},
|
|
7942
7946
|
required: ["message", "is_access_code_error", "error_code"],
|
|
7943
|
-
type: "object"
|
|
7944
|
-
"x-deprecated": "Use `provider_issue` instead."
|
|
7947
|
+
type: "object"
|
|
7945
7948
|
},
|
|
7946
7949
|
{
|
|
7947
7950
|
deprecated: true,
|
|
@@ -21996,6 +21999,28 @@ var openapi = {
|
|
|
21996
21999
|
],
|
|
21997
22000
|
type: "object",
|
|
21998
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"
|
|
21999
22024
|
}
|
|
22000
22025
|
]
|
|
22001
22026
|
},
|
|
@@ -32623,8 +32648,7 @@ var openapi = {
|
|
|
32623
32648
|
"x-deprecated": "Use `provider_issue` instead."
|
|
32624
32649
|
},
|
|
32625
32650
|
{
|
|
32626
|
-
|
|
32627
|
-
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.",
|
|
32628
32652
|
properties: {
|
|
32629
32653
|
created_at: {
|
|
32630
32654
|
description: "Date and time at which Seam created the error.",
|
|
@@ -32633,7 +32657,7 @@ var openapi = {
|
|
|
32633
32657
|
},
|
|
32634
32658
|
error_code: {
|
|
32635
32659
|
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
32636
|
-
enum: ["
|
|
32660
|
+
enum: ["insufficient_permissions"],
|
|
32637
32661
|
type: "string"
|
|
32638
32662
|
},
|
|
32639
32663
|
is_access_code_error: {
|
|
@@ -32647,8 +32671,7 @@ var openapi = {
|
|
|
32647
32671
|
}
|
|
32648
32672
|
},
|
|
32649
32673
|
required: ["message", "is_access_code_error", "error_code"],
|
|
32650
|
-
type: "object"
|
|
32651
|
-
"x-deprecated": "Use `provider_issue` instead."
|
|
32674
|
+
type: "object"
|
|
32652
32675
|
},
|
|
32653
32676
|
{
|
|
32654
32677
|
deprecated: true,
|
|
@@ -36659,6 +36682,28 @@ var openapi = {
|
|
|
36659
36682
|
],
|
|
36660
36683
|
type: "object",
|
|
36661
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"
|
|
36662
36707
|
}
|
|
36663
36708
|
]
|
|
36664
36709
|
},
|
|
@@ -37031,7 +37076,7 @@ var openapi = {
|
|
|
37031
37076
|
paths: {
|
|
37032
37077
|
"/access_codes/create": {
|
|
37033
37078
|
post: {
|
|
37034
|
-
description: "Creates a new [access code](https://docs.seam.co/latest/
|
|
37079
|
+
description: "Creates a new [access code](https://docs.seam.co/latest/low-level-apis/access-codes). For granting access, we recommend [Access Grants](https://docs.seam.co/latest/use-cases/granting-access) instead: they work across both standalone smart locks and access control systems and manage the underlying codes for you. Use this low-level endpoint only when you need direct control over a code on a single device, such as setting a custom PIN value.",
|
|
37035
37080
|
operationId: "accessCodesCreatePost",
|
|
37036
37081
|
requestBody: {
|
|
37037
37082
|
content: {
|
|
@@ -39840,7 +39885,7 @@ var openapi = {
|
|
|
39840
39885
|
},
|
|
39841
39886
|
"/access_grants/create": {
|
|
39842
39887
|
post: {
|
|
39843
|
-
description: "Creates a new Access Grant.",
|
|
39888
|
+
description: "Creates a new [Access Grant](https://docs.seam.co/latest/use-cases/granting-access/access-grants). Access Grants are the default and recommended way to grant a user access to any physical space, irrespective of the locking hardware. They work with both standalone smart locks (using `device_ids`) and access control systems (using `acs_entrance_ids` or `space_ids`), and can issue PIN codes, key cards, and mobile keys through a single request.",
|
|
39844
39889
|
operationId: "accessGrantsCreatePost",
|
|
39845
39890
|
requestBody: {
|
|
39846
39891
|
content: {
|
|
@@ -47462,7 +47507,7 @@ var openapi = {
|
|
|
47462
47507
|
},
|
|
47463
47508
|
"/acs/credentials/create": {
|
|
47464
47509
|
post: {
|
|
47465
|
-
description: "Creates a new [credential](https://docs.seam.co/latest/
|
|
47510
|
+
description: "Creates a new [credential](https://docs.seam.co/latest/low-level-apis/managing-credentials) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). For granting access, we recommend [Access Grants](https://docs.seam.co/latest/use-cases/granting-access) instead: they create and manage the underlying credentials for you, across access systems and standalone smart locks alike. Use this low-level endpoint only when you need direct control over an individual ACS credential.",
|
|
47466
47511
|
operationId: "acsCredentialsCreatePost",
|
|
47467
47512
|
requestBody: {
|
|
47468
47513
|
content: {
|