New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →
Socket
Sign inDemoInstall
Socket
Sign inDemoInstall

@seamapi/types

Package Overview
Dependencies
Maintainers
0
Versions
503
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@seamapi/types - npm Package Compare versions

Comparing version 1.312.2 to 1.313.0

34

lib/seam/connect/models/events/common.js
import { z } from 'zod';
export const common_event = z.object({
event_id: z.string().uuid().describe(`
---
title: Event ID
---
The ID of the event.
`),
workspace_id: z.string().uuid().describe(`
---
title: Workspace ID
---
The ID of the workspace.
`),
created_at: z.string().datetime().describe(`
---
title: Created At
---
The time when the event was created.
`),
occurred_at: z.string().datetime().describe(`
---
title: Occurred At
---
The time when the event occurred.
`),
event_id: z.string().uuid().describe('ID of the event.'),
workspace_id: z
.string()
.uuid()
.describe('ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).'),
created_at: z
.string()
.datetime()
.describe('Time at which the event was created.'),
occurred_at: z.string().datetime().describe('Time when the event occurred.'),
});
//# sourceMappingURL=common.js.map

243

lib/seam/connect/models/events/devices.js

@@ -5,50 +5,22 @@ import { z } from 'zod';

const device_event = common_event.extend({
device_id: z.string().uuid().describe(`
---
title: Device ID
---
ID of the device.
`),
connected_account_id: z.string().uuid().describe(`
---
title: Connected Account ID
---
ID of the connected account.
`),
device_id: z.string().uuid().describe('ID of the device.'),
connected_account_id: z
.string()
.uuid()
.describe('ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).'),
});
const battery_level = z.number().min(0).max(1).describe(`
---
title: Battery Level
---
Fractional number 0 to 1.0 indicating amount of battery in device, as reported by device.
`);
const device_battery_status = z.enum(['critical', 'low', 'good', 'full'])
.describe(`
---
title: Battery Status
---
Enum representing the battery status calculated from numeric battery_level value, one of 'critical' | 'low' | 'good' | 'full'
`);
const disconnection_error_code = z.enum([
'account_disconnected',
'hub_disconnected',
'device_disconnected',
]).describe(`
---
title: Event Error Code
---
The error code associated with the event, if any.
`);
export const lock_method = z.enum([
'keycode',
'manual',
'automatic',
'unknown',
'seamapi',
]).describe(`
---
title: Lock Lock/Unlock Method
---
Method by which a lock device was locked or unlocked. When the method is \`keycode\`, the \`access_code_id\` will reference the Seam access code which was used, if reported by the device.
`);
const battery_level = z
.number()
.min(0)
.max(1)
.describe('Number in the range 0 to 1.0 indicating the amount of battery in the device, as reported by the device.');
const device_battery_status = z
.enum(['critical', 'low', 'good', 'full'])
.describe('Battery status of the device, calculated from the numeric `battery_level` value.');
const disconnection_error_code = z
.enum(['account_disconnected', 'hub_disconnected', 'device_disconnected'])
.describe('Error code associated with the disconnection event, if any.');
export const lock_method = z
.enum(['keycode', 'manual', 'automatic', 'unknown', 'seamapi'])
.describe('Method by which a lock device was locked or unlocked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device.');
export const device_connected_event = device_event

@@ -63,3 +35,3 @@ .extend({

})
.describe('A device has been added or reconnected to Seam.');
.describe('A device was added or reconnected to Seam.');
export const device_converted_to_unmanaged_event = device_event

@@ -69,3 +41,3 @@ .extend({

})
.describe('An unmanaged device was successfully converted to a managed device.');
.describe('An [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices) was successfully converted to a managed device.');
export const unmanaged_device_converted_to_managed_event = device_event

@@ -75,3 +47,3 @@ .extend({

})
.describe('A managed device was successfully converted to an unmanaged device.');
.describe('A managed device was successfully converted to an [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices).');
export const unmanaged_device_connected_event = device_event

@@ -81,3 +53,3 @@ .extend({

})
.describe('An unmanaged device was connected to Seam');
.describe('An [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices) was connected to Seam.');
export const device_disconnected_event = device_event

@@ -88,3 +60,3 @@ .extend({

})
.describe('A device was disconnected');
.describe('A device was disconnected from Seam.');
export const unmanaged_device_disconnected_event = device_event

@@ -95,3 +67,3 @@ .extend({

})
.describe('An unmanaged device was disconnected');
.describe('An [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices) was disconnected from Seam.');
export const device_tampered_event = device_event

@@ -101,3 +73,3 @@ .extend({

})
.describe('A device detected that it was tampered with, e.g., opened or moved.');
.describe('A device detected that it was tampered with, for example, opened or moved.');
export const device_low_battery_event = device_event

@@ -115,3 +87,3 @@ .extend({

})
.describe('A device battery status changed since the last battery status changed event.');
.describe('A device battery status changed since the last `battery_status_changed` event.');
export const device_removed_event = device_event

@@ -121,3 +93,3 @@ .extend({

})
.describe('A device was removed externally from the connected account.');
.describe('A device was removed externally from the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).');
export const device_deleted_event = device_event

@@ -127,3 +99,3 @@ .extend({

})
.describe('A device was deleted.');
.describe('A device was [deleted](https://docs.seam.co/latest/api/devices/delete).');
export const device_third_party_integration_detected_event = device_event

@@ -133,3 +105,3 @@ .extend({

})
.describe('Seam detected a device is using a third party integration that will interfere with Seam device management.');
.describe('Seam detected that a device is using a third-party integration that will interfere with Seam device management.');
export const device_third_party_integration_no_longer_detected_event = device_event

@@ -139,3 +111,3 @@ .extend({

})
.describe('Seam detected a device is no longer using a third party integration that was interfering with Seam device management.');
.describe('Seam detected that a device is no longer using a third-party integration that was interfering with Seam device management.');
export const device_salto_privacy_mode_activated_event = device_event

@@ -160,3 +132,3 @@ .extend({

})
.describe('Seam detected a previously flaky device connection stabilized.');
.describe('Seam detected that a previously-flaky device connection stabilized.');
export const device_error_subscription_required_event = device_event

@@ -166,3 +138,3 @@ .extend({

})
.describe('A third party subscription is required to use all device features.');
.describe('A third-party subscription is required to use all device features.');
export const device_error_subscription_required_resolved_event = device_event

@@ -172,3 +144,3 @@ .extend({

})
.describe('A third party subscription is active or no longer-required to use all device features.');
.describe('A third-party subscription is active or no longer required to use all device features.');
export const device_accessory_keypad_connected_event = device_event

@@ -178,3 +150,3 @@ .extend({

})
.describe('A accessory keypad was connected to a device.');
.describe('An accessory keypad was connected to a device.');
export const device_accessory_keypad_disconnected_event = device_event

@@ -184,10 +156,23 @@ .extend({

})
.describe('A accessory keypad was disconnected to a device.');
.describe('An accessory keypad was disconnected from a device.');
export const noise_sensor_noise_threshold_triggered_event = device_event
.extend({
event_type: z.literal('noise_sensor.noise_threshold_triggered'),
noise_level_decibels: z.number().optional(),
noise_level_nrs: z.number().optional(),
noise_threshold_id: z.string().uuid().optional(),
noise_threshold_name: z.string().optional(),
noise_level_decibels: z
.number()
.optional()
.describe('Detected noise level in decibels.'),
noise_level_nrs: z
.number()
.optional()
.describe('Detected noise level in Noiseaware Noise Risk Score (NRS).'),
noise_threshold_id: z
.string()
.uuid()
.optional()
.describe('ID of the [noise threshold](https://docs.seam.co/latest/capability-guides/noise-sensors#what-is-a-threshold) that was triggered.'),
noise_threshold_name: z
.string()
.optional()
.describe('Name of the [noise threshold](https://docs.seam.co/latest/capability-guides/noise-sensors#what-is-a-threshold) that was triggered.'),
// TODO: remove metadata from this event

@@ -198,3 +183,3 @@ noiseaware_metadata: z.record(z.unknown()).optional().describe(`

---
Metadata from the Noiseaware API.
Metadata from Noiseaware.
`),

@@ -205,12 +190,20 @@ minut_metadata: z.record(z.unknown()).optional().describe(`

---
Metadata from the Minut API.
Metadata from Minut.
`),
})
.describe('Extended periods of noise or noise exceeding a threshold was detected.');
.describe('Extended periods of noise or noise exceeding a [threshold](https://docs.seam.co/latest/capability-guides/noise-sensors#what-is-a-threshold) were detected.');
export const lock_locked_event = device_event
.extend({
event_type: z.literal('lock.locked'),
access_code_id: z.string().uuid().optional(),
action_attempt_id: z.string().uuid().optional(),
method: lock_method,
access_code_id: z
.string()
.uuid()
.optional()
.describe('ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used to lock the device.'),
action_attempt_id: z
.string()
.uuid()
.optional()
.describe('ID of the [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) associated with the lock action.'),
method: lock_method.describe('Method by which a lock device was locked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device.'),
})

@@ -221,5 +214,13 @@ .describe('A lock was locked.');

event_type: z.literal('lock.unlocked'),
access_code_id: z.string().uuid().optional(),
action_attempt_id: z.string().uuid().optional(),
method: lock_method,
access_code_id: z
.string()
.uuid()
.optional()
.describe('ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used to unlock the device.'),
action_attempt_id: z
.string()
.uuid()
.optional()
.describe('ID of the [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) associated with the unlock action.'),
method: lock_method.describe('Method by which a lock device was unlocked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device.'),
})

@@ -230,3 +231,7 @@ .describe('A lock was unlocked.');

event_type: z.literal('lock.access_denied'),
access_code_id: z.string().uuid().optional(),
access_code_id: z
.string()
.uuid()
.optional()
.describe('ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used in the unlock attempts.'),
})

@@ -237,8 +242,18 @@ .describe('The lock denied access to a user after one or more consecutive invalid attempts to unlock the device.');

event_type: z.literal('thermostat.climate_preset_activated'),
thermostat_schedule_id: z.string().uuid().nullable(),
climate_preset_key: z.string(),
is_fallback_climate_preset: z.boolean(),
thermostat_schedule_id: z
.string()
.uuid()
.nullable()
.describe('ID of the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that prompted the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to be activated.'),
climate_preset_key: z
.string()
.describe('Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) that was activated.'),
is_fallback_climate_preset: z
.boolean()
.describe('Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) that was activated is the [fallback climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) for the thermostat.'),
})
.describe('A thermostat climate preset was activated.');
export const thermostat_manually_adjusted_method = z.enum(['seam', 'external']);
.describe('A thermostat [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) was activated.');
export const thermostat_manually_adjusted_method = z
.enum(['seam', 'external'])
.describe('Method used to adjust the thermostat manually. `seam` indicates that the Seam API, Seam CLI, or Seam Console was used to adjust the thermostat.');
export const thermostat_manually_adjusted_event = device_event

@@ -257,25 +272,57 @@ .extend({

}))
.describe('A thermostat was manually adjusted.');
.describe('A thermostat was adjusted manually.');
export const temperature_threshold_exceeded_event = device_event
.extend({
event_type: z.literal('thermostat.temperature_threshold_exceeded'),
temperature_celsius: z.number(),
temperature_fahrenheit: z.number(),
upper_limit_celsius: z.number().nullable(),
upper_limit_fahrenheit: z.number().nullable(),
lower_limit_celsius: z.number().nullable(),
lower_limit_fahrenheit: z.number().nullable(),
temperature_celsius: z
.number()
.describe('Temperature, in °C, reported by the thermostat.'),
temperature_fahrenheit: z
.number()
.describe('Temperature, in °F, reported by the thermostat.'),
upper_limit_celsius: z
.number()
.nullable()
.describe('Upper temperature limit, in °C, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).'),
upper_limit_fahrenheit: z
.number()
.nullable()
.describe('Upper temperature limit, in °F, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).'),
lower_limit_celsius: z
.number()
.nullable()
.describe('Lower temperature limit, in °C, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).'),
lower_limit_fahrenheit: z
.number()
.nullable()
.describe('Lower temperature limit, in °F, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).'),
})
.describe("A thermostat's temperature reading exceeded the set threshold.");
.describe("A thermostat's temperature reading exceeded the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).");
export const temperature_threshold_no_longer_exceeded_event = device_event
.extend({
event_type: z.literal('thermostat.temperature_threshold_no_longer_exceeded'),
temperature_celsius: z.number(),
temperature_fahrenheit: z.number(),
upper_limit_celsius: z.number().nullable(),
upper_limit_fahrenheit: z.number().nullable(),
lower_limit_celsius: z.number().nullable(),
lower_limit_fahrenheit: z.number().nullable(),
temperature_celsius: z
.number()
.describe('Temperature, in °C, reported by the thermostat.'),
temperature_fahrenheit: z
.number()
.describe('Temperature, in °F, reported by the thermostat.'),
upper_limit_celsius: z
.number()
.nullable()
.describe('Upper temperature limit, in °C, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).'),
upper_limit_fahrenheit: z
.number()
.nullable()
.describe('Upper temperature limit, in °F, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).'),
lower_limit_celsius: z
.number()
.nullable()
.describe('Lower temperature limit, in °C, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).'),
lower_limit_fahrenheit: z
.number()
.nullable()
.describe('Lower temperature limit, in °F, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).'),
})
.describe("A thermostat's temperature reading is no longer exceeding the set threshold.");
.describe("A thermostat's temperature reading no longer exceeds the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).");
export const device_events = [

@@ -282,0 +329,0 @@ device_connected_event,

2

package.json
{
"name": "@seamapi/types",
"version": "1.312.2",
"version": "1.313.0",
"description": "TypeScript types for the Seam API.",

@@ -5,0 +5,0 @@ "type": "module",

36

src/lib/seam/connect/models/events/common.ts
import { z } from 'zod'
export const common_event = z.object({
event_id: z.string().uuid().describe(`
---
title: Event ID
---
The ID of the event.
`),
workspace_id: z.string().uuid().describe(`
---
title: Workspace ID
---
The ID of the workspace.
`),
created_at: z.string().datetime().describe(`
---
title: Created At
---
The time when the event was created.
`),
occurred_at: z.string().datetime().describe(`
---
title: Occurred At
---
The time when the event occurred.
`),
event_id: z.string().uuid().describe('ID of the event.'),
workspace_id: z
.string()
.uuid()
.describe(
'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
),
created_at: z
.string()
.datetime()
.describe('Time at which the event was created.'),
occurred_at: z.string().datetime().describe('Time when the event occurred.'),
})

307

src/lib/seam/connect/models/events/devices.ts

@@ -7,54 +7,34 @@ import { z } from 'zod'

const device_event = common_event.extend({
device_id: z.string().uuid().describe(`
---
title: Device ID
---
ID of the device.
`),
connected_account_id: z.string().uuid().describe(`
---
title: Connected Account ID
---
ID of the connected account.
`),
device_id: z.string().uuid().describe('ID of the device.'),
connected_account_id: z
.string()
.uuid()
.describe(
'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
),
})
const battery_level = z.number().min(0).max(1).describe(`
---
title: Battery Level
---
Fractional number 0 to 1.0 indicating amount of battery in device, as reported by device.
`)
const battery_level = z
.number()
.min(0)
.max(1)
.describe(
'Number in the range 0 to 1.0 indicating the amount of battery in the device, as reported by the device.',
)
const device_battery_status = z.enum(['critical', 'low', 'good', 'full'])
.describe(`
---
title: Battery Status
---
Enum representing the battery status calculated from numeric battery_level value, one of 'critical' | 'low' | 'good' | 'full'
`)
const device_battery_status = z
.enum(['critical', 'low', 'good', 'full'])
.describe(
'Battery status of the device, calculated from the numeric `battery_level` value.',
)
const disconnection_error_code = z.enum([
'account_disconnected',
'hub_disconnected',
'device_disconnected',
]).describe(`
---
title: Event Error Code
---
The error code associated with the event, if any.
`)
const disconnection_error_code = z
.enum(['account_disconnected', 'hub_disconnected', 'device_disconnected'])
.describe('Error code associated with the disconnection event, if any.')
export const lock_method = z.enum([
'keycode',
'manual',
'automatic',
'unknown',
'seamapi',
]).describe(`
---
title: Lock Lock/Unlock Method
---
Method by which a lock device was locked or unlocked. When the method is \`keycode\`, the \`access_code_id\` will reference the Seam access code which was used, if reported by the device.
`)
export const lock_method = z
.enum(['keycode', 'manual', 'automatic', 'unknown', 'seamapi'])
.describe(
'Method by which a lock device was locked or unlocked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device.',
)
export type LockMethod = z.infer<typeof lock_method>

@@ -74,3 +54,3 @@

})
.describe('A device has been added or reconnected to Seam.')
.describe('A device was added or reconnected to Seam.')

@@ -84,3 +64,3 @@ export type DeviceAddedEvent = z.infer<typeof device_added_event>

.describe(
'An unmanaged device was successfully converted to a managed device.',
'An [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices) was successfully converted to a managed device.',
)

@@ -97,3 +77,3 @@

.describe(
'A managed device was successfully converted to an unmanaged device.',
'A managed device was successfully converted to an [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices).',
)

@@ -109,3 +89,5 @@

})
.describe('An unmanaged device was connected to Seam')
.describe(
'An [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices) was connected to Seam.',
)

@@ -121,3 +103,3 @@ export type UnmanagedDeviceConnectedEvent = z.infer<

})
.describe('A device was disconnected')
.describe('A device was disconnected from Seam.')

@@ -131,3 +113,5 @@ export type DeviceDisconnectedEvent = z.infer<typeof device_disconnected_event>

})
.describe('An unmanaged device was disconnected')
.describe(
'An [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices) was disconnected from Seam.',
)

@@ -143,3 +127,3 @@ export type UnmanagedDeviceDisconnectedEvent = z.infer<

.describe(
'A device detected that it was tampered with, e.g., opened or moved.',
'A device detected that it was tampered with, for example, opened or moved.',
)

@@ -165,3 +149,3 @@

.describe(
'A device battery status changed since the last battery status changed event.',
'A device battery status changed since the last `battery_status_changed` event.',
)

@@ -177,3 +161,5 @@

})
.describe('A device was removed externally from the connected account.')
.describe(
'A device was removed externally from the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
)

@@ -186,3 +172,5 @@ export type DeviceRemovedEvent = z.infer<typeof device_removed_event>

})
.describe('A device was deleted.')
.describe(
'A device was [deleted](https://docs.seam.co/latest/api/devices/delete).',
)

@@ -196,3 +184,3 @@ export type DeviceDeletedEvent = z.infer<typeof device_deleted_event>

.describe(
'Seam detected a device is using a third party integration that will interfere with Seam device management.',
'Seam detected that a device is using a third-party integration that will interfere with Seam device management.',
)

@@ -212,3 +200,3 @@

.describe(
'Seam detected a device is no longer using a third party integration that was interfering with Seam device management.',
'Seam detected that a device is no longer using a third-party integration that was interfering with Seam device management.',
)

@@ -254,3 +242,5 @@

})
.describe('Seam detected a previously flaky device connection stabilized.')
.describe(
'Seam detected that a previously-flaky device connection stabilized.',
)

@@ -266,3 +256,3 @@ export type DeviceConnectionStabilizedEvent = z.infer<

.describe(
'A third party subscription is required to use all device features.',
'A third-party subscription is required to use all device features.',
)

@@ -279,3 +269,3 @@

.describe(
'A third party subscription is active or no longer-required to use all device features.',
'A third-party subscription is active or no longer required to use all device features.',
)

@@ -291,3 +281,3 @@

})
.describe('A accessory keypad was connected to a device.')
.describe('An accessory keypad was connected to a device.')

@@ -302,3 +292,3 @@ export type DeviceAccessoryKeypadConnectedEvent = z.infer<

})
.describe('A accessory keypad was disconnected to a device.')
.describe('An accessory keypad was disconnected from a device.')

@@ -312,6 +302,23 @@ export type DeviceAccessoryKeypadDisconnectedEvent = z.infer<

event_type: z.literal('noise_sensor.noise_threshold_triggered'),
noise_level_decibels: z.number().optional(),
noise_level_nrs: z.number().optional(),
noise_threshold_id: z.string().uuid().optional(),
noise_threshold_name: z.string().optional(),
noise_level_decibels: z
.number()
.optional()
.describe('Detected noise level in decibels.'),
noise_level_nrs: z
.number()
.optional()
.describe('Detected noise level in Noiseaware Noise Risk Score (NRS).'),
noise_threshold_id: z
.string()
.uuid()
.optional()
.describe(
'ID of the [noise threshold](https://docs.seam.co/latest/capability-guides/noise-sensors#what-is-a-threshold) that was triggered.',
),
noise_threshold_name: z
.string()
.optional()
.describe(
'Name of the [noise threshold](https://docs.seam.co/latest/capability-guides/noise-sensors#what-is-a-threshold) that was triggered.',
),
// TODO: remove metadata from this event

@@ -322,3 +329,3 @@ noiseaware_metadata: z.record(z.unknown()).optional().describe(`

---
Metadata from the Noiseaware API.
Metadata from Noiseaware.
`),

@@ -329,7 +336,7 @@ minut_metadata: z.record(z.unknown()).optional().describe(`

---
Metadata from the Minut API.
Metadata from Minut.
`),
})
.describe(
'Extended periods of noise or noise exceeding a threshold was detected.',
'Extended periods of noise or noise exceeding a [threshold](https://docs.seam.co/latest/capability-guides/noise-sensors#what-is-a-threshold) were detected.',
)

@@ -344,5 +351,19 @@

event_type: z.literal('lock.locked'),
access_code_id: z.string().uuid().optional(),
action_attempt_id: z.string().uuid().optional(),
method: lock_method,
access_code_id: z
.string()
.uuid()
.optional()
.describe(
'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used to lock the device.',
),
action_attempt_id: z
.string()
.uuid()
.optional()
.describe(
'ID of the [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) associated with the lock action.',
),
method: lock_method.describe(
'Method by which a lock device was locked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device.',
),
})

@@ -356,5 +377,19 @@ .describe('A lock was locked.')

event_type: z.literal('lock.unlocked'),
access_code_id: z.string().uuid().optional(),
action_attempt_id: z.string().uuid().optional(),
method: lock_method,
access_code_id: z
.string()
.uuid()
.optional()
.describe(
'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used to unlock the device.',
),
action_attempt_id: z
.string()
.uuid()
.optional()
.describe(
'ID of the [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) associated with the unlock action.',
),
method: lock_method.describe(
'Method by which a lock device was unlocked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device.',
),
})

@@ -368,3 +403,9 @@ .describe('A lock was unlocked.')

event_type: z.literal('lock.access_denied'),
access_code_id: z.string().uuid().optional(),
access_code_id: z
.string()
.uuid()
.optional()
.describe(
'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used in the unlock attempts.',
),
})

@@ -380,7 +421,23 @@ .describe(

event_type: z.literal('thermostat.climate_preset_activated'),
thermostat_schedule_id: z.string().uuid().nullable(),
climate_preset_key: z.string(),
is_fallback_climate_preset: z.boolean(),
thermostat_schedule_id: z
.string()
.uuid()
.nullable()
.describe(
'ID of the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that prompted the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to be activated.',
),
climate_preset_key: z
.string()
.describe(
'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) that was activated.',
),
is_fallback_climate_preset: z
.boolean()
.describe(
'Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) that was activated is the [fallback climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) for the thermostat.',
),
})
.describe('A thermostat climate preset was activated.')
.describe(
'A thermostat [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) was activated.',
)

@@ -391,3 +448,7 @@ export type ThermostatClimatePresetActivatedEvent = z.infer<

export const thermostat_manually_adjusted_method = z.enum(['seam', 'external'])
export const thermostat_manually_adjusted_method = z
.enum(['seam', 'external'])
.describe(
'Method used to adjust the thermostat manually. `seam` indicates that the Seam API, Seam CLI, or Seam Console was used to adjust the thermostat.',
)

@@ -409,3 +470,3 @@ export const thermostat_manually_adjusted_event = device_event

)
.describe('A thermostat was manually adjusted.')
.describe('A thermostat was adjusted manually.')

@@ -419,10 +480,36 @@ export type ThermostatManuallyAdjustedEvent = z.infer<

event_type: z.literal('thermostat.temperature_threshold_exceeded'),
temperature_celsius: z.number(),
temperature_fahrenheit: z.number(),
upper_limit_celsius: z.number().nullable(),
upper_limit_fahrenheit: z.number().nullable(),
lower_limit_celsius: z.number().nullable(),
lower_limit_fahrenheit: z.number().nullable(),
temperature_celsius: z
.number()
.describe('Temperature, in °C, reported by the thermostat.'),
temperature_fahrenheit: z
.number()
.describe('Temperature, in °F, reported by the thermostat.'),
upper_limit_celsius: z
.number()
.nullable()
.describe(
'Upper temperature limit, in °C, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).',
),
upper_limit_fahrenheit: z
.number()
.nullable()
.describe(
'Upper temperature limit, in °F, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).',
),
lower_limit_celsius: z
.number()
.nullable()
.describe(
'Lower temperature limit, in °C, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).',
),
lower_limit_fahrenheit: z
.number()
.nullable()
.describe(
'Lower temperature limit, in °F, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).',
),
})
.describe("A thermostat's temperature reading exceeded the set threshold.")
.describe(
"A thermostat's temperature reading exceeded the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).",
)

@@ -438,11 +525,35 @@ export type TemperatureThresholdExceededEvent = z.infer<

),
temperature_celsius: z.number(),
temperature_fahrenheit: z.number(),
upper_limit_celsius: z.number().nullable(),
upper_limit_fahrenheit: z.number().nullable(),
lower_limit_celsius: z.number().nullable(),
lower_limit_fahrenheit: z.number().nullable(),
temperature_celsius: z
.number()
.describe('Temperature, in °C, reported by the thermostat.'),
temperature_fahrenheit: z
.number()
.describe('Temperature, in °F, reported by the thermostat.'),
upper_limit_celsius: z
.number()
.nullable()
.describe(
'Upper temperature limit, in °C, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).',
),
upper_limit_fahrenheit: z
.number()
.nullable()
.describe(
'Upper temperature limit, in °F, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).',
),
lower_limit_celsius: z
.number()
.nullable()
.describe(
'Lower temperature limit, in °C, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).',
),
lower_limit_fahrenheit: z
.number()
.nullable()
.describe(
'Lower temperature limit, in °F, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).',
),
})
.describe(
"A thermostat's temperature reading is no longer exceeding the set threshold.",
"A thermostat's temperature reading no longer exceeds the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).",
)

@@ -449,0 +560,0 @@ 

dist/connect.cjs

Sorry, the diff of this file is not supported yet

dist/connect.cjs.map

Sorry, the diff of this file is not supported yet

dist/connect.d.cts

Sorry, the diff of this file is not supported yet

lib/seam/connect/models/events/common.js.map

Sorry, the diff of this file is not supported yet

lib/seam/connect/models/events/devices.js.map

Sorry, the diff of this file is not supported yet

lib/seam/connect/openapi.d.ts

Sorry, the diff of this file is too big to display

lib/seam/connect/openapi.js

Sorry, the diff of this file is too big to display

lib/seam/connect/openapi.js.map

Sorry, the diff of this file is not supported yet

lib/seam/connect/route-types.d.ts

Sorry, the diff of this file is too big to display

src/lib/seam/connect/openapi.ts

Sorry, the diff of this file is too big to display

src/lib/seam/connect/route-types.ts

Sorry, the diff of this file is too big to display

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

About

Packages

npm

Go

Maven

PyPI

Rubygems

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc