@seamapi/types 1.180.0 → 1.182.0

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

@@ -2921,6 +2921,7 @@ export interface Routes {
                     ---
                      */
                 access_group_type_display_name: string;
+                display_name: string;
                 external_type: 'pti_unit' | 'pti_access_level' | 'salto_access_group' | 'brivo_group';
                 external_type_display_name: string;
                 created_at: string;
@@ -2955,6 +2956,7 @@ export interface Routes {
                     ---
                      */
                 access_group_type_display_name: string;
+                display_name: string;
                 external_type: 'pti_unit' | 'pti_access_level' | 'salto_access_group' | 'brivo_group';
                 external_type_display_name: string;
                 created_at: string;
@@ -6934,8 +6936,8 @@ export interface Routes {
             device_ids?: string[] | undefined;
             access_code_id?: string | undefined;
             access_code_ids?: string[] | undefined;
-            event_type?: ('device.accessory_keypad_connected' | 'device.accessory_keypad_disconnected' | 'device.connected' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.removed' | 'device.deleted' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | 'device.third_party_integration_detected' | 'device.third_party_integration_no_longer_detected' | 'device.salto.privacy_mode_activated' | 'device.salto.privacy_mode_deactivated' | 'device.connection_became_flaky' | 'device.connection_stabilized' | 'device.error.subscription_required' | 'device.error.subscription_required.resolved' | 'access_code.created' | 'access_code.changed' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.deleted' | 'access_code.removed_from_device' | 'access_code.failed_to_set_on_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_remove_from_device' | 'access_code.delay_in_removing_from_device' | 'access_code.deleted_external_to_seam' | 'access_code.modified_external_to_seam' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'lock.locked' | 'lock.unlocked' | 'phone.deactivated' | 'connected_account.connected' | 'connected_account.successful_login' | 'connected_account.created' | 'connected_account.deleted' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'connected_account.completed_first_sync_after_reconnection' | 'noise_sensor.noise_threshold_triggered' | 'access_code.backup_access_code_pulled' | 'acs_user.deleted' | 'acs_credential.deleted' | 'enrollment_automation.deleted' | 'client_session.deleted' | 'action_attempt.lock_door.succeeded' | 'action_attempt.lock_door.failed' | 'action_attempt.unlock_door.succeeded' | 'action_attempt.unlock_door.failed') | undefined;
-            event_types?: Array<'device.accessory_keypad_connected' | 'device.accessory_keypad_disconnected' | 'device.connected' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.removed' | 'device.deleted' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | 'device.third_party_integration_detected' | 'device.third_party_integration_no_longer_detected' | 'device.salto.privacy_mode_activated' | 'device.salto.privacy_mode_deactivated' | 'device.connection_became_flaky' | 'device.connection_stabilized' | 'device.error.subscription_required' | 'device.error.subscription_required.resolved' | 'access_code.created' | 'access_code.changed' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.deleted' | 'access_code.removed_from_device' | 'access_code.failed_to_set_on_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_remove_from_device' | 'access_code.delay_in_removing_from_device' | 'access_code.deleted_external_to_seam' | 'access_code.modified_external_to_seam' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'lock.locked' | 'lock.unlocked' | 'phone.deactivated' | 'connected_account.connected' | 'connected_account.successful_login' | 'connected_account.created' | 'connected_account.deleted' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'connected_account.completed_first_sync_after_reconnection' | 'noise_sensor.noise_threshold_triggered' | 'access_code.backup_access_code_pulled' | 'acs_user.deleted' | 'acs_credential.deleted' | 'enrollment_automation.deleted' | 'client_session.deleted' | 'action_attempt.lock_door.succeeded' | 'action_attempt.lock_door.failed' | 'action_attempt.unlock_door.succeeded' | 'action_attempt.unlock_door.failed'> | undefined;
+            event_type?: ('device.accessory_keypad_connected' | 'device.accessory_keypad_disconnected' | 'device.connected' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.removed' | 'device.deleted' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | 'device.third_party_integration_detected' | 'device.third_party_integration_no_longer_detected' | 'device.salto.privacy_mode_activated' | 'device.salto.privacy_mode_deactivated' | 'device.connection_became_flaky' | 'device.connection_stabilized' | 'device.error.subscription_required' | 'device.error.subscription_required.resolved' | 'access_code.created' | 'access_code.changed' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.deleted' | 'access_code.removed_from_device' | 'access_code.failed_to_set_on_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_remove_from_device' | 'access_code.delay_in_removing_from_device' | 'access_code.deleted_external_to_seam' | 'access_code.modified_external_to_seam' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'lock.locked' | 'lock.unlocked' | 'phone.deactivated' | 'connected_account.connected' | 'connected_account.successful_login' | 'connected_account.created' | 'connected_account.deleted' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'connected_account.completed_first_sync_after_reconnection' | 'noise_sensor.noise_threshold_triggered' | 'access_code.backup_access_code_pulled' | 'acs_system.connected' | 'acs_user.deleted' | 'acs_credential.deleted' | 'enrollment_automation.deleted' | 'client_session.deleted' | 'action_attempt.lock_door.succeeded' | 'action_attempt.lock_door.failed' | 'action_attempt.unlock_door.succeeded' | 'action_attempt.unlock_door.failed') | undefined;
+            event_types?: Array<'device.accessory_keypad_connected' | 'device.accessory_keypad_disconnected' | 'device.connected' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.removed' | 'device.deleted' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | 'device.third_party_integration_detected' | 'device.third_party_integration_no_longer_detected' | 'device.salto.privacy_mode_activated' | 'device.salto.privacy_mode_deactivated' | 'device.connection_became_flaky' | 'device.connection_stabilized' | 'device.error.subscription_required' | 'device.error.subscription_required.resolved' | 'access_code.created' | 'access_code.changed' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.deleted' | 'access_code.removed_from_device' | 'access_code.failed_to_set_on_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_remove_from_device' | 'access_code.delay_in_removing_from_device' | 'access_code.deleted_external_to_seam' | 'access_code.modified_external_to_seam' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'lock.locked' | 'lock.unlocked' | 'phone.deactivated' | 'connected_account.connected' | 'connected_account.successful_login' | 'connected_account.created' | 'connected_account.deleted' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'connected_account.completed_first_sync_after_reconnection' | 'noise_sensor.noise_threshold_triggered' | 'access_code.backup_access_code_pulled' | 'acs_system.connected' | 'acs_user.deleted' | 'acs_credential.deleted' | 'enrollment_automation.deleted' | 'client_session.deleted' | 'action_attempt.lock_door.succeeded' | 'action_attempt.lock_door.failed' | 'action_attempt.unlock_door.succeeded' | 'action_attempt.unlock_door.failed'> | undefined;
             connected_account_id?: string | undefined;
             limit?: number;
         };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/types",
-  "version": "1.180.0",
+  "version": "1.182.0",
   "description": "TypeScript types for the Seam API.",
   "type": "module",
   "main": "index.js",

package/src/lib/seam/connect/internal/enums.ts

@@ -1,9 +1,12 @@
 export {
+  ALL_DEVICE_PROVIDERS,
   LOCK_DEVICE_TYPE,
   LOCK_DEVICE_TYPE_LIST,
   NOISE_SENSOR_DEVICE_TYPE,
   NOISE_SENSOR_DEVICE_TYPE_LIST,
   PHONE_DEVICE_TYPE,
+  PROVIDER_CATEGORIES,
+  PUBLIC_PROVIDER_CATEGORIES,
   THERMOSTAT_DEVICE_TYPE,
   THERMOSTAT_DEVICE_TYPE_LIST,
 } from '../models/index.js'

package/src/lib/seam/connect/internal/schemas.ts

@@ -21,9 +21,11 @@ export {
   climate_setting_schedule,
   common_device_properties,
   connect_webview_device_selection_mode,
+  connected_account,
   custom_metadata_input,
   device_capability_flags,
   device_metadata,
+  device_provider,
   dormakaba_oracode_time_slot,
   enrollment_automation,
   fan_mode_setting,
@@ -31,6 +33,7 @@ export {
   managed_access_code,
   managed_device,
   noise_sensor_device_type,
+  noise_threshold,
   phone,
   phone_number,
   thermostat_capability_properties,
@@ -38,5 +41,6 @@ export {
   unmanaged_access_code,
   unmanaged_device,
   user_identity,
+  webhook,
 } from '../models/index.js'
 export * from '../schemas.js'

package/src/lib/seam/connect/models/acs/access_group.ts

@@ -27,6 +27,7 @@ export const acs_access_group = z.object({
     deprecated: use external_type_display_name
     ---
     `),
+  display_name: z.string(),
   external_type: acs_access_group_external_type,
   external_type_display_name: z.string(),
   created_at: z.string().datetime(),

package/src/lib/seam/connect/models/acs/seam-bridge.ts

@@ -5,26 +5,32 @@ const common_seam_bridge_error = z.object({
   message: z.string(),
 })
 
-const connection_failure = common_seam_bridge_error.extend({
-  error_code: z.literal('connection_failure'),
+const seam_bridge_unreachable = common_seam_bridge_error.extend({
+  error_code: z.literal('seam_bridge_unreachable'),
 })
-const bridge_tunnel_failed = common_seam_bridge_error.extend({
-  error_code: z.literal('bridge_tunnel_failed'),
+const failed_to_create_tunnel = common_seam_bridge_error.extend({
+  error_code: z.literal('failed_to_create_tunnel'),
 })
-const bridge_proxy_failure = common_seam_bridge_error.extend({
-  error_code: z.literal('bridge_proxy_failure'),
+const failed_to_create_proxy = common_seam_bridge_error.extend({
+  error_code: z.literal('failed_to_create_proxy'),
+})
+
+const managed_by_other_account = common_seam_bridge_error.extend({
+  error_code: z.literal('managed_by_other_account'),
 })
 
 export const seam_bridge_error_map = z.object({
-  bridge_tunnel_failed: bridge_tunnel_failed.optional().nullable(),
-  bridge_proxy_failure: bridge_proxy_failure.optional().nullable(),
-  connection_failure: connection_failure.optional().nullable(),
+  failed_to_create_tunnel: failed_to_create_tunnel.optional().nullable(),
+  failed_to_create_proxy: failed_to_create_proxy.optional().nullable(),
+  seam_bridge_unreachable: seam_bridge_unreachable.optional().nullable(),
+  managed_by_other_account: managed_by_other_account.optional().nullable(),
 })
 
 export const seam_bridge_error = z.union([
-  connection_failure,
-  bridge_proxy_failure,
-  bridge_tunnel_failed,
+  seam_bridge_unreachable,
+  failed_to_create_proxy,
+  failed_to_create_tunnel,
+  managed_by_other_account,
 ])
 
 export type SeamBridgeErrorMap = z.infer<typeof seam_bridge_error_map>

package/src/lib/seam/connect/models/connected-accounts/connected-account.ts

@@ -0,0 +1,23 @@
+import { z } from 'zod'
+
+import { custom_metadata } from '../custom-metadata.js'
+
+export const connected_account = z.object({
+  connected_account_id: z.string().uuid().optional(),
+  created_at: z.string().datetime().optional(),
+  user_identifier: z
+    .object({
+      username: z.string().optional(),
+      api_url: z.string().optional(),
+      email: z.string().optional(),
+      phone: z.string().optional(),
+      exclusive: z.boolean().optional(),
+    })
+    .optional(),
+  account_type: z.string().optional(),
+  account_type_display_name: z.string(),
+  errors: z.any(),
+  warnings: z.any(),
+  custom_metadata,
+  automatically_manage_new_devices: z.boolean(),
+})

package/src/lib/seam/connect/models/connected-accounts/index.ts

@@ -0,0 +1 @@
+export * from './connected-account.js'

package/src/lib/seam/connect/models/devices/device-provider.ts

@@ -0,0 +1,116 @@
+import { z } from 'zod'
+
+export const DEVICE_PROVIDERS = {
+  AKUVOX: 'akuvox',
+  AUGUST: 'august',
+  AVIGILON_ALTA: 'avigilon_alta',
+  BRIVO: 'brivo',
+  BUTTERFLYMX: 'butterflymx',
+  SCHLAGE: 'schlage',
+  SMARTTHINGS: 'smartthings',
+  YALE: 'yale',
+  GENIE: 'genie',
+  DOORKING: 'doorking',
+  SALTO: 'salto',
+  LOCKLY: 'lockly',
+  TTLOCK: 'ttlock',
+  LINEAR: 'linear',
+  NOISEAWARE: 'noiseaware',
+  NUKI: 'nuki',
+  SEAM_RELAY_ADMIN: 'seam_relay_admin',
+  IGLOO: 'igloo',
+  KWIKSET: 'kwikset',
+  MINUT: 'minut',
+  MY_2N: 'my_2n',
+  CONTROLBYWEB: 'controlbyweb',
+  NEST: 'nest',
+  IGLOOHOME: 'igloohome',
+  ECOBEE: 'ecobee',
+  HUBITAT: 'hubitat',
+  FOUR_SUITES: 'four_suites',
+  DORMAKABA_ORACODE: 'dormakaba_oracode',
+  PTI: 'pti',
+  WYZE: 'wyze',
+  SEAM_PASSPORT: 'seam_passport',
+  VISIONLINE: 'visionline',
+  ASSA_ABLOY_CREDENTIAL_SERVICE: 'assa_abloy_credential_service',
+  SEAM_BRIDGE: 'seam_bridge',
+  TEDEE: 'tedee',
+  HONEYWELL_RESIDEO: 'honeywell_resideo',
+  LATCH: 'latch',
+} as const
+
+export type DeviceProvider =
+  (typeof DEVICE_PROVIDERS)[keyof typeof DEVICE_PROVIDERS]
+
+export const ALL_DEVICE_PROVIDERS: [DeviceProvider, ...DeviceProvider[]] =
+  Object.values(DEVICE_PROVIDERS) as any
+
+export type ProviderCategory = keyof typeof PROVIDER_CATEGORY_MAP
+
+export const PROVIDER_CATEGORY_MAP = {
+  stable: [
+    'august',
+    'avigilon_alta',
+    'brivo',
+    'schlage',
+    'smartthings',
+    'yale',
+    'nuki',
+    'salto',
+    'controlbyweb',
+    'minut',
+    'my_2n',
+    'kwikset',
+    'ttlock',
+    'noiseaware',
+    'igloohome',
+    'ecobee',
+    'four_suites',
+    'lockly',
+    'wyze',
+    'nest',
+    'tedee',
+    'seam_bridge',
+    'honeywell_resideo',
+    'visionline',
+    'assa_abloy_credential_service',
+    'latch',
+  ],
+
+  consumer_smartlocks: [
+    'august',
+    'schlage',
+    'yale',
+    'smartthings',
+    'nuki',
+    'ttlock',
+    'kwikset',
+    'igloohome',
+    'wyze',
+  ],
+
+  thermostats: ['ecobee', 'nest'],
+  noise_sensors: ['minut', 'noiseaware'],
+  access_control_systems: [
+    'pti',
+    'visionline',
+    'assa_abloy_credential_service',
+    'latch',
+  ],
+
+  internal_beta: ALL_DEVICE_PROVIDERS,
+} as const satisfies Record<string, readonly DeviceProvider[]>
+
+export const PROVIDER_CATEGORIES: [ProviderCategory, ...ProviderCategory[]] =
+  Object.keys(PROVIDER_CATEGORY_MAP) as any
+
+export const PUBLIC_PROVIDER_CATEGORIES: typeof PROVIDER_CATEGORIES =
+  PROVIDER_CATEGORIES.filter((category) => category !== 'internal_beta') as any
+
+export const device_provider = z.object({
+  device_provider_name: z.enum(ALL_DEVICE_PROVIDERS),
+  display_name: z.string(),
+  image_url: z.string(),
+  provider_categories: z.array(z.enum(PUBLIC_PROVIDER_CATEGORIES)),
+})

package/src/lib/seam/connect/models/devices/index.ts

@@ -1,6 +1,8 @@
 export * from './capabilities-supported.js'
 export * from './device-metadata.js'
+export * from './device-provider.js'
 export * from './device-type.js'
 export * from './managed-device.js'
+export * from './noise-threshold.js'
 export * from './phone.js'
 export * from './unmanaged-device.js'

package/src/lib/seam/connect/models/devices/noise-threshold.ts

@@ -0,0 +1,11 @@
+import { z } from 'zod'
+
+export const noise_threshold = z.object({
+  noise_threshold_id: z.string().uuid(),
+  device_id: z.string().uuid(),
+  name: z.string(),
+  noise_threshold_nrs: z.number().optional(),
+  starts_daily_at: z.string(), // TODO: zoned_time
+  ends_daily_at: z.string(), // TODO: zoned_time
+  noise_threshold_decibels: z.number(),
+})

package/src/lib/seam/connect/models/events/acs/index.ts

@@ -1,7 +1,9 @@
 import { acs_credential_events } from './credentials.js'
+import { acs_system_events } from './systems.js'
 import { acs_user_events } from './users.js'
 
 export const acs_events = [
+  ...acs_system_events,
   ...acs_credential_events,
   ...acs_user_events,
 ] as const

package/src/lib/seam/connect/models/events/acs/systems.ts

@@ -0,0 +1,15 @@
+import { z } from 'zod'
+
+import { common_acs_event } from './common.js'
+
+const acs_system_event = common_acs_event.extend({})
+
+export const acs_system_connected_event = acs_system_event
+  .extend({
+    event_type: z.literal('acs_system.connected'),
+  })
+  .describe('An ACS system was connected.')
+
+export type AcsSystemConnectedEvent = z.infer<typeof acs_system_connected_event>
+
+export const acs_system_events = [acs_system_connected_event] as const

package/src/lib/seam/connect/models/index.ts

@@ -4,9 +4,11 @@ export * from './action-attempts/index.js'
 export * from './capability-properties/index.js'
 export * from './client-sessions/index.js'
 export * from './connect-webviews/index.js'
+export * from './connected-accounts/index.js'
 export * from './custom-metadata.js'
 export * from './devices/index.js'
 export * from './events/index.js'
 export * from './phone-number.js'
 export * from './user-identities/index.js'
+export * from './webhooks/index.js'
 export * from './workspaces/index.js'

package/src/lib/seam/connect/models/webhooks/index.ts

@@ -0,0 +1 @@
+export * from './webhook.js'

package/src/lib/seam/connect/models/webhooks/webhook.ts

@@ -0,0 +1,8 @@
+import { z } from 'zod'
+
+export const webhook = z.object({
+  webhook_id: z.string(),
+  url: z.string(),
+  event_types: z.array(z.string()).optional(),
+  secret: z.string().optional(),
+})

package/src/lib/seam/connect/openapi.ts

@@ -158,6 +158,7 @@ export default {
           acs_access_group_id: { format: 'uuid', type: 'string' },
           acs_system_id: { format: 'uuid', type: 'string' },
           created_at: { format: 'date-time', type: 'string' },
+          display_name: { type: 'string' },
           external_type: {
             enum: [
               'pti_unit',
@@ -178,6 +179,7 @@ export default {
           'name',
           'access_group_type',
           'access_group_type_display_name',
+          'display_name',
           'external_type',
           'external_type_display_name',
           'created_at',
@@ -9110,6 +9112,7 @@ export default {
                       'connected_account.completed_first_sync_after_reconnection',
                       'noise_sensor.noise_threshold_triggered',
                       'access_code.backup_access_code_pulled',
+                      'acs_system.connected',
                       'acs_user.deleted',
                       'acs_credential.deleted',
                       'enrollment_automation.deleted',
@@ -9173,6 +9176,7 @@ export default {
                         'connected_account.completed_first_sync_after_reconnection',
                         'noise_sensor.noise_threshold_triggered',
                         'access_code.backup_access_code_pulled',
+                        'acs_system.connected',
                         'acs_user.deleted',
                         'acs_credential.deleted',
                         'enrollment_automation.deleted',

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

@@ -3105,6 +3105,7 @@ export interface Routes {
             ---
              */
         access_group_type_display_name: string
+        display_name: string
         external_type:
           | 'pti_unit'
           | 'pti_access_level'
@@ -3147,6 +3148,7 @@ export interface Routes {
             ---
              */
         access_group_type_display_name: string
+        display_name: string
         external_type:
           | 'pti_unit'
           | 'pti_access_level'
@@ -8391,6 +8393,7 @@ export interface Routes {
             | 'connected_account.completed_first_sync_after_reconnection'
             | 'noise_sensor.noise_threshold_triggered'
             | 'access_code.backup_access_code_pulled'
+            | 'acs_system.connected'
             | 'acs_user.deleted'
             | 'acs_credential.deleted'
             | 'enrollment_automation.deleted'
@@ -8452,6 +8455,7 @@ export interface Routes {
             | 'connected_account.completed_first_sync_after_reconnection'
             | 'noise_sensor.noise_threshold_triggered'
             | 'access_code.backup_access_code_pulled'
+            | 'acs_system.connected'
             | 'acs_user.deleted'
             | 'acs_credential.deleted'
             | 'enrollment_automation.deleted'