@seamapi/types 1.1188.0 → 1.1189.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/lib/seam/connect/models/devices/device.d.ts +104 -95
- package/lib/seam/connect/models/devices/device.js +16 -1
- package/lib/seam/connect/models/devices/device.js.map +1 -1
- package/lib/seam/connect/models/devices/unmanaged-device.d.ts +72 -64
- package/lib/seam/connect/models/devices/unmanaged-device.js +5 -2
- package/lib/seam/connect/models/devices/unmanaged-device.js.map +1 -1
- package/lib/seam/connect/openapi.js +20 -2
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +512 -438
- package/package.json +1 -1
- package/src/lib/seam/connect/models/devices/device.ts +21 -2
- package/src/lib/seam/connect/models/devices/unmanaged-device.ts +21 -14
- package/src/lib/seam/connect/openapi.ts +20 -2
- package/src/lib/seam/connect/route-types.ts +25219 -24523
package/package.json
CHANGED
|
@@ -1239,10 +1239,25 @@ export const device = z
|
|
|
1239
1239
|
capabilities_supported: z.array(capabilities).describe(`
|
|
1240
1240
|
Collection of capabilities that the device supports when connected to Seam. Values are \`access_code\`, which indicates that the device can manage and utilize digital PIN codes for secure access; \`lock\`, which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; \`noise_detection\`, which indicates that the device supports monitoring and responding to ambient noise levels; \`thermostat\`, which indicates that the device can regulate and adjust indoor temperatures; \`battery\`, which indicates that the device can manage battery life and health; and \`phone\`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://www.seam.co/docs/capability-guides/device-and-system-capabilities#capability-flags).
|
|
1241
1241
|
`),
|
|
1242
|
+
is_online: z.boolean().describe(`
|
|
1243
|
+
---
|
|
1244
|
+
undocumented: Unreleased.
|
|
1245
|
+
property_group_key: hardware
|
|
1246
|
+
---
|
|
1247
|
+
Indicates whether the device is online.
|
|
1248
|
+
`),
|
|
1249
|
+
is_door_locked: z.boolean().optional().describe(`
|
|
1250
|
+
---
|
|
1251
|
+
undocumented: Unreleased.
|
|
1252
|
+
property_group_key: locks
|
|
1253
|
+
---
|
|
1254
|
+
Indicates whether the lock is locked.
|
|
1255
|
+
`),
|
|
1242
1256
|
properties: common_device_properties
|
|
1243
1257
|
.and(phone_specific_properties.partial())
|
|
1244
1258
|
.and(device_metadata)
|
|
1245
|
-
.and(capability_properties)
|
|
1259
|
+
.and(capability_properties)
|
|
1260
|
+
.optional().describe(`
|
|
1246
1261
|
---
|
|
1247
1262
|
property_groups:
|
|
1248
1263
|
locks:
|
|
@@ -1412,4 +1427,8 @@ export const device = z
|
|
|
1412
1427
|
Represents a [device](https://www.seam.co/docs/core-concepts/devices) that has been connected to Seam.
|
|
1413
1428
|
`)
|
|
1414
1429
|
|
|
1415
|
-
|
|
1430
|
+
type DeviceFromSchema = z.infer<typeof device>
|
|
1431
|
+
|
|
1432
|
+
export type Device = Omit<DeviceFromSchema, 'properties'> & {
|
|
1433
|
+
properties: NonNullable<DeviceFromSchema['properties']>
|
|
1434
|
+
}
|
|
@@ -19,24 +19,27 @@ export const unmanaged_device = device
|
|
|
19
19
|
created_at: true,
|
|
20
20
|
custom_metadata: true,
|
|
21
21
|
display_name: true,
|
|
22
|
+
is_online: true,
|
|
22
23
|
})
|
|
23
24
|
.extend({
|
|
24
25
|
is_managed: z
|
|
25
26
|
.literal(false)
|
|
26
27
|
.describe('Indicates that Seam does not manage the device.'),
|
|
27
|
-
properties: common_device_properties
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
28
|
+
properties: common_device_properties
|
|
29
|
+
.pick({
|
|
30
|
+
accessory_keypad: true,
|
|
31
|
+
name: true,
|
|
32
|
+
online: true,
|
|
33
|
+
manufacturer: true,
|
|
34
|
+
image_url: true,
|
|
35
|
+
image_alt_text: true,
|
|
36
|
+
battery_level: true,
|
|
37
|
+
battery: true,
|
|
38
|
+
online_access_codes_enabled: true,
|
|
39
|
+
offline_access_codes_enabled: true,
|
|
40
|
+
model: true,
|
|
41
|
+
})
|
|
42
|
+
.optional().describe(`
|
|
40
43
|
---
|
|
41
44
|
property_groups:
|
|
42
45
|
locks:
|
|
@@ -79,4 +82,8 @@ export const unmanaged_device = device
|
|
|
79
82
|
Represents an [unmanaged device](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices). An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).
|
|
80
83
|
`)
|
|
81
84
|
|
|
82
|
-
|
|
85
|
+
type UnmanagedDeviceFromSchema = z.infer<typeof unmanaged_device>
|
|
86
|
+
|
|
87
|
+
export type UnmanagedDevice = Omit<UnmanagedDeviceFromSchema, 'properties'> & {
|
|
88
|
+
properties: NonNullable<UnmanagedDeviceFromSchema['properties']>
|
|
89
|
+
}
|
|
@@ -16643,6 +16643,12 @@ const openapi: OpenAPISpec = {
|
|
|
16643
16643
|
thermostats: { name: 'Thermostats' },
|
|
16644
16644
|
},
|
|
16645
16645
|
},
|
|
16646
|
+
is_door_locked: {
|
|
16647
|
+
description: 'Indicates whether the lock is locked.',
|
|
16648
|
+
type: 'boolean',
|
|
16649
|
+
'x-property-group-key': 'locks',
|
|
16650
|
+
'x-undocumented': 'Unreleased.',
|
|
16651
|
+
},
|
|
16646
16652
|
is_managed: {
|
|
16647
16653
|
description:
|
|
16648
16654
|
'Indicates whether Seam manages the device. See also [Managed and Unmanaged Devices](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices).',
|
|
@@ -16655,6 +16661,12 @@ const openapi: OpenAPISpec = {
|
|
|
16655
16661
|
type: 'boolean',
|
|
16656
16662
|
'x-property-group-key': 'sensors',
|
|
16657
16663
|
},
|
|
16664
|
+
is_online: {
|
|
16665
|
+
description: 'Indicates whether the device is online.',
|
|
16666
|
+
type: 'boolean',
|
|
16667
|
+
'x-property-group-key': 'hardware',
|
|
16668
|
+
'x-undocumented': 'Unreleased.',
|
|
16669
|
+
},
|
|
16658
16670
|
is_smoking_detected: {
|
|
16659
16671
|
description:
|
|
16660
16672
|
'Indicates whether the device detects smoking, if the device measures it.',
|
|
@@ -20864,7 +20876,7 @@ const openapi: OpenAPISpec = {
|
|
|
20864
20876
|
'space_ids',
|
|
20865
20877
|
'display_name',
|
|
20866
20878
|
'capabilities_supported',
|
|
20867
|
-
'
|
|
20879
|
+
'is_online',
|
|
20868
20880
|
'connected_account_id',
|
|
20869
20881
|
'workspace_id',
|
|
20870
20882
|
'errors',
|
|
@@ -42166,6 +42178,12 @@ const openapi: OpenAPISpec = {
|
|
|
42166
42178
|
enum: [false],
|
|
42167
42179
|
type: 'boolean',
|
|
42168
42180
|
},
|
|
42181
|
+
is_online: {
|
|
42182
|
+
description: 'Indicates whether the device is online.',
|
|
42183
|
+
type: 'boolean',
|
|
42184
|
+
'x-property-group-key': 'hardware',
|
|
42185
|
+
'x-undocumented': 'Unreleased.',
|
|
42186
|
+
},
|
|
42169
42187
|
location: {
|
|
42170
42188
|
description: 'Location information for the device.',
|
|
42171
42189
|
properties: {
|
|
@@ -43157,8 +43175,8 @@ const openapi: OpenAPISpec = {
|
|
|
43157
43175
|
'created_at',
|
|
43158
43176
|
'custom_metadata',
|
|
43159
43177
|
'display_name',
|
|
43178
|
+
'is_online',
|
|
43160
43179
|
'is_managed',
|
|
43161
|
-
'properties',
|
|
43162
43180
|
],
|
|
43163
43181
|
type: 'object',
|
|
43164
43182
|
'x-property-groups': {
|