@seamapi/types 1.463.0 → 1.464.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 +57 -55
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +91 -279
- package/dist/index.cjs +57 -55
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/access-codes/managed-access-code.d.ts +4 -4
- package/lib/seam/connect/models/access-codes/managed-access-code.js +2 -2
- package/lib/seam/connect/models/access-codes/managed-access-code.js.map +1 -1
- package/lib/seam/connect/models/access-grants/access-grant.d.ts +6 -6
- package/lib/seam/connect/models/access-grants/access-grant.js +1 -2
- package/lib/seam/connect/models/access-grants/access-grant.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-access-group.d.ts +2 -2
- package/lib/seam/connect/models/acs/acs-access-group.js +1 -1
- package/lib/seam/connect/models/acs/acs-access-group.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-credential.d.ts +2 -2
- package/lib/seam/connect/models/acs/acs-credential.js +1 -1
- package/lib/seam/connect/models/acs/acs-credential.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-encoder.d.ts +2 -2
- package/lib/seam/connect/models/acs/acs-encoder.js +1 -1
- package/lib/seam/connect/models/acs/acs-encoder.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-system.d.ts +5 -4
- package/lib/seam/connect/models/acs/acs-system.js +2 -2
- package/lib/seam/connect/models/acs/acs-system.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-users/acs-user.d.ts +5 -4
- package/lib/seam/connect/models/acs/acs-users/acs-user.js +2 -2
- package/lib/seam/connect/models/acs/acs-users/acs-user.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-users/pending-mutations.d.ts +3 -2
- package/lib/seam/connect/models/acs/acs-users/pending-mutations.js +1 -1
- package/lib/seam/connect/models/acs/acs-users/pending-mutations.js.map +1 -1
- package/lib/seam/connect/models/batch.d.ts +0 -203
- package/lib/seam/connect/models/bridges/bridge-client-session.d.ts +2 -2
- package/lib/seam/connect/models/bridges/bridge-client-session.js +1 -1
- package/lib/seam/connect/models/bridges/bridge-client-session.js.map +1 -1
- package/lib/seam/connect/models/connected-accounts/connected-account.d.ts +4 -4
- package/lib/seam/connect/models/connected-accounts/connected-account.js +2 -2
- package/lib/seam/connect/models/connected-accounts/connected-account.js.map +1 -1
- package/lib/seam/connect/models/customer/customer-portal.d.ts +34 -0
- package/lib/seam/connect/models/customer/customer-portal.js +18 -0
- package/lib/seam/connect/models/customer/customer-portal.js.map +1 -1
- package/lib/seam/connect/models/devices/device.d.ts +4 -62
- package/lib/seam/connect/models/devices/device.js +2 -16
- package/lib/seam/connect/models/devices/device.js.map +1 -1
- package/lib/seam/connect/models/devices/unmanaged-device.d.ts +0 -21
- package/lib/seam/connect/models/user-identities/user-identity.d.ts +5 -4
- package/lib/seam/connect/models/user-identities/user-identity.js +2 -2
- package/lib/seam/connect/models/user-identities/user-identity.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +58 -0
- package/lib/seam/connect/openapi.js +56 -44
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +27 -160
- package/package.json +1 -1
- package/src/lib/seam/connect/models/access-codes/managed-access-code.ts +4 -4
- package/src/lib/seam/connect/models/access-grants/access-grant.ts +1 -2
- package/src/lib/seam/connect/models/acs/acs-access-group.ts +2 -2
- package/src/lib/seam/connect/models/acs/acs-credential.ts +4 -2
- package/src/lib/seam/connect/models/acs/acs-encoder.ts +2 -2
- package/src/lib/seam/connect/models/acs/acs-system.ts +4 -4
- package/src/lib/seam/connect/models/acs/acs-users/acs-user.ts +4 -4
- package/src/lib/seam/connect/models/acs/acs-users/pending-mutations.ts +2 -2
- package/src/lib/seam/connect/models/bridges/bridge-client-session.ts +2 -2
- package/src/lib/seam/connect/models/connected-accounts/connected-account.ts +4 -4
- package/src/lib/seam/connect/models/customer/customer-portal.ts +23 -0
- package/src/lib/seam/connect/models/devices/device.ts +4 -19
- package/src/lib/seam/connect/models/user-identities/user-identity.ts +4 -4
- package/src/lib/seam/connect/openapi.ts +60 -52
- package/src/lib/seam/connect/route-types.ts +31 -181
|
@@ -11,6 +11,21 @@ const base_connect_feature = base_feature
|
|
|
11
11
|
const base_manage_devices_feature = base_feature
|
|
12
12
|
const base_organize_feature = base_feature
|
|
13
13
|
|
|
14
|
+
const base_configure_feature = base_feature.extend({
|
|
15
|
+
allow_access_automation_rule_customization: z
|
|
16
|
+
.boolean()
|
|
17
|
+
.default(false)
|
|
18
|
+
.describe(
|
|
19
|
+
'Indicates whether the customer can customize the access automation rules for their properties.',
|
|
20
|
+
),
|
|
21
|
+
allow_instant_key_customization: z
|
|
22
|
+
.boolean()
|
|
23
|
+
.default(false)
|
|
24
|
+
.describe(
|
|
25
|
+
'Indicates whether the customer can customize the Instant Key profile for their properties.',
|
|
26
|
+
),
|
|
27
|
+
})
|
|
28
|
+
|
|
14
29
|
const base_features = z.object({
|
|
15
30
|
connect: base_connect_feature
|
|
16
31
|
.default({})
|
|
@@ -21,6 +36,9 @@ const base_features = z.object({
|
|
|
21
36
|
organize: base_organize_feature
|
|
22
37
|
.default({})
|
|
23
38
|
.describe('Configuration for the organize feature.'),
|
|
39
|
+
configure: base_configure_feature
|
|
40
|
+
.default({})
|
|
41
|
+
.describe('Configuration for the configure feature.'),
|
|
24
42
|
})
|
|
25
43
|
|
|
26
44
|
export const portal_configuration = z
|
|
@@ -36,6 +54,11 @@ export const portal_configuration = z
|
|
|
36
54
|
connect: { exclude: false },
|
|
37
55
|
organize: { exclude: false },
|
|
38
56
|
manage_devices: { exclude: false },
|
|
57
|
+
configure: {
|
|
58
|
+
exclude: false,
|
|
59
|
+
allow_instant_key_customization: false, // default
|
|
60
|
+
allow_access_automation_rule_customization: false, // default
|
|
61
|
+
},
|
|
39
62
|
},
|
|
40
63
|
is_embedded: false,
|
|
41
64
|
})
|
|
@@ -207,7 +207,7 @@ export const device_error = z
|
|
|
207
207
|
|
|
208
208
|
export type DeviceError = z.infer<typeof device_error>
|
|
209
209
|
|
|
210
|
-
const
|
|
210
|
+
const _device_error_map = z.object({
|
|
211
211
|
device_offline: device_offline.optional().nullable(),
|
|
212
212
|
device_removed: device_removed.optional().nullable(),
|
|
213
213
|
hub_disconnected: hub_disconnected.optional().nullable(),
|
|
@@ -230,7 +230,7 @@ const device_error_map = z.object({
|
|
|
230
230
|
lockly_missing_wifi_bridge: lockly_missing_wifi_bridge.optional().nullable(),
|
|
231
231
|
})
|
|
232
232
|
|
|
233
|
-
export type DeviceErrorMap = z.infer<typeof
|
|
233
|
+
export type DeviceErrorMap = z.infer<typeof _device_error_map>
|
|
234
234
|
|
|
235
235
|
const warning_code_description =
|
|
236
236
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.'
|
|
@@ -327,17 +327,6 @@ const third_party_integration_detected = common_device_warning
|
|
|
327
327
|
})
|
|
328
328
|
.describe('Indicates that a third-party integration has been detected.')
|
|
329
329
|
|
|
330
|
-
const nest_thermostat_in_manual_eco_mode = common_device_warning.extend({
|
|
331
|
-
warning_code: z
|
|
332
|
-
.literal('nest_thermostat_in_manual_eco_mode')
|
|
333
|
-
.describe(warning_code_description),
|
|
334
|
-
}).describe(`
|
|
335
|
-
---
|
|
336
|
-
variant_group_key: thermostats
|
|
337
|
-
---
|
|
338
|
-
Indicates that the Nest thermostat is in manual eco mode.
|
|
339
|
-
`)
|
|
340
|
-
|
|
341
330
|
const ttlock_lock_gateway_unlocking_not_enabled = common_device_warning.extend({
|
|
342
331
|
warning_code: z
|
|
343
332
|
.literal('ttlock_lock_gateway_unlocking_not_enabled')
|
|
@@ -430,7 +419,6 @@ const device_warning = z.discriminatedUnion('warning_code', [
|
|
|
430
419
|
wyze_device_missing_gateway,
|
|
431
420
|
functional_offline_device,
|
|
432
421
|
third_party_integration_detected,
|
|
433
|
-
nest_thermostat_in_manual_eco_mode,
|
|
434
422
|
ttlock_lock_gateway_unlocking_not_enabled,
|
|
435
423
|
ttlock_weak_gateway_signal,
|
|
436
424
|
power_saving_mode,
|
|
@@ -447,7 +435,7 @@ const device_warning = z.discriminatedUnion('warning_code', [
|
|
|
447
435
|
|
|
448
436
|
export type DeviceWarning = z.infer<typeof device_warning>
|
|
449
437
|
|
|
450
|
-
|
|
438
|
+
const _device_warning_map = z.object({
|
|
451
439
|
partial_backup_access_code_pool: partial_backup_access_code_pool
|
|
452
440
|
.optional()
|
|
453
441
|
.nullable(),
|
|
@@ -466,9 +454,6 @@ export const device_warning_map = z.object({
|
|
|
466
454
|
third_party_integration_detected: third_party_integration_detected
|
|
467
455
|
.optional()
|
|
468
456
|
.nullable(),
|
|
469
|
-
nest_thermostat_in_manual_eco_mode: nest_thermostat_in_manual_eco_mode
|
|
470
|
-
.optional()
|
|
471
|
-
.nullable(),
|
|
472
457
|
ttlock_lock_gateway_unlocking_not_enabled:
|
|
473
458
|
ttlock_lock_gateway_unlocking_not_enabled.optional().nullable(),
|
|
474
459
|
ttlock_weak_gateway_signal: ttlock_weak_gateway_signal.optional().nullable(),
|
|
@@ -492,7 +477,7 @@ export const device_warning_map = z.object({
|
|
|
492
477
|
.nullable(),
|
|
493
478
|
})
|
|
494
479
|
|
|
495
|
-
export type DeviceWarningMap = z.infer<typeof
|
|
480
|
+
export type DeviceWarningMap = z.infer<typeof _device_warning_map>
|
|
496
481
|
|
|
497
482
|
export const common_device_properties = z.object({
|
|
498
483
|
online: z.boolean().describe('Indicates whether the device is online.'),
|
|
@@ -71,7 +71,7 @@ const user_identity_issue_with_acs_user = common_user_identity_error
|
|
|
71
71
|
'Indicates that there is an issue with an access system user associated with this user identity.',
|
|
72
72
|
)
|
|
73
73
|
|
|
74
|
-
|
|
74
|
+
const _user_identity_error_map = z.object({
|
|
75
75
|
issue_with_acs_user: z
|
|
76
76
|
.record(z.string().uuid(), user_identity_issue_with_acs_user)
|
|
77
77
|
.optional()
|
|
@@ -81,7 +81,7 @@ export const user_identity_error_map = z.object({
|
|
|
81
81
|
),
|
|
82
82
|
})
|
|
83
83
|
|
|
84
|
-
export type UserIdentityErrorMap = z.infer<typeof
|
|
84
|
+
export type UserIdentityErrorMap = z.infer<typeof _user_identity_error_map>
|
|
85
85
|
|
|
86
86
|
const user_identity_warnings = z
|
|
87
87
|
.discriminatedUnion('warning_code', [
|
|
@@ -90,7 +90,7 @@ const user_identity_warnings = z
|
|
|
90
90
|
])
|
|
91
91
|
.describe('Warnings associated with the user identity.')
|
|
92
92
|
|
|
93
|
-
|
|
93
|
+
const _user_identity_warning_map = z.object({
|
|
94
94
|
user_identity_being_deleted: user_identity_being_deleted
|
|
95
95
|
.optional()
|
|
96
96
|
.nullable(),
|
|
@@ -98,7 +98,7 @@ export const user_identity_warning_map = z.object({
|
|
|
98
98
|
acs_user_profile_does_not_match_user_identity.optional().nullable(),
|
|
99
99
|
})
|
|
100
100
|
|
|
101
|
-
export type UserIdentityWarningMap = z.infer<typeof
|
|
101
|
+
export type UserIdentityWarningMap = z.infer<typeof _user_identity_warning_map>
|
|
102
102
|
|
|
103
103
|
const user_identity_errors = z
|
|
104
104
|
.discriminatedUnion('error_code', [user_identity_issue_with_acs_user])
|
|
@@ -1850,6 +1850,7 @@ export default {
|
|
|
1850
1850
|
ends_at: {
|
|
1851
1851
|
description: 'Date and time at which the Access Grant ends.',
|
|
1852
1852
|
format: 'date-time',
|
|
1853
|
+
nullable: true,
|
|
1853
1854
|
type: 'string',
|
|
1854
1855
|
},
|
|
1855
1856
|
instant_key_url: {
|
|
@@ -1943,6 +1944,8 @@ export default {
|
|
|
1943
1944
|
'name',
|
|
1944
1945
|
'display_name',
|
|
1945
1946
|
'created_at',
|
|
1947
|
+
'starts_at',
|
|
1948
|
+
'ends_at',
|
|
1946
1949
|
],
|
|
1947
1950
|
type: 'object',
|
|
1948
1951
|
'x-draft': 'Early access.',
|
|
@@ -12581,32 +12584,6 @@ export default {
|
|
|
12581
12584
|
required: ['message', 'created_at', 'warning_code'],
|
|
12582
12585
|
type: 'object',
|
|
12583
12586
|
},
|
|
12584
|
-
{
|
|
12585
|
-
description:
|
|
12586
|
-
'Indicates that the Nest thermostat is in manual eco mode.',
|
|
12587
|
-
properties: {
|
|
12588
|
-
created_at: {
|
|
12589
|
-
description:
|
|
12590
|
-
'Date and time at which Seam created the warning.',
|
|
12591
|
-
format: 'date-time',
|
|
12592
|
-
type: 'string',
|
|
12593
|
-
},
|
|
12594
|
-
message: {
|
|
12595
|
-
description:
|
|
12596
|
-
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
12597
|
-
type: 'string',
|
|
12598
|
-
},
|
|
12599
|
-
warning_code: {
|
|
12600
|
-
description:
|
|
12601
|
-
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
12602
|
-
enum: ['nest_thermostat_in_manual_eco_mode'],
|
|
12603
|
-
type: 'string',
|
|
12604
|
-
},
|
|
12605
|
-
},
|
|
12606
|
-
required: ['message', 'created_at', 'warning_code'],
|
|
12607
|
-
type: 'object',
|
|
12608
|
-
'x-variant-group-key': 'thermostats',
|
|
12609
|
-
},
|
|
12610
12587
|
{
|
|
12611
12588
|
description:
|
|
12612
12589
|
'Indicates that the Remote Unlock feature is not enabled in the settings."',
|
|
@@ -24655,32 +24632,6 @@ export default {
|
|
|
24655
24632
|
required: ['message', 'created_at', 'warning_code'],
|
|
24656
24633
|
type: 'object',
|
|
24657
24634
|
},
|
|
24658
|
-
{
|
|
24659
|
-
description:
|
|
24660
|
-
'Indicates that the Nest thermostat is in manual eco mode.',
|
|
24661
|
-
properties: {
|
|
24662
|
-
created_at: {
|
|
24663
|
-
description:
|
|
24664
|
-
'Date and time at which Seam created the warning.',
|
|
24665
|
-
format: 'date-time',
|
|
24666
|
-
type: 'string',
|
|
24667
|
-
},
|
|
24668
|
-
message: {
|
|
24669
|
-
description:
|
|
24670
|
-
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
24671
|
-
type: 'string',
|
|
24672
|
-
},
|
|
24673
|
-
warning_code: {
|
|
24674
|
-
description:
|
|
24675
|
-
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
24676
|
-
enum: ['nest_thermostat_in_manual_eco_mode'],
|
|
24677
|
-
type: 'string',
|
|
24678
|
-
},
|
|
24679
|
-
},
|
|
24680
|
-
required: ['message', 'created_at', 'warning_code'],
|
|
24681
|
-
type: 'object',
|
|
24682
|
-
'x-variant-group-key': 'thermostats',
|
|
24683
|
-
},
|
|
24684
24635
|
{
|
|
24685
24636
|
description:
|
|
24686
24637
|
'Indicates that the Remote Unlock feature is not enabled in the settings."',
|
|
@@ -28001,8 +27952,10 @@ export default {
|
|
|
28001
27952
|
type: 'array',
|
|
28002
27953
|
},
|
|
28003
27954
|
ends_at: {
|
|
27955
|
+
default: null,
|
|
28004
27956
|
description:
|
|
28005
27957
|
'Date and time at which the validity of the new grant ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.',
|
|
27958
|
+
nullable: true,
|
|
28006
27959
|
type: 'string',
|
|
28007
27960
|
},
|
|
28008
27961
|
location: {
|
|
@@ -38067,6 +38020,11 @@ export default {
|
|
|
38067
38020
|
{
|
|
38068
38021
|
default: {
|
|
38069
38022
|
features: {
|
|
38023
|
+
configure: {
|
|
38024
|
+
allow_access_automation_rule_customization: false,
|
|
38025
|
+
allow_instant_key_customization: false,
|
|
38026
|
+
exclude: false,
|
|
38027
|
+
},
|
|
38070
38028
|
connect: { exclude: false },
|
|
38071
38029
|
manage_devices: { exclude: false },
|
|
38072
38030
|
organize: { exclude: false },
|
|
@@ -38078,6 +38036,32 @@ export default {
|
|
|
38078
38036
|
features: {
|
|
38079
38037
|
default: {},
|
|
38080
38038
|
properties: {
|
|
38039
|
+
configure: {
|
|
38040
|
+
default: {},
|
|
38041
|
+
description:
|
|
38042
|
+
'Configuration for the configure feature.',
|
|
38043
|
+
properties: {
|
|
38044
|
+
allow_access_automation_rule_customization: {
|
|
38045
|
+
default: false,
|
|
38046
|
+
description:
|
|
38047
|
+
'Indicates whether the customer can customize the access automation rules for their properties.',
|
|
38048
|
+
type: 'boolean',
|
|
38049
|
+
},
|
|
38050
|
+
allow_instant_key_customization: {
|
|
38051
|
+
default: false,
|
|
38052
|
+
description:
|
|
38053
|
+
'Indicates whether the customer can customize the Instant Key profile for their properties.',
|
|
38054
|
+
type: 'boolean',
|
|
38055
|
+
},
|
|
38056
|
+
exclude: {
|
|
38057
|
+
default: false,
|
|
38058
|
+
description:
|
|
38059
|
+
'Whether to exclude this feature from the portal.',
|
|
38060
|
+
type: 'boolean',
|
|
38061
|
+
},
|
|
38062
|
+
},
|
|
38063
|
+
type: 'object',
|
|
38064
|
+
},
|
|
38081
38065
|
connect: {
|
|
38082
38066
|
default: {},
|
|
38083
38067
|
description:
|
|
@@ -47269,6 +47253,18 @@ export default {
|
|
|
47269
47253
|
},
|
|
47270
47254
|
features: {
|
|
47271
47255
|
properties: {
|
|
47256
|
+
configure: {
|
|
47257
|
+
properties: {
|
|
47258
|
+
allow_access_automation_rule_customization: {
|
|
47259
|
+
type: 'boolean',
|
|
47260
|
+
},
|
|
47261
|
+
allow_instant_key_customization: {
|
|
47262
|
+
type: 'boolean',
|
|
47263
|
+
},
|
|
47264
|
+
exclude: { type: 'boolean' },
|
|
47265
|
+
},
|
|
47266
|
+
type: 'object',
|
|
47267
|
+
},
|
|
47272
47268
|
connect: {
|
|
47273
47269
|
properties: { exclude: { type: 'boolean' } },
|
|
47274
47270
|
type: 'object',
|
|
@@ -47352,6 +47348,18 @@ export default {
|
|
|
47352
47348
|
},
|
|
47353
47349
|
features: {
|
|
47354
47350
|
properties: {
|
|
47351
|
+
configure: {
|
|
47352
|
+
properties: {
|
|
47353
|
+
allow_access_automation_rule_customization: {
|
|
47354
|
+
type: 'boolean',
|
|
47355
|
+
},
|
|
47356
|
+
allow_instant_key_customization: {
|
|
47357
|
+
type: 'boolean',
|
|
47358
|
+
},
|
|
47359
|
+
exclude: { type: 'boolean' },
|
|
47360
|
+
},
|
|
47361
|
+
type: 'object',
|
|
47362
|
+
},
|
|
47355
47363
|
connect: {
|
|
47356
47364
|
properties: { exclude: { type: 'boolean' } },
|
|
47357
47365
|
type: 'object',
|